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
251 <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>
252 <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>
253 <a href="http://cpants.cpanauthors.org/dist/Catalyst-Runtime"><img src="http://cpants.cpanauthors.org/dist/Catalyst-Runtime.png" alt='Kwalitee Score' /></a>
257 See the L<Catalyst::Manual> distribution for comprehensive
258 documentation and tutorials.
260 # Install Catalyst::Devel for helpers and other development tools
261 # use the helper to create a new application
264 # add models, views, controllers
265 script/myapp_create.pl model MyDatabase DBIC::Schema create=static dbi:SQLite:/path/to/db
266 script/myapp_create.pl view MyTemplate TT
267 script/myapp_create.pl controller Search
269 # built in testserver -- use -r to restart automatically on changes
270 # --help to see all available options
271 script/myapp_server.pl
273 # command line testing interface
274 script/myapp_test.pl /yada
277 use Catalyst qw/-Debug/; # include plugins here as well
279 ### In lib/MyApp/Controller/Root.pm (autocreated)
280 sub foo : Chained('/') Args() { # called for /foo, /foo/1, /foo/1/2, etc.
281 my ( $self, $c, @args ) = @_; # args are qw/1 2/ for /foo/1/2
282 $c->stash->{template} = 'foo.tt'; # set the template
283 # lookup something from db -- stash vars are passed to TT
285 $c->model('Database::Foo')->search( { country => $args[0] } );
286 if ( $c->req->params->{bar} ) { # access GET or POST parameters
287 $c->forward( 'bar' ); # process another action
288 # do something else after forward returns
292 # The foo.tt TT template can use the stash data from the database
293 [% WHILE (item = data.next) %]
297 # called for /bar/of/soap, /bar/of/soap/10, etc.
298 sub bar : Chained('/') PathPart('/bar/of/soap') Args() { ... }
300 # called after all actions are finished
302 my ( $self, $c ) = @_;
303 if ( scalar @{ $c->error } ) { ... } # handle errors
304 return if $c->res->body; # already have a response
305 $c->forward( 'MyApp::View::TT' ); # render template
308 See L<Catalyst::Manual::Intro> for additional information.
312 Catalyst is a modern framework for making web applications without the
313 pain usually associated with this process. This document is a reference
314 to the main Catalyst application. If you are a new user, we suggest you
315 start with L<Catalyst::Manual::Tutorial> or L<Catalyst::Manual::Intro>.
317 See L<Catalyst::Manual> for more documentation.
319 Catalyst plugins can be loaded by naming them as arguments to the "use
320 Catalyst" statement. Omit the C<Catalyst::Plugin::> prefix from the
321 plugin name, i.e., C<Catalyst::Plugin::My::Module> becomes
324 use Catalyst qw/My::Module/;
326 If your plugin starts with a name other than C<Catalyst::Plugin::>, you can
327 fully qualify the name by using a unary plus:
331 +Fully::Qualified::Plugin::Name
334 Special flags like C<-Debug> can also be specified as
335 arguments when Catalyst is loaded:
337 use Catalyst qw/-Debug My::Module/;
339 The position of plugins and flags in the chain is important, because
340 they are loaded in the order in which they appear.
342 The following flags are supported:
346 Enables debug output. You can also force this setting from the system
347 environment with CATALYST_DEBUG or <MYAPP>_DEBUG. The environment
348 settings override the application, with <MYAPP>_DEBUG having the highest
351 This sets the log level to 'debug' and enables full debug output on the
352 error screen. If you only want the latter, see L<< $c->debug >>.
356 Forces Catalyst to use a specific home directory, e.g.:
358 use Catalyst qw[-Home=/usr/mst];
360 This can also be done in the shell environment by setting either the
361 C<CATALYST_HOME> environment variable or C<MYAPP_HOME>; where C<MYAPP>
362 is replaced with the uppercased name of your application, any "::" in
363 the name will be replaced with underscores, e.g. MyApp::Web should use
364 MYAPP_WEB_HOME. If both variables are set, the MYAPP_HOME one will be used.
366 If none of these are set, Catalyst will attempt to automatically detect the
367 home directory. If you are working in a development environment, Catalyst
368 will try and find the directory containing either Makefile.PL, Build.PL,
369 dist.ini, or cpanfile. If the application has been installed into the system
370 (i.e. you have done C<make install>), then Catalyst will use the path to your
371 application module, without the .pm extension (e.g., /foo/MyApp if your
372 application was installed at /foo/MyApp.pm)
376 use Catalyst '-Log=warn,fatal,error';
378 Specifies a comma-delimited list of log levels.
382 Enables statistics collection and reporting.
384 use Catalyst qw/-Stats=1/;
386 You can also force this setting from the system environment with CATALYST_STATS
387 or <MYAPP>_STATS. The environment settings override the application, with
388 <MYAPP>_STATS having the highest priority.
390 Stats are also enabled if L<< debugging |/"-Debug" >> is enabled.
394 =head2 INFORMATION ABOUT THE CURRENT REQUEST
398 Returns a L<Catalyst::Action> object for the current action, which
399 stringifies to the action name. See L<Catalyst::Action>.
403 Returns the namespace of the current action, i.e., the URI prefix
404 corresponding to the controller of the current action. For example:
406 # in Controller::Foo::Bar
407 $c->namespace; # returns 'foo/bar';
413 Returns the current L<Catalyst::Request> object, giving access to
414 information about the current client request (including parameters,
415 cookies, HTTP headers, etc.). See L<Catalyst::Request>.
417 =head2 REQUEST FLOW HANDLING
419 =head2 $c->forward( $action [, \@arguments ] )
421 =head2 $c->forward( $class, $method, [, \@arguments ] )
423 This is one way of calling another action (method) in the same or
424 a different controller. You can also use C<< $self->my_method($c, @args) >>
425 in the same controller or C<< $c->controller('MyController')->my_method($c, @args) >>
426 in a different controller.
427 The main difference is that 'forward' uses some of the Catalyst request
428 cycle overhead, including debugging, which may be useful to you. On the
429 other hand, there are some complications to using 'forward', restrictions
430 on values returned from 'forward', and it may not handle errors as you prefer.
431 Whether you use 'forward' or not is up to you; it is not considered superior to
432 the other ways to call a method.
434 'forward' calls another action, by its private name. If you give a
435 class name but no method, C<process()> is called. You may also optionally
436 pass arguments in an arrayref. The action will receive the arguments in
437 C<@_> and C<< $c->req->args >>. Upon returning from the function,
438 C<< $c->req->args >> will be restored to the previous values.
440 Any data C<return>ed from the action forwarded to, will be returned by the
443 my $foodata = $c->forward('/foo');
444 $c->forward('index');
445 $c->forward(qw/Model::DBIC::Foo do_stuff/);
446 $c->forward('View::TT');
448 Note that L<< forward|/"$c->forward( $action [, \@arguments ] )" >> implies
449 an C<< eval { } >> around the call (actually
450 L<< execute|/"$c->execute( $class, $coderef )" >> does), thus rendering all
451 exceptions thrown by the called action non-fatal and pushing them onto
452 $c->error instead. If you want C<die> to propagate you need to do something
456 die join "\n", @{ $c->error } if @{ $c->error };
458 Or make sure to always return true values from your actions and write
461 $c->forward('foo') || return;
463 Another note is that C<< $c->forward >> always returns a scalar because it
464 actually returns $c->state which operates in a scalar context.
465 Thus, something like:
469 in an action that is forwarded to is going to return a scalar,
470 i.e. how many items are in that array, which is probably not what you want.
471 If you need to return an array then return a reference to it,
474 $c->stash->{array} = \@array;
476 and access it from the stash.
478 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.
482 sub forward { my $c = shift; no warnings 'recursion'; $c->dispatcher->forward( $c, @_ ) }
484 =head2 $c->detach( $action [, \@arguments ] )
486 =head2 $c->detach( $class, $method, [, \@arguments ] )
490 The same as L<< forward|/"$c->forward( $action [, \@arguments ] )" >>, but
491 doesn't return to the previous action when processing is finished.
493 When called with no arguments it escapes the processing chain entirely.
497 sub detach { my $c = shift; $c->dispatcher->detach( $c, @_ ) }
499 =head2 $c->visit( $action [, \@arguments ] )
501 =head2 $c->visit( $action [, \@captures, \@arguments ] )
503 =head2 $c->visit( $class, $method, [, \@arguments ] )
505 =head2 $c->visit( $class, $method, [, \@captures, \@arguments ] )
507 Almost the same as L<< forward|/"$c->forward( $action [, \@arguments ] )" >>,
508 but does a full dispatch, instead of just calling the new C<$action> /
509 C<< $class->$method >>. This means that C<begin>, C<auto> and the method
510 you go to are called, just like a new request.
512 In addition both C<< $c->action >> and C<< $c->namespace >> are localized.
513 This means, for example, that C<< $c->action >> methods such as
514 L<name|Catalyst::Action/name>, L<class|Catalyst::Action/class> and
515 L<reverse|Catalyst::Action/reverse> return information for the visited action
516 when they are invoked within the visited action. This is different from the
517 behavior of L<< forward|/"$c->forward( $action [, \@arguments ] )" >>, which
518 continues to use the $c->action object from the caller action even when
519 invoked from the called action.
521 C<< $c->stash >> is kept unchanged.
523 In effect, L<< visit|/"$c->visit( $action [, \@captures, \@arguments ] )" >>
524 allows you to "wrap" another action, just as it would have been called by
525 dispatching from a URL, while the analogous
526 L<< go|/"$c->go( $action [, \@captures, \@arguments ] )" >> allows you to
527 transfer control to another action as if it had been reached directly from a URL.
531 sub visit { my $c = shift; $c->dispatcher->visit( $c, @_ ) }
533 =head2 $c->go( $action [, \@arguments ] )
535 =head2 $c->go( $action [, \@captures, \@arguments ] )
537 =head2 $c->go( $class, $method, [, \@arguments ] )
539 =head2 $c->go( $class, $method, [, \@captures, \@arguments ] )
541 The relationship between C<go> and
542 L<< visit|/"$c->visit( $action [, \@captures, \@arguments ] )" >> is the same as
543 the relationship between
544 L<< forward|/"$c->forward( $class, $method, [, \@arguments ] )" >> and
545 L<< detach|/"$c->detach( $action [, \@arguments ] )" >>. Like C<< $c->visit >>,
546 C<< $c->go >> will perform a full dispatch on the specified action or method,
547 with localized C<< $c->action >> and C<< $c->namespace >>. Like C<detach>,
548 C<go> escapes the processing of the current request chain on completion, and
549 does not return to its caller.
551 @arguments are arguments to the final destination of $action. @captures are
552 arguments to the intermediate steps, if any, on the way to the final sub of
557 sub go { my $c = shift; $c->dispatcher->go( $c, @_ ) }
563 Returns the current L<Catalyst::Response> object, see there for details.
567 Returns a hashref to the stash, which may be used to store data and pass
568 it between components during a request. You can also set hash keys by
569 passing arguments. The stash is automatically sent to the view. The
570 stash is cleared at the end of a request; it cannot be used for
571 persistent storage (for this you must use a session; see
572 L<Catalyst::Plugin::Session> for a complete system integrated with
575 $c->stash->{foo} = $bar;
576 $c->stash( { moose => 'majestic', qux => 0 } );
577 $c->stash( bar => 1, gorch => 2 ); # equivalent to passing a hashref
579 # stash is automatically passed to the view for use in a template
580 $c->forward( 'MyApp::View::TT' );
582 The stash hash is currently stored in the PSGI C<$env> and is managed by
583 L<Catalyst::Middleware::Stash>. Since it's part of the C<$env> items in
584 the stash can be accessed in sub applications mounted under your main
585 L<Catalyst> application. For example if you delegate the response of an
586 action to another L<Catalyst> application, that sub application will have
587 access to all the stash keys of the main one, and if can of course add
588 more keys of its own. However those new keys will not 'bubble' back up
589 to the main application.
591 For more information the best thing to do is to review the test case:
592 t/middleware-stash.t in the distribution /t directory.
598 $c->log->error("You are requesting the stash but you don't have a context") unless blessed $c;
599 return Catalyst::Middleware::Stash::get_stash($c->req->env)->(@_);
604 =head2 $c->error($error, ...)
606 =head2 $c->error($arrayref)
608 Returns an arrayref containing error messages. If Catalyst encounters an
609 error while processing a request, it stores the error in $c->error. This
610 method should only be used to store fatal error messages.
612 my @error = @{ $c->error };
616 $c->error('Something bad happened');
618 Calling this will always return an arrayref (if there are no errors it
619 will be an empty arrayref.
626 my $error = ref $_[0] eq 'ARRAY' ? $_[0] : [@_];
627 croak @$error unless ref $c;
628 push @{ $c->{error} }, @$error;
630 elsif ( defined $_[0] ) { $c->{error} = undef }
631 return $c->{error} || [];
636 Contains the return value of the last executed action.
637 Note that << $c->state >> operates in a scalar context which means that all
638 values it returns are scalar.
640 Please note that if an action throws an exception, the value of state
641 should no longer be considered the return if the last action. It is generally
642 going to be 0, which indicates an error state. Examine $c->error for error
645 =head2 $c->clear_errors
647 Clear errors. You probably don't want to clear the errors unless you are
648 implementing a custom error screen.
650 This is equivalent to running
661 =head2 $c->has_errors
663 Returns true if you have errors
667 sub has_errors { scalar(@{shift->error}) ? 1:0 }
669 =head2 $c->last_error
671 Returns the most recent error in the stack (the one most recently added...)
672 or nothing if there are no errors. This does not modify the contents of the
678 my (@errs) = @{shift->error};
679 return scalar(@errs) ? $errs[-1]: undef;
684 shifts the most recently added error off the error stack and returns it. Returns
685 nothing if there are no more errors.
691 my @errors = @{$self->error};
692 my $err = shift(@errors);
693 $self->{error} = \@errors;
699 pops the most recently added error off the error stack and returns it. Returns
700 nothing if there are no more errors.
706 my @errors = @{$self->error};
707 my $err = pop(@errors);
708 $self->{error} = \@errors;
712 sub _comp_search_prefixes {
714 return map $c->components->{ $_ }, $c->_comp_names_search_prefixes(@_);
717 # search components given a name and some prefixes
718 sub _comp_names_search_prefixes {
719 my ( $c, $name, @prefixes ) = @_;
720 my $appclass = ref $c || $c;
721 my $filter = "^${appclass}::(" . join( '|', @prefixes ) . ')::';
722 $filter = qr/$filter/; # Compile regex now rather than once per loop
724 # map the original component name to the sub part that we will search against
725 my %eligible = map { my $n = $_; $n =~ s{^$appclass\::[^:]+::}{}; $_ => $n; }
726 grep { /$filter/ } keys %{ $c->components };
728 # undef for a name will return all
729 return keys %eligible if !defined $name;
731 my $query = $name->$_isa('Regexp') ? $name : qr/^$name$/i;
732 my @result = grep { $eligible{$_} =~ m{$query} } keys %eligible;
734 return @result if @result;
736 # if we were given a regexp to search against, we're done.
737 return if $name->$_isa('Regexp');
739 # skip regexp fallback if configured
741 if $appclass->config->{disable_component_resolution_regex_fallback};
745 @result = grep { $eligible{ $_ } =~ m{$query} } keys %eligible;
747 # no results? try against full names
749 @result = grep { m{$query} } keys %eligible;
752 # don't warn if we didn't find any results, it just might not exist
754 # Disgusting hack to work out correct method name
755 my $warn_for = lc $prefixes[0];
756 my $msg = "Used regexp fallback for \$c->${warn_for}('${name}'), which found '" .
757 (join '", "', @result) . "'. Relying on regexp fallback behavior for " .
758 "component resolution is unreliable and unsafe.";
759 my $short = $result[0];
760 # remove the component namespace prefix
761 $short =~ s/.*?(Model|Controller|View):://;
762 my $shortmess = Carp::shortmess('');
763 if ($shortmess =~ m#Catalyst/Plugin#) {
764 $msg .= " You probably need to set '$short' instead of '${name}' in this " .
766 } elsif ($shortmess =~ m#Catalyst/lib/(View|Controller)#) {
767 $msg .= " You probably need to set '$short' instead of '${name}' in this " .
768 "component's config";
770 $msg .= " You probably meant \$c->${warn_for}('$short') instead of \$c->${warn_for}('${name}'), " .
771 "but if you really wanted to search, pass in a regexp as the argument " .
772 "like so: \$c->${warn_for}(qr/${name}/)";
774 $c->log->warn( "${msg}$shortmess" );
780 # Find possible names for a prefix
782 my ( $c, @prefixes ) = @_;
783 my $appclass = ref $c || $c;
785 my $filter = "^${appclass}::(" . join( '|', @prefixes ) . ')::';
787 my @names = map { s{$filter}{}; $_; }
788 $c->_comp_names_search_prefixes( undef, @prefixes );
793 # Filter a component before returning by calling ACCEPT_CONTEXT if available
795 sub _filter_component {
796 my ( $c, $comp, @args ) = @_;
798 if(ref $comp eq 'CODE') {
802 if ( eval { $comp->can('ACCEPT_CONTEXT'); } ) {
803 return $comp->ACCEPT_CONTEXT( $c, @args );
806 $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;
811 =head2 COMPONENT ACCESSORS
813 =head2 $c->controller($name)
815 Gets a L<Catalyst::Controller> instance by name.
817 $c->controller('Foo')->do_stuff;
819 If the name is omitted, will return the controller for the dispatched
822 If you want to search for controllers, pass in a regexp as the argument.
824 # find all controllers that start with Foo
825 my @foo_controllers = $c->controller(qr{^Foo});
831 my ( $c, $name, @args ) = @_;
833 my $appclass = ref($c) || $c;
835 unless ( $name->$_isa('Regexp') ) { # Direct component hash lookup to avoid costly regexps
836 my $comps = $c->components;
837 my $check = $appclass."::Controller::".$name;
838 return $c->_filter_component( $comps->{$check}, @args ) if exists $comps->{$check};
839 foreach my $path (@{$appclass->config->{ setup_components }->{ search_extra }}) {
840 next unless $path =~ /.*::Controller/;
841 $check = $path."::".$name;
842 return $c->_filter_component( $comps->{$check}, @args ) if exists $comps->{$check};
845 my @result = $c->_comp_search_prefixes( $name, qw/Controller C/ );
846 return map { $c->_filter_component( $_, @args ) } @result if ref $name;
847 return $c->_filter_component( $result[ 0 ], @args );
850 return $c->component( $c->action->class );
853 =head2 $c->model($name)
855 Gets a L<Catalyst::Model> instance by name.
857 $c->model('Foo')->do_stuff;
859 Any extra arguments are directly passed to ACCEPT_CONTEXT, if the model
860 defines ACCEPT_CONTEXT. If it does not, the args are discarded.
862 If the name is omitted, it will look for
863 - a model object in $c->stash->{current_model_instance}, then
864 - a model name in $c->stash->{current_model}, then
865 - a config setting 'default_model', or
866 - check if there is only one model, and return it if that's the case.
868 If you want to search for models, pass in a regexp as the argument.
870 # find all models that start with Foo
871 my @foo_models = $c->model(qr{^Foo});
876 my ( $c, $name, @args ) = @_;
877 my $appclass = ref($c) || $c;
879 unless ( $name->$_isa('Regexp') ) { # Direct component hash lookup to avoid costly regexps
880 my $comps = $c->components;
881 my $check = $appclass."::Model::".$name;
882 return $c->_filter_component( $comps->{$check}, @args ) if exists $comps->{$check};
883 foreach my $path (@{$appclass->config->{ setup_components }->{ search_extra }}) {
884 next unless $path =~ /.*::Model/;
885 $check = $path."::".$name;
886 return $c->_filter_component( $comps->{$check}, @args ) if exists $comps->{$check};
889 my @result = $c->_comp_search_prefixes( $name, qw/Model M/ );
890 return map { $c->_filter_component( $_, @args ) } @result if ref $name;
891 return $c->_filter_component( $result[ 0 ], @args );
895 return $c->stash->{current_model_instance}
896 if $c->stash->{current_model_instance};
897 return $c->model( $c->stash->{current_model} )
898 if $c->stash->{current_model};
900 return $c->model( $appclass->config->{default_model} )
901 if $appclass->config->{default_model};
903 my( $comp, $rest ) = $c->_comp_search_prefixes( undef, qw/Model M/);
906 $c->log->warn( Carp::shortmess('Calling $c->model() will return a random model unless you specify one of:') );
907 $c->log->warn( '* $c->config(default_model => "the name of the default model to use")' );
908 $c->log->warn( '* $c->stash->{current_model} # the name of the model to use for this request' );
909 $c->log->warn( '* $c->stash->{current_model_instance} # the instance of the model to use for this request' );
910 $c->log->warn( 'NB: in version 5.81, the "random" behavior will not work at all.' );
913 return $c->_filter_component( $comp );
917 =head2 $c->view($name)
919 Gets a L<Catalyst::View> instance by name.
921 $c->view('Foo')->do_stuff;
923 Any extra arguments are directly passed to ACCEPT_CONTEXT.
925 If the name is omitted, it will look for
926 - a view object in $c->stash->{current_view_instance}, then
927 - a view name in $c->stash->{current_view}, then
928 - a config setting 'default_view', or
929 - check if there is only one view, and return it if that's the case.
931 If you want to search for views, pass in a regexp as the argument.
933 # find all views that start with Foo
934 my @foo_views = $c->view(qr{^Foo});
939 my ( $c, $name, @args ) = @_;
941 my $appclass = ref($c) || $c;
943 unless ( $name->$_isa('Regexp') ) { # Direct component hash lookup to avoid costly regexps
944 my $comps = $c->components;
945 my $check = $appclass."::View::".$name;
946 if( exists $comps->{$check} ) {
947 return $c->_filter_component( $comps->{$check}, @args );
950 $c->log->warn( "Attempted to use view '$check', but does not exist" );
952 foreach my $path (@{$appclass->config->{ setup_components }->{ search_extra }}) {
953 next unless $path =~ /.*::View/;
954 $check = $path."::".$name;
955 return $c->_filter_component( $comps->{$check}, @args ) if exists $comps->{$check};
958 my @result = $c->_comp_search_prefixes( $name, qw/View V/ );
959 return map { $c->_filter_component( $_, @args ) } @result if ref $name;
960 return $c->_filter_component( $result[ 0 ], @args );
964 return $c->stash->{current_view_instance}
965 if $c->stash->{current_view_instance};
966 return $c->view( $c->stash->{current_view} )
967 if $c->stash->{current_view};
969 return $c->view( $appclass->config->{default_view} )
970 if $appclass->config->{default_view};
972 my( $comp, $rest ) = $c->_comp_search_prefixes( undef, qw/View V/);
975 $c->log->warn( 'Calling $c->view() will return a random view unless you specify one of:' );
976 $c->log->warn( '* $c->config(default_view => "the name of the default view to use")' );
977 $c->log->warn( '* $c->stash->{current_view} # the name of the view to use for this request' );
978 $c->log->warn( '* $c->stash->{current_view_instance} # the instance of the view to use for this request' );
979 $c->log->warn( 'NB: in version 5.81, the "random" behavior will not work at all.' );
982 return $c->_filter_component( $comp );
985 =head2 $c->controllers
987 Returns the available names which can be passed to $c->controller
993 return $c->_comp_names(qw/Controller C/);
998 Returns the available names which can be passed to $c->model
1004 return $c->_comp_names(qw/Model M/);
1010 Returns the available names which can be passed to $c->view
1016 return $c->_comp_names(qw/View V/);
1019 =head2 $c->comp($name)
1021 =head2 $c->component($name)
1023 Gets a component object by name. This method is not recommended,
1024 unless you want to get a specific component by full
1025 class. C<< $c->controller >>, C<< $c->model >>, and C<< $c->view >>
1026 should be used instead.
1028 If C<$name> is a regexp, a list of components matched against the full
1029 component name will be returned.
1031 If Catalyst can't find a component by name, it will fallback to regex
1032 matching by default. To disable this behaviour set
1033 disable_component_resolution_regex_fallback to a true value.
1035 __PACKAGE__->config( disable_component_resolution_regex_fallback => 1 );
1040 my ( $c, $name, @args ) = @_;
1043 my $comps = $c->components;
1046 # is it the exact name?
1047 return $c->_filter_component( $comps->{ $name }, @args )
1048 if exists $comps->{ $name };
1050 # perhaps we just omitted "MyApp"?
1051 my $composed = ( ref $c || $c ) . "::${name}";
1052 return $c->_filter_component( $comps->{ $composed }, @args )
1053 if exists $comps->{ $composed };
1055 # search all of the models, views and controllers
1056 my( $comp ) = $c->_comp_search_prefixes( $name, qw/Model M Controller C View V/ );
1057 return $c->_filter_component( $comp, @args ) if $comp;
1061 if $c->config->{disable_component_resolution_regex_fallback};
1063 # This is here so $c->comp( '::M::' ) works
1064 my $query = ref $name ? $name : qr{$name}i;
1066 my @result = grep { m{$query} } keys %{ $c->components };
1067 return map { $c->_filter_component( $_, @args ) } @result if ref $name;
1069 if( $result[ 0 ] ) {
1070 $c->log->warn( Carp::shortmess(qq(Found results for "${name}" using regexp fallback)) );
1071 $c->log->warn( 'Relying on the regexp fallback behavior for component resolution' );
1072 $c->log->warn( 'is unreliable and unsafe. You have been warned' );
1073 return $c->_filter_component( $result[ 0 ], @args );
1076 # I would expect to return an empty list here, but that breaks back-compat
1080 return sort keys %{ $c->components };
1083 =head2 CLASS DATA AND HELPER CLASSES
1087 Returns or takes a hashref containing the application's configuration.
1089 __PACKAGE__->config( { db => 'dsn:SQLite:foo.db' } );
1091 You can also use a C<YAML>, C<XML> or L<Config::General> config file
1092 like C<myapp.conf> in your applications home directory. See
1093 L<Catalyst::Plugin::ConfigLoader>.
1095 =head3 Cascading configuration
1097 The config method is present on all Catalyst components, and configuration
1098 will be merged when an application is started. Configuration loaded with
1099 L<Catalyst::Plugin::ConfigLoader> takes precedence over other configuration,
1100 followed by configuration in your top level C<MyApp> class. These two
1101 configurations are merged, and then configuration data whose hash key matches a
1102 component name is merged with configuration for that component.
1104 The configuration for a component is then passed to the C<new> method when a
1105 component is constructed.
1109 MyApp->config({ 'Model::Foo' => { bar => 'baz', overrides => 'me' } });
1110 MyApp::Model::Foo->config({ quux => 'frob', overrides => 'this' });
1112 will mean that C<MyApp::Model::Foo> receives the following data when
1115 MyApp::Model::Foo->new({
1121 It's common practice to use a Moose attribute
1122 on the receiving component to access the config value.
1124 package MyApp::Model::Foo;
1128 # this attr will receive 'baz' at construction time
1134 You can then get the value 'baz' by calling $c->model('Foo')->bar
1135 (or $self->bar inside code in the model).
1137 B<NOTE:> you MUST NOT call C<< $self->config >> or C<< __PACKAGE__->config >>
1138 as a way of reading config within your code, as this B<will not> give you the
1139 correctly merged config back. You B<MUST> take the config values supplied to
1140 the constructor and use those instead.
1144 around config => sub {
1148 croak('Setting config after setup has been run is not allowed.')
1149 if ( @_ and $c->setup_finished );
1156 Returns the logging object instance. Unless it is already set, Catalyst
1157 sets this up with a L<Catalyst::Log> object. To use your own log class,
1158 set the logger with the C<< __PACKAGE__->log >> method prior to calling
1159 C<< __PACKAGE__->setup >>.
1161 __PACKAGE__->log( MyLogger->new );
1166 $c->log->info( 'Now logging with my own logger!' );
1168 Your log class should implement the methods described in
1173 Returned True if there's a valid encoding
1175 =head2 clear_encoding
1177 Clears the encoding for the current context
1181 Sets or gets the application encoding. Setting encoding takes either an
1182 Encoding object or a string that we try to resolve via L<Encode::find_encoding>.
1184 You would expect to get the encoding object back if you attempt to set it. If
1185 there is a failure you will get undef returned and an error message in the log.
1189 sub has_encoding { shift->encoding ? 1:0 }
1191 sub clear_encoding {
1194 $c->encoding(undef);
1196 $c->log->error("You can't clear encoding on the application");
1206 # Don't let one change this once we are too far into the response
1207 if(blessed $c && $c->res->finalized_headers) {
1208 Carp::croak("You may not change the encoding once the headers are finalized");
1212 # Let it be set to undef
1213 if (my $wanted = shift) {
1214 $encoding = Encode::find_encoding($wanted)
1215 or Carp::croak( qq/Unknown encoding '$wanted'/ );
1216 binmode(STDERR, ':encoding(' . $encoding->name . ')');
1223 ? $c->{encoding} = $encoding
1224 : $c->_encoding($encoding);
1226 $encoding = ref $c && exists $c->{encoding}
1236 Returns 1 if debug mode is enabled, 0 otherwise.
1238 You can enable debug mode in several ways:
1242 =item By calling myapp_server.pl with the -d flag
1244 =item With the environment variables MYAPP_DEBUG, or CATALYST_DEBUG
1246 =item The -Debug option in your MyApp.pm
1248 =item By declaring C<sub debug { 1 }> in your MyApp.pm.
1252 The first three also set the log level to 'debug'.
1254 Calling C<< $c->debug(1) >> has no effect.
1260 =head2 $c->dispatcher
1262 Returns the dispatcher instance. See L<Catalyst::Dispatcher>.
1266 Returns the engine instance. See L<Catalyst::Engine>.
1269 =head2 UTILITY METHODS
1271 =head2 $c->path_to(@path)
1273 Merges C<@path> with C<< $c->config->{home} >> and returns a
1274 L<Path::Class::Dir> object. Note you can usually use this object as
1275 a filename, but sometimes you will have to explicitly stringify it
1276 yourself by calling the C<< ->stringify >> method.
1280 $c->path_to( 'db', 'sqlite.db' );
1285 my ( $c, @path ) = @_;
1286 my $path = Path::Class::Dir->new( $c->config->{home}, @path );
1287 if ( -d $path ) { return $path }
1288 else { return Path::Class::File->new( $c->config->{home}, @path ) }
1292 my ( $class, $name, $plugin, @args ) = @_;
1294 # See block comment in t/unit_core_plugin.t
1295 $class->log->warn(qq/Adding plugin using the ->plugin method is deprecated, and will be removed in a future release/);
1297 $class->_register_plugin( $plugin, 1 );
1299 eval { $plugin->import };
1300 $class->mk_classdata($name);
1302 eval { $obj = $plugin->new(@args) };
1305 Catalyst::Exception->throw( message =>
1306 qq/Couldn't instantiate instant plugin "$plugin", "$@"/ );
1309 $class->$name($obj);
1310 $class->log->debug(qq/Initialized instant plugin "$plugin" as "$name"/)
1316 Initializes the dispatcher and engine, loads any plugins, and loads the
1317 model, view, and controller components. You may also specify an array
1318 of plugins to load here, if you choose to not load them in the C<use
1322 MyApp->setup( qw/-Debug/ );
1324 B<Note:> You B<should not> wrap this method with method modifiers
1325 or bad things will happen - wrap the C<setup_finalize> method instead.
1327 B<Note:> You can create a custom setup stage that will execute when the
1328 application is starting. Use this to customize setup.
1330 MyApp->setup(-Custom=value);
1333 my ($class, $value) = @_;
1336 Can be handy if you want to hook into the setup phase.
1341 my ( $class, @arguments ) = @_;
1342 croak('Running setup more than once')
1343 if ( $class->setup_finished );
1345 unless ( $class->isa('Catalyst') ) {
1347 Catalyst::Exception->throw(
1348 message => qq/'$class' does not inherit from Catalyst/ );
1351 if ( $class->arguments ) {
1352 @arguments = ( @arguments, @{ $class->arguments } );
1358 foreach (@arguments) {
1362 ( $flags->{log} ) ? 'debug,' . $flags->{log} : 'debug';
1364 elsif (/^-(\w+)=?(.*)$/) {
1365 $flags->{ lc $1 } = $2;
1368 push @{ $flags->{plugins} }, $_;
1372 $class->setup_home( delete $flags->{home} );
1374 $class->setup_log( delete $flags->{log} );
1375 $class->setup_plugins( delete $flags->{plugins} );
1377 $class->setup_data_handlers();
1378 $class->setup_dispatcher( delete $flags->{dispatcher} );
1379 if (my $engine = delete $flags->{engine}) {
1380 $class->log->warn("Specifying the engine in ->setup is no longer supported, see Catalyst::Upgrading");
1382 $class->setup_engine();
1383 $class->setup_stats( delete $flags->{stats} );
1385 for my $flag ( sort keys %{$flags} ) {
1387 if ( my $code = $class->can( 'setup_' . $flag ) ) {
1388 &$code( $class, delete $flags->{$flag} );
1391 $class->log->warn(qq/Unknown flag "$flag"/);
1395 eval { require Catalyst::Devel; };
1396 if( !$@ && $ENV{CATALYST_SCRIPT_GEN} && ( $ENV{CATALYST_SCRIPT_GEN} < $Catalyst::Devel::CATALYST_SCRIPT_GEN ) ) {
1397 $class->log->warn(<<"EOF");
1398 You are running an old script!
1400 Please update by running (this will overwrite existing files):
1401 catalyst.pl -force -scripts $class
1403 or (this will not overwrite existing files):
1404 catalyst.pl -scripts $class
1409 # Call plugins setup, this is stupid and evil.
1410 # Also screws C3 badly on 5.10, hack to avoid.
1412 no warnings qw/redefine/;
1413 local *setup = sub { };
1414 $class->setup unless $Catalyst::__AM_RESTARTING;
1417 # If you are expecting configuration info as part of your setup, it needs
1418 # to get called here and below, since we need the above line to support
1419 # ConfigLoader based configs.
1421 $class->setup_encoding();
1422 $class->setup_middleware();
1424 # Initialize our data structure
1425 $class->components( {} );
1427 $class->setup_components;
1429 if ( $class->debug ) {
1430 my @plugins = map { "$_ " . ( $_->VERSION || '' ) } $class->registered_plugins;
1433 my $column_width = Catalyst::Utils::term_width() - 6;
1434 my $t = Text::SimpleTable->new($column_width);
1435 $t->row($_) for @plugins;
1436 $class->log->debug( "Loaded plugins:\n" . $t->draw . "\n" );
1439 my @middleware = map {
1442 (ref($_) .' '. ($_->can('VERSION') ? $_->VERSION || '' : '')
1443 || '') } $class->registered_middlewares;
1446 my $column_width = Catalyst::Utils::term_width() - 6;
1447 my $t = Text::SimpleTable->new($column_width);
1448 $t->row($_) for @middleware;
1449 $class->log->debug( "Loaded PSGI Middleware:\n" . $t->draw . "\n" );
1452 my %dh = $class->registered_data_handlers;
1453 if (my @data_handlers = keys %dh) {
1454 my $column_width = Catalyst::Utils::term_width() - 6;
1455 my $t = Text::SimpleTable->new($column_width);
1456 $t->row($_) for @data_handlers;
1457 $class->log->debug( "Loaded Request Data Handlers:\n" . $t->draw . "\n" );
1460 my $dispatcher = $class->dispatcher;
1461 my $engine = $class->engine;
1462 my $home = $class->config->{home};
1464 $class->log->debug(sprintf(q/Loaded dispatcher "%s"/, blessed($dispatcher)));
1465 $class->log->debug(sprintf(q/Loaded engine "%s"/, blessed($engine)));
1469 ? $class->log->debug(qq/Found home "$home"/)
1470 : $class->log->debug(qq/Home "$home" doesn't exist/)
1471 : $class->log->debug(q/Couldn't find home/);
1473 my $column_width = Catalyst::Utils::term_width() - 8 - 9;
1475 my $t = Text::SimpleTable->new( [ $column_width, 'Class' ], [ 8, 'Type' ] );
1476 for my $comp ( sort keys %{ $class->components } ) {
1477 my $type = ref $class->components->{$comp} ? 'instance' : 'class';
1478 $t->row( $comp, $type );
1480 $class->log->debug( "Loaded components:\n" . $t->draw . "\n" )
1481 if ( keys %{ $class->components } );
1484 # Add our self to components, since we are also a component
1485 if( $class->isa('Catalyst::Controller') ){
1486 $class->components->{$class} = $class;
1489 $class->setup_actions;
1491 if ( $class->debug ) {
1492 my $name = $class->config->{name} || 'Application';
1493 $class->log->info("$name powered by Catalyst $Catalyst::VERSION");
1496 if ($class->config->{case_sensitive}) {
1497 $class->log->warn($class . "->config->{case_sensitive} is set.");
1498 $class->log->warn("This setting is deprecated and planned to be removed in Catalyst 5.81.");
1501 # call these so we pre setup the composed classes
1502 $class->composed_request_class;
1503 $class->composed_response_class;
1504 $class->composed_stats_class;
1506 $class->setup_finalize;
1508 # Flush the log for good measure (in case something turned off 'autoflush' early)
1509 $class->log->_flush() if $class->log->can('_flush');
1511 return $class || 1; # Just in case someone named their Application 0...
1514 =head2 $app->setup_finalize
1516 A hook to attach modifiers to. This method does not do anything except set the
1517 C<setup_finished> accessor.
1519 Applying method modifiers to the C<setup> method doesn't work, because of quirky things done for plugin setup.
1523 after setup_finalize => sub {
1531 sub setup_finalize {
1533 $class->setup_finished(1);
1536 =head2 $c->uri_for( $path?, @args?, \%query_values?, \$fragment? )
1538 =head2 $c->uri_for( $action, \@captures?, @args?, \%query_values?, \$fragment? )
1540 =head2 $c->uri_for( $action, [@captures, @args], \%query_values?, \$fragment? )
1542 Constructs an absolute L<URI> object based on the application root, the
1543 provided path, and the additional arguments and query parameters provided.
1544 When used as a string, provides a textual URI. If you need more flexibility
1545 than this (i.e. the option to provide relative URIs etc.) see
1546 L<Catalyst::Plugin::SmartURI>.
1548 If no arguments are provided, the URI for the current action is returned.
1549 To return the current action and also provide @args, use
1550 C<< $c->uri_for( $c->action, @args ) >>.
1552 If the first argument is a string, it is taken as a public URI path relative
1553 to C<< $c->namespace >> (if it doesn't begin with a forward slash) or
1554 relative to the application root (if it does). It is then merged with
1555 C<< $c->request->base >>; any C<@args> are appended as additional path
1556 components; and any C<%query_values> are appended as C<?foo=bar> parameters.
1558 B<NOTE> If you are using this 'stringy' first argument, we skip encoding and
1559 allow you to declare something like:
1561 $c->uri_for('/foo/bar#baz')
1563 Where 'baz' is a URI fragment. We consider this first argument string to be
1564 'expert' mode where you are expected to create a valid URL and we for the most
1565 part just pass it through without a lot of internal effort to escape and encode.
1567 If the first argument is a L<Catalyst::Action> it represents an action which
1568 will have its path resolved using C<< $c->dispatcher->uri_for_action >>. The
1569 optional C<\@captures> argument (an arrayref) allows passing the captured
1570 variables that are needed to fill in the paths of Chained and Regex actions;
1571 once the path is resolved, C<uri_for> continues as though a path was
1572 provided, appending any arguments or parameters and creating an absolute
1575 The captures for the current request can be found in
1576 C<< $c->request->captures >>, and actions can be resolved using
1577 C<< Catalyst::Controller->action_for($name) >>. If you have a private action
1578 path, use C<< $c->uri_for_action >> instead.
1580 # Equivalent to $c->req->uri
1581 $c->uri_for($c->action, $c->req->captures,
1582 @{ $c->req->args }, $c->req->params);
1584 # For the Foo action in the Bar controller
1585 $c->uri_for($c->controller('Bar')->action_for('Foo'));
1587 # Path to a static resource
1588 $c->uri_for('/static/images/logo.png');
1590 In general the scheme of the generated URI object will follow the incoming request
1591 however if your targeted action or action chain has the Scheme attribute it will
1594 Also, if the targeted Action or Action chain declares Args/CaptureArgs that have
1595 type constraints, we will require that your proposed URL verify on those declared
1601 my ( $c, $path, @args ) = @_;
1603 if ( $path->$_isa('Catalyst::Controller') ) {
1604 $path = $path->path_prefix;
1609 my $fragment = ((scalar(@args) && ref($args[-1]) eq 'SCALAR') ? pop @args : undef );
1611 unless(blessed $path) {
1612 if (defined($path) and $path =~ s/#(.+)$//) {
1613 if(defined($1) and $fragment) {
1614 carp "Abiguious fragment declaration: You cannot define a fragment in '$path' and as an argument '$fragment'";
1623 ( scalar @args && ref $args[$#args] eq 'HASH' ? pop @args : {} );
1625 undef($path) if (defined $path && $path eq '');
1627 carp "uri_for called with undef argument" if grep { ! defined $_ } @args;
1629 my $target_action = $path->$_isa('Catalyst::Action') ? $path : undef;
1630 if ( $path->$_isa('Catalyst::Action') ) { # action object
1631 s|/|%2F|g for @args;
1632 my $captures = [ map { s|/|%2F|g; $_; }
1633 ( scalar @args && ref $args[0] eq 'ARRAY'
1638 my $expanded_action = $c->dispatcher->expand_action( $action );
1639 my $num_captures = $expanded_action->number_of_captures;
1641 # ->uri_for( $action, \@captures_and_args, \%query_values? )
1642 if( !@args && $action->number_of_args ) {
1643 unshift @args, splice @$captures, $num_captures;
1647 unless($expanded_action->match_captures_constraints($c, $captures)) {
1648 carp "captures [@{$captures}] do not match the type constraints in actionchain ending with '$expanded_action'";
1653 $path = $c->dispatcher->uri_for_action($action, $captures);
1654 if (not defined $path) {
1655 $c->log->debug(qq/Can't find uri_for action '$action' @$captures/)
1659 $path = '/' if $path eq '';
1661 # At this point @encoded_args is the remaining Args (all captures removed).
1662 if($expanded_action->has_args_constraints) {
1663 unless($expanded_action->match_args($c,\@args)) {
1664 carp "args [@args] do not match the type constraints in action '$expanded_action'";
1670 unshift(@args, $path);
1672 unless (defined $path && $path =~ s!^/!!) { # in-place strip
1673 my $namespace = $c->namespace;
1674 if (defined $path) { # cheesy hack to handle path '../foo'
1675 $namespace =~ s{(?:^|/)[^/]+$}{} while $args[0] =~ s{^\.\./}{};
1677 unshift(@args, $namespace || '');
1680 # join args with '/', or a blank string
1681 my $args = join('/', grep { defined($_) } @args);
1682 $args =~ s/\?/%3F/g; # STUPID STUPID SPECIAL CASE
1685 my ($base, $class) = ('/', 'URI::_generic');
1687 $base = $c->req->base;
1688 if($target_action) {
1689 $target_action = $c->dispatcher->expand_action($target_action);
1690 if(my $s = $target_action->scheme) {
1695 $class = ref($base);
1698 $class = ref($base);
1701 $base =~ s{(?<!/)$}{/};
1705 if (my @keys = keys %$params) {
1706 # somewhat lifted from URI::_query's query_form
1707 $query = '?'.join('&', map {
1708 my $val = $params->{$_};
1709 #s/([;\/?:@&=+,\$\[\]%])/$URI::Escape::escapes{$1}/go; ## Commented out because seems to lead to double encoding - JNAP
1712 $val = '' unless defined $val;
1715 $param = encode_utf8($param);
1716 # using the URI::Escape pattern here so utf8 chars survive
1717 $param =~ s/([^A-Za-z0-9\-_.!~*'() ])/$URI::Escape::escapes{$1}/go;
1720 $key = encode_utf8($key);
1721 # using the URI::Escape pattern here so utf8 chars survive
1722 $key =~ s/([^A-Za-z0-9\-_.!~*'() ])/$URI::Escape::escapes{$1}/go;
1725 "${key}=$param"; } ( ref $val eq 'ARRAY' ? @$val : $val ));
1729 $base = encode_utf8 $base;
1730 $base =~ s/([^$URI::uric])/$URI::Escape::escapes{$1}/go;
1731 $args = encode_utf8 $args;
1732 $args =~ s/([^$URI::uric])/$URI::Escape::escapes{$1}/go;
1734 if(defined $fragment) {
1736 $fragment = encode_utf8(${$fragment});
1737 $fragment =~ s/([^A-Za-z0-9\-_.!~*'() ])/$URI::Escape::escapes{$1}/go;
1738 $fragment =~ s/ /+/g;
1740 $query .= "#$fragment";
1743 my $res = bless(\"${base}${args}${query}", $class);
1747 =head2 $c->uri_for_action( $path, \@captures_and_args?, @args?, \%query_values? )
1749 =head2 $c->uri_for_action( $action, \@captures_and_args?, @args?, \%query_values? )
1755 A private path to the Catalyst action you want to create a URI for.
1757 This is a shortcut for calling C<< $c->dispatcher->get_action_by_path($path)
1758 >> and passing the resulting C<$action> and the remaining arguments to C<<
1761 You can also pass in a Catalyst::Action object, in which case it is passed to
1764 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.
1766 For example, if the action looks like:
1768 package MyApp::Controller::Users;
1770 sub lst : Path('the-list') {}
1774 $c->uri_for_action('/users/lst')
1776 and it will create the URI /users/the-list.
1778 =item \@captures_and_args?
1780 Optional array reference of Captures (i.e. C<<CaptureArgs or $c->req->captures>)
1781 and arguments to the request. Usually used with L<Catalyst::DispatchType::Chained>
1782 to interpolate all the parameters in the URI.
1786 Optional list of extra arguments - can be supplied in the
1787 C<< \@captures_and_args? >> array ref, or here - whichever is easier for your
1790 Your action can have zero, a fixed or a variable number of args (e.g.
1791 C<< Args(1) >> for a fixed number or C<< Args() >> for a variable number)..
1793 =item \%query_values?
1795 Optional array reference of query parameters to append. E.g.
1801 /rest/of/your/uri?foo=bar
1807 sub uri_for_action {
1808 my ( $c, $path, @args ) = @_;
1809 my $action = blessed($path)
1811 : $c->dispatcher->get_action_by_path($path);
1812 unless (defined $action) {
1813 croak "Can't find action for path '$path'";
1815 return $c->uri_for( $action, @args );
1818 =head2 $c->welcome_message
1820 Returns the Catalyst welcome HTML page.
1824 sub welcome_message {
1826 my $name = $c->config->{name};
1827 my $logo = $c->uri_for('/static/images/catalyst_logo.png');
1828 my $prefix = Catalyst::Utils::appprefix( ref $c );
1829 $c->response->content_type('text/html; charset=utf-8');
1831 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
1832 "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
1833 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
1835 <meta http-equiv="Content-Language" content="en" />
1836 <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
1837 <title>$name on Catalyst $VERSION</title>
1838 <style type="text/css">
1841 background-color: #eee;
1848 margin-bottom: 10px;
1850 background-color: #ccc;
1851 border: 1px solid #aaa;
1856 font-family: verdana, tahoma, sans-serif;
1859 font-family: verdana, tahoma, sans-serif;
1862 text-decoration: none;
1864 border-bottom: 1px dotted #bbb;
1866 :link:hover, :visited:hover {
1879 background-color: #fff;
1880 border: 1px solid #aaa;
1884 font-weight: normal;
1906 <h1><span id="appname">$name</span> on <a href="http://catalyst.perl.org">Catalyst</a>
1911 <img src="$logo" alt="Catalyst Logo" />
1913 <p>Welcome to the world of Catalyst.
1914 This <a href="http://en.wikipedia.org/wiki/MVC">MVC</a>
1915 framework will make web development something you had
1916 never expected it to be: Fun, rewarding, and quick.</p>
1917 <h2>What to do now?</h2>
1918 <p>That really depends on what <b>you</b> want to do.
1919 We do, however, provide you with a few starting points.</p>
1920 <p>If you want to jump right into web development with Catalyst
1921 you might want to start with a tutorial.</p>
1922 <pre>perldoc <a href="https://metacpan.org/module/Catalyst::Manual::Tutorial">Catalyst::Manual::Tutorial</a></code>
1924 <p>Afterwards you can go on to check out a more complete look at our features.</p>
1926 <code>perldoc <a href="https://metacpan.org/module/Catalyst::Manual::Intro">Catalyst::Manual::Intro</a>
1927 <!-- Something else should go here, but the Catalyst::Manual link seems unhelpful -->
1929 <h2>What to do next?</h2>
1930 <p>Next it's time to write an actual application. Use the
1931 helper scripts to generate <a href="https://metacpan.org/search?q=Catalyst%3A%3AController">controllers</a>,
1932 <a href="https://metacpan.org/search?q=Catalyst%3A%3AModel">models</a>, and
1933 <a href="https://metacpan.org/search?q=Catalyst%3A%3AView">views</a>;
1934 they can save you a lot of work.</p>
1935 <pre><code>script/${prefix}_create.pl --help</code></pre>
1936 <p>Also, be sure to check out the vast and growing
1937 collection of <a href="http://search.cpan.org/search?query=Catalyst">plugins for Catalyst on CPAN</a>;
1938 you are likely to find what you need there.
1942 <p>Catalyst has a very active community. Here are the main places to
1943 get in touch with us.</p>
1946 <a href="http://dev.catalyst.perl.org">Wiki</a>
1949 <a href="http://lists.scsys.co.uk/cgi-bin/mailman/listinfo/catalyst">Mailing-List</a>
1952 <a href="irc://irc.perl.org/catalyst">IRC channel #catalyst on irc.perl.org</a>
1955 <h2>In conclusion</h2>
1956 <p>The Catalyst team hopes you will enjoy using Catalyst as much
1957 as we enjoyed making it. Please contact us if you have ideas
1958 for improvement or other feedback.</p>
1968 Contains a hash of options passed from the application script, including
1969 the original ARGV the script received, the processed values from that
1970 ARGV and any extra arguments to the script which were not processed.
1972 This can be used to add custom options to your application's scripts
1973 and setup your application differently depending on the values of these
1976 =head1 INTERNAL METHODS
1978 These methods are not meant to be used by end users.
1980 =head2 $c->components
1982 Returns a hash of components.
1984 =head2 $c->context_class
1986 Returns or sets the context class.
1990 Returns a hashref containing coderefs and execution counts (needed for
1991 deep recursion detection).
1995 Returns the number of actions on the current internal execution stack.
1999 Dispatches a request to actions.
2003 sub dispatch { my $c = shift; $c->dispatcher->dispatch( $c, @_ ) }
2005 =head2 $c->dispatcher_class
2007 Returns or sets the dispatcher class.
2009 =head2 $c->dump_these
2011 Returns a list of 2-element array references (name, structure) pairs
2012 that will be dumped on the error page in debug mode.
2018 [ Request => $c->req ],
2019 [ Response => $c->res ],
2020 [ Stash => $c->stash ],
2021 [ Config => $c->config ];
2024 =head2 $c->engine_class
2026 Returns or sets the engine class.
2028 =head2 $c->execute( $class, $coderef )
2030 Execute a coderef in given class and catch exceptions. Errors are available
2036 my ( $c, $class, $code ) = @_;
2037 $class = $c->component($class) || $class;
2040 if ( $c->depth >= $RECURSION ) {
2041 my $action = $code->reverse();
2042 $action = "/$action" unless $action =~ /->/;
2043 my $error = qq/Deep recursion detected calling "${action}"/;
2044 $c->log->error($error);
2050 my $stats_info = $c->_stats_start_execute( $code ) if $c->use_stats;
2052 push( @{ $c->stack }, $code );
2054 no warnings 'recursion';
2055 # N.B. This used to be combined, but I have seen $c get clobbered if so, and
2056 # I have no idea how, ergo $ret (which appears to fix the issue)
2057 eval { my $ret = $code->execute( $class, $c, @{ $c->req->args } ) || 0; $c->state( $ret ) };
2059 $c->_stats_finish_execute( $stats_info ) if $c->use_stats and $stats_info;
2061 my $last = pop( @{ $c->stack } );
2063 if ( my $error = $@ ) {
2064 #rethow if this can be handled by middleware
2065 if ( $c->_handle_http_exception($error) ) {
2066 foreach my $err (@{$c->error}) {
2067 $c->log->error($err);
2070 $c->log->_flush if $c->log->can('_flush');
2072 $error->can('rethrow') ? $error->rethrow : croak $error;
2074 if ( blessed($error) and $error->isa('Catalyst::Exception::Detach') ) {
2075 $error->rethrow if $c->depth > 1;
2077 elsif ( blessed($error) and $error->isa('Catalyst::Exception::Go') ) {
2078 $error->rethrow if $c->depth > 0;
2081 unless ( ref $error ) {
2082 no warnings 'uninitialized';
2084 my $class = $last->class;
2085 my $name = $last->name;
2086 $error = qq/Caught exception in $class->$name "$error"/;
2095 sub _stats_start_execute {
2096 my ( $c, $code ) = @_;
2097 my $appclass = ref($c) || $c;
2098 return if ( ( $code->name =~ /^_.*/ )
2099 && ( !$appclass->config->{show_internal_actions} ) );
2101 my $action_name = $code->reverse();
2102 $c->counter->{$action_name}++;
2104 my $action = $action_name;
2105 $action = "/$action" unless $action =~ /->/;
2107 # determine if the call was the result of a forward
2108 # this is done by walking up the call stack and looking for a calling
2109 # sub of Catalyst::forward before the eval
2111 for my $index ( 2 .. 11 ) {
2113 if ( ( caller($index) )[0] eq 'Catalyst'
2114 && ( caller($index) )[3] eq '(eval)' );
2116 if ( ( caller($index) )[3] =~ /forward$/ ) {
2117 $callsub = ( caller($index) )[3];
2118 $action = "-> $action";
2123 my $uid = $action_name . $c->counter->{$action_name};
2125 # is this a root-level call or a forwarded call?
2126 if ( $callsub =~ /forward$/ ) {
2127 my $parent = $c->stack->[-1];
2129 # forward, locate the caller
2130 if ( defined $parent && exists $c->counter->{"$parent"} ) {
2133 parent => "$parent" . $c->counter->{"$parent"},
2139 # forward with no caller may come from a plugin
2158 sub _stats_finish_execute {
2159 my ( $c, $info ) = @_;
2160 $c->stats->profile( end => $info );
2165 Finalizes the request.
2172 for my $error ( @{ $c->error } ) {
2173 $c->log->error($error);
2176 # Support skipping finalize for psgix.io style 'jailbreak'. Used to support
2177 # stuff like cometd and websockets
2179 if($c->request->_has_io_fh) {
2184 # Allow engine to handle finalize flow (for POE)
2185 my $engine = $c->engine;
2186 if ( my $code = $engine->can('finalize') ) {
2191 $c->finalize_uploads;
2194 if ( $#{ $c->error } >= 0 ) {
2198 $c->finalize_encoding;
2199 $c->finalize_headers unless $c->response->finalized_headers;
2205 if ($c->use_stats) {
2206 my $elapsed = $c->stats->elapsed;
2207 my $av = $elapsed == 0 ? '??' : sprintf '%.3f', 1 / $elapsed;
2209 "Request took ${elapsed}s ($av/s)\n" . $c->stats->report . "\n" );
2212 return $c->response->status;
2215 =head2 $c->finalize_body
2221 sub finalize_body { my $c = shift; $c->engine->finalize_body( $c, @_ ) }
2223 =head2 $c->finalize_cookies
2229 sub finalize_cookies { my $c = shift; $c->engine->finalize_cookies( $c, @_ ) }
2231 =head2 $c->finalize_error
2233 Finalizes error. If there is only one error in L</error> and it is an object that
2234 does C<as_psgi> or C<code> we rethrow the error and presume it caught by middleware
2235 up the ladder. Otherwise we return the debugging error page (in debug mode) or we
2236 return the default error page (production mode).
2240 sub finalize_error {
2242 if($#{$c->error} > 0) {
2243 $c->engine->finalize_error( $c, @_ );
2245 my ($error) = @{$c->error};
2246 if ( $c->_handle_http_exception($error) ) {
2247 # In the case where the error 'knows what it wants', becauses its PSGI
2248 # aware, just rethow and let middleware catch it
2249 $error->can('rethrow') ? $error->rethrow : croak $error;
2251 $c->engine->finalize_error( $c, @_ )
2256 =head2 $c->finalize_headers
2262 sub finalize_headers {
2265 my $response = $c->response; #accessor calls can add up?
2267 # Check if we already finalized headers
2268 return if $response->finalized_headers;
2271 if ( my $location = $response->redirect ) {
2272 $c->log->debug(qq/Redirecting to "$location"/) if $c->debug;
2273 $response->header( Location => $location );
2276 # Remove incorrectly added body and content related meta data when returning
2277 # an information response, or a response the is required to not include a body
2279 $c->finalize_cookies;
2281 # This currently is a NOOP but I don't want to remove it since I guess people
2282 # might have Response subclasses that use it for something... (JNAP)
2283 $c->response->finalize_headers();
2286 $response->finalized_headers(1);
2289 =head2 $c->finalize_encoding
2291 Make sure your body is encoded properly IF you set an encoding. By
2292 default the encoding is UTF-8 but you can disable it by explicitly setting the
2293 encoding configuration value to undef.
2295 We can only encode when the body is a scalar. Methods for encoding via the
2296 streaming interfaces (such as C<write> and C<write_fh> on L<Catalyst::Response>
2303 sub finalize_encoding {
2305 my $res = $c->res || return;
2307 # Warn if the set charset is different from the one you put into encoding. We need
2308 # to do this early since encodable_response is false for this condition and we need
2309 # to match the debug output for backcompat (there's a test for this...) -JNAP
2311 $res->content_type_charset and $c->encoding and
2312 (uc($c->encoding->mime_name) ne uc($res->content_type_charset))
2314 my $ct = lc($res->content_type_charset);
2315 $c->log->debug("Catalyst encoding config is set to encode in '" .
2316 $c->encoding->mime_name .
2317 "', content type is '$ct', not encoding ");
2321 ($res->encodable_response) and
2322 (defined($res->body)) and
2323 (ref(\$res->body) eq 'SCALAR')
2325 # if you are finding yourself here and your body is already encoded correctly
2326 # and you want to turn this off, use $c->clear_encoding to prevent encoding
2327 # at this step, or set encoding to undef in the config to do so for the whole
2328 # application. See the ENCODING documentaiton for better notes.
2329 $c->res->body( $c->encoding->encode( $c->res->body, $c->_encode_check ) );
2331 # Set the charset if necessary. This might be a bit bonkers since encodable response
2332 # is false when the set charset is not the same as the encoding mimetype (maybe
2333 # confusing action at a distance here..
2334 # Don't try to set the charset if one already exists or if headers are already finalized
2335 $c->res->content_type($c->res->content_type . "; charset=" . $c->encoding->mime_name)
2336 unless($c->res->content_type_charset ||
2337 ($c->res->_context && $c->res->finalized_headers && !$c->res->_has_response_cb));
2341 =head2 $c->finalize_output
2343 An alias for finalize_body.
2345 =head2 $c->finalize_read
2347 Finalizes the input after reading is complete.
2351 sub finalize_read { my $c = shift; $c->engine->finalize_read( $c, @_ ) }
2353 =head2 $c->finalize_uploads
2355 Finalizes uploads. Cleans up any temporary files.
2359 sub finalize_uploads { my $c = shift; $c->engine->finalize_uploads( $c, @_ ) }
2361 =head2 $c->get_action( $action, $namespace )
2363 Gets an action in a given namespace.
2367 sub get_action { my $c = shift; $c->dispatcher->get_action(@_) }
2369 =head2 $c->get_actions( $action, $namespace )
2371 Gets all actions of a given name in a namespace and all parent
2376 sub get_actions { my $c = shift; $c->dispatcher->get_actions( $c, @_ ) }
2378 =head2 $app->handle_request( @arguments )
2380 Called to handle each HTTP request.
2384 sub handle_request {
2385 my ( $class, @arguments ) = @_;
2387 # Always expect worst case!
2390 if ($class->debug) {
2391 my $secs = time - $START || 1;
2392 my $av = sprintf '%.3f', $COUNT / $secs;
2393 my $time = localtime time;
2394 $class->log->info("*** Request $COUNT ($av/s) [$$] [$time] ***");
2397 my $c = $class->prepare(@arguments);
2399 $status = $c->finalize;
2401 #rethow if this can be handled by middleware
2402 if ( $class->_handle_http_exception($_) ) {
2403 $_->can('rethrow') ? $_->rethrow : croak $_;
2405 chomp(my $error = $_);
2406 $class->log->error(qq/Caught exception in engine "$error"/);
2411 if(my $coderef = $class->log->can('_flush')){
2412 $class->log->$coderef();
2417 =head2 $class->prepare( @arguments )
2419 Creates a Catalyst context from an engine-specific request (Apache, CGI,
2426 predicate => '_has_uploadtmp',
2430 my ( $class, @arguments ) = @_;
2433 # After the app/ctxt split, this should become an attribute based on something passed
2434 # into the application.
2435 $class->context_class( ref $class || $class ) unless $class->context_class;
2437 my $uploadtmp = $class->config->{uploadtmp};
2438 my $c = $class->context_class->new({ $uploadtmp ? (_uploadtmp => $uploadtmp) : ()});
2440 $c->response->_context($c);
2441 $c->stats($class->stats_class->new)->enable($c->use_stats);
2443 if ( $c->debug || $c->config->{enable_catalyst_header} ) {
2444 $c->res->headers->header( 'X-Catalyst' => $Catalyst::VERSION );
2448 # Allow engine to direct the prepare flow (for POE)
2449 if ( my $prepare = $c->engine->can('prepare') ) {
2450 $c->engine->$prepare( $c, @arguments );
2453 $c->prepare_request(@arguments);
2454 $c->prepare_connection;
2455 $c->prepare_query_parameters;
2456 $c->prepare_headers; # Just hooks, no longer needed - they just
2457 $c->prepare_cookies; # cause the lazy attribute on req to build
2460 # Prepare the body for reading, either by prepare_body
2461 # or the user, if they are using $c->read
2464 # Parse the body unless the user wants it on-demand
2465 unless ( ref($c)->config->{parse_on_demand} ) {
2471 # VERY ugly and probably shouldn't rely on ->finalize actually working
2473 # failed prepare is always due to an invalid request, right?
2474 # Note we call finalize and then die here, which escapes
2475 # finalize being called in the enclosing block..
2476 # It in fact couldn't be called, as we don't return $c..
2477 # This is a mess - but I'm unsure you can fix this without
2478 # breaking compat for people doing crazy things (we should set
2479 # the 400 and just return the ctx here IMO, letting finalize get called
2481 if ( $c->_handle_http_exception($_) ) {
2482 foreach my $err (@{$c->error}) {
2483 $c->log->error($err);
2486 $c->log->_flush if $c->log->can('_flush');
2487 $_->can('rethrow') ? $_->rethrow : croak $_;
2489 $c->response->status(400);
2490 $c->response->content_type('text/plain');
2491 $c->response->body('Bad Request');
2498 $c->{stash} = $c->stash;
2499 Scalar::Util::weaken($c->{stash});
2504 =head2 $c->prepare_action
2506 Prepares action. See L<Catalyst::Dispatcher>.
2510 sub prepare_action {
2512 my $ret = $c->dispatcher->prepare_action( $c, @_);
2515 foreach (@{$c->req->arguments}, @{$c->req->captures}) {
2516 $_ = $c->_handle_param_unicode_decoding($_);
2524 =head2 $c->prepare_body
2526 Prepares message body.
2533 return if $c->request->_has_body;
2535 # Initialize on-demand data
2536 $c->engine->prepare_body( $c, @_ );
2537 $c->prepare_parameters;
2538 $c->prepare_uploads;
2541 =head2 $c->prepare_body_chunk( $chunk )
2543 Prepares a chunk of data before sending it to L<HTTP::Body>.
2545 See L<Catalyst::Engine>.
2549 sub prepare_body_chunk {
2551 $c->engine->prepare_body_chunk( $c, @_ );
2554 =head2 $c->prepare_body_parameters
2556 Prepares body parameters.
2560 sub prepare_body_parameters {
2562 $c->request->prepare_body_parameters( $c, @_ );
2565 =head2 $c->prepare_connection
2567 Prepares connection.
2571 sub prepare_connection {
2573 $c->request->prepare_connection($c);
2576 =head2 $c->prepare_cookies
2578 Prepares cookies by ensuring that the attribute on the request
2579 object has been built.
2583 sub prepare_cookies { my $c = shift; $c->request->cookies }
2585 =head2 $c->prepare_headers
2587 Prepares request headers by ensuring that the attribute on the request
2588 object has been built.
2592 sub prepare_headers { my $c = shift; $c->request->headers }
2594 =head2 $c->prepare_parameters
2596 Prepares parameters.
2600 sub prepare_parameters {
2602 $c->prepare_body_parameters;
2603 $c->engine->prepare_parameters( $c, @_ );
2606 =head2 $c->prepare_path
2608 Prepares path and base.
2612 sub prepare_path { my $c = shift; $c->engine->prepare_path( $c, @_ ) }
2614 =head2 $c->prepare_query_parameters
2616 Prepares query parameters.
2620 sub prepare_query_parameters {
2623 $c->engine->prepare_query_parameters( $c, @_ );
2626 =head2 $c->log_request
2628 Writes information about the request to the debug logs. This includes:
2632 =item * Request method, path, and remote IP address
2634 =item * Query keywords (see L<Catalyst::Request/query_keywords>)
2636 =item * Request parameters
2638 =item * File uploads
2647 return unless $c->debug;
2649 my($dump) = grep {$_->[0] eq 'Request' } $c->dump_these;
2650 my $request = $dump->[1];
2652 my ( $method, $path, $address ) = ( $request->method, $request->path, $request->address );
2654 $path = '/' unless length $path;
2657 $path =~ s/%([0-9A-Fa-f]{2})/chr(hex($1))/eg;
2658 $path = decode_utf8($path);
2660 $c->log->debug(qq/"$method" request for "$path" from "$address"/);
2662 $c->log_request_headers($request->headers);
2664 if ( my $keywords = $request->query_keywords ) {
2665 $c->log->debug("Query keywords are: $keywords");
2668 $c->log_request_parameters( query => $request->query_parameters, $request->_has_body ? (body => $request->body_parameters) : () );
2670 $c->log_request_uploads($request);
2673 =head2 $c->log_response
2675 Writes information about the response to the debug logs by calling
2676 C<< $c->log_response_status_line >> and C<< $c->log_response_headers >>.
2683 return unless $c->debug;
2685 my($dump) = grep {$_->[0] eq 'Response' } $c->dump_these;
2686 my $response = $dump->[1];
2688 $c->log_response_status_line($response);
2689 $c->log_response_headers($response->headers);
2692 =head2 $c->log_response_status_line($response)
2694 Writes one line of information about the response to the debug logs. This includes:
2698 =item * Response status code
2700 =item * Content-Type header (if present)
2702 =item * Content-Length header (if present)
2708 sub log_response_status_line {
2709 my ($c, $response) = @_;
2713 'Response Code: %s; Content-Type: %s; Content-Length: %s',
2714 $response->status || 'unknown',
2715 $response->headers->header('Content-Type') || 'unknown',
2716 $response->headers->header('Content-Length') || 'unknown'
2721 =head2 $c->log_response_headers($headers);
2723 Hook method which can be wrapped by plugins to log the response headers.
2724 No-op in the default implementation.
2728 sub log_response_headers {}
2730 =head2 $c->log_request_parameters( query => {}, body => {} )
2732 Logs request parameters to debug logs
2736 sub log_request_parameters {
2738 my %all_params = @_;
2740 return unless $c->debug;
2742 my $column_width = Catalyst::Utils::term_width() - 44;
2743 foreach my $type (qw(query body)) {
2744 my $params = $all_params{$type};
2745 next if ! keys %$params;
2746 my $t = Text::SimpleTable->new( [ 35, 'Parameter' ], [ $column_width, 'Value' ] );
2747 for my $key ( sort keys %$params ) {
2749 if(ref $params eq 'Hash::MultiValue') {
2750 @values = $params->get_all($key);
2752 my $param = $params->{$key};
2753 if( defined($param) ) {
2754 @values = ref $param eq 'ARRAY' ? @$param : $param;
2757 $t->row( $key.( scalar @values > 1 ? ' [multiple]' : ''), join(', ', @values) );
2759 $c->log->debug( ucfirst($type) . " Parameters are:\n" . $t->draw );
2763 =head2 $c->log_request_uploads
2765 Logs file uploads included in the request to the debug logs.
2766 The parameter name, filename, file type, and file size are all included in
2771 sub log_request_uploads {
2773 my $request = shift;
2774 return unless $c->debug;
2775 my $uploads = $request->uploads;
2776 if ( keys %$uploads ) {
2777 my $t = Text::SimpleTable->new(
2778 [ 12, 'Parameter' ],
2783 for my $key ( sort keys %$uploads ) {
2784 my $upload = $uploads->{$key};
2785 for my $u ( ref $upload eq 'ARRAY' ? @{$upload} : ($upload) ) {
2786 $t->row( $key, $u->filename, $u->type, $u->size );
2789 $c->log->debug( "File Uploads are:\n" . $t->draw );
2793 =head2 $c->log_request_headers($headers);
2795 Hook method which can be wrapped by plugins to log the request headers.
2796 No-op in the default implementation.
2800 sub log_request_headers {}
2802 =head2 $c->log_headers($type => $headers)
2804 Logs L<HTTP::Headers> (either request or response) to the debug logs.
2811 my $headers = shift; # an HTTP::Headers instance
2813 return unless $c->debug;
2815 my $column_width = Catalyst::Utils::term_width() - 28;
2816 my $t = Text::SimpleTable->new( [ 15, 'Header Name' ], [ $column_width, 'Value' ] );
2819 my ( $name, $value ) = @_;
2820 $t->row( $name, $value );
2823 $c->log->debug( ucfirst($type) . " Headers:\n" . $t->draw );
2827 =head2 $c->prepare_read
2829 Prepares the input for reading.
2833 sub prepare_read { my $c = shift; $c->engine->prepare_read( $c, @_ ) }
2835 =head2 $c->prepare_request
2837 Prepares the engine request.
2841 sub prepare_request { my $c = shift; $c->engine->prepare_request( $c, @_ ) }
2843 =head2 $c->prepare_uploads
2849 sub prepare_uploads {
2851 $c->engine->prepare_uploads( $c, @_ );
2854 =head2 $c->prepare_write
2856 Prepares the output for writing.
2860 sub prepare_write { my $c = shift; $c->engine->prepare_write( $c, @_ ) }
2862 =head2 $c->request_class
2864 Returns or sets the request class. Defaults to L<Catalyst::Request>.
2866 =head2 $app->request_class_traits
2868 An arrayref of L<Moose::Role>s which are applied to the request class. You can
2869 name the full namespace of the role, or a namespace suffix, which will then
2870 be tried against the following standard namespace prefixes.
2872 $MyApp::TraitFor::Request::$trait_suffix
2873 Catalyst::TraitFor::Request::$trait_suffix
2875 So for example if you set:
2877 MyApp->request_class_traits(['Foo']);
2879 We try each possible role in turn (and throw an error if none load)
2882 MyApp::TraitFor::Request::Foo
2883 Catalyst::TraitFor::Request::Foo
2885 The namespace part 'TraitFor::Request' was chosen to assist in backwards
2886 compatibility with L<CatalystX::RoleApplicator> which previously provided
2887 these features in a stand alone package.
2889 =head2 $app->composed_request_class
2891 This is the request class which has been composed with any request_class_traits.
2893 =head2 $c->response_class
2895 Returns or sets the response class. Defaults to L<Catalyst::Response>.
2897 =head2 $app->response_class_traits
2899 An arrayref of L<Moose::Role>s which are applied to the response class. You can
2900 name the full namespace of the role, or a namespace suffix, which will then
2901 be tried against the following standard namespace prefixes.
2903 $MyApp::TraitFor::Response::$trait_suffix
2904 Catalyst::TraitFor::Response::$trait_suffix
2906 So for example if you set:
2908 MyApp->response_class_traits(['Foo']);
2910 We try each possible role in turn (and throw an error if none load)
2913 MyApp::TraitFor::Response::Foo
2914 Catalyst::TraitFor::Responset::Foo
2916 The namespace part 'TraitFor::Response' was chosen to assist in backwards
2917 compatibility with L<CatalystX::RoleApplicator> which previously provided
2918 these features in a stand alone package.
2921 =head2 $app->composed_response_class
2923 This is the request class which has been composed with any response_class_traits.
2925 =head2 $c->read( [$maxlength] )
2927 Reads a chunk of data from the request body. This method is designed to
2928 be used in a while loop, reading C<$maxlength> bytes on every call.
2929 C<$maxlength> defaults to the size of the request if not specified.
2931 You have to set C<< MyApp->config(parse_on_demand => 1) >> to use this
2934 Warning: If you use read(), Catalyst will not process the body,
2935 so you will not be able to access POST parameters or file uploads via
2936 $c->request. You must handle all body parsing yourself.
2940 sub read { my $c = shift; return $c->request->read( @_ ) }
2950 $app->_make_immutable_if_needed;
2951 $app->engine_loader->needs_psgi_engine_compat_hack ?
2952 $app->engine->run($app, @_) :
2953 $app->engine->run( $app, $app->_finalized_psgi_app, @_ );
2956 sub _make_immutable_if_needed {
2958 my $meta = find_meta($class);
2959 my $isa_ca = $class->isa('Class::Accessor::Fast') || $class->isa('Class::Accessor');
2962 && ! { $meta->immutable_options }->{replace_constructor}
2965 warn("You made your application class ($class) immutable, "
2966 . "but did not inline the\nconstructor. "
2967 . "This will break catalyst, as your app \@ISA "
2968 . "Class::Accessor(::Fast)?\nPlease pass "
2969 . "(replace_constructor => 1)\nwhen making your class immutable.\n");
2971 unless ($meta->is_immutable) {
2972 # XXX - FIXME warning here as you should make your app immutable yourself.
2973 $meta->make_immutable(
2974 replace_constructor => 1,
2979 =head2 $c->set_action( $action, $code, $namespace, $attrs )
2981 Sets an action in a given namespace.
2985 sub set_action { my $c = shift; $c->dispatcher->set_action( $c, @_ ) }
2987 =head2 $c->setup_actions($component)
2989 Sets up actions for a component.
2993 sub setup_actions { my $c = shift; $c->dispatcher->setup_actions( $c, @_ ) }
2995 =head2 $c->setup_components
2997 This method is called internally to set up the application's components.
2999 It finds modules by calling the L<locate_components> method, expands them to
3000 package names with the L<expand_component_module> method, and then installs
3001 each component into the application.
3003 The C<setup_components> config option is passed to both of the above methods.
3005 Installation of each component is performed by the L<setup_component> method,
3010 sub setup_components {
3013 my $config = $class->config->{ setup_components };
3015 my @comps = $class->locate_components($config);
3016 my %comps = map { $_ => 1 } @comps;
3018 my $deprecatedcatalyst_component_names = grep { /::[CMV]::/ } @comps;
3019 $class->log->warn(qq{Your application is using the deprecated ::[MVC]:: type naming scheme.\n}.
3020 qq{Please switch your class names to ::Model::, ::View:: and ::Controller: as appropriate.\n}
3021 ) if $deprecatedcatalyst_component_names;
3023 for my $component ( @comps ) {
3025 # We pass ignore_loaded here so that overlay files for (e.g.)
3026 # Model::DBI::Schema sub-classes are loaded - if it's in @comps
3027 # we know M::P::O found a file on disk so this is safe
3029 Catalyst::Utils::ensure_class_loaded( $component, { ignore_loaded => 1 } );
3032 for my $component (@comps) {
3033 my $instance = $class->components->{ $component } = $class->delayed_setup_component($component);
3036 # Inject a component or wrap a stand alone class in an adaptor. This makes a list
3037 # of named components in the configuration that are not actually existing (not a
3040 my @injected = $class->setup_injected_components;
3042 # All components are registered, now we need to 'init' them.
3043 foreach my $component_name (@comps, @injected) {
3044 $class->components->{$component_name} = $class->components->{$component_name}->() if
3045 (ref($class->components->{$component_name}) || '') eq 'CODE';
3049 =head2 $app->setup_injected_components
3051 Called by setup_compoents to setup components that are injected.
3055 sub setup_injected_components {
3057 my @injected_components = keys %{$class->config->{inject_components} ||+{}};
3059 foreach my $injected_comp_name(@injected_components) {
3060 $class->setup_injected_component(
3061 $injected_comp_name,
3062 $class->config->{inject_components}->{$injected_comp_name});
3065 return map { $class ."::" . $_ }
3066 @injected_components;
3069 =head2 $app->setup_injected_component( $injected_component_name, $config )
3071 Setup a given injected component.
3075 sub setup_injected_component {
3076 my ($class, $injected_comp_name, $config) = @_;
3077 if(my $component_class = $config->{from_component}) {
3078 my @roles = @{$config->{roles} ||[]};
3079 Catalyst::Utils::inject_component(
3081 component => $component_class,
3082 (scalar(@roles) ? (traits => \@roles) : ()),
3083 as => $injected_comp_name);
3087 =head2 $app->inject_component($MyApp_Component_name => \%args);
3089 Add a component that is injected at setup:
3091 MyApp->inject_component( 'Model::Foo' => { from_component => 'Common::Foo' } );
3093 Must be called before ->setup. Expects a component name for your
3094 current application and \%args where
3098 =item from_component
3100 The target component being injected into your application
3104 An arrayref of L<Moose::Role>s that are applied to your component.
3110 MyApp->inject_component(
3112 from_component => 'Common::Model::Foo',
3113 roles => ['Role1', 'Role2'],
3116 =head2 $app->inject_components
3118 Inject a list of components:
3120 MyApp->inject_components(
3121 'Model::FooOne' => {
3122 from_component => 'Common::Model::Foo',
3123 roles => ['Role1', 'Role2'],
3125 'Model::FooTwo' => {
3126 from_component => 'Common::Model::Foo',
3127 roles => ['Role1', 'Role2'],
3132 sub inject_component {
3133 my ($app, $name, $args) = @_;
3134 die "Component $name exists" if
3135 $app->config->{inject_components}->{$name};
3136 $app->config->{inject_components}->{$name} = $args;
3139 sub inject_components {
3142 $app->inject_component(shift, shift);
3146 =head2 $c->locate_components( $setup_component_config )
3148 This method is meant to provide a list of component modules that should be
3149 setup for the application. By default, it will use L<Module::Pluggable>.
3151 Specify a C<setup_components> config option to pass additional options directly
3152 to L<Module::Pluggable>. To add additional search paths, specify a key named
3153 C<search_extra> as an array reference. Items in the array beginning with C<::>
3154 will have the application class name prepended to them.
3158 sub locate_components {
3162 my @paths = qw( ::M ::Model ::V ::View ::C ::Controller );
3163 my $extra = $config->{ search_extra } || [];
3165 unshift @paths, @$extra;
3167 my @comps = map { sort { length($a) <=> length($b) } Module::Pluggable::Object->new(
3168 search_path => [ map { s/^(?=::)/$class/; $_; } ($_) ],
3170 )->plugins } @paths;
3175 =head2 $c->expand_component_module( $component, $setup_component_config )
3177 Components found by C<locate_components> will be passed to this method, which
3178 is expected to return a list of component (package) names to be set up.
3182 sub expand_component_module {
3183 my ($class, $module) = @_;
3184 return Devel::InnerPackage::list_packages( $module );
3187 =head2 $app->delayed_setup_component
3189 Returns a coderef that points to a setup_component instance. Used
3190 internally for when you want to delay setup until the first time
3191 the component is called.
3195 sub delayed_setup_component {
3196 my($class, $component, @more) = @_;
3198 return my $instance = $class->setup_component($component, @more);
3202 =head2 $c->setup_component
3206 sub setup_component {
3207 my( $class, $component ) = @_;
3209 unless ( $component->can( 'COMPONENT' ) ) {
3213 my $config = $class->config_for($component);
3214 # Stash catalyst_component_name in the config here, so that custom COMPONENT
3215 # methods also pass it. local to avoid pointlessly shitting in config
3216 # for the debug screen, as $component is already the key name.
3217 local $config->{catalyst_component_name} = $component;
3219 my $instance = eval {
3220 $component->COMPONENT( $class, $config );
3224 Catalyst::Exception->throw(
3225 message => qq/Couldn't instantiate component "$component", "$error"/
3229 unless (blessed $instance) {
3230 my $metaclass = Moose::Util::find_meta($component);
3231 my $method_meta = $metaclass->find_method_by_name('COMPONENT');
3232 my $component_method_from = $method_meta->associated_metaclass->name;
3233 my $value = defined($instance) ? $instance : 'undef';
3234 Catalyst::Exception->throw(
3236 qq/Couldn't instantiate component "$component", COMPONENT() method (from $component_method_from) didn't return an object-like value (value was $value)./
3240 my @expanded_components = $instance->can('expand_modules')
3241 ? $instance->expand_modules( $component, $config )
3242 : $class->expand_component_module( $component, $config );
3243 for my $component (@expanded_components) {
3244 next if $class->components->{ $component };
3245 $class->components->{ $component } = $class->setup_component($component);
3251 =head2 $app->config_for( $component_name )
3253 Return the application level configuration (which is not yet merged with any
3254 local component configuration, via $component_class->config) for the named
3255 component or component object. Example:
3258 'Model::Foo' => { a => 1, b => 2},
3261 my $config = MyApp->config_for('MyApp::Model::Foo');
3263 In this case $config is the hashref C< {a=>1, b=>2} >.
3265 This is also handy for looking up configuration for a plugin, to make sure you follow
3266 existing L<Catalyst> standards for where a plugin should put its configuration.
3271 my ($class, $component_name) = @_;
3272 my $component_suffix = Catalyst::Utils::class2classsuffix($component_name);
3273 my $config = $class->config->{ $component_suffix } || {};
3278 =head2 $c->setup_dispatcher
3284 sub setup_dispatcher {
3285 my ( $class, $dispatcher ) = @_;
3288 $dispatcher = 'Catalyst::Dispatcher::' . $dispatcher;
3291 if ( my $env = Catalyst::Utils::env_value( $class, 'DISPATCHER' ) ) {
3292 $dispatcher = 'Catalyst::Dispatcher::' . $env;
3295 unless ($dispatcher) {
3296 $dispatcher = $class->dispatcher_class;
3299 load_class($dispatcher);
3301 # dispatcher instance
3302 $class->dispatcher( $dispatcher->new );
3305 =head2 $c->setup_engine
3312 my ($class, $requested_engine) = @_;
3314 if (!$class->engine_loader || $requested_engine) {
3315 $class->engine_loader(
3316 Catalyst::EngineLoader->new({
3317 application_name => $class,
3318 (defined $requested_engine
3319 ? (catalyst_engine_class => $requested_engine) : ()),
3324 $class->engine_loader->catalyst_engine_class;
3328 my ($class, $requested_engine) = @_;
3331 my $loader = $class->engine_loader;
3333 if (!$loader || $requested_engine) {
3334 $loader = Catalyst::EngineLoader->new({
3335 application_name => $class,
3336 (defined $requested_engine
3337 ? (requested_engine => $requested_engine) : ()),
3340 $class->engine_loader($loader);
3343 $loader->catalyst_engine_class;
3346 # Don't really setup_engine -- see _setup_psgi_app for explanation.
3347 return if $class->loading_psgi_file;
3349 load_class($engine);
3351 if ($ENV{MOD_PERL}) {
3352 my $apache = $class->engine_loader->auto;
3354 my $meta = find_meta($class);
3355 my $was_immutable = $meta->is_immutable;
3356 my %immutable_options = $meta->immutable_options;
3357 $meta->make_mutable if $was_immutable;
3359 $meta->add_method(handler => sub {
3361 my $psgi_app = $class->_finalized_psgi_app;
3362 $apache->call_app($r, $psgi_app);
3365 $meta->make_immutable(%immutable_options) if $was_immutable;
3368 $class->engine( $engine->new );
3373 ## This exists just to supply a prebuild psgi app for mod_perl and for the
3374 ## build in server support (back compat support for pre psgi port behavior).
3375 ## This is so that we don't build a new psgi app for each request when using
3376 ## the mod_perl handler or the built in servers (http and fcgi, etc).
3378 sub _finalized_psgi_app {
3381 unless ($app->_psgi_app) {
3382 my $psgi_app = $app->_setup_psgi_app;
3383 $app->_psgi_app($psgi_app);
3386 return $app->_psgi_app;
3389 ## Look for a psgi file like 'myapp_web.psgi' (if the app is MyApp::Web) in the
3390 ## home directory and load that and return it (just assume it is doing the
3391 ## right thing :) ). If that does not exist, call $app->psgi_app, wrap that
3392 ## in default_middleware and return it ( this is for backward compatibility
3393 ## with pre psgi port behavior ).
3395 sub _setup_psgi_app {
3398 for my $home (Path::Class::Dir->new($app->config->{home})) {
3399 my $psgi_file = $home->file(
3400 Catalyst::Utils::appprefix($app) . '.psgi',
3403 next unless -e $psgi_file;
3405 # If $psgi_file calls ->setup_engine, it's doing so to load
3406 # Catalyst::Engine::PSGI. But if it does that, we're only going to
3407 # throw away the loaded PSGI-app and load the 5.9 Catalyst::Engine
3408 # anyway. So set a flag (ick) that tells setup_engine not to populate
3409 # $c->engine or do any other things we might regret.
3411 $app->loading_psgi_file(1);
3412 my $psgi_app = Plack::Util::load_psgi($psgi_file);
3413 $app->loading_psgi_file(0);
3416 unless $app->engine_loader->needs_psgi_engine_compat_hack;
3419 Found a legacy Catalyst::Engine::PSGI .psgi file at ${psgi_file}.
3421 Its content has been ignored. Please consult the Catalyst::Upgrading
3422 documentation on how to upgrade from Catalyst::Engine::PSGI.
3426 return $app->apply_default_middlewares($app->psgi_app);
3429 =head2 $c->apply_default_middlewares
3431 Adds the following L<Plack> middlewares to your application, since they are
3432 useful and commonly needed:
3434 L<Plack::Middleware::LighttpdScriptNameFix> (if you are using Lighttpd),
3435 L<Plack::Middleware::IIS6ScriptNameFix> (always applied since this middleware
3436 is smart enough to conditionally apply itself).
3438 We will also automatically add L<Plack::Middleware::ReverseProxy> if we notice
3439 that your HTTP $env variable C<REMOTE_ADDR> is '127.0.0.1'. This is usually
3440 an indication that your server is running behind a proxy frontend. However in
3441 2014 this is often not the case. We preserve this code for backwards compatibility
3442 however I B<highly> recommend that if you are running the server behind a front
3443 end proxy that you clearly indicate so with the C<using_frontend_proxy> configuration
3444 setting to true for your environment configurations that run behind a proxy. This
3445 way if you change your front end proxy address someday your code would inexplicably
3446 stop working as expected.
3448 Additionally if we detect we are using Nginx, we add a bit of custom middleware
3449 to solve some problems with the way that server handles $ENV{PATH_INFO} and
3452 Please B<NOTE> that if you do use C<using_frontend_proxy> the middleware is now
3453 adding via C<registered_middleware> rather than this method.
3455 If you are using Lighttpd or IIS6 you may wish to apply these middlewares. In
3456 general this is no longer a common case but we have this here for backward
3462 sub apply_default_middlewares {
3463 my ($app, $psgi_app) = @_;
3465 # Don't add this conditional IF we are explicitly saying we want the
3466 # frontend proxy support. We don't need it here since if that is the
3467 # case it will be always loaded in the default_middleware.
3469 unless($app->config->{using_frontend_proxy}) {
3470 $psgi_app = Plack::Middleware::Conditional->wrap(
3472 builder => sub { Plack::Middleware::ReverseProxy->wrap($_[0]) },
3475 return if $app->config->{ignore_frontend_proxy};
3476 return $env->{REMOTE_ADDR} eq '127.0.0.1';
3481 # If we're running under Lighttpd, swap PATH_INFO and SCRIPT_NAME
3482 # http://lists.scsys.co.uk/pipermail/catalyst/2006-June/008361.html
3483 $psgi_app = Plack::Middleware::Conditional->wrap(
3485 builder => sub { Plack::Middleware::LighttpdScriptNameFix->wrap($_[0]) },
3488 return unless $env->{SERVER_SOFTWARE} && $env->{SERVER_SOFTWARE} =~ m!lighttpd[-/]1\.(\d+\.\d+)!;
3489 return unless $1 < 4.23;
3494 # we're applying this unconditionally as the middleware itself already makes
3495 # sure it doesn't fuck things up if it's not running under one of the right
3497 $psgi_app = Plack::Middleware::IIS6ScriptNameFix->wrap($psgi_app);
3499 # And another IIS issue, this time with IIS7.
3500 $psgi_app = Plack::Middleware::Conditional->wrap(
3502 builder => sub { Plack::Middleware::IIS7KeepAliveFix->wrap($_[0]) },
3505 return $env->{SERVER_SOFTWARE} && $env->{SERVER_SOFTWARE} =~ m!IIS/7\.[0-9]!;
3512 =head2 App->psgi_app
3516 Returns a PSGI application code reference for the catalyst application
3517 C<$c>. This is the bare application created without the C<apply_default_middlewares>
3518 method called. We do however apply C<registered_middleware> since those are
3519 integral to how L<Catalyst> functions. Also, unlike starting your application
3520 with a generated server script (via L<Catalyst::Devel> and C<catalyst.pl>) we do
3521 not attempt to return a valid L<PSGI> application using any existing C<${myapp}.psgi>
3522 scripts in your $HOME directory.
3524 B<NOTE> C<apply_default_middlewares> was originally created when the first PSGI
3525 port was done for v5.90000. These are middlewares that are added to achieve
3526 backward compatibility with older applications. If you start your application
3527 using one of the supplied server scripts (generated with L<Catalyst::Devel> and
3528 the project skeleton script C<catalyst.pl>) we apply C<apply_default_middlewares>
3529 automatically. This was done so that pre and post PSGI port applications would
3532 This is what you want to be using to retrieve the PSGI application code
3533 reference of your Catalyst application for use in a custom F<.psgi> or in your
3534 own created server modules.
3538 *to_app = \&psgi_app;
3542 my $psgi = $app->engine->build_psgi_app($app);
3543 return $app->Catalyst::Utils::apply_registered_middleware($psgi);
3546 =head2 $c->setup_home
3548 Sets up the home directory.
3553 my ( $class, $home ) = @_;
3555 if ( my $env = Catalyst::Utils::env_value( $class, 'HOME' ) ) {
3559 $home ||= Catalyst::Utils::home($class);
3562 #I remember recently being scolded for assigning config values like this
3563 $class->config->{home} ||= $home;
3564 $class->config->{root} ||= Path::Class::Dir->new($home)->subdir('root');
3568 =head2 $c->setup_encoding
3570 Sets up the input/output encoding. See L<ENCODING>
3574 sub setup_encoding {
3576 if( exists($c->config->{encoding}) && !defined($c->config->{encoding}) ) {
3577 # Ok, so the user has explicitly said "I don't want encoding..."
3580 my $enc = defined($c->config->{encoding}) ?
3581 delete $c->config->{encoding} : 'UTF-8'; # not sure why we delete it... (JNAP)
3586 =head2 handle_unicode_encoding_exception
3588 Hook to let you customize how encoding errors are handled. By default
3589 we just throw an exception and the default error page will pick it up.
3590 Receives a hashref of debug information. Example of call (from the
3591 Catalyst internals):
3593 my $decoded_after_fail = $c->handle_unicode_encoding_exception({
3594 param_value => $value,
3596 encoding_step => 'params',
3599 The calling code expects to receive a decoded string or an exception.
3601 You can override this for custom handling of unicode errors. By
3602 default we just die. If you want a custom response here, one approach
3603 is to throw an HTTP style exception, instead of returning a decoded
3604 string or throwing a generic exception.
3606 sub handle_unicode_encoding_exception {
3607 my ($c, $params) = @_;
3608 HTTP::Exception::BAD_REQUEST->throw(status_message=>$params->{error_msg});
3611 Alternatively you can 'catch' the error, stash it and write handling code later
3612 in your application:
3614 sub handle_unicode_encoding_exception {
3615 my ($c, $params) = @_;
3616 $c->stash(BAD_UNICODE_DATA=>$params);
3617 # return a dummy string.
3621 <B>NOTE:</b> Please keep in mind that once an error like this occurs,
3622 the request setup is still ongoing, which means the state of C<$c> and
3623 related context parts like the request and response may not be setup
3624 up correctly (since we haven't finished the setup yet). If you throw
3625 an exception the setup is aborted.
3629 sub handle_unicode_encoding_exception {
3630 my ( $self, $exception_ctx ) = @_;
3631 die $exception_ctx->{error_msg};
3634 # Some unicode helpers cargo culted from the old plugin. These could likely
3637 sub _handle_unicode_decoding {
3638 my ( $self, $value ) = @_;
3640 return unless defined $value;
3642 ## I think this mess is to support the old nested
3643 if ( ref $value eq 'ARRAY' ) {
3644 foreach ( @$value ) {
3645 $_ = $self->_handle_unicode_decoding($_);
3649 elsif ( ref $value eq 'HASH' ) {
3650 foreach (keys %$value) {
3651 my $encoded_key = $self->_handle_param_unicode_decoding($_);
3652 $value->{$encoded_key} = $self->_handle_unicode_decoding($value->{$_});
3654 # If the key was encoded we now have two (the original and current so
3655 # delete the original.
3656 delete $value->{$_} if $_ ne $encoded_key;
3661 return $self->_handle_param_unicode_decoding($value);
3665 sub _handle_param_unicode_decoding {
3666 my ( $self, $value, $check ) = @_;
3667 return unless defined $value; # not in love with just ignoring undefs - jnap
3668 return $value if blessed($value); #don't decode when the value is an object.
3670 my $enc = $self->encoding;
3672 return $value unless $enc; # don't decode if no encoding is specified
3674 $check ||= $self->_encode_check;
3676 $enc->decode( $value, $check);
3679 return $self->handle_unicode_encoding_exception({
3680 param_value => $value,
3682 encoding_step => 'params',
3687 =head2 $c->setup_log
3689 Sets up log by instantiating a L<Catalyst::Log|Catalyst::Log> object and
3690 passing it to C<log()>. Pass in a comma-delimited list of levels to set the
3693 This method also installs a C<debug> method that returns a true value into the
3694 catalyst subclass if the "debug" level is passed in the comma-delimited list,
3695 or if the C<$CATALYST_DEBUG> environment variable is set to a true value.
3697 Note that if the log has already been setup, by either a previous call to
3698 C<setup_log> or by a call such as C<< __PACKAGE__->log( MyLogger->new ) >>,
3699 that this method won't actually set up the log object.
3704 my ( $class, $levels ) = @_;
3707 $levels =~ s/^\s+//;
3708 $levels =~ s/\s+$//;
3709 my %levels = map { $_ => 1 } split /\s*,\s*/, $levels;
3711 my $env_debug = Catalyst::Utils::env_value( $class, 'DEBUG' );
3712 if ( defined $env_debug ) {
3713 $levels{debug} = 1 if $env_debug; # Ugly!
3714 delete($levels{debug}) unless $env_debug;
3717 unless ( $class->log ) {
3718 $class->log( Catalyst::Log->new(keys %levels) );
3721 if ( $levels{debug} ) {
3722 Class::MOP::get_metaclass_by_name($class)->add_method('debug' => sub { 1 });
3723 $class->log->debug('Debug messages enabled');
3727 =head2 $c->setup_plugins
3733 =head2 $c->setup_stats
3735 Sets up timing statistics class.
3740 my ( $class, $stats ) = @_;
3742 Catalyst::Utils::ensure_class_loaded($class->stats_class);
3744 my $env = Catalyst::Utils::env_value( $class, 'STATS' );
3745 if ( defined($env) ? $env : ($stats || $class->debug ) ) {
3746 Class::MOP::get_metaclass_by_name($class)->add_method('use_stats' => sub { 1 });
3747 $class->log->debug('Statistics enabled');
3752 =head2 $c->registered_plugins
3754 Returns a sorted list of the plugins which have either been stated in the
3757 If passed a given plugin name, it will report a boolean value indicating
3758 whether or not that plugin is loaded. A fully qualified name is required if
3759 the plugin name does not begin with C<Catalyst::Plugin::>.
3761 if ($c->registered_plugins('Some::Plugin')) {
3769 sub registered_plugins {
3771 return sort keys %{ $proto->_plugins } unless @_;
3773 return 1 if exists $proto->_plugins->{$plugin};
3774 return exists $proto->_plugins->{"Catalyst::Plugin::$plugin"};
3777 sub _register_plugin {
3778 my ( $proto, $plugin, $instant ) = @_;
3779 my $class = ref $proto || $proto;
3781 load_class( $plugin );
3782 $class->log->warn( "$plugin inherits from 'Catalyst::Component' - this is deprecated and will not work in 5.81" )
3783 if $plugin->isa( 'Catalyst::Component' );
3784 my $plugin_meta = Moose::Meta::Class->create($plugin);
3785 if (!$plugin_meta->has_method('new')
3786 && ( $plugin->isa('Class::Accessor::Fast') || $plugin->isa('Class::Accessor') ) ) {
3787 $plugin_meta->add_method('new', Moose::Object->meta->get_method('new'))
3789 if (!$instant && !$proto->_plugins->{$plugin}) {
3790 my $meta = Class::MOP::get_metaclass_by_name($class);
3791 $meta->superclasses($plugin, $meta->superclasses);
3793 $proto->_plugins->{$plugin} = 1;
3797 sub _default_plugins { return qw() }
3800 my ( $class, $plugins ) = @_;
3802 $class->_plugins( {} ) unless $class->_plugins;
3804 m/Unicode::Encoding/ ? do {
3806 'Unicode::Encoding plugin is auto-applied,'
3807 . ' please remove this from your appclass'
3808 . ' and make sure to define "encoding" config'
3810 unless (exists $class->config->{'encoding'}) {
3811 $class->config->{'encoding'} = 'UTF-8';
3816 push @$plugins, $class->_default_plugins;
3817 $plugins = Data::OptList::mkopt($plugins || []);
3820 [ Catalyst::Utils::resolve_namespace(
3821 $class . '::Plugin',
3822 'Catalyst::Plugin', $_->[0]
3828 for my $plugin ( reverse @plugins ) {
3829 load_class($plugin->[0], $plugin->[1]);
3830 my $meta = find_meta($plugin->[0]);
3831 next if $meta && $meta->isa('Moose::Meta::Role');
3833 $class->_register_plugin($plugin->[0]);
3837 map { $_->[0]->name, $_->[1] }
3838 grep { blessed($_->[0]) && $_->[0]->isa('Moose::Meta::Role') }
3839 map { [find_meta($_->[0]), $_->[1]] }
3842 Moose::Util::apply_all_roles(
3848 =head2 default_middleware
3850 Returns a list of instantiated PSGI middleware objects which is the default
3851 middleware that is active for this application (taking any configuration
3852 options into account, excluding your custom added middleware via the C<psgi_middleware>
3853 configuration option). You can override this method if you wish to change
3854 the default middleware (although do so at risk since some middleware is vital
3855 to application function.)
3857 The current default middleware list is:
3859 Catalyst::Middleware::Stash
3860 Plack::Middleware::HTTPExceptions
3861 Plack::Middleware::RemoveRedundantBody
3862 Plack::Middleware::FixMissingBodyInRedirect
3863 Plack::Middleware::ContentLength
3864 Plack::Middleware::MethodOverride
3865 Plack::Middleware::Head
3867 If the configuration setting C<using_frontend_proxy> is true we add:
3869 Plack::Middleware::ReverseProxy
3871 If the configuration setting C<using_frontend_proxy_path> is true we add:
3873 Plack::Middleware::ReverseProxyPath
3875 But B<NOTE> that L<Plack::Middleware::ReverseProxyPath> is not a dependency of the
3876 L<Catalyst> distribution so if you want to use this option you should add it to
3877 your project distribution file.
3879 These middlewares will be added at L</setup_middleware> during the
3880 L</setup> phase of application startup.
3884 sub default_middleware {
3887 Catalyst::Middleware::Stash->new,
3888 Plack::Middleware::HTTPExceptions->new,
3889 Plack::Middleware::RemoveRedundantBody->new,
3890 Plack::Middleware::FixMissingBodyInRedirect->new,
3891 Plack::Middleware::ContentLength->new,
3892 Plack::Middleware::MethodOverride->new,
3893 Plack::Middleware::Head->new);
3895 if($class->config->{using_frontend_proxy}) {
3896 push @mw, Plack::Middleware::ReverseProxy->new;
3899 if($class->config->{using_frontend_proxy_path}) {
3900 if(Class::Load::try_load_class('Plack::Middleware::ReverseProxyPath')) {
3901 push @mw, Plack::Middleware::ReverseProxyPath->new;
3903 $class->log->error("Cannot use configuration 'using_frontend_proxy_path' because 'Plack::Middleware::ReverseProxyPath' is not installed");
3910 =head2 registered_middlewares
3912 Read only accessor that returns an array of all the middleware in the order
3913 that they were added (which is the REVERSE of the order they will be applied).
3915 The values returned will be either instances of L<Plack::Middleware> or of a
3916 compatible interface, or a coderef, which is assumed to be inlined middleware
3918 =head2 setup_middleware (?@middleware)
3920 Read configuration information stored in configuration key C<psgi_middleware> or
3923 See under L</CONFIGURATION> information regarding C<psgi_middleware> and how
3924 to use it to enable L<Plack::Middleware>
3926 This method is automatically called during 'setup' of your application, so
3927 you really don't need to invoke it. However you may do so if you find the idea
3928 of loading middleware via configuration weird :). For example:
3934 __PACKAGE__->setup_middleware('Head');
3937 When we read middleware definitions from configuration, we reverse the list
3938 which sounds odd but is likely how you expect it to work if you have prior
3939 experience with L<Plack::Builder> or if you previously used the plugin
3940 L<Catalyst::Plugin::EnableMiddleware> (which is now considered deprecated)
3942 So basically your middleware handles an incoming request from the first
3943 registered middleware, down and handles the response from the last middleware
3948 sub registered_middlewares {
3950 if(my $middleware = $class->_psgi_middleware) {
3951 my @mw = ($class->default_middleware, @$middleware);
3953 if($class->config->{using_frontend_proxy}) {
3954 push @mw, Plack::Middleware::ReverseProxy->new;
3959 die "You cannot call ->registered_middlewares until middleware has been setup";
3963 sub setup_middleware {
3965 my @middleware_definitions;
3967 # If someone calls this method you can add middleware with args. However if its
3968 # called without an arg we need to setup the configuration middleware.
3970 @middleware_definitions = reverse(@_);
3972 @middleware_definitions = reverse(@{$class->config->{'psgi_middleware'}||[]})
3973 unless $class->finalized_default_middleware;
3974 $class->finalized_default_middleware(1); # Only do this once, just in case some people call setup over and over...
3977 my @middleware = ();
3978 while(my $next = shift(@middleware_definitions)) {
3980 if(Scalar::Util::blessed $next && $next->can('wrap')) {
3981 push @middleware, $next;
3982 } elsif(ref $next eq 'CODE') {
3983 push @middleware, $next;
3984 } elsif(ref $next eq 'HASH') {
3985 my $namespace = shift @middleware_definitions;
3986 my $mw = $class->Catalyst::Utils::build_middleware($namespace, %$next);
3987 push @middleware, $mw;
3989 die "I can't handle middleware definition ${\ref $next}";
3992 my $mw = $class->Catalyst::Utils::build_middleware($next);
3993 push @middleware, $mw;
3997 my @existing = @{$class->_psgi_middleware || []};
3998 $class->_psgi_middleware([@middleware,@existing,]);
4001 =head2 registered_data_handlers
4003 A read only copy of registered Data Handlers returned as a Hash, where each key
4004 is a content type and each value is a subref that attempts to decode that content
4007 =head2 setup_data_handlers (?@data_handler)
4009 Read configuration information stored in configuration key C<data_handlers> or
4012 See under L</CONFIGURATION> information regarding C<data_handlers>.
4014 This method is automatically called during 'setup' of your application, so
4015 you really don't need to invoke it.
4017 =head2 default_data_handlers
4019 Default Data Handlers that come bundled with L<Catalyst>. Currently there are
4020 only two default data handlers, for 'application/json' and an alternative to
4021 'application/x-www-form-urlencoded' which supposed nested form parameters via
4022 L<CGI::Struct> or via L<CGI::Struct::XS> IF you've installed it.
4024 The 'application/json' data handler is used to parse incoming JSON into a Perl
4025 data structure. It used either L<JSON::MaybeXS> or L<JSON>, depending on which
4026 is installed. This allows you to fail back to L<JSON:PP>, which is a Pure Perl
4027 JSON decoder, and has the smallest dependency impact.
4029 Because we don't wish to add more dependencies to L<Catalyst>, if you wish to
4030 use this new feature we recommend installing L<JSON> or L<JSON::MaybeXS> in
4031 order to get the best performance. You should add either to your dependency
4032 list (Makefile.PL, dist.ini, cpanfile, etc.)
4036 sub registered_data_handlers {
4038 if(my $data_handlers = $class->_data_handlers) {
4039 return %$data_handlers;
4041 $class->setup_data_handlers;
4042 return $class->registered_data_handlers;
4046 sub setup_data_handlers {
4047 my ($class, %data_handler_callbacks) = @_;
4048 %data_handler_callbacks = (
4049 %{$class->default_data_handlers},
4050 %{$class->config->{'data_handlers'}||+{}},
4051 %data_handler_callbacks);
4053 $class->_data_handlers(\%data_handler_callbacks);
4056 sub default_data_handlers {
4059 'application/x-www-form-urlencoded' => sub {
4060 my ($fh, $req) = @_;
4061 my $params = $req->_use_hash_multivalue ? $req->body_parameters->mixed : $req->body_parameters;
4062 Class::Load::load_first_existing_class('CGI::Struct::XS', 'CGI::Struct')
4063 ->can('build_cgi_struct')->($params);
4065 'application/json' => sub {
4066 my ($fh, $req) = @_;
4067 my $parser = Class::Load::load_first_existing_class('JSON::MaybeXS', 'JSON');
4071 $slurped = $fh->getline;
4072 $parser->can("decode_json")->($slurped); # decode_json does utf8 decoding for us
4073 } || Catalyst::Exception->throw(sprintf "Error Parsing POST '%s', Error: %s", (defined($slurped) ? $slurped : 'undef') ,$@);
4078 sub _handle_http_exception {
4079 my ( $self, $error ) = @_;
4081 !$self->config->{always_catch_http_exceptions}
4084 $error->can('as_psgi')
4085 || ( $error->can('code')
4086 && $error->code =~ m/^[1-5][0-9][0-9]$/ )
4096 Returns an arrayref of the internal execution stack (actions that are
4097 currently executing).
4101 Returns the current timing statistics object. By default Catalyst uses
4102 L<Catalyst::Stats|Catalyst::Stats>, but can be set otherwise with
4103 L<< stats_class|/"$c->stats_class" >>.
4105 Even if L<< -Stats|/"-Stats" >> is not enabled, the stats object is still
4106 available. By enabling it with C< $c->stats->enabled(1) >, it can be used to
4107 profile explicitly, although MyApp.pm still won't profile nor output anything
4110 =head2 $c->stats_class
4112 Returns or sets the stats (timing statistics) class. L<Catalyst::Stats|Catalyst::Stats> is used by default.
4114 =head2 $app->stats_class_traits
4116 A arrayref of L<Moose::Role>s that are applied to the stats_class before creating it.
4118 =head2 $app->composed_stats_class
4120 this is the stats_class composed with any 'stats_class_traits'. You can
4121 name the full namespace of the role, or a namespace suffix, which will then
4122 be tried against the following standard namespace prefixes.
4124 $MyApp::TraitFor::Stats::$trait_suffix
4125 Catalyst::TraitFor::Stats::$trait_suffix
4127 So for example if you set:
4129 MyApp->stats_class_traits(['Foo']);
4131 We try each possible role in turn (and throw an error if none load)
4134 MyApp::TraitFor::Stats::Foo
4135 Catalyst::TraitFor::Stats::Foo
4137 The namespace part 'TraitFor::Stats' was chosen to assist in backwards
4138 compatibility with L<CatalystX::RoleApplicator> which previously provided
4139 these features in a stand alone package.
4141 =head2 $c->use_stats
4143 Returns 1 when L<< stats collection|/"-Stats" >> is enabled.
4145 Note that this is a static method, not an accessor and should be overridden
4146 by declaring C<sub use_stats { 1 }> in your MyApp.pm, not by calling C<< $c->use_stats(1) >>.
4153 =head2 $c->write( $data )
4155 Writes $data to the output stream. When using this method directly, you
4156 will need to manually set the C<Content-Length> header to the length of
4157 your output data, if known.
4164 # Finalize headers if someone manually writes output (for compat)
4165 $c->finalize_headers;
4167 return $c->response->write( @_ );
4172 Returns the Catalyst version number. Mostly useful for "powered by"
4173 messages in template systems.
4177 sub version { return $Catalyst::VERSION }
4179 =head1 CONFIGURATION
4181 There are a number of 'base' config variables which can be set:
4187 C<always_catch_http_exceptions> - As of version 5.90060 Catalyst
4188 rethrows errors conforming to the interface described by
4189 L<Plack::Middleware::HTTPExceptions> and lets the middleware deal with it.
4190 Set true to get the deprecated behaviour and have Catalyst catch HTTP exceptions.
4194 C<default_model> - The default model picked if you say C<< $c->model >>. See L<< /$c->model($name) >>.
4198 C<default_view> - The default view to be rendered or returned when C<< $c->view >> is called. See L<< /$c->view($name) >>.
4202 C<disable_component_resolution_regex_fallback> - Turns
4203 off the deprecated component resolution functionality so
4204 that if any of the component methods (e.g. C<< $c->controller('Foo') >>)
4205 are called then regex search will not be attempted on string values and
4206 instead C<undef> will be returned.
4210 C<home> - The application home directory. In an uninstalled application,
4211 this is the top level application directory. In an installed application,
4212 this will be the directory containing C<< MyApp.pm >>.
4216 C<ignore_frontend_proxy> - See L</PROXY SUPPORT>
4220 C<name> - The name of the application in debug messages and the debug and
4225 C<parse_on_demand> - The request body (for example file uploads) will not be parsed
4226 until it is accessed. This allows you to (for example) check authentication (and reject
4227 the upload) before actually receiving all the data. See L</ON-DEMAND PARSER>
4231 C<root> - The root directory for templates. Usually this is just a
4232 subdirectory of the home directory, but you can set it to change the
4233 templates to a different directory.
4237 C<search_extra> - Array reference passed to Module::Pluggable to for additional
4238 namespaces from which components will be loaded (and constructed and stored in
4239 C<< $c->components >>).
4243 C<show_internal_actions> - If true, causes internal actions such as C<< _DISPATCH >>
4244 to be shown in hit debug tables in the test server.
4248 C<use_request_uri_for_path> - Controls if the C<REQUEST_URI> or C<PATH_INFO> environment
4249 variable should be used for determining the request path.
4251 Most web server environments pass the requested path to the application using environment variables,
4252 from which Catalyst has to reconstruct the request base (i.e. the top level path to / in the application,
4253 exposed as C<< $c->request->base >>) and the request path below that base.
4255 There are two methods of doing this, both of which have advantages and disadvantages. Which method is used
4256 is determined by the C<< $c->config(use_request_uri_for_path) >> setting (which can either be true or false).
4260 =item use_request_uri_for_path => 0
4262 This is the default (and the) traditional method that Catalyst has used for determining the path information.
4263 The path is generated from a combination of the C<PATH_INFO> and C<SCRIPT_NAME> environment variables.
4264 The allows the application to behave correctly when C<mod_rewrite> is being used to redirect requests
4265 into the application, as these variables are adjusted by mod_rewrite to take account for the redirect.
4267 However this method has the major disadvantage that it is impossible to correctly decode some elements
4268 of the path, as RFC 3875 says: "C<< Unlike a URI path, the PATH_INFO is not URL-encoded, and cannot
4269 contain path-segment parameters. >>" This means PATH_INFO is B<always> decoded, and therefore Catalyst
4270 can't distinguish / vs %2F in paths (in addition to other encoded values).
4272 =item use_request_uri_for_path => 1
4274 This method uses the C<REQUEST_URI> and C<SCRIPT_NAME> environment variables. As C<REQUEST_URI> is never
4275 decoded, this means that applications using this mode can correctly handle URIs including the %2F character
4276 (i.e. with C<AllowEncodedSlashes> set to C<On> in Apache).
4278 Given that this method of path resolution is provably more correct, it is recommended that you use
4279 this unless you have a specific need to deploy your application in a non-standard environment, and you are
4280 aware of the implications of not being able to handle encoded URI paths correctly.
4282 However it also means that in a number of cases when the app isn't installed directly at a path, but instead
4283 is having paths rewritten into it (e.g. as a .cgi/fcgi in a public_html directory, with mod_rewrite in a
4284 .htaccess file, or when SSI is used to rewrite pages into the app, or when sub-paths of the app are exposed
4285 at other URIs than that which the app is 'normally' based at with C<mod_rewrite>), the resolution of
4286 C<< $c->request->base >> will be incorrect.
4292 C<using_frontend_proxy> - See L</PROXY SUPPORT>.
4296 C<using_frontend_proxy_path> - Enabled L<Plack::Middleware::ReverseProxyPath> on your application (if
4297 installed, otherwise log an error). This is useful if your application is not running on the
4298 'root' (or /) of your host server. B<NOTE> if you use this feature you should add the required
4299 middleware to your project dependency list since its not automatically a dependency of L<Catalyst>.
4300 This has been done since not all people need this feature and we wish to restrict the growth of
4301 L<Catalyst> dependencies.
4305 C<encoding> - See L</ENCODING>
4307 This now defaults to 'UTF-8'. You my turn it off by setting this configuration
4312 C<abort_chain_on_error_fix>
4316 When there is an error in an action chain, the default behavior is to
4317 abort the processing of the remaining actions to avoid running them
4318 when the application is in an unexpected state.
4320 Before version 5.90070, the default used to be false. To keep the old
4321 behaviour, you can explicitely set the value to false. E.g.
4323 __PACKAGE__->config(abort_chain_on_error_fix => 0);
4325 If this setting is set to false, then the remaining actions are
4326 performed and the error is caught at the end of the chain.
4331 C<use_hash_multivalue_in_request>
4333 In L<Catalyst::Request> the methods C<query_parameters>, C<body_parametes>
4334 and C<parameters> return a hashref where values might be scalar or an arrayref
4335 depending on the incoming data. In many cases this can be undesirable as it
4336 leads one to writing defensive code like the following:
4338 my ($val) = ref($c->req->parameters->{a}) ?
4339 @{$c->req->parameters->{a}} :
4340 $c->req->parameters->{a};
4342 Setting this configuration item to true will make L<Catalyst> populate the
4343 attributes underlying these methods with an instance of L<Hash::MultiValue>
4344 which is used by L<Plack::Request> and others to solve this very issue. You
4345 may prefer this behavior to the default, if so enable this option (be warned
4346 if you enable it in a legacy application we are not sure if it is completely
4347 backwardly compatible).
4351 C<skip_complex_post_part_handling>
4353 When creating body parameters from a POST, if we run into a multipart POST
4354 that does not contain uploads, but instead contains inlined complex data
4355 (very uncommon) we cannot reliably convert that into field => value pairs. So
4356 instead we create an instance of L<Catalyst::Request::PartData>. If this causes
4357 issue for you, you can disable this by setting C<skip_complex_post_part_handling>
4358 to true (default is false).
4362 C<skip_body_param_unicode_decoding>
4364 Generally we decode incoming POST params based on your declared encoding (the
4365 default for this is to decode UTF-8). If this is causing you trouble and you
4366 do not wish to turn all encoding support off (with the C<encoding> configuration
4367 parameter) you may disable this step atomically by setting this configuration
4372 C<do_not_decode_query>
4374 If true, then do not try to character decode any wide characters in your
4375 request URL query or keywords. Most readings of the relevant specifications
4376 suggest these should be UTF-* encoded, which is the default that L<Catalyst>
4377 will use, however if you are creating a lot of URLs manually or have external
4378 evil clients, this might cause you trouble. If you find the changes introduced
4379 in Catalyst version 5.90080+ break some of your query code, you may disable
4380 the UTF-8 decoding globally using this configuration.
4382 This setting takes precedence over C<default_query_encoding>
4386 C<do_not_check_query_encoding>
4388 Catalyst versions 5.90080 - 5.90106 would decode query parts of an incoming
4389 request but would not raise an exception when the decoding failed due to
4390 incorrect unicode. It now does, but if this change is giving you trouble
4391 you may disable it by setting this configuration to true.
4395 C<default_query_encoding>
4397 By default we decode query and keywords in your request URL using UTF-8, which
4398 is our reading of the relevant specifications. This setting allows one to
4399 specify a fixed value for how to decode your query. You might need this if
4400 you are doing a lot of custom encoding of your URLs and not using UTF-8.
4404 C<use_chained_args_0_special_case>
4406 In older versions of Catalyst, when more than one action matched the same path
4407 AND all those matching actions declared Args(0), we'd break the tie by choosing
4408 the first action defined. We now normalized how Args(0) works so that it
4409 follows the same rule as Args(N), which is to say when we need to break a tie
4410 we choose the LAST action defined. If this breaks your code and you don't
4411 have time to update to follow the new normalized approach, you may set this
4412 value to true and it will globally revert to the original chaining behavior.
4416 C<psgi_middleware> - See L<PSGI MIDDLEWARE>.
4420 C<data_handlers> - See L<DATA HANDLERS>.
4424 C<stats_class_traits>
4426 An arrayref of L<Moose::Role>s that get composed into your stats class.
4430 C<request_class_traits>
4432 An arrayref of L<Moose::Role>s that get composed into your request class.
4436 C<response_class_traits>
4438 An arrayref of L<Moose::Role>s that get composed into your response class.
4442 C<inject_components>
4444 A Hashref of L<Catalyst::Component> subclasses that are 'injected' into configuration.
4448 inject_components => {
4449 'Controller::Err' => { from_component => 'Local::Controller::Errors' },
4450 'Model::Zoo' => { from_component => 'Local::Model::Foo' },
4451 'Model::Foo' => { from_component => 'Local::Model::Foo', roles => ['TestRole'] },
4453 'Controller::Err' => { a => 100, b=>200, namespace=>'error' },
4454 'Model::Zoo' => { a => 2 },
4455 'Model::Foo' => { a => 100 },
4458 Generally L<Catalyst> looks for components in your Model/View or Controller directories.
4459 However for cases when you which to use an existing component and you don't need any
4460 customization (where for when you can apply a role to customize it) you may inject those
4461 components into your application. Please note any configuration should be done 'in the
4462 normal way', with a key under configuration named after the component affix, as in the
4465 Using this type of injection allows you to construct significant amounts of your application
4466 with only configuration!. This may or may not lead to increased code understanding.
4468 Please not you may also call the ->inject_components application method as well, although
4469 you must do so BEFORE setup.
4475 Generally when you throw an exception inside an Action (or somewhere in
4476 your stack, such as in a model that an Action is calling) that exception
4477 is caught by Catalyst and unless you either catch it yourself (via eval
4478 or something like L<Try::Tiny> or by reviewing the L</error> stack, it
4479 will eventually reach L</finalize_errors> and return either the debugging
4480 error stack page, or the default error page. However, if your exception
4481 can be caught by L<Plack::Middleware::HTTPExceptions>, L<Catalyst> will
4482 instead rethrow it so that it can be handled by that middleware (which
4483 is part of the default middleware). For example this would allow
4485 use HTTP::Throwable::Factory 'http_throw';
4487 sub throws_exception :Local {
4488 my ($self, $c) = @_;
4490 http_throw(SeeOther => { location =>
4491 $c->uri_for($self->action_for('redirect')) });
4495 =head1 INTERNAL ACTIONS
4497 Catalyst uses internal actions like C<_DISPATCH>, C<_BEGIN>, C<_AUTO>,
4498 C<_ACTION>, and C<_END>. These are by default not shown in the private
4499 action table, but you can make them visible with a config parameter.
4501 MyApp->config(show_internal_actions => 1);
4503 =head1 ON-DEMAND PARSER
4505 The request body is usually parsed at the beginning of a request,
4506 but if you want to handle input yourself, you can enable on-demand
4507 parsing with a config parameter.
4509 MyApp->config(parse_on_demand => 1);
4511 =head1 PROXY SUPPORT
4513 Many production servers operate using the common double-server approach,
4514 with a lightweight frontend web server passing requests to a larger
4515 backend server. An application running on the backend server must deal
4516 with two problems: the remote user always appears to be C<127.0.0.1> and
4517 the server's hostname will appear to be C<localhost> regardless of the
4518 virtual host that the user connected through.
4520 Catalyst will automatically detect this situation when you are running
4521 the frontend and backend servers on the same machine. The following
4522 changes are made to the request.
4524 $c->req->address is set to the user's real IP address, as read from
4525 the HTTP X-Forwarded-For header.
4527 The host value for $c->req->base and $c->req->uri is set to the real
4528 host, as read from the HTTP X-Forwarded-Host header.
4530 Additionally, you may be running your backend application on an insecure
4531 connection (port 80) while your frontend proxy is running under SSL. If there
4532 is a discrepancy in the ports, use the HTTP header C<X-Forwarded-Port> to
4533 tell Catalyst what port the frontend listens on. This will allow all URIs to
4534 be created properly.
4536 In the case of passing in:
4538 X-Forwarded-Port: 443
4540 All calls to C<uri_for> will result in an https link, as is expected.
4542 Obviously, your web server must support these headers for this to work.
4544 In a more complex server farm environment where you may have your
4545 frontend proxy server(s) on different machines, you will need to set a
4546 configuration option to tell Catalyst to read the proxied data from the
4549 MyApp->config(using_frontend_proxy => 1);
4551 If you do not wish to use the proxy support at all, you may set:
4553 MyApp->config(ignore_frontend_proxy => 0);
4555 =head2 Note about psgi files
4557 Note that if you supply your own .psgi file, calling
4558 C<< MyApp->psgi_app(@_); >>, then B<this will not happen automatically>.
4560 You either need to apply L<Plack::Middleware::ReverseProxy> yourself
4561 in your psgi, for example:
4564 enable "Plack::Middleware::ReverseProxy";
4568 This will unconditionally add the ReverseProxy support, or you need to call
4569 C<< $app = MyApp->apply_default_middlewares($app) >> (to conditionally
4570 apply the support depending upon your config).
4572 See L<Catalyst::PSGI> for more information.
4574 =head1 THREAD SAFETY
4576 Catalyst has been tested under Apache 2's threading C<mpm_worker>,
4577 C<mpm_winnt>, and the standalone forking HTTP server on Windows. We
4578 believe the Catalyst core to be thread-safe.
4580 If you plan to operate in a threaded environment, remember that all other
4581 modules you are using must also be thread-safe. Some modules, most notably
4582 L<DBD::SQLite>, are not thread-safe.
4584 =head1 DATA HANDLERS
4586 The L<Catalyst::Request> object uses L<HTTP::Body> to populate 'classic' HTML
4587 form parameters and URL search query fields. However it has become common
4588 for various alternative content types to be PUT or POSTed to your controllers
4589 and actions. People working on RESTful APIs, or using AJAX often use JSON,
4590 XML and other content types when communicating with an application server. In
4591 order to better support this use case, L<Catalyst> defines a global configuration
4592 option, C<data_handlers>, which lets you associate a content type with a coderef
4593 that parses that content type into something Perl can readily access.
4600 __PACKAGE__->config(
4602 'application/json' => sub { local $/; decode_json $_->getline },
4604 ## Any other configuration.
4609 By default L<Catalyst> comes with a generic JSON data handler similar to the
4610 example given above, which uses L<JSON::Maybe> to provide either L<JSON::PP>
4611 (a pure Perl, dependency free JSON parser) or L<Cpanel::JSON::XS> if you have
4612 it installed (if you want the faster XS parser, add it to you project Makefile.PL
4613 or dist.ini, cpanfile, etc.)
4615 The C<data_handlers> configuration is a hashref whose keys are HTTP Content-Types
4616 (matched against the incoming request type using a regexp such as to be case
4617 insensitive) and whose values are coderefs that receive a localized version of
4618 C<$_> which is a filehandle object pointing to received body.
4620 This feature is considered an early access release and we reserve the right
4621 to alter the interface in order to provide a performant and secure solution to
4622 alternative request body content. Your reports welcomed!
4624 =head1 PSGI MIDDLEWARE
4626 You can define middleware, defined as L<Plack::Middleware> or a compatible
4627 interface in configuration. Your middleware definitions are in the form of an
4628 arrayref under the configuration key C<psgi_middleware>. Here's an example
4629 with details to follow:
4634 use Plack::Middleware::StackTrace;
4636 my $stacktrace_middleware = Plack::Middleware::StackTrace->new;
4638 __PACKAGE__->config(
4639 'psgi_middleware', [
4642 $stacktrace_middleware,
4643 'Session' => {store => 'File'},
4648 $env->{myapp.customkey} = 'helloworld';
4657 So the general form is:
4659 __PACKAGE__->config(psgi_middleware => \@middleware_definitions);
4661 Where C<@middleware> is one or more of the following, applied in the REVERSE of
4662 the order listed (to make it function similarly to L<Plack::Builder>:
4664 Alternatively, you may also define middleware by calling the L</setup_middleware>
4671 __PACKAGE__->setup_middleware( \@middleware_definitions);
4674 In the case where you do both (use 'setup_middleware' and configuration) the
4675 package call to setup_middleware will be applied earlier (in other words its
4676 middleware will wrap closer to the application). Keep this in mind since in
4677 some cases the order of middleware is important.
4679 The two approaches are not exclusive.
4683 =item Middleware Object
4685 An already initialized object that conforms to the L<Plack::Middleware>
4688 my $stacktrace_middleware = Plack::Middleware::StackTrace->new;
4690 __PACKAGE__->config(
4691 'psgi_middleware', [
4692 $stacktrace_middleware,
4698 A coderef that is an inlined middleware:
4700 __PACKAGE__->config(
4701 'psgi_middleware', [
4706 if($env->{PATH_INFO} =~m/forced/) {
4708 ->new(file=>TestApp->path_to(qw/share static forced.txt/))
4711 return $app->($env);
4721 We assume the scalar refers to a namespace after normalizing it using the
4724 (1) If the scalar is prefixed with a "+" (as in C<+MyApp::Foo>) then the full string
4725 is assumed to be 'as is', and we just install and use the middleware.
4727 (2) If the scalar begins with "Plack::Middleware" or your application namespace
4728 (the package name of your Catalyst application subclass), we also assume then
4729 that it is a full namespace, and use it.
4731 (3) Lastly, we then assume that the scalar is a partial namespace, and attempt to
4732 resolve it first by looking for it under your application namespace (for example
4733 if you application is "MyApp::Web" and the scalar is "MyMiddleware", we'd look
4734 under "MyApp::Web::Middleware::MyMiddleware") and if we don't find it there, we
4735 will then look under the regular L<Plack::Middleware> namespace (i.e. for the
4736 previous we'd try "Plack::Middleware::MyMiddleware"). We look under your application
4737 namespace first to let you 'override' common L<Plack::Middleware> locally, should
4738 you find that a good idea.
4744 __PACKAGE__->config(
4745 'psgi_middleware', [
4746 'Debug', ## MyAppWeb::Middleware::Debug->wrap or Plack::Middleware::Debug->wrap
4747 'Plack::Middleware::Stacktrace', ## Plack::Middleware::Stacktrace->wrap
4748 '+MyApp::Custom', ## MyApp::Custom->wrap
4752 =item a scalar followed by a hashref
4754 Just like the previous, except the following C<HashRef> is used as arguments
4755 to initialize the middleware object.
4757 __PACKAGE__->config(
4758 'psgi_middleware', [
4759 'Session' => {store => 'File'},
4764 Please see L<PSGI> for more on middleware.
4768 Starting in L<Catalyst> version 5.90080 encoding is automatically enabled
4769 and set to encode all body responses to UTF8 when possible and applicable.
4770 Following is documentation on this process. If you are using an older
4771 version of L<Catalyst> you should review documentation for that version since
4774 By default encoding is now 'UTF-8'. You may turn it off by setting
4775 the encoding configuration to undef.
4777 MyApp->config(encoding => undef);
4779 This is recommended for temporary backwards compatibility only.
4781 To turn it off for a single request use the L<clear_encoding>
4782 method to turn off encoding for this request. This can be useful
4783 when you are setting the body to be an arbitrary block of bytes,
4784 especially if that block happens to be a block of UTF8 text.
4786 Encoding is automatically applied when the content-type is set to
4787 a type that can be encoded. Currently we encode when the content type
4788 matches the following regular expression:
4790 $content_type =~ /^text|xml$|javascript$/
4792 Encoding is set on the application, but it is copied to the context object
4793 so that you can override it on a request basis.
4795 Be default we don't automatically encode 'application/json' since the most
4796 common approaches to generating this type of response (Either via L<Catalyst::View::JSON>
4797 or L<Catalyst::Action::REST>) will do so already and we want to avoid double
4800 If you are producing JSON response in an unconventional manner (such
4801 as via a template or manual strings) you should perform the UTF8 encoding
4802 manually as well such as to conform to the JSON specification.
4804 NOTE: We also examine the value of $c->response->content_encoding. If
4805 you set this (like for example 'gzip', and manually gzipping the body)
4806 we assume that you have done all the necessary encoding yourself, since
4807 we cannot encode the gzipped contents. If you use a plugin like
4808 L<Catalyst::Plugin::Compress> you need to update to a modern version in order
4809 to have this function correctly with the new UTF8 encoding code, or you
4810 can use L<Plack::Middleware::Deflater> or (probably best) do your compression on
4819 Returns an instance of an C<Encode> encoding
4821 print $c->encoding->name
4823 =item handle_unicode_encoding_exception ($exception_context)
4825 Method called when decoding process for a request fails.
4827 An C<$exception_context> hashref is provided to allow you to override the
4828 behaviour of your application when given data with incorrect encodings.
4830 The default method throws exceptions in the case of invalid request parameters
4831 (resulting in a 500 error), but ignores errors in upload filenames.
4833 The keys passed in the C<$exception_context> hash are:
4839 The value which was not able to be decoded.
4843 The exception received from L<Encode>.
4847 What type of data was being decoded. Valid values are (currently)
4848 C<params> - for request parameters / arguments / captures
4849 and C<uploads> - for request upload filenames.
4859 Join #catalyst on irc.perl.org.
4863 http://lists.scsys.co.uk/cgi-bin/mailman/listinfo/catalyst
4864 http://lists.scsys.co.uk/cgi-bin/mailman/listinfo/catalyst-dev
4868 http://catalyst.perl.org
4872 http://dev.catalyst.perl.org
4876 =head2 L<Task::Catalyst> - All you need to start with Catalyst
4878 =head2 L<Catalyst::Manual> - The Catalyst Manual
4880 =head2 L<Catalyst::Component>, L<Catalyst::Controller> - Base classes for components
4882 =head2 L<Catalyst::Engine> - Core engine
4884 =head2 L<Catalyst::Log> - Log class.
4886 =head2 L<Catalyst::Request> - Request object
4888 =head2 L<Catalyst::Response> - Response object
4890 =head2 L<Catalyst::Test> - The test suite.
4892 =head1 PROJECT FOUNDER
4894 sri: Sebastian Riedel <sri@cpan.org>
4900 acme: Leon Brocard <leon@astray.com>
4902 abraxxa: Alexander Hartmaier <abraxxa@cpan.org>
4904 andrewalker: André Walker <andre@cpan.org>
4908 Andrew Ford <A.Ford@ford-mason.co.uk>
4912 andyg: Andy Grundman <andy@hybridized.org>
4914 audreyt: Audrey Tang
4916 bricas: Brian Cassidy <bricas@cpan.org>
4918 Caelum: Rafael Kitover <rkitover@io.com>
4920 chansen: Christian Hansen
4922 Chase Venters C<chase.venters@gmail.com>
4924 chicks: Christopher Hicks
4926 Chisel Wright C<pause@herlpacker.co.uk>
4928 Danijel Milicevic C<me@danijel.de>
4930 davewood: David Schmidt <davewood@cpan.org>
4932 David Kamholz <dkamholz@cpan.org>
4934 David Naughton, C<naughton@umn.edu>
4938 dhoss: Devin Austin <dhoss@cpan.org>
4940 dkubb: Dan Kubb <dan.kubb-cpan@onautopilot.com>
4944 dwc: Daniel Westermann-Clark <danieltwc@cpan.org>
4946 esskar: Sascha Kiefer
4948 fireartist: Carl Franks <cfranks@cpan.org>
4950 frew: Arthur Axel "fREW" Schmidt <frioux@gmail.com>
4952 gabb: Danijel Milicevic
4956 Gavin Henry C<ghenry@perl.me.uk>
4960 groditi: Guillermo Roditi <groditi@gmail.com>
4962 hobbs: Andrew Rodland <andrew@cleverdomain.org>
4964 ilmari: Dagfinn Ilmari Mannsåker <ilmari@ilmari.org>
4966 jcamacho: Juan Camacho
4968 jester: Jesse Sheidlower C<jester@panix.com>
4970 jhannah: Jay Hannah <jay@jays.net>
4976 jon: Jon Schutz <jjschutz@cpan.org>
4978 Jonathan Rockway C<< <jrockway@cpan.org> >>
4980 Kieren Diment C<kd@totaldatasolution.com>
4982 konobi: Scott McWhirter <konobi@cpan.org>
4984 marcus: Marcus Ramberg <mramberg@cpan.org>
4986 miyagawa: Tatsuhiko Miyagawa <miyagawa@bulknews.net>
4988 mgrimes: Mark Grimes <mgrimes@cpan.org>
4990 mst: Matt S. Trout <mst@shadowcatsystems.co.uk>
4994 naughton: David Naughton
4996 ningu: David Kamholz <dkamholz@cpan.org>
4998 nothingmuch: Yuval Kogman <nothingmuch@woobling.org>
5000 numa: Dan Sully <daniel@cpan.org>
5006 omega: Andreas Marienborg
5008 Oleg Kostyuk <cub.uanic@gmail.com>
5010 phaylon: Robert Sedlacek <phaylon@dunkelheit.at>
5012 rafl: Florian Ragwitz <rafl@debian.org>
5014 random: Roland Lammel <lammel@cpan.org>
5016 Robert Sedlacek C<< <rs@474.at> >>
5018 SpiceMan: Marcel Montes
5022 szbalint: Balint Szilakszi <szbalint@cpan.org>
5024 t0m: Tomas Doran <bobtfish@bobtfish.net>
5028 vanstyn: Henry Van Styn <vanstyn@cpan.org>
5030 Viljo Marrandi C<vilts@yahoo.com>
5032 Will Hawes C<info@whawes.co.uk>
5034 willert: Sebastian Willert <willert@cpan.org>
5036 wreis: Wallace Reis <wreis@cpan.org>
5038 Yuval Kogman, C<nothingmuch@woobling.org>
5040 rainboxx: Matthias Dietrich, C<perl@rainboxx.de>
5042 dd070: Dhaval Dhanani <dhaval070@gmail.com>
5044 Upasana <me@upasana.me>
5046 John Napiorkowski (jnap) <jjnapiork@cpan.org>
5050 Copyright (c) 2005-2015, the above named PROJECT FOUNDER and CONTRIBUTORS.
5054 This library is free software. You can redistribute it and/or modify it under
5055 the same terms as Perl itself.
5061 __PACKAGE__->meta->make_immutable;