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-E<gt>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 $c->res->body( $c->encoding->encode( $c->res->body, $c->_encode_check ) );
2327 # Set the charset if necessary. This might be a bit bonkers since encodable response
2328 # is false when the set charset is not the same as the encoding mimetype (maybe
2329 # confusing action at a distance here..
2330 # Don't try to set the charset if one already exists or if headers are already finalized
2331 $c->res->content_type($c->res->content_type . "; charset=" . $c->encoding->mime_name)
2332 unless($c->res->content_type_charset ||
2333 ($c->res->_context && $c->res->finalized_headers && !$c->res->_has_response_cb));
2337 =head2 $c->finalize_output
2339 An alias for finalize_body.
2341 =head2 $c->finalize_read
2343 Finalizes the input after reading is complete.
2347 sub finalize_read { my $c = shift; $c->engine->finalize_read( $c, @_ ) }
2349 =head2 $c->finalize_uploads
2351 Finalizes uploads. Cleans up any temporary files.
2355 sub finalize_uploads { my $c = shift; $c->engine->finalize_uploads( $c, @_ ) }
2357 =head2 $c->get_action( $action, $namespace )
2359 Gets an action in a given namespace.
2363 sub get_action { my $c = shift; $c->dispatcher->get_action(@_) }
2365 =head2 $c->get_actions( $action, $namespace )
2367 Gets all actions of a given name in a namespace and all parent
2372 sub get_actions { my $c = shift; $c->dispatcher->get_actions( $c, @_ ) }
2374 =head2 $app->handle_request( @arguments )
2376 Called to handle each HTTP request.
2380 sub handle_request {
2381 my ( $class, @arguments ) = @_;
2383 # Always expect worst case!
2386 if ($class->debug) {
2387 my $secs = time - $START || 1;
2388 my $av = sprintf '%.3f', $COUNT / $secs;
2389 my $time = localtime time;
2390 $class->log->info("*** Request $COUNT ($av/s) [$$] [$time] ***");
2393 my $c = $class->prepare(@arguments);
2395 $status = $c->finalize;
2397 #rethow if this can be handled by middleware
2398 if ( $class->_handle_http_exception($_) ) {
2399 $_->can('rethrow') ? $_->rethrow : croak $_;
2401 chomp(my $error = $_);
2402 $class->log->error(qq/Caught exception in engine "$error"/);
2407 if(my $coderef = $class->log->can('_flush')){
2408 $class->log->$coderef();
2413 =head2 $class->prepare( @arguments )
2415 Creates a Catalyst context from an engine-specific request (Apache, CGI,
2422 predicate => '_has_uploadtmp',
2426 my ( $class, @arguments ) = @_;
2429 # After the app/ctxt split, this should become an attribute based on something passed
2430 # into the application.
2431 $class->context_class( ref $class || $class ) unless $class->context_class;
2433 my $uploadtmp = $class->config->{uploadtmp};
2434 my $c = $class->context_class->new({ $uploadtmp ? (_uploadtmp => $uploadtmp) : ()});
2436 $c->response->_context($c);
2437 $c->stats($class->stats_class->new)->enable($c->use_stats);
2439 if ( $c->debug || $c->config->{enable_catalyst_header} ) {
2440 $c->res->headers->header( 'X-Catalyst' => $Catalyst::VERSION );
2444 # Allow engine to direct the prepare flow (for POE)
2445 if ( my $prepare = $c->engine->can('prepare') ) {
2446 $c->engine->$prepare( $c, @arguments );
2449 $c->prepare_request(@arguments);
2450 $c->prepare_connection;
2451 $c->prepare_query_parameters;
2452 $c->prepare_headers; # Just hooks, no longer needed - they just
2453 $c->prepare_cookies; # cause the lazy attribute on req to build
2456 # Prepare the body for reading, either by prepare_body
2457 # or the user, if they are using $c->read
2460 # Parse the body unless the user wants it on-demand
2461 unless ( ref($c)->config->{parse_on_demand} ) {
2467 # VERY ugly and probably shouldn't rely on ->finalize actually working
2469 # failed prepare is always due to an invalid request, right?
2470 # Note we call finalize and then die here, which escapes
2471 # finalize being called in the enclosing block..
2472 # It in fact couldn't be called, as we don't return $c..
2473 # This is a mess - but I'm unsure you can fix this without
2474 # breaking compat for people doing crazy things (we should set
2475 # the 400 and just return the ctx here IMO, letting finalize get called
2477 if ( $c->_handle_http_exception($_) ) {
2478 foreach my $err (@{$c->error}) {
2479 $c->log->error($err);
2482 $c->log->_flush if $c->log->can('_flush');
2483 $_->can('rethrow') ? $_->rethrow : croak $_;
2485 $c->response->status(400);
2486 $c->response->content_type('text/plain');
2487 $c->response->body('Bad Request');
2494 $c->{stash} = $c->stash;
2495 Scalar::Util::weaken($c->{stash});
2500 =head2 $c->prepare_action
2502 Prepares action. See L<Catalyst::Dispatcher>.
2506 sub prepare_action {
2508 my $ret = $c->dispatcher->prepare_action( $c, @_);
2511 foreach (@{$c->req->arguments}, @{$c->req->captures}) {
2512 $_ = $c->_handle_param_unicode_decoding($_);
2520 =head2 $c->prepare_body
2522 Prepares message body.
2529 return if $c->request->_has_body;
2531 # Initialize on-demand data
2532 $c->engine->prepare_body( $c, @_ );
2533 $c->prepare_parameters;
2534 $c->prepare_uploads;
2537 =head2 $c->prepare_body_chunk( $chunk )
2539 Prepares a chunk of data before sending it to L<HTTP::Body>.
2541 See L<Catalyst::Engine>.
2545 sub prepare_body_chunk {
2547 $c->engine->prepare_body_chunk( $c, @_ );
2550 =head2 $c->prepare_body_parameters
2552 Prepares body parameters.
2556 sub prepare_body_parameters {
2558 $c->request->prepare_body_parameters( $c, @_ );
2561 =head2 $c->prepare_connection
2563 Prepares connection.
2567 sub prepare_connection {
2569 $c->request->prepare_connection($c);
2572 =head2 $c->prepare_cookies
2574 Prepares cookies by ensuring that the attribute on the request
2575 object has been built.
2579 sub prepare_cookies { my $c = shift; $c->request->cookies }
2581 =head2 $c->prepare_headers
2583 Prepares request headers by ensuring that the attribute on the request
2584 object has been built.
2588 sub prepare_headers { my $c = shift; $c->request->headers }
2590 =head2 $c->prepare_parameters
2592 Prepares parameters.
2596 sub prepare_parameters {
2598 $c->prepare_body_parameters;
2599 $c->engine->prepare_parameters( $c, @_ );
2602 =head2 $c->prepare_path
2604 Prepares path and base.
2608 sub prepare_path { my $c = shift; $c->engine->prepare_path( $c, @_ ) }
2610 =head2 $c->prepare_query_parameters
2612 Prepares query parameters.
2616 sub prepare_query_parameters {
2619 $c->engine->prepare_query_parameters( $c, @_ );
2622 =head2 $c->log_request
2624 Writes information about the request to the debug logs. This includes:
2628 =item * Request method, path, and remote IP address
2630 =item * Query keywords (see L<Catalyst::Request/query_keywords>)
2632 =item * Request parameters
2634 =item * File uploads
2643 return unless $c->debug;
2645 my($dump) = grep {$_->[0] eq 'Request' } $c->dump_these;
2646 my $request = $dump->[1];
2648 my ( $method, $path, $address ) = ( $request->method, $request->path, $request->address );
2650 $path = '/' unless length $path;
2653 $path =~ s/%([0-9A-Fa-f]{2})/chr(hex($1))/eg;
2654 $path = decode_utf8($path);
2656 $c->log->debug(qq/"$method" request for "$path" from "$address"/);
2658 $c->log_request_headers($request->headers);
2660 if ( my $keywords = $request->query_keywords ) {
2661 $c->log->debug("Query keywords are: $keywords");
2664 $c->log_request_parameters( query => $request->query_parameters, $request->_has_body ? (body => $request->body_parameters) : () );
2666 $c->log_request_uploads($request);
2669 =head2 $c->log_response
2671 Writes information about the response to the debug logs by calling
2672 C<< $c->log_response_status_line >> and C<< $c->log_response_headers >>.
2679 return unless $c->debug;
2681 my($dump) = grep {$_->[0] eq 'Response' } $c->dump_these;
2682 my $response = $dump->[1];
2684 $c->log_response_status_line($response);
2685 $c->log_response_headers($response->headers);
2688 =head2 $c->log_response_status_line($response)
2690 Writes one line of information about the response to the debug logs. This includes:
2694 =item * Response status code
2696 =item * Content-Type header (if present)
2698 =item * Content-Length header (if present)
2704 sub log_response_status_line {
2705 my ($c, $response) = @_;
2709 'Response Code: %s; Content-Type: %s; Content-Length: %s',
2710 $response->status || 'unknown',
2711 $response->headers->header('Content-Type') || 'unknown',
2712 $response->headers->header('Content-Length') || 'unknown'
2717 =head2 $c->log_response_headers($headers);
2719 Hook method which can be wrapped by plugins to log the response headers.
2720 No-op in the default implementation.
2724 sub log_response_headers {}
2726 =head2 $c->log_request_parameters( query => {}, body => {} )
2728 Logs request parameters to debug logs
2732 sub log_request_parameters {
2734 my %all_params = @_;
2736 return unless $c->debug;
2738 my $column_width = Catalyst::Utils::term_width() - 44;
2739 foreach my $type (qw(query body)) {
2740 my $params = $all_params{$type};
2741 next if ! keys %$params;
2742 my $t = Text::SimpleTable->new( [ 35, 'Parameter' ], [ $column_width, 'Value' ] );
2743 for my $key ( sort keys %$params ) {
2744 my $param = $params->{$key};
2745 my $value = defined($param) ? $param : '';
2746 $t->row( $key, ref $value eq 'ARRAY' ? ( join ', ', @$value ) : $value );
2748 $c->log->debug( ucfirst($type) . " Parameters are:\n" . $t->draw );
2752 =head2 $c->log_request_uploads
2754 Logs file uploads included in the request to the debug logs.
2755 The parameter name, filename, file type, and file size are all included in
2760 sub log_request_uploads {
2762 my $request = shift;
2763 return unless $c->debug;
2764 my $uploads = $request->uploads;
2765 if ( keys %$uploads ) {
2766 my $t = Text::SimpleTable->new(
2767 [ 12, 'Parameter' ],
2772 for my $key ( sort keys %$uploads ) {
2773 my $upload = $uploads->{$key};
2774 for my $u ( ref $upload eq 'ARRAY' ? @{$upload} : ($upload) ) {
2775 $t->row( $key, $u->filename, $u->type, $u->size );
2778 $c->log->debug( "File Uploads are:\n" . $t->draw );
2782 =head2 $c->log_request_headers($headers);
2784 Hook method which can be wrapped by plugins to log the request headers.
2785 No-op in the default implementation.
2789 sub log_request_headers {}
2791 =head2 $c->log_headers($type => $headers)
2793 Logs L<HTTP::Headers> (either request or response) to the debug logs.
2800 my $headers = shift; # an HTTP::Headers instance
2802 return unless $c->debug;
2804 my $column_width = Catalyst::Utils::term_width() - 28;
2805 my $t = Text::SimpleTable->new( [ 15, 'Header Name' ], [ $column_width, 'Value' ] );
2808 my ( $name, $value ) = @_;
2809 $t->row( $name, $value );
2812 $c->log->debug( ucfirst($type) . " Headers:\n" . $t->draw );
2816 =head2 $c->prepare_read
2818 Prepares the input for reading.
2822 sub prepare_read { my $c = shift; $c->engine->prepare_read( $c, @_ ) }
2824 =head2 $c->prepare_request
2826 Prepares the engine request.
2830 sub prepare_request { my $c = shift; $c->engine->prepare_request( $c, @_ ) }
2832 =head2 $c->prepare_uploads
2838 sub prepare_uploads {
2840 $c->engine->prepare_uploads( $c, @_ );
2843 =head2 $c->prepare_write
2845 Prepares the output for writing.
2849 sub prepare_write { my $c = shift; $c->engine->prepare_write( $c, @_ ) }
2851 =head2 $c->request_class
2853 Returns or sets the request class. Defaults to L<Catalyst::Request>.
2855 =head2 $app->request_class_traits
2857 An arrayref of L<Moose::Role>s which are applied to the request class. You can
2858 name the full namespace of the role, or a namespace suffix, which will then
2859 be tried against the following standard namespace prefixes.
2861 $MyApp::TraitFor::Request::$trait_suffix
2862 Catalyst::TraitFor::Request::$trait_suffix
2864 So for example if you set:
2866 MyApp->request_class_traits(['Foo']);
2868 We try each possible role in turn (and throw an error if none load)
2871 MyApp::TraitFor::Request::Foo
2872 Catalyst::TraitFor::Request::Foo
2874 The namespace part 'TraitFor::Request' was chosen to assist in backwards
2875 compatibility with L<CatalystX::RoleApplicator> which previously provided
2876 these features in a stand alone package.
2878 =head2 $app->composed_request_class
2880 This is the request class which has been composed with any request_class_traits.
2882 =head2 $c->response_class
2884 Returns or sets the response class. Defaults to L<Catalyst::Response>.
2886 =head2 $app->response_class_traits
2888 An arrayref of L<Moose::Role>s which are applied to the response class. You can
2889 name the full namespace of the role, or a namespace suffix, which will then
2890 be tried against the following standard namespace prefixes.
2892 $MyApp::TraitFor::Response::$trait_suffix
2893 Catalyst::TraitFor::Response::$trait_suffix
2895 So for example if you set:
2897 MyApp->response_class_traits(['Foo']);
2899 We try each possible role in turn (and throw an error if none load)
2902 MyApp::TraitFor::Response::Foo
2903 Catalyst::TraitFor::Responset::Foo
2905 The namespace part 'TraitFor::Response' was chosen to assist in backwards
2906 compatibility with L<CatalystX::RoleApplicator> which previously provided
2907 these features in a stand alone package.
2910 =head2 $app->composed_response_class
2912 This is the request class which has been composed with any response_class_traits.
2914 =head2 $c->read( [$maxlength] )
2916 Reads a chunk of data from the request body. This method is designed to
2917 be used in a while loop, reading C<$maxlength> bytes on every call.
2918 C<$maxlength> defaults to the size of the request if not specified.
2920 You have to set C<< MyApp->config(parse_on_demand => 1) >> to use this
2923 Warning: If you use read(), Catalyst will not process the body,
2924 so you will not be able to access POST parameters or file uploads via
2925 $c->request. You must handle all body parsing yourself.
2929 sub read { my $c = shift; return $c->request->read( @_ ) }
2939 $app->_make_immutable_if_needed;
2940 $app->engine_loader->needs_psgi_engine_compat_hack ?
2941 $app->engine->run($app, @_) :
2942 $app->engine->run( $app, $app->_finalized_psgi_app, @_ );
2945 sub _make_immutable_if_needed {
2947 my $meta = find_meta($class);
2948 my $isa_ca = $class->isa('Class::Accessor::Fast') || $class->isa('Class::Accessor');
2951 && ! { $meta->immutable_options }->{replace_constructor}
2954 warn("You made your application class ($class) immutable, "
2955 . "but did not inline the\nconstructor. "
2956 . "This will break catalyst, as your app \@ISA "
2957 . "Class::Accessor(::Fast)?\nPlease pass "
2958 . "(replace_constructor => 1)\nwhen making your class immutable.\n");
2960 unless ($meta->is_immutable) {
2961 # XXX - FIXME warning here as you should make your app immutable yourself.
2962 $meta->make_immutable(
2963 replace_constructor => 1,
2968 =head2 $c->set_action( $action, $code, $namespace, $attrs )
2970 Sets an action in a given namespace.
2974 sub set_action { my $c = shift; $c->dispatcher->set_action( $c, @_ ) }
2976 =head2 $c->setup_actions($component)
2978 Sets up actions for a component.
2982 sub setup_actions { my $c = shift; $c->dispatcher->setup_actions( $c, @_ ) }
2984 =head2 $c->setup_components
2986 This method is called internally to set up the application's components.
2988 It finds modules by calling the L<locate_components> method, expands them to
2989 package names with the L<expand_component_module> method, and then installs
2990 each component into the application.
2992 The C<setup_components> config option is passed to both of the above methods.
2994 Installation of each component is performed by the L<setup_component> method,
2999 sub setup_components {
3002 my $config = $class->config->{ setup_components };
3004 my @comps = $class->locate_components($config);
3005 my %comps = map { $_ => 1 } @comps;
3007 my $deprecatedcatalyst_component_names = grep { /::[CMV]::/ } @comps;
3008 $class->log->warn(qq{Your application is using the deprecated ::[MVC]:: type naming scheme.\n}.
3009 qq{Please switch your class names to ::Model::, ::View:: and ::Controller: as appropriate.\n}
3010 ) if $deprecatedcatalyst_component_names;
3012 for my $component ( @comps ) {
3014 # We pass ignore_loaded here so that overlay files for (e.g.)
3015 # Model::DBI::Schema sub-classes are loaded - if it's in @comps
3016 # we know M::P::O found a file on disk so this is safe
3018 Catalyst::Utils::ensure_class_loaded( $component, { ignore_loaded => 1 } );
3021 for my $component (@comps) {
3022 my $instance = $class->components->{ $component } = $class->delayed_setup_component($component);
3025 # Inject a component or wrap a stand alone class in an adaptor. This makes a list
3026 # of named components in the configuration that are not actually existing (not a
3029 my @injected = $class->setup_injected_components;
3031 # All components are registered, now we need to 'init' them.
3032 foreach my $component_name (@comps, @injected) {
3033 $class->components->{$component_name} = $class->components->{$component_name}->() if
3034 (ref($class->components->{$component_name}) || '') eq 'CODE';
3038 =head2 $app->setup_injected_components
3040 Called by setup_compoents to setup components that are injected.
3044 sub setup_injected_components {
3046 my @injected_components = keys %{$class->config->{inject_components} ||+{}};
3048 foreach my $injected_comp_name(@injected_components) {
3049 $class->setup_injected_component(
3050 $injected_comp_name,
3051 $class->config->{inject_components}->{$injected_comp_name});
3054 return map { $class ."::" . $_ }
3055 @injected_components;
3058 =head2 $app->setup_injected_component( $injected_component_name, $config )
3060 Setup a given injected component.
3064 sub setup_injected_component {
3065 my ($class, $injected_comp_name, $config) = @_;
3066 if(my $component_class = $config->{from_component}) {
3067 my @roles = @{$config->{roles} ||[]};
3068 Catalyst::Utils::inject_component(
3070 component => $component_class,
3071 (scalar(@roles) ? (traits => \@roles) : ()),
3072 as => $injected_comp_name);
3076 =head2 $app->inject_component($MyApp_Component_name => \%args);
3078 Add a component that is injected at setup:
3080 MyApp->inject_component( 'Model::Foo' => { from_component => 'Common::Foo' } );
3082 Must be called before ->setup. Expects a component name for your
3083 current application and \%args where
3087 =item from_component
3089 The target component being injected into your application
3093 An arrayref of L<Moose::Role>s that are applied to your component.
3099 MyApp->inject_component(
3101 from_component => 'Common::Model::Foo',
3102 roles => ['Role1', 'Role2'],
3105 =head2 $app->inject_components
3107 Inject a list of components:
3109 MyApp->inject_components(
3110 'Model::FooOne' => {
3111 from_component => 'Common::Model::Foo',
3112 roles => ['Role1', 'Role2'],
3114 'Model::FooTwo' => {
3115 from_component => 'Common::Model::Foo',
3116 roles => ['Role1', 'Role2'],
3121 sub inject_component {
3122 my ($app, $name, $args) = @_;
3123 die "Component $name exists" if
3124 $app->config->{inject_components}->{$name};
3125 $app->config->{inject_components}->{$name} = $args;
3128 sub inject_components {
3131 $app->inject_component(shift, shift);
3135 =head2 $c->locate_components( $setup_component_config )
3137 This method is meant to provide a list of component modules that should be
3138 setup for the application. By default, it will use L<Module::Pluggable>.
3140 Specify a C<setup_components> config option to pass additional options directly
3141 to L<Module::Pluggable>. To add additional search paths, specify a key named
3142 C<search_extra> as an array reference. Items in the array beginning with C<::>
3143 will have the application class name prepended to them.
3147 sub locate_components {
3151 my @paths = qw( ::M ::Model ::V ::View ::C ::Controller );
3152 my $extra = $config->{ search_extra } || [];
3154 unshift @paths, @$extra;
3156 my @comps = map { sort { length($a) <=> length($b) } Module::Pluggable::Object->new(
3157 search_path => [ map { s/^(?=::)/$class/; $_; } ($_) ],
3159 )->plugins } @paths;
3164 =head2 $c->expand_component_module( $component, $setup_component_config )
3166 Components found by C<locate_components> will be passed to this method, which
3167 is expected to return a list of component (package) names to be set up.
3171 sub expand_component_module {
3172 my ($class, $module) = @_;
3173 return Devel::InnerPackage::list_packages( $module );
3176 =head2 $app->delayed_setup_component
3178 Returns a coderef that points to a setup_component instance. Used
3179 internally for when you want to delay setup until the first time
3180 the component is called.
3184 sub delayed_setup_component {
3185 my($class, $component, @more) = @_;
3187 return my $instance = $class->setup_component($component, @more);
3191 =head2 $c->setup_component
3195 sub setup_component {
3196 my( $class, $component ) = @_;
3198 unless ( $component->can( 'COMPONENT' ) ) {
3202 my $config = $class->config_for($component);
3203 # Stash catalyst_component_name in the config here, so that custom COMPONENT
3204 # methods also pass it. local to avoid pointlessly shitting in config
3205 # for the debug screen, as $component is already the key name.
3206 local $config->{catalyst_component_name} = $component;
3208 my $instance = eval {
3209 $component->COMPONENT( $class, $config );
3213 Catalyst::Exception->throw(
3214 message => qq/Couldn't instantiate component "$component", "$error"/
3218 unless (blessed $instance) {
3219 my $metaclass = Moose::Util::find_meta($component);
3220 my $method_meta = $metaclass->find_method_by_name('COMPONENT');
3221 my $component_method_from = $method_meta->associated_metaclass->name;
3222 my $value = defined($instance) ? $instance : 'undef';
3223 Catalyst::Exception->throw(
3225 qq/Couldn't instantiate component "$component", COMPONENT() method (from $component_method_from) didn't return an object-like value (value was $value)./
3229 my @expanded_components = $instance->can('expand_modules')
3230 ? $instance->expand_modules( $component, $config )
3231 : $class->expand_component_module( $component, $config );
3232 for my $component (@expanded_components) {
3233 next if $class->components->{ $component };
3234 $class->components->{ $component } = $class->setup_component($component);
3240 =head2 $app->config_for( $component_name )
3242 Return the application level configuration (which is not yet merged with any
3243 local component configuration, via $component_class->config) for the named
3244 component or component object. Example:
3247 'Model::Foo' => { a => 1, b => 2},
3250 my $config = MyApp->config_for('MyApp::Model::Foo');
3252 In this case $config is the hashref C< {a=>1, b=>2} >.
3254 This is also handy for looking up configuration for a plugin, to make sure you follow
3255 existing L<Catalyst> standards for where a plugin should put its configuration.
3260 my ($class, $component_name) = @_;
3261 my $component_suffix = Catalyst::Utils::class2classsuffix($component_name);
3262 my $config = $class->config->{ $component_suffix } || {};
3267 =head2 $c->setup_dispatcher
3273 sub setup_dispatcher {
3274 my ( $class, $dispatcher ) = @_;
3277 $dispatcher = 'Catalyst::Dispatcher::' . $dispatcher;
3280 if ( my $env = Catalyst::Utils::env_value( $class, 'DISPATCHER' ) ) {
3281 $dispatcher = 'Catalyst::Dispatcher::' . $env;
3284 unless ($dispatcher) {
3285 $dispatcher = $class->dispatcher_class;
3288 load_class($dispatcher);
3290 # dispatcher instance
3291 $class->dispatcher( $dispatcher->new );
3294 =head2 $c->setup_engine
3301 my ($class, $requested_engine) = @_;
3303 if (!$class->engine_loader || $requested_engine) {
3304 $class->engine_loader(
3305 Catalyst::EngineLoader->new({
3306 application_name => $class,
3307 (defined $requested_engine
3308 ? (catalyst_engine_class => $requested_engine) : ()),
3313 $class->engine_loader->catalyst_engine_class;
3317 my ($class, $requested_engine) = @_;
3320 my $loader = $class->engine_loader;
3322 if (!$loader || $requested_engine) {
3323 $loader = Catalyst::EngineLoader->new({
3324 application_name => $class,
3325 (defined $requested_engine
3326 ? (requested_engine => $requested_engine) : ()),
3329 $class->engine_loader($loader);
3332 $loader->catalyst_engine_class;
3335 # Don't really setup_engine -- see _setup_psgi_app for explanation.
3336 return if $class->loading_psgi_file;
3338 load_class($engine);
3340 if ($ENV{MOD_PERL}) {
3341 my $apache = $class->engine_loader->auto;
3343 my $meta = find_meta($class);
3344 my $was_immutable = $meta->is_immutable;
3345 my %immutable_options = $meta->immutable_options;
3346 $meta->make_mutable if $was_immutable;
3348 $meta->add_method(handler => sub {
3350 my $psgi_app = $class->_finalized_psgi_app;
3351 $apache->call_app($r, $psgi_app);
3354 $meta->make_immutable(%immutable_options) if $was_immutable;
3357 $class->engine( $engine->new );
3362 ## This exists just to supply a prebuild psgi app for mod_perl and for the
3363 ## build in server support (back compat support for pre psgi port behavior).
3364 ## This is so that we don't build a new psgi app for each request when using
3365 ## the mod_perl handler or the built in servers (http and fcgi, etc).
3367 sub _finalized_psgi_app {
3370 unless ($app->_psgi_app) {
3371 my $psgi_app = $app->_setup_psgi_app;
3372 $app->_psgi_app($psgi_app);
3375 return $app->_psgi_app;
3378 ## Look for a psgi file like 'myapp_web.psgi' (if the app is MyApp::Web) in the
3379 ## home directory and load that and return it (just assume it is doing the
3380 ## right thing :) ). If that does not exist, call $app->psgi_app, wrap that
3381 ## in default_middleware and return it ( this is for backward compatibility
3382 ## with pre psgi port behavior ).
3384 sub _setup_psgi_app {
3387 for my $home (Path::Class::Dir->new($app->config->{home})) {
3388 my $psgi_file = $home->file(
3389 Catalyst::Utils::appprefix($app) . '.psgi',
3392 next unless -e $psgi_file;
3394 # If $psgi_file calls ->setup_engine, it's doing so to load
3395 # Catalyst::Engine::PSGI. But if it does that, we're only going to
3396 # throw away the loaded PSGI-app and load the 5.9 Catalyst::Engine
3397 # anyway. So set a flag (ick) that tells setup_engine not to populate
3398 # $c->engine or do any other things we might regret.
3400 $app->loading_psgi_file(1);
3401 my $psgi_app = Plack::Util::load_psgi($psgi_file);
3402 $app->loading_psgi_file(0);
3405 unless $app->engine_loader->needs_psgi_engine_compat_hack;
3408 Found a legacy Catalyst::Engine::PSGI .psgi file at ${psgi_file}.
3410 Its content has been ignored. Please consult the Catalyst::Upgrading
3411 documentation on how to upgrade from Catalyst::Engine::PSGI.
3415 return $app->apply_default_middlewares($app->psgi_app);
3418 =head2 $c->apply_default_middlewares
3420 Adds the following L<Plack> middlewares to your application, since they are
3421 useful and commonly needed:
3423 L<Plack::Middleware::LighttpdScriptNameFix> (if you are using Lighttpd),
3424 L<Plack::Middleware::IIS6ScriptNameFix> (always applied since this middleware
3425 is smart enough to conditionally apply itself).
3427 We will also automatically add L<Plack::Middleware::ReverseProxy> if we notice
3428 that your HTTP $env variable C<REMOTE_ADDR> is '127.0.0.1'. This is usually
3429 an indication that your server is running behind a proxy frontend. However in
3430 2014 this is often not the case. We preserve this code for backwards compatibility
3431 however I B<highly> recommend that if you are running the server behind a front
3432 end proxy that you clearly indicate so with the C<using_frontend_proxy> configuration
3433 setting to true for your environment configurations that run behind a proxy. This
3434 way if you change your front end proxy address someday your code would inexplicably
3435 stop working as expected.
3437 Additionally if we detect we are using Nginx, we add a bit of custom middleware
3438 to solve some problems with the way that server handles $ENV{PATH_INFO} and
3441 Please B<NOTE> that if you do use C<using_frontend_proxy> the middleware is now
3442 adding via C<registered_middleware> rather than this method.
3444 If you are using Lighttpd or IIS6 you may wish to apply these middlewares. In
3445 general this is no longer a common case but we have this here for backward
3451 sub apply_default_middlewares {
3452 my ($app, $psgi_app) = @_;
3454 # Don't add this conditional IF we are explicitly saying we want the
3455 # frontend proxy support. We don't need it here since if that is the
3456 # case it will be always loaded in the default_middleware.
3458 unless($app->config->{using_frontend_proxy}) {
3459 $psgi_app = Plack::Middleware::Conditional->wrap(
3461 builder => sub { Plack::Middleware::ReverseProxy->wrap($_[0]) },
3464 return if $app->config->{ignore_frontend_proxy};
3465 return $env->{REMOTE_ADDR} eq '127.0.0.1';
3470 # If we're running under Lighttpd, swap PATH_INFO and SCRIPT_NAME
3471 # http://lists.scsys.co.uk/pipermail/catalyst/2006-June/008361.html
3472 $psgi_app = Plack::Middleware::Conditional->wrap(
3474 builder => sub { Plack::Middleware::LighttpdScriptNameFix->wrap($_[0]) },
3477 return unless $env->{SERVER_SOFTWARE} && $env->{SERVER_SOFTWARE} =~ m!lighttpd[-/]1\.(\d+\.\d+)!;
3478 return unless $1 < 4.23;
3483 # we're applying this unconditionally as the middleware itself already makes
3484 # sure it doesn't fuck things up if it's not running under one of the right
3486 $psgi_app = Plack::Middleware::IIS6ScriptNameFix->wrap($psgi_app);
3488 # And another IIS issue, this time with IIS7.
3489 $psgi_app = Plack::Middleware::Conditional->wrap(
3491 builder => sub { Plack::Middleware::IIS7KeepAliveFix->wrap($_[0]) },
3494 return $env->{SERVER_SOFTWARE} && $env->{SERVER_SOFTWARE} =~ m!IIS/7\.[0-9]!;
3501 =head2 App->psgi_app
3505 Returns a PSGI application code reference for the catalyst application
3506 C<$c>. This is the bare application created without the C<apply_default_middlewares>
3507 method called. We do however apply C<registered_middleware> since those are
3508 integral to how L<Catalyst> functions. Also, unlike starting your application
3509 with a generated server script (via L<Catalyst::Devel> and C<catalyst.pl>) we do
3510 not attempt to return a valid L<PSGI> application using any existing C<${myapp}.psgi>
3511 scripts in your $HOME directory.
3513 B<NOTE> C<apply_default_middlewares> was originally created when the first PSGI
3514 port was done for v5.90000. These are middlewares that are added to achieve
3515 backward compatibility with older applications. If you start your application
3516 using one of the supplied server scripts (generated with L<Catalyst::Devel> and
3517 the project skeleton script C<catalyst.pl>) we apply C<apply_default_middlewares>
3518 automatically. This was done so that pre and post PSGI port applications would
3521 This is what you want to be using to retrieve the PSGI application code
3522 reference of your Catalyst application for use in a custom F<.psgi> or in your
3523 own created server modules.
3527 *to_app = \&psgi_app;
3531 my $psgi = $app->engine->build_psgi_app($app);
3532 return $app->Catalyst::Utils::apply_registered_middleware($psgi);
3535 =head2 $c->setup_home
3537 Sets up the home directory.
3542 my ( $class, $home ) = @_;
3544 if ( my $env = Catalyst::Utils::env_value( $class, 'HOME' ) ) {
3548 $home ||= Catalyst::Utils::home($class);
3551 #I remember recently being scolded for assigning config values like this
3552 $class->config->{home} ||= $home;
3553 $class->config->{root} ||= Path::Class::Dir->new($home)->subdir('root');
3557 =head2 $c->setup_encoding
3559 Sets up the input/output encoding. See L<ENCODING>
3563 sub setup_encoding {
3565 if( exists($c->config->{encoding}) && !defined($c->config->{encoding}) ) {
3566 # Ok, so the user has explicitly said "I don't want encoding..."
3569 my $enc = defined($c->config->{encoding}) ?
3570 delete $c->config->{encoding} : 'UTF-8'; # not sure why we delete it... (JNAP)
3575 =head2 handle_unicode_encoding_exception
3577 Hook to let you customize how encoding errors are handled. By default
3578 we just throw an exception and the default error page will pick it up.
3579 Receives a hashref of debug information. Example of call (from the
3580 Catalyst internals):
3582 my $decoded_after_fail = $c->handle_unicode_encoding_exception({
3583 param_value => $value,
3585 encoding_step => 'params',
3588 The calling code expects to receive a decoded string or an exception.
3590 You can override this for custom handling of unicode errors. By
3591 default we just die. If you want a custom response here, one approach
3592 is to throw an HTTP style exception, instead of returning a decoded
3593 string or throwing a generic exception.
3595 sub handle_unicode_encoding_exception {
3596 my ($c, $params) = @_;
3597 HTTP::Exception::BAD_REQUEST->throw(status_message=>$params->{error_msg});
3600 Alternatively you can 'catch' the error, stash it and write handling code later
3601 in your application:
3603 sub handle_unicode_encoding_exception {
3604 my ($c, $params) = @_;
3605 $c->stash(BAD_UNICODE_DATA=>$params);
3606 # return a dummy string.
3610 <B>NOTE:</b> Please keep in mind that once an error like this occurs,
3611 the request setup is still ongoing, which means the state of C<$c> and
3612 related context parts like the request and response may not be setup
3613 up correctly (since we haven't finished the setup yet). If you throw
3614 an exception the setup is aborted.
3618 sub handle_unicode_encoding_exception {
3619 my ( $self, $exception_ctx ) = @_;
3620 die $exception_ctx->{error_msg};
3623 # Some unicode helpers cargo culted from the old plugin. These could likely
3626 sub _handle_unicode_decoding {
3627 my ( $self, $value ) = @_;
3629 return unless defined $value;
3631 ## I think this mess is to support the old nested
3632 if ( ref $value eq 'ARRAY' ) {
3633 foreach ( @$value ) {
3634 $_ = $self->_handle_unicode_decoding($_);
3638 elsif ( ref $value eq 'HASH' ) {
3639 foreach (keys %$value) {
3640 my $encoded_key = $self->_handle_param_unicode_decoding($_);
3641 $value->{$encoded_key} = $self->_handle_unicode_decoding($value->{$_});
3643 # If the key was encoded we now have two (the original and current so
3644 # delete the original.
3645 delete $value->{$_} if $_ ne $encoded_key;
3650 return $self->_handle_param_unicode_decoding($value);
3654 sub _handle_param_unicode_decoding {
3655 my ( $self, $value, $check ) = @_;
3656 return unless defined $value; # not in love with just ignoring undefs - jnap
3657 return $value if blessed($value); #don't decode when the value is an object.
3659 my $enc = $self->encoding;
3661 return $value unless $enc; # don't decode if no encoding is specified
3663 $check ||= $self->_encode_check;
3665 $enc->decode( $value, $check);
3668 return $self->handle_unicode_encoding_exception({
3669 param_value => $value,
3671 encoding_step => 'params',
3676 =head2 $c->setup_log
3678 Sets up log by instantiating a L<Catalyst::Log|Catalyst::Log> object and
3679 passing it to C<log()>. Pass in a comma-delimited list of levels to set the
3682 This method also installs a C<debug> method that returns a true value into the
3683 catalyst subclass if the "debug" level is passed in the comma-delimited list,
3684 or if the C<$CATALYST_DEBUG> environment variable is set to a true value.
3686 Note that if the log has already been setup, by either a previous call to
3687 C<setup_log> or by a call such as C<< __PACKAGE__->log( MyLogger->new ) >>,
3688 that this method won't actually set up the log object.
3693 my ( $class, $levels ) = @_;
3696 $levels =~ s/^\s+//;
3697 $levels =~ s/\s+$//;
3698 my %levels = map { $_ => 1 } split /\s*,\s*/, $levels;
3700 my $env_debug = Catalyst::Utils::env_value( $class, 'DEBUG' );
3701 if ( defined $env_debug ) {
3702 $levels{debug} = 1 if $env_debug; # Ugly!
3703 delete($levels{debug}) unless $env_debug;
3706 unless ( $class->log ) {
3707 $class->log( Catalyst::Log->new(keys %levels) );
3710 if ( $levels{debug} ) {
3711 Class::MOP::get_metaclass_by_name($class)->add_method('debug' => sub { 1 });
3712 $class->log->debug('Debug messages enabled');
3716 =head2 $c->setup_plugins
3722 =head2 $c->setup_stats
3724 Sets up timing statistics class.
3729 my ( $class, $stats ) = @_;
3731 Catalyst::Utils::ensure_class_loaded($class->stats_class);
3733 my $env = Catalyst::Utils::env_value( $class, 'STATS' );
3734 if ( defined($env) ? $env : ($stats || $class->debug ) ) {
3735 Class::MOP::get_metaclass_by_name($class)->add_method('use_stats' => sub { 1 });
3736 $class->log->debug('Statistics enabled');
3741 =head2 $c->registered_plugins
3743 Returns a sorted list of the plugins which have either been stated in the
3746 If passed a given plugin name, it will report a boolean value indicating
3747 whether or not that plugin is loaded. A fully qualified name is required if
3748 the plugin name does not begin with C<Catalyst::Plugin::>.
3750 if ($c->registered_plugins('Some::Plugin')) {
3758 sub registered_plugins {
3760 return sort keys %{ $proto->_plugins } unless @_;
3762 return 1 if exists $proto->_plugins->{$plugin};
3763 return exists $proto->_plugins->{"Catalyst::Plugin::$plugin"};
3766 sub _register_plugin {
3767 my ( $proto, $plugin, $instant ) = @_;
3768 my $class = ref $proto || $proto;
3770 load_class( $plugin );
3771 $class->log->warn( "$plugin inherits from 'Catalyst::Component' - this is deprecated and will not work in 5.81" )
3772 if $plugin->isa( 'Catalyst::Component' );
3773 my $plugin_meta = Moose::Meta::Class->create($plugin);
3774 if (!$plugin_meta->has_method('new')
3775 && ( $plugin->isa('Class::Accessor::Fast') || $plugin->isa('Class::Accessor') ) ) {
3776 $plugin_meta->add_method('new', Moose::Object->meta->get_method('new'))
3778 if (!$instant && !$proto->_plugins->{$plugin}) {
3779 my $meta = Class::MOP::get_metaclass_by_name($class);
3780 $meta->superclasses($plugin, $meta->superclasses);
3782 $proto->_plugins->{$plugin} = 1;
3786 sub _default_plugins { return qw() }
3789 my ( $class, $plugins ) = @_;
3791 $class->_plugins( {} ) unless $class->_plugins;
3793 m/Unicode::Encoding/ ? do {
3795 'Unicode::Encoding plugin is auto-applied,'
3796 . ' please remove this from your appclass'
3797 . ' and make sure to define "encoding" config'
3799 unless (exists $class->config->{'encoding'}) {
3800 $class->config->{'encoding'} = 'UTF-8';
3805 push @$plugins, $class->_default_plugins;
3806 $plugins = Data::OptList::mkopt($plugins || []);
3809 [ Catalyst::Utils::resolve_namespace(
3810 $class . '::Plugin',
3811 'Catalyst::Plugin', $_->[0]
3817 for my $plugin ( reverse @plugins ) {
3818 load_class($plugin->[0], $plugin->[1]);
3819 my $meta = find_meta($plugin->[0]);
3820 next if $meta && $meta->isa('Moose::Meta::Role');
3822 $class->_register_plugin($plugin->[0]);
3826 map { $_->[0]->name, $_->[1] }
3827 grep { blessed($_->[0]) && $_->[0]->isa('Moose::Meta::Role') }
3828 map { [find_meta($_->[0]), $_->[1]] }
3831 Moose::Util::apply_all_roles(
3837 =head2 default_middleware
3839 Returns a list of instantiated PSGI middleware objects which is the default
3840 middleware that is active for this application (taking any configuration
3841 options into account, excluding your custom added middleware via the C<psgi_middleware>
3842 configuration option). You can override this method if you wish to change
3843 the default middleware (although do so at risk since some middleware is vital
3844 to application function.)
3846 The current default middleware list is:
3848 Catalyst::Middleware::Stash
3849 Plack::Middleware::HTTPExceptions
3850 Plack::Middleware::RemoveRedundantBody
3851 Plack::Middleware::FixMissingBodyInRedirect
3852 Plack::Middleware::ContentLength
3853 Plack::Middleware::MethodOverride
3854 Plack::Middleware::Head
3856 If the configuration setting C<using_frontend_proxy> is true we add:
3858 Plack::Middleware::ReverseProxy
3860 If the configuration setting C<using_frontend_proxy_path> is true we add:
3862 Plack::Middleware::ReverseProxyPath
3864 But B<NOTE> that L<Plack::Middleware::ReverseProxyPath> is not a dependency of the
3865 L<Catalyst> distribution so if you want to use this option you should add it to
3866 your project distribution file.
3868 These middlewares will be added at L</setup_middleware> during the
3869 L</setup> phase of application startup.
3873 sub default_middleware {
3876 Catalyst::Middleware::Stash->new,
3877 Plack::Middleware::HTTPExceptions->new,
3878 Plack::Middleware::RemoveRedundantBody->new,
3879 Plack::Middleware::FixMissingBodyInRedirect->new,
3880 Plack::Middleware::ContentLength->new,
3881 Plack::Middleware::MethodOverride->new,
3882 Plack::Middleware::Head->new);
3884 if($class->config->{using_frontend_proxy}) {
3885 push @mw, Plack::Middleware::ReverseProxy->new;
3888 if($class->config->{using_frontend_proxy_path}) {
3889 if(Class::Load::try_load_class('Plack::Middleware::ReverseProxyPath')) {
3890 push @mw, Plack::Middleware::ReverseProxyPath->new;
3892 $class->log->error("Cannot use configuration 'using_frontend_proxy_path' because 'Plack::Middleware::ReverseProxyPath' is not installed");
3899 =head2 registered_middlewares
3901 Read only accessor that returns an array of all the middleware in the order
3902 that they were added (which is the REVERSE of the order they will be applied).
3904 The values returned will be either instances of L<Plack::Middleware> or of a
3905 compatible interface, or a coderef, which is assumed to be inlined middleware
3907 =head2 setup_middleware (?@middleware)
3909 Read configuration information stored in configuration key C<psgi_middleware> or
3912 See under L</CONFIGURATION> information regarding C<psgi_middleware> and how
3913 to use it to enable L<Plack::Middleware>
3915 This method is automatically called during 'setup' of your application, so
3916 you really don't need to invoke it. However you may do so if you find the idea
3917 of loading middleware via configuration weird :). For example:
3923 __PACKAGE__->setup_middleware('Head');
3926 When we read middleware definitions from configuration, we reverse the list
3927 which sounds odd but is likely how you expect it to work if you have prior
3928 experience with L<Plack::Builder> or if you previously used the plugin
3929 L<Catalyst::Plugin::EnableMiddleware> (which is now considered deprecated)
3931 So basically your middleware handles an incoming request from the first
3932 registered middleware, down and handles the response from the last middleware
3937 sub registered_middlewares {
3939 if(my $middleware = $class->_psgi_middleware) {
3940 my @mw = ($class->default_middleware, @$middleware);
3942 if($class->config->{using_frontend_proxy}) {
3943 push @mw, Plack::Middleware::ReverseProxy->new;
3948 die "You cannot call ->registered_middlewares until middleware has been setup";
3952 sub setup_middleware {
3954 my @middleware_definitions;
3956 # If someone calls this method you can add middleware with args. However if its
3957 # called without an arg we need to setup the configuration middleware.
3959 @middleware_definitions = reverse(@_);
3961 @middleware_definitions = reverse(@{$class->config->{'psgi_middleware'}||[]})
3962 unless $class->finalized_default_middleware;
3963 $class->finalized_default_middleware(1); # Only do this once, just in case some people call setup over and over...
3966 my @middleware = ();
3967 while(my $next = shift(@middleware_definitions)) {
3969 if(Scalar::Util::blessed $next && $next->can('wrap')) {
3970 push @middleware, $next;
3971 } elsif(ref $next eq 'CODE') {
3972 push @middleware, $next;
3973 } elsif(ref $next eq 'HASH') {
3974 my $namespace = shift @middleware_definitions;
3975 my $mw = $class->Catalyst::Utils::build_middleware($namespace, %$next);
3976 push @middleware, $mw;
3978 die "I can't handle middleware definition ${\ref $next}";
3981 my $mw = $class->Catalyst::Utils::build_middleware($next);
3982 push @middleware, $mw;
3986 my @existing = @{$class->_psgi_middleware || []};
3987 $class->_psgi_middleware([@middleware,@existing,]);
3990 =head2 registered_data_handlers
3992 A read only copy of registered Data Handlers returned as a Hash, where each key
3993 is a content type and each value is a subref that attempts to decode that content
3996 =head2 setup_data_handlers (?@data_handler)
3998 Read configuration information stored in configuration key C<data_handlers> or
4001 See under L</CONFIGURATION> information regarding C<data_handlers>.
4003 This method is automatically called during 'setup' of your application, so
4004 you really don't need to invoke it.
4006 =head2 default_data_handlers
4008 Default Data Handlers that come bundled with L<Catalyst>. Currently there are
4009 only two default data handlers, for 'application/json' and an alternative to
4010 'application/x-www-form-urlencoded' which supposed nested form parameters via
4011 L<CGI::Struct> or via L<CGI::Struct::XS> IF you've installed it.
4013 The 'application/json' data handler is used to parse incoming JSON into a Perl
4014 data structure. It used either L<JSON::MaybeXS> or L<JSON>, depending on which
4015 is installed. This allows you to fail back to L<JSON:PP>, which is a Pure Perl
4016 JSON decoder, and has the smallest dependency impact.
4018 Because we don't wish to add more dependencies to L<Catalyst>, if you wish to
4019 use this new feature we recommend installing L<JSON> or L<JSON::MaybeXS> in
4020 order to get the best performance. You should add either to your dependency
4021 list (Makefile.PL, dist.ini, cpanfile, etc.)
4025 sub registered_data_handlers {
4027 if(my $data_handlers = $class->_data_handlers) {
4028 return %$data_handlers;
4030 $class->setup_data_handlers;
4031 return $class->registered_data_handlers;
4035 sub setup_data_handlers {
4036 my ($class, %data_handler_callbacks) = @_;
4037 %data_handler_callbacks = (
4038 %{$class->default_data_handlers},
4039 %{$class->config->{'data_handlers'}||+{}},
4040 %data_handler_callbacks);
4042 $class->_data_handlers(\%data_handler_callbacks);
4045 sub default_data_handlers {
4048 'application/x-www-form-urlencoded' => sub {
4049 my ($fh, $req) = @_;
4050 my $params = $req->_use_hash_multivalue ? $req->body_parameters->mixed : $req->body_parameters;
4051 Class::Load::load_first_existing_class('CGI::Struct::XS', 'CGI::Struct')
4052 ->can('build_cgi_struct')->($params);
4054 'application/json' => sub {
4055 my ($fh, $req) = @_;
4056 my $parser = Class::Load::load_first_existing_class('JSON::MaybeXS', 'JSON');
4060 $slurped = $fh->getline;
4061 $parser->can("decode_json")->($slurped); # decode_json does utf8 decoding for us
4062 } || Catalyst::Exception->throw(sprintf "Error Parsing POST '%s', Error: %s", (defined($slurped) ? $slurped : 'undef') ,$@);
4067 sub _handle_http_exception {
4068 my ( $self, $error ) = @_;
4070 !$self->config->{always_catch_http_exceptions}
4073 $error->can('as_psgi')
4074 || ( $error->can('code')
4075 && $error->code =~ m/^[1-5][0-9][0-9]$/ )
4085 Returns an arrayref of the internal execution stack (actions that are
4086 currently executing).
4090 Returns the current timing statistics object. By default Catalyst uses
4091 L<Catalyst::Stats|Catalyst::Stats>, but can be set otherwise with
4092 L<< stats_class|/"$c->stats_class" >>.
4094 Even if L<< -Stats|/"-Stats" >> is not enabled, the stats object is still
4095 available. By enabling it with C< $c->stats->enabled(1) >, it can be used to
4096 profile explicitly, although MyApp.pm still won't profile nor output anything
4099 =head2 $c->stats_class
4101 Returns or sets the stats (timing statistics) class. L<Catalyst::Stats|Catalyst::Stats> is used by default.
4103 =head2 $app->stats_class_traits
4105 A arrayref of L<Moose::Role>s that are applied to the stats_class before creating it.
4107 =head2 $app->composed_stats_class
4109 this is the stats_class composed with any 'stats_class_traits'. You can
4110 name the full namespace of the role, or a namespace suffix, which will then
4111 be tried against the following standard namespace prefixes.
4113 $MyApp::TraitFor::Stats::$trait_suffix
4114 Catalyst::TraitFor::Stats::$trait_suffix
4116 So for example if you set:
4118 MyApp->stats_class_traits(['Foo']);
4120 We try each possible role in turn (and throw an error if none load)
4123 MyApp::TraitFor::Stats::Foo
4124 Catalyst::TraitFor::Stats::Foo
4126 The namespace part 'TraitFor::Stats' was chosen to assist in backwards
4127 compatibility with L<CatalystX::RoleApplicator> which previously provided
4128 these features in a stand alone package.
4130 =head2 $c->use_stats
4132 Returns 1 when L<< stats collection|/"-Stats" >> is enabled.
4134 Note that this is a static method, not an accessor and should be overridden
4135 by declaring C<sub use_stats { 1 }> in your MyApp.pm, not by calling C<< $c->use_stats(1) >>.
4142 =head2 $c->write( $data )
4144 Writes $data to the output stream. When using this method directly, you
4145 will need to manually set the C<Content-Length> header to the length of
4146 your output data, if known.
4153 # Finalize headers if someone manually writes output (for compat)
4154 $c->finalize_headers;
4156 return $c->response->write( @_ );
4161 Returns the Catalyst version number. Mostly useful for "powered by"
4162 messages in template systems.
4166 sub version { return $Catalyst::VERSION }
4168 =head1 CONFIGURATION
4170 There are a number of 'base' config variables which can be set:
4176 C<always_catch_http_exceptions> - As of version 5.90060 Catalyst
4177 rethrows errors conforming to the interface described by
4178 L<Plack::Middleware::HTTPExceptions> and lets the middleware deal with it.
4179 Set true to get the deprecated behaviour and have Catalyst catch HTTP exceptions.
4183 C<default_model> - The default model picked if you say C<< $c->model >>. See L<< /$c->model($name) >>.
4187 C<default_view> - The default view to be rendered or returned when C<< $c->view >> is called. See L<< /$c->view($name) >>.
4191 C<disable_component_resolution_regex_fallback> - Turns
4192 off the deprecated component resolution functionality so
4193 that if any of the component methods (e.g. C<< $c->controller('Foo') >>)
4194 are called then regex search will not be attempted on string values and
4195 instead C<undef> will be returned.
4199 C<home> - The application home directory. In an uninstalled application,
4200 this is the top level application directory. In an installed application,
4201 this will be the directory containing C<< MyApp.pm >>.
4205 C<ignore_frontend_proxy> - See L</PROXY SUPPORT>
4209 C<name> - The name of the application in debug messages and the debug and
4214 C<parse_on_demand> - The request body (for example file uploads) will not be parsed
4215 until it is accessed. This allows you to (for example) check authentication (and reject
4216 the upload) before actually receiving all the data. See L</ON-DEMAND PARSER>
4220 C<root> - The root directory for templates. Usually this is just a
4221 subdirectory of the home directory, but you can set it to change the
4222 templates to a different directory.
4226 C<search_extra> - Array reference passed to Module::Pluggable to for additional
4227 namespaces from which components will be loaded (and constructed and stored in
4228 C<< $c->components >>).
4232 C<show_internal_actions> - If true, causes internal actions such as C<< _DISPATCH >>
4233 to be shown in hit debug tables in the test server.
4237 C<use_request_uri_for_path> - Controls if the C<REQUEST_URI> or C<PATH_INFO> environment
4238 variable should be used for determining the request path.
4240 Most web server environments pass the requested path to the application using environment variables,
4241 from which Catalyst has to reconstruct the request base (i.e. the top level path to / in the application,
4242 exposed as C<< $c->request->base >>) and the request path below that base.
4244 There are two methods of doing this, both of which have advantages and disadvantages. Which method is used
4245 is determined by the C<< $c->config(use_request_uri_for_path) >> setting (which can either be true or false).
4249 =item use_request_uri_for_path => 0
4251 This is the default (and the) traditional method that Catalyst has used for determining the path information.
4252 The path is generated from a combination of the C<PATH_INFO> and C<SCRIPT_NAME> environment variables.
4253 The allows the application to behave correctly when C<mod_rewrite> is being used to redirect requests
4254 into the application, as these variables are adjusted by mod_rewrite to take account for the redirect.
4256 However this method has the major disadvantage that it is impossible to correctly decode some elements
4257 of the path, as RFC 3875 says: "C<< Unlike a URI path, the PATH_INFO is not URL-encoded, and cannot
4258 contain path-segment parameters. >>" This means PATH_INFO is B<always> decoded, and therefore Catalyst
4259 can't distinguish / vs %2F in paths (in addition to other encoded values).
4261 =item use_request_uri_for_path => 1
4263 This method uses the C<REQUEST_URI> and C<SCRIPT_NAME> environment variables. As C<REQUEST_URI> is never
4264 decoded, this means that applications using this mode can correctly handle URIs including the %2F character
4265 (i.e. with C<AllowEncodedSlashes> set to C<On> in Apache).
4267 Given that this method of path resolution is provably more correct, it is recommended that you use
4268 this unless you have a specific need to deploy your application in a non-standard environment, and you are
4269 aware of the implications of not being able to handle encoded URI paths correctly.
4271 However it also means that in a number of cases when the app isn't installed directly at a path, but instead
4272 is having paths rewritten into it (e.g. as a .cgi/fcgi in a public_html directory, with mod_rewrite in a
4273 .htaccess file, or when SSI is used to rewrite pages into the app, or when sub-paths of the app are exposed
4274 at other URIs than that which the app is 'normally' based at with C<mod_rewrite>), the resolution of
4275 C<< $c->request->base >> will be incorrect.
4281 C<using_frontend_proxy> - See L</PROXY SUPPORT>.
4285 C<using_frontend_proxy_path> - Enabled L<Plack::Middleware::ReverseProxyPath> on your application (if
4286 installed, otherwise log an error). This is useful if your application is not running on the
4287 'root' (or /) of your host server. B<NOTE> if you use this feature you should add the required
4288 middleware to your project dependency list since its not automatically a dependency of L<Catalyst>.
4289 This has been done since not all people need this feature and we wish to restrict the growth of
4290 L<Catalyst> dependencies.
4294 C<encoding> - See L</ENCODING>
4296 This now defaults to 'UTF-8'. You my turn it off by setting this configuration
4301 C<abort_chain_on_error_fix>
4303 When there is an error in an action chain, the default behavior is to continue
4304 processing the remaining actions and then catch the error upon chain end. This
4305 can lead to running actions when the application is in an unexpected state. If
4306 you have this issue, setting this config value to true will promptly exit a
4307 chain when there is an error raised in any action (thus terminating the chain
4312 __PACKAGE__->config(abort_chain_on_error_fix => 1);
4314 In the future this might become the default behavior.
4318 C<use_hash_multivalue_in_request>
4320 In L<Catalyst::Request> the methods C<query_parameters>, C<body_parametes>
4321 and C<parameters> return a hashref where values might be scalar or an arrayref
4322 depending on the incoming data. In many cases this can be undesirable as it
4323 leads one to writing defensive code like the following:
4325 my ($val) = ref($c->req->parameters->{a}) ?
4326 @{$c->req->parameters->{a}} :
4327 $c->req->parameters->{a};
4329 Setting this configuration item to true will make L<Catalyst> populate the
4330 attributes underlying these methods with an instance of L<Hash::MultiValue>
4331 which is used by L<Plack::Request> and others to solve this very issue. You
4332 may prefer this behavior to the default, if so enable this option (be warned
4333 if you enable it in a legacy application we are not sure if it is completely
4334 backwardly compatible).
4338 C<skip_complex_post_part_handling>
4340 When creating body parameters from a POST, if we run into a multipart POST
4341 that does not contain uploads, but instead contains inlined complex data
4342 (very uncommon) we cannot reliably convert that into field => value pairs. So
4343 instead we create an instance of L<Catalyst::Request::PartData>. If this causes
4344 issue for you, you can disable this by setting C<skip_complex_post_part_handling>
4345 to true (default is false).
4349 C<skip_body_param_unicode_decoding>
4351 Generally we decode incoming POST params based on your declared encoding (the
4352 default for this is to decode UTF-8). If this is causing you trouble and you
4353 do not wish to turn all encoding support off (with the C<encoding> configuration
4354 parameter) you may disable this step atomically by setting this configuration
4359 C<do_not_decode_query>
4361 If true, then do not try to character decode any wide characters in your
4362 request URL query or keywords. Most readings of the relevant specifications
4363 suggest these should be UTF-* encoded, which is the default that L<Catalyst>
4364 will use, however if you are creating a lot of URLs manually or have external
4365 evil clients, this might cause you trouble. If you find the changes introduced
4366 in Catalyst version 5.90080+ break some of your query code, you may disable
4367 the UTF-8 decoding globally using this configuration.
4369 This setting takes precedence over C<default_query_encoding>
4373 C<do_not_check_query_encoding>
4375 Catalyst versions 5.90080 - 5.90106 would decode query parts of an incoming
4376 request but would not raise an exception when the decoding failed due to
4377 incorrect unicode. It now does, but if this change is giving you trouble
4378 you may disable it by setting this configuration to true.
4382 C<default_query_encoding>
4384 By default we decode query and keywords in your request URL using UTF-8, which
4385 is our reading of the relevant specifications. This setting allows one to
4386 specify a fixed value for how to decode your query. You might need this if
4387 you are doing a lot of custom encoding of your URLs and not using UTF-8.
4391 C<use_chained_args_0_special_case>
4393 In older versions of Catalyst, when more than one action matched the same path
4394 AND all those matching actions declared Args(0), we'd break the tie by choosing
4395 the first action defined. We now normalized how Args(0) works so that it
4396 follows the same rule as Args(N), which is to say when we need to break a tie
4397 we choose the LAST action defined. If this breaks your code and you don't
4398 have time to update to follow the new normalized approach, you may set this
4399 value to true and it will globally revert to the original chaining behavior.
4403 C<psgi_middleware> - See L<PSGI MIDDLEWARE>.
4407 C<data_handlers> - See L<DATA HANDLERS>.
4411 C<stats_class_traits>
4413 An arrayref of L<Moose::Role>s that get composed into your stats class.
4417 C<request_class_traits>
4419 An arrayref of L<Moose::Role>s that get composed into your request class.
4423 C<response_class_traits>
4425 An arrayref of L<Moose::Role>s that get composed into your response class.
4429 C<inject_components>
4431 A Hashref of L<Catalyst::Component> subclasses that are 'injected' into configuration.
4435 inject_components => {
4436 'Controller::Err' => { from_component => 'Local::Controller::Errors' },
4437 'Model::Zoo' => { from_component => 'Local::Model::Foo' },
4438 'Model::Foo' => { from_component => 'Local::Model::Foo', roles => ['TestRole'] },
4440 'Controller::Err' => { a => 100, b=>200, namespace=>'error' },
4441 'Model::Zoo' => { a => 2 },
4442 'Model::Foo' => { a => 100 },
4445 Generally L<Catalyst> looks for components in your Model/View or Controller directories.
4446 However for cases when you which to use an existing component and you don't need any
4447 customization (where for when you can apply a role to customize it) you may inject those
4448 components into your application. Please note any configuration should be done 'in the
4449 normal way', with a key under configuration named after the component affix, as in the
4452 Using this type of injection allows you to construct significant amounts of your application
4453 with only configuration!. This may or may not lead to increased code understanding.
4455 Please not you may also call the ->inject_components application method as well, although
4456 you must do so BEFORE setup.
4462 Generally when you throw an exception inside an Action (or somewhere in
4463 your stack, such as in a model that an Action is calling) that exception
4464 is caught by Catalyst and unless you either catch it yourself (via eval
4465 or something like L<Try::Tiny> or by reviewing the L</error> stack, it
4466 will eventually reach L</finalize_errors> and return either the debugging
4467 error stack page, or the default error page. However, if your exception
4468 can be caught by L<Plack::Middleware::HTTPExceptions>, L<Catalyst> will
4469 instead rethrow it so that it can be handled by that middleware (which
4470 is part of the default middleware). For example this would allow
4472 use HTTP::Throwable::Factory 'http_throw';
4474 sub throws_exception :Local {
4475 my ($self, $c) = @_;
4477 http_throw(SeeOther => { location =>
4478 $c->uri_for($self->action_for('redirect')) });
4482 =head1 INTERNAL ACTIONS
4484 Catalyst uses internal actions like C<_DISPATCH>, C<_BEGIN>, C<_AUTO>,
4485 C<_ACTION>, and C<_END>. These are by default not shown in the private
4486 action table, but you can make them visible with a config parameter.
4488 MyApp->config(show_internal_actions => 1);
4490 =head1 ON-DEMAND PARSER
4492 The request body is usually parsed at the beginning of a request,
4493 but if you want to handle input yourself, you can enable on-demand
4494 parsing with a config parameter.
4496 MyApp->config(parse_on_demand => 1);
4498 =head1 PROXY SUPPORT
4500 Many production servers operate using the common double-server approach,
4501 with a lightweight frontend web server passing requests to a larger
4502 backend server. An application running on the backend server must deal
4503 with two problems: the remote user always appears to be C<127.0.0.1> and
4504 the server's hostname will appear to be C<localhost> regardless of the
4505 virtual host that the user connected through.
4507 Catalyst will automatically detect this situation when you are running
4508 the frontend and backend servers on the same machine. The following
4509 changes are made to the request.
4511 $c->req->address is set to the user's real IP address, as read from
4512 the HTTP X-Forwarded-For header.
4514 The host value for $c->req->base and $c->req->uri is set to the real
4515 host, as read from the HTTP X-Forwarded-Host header.
4517 Additionally, you may be running your backend application on an insecure
4518 connection (port 80) while your frontend proxy is running under SSL. If there
4519 is a discrepancy in the ports, use the HTTP header C<X-Forwarded-Port> to
4520 tell Catalyst what port the frontend listens on. This will allow all URIs to
4521 be created properly.
4523 In the case of passing in:
4525 X-Forwarded-Port: 443
4527 All calls to C<uri_for> will result in an https link, as is expected.
4529 Obviously, your web server must support these headers for this to work.
4531 In a more complex server farm environment where you may have your
4532 frontend proxy server(s) on different machines, you will need to set a
4533 configuration option to tell Catalyst to read the proxied data from the
4536 MyApp->config(using_frontend_proxy => 1);
4538 If you do not wish to use the proxy support at all, you may set:
4540 MyApp->config(ignore_frontend_proxy => 0);
4542 =head2 Note about psgi files
4544 Note that if you supply your own .psgi file, calling
4545 C<< MyApp->psgi_app(@_); >>, then B<this will not happen automatically>.
4547 You either need to apply L<Plack::Middleware::ReverseProxy> yourself
4548 in your psgi, for example:
4551 enable "Plack::Middleware::ReverseProxy";
4555 This will unconditionally add the ReverseProxy support, or you need to call
4556 C<< $app = MyApp->apply_default_middlewares($app) >> (to conditionally
4557 apply the support depending upon your config).
4559 See L<Catalyst::PSGI> for more information.
4561 =head1 THREAD SAFETY
4563 Catalyst has been tested under Apache 2's threading C<mpm_worker>,
4564 C<mpm_winnt>, and the standalone forking HTTP server on Windows. We
4565 believe the Catalyst core to be thread-safe.
4567 If you plan to operate in a threaded environment, remember that all other
4568 modules you are using must also be thread-safe. Some modules, most notably
4569 L<DBD::SQLite>, are not thread-safe.
4571 =head1 DATA HANDLERS
4573 The L<Catalyst::Request> object uses L<HTTP::Body> to populate 'classic' HTML
4574 form parameters and URL search query fields. However it has become common
4575 for various alternative content types to be PUT or POSTed to your controllers
4576 and actions. People working on RESTful APIs, or using AJAX often use JSON,
4577 XML and other content types when communicating with an application server. In
4578 order to better support this use case, L<Catalyst> defines a global configuration
4579 option, C<data_handlers>, which lets you associate a content type with a coderef
4580 that parses that content type into something Perl can readily access.
4587 __PACKAGE__->config(
4589 'application/json' => sub { local $/; decode_json $_->getline },
4591 ## Any other configuration.
4596 By default L<Catalyst> comes with a generic JSON data handler similar to the
4597 example given above, which uses L<JSON::Maybe> to provide either L<JSON::PP>
4598 (a pure Perl, dependency free JSON parser) or L<Cpanel::JSON::XS> if you have
4599 it installed (if you want the faster XS parser, add it to you project Makefile.PL
4600 or dist.ini, cpanfile, etc.)
4602 The C<data_handlers> configuration is a hashref whose keys are HTTP Content-Types
4603 (matched against the incoming request type using a regexp such as to be case
4604 insensitive) and whose values are coderefs that receive a localized version of
4605 C<$_> which is a filehandle object pointing to received body.
4607 This feature is considered an early access release and we reserve the right
4608 to alter the interface in order to provide a performant and secure solution to
4609 alternative request body content. Your reports welcomed!
4611 =head1 PSGI MIDDLEWARE
4613 You can define middleware, defined as L<Plack::Middleware> or a compatible
4614 interface in configuration. Your middleware definitions are in the form of an
4615 arrayref under the configuration key C<psgi_middleware>. Here's an example
4616 with details to follow:
4621 use Plack::Middleware::StackTrace;
4623 my $stacktrace_middleware = Plack::Middleware::StackTrace->new;
4625 __PACKAGE__->config(
4626 'psgi_middleware', [
4629 $stacktrace_middleware,
4630 'Session' => {store => 'File'},
4635 $env->{myapp.customkey} = 'helloworld';
4644 So the general form is:
4646 __PACKAGE__->config(psgi_middleware => \@middleware_definitions);
4648 Where C<@middleware> is one or more of the following, applied in the REVERSE of
4649 the order listed (to make it function similarly to L<Plack::Builder>:
4651 Alternatively, you may also define middleware by calling the L</setup_middleware>
4658 __PACKAGE__->setup_middleware( \@middleware_definitions);
4661 In the case where you do both (use 'setup_middleware' and configuration) the
4662 package call to setup_middleware will be applied earlier (in other words its
4663 middleware will wrap closer to the application). Keep this in mind since in
4664 some cases the order of middleware is important.
4666 The two approaches are not exclusive.
4670 =item Middleware Object
4672 An already initialized object that conforms to the L<Plack::Middleware>
4675 my $stacktrace_middleware = Plack::Middleware::StackTrace->new;
4677 __PACKAGE__->config(
4678 'psgi_middleware', [
4679 $stacktrace_middleware,
4685 A coderef that is an inlined middleware:
4687 __PACKAGE__->config(
4688 'psgi_middleware', [
4693 if($env->{PATH_INFO} =~m/forced/) {
4695 ->new(file=>TestApp->path_to(qw/share static forced.txt/))
4698 return $app->($env);
4708 We assume the scalar refers to a namespace after normalizing it using the
4711 (1) If the scalar is prefixed with a "+" (as in C<+MyApp::Foo>) then the full string
4712 is assumed to be 'as is', and we just install and use the middleware.
4714 (2) If the scalar begins with "Plack::Middleware" or your application namespace
4715 (the package name of your Catalyst application subclass), we also assume then
4716 that it is a full namespace, and use it.
4718 (3) Lastly, we then assume that the scalar is a partial namespace, and attempt to
4719 resolve it first by looking for it under your application namespace (for example
4720 if you application is "MyApp::Web" and the scalar is "MyMiddleware", we'd look
4721 under "MyApp::Web::Middleware::MyMiddleware") and if we don't find it there, we
4722 will then look under the regular L<Plack::Middleware> namespace (i.e. for the
4723 previous we'd try "Plack::Middleware::MyMiddleware"). We look under your application
4724 namespace first to let you 'override' common L<Plack::Middleware> locally, should
4725 you find that a good idea.
4731 __PACKAGE__->config(
4732 'psgi_middleware', [
4733 'Debug', ## MyAppWeb::Middleware::Debug->wrap or Plack::Middleware::Debug->wrap
4734 'Plack::Middleware::Stacktrace', ## Plack::Middleware::Stacktrace->wrap
4735 '+MyApp::Custom', ## MyApp::Custom->wrap
4739 =item a scalar followed by a hashref
4741 Just like the previous, except the following C<HashRef> is used as arguments
4742 to initialize the middleware object.
4744 __PACKAGE__->config(
4745 'psgi_middleware', [
4746 'Session' => {store => 'File'},
4751 Please see L<PSGI> for more on middleware.
4755 Starting in L<Catalyst> version 5.90080 encoding is automatically enabled
4756 and set to encode all body responses to UTF8 when possible and applicable.
4757 Following is documentation on this process. If you are using an older
4758 version of L<Catalyst> you should review documentation for that version since
4761 By default encoding is now 'UTF-8'. You may turn it off by setting
4762 the encoding configuration to undef.
4764 MyApp->config(encoding => undef);
4766 This is recommended for temporary backwards compatibility only.
4768 Encoding is automatically applied when the content-type is set to
4769 a type that can be encoded. Currently we encode when the content type
4770 matches the following regular expression:
4772 $content_type =~ /^text|xml$|javascript$/
4774 Encoding is set on the application, but it is copied to the context object
4775 so that you can override it on a request basis.
4777 Be default we don't automatically encode 'application/json' since the most
4778 common approaches to generating this type of response (Either via L<Catalyst::View::JSON>
4779 or L<Catalyst::Action::REST>) will do so already and we want to avoid double
4782 If you are producing JSON response in an unconventional manner (such
4783 as via a template or manual strings) you should perform the UTF8 encoding
4784 manually as well such as to conform to the JSON specification.
4786 NOTE: We also examine the value of $c->response->content_encoding. If
4787 you set this (like for example 'gzip', and manually gzipping the body)
4788 we assume that you have done all the necessary encoding yourself, since
4789 we cannot encode the gzipped contents. If you use a plugin like
4790 L<Catalyst::Plugin::Compress> you need to update to a modern version in order
4791 to have this function correctly with the new UTF8 encoding code, or you
4792 can use L<Plack::Middleware::Deflater> or (probably best) do your compression on
4801 Returns an instance of an C<Encode> encoding
4803 print $c->encoding->name
4805 =item handle_unicode_encoding_exception ($exception_context)
4807 Method called when decoding process for a request fails.
4809 An C<$exception_context> hashref is provided to allow you to override the
4810 behaviour of your application when given data with incorrect encodings.
4812 The default method throws exceptions in the case of invalid request parameters
4813 (resulting in a 500 error), but ignores errors in upload filenames.
4815 The keys passed in the C<$exception_context> hash are:
4821 The value which was not able to be decoded.
4825 The exception received from L<Encode>.
4829 What type of data was being decoded. Valid values are (currently)
4830 C<params> - for request parameters / arguments / captures
4831 and C<uploads> - for request upload filenames.
4841 Join #catalyst on irc.perl.org.
4845 http://lists.scsys.co.uk/cgi-bin/mailman/listinfo/catalyst
4846 http://lists.scsys.co.uk/cgi-bin/mailman/listinfo/catalyst-dev
4850 http://catalyst.perl.org
4854 http://dev.catalyst.perl.org
4858 =head2 L<Task::Catalyst> - All you need to start with Catalyst
4860 =head2 L<Catalyst::Manual> - The Catalyst Manual
4862 =head2 L<Catalyst::Component>, L<Catalyst::Controller> - Base classes for components
4864 =head2 L<Catalyst::Engine> - Core engine
4866 =head2 L<Catalyst::Log> - Log class.
4868 =head2 L<Catalyst::Request> - Request object
4870 =head2 L<Catalyst::Response> - Response object
4872 =head2 L<Catalyst::Test> - The test suite.
4874 =head1 PROJECT FOUNDER
4876 sri: Sebastian Riedel <sri@cpan.org>
4882 acme: Leon Brocard <leon@astray.com>
4884 abraxxa: Alexander Hartmaier <abraxxa@cpan.org>
4886 andrewalker: André Walker <andre@cpan.org>
4890 Andrew Ford E<lt>A.Ford@ford-mason.co.ukE<gt>
4894 andyg: Andy Grundman <andy@hybridized.org>
4896 audreyt: Audrey Tang
4898 bricas: Brian Cassidy <bricas@cpan.org>
4900 Caelum: Rafael Kitover <rkitover@io.com>
4902 chansen: Christian Hansen
4904 Chase Venters C<chase.venters@gmail.com>
4906 chicks: Christopher Hicks
4908 Chisel Wright C<pause@herlpacker.co.uk>
4910 Danijel Milicevic C<me@danijel.de>
4912 davewood: David Schmidt <davewood@cpan.org>
4914 David Kamholz E<lt>dkamholz@cpan.orgE<gt>
4916 David Naughton, C<naughton@umn.edu>
4920 dhoss: Devin Austin <dhoss@cpan.org>
4922 dkubb: Dan Kubb <dan.kubb-cpan@onautopilot.com>
4926 dwc: Daniel Westermann-Clark <danieltwc@cpan.org>
4928 esskar: Sascha Kiefer
4930 fireartist: Carl Franks <cfranks@cpan.org>
4932 frew: Arthur Axel "fREW" Schmidt <frioux@gmail.com>
4934 gabb: Danijel Milicevic
4938 Gavin Henry C<ghenry@perl.me.uk>
4942 groditi: Guillermo Roditi <groditi@gmail.com>
4944 hobbs: Andrew Rodland <andrew@cleverdomain.org>
4946 ilmari: Dagfinn Ilmari Mannsåker <ilmari@ilmari.org>
4948 jcamacho: Juan Camacho
4950 jester: Jesse Sheidlower C<jester@panix.com>
4952 jhannah: Jay Hannah <jay@jays.net>
4958 jon: Jon Schutz <jjschutz@cpan.org>
4960 Jonathan Rockway C<< <jrockway@cpan.org> >>
4962 Kieren Diment C<kd@totaldatasolution.com>
4964 konobi: Scott McWhirter <konobi@cpan.org>
4966 marcus: Marcus Ramberg <mramberg@cpan.org>
4968 miyagawa: Tatsuhiko Miyagawa <miyagawa@bulknews.net>
4970 mgrimes: Mark Grimes <mgrimes@cpan.org>
4972 mst: Matt S. Trout <mst@shadowcatsystems.co.uk>
4976 naughton: David Naughton
4978 ningu: David Kamholz <dkamholz@cpan.org>
4980 nothingmuch: Yuval Kogman <nothingmuch@woobling.org>
4982 numa: Dan Sully <daniel@cpan.org>
4988 omega: Andreas Marienborg
4990 Oleg Kostyuk <cub.uanic@gmail.com>
4992 phaylon: Robert Sedlacek <phaylon@dunkelheit.at>
4994 rafl: Florian Ragwitz <rafl@debian.org>
4996 random: Roland Lammel <lammel@cpan.org>
4998 Robert Sedlacek C<< <rs@474.at> >>
5000 SpiceMan: Marcel Montes
5004 szbalint: Balint Szilakszi <szbalint@cpan.org>
5006 t0m: Tomas Doran <bobtfish@bobtfish.net>
5010 vanstyn: Henry Van Styn <vanstyn@cpan.org>
5012 Viljo Marrandi C<vilts@yahoo.com>
5014 Will Hawes C<info@whawes.co.uk>
5016 willert: Sebastian Willert <willert@cpan.org>
5018 wreis: Wallace Reis <wreis@cpan.org>
5020 Yuval Kogman, C<nothingmuch@woobling.org>
5022 rainboxx: Matthias Dietrich, C<perl@rainboxx.de>
5024 dd070: Dhaval Dhanani <dhaval070@gmail.com>
5026 Upasana <me@upasana.me>
5028 John Napiorkowski (jnap) <jjnapiork@cpan.org>
5032 Copyright (c) 2005-2015, the above named PROJECT FOUNDER and CONTRIBUTORS.
5036 This library is free software. You can redistribute it and/or modify it under
5037 the same terms as Perl itself.
5043 __PACKAGE__->meta->make_immutable;