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.90101';
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?, \$fragment? )
1489 =head2 $c->uri_for( $action, \@captures?, @args?, \%query_values?, \$fragment? )
1491 =head2 $c->uri_for( $action, [@captures, @args], \%query_values?, \$fragment? )
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 B<NOTE> If you are using this 'stringy' first argument, we skip encoding and
1510 allow you to declare something like:
1512 $c->uri_for('/foo/bar#baz')
1514 Where 'baz' is a URI fragment. We consider this first argument string to be
1515 'expert' mode where you are expected to create a valid URL and we for the most
1516 part just pass it through without a lot of internal effort to escape and encode.
1518 If the first argument is a L<Catalyst::Action> it represents an action which
1519 will have its path resolved using C<< $c->dispatcher->uri_for_action >>. The
1520 optional C<\@captures> argument (an arrayref) allows passing the captured
1521 variables that are needed to fill in the paths of Chained and Regex actions;
1522 once the path is resolved, C<uri_for> continues as though a path was
1523 provided, appending any arguments or parameters and creating an absolute
1526 The captures for the current request can be found in
1527 C<< $c->request->captures >>, and actions can be resolved using
1528 C<< Catalyst::Controller->action_for($name) >>. If you have a private action
1529 path, use C<< $c->uri_for_action >> instead.
1531 # Equivalent to $c->req->uri
1532 $c->uri_for($c->action, $c->req->captures,
1533 @{ $c->req->args }, $c->req->params);
1535 # For the Foo action in the Bar controller
1536 $c->uri_for($c->controller('Bar')->action_for('Foo'));
1538 # Path to a static resource
1539 $c->uri_for('/static/images/logo.png');
1541 In general the scheme of the generated URI object will follow the incoming request
1542 however if your targeted action or action chain has the Scheme attribute it will
1545 Also, if the targeted Action or Action chain declares Args/CaptureArgs that have
1546 type constraints, we will require that your proposed URL verify on those declared
1552 my ( $c, $path, @args ) = @_;
1554 if ( $path->$_isa('Catalyst::Controller') ) {
1555 $path = $path->path_prefix;
1560 my $fragment = ((scalar(@args) && ref($args[-1]) eq 'SCALAR') ? pop @args : undef );
1562 unless(blessed $path) {
1563 if (defined($path) and $path =~ s/#(.+)$//) {
1564 if(defined($1) and $fragment) {
1565 carp "Abiguious fragment declaration: You cannot define a fragment in '$path' and as an argument '$fragment'";
1574 ( scalar @args && ref $args[$#args] eq 'HASH' ? pop @args : {} );
1576 undef($path) if (defined $path && $path eq '');
1578 carp "uri_for called with undef argument" if grep { ! defined $_ } @args;
1580 my $target_action = $path->$_isa('Catalyst::Action') ? $path : undef;
1581 if ( $path->$_isa('Catalyst::Action') ) { # action object
1582 s|/|%2F|g for @args;
1583 my $captures = [ map { s|/|%2F|g; $_; }
1584 ( scalar @args && ref $args[0] eq 'ARRAY'
1589 my $expanded_action = $c->dispatcher->expand_action( $action );
1590 my $num_captures = $expanded_action->number_of_captures;
1592 # ->uri_for( $action, \@captures_and_args, \%query_values? )
1593 if( !@args && $action->number_of_args ) {
1594 unshift @args, splice @$captures, $num_captures;
1598 unless($expanded_action->match_captures_constraints($c, $captures)) {
1599 carp "captures [@{$captures}] do not match the type constraints in actionchain ending with '$expanded_action'";
1604 $path = $c->dispatcher->uri_for_action($action, $captures);
1605 if (not defined $path) {
1606 $c->log->debug(qq/Can't find uri_for action '$action' @$captures/)
1610 $path = '/' if $path eq '';
1612 # At this point @encoded_args is the remaining Args (all captures removed).
1613 if($expanded_action->has_args_constraints) {
1614 unless($expanded_action->match_args($c,\@args)) {
1615 carp "args [@args] do not match the type constraints in action '$expanded_action'";
1621 unshift(@args, $path);
1623 unless (defined $path && $path =~ s!^/!!) { # in-place strip
1624 my $namespace = $c->namespace;
1625 if (defined $path) { # cheesy hack to handle path '../foo'
1626 $namespace =~ s{(?:^|/)[^/]+$}{} while $args[0] =~ s{^\.\./}{};
1628 unshift(@args, $namespace || '');
1631 # join args with '/', or a blank string
1632 my $args = join('/', grep { defined($_) } @args);
1633 $args =~ s/\?/%3F/g; # STUPID STUPID SPECIAL CASE
1636 my ($base, $class) = ('/', 'URI::_generic');
1638 $base = $c->req->base;
1639 if($target_action) {
1640 $target_action = $c->dispatcher->expand_action($target_action);
1641 if(my $s = $target_action->scheme) {
1646 $class = ref($base);
1649 $class = ref($base);
1652 $base =~ s{(?<!/)$}{/};
1656 if (my @keys = keys %$params) {
1657 # somewhat lifted from URI::_query's query_form
1658 $query = '?'.join('&', map {
1659 my $val = $params->{$_};
1660 #s/([;\/?:@&=+,\$\[\]%])/$URI::Escape::escapes{$1}/go; ## Commented out because seems to lead to double encoding - JNAP
1663 $val = '' unless defined $val;
1666 $param = encode_utf8($param);
1667 # using the URI::Escape pattern here so utf8 chars survive
1668 $param =~ s/([^A-Za-z0-9\-_.!~*'() ])/$URI::Escape::escapes{$1}/go;
1671 $key = encode_utf8($key);
1672 # using the URI::Escape pattern here so utf8 chars survive
1673 $key =~ s/([^A-Za-z0-9\-_.!~*'() ])/$URI::Escape::escapes{$1}/go;
1676 "${key}=$param"; } ( ref $val eq 'ARRAY' ? @$val : $val ));
1680 $base = encode_utf8 $base;
1681 $base =~ s/([^$URI::uric])/$URI::Escape::escapes{$1}/go;
1682 $args = encode_utf8 $args;
1683 $args =~ s/([^$URI::uric])/$URI::Escape::escapes{$1}/go;
1685 if(defined $fragment) {
1687 $fragment = encode_utf8(${$fragment});
1688 $fragment =~ s/([^A-Za-z0-9\-_.!~*'() ])/$URI::Escape::escapes{$1}/go;
1689 $fragment =~ s/ /+/g;
1691 $query .= "#$fragment";
1694 my $res = bless(\"${base}${args}${query}", $class);
1698 =head2 $c->uri_for_action( $path, \@captures_and_args?, @args?, \%query_values? )
1700 =head2 $c->uri_for_action( $action, \@captures_and_args?, @args?, \%query_values? )
1706 A private path to the Catalyst action you want to create a URI for.
1708 This is a shortcut for calling C<< $c->dispatcher->get_action_by_path($path)
1709 >> and passing the resulting C<$action> and the remaining arguments to C<<
1712 You can also pass in a Catalyst::Action object, in which case it is passed to
1715 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.
1717 For example, if the action looks like:
1719 package MyApp::Controller::Users;
1721 sub lst : Path('the-list') {}
1725 $c->uri_for_action('/users/lst')
1727 and it will create the URI /users/the-list.
1729 =item \@captures_and_args?
1731 Optional array reference of Captures (i.e. C<<CaptureArgs or $c->req->captures>)
1732 and arguments to the request. Usually used with L<Catalyst::DispatchType::Chained>
1733 to interpolate all the parameters in the URI.
1737 Optional list of extra arguments - can be supplied in the
1738 C<< \@captures_and_args? >> array ref, or here - whichever is easier for your
1741 Your action can have zero, a fixed or a variable number of args (e.g.
1742 C<< Args(1) >> for a fixed number or C<< Args() >> for a variable number)..
1744 =item \%query_values?
1746 Optional array reference of query parameters to append. E.g.
1752 /rest/of/your/uri?foo=bar
1758 sub uri_for_action {
1759 my ( $c, $path, @args ) = @_;
1760 my $action = blessed($path)
1762 : $c->dispatcher->get_action_by_path($path);
1763 unless (defined $action) {
1764 croak "Can't find action for path '$path'";
1766 return $c->uri_for( $action, @args );
1769 =head2 $c->welcome_message
1771 Returns the Catalyst welcome HTML page.
1775 sub welcome_message {
1777 my $name = $c->config->{name};
1778 my $logo = $c->uri_for('/static/images/catalyst_logo.png');
1779 my $prefix = Catalyst::Utils::appprefix( ref $c );
1780 $c->response->content_type('text/html; charset=utf-8');
1782 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
1783 "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
1784 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
1786 <meta http-equiv="Content-Language" content="en" />
1787 <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
1788 <title>$name on Catalyst $VERSION</title>
1789 <style type="text/css">
1792 background-color: #eee;
1799 margin-bottom: 10px;
1801 background-color: #ccc;
1802 border: 1px solid #aaa;
1807 font-family: verdana, tahoma, sans-serif;
1810 font-family: verdana, tahoma, sans-serif;
1813 text-decoration: none;
1815 border-bottom: 1px dotted #bbb;
1817 :link:hover, :visited:hover {
1830 background-color: #fff;
1831 border: 1px solid #aaa;
1835 font-weight: normal;
1857 <h1><span id="appname">$name</span> on <a href="http://catalyst.perl.org">Catalyst</a>
1862 <img src="$logo" alt="Catalyst Logo" />
1864 <p>Welcome to the world of Catalyst.
1865 This <a href="http://en.wikipedia.org/wiki/MVC">MVC</a>
1866 framework will make web development something you had
1867 never expected it to be: Fun, rewarding, and quick.</p>
1868 <h2>What to do now?</h2>
1869 <p>That really depends on what <b>you</b> want to do.
1870 We do, however, provide you with a few starting points.</p>
1871 <p>If you want to jump right into web development with Catalyst
1872 you might want to start with a tutorial.</p>
1873 <pre>perldoc <a href="https://metacpan.org/module/Catalyst::Manual::Tutorial">Catalyst::Manual::Tutorial</a></code>
1875 <p>Afterwards you can go on to check out a more complete look at our features.</p>
1877 <code>perldoc <a href="https://metacpan.org/module/Catalyst::Manual::Intro">Catalyst::Manual::Intro</a>
1878 <!-- Something else should go here, but the Catalyst::Manual link seems unhelpful -->
1880 <h2>What to do next?</h2>
1881 <p>Next it's time to write an actual application. Use the
1882 helper scripts to generate <a href="https://metacpan.org/search?q=Catalyst%3A%3AController">controllers</a>,
1883 <a href="https://metacpan.org/search?q=Catalyst%3A%3AModel">models</a>, and
1884 <a href="https://metacpan.org/search?q=Catalyst%3A%3AView">views</a>;
1885 they can save you a lot of work.</p>
1886 <pre><code>script/${prefix}_create.pl --help</code></pre>
1887 <p>Also, be sure to check out the vast and growing
1888 collection of <a href="http://search.cpan.org/search?query=Catalyst">plugins for Catalyst on CPAN</a>;
1889 you are likely to find what you need there.
1893 <p>Catalyst has a very active community. Here are the main places to
1894 get in touch with us.</p>
1897 <a href="http://dev.catalyst.perl.org">Wiki</a>
1900 <a href="http://lists.scsys.co.uk/cgi-bin/mailman/listinfo/catalyst">Mailing-List</a>
1903 <a href="irc://irc.perl.org/catalyst">IRC channel #catalyst on irc.perl.org</a>
1906 <h2>In conclusion</h2>
1907 <p>The Catalyst team hopes you will enjoy using Catalyst as much
1908 as we enjoyed making it. Please contact us if you have ideas
1909 for improvement or other feedback.</p>
1919 Contains a hash of options passed from the application script, including
1920 the original ARGV the script received, the processed values from that
1921 ARGV and any extra arguments to the script which were not processed.
1923 This can be used to add custom options to your application's scripts
1924 and setup your application differently depending on the values of these
1927 =head1 INTERNAL METHODS
1929 These methods are not meant to be used by end users.
1931 =head2 $c->components
1933 Returns a hash of components.
1935 =head2 $c->context_class
1937 Returns or sets the context class.
1941 Returns a hashref containing coderefs and execution counts (needed for
1942 deep recursion detection).
1946 Returns the number of actions on the current internal execution stack.
1950 Dispatches a request to actions.
1954 sub dispatch { my $c = shift; $c->dispatcher->dispatch( $c, @_ ) }
1956 =head2 $c->dispatcher_class
1958 Returns or sets the dispatcher class.
1960 =head2 $c->dump_these
1962 Returns a list of 2-element array references (name, structure) pairs
1963 that will be dumped on the error page in debug mode.
1969 [ Request => $c->req ],
1970 [ Response => $c->res ],
1971 [ Stash => $c->stash ],
1972 [ Config => $c->config ];
1975 =head2 $c->engine_class
1977 Returns or sets the engine class.
1979 =head2 $c->execute( $class, $coderef )
1981 Execute a coderef in given class and catch exceptions. Errors are available
1987 my ( $c, $class, $code ) = @_;
1988 $class = $c->component($class) || $class;
1991 if ( $c->depth >= $RECURSION ) {
1992 my $action = $code->reverse();
1993 $action = "/$action" unless $action =~ /->/;
1994 my $error = qq/Deep recursion detected calling "${action}"/;
1995 $c->log->error($error);
2001 my $stats_info = $c->_stats_start_execute( $code ) if $c->use_stats;
2003 push( @{ $c->stack }, $code );
2005 no warnings 'recursion';
2006 # N.B. This used to be combined, but I have seen $c get clobbered if so, and
2007 # I have no idea how, ergo $ret (which appears to fix the issue)
2008 eval { my $ret = $code->execute( $class, $c, @{ $c->req->args } ) || 0; $c->state( $ret ) };
2010 $c->_stats_finish_execute( $stats_info ) if $c->use_stats and $stats_info;
2012 my $last = pop( @{ $c->stack } );
2014 if ( my $error = $@ ) {
2015 #rethow if this can be handled by middleware
2016 if ( $c->_handle_http_exception($error) ) {
2017 foreach my $err (@{$c->error}) {
2018 $c->log->error($err);
2021 $c->log->_flush if $c->log->can('_flush');
2023 $error->can('rethrow') ? $error->rethrow : croak $error;
2025 if ( blessed($error) and $error->isa('Catalyst::Exception::Detach') ) {
2026 $error->rethrow if $c->depth > 1;
2028 elsif ( blessed($error) and $error->isa('Catalyst::Exception::Go') ) {
2029 $error->rethrow if $c->depth > 0;
2032 unless ( ref $error ) {
2033 no warnings 'uninitialized';
2035 my $class = $last->class;
2036 my $name = $last->name;
2037 $error = qq/Caught exception in $class->$name "$error"/;
2046 sub _stats_start_execute {
2047 my ( $c, $code ) = @_;
2048 my $appclass = ref($c) || $c;
2049 return if ( ( $code->name =~ /^_.*/ )
2050 && ( !$appclass->config->{show_internal_actions} ) );
2052 my $action_name = $code->reverse();
2053 $c->counter->{$action_name}++;
2055 my $action = $action_name;
2056 $action = "/$action" unless $action =~ /->/;
2058 # determine if the call was the result of a forward
2059 # this is done by walking up the call stack and looking for a calling
2060 # sub of Catalyst::forward before the eval
2062 for my $index ( 2 .. 11 ) {
2064 if ( ( caller($index) )[0] eq 'Catalyst'
2065 && ( caller($index) )[3] eq '(eval)' );
2067 if ( ( caller($index) )[3] =~ /forward$/ ) {
2068 $callsub = ( caller($index) )[3];
2069 $action = "-> $action";
2074 my $uid = $action_name . $c->counter->{$action_name};
2076 # is this a root-level call or a forwarded call?
2077 if ( $callsub =~ /forward$/ ) {
2078 my $parent = $c->stack->[-1];
2080 # forward, locate the caller
2081 if ( defined $parent && exists $c->counter->{"$parent"} ) {
2084 parent => "$parent" . $c->counter->{"$parent"},
2090 # forward with no caller may come from a plugin
2109 sub _stats_finish_execute {
2110 my ( $c, $info ) = @_;
2111 $c->stats->profile( end => $info );
2116 Finalizes the request.
2123 for my $error ( @{ $c->error } ) {
2124 $c->log->error($error);
2127 # Support skipping finalize for psgix.io style 'jailbreak'. Used to support
2128 # stuff like cometd and websockets
2130 if($c->request->_has_io_fh) {
2135 # Allow engine to handle finalize flow (for POE)
2136 my $engine = $c->engine;
2137 if ( my $code = $engine->can('finalize') ) {
2142 $c->finalize_uploads;
2145 if ( $#{ $c->error } >= 0 ) {
2149 $c->finalize_encoding;
2150 $c->finalize_headers unless $c->response->finalized_headers;
2156 if ($c->use_stats) {
2157 my $elapsed = $c->stats->elapsed;
2158 my $av = $elapsed == 0 ? '??' : sprintf '%.3f', 1 / $elapsed;
2160 "Request took ${elapsed}s ($av/s)\n" . $c->stats->report . "\n" );
2163 return $c->response->status;
2166 =head2 $c->finalize_body
2172 sub finalize_body { my $c = shift; $c->engine->finalize_body( $c, @_ ) }
2174 =head2 $c->finalize_cookies
2180 sub finalize_cookies { my $c = shift; $c->engine->finalize_cookies( $c, @_ ) }
2182 =head2 $c->finalize_error
2184 Finalizes error. If there is only one error in L</error> and it is an object that
2185 does C<as_psgi> or C<code> we rethrow the error and presume it caught by middleware
2186 up the ladder. Otherwise we return the debugging error page (in debug mode) or we
2187 return the default error page (production mode).
2191 sub finalize_error {
2193 if($#{$c->error} > 0) {
2194 $c->engine->finalize_error( $c, @_ );
2196 my ($error) = @{$c->error};
2197 if ( $c->_handle_http_exception($error) ) {
2198 # In the case where the error 'knows what it wants', becauses its PSGI
2199 # aware, just rethow and let middleware catch it
2200 $error->can('rethrow') ? $error->rethrow : croak $error;
2202 $c->engine->finalize_error( $c, @_ )
2207 =head2 $c->finalize_headers
2213 sub finalize_headers {
2216 my $response = $c->response; #accessor calls can add up?
2218 # Check if we already finalized headers
2219 return if $response->finalized_headers;
2222 if ( my $location = $response->redirect ) {
2223 $c->log->debug(qq/Redirecting to "$location"/) if $c->debug;
2224 $response->header( Location => $location );
2227 # Remove incorrectly added body and content related meta data when returning
2228 # an information response, or a response the is required to not include a body
2230 $c->finalize_cookies;
2232 # This currently is a NOOP but I don't want to remove it since I guess people
2233 # might have Response subclasses that use it for something... (JNAP)
2234 $c->response->finalize_headers();
2237 $response->finalized_headers(1);
2240 =head2 $c->finalize_encoding
2242 Make sure your body is encoded properly IF you set an encoding. By
2243 default the encoding is UTF-8 but you can disable it by explicitly setting the
2244 encoding configuration value to undef.
2246 We can only encode when the body is a scalar. Methods for encoding via the
2247 streaming interfaces (such as C<write> and C<write_fh> on L<Catalyst::Response>
2254 sub finalize_encoding {
2256 my $res = $c->res || return;
2258 # Warn if the set charset is different from the one you put into encoding. We need
2259 # to do this early since encodable_response is false for this condition and we need
2260 # to match the debug output for backcompat (there's a test for this...) -JNAP
2262 $res->content_type_charset and $c->encoding and
2263 (uc($c->encoding->mime_name) ne uc($res->content_type_charset))
2265 my $ct = lc($res->content_type_charset);
2266 $c->log->debug("Catalyst encoding config is set to encode in '" .
2267 $c->encoding->mime_name .
2268 "', content type is '$ct', not encoding ");
2272 ($res->encodable_response) and
2273 (defined($res->body)) and
2274 (ref(\$res->body) eq 'SCALAR')
2276 $c->res->body( $c->encoding->encode( $c->res->body, $c->_encode_check ) );
2278 # Set the charset if necessary. This might be a bit bonkers since encodable response
2279 # is false when the set charset is not the same as the encoding mimetype (maybe
2280 # confusing action at a distance here..
2281 # Don't try to set the charset if one already exists or if headers are already finalized
2282 $c->res->content_type($c->res->content_type . "; charset=" . $c->encoding->mime_name)
2283 unless($c->res->content_type_charset ||
2284 ($c->res->_context && $c->res->finalized_headers && !$c->res->_has_response_cb));
2288 =head2 $c->finalize_output
2290 An alias for finalize_body.
2292 =head2 $c->finalize_read
2294 Finalizes the input after reading is complete.
2298 sub finalize_read { my $c = shift; $c->engine->finalize_read( $c, @_ ) }
2300 =head2 $c->finalize_uploads
2302 Finalizes uploads. Cleans up any temporary files.
2306 sub finalize_uploads { my $c = shift; $c->engine->finalize_uploads( $c, @_ ) }
2308 =head2 $c->get_action( $action, $namespace )
2310 Gets an action in a given namespace.
2314 sub get_action { my $c = shift; $c->dispatcher->get_action(@_) }
2316 =head2 $c->get_actions( $action, $namespace )
2318 Gets all actions of a given name in a namespace and all parent
2323 sub get_actions { my $c = shift; $c->dispatcher->get_actions( $c, @_ ) }
2325 =head2 $app->handle_request( @arguments )
2327 Called to handle each HTTP request.
2331 sub handle_request {
2332 my ( $class, @arguments ) = @_;
2334 # Always expect worst case!
2337 if ($class->debug) {
2338 my $secs = time - $START || 1;
2339 my $av = sprintf '%.3f', $COUNT / $secs;
2340 my $time = localtime time;
2341 $class->log->info("*** Request $COUNT ($av/s) [$$] [$time] ***");
2344 my $c = $class->prepare(@arguments);
2346 $status = $c->finalize;
2348 #rethow if this can be handled by middleware
2349 if ( $class->_handle_http_exception($_) ) {
2350 $_->can('rethrow') ? $_->rethrow : croak $_;
2352 chomp(my $error = $_);
2353 $class->log->error(qq/Caught exception in engine "$error"/);
2358 if(my $coderef = $class->log->can('_flush')){
2359 $class->log->$coderef();
2364 =head2 $class->prepare( @arguments )
2366 Creates a Catalyst context from an engine-specific request (Apache, CGI,
2373 predicate => '_has_uploadtmp',
2377 my ( $class, @arguments ) = @_;
2380 # After the app/ctxt split, this should become an attribute based on something passed
2381 # into the application.
2382 $class->context_class( ref $class || $class ) unless $class->context_class;
2384 my $uploadtmp = $class->config->{uploadtmp};
2385 my $c = $class->context_class->new({ $uploadtmp ? (_uploadtmp => $uploadtmp) : ()});
2387 $c->response->_context($c);
2389 $c->stats($class->stats_class->new)->enable($c->use_stats);
2391 if ( $c->debug || $c->config->{enable_catalyst_header} ) {
2392 $c->res->headers->header( 'X-Catalyst' => $Catalyst::VERSION );
2396 # Allow engine to direct the prepare flow (for POE)
2397 if ( my $prepare = $c->engine->can('prepare') ) {
2398 $c->engine->$prepare( $c, @arguments );
2401 $c->prepare_request(@arguments);
2402 $c->prepare_connection;
2403 $c->prepare_query_parameters;
2404 $c->prepare_headers; # Just hooks, no longer needed - they just
2405 $c->prepare_cookies; # cause the lazy attribute on req to build
2408 # Prepare the body for reading, either by prepare_body
2409 # or the user, if they are using $c->read
2412 # Parse the body unless the user wants it on-demand
2413 unless ( ref($c)->config->{parse_on_demand} ) {
2419 # VERY ugly and probably shouldn't rely on ->finalize actually working
2421 # failed prepare is always due to an invalid request, right?
2422 $c->response->status(400);
2423 $c->response->content_type('text/plain');
2424 $c->response->body('Bad Request');
2425 # Note we call finalize and then die here, which escapes
2426 # finalize being called in the enclosing block..
2427 # It in fact couldn't be called, as we don't return $c..
2428 # This is a mess - but I'm unsure you can fix this without
2429 # breaking compat for people doing crazy things (we should set
2430 # the 400 and just return the ctx here IMO, letting finalize get called
2441 =head2 $c->prepare_action
2443 Prepares action. See L<Catalyst::Dispatcher>.
2447 sub prepare_action {
2449 my $ret = $c->dispatcher->prepare_action( $c, @_);
2452 foreach (@{$c->req->arguments}, @{$c->req->captures}) {
2453 $_ = $c->_handle_param_unicode_decoding($_);
2461 =head2 $c->prepare_body
2463 Prepares message body.
2470 return if $c->request->_has_body;
2472 # Initialize on-demand data
2473 $c->engine->prepare_body( $c, @_ );
2474 $c->prepare_parameters;
2475 $c->prepare_uploads;
2478 =head2 $c->prepare_body_chunk( $chunk )
2480 Prepares a chunk of data before sending it to L<HTTP::Body>.
2482 See L<Catalyst::Engine>.
2486 sub prepare_body_chunk {
2488 $c->engine->prepare_body_chunk( $c, @_ );
2491 =head2 $c->prepare_body_parameters
2493 Prepares body parameters.
2497 sub prepare_body_parameters {
2499 $c->request->prepare_body_parameters( $c, @_ );
2502 =head2 $c->prepare_connection
2504 Prepares connection.
2508 sub prepare_connection {
2510 $c->request->prepare_connection($c);
2513 =head2 $c->prepare_cookies
2515 Prepares cookies by ensuring that the attribute on the request
2516 object has been built.
2520 sub prepare_cookies { my $c = shift; $c->request->cookies }
2522 =head2 $c->prepare_headers
2524 Prepares request headers by ensuring that the attribute on the request
2525 object has been built.
2529 sub prepare_headers { my $c = shift; $c->request->headers }
2531 =head2 $c->prepare_parameters
2533 Prepares parameters.
2537 sub prepare_parameters {
2539 $c->prepare_body_parameters;
2540 $c->engine->prepare_parameters( $c, @_ );
2543 =head2 $c->prepare_path
2545 Prepares path and base.
2549 sub prepare_path { my $c = shift; $c->engine->prepare_path( $c, @_ ) }
2551 =head2 $c->prepare_query_parameters
2553 Prepares query parameters.
2557 sub prepare_query_parameters {
2560 $c->engine->prepare_query_parameters( $c, @_ );
2563 =head2 $c->log_request
2565 Writes information about the request to the debug logs. This includes:
2569 =item * Request method, path, and remote IP address
2571 =item * Query keywords (see L<Catalyst::Request/query_keywords>)
2573 =item * Request parameters
2575 =item * File uploads
2584 return unless $c->debug;
2586 my($dump) = grep {$_->[0] eq 'Request' } $c->dump_these;
2587 my $request = $dump->[1];
2589 my ( $method, $path, $address ) = ( $request->method, $request->path, $request->address );
2591 $path = '/' unless length $path;
2594 $path =~ s/%([0-9A-Fa-f]{2})/chr(hex($1))/eg;
2595 $path = decode_utf8($path);
2597 $c->log->debug(qq/"$method" request for "$path" from "$address"/);
2599 $c->log_request_headers($request->headers);
2601 if ( my $keywords = $request->query_keywords ) {
2602 $c->log->debug("Query keywords are: $keywords");
2605 $c->log_request_parameters( query => $request->query_parameters, $request->_has_body ? (body => $request->body_parameters) : () );
2607 $c->log_request_uploads($request);
2610 =head2 $c->log_response
2612 Writes information about the response to the debug logs by calling
2613 C<< $c->log_response_status_line >> and C<< $c->log_response_headers >>.
2620 return unless $c->debug;
2622 my($dump) = grep {$_->[0] eq 'Response' } $c->dump_these;
2623 my $response = $dump->[1];
2625 $c->log_response_status_line($response);
2626 $c->log_response_headers($response->headers);
2629 =head2 $c->log_response_status_line($response)
2631 Writes one line of information about the response to the debug logs. This includes:
2635 =item * Response status code
2637 =item * Content-Type header (if present)
2639 =item * Content-Length header (if present)
2645 sub log_response_status_line {
2646 my ($c, $response) = @_;
2650 'Response Code: %s; Content-Type: %s; Content-Length: %s',
2651 $response->status || 'unknown',
2652 $response->headers->header('Content-Type') || 'unknown',
2653 $response->headers->header('Content-Length') || 'unknown'
2658 =head2 $c->log_response_headers($headers);
2660 Hook method which can be wrapped by plugins to log the response headers.
2661 No-op in the default implementation.
2665 sub log_response_headers {}
2667 =head2 $c->log_request_parameters( query => {}, body => {} )
2669 Logs request parameters to debug logs
2673 sub log_request_parameters {
2675 my %all_params = @_;
2677 return unless $c->debug;
2679 my $column_width = Catalyst::Utils::term_width() - 44;
2680 foreach my $type (qw(query body)) {
2681 my $params = $all_params{$type};
2682 next if ! keys %$params;
2683 my $t = Text::SimpleTable->new( [ 35, 'Parameter' ], [ $column_width, 'Value' ] );
2684 for my $key ( sort keys %$params ) {
2685 my $param = $params->{$key};
2686 my $value = defined($param) ? $param : '';
2687 $t->row( $key, ref $value eq 'ARRAY' ? ( join ', ', @$value ) : $value );
2689 $c->log->debug( ucfirst($type) . " Parameters are:\n" . $t->draw );
2693 =head2 $c->log_request_uploads
2695 Logs file uploads included in the request to the debug logs.
2696 The parameter name, filename, file type, and file size are all included in
2701 sub log_request_uploads {
2703 my $request = shift;
2704 return unless $c->debug;
2705 my $uploads = $request->uploads;
2706 if ( keys %$uploads ) {
2707 my $t = Text::SimpleTable->new(
2708 [ 12, 'Parameter' ],
2713 for my $key ( sort keys %$uploads ) {
2714 my $upload = $uploads->{$key};
2715 for my $u ( ref $upload eq 'ARRAY' ? @{$upload} : ($upload) ) {
2716 $t->row( $key, $u->filename, $u->type, $u->size );
2719 $c->log->debug( "File Uploads are:\n" . $t->draw );
2723 =head2 $c->log_request_headers($headers);
2725 Hook method which can be wrapped by plugins to log the request headers.
2726 No-op in the default implementation.
2730 sub log_request_headers {}
2732 =head2 $c->log_headers($type => $headers)
2734 Logs L<HTTP::Headers> (either request or response) to the debug logs.
2741 my $headers = shift; # an HTTP::Headers instance
2743 return unless $c->debug;
2745 my $column_width = Catalyst::Utils::term_width() - 28;
2746 my $t = Text::SimpleTable->new( [ 15, 'Header Name' ], [ $column_width, 'Value' ] );
2749 my ( $name, $value ) = @_;
2750 $t->row( $name, $value );
2753 $c->log->debug( ucfirst($type) . " Headers:\n" . $t->draw );
2757 =head2 $c->prepare_read
2759 Prepares the input for reading.
2763 sub prepare_read { my $c = shift; $c->engine->prepare_read( $c, @_ ) }
2765 =head2 $c->prepare_request
2767 Prepares the engine request.
2771 sub prepare_request { my $c = shift; $c->engine->prepare_request( $c, @_ ) }
2773 =head2 $c->prepare_uploads
2779 sub prepare_uploads {
2781 $c->engine->prepare_uploads( $c, @_ );
2784 =head2 $c->prepare_write
2786 Prepares the output for writing.
2790 sub prepare_write { my $c = shift; $c->engine->prepare_write( $c, @_ ) }
2792 =head2 $c->request_class
2794 Returns or sets the request class. Defaults to L<Catalyst::Request>.
2796 =head2 $app->request_class_traits
2798 An arrayref of L<Moose::Role>s which are applied to the request class. You can
2799 name the full namespace of the role, or a namespace suffix, which will then
2800 be tried against the following standard namespace prefixes.
2802 $MyApp::TraitFor::Request::$trait_suffix
2803 Catalyst::TraitFor::Request::$trait_suffix
2805 So for example if you set:
2807 MyApp->request_class_traits(['Foo']);
2809 We try each possible role in turn (and throw an error if none load)
2812 MyApp::TraitFor::Request::Foo
2813 Catalyst::TraitFor::Request::Foo
2815 The namespace part 'TraitFor::Request' was choosen to assist in backwards
2816 compatibility with L<CatalystX::RoleApplicator> which previously provided
2817 these features in a stand alone package.
2819 =head2 $app->composed_request_class
2821 This is the request class which has been composed with any request_class_traits.
2823 =head2 $c->response_class
2825 Returns or sets the response class. Defaults to L<Catalyst::Response>.
2827 =head2 $app->response_class_traits
2829 An arrayref of L<Moose::Role>s which are applied to the response class. You can
2830 name the full namespace of the role, or a namespace suffix, which will then
2831 be tried against the following standard namespace prefixes.
2833 $MyApp::TraitFor::Response::$trait_suffix
2834 Catalyst::TraitFor::Response::$trait_suffix
2836 So for example if you set:
2838 MyApp->response_class_traits(['Foo']);
2840 We try each possible role in turn (and throw an error if none load)
2843 MyApp::TraitFor::Response::Foo
2844 Catalyst::TraitFor::Responset::Foo
2846 The namespace part 'TraitFor::Response' was choosen to assist in backwards
2847 compatibility with L<CatalystX::RoleApplicator> which previously provided
2848 these features in a stand alone package.
2851 =head2 $app->composed_response_class
2853 This is the request class which has been composed with any response_class_traits.
2855 =head2 $c->read( [$maxlength] )
2857 Reads a chunk of data from the request body. This method is designed to
2858 be used in a while loop, reading C<$maxlength> bytes on every call.
2859 C<$maxlength> defaults to the size of the request if not specified.
2861 You have to set C<< MyApp->config(parse_on_demand => 1) >> to use this
2864 Warning: If you use read(), Catalyst will not process the body,
2865 so you will not be able to access POST parameters or file uploads via
2866 $c->request. You must handle all body parsing yourself.
2870 sub read { my $c = shift; return $c->request->read( @_ ) }
2880 $app->_make_immutable_if_needed;
2881 $app->engine_loader->needs_psgi_engine_compat_hack ?
2882 $app->engine->run($app, @_) :
2883 $app->engine->run( $app, $app->_finalized_psgi_app, @_ );
2886 sub _make_immutable_if_needed {
2888 my $meta = find_meta($class);
2889 my $isa_ca = $class->isa('Class::Accessor::Fast') || $class->isa('Class::Accessor');
2892 && ! { $meta->immutable_options }->{replace_constructor}
2895 warn("You made your application class ($class) immutable, "
2896 . "but did not inline the\nconstructor. "
2897 . "This will break catalyst, as your app \@ISA "
2898 . "Class::Accessor(::Fast)?\nPlease pass "
2899 . "(replace_constructor => 1)\nwhen making your class immutable.\n");
2901 unless ($meta->is_immutable) {
2902 # XXX - FIXME warning here as you should make your app immutable yourself.
2903 $meta->make_immutable(
2904 replace_constructor => 1,
2909 =head2 $c->set_action( $action, $code, $namespace, $attrs )
2911 Sets an action in a given namespace.
2915 sub set_action { my $c = shift; $c->dispatcher->set_action( $c, @_ ) }
2917 =head2 $c->setup_actions($component)
2919 Sets up actions for a component.
2923 sub setup_actions { my $c = shift; $c->dispatcher->setup_actions( $c, @_ ) }
2925 =head2 $c->setup_components
2927 This method is called internally to set up the application's components.
2929 It finds modules by calling the L<locate_components> method, expands them to
2930 package names with the L<expand_component_module> method, and then installs
2931 each component into the application.
2933 The C<setup_components> config option is passed to both of the above methods.
2935 Installation of each component is performed by the L<setup_component> method,
2940 sub setup_components {
2943 my $config = $class->config->{ setup_components };
2945 my @comps = $class->locate_components($config);
2946 my %comps = map { $_ => 1 } @comps;
2948 my $deprecatedcatalyst_component_names = grep { /::[CMV]::/ } @comps;
2949 $class->log->warn(qq{Your application is using the deprecated ::[MVC]:: type naming scheme.\n}.
2950 qq{Please switch your class names to ::Model::, ::View:: and ::Controller: as appropriate.\n}
2951 ) if $deprecatedcatalyst_component_names;
2953 for my $component ( @comps ) {
2955 # We pass ignore_loaded here so that overlay files for (e.g.)
2956 # Model::DBI::Schema sub-classes are loaded - if it's in @comps
2957 # we know M::P::O found a file on disk so this is safe
2959 Catalyst::Utils::ensure_class_loaded( $component, { ignore_loaded => 1 } );
2962 for my $component (@comps) {
2963 my $instance = $class->components->{ $component } = $class->delayed_setup_component($component);
2966 # Inject a component or wrap a stand alone class in an adaptor. This makes a list
2967 # of named components in the configuration that are not actually existing (not a
2970 my @injected = $class->setup_injected_components;
2972 # All components are registered, now we need to 'init' them.
2973 foreach my $component_name (@comps, @injected) {
2974 $class->components->{$component_name} = $class->components->{$component_name}->() if
2975 (ref($class->components->{$component_name}) || '') eq 'CODE';
2979 =head2 $app->setup_injected_components
2981 Called by setup_compoents to setup components that are injected.
2985 sub setup_injected_components {
2987 my @injected_components = keys %{$class->config->{inject_components} ||+{}};
2989 foreach my $injected_comp_name(@injected_components) {
2990 $class->setup_injected_component(
2991 $injected_comp_name,
2992 $class->config->{inject_components}->{$injected_comp_name});
2995 return map { $class ."::" . $_ }
2996 @injected_components;
2999 =head2 $app->setup_injected_component( $injected_component_name, $config )
3001 Setup a given injected component.
3005 sub setup_injected_component {
3006 my ($class, $injected_comp_name, $config) = @_;
3007 if(my $component_class = $config->{from_component}) {
3008 my @roles = @{$config->{roles} ||[]};
3009 Catalyst::Utils::inject_component(
3011 component => $component_class,
3012 (scalar(@roles) ? (traits => \@roles) : ()),
3013 as => $injected_comp_name);
3017 =head2 $app->inject_component($MyApp_Component_name => \%args);
3019 Add a component that is injected at setup:
3021 MyApp->inject_component( 'Model::Foo' => { from_component => 'Common::Foo' } );
3023 Must be called before ->setup. Expects a component name for your
3024 current application and \%args where
3028 =item from_component
3030 The target component being injected into your application
3034 An arrayref of L<Moose::Role>s that are applied to your component.
3040 MyApp->inject_component(
3042 from_component => 'Common::Model::Foo',
3043 roles => ['Role1', 'Role2'],
3046 =head2 $app->inject_components
3048 Inject a list of components:
3050 MyApp->inject_components(
3051 'Model::FooOne' => {
3052 from_component => 'Common::Model::Foo',
3053 roles => ['Role1', 'Role2'],
3055 'Model::FooTwo' => {
3056 from_component => 'Common::Model::Foo',
3057 roles => ['Role1', 'Role2'],
3062 sub inject_component {
3063 my ($app, $name, $args) = @_;
3064 die "Component $name exists" if
3065 $app->config->{inject_components}->{$name};
3066 $app->config->{inject_components}->{$name} = $args;
3069 sub inject_components {
3072 $app->inject_component(shift, shift);
3076 =head2 $c->locate_components( $setup_component_config )
3078 This method is meant to provide a list of component modules that should be
3079 setup for the application. By default, it will use L<Module::Pluggable>.
3081 Specify a C<setup_components> config option to pass additional options directly
3082 to L<Module::Pluggable>. To add additional search paths, specify a key named
3083 C<search_extra> as an array reference. Items in the array beginning with C<::>
3084 will have the application class name prepended to them.
3088 sub locate_components {
3092 my @paths = qw( ::M ::Model ::V ::View ::C ::Controller );
3093 my $extra = delete $config->{ search_extra } || [];
3095 unshift @paths, @$extra;
3097 my @comps = map { sort { length($a) <=> length($b) } Module::Pluggable::Object->new(
3098 search_path => [ map { s/^(?=::)/$class/; $_; } ($_) ],
3100 )->plugins } @paths;
3105 =head2 $c->expand_component_module( $component, $setup_component_config )
3107 Components found by C<locate_components> will be passed to this method, which
3108 is expected to return a list of component (package) names to be set up.
3112 sub expand_component_module {
3113 my ($class, $module) = @_;
3114 return Devel::InnerPackage::list_packages( $module );
3117 =head2 $app->delayed_setup_component
3119 Returns a coderef that points to a setup_component instance. Used
3120 internally for when you want to delay setup until the first time
3121 the component is called.
3125 sub delayed_setup_component {
3126 my($class, $component, @more) = @_;
3128 return my $instance = $class->setup_component($component, @more);
3132 =head2 $c->setup_component
3136 sub setup_component {
3137 my( $class, $component ) = @_;
3139 unless ( $component->can( 'COMPONENT' ) ) {
3143 my $config = $class->config_for($component);
3144 # Stash catalyst_component_name in the config here, so that custom COMPONENT
3145 # methods also pass it. local to avoid pointlessly shitting in config
3146 # for the debug screen, as $component is already the key name.
3147 local $config->{catalyst_component_name} = $component;
3149 my $instance = eval {
3150 $component->COMPONENT( $class, $config );
3154 Catalyst::Exception->throw(
3155 message => qq/Couldn't instantiate component "$component", "$error"/
3159 unless (blessed $instance) {
3160 my $metaclass = Moose::Util::find_meta($component);
3161 my $method_meta = $metaclass->find_method_by_name('COMPONENT');
3162 my $component_method_from = $method_meta->associated_metaclass->name;
3163 my $value = defined($instance) ? $instance : 'undef';
3164 Catalyst::Exception->throw(
3166 qq/Couldn't instantiate component "$component", COMPONENT() method (from $component_method_from) didn't return an object-like value (value was $value)./
3170 my @expanded_components = $instance->can('expand_modules')
3171 ? $instance->expand_modules( $component, $config )
3172 : $class->expand_component_module( $component, $config );
3173 for my $component (@expanded_components) {
3174 next if $class->components->{ $component };
3175 $class->components->{ $component } = $class->setup_component($component);
3181 =head2 $app->config_for( $component_name )
3183 Return the application level configuration (which is not yet merged with any
3184 local component configuration, via $component_class->config) for the named
3185 component or component object. Example:
3188 'Model::Foo' => { a => 1, b => 2},
3191 my $config = MyApp->config_for('MyApp::Model::Foo');
3193 In this case $config is the hashref C< {a=>1, b=>2} >.
3195 This is also handy for looking up configuration for a plugin, to make sure you follow
3196 existing L<Catalyst> standards for where a plugin should put its configuration.
3201 my ($class, $component_name) = @_;
3202 my $component_suffix = Catalyst::Utils::class2classsuffix($component_name);
3203 my $config = $class->config->{ $component_suffix } || {};
3208 =head2 $c->setup_dispatcher
3214 sub setup_dispatcher {
3215 my ( $class, $dispatcher ) = @_;
3218 $dispatcher = 'Catalyst::Dispatcher::' . $dispatcher;
3221 if ( my $env = Catalyst::Utils::env_value( $class, 'DISPATCHER' ) ) {
3222 $dispatcher = 'Catalyst::Dispatcher::' . $env;
3225 unless ($dispatcher) {
3226 $dispatcher = $class->dispatcher_class;
3229 load_class($dispatcher);
3231 # dispatcher instance
3232 $class->dispatcher( $dispatcher->new );
3235 =head2 $c->setup_engine
3242 my ($class, $requested_engine) = @_;
3244 if (!$class->engine_loader || $requested_engine) {
3245 $class->engine_loader(
3246 Catalyst::EngineLoader->new({
3247 application_name => $class,
3248 (defined $requested_engine
3249 ? (catalyst_engine_class => $requested_engine) : ()),
3254 $class->engine_loader->catalyst_engine_class;
3258 my ($class, $requested_engine) = @_;
3261 my $loader = $class->engine_loader;
3263 if (!$loader || $requested_engine) {
3264 $loader = Catalyst::EngineLoader->new({
3265 application_name => $class,
3266 (defined $requested_engine
3267 ? (requested_engine => $requested_engine) : ()),
3270 $class->engine_loader($loader);
3273 $loader->catalyst_engine_class;
3276 # Don't really setup_engine -- see _setup_psgi_app for explanation.
3277 return if $class->loading_psgi_file;
3279 load_class($engine);
3281 if ($ENV{MOD_PERL}) {
3282 my $apache = $class->engine_loader->auto;
3284 my $meta = find_meta($class);
3285 my $was_immutable = $meta->is_immutable;
3286 my %immutable_options = $meta->immutable_options;
3287 $meta->make_mutable if $was_immutable;
3289 $meta->add_method(handler => sub {
3291 my $psgi_app = $class->_finalized_psgi_app;
3292 $apache->call_app($r, $psgi_app);
3295 $meta->make_immutable(%immutable_options) if $was_immutable;
3298 $class->engine( $engine->new );
3303 ## This exists just to supply a prebuild psgi app for mod_perl and for the
3304 ## build in server support (back compat support for pre psgi port behavior).
3305 ## This is so that we don't build a new psgi app for each request when using
3306 ## the mod_perl handler or the built in servers (http and fcgi, etc).
3308 sub _finalized_psgi_app {
3311 unless ($app->_psgi_app) {
3312 my $psgi_app = $app->_setup_psgi_app;
3313 $app->_psgi_app($psgi_app);
3316 return $app->_psgi_app;
3319 ## Look for a psgi file like 'myapp_web.psgi' (if the app is MyApp::Web) in the
3320 ## home directory and load that and return it (just assume it is doing the
3321 ## right thing :) ). If that does not exist, call $app->psgi_app, wrap that
3322 ## in default_middleware and return it ( this is for backward compatibility
3323 ## with pre psgi port behavior ).
3325 sub _setup_psgi_app {
3328 for my $home (Path::Class::Dir->new($app->config->{home})) {
3329 my $psgi_file = $home->file(
3330 Catalyst::Utils::appprefix($app) . '.psgi',
3333 next unless -e $psgi_file;
3335 # If $psgi_file calls ->setup_engine, it's doing so to load
3336 # Catalyst::Engine::PSGI. But if it does that, we're only going to
3337 # throw away the loaded PSGI-app and load the 5.9 Catalyst::Engine
3338 # anyway. So set a flag (ick) that tells setup_engine not to populate
3339 # $c->engine or do any other things we might regret.
3341 $app->loading_psgi_file(1);
3342 my $psgi_app = Plack::Util::load_psgi($psgi_file);
3343 $app->loading_psgi_file(0);
3346 unless $app->engine_loader->needs_psgi_engine_compat_hack;
3349 Found a legacy Catalyst::Engine::PSGI .psgi file at ${psgi_file}.
3351 Its content has been ignored. Please consult the Catalyst::Upgrading
3352 documentation on how to upgrade from Catalyst::Engine::PSGI.
3356 return $app->apply_default_middlewares($app->psgi_app);
3359 =head2 $c->apply_default_middlewares
3361 Adds the following L<Plack> middlewares to your application, since they are
3362 useful and commonly needed:
3364 L<Plack::Middleware::LighttpdScriptNameFix> (if you are using Lighttpd),
3365 L<Plack::Middleware::IIS6ScriptNameFix> (always applied since this middleware
3366 is smart enough to conditionally apply itself).
3368 We will also automatically add L<Plack::Middleware::ReverseProxy> if we notice
3369 that your HTTP $env variable C<REMOTE_ADDR> is '127.0.0.1'. This is usually
3370 an indication that your server is running behind a proxy frontend. However in
3371 2014 this is often not the case. We preserve this code for backwards compatibility
3372 however I B<highly> recommend that if you are running the server behind a front
3373 end proxy that you clearly indicate so with the C<using_frontend_proxy> configuration
3374 setting to true for your environment configurations that run behind a proxy. This
3375 way if you change your front end proxy address someday your code would inexplicably
3376 stop working as expected.
3378 Additionally if we detect we are using Nginx, we add a bit of custom middleware
3379 to solve some problems with the way that server handles $ENV{PATH_INFO} and
3382 Please B<NOTE> that if you do use C<using_frontend_proxy> the middleware is now
3383 adding via C<registered_middleware> rather than this method.
3385 If you are using Lighttpd or IIS6 you may wish to apply these middlewares. In
3386 general this is no longer a common case but we have this here for backward
3392 sub apply_default_middlewares {
3393 my ($app, $psgi_app) = @_;
3395 # Don't add this conditional IF we are explicitly saying we want the
3396 # frontend proxy support. We don't need it here since if that is the
3397 # case it will be always loaded in the default_middleware.
3399 unless($app->config->{using_frontend_proxy}) {
3400 $psgi_app = Plack::Middleware::Conditional->wrap(
3402 builder => sub { Plack::Middleware::ReverseProxy->wrap($_[0]) },
3405 return if $app->config->{ignore_frontend_proxy};
3406 return $env->{REMOTE_ADDR} eq '127.0.0.1';
3411 # If we're running under Lighttpd, swap PATH_INFO and SCRIPT_NAME
3412 # http://lists.scsys.co.uk/pipermail/catalyst/2006-June/008361.html
3413 $psgi_app = Plack::Middleware::Conditional->wrap(
3415 builder => sub { Plack::Middleware::LighttpdScriptNameFix->wrap($_[0]) },
3418 return unless $env->{SERVER_SOFTWARE} && $env->{SERVER_SOFTWARE} =~ m!lighttpd[-/]1\.(\d+\.\d+)!;
3419 return unless $1 < 4.23;
3424 # we're applying this unconditionally as the middleware itself already makes
3425 # sure it doesn't fuck things up if it's not running under one of the right
3427 $psgi_app = Plack::Middleware::IIS6ScriptNameFix->wrap($psgi_app);
3429 # And another IIS issue, this time with IIS7.
3430 $psgi_app = Plack::Middleware::Conditional->wrap(
3432 builder => sub { Plack::Middleware::IIS7KeepAliveFix->wrap($_[0]) },
3435 return $env->{SERVER_SOFTWARE} && $env->{SERVER_SOFTWARE} =~ m!IIS/7\.[0-9]!;
3442 =head2 App->psgi_app
3446 Returns a PSGI application code reference for the catalyst application
3447 C<$c>. This is the bare application created without the C<apply_default_middlewares>
3448 method called. We do however apply C<registered_middleware> since those are
3449 integral to how L<Catalyst> functions. Also, unlike starting your application
3450 with a generated server script (via L<Catalyst::Devel> and C<catalyst.pl>) we do
3451 not attempt to return a valid L<PSGI> application using any existing C<${myapp}.psgi>
3452 scripts in your $HOME directory.
3454 B<NOTE> C<apply_default_middlewares> was originally created when the first PSGI
3455 port was done for v5.90000. These are middlewares that are added to achieve
3456 backward compatibility with older applications. If you start your application
3457 using one of the supplied server scripts (generated with L<Catalyst::Devel> and
3458 the project skeleton script C<catalyst.pl>) we apply C<apply_default_middlewares>
3459 automatically. This was done so that pre and post PSGI port applications would
3462 This is what you want to be using to retrieve the PSGI application code
3463 reference of your Catalyst application for use in a custom F<.psgi> or in your
3464 own created server modules.
3468 *to_app = \&psgi_app;
3472 my $psgi = $app->engine->build_psgi_app($app);
3473 return $app->Catalyst::Utils::apply_registered_middleware($psgi);
3476 =head2 $c->setup_home
3478 Sets up the home directory.
3483 my ( $class, $home ) = @_;
3485 if ( my $env = Catalyst::Utils::env_value( $class, 'HOME' ) ) {
3489 $home ||= Catalyst::Utils::home($class);
3492 #I remember recently being scolded for assigning config values like this
3493 $class->config->{home} ||= $home;
3494 $class->config->{root} ||= Path::Class::Dir->new($home)->subdir('root');
3498 =head2 $c->setup_encoding
3500 Sets up the input/output encoding. See L<ENCODING>
3504 sub setup_encoding {
3506 if( exists($c->config->{encoding}) && !defined($c->config->{encoding}) ) {
3507 # Ok, so the user has explicitly said "I don't want encoding..."
3510 my $enc = defined($c->config->{encoding}) ?
3511 delete $c->config->{encoding} : 'UTF-8'; # not sure why we delete it... (JNAP)
3516 =head2 handle_unicode_encoding_exception
3518 Hook to let you customize how encoding errors are handled. By default
3519 we just throw an exception. Receives a hashref of debug information.
3522 $c->handle_unicode_encoding_exception({
3523 param_value => $value,
3525 encoding_step => 'params',
3530 sub handle_unicode_encoding_exception {
3531 my ( $self, $exception_ctx ) = @_;
3532 die $exception_ctx->{error_msg};
3535 # Some unicode helpers cargo culted from the old plugin. These could likely
3538 sub _handle_unicode_decoding {
3539 my ( $self, $value ) = @_;
3541 return unless defined $value;
3543 ## I think this mess is to support the old nested
3544 if ( ref $value eq 'ARRAY' ) {
3545 foreach ( @$value ) {
3546 $_ = $self->_handle_unicode_decoding($_);
3550 elsif ( ref $value eq 'HASH' ) {
3551 foreach (keys %$value) {
3552 my $encoded_key = $self->_handle_param_unicode_decoding($_);
3553 $value->{$encoded_key} = $self->_handle_unicode_decoding($value->{$_});
3555 # If the key was encoded we now have two (the original and current so
3556 # delete the original.
3557 delete $value->{$_} if $_ ne $encoded_key;
3562 return $self->_handle_param_unicode_decoding($value);
3566 sub _handle_param_unicode_decoding {
3567 my ( $self, $value ) = @_;
3568 return unless defined $value; # not in love with just ignoring undefs - jnap
3569 return $value if blessed($value); #don't decode when the value is an object.
3571 my $enc = $self->encoding;
3573 $enc->decode( $value, $self->_encode_check );
3576 $self->handle_unicode_encoding_exception({
3577 param_value => $value,
3579 encoding_step => 'params',
3584 =head2 $c->setup_log
3586 Sets up log by instantiating a L<Catalyst::Log|Catalyst::Log> object and
3587 passing it to C<log()>. Pass in a comma-delimited list of levels to set the
3590 This method also installs a C<debug> method that returns a true value into the
3591 catalyst subclass if the "debug" level is passed in the comma-delimited list,
3592 or if the C<$CATALYST_DEBUG> environment variable is set to a true value.
3594 Note that if the log has already been setup, by either a previous call to
3595 C<setup_log> or by a call such as C<< __PACKAGE__->log( MyLogger->new ) >>,
3596 that this method won't actually set up the log object.
3601 my ( $class, $levels ) = @_;
3604 $levels =~ s/^\s+//;
3605 $levels =~ s/\s+$//;
3606 my %levels = map { $_ => 1 } split /\s*,\s*/, $levels;
3608 my $env_debug = Catalyst::Utils::env_value( $class, 'DEBUG' );
3609 if ( defined $env_debug ) {
3610 $levels{debug} = 1 if $env_debug; # Ugly!
3611 delete($levels{debug}) unless $env_debug;
3614 unless ( $class->log ) {
3615 $class->log( Catalyst::Log->new(keys %levels) );
3618 if ( $levels{debug} ) {
3619 Class::MOP::get_metaclass_by_name($class)->add_method('debug' => sub { 1 });
3620 $class->log->debug('Debug messages enabled');
3624 =head2 $c->setup_plugins
3630 =head2 $c->setup_stats
3632 Sets up timing statistics class.
3637 my ( $class, $stats ) = @_;
3639 Catalyst::Utils::ensure_class_loaded($class->stats_class);
3641 my $env = Catalyst::Utils::env_value( $class, 'STATS' );
3642 if ( defined($env) ? $env : ($stats || $class->debug ) ) {
3643 Class::MOP::get_metaclass_by_name($class)->add_method('use_stats' => sub { 1 });
3644 $class->log->debug('Statistics enabled');
3649 =head2 $c->registered_plugins
3651 Returns a sorted list of the plugins which have either been stated in the
3654 If passed a given plugin name, it will report a boolean value indicating
3655 whether or not that plugin is loaded. A fully qualified name is required if
3656 the plugin name does not begin with C<Catalyst::Plugin::>.
3658 if ($c->registered_plugins('Some::Plugin')) {
3666 sub registered_plugins {
3668 return sort keys %{ $proto->_plugins } unless @_;
3670 return 1 if exists $proto->_plugins->{$plugin};
3671 return exists $proto->_plugins->{"Catalyst::Plugin::$plugin"};
3674 sub _register_plugin {
3675 my ( $proto, $plugin, $instant ) = @_;
3676 my $class = ref $proto || $proto;
3678 load_class( $plugin );
3679 $class->log->warn( "$plugin inherits from 'Catalyst::Component' - this is deprecated and will not work in 5.81" )
3680 if $plugin->isa( 'Catalyst::Component' );
3681 my $plugin_meta = Moose::Meta::Class->create($plugin);
3682 if (!$plugin_meta->has_method('new')
3683 && ( $plugin->isa('Class::Accessor::Fast') || $plugin->isa('Class::Accessor') ) ) {
3684 $plugin_meta->add_method('new', Moose::Object->meta->get_method('new'))
3686 if (!$instant && !$proto->_plugins->{$plugin}) {
3687 my $meta = Class::MOP::get_metaclass_by_name($class);
3688 $meta->superclasses($plugin, $meta->superclasses);
3690 $proto->_plugins->{$plugin} = 1;
3694 sub _default_plugins { return qw() }
3697 my ( $class, $plugins ) = @_;
3699 $class->_plugins( {} ) unless $class->_plugins;
3701 m/Unicode::Encoding/ ? do {
3703 'Unicode::Encoding plugin is auto-applied,'
3704 . ' please remove this from your appclass'
3705 . ' and make sure to define "encoding" config'
3707 unless (exists $class->config->{'encoding'}) {
3708 $class->config->{'encoding'} = 'UTF-8';
3713 push @$plugins, $class->_default_plugins;
3714 $plugins = Data::OptList::mkopt($plugins || []);
3717 [ Catalyst::Utils::resolve_namespace(
3718 $class . '::Plugin',
3719 'Catalyst::Plugin', $_->[0]
3725 for my $plugin ( reverse @plugins ) {
3726 load_class($plugin->[0], $plugin->[1]);
3727 my $meta = find_meta($plugin->[0]);
3728 next if $meta && $meta->isa('Moose::Meta::Role');
3730 $class->_register_plugin($plugin->[0]);
3734 map { $_->[0]->name, $_->[1] }
3735 grep { blessed($_->[0]) && $_->[0]->isa('Moose::Meta::Role') }
3736 map { [find_meta($_->[0]), $_->[1]] }
3739 Moose::Util::apply_all_roles(
3745 =head2 default_middleware
3747 Returns a list of instantiated PSGI middleware objects which is the default
3748 middleware that is active for this application (taking any configuration
3749 options into account, excluding your custom added middleware via the C<psgi_middleware>
3750 configuration option). You can override this method if you wish to change
3751 the default middleware (although do so at risk since some middleware is vital
3752 to application function.)
3754 The current default middleware list is:
3756 Catalyst::Middleware::Stash
3757 Plack::Middleware::HTTPExceptions
3758 Plack::Middleware::RemoveRedundantBody
3759 Plack::Middleware::FixMissingBodyInRedirect
3760 Plack::Middleware::ContentLength
3761 Plack::Middleware::MethodOverride
3762 Plack::Middleware::Head
3764 If the configuration setting C<using_frontend_proxy> is true we add:
3766 Plack::Middleware::ReverseProxy
3768 If the configuration setting C<using_frontend_proxy_path> is true we add:
3770 Plack::Middleware::ReverseProxyPath
3772 But B<NOTE> that L<Plack::Middleware::ReverseProxyPath> is not a dependency of the
3773 L<Catalyst> distribution so if you want to use this option you should add it to
3774 your project distribution file.
3776 These middlewares will be added at L</setup_middleware> during the
3777 L</setup> phase of application startup.
3781 sub default_middleware {
3784 Catalyst::Middleware::Stash->new,
3785 Plack::Middleware::HTTPExceptions->new,
3786 Plack::Middleware::RemoveRedundantBody->new,
3787 Plack::Middleware::FixMissingBodyInRedirect->new,
3788 Plack::Middleware::ContentLength->new,
3789 Plack::Middleware::MethodOverride->new,
3790 Plack::Middleware::Head->new);
3792 if($class->config->{using_frontend_proxy}) {
3793 push @mw, Plack::Middleware::ReverseProxy->new;
3796 if($class->config->{using_frontend_proxy_path}) {
3797 if(Class::Load::try_load_class('Plack::Middleware::ReverseProxyPath')) {
3798 push @mw, Plack::Middleware::ReverseProxyPath->new;
3800 $class->log->error("Cannot use configuration 'using_frontend_proxy_path' because 'Plack::Middleware::ReverseProxyPath' is not installed");
3807 =head2 registered_middlewares
3809 Read only accessor that returns an array of all the middleware in the order
3810 that they were added (which is the REVERSE of the order they will be applied).
3812 The values returned will be either instances of L<Plack::Middleware> or of a
3813 compatible interface, or a coderef, which is assumed to be inlined middleware
3815 =head2 setup_middleware (?@middleware)
3817 Read configuration information stored in configuration key C<psgi_middleware> or
3820 See under L</CONFIGURATION> information regarding C<psgi_middleware> and how
3821 to use it to enable L<Plack::Middleware>
3823 This method is automatically called during 'setup' of your application, so
3824 you really don't need to invoke it. However you may do so if you find the idea
3825 of loading middleware via configuration weird :). For example:
3831 __PACKAGE__->setup_middleware('Head');
3834 When we read middleware definitions from configuration, we reverse the list
3835 which sounds odd but is likely how you expect it to work if you have prior
3836 experience with L<Plack::Builder> or if you previously used the plugin
3837 L<Catalyst::Plugin::EnableMiddleware> (which is now considered deprecated)
3839 So basically your middleware handles an incoming request from the first
3840 registered middleware, down and handles the response from the last middleware
3845 sub registered_middlewares {
3847 if(my $middleware = $class->_psgi_middleware) {
3848 my @mw = ($class->default_middleware, @$middleware);
3850 if($class->config->{using_frontend_proxy}) {
3851 push @mw, Plack::Middleware::ReverseProxy->new;
3856 die "You cannot call ->registered_middlewares until middleware has been setup";
3860 sub setup_middleware {
3862 my @middleware_definitions;
3864 # If someone calls this method you can add middleware with args. However if its
3865 # called without an arg we need to setup the configuration middleware.
3867 @middleware_definitions = reverse(@_);
3869 @middleware_definitions = reverse(@{$class->config->{'psgi_middleware'}||[]})
3870 unless $class->finalized_default_middleware;
3871 $class->finalized_default_middleware(1); # Only do this once, just in case some people call setup over and over...
3874 my @middleware = ();
3875 while(my $next = shift(@middleware_definitions)) {
3877 if(Scalar::Util::blessed $next && $next->can('wrap')) {
3878 push @middleware, $next;
3879 } elsif(ref $next eq 'CODE') {
3880 push @middleware, $next;
3881 } elsif(ref $next eq 'HASH') {
3882 my $namespace = shift @middleware_definitions;
3883 my $mw = $class->Catalyst::Utils::build_middleware($namespace, %$next);
3884 push @middleware, $mw;
3886 die "I can't handle middleware definition ${\ref $next}";
3889 my $mw = $class->Catalyst::Utils::build_middleware($next);
3890 push @middleware, $mw;
3894 my @existing = @{$class->_psgi_middleware || []};
3895 $class->_psgi_middleware([@middleware,@existing,]);
3898 =head2 registered_data_handlers
3900 A read only copy of registered Data Handlers returned as a Hash, where each key
3901 is a content type and each value is a subref that attempts to decode that content
3904 =head2 setup_data_handlers (?@data_handler)
3906 Read configuration information stored in configuration key C<data_handlers> or
3909 See under L</CONFIGURATION> information regarding C<data_handlers>.
3911 This method is automatically called during 'setup' of your application, so
3912 you really don't need to invoke it.
3914 =head2 default_data_handlers
3916 Default Data Handlers that come bundled with L<Catalyst>. Currently there are
3917 only two default data handlers, for 'application/json' and an alternative to
3918 'application/x-www-form-urlencoded' which supposed nested form parameters via
3919 L<CGI::Struct> or via L<CGI::Struct::XS> IF you've installed it.
3921 The 'application/json' data handler is used to parse incoming JSON into a Perl
3922 data structure. It used either L<JSON::MaybeXS> or L<JSON>, depending on which
3923 is installed. This allows you to fail back to L<JSON:PP>, which is a Pure Perl
3924 JSON decoder, and has the smallest dependency impact.
3926 Because we don't wish to add more dependencies to L<Catalyst>, if you wish to
3927 use this new feature we recommend installing L<JSON> or L<JSON::MaybeXS> in
3928 order to get the best performance. You should add either to your dependency
3929 list (Makefile.PL, dist.ini, cpanfile, etc.)
3933 sub registered_data_handlers {
3935 if(my $data_handlers = $class->_data_handlers) {
3936 return %$data_handlers;
3938 $class->setup_data_handlers;
3939 return $class->registered_data_handlers;
3943 sub setup_data_handlers {
3944 my ($class, %data_handler_callbacks) = @_;
3945 %data_handler_callbacks = (
3946 %{$class->default_data_handlers},
3947 %{$class->config->{'data_handlers'}||+{}},
3948 %data_handler_callbacks);
3950 $class->_data_handlers(\%data_handler_callbacks);
3953 sub default_data_handlers {
3956 'application/x-www-form-urlencoded' => sub {
3957 my ($fh, $req) = @_;
3958 my $params = $req->_use_hash_multivalue ? $req->body_parameters->mixed : $req->body_parameters;
3959 Class::Load::load_first_existing_class('CGI::Struct::XS', 'CGI::Struct')
3960 ->can('build_cgi_struct')->($params);
3962 'application/json' => sub {
3963 my ($fh, $req) = @_;
3964 my $parser = Class::Load::load_first_existing_class('JSON::MaybeXS', 'JSON');
3968 $slurped = $fh->getline;
3969 $parser->can("decode_json")->($slurped); # decode_json does utf8 decoding for us
3970 } || Catalyst::Exception->throw(sprintf "Error Parsing POST '%s', Error: %s", (defined($slurped) ? $slurped : 'undef') ,$@);
3975 sub _handle_http_exception {
3976 my ( $self, $error ) = @_;
3978 !$self->config->{always_catch_http_exceptions}
3981 $error->can('as_psgi')
3982 || ( $error->can('code')
3983 && $error->code =~ m/^[1-5][0-9][0-9]$/ )
3993 Returns an arrayref of the internal execution stack (actions that are
3994 currently executing).
3998 Returns the current timing statistics object. By default Catalyst uses
3999 L<Catalyst::Stats|Catalyst::Stats>, but can be set otherwise with
4000 L<< stats_class|/"$c->stats_class" >>.
4002 Even if L<< -Stats|/"-Stats" >> is not enabled, the stats object is still
4003 available. By enabling it with C< $c->stats->enabled(1) >, it can be used to
4004 profile explicitly, although MyApp.pm still won't profile nor output anything
4007 =head2 $c->stats_class
4009 Returns or sets the stats (timing statistics) class. L<Catalyst::Stats|Catalyst::Stats> is used by default.
4011 =head2 $app->stats_class_traits
4013 A arrayref of L<Moose::Role>s that are applied to the stats_class before creating it.
4015 =head2 $app->composed_stats_class
4017 this is the stats_class composed with any 'stats_class_traits'. You can
4018 name the full namespace of the role, or a namespace suffix, which will then
4019 be tried against the following standard namespace prefixes.
4021 $MyApp::TraitFor::Stats::$trait_suffix
4022 Catalyst::TraitFor::Stats::$trait_suffix
4024 So for example if you set:
4026 MyApp->stats_class_traits(['Foo']);
4028 We try each possible role in turn (and throw an error if none load)
4031 MyApp::TraitFor::Stats::Foo
4032 Catalyst::TraitFor::Stats::Foo
4034 The namespace part 'TraitFor::Stats' was choosen to assist in backwards
4035 compatibility with L<CatalystX::RoleApplicator> which previously provided
4036 these features in a stand alone package.
4038 =head2 $c->use_stats
4040 Returns 1 when L<< stats collection|/"-Stats" >> is enabled.
4042 Note that this is a static method, not an accessor and should be overridden
4043 by declaring C<sub use_stats { 1 }> in your MyApp.pm, not by calling C<< $c->use_stats(1) >>.
4050 =head2 $c->write( $data )
4052 Writes $data to the output stream. When using this method directly, you
4053 will need to manually set the C<Content-Length> header to the length of
4054 your output data, if known.
4061 # Finalize headers if someone manually writes output (for compat)
4062 $c->finalize_headers;
4064 return $c->response->write( @_ );
4069 Returns the Catalyst version number. Mostly useful for "powered by"
4070 messages in template systems.
4074 sub version { return $Catalyst::VERSION }
4076 =head1 CONFIGURATION
4078 There are a number of 'base' config variables which can be set:
4084 C<always_catch_http_exceptions> - As of version 5.90060 Catalyst
4085 rethrows errors conforming to the interface described by
4086 L<Plack::Middleware::HTTPExceptions> and lets the middleware deal with it.
4087 Set true to get the deprecated behaviour and have Catalyst catch HTTP exceptions.
4091 C<default_model> - The default model picked if you say C<< $c->model >>. See L<< /$c->model($name) >>.
4095 C<default_view> - The default view to be rendered or returned when C<< $c->view >> is called. See L<< /$c->view($name) >>.
4099 C<disable_component_resolution_regex_fallback> - Turns
4100 off the deprecated component resolution functionality so
4101 that if any of the component methods (e.g. C<< $c->controller('Foo') >>)
4102 are called then regex search will not be attempted on string values and
4103 instead C<undef> will be returned.
4107 C<home> - The application home directory. In an uninstalled application,
4108 this is the top level application directory. In an installed application,
4109 this will be the directory containing C<< MyApp.pm >>.
4113 C<ignore_frontend_proxy> - See L</PROXY SUPPORT>
4117 C<name> - The name of the application in debug messages and the debug and
4122 C<parse_on_demand> - The request body (for example file uploads) will not be parsed
4123 until it is accessed. This allows you to (for example) check authentication (and reject
4124 the upload) before actually receiving all the data. See L</ON-DEMAND PARSER>
4128 C<root> - The root directory for templates. Usually this is just a
4129 subdirectory of the home directory, but you can set it to change the
4130 templates to a different directory.
4134 C<search_extra> - Array reference passed to Module::Pluggable to for additional
4135 namespaces from which components will be loaded (and constructed and stored in
4136 C<< $c->components >>).
4140 C<show_internal_actions> - If true, causes internal actions such as C<< _DISPATCH >>
4141 to be shown in hit debug tables in the test server.
4145 C<use_request_uri_for_path> - Controls if the C<REQUEST_URI> or C<PATH_INFO> environment
4146 variable should be used for determining the request path.
4148 Most web server environments pass the requested path to the application using environment variables,
4149 from which Catalyst has to reconstruct the request base (i.e. the top level path to / in the application,
4150 exposed as C<< $c->request->base >>) and the request path below that base.
4152 There are two methods of doing this, both of which have advantages and disadvantages. Which method is used
4153 is determined by the C<< $c->config(use_request_uri_for_path) >> setting (which can either be true or false).
4157 =item use_request_uri_for_path => 0
4159 This is the default (and the) traditional method that Catalyst has used for determining the path information.
4160 The path is generated from a combination of the C<PATH_INFO> and C<SCRIPT_NAME> environment variables.
4161 The allows the application to behave correctly when C<mod_rewrite> is being used to redirect requests
4162 into the application, as these variables are adjusted by mod_rewrite to take account for the redirect.
4164 However this method has the major disadvantage that it is impossible to correctly decode some elements
4165 of the path, as RFC 3875 says: "C<< Unlike a URI path, the PATH_INFO is not URL-encoded, and cannot
4166 contain path-segment parameters. >>" This means PATH_INFO is B<always> decoded, and therefore Catalyst
4167 can't distinguish / vs %2F in paths (in addition to other encoded values).
4169 =item use_request_uri_for_path => 1
4171 This method uses the C<REQUEST_URI> and C<SCRIPT_NAME> environment variables. As C<REQUEST_URI> is never
4172 decoded, this means that applications using this mode can correctly handle URIs including the %2F character
4173 (i.e. with C<AllowEncodedSlashes> set to C<On> in Apache).
4175 Given that this method of path resolution is provably more correct, it is recommended that you use
4176 this unless you have a specific need to deploy your application in a non-standard environment, and you are
4177 aware of the implications of not being able to handle encoded URI paths correctly.
4179 However it also means that in a number of cases when the app isn't installed directly at a path, but instead
4180 is having paths rewritten into it (e.g. as a .cgi/fcgi in a public_html directory, with mod_rewrite in a
4181 .htaccess file, or when SSI is used to rewrite pages into the app, or when sub-paths of the app are exposed
4182 at other URIs than that which the app is 'normally' based at with C<mod_rewrite>), the resolution of
4183 C<< $c->request->base >> will be incorrect.
4189 C<using_frontend_proxy> - See L</PROXY SUPPORT>.
4193 C<using_frontend_proxy_path> - Enabled L<Plack::Middleware::ReverseProxyPath> on your application (if
4194 installed, otherwise log an error). This is useful if your application is not running on the
4195 'root' (or /) of your host server. B<NOTE> if you use this feature you should add the required
4196 middleware to your project dependency list since its not automatically a dependency of L<Catalyst>.
4197 This has been done since not all people need this feature and we wish to restrict the growth of
4198 L<Catalyst> dependencies.
4202 C<encoding> - See L</ENCODING>
4204 This now defaults to 'UTF-8'. You my turn it off by setting this configuration
4209 C<abort_chain_on_error_fix>
4211 When there is an error in an action chain, the default behavior is to continue
4212 processing the remaining actions and then catch the error upon chain end. This
4213 can lead to running actions when the application is in an unexpected state. If
4214 you have this issue, setting this config value to true will promptly exit a
4215 chain when there is an error raised in any action (thus terminating the chain
4220 __PACKAGE__->config(abort_chain_on_error_fix => 1);
4222 In the future this might become the default behavior.
4226 C<use_hash_multivalue_in_request>
4228 In L<Catalyst::Request> the methods C<query_parameters>, C<body_parametes>
4229 and C<parameters> return a hashref where values might be scalar or an arrayref
4230 depending on the incoming data. In many cases this can be undesirable as it
4231 leads one to writing defensive code like the following:
4233 my ($val) = ref($c->req->parameters->{a}) ?
4234 @{$c->req->parameters->{a}} :
4235 $c->req->parameters->{a};
4237 Setting this configuration item to true will make L<Catalyst> populate the
4238 attributes underlying these methods with an instance of L<Hash::MultiValue>
4239 which is used by L<Plack::Request> and others to solve this very issue. You
4240 may prefer this behavior to the default, if so enable this option (be warned
4241 if you enable it in a legacy application we are not sure if it is completely
4242 backwardly compatible).
4246 C<skip_complex_post_part_handling>
4248 When creating body parameters from a POST, if we run into a multpart POST
4249 that does not contain uploads, but instead contains inlined complex data
4250 (very uncommon) we cannot reliably convert that into field => value pairs. So
4251 instead we create an instance of L<Catalyst::Request::PartData>. If this causes
4252 issue for you, you can disable this by setting C<skip_complex_post_part_handling>
4253 to true (default is false).
4257 C<skip_body_param_unicode_decoding>
4259 Generally we decode incoming POST params based on your declared encoding (the
4260 default for this is to decode UTF-8). If this is causing you trouble and you
4261 do not wish to turn all encoding support off (with the C<encoding> configuration
4262 parameter) you may disable this step atomically by setting this configuration
4267 C<do_not_decode_query>
4269 If true, then do not try to character decode any wide characters in your
4270 request URL query or keywords. Most readings of the relevent specifications
4271 suggest these should be UTF-* encoded, which is the default that L<Catalyst>
4272 will use, hwoever if you are creating a lot of URLs manually or have external
4273 evil clients, this might cause you trouble. If you find the changes introduced
4274 in Catalyst version 5.90080+ break some of your query code, you may disable
4275 the UTF-8 decoding globally using this configuration.
4277 This setting takes precedence over C<default_query_encoding> and
4278 C<decode_query_using_global_encoding>
4282 C<default_query_encoding>
4284 By default we decode query and keywords in your request URL using UTF-8, which
4285 is our reading of the relevent specifications. This setting allows one to
4286 specify a fixed value for how to decode your query. You might need this if
4287 you are doing a lot of custom encoding of your URLs and not using UTF-8.
4289 This setting take precedence over C<decode_query_using_global_encoding>.
4293 C<decode_query_using_global_encoding>
4295 Setting this to true will default your query decoding to whatever your
4296 general global encoding is (the default is UTF-8).
4300 C<use_chained_args_0_special_case>
4302 In older versions of Catalyst, when more than one action matched the same path
4303 AND all those matching actions declared Args(0), we'd break the tie by choosing
4304 the first action defined. We now normalized how Args(0) works so that it
4305 follows the same rule as Args(N), which is to say when we need to break a tie
4306 we choose the LAST action defined. If this breaks your code and you don't
4307 have time to update to follow the new normalized approach, you may set this
4308 value to true and it will globally revert to the original chaining behavior.
4312 C<psgi_middleware> - See L<PSGI MIDDLEWARE>.
4316 C<data_handlers> - See L<DATA HANDLERS>.
4320 C<stats_class_traits>
4322 An arrayref of L<Moose::Role>s that get componsed into your stats class.
4326 C<request_class_traits>
4328 An arrayref of L<Moose::Role>s that get componsed into your request class.
4332 C<response_class_traits>
4334 An arrayref of L<Moose::Role>s that get componsed into your response class.
4338 C<inject_components>
4340 A Hashref of L<Catalyst::Component> subclasses that are 'injected' into configuration.
4344 inject_components => {
4345 'Controller::Err' => { from_component => 'Local::Controller::Errors' },
4346 'Model::Zoo' => { from_component => 'Local::Model::Foo' },
4347 'Model::Foo' => { from_component => 'Local::Model::Foo', roles => ['TestRole'] },
4349 'Controller::Err' => { a => 100, b=>200, namespace=>'error' },
4350 'Model::Zoo' => { a => 2 },
4351 'Model::Foo' => { a => 100 },
4354 Generally L<Catalyst> looks for components in your Model/View or Controller directories.
4355 However for cases when you which to use an existing component and you don't need any
4356 customization (where for when you can apply a role to customize it) you may inject those
4357 components into your application. Please note any configuration should be done 'in the
4358 normal way', with a key under configuration named after the component affix, as in the
4361 Using this type of injection allows you to construct significant amounts of your application
4362 with only configuration!. This may or may not lead to increased code understanding.
4364 Please not you may also call the ->inject_components application method as well, although
4365 you must do so BEFORE setup.
4371 Generally when you throw an exception inside an Action (or somewhere in
4372 your stack, such as in a model that an Action is calling) that exception
4373 is caught by Catalyst and unless you either catch it yourself (via eval
4374 or something like L<Try::Tiny> or by reviewing the L</error> stack, it
4375 will eventually reach L</finalize_errors> and return either the debugging
4376 error stack page, or the default error page. However, if your exception
4377 can be caught by L<Plack::Middleware::HTTPExceptions>, L<Catalyst> will
4378 instead rethrow it so that it can be handled by that middleware (which
4379 is part of the default middleware). For example this would allow
4381 use HTTP::Throwable::Factory 'http_throw';
4383 sub throws_exception :Local {
4384 my ($self, $c) = @_;
4386 http_throw(SeeOther => { location =>
4387 $c->uri_for($self->action_for('redirect')) });
4391 =head1 INTERNAL ACTIONS
4393 Catalyst uses internal actions like C<_DISPATCH>, C<_BEGIN>, C<_AUTO>,
4394 C<_ACTION>, and C<_END>. These are by default not shown in the private
4395 action table, but you can make them visible with a config parameter.
4397 MyApp->config(show_internal_actions => 1);
4399 =head1 ON-DEMAND PARSER
4401 The request body is usually parsed at the beginning of a request,
4402 but if you want to handle input yourself, you can enable on-demand
4403 parsing with a config parameter.
4405 MyApp->config(parse_on_demand => 1);
4407 =head1 PROXY SUPPORT
4409 Many production servers operate using the common double-server approach,
4410 with a lightweight frontend web server passing requests to a larger
4411 backend server. An application running on the backend server must deal
4412 with two problems: the remote user always appears to be C<127.0.0.1> and
4413 the server's hostname will appear to be C<localhost> regardless of the
4414 virtual host that the user connected through.
4416 Catalyst will automatically detect this situation when you are running
4417 the frontend and backend servers on the same machine. The following
4418 changes are made to the request.
4420 $c->req->address is set to the user's real IP address, as read from
4421 the HTTP X-Forwarded-For header.
4423 The host value for $c->req->base and $c->req->uri is set to the real
4424 host, as read from the HTTP X-Forwarded-Host header.
4426 Additionally, you may be running your backend application on an insecure
4427 connection (port 80) while your frontend proxy is running under SSL. If there
4428 is a discrepancy in the ports, use the HTTP header C<X-Forwarded-Port> to
4429 tell Catalyst what port the frontend listens on. This will allow all URIs to
4430 be created properly.
4432 In the case of passing in:
4434 X-Forwarded-Port: 443
4436 All calls to C<uri_for> will result in an https link, as is expected.
4438 Obviously, your web server must support these headers for this to work.
4440 In a more complex server farm environment where you may have your
4441 frontend proxy server(s) on different machines, you will need to set a
4442 configuration option to tell Catalyst to read the proxied data from the
4445 MyApp->config(using_frontend_proxy => 1);
4447 If you do not wish to use the proxy support at all, you may set:
4449 MyApp->config(ignore_frontend_proxy => 0);
4451 =head2 Note about psgi files
4453 Note that if you supply your own .psgi file, calling
4454 C<< MyApp->psgi_app(@_); >>, then B<this will not happen automatically>.
4456 You either need to apply L<Plack::Middleware::ReverseProxy> yourself
4457 in your psgi, for example:
4460 enable "Plack::Middleware::ReverseProxy";
4464 This will unconditionally add the ReverseProxy support, or you need to call
4465 C<< $app = MyApp->apply_default_middlewares($app) >> (to conditionally
4466 apply the support depending upon your config).
4468 See L<Catalyst::PSGI> for more information.
4470 =head1 THREAD SAFETY
4472 Catalyst has been tested under Apache 2's threading C<mpm_worker>,
4473 C<mpm_winnt>, and the standalone forking HTTP server on Windows. We
4474 believe the Catalyst core to be thread-safe.
4476 If you plan to operate in a threaded environment, remember that all other
4477 modules you are using must also be thread-safe. Some modules, most notably
4478 L<DBD::SQLite>, are not thread-safe.
4480 =head1 DATA HANDLERS
4482 The L<Catalyst::Request> object uses L<HTTP::Body> to populate 'classic' HTML
4483 form parameters and URL search query fields. However it has become common
4484 for various alternative content types to be PUT or POSTed to your controllers
4485 and actions. People working on RESTful APIs, or using AJAX often use JSON,
4486 XML and other content types when communicating with an application server. In
4487 order to better support this use case, L<Catalyst> defines a global configuration
4488 option, C<data_handlers>, which lets you associate a content type with a coderef
4489 that parses that content type into something Perl can readily access.
4496 __PACKAGE__->config(
4498 'application/json' => sub { local $/; decode_json $_->getline },
4500 ## Any other configuration.
4505 By default L<Catalyst> comes with a generic JSON data handler similar to the
4506 example given above, which uses L<JSON::Maybe> to provide either L<JSON::PP>
4507 (a pure Perl, dependency free JSON parser) or L<Cpanel::JSON::XS> if you have
4508 it installed (if you want the faster XS parser, add it to you project Makefile.PL
4509 or dist.ini, cpanfile, etc.)
4511 The C<data_handlers> configuration is a hashref whose keys are HTTP Content-Types
4512 (matched against the incoming request type using a regexp such as to be case
4513 insensitive) and whose values are coderefs that receive a localized version of
4514 C<$_> which is a filehandle object pointing to received body.
4516 This feature is considered an early access release and we reserve the right
4517 to alter the interface in order to provide a performant and secure solution to
4518 alternative request body content. Your reports welcomed!
4520 =head1 PSGI MIDDLEWARE
4522 You can define middleware, defined as L<Plack::Middleware> or a compatible
4523 interface in configuration. Your middleware definitions are in the form of an
4524 arrayref under the configuration key C<psgi_middleware>. Here's an example
4525 with details to follow:
4530 use Plack::Middleware::StackTrace;
4532 my $stacktrace_middleware = Plack::Middleware::StackTrace->new;
4534 __PACKAGE__->config(
4535 'psgi_middleware', [
4538 $stacktrace_middleware,
4539 'Session' => {store => 'File'},
4544 $env->{myapp.customkey} = 'helloworld';
4553 So the general form is:
4555 __PACKAGE__->config(psgi_middleware => \@middleware_definitions);
4557 Where C<@middleware> is one or more of the following, applied in the REVERSE of
4558 the order listed (to make it function similarly to L<Plack::Builder>:
4560 Alternatively, you may also define middleware by calling the L</setup_middleware>
4567 __PACKAGE__->setup_middleware( \@middleware_definitions);
4570 In the case where you do both (use 'setup_middleware' and configuration) the
4571 package call to setup_middleware will be applied earlier (in other words its
4572 middleware will wrap closer to the application). Keep this in mind since in
4573 some cases the order of middleware is important.
4575 The two approaches are not exclusive.
4579 =item Middleware Object
4581 An already initialized object that conforms to the L<Plack::Middleware>
4584 my $stacktrace_middleware = Plack::Middleware::StackTrace->new;
4586 __PACKAGE__->config(
4587 'psgi_middleware', [
4588 $stacktrace_middleware,
4594 A coderef that is an inlined middleware:
4596 __PACKAGE__->config(
4597 'psgi_middleware', [
4602 if($env->{PATH_INFO} =~m/forced/) {
4604 ->new(file=>TestApp->path_to(qw/share static forced.txt/))
4607 return $app->($env);
4617 We assume the scalar refers to a namespace after normalizing it using the
4620 (1) If the scalar is prefixed with a "+" (as in C<+MyApp::Foo>) then the full string
4621 is assumed to be 'as is', and we just install and use the middleware.
4623 (2) If the scalar begins with "Plack::Middleware" or your application namespace
4624 (the package name of your Catalyst application subclass), we also assume then
4625 that it is a full namespace, and use it.
4627 (3) Lastly, we then assume that the scalar is a partial namespace, and attempt to
4628 resolve it first by looking for it under your application namespace (for example
4629 if you application is "MyApp::Web" and the scalar is "MyMiddleware", we'd look
4630 under "MyApp::Web::Middleware::MyMiddleware") and if we don't find it there, we
4631 will then look under the regular L<Plack::Middleware> namespace (i.e. for the
4632 previous we'd try "Plack::Middleware::MyMiddleware"). We look under your application
4633 namespace first to let you 'override' common L<Plack::Middleware> locally, should
4634 you find that a good idea.
4640 __PACKAGE__->config(
4641 'psgi_middleware', [
4642 'Debug', ## MyAppWeb::Middleware::Debug->wrap or Plack::Middleware::Debug->wrap
4643 'Plack::Middleware::Stacktrace', ## Plack::Middleware::Stacktrace->wrap
4644 '+MyApp::Custom', ## MyApp::Custom->wrap
4648 =item a scalar followed by a hashref
4650 Just like the previous, except the following C<HashRef> is used as arguments
4651 to initialize the middleware object.
4653 __PACKAGE__->config(
4654 'psgi_middleware', [
4655 'Session' => {store => 'File'},
4660 Please see L<PSGI> for more on middleware.
4664 Starting in L<Catalyst> version 5.90080 encoding is automatically enabled
4665 and set to encode all body responses to UTF8 when possible and applicable.
4666 Following is documentation on this process. If you are using an older
4667 version of L<Catalyst> you should review documentation for that version since
4670 By default encoding is now 'UTF-8'. You may turn it off by setting
4671 the encoding configuration to undef.
4673 MyApp->config(encoding => undef);
4675 This is recommended for temporary backwards compatibility only.
4677 Encoding is automatically applied when the content-type is set to
4678 a type that can be encoded. Currently we encode when the content type
4679 matches the following regular expression:
4681 $content_type =~ /^text|xml$|javascript$/
4683 Encoding is set on the application, but it is copied to the context object
4684 so that you can override it on a request basis.
4686 Be default we don't automatically encode 'application/json' since the most
4687 common approaches to generating this type of response (Either via L<Catalyst::View::JSON>
4688 or L<Catalyst::Action::REST>) will do so already and we want to avoid double
4691 If you are producing JSON response in an unconventional manner (such
4692 as via a template or manual strings) you should perform the UTF8 encoding
4693 manually as well such as to conform to the JSON specification.
4695 NOTE: We also examine the value of $c->response->content_encoding. If
4696 you set this (like for example 'gzip', and manually gzipping the body)
4697 we assume that you have done all the necessary encoding yourself, since
4698 we cannot encode the gzipped contents. If you use a plugin like
4699 L<Catalyst::Plugin::Compress> you need to update to a modern version in order
4700 to have this function correctly with the new UTF8 encoding code, or you
4701 can use L<Plack::Middleware::Deflater> or (probably best) do your compression on
4710 Returns an instance of an C<Encode> encoding
4712 print $c->encoding->name
4714 =item handle_unicode_encoding_exception ($exception_context)
4716 Method called when decoding process for a request fails.
4718 An C<$exception_context> hashref is provided to allow you to override the
4719 behaviour of your application when given data with incorrect encodings.
4721 The default method throws exceptions in the case of invalid request parameters
4722 (resulting in a 500 error), but ignores errors in upload filenames.
4724 The keys passed in the C<$exception_context> hash are:
4730 The value which was not able to be decoded.
4734 The exception received from L<Encode>.
4738 What type of data was being decoded. Valid values are (currently)
4739 C<params> - for request parameters / arguments / captures
4740 and C<uploads> - for request upload filenames.
4750 Join #catalyst on irc.perl.org.
4754 http://lists.scsys.co.uk/cgi-bin/mailman/listinfo/catalyst
4755 http://lists.scsys.co.uk/cgi-bin/mailman/listinfo/catalyst-dev
4759 http://catalyst.perl.org
4763 http://dev.catalyst.perl.org
4767 =head2 L<Task::Catalyst> - All you need to start with Catalyst
4769 =head2 L<Catalyst::Manual> - The Catalyst Manual
4771 =head2 L<Catalyst::Component>, L<Catalyst::Controller> - Base classes for components
4773 =head2 L<Catalyst::Engine> - Core engine
4775 =head2 L<Catalyst::Log> - Log class.
4777 =head2 L<Catalyst::Request> - Request object
4779 =head2 L<Catalyst::Response> - Response object
4781 =head2 L<Catalyst::Test> - The test suite.
4783 =head1 PROJECT FOUNDER
4785 sri: Sebastian Riedel <sri@cpan.org>
4791 acme: Leon Brocard <leon@astray.com>
4793 abraxxa: Alexander Hartmaier <abraxxa@cpan.org>
4795 andrewalker: André Walker <andre@cpan.org>
4799 Andrew Ford E<lt>A.Ford@ford-mason.co.ukE<gt>
4803 andyg: Andy Grundman <andy@hybridized.org>
4805 audreyt: Audrey Tang
4807 bricas: Brian Cassidy <bricas@cpan.org>
4809 Caelum: Rafael Kitover <rkitover@io.com>
4811 chansen: Christian Hansen
4813 chicks: Christopher Hicks
4815 Chisel Wright C<pause@herlpacker.co.uk>
4817 Danijel Milicevic C<me@danijel.de>
4819 davewood: David Schmidt <davewood@cpan.org>
4821 David Kamholz E<lt>dkamholz@cpan.orgE<gt>
4823 David Naughton, C<naughton@umn.edu>
4827 dhoss: Devin Austin <dhoss@cpan.org>
4829 dkubb: Dan Kubb <dan.kubb-cpan@onautopilot.com>
4833 dwc: Daniel Westermann-Clark <danieltwc@cpan.org>
4835 esskar: Sascha Kiefer
4837 fireartist: Carl Franks <cfranks@cpan.org>
4839 frew: Arthur Axel "fREW" Schmidt <frioux@gmail.com>
4841 gabb: Danijel Milicevic
4845 Gavin Henry C<ghenry@perl.me.uk>
4849 groditi: Guillermo Roditi <groditi@gmail.com>
4851 hobbs: Andrew Rodland <andrew@cleverdomain.org>
4853 ilmari: Dagfinn Ilmari Mannsåker <ilmari@ilmari.org>
4855 jcamacho: Juan Camacho
4857 jester: Jesse Sheidlower C<jester@panix.com>
4859 jhannah: Jay Hannah <jay@jays.net>
4865 jon: Jon Schutz <jjschutz@cpan.org>
4867 Jonathan Rockway C<< <jrockway@cpan.org> >>
4869 Kieren Diment C<kd@totaldatasolution.com>
4871 konobi: Scott McWhirter <konobi@cpan.org>
4873 marcus: Marcus Ramberg <mramberg@cpan.org>
4875 miyagawa: Tatsuhiko Miyagawa <miyagawa@bulknews.net>
4877 mgrimes: Mark Grimes <mgrimes@cpan.org>
4879 mst: Matt S. Trout <mst@shadowcatsystems.co.uk>
4883 naughton: David Naughton
4885 ningu: David Kamholz <dkamholz@cpan.org>
4887 nothingmuch: Yuval Kogman <nothingmuch@woobling.org>
4889 numa: Dan Sully <daniel@cpan.org>
4895 omega: Andreas Marienborg
4897 Oleg Kostyuk <cub.uanic@gmail.com>
4899 phaylon: Robert Sedlacek <phaylon@dunkelheit.at>
4901 rafl: Florian Ragwitz <rafl@debian.org>
4903 random: Roland Lammel <lammel@cpan.org>
4905 Robert Sedlacek C<< <rs@474.at> >>
4907 SpiceMan: Marcel Montes
4911 szbalint: Balint Szilakszi <szbalint@cpan.org>
4913 t0m: Tomas Doran <bobtfish@bobtfish.net>
4917 vanstyn: Henry Van Styn <vanstyn@cpan.org>
4919 Viljo Marrandi C<vilts@yahoo.com>
4921 Will Hawes C<info@whawes.co.uk>
4923 willert: Sebastian Willert <willert@cpan.org>
4925 wreis: Wallace Reis <wreis@cpan.org>
4927 Yuval Kogman, C<nothingmuch@woobling.org>
4929 rainboxx: Matthias Dietrich, C<perl@rainboxx.de>
4931 dd070: Dhaval Dhanani <dhaval070@gmail.com>
4933 Upasana <me@upasana.me>
4935 John Napiorkowski (jnap) <jjnapiork@cpan.org>
4939 Copyright (c) 2005-2015, the above named PROJECT FOUNDER and CONTRIBUTORS.
4943 This library is free software. You can redistribute it and/or modify it under
4944 the same terms as Perl itself.
4950 __PACKAGE__->meta->make_immutable;