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';
55 BEGIN { require 5.008003; }
57 has stack => (is => 'ro', default => sub { [] });
58 has state => (is => 'rw', default => 0);
59 has stats => (is => 'rw');
60 has action => (is => 'rw');
61 has counter => (is => 'rw', default => sub { {} });
66 my $class = ref $self;
67 my $composed_request_class = $class->composed_request_class;
68 return $composed_request_class->new( $self->_build_request_constructor_args);
72 sub _build_request_constructor_args {
74 my %p = ( _log => $self->log );
75 $p{_uploadtmp} = $self->_uploadtmp if $self->_has_uploadtmp;
76 $p{data_handlers} = {$self->registered_data_handlers};
77 $p{_use_hash_multivalue} = $self->config->{use_hash_multivalue_in_request}
78 if $self->config->{use_hash_multivalue_in_request};
82 sub composed_request_class {
84 my @traits = (@{$class->request_class_traits||[]}, @{$class->config->{request_class_traits}||[]});
86 # For each trait listed, figure out what the namespace is. First we try the $trait
87 # as it is in the config. Then try $MyApp::TraitFor::Request:$trait. Last we try
88 # Catalyst::TraitFor::Request::$trait. If none load, throw error.
90 my $trait_ns = 'TraitFor::Request';
91 my @normalized_traits = map {
92 Class::Load::load_first_existing_class($_, $class.'::'.$trait_ns.'::'. $_, 'Catalyst::'.$trait_ns.'::'.$_)
95 return $class->_composed_request_class ||
96 $class->_composed_request_class(Moose::Util::with_traits($class->request_class, @normalized_traits));
103 my $class = ref $self;
104 my $composed_response_class = $class->composed_response_class;
105 return $composed_response_class->new( $self->_build_response_constructor_args);
109 sub _build_response_constructor_args {
112 encoding => $_[0]->encoding,
116 sub composed_response_class {
118 my @traits = (@{$class->response_class_traits||[]}, @{$class->config->{response_class_traits}||[]});
120 my $trait_ns = 'TraitFor::Response';
121 my @normalized_traits = map {
122 Class::Load::load_first_existing_class($_, $class.'::'.$trait_ns.'::'. $_, 'Catalyst::'.$trait_ns.'::'.$_)
125 return $class->_composed_response_class ||
126 $class->_composed_response_class(Moose::Util::with_traits($class->response_class, @normalized_traits));
129 has namespace => (is => 'rw');
131 sub depth { scalar @{ shift->stack || [] }; }
132 sub comp { shift->component(@_) }
135 my $self = shift; return $self->request(@_);
138 my $self = shift; return $self->response(@_);
141 # For backwards compatibility
142 sub finalize_output { shift->finalize_body(@_) };
147 our $RECURSION = 1000;
148 our $DETACH = Catalyst::Exception::Detach->new;
149 our $GO = Catalyst::Exception::Go->new;
151 #I imagine that very few of these really
152 #need to be class variables. if any.
153 #maybe we should just make them attributes with a default?
154 __PACKAGE__->mk_classdata($_)
155 for qw/components arguments dispatcher engine log dispatcher_class
156 engine_loader context_class request_class response_class stats_class
157 setup_finished _psgi_app loading_psgi_file run_options _psgi_middleware
158 _data_handlers _encoding _encode_check finalized_default_middleware
159 request_class_traits response_class_traits stats_class_traits
160 _composed_request_class _composed_response_class _composed_stats_class/;
162 __PACKAGE__->dispatcher_class('Catalyst::Dispatcher');
163 __PACKAGE__->request_class('Catalyst::Request');
164 __PACKAGE__->response_class('Catalyst::Response');
165 __PACKAGE__->stats_class('Catalyst::Stats');
167 sub composed_stats_class {
169 my @traits = (@{$class->stats_class_traits||[]}, @{$class->config->{stats_class_traits}||[]});
171 my $trait_ns = 'TraitFor::Stats';
172 my @normalized_traits = map {
173 Class::Load::load_first_existing_class($_, $class.'::'.$trait_ns.'::'. $_, 'Catalyst::'.$trait_ns.'::'.$_)
176 return $class->_composed_stats_class ||
177 $class->_composed_stats_class(Moose::Util::with_traits($class->stats_class, @normalized_traits));
180 __PACKAGE__->_encode_check(Encode::FB_CROAK | Encode::LEAVE_SRC);
182 # Remember to update this in Catalyst::Runtime as well!
183 our $VERSION = '5.90094';
184 $VERSION = eval $VERSION if $VERSION =~ /_/; # numify for warning-free dev releases
187 my ( $class, @arguments ) = @_;
189 # We have to limit $class to Catalyst to avoid pushing Catalyst upon every
191 return unless $class eq 'Catalyst';
193 my $caller = caller();
194 return if $caller eq 'main';
196 my $meta = Moose::Meta::Class->initialize($caller);
197 unless ( $caller->isa('Catalyst') ) {
198 my @superclasses = ($meta->superclasses, $class, 'Catalyst::Controller');
199 $meta->superclasses(@superclasses);
201 # Avoid possible C3 issues if 'Moose::Object' is already on RHS of MyApp
202 $meta->superclasses(grep { $_ ne 'Moose::Object' } $meta->superclasses);
204 unless( $meta->has_method('meta') ){
205 if ($Moose::VERSION >= 1.15) {
206 $meta->_add_meta_method('meta');
209 $meta->add_method(meta => sub { Moose::Meta::Class->initialize("${caller}") } );
213 $caller->arguments( [@arguments] );
217 sub _application { $_[0] }
223 Catalyst - The Elegant MVC Web Application Framework
226 <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>
227 <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>
228 <a href="http://cpants.cpanauthors.org/dist/Catalyst-Runtime"><img src="http://cpants.cpanauthors.org/dist/Catalyst-Runtime.png" alt='Kwalitee Score' /></a>
232 See the L<Catalyst::Manual> distribution for comprehensive
233 documentation and tutorials.
235 # Install Catalyst::Devel for helpers and other development tools
236 # use the helper to create a new application
239 # add models, views, controllers
240 script/myapp_create.pl model MyDatabase DBIC::Schema create=static dbi:SQLite:/path/to/db
241 script/myapp_create.pl view MyTemplate TT
242 script/myapp_create.pl controller Search
244 # built in testserver -- use -r to restart automatically on changes
245 # --help to see all available options
246 script/myapp_server.pl
248 # command line testing interface
249 script/myapp_test.pl /yada
252 use Catalyst qw/-Debug/; # include plugins here as well
254 ### In lib/MyApp/Controller/Root.pm (autocreated)
255 sub foo : Chained('/') Args() { # called for /foo, /foo/1, /foo/1/2, etc.
256 my ( $self, $c, @args ) = @_; # args are qw/1 2/ for /foo/1/2
257 $c->stash->{template} = 'foo.tt'; # set the template
258 # lookup something from db -- stash vars are passed to TT
260 $c->model('Database::Foo')->search( { country => $args[0] } );
261 if ( $c->req->params->{bar} ) { # access GET or POST parameters
262 $c->forward( 'bar' ); # process another action
263 # do something else after forward returns
267 # The foo.tt TT template can use the stash data from the database
268 [% WHILE (item = data.next) %]
272 # called for /bar/of/soap, /bar/of/soap/10, etc.
273 sub bar : Chained('/') PathPart('/bar/of/soap') Args() { ... }
275 # called after all actions are finished
277 my ( $self, $c ) = @_;
278 if ( scalar @{ $c->error } ) { ... } # handle errors
279 return if $c->res->body; # already have a response
280 $c->forward( 'MyApp::View::TT' ); # render template
283 See L<Catalyst::Manual::Intro> for additional information.
287 Catalyst is a modern framework for making web applications without the
288 pain usually associated with this process. This document is a reference
289 to the main Catalyst application. If you are a new user, we suggest you
290 start with L<Catalyst::Manual::Tutorial> or L<Catalyst::Manual::Intro>.
292 See L<Catalyst::Manual> for more documentation.
294 Catalyst plugins can be loaded by naming them as arguments to the "use
295 Catalyst" statement. Omit the C<Catalyst::Plugin::> prefix from the
296 plugin name, i.e., C<Catalyst::Plugin::My::Module> becomes
299 use Catalyst qw/My::Module/;
301 If your plugin starts with a name other than C<Catalyst::Plugin::>, you can
302 fully qualify the name by using a unary plus:
306 +Fully::Qualified::Plugin::Name
309 Special flags like C<-Debug> can also be specified as
310 arguments when Catalyst is loaded:
312 use Catalyst qw/-Debug My::Module/;
314 The position of plugins and flags in the chain is important, because
315 they are loaded in the order in which they appear.
317 The following flags are supported:
321 Enables debug output. You can also force this setting from the system
322 environment with CATALYST_DEBUG or <MYAPP>_DEBUG. The environment
323 settings override the application, with <MYAPP>_DEBUG having the highest
326 This sets the log level to 'debug' and enables full debug output on the
327 error screen. If you only want the latter, see L<< $c->debug >>.
331 Forces Catalyst to use a specific home directory, e.g.:
333 use Catalyst qw[-Home=/usr/mst];
335 This can also be done in the shell environment by setting either the
336 C<CATALYST_HOME> environment variable or C<MYAPP_HOME>; where C<MYAPP>
337 is replaced with the uppercased name of your application, any "::" in
338 the name will be replaced with underscores, e.g. MyApp::Web should use
339 MYAPP_WEB_HOME. If both variables are set, the MYAPP_HOME one will be used.
341 If none of these are set, Catalyst will attempt to automatically detect the
342 home directory. If you are working in a development environment, Catalyst
343 will try and find the directory containing either Makefile.PL, Build.PL,
344 dist.ini, or cpanfile. If the application has been installed into the system
345 (i.e. you have done C<make install>), then Catalyst will use the path to your
346 application module, without the .pm extension (e.g., /foo/MyApp if your
347 application was installed at /foo/MyApp.pm)
351 use Catalyst '-Log=warn,fatal,error';
353 Specifies a comma-delimited list of log levels.
357 Enables statistics collection and reporting.
359 use Catalyst qw/-Stats=1/;
361 You can also force this setting from the system environment with CATALYST_STATS
362 or <MYAPP>_STATS. The environment settings override the application, with
363 <MYAPP>_STATS having the highest priority.
365 Stats are also enabled if L<< debugging |/"-Debug" >> is enabled.
369 =head2 INFORMATION ABOUT THE CURRENT REQUEST
373 Returns a L<Catalyst::Action> object for the current action, which
374 stringifies to the action name. See L<Catalyst::Action>.
378 Returns the namespace of the current action, i.e., the URI prefix
379 corresponding to the controller of the current action. For example:
381 # in Controller::Foo::Bar
382 $c->namespace; # returns 'foo/bar';
388 Returns the current L<Catalyst::Request> object, giving access to
389 information about the current client request (including parameters,
390 cookies, HTTP headers, etc.). See L<Catalyst::Request>.
392 =head2 REQUEST FLOW HANDLING
394 =head2 $c->forward( $action [, \@arguments ] )
396 =head2 $c->forward( $class, $method, [, \@arguments ] )
398 This is one way of calling another action (method) in the same or
399 a different controller. You can also use C<< $self->my_method($c, @args) >>
400 in the same controller or C<< $c->controller('MyController')->my_method($c, @args) >>
401 in a different controller.
402 The main difference is that 'forward' uses some of the Catalyst request
403 cycle overhead, including debugging, which may be useful to you. On the
404 other hand, there are some complications to using 'forward', restrictions
405 on values returned from 'forward', and it may not handle errors as you prefer.
406 Whether you use 'forward' or not is up to you; it is not considered superior to
407 the other ways to call a method.
409 'forward' calls another action, by its private name. If you give a
410 class name but no method, C<process()> is called. You may also optionally
411 pass arguments in an arrayref. The action will receive the arguments in
412 C<@_> and C<< $c->req->args >>. Upon returning from the function,
413 C<< $c->req->args >> will be restored to the previous values.
415 Any data C<return>ed from the action forwarded to, will be returned by the
418 my $foodata = $c->forward('/foo');
419 $c->forward('index');
420 $c->forward(qw/Model::DBIC::Foo do_stuff/);
421 $c->forward('View::TT');
423 Note that L<< forward|/"$c->forward( $action [, \@arguments ] )" >> implies
424 an C<< eval { } >> around the call (actually
425 L<< execute|/"$c->execute( $class, $coderef )" >> does), thus rendering all
426 exceptions thrown by the called action non-fatal and pushing them onto
427 $c->error instead. If you want C<die> to propagate you need to do something
431 die join "\n", @{ $c->error } if @{ $c->error };
433 Or make sure to always return true values from your actions and write
436 $c->forward('foo') || return;
438 Another note is that C<< $c->forward >> always returns a scalar because it
439 actually returns $c->state which operates in a scalar context.
440 Thus, something like:
444 in an action that is forwarded to is going to return a scalar,
445 i.e. how many items are in that array, which is probably not what you want.
446 If you need to return an array then return a reference to it,
449 $c->stash->{array} = \@array;
451 and access it from the stash.
453 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.
457 sub forward { my $c = shift; no warnings 'recursion'; $c->dispatcher->forward( $c, @_ ) }
459 =head2 $c->detach( $action [, \@arguments ] )
461 =head2 $c->detach( $class, $method, [, \@arguments ] )
465 The same as L<< forward|/"$c->forward( $action [, \@arguments ] )" >>, but
466 doesn't return to the previous action when processing is finished.
468 When called with no arguments it escapes the processing chain entirely.
472 sub detach { my $c = shift; $c->dispatcher->detach( $c, @_ ) }
474 =head2 $c->visit( $action [, \@arguments ] )
476 =head2 $c->visit( $action [, \@captures, \@arguments ] )
478 =head2 $c->visit( $class, $method, [, \@arguments ] )
480 =head2 $c->visit( $class, $method, [, \@captures, \@arguments ] )
482 Almost the same as L<< forward|/"$c->forward( $action [, \@arguments ] )" >>,
483 but does a full dispatch, instead of just calling the new C<$action> /
484 C<< $class->$method >>. This means that C<begin>, C<auto> and the method
485 you go to are called, just like a new request.
487 In addition both C<< $c->action >> and C<< $c->namespace >> are localized.
488 This means, for example, that C<< $c->action >> methods such as
489 L<name|Catalyst::Action/name>, L<class|Catalyst::Action/class> and
490 L<reverse|Catalyst::Action/reverse> return information for the visited action
491 when they are invoked within the visited action. This is different from the
492 behavior of L<< forward|/"$c->forward( $action [, \@arguments ] )" >>, which
493 continues to use the $c->action object from the caller action even when
494 invoked from the called action.
496 C<< $c->stash >> is kept unchanged.
498 In effect, L<< visit|/"$c->visit( $action [, \@captures, \@arguments ] )" >>
499 allows you to "wrap" another action, just as it would have been called by
500 dispatching from a URL, while the analogous
501 L<< go|/"$c->go( $action [, \@captures, \@arguments ] )" >> allows you to
502 transfer control to another action as if it had been reached directly from a URL.
506 sub visit { my $c = shift; $c->dispatcher->visit( $c, @_ ) }
508 =head2 $c->go( $action [, \@arguments ] )
510 =head2 $c->go( $action [, \@captures, \@arguments ] )
512 =head2 $c->go( $class, $method, [, \@arguments ] )
514 =head2 $c->go( $class, $method, [, \@captures, \@arguments ] )
516 The relationship between C<go> and
517 L<< visit|/"$c->visit( $action [, \@captures, \@arguments ] )" >> is the same as
518 the relationship between
519 L<< forward|/"$c->forward( $class, $method, [, \@arguments ] )" >> and
520 L<< detach|/"$c->detach( $action [, \@arguments ] )" >>. Like C<< $c->visit >>,
521 C<< $c->go >> will perform a full dispatch on the specified action or method,
522 with localized C<< $c->action >> and C<< $c->namespace >>. Like C<detach>,
523 C<go> escapes the processing of the current request chain on completion, and
524 does not return to its caller.
526 @arguments are arguments to the final destination of $action. @captures are
527 arguments to the intermediate steps, if any, on the way to the final sub of
532 sub go { my $c = shift; $c->dispatcher->go( $c, @_ ) }
538 Returns the current L<Catalyst::Response> object, see there for details.
542 Returns a hashref to the stash, which may be used to store data and pass
543 it between components during a request. You can also set hash keys by
544 passing arguments. The stash is automatically sent to the view. The
545 stash is cleared at the end of a request; it cannot be used for
546 persistent storage (for this you must use a session; see
547 L<Catalyst::Plugin::Session> for a complete system integrated with
550 $c->stash->{foo} = $bar;
551 $c->stash( { moose => 'majestic', qux => 0 } );
552 $c->stash( bar => 1, gorch => 2 ); # equivalent to passing a hashref
554 # stash is automatically passed to the view for use in a template
555 $c->forward( 'MyApp::View::TT' );
557 The stash hash is currently stored in the PSGI C<$env> and is managed by
558 L<Catalyst::Middleware::Stash>. Since it's part of the C<$env> items in
559 the stash can be accessed in sub applications mounted under your main
560 L<Catalyst> application. For example if you delegate the response of an
561 action to another L<Catalyst> application, that sub application will have
562 access to all the stash keys of the main one, and if can of course add
563 more keys of its own. However those new keys will not 'bubble' back up
564 to the main application.
566 For more information the best thing to do is to review the test case:
567 t/middleware-stash.t in the distribution /t directory.
573 $c->log->error("You are requesting the stash but you don't have a context") unless blessed $c;
574 return Catalyst::Middleware::Stash::get_stash($c->req->env)->(@_);
579 =head2 $c->error($error, ...)
581 =head2 $c->error($arrayref)
583 Returns an arrayref containing error messages. If Catalyst encounters an
584 error while processing a request, it stores the error in $c->error. This
585 method should only be used to store fatal error messages.
587 my @error = @{ $c->error };
591 $c->error('Something bad happened');
593 Calling this will always return an arrayref (if there are no errors it
594 will be an empty arrayref.
601 my $error = ref $_[0] eq 'ARRAY' ? $_[0] : [@_];
602 croak @$error unless ref $c;
603 push @{ $c->{error} }, @$error;
605 elsif ( defined $_[0] ) { $c->{error} = undef }
606 return $c->{error} || [];
612 Contains the return value of the last executed action.
613 Note that << $c->state >> operates in a scalar context which means that all
614 values it returns are scalar.
616 =head2 $c->clear_errors
618 Clear errors. You probably don't want to clear the errors unless you are
619 implementing a custom error screen.
621 This is equivalent to running
632 =head2 $c->has_errors
634 Returns true if you have errors
638 sub has_errors { scalar(@{shift->error}) ? 1:0 }
640 =head2 $c->last_error
642 Returns the most recent error in the stack (the one most recently added...)
643 or nothing if there are no errors. This does not modify the contents of the
649 my (@errs) = @{shift->error};
650 return scalar(@errs) ? $errs[-1]: undef;
655 shifts the most recently added error off the error stack and returns it. Returns
656 nothing if there are no more errors.
662 my @errors = @{$self->error};
663 my $err = shift(@errors);
664 $self->{error} = \@errors;
670 pops the most recently added error off the error stack and returns it. Returns
671 nothing if there are no more errors.
677 my @errors = @{$self->error};
678 my $err = pop(@errors);
679 $self->{error} = \@errors;
683 sub _comp_search_prefixes {
685 return map $c->components->{ $_ }, $c->_comp_names_search_prefixes(@_);
688 # search components given a name and some prefixes
689 sub _comp_names_search_prefixes {
690 my ( $c, $name, @prefixes ) = @_;
691 my $appclass = ref $c || $c;
692 my $filter = "^${appclass}::(" . join( '|', @prefixes ) . ')::';
693 $filter = qr/$filter/; # Compile regex now rather than once per loop
695 # map the original component name to the sub part that we will search against
696 my %eligible = map { my $n = $_; $n =~ s{^$appclass\::[^:]+::}{}; $_ => $n; }
697 grep { /$filter/ } keys %{ $c->components };
699 # undef for a name will return all
700 return keys %eligible if !defined $name;
702 my $query = $name->$_isa('Regexp') ? $name : qr/^$name$/i;
703 my @result = grep { $eligible{$_} =~ m{$query} } keys %eligible;
705 return @result if @result;
707 # if we were given a regexp to search against, we're done.
708 return if $name->$_isa('Regexp');
710 # skip regexp fallback if configured
712 if $appclass->config->{disable_component_resolution_regex_fallback};
716 @result = grep { $eligible{ $_ } =~ m{$query} } keys %eligible;
718 # no results? try against full names
720 @result = grep { m{$query} } keys %eligible;
723 # don't warn if we didn't find any results, it just might not exist
725 # Disgusting hack to work out correct method name
726 my $warn_for = lc $prefixes[0];
727 my $msg = "Used regexp fallback for \$c->${warn_for}('${name}'), which found '" .
728 (join '", "', @result) . "'. Relying on regexp fallback behavior for " .
729 "component resolution is unreliable and unsafe.";
730 my $short = $result[0];
731 # remove the component namespace prefix
732 $short =~ s/.*?(Model|Controller|View):://;
733 my $shortmess = Carp::shortmess('');
734 if ($shortmess =~ m#Catalyst/Plugin#) {
735 $msg .= " You probably need to set '$short' instead of '${name}' in this " .
737 } elsif ($shortmess =~ m#Catalyst/lib/(View|Controller)#) {
738 $msg .= " You probably need to set '$short' instead of '${name}' in this " .
739 "component's config";
741 $msg .= " You probably meant \$c->${warn_for}('$short') instead of \$c->${warn_for}('${name}'), " .
742 "but if you really wanted to search, pass in a regexp as the argument " .
743 "like so: \$c->${warn_for}(qr/${name}/)";
745 $c->log->warn( "${msg}$shortmess" );
751 # Find possible names for a prefix
753 my ( $c, @prefixes ) = @_;
754 my $appclass = ref $c || $c;
756 my $filter = "^${appclass}::(" . join( '|', @prefixes ) . ')::';
758 my @names = map { s{$filter}{}; $_; }
759 $c->_comp_names_search_prefixes( undef, @prefixes );
764 # Filter a component before returning by calling ACCEPT_CONTEXT if available
766 sub _filter_component {
767 my ( $c, $comp, @args ) = @_;
769 if(ref $comp eq 'CODE') {
773 if ( eval { $comp->can('ACCEPT_CONTEXT'); } ) {
774 return $comp->ACCEPT_CONTEXT( $c, @args );
777 $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;
782 =head2 COMPONENT ACCESSORS
784 =head2 $c->controller($name)
786 Gets a L<Catalyst::Controller> instance by name.
788 $c->controller('Foo')->do_stuff;
790 If the name is omitted, will return the controller for the dispatched
793 If you want to search for controllers, pass in a regexp as the argument.
795 # find all controllers that start with Foo
796 my @foo_controllers = $c->controller(qr{^Foo});
802 my ( $c, $name, @args ) = @_;
804 my $appclass = ref($c) || $c;
806 unless ( $name->$_isa('Regexp') ) { # Direct component hash lookup to avoid costly regexps
807 my $comps = $c->components;
808 my $check = $appclass."::Controller::".$name;
809 return $c->_filter_component( $comps->{$check}, @args ) if exists $comps->{$check};
811 my @result = $c->_comp_search_prefixes( $name, qw/Controller C/ );
812 return map { $c->_filter_component( $_, @args ) } @result if ref $name;
813 return $c->_filter_component( $result[ 0 ], @args );
816 return $c->component( $c->action->class );
819 =head2 $c->model($name)
821 Gets a L<Catalyst::Model> instance by name.
823 $c->model('Foo')->do_stuff;
825 Any extra arguments are directly passed to ACCEPT_CONTEXT, if the model
826 defines ACCEPT_CONTEXT. If it does not, the args are discarded.
828 If the name is omitted, it will look for
829 - a model object in $c->stash->{current_model_instance}, then
830 - a model name in $c->stash->{current_model}, then
831 - a config setting 'default_model', or
832 - check if there is only one model, and return it if that's the case.
834 If you want to search for models, pass in a regexp as the argument.
836 # find all models that start with Foo
837 my @foo_models = $c->model(qr{^Foo});
842 my ( $c, $name, @args ) = @_;
843 my $appclass = ref($c) || $c;
845 unless ( $name->$_isa('Regexp') ) { # Direct component hash lookup to avoid costly regexps
846 my $comps = $c->components;
847 my $check = $appclass."::Model::".$name;
848 return $c->_filter_component( $comps->{$check}, @args ) if exists $comps->{$check};
850 my @result = $c->_comp_search_prefixes( $name, qw/Model M/ );
851 return map { $c->_filter_component( $_, @args ) } @result if ref $name;
852 return $c->_filter_component( $result[ 0 ], @args );
856 return $c->stash->{current_model_instance}
857 if $c->stash->{current_model_instance};
858 return $c->model( $c->stash->{current_model} )
859 if $c->stash->{current_model};
861 return $c->model( $appclass->config->{default_model} )
862 if $appclass->config->{default_model};
864 my( $comp, $rest ) = $c->_comp_search_prefixes( undef, qw/Model M/);
867 $c->log->warn( Carp::shortmess('Calling $c->model() will return a random model unless you specify one of:') );
868 $c->log->warn( '* $c->config(default_model => "the name of the default model to use")' );
869 $c->log->warn( '* $c->stash->{current_model} # the name of the model to use for this request' );
870 $c->log->warn( '* $c->stash->{current_model_instance} # the instance of the model to use for this request' );
871 $c->log->warn( 'NB: in version 5.81, the "random" behavior will not work at all.' );
874 return $c->_filter_component( $comp );
878 =head2 $c->view($name)
880 Gets a L<Catalyst::View> instance by name.
882 $c->view('Foo')->do_stuff;
884 Any extra arguments are directly passed to ACCEPT_CONTEXT.
886 If the name is omitted, it will look for
887 - a view object in $c->stash->{current_view_instance}, then
888 - a view name in $c->stash->{current_view}, then
889 - a config setting 'default_view', or
890 - check if there is only one view, and return it if that's the case.
892 If you want to search for views, pass in a regexp as the argument.
894 # find all views that start with Foo
895 my @foo_views = $c->view(qr{^Foo});
900 my ( $c, $name, @args ) = @_;
902 my $appclass = ref($c) || $c;
904 unless ( $name->$_isa('Regexp') ) { # Direct component hash lookup to avoid costly regexps
905 my $comps = $c->components;
906 my $check = $appclass."::View::".$name;
907 if( exists $comps->{$check} ) {
908 return $c->_filter_component( $comps->{$check}, @args );
911 $c->log->warn( "Attempted to use view '$check', but does not exist" );
914 my @result = $c->_comp_search_prefixes( $name, qw/View V/ );
915 return map { $c->_filter_component( $_, @args ) } @result if ref $name;
916 return $c->_filter_component( $result[ 0 ], @args );
920 return $c->stash->{current_view_instance}
921 if $c->stash->{current_view_instance};
922 return $c->view( $c->stash->{current_view} )
923 if $c->stash->{current_view};
925 return $c->view( $appclass->config->{default_view} )
926 if $appclass->config->{default_view};
928 my( $comp, $rest ) = $c->_comp_search_prefixes( undef, qw/View V/);
931 $c->log->warn( 'Calling $c->view() will return a random view unless you specify one of:' );
932 $c->log->warn( '* $c->config(default_view => "the name of the default view to use")' );
933 $c->log->warn( '* $c->stash->{current_view} # the name of the view to use for this request' );
934 $c->log->warn( '* $c->stash->{current_view_instance} # the instance of the view to use for this request' );
935 $c->log->warn( 'NB: in version 5.81, the "random" behavior will not work at all.' );
938 return $c->_filter_component( $comp );
941 =head2 $c->controllers
943 Returns the available names which can be passed to $c->controller
949 return $c->_comp_names(qw/Controller C/);
954 Returns the available names which can be passed to $c->model
960 return $c->_comp_names(qw/Model M/);
966 Returns the available names which can be passed to $c->view
972 return $c->_comp_names(qw/View V/);
975 =head2 $c->comp($name)
977 =head2 $c->component($name)
979 Gets a component object by name. This method is not recommended,
980 unless you want to get a specific component by full
981 class. C<< $c->controller >>, C<< $c->model >>, and C<< $c->view >>
982 should be used instead.
984 If C<$name> is a regexp, a list of components matched against the full
985 component name will be returned.
987 If Catalyst can't find a component by name, it will fallback to regex
988 matching by default. To disable this behaviour set
989 disable_component_resolution_regex_fallback to a true value.
991 __PACKAGE__->config( disable_component_resolution_regex_fallback => 1 );
996 my ( $c, $name, @args ) = @_;
999 my $comps = $c->components;
1002 # is it the exact name?
1003 return $c->_filter_component( $comps->{ $name }, @args )
1004 if exists $comps->{ $name };
1006 # perhaps we just omitted "MyApp"?
1007 my $composed = ( ref $c || $c ) . "::${name}";
1008 return $c->_filter_component( $comps->{ $composed }, @args )
1009 if exists $comps->{ $composed };
1011 # search all of the models, views and controllers
1012 my( $comp ) = $c->_comp_search_prefixes( $name, qw/Model M Controller C View V/ );
1013 return $c->_filter_component( $comp, @args ) if $comp;
1017 if $c->config->{disable_component_resolution_regex_fallback};
1019 # This is here so $c->comp( '::M::' ) works
1020 my $query = ref $name ? $name : qr{$name}i;
1022 my @result = grep { m{$query} } keys %{ $c->components };
1023 return map { $c->_filter_component( $_, @args ) } @result if ref $name;
1025 if( $result[ 0 ] ) {
1026 $c->log->warn( Carp::shortmess(qq(Found results for "${name}" using regexp fallback)) );
1027 $c->log->warn( 'Relying on the regexp fallback behavior for component resolution' );
1028 $c->log->warn( 'is unreliable and unsafe. You have been warned' );
1029 return $c->_filter_component( $result[ 0 ], @args );
1032 # I would expect to return an empty list here, but that breaks back-compat
1036 return sort keys %{ $c->components };
1039 =head2 CLASS DATA AND HELPER CLASSES
1043 Returns or takes a hashref containing the application's configuration.
1045 __PACKAGE__->config( { db => 'dsn:SQLite:foo.db' } );
1047 You can also use a C<YAML>, C<XML> or L<Config::General> config file
1048 like C<myapp.conf> in your applications home directory. See
1049 L<Catalyst::Plugin::ConfigLoader>.
1051 =head3 Cascading configuration
1053 The config method is present on all Catalyst components, and configuration
1054 will be merged when an application is started. Configuration loaded with
1055 L<Catalyst::Plugin::ConfigLoader> takes precedence over other configuration,
1056 followed by configuration in your top level C<MyApp> class. These two
1057 configurations are merged, and then configuration data whose hash key matches a
1058 component name is merged with configuration for that component.
1060 The configuration for a component is then passed to the C<new> method when a
1061 component is constructed.
1065 MyApp->config({ 'Model::Foo' => { bar => 'baz', overrides => 'me' } });
1066 MyApp::Model::Foo->config({ quux => 'frob', overrides => 'this' });
1068 will mean that C<MyApp::Model::Foo> receives the following data when
1071 MyApp::Model::Foo->new({
1077 It's common practice to use a Moose attribute
1078 on the receiving component to access the config value.
1080 package MyApp::Model::Foo;
1084 # this attr will receive 'baz' at construction time
1090 You can then get the value 'baz' by calling $c->model('Foo')->bar
1091 (or $self->bar inside code in the model).
1093 B<NOTE:> you MUST NOT call C<< $self->config >> or C<< __PACKAGE__->config >>
1094 as a way of reading config within your code, as this B<will not> give you the
1095 correctly merged config back. You B<MUST> take the config values supplied to
1096 the constructor and use those instead.
1100 around config => sub {
1104 croak('Setting config after setup has been run is not allowed.')
1105 if ( @_ and $c->setup_finished );
1112 Returns the logging object instance. Unless it is already set, Catalyst
1113 sets this up with a L<Catalyst::Log> object. To use your own log class,
1114 set the logger with the C<< __PACKAGE__->log >> method prior to calling
1115 C<< __PACKAGE__->setup >>.
1117 __PACKAGE__->log( MyLogger->new );
1122 $c->log->info( 'Now logging with my own logger!' );
1124 Your log class should implement the methods described in
1129 Returned True if there's a valid encoding
1131 =head2 clear_encoding
1133 Clears the encoding for the current context
1137 Sets or gets the application encoding. Setting encoding takes either an
1138 Encoding object or a string that we try to resolve via L<Encode::find_encoding>.
1140 You would expect to get the encoding object back if you attempt to set it. If
1141 there is a failure you will get undef returned and an error message in the log.
1145 sub has_encoding { shift->encoding ? 1:0 }
1147 sub clear_encoding {
1150 $c->encoding(undef);
1152 $c->log->error("You can't clear encoding on the application");
1162 # Don't let one change this once we are too far into the response
1163 if(blessed $c && $c->res->finalized_headers) {
1164 Carp::croak("You may not change the encoding once the headers are finalized");
1168 # Let it be set to undef
1169 if (my $wanted = shift) {
1170 $encoding = Encode::find_encoding($wanted)
1171 or Carp::croak( qq/Unknown encoding '$wanted'/ );
1172 binmode(STDERR, ':encoding(' . $encoding->name . ')');
1179 ? $c->{encoding} = $encoding
1180 : $c->_encoding($encoding);
1182 $encoding = ref $c && exists $c->{encoding}
1192 Returns 1 if debug mode is enabled, 0 otherwise.
1194 You can enable debug mode in several ways:
1198 =item By calling myapp_server.pl with the -d flag
1200 =item With the environment variables MYAPP_DEBUG, or CATALYST_DEBUG
1202 =item The -Debug option in your MyApp.pm
1204 =item By declaring C<sub debug { 1 }> in your MyApp.pm.
1208 The first three also set the log level to 'debug'.
1210 Calling C<< $c->debug(1) >> has no effect.
1216 =head2 $c->dispatcher
1218 Returns the dispatcher instance. See L<Catalyst::Dispatcher>.
1222 Returns the engine instance. See L<Catalyst::Engine>.
1225 =head2 UTILITY METHODS
1227 =head2 $c->path_to(@path)
1229 Merges C<@path> with C<< $c->config->{home} >> and returns a
1230 L<Path::Class::Dir> object. Note you can usually use this object as
1231 a filename, but sometimes you will have to explicitly stringify it
1232 yourself by calling the C<< ->stringify >> method.
1236 $c->path_to( 'db', 'sqlite.db' );
1241 my ( $c, @path ) = @_;
1242 my $path = Path::Class::Dir->new( $c->config->{home}, @path );
1243 if ( -d $path ) { return $path }
1244 else { return Path::Class::File->new( $c->config->{home}, @path ) }
1248 my ( $class, $name, $plugin, @args ) = @_;
1250 # See block comment in t/unit_core_plugin.t
1251 $class->log->warn(qq/Adding plugin using the ->plugin method is deprecated, and will be removed in a future release/);
1253 $class->_register_plugin( $plugin, 1 );
1255 eval { $plugin->import };
1256 $class->mk_classdata($name);
1258 eval { $obj = $plugin->new(@args) };
1261 Catalyst::Exception->throw( message =>
1262 qq/Couldn't instantiate instant plugin "$plugin", "$@"/ );
1265 $class->$name($obj);
1266 $class->log->debug(qq/Initialized instant plugin "$plugin" as "$name"/)
1272 Initializes the dispatcher and engine, loads any plugins, and loads the
1273 model, view, and controller components. You may also specify an array
1274 of plugins to load here, if you choose to not load them in the C<use
1278 MyApp->setup( qw/-Debug/ );
1280 B<Note:> You B<should not> wrap this method with method modifiers
1281 or bad things will happen - wrap the C<setup_finalize> method instead.
1283 B<Note:> You can create a custom setup stage that will execute when the
1284 application is starting. Use this to customize setup.
1286 MyApp->setup(-Custom=value);
1289 my ($class, $value) = @_;
1292 Can be handy if you want to hook into the setup phase.
1297 my ( $class, @arguments ) = @_;
1298 croak('Running setup more than once')
1299 if ( $class->setup_finished );
1301 unless ( $class->isa('Catalyst') ) {
1303 Catalyst::Exception->throw(
1304 message => qq/'$class' does not inherit from Catalyst/ );
1307 if ( $class->arguments ) {
1308 @arguments = ( @arguments, @{ $class->arguments } );
1314 foreach (@arguments) {
1318 ( $flags->{log} ) ? 'debug,' . $flags->{log} : 'debug';
1320 elsif (/^-(\w+)=?(.*)$/) {
1321 $flags->{ lc $1 } = $2;
1324 push @{ $flags->{plugins} }, $_;
1328 $class->setup_home( delete $flags->{home} );
1330 $class->setup_log( delete $flags->{log} );
1331 $class->setup_plugins( delete $flags->{plugins} );
1333 $class->setup_data_handlers();
1334 $class->setup_dispatcher( delete $flags->{dispatcher} );
1335 if (my $engine = delete $flags->{engine}) {
1336 $class->log->warn("Specifying the engine in ->setup is no longer supported, see Catalyst::Upgrading");
1338 $class->setup_engine();
1339 $class->setup_stats( delete $flags->{stats} );
1341 for my $flag ( sort keys %{$flags} ) {
1343 if ( my $code = $class->can( 'setup_' . $flag ) ) {
1344 &$code( $class, delete $flags->{$flag} );
1347 $class->log->warn(qq/Unknown flag "$flag"/);
1351 eval { require Catalyst::Devel; };
1352 if( !$@ && $ENV{CATALYST_SCRIPT_GEN} && ( $ENV{CATALYST_SCRIPT_GEN} < $Catalyst::Devel::CATALYST_SCRIPT_GEN ) ) {
1353 $class->log->warn(<<"EOF");
1354 You are running an old script!
1356 Please update by running (this will overwrite existing files):
1357 catalyst.pl -force -scripts $class
1359 or (this will not overwrite existing files):
1360 catalyst.pl -scripts $class
1365 # Call plugins setup, this is stupid and evil.
1366 # Also screws C3 badly on 5.10, hack to avoid.
1368 no warnings qw/redefine/;
1369 local *setup = sub { };
1370 $class->setup unless $Catalyst::__AM_RESTARTING;
1373 # If you are expecting configuration info as part of your setup, it needs
1374 # to get called here and below, since we need the above line to support
1375 # ConfigLoader based configs.
1377 $class->setup_encoding();
1378 $class->setup_middleware();
1380 # Initialize our data structure
1381 $class->components( {} );
1383 $class->setup_components;
1385 if ( $class->debug ) {
1386 my @plugins = map { "$_ " . ( $_->VERSION || '' ) } $class->registered_plugins;
1389 my $column_width = Catalyst::Utils::term_width() - 6;
1390 my $t = Text::SimpleTable->new($column_width);
1391 $t->row($_) for @plugins;
1392 $class->log->debug( "Loaded plugins:\n" . $t->draw . "\n" );
1395 my @middleware = map {
1398 (ref($_) .' '. ($_->can('VERSION') ? $_->VERSION || '' : '')
1399 || '') } $class->registered_middlewares;
1402 my $column_width = Catalyst::Utils::term_width() - 6;
1403 my $t = Text::SimpleTable->new($column_width);
1404 $t->row($_) for @middleware;
1405 $class->log->debug( "Loaded PSGI Middleware:\n" . $t->draw . "\n" );
1408 my %dh = $class->registered_data_handlers;
1409 if (my @data_handlers = keys %dh) {
1410 my $column_width = Catalyst::Utils::term_width() - 6;
1411 my $t = Text::SimpleTable->new($column_width);
1412 $t->row($_) for @data_handlers;
1413 $class->log->debug( "Loaded Request Data Handlers:\n" . $t->draw . "\n" );
1416 my $dispatcher = $class->dispatcher;
1417 my $engine = $class->engine;
1418 my $home = $class->config->{home};
1420 $class->log->debug(sprintf(q/Loaded dispatcher "%s"/, blessed($dispatcher)));
1421 $class->log->debug(sprintf(q/Loaded engine "%s"/, blessed($engine)));
1425 ? $class->log->debug(qq/Found home "$home"/)
1426 : $class->log->debug(qq/Home "$home" doesn't exist/)
1427 : $class->log->debug(q/Couldn't find home/);
1429 my $column_width = Catalyst::Utils::term_width() - 8 - 9;
1431 my $t = Text::SimpleTable->new( [ $column_width, 'Class' ], [ 8, 'Type' ] );
1432 for my $comp ( sort keys %{ $class->components } ) {
1433 my $type = ref $class->components->{$comp} ? 'instance' : 'class';
1434 $t->row( $comp, $type );
1436 $class->log->debug( "Loaded components:\n" . $t->draw . "\n" )
1437 if ( keys %{ $class->components } );
1440 # Add our self to components, since we are also a component
1441 if( $class->isa('Catalyst::Controller') ){
1442 $class->components->{$class} = $class;
1445 $class->setup_actions;
1447 if ( $class->debug ) {
1448 my $name = $class->config->{name} || 'Application';
1449 $class->log->info("$name powered by Catalyst $Catalyst::VERSION");
1452 if ($class->config->{case_sensitive}) {
1453 $class->log->warn($class . "->config->{case_sensitive} is set.");
1454 $class->log->warn("This setting is deprecated and planned to be removed in Catalyst 5.81.");
1457 $class->setup_finalize;
1459 # Flush the log for good measure (in case something turned off 'autoflush' early)
1460 $class->log->_flush() if $class->log->can('_flush');
1462 return $class || 1; # Just in case someone named their Application 0...
1465 =head2 $app->setup_finalize
1467 A hook to attach modifiers to. This method does not do anything except set the
1468 C<setup_finished> accessor.
1470 Applying method modifiers to the C<setup> method doesn't work, because of quirky things done for plugin setup.
1474 after setup_finalize => sub {
1482 sub setup_finalize {
1484 $class->setup_finished(1);
1487 =head2 $c->uri_for( $path?, @args?, \%query_values? )
1489 =head2 $c->uri_for( $action, \@captures?, @args?, \%query_values? )
1491 =head2 $c->uri_for( $action, [@captures, @args], \%query_values? )
1493 Constructs an absolute L<URI> object based on the application root, the
1494 provided path, and the additional arguments and query parameters provided.
1495 When used as a string, provides a textual URI. If you need more flexibility
1496 than this (i.e. the option to provide relative URIs etc.) see
1497 L<Catalyst::Plugin::SmartURI>.
1499 If no arguments are provided, the URI for the current action is returned.
1500 To return the current action and also provide @args, use
1501 C<< $c->uri_for( $c->action, @args ) >>.
1503 If the first argument is a string, it is taken as a public URI path relative
1504 to C<< $c->namespace >> (if it doesn't begin with a forward slash) or
1505 relative to the application root (if it does). It is then merged with
1506 C<< $c->request->base >>; any C<@args> are appended as additional path
1507 components; and any C<%query_values> are appended as C<?foo=bar> parameters.
1509 If the first argument is a L<Catalyst::Action> it represents an action which
1510 will have its path resolved using C<< $c->dispatcher->uri_for_action >>. The
1511 optional C<\@captures> argument (an arrayref) allows passing the captured
1512 variables that are needed to fill in the paths of Chained and Regex actions;
1513 once the path is resolved, C<uri_for> continues as though a path was
1514 provided, appending any arguments or parameters and creating an absolute
1517 The captures for the current request can be found in
1518 C<< $c->request->captures >>, and actions can be resolved using
1519 C<< Catalyst::Controller->action_for($name) >>. If you have a private action
1520 path, use C<< $c->uri_for_action >> instead.
1522 # Equivalent to $c->req->uri
1523 $c->uri_for($c->action, $c->req->captures,
1524 @{ $c->req->args }, $c->req->params);
1526 # For the Foo action in the Bar controller
1527 $c->uri_for($c->controller('Bar')->action_for('Foo'));
1529 # Path to a static resource
1530 $c->uri_for('/static/images/logo.png');
1532 In general the scheme of the generated URI object will follow the incoming request
1533 however if your targeted action or action chain has the Scheme attribute it will
1536 Also, if the targeted Action or Action chain declares Args/CaptureArgs that have
1537 type constraints, we will require that your proposed URL verify on those declared
1543 my ( $c, $path, @args ) = @_;
1545 if ( $path->$_isa('Catalyst::Controller') ) {
1546 $path = $path->path_prefix;
1551 undef($path) if (defined $path && $path eq '');
1554 ( scalar @args && ref $args[$#args] eq 'HASH' ? pop @args : {} );
1556 carp "uri_for called with undef argument" if grep { ! defined $_ } @args;
1558 my $target_action = $path->$_isa('Catalyst::Action') ? $path : undef;
1559 if ( $path->$_isa('Catalyst::Action') ) { # action object
1560 s|/|%2F|g for @args;
1561 my $captures = [ map { s|/|%2F|g; $_; }
1562 ( scalar @args && ref $args[0] eq 'ARRAY'
1567 my $expanded_action = $c->dispatcher->expand_action( $action );
1568 my $num_captures = $expanded_action->number_of_captures;
1570 # ->uri_for( $action, \@captures_and_args, \%query_values? )
1571 if( !@args && $action->number_of_args ) {
1572 unshift @args, splice @$captures, $num_captures;
1576 unless($expanded_action->match_captures_constraints($c, $captures)) {
1577 carp "captures [@{$captures}] do not match the type constraints in actionchain ending with '$expanded_action'";
1582 $path = $c->dispatcher->uri_for_action($action, $captures);
1583 if (not defined $path) {
1584 $c->log->debug(qq/Can't find uri_for action '$action' @$captures/)
1588 $path = '/' if $path eq '';
1590 # At this point @encoded_args is the remaining Args (all captures removed).
1591 if($expanded_action->has_args_constraints) {
1592 unless($expanded_action->match_args($c,\@args)) {
1593 carp "args [@args] do not match the type constraints in action '$expanded_action'";
1599 unshift(@args, $path);
1601 unless (defined $path && $path =~ s!^/!!) { # in-place strip
1602 my $namespace = $c->namespace;
1603 if (defined $path) { # cheesy hack to handle path '../foo'
1604 $namespace =~ s{(?:^|/)[^/]+$}{} while $args[0] =~ s{^\.\./}{};
1606 unshift(@args, $namespace || '');
1609 # join args with '/', or a blank string
1610 my $args = join('/', grep { defined($_) } @args);
1611 $args =~ s/\?/%3F/g; # STUPID STUPID SPECIAL CASE
1614 my ($base, $class) = ('/', 'URI::_generic');
1616 $base = $c->req->base;
1617 if($target_action) {
1618 $target_action = $c->dispatcher->expand_action($target_action);
1619 if(my $s = $target_action->scheme) {
1624 $class = ref($base);
1627 $class = ref($base);
1630 $base =~ s{(?<!/)$}{/};
1635 if (my @keys = keys %$params) {
1636 # somewhat lifted from URI::_query's query_form
1637 $query = '?'.join('&', map {
1638 my $val = $params->{$_};
1639 #s/([;\/?:@&=+,\$\[\]%])/$URI::Escape::escapes{$1}/go; ## Commented out because seems to lead to double encoding - JNAP
1642 $val = '' unless defined $val;
1645 $param = encode_utf8($param);
1646 # using the URI::Escape pattern here so utf8 chars survive
1647 $param =~ s/([^A-Za-z0-9\-_.!~*'() ])/$URI::Escape::escapes{$1}/go;
1650 $key = encode_utf8($key);
1651 # using the URI::Escape pattern here so utf8 chars survive
1652 $key =~ s/([^A-Za-z0-9\-_.!~*'() ])/$URI::Escape::escapes{$1}/go;
1655 "${key}=$param"; } ( ref $val eq 'ARRAY' ? @$val : $val ));
1659 $base = encode_utf8 $base;
1660 $base =~ s/([^$URI::uric])/$URI::Escape::escapes{$1}/go;
1661 $args = encode_utf8 $args;
1662 $args =~ s/([^$URI::uric])/$URI::Escape::escapes{$1}/go;
1664 my $res = bless(\"${base}${args}${query}", $class);
1668 =head2 $c->uri_for_action( $path, \@captures_and_args?, @args?, \%query_values? )
1670 =head2 $c->uri_for_action( $action, \@captures_and_args?, @args?, \%query_values? )
1676 A private path to the Catalyst action you want to create a URI for.
1678 This is a shortcut for calling C<< $c->dispatcher->get_action_by_path($path)
1679 >> and passing the resulting C<$action> and the remaining arguments to C<<
1682 You can also pass in a Catalyst::Action object, in which case it is passed to
1685 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.
1687 For example, if the action looks like:
1689 package MyApp::Controller::Users;
1691 sub lst : Path('the-list') {}
1695 $c->uri_for_action('/users/lst')
1697 and it will create the URI /users/the-list.
1699 =item \@captures_and_args?
1701 Optional array reference of Captures (i.e. C<<CaptureArgs or $c->req->captures>)
1702 and arguments to the request. Usually used with L<Catalyst::DispatchType::Chained>
1703 to interpolate all the parameters in the URI.
1707 Optional list of extra arguments - can be supplied in the
1708 C<< \@captures_and_args? >> array ref, or here - whichever is easier for your
1711 Your action can have zero, a fixed or a variable number of args (e.g.
1712 C<< Args(1) >> for a fixed number or C<< Args() >> for a variable number)..
1714 =item \%query_values?
1716 Optional array reference of query parameters to append. E.g.
1722 /rest/of/your/uri?foo=bar
1728 sub uri_for_action {
1729 my ( $c, $path, @args ) = @_;
1730 my $action = blessed($path)
1732 : $c->dispatcher->get_action_by_path($path);
1733 unless (defined $action) {
1734 croak "Can't find action for path '$path'";
1736 return $c->uri_for( $action, @args );
1739 =head2 $c->welcome_message
1741 Returns the Catalyst welcome HTML page.
1745 sub welcome_message {
1747 my $name = $c->config->{name};
1748 my $logo = $c->uri_for('/static/images/catalyst_logo.png');
1749 my $prefix = Catalyst::Utils::appprefix( ref $c );
1750 $c->response->content_type('text/html; charset=utf-8');
1752 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
1753 "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
1754 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
1756 <meta http-equiv="Content-Language" content="en" />
1757 <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
1758 <title>$name on Catalyst $VERSION</title>
1759 <style type="text/css">
1762 background-color: #eee;
1769 margin-bottom: 10px;
1771 background-color: #ccc;
1772 border: 1px solid #aaa;
1777 font-family: verdana, tahoma, sans-serif;
1780 font-family: verdana, tahoma, sans-serif;
1783 text-decoration: none;
1785 border-bottom: 1px dotted #bbb;
1787 :link:hover, :visited:hover {
1800 background-color: #fff;
1801 border: 1px solid #aaa;
1805 font-weight: normal;
1827 <h1><span id="appname">$name</span> on <a href="http://catalyst.perl.org">Catalyst</a>
1832 <img src="$logo" alt="Catalyst Logo" />
1834 <p>Welcome to the world of Catalyst.
1835 This <a href="http://en.wikipedia.org/wiki/MVC">MVC</a>
1836 framework will make web development something you had
1837 never expected it to be: Fun, rewarding, and quick.</p>
1838 <h2>What to do now?</h2>
1839 <p>That really depends on what <b>you</b> want to do.
1840 We do, however, provide you with a few starting points.</p>
1841 <p>If you want to jump right into web development with Catalyst
1842 you might want to start with a tutorial.</p>
1843 <pre>perldoc <a href="https://metacpan.org/module/Catalyst::Manual::Tutorial">Catalyst::Manual::Tutorial</a></code>
1845 <p>Afterwards you can go on to check out a more complete look at our features.</p>
1847 <code>perldoc <a href="https://metacpan.org/module/Catalyst::Manual::Intro">Catalyst::Manual::Intro</a>
1848 <!-- Something else should go here, but the Catalyst::Manual link seems unhelpful -->
1850 <h2>What to do next?</h2>
1851 <p>Next it's time to write an actual application. Use the
1852 helper scripts to generate <a href="https://metacpan.org/search?q=Catalyst%3A%3AController">controllers</a>,
1853 <a href="https://metacpan.org/search?q=Catalyst%3A%3AModel">models</a>, and
1854 <a href="https://metacpan.org/search?q=Catalyst%3A%3AView">views</a>;
1855 they can save you a lot of work.</p>
1856 <pre><code>script/${prefix}_create.pl --help</code></pre>
1857 <p>Also, be sure to check out the vast and growing
1858 collection of <a href="http://search.cpan.org/search?query=Catalyst">plugins for Catalyst on CPAN</a>;
1859 you are likely to find what you need there.
1863 <p>Catalyst has a very active community. Here are the main places to
1864 get in touch with us.</p>
1867 <a href="http://dev.catalyst.perl.org">Wiki</a>
1870 <a href="http://lists.scsys.co.uk/cgi-bin/mailman/listinfo/catalyst">Mailing-List</a>
1873 <a href="irc://irc.perl.org/catalyst">IRC channel #catalyst on irc.perl.org</a>
1876 <h2>In conclusion</h2>
1877 <p>The Catalyst team hopes you will enjoy using Catalyst as much
1878 as we enjoyed making it. Please contact us if you have ideas
1879 for improvement or other feedback.</p>
1889 Contains a hash of options passed from the application script, including
1890 the original ARGV the script received, the processed values from that
1891 ARGV and any extra arguments to the script which were not processed.
1893 This can be used to add custom options to your application's scripts
1894 and setup your application differently depending on the values of these
1897 =head1 INTERNAL METHODS
1899 These methods are not meant to be used by end users.
1901 =head2 $c->components
1903 Returns a hash of components.
1905 =head2 $c->context_class
1907 Returns or sets the context class.
1911 Returns a hashref containing coderefs and execution counts (needed for
1912 deep recursion detection).
1916 Returns the number of actions on the current internal execution stack.
1920 Dispatches a request to actions.
1924 sub dispatch { my $c = shift; $c->dispatcher->dispatch( $c, @_ ) }
1926 =head2 $c->dispatcher_class
1928 Returns or sets the dispatcher class.
1930 =head2 $c->dump_these
1932 Returns a list of 2-element array references (name, structure) pairs
1933 that will be dumped on the error page in debug mode.
1939 [ Request => $c->req ],
1940 [ Response => $c->res ],
1941 [ Stash => $c->stash ],
1942 [ Config => $c->config ];
1945 =head2 $c->engine_class
1947 Returns or sets the engine class.
1949 =head2 $c->execute( $class, $coderef )
1951 Execute a coderef in given class and catch exceptions. Errors are available
1957 my ( $c, $class, $code ) = @_;
1958 $class = $c->component($class) || $class;
1961 if ( $c->depth >= $RECURSION ) {
1962 my $action = $code->reverse();
1963 $action = "/$action" unless $action =~ /->/;
1964 my $error = qq/Deep recursion detected calling "${action}"/;
1965 $c->log->error($error);
1971 my $stats_info = $c->_stats_start_execute( $code ) if $c->use_stats;
1973 push( @{ $c->stack }, $code );
1975 no warnings 'recursion';
1976 # N.B. This used to be combined, but I have seen $c get clobbered if so, and
1977 # I have no idea how, ergo $ret (which appears to fix the issue)
1978 eval { my $ret = $code->execute( $class, $c, @{ $c->req->args } ) || 0; $c->state( $ret ) };
1980 $c->_stats_finish_execute( $stats_info ) if $c->use_stats and $stats_info;
1982 my $last = pop( @{ $c->stack } );
1984 if ( my $error = $@ ) {
1985 #rethow if this can be handled by middleware
1986 if ( $c->_handle_http_exception($error) ) {
1987 foreach my $err (@{$c->error}) {
1988 $c->log->error($err);
1991 $c->log->_flush if $c->log->can('_flush');
1993 $error->can('rethrow') ? $error->rethrow : croak $error;
1995 if ( blessed($error) and $error->isa('Catalyst::Exception::Detach') ) {
1996 $error->rethrow if $c->depth > 1;
1998 elsif ( blessed($error) and $error->isa('Catalyst::Exception::Go') ) {
1999 $error->rethrow if $c->depth > 0;
2002 unless ( ref $error ) {
2003 no warnings 'uninitialized';
2005 my $class = $last->class;
2006 my $name = $last->name;
2007 $error = qq/Caught exception in $class->$name "$error"/;
2016 sub _stats_start_execute {
2017 my ( $c, $code ) = @_;
2018 my $appclass = ref($c) || $c;
2019 return if ( ( $code->name =~ /^_.*/ )
2020 && ( !$appclass->config->{show_internal_actions} ) );
2022 my $action_name = $code->reverse();
2023 $c->counter->{$action_name}++;
2025 my $action = $action_name;
2026 $action = "/$action" unless $action =~ /->/;
2028 # determine if the call was the result of a forward
2029 # this is done by walking up the call stack and looking for a calling
2030 # sub of Catalyst::forward before the eval
2032 for my $index ( 2 .. 11 ) {
2034 if ( ( caller($index) )[0] eq 'Catalyst'
2035 && ( caller($index) )[3] eq '(eval)' );
2037 if ( ( caller($index) )[3] =~ /forward$/ ) {
2038 $callsub = ( caller($index) )[3];
2039 $action = "-> $action";
2044 my $uid = $action_name . $c->counter->{$action_name};
2046 # is this a root-level call or a forwarded call?
2047 if ( $callsub =~ /forward$/ ) {
2048 my $parent = $c->stack->[-1];
2050 # forward, locate the caller
2051 if ( defined $parent && exists $c->counter->{"$parent"} ) {
2054 parent => "$parent" . $c->counter->{"$parent"},
2060 # forward with no caller may come from a plugin
2079 sub _stats_finish_execute {
2080 my ( $c, $info ) = @_;
2081 $c->stats->profile( end => $info );
2086 Finalizes the request.
2093 for my $error ( @{ $c->error } ) {
2094 $c->log->error($error);
2097 # Support skipping finalize for psgix.io style 'jailbreak'. Used to support
2098 # stuff like cometd and websockets
2100 if($c->request->_has_io_fh) {
2105 # Allow engine to handle finalize flow (for POE)
2106 my $engine = $c->engine;
2107 if ( my $code = $engine->can('finalize') ) {
2112 $c->finalize_uploads;
2115 if ( $#{ $c->error } >= 0 ) {
2119 $c->finalize_encoding;
2120 $c->finalize_headers unless $c->response->finalized_headers;
2126 if ($c->use_stats) {
2127 my $elapsed = $c->stats->elapsed;
2128 my $av = $elapsed == 0 ? '??' : sprintf '%.3f', 1 / $elapsed;
2130 "Request took ${elapsed}s ($av/s)\n" . $c->stats->report . "\n" );
2133 return $c->response->status;
2136 =head2 $c->finalize_body
2142 sub finalize_body { my $c = shift; $c->engine->finalize_body( $c, @_ ) }
2144 =head2 $c->finalize_cookies
2150 sub finalize_cookies { my $c = shift; $c->engine->finalize_cookies( $c, @_ ) }
2152 =head2 $c->finalize_error
2154 Finalizes error. If there is only one error in L</error> and it is an object that
2155 does C<as_psgi> or C<code> we rethrow the error and presume it caught by middleware
2156 up the ladder. Otherwise we return the debugging error page (in debug mode) or we
2157 return the default error page (production mode).
2161 sub finalize_error {
2163 if($#{$c->error} > 0) {
2164 $c->engine->finalize_error( $c, @_ );
2166 my ($error) = @{$c->error};
2167 if ( $c->_handle_http_exception($error) ) {
2168 # In the case where the error 'knows what it wants', becauses its PSGI
2169 # aware, just rethow and let middleware catch it
2170 $error->can('rethrow') ? $error->rethrow : croak $error;
2172 $c->engine->finalize_error( $c, @_ )
2177 =head2 $c->finalize_headers
2183 sub finalize_headers {
2186 my $response = $c->response; #accessor calls can add up?
2188 # Check if we already finalized headers
2189 return if $response->finalized_headers;
2192 if ( my $location = $response->redirect ) {
2193 $c->log->debug(qq/Redirecting to "$location"/) if $c->debug;
2194 $response->header( Location => $location );
2197 # Remove incorrectly added body and content related meta data when returning
2198 # an information response, or a response the is required to not include a body
2200 $c->finalize_cookies;
2202 # This currently is a NOOP but I don't want to remove it since I guess people
2203 # might have Response subclasses that use it for something... (JNAP)
2204 $c->response->finalize_headers();
2207 $response->finalized_headers(1);
2210 =head2 $c->finalize_encoding
2212 Make sure your body is encoded properly IF you set an encoding. By
2213 default the encoding is UTF-8 but you can disable it by explicitly setting the
2214 encoding configuration value to undef.
2216 We can only encode when the body is a scalar. Methods for encoding via the
2217 streaming interfaces (such as C<write> and C<write_fh> on L<Catalyst::Response>
2224 sub finalize_encoding {
2226 my $res = $c->res || return;
2228 # Warn if the set charset is different from the one you put into encoding. We need
2229 # to do this early since encodable_response is false for this condition and we need
2230 # to match the debug output for backcompat (there's a test for this...) -JNAP
2232 $res->content_type_charset and $c->encoding and
2233 (uc($c->encoding->mime_name) ne uc($res->content_type_charset))
2235 my $ct = lc($res->content_type_charset);
2236 $c->log->debug("Catalyst encoding config is set to encode in '" .
2237 $c->encoding->mime_name .
2238 "', content type is '$ct', not encoding ");
2242 ($res->encodable_response) and
2243 (defined($res->body)) and
2244 (ref(\$res->body) eq 'SCALAR')
2246 $c->res->body( $c->encoding->encode( $c->res->body, $c->_encode_check ) );
2248 # Set the charset if necessary. This might be a bit bonkers since encodable response
2249 # is false when the set charset is not the same as the encoding mimetype (maybe
2250 # confusing action at a distance here..
2251 # Don't try to set the charset if one already exists or if headers are already finalized
2252 $c->res->content_type($c->res->content_type . "; charset=" . $c->encoding->mime_name)
2253 unless($c->res->content_type_charset ||
2254 ($c->res->_context && $c->res->finalized_headers && !$c->res->_has_response_cb));
2258 =head2 $c->finalize_output
2260 An alias for finalize_body.
2262 =head2 $c->finalize_read
2264 Finalizes the input after reading is complete.
2268 sub finalize_read { my $c = shift; $c->engine->finalize_read( $c, @_ ) }
2270 =head2 $c->finalize_uploads
2272 Finalizes uploads. Cleans up any temporary files.
2276 sub finalize_uploads { my $c = shift; $c->engine->finalize_uploads( $c, @_ ) }
2278 =head2 $c->get_action( $action, $namespace )
2280 Gets an action in a given namespace.
2284 sub get_action { my $c = shift; $c->dispatcher->get_action(@_) }
2286 =head2 $c->get_actions( $action, $namespace )
2288 Gets all actions of a given name in a namespace and all parent
2293 sub get_actions { my $c = shift; $c->dispatcher->get_actions( $c, @_ ) }
2295 =head2 $app->handle_request( @arguments )
2297 Called to handle each HTTP request.
2301 sub handle_request {
2302 my ( $class, @arguments ) = @_;
2304 # Always expect worst case!
2307 if ($class->debug) {
2308 my $secs = time - $START || 1;
2309 my $av = sprintf '%.3f', $COUNT / $secs;
2310 my $time = localtime time;
2311 $class->log->info("*** Request $COUNT ($av/s) [$$] [$time] ***");
2314 my $c = $class->prepare(@arguments);
2316 $status = $c->finalize;
2318 #rethow if this can be handled by middleware
2319 if ( $class->_handle_http_exception($_) ) {
2320 $_->can('rethrow') ? $_->rethrow : croak $_;
2322 chomp(my $error = $_);
2323 $class->log->error(qq/Caught exception in engine "$error"/);
2328 if(my $coderef = $class->log->can('_flush')){
2329 $class->log->$coderef();
2334 =head2 $class->prepare( @arguments )
2336 Creates a Catalyst context from an engine-specific request (Apache, CGI,
2343 predicate => '_has_uploadtmp',
2347 my ( $class, @arguments ) = @_;
2350 # After the app/ctxt split, this should become an attribute based on something passed
2351 # into the application.
2352 $class->context_class( ref $class || $class ) unless $class->context_class;
2354 my $uploadtmp = $class->config->{uploadtmp};
2355 my $c = $class->context_class->new({ $uploadtmp ? (_uploadtmp => $uploadtmp) : ()});
2357 $c->response->_context($c);
2359 $c->stats($class->stats_class->new)->enable($c->use_stats);
2361 if ( $c->debug || $c->config->{enable_catalyst_header} ) {
2362 $c->res->headers->header( 'X-Catalyst' => $Catalyst::VERSION );
2366 # Allow engine to direct the prepare flow (for POE)
2367 if ( my $prepare = $c->engine->can('prepare') ) {
2368 $c->engine->$prepare( $c, @arguments );
2371 $c->prepare_request(@arguments);
2372 $c->prepare_connection;
2373 $c->prepare_query_parameters;
2374 $c->prepare_headers; # Just hooks, no longer needed - they just
2375 $c->prepare_cookies; # cause the lazy attribute on req to build
2378 # Prepare the body for reading, either by prepare_body
2379 # or the user, if they are using $c->read
2382 # Parse the body unless the user wants it on-demand
2383 unless ( ref($c)->config->{parse_on_demand} ) {
2389 # VERY ugly and probably shouldn't rely on ->finalize actually working
2391 # failed prepare is always due to an invalid request, right?
2392 $c->response->status(400);
2393 $c->response->content_type('text/plain');
2394 $c->response->body('Bad Request');
2395 # Note we call finalize and then die here, which escapes
2396 # finalize being called in the enclosing block..
2397 # It in fact couldn't be called, as we don't return $c..
2398 # This is a mess - but I'm unsure you can fix this without
2399 # breaking compat for people doing crazy things (we should set
2400 # the 400 and just return the ctx here IMO, letting finalize get called
2411 =head2 $c->prepare_action
2413 Prepares action. See L<Catalyst::Dispatcher>.
2417 sub prepare_action {
2419 my $ret = $c->dispatcher->prepare_action( $c, @_);
2422 foreach (@{$c->req->arguments}, @{$c->req->captures}) {
2423 $_ = $c->_handle_param_unicode_decoding($_);
2431 =head2 $c->prepare_body
2433 Prepares message body.
2440 return if $c->request->_has_body;
2442 # Initialize on-demand data
2443 $c->engine->prepare_body( $c, @_ );
2444 $c->prepare_parameters;
2445 $c->prepare_uploads;
2448 =head2 $c->prepare_body_chunk( $chunk )
2450 Prepares a chunk of data before sending it to L<HTTP::Body>.
2452 See L<Catalyst::Engine>.
2456 sub prepare_body_chunk {
2458 $c->engine->prepare_body_chunk( $c, @_ );
2461 =head2 $c->prepare_body_parameters
2463 Prepares body parameters.
2467 sub prepare_body_parameters {
2469 $c->request->prepare_body_parameters( $c, @_ );
2472 =head2 $c->prepare_connection
2474 Prepares connection.
2478 sub prepare_connection {
2480 $c->request->prepare_connection($c);
2483 =head2 $c->prepare_cookies
2485 Prepares cookies by ensuring that the attribute on the request
2486 object has been built.
2490 sub prepare_cookies { my $c = shift; $c->request->cookies }
2492 =head2 $c->prepare_headers
2494 Prepares request headers by ensuring that the attribute on the request
2495 object has been built.
2499 sub prepare_headers { my $c = shift; $c->request->headers }
2501 =head2 $c->prepare_parameters
2503 Prepares parameters.
2507 sub prepare_parameters {
2509 $c->prepare_body_parameters;
2510 $c->engine->prepare_parameters( $c, @_ );
2513 =head2 $c->prepare_path
2515 Prepares path and base.
2519 sub prepare_path { my $c = shift; $c->engine->prepare_path( $c, @_ ) }
2521 =head2 $c->prepare_query_parameters
2523 Prepares query parameters.
2527 sub prepare_query_parameters {
2530 $c->engine->prepare_query_parameters( $c, @_ );
2533 =head2 $c->log_request
2535 Writes information about the request to the debug logs. This includes:
2539 =item * Request method, path, and remote IP address
2541 =item * Query keywords (see L<Catalyst::Request/query_keywords>)
2543 =item * Request parameters
2545 =item * File uploads
2554 return unless $c->debug;
2556 my($dump) = grep {$_->[0] eq 'Request' } $c->dump_these;
2557 my $request = $dump->[1];
2559 my ( $method, $path, $address ) = ( $request->method, $request->path, $request->address );
2561 $path = '/' unless length $path;
2564 $path =~ s/%([0-9A-Fa-f]{2})/chr(hex($1))/eg;
2565 $path = decode_utf8($path);
2567 $c->log->debug(qq/"$method" request for "$path" from "$address"/);
2569 $c->log_request_headers($request->headers);
2571 if ( my $keywords = $request->query_keywords ) {
2572 $c->log->debug("Query keywords are: $keywords");
2575 $c->log_request_parameters( query => $request->query_parameters, $request->_has_body ? (body => $request->body_parameters) : () );
2577 $c->log_request_uploads($request);
2580 =head2 $c->log_response
2582 Writes information about the response to the debug logs by calling
2583 C<< $c->log_response_status_line >> and C<< $c->log_response_headers >>.
2590 return unless $c->debug;
2592 my($dump) = grep {$_->[0] eq 'Response' } $c->dump_these;
2593 my $response = $dump->[1];
2595 $c->log_response_status_line($response);
2596 $c->log_response_headers($response->headers);
2599 =head2 $c->log_response_status_line($response)
2601 Writes one line of information about the response to the debug logs. This includes:
2605 =item * Response status code
2607 =item * Content-Type header (if present)
2609 =item * Content-Length header (if present)
2615 sub log_response_status_line {
2616 my ($c, $response) = @_;
2620 'Response Code: %s; Content-Type: %s; Content-Length: %s',
2621 $response->status || 'unknown',
2622 $response->headers->header('Content-Type') || 'unknown',
2623 $response->headers->header('Content-Length') || 'unknown'
2628 =head2 $c->log_response_headers($headers);
2630 Hook method which can be wrapped by plugins to log the response headers.
2631 No-op in the default implementation.
2635 sub log_response_headers {}
2637 =head2 $c->log_request_parameters( query => {}, body => {} )
2639 Logs request parameters to debug logs
2643 sub log_request_parameters {
2645 my %all_params = @_;
2647 return unless $c->debug;
2649 my $column_width = Catalyst::Utils::term_width() - 44;
2650 foreach my $type (qw(query body)) {
2651 my $params = $all_params{$type};
2652 next if ! keys %$params;
2653 my $t = Text::SimpleTable->new( [ 35, 'Parameter' ], [ $column_width, 'Value' ] );
2654 for my $key ( sort keys %$params ) {
2655 my $param = $params->{$key};
2656 my $value = defined($param) ? $param : '';
2657 $t->row( $key, ref $value eq 'ARRAY' ? ( join ', ', @$value ) : $value );
2659 $c->log->debug( ucfirst($type) . " Parameters are:\n" . $t->draw );
2663 =head2 $c->log_request_uploads
2665 Logs file uploads included in the request to the debug logs.
2666 The parameter name, filename, file type, and file size are all included in
2671 sub log_request_uploads {
2673 my $request = shift;
2674 return unless $c->debug;
2675 my $uploads = $request->uploads;
2676 if ( keys %$uploads ) {
2677 my $t = Text::SimpleTable->new(
2678 [ 12, 'Parameter' ],
2683 for my $key ( sort keys %$uploads ) {
2684 my $upload = $uploads->{$key};
2685 for my $u ( ref $upload eq 'ARRAY' ? @{$upload} : ($upload) ) {
2686 $t->row( $key, $u->filename, $u->type, $u->size );
2689 $c->log->debug( "File Uploads are:\n" . $t->draw );
2693 =head2 $c->log_request_headers($headers);
2695 Hook method which can be wrapped by plugins to log the request headers.
2696 No-op in the default implementation.
2700 sub log_request_headers {}
2702 =head2 $c->log_headers($type => $headers)
2704 Logs L<HTTP::Headers> (either request or response) to the debug logs.
2711 my $headers = shift; # an HTTP::Headers instance
2713 return unless $c->debug;
2715 my $column_width = Catalyst::Utils::term_width() - 28;
2716 my $t = Text::SimpleTable->new( [ 15, 'Header Name' ], [ $column_width, 'Value' ] );
2719 my ( $name, $value ) = @_;
2720 $t->row( $name, $value );
2723 $c->log->debug( ucfirst($type) . " Headers:\n" . $t->draw );
2727 =head2 $c->prepare_read
2729 Prepares the input for reading.
2733 sub prepare_read { my $c = shift; $c->engine->prepare_read( $c, @_ ) }
2735 =head2 $c->prepare_request
2737 Prepares the engine request.
2741 sub prepare_request { my $c = shift; $c->engine->prepare_request( $c, @_ ) }
2743 =head2 $c->prepare_uploads
2749 sub prepare_uploads {
2751 $c->engine->prepare_uploads( $c, @_ );
2754 =head2 $c->prepare_write
2756 Prepares the output for writing.
2760 sub prepare_write { my $c = shift; $c->engine->prepare_write( $c, @_ ) }
2762 =head2 $c->request_class
2764 Returns or sets the request class. Defaults to L<Catalyst::Request>.
2766 =head2 $app->request_class_traits
2768 An arrayref of L<Moose::Role>s which are applied to the request class. You can
2769 name the full namespace of the role, or a namespace suffix, which will then
2770 be tried against the following standard namespace prefixes.
2772 $MyApp::TraitFor::Request::$trait_suffix
2773 Catalyst::TraitFor::Request::$trait_suffix
2775 So for example if you set:
2777 MyApp->request_class_traits(['Foo']);
2779 We try each possible role in turn (and throw an error if none load)
2782 MyApp::TraitFor::Request::Foo
2783 Catalyst::TraitFor::Request::Foo
2785 The namespace part 'TraitFor::Request' was choosen to assist in backwards
2786 compatibility with L<CatalystX::RoleApplicator> which previously provided
2787 these features in a stand alone package.
2789 =head2 $app->composed_request_class
2791 This is the request class which has been composed with any request_class_traits.
2793 =head2 $c->response_class
2795 Returns or sets the response class. Defaults to L<Catalyst::Response>.
2797 =head2 $app->response_class_traits
2799 An arrayref of L<Moose::Role>s which are applied to the response class. You can
2800 name the full namespace of the role, or a namespace suffix, which will then
2801 be tried against the following standard namespace prefixes.
2803 $MyApp::TraitFor::Response::$trait_suffix
2804 Catalyst::TraitFor::Response::$trait_suffix
2806 So for example if you set:
2808 MyApp->response_class_traits(['Foo']);
2810 We try each possible role in turn (and throw an error if none load)
2813 MyApp::TraitFor::Response::Foo
2814 Catalyst::TraitFor::Responset::Foo
2816 The namespace part 'TraitFor::Response' was choosen to assist in backwards
2817 compatibility with L<CatalystX::RoleApplicator> which previously provided
2818 these features in a stand alone package.
2821 =head2 $app->composed_response_class
2823 This is the request class which has been composed with any response_class_traits.
2825 =head2 $c->read( [$maxlength] )
2827 Reads a chunk of data from the request body. This method is designed to
2828 be used in a while loop, reading C<$maxlength> bytes on every call.
2829 C<$maxlength> defaults to the size of the request if not specified.
2831 You have to set C<< MyApp->config(parse_on_demand => 1) >> to use this
2834 Warning: If you use read(), Catalyst will not process the body,
2835 so you will not be able to access POST parameters or file uploads via
2836 $c->request. You must handle all body parsing yourself.
2840 sub read { my $c = shift; return $c->request->read( @_ ) }
2850 $app->_make_immutable_if_needed;
2851 $app->engine_loader->needs_psgi_engine_compat_hack ?
2852 $app->engine->run($app, @_) :
2853 $app->engine->run( $app, $app->_finalized_psgi_app, @_ );
2856 sub _make_immutable_if_needed {
2858 my $meta = find_meta($class);
2859 my $isa_ca = $class->isa('Class::Accessor::Fast') || $class->isa('Class::Accessor');
2862 && ! { $meta->immutable_options }->{replace_constructor}
2865 warn("You made your application class ($class) immutable, "
2866 . "but did not inline the\nconstructor. "
2867 . "This will break catalyst, as your app \@ISA "
2868 . "Class::Accessor(::Fast)?\nPlease pass "
2869 . "(replace_constructor => 1)\nwhen making your class immutable.\n");
2871 unless ($meta->is_immutable) {
2872 # XXX - FIXME warning here as you should make your app immutable yourself.
2873 $meta->make_immutable(
2874 replace_constructor => 1,
2879 =head2 $c->set_action( $action, $code, $namespace, $attrs )
2881 Sets an action in a given namespace.
2885 sub set_action { my $c = shift; $c->dispatcher->set_action( $c, @_ ) }
2887 =head2 $c->setup_actions($component)
2889 Sets up actions for a component.
2893 sub setup_actions { my $c = shift; $c->dispatcher->setup_actions( $c, @_ ) }
2895 =head2 $c->setup_components
2897 This method is called internally to set up the application's components.
2899 It finds modules by calling the L<locate_components> method, expands them to
2900 package names with the L<expand_component_module> method, and then installs
2901 each component into the application.
2903 The C<setup_components> config option is passed to both of the above methods.
2905 Installation of each component is performed by the L<setup_component> method,
2910 sub setup_components {
2913 my $config = $class->config->{ setup_components };
2915 my @comps = $class->locate_components($config);
2916 my %comps = map { $_ => 1 } @comps;
2918 my $deprecatedcatalyst_component_names = grep { /::[CMV]::/ } @comps;
2919 $class->log->warn(qq{Your application is using the deprecated ::[MVC]:: type naming scheme.\n}.
2920 qq{Please switch your class names to ::Model::, ::View:: and ::Controller: as appropriate.\n}
2921 ) if $deprecatedcatalyst_component_names;
2923 for my $component ( @comps ) {
2925 # We pass ignore_loaded here so that overlay files for (e.g.)
2926 # Model::DBI::Schema sub-classes are loaded - if it's in @comps
2927 # we know M::P::O found a file on disk so this is safe
2929 Catalyst::Utils::ensure_class_loaded( $component, { ignore_loaded => 1 } );
2932 for my $component (@comps) {
2933 my $instance = $class->components->{ $component } = $class->delayed_setup_component($component);
2936 # Inject a component or wrap a stand alone class in an adaptor. This makes a list
2937 # of named components in the configuration that are not actually existing (not a
2940 my @injected = $class->setup_injected_components;
2942 # All components are registered, now we need to 'init' them.
2943 foreach my $component_name (@comps, @injected) {
2944 $class->components->{$component_name} = $class->components->{$component_name}->() if
2945 (ref($class->components->{$component_name}) || '') eq 'CODE';
2949 =head2 $app->setup_injected_components
2951 Called by setup_compoents to setup components that are injected.
2955 sub setup_injected_components {
2957 my @injected_components = keys %{$class->config->{inject_components} ||+{}};
2959 foreach my $injected_comp_name(@injected_components) {
2960 $class->setup_injected_component(
2961 $injected_comp_name,
2962 $class->config->{inject_components}->{$injected_comp_name});
2965 return map { $class ."::" . $_ }
2966 @injected_components;
2969 =head2 $app->setup_injected_component( $injected_component_name, $config )
2971 Setup a given injected component.
2975 sub setup_injected_component {
2976 my ($class, $injected_comp_name, $config) = @_;
2977 if(my $component_class = $config->{from_component}) {
2978 my @roles = @{$config->{roles} ||[]};
2979 Catalyst::Utils::inject_component(
2981 component => $component_class,
2982 (scalar(@roles) ? (traits => \@roles) : ()),
2983 as => $injected_comp_name);
2987 =head2 $app->inject_component($MyApp_Component_name => \%args);
2989 Add a component that is injected at setup:
2991 MyApp->inject_component( 'Model::Foo' => { from_component => 'Common::Foo' } );
2993 Must be called before ->setup. Expects a component name for your
2994 current application and \%args where
2998 =item from_component
3000 The target component being injected into your application
3004 An arrayref of L<Moose::Role>s that are applied to your component.
3010 MyApp->inject_component(
3012 from_component => 'Common::Model::Foo',
3013 roles => ['Role1', 'Role2'],
3016 =head2 $app->inject_components
3018 Inject a list of components:
3020 MyApp->inject_components(
3021 'Model::FooOne' => {
3022 from_component => 'Common::Model::Foo',
3023 roles => ['Role1', 'Role2'],
3025 'Model::FooTwo' => {
3026 from_component => 'Common::Model::Foo',
3027 roles => ['Role1', 'Role2'],
3032 sub inject_component {
3033 my ($app, $name, $args) = @_;
3034 die "Component $name exists" if
3035 $app->config->{inject_components}->{$name};
3036 $app->config->{inject_components}->{$name} = $args;
3039 sub inject_components {
3042 $app->inject_component(shift, shift);
3046 =head2 $c->locate_components( $setup_component_config )
3048 This method is meant to provide a list of component modules that should be
3049 setup for the application. By default, it will use L<Module::Pluggable>.
3051 Specify a C<setup_components> config option to pass additional options directly
3052 to L<Module::Pluggable>. To add additional search paths, specify a key named
3053 C<search_extra> as an array reference. Items in the array beginning with C<::>
3054 will have the application class name prepended to them.
3058 sub locate_components {
3062 my @paths = qw( ::M ::Model ::V ::View ::C ::Controller );
3063 my $extra = delete $config->{ search_extra } || [];
3065 unshift @paths, @$extra;
3067 my @comps = map { sort { length($a) <=> length($b) } Module::Pluggable::Object->new(
3068 search_path => [ map { s/^(?=::)/$class/; $_; } ($_) ],
3070 )->plugins } @paths;
3075 =head2 $c->expand_component_module( $component, $setup_component_config )
3077 Components found by C<locate_components> will be passed to this method, which
3078 is expected to return a list of component (package) names to be set up.
3082 sub expand_component_module {
3083 my ($class, $module) = @_;
3084 return Devel::InnerPackage::list_packages( $module );
3087 =head2 $app->delayed_setup_component
3089 Returns a coderef that points to a setup_component instance. Used
3090 internally for when you want to delay setup until the first time
3091 the component is called.
3095 sub delayed_setup_component {
3096 my($class, $component, @more) = @_;
3098 return my $instance = $class->setup_component($component, @more);
3102 =head2 $c->setup_component
3106 sub setup_component {
3107 my( $class, $component ) = @_;
3109 unless ( $component->can( 'COMPONENT' ) ) {
3113 my $config = $class->config_for($component);
3114 # Stash catalyst_component_name in the config here, so that custom COMPONENT
3115 # methods also pass it. local to avoid pointlessly shitting in config
3116 # for the debug screen, as $component is already the key name.
3117 local $config->{catalyst_component_name} = $component;
3119 my $instance = eval {
3120 $component->COMPONENT( $class, $config );
3124 Catalyst::Exception->throw(
3125 message => qq/Couldn't instantiate component "$component", "$error"/
3129 unless (blessed $instance) {
3130 my $metaclass = Moose::Util::find_meta($component);
3131 my $method_meta = $metaclass->find_method_by_name('COMPONENT');
3132 my $component_method_from = $method_meta->associated_metaclass->name;
3133 my $value = defined($instance) ? $instance : 'undef';
3134 Catalyst::Exception->throw(
3136 qq/Couldn't instantiate component "$component", COMPONENT() method (from $component_method_from) didn't return an object-like value (value was $value)./
3140 my @expanded_components = $instance->can('expand_modules')
3141 ? $instance->expand_modules( $component, $config )
3142 : $class->expand_component_module( $component, $config );
3143 for my $component (@expanded_components) {
3144 next if $class->components->{ $component };
3145 $class->components->{ $component } = $class->setup_component($component);
3151 =head2 $app->config_for( $component_name )
3153 Return the application level configuration (which is not yet merged with any
3154 local component configuration, via $component_class->config) for the named
3155 component or component object. Example:
3158 'Model::Foo' => { a => 1, b => 2},
3161 my $config = MyApp->config_for('MyApp::Model::Foo');
3163 In this case $config is the hashref C< {a=>1, b=>2} >.
3165 This is also handy for looking up configuration for a plugin, to make sure you follow
3166 existing L<Catalyst> standards for where a plugin should put its configuration.
3171 my ($class, $component_name) = @_;
3172 my $component_suffix = Catalyst::Utils::class2classsuffix($component_name);
3173 my $config = $class->config->{ $component_suffix } || {};
3178 =head2 $c->setup_dispatcher
3184 sub setup_dispatcher {
3185 my ( $class, $dispatcher ) = @_;
3188 $dispatcher = 'Catalyst::Dispatcher::' . $dispatcher;
3191 if ( my $env = Catalyst::Utils::env_value( $class, 'DISPATCHER' ) ) {
3192 $dispatcher = 'Catalyst::Dispatcher::' . $env;
3195 unless ($dispatcher) {
3196 $dispatcher = $class->dispatcher_class;
3199 load_class($dispatcher);
3201 # dispatcher instance
3202 $class->dispatcher( $dispatcher->new );
3205 =head2 $c->setup_engine
3212 my ($class, $requested_engine) = @_;
3214 if (!$class->engine_loader || $requested_engine) {
3215 $class->engine_loader(
3216 Catalyst::EngineLoader->new({
3217 application_name => $class,
3218 (defined $requested_engine
3219 ? (catalyst_engine_class => $requested_engine) : ()),
3224 $class->engine_loader->catalyst_engine_class;
3228 my ($class, $requested_engine) = @_;
3231 my $loader = $class->engine_loader;
3233 if (!$loader || $requested_engine) {
3234 $loader = Catalyst::EngineLoader->new({
3235 application_name => $class,
3236 (defined $requested_engine
3237 ? (requested_engine => $requested_engine) : ()),
3240 $class->engine_loader($loader);
3243 $loader->catalyst_engine_class;
3246 # Don't really setup_engine -- see _setup_psgi_app for explanation.
3247 return if $class->loading_psgi_file;
3249 load_class($engine);
3251 if ($ENV{MOD_PERL}) {
3252 my $apache = $class->engine_loader->auto;
3254 my $meta = find_meta($class);
3255 my $was_immutable = $meta->is_immutable;
3256 my %immutable_options = $meta->immutable_options;
3257 $meta->make_mutable if $was_immutable;
3259 $meta->add_method(handler => sub {
3261 my $psgi_app = $class->_finalized_psgi_app;
3262 $apache->call_app($r, $psgi_app);
3265 $meta->make_immutable(%immutable_options) if $was_immutable;
3268 $class->engine( $engine->new );
3273 ## This exists just to supply a prebuild psgi app for mod_perl and for the
3274 ## build in server support (back compat support for pre psgi port behavior).
3275 ## This is so that we don't build a new psgi app for each request when using
3276 ## the mod_perl handler or the built in servers (http and fcgi, etc).
3278 sub _finalized_psgi_app {
3281 unless ($app->_psgi_app) {
3282 my $psgi_app = $app->_setup_psgi_app;
3283 $app->_psgi_app($psgi_app);
3286 return $app->_psgi_app;
3289 ## Look for a psgi file like 'myapp_web.psgi' (if the app is MyApp::Web) in the
3290 ## home directory and load that and return it (just assume it is doing the
3291 ## right thing :) ). If that does not exist, call $app->psgi_app, wrap that
3292 ## in default_middleware and return it ( this is for backward compatibility
3293 ## with pre psgi port behavior ).
3295 sub _setup_psgi_app {
3298 for my $home (Path::Class::Dir->new($app->config->{home})) {
3299 my $psgi_file = $home->file(
3300 Catalyst::Utils::appprefix($app) . '.psgi',
3303 next unless -e $psgi_file;
3305 # If $psgi_file calls ->setup_engine, it's doing so to load
3306 # Catalyst::Engine::PSGI. But if it does that, we're only going to
3307 # throw away the loaded PSGI-app and load the 5.9 Catalyst::Engine
3308 # anyway. So set a flag (ick) that tells setup_engine not to populate
3309 # $c->engine or do any other things we might regret.
3311 $app->loading_psgi_file(1);
3312 my $psgi_app = Plack::Util::load_psgi($psgi_file);
3313 $app->loading_psgi_file(0);
3316 unless $app->engine_loader->needs_psgi_engine_compat_hack;
3319 Found a legacy Catalyst::Engine::PSGI .psgi file at ${psgi_file}.
3321 Its content has been ignored. Please consult the Catalyst::Upgrading
3322 documentation on how to upgrade from Catalyst::Engine::PSGI.
3326 return $app->apply_default_middlewares($app->psgi_app);
3329 =head2 $c->apply_default_middlewares
3331 Adds the following L<Plack> middlewares to your application, since they are
3332 useful and commonly needed:
3334 L<Plack::Middleware::LighttpdScriptNameFix> (if you are using Lighttpd),
3335 L<Plack::Middleware::IIS6ScriptNameFix> (always applied since this middleware
3336 is smart enough to conditionally apply itself).
3338 We will also automatically add L<Plack::Middleware::ReverseProxy> if we notice
3339 that your HTTP $env variable C<REMOTE_ADDR> is '127.0.0.1'. This is usually
3340 an indication that your server is running behind a proxy frontend. However in
3341 2014 this is often not the case. We preserve this code for backwards compatibility
3342 however I B<highly> recommend that if you are running the server behind a front
3343 end proxy that you clearly indicate so with the C<using_frontend_proxy> configuration
3344 setting to true for your environment configurations that run behind a proxy. This
3345 way if you change your front end proxy address someday your code would inexplicably
3346 stop working as expected.
3348 Additionally if we detect we are using Nginx, we add a bit of custom middleware
3349 to solve some problems with the way that server handles $ENV{PATH_INFO} and
3352 Please B<NOTE> that if you do use C<using_frontend_proxy> the middleware is now
3353 adding via C<registered_middleware> rather than this method.
3355 If you are using Lighttpd or IIS6 you may wish to apply these middlewares. In
3356 general this is no longer a common case but we have this here for backward
3362 sub apply_default_middlewares {
3363 my ($app, $psgi_app) = @_;
3365 # Don't add this conditional IF we are explicitly saying we want the
3366 # frontend proxy support. We don't need it here since if that is the
3367 # case it will be always loaded in the default_middleware.
3369 unless($app->config->{using_frontend_proxy}) {
3370 $psgi_app = Plack::Middleware::Conditional->wrap(
3372 builder => sub { Plack::Middleware::ReverseProxy->wrap($_[0]) },
3375 return if $app->config->{ignore_frontend_proxy};
3376 return $env->{REMOTE_ADDR} eq '127.0.0.1';
3381 # If we're running under Lighttpd, swap PATH_INFO and SCRIPT_NAME
3382 # http://lists.scsys.co.uk/pipermail/catalyst/2006-June/008361.html
3383 $psgi_app = Plack::Middleware::Conditional->wrap(
3385 builder => sub { Plack::Middleware::LighttpdScriptNameFix->wrap($_[0]) },
3388 return unless $env->{SERVER_SOFTWARE} && $env->{SERVER_SOFTWARE} =~ m!lighttpd[-/]1\.(\d+\.\d+)!;
3389 return unless $1 < 4.23;
3394 # we're applying this unconditionally as the middleware itself already makes
3395 # sure it doesn't fuck things up if it's not running under one of the right
3397 $psgi_app = Plack::Middleware::IIS6ScriptNameFix->wrap($psgi_app);
3399 # And another IIS issue, this time with IIS7.
3400 $psgi_app = Plack::Middleware::Conditional->wrap(
3402 builder => sub { Plack::Middleware::IIS7KeepAliveFix->wrap($_[0]) },
3405 return $env->{SERVER_SOFTWARE} && $env->{SERVER_SOFTWARE} =~ m!IIS/7\.[0-9]!;
3412 =head2 App->psgi_app
3416 Returns a PSGI application code reference for the catalyst application
3417 C<$c>. This is the bare application created without the C<apply_default_middlewares>
3418 method called. We do however apply C<registered_middleware> since those are
3419 integral to how L<Catalyst> functions. Also, unlike starting your application
3420 with a generated server script (via L<Catalyst::Devel> and C<catalyst.pl>) we do
3421 not attempt to return a valid L<PSGI> application using any existing C<${myapp}.psgi>
3422 scripts in your $HOME directory.
3424 B<NOTE> C<apply_default_middlewares> was originally created when the first PSGI
3425 port was done for v5.90000. These are middlewares that are added to achieve
3426 backward compatibility with older applications. If you start your application
3427 using one of the supplied server scripts (generated with L<Catalyst::Devel> and
3428 the project skeleton script C<catalyst.pl>) we apply C<apply_default_middlewares>
3429 automatically. This was done so that pre and post PSGI port applications would
3432 This is what you want to be using to retrieve the PSGI application code
3433 reference of your Catalyst application for use in a custom F<.psgi> or in your
3434 own created server modules.
3438 *to_app = \&psgi_app;
3442 my $psgi = $app->engine->build_psgi_app($app);
3443 return $app->Catalyst::Utils::apply_registered_middleware($psgi);
3446 =head2 $c->setup_home
3448 Sets up the home directory.
3453 my ( $class, $home ) = @_;
3455 if ( my $env = Catalyst::Utils::env_value( $class, 'HOME' ) ) {
3459 $home ||= Catalyst::Utils::home($class);
3462 #I remember recently being scolded for assigning config values like this
3463 $class->config->{home} ||= $home;
3464 $class->config->{root} ||= Path::Class::Dir->new($home)->subdir('root');
3468 =head2 $c->setup_encoding
3470 Sets up the input/output encoding. See L<ENCODING>
3474 sub setup_encoding {
3476 if( exists($c->config->{encoding}) && !defined($c->config->{encoding}) ) {
3477 # Ok, so the user has explicitly said "I don't want encoding..."
3480 my $enc = defined($c->config->{encoding}) ?
3481 delete $c->config->{encoding} : 'UTF-8'; # not sure why we delete it... (JNAP)
3486 =head2 handle_unicode_encoding_exception
3488 Hook to let you customize how encoding errors are handled. By default
3489 we just throw an exception. Receives a hashref of debug information.
3492 $c->handle_unicode_encoding_exception({
3493 param_value => $value,
3495 encoding_step => 'params',
3500 sub handle_unicode_encoding_exception {
3501 my ( $self, $exception_ctx ) = @_;
3502 die $exception_ctx->{error_msg};
3505 # Some unicode helpers cargo culted from the old plugin. These could likely
3508 sub _handle_unicode_decoding {
3509 my ( $self, $value ) = @_;
3511 return unless defined $value;
3513 ## I think this mess is to support the old nested
3514 if ( ref $value eq 'ARRAY' ) {
3515 foreach ( @$value ) {
3516 $_ = $self->_handle_unicode_decoding($_);
3520 elsif ( ref $value eq 'HASH' ) {
3521 foreach (keys %$value) {
3522 my $encoded_key = $self->_handle_param_unicode_decoding($_);
3523 $value->{$encoded_key} = $self->_handle_unicode_decoding($value->{$_});
3525 # If the key was encoded we now have two (the original and current so
3526 # delete the original.
3527 delete $value->{$_} if $_ ne $encoded_key;
3532 return $self->_handle_param_unicode_decoding($value);
3536 sub _handle_param_unicode_decoding {
3537 my ( $self, $value ) = @_;
3538 return unless defined $value; # not in love with just ignoring undefs - jnap
3539 return $value if blessed($value); #don't decode when the value is an object.
3541 my $enc = $self->encoding;
3543 $enc->decode( $value, $self->_encode_check );
3546 $self->handle_unicode_encoding_exception({
3547 param_value => $value,
3549 encoding_step => 'params',
3554 =head2 $c->setup_log
3556 Sets up log by instantiating a L<Catalyst::Log|Catalyst::Log> object and
3557 passing it to C<log()>. Pass in a comma-delimited list of levels to set the
3560 This method also installs a C<debug> method that returns a true value into the
3561 catalyst subclass if the "debug" level is passed in the comma-delimited list,
3562 or if the C<$CATALYST_DEBUG> environment variable is set to a true value.
3564 Note that if the log has already been setup, by either a previous call to
3565 C<setup_log> or by a call such as C<< __PACKAGE__->log( MyLogger->new ) >>,
3566 that this method won't actually set up the log object.
3571 my ( $class, $levels ) = @_;
3574 $levels =~ s/^\s+//;
3575 $levels =~ s/\s+$//;
3576 my %levels = map { $_ => 1 } split /\s*,\s*/, $levels;
3578 my $env_debug = Catalyst::Utils::env_value( $class, 'DEBUG' );
3579 if ( defined $env_debug ) {
3580 $levels{debug} = 1 if $env_debug; # Ugly!
3581 delete($levels{debug}) unless $env_debug;
3584 unless ( $class->log ) {
3585 $class->log( Catalyst::Log->new(keys %levels) );
3588 if ( $levels{debug} ) {
3589 Class::MOP::get_metaclass_by_name($class)->add_method('debug' => sub { 1 });
3590 $class->log->debug('Debug messages enabled');
3594 =head2 $c->setup_plugins
3600 =head2 $c->setup_stats
3602 Sets up timing statistics class.
3607 my ( $class, $stats ) = @_;
3609 Catalyst::Utils::ensure_class_loaded($class->stats_class);
3611 my $env = Catalyst::Utils::env_value( $class, 'STATS' );
3612 if ( defined($env) ? $env : ($stats || $class->debug ) ) {
3613 Class::MOP::get_metaclass_by_name($class)->add_method('use_stats' => sub { 1 });
3614 $class->log->debug('Statistics enabled');
3619 =head2 $c->registered_plugins
3621 Returns a sorted list of the plugins which have either been stated in the
3624 If passed a given plugin name, it will report a boolean value indicating
3625 whether or not that plugin is loaded. A fully qualified name is required if
3626 the plugin name does not begin with C<Catalyst::Plugin::>.
3628 if ($c->registered_plugins('Some::Plugin')) {
3636 sub registered_plugins {
3638 return sort keys %{ $proto->_plugins } unless @_;
3640 return 1 if exists $proto->_plugins->{$plugin};
3641 return exists $proto->_plugins->{"Catalyst::Plugin::$plugin"};
3644 sub _register_plugin {
3645 my ( $proto, $plugin, $instant ) = @_;
3646 my $class = ref $proto || $proto;
3648 load_class( $plugin );
3649 $class->log->warn( "$plugin inherits from 'Catalyst::Component' - this is deprecated and will not work in 5.81" )
3650 if $plugin->isa( 'Catalyst::Component' );
3651 my $plugin_meta = Moose::Meta::Class->create($plugin);
3652 if (!$plugin_meta->has_method('new')
3653 && ( $plugin->isa('Class::Accessor::Fast') || $plugin->isa('Class::Accessor') ) ) {
3654 $plugin_meta->add_method('new', Moose::Object->meta->get_method('new'))
3656 if (!$instant && !$proto->_plugins->{$plugin}) {
3657 my $meta = Class::MOP::get_metaclass_by_name($class);
3658 $meta->superclasses($plugin, $meta->superclasses);
3660 $proto->_plugins->{$plugin} = 1;
3664 sub _default_plugins { return qw() }
3667 my ( $class, $plugins ) = @_;
3669 $class->_plugins( {} ) unless $class->_plugins;
3671 m/Unicode::Encoding/ ? do {
3673 'Unicode::Encoding plugin is auto-applied,'
3674 . ' please remove this from your appclass'
3675 . ' and make sure to define "encoding" config'
3677 unless (exists $class->config->{'encoding'}) {
3678 $class->config->{'encoding'} = 'UTF-8';
3683 push @$plugins, $class->_default_plugins;
3684 $plugins = Data::OptList::mkopt($plugins || []);
3687 [ Catalyst::Utils::resolve_namespace(
3688 $class . '::Plugin',
3689 'Catalyst::Plugin', $_->[0]
3695 for my $plugin ( reverse @plugins ) {
3696 load_class($plugin->[0], $plugin->[1]);
3697 my $meta = find_meta($plugin->[0]);
3698 next if $meta && $meta->isa('Moose::Meta::Role');
3700 $class->_register_plugin($plugin->[0]);
3704 map { $_->[0]->name, $_->[1] }
3705 grep { blessed($_->[0]) && $_->[0]->isa('Moose::Meta::Role') }
3706 map { [find_meta($_->[0]), $_->[1]] }
3709 Moose::Util::apply_all_roles(
3715 =head2 default_middleware
3717 Returns a list of instantiated PSGI middleware objects which is the default
3718 middleware that is active for this application (taking any configuration
3719 options into account, excluding your custom added middleware via the C<psgi_middleware>
3720 configuration option). You can override this method if you wish to change
3721 the default middleware (although do so at risk since some middleware is vital
3722 to application function.)
3724 The current default middleware list is:
3726 Catalyst::Middleware::Stash
3727 Plack::Middleware::HTTPExceptions
3728 Plack::Middleware::RemoveRedundantBody
3729 Plack::Middleware::FixMissingBodyInRedirect
3730 Plack::Middleware::ContentLength
3731 Plack::Middleware::MethodOverride
3732 Plack::Middleware::Head
3734 If the configuration setting C<using_frontend_proxy> is true we add:
3736 Plack::Middleware::ReverseProxy
3738 If the configuration setting C<using_frontend_proxy_path> is true we add:
3740 Plack::Middleware::ReverseProxyPath
3742 But B<NOTE> that L<Plack::Middleware::ReverseProxyPath> is not a dependency of the
3743 L<Catalyst> distribution so if you want to use this option you should add it to
3744 your project distribution file.
3746 These middlewares will be added at L</setup_middleware> during the
3747 L</setup> phase of application startup.
3751 sub default_middleware {
3754 Catalyst::Middleware::Stash->new,
3755 Plack::Middleware::HTTPExceptions->new,
3756 Plack::Middleware::RemoveRedundantBody->new,
3757 Plack::Middleware::FixMissingBodyInRedirect->new,
3758 Plack::Middleware::ContentLength->new,
3759 Plack::Middleware::MethodOverride->new,
3760 Plack::Middleware::Head->new);
3762 if($class->config->{using_frontend_proxy}) {
3763 push @mw, Plack::Middleware::ReverseProxy->new;
3766 if($class->config->{using_frontend_proxy_path}) {
3767 if(Class::Load::try_load_class('Plack::Middleware::ReverseProxyPath')) {
3768 push @mw, Plack::Middleware::ReverseProxyPath->new;
3770 $class->log->error("Cannot use configuration 'using_frontend_proxy_path' because 'Plack::Middleware::ReverseProxyPath' is not installed");
3777 =head2 registered_middlewares
3779 Read only accessor that returns an array of all the middleware in the order
3780 that they were added (which is the REVERSE of the order they will be applied).
3782 The values returned will be either instances of L<Plack::Middleware> or of a
3783 compatible interface, or a coderef, which is assumed to be inlined middleware
3785 =head2 setup_middleware (?@middleware)
3787 Read configuration information stored in configuration key C<psgi_middleware> or
3790 See under L</CONFIGURATION> information regarding C<psgi_middleware> and how
3791 to use it to enable L<Plack::Middleware>
3793 This method is automatically called during 'setup' of your application, so
3794 you really don't need to invoke it. However you may do so if you find the idea
3795 of loading middleware via configuration weird :). For example:
3801 __PACKAGE__->setup_middleware('Head');
3804 When we read middleware definitions from configuration, we reverse the list
3805 which sounds odd but is likely how you expect it to work if you have prior
3806 experience with L<Plack::Builder> or if you previously used the plugin
3807 L<Catalyst::Plugin::EnableMiddleware> (which is now considered deprecated)
3809 So basically your middleware handles an incoming request from the first
3810 registered middleware, down and handles the response from the last middleware
3815 sub registered_middlewares {
3817 if(my $middleware = $class->_psgi_middleware) {
3818 my @mw = ($class->default_middleware, @$middleware);
3820 if($class->config->{using_frontend_proxy}) {
3821 push @mw, Plack::Middleware::ReverseProxy->new;
3826 die "You cannot call ->registered_middlewares until middleware has been setup";
3830 sub setup_middleware {
3832 my @middleware_definitions;
3834 # If someone calls this method you can add middleware with args. However if its
3835 # called without an arg we need to setup the configuration middleware.
3837 @middleware_definitions = reverse(@_);
3839 @middleware_definitions = reverse(@{$class->config->{'psgi_middleware'}||[]})
3840 unless $class->finalized_default_middleware;
3841 $class->finalized_default_middleware(1); # Only do this once, just in case some people call setup over and over...
3844 my @middleware = ();
3845 while(my $next = shift(@middleware_definitions)) {
3847 if(Scalar::Util::blessed $next && $next->can('wrap')) {
3848 push @middleware, $next;
3849 } elsif(ref $next eq 'CODE') {
3850 push @middleware, $next;
3851 } elsif(ref $next eq 'HASH') {
3852 my $namespace = shift @middleware_definitions;
3853 my $mw = $class->Catalyst::Utils::build_middleware($namespace, %$next);
3854 push @middleware, $mw;
3856 die "I can't handle middleware definition ${\ref $next}";
3859 my $mw = $class->Catalyst::Utils::build_middleware($next);
3860 push @middleware, $mw;
3864 my @existing = @{$class->_psgi_middleware || []};
3865 $class->_psgi_middleware([@middleware,@existing,]);
3868 =head2 registered_data_handlers
3870 A read only copy of registered Data Handlers returned as a Hash, where each key
3871 is a content type and each value is a subref that attempts to decode that content
3874 =head2 setup_data_handlers (?@data_handler)
3876 Read configuration information stored in configuration key C<data_handlers> or
3879 See under L</CONFIGURATION> information regarding C<data_handlers>.
3881 This method is automatically called during 'setup' of your application, so
3882 you really don't need to invoke it.
3884 =head2 default_data_handlers
3886 Default Data Handlers that come bundled with L<Catalyst>. Currently there are
3887 only two default data handlers, for 'application/json' and an alternative to
3888 'application/x-www-form-urlencoded' which supposed nested form parameters via
3889 L<CGI::Struct> or via L<CGI::Struct::XS> IF you've installed it.
3891 The 'application/json' data handler is used to parse incoming JSON into a Perl
3892 data structure. It used either L<JSON::MaybeXS> or L<JSON>, depending on which
3893 is installed. This allows you to fail back to L<JSON:PP>, which is a Pure Perl
3894 JSON decoder, and has the smallest dependency impact.
3896 Because we don't wish to add more dependencies to L<Catalyst>, if you wish to
3897 use this new feature we recommend installing L<JSON> or L<JSON::MaybeXS> in
3898 order to get the best performance. You should add either to your dependency
3899 list (Makefile.PL, dist.ini, cpanfile, etc.)
3903 sub registered_data_handlers {
3905 if(my $data_handlers = $class->_data_handlers) {
3906 return %$data_handlers;
3908 $class->setup_data_handlers;
3909 return $class->registered_data_handlers;
3913 sub setup_data_handlers {
3914 my ($class, %data_handler_callbacks) = @_;
3915 %data_handler_callbacks = (
3916 %{$class->default_data_handlers},
3917 %{$class->config->{'data_handlers'}||+{}},
3918 %data_handler_callbacks);
3920 $class->_data_handlers(\%data_handler_callbacks);
3923 sub default_data_handlers {
3926 'application/x-www-form-urlencoded' => sub {
3927 my ($fh, $req) = @_;
3928 my $params = $req->_use_hash_multivalue ? $req->body_parameters->mixed : $req->body_parameters;
3929 Class::Load::load_first_existing_class('CGI::Struct::XS', 'CGI::Struct')
3930 ->can('build_cgi_struct')->($params);
3932 'application/json' => sub {
3933 my ($fh, $req) = @_;
3934 my $parser = Class::Load::load_first_existing_class('JSON::MaybeXS', 'JSON');
3938 $slurped = $fh->getline;
3939 $parser->can("decode_json")->($slurped); # decode_json does utf8 decoding for us
3940 } || Catalyst::Exception->throw(sprintf "Error Parsing POST '%s', Error: %s", (defined($slurped) ? $slurped : 'undef') ,$@);
3945 sub _handle_http_exception {
3946 my ( $self, $error ) = @_;
3948 !$self->config->{always_catch_http_exceptions}
3951 $error->can('as_psgi')
3952 || ( $error->can('code')
3953 && $error->code =~ m/^[1-5][0-9][0-9]$/ )
3963 Returns an arrayref of the internal execution stack (actions that are
3964 currently executing).
3968 Returns the current timing statistics object. By default Catalyst uses
3969 L<Catalyst::Stats|Catalyst::Stats>, but can be set otherwise with
3970 L<< stats_class|/"$c->stats_class" >>.
3972 Even if L<< -Stats|/"-Stats" >> is not enabled, the stats object is still
3973 available. By enabling it with C< $c->stats->enabled(1) >, it can be used to
3974 profile explicitly, although MyApp.pm still won't profile nor output anything
3977 =head2 $c->stats_class
3979 Returns or sets the stats (timing statistics) class. L<Catalyst::Stats|Catalyst::Stats> is used by default.
3981 =head2 $app->stats_class_traits
3983 A arrayref of L<Moose::Role>s that are applied to the stats_class before creating it.
3985 =head2 $app->composed_stats_class
3987 this is the stats_class composed with any 'stats_class_traits'. You can
3988 name the full namespace of the role, or a namespace suffix, which will then
3989 be tried against the following standard namespace prefixes.
3991 $MyApp::TraitFor::Stats::$trait_suffix
3992 Catalyst::TraitFor::Stats::$trait_suffix
3994 So for example if you set:
3996 MyApp->stats_class_traits(['Foo']);
3998 We try each possible role in turn (and throw an error if none load)
4001 MyApp::TraitFor::Stats::Foo
4002 Catalyst::TraitFor::Stats::Foo
4004 The namespace part 'TraitFor::Stats' was choosen to assist in backwards
4005 compatibility with L<CatalystX::RoleApplicator> which previously provided
4006 these features in a stand alone package.
4008 =head2 $c->use_stats
4010 Returns 1 when L<< stats collection|/"-Stats" >> is enabled.
4012 Note that this is a static method, not an accessor and should be overridden
4013 by declaring C<sub use_stats { 1 }> in your MyApp.pm, not by calling C<< $c->use_stats(1) >>.
4020 =head2 $c->write( $data )
4022 Writes $data to the output stream. When using this method directly, you
4023 will need to manually set the C<Content-Length> header to the length of
4024 your output data, if known.
4031 # Finalize headers if someone manually writes output (for compat)
4032 $c->finalize_headers;
4034 return $c->response->write( @_ );
4039 Returns the Catalyst version number. Mostly useful for "powered by"
4040 messages in template systems.
4044 sub version { return $Catalyst::VERSION }
4046 =head1 CONFIGURATION
4048 There are a number of 'base' config variables which can be set:
4054 C<always_catch_http_exceptions> - As of version 5.90060 Catalyst
4055 rethrows errors conforming to the interface described by
4056 L<Plack::Middleware::HTTPExceptions> and lets the middleware deal with it.
4057 Set true to get the deprecated behaviour and have Catalyst catch HTTP exceptions.
4061 C<default_model> - The default model picked if you say C<< $c->model >>. See L<< /$c->model($name) >>.
4065 C<default_view> - The default view to be rendered or returned when C<< $c->view >> is called. See L<< /$c->view($name) >>.
4069 C<disable_component_resolution_regex_fallback> - Turns
4070 off the deprecated component resolution functionality so
4071 that if any of the component methods (e.g. C<< $c->controller('Foo') >>)
4072 are called then regex search will not be attempted on string values and
4073 instead C<undef> will be returned.
4077 C<home> - The application home directory. In an uninstalled application,
4078 this is the top level application directory. In an installed application,
4079 this will be the directory containing C<< MyApp.pm >>.
4083 C<ignore_frontend_proxy> - See L</PROXY SUPPORT>
4087 C<name> - The name of the application in debug messages and the debug and
4092 C<parse_on_demand> - The request body (for example file uploads) will not be parsed
4093 until it is accessed. This allows you to (for example) check authentication (and reject
4094 the upload) before actually receiving all the data. See L</ON-DEMAND PARSER>
4098 C<root> - The root directory for templates. Usually this is just a
4099 subdirectory of the home directory, but you can set it to change the
4100 templates to a different directory.
4104 C<search_extra> - Array reference passed to Module::Pluggable to for additional
4105 namespaces from which components will be loaded (and constructed and stored in
4106 C<< $c->components >>).
4110 C<show_internal_actions> - If true, causes internal actions such as C<< _DISPATCH >>
4111 to be shown in hit debug tables in the test server.
4115 C<use_request_uri_for_path> - Controls if the C<REQUEST_URI> or C<PATH_INFO> environment
4116 variable should be used for determining the request path.
4118 Most web server environments pass the requested path to the application using environment variables,
4119 from which Catalyst has to reconstruct the request base (i.e. the top level path to / in the application,
4120 exposed as C<< $c->request->base >>) and the request path below that base.
4122 There are two methods of doing this, both of which have advantages and disadvantages. Which method is used
4123 is determined by the C<< $c->config(use_request_uri_for_path) >> setting (which can either be true or false).
4127 =item use_request_uri_for_path => 0
4129 This is the default (and the) traditional method that Catalyst has used for determining the path information.
4130 The path is generated from a combination of the C<PATH_INFO> and C<SCRIPT_NAME> environment variables.
4131 The allows the application to behave correctly when C<mod_rewrite> is being used to redirect requests
4132 into the application, as these variables are adjusted by mod_rewrite to take account for the redirect.
4134 However this method has the major disadvantage that it is impossible to correctly decode some elements
4135 of the path, as RFC 3875 says: "C<< Unlike a URI path, the PATH_INFO is not URL-encoded, and cannot
4136 contain path-segment parameters. >>" This means PATH_INFO is B<always> decoded, and therefore Catalyst
4137 can't distinguish / vs %2F in paths (in addition to other encoded values).
4139 =item use_request_uri_for_path => 1
4141 This method uses the C<REQUEST_URI> and C<SCRIPT_NAME> environment variables. As C<REQUEST_URI> is never
4142 decoded, this means that applications using this mode can correctly handle URIs including the %2F character
4143 (i.e. with C<AllowEncodedSlashes> set to C<On> in Apache).
4145 Given that this method of path resolution is provably more correct, it is recommended that you use
4146 this unless you have a specific need to deploy your application in a non-standard environment, and you are
4147 aware of the implications of not being able to handle encoded URI paths correctly.
4149 However it also means that in a number of cases when the app isn't installed directly at a path, but instead
4150 is having paths rewritten into it (e.g. as a .cgi/fcgi in a public_html directory, with mod_rewrite in a
4151 .htaccess file, or when SSI is used to rewrite pages into the app, or when sub-paths of the app are exposed
4152 at other URIs than that which the app is 'normally' based at with C<mod_rewrite>), the resolution of
4153 C<< $c->request->base >> will be incorrect.
4159 C<using_frontend_proxy> - See L</PROXY SUPPORT>.
4163 C<using_frontend_proxy_path> - Enabled L<Plack::Middleware::ReverseProxyPath> on your application (if
4164 installed, otherwise log an error). This is useful if your application is not running on the
4165 'root' (or /) of your host server. B<NOTE> if you use this feature you should add the required
4166 middleware to your project dependency list since its not automatically a dependency of L<Catalyst>.
4167 This has been done since not all people need this feature and we wish to restrict the growth of
4168 L<Catalyst> dependencies.
4172 C<encoding> - See L</ENCODING>
4174 This now defaults to 'UTF-8'. You my turn it off by setting this configuration
4179 C<abort_chain_on_error_fix>
4181 When there is an error in an action chain, the default behavior is to continue
4182 processing the remaining actions and then catch the error upon chain end. This
4183 can lead to running actions when the application is in an unexpected state. If
4184 you have this issue, setting this config value to true will promptly exit a
4185 chain when there is an error raised in any action (thus terminating the chain
4190 __PACKAGE__->config(abort_chain_on_error_fix => 1);
4192 In the future this might become the default behavior.
4196 C<use_hash_multivalue_in_request>
4198 In L<Catalyst::Request> the methods C<query_parameters>, C<body_parametes>
4199 and C<parameters> return a hashref where values might be scalar or an arrayref
4200 depending on the incoming data. In many cases this can be undesirable as it
4201 leads one to writing defensive code like the following:
4203 my ($val) = ref($c->req->parameters->{a}) ?
4204 @{$c->req->parameters->{a}} :
4205 $c->req->parameters->{a};
4207 Setting this configuration item to true will make L<Catalyst> populate the
4208 attributes underlying these methods with an instance of L<Hash::MultiValue>
4209 which is used by L<Plack::Request> and others to solve this very issue. You
4210 may prefer this behavior to the default, if so enable this option (be warned
4211 if you enable it in a legacy application we are not sure if it is completely
4212 backwardly compatible).
4216 C<skip_complex_post_part_handling>
4218 When creating body parameters from a POST, if we run into a multpart POST
4219 that does not contain uploads, but instead contains inlined complex data
4220 (very uncommon) we cannot reliably convert that into field => value pairs. So
4221 instead we create an instance of L<Catalyst::Request::PartData>. If this causes
4222 issue for you, you can disable this by setting C<skip_complex_post_part_handling>
4223 to true (default is false).
4227 C<skip_body_param_unicode_decoding>
4229 Generally we decode incoming POST params based on your declared encoding (the
4230 default for this is to decode UTF-8). If this is causing you trouble and you
4231 do not wish to turn all encoding support off (with the C<encoding> configuration
4232 parameter) you may disable this step atomically by setting this configuration
4237 C<do_not_decode_query>
4239 If true, then do not try to character decode any wide characters in your
4240 request URL query or keywords. Most readings of the relevent specifications
4241 suggest these should be UTF-* encoded, which is the default that L<Catalyst>
4242 will use, hwoever if you are creating a lot of URLs manually or have external
4243 evil clients, this might cause you trouble. If you find the changes introduced
4244 in Catalyst version 5.90080+ break some of your query code, you may disable
4245 the UTF-8 decoding globally using this configuration.
4247 This setting takes precedence over C<default_query_encoding> and
4248 C<decode_query_using_global_encoding>
4252 C<default_query_encoding>
4254 By default we decode query and keywords in your request URL using UTF-8, which
4255 is our reading of the relevent specifications. This setting allows one to
4256 specify a fixed value for how to decode your query. You might need this if
4257 you are doing a lot of custom encoding of your URLs and not using UTF-8.
4259 This setting take precedence over C<decode_query_using_global_encoding>.
4263 C<decode_query_using_global_encoding>
4265 Setting this to true will default your query decoding to whatever your
4266 general global encoding is (the default is UTF-8).
4270 C<use_chained_args_0_special_case>
4272 In older versions of Catalyst, when more than one action matched the same path
4273 AND all those matching actions declared Args(0), we'd break the tie by choosing
4274 the first action defined. We now normalized how Args(0) works so that it
4275 follows the same rule as Args(N), which is to say when we need to break a tie
4276 we choose the LAST action defined. If this breaks your code and you don't
4277 have time to update to follow the new normalized approach, you may set this
4278 value to true and it will globally revert to the original chaining behavior.
4282 C<psgi_middleware> - See L<PSGI MIDDLEWARE>.
4286 C<data_handlers> - See L<DATA HANDLERS>.
4290 C<stats_class_traits>
4292 An arrayref of L<Moose::Role>s that get componsed into your stats class.
4296 C<request_class_traits>
4298 An arrayref of L<Moose::Role>s that get componsed into your request class.
4302 C<response_class_traits>
4304 An arrayref of L<Moose::Role>s that get componsed into your response class.
4308 C<inject_components>
4310 A Hashref of L<Catalyst::Component> subclasses that are 'injected' into configuration.
4314 inject_components => {
4315 'Controller::Err' => { from_component => 'Local::Controller::Errors' },
4316 'Model::Zoo' => { from_component => 'Local::Model::Foo' },
4317 'Model::Foo' => { from_component => 'Local::Model::Foo', roles => ['TestRole'] },
4319 'Controller::Err' => { a => 100, b=>200, namespace=>'error' },
4320 'Model::Zoo' => { a => 2 },
4321 'Model::Foo' => { a => 100 },
4324 Generally L<Catalyst> looks for components in your Model/View or Controller directories.
4325 However for cases when you which to use an existing component and you don't need any
4326 customization (where for when you can apply a role to customize it) you may inject those
4327 components into your application. Please note any configuration should be done 'in the
4328 normal way', with a key under configuration named after the component affix, as in the
4331 Using this type of injection allows you to construct significant amounts of your application
4332 with only configuration!. This may or may not lead to increased code understanding.
4334 Please not you may also call the ->inject_components application method as well, although
4335 you must do so BEFORE setup.
4341 Generally when you throw an exception inside an Action (or somewhere in
4342 your stack, such as in a model that an Action is calling) that exception
4343 is caught by Catalyst and unless you either catch it yourself (via eval
4344 or something like L<Try::Tiny> or by reviewing the L</error> stack, it
4345 will eventually reach L</finalize_errors> and return either the debugging
4346 error stack page, or the default error page. However, if your exception
4347 can be caught by L<Plack::Middleware::HTTPExceptions>, L<Catalyst> will
4348 instead rethrow it so that it can be handled by that middleware (which
4349 is part of the default middleware). For example this would allow
4351 use HTTP::Throwable::Factory 'http_throw';
4353 sub throws_exception :Local {
4354 my ($self, $c) = @_;
4356 http_throw(SeeOther => { location =>
4357 $c->uri_for($self->action_for('redirect')) });
4361 =head1 INTERNAL ACTIONS
4363 Catalyst uses internal actions like C<_DISPATCH>, C<_BEGIN>, C<_AUTO>,
4364 C<_ACTION>, and C<_END>. These are by default not shown in the private
4365 action table, but you can make them visible with a config parameter.
4367 MyApp->config(show_internal_actions => 1);
4369 =head1 ON-DEMAND PARSER
4371 The request body is usually parsed at the beginning of a request,
4372 but if you want to handle input yourself, you can enable on-demand
4373 parsing with a config parameter.
4375 MyApp->config(parse_on_demand => 1);
4377 =head1 PROXY SUPPORT
4379 Many production servers operate using the common double-server approach,
4380 with a lightweight frontend web server passing requests to a larger
4381 backend server. An application running on the backend server must deal
4382 with two problems: the remote user always appears to be C<127.0.0.1> and
4383 the server's hostname will appear to be C<localhost> regardless of the
4384 virtual host that the user connected through.
4386 Catalyst will automatically detect this situation when you are running
4387 the frontend and backend servers on the same machine. The following
4388 changes are made to the request.
4390 $c->req->address is set to the user's real IP address, as read from
4391 the HTTP X-Forwarded-For header.
4393 The host value for $c->req->base and $c->req->uri is set to the real
4394 host, as read from the HTTP X-Forwarded-Host header.
4396 Additionally, you may be running your backend application on an insecure
4397 connection (port 80) while your frontend proxy is running under SSL. If there
4398 is a discrepancy in the ports, use the HTTP header C<X-Forwarded-Port> to
4399 tell Catalyst what port the frontend listens on. This will allow all URIs to
4400 be created properly.
4402 In the case of passing in:
4404 X-Forwarded-Port: 443
4406 All calls to C<uri_for> will result in an https link, as is expected.
4408 Obviously, your web server must support these headers for this to work.
4410 In a more complex server farm environment where you may have your
4411 frontend proxy server(s) on different machines, you will need to set a
4412 configuration option to tell Catalyst to read the proxied data from the
4415 MyApp->config(using_frontend_proxy => 1);
4417 If you do not wish to use the proxy support at all, you may set:
4419 MyApp->config(ignore_frontend_proxy => 0);
4421 =head2 Note about psgi files
4423 Note that if you supply your own .psgi file, calling
4424 C<< MyApp->psgi_app(@_); >>, then B<this will not happen automatically>.
4426 You either need to apply L<Plack::Middleware::ReverseProxy> yourself
4427 in your psgi, for example:
4430 enable "Plack::Middleware::ReverseProxy";
4434 This will unconditionally add the ReverseProxy support, or you need to call
4435 C<< $app = MyApp->apply_default_middlewares($app) >> (to conditionally
4436 apply the support depending upon your config).
4438 See L<Catalyst::PSGI> for more information.
4440 =head1 THREAD SAFETY
4442 Catalyst has been tested under Apache 2's threading C<mpm_worker>,
4443 C<mpm_winnt>, and the standalone forking HTTP server on Windows. We
4444 believe the Catalyst core to be thread-safe.
4446 If you plan to operate in a threaded environment, remember that all other
4447 modules you are using must also be thread-safe. Some modules, most notably
4448 L<DBD::SQLite>, are not thread-safe.
4450 =head1 DATA HANDLERS
4452 The L<Catalyst::Request> object uses L<HTTP::Body> to populate 'classic' HTML
4453 form parameters and URL search query fields. However it has become common
4454 for various alternative content types to be PUT or POSTed to your controllers
4455 and actions. People working on RESTful APIs, or using AJAX often use JSON,
4456 XML and other content types when communicating with an application server. In
4457 order to better support this use case, L<Catalyst> defines a global configuration
4458 option, C<data_handlers>, which lets you associate a content type with a coderef
4459 that parses that content type into something Perl can readily access.
4466 __PACKAGE__->config(
4468 'application/json' => sub { local $/; decode_json $_->getline },
4470 ## Any other configuration.
4475 By default L<Catalyst> comes with a generic JSON data handler similar to the
4476 example given above, which uses L<JSON::Maybe> to provide either L<JSON::PP>
4477 (a pure Perl, dependency free JSON parser) or L<Cpanel::JSON::XS> if you have
4478 it installed (if you want the faster XS parser, add it to you project Makefile.PL
4479 or dist.ini, cpanfile, etc.)
4481 The C<data_handlers> configuration is a hashref whose keys are HTTP Content-Types
4482 (matched against the incoming request type using a regexp such as to be case
4483 insensitive) and whose values are coderefs that receive a localized version of
4484 C<$_> which is a filehandle object pointing to received body.
4486 This feature is considered an early access release and we reserve the right
4487 to alter the interface in order to provide a performant and secure solution to
4488 alternative request body content. Your reports welcomed!
4490 =head1 PSGI MIDDLEWARE
4492 You can define middleware, defined as L<Plack::Middleware> or a compatible
4493 interface in configuration. Your middleware definitions are in the form of an
4494 arrayref under the configuration key C<psgi_middleware>. Here's an example
4495 with details to follow:
4500 use Plack::Middleware::StackTrace;
4502 my $stacktrace_middleware = Plack::Middleware::StackTrace->new;
4504 __PACKAGE__->config(
4505 'psgi_middleware', [
4508 $stacktrace_middleware,
4509 'Session' => {store => 'File'},
4514 $env->{myapp.customkey} = 'helloworld';
4523 So the general form is:
4525 __PACKAGE__->config(psgi_middleware => \@middleware_definitions);
4527 Where C<@middleware> is one or more of the following, applied in the REVERSE of
4528 the order listed (to make it function similarly to L<Plack::Builder>:
4530 Alternatively, you may also define middleware by calling the L</setup_middleware>
4537 __PACKAGE__->setup_middleware( \@middleware_definitions);
4540 In the case where you do both (use 'setup_middleware' and configuration) the
4541 package call to setup_middleware will be applied earlier (in other words its
4542 middleware will wrap closer to the application). Keep this in mind since in
4543 some cases the order of middleware is important.
4545 The two approaches are not exclusive.
4549 =item Middleware Object
4551 An already initialized object that conforms to the L<Plack::Middleware>
4554 my $stacktrace_middleware = Plack::Middleware::StackTrace->new;
4556 __PACKAGE__->config(
4557 'psgi_middleware', [
4558 $stacktrace_middleware,
4564 A coderef that is an inlined middleware:
4566 __PACKAGE__->config(
4567 'psgi_middleware', [
4572 if($env->{PATH_INFO} =~m/forced/) {
4574 ->new(file=>TestApp->path_to(qw/share static forced.txt/))
4577 return $app->($env);
4587 We assume the scalar refers to a namespace after normalizing it using the
4590 (1) If the scalar is prefixed with a "+" (as in C<+MyApp::Foo>) then the full string
4591 is assumed to be 'as is', and we just install and use the middleware.
4593 (2) If the scalar begins with "Plack::Middleware" or your application namespace
4594 (the package name of your Catalyst application subclass), we also assume then
4595 that it is a full namespace, and use it.
4597 (3) Lastly, we then assume that the scalar is a partial namespace, and attempt to
4598 resolve it first by looking for it under your application namespace (for example
4599 if you application is "MyApp::Web" and the scalar is "MyMiddleware", we'd look
4600 under "MyApp::Web::Middleware::MyMiddleware") and if we don't find it there, we
4601 will then look under the regular L<Plack::Middleware> namespace (i.e. for the
4602 previous we'd try "Plack::Middleware::MyMiddleware"). We look under your application
4603 namespace first to let you 'override' common L<Plack::Middleware> locally, should
4604 you find that a good idea.
4610 __PACKAGE__->config(
4611 'psgi_middleware', [
4612 'Debug', ## MyAppWeb::Middleware::Debug->wrap or Plack::Middleware::Debug->wrap
4613 'Plack::Middleware::Stacktrace', ## Plack::Middleware::Stacktrace->wrap
4614 '+MyApp::Custom', ## MyApp::Custom->wrap
4618 =item a scalar followed by a hashref
4620 Just like the previous, except the following C<HashRef> is used as arguments
4621 to initialize the middleware object.
4623 __PACKAGE__->config(
4624 'psgi_middleware', [
4625 'Session' => {store => 'File'},
4630 Please see L<PSGI> for more on middleware.
4634 Starting in L<Catalyst> version 5.90080 encoding is automatically enabled
4635 and set to encode all body responses to UTF8 when possible and applicable.
4636 Following is documentation on this process. If you are using an older
4637 version of L<Catalyst> you should review documentation for that version since
4640 By default encoding is now 'UTF-8'. You may turn it off by setting
4641 the encoding configuration to undef.
4643 MyApp->config(encoding => undef);
4645 This is recommended for temporary backwards compatibility only.
4647 Encoding is automatically applied when the content-type is set to
4648 a type that can be encoded. Currently we encode when the content type
4649 matches the following regular expression:
4651 $content_type =~ /^text|xml$|javascript$/
4653 Encoding is set on the application, but it is copied to the context object
4654 so that you can override it on a request basis.
4656 Be default we don't automatically encode 'application/json' since the most
4657 common approaches to generating this type of response (Either via L<Catalyst::View::JSON>
4658 or L<Catalyst::Action::REST>) will do so already and we want to avoid double
4661 If you are producing JSON response in an unconventional manner (such
4662 as via a template or manual strings) you should perform the UTF8 encoding
4663 manually as well such as to conform to the JSON specification.
4665 NOTE: We also examine the value of $c->response->content_encoding. If
4666 you set this (like for example 'gzip', and manually gzipping the body)
4667 we assume that you have done all the necessary encoding yourself, since
4668 we cannot encode the gzipped contents. If you use a plugin like
4669 L<Catalyst::Plugin::Compress> you need to update to a modern version in order
4670 to have this function correctly with the new UTF8 encoding code, or you
4671 can use L<Plack::Middleware::Deflater> or (probably best) do your compression on
4680 Returns an instance of an C<Encode> encoding
4682 print $c->encoding->name
4684 =item handle_unicode_encoding_exception ($exception_context)
4686 Method called when decoding process for a request fails.
4688 An C<$exception_context> hashref is provided to allow you to override the
4689 behaviour of your application when given data with incorrect encodings.
4691 The default method throws exceptions in the case of invalid request parameters
4692 (resulting in a 500 error), but ignores errors in upload filenames.
4694 The keys passed in the C<$exception_context> hash are:
4700 The value which was not able to be decoded.
4704 The exception received from L<Encode>.
4708 What type of data was being decoded. Valid values are (currently)
4709 C<params> - for request parameters / arguments / captures
4710 and C<uploads> - for request upload filenames.
4720 Join #catalyst on irc.perl.org.
4724 http://lists.scsys.co.uk/cgi-bin/mailman/listinfo/catalyst
4725 http://lists.scsys.co.uk/cgi-bin/mailman/listinfo/catalyst-dev
4729 http://catalyst.perl.org
4733 http://dev.catalyst.perl.org
4737 =head2 L<Task::Catalyst> - All you need to start with Catalyst
4739 =head2 L<Catalyst::Manual> - The Catalyst Manual
4741 =head2 L<Catalyst::Component>, L<Catalyst::Controller> - Base classes for components
4743 =head2 L<Catalyst::Engine> - Core engine
4745 =head2 L<Catalyst::Log> - Log class.
4747 =head2 L<Catalyst::Request> - Request object
4749 =head2 L<Catalyst::Response> - Response object
4751 =head2 L<Catalyst::Test> - The test suite.
4753 =head1 PROJECT FOUNDER
4755 sri: Sebastian Riedel <sri@cpan.org>
4761 acme: Leon Brocard <leon@astray.com>
4763 abraxxa: Alexander Hartmaier <abraxxa@cpan.org>
4765 andrewalker: André Walker <andre@cpan.org>
4769 Andrew Ford E<lt>A.Ford@ford-mason.co.ukE<gt>
4773 andyg: Andy Grundman <andy@hybridized.org>
4775 audreyt: Audrey Tang
4777 bricas: Brian Cassidy <bricas@cpan.org>
4779 Caelum: Rafael Kitover <rkitover@io.com>
4781 chansen: Christian Hansen
4783 chicks: Christopher Hicks
4785 Chisel Wright C<pause@herlpacker.co.uk>
4787 Danijel Milicevic C<me@danijel.de>
4789 davewood: David Schmidt <davewood@cpan.org>
4791 David Kamholz E<lt>dkamholz@cpan.orgE<gt>
4793 David Naughton, C<naughton@umn.edu>
4797 dhoss: Devin Austin <dhoss@cpan.org>
4799 dkubb: Dan Kubb <dan.kubb-cpan@onautopilot.com>
4803 dwc: Daniel Westermann-Clark <danieltwc@cpan.org>
4805 esskar: Sascha Kiefer
4807 fireartist: Carl Franks <cfranks@cpan.org>
4809 frew: Arthur Axel "fREW" Schmidt <frioux@gmail.com>
4811 gabb: Danijel Milicevic
4815 Gavin Henry C<ghenry@perl.me.uk>
4819 groditi: Guillermo Roditi <groditi@gmail.com>
4821 hobbs: Andrew Rodland <andrew@cleverdomain.org>
4823 ilmari: Dagfinn Ilmari Mannsåker <ilmari@ilmari.org>
4825 jcamacho: Juan Camacho
4827 jester: Jesse Sheidlower C<jester@panix.com>
4829 jhannah: Jay Hannah <jay@jays.net>
4835 jon: Jon Schutz <jjschutz@cpan.org>
4837 Jonathan Rockway C<< <jrockway@cpan.org> >>
4839 Kieren Diment C<kd@totaldatasolution.com>
4841 konobi: Scott McWhirter <konobi@cpan.org>
4843 marcus: Marcus Ramberg <mramberg@cpan.org>
4845 miyagawa: Tatsuhiko Miyagawa <miyagawa@bulknews.net>
4847 mgrimes: Mark Grimes <mgrimes@cpan.org>
4849 mst: Matt S. Trout <mst@shadowcatsystems.co.uk>
4853 naughton: David Naughton
4855 ningu: David Kamholz <dkamholz@cpan.org>
4857 nothingmuch: Yuval Kogman <nothingmuch@woobling.org>
4859 numa: Dan Sully <daniel@cpan.org>
4865 omega: Andreas Marienborg
4867 Oleg Kostyuk <cub.uanic@gmail.com>
4869 phaylon: Robert Sedlacek <phaylon@dunkelheit.at>
4871 rafl: Florian Ragwitz <rafl@debian.org>
4873 random: Roland Lammel <lammel@cpan.org>
4875 Robert Sedlacek C<< <rs@474.at> >>
4877 SpiceMan: Marcel Montes
4881 szbalint: Balint Szilakszi <szbalint@cpan.org>
4883 t0m: Tomas Doran <bobtfish@bobtfish.net>
4887 vanstyn: Henry Van Styn <vanstyn@cpan.org>
4889 Viljo Marrandi C<vilts@yahoo.com>
4891 Will Hawes C<info@whawes.co.uk>
4893 willert: Sebastian Willert <willert@cpan.org>
4895 wreis: Wallace Reis <wreis@cpan.org>
4897 Yuval Kogman, C<nothingmuch@woobling.org>
4899 rainboxx: Matthias Dietrich, C<perl@rainboxx.de>
4901 dd070: Dhaval Dhanani <dhaval070@gmail.com>
4903 Upasana <me@upasana.me>
4905 John Napiorkowski (jnap) <jjnapiork@cpan.org>
4909 Copyright (c) 2005-2015, the above named PROJECT FOUNDER and CONTRIBUTORS.
4913 This library is free software. You can redistribute it and/or modify it under
4914 the same terms as Perl itself.
4920 __PACKAGE__->meta->make_immutable;