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}||[]});
85 return $class->_composed_request_class ||
86 $class->_composed_request_class(Moose::Util::with_traits($class->request_class, @traits));
93 my $class = ref $self;
94 my $composed_response_class = $class->composed_response_class;
95 return $composed_response_class->new( $self->_build_response_constructor_args);
99 sub _build_response_constructor_args {
102 encoding => $_[0]->encoding,
106 sub composed_response_class {
108 my @traits = (@{$class->response_class_traits||[]}, @{$class->config->{response_class_traits}||[]});
109 return $class->_composed_response_class ||
110 $class->_composed_response_class(Moose::Util::with_traits($class->response_class, @traits));
113 has namespace => (is => 'rw');
115 sub depth { scalar @{ shift->stack || [] }; }
116 sub comp { shift->component(@_) }
119 my $self = shift; return $self->request(@_);
122 my $self = shift; return $self->response(@_);
125 # For backwards compatibility
126 sub finalize_output { shift->finalize_body(@_) };
131 our $RECURSION = 1000;
132 our $DETACH = Catalyst::Exception::Detach->new;
133 our $GO = Catalyst::Exception::Go->new;
135 #I imagine that very few of these really need to be class variables. if any.
136 #maybe we should just make them attributes with a default?
137 __PACKAGE__->mk_classdata($_)
138 for qw/components arguments dispatcher engine log dispatcher_class
139 engine_loader context_class request_class response_class stats_class
140 setup_finished _psgi_app loading_psgi_file run_options _psgi_middleware
141 _data_handlers _encoding _encode_check finalized_default_middleware
142 request_class_traits response_class_traits stats_class_traits
143 _composed_request_class _composed_response_class _composed_stats_class/;
145 __PACKAGE__->dispatcher_class('Catalyst::Dispatcher');
146 __PACKAGE__->request_class('Catalyst::Request');
147 __PACKAGE__->response_class('Catalyst::Response');
148 __PACKAGE__->stats_class('Catalyst::Stats');
150 sub composed_stats_class {
152 my @traits = (@{$class->stats_class_traits||[]}, @{$class->config->{stats_class_traits}||[]});
153 return $class->_composed_stats_class ||
154 $class->_composed_stats_class(Moose::Util::with_traits($class->stats_class, @traits));
157 __PACKAGE__->_encode_check(Encode::FB_CROAK | Encode::LEAVE_SRC);
159 # Remember to update this in Catalyst::Runtime as well!
160 our $VERSION = '5.90089_003';
161 $VERSION = eval $VERSION if $VERSION =~ /_/; # numify for warning-free dev releases
164 my ( $class, @arguments ) = @_;
166 # We have to limit $class to Catalyst to avoid pushing Catalyst upon every
168 return unless $class eq 'Catalyst';
170 my $caller = caller();
171 return if $caller eq 'main';
173 my $meta = Moose::Meta::Class->initialize($caller);
174 unless ( $caller->isa('Catalyst') ) {
175 my @superclasses = ($meta->superclasses, $class, 'Catalyst::Controller');
176 $meta->superclasses(@superclasses);
178 # Avoid possible C3 issues if 'Moose::Object' is already on RHS of MyApp
179 $meta->superclasses(grep { $_ ne 'Moose::Object' } $meta->superclasses);
181 unless( $meta->has_method('meta') ){
182 if ($Moose::VERSION >= 1.15) {
183 $meta->_add_meta_method('meta');
186 $meta->add_method(meta => sub { Moose::Meta::Class->initialize("${caller}") } );
190 $caller->arguments( [@arguments] );
194 sub _application { $_[0] }
200 Catalyst - The Elegant MVC Web Application Framework
203 <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>
204 <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>
205 <a href="http://cpants.cpanauthors.org/dist/Catalyst-Runtime"><img src="http://cpants.cpanauthors.org/dist/Catalyst-Runtime.png" alt='Kwalitee Score' /></a>
209 See the L<Catalyst::Manual> distribution for comprehensive
210 documentation and tutorials.
212 # Install Catalyst::Devel for helpers and other development tools
213 # use the helper to create a new application
216 # add models, views, controllers
217 script/myapp_create.pl model MyDatabase DBIC::Schema create=static dbi:SQLite:/path/to/db
218 script/myapp_create.pl view MyTemplate TT
219 script/myapp_create.pl controller Search
221 # built in testserver -- use -r to restart automatically on changes
222 # --help to see all available options
223 script/myapp_server.pl
225 # command line testing interface
226 script/myapp_test.pl /yada
229 use Catalyst qw/-Debug/; # include plugins here as well
231 ### In lib/MyApp/Controller/Root.pm (autocreated)
232 sub foo : Chained('/') Args() { # called for /foo, /foo/1, /foo/1/2, etc.
233 my ( $self, $c, @args ) = @_; # args are qw/1 2/ for /foo/1/2
234 $c->stash->{template} = 'foo.tt'; # set the template
235 # lookup something from db -- stash vars are passed to TT
237 $c->model('Database::Foo')->search( { country => $args[0] } );
238 if ( $c->req->params->{bar} ) { # access GET or POST parameters
239 $c->forward( 'bar' ); # process another action
240 # do something else after forward returns
244 # The foo.tt TT template can use the stash data from the database
245 [% WHILE (item = data.next) %]
249 # called for /bar/of/soap, /bar/of/soap/10, etc.
250 sub bar : Chained('/') PathPart('/bar/of/soap') Args() { ... }
252 # called after all actions are finished
254 my ( $self, $c ) = @_;
255 if ( scalar @{ $c->error } ) { ... } # handle errors
256 return if $c->res->body; # already have a response
257 $c->forward( 'MyApp::View::TT' ); # render template
260 See L<Catalyst::Manual::Intro> for additional information.
264 Catalyst is a modern framework for making web applications without the
265 pain usually associated with this process. This document is a reference
266 to the main Catalyst application. If you are a new user, we suggest you
267 start with L<Catalyst::Manual::Tutorial> or L<Catalyst::Manual::Intro>.
269 See L<Catalyst::Manual> for more documentation.
271 Catalyst plugins can be loaded by naming them as arguments to the "use
272 Catalyst" statement. Omit the C<Catalyst::Plugin::> prefix from the
273 plugin name, i.e., C<Catalyst::Plugin::My::Module> becomes
276 use Catalyst qw/My::Module/;
278 If your plugin starts with a name other than C<Catalyst::Plugin::>, you can
279 fully qualify the name by using a unary plus:
283 +Fully::Qualified::Plugin::Name
286 Special flags like C<-Debug> can also be specified as
287 arguments when Catalyst is loaded:
289 use Catalyst qw/-Debug My::Module/;
291 The position of plugins and flags in the chain is important, because
292 they are loaded in the order in which they appear.
294 The following flags are supported:
298 Enables debug output. You can also force this setting from the system
299 environment with CATALYST_DEBUG or <MYAPP>_DEBUG. The environment
300 settings override the application, with <MYAPP>_DEBUG having the highest
303 This sets the log level to 'debug' and enables full debug output on the
304 error screen. If you only want the latter, see L<< $c->debug >>.
308 Forces Catalyst to use a specific home directory, e.g.:
310 use Catalyst qw[-Home=/usr/mst];
312 This can also be done in the shell environment by setting either the
313 C<CATALYST_HOME> environment variable or C<MYAPP_HOME>; where C<MYAPP>
314 is replaced with the uppercased name of your application, any "::" in
315 the name will be replaced with underscores, e.g. MyApp::Web should use
316 MYAPP_WEB_HOME. If both variables are set, the MYAPP_HOME one will be used.
318 If none of these are set, Catalyst will attempt to automatically detect the
319 home directory. If you are working in a development environment, Catalyst
320 will try and find the directory containing either Makefile.PL, Build.PL,
321 dist.ini, or cpanfile. If the application has been installed into the system
322 (i.e. you have done C<make install>), then Catalyst will use the path to your
323 application module, without the .pm extension (e.g., /foo/MyApp if your
324 application was installed at /foo/MyApp.pm)
328 use Catalyst '-Log=warn,fatal,error';
330 Specifies a comma-delimited list of log levels.
334 Enables statistics collection and reporting.
336 use Catalyst qw/-Stats=1/;
338 You can also force this setting from the system environment with CATALYST_STATS
339 or <MYAPP>_STATS. The environment settings override the application, with
340 <MYAPP>_STATS having the highest priority.
342 Stats are also enabled if L<< debugging |/"-Debug" >> is enabled.
346 =head2 INFORMATION ABOUT THE CURRENT REQUEST
350 Returns a L<Catalyst::Action> object for the current action, which
351 stringifies to the action name. See L<Catalyst::Action>.
355 Returns the namespace of the current action, i.e., the URI prefix
356 corresponding to the controller of the current action. For example:
358 # in Controller::Foo::Bar
359 $c->namespace; # returns 'foo/bar';
365 Returns the current L<Catalyst::Request> object, giving access to
366 information about the current client request (including parameters,
367 cookies, HTTP headers, etc.). See L<Catalyst::Request>.
369 =head2 REQUEST FLOW HANDLING
371 =head2 $c->forward( $action [, \@arguments ] )
373 =head2 $c->forward( $class, $method, [, \@arguments ] )
375 This is one way of calling another action (method) in the same or
376 a different controller. You can also use C<< $self->my_method($c, @args) >>
377 in the same controller or C<< $c->controller('MyController')->my_method($c, @args) >>
378 in a different controller.
379 The main difference is that 'forward' uses some of the Catalyst request
380 cycle overhead, including debugging, which may be useful to you. On the
381 other hand, there are some complications to using 'forward', restrictions
382 on values returned from 'forward', and it may not handle errors as you prefer.
383 Whether you use 'forward' or not is up to you; it is not considered superior to
384 the other ways to call a method.
386 'forward' calls another action, by its private name. If you give a
387 class name but no method, C<process()> is called. You may also optionally
388 pass arguments in an arrayref. The action will receive the arguments in
389 C<@_> and C<< $c->req->args >>. Upon returning from the function,
390 C<< $c->req->args >> will be restored to the previous values.
392 Any data C<return>ed from the action forwarded to, will be returned by the
395 my $foodata = $c->forward('/foo');
396 $c->forward('index');
397 $c->forward(qw/Model::DBIC::Foo do_stuff/);
398 $c->forward('View::TT');
400 Note that L<< forward|/"$c->forward( $action [, \@arguments ] )" >> implies
401 an C<< eval { } >> around the call (actually
402 L<< execute|/"$c->execute( $class, $coderef )" >> does), thus rendering all
403 exceptions thrown by the called action non-fatal and pushing them onto
404 $c->error instead. If you want C<die> to propagate you need to do something
408 die join "\n", @{ $c->error } if @{ $c->error };
410 Or make sure to always return true values from your actions and write
413 $c->forward('foo') || return;
415 Another note is that C<< $c->forward >> always returns a scalar because it
416 actually returns $c->state which operates in a scalar context.
417 Thus, something like:
421 in an action that is forwarded to is going to return a scalar,
422 i.e. how many items are in that array, which is probably not what you want.
423 If you need to return an array then return a reference to it,
426 $c->stash->{array} = \@array;
428 and access it from the stash.
430 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.
434 sub forward { my $c = shift; no warnings 'recursion'; $c->dispatcher->forward( $c, @_ ) }
436 =head2 $c->detach( $action [, \@arguments ] )
438 =head2 $c->detach( $class, $method, [, \@arguments ] )
442 The same as L<< forward|/"$c->forward( $action [, \@arguments ] )" >>, but
443 doesn't return to the previous action when processing is finished.
445 When called with no arguments it escapes the processing chain entirely.
449 sub detach { my $c = shift; $c->dispatcher->detach( $c, @_ ) }
451 =head2 $c->visit( $action [, \@arguments ] )
453 =head2 $c->visit( $action [, \@captures, \@arguments ] )
455 =head2 $c->visit( $class, $method, [, \@arguments ] )
457 =head2 $c->visit( $class, $method, [, \@captures, \@arguments ] )
459 Almost the same as L<< forward|/"$c->forward( $action [, \@arguments ] )" >>,
460 but does a full dispatch, instead of just calling the new C<$action> /
461 C<< $class->$method >>. This means that C<begin>, C<auto> and the method
462 you go to are called, just like a new request.
464 In addition both C<< $c->action >> and C<< $c->namespace >> are localized.
465 This means, for example, that C<< $c->action >> methods such as
466 L<name|Catalyst::Action/name>, L<class|Catalyst::Action/class> and
467 L<reverse|Catalyst::Action/reverse> return information for the visited action
468 when they are invoked within the visited action. This is different from the
469 behavior of L<< forward|/"$c->forward( $action [, \@arguments ] )" >>, which
470 continues to use the $c->action object from the caller action even when
471 invoked from the called action.
473 C<< $c->stash >> is kept unchanged.
475 In effect, L<< visit|/"$c->visit( $action [, \@captures, \@arguments ] )" >>
476 allows you to "wrap" another action, just as it would have been called by
477 dispatching from a URL, while the analogous
478 L<< go|/"$c->go( $action [, \@captures, \@arguments ] )" >> allows you to
479 transfer control to another action as if it had been reached directly from a URL.
483 sub visit { my $c = shift; $c->dispatcher->visit( $c, @_ ) }
485 =head2 $c->go( $action [, \@arguments ] )
487 =head2 $c->go( $action [, \@captures, \@arguments ] )
489 =head2 $c->go( $class, $method, [, \@arguments ] )
491 =head2 $c->go( $class, $method, [, \@captures, \@arguments ] )
493 The relationship between C<go> and
494 L<< visit|/"$c->visit( $action [, \@captures, \@arguments ] )" >> is the same as
495 the relationship between
496 L<< forward|/"$c->forward( $class, $method, [, \@arguments ] )" >> and
497 L<< detach|/"$c->detach( $action [, \@arguments ] )" >>. Like C<< $c->visit >>,
498 C<< $c->go >> will perform a full dispatch on the specified action or method,
499 with localized C<< $c->action >> and C<< $c->namespace >>. Like C<detach>,
500 C<go> escapes the processing of the current request chain on completion, and
501 does not return to its cunless blessed $cunless blessed $caller.
503 @arguments are arguments to the final destination of $action. @captures are
504 arguments to the intermediate steps, if any, on the way to the final sub of
509 sub go { my $c = shift; $c->dispatcher->go( $c, @_ ) }
515 Returns the current L<Catalyst::Response> object, see there for details.
519 Returns a hashref to the stash, which may be used to store data and pass
520 it between components during a request. You can also set hash keys by
521 passing arguments. The stash is automatically sent to the view. The
522 stash is cleared at the end of a request; it cannot be used for
523 persistent storage (for this you must use a session; see
524 L<Catalyst::Plugin::Session> for a complete system integrated with
527 $c->stash->{foo} = $bar;
528 $c->stash( { moose => 'majestic', qux => 0 } );
529 $c->stash( bar => 1, gorch => 2 ); # equivalent to passing a hashref
531 # stash is automatically passed to the view for use in a template
532 $c->forward( 'MyApp::View::TT' );
534 The stash hash is currently stored in the PSGI C<$env> and is managed by
535 L<Catalyst::Middleware::Stash>. Since it's part of the C<$env> items in
536 the stash can be accessed in sub applications mounted under your main
537 L<Catalyst> application. For example if you delegate the response of an
538 action to another L<Catalyst> application, that sub application will have
539 access to all the stash keys of the main one, and if can of course add
540 more keys of its own. However those new keys will not 'bubble' back up
541 to the main application.
543 For more information the best thing to do is to review the test case:
544 t/middleware-stash.t in the distribution /t directory.
550 $c->log->error("You are requesting the stash but you don't have a context") unless blessed $c;
551 return Catalyst::Middleware::Stash::get_stash($c->req->env)->(@_);
556 =head2 $c->error($error, ...)
558 =head2 $c->error($arrayref)
560 Returns an arrayref containing error messages. If Catalyst encounters an
561 error while processing a request, it stores the error in $c->error. This
562 method should only be used to store fatal error messages.
564 my @error = @{ $c->error };
568 $c->error('Something bad happened');
570 Calling this will always return an arrayref (if there are no errors it
571 will be an empty arrayref.
578 my $error = ref $_[0] eq 'ARRAY' ? $_[0] : [@_];
579 croak @$error unless ref $c;
580 push @{ $c->{error} }, @$error;
582 elsif ( defined $_[0] ) { $c->{error} = undef }
583 return $c->{error} || [];
589 Contains the return value of the last executed action.
590 Note that << $c->state >> operates in a scalar context which means that all
591 values it returns are scalar.
593 =head2 $c->clear_errors
595 Clear errors. You probably don't want to clear the errors unless you are
596 implementing a custom error screen.
598 This is equivalent to running
609 =head2 $c->has_errors
611 Returns true if you have errors
615 sub has_errors { scalar(@{shift->error}) ? 1:0 }
617 =head2 $c->last_error
619 Returns the most recent error in the stack (the one most recently added...)
620 or nothing if there are no errors.
624 sub last_error { my ($err, @errs) = @{shift->error}; return $err }
628 shifts the most recently added error off the error stack and returns if. Returns
629 nothing if there are no more errors.
635 my ($err, @errors) = @{$self->error};
636 $self->{error} = \@errors;
640 sub _comp_search_prefixes {
642 return map $c->components->{ $_ }, $c->_comp_names_search_prefixes(@_);
645 # search components given a name and some prefixes
646 sub _comp_names_search_prefixes {
647 my ( $c, $name, @prefixes ) = @_;
648 my $appclass = ref $c || $c;
649 my $filter = "^${appclass}::(" . join( '|', @prefixes ) . ')::';
650 $filter = qr/$filter/; # Compile regex now rather than once per loop
652 # map the original component name to the sub part that we will search against
653 my %eligible = map { my $n = $_; $n =~ s{^$appclass\::[^:]+::}{}; $_ => $n; }
654 grep { /$filter/ } keys %{ $c->components };
656 # undef for a name will return all
657 return keys %eligible if !defined $name;
659 my $query = $name->$_isa('Regexp') ? $name : qr/^$name$/i;
660 my @result = grep { $eligible{$_} =~ m{$query} } keys %eligible;
662 return @result if @result;
664 # if we were given a regexp to search against, we're done.
665 return if $name->$_isa('Regexp');
667 # skip regexp fallback if configured
669 if $appclass->config->{disable_component_resolution_regex_fallback};
673 @result = grep { $eligible{ $_ } =~ m{$query} } keys %eligible;
675 # no results? try against full names
677 @result = grep { m{$query} } keys %eligible;
680 # don't warn if we didn't find any results, it just might not exist
682 # Disgusting hack to work out correct method name
683 my $warn_for = lc $prefixes[0];
684 my $msg = "Used regexp fallback for \$c->${warn_for}('${name}'), which found '" .
685 (join '", "', @result) . "'. Relying on regexp fallback behavior for " .
686 "component resolution is unreliable and unsafe.";
687 my $short = $result[0];
688 # remove the component namespace prefix
689 $short =~ s/.*?(Model|Controller|View):://;
690 my $shortmess = Carp::shortmess('');
691 if ($shortmess =~ m#Catalyst/Plugin#) {
692 $msg .= " You probably need to set '$short' instead of '${name}' in this " .
694 } elsif ($shortmess =~ m#Catalyst/lib/(View|Controller)#) {
695 $msg .= " You probably need to set '$short' instead of '${name}' in this " .
696 "component's config";
698 $msg .= " You probably meant \$c->${warn_for}('$short') instead of \$c->${warn_for}('${name}'), " .
699 "but if you really wanted to search, pass in a regexp as the argument " .
700 "like so: \$c->${warn_for}(qr/${name}/)";
702 $c->log->warn( "${msg}$shortmess" );
708 # Find possible names for a prefix
710 my ( $c, @prefixes ) = @_;
711 my $appclass = ref $c || $c;
713 my $filter = "^${appclass}::(" . join( '|', @prefixes ) . ')::';
715 my @names = map { s{$filter}{}; $_; }
716 $c->_comp_names_search_prefixes( undef, @prefixes );
721 # Filter a component before returning by calling ACCEPT_CONTEXT if available
723 sub _filter_component {
724 my ( $c, $comp, @args ) = @_;
726 if(ref $comp eq 'CODE') {
730 if ( eval { $comp->can('ACCEPT_CONTEXT'); } ) {
731 return $comp->ACCEPT_CONTEXT( $c, @args );
734 $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;
739 =head2 COMPONENT ACCESSORS
741 =head2 $c->controller($name)
743 Gets a L<Catalyst::Controller> instance by name.
745 $c->controller('Foo')->do_stuff;
747 If the name is omitted, will return the controller for the dispatched
750 If you want to search for controllers, pass in a regexp as the argument.
752 # find all controllers that start with Foo
753 my @foo_controllers = $c->controller(qr{^Foo});
759 my ( $c, $name, @args ) = @_;
761 my $appclass = ref($c) || $c;
763 unless ( $name->$_isa('Regexp') ) { # Direct component hash lookup to avoid costly regexps
764 my $comps = $c->components;
765 my $check = $appclass."::Controller::".$name;
766 return $c->_filter_component( $comps->{$check}, @args ) if exists $comps->{$check};
768 my @result = $c->_comp_search_prefixes( $name, qw/Controller C/ );
769 return map { $c->_filter_component( $_, @args ) } @result if ref $name;
770 return $c->_filter_component( $result[ 0 ], @args );
773 return $c->component( $c->action->class );
776 =head2 $c->model($name)
778 Gets a L<Catalyst::Model> instance by name.
780 $c->model('Foo')->do_stuff;
782 Any extra arguments are directly passed to ACCEPT_CONTEXT, if the model
783 defines ACCEPT_CONTEXT. If it does not, the args are discarded.
785 If the name is omitted, it will look for
786 - a model object in $c->stash->{current_model_instance}, then
787 - a model name in $c->stash->{current_model}, then
788 - a config setting 'default_model', or
789 - check if there is only one model, and return it if that's the case.
791 If you want to search for models, pass in a regexp as the argument.
793 # find all models that start with Foo
794 my @foo_models = $c->model(qr{^Foo});
799 my ( $c, $name, @args ) = @_;
800 my $appclass = ref($c) || $c;
802 unless ( $name->$_isa('Regexp') ) { # Direct component hash lookup to avoid costly regexps
803 my $comps = $c->components;
804 my $check = $appclass."::Model::".$name;
805 return $c->_filter_component( $comps->{$check}, @args ) if exists $comps->{$check};
807 my @result = $c->_comp_search_prefixes( $name, qw/Model M/ );
808 return map { $c->_filter_component( $_, @args ) } @result if ref $name;
809 return $c->_filter_component( $result[ 0 ], @args );
813 return $c->stash->{current_model_instance}
814 if $c->stash->{current_model_instance};
815 return $c->model( $c->stash->{current_model} )
816 if $c->stash->{current_model};
818 return $c->model( $appclass->config->{default_model} )
819 if $appclass->config->{default_model};
821 my( $comp, $rest ) = $c->_comp_search_prefixes( undef, qw/Model M/);
824 $c->log->warn( Carp::shortmess('Calling $c->model() will return a random model unless you specify one of:') );
825 $c->log->warn( '* $c->config(default_model => "the name of the default model to use")' );
826 $c->log->warn( '* $c->stash->{current_model} # the name of the model to use for this request' );
827 $c->log->warn( '* $c->stash->{current_model_instance} # the instance of the model to use for this request' );
828 $c->log->warn( 'NB: in version 5.81, the "random" behavior will not work at all.' );
831 return $c->_filter_component( $comp );
835 =head2 $c->view($name)
837 Gets a L<Catalyst::View> instance by name.
839 $c->view('Foo')->do_stuff;
841 Any extra arguments are directly passed to ACCEPT_CONTEXT.
843 If the name is omitted, it will look for
844 - a view object in $c->stash->{current_view_instance}, then
845 - a view name in $c->stash->{current_view}, then
846 - a config setting 'default_view', or
847 - check if there is only one view, and return it if that's the case.
849 If you want to search for views, pass in a regexp as the argument.
851 # find all views that start with Foo
852 my @foo_views = $c->view(qr{^Foo});
857 my ( $c, $name, @args ) = @_;
859 my $appclass = ref($c) || $c;
861 unless ( $name->$_isa('Regexp') ) { # Direct component hash lookup to avoid costly regexps
862 my $comps = $c->components;
863 my $check = $appclass."::View::".$name;
864 if( exists $comps->{$check} ) {
865 return $c->_filter_component( $comps->{$check}, @args );
868 $c->log->warn( "Attempted to use view '$check', but does not exist" );
871 my @result = $c->_comp_search_prefixes( $name, qw/View V/ );
872 return map { $c->_filter_component( $_, @args ) } @result if ref $name;
873 return $c->_filter_component( $result[ 0 ], @args );
877 return $c->stash->{current_view_instance}
878 if $c->stash->{current_view_instance};
879 return $c->view( $c->stash->{current_view} )
880 if $c->stash->{current_view};
882 return $c->view( $appclass->config->{default_view} )
883 if $appclass->config->{default_view};
885 my( $comp, $rest ) = $c->_comp_search_prefixes( undef, qw/View V/);
888 $c->log->warn( 'Calling $c->view() will return a random view unless you specify one of:' );
889 $c->log->warn( '* $c->config(default_view => "the name of the default view to use")' );
890 $c->log->warn( '* $c->stash->{current_view} # the name of the view to use for this request' );
891 $c->log->warn( '* $c->stash->{current_view_instance} # the instance of the view to use for this request' );
892 $c->log->warn( 'NB: in version 5.81, the "random" behavior will not work at all.' );
895 return $c->_filter_component( $comp );
898 =head2 $c->controllers
900 Returns the available names which can be passed to $c->controller
906 return $c->_comp_names(qw/Controller C/);
911 Returns the available names which can be passed to $c->model
917 return $c->_comp_names(qw/Model M/);
923 Returns the available names which can be passed to $c->view
929 return $c->_comp_names(qw/View V/);
932 =head2 $c->comp($name)
934 =head2 $c->component($name)
936 Gets a component object by name. This method is not recommended,
937 unless you want to get a specific component by full
938 class. C<< $c->controller >>, C<< $c->model >>, and C<< $c->view >>
939 should be used instead.
941 If C<$name> is a regexp, a list of components matched against the full
942 component name will be returned.
944 If Catalyst can't find a component by name, it will fallback to regex
945 matching by default. To disable this behaviour set
946 disable_component_resolution_regex_fallback to a true value.
948 __PACKAGE__->config( disable_component_resolution_regex_fallback => 1 );
953 my ( $c, $name, @args ) = @_;
956 my $comps = $c->components;
959 # is it the exact name?
960 return $c->_filter_component( $comps->{ $name }, @args )
961 if exists $comps->{ $name };
963 # perhaps we just omitted "MyApp"?
964 my $composed = ( ref $c || $c ) . "::${name}";
965 return $c->_filter_component( $comps->{ $composed }, @args )
966 if exists $comps->{ $composed };
968 # search all of the models, views and controllers
969 my( $comp ) = $c->_comp_search_prefixes( $name, qw/Model M Controller C View V/ );
970 return $c->_filter_component( $comp, @args ) if $comp;
974 if $c->config->{disable_component_resolution_regex_fallback};
976 # This is here so $c->comp( '::M::' ) works
977 my $query = ref $name ? $name : qr{$name}i;
979 my @result = grep { m{$query} } keys %{ $c->components };
980 return map { $c->_filter_component( $_, @args ) } @result if ref $name;
983 $c->log->warn( Carp::shortmess(qq(Found results for "${name}" using regexp fallback)) );
984 $c->log->warn( 'Relying on the regexp fallback behavior for component resolution' );
985 $c->log->warn( 'is unreliable and unsafe. You have been warned' );
986 return $c->_filter_component( $result[ 0 ], @args );
989 # I would expect to return an empty list here, but that breaks back-compat
993 return sort keys %{ $c->components };
996 =head2 CLASS DATA AND HELPER CLASSES
1000 Returns or takes a hashref containing the application's configuration.
1002 __PACKAGE__->config( { db => 'dsn:SQLite:foo.db' } );
1004 You can also use a C<YAML>, C<XML> or L<Config::General> config file
1005 like C<myapp.conf> in your applications home directory. See
1006 L<Catalyst::Plugin::ConfigLoader>.
1008 =head3 Cascading configuration
1010 The config method is present on all Catalyst components, and configuration
1011 will be merged when an application is started. Configuration loaded with
1012 L<Catalyst::Plugin::ConfigLoader> takes precedence over other configuration,
1013 followed by configuration in your top level C<MyApp> class. These two
1014 configurations are merged, and then configuration data whose hash key matches a
1015 component name is merged with configuration for that component.
1017 The configuration for a component is then passed to the C<new> method when a
1018 component is constructed.
1022 MyApp->config({ 'Model::Foo' => { bar => 'baz', overrides => 'me' } });
1023 MyApp::Model::Foo->config({ quux => 'frob', overrides => 'this' });
1025 will mean that C<MyApp::Model::Foo> receives the following data when
1028 MyApp::Model::Foo->new({
1034 It's common practice to use a Moose attribute
1035 on the receiving component to access the config value.
1037 package MyApp::Model::Foo;
1041 # this attr will receive 'baz' at construction time
1047 You can then get the value 'baz' by calling $c->model('Foo')->bar
1048 (or $self->bar inside code in the model).
1050 B<NOTE:> you MUST NOT call C<< $self->config >> or C<< __PACKAGE__->config >>
1051 as a way of reading config within your code, as this B<will not> give you the
1052 correctly merged config back. You B<MUST> take the config values supplied to
1053 the constructor and use those instead.
1057 around config => sub {
1061 croak('Setting config after setup has been run is not allowed.')
1062 if ( @_ and $c->setup_finished );
1069 Returns the logging object instance. Unless it is already set, Catalyst
1070 sets this up with a L<Catalyst::Log> object. To use your own log class,
1071 set the logger with the C<< __PACKAGE__->log >> method prior to calling
1072 C<< __PACKAGE__->setup >>.
1074 __PACKAGE__->log( MyLogger->new );
1079 $c->log->info( 'Now logging with my own logger!' );
1081 Your log class should implement the methods described in
1086 Returned True if there's a valid encoding
1088 =head2 clear_encoding
1090 Clears the encoding for the current context
1094 Sets or gets the application encoding. Setting encoding takes either an
1095 Encoding object or a string that we try to resolve via L<Encode::find_encoding>.
1097 You would expect to get the encoding object back if you attempt to set it. If
1098 there is a failure you will get undef returned and an error message in the log.
1102 sub has_encoding { shift->encoding ? 1:0 }
1104 sub clear_encoding {
1107 $c->encoding(undef);
1109 $c->log->error("You can't clear encoding on the application");
1119 # Don't let one change this once we are too far into the response
1120 if(blessed $c && $c->res->finalized_headers) {
1121 Carp::croak("You may not change the encoding once the headers are finalized");
1125 # Let it be set to undef
1126 if (my $wanted = shift) {
1127 $encoding = Encode::find_encoding($wanted)
1128 or Carp::croak( qq/Unknown encoding '$wanted'/ );
1129 binmode(STDERR, ':encoding(' . $encoding->name . ')');
1136 ? $c->{encoding} = $encoding
1137 : $c->_encoding($encoding);
1139 $encoding = ref $c && exists $c->{encoding}
1149 Returns 1 if debug mode is enabled, 0 otherwise.
1151 You can enable debug mode in several ways:
1155 =item By calling myapp_server.pl with the -d flag
1157 =item With the environment variables MYAPP_DEBUG, or CATALYST_DEBUG
1159 =item The -Debug option in your MyApp.pm
1161 =item By declaring C<sub debug { 1 }> in your MyApp.pm.
1165 The first three also set the log level to 'debug'.
1167 Calling C<< $c->debug(1) >> has no effect.
1173 =head2 $c->dispatcher
1175 Returns the dispatcher instance. See L<Catalyst::Dispatcher>.
1179 Returns the engine instance. See L<Catalyst::Engine>.
1182 =head2 UTILITY METHODS
1184 =head2 $c->path_to(@path)
1186 Merges C<@path> with C<< $c->config->{home} >> and returns a
1187 L<Path::Class::Dir> object. Note you can usually use this object as
1188 a filename, but sometimes you will have to explicitly stringify it
1189 yourself by calling the C<< ->stringify >> method.
1193 $c->path_to( 'db', 'sqlite.db' );
1198 my ( $c, @path ) = @_;
1199 my $path = Path::Class::Dir->new( $c->config->{home}, @path );
1200 if ( -d $path ) { return $path }
1201 else { return Path::Class::File->new( $c->config->{home}, @path ) }
1205 my ( $class, $name, $plugin, @args ) = @_;
1207 # See block comment in t/unit_core_plugin.t
1208 $class->log->warn(qq/Adding plugin using the ->plugin method is deprecated, and will be removed in a future release/);
1210 $class->_register_plugin( $plugin, 1 );
1212 eval { $plugin->import };
1213 $class->mk_classdata($name);
1215 eval { $obj = $plugin->new(@args) };
1218 Catalyst::Exception->throw( message =>
1219 qq/Couldn't instantiate instant plugin "$plugin", "$@"/ );
1222 $class->$name($obj);
1223 $class->log->debug(qq/Initialized instant plugin "$plugin" as "$name"/)
1229 Initializes the dispatcher and engine, loads any plugins, and loads the
1230 model, view, and controller components. You may also specify an array
1231 of plugins to load here, if you choose to not load them in the C<use
1235 MyApp->setup( qw/-Debug/ );
1237 B<Note:> You B<should not> wrap this method with method modifiers
1238 or bad things will happen - wrap the C<setup_finalize> method instead.
1240 B<Note:> You can create a custom setup stage that will execute when the
1241 application is starting. Use this to customize setup.
1243 MyApp->setup(-Custom=value);
1246 my ($class, $value) = @_;
1249 Can be handy if you want to hook into the setup phase.
1254 my ( $class, @arguments ) = @_;
1255 croak('Running setup more than once')
1256 if ( $class->setup_finished );
1258 unless ( $class->isa('Catalyst') ) {
1260 Catalyst::Exception->throw(
1261 message => qq/'$class' does not inherit from Catalyst/ );
1264 if ( $class->arguments ) {
1265 @arguments = ( @arguments, @{ $class->arguments } );
1271 foreach (@arguments) {
1275 ( $flags->{log} ) ? 'debug,' . $flags->{log} : 'debug';
1277 elsif (/^-(\w+)=?(.*)$/) {
1278 $flags->{ lc $1 } = $2;
1281 push @{ $flags->{plugins} }, $_;
1285 $class->setup_home( delete $flags->{home} );
1287 $class->setup_log( delete $flags->{log} );
1288 $class->setup_plugins( delete $flags->{plugins} );
1290 $class->setup_data_handlers();
1291 $class->setup_dispatcher( delete $flags->{dispatcher} );
1292 if (my $engine = delete $flags->{engine}) {
1293 $class->log->warn("Specifying the engine in ->setup is no longer supported, see Catalyst::Upgrading");
1295 $class->setup_engine();
1296 $class->setup_stats( delete $flags->{stats} );
1298 for my $flag ( sort keys %{$flags} ) {
1300 if ( my $code = $class->can( 'setup_' . $flag ) ) {
1301 &$code( $class, delete $flags->{$flag} );
1304 $class->log->warn(qq/Unknown flag "$flag"/);
1308 eval { require Catalyst::Devel; };
1309 if( !$@ && $ENV{CATALYST_SCRIPT_GEN} && ( $ENV{CATALYST_SCRIPT_GEN} < $Catalyst::Devel::CATALYST_SCRIPT_GEN ) ) {
1310 $class->log->warn(<<"EOF");
1311 You are running an old script!
1313 Please update by running (this will overwrite existing files):
1314 catalyst.pl -force -scripts $class
1316 or (this will not overwrite existing files):
1317 catalyst.pl -scripts $class
1322 # Call plugins setup, this is stupid and evil.
1323 # Also screws C3 badly on 5.10, hack to avoid.
1325 no warnings qw/redefine/;
1326 local *setup = sub { };
1327 $class->setup unless $Catalyst::__AM_RESTARTING;
1330 # If you are expecting configuration info as part of your setup, it needs
1331 # to get called here and below, since we need the above line to support
1332 # ConfigLoader based configs.
1334 $class->setup_encoding();
1335 $class->setup_middleware();
1337 # Initialize our data structure
1338 $class->components( {} );
1340 $class->setup_components;
1342 if ( $class->debug ) {
1343 my @plugins = map { "$_ " . ( $_->VERSION || '' ) } $class->registered_plugins;
1346 my $column_width = Catalyst::Utils::term_width() - 6;
1347 my $t = Text::SimpleTable->new($column_width);
1348 $t->row($_) for @plugins;
1349 $class->log->debug( "Loaded plugins:\n" . $t->draw . "\n" );
1352 my @middleware = map {
1355 (ref($_) .' '. ($_->can('VERSION') ? $_->VERSION || '' : '')
1356 || '') } $class->registered_middlewares;
1359 my $column_width = Catalyst::Utils::term_width() - 6;
1360 my $t = Text::SimpleTable->new($column_width);
1361 $t->row($_) for @middleware;
1362 $class->log->debug( "Loaded PSGI Middleware:\n" . $t->draw . "\n" );
1365 my %dh = $class->registered_data_handlers;
1366 if (my @data_handlers = keys %dh) {
1367 my $column_width = Catalyst::Utils::term_width() - 6;
1368 my $t = Text::SimpleTable->new($column_width);
1369 $t->row($_) for @data_handlers;
1370 $class->log->debug( "Loaded Request Data Handlers:\n" . $t->draw . "\n" );
1373 my $dispatcher = $class->dispatcher;
1374 my $engine = $class->engine;
1375 my $home = $class->config->{home};
1377 $class->log->debug(sprintf(q/Loaded dispatcher "%s"/, blessed($dispatcher)));
1378 $class->log->debug(sprintf(q/Loaded engine "%s"/, blessed($engine)));
1382 ? $class->log->debug(qq/Found home "$home"/)
1383 : $class->log->debug(qq/Home "$home" doesn't exist/)
1384 : $class->log->debug(q/Couldn't find home/);
1386 my $column_width = Catalyst::Utils::term_width() - 8 - 9;
1387 my $t = Text::SimpleTable->new( [ $column_width, 'Class' ], [ 8, 'Type' ] );
1388 for my $comp ( sort keys %{ $class->components } ) {
1389 my $type = ref $class->components->{$comp} ? 'instance' : 'class';
1390 $t->row( $comp, $type );
1392 $class->log->debug( "Loaded components:\n" . $t->draw . "\n" )
1393 if ( keys %{ $class->components } );
1396 # Add our self to components, since we are also a component
1397 if( $class->isa('Catalyst::Controller') ){
1398 $class->components->{$class} = $class;
1401 $class->setup_actions;
1403 if ( $class->debug ) {
1404 my $name = $class->config->{name} || 'Application';
1405 $class->log->info("$name powered by Catalyst $Catalyst::VERSION");
1408 if ($class->config->{case_sensitive}) {
1409 $class->log->warn($class . "->config->{case_sensitive} is set.");
1410 $class->log->warn("This setting is deprecated and planned to be removed in Catalyst 5.81.");
1413 $class->setup_finalize;
1415 # Flush the log for good measure (in case something turned off 'autoflush' early)
1416 $class->log->_flush() if $class->log->can('_flush');
1418 return $class || 1; # Just in case someone named their Application 0...
1421 =head2 $app->setup_finalize
1423 A hook to attach modifiers to. This method does not do anything except set the
1424 C<setup_finished> accessor.
1426 Applying method modifiers to the C<setup> method doesn't work, because of quirky things done for plugin setup.
1430 after setup_finalize => sub {
1438 sub setup_finalize {
1440 $class->setup_finished(1);
1443 =head2 $c->uri_for( $path?, @args?, \%query_values? )
1445 =head2 $c->uri_for( $action, \@captures?, @args?, \%query_values? )
1447 =head2 $c->uri_for( $action, [@captures, @args], \%query_values? )
1449 Constructs an absolute L<URI> object based on the application root, the
1450 provided path, and the additional arguments and query parameters provided.
1451 When used as a string, provides a textual URI. If you need more flexibility
1452 than this (i.e. the option to provide relative URIs etc.) see
1453 L<Catalyst::Plugin::SmartURI>.
1455 If no arguments are provided, the URI for the current action is returned.
1456 To return the current action and also provide @args, use
1457 C<< $c->uri_for( $c->action, @args ) >>.
1459 If the first argument is a string, it is taken as a public URI path relative
1460 to C<< $c->namespace >> (if it doesn't begin with a forward slash) or
1461 relative to the application root (if it does). It is then merged with
1462 C<< $c->request->base >>; any C<@args> are appended as additional path
1463 components; and any C<%query_values> are appended as C<?foo=bar> parameters.
1465 If the first argument is a L<Catalyst::Action> it represents an action which
1466 will have its path resolved using C<< $c->dispatcher->uri_for_action >>. The
1467 optional C<\@captures> argument (an arrayref) allows passing the captured
1468 variables that are needed to fill in the paths of Chained and Regex actions;
1469 once the path is resolved, C<uri_for> continues as though a path was
1470 provided, appending any arguments or parameters and creating an absolute
1473 The captures for the current request can be found in
1474 C<< $c->request->captures >>, and actions can be resolved using
1475 C<< Catalyst::Controller->action_for($name) >>. If you have a private action
1476 path, use C<< $c->uri_for_action >> instead.
1478 # Equivalent to $c->req->uri
1479 $c->uri_for($c->action, $c->req->captures,
1480 @{ $c->req->args }, $c->req->params);
1482 # For the Foo action in the Bar controller
1483 $c->uri_for($c->controller('Bar')->action_for('Foo'));
1485 # Path to a static resource
1486 $c->uri_for('/static/images/logo.png');
1488 In general the scheme of the generated URI object will follow the incoming request
1489 however if your targeted action or action chain has the Scheme attribute it will
1492 Also, if the targeted Action or Action chain declares Args/CaptureArgs that have
1493 type constraints, we will require that your proposed URL verify on those declared
1499 my ( $c, $path, @args ) = @_;
1501 if ( $path->$_isa('Catalyst::Controller') ) {
1502 $path = $path->path_prefix;
1507 undef($path) if (defined $path && $path eq '');
1510 ( scalar @args && ref $args[$#args] eq 'HASH' ? pop @args : {} );
1512 carp "uri_for called with undef argument" if grep { ! defined $_ } @args;
1514 my $target_action = $path->$_isa('Catalyst::Action') ? $path : undef;
1515 if ( $path->$_isa('Catalyst::Action') ) { # action object
1516 s|/|%2F|g for @args;
1517 my $captures = [ map { s|/|%2F|g; $_; }
1518 ( scalar @args && ref $args[0] eq 'ARRAY'
1523 my $expanded_action = $c->dispatcher->expand_action( $action );
1524 my $num_captures = $expanded_action->number_of_captures;
1526 # ->uri_for( $action, \@captures_and_args, \%query_values? )
1527 if( !@args && $action->number_of_args ) {
1528 unshift @args, splice @$captures, $num_captures;
1532 unless($expanded_action->match_captures_constraints($c, $captures)) {
1533 carp "captures [@{$captures}] do not match the type constraints in actionchain ending with '$expanded_action'";
1538 $path = $c->dispatcher->uri_for_action($action, $captures);
1539 if (not defined $path) {
1540 $c->log->debug(qq/Can't find uri_for action '$action' @$captures/)
1544 $path = '/' if $path eq '';
1546 # At this point @encoded_args is the remaining Args (all captures removed).
1547 if($expanded_action->has_args_constraints) {
1548 unless($expanded_action->match_args($c,\@args)) {
1549 carp "args [@args] do not match the type constraints in action '$expanded_action'";
1555 unshift(@args, $path);
1557 unless (defined $path && $path =~ s!^/!!) { # in-place strip
1558 my $namespace = $c->namespace;
1559 if (defined $path) { # cheesy hack to handle path '../foo'
1560 $namespace =~ s{(?:^|/)[^/]+$}{} while $args[0] =~ s{^\.\./}{};
1562 unshift(@args, $namespace || '');
1565 # join args with '/', or a blank string
1566 my $args = join('/', grep { defined($_) } @args);
1567 $args =~ s/\?/%3F/g; # STUPID STUPID SPECIAL CASE
1570 my ($base, $class) = ('/', 'URI::_generic');
1572 $base = $c->req->base;
1573 if($target_action) {
1574 $target_action = $c->dispatcher->expand_action($target_action);
1575 if(my $s = $target_action->scheme) {
1580 $class = ref($base);
1583 $class = ref($base);
1586 $base =~ s{(?<!/)$}{/};
1591 if (my @keys = keys %$params) {
1592 # somewhat lifted from URI::_query's query_form
1593 $query = '?'.join('&', map {
1594 my $val = $params->{$_};
1595 #s/([;\/?:@&=+,\$\[\]%])/$URI::Escape::escapes{$1}/go; ## Commented out because seems to lead to double encoding - JNAP
1598 $val = '' unless defined $val;
1601 $param = encode_utf8($param);
1602 # using the URI::Escape pattern here so utf8 chars survive
1603 $param =~ s/([^A-Za-z0-9\-_.!~*'() ])/$URI::Escape::escapes{$1}/go;
1606 $key = encode_utf8($key);
1607 # using the URI::Escape pattern here so utf8 chars survive
1608 $key =~ s/([^A-Za-z0-9\-_.!~*'() ])/$URI::Escape::escapes{$1}/go;
1611 "${key}=$param"; } ( ref $val eq 'ARRAY' ? @$val : $val ));
1615 $base = encode_utf8 $base;
1616 $base =~ s/([^$URI::uric])/$URI::Escape::escapes{$1}/go;
1617 $args = encode_utf8 $args;
1618 $args =~ s/([^$URI::uric])/$URI::Escape::escapes{$1}/go;
1620 my $res = bless(\"${base}${args}${query}", $class);
1624 =head2 $c->uri_for_action( $path, \@captures_and_args?, @args?, \%query_values? )
1626 =head2 $c->uri_for_action( $action, \@captures_and_args?, @args?, \%query_values? )
1632 A private path to the Catalyst action you want to create a URI for.
1634 This is a shortcut for calling C<< $c->dispatcher->get_action_by_path($path)
1635 >> and passing the resulting C<$action> and the remaining arguments to C<<
1638 You can also pass in a Catalyst::Action object, in which case it is passed to
1641 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.
1643 For example, if the action looks like:
1645 package MyApp::Controller::Users;
1647 sub lst : Path('the-list') {}
1651 $c->uri_for_action('/users/lst')
1653 and it will create the URI /users/the-list.
1655 =item \@captures_and_args?
1657 Optional array reference of Captures (i.e. C<<CaptureArgs or $c->req->captures>)
1658 and arguments to the request. Usually used with L<Catalyst::DispatchType::Chained>
1659 to interpolate all the parameters in the URI.
1663 Optional list of extra arguments - can be supplied in the
1664 C<< \@captures_and_args? >> array ref, or here - whichever is easier for your
1667 Your action can have zero, a fixed or a variable number of args (e.g.
1668 C<< Args(1) >> for a fixed number or C<< Args() >> for a variable number)..
1670 =item \%query_values?
1672 Optional array reference of query parameters to append. E.g.
1678 /rest/of/your/uri?foo=bar
1684 sub uri_for_action {
1685 my ( $c, $path, @args ) = @_;
1686 my $action = blessed($path)
1688 : $c->dispatcher->get_action_by_path($path);
1689 unless (defined $action) {
1690 croak "Can't find action for path '$path'";
1692 return $c->uri_for( $action, @args );
1695 =head2 $c->welcome_message
1697 Returns the Catalyst welcome HTML page.
1701 sub welcome_message {
1703 my $name = $c->config->{name};
1704 my $logo = $c->uri_for('/static/images/catalyst_logo.png');
1705 my $prefix = Catalyst::Utils::appprefix( ref $c );
1706 $c->response->content_type('text/html; charset=utf-8');
1708 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
1709 "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
1710 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
1712 <meta http-equiv="Content-Language" content="en" />
1713 <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
1714 <title>$name on Catalyst $VERSION</title>
1715 <style type="text/css">
1718 background-color: #eee;
1725 margin-bottom: 10px;
1727 background-color: #ccc;
1728 border: 1px solid #aaa;
1733 font-family: verdana, tahoma, sans-serif;
1736 font-family: verdana, tahoma, sans-serif;
1739 text-decoration: none;
1741 border-bottom: 1px dotted #bbb;
1743 :link:hover, :visited:hover {
1756 background-color: #fff;
1757 border: 1px solid #aaa;
1761 font-weight: normal;
1783 <h1><span id="appname">$name</span> on <a href="http://catalyst.perl.org">Catalyst</a>
1788 <img src="$logo" alt="Catalyst Logo" />
1790 <p>Welcome to the world of Catalyst.
1791 This <a href="http://en.wikipedia.org/wiki/MVC">MVC</a>
1792 framework will make web development something you had
1793 never expected it to be: Fun, rewarding, and quick.</p>
1794 <h2>What to do now?</h2>
1795 <p>That really depends on what <b>you</b> want to do.
1796 We do, however, provide you with a few starting points.</p>
1797 <p>If you want to jump right into web development with Catalyst
1798 you might want to start with a tutorial.</p>
1799 <pre>perldoc <a href="https://metacpan.org/module/Catalyst::Manual::Tutorial">Catalyst::Manual::Tutorial</a></code>
1801 <p>Afterwards you can go on to check out a more complete look at our features.</p>
1803 <code>perldoc <a href="https://metacpan.org/module/Catalyst::Manual::Intro">Catalyst::Manual::Intro</a>
1804 <!-- Something else should go here, but the Catalyst::Manual link seems unhelpful -->
1806 <h2>What to do next?</h2>
1807 <p>Next it's time to write an actual application. Use the
1808 helper scripts to generate <a href="https://metacpan.org/search?q=Catalyst%3A%3AController">controllers</a>,
1809 <a href="https://metacpan.org/search?q=Catalyst%3A%3AModel">models</a>, and
1810 <a href="https://metacpan.org/search?q=Catalyst%3A%3AView">views</a>;
1811 they can save you a lot of work.</p>
1812 <pre><code>script/${prefix}_create.pl --help</code></pre>
1813 <p>Also, be sure to check out the vast and growing
1814 collection of <a href="http://search.cpan.org/search?query=Catalyst">plugins for Catalyst on CPAN</a>;
1815 you are likely to find what you need there.
1819 <p>Catalyst has a very active community. Here are the main places to
1820 get in touch with us.</p>
1823 <a href="http://dev.catalyst.perl.org">Wiki</a>
1826 <a href="http://lists.scsys.co.uk/cgi-bin/mailman/listinfo/catalyst">Mailing-List</a>
1829 <a href="irc://irc.perl.org/catalyst">IRC channel #catalyst on irc.perl.org</a>
1832 <h2>In conclusion</h2>
1833 <p>The Catalyst team hopes you will enjoy using Catalyst as much
1834 as we enjoyed making it. Please contact us if you have ideas
1835 for improvement or other feedback.</p>
1845 Contains a hash of options passed from the application script, including
1846 the original ARGV the script received, the processed values from that
1847 ARGV and any extra arguments to the script which were not processed.
1849 This can be used to add custom options to your application's scripts
1850 and setup your application differently depending on the values of these
1853 =head1 INTERNAL METHODS
1855 These methods are not meant to be used by end users.
1857 =head2 $c->components
1859 Returns a hash of components.
1861 =head2 $c->context_class
1863 Returns or sets the context class.
1867 Returns a hashref containing coderefs and execution counts (needed for
1868 deep recursion detection).
1872 Returns the number of actions on the current internal execution stack.
1876 Dispatches a request to actions.
1880 sub dispatch { my $c = shift; $c->dispatcher->dispatch( $c, @_ ) }
1882 =head2 $c->dispatcher_class
1884 Returns or sets the dispatcher class.
1886 =head2 $c->dump_these
1888 Returns a list of 2-element array references (name, structure) pairs
1889 that will be dumped on the error page in debug mode.
1895 [ Request => $c->req ],
1896 [ Response => $c->res ],
1897 [ Stash => $c->stash ],
1898 [ Config => $c->config ];
1901 =head2 $c->engine_class
1903 Returns or sets the engine class.
1905 =head2 $c->execute( $class, $coderef )
1907 Execute a coderef in given class and catch exceptions. Errors are available
1913 my ( $c, $class, $code ) = @_;
1914 $class = $c->component($class) || $class;
1917 if ( $c->depth >= $RECURSION ) {
1918 my $action = $code->reverse();
1919 $action = "/$action" unless $action =~ /->/;
1920 my $error = qq/Deep recursion detected calling "${action}"/;
1921 $c->log->error($error);
1927 my $stats_info = $c->_stats_start_execute( $code ) if $c->use_stats;
1929 push( @{ $c->stack }, $code );
1931 no warnings 'recursion';
1932 # N.B. This used to be combined, but I have seen $c get clobbered if so, and
1933 # I have no idea how, ergo $ret (which appears to fix the issue)
1934 eval { my $ret = $code->execute( $class, $c, @{ $c->req->args } ) || 0; $c->state( $ret ) };
1936 $c->_stats_finish_execute( $stats_info ) if $c->use_stats and $stats_info;
1938 my $last = pop( @{ $c->stack } );
1940 if ( my $error = $@ ) {
1941 #rethow if this can be handled by middleware
1942 if ( $c->_handle_http_exception($error) ) {
1943 foreach my $err (@{$c->error}) {
1944 $c->log->error($err);
1947 $c->log->_flush if $c->log->can('_flush');
1949 $error->can('rethrow') ? $error->rethrow : croak $error;
1951 if ( blessed($error) and $error->isa('Catalyst::Exception::Detach') ) {
1952 $error->rethrow if $c->depth > 1;
1954 elsif ( blessed($error) and $error->isa('Catalyst::Exception::Go') ) {
1955 $error->rethrow if $c->depth > 0;
1958 unless ( ref $error ) {
1959 no warnings 'uninitialized';
1961 my $class = $last->class;
1962 my $name = $last->name;
1963 $error = qq/Caught exception in $class->$name "$error"/;
1972 sub _stats_start_execute {
1973 my ( $c, $code ) = @_;
1974 my $appclass = ref($c) || $c;
1975 return if ( ( $code->name =~ /^_.*/ )
1976 && ( !$appclass->config->{show_internal_actions} ) );
1978 my $action_name = $code->reverse();
1979 $c->counter->{$action_name}++;
1981 my $action = $action_name;
1982 $action = "/$action" unless $action =~ /->/;
1984 # determine if the call was the result of a forward
1985 # this is done by walking up the call stack and looking for a calling
1986 # sub of Catalyst::forward before the eval
1988 for my $index ( 2 .. 11 ) {
1990 if ( ( caller($index) )[0] eq 'Catalyst'
1991 && ( caller($index) )[3] eq '(eval)' );
1993 if ( ( caller($index) )[3] =~ /forward$/ ) {
1994 $callsub = ( caller($index) )[3];
1995 $action = "-> $action";
2000 my $uid = $action_name . $c->counter->{$action_name};
2002 # is this a root-level call or a forwarded call?
2003 if ( $callsub =~ /forward$/ ) {
2004 my $parent = $c->stack->[-1];
2006 # forward, locate the caller
2007 if ( defined $parent && exists $c->counter->{"$parent"} ) {
2010 parent => "$parent" . $c->counter->{"$parent"},
2016 # forward with no caller may come from a plugin
2035 sub _stats_finish_execute {
2036 my ( $c, $info ) = @_;
2037 $c->stats->profile( end => $info );
2042 Finalizes the request.
2049 for my $error ( @{ $c->error } ) {
2050 $c->log->error($error);
2053 # Support skipping finalize for psgix.io style 'jailbreak'. Used to support
2054 # stuff like cometd and websockets
2056 if($c->request->_has_io_fh) {
2061 # Allow engine to handle finalize flow (for POE)
2062 my $engine = $c->engine;
2063 if ( my $code = $engine->can('finalize') ) {
2068 $c->finalize_uploads;
2071 if ( $#{ $c->error } >= 0 ) {
2075 $c->finalize_encoding;
2076 $c->finalize_headers unless $c->response->finalized_headers;
2082 if ($c->use_stats) {
2083 my $elapsed = $c->stats->elapsed;
2084 my $av = $elapsed == 0 ? '??' : sprintf '%.3f', 1 / $elapsed;
2086 "Request took ${elapsed}s ($av/s)\n" . $c->stats->report . "\n" );
2089 return $c->response->status;
2092 =head2 $c->finalize_body
2098 sub finalize_body { my $c = shift; $c->engine->finalize_body( $c, @_ ) }
2100 =head2 $c->finalize_cookies
2106 sub finalize_cookies { my $c = shift; $c->engine->finalize_cookies( $c, @_ ) }
2108 =head2 $c->finalize_error
2110 Finalizes error. If there is only one error in L</error> and it is an object that
2111 does C<as_psgi> or C<code> we rethrow the error and presume it caught by middleware
2112 up the ladder. Otherwise we return the debugging error page (in debug mode) or we
2113 return the default error page (production mode).
2117 sub finalize_error {
2119 if($#{$c->error} > 0) {
2120 $c->engine->finalize_error( $c, @_ );
2122 my ($error) = @{$c->error};
2123 if ( $c->_handle_http_exception($error) ) {
2124 # In the case where the error 'knows what it wants', becauses its PSGI
2125 # aware, just rethow and let middleware catch it
2126 $error->can('rethrow') ? $error->rethrow : croak $error;
2128 $c->engine->finalize_error( $c, @_ )
2133 =head2 $c->finalize_headers
2139 sub finalize_headers {
2142 my $response = $c->response; #accessor calls can add up?
2144 # Check if we already finalized headers
2145 return if $response->finalized_headers;
2148 if ( my $location = $response->redirect ) {
2149 $c->log->debug(qq/Redirecting to "$location"/) if $c->debug;
2150 $response->header( Location => $location );
2153 # Remove incorrectly added body and content related meta data when returning
2154 # an information response, or a response the is required to not include a body
2156 $c->finalize_cookies;
2158 # This currently is a NOOP but I don't want to remove it since I guess people
2159 # might have Response subclasses that use it for something... (JNAP)
2160 $c->response->finalize_headers();
2163 $response->finalized_headers(1);
2166 =head2 $c->finalize_encoding
2168 Make sure your body is encoded properly IF you set an encoding. By
2169 default the encoding is UTF-8 but you can disable it by explicitly setting the
2170 encoding configuration value to undef.
2172 We can only encode when the body is a scalar. Methods for encoding via the
2173 streaming interfaces (such as C<write> and C<write_fh> on L<Catalyst::Response>
2180 sub finalize_encoding {
2182 my $res = $c->res || return;
2184 # Warn if the set charset is different from the one you put into encoding. We need
2185 # to do this early since encodable_response is false for this condition and we need
2186 # to match the debug output for backcompat (there's a test for this...) -JNAP
2188 $res->content_type_charset and $c->encoding and
2189 (uc($c->encoding->mime_name) ne uc($res->content_type_charset))
2191 my $ct = lc($res->content_type_charset);
2192 $c->log->debug("Catalyst encoding config is set to encode in '" .
2193 $c->encoding->mime_name .
2194 "', content type is '$ct', not encoding ");
2198 ($res->encodable_response) and
2199 (defined($res->body)) and
2200 (ref(\$res->body) eq 'SCALAR')
2202 $c->res->body( $c->encoding->encode( $c->res->body, $c->_encode_check ) );
2204 # Set the charset if necessary. This might be a bit bonkers since encodable response
2205 # is false when the set charset is not the same as the encoding mimetype (maybe
2206 # confusing action at a distance here..
2207 # Don't try to set the charset if one already exists
2208 $c->res->content_type($c->res->content_type . "; charset=" . $c->encoding->mime_name)
2209 unless($c->res->content_type_charset);
2213 =head2 $c->finalize_output
2215 An alias for finalize_body.
2217 =head2 $c->finalize_read
2219 Finalizes the input after reading is complete.
2223 sub finalize_read { my $c = shift; $c->engine->finalize_read( $c, @_ ) }
2225 =head2 $c->finalize_uploads
2227 Finalizes uploads. Cleans up any temporary files.
2231 sub finalize_uploads { my $c = shift; $c->engine->finalize_uploads( $c, @_ ) }
2233 =head2 $c->get_action( $action, $namespace )
2235 Gets an action in a given namespace.
2239 sub get_action { my $c = shift; $c->dispatcher->get_action(@_) }
2241 =head2 $c->get_actions( $action, $namespace )
2243 Gets all actions of a given name in a namespace and all parent
2248 sub get_actions { my $c = shift; $c->dispatcher->get_actions( $c, @_ ) }
2250 =head2 $app->handle_request( @arguments )
2252 Called to handle each HTTP request.
2256 sub handle_request {
2257 my ( $class, @arguments ) = @_;
2259 # Always expect worst case!
2262 if ($class->debug) {
2263 my $secs = time - $START || 1;
2264 my $av = sprintf '%.3f', $COUNT / $secs;
2265 my $time = localtime time;
2266 $class->log->info("*** Request $COUNT ($av/s) [$$] [$time] ***");
2269 my $c = $class->prepare(@arguments);
2271 $status = $c->finalize;
2273 #rethow if this can be handled by middleware
2274 if ( $class->_handle_http_exception($_) ) {
2275 $_->can('rethrow') ? $_->rethrow : croak $_;
2277 chomp(my $error = $_);
2278 $class->log->error(qq/Caught exception in engine "$error"/);
2283 if(my $coderef = $class->log->can('_flush')){
2284 $class->log->$coderef();
2289 =head2 $class->prepare( @arguments )
2291 Creates a Catalyst context from an engine-specific request (Apache, CGI,
2298 predicate => '_has_uploadtmp',
2302 my ( $class, @arguments ) = @_;
2305 # After the app/ctxt split, this should become an attribute based on something passed
2306 # into the application.
2307 $class->context_class( ref $class || $class ) unless $class->context_class;
2309 my $uploadtmp = $class->config->{uploadtmp};
2310 my $c = $class->context_class->new({ $uploadtmp ? (_uploadtmp => $uploadtmp) : ()});
2312 $c->response->_context($c);
2314 $c->stats($class->stats_class->new)->enable($c->use_stats);
2316 if ( $c->debug || $c->config->{enable_catalyst_header} ) {
2317 $c->res->headers->header( 'X-Catalyst' => $Catalyst::VERSION );
2321 # Allow engine to direct the prepare flow (for POE)
2322 if ( my $prepare = $c->engine->can('prepare') ) {
2323 $c->engine->$prepare( $c, @arguments );
2326 $c->prepare_request(@arguments);
2327 $c->prepare_connection;
2328 $c->prepare_query_parameters;
2329 $c->prepare_headers; # Just hooks, no longer needed - they just
2330 $c->prepare_cookies; # cause the lazy attribute on req to build
2333 # Prepare the body for reading, either by prepare_body
2334 # or the user, if they are using $c->read
2337 # Parse the body unless the user wants it on-demand
2338 unless ( ref($c)->config->{parse_on_demand} ) {
2344 # VERY ugly and probably shouldn't rely on ->finalize actually working
2346 # failed prepare is always due to an invalid request, right?
2347 $c->response->status(400);
2348 $c->response->content_type('text/plain');
2349 $c->response->body('Bad Request');
2350 # Note we call finalize and then die here, which escapes
2351 # finalize being called in the enclosing block..
2352 # It in fact couldn't be called, as we don't return $c..
2353 # This is a mess - but I'm unsure you can fix this without
2354 # breaking compat for people doing crazy things (we should set
2355 # the 400 and just return the ctx here IMO, letting finalize get called
2366 =head2 $c->prepare_action
2368 Prepares action. See L<Catalyst::Dispatcher>.
2372 sub prepare_action {
2374 my $ret = $c->dispatcher->prepare_action( $c, @_);
2377 foreach (@{$c->req->arguments}, @{$c->req->captures}) {
2378 $_ = $c->_handle_param_unicode_decoding($_);
2386 =head2 $c->prepare_body
2388 Prepares message body.
2395 return if $c->request->_has_body;
2397 # Initialize on-demand data
2398 $c->engine->prepare_body( $c, @_ );
2399 $c->prepare_parameters;
2400 $c->prepare_uploads;
2403 =head2 $c->prepare_body_chunk( $chunk )
2405 Prepares a chunk of data before sending it to L<HTTP::Body>.
2407 See L<Catalyst::Engine>.
2411 sub prepare_body_chunk {
2413 $c->engine->prepare_body_chunk( $c, @_ );
2416 =head2 $c->prepare_body_parameters
2418 Prepares body parameters.
2422 sub prepare_body_parameters {
2424 $c->request->prepare_body_parameters( $c, @_ );
2427 =head2 $c->prepare_connection
2429 Prepares connection.
2433 sub prepare_connection {
2435 $c->request->prepare_connection($c);
2438 =head2 $c->prepare_cookies
2440 Prepares cookies by ensuring that the attribute on the request
2441 object has been built.
2445 sub prepare_cookies { my $c = shift; $c->request->cookies }
2447 =head2 $c->prepare_headers
2449 Prepares request headers by ensuring that the attribute on the request
2450 object has been built.
2454 sub prepare_headers { my $c = shift; $c->request->headers }
2456 =head2 $c->prepare_parameters
2458 Prepares parameters.
2462 sub prepare_parameters {
2464 $c->prepare_body_parameters;
2465 $c->engine->prepare_parameters( $c, @_ );
2468 =head2 $c->prepare_path
2470 Prepares path and base.
2474 sub prepare_path { my $c = shift; $c->engine->prepare_path( $c, @_ ) }
2476 =head2 $c->prepare_query_parameters
2478 Prepares query parameters.
2482 sub prepare_query_parameters {
2485 $c->engine->prepare_query_parameters( $c, @_ );
2488 =head2 $c->log_request
2490 Writes information about the request to the debug logs. This includes:
2494 =item * Request method, path, and remote IP address
2496 =item * Query keywords (see L<Catalyst::Request/query_keywords>)
2498 =item * Request parameters
2500 =item * File uploads
2509 return unless $c->debug;
2511 my($dump) = grep {$_->[0] eq 'Request' } $c->dump_these;
2512 my $request = $dump->[1];
2514 my ( $method, $path, $address ) = ( $request->method, $request->path, $request->address );
2516 $path = '/' unless length $path;
2519 $path =~ s/%([0-9A-Fa-f]{2})/chr(hex($1))/eg;
2520 $path = decode_utf8($path);
2522 $c->log->debug(qq/"$method" request for "$path" from "$address"/);
2524 $c->log_request_headers($request->headers);
2526 if ( my $keywords = $request->query_keywords ) {
2527 $c->log->debug("Query keywords are: $keywords");
2530 $c->log_request_parameters( query => $request->query_parameters, $request->_has_body ? (body => $request->body_parameters) : () );
2532 $c->log_request_uploads($request);
2535 =head2 $c->log_response
2537 Writes information about the response to the debug logs by calling
2538 C<< $c->log_response_status_line >> and C<< $c->log_response_headers >>.
2545 return unless $c->debug;
2547 my($dump) = grep {$_->[0] eq 'Response' } $c->dump_these;
2548 my $response = $dump->[1];
2550 $c->log_response_status_line($response);
2551 $c->log_response_headers($response->headers);
2554 =head2 $c->log_response_status_line($response)
2556 Writes one line of information about the response to the debug logs. This includes:
2560 =item * Response status code
2562 =item * Content-Type header (if present)
2564 =item * Content-Length header (if present)
2570 sub log_response_status_line {
2571 my ($c, $response) = @_;
2575 'Response Code: %s; Content-Type: %s; Content-Length: %s',
2576 $response->status || 'unknown',
2577 $response->headers->header('Content-Type') || 'unknown',
2578 $response->headers->header('Content-Length') || 'unknown'
2583 =head2 $c->log_response_headers($headers);
2585 Hook method which can be wrapped by plugins to log the response headers.
2586 No-op in the default implementation.
2590 sub log_response_headers {}
2592 =head2 $c->log_request_parameters( query => {}, body => {} )
2594 Logs request parameters to debug logs
2598 sub log_request_parameters {
2600 my %all_params = @_;
2602 return unless $c->debug;
2604 my $column_width = Catalyst::Utils::term_width() - 44;
2605 foreach my $type (qw(query body)) {
2606 my $params = $all_params{$type};
2607 next if ! keys %$params;
2608 my $t = Text::SimpleTable->new( [ 35, 'Parameter' ], [ $column_width, 'Value' ] );
2609 for my $key ( sort keys %$params ) {
2610 my $param = $params->{$key};
2611 my $value = defined($param) ? $param : '';
2612 $t->row( $key, ref $value eq 'ARRAY' ? ( join ', ', @$value ) : $value );
2614 $c->log->debug( ucfirst($type) . " Parameters are:\n" . $t->draw );
2618 =head2 $c->log_request_uploads
2620 Logs file uploads included in the request to the debug logs.
2621 The parameter name, filename, file type, and file size are all included in
2626 sub log_request_uploads {
2628 my $request = shift;
2629 return unless $c->debug;
2630 my $uploads = $request->uploads;
2631 if ( keys %$uploads ) {
2632 my $t = Text::SimpleTable->new(
2633 [ 12, 'Parameter' ],
2638 for my $key ( sort keys %$uploads ) {
2639 my $upload = $uploads->{$key};
2640 for my $u ( ref $upload eq 'ARRAY' ? @{$upload} : ($upload) ) {
2641 $t->row( $key, $u->filename, $u->type, $u->size );
2644 $c->log->debug( "File Uploads are:\n" . $t->draw );
2648 =head2 $c->log_request_headers($headers);
2650 Hook method which can be wrapped by plugins to log the request headers.
2651 No-op in the default implementation.
2655 sub log_request_headers {}
2657 =head2 $c->log_headers($type => $headers)
2659 Logs L<HTTP::Headers> (either request or response) to the debug logs.
2666 my $headers = shift; # an HTTP::Headers instance
2668 return unless $c->debug;
2670 my $column_width = Catalyst::Utils::term_width() - 28;
2671 my $t = Text::SimpleTable->new( [ 15, 'Header Name' ], [ $column_width, 'Value' ] );
2674 my ( $name, $value ) = @_;
2675 $t->row( $name, $value );
2678 $c->log->debug( ucfirst($type) . " Headers:\n" . $t->draw );
2682 =head2 $c->prepare_read
2684 Prepares the input for reading.
2688 sub prepare_read { my $c = shift; $c->engine->prepare_read( $c, @_ ) }
2690 =head2 $c->prepare_request
2692 Prepares the engine request.
2696 sub prepare_request { my $c = shift; $c->engine->prepare_request( $c, @_ ) }
2698 =head2 $c->prepare_uploads
2704 sub prepare_uploads {
2706 $c->engine->prepare_uploads( $c, @_ );
2709 =head2 $c->prepare_write
2711 Prepares the output for writing.
2715 sub prepare_write { my $c = shift; $c->engine->prepare_write( $c, @_ ) }
2717 =head2 $c->request_class
2719 Returns or sets the request class. Defaults to L<Catalyst::Request>.
2721 =head2 $app->request_class_traits
2723 An arrayref of L<Moose::Role>s which are applied to the request class.
2725 =head2 $app->composed_request_class
2727 This is the request class which has been composed with any request_class_traits.
2729 =head2 $c->response_class
2731 Returns or sets the response class. Defaults to L<Catalyst::Response>.
2733 =head2 $app->response_class_traits
2735 An arrayref of L<Moose::Role>s which are applied to the response class.
2737 =head2 $app->composed_response_class
2739 This is the request class which has been composed with any response_class_traits.
2741 =head2 $c->read( [$maxlength] )
2743 Reads a chunk of data from the request body. This method is designed to
2744 be used in a while loop, reading C<$maxlength> bytes on every call.
2745 C<$maxlength> defaults to the size of the request if not specified.
2747 You have to set C<< MyApp->config(parse_on_demand => 1) >> to use this
2750 Warning: If you use read(), Catalyst will not process the body,
2751 so you will not be able to access POST parameters or file uploads via
2752 $c->request. You must handle all body parsing yourself.
2756 sub read { my $c = shift; return $c->request->read( @_ ) }
2766 $app->_make_immutable_if_needed;
2767 $app->engine_loader->needs_psgi_engine_compat_hack ?
2768 $app->engine->run($app, @_) :
2769 $app->engine->run( $app, $app->_finalized_psgi_app, @_ );
2772 sub _make_immutable_if_needed {
2774 my $meta = find_meta($class);
2775 my $isa_ca = $class->isa('Class::Accessor::Fast') || $class->isa('Class::Accessor');
2778 && ! { $meta->immutable_options }->{replace_constructor}
2781 warn("You made your application class ($class) immutable, "
2782 . "but did not inline the\nconstructor. "
2783 . "This will break catalyst, as your app \@ISA "
2784 . "Class::Accessor(::Fast)?\nPlease pass "
2785 . "(replace_constructor => 1)\nwhen making your class immutable.\n");
2787 unless ($meta->is_immutable) {
2788 # XXX - FIXME warning here as you should make your app immutable yourself.
2789 $meta->make_immutable(
2790 replace_constructor => 1,
2795 =head2 $c->set_action( $action, $code, $namespace, $attrs )
2797 Sets an action in a given namespace.
2801 sub set_action { my $c = shift; $c->dispatcher->set_action( $c, @_ ) }
2803 =head2 $c->setup_actions($component)
2805 Sets up actions for a component.
2809 sub setup_actions { my $c = shift; $c->dispatcher->setup_actions( $c, @_ ) }
2811 =head2 $c->setup_components
2813 This method is called internally to set up the application's components.
2815 It finds modules by calling the L<locate_components> method, expands them to
2816 package names with the L<expand_component_module> method, and then installs
2817 each component into the application.
2819 The C<setup_components> config option is passed to both of the above methods.
2821 Installation of each component is performed by the L<setup_component> method,
2826 sub setup_components {
2829 my $config = $class->config->{ setup_components };
2831 my @comps = $class->locate_components($config);
2832 my %comps = map { $_ => 1 } @comps;
2834 my $deprecatedcatalyst_component_names = grep { /::[CMV]::/ } @comps;
2835 $class->log->warn(qq{Your application is using the deprecated ::[MVC]:: type naming scheme.\n}.
2836 qq{Please switch your class names to ::Model::, ::View:: and ::Controller: as appropriate.\n}
2837 ) if $deprecatedcatalyst_component_names;
2839 for my $component ( @comps ) {
2841 # We pass ignore_loaded here so that overlay files for (e.g.)
2842 # Model::DBI::Schema sub-classes are loaded - if it's in @comps
2843 # we know M::P::O found a file on disk so this is safe
2845 Catalyst::Utils::ensure_class_loaded( $component, { ignore_loaded => 1 } );
2848 for my $component (@comps) {
2849 my $instance = $class->components->{ $component } = $class->delayed_setup_component($component);
2852 # Inject a component or wrap a stand alone class in an adaptor. This makes a list
2853 # of named components in the configuration that are not actually existing (not a
2856 my @injected_components = $class->setup_injected_components;
2858 # All components are registered, now we need to 'init' them.
2859 foreach my $component_name (@comps, @injected_components) {
2860 $class->components->{$component_name} = $class->components->{$component_name}->() if
2861 (ref($class->components->{$component_name}) || '') eq 'CODE';
2865 =head2 $app->setup_injected_components
2867 Called by setup_compoents to setup components that are injected.
2871 sub setup_injected_components {
2873 my @injected_components = keys %{$class->config->{inject_components} ||+{}};
2875 foreach my $injected_comp_name(@injected_components) {
2876 $class->setup_injected_component(
2877 $injected_comp_name,
2878 $class->config->{inject_components}->{$injected_comp_name});
2881 return @injected_components;
2884 =head2 $app->setup_injected_component( $injected_component_name, $config )
2886 Setup a given injected component.
2890 sub setup_injected_component {
2891 my ($class, $injected_comp_name, $config) = @_;
2892 if(my $component_class = $config->{from_component}) {
2893 my @roles = @{$config->{roles} ||[]};
2894 Catalyst::Utils::inject_component(
2896 component => $component_class,
2897 (scalar(@roles) ? (traits => \@roles) : ()),
2898 as => $injected_comp_name);
2902 =head2 $app->inject_component($MyApp_Component_name => \%args);
2904 Add a component that is injected at setup:
2906 MyApp->inject_component( 'Model::Foo' => { from_component => 'Common::Foo' } );
2908 Must be called before ->setup. Expects a component name for your
2909 current application and \%args where
2913 =item from_component
2915 The target component being injected into your application
2919 An arrayref of L<Moose::Role>s that are applied to your component.
2925 MyApp->inject_component(
2927 from_component => 'Common::Model::Foo',
2928 roles => ['Role1', 'Role2'],
2931 =head2 $app->inject_components
2933 Inject a list of components:
2935 MyApp->inject_components(
2936 'Model::FooOne' => {
2937 from_component => 'Common::Model::Foo',
2938 roles => ['Role1', 'Role2'],
2940 'Model::FooTwo' => {
2941 from_component => 'Common::Model::Foo',
2942 roles => ['Role1', 'Role2'],
2947 sub inject_component {
2948 my ($app, $name, $args) = @_;
2949 die "Component $name exists" if
2950 $app->config->{inject_components}->{$name};
2951 $app->config->{inject_components}->{$name} = $args;
2954 sub inject_components {
2957 $app->inject_component(shift, shift);
2961 =head2 $c->locate_components( $setup_component_config )
2963 This method is meant to provide a list of component modules that should be
2964 setup for the application. By default, it will use L<Module::Pluggable>.
2966 Specify a C<setup_components> config option to pass additional options directly
2967 to L<Module::Pluggable>. To add additional search paths, specify a key named
2968 C<search_extra> as an array reference. Items in the array beginning with C<::>
2969 will have the application class name prepended to them.
2973 sub locate_components {
2977 my @paths = qw( ::M ::Model ::V ::View ::C ::Controller );
2978 my $extra = delete $config->{ search_extra } || [];
2980 unshift @paths, @$extra;
2982 my @comps = map { sort { length($a) <=> length($b) } Module::Pluggable::Object->new(
2983 search_path => [ map { s/^(?=::)/$class/; $_; } ($_) ],
2985 )->plugins } @paths;
2990 =head2 $c->expand_component_module( $component, $setup_component_config )
2992 Components found by C<locate_components> will be passed to this method, which
2993 is expected to return a list of component (package) names to be set up.
2997 sub expand_component_module {
2998 my ($class, $module) = @_;
2999 return Devel::InnerPackage::list_packages( $module );
3002 =head2 $app->delayed_setup_component
3004 Returns a coderef that points to a setup_component instance. Used
3005 internally for when you want to delay setup until the first time
3006 the component is called.
3010 sub delayed_setup_component {
3011 my($class, $component, @more) = @_;
3013 return my $instance = $class->setup_component($component, @more);
3017 =head2 $c->setup_component
3021 sub setup_component {
3022 my( $class, $component ) = @_;
3024 unless ( $component->can( 'COMPONENT' ) ) {
3028 my $config = $class->config_for($component);
3029 # Stash catalyst_component_name in the config here, so that custom COMPONENT
3030 # methods also pass it. local to avoid pointlessly shitting in config
3031 # for the debug screen, as $component is already the key name.
3032 local $config->{catalyst_component_name} = $component;
3034 my $instance = eval {
3035 $component->COMPONENT( $class, $config );
3039 Catalyst::Exception->throw(
3040 message => qq/Couldn't instantiate component "$component", "$error"/
3044 unless (blessed $instance) {
3045 my $metaclass = Moose::Util::find_meta($component);
3046 my $method_meta = $metaclass->find_method_by_name('COMPONENT');
3047 my $component_method_from = $method_meta->associated_metaclass->name;
3048 my $value = defined($instance) ? $instance : 'undef';
3049 Catalyst::Exception->throw(
3051 qq/Couldn't instantiate component "$component", COMPONENT() method (from $component_method_from) didn't return an object-like value (value was $value)./
3055 my @expanded_components = $instance->can('expand_modules')
3056 ? $instance->expand_modules( $component, $config )
3057 : $class->expand_component_module( $component, $config );
3058 for my $component (@expanded_components) {
3059 next if $class->components->{ $component };
3060 $class->components->{ $component } = $class->setup_component($component);
3066 =head2 $app->config_for( $component_name )
3068 Return the application level configuration (which is not yet merged with any
3069 local component configuration, via $component_class->config) for the named
3070 component or component object. Example:
3073 'Model::Foo' => { a => 1, b => 2},
3076 my $config = MyApp->config_for('MyApp::Model::Foo');
3078 In this case $config is the hashref C< {a=>1, b=>2} >.
3080 This is also handy for looking up configuration for a plugin, to make sure you follow
3081 existing L<Catalyst> standards for where a plugin should put its configuration.
3086 my ($class, $component_name) = @_;
3087 my $component_suffix = Catalyst::Utils::class2classsuffix($component_name);
3088 my $config = $class->config->{ $component_suffix } || {};
3093 =head2 $c->setup_dispatcher
3099 sub setup_dispatcher {
3100 my ( $class, $dispatcher ) = @_;
3103 $dispatcher = 'Catalyst::Dispatcher::' . $dispatcher;
3106 if ( my $env = Catalyst::Utils::env_value( $class, 'DISPATCHER' ) ) {
3107 $dispatcher = 'Catalyst::Dispatcher::' . $env;
3110 unless ($dispatcher) {
3111 $dispatcher = $class->dispatcher_class;
3114 load_class($dispatcher);
3116 # dispatcher instance
3117 $class->dispatcher( $dispatcher->new );
3120 =head2 $c->setup_engine
3127 my ($class, $requested_engine) = @_;
3129 if (!$class->engine_loader || $requested_engine) {
3130 $class->engine_loader(
3131 Catalyst::EngineLoader->new({
3132 application_name => $class,
3133 (defined $requested_engine
3134 ? (catalyst_engine_class => $requested_engine) : ()),
3139 $class->engine_loader->catalyst_engine_class;
3143 my ($class, $requested_engine) = @_;
3146 my $loader = $class->engine_loader;
3148 if (!$loader || $requested_engine) {
3149 $loader = Catalyst::EngineLoader->new({
3150 application_name => $class,
3151 (defined $requested_engine
3152 ? (requested_engine => $requested_engine) : ()),
3155 $class->engine_loader($loader);
3158 $loader->catalyst_engine_class;
3161 # Don't really setup_engine -- see _setup_psgi_app for explanation.
3162 return if $class->loading_psgi_file;
3164 load_class($engine);
3166 if ($ENV{MOD_PERL}) {
3167 my $apache = $class->engine_loader->auto;
3169 my $meta = find_meta($class);
3170 my $was_immutable = $meta->is_immutable;
3171 my %immutable_options = $meta->immutable_options;
3172 $meta->make_mutable if $was_immutable;
3174 $meta->add_method(handler => sub {
3176 my $psgi_app = $class->_finalized_psgi_app;
3177 $apache->call_app($r, $psgi_app);
3180 $meta->make_immutable(%immutable_options) if $was_immutable;
3183 $class->engine( $engine->new );
3188 ## This exists just to supply a prebuild psgi app for mod_perl and for the
3189 ## build in server support (back compat support for pre psgi port behavior).
3190 ## This is so that we don't build a new psgi app for each request when using
3191 ## the mod_perl handler or the built in servers (http and fcgi, etc).
3193 sub _finalized_psgi_app {
3196 unless ($app->_psgi_app) {
3197 my $psgi_app = $app->_setup_psgi_app;
3198 $app->_psgi_app($psgi_app);
3201 return $app->_psgi_app;
3204 ## Look for a psgi file like 'myapp_web.psgi' (if the app is MyApp::Web) in the
3205 ## home directory and load that and return it (just assume it is doing the
3206 ## right thing :) ). If that does not exist, call $app->psgi_app, wrap that
3207 ## in default_middleware and return it ( this is for backward compatibility
3208 ## with pre psgi port behavior ).
3210 sub _setup_psgi_app {
3213 for my $home (Path::Class::Dir->new($app->config->{home})) {
3214 my $psgi_file = $home->file(
3215 Catalyst::Utils::appprefix($app) . '.psgi',
3218 next unless -e $psgi_file;
3220 # If $psgi_file calls ->setup_engine, it's doing so to load
3221 # Catalyst::Engine::PSGI. But if it does that, we're only going to
3222 # throw away the loaded PSGI-app and load the 5.9 Catalyst::Engine
3223 # anyway. So set a flag (ick) that tells setup_engine not to populate
3224 # $c->engine or do any other things we might regret.
3226 $app->loading_psgi_file(1);
3227 my $psgi_app = Plack::Util::load_psgi($psgi_file);
3228 $app->loading_psgi_file(0);
3231 unless $app->engine_loader->needs_psgi_engine_compat_hack;
3234 Found a legacy Catalyst::Engine::PSGI .psgi file at ${psgi_file}.
3236 Its content has been ignored. Please consult the Catalyst::Upgrading
3237 documentation on how to upgrade from Catalyst::Engine::PSGI.
3241 return $app->apply_default_middlewares($app->psgi_app);
3244 =head2 $c->apply_default_middlewares
3246 Adds the following L<Plack> middlewares to your application, since they are
3247 useful and commonly needed:
3249 L<Plack::Middleware::LighttpdScriptNameFix> (if you are using Lighttpd),
3250 L<Plack::Middleware::IIS6ScriptNameFix> (always applied since this middleware
3251 is smart enough to conditionally apply itself).
3253 We will also automatically add L<Plack::Middleware::ReverseProxy> if we notice
3254 that your HTTP $env variable C<REMOTE_ADDR> is '127.0.0.1'. This is usually
3255 an indication that your server is running behind a proxy frontend. However in
3256 2014 this is often not the case. We preserve this code for backwards compatibility
3257 however I B<highly> recommend that if you are running the server behind a front
3258 end proxy that you clearly indicate so with the C<using_frontend_proxy> configuration
3259 setting to true for your environment configurations that run behind a proxy. This
3260 way if you change your front end proxy address someday your code would inexplicably
3261 stop working as expected.
3263 Additionally if we detect we are using Nginx, we add a bit of custom middleware
3264 to solve some problems with the way that server handles $ENV{PATH_INFO} and
3267 Please B<NOTE> that if you do use C<using_frontend_proxy> the middleware is now
3268 adding via C<registered_middleware> rather than this method.
3270 If you are using Lighttpd or IIS6 you may wish to apply these middlewares. In
3271 general this is no longer a common case but we have this here for backward
3277 sub apply_default_middlewares {
3278 my ($app, $psgi_app) = @_;
3280 # Don't add this conditional IF we are explicitly saying we want the
3281 # frontend proxy support. We don't need it here since if that is the
3282 # case it will be always loaded in the default_middleware.
3284 unless($app->config->{using_frontend_proxy}) {
3285 $psgi_app = Plack::Middleware::Conditional->wrap(
3287 builder => sub { Plack::Middleware::ReverseProxy->wrap($_[0]) },
3290 return if $app->config->{ignore_frontend_proxy};
3291 return $env->{REMOTE_ADDR} eq '127.0.0.1';
3296 # If we're running under Lighttpd, swap PATH_INFO and SCRIPT_NAME
3297 # http://lists.scsys.co.uk/pipermail/catalyst/2006-June/008361.html
3298 $psgi_app = Plack::Middleware::Conditional->wrap(
3300 builder => sub { Plack::Middleware::LighttpdScriptNameFix->wrap($_[0]) },
3303 return unless $env->{SERVER_SOFTWARE} && $env->{SERVER_SOFTWARE} =~ m!lighttpd[-/]1\.(\d+\.\d+)!;
3304 return unless $1 < 4.23;
3309 # we're applying this unconditionally as the middleware itself already makes
3310 # sure it doesn't fuck things up if it's not running under one of the right
3312 $psgi_app = Plack::Middleware::IIS6ScriptNameFix->wrap($psgi_app);
3314 # And another IIS issue, this time with IIS7.
3315 $psgi_app = Plack::Middleware::Conditional->wrap(
3317 builder => sub { Plack::Middleware::IIS7KeepAliveFix->wrap($_[0]) },
3320 return $env->{SERVER_SOFTWARE} && $env->{SERVER_SOFTWARE} =~ m!IIS/7\.[0-9]!;
3327 =head2 App->psgi_app
3331 Returns a PSGI application code reference for the catalyst application
3332 C<$c>. This is the bare application created without the C<apply_default_middlewares>
3333 method called. We do however apply C<registered_middleware> since those are
3334 integral to how L<Catalyst> functions. Also, unlike starting your application
3335 with a generated server script (via L<Catalyst::Devel> and C<catalyst.pl>) we do
3336 not attempt to return a valid L<PSGI> application using any existing C<${myapp}.psgi>
3337 scripts in your $HOME directory.
3339 B<NOTE> C<apply_default_middlewares> was originally created when the first PSGI
3340 port was done for v5.90000. These are middlewares that are added to achieve
3341 backward compatibility with older applications. If you start your application
3342 using one of the supplied server scripts (generated with L<Catalyst::Devel> and
3343 the project skeleton script C<catalyst.pl>) we apply C<apply_default_middlewares>
3344 automatically. This was done so that pre and post PSGI port applications would
3347 This is what you want to be using to retrieve the PSGI application code
3348 reference of your Catalyst application for use in a custom F<.psgi> or in your
3349 own created server modules.
3353 *to_app = \&psgi_app;
3357 my $psgi = $app->engine->build_psgi_app($app);
3358 return $app->Catalyst::Utils::apply_registered_middleware($psgi);
3361 =head2 $c->setup_home
3363 Sets up the home directory.
3368 my ( $class, $home ) = @_;
3370 if ( my $env = Catalyst::Utils::env_value( $class, 'HOME' ) ) {
3374 $home ||= Catalyst::Utils::home($class);
3377 #I remember recently being scolded for assigning config values like this
3378 $class->config->{home} ||= $home;
3379 $class->config->{root} ||= Path::Class::Dir->new($home)->subdir('root');
3383 =head2 $c->setup_encoding
3385 Sets up the input/output encoding. See L<ENCODING>
3389 sub setup_encoding {
3391 if( exists($c->config->{encoding}) && !defined($c->config->{encoding}) ) {
3392 # Ok, so the user has explicitly said "I don't want encoding..."
3395 my $enc = defined($c->config->{encoding}) ?
3396 delete $c->config->{encoding} : 'UTF-8'; # not sure why we delete it... (JNAP)
3401 =head2 handle_unicode_encoding_exception
3403 Hook to let you customize how encoding errors are handled. By default
3404 we just throw an exception. Receives a hashref of debug information.
3407 $c->handle_unicode_encoding_exception({
3408 param_value => $value,
3410 encoding_step => 'params',
3415 sub handle_unicode_encoding_exception {
3416 my ( $self, $exception_ctx ) = @_;
3417 die $exception_ctx->{error_msg};
3420 # Some unicode helpers cargo culted from the old plugin. These could likely
3423 sub _handle_unicode_decoding {
3424 my ( $self, $value ) = @_;
3426 return unless defined $value;
3428 ## I think this mess is to support the old nested
3429 if ( ref $value eq 'ARRAY' ) {
3430 foreach ( @$value ) {
3431 $_ = $self->_handle_unicode_decoding($_);
3435 elsif ( ref $value eq 'HASH' ) {
3436 foreach (keys %$value) {
3437 my $encoded_key = $self->_handle_param_unicode_decoding($_);
3438 $value->{$encoded_key} = $self->_handle_unicode_decoding($value->{$_});
3440 # If the key was encoded we now have two (the original and current so
3441 # delete the original.
3442 delete $value->{$_} if $_ ne $encoded_key;
3447 return $self->_handle_param_unicode_decoding($value);
3451 sub _handle_param_unicode_decoding {
3452 my ( $self, $value ) = @_;
3453 return unless defined $value; # not in love with just ignoring undefs - jnap
3454 return $value if blessed($value); #don't decode when the value is an object.
3456 my $enc = $self->encoding;
3458 $enc->decode( $value, $self->_encode_check );
3461 $self->handle_unicode_encoding_exception({
3462 param_value => $value,
3464 encoding_step => 'params',
3469 =head2 $c->setup_log
3471 Sets up log by instantiating a L<Catalyst::Log|Catalyst::Log> object and
3472 passing it to C<log()>. Pass in a comma-delimited list of levels to set the
3475 This method also installs a C<debug> method that returns a true value into the
3476 catalyst subclass if the "debug" level is passed in the comma-delimited list,
3477 or if the C<$CATALYST_DEBUG> environment variable is set to a true value.
3479 Note that if the log has already been setup, by either a previous call to
3480 C<setup_log> or by a call such as C<< __PACKAGE__->log( MyLogger->new ) >>,
3481 that this method won't actually set up the log object.
3486 my ( $class, $levels ) = @_;
3489 $levels =~ s/^\s+//;
3490 $levels =~ s/\s+$//;
3491 my %levels = map { $_ => 1 } split /\s*,\s*/, $levels;
3493 my $env_debug = Catalyst::Utils::env_value( $class, 'DEBUG' );
3494 if ( defined $env_debug ) {
3495 $levels{debug} = 1 if $env_debug; # Ugly!
3496 delete($levels{debug}) unless $env_debug;
3499 unless ( $class->log ) {
3500 $class->log( Catalyst::Log->new(keys %levels) );
3503 if ( $levels{debug} ) {
3504 Class::MOP::get_metaclass_by_name($class)->add_method('debug' => sub { 1 });
3505 $class->log->debug('Debug messages enabled');
3509 =head2 $c->setup_plugins
3515 =head2 $c->setup_stats
3517 Sets up timing statistics class.
3522 my ( $class, $stats ) = @_;
3524 Catalyst::Utils::ensure_class_loaded($class->stats_class);
3526 my $env = Catalyst::Utils::env_value( $class, 'STATS' );
3527 if ( defined($env) ? $env : ($stats || $class->debug ) ) {
3528 Class::MOP::get_metaclass_by_name($class)->add_method('use_stats' => sub { 1 });
3529 $class->log->debug('Statistics enabled');
3534 =head2 $c->registered_plugins
3536 Returns a sorted list of the plugins which have either been stated in the
3539 If passed a given plugin name, it will report a boolean value indicating
3540 whether or not that plugin is loaded. A fully qualified name is required if
3541 the plugin name does not begin with C<Catalyst::Plugin::>.
3543 if ($c->registered_plugins('Some::Plugin')) {
3551 sub registered_plugins {
3553 return sort keys %{ $proto->_plugins } unless @_;
3555 return 1 if exists $proto->_plugins->{$plugin};
3556 return exists $proto->_plugins->{"Catalyst::Plugin::$plugin"};
3559 sub _register_plugin {
3560 my ( $proto, $plugin, $instant ) = @_;
3561 my $class = ref $proto || $proto;
3563 load_class( $plugin );
3564 $class->log->warn( "$plugin inherits from 'Catalyst::Component' - this is deprecated and will not work in 5.81" )
3565 if $plugin->isa( 'Catalyst::Component' );
3566 my $plugin_meta = Moose::Meta::Class->create($plugin);
3567 if (!$plugin_meta->has_method('new')
3568 && ( $plugin->isa('Class::Accessor::Fast') || $plugin->isa('Class::Accessor') ) ) {
3569 $plugin_meta->add_method('new', Moose::Object->meta->get_method('new'))
3571 if (!$instant && !$proto->_plugins->{$plugin}) {
3572 my $meta = Class::MOP::get_metaclass_by_name($class);
3573 $meta->superclasses($plugin, $meta->superclasses);
3575 $proto->_plugins->{$plugin} = 1;
3579 sub _default_plugins { return qw() }
3582 my ( $class, $plugins ) = @_;
3584 $class->_plugins( {} ) unless $class->_plugins;
3586 m/Unicode::Encoding/ ? do {
3588 'Unicode::Encoding plugin is auto-applied,'
3589 . ' please remove this from your appclass'
3590 . ' and make sure to define "encoding" config'
3592 unless (exists $class->config->{'encoding'}) {
3593 $class->config->{'encoding'} = 'UTF-8';
3598 push @$plugins, $class->_default_plugins;
3599 $plugins = Data::OptList::mkopt($plugins || []);
3602 [ Catalyst::Utils::resolve_namespace(
3603 $class . '::Plugin',
3604 'Catalyst::Plugin', $_->[0]
3610 for my $plugin ( reverse @plugins ) {
3611 load_class($plugin->[0], $plugin->[1]);
3612 my $meta = find_meta($plugin->[0]);
3613 next if $meta && $meta->isa('Moose::Meta::Role');
3615 $class->_register_plugin($plugin->[0]);
3619 map { $_->[0]->name, $_->[1] }
3620 grep { blessed($_->[0]) && $_->[0]->isa('Moose::Meta::Role') }
3621 map { [find_meta($_->[0]), $_->[1]] }
3624 Moose::Util::apply_all_roles(
3630 =head2 default_middleware
3632 Returns a list of instantiated PSGI middleware objects which is the default
3633 middleware that is active for this application (taking any configuration
3634 options into account, excluding your custom added middleware via the C<psgi_middleware>
3635 configuration option). You can override this method if you wish to change
3636 the default middleware (although do so at risk since some middleware is vital
3637 to application function.)
3639 The current default middleware list is:
3641 Catalyst::Middleware::Stash
3642 Plack::Middleware::HTTPExceptions
3643 Plack::Middleware::RemoveRedundantBody
3644 Plack::Middleware::FixMissingBodyInRedirect
3645 Plack::Middleware::ContentLength
3646 Plack::Middleware::MethodOverride
3647 Plack::Middleware::Head
3649 If the configuration setting C<using_frontend_proxy> is true we add:
3651 Plack::Middleware::ReverseProxy
3653 If the configuration setting C<using_frontend_proxy_path> is true we add:
3655 Plack::Middleware::ReverseProxyPath
3657 But B<NOTE> that L<Plack::Middleware::ReverseProxyPath> is not a dependency of the
3658 L<Catalyst> distribution so if you want to use this option you should add it to
3659 your project distribution file.
3661 These middlewares will be added at L</setup_middleware> during the
3662 L</setup> phase of application startup.
3666 sub default_middleware {
3669 Catalyst::Middleware::Stash->new,
3670 Plack::Middleware::HTTPExceptions->new,
3671 Plack::Middleware::RemoveRedundantBody->new,
3672 Plack::Middleware::FixMissingBodyInRedirect->new,
3673 Plack::Middleware::ContentLength->new,
3674 Plack::Middleware::MethodOverride->new,
3675 Plack::Middleware::Head->new);
3677 if($class->config->{using_frontend_proxy}) {
3678 push @mw, Plack::Middleware::ReverseProxy->new;
3681 if($class->config->{using_frontend_proxy_path}) {
3682 if(Class::Load::try_load_class('Plack::Middleware::ReverseProxyPath')) {
3683 push @mw, Plack::Middleware::ReverseProxyPath->new;
3685 $class->log->error("Cannot use configuration 'using_frontend_proxy_path' because 'Plack::Middleware::ReverseProxyPath' is not installed");
3692 =head2 registered_middlewares
3694 Read only accessor that returns an array of all the middleware in the order
3695 that they were added (which is the REVERSE of the order they will be applied).
3697 The values returned will be either instances of L<Plack::Middleware> or of a
3698 compatible interface, or a coderef, which is assumed to be inlined middleware
3700 =head2 setup_middleware (?@middleware)
3702 Read configuration information stored in configuration key C<psgi_middleware> or
3705 See under L</CONFIGURATION> information regarding C<psgi_middleware> and how
3706 to use it to enable L<Plack::Middleware>
3708 This method is automatically called during 'setup' of your application, so
3709 you really don't need to invoke it. However you may do so if you find the idea
3710 of loading middleware via configuration weird :). For example:
3716 __PACKAGE__->setup_middleware('Head');
3719 When we read middleware definitions from configuration, we reverse the list
3720 which sounds odd but is likely how you expect it to work if you have prior
3721 experience with L<Plack::Builder> or if you previously used the plugin
3722 L<Catalyst::Plugin::EnableMiddleware> (which is now considered deprecated)
3724 So basically your middleware handles an incoming request from the first
3725 registered middleware, down and handles the response from the last middleware
3730 sub registered_middlewares {
3732 if(my $middleware = $class->_psgi_middleware) {
3733 my @mw = ($class->default_middleware, @$middleware);
3735 if($class->config->{using_frontend_proxy}) {
3736 push @mw, Plack::Middleware::ReverseProxy->new;
3741 die "You cannot call ->registered_middlewares until middleware has been setup";
3745 sub setup_middleware {
3747 my @middleware_definitions;
3749 # If someone calls this method you can add middleware with args. However if its
3750 # called without an arg we need to setup the configuration middleware.
3752 @middleware_definitions = reverse(@_);
3754 @middleware_definitions = reverse(@{$class->config->{'psgi_middleware'}||[]})
3755 unless $class->finalized_default_middleware;
3756 $class->finalized_default_middleware(1); # Only do this once, just in case some people call setup over and over...
3759 my @middleware = ();
3760 while(my $next = shift(@middleware_definitions)) {
3762 if(Scalar::Util::blessed $next && $next->can('wrap')) {
3763 push @middleware, $next;
3764 } elsif(ref $next eq 'CODE') {
3765 push @middleware, $next;
3766 } elsif(ref $next eq 'HASH') {
3767 my $namespace = shift @middleware_definitions;
3768 my $mw = $class->Catalyst::Utils::build_middleware($namespace, %$next);
3769 push @middleware, $mw;
3771 die "I can't handle middleware definition ${\ref $next}";
3774 my $mw = $class->Catalyst::Utils::build_middleware($next);
3775 push @middleware, $mw;
3779 my @existing = @{$class->_psgi_middleware || []};
3780 $class->_psgi_middleware([@middleware,@existing,]);
3783 =head2 registered_data_handlers
3785 A read only copy of registered Data Handlers returned as a Hash, where each key
3786 is a content type and each value is a subref that attempts to decode that content
3789 =head2 setup_data_handlers (?@data_handler)
3791 Read configuration information stored in configuration key C<data_handlers> or
3794 See under L</CONFIGURATION> information regarding C<data_handlers>.
3796 This method is automatically called during 'setup' of your application, so
3797 you really don't need to invoke it.
3799 =head2 default_data_handlers
3801 Default Data Handlers that come bundled with L<Catalyst>. Currently there are
3802 only two default data handlers, for 'application/json' and an alternative to
3803 'application/x-www-form-urlencoded' which supposed nested form parameters via
3804 L<CGI::Struct> or via L<CGI::Struct::XS> IF you've installed it.
3806 The 'application/json' data handler is used to parse incoming JSON into a Perl
3807 data structure. It used either L<JSON::MaybeXS> or L<JSON>, depending on which
3808 is installed. This allows you to fail back to L<JSON:PP>, which is a Pure Perl
3809 JSON decoder, and has the smallest dependency impact.
3811 Because we don't wish to add more dependencies to L<Catalyst>, if you wish to
3812 use this new feature we recommend installing L<JSON> or L<JSON::MaybeXS> in
3813 order to get the best performance. You should add either to your dependency
3814 list (Makefile.PL, dist.ini, cpanfile, etc.)
3818 sub registered_data_handlers {
3820 if(my $data_handlers = $class->_data_handlers) {
3821 return %$data_handlers;
3823 $class->setup_data_handlers;
3824 return $class->registered_data_handlers;
3828 sub setup_data_handlers {
3829 my ($class, %data_handler_callbacks) = @_;
3830 %data_handler_callbacks = (
3831 %{$class->default_data_handlers},
3832 %{$class->config->{'data_handlers'}||+{}},
3833 %data_handler_callbacks);
3835 $class->_data_handlers(\%data_handler_callbacks);
3838 sub default_data_handlers {
3841 'application/x-www-form-urlencoded' => sub {
3842 my ($fh, $req) = @_;
3843 my $params = $req->_use_hash_multivalue ? $req->body_parameters->mixed : $req->body_parameters;
3844 Class::Load::load_first_existing_class('CGI::Struct::XS', 'CGI::Struct')
3845 ->can('build_cgi_struct')->($params);
3847 'application/json' => sub {
3848 my ($fh, $req) = @_;
3849 my $parser = Class::Load::load_first_existing_class('JSON::MaybeXS', 'JSON');
3853 $slurped = $fh->getline;
3854 $parser->can("decode_json")->($slurped); # decode_json does utf8 decoding for us
3855 } || Catalyst::Exception->throw(sprintf "Error Parsing POST '%s', Error: %s", (defined($slurped) ? $slurped : 'undef') ,$@);
3860 sub _handle_http_exception {
3861 my ( $self, $error ) = @_;
3863 !$self->config->{always_catch_http_exceptions}
3866 $error->can('as_psgi')
3867 || ( $error->can('code')
3868 && $error->code =~ m/^[1-5][0-9][0-9]$/ )
3878 Returns an arrayref of the internal execution stack (actions that are
3879 currently executing).
3883 Returns the current timing statistics object. By default Catalyst uses
3884 L<Catalyst::Stats|Catalyst::Stats>, but can be set otherwise with
3885 L<< stats_class|/"$c->stats_class" >>.
3887 Even if L<< -Stats|/"-Stats" >> is not enabled, the stats object is still
3888 available. By enabling it with C< $c->stats->enabled(1) >, it can be used to
3889 profile explicitly, although MyApp.pm still won't profile nor output anything
3892 =head2 $c->stats_class
3894 Returns or sets the stats (timing statistics) class. L<Catalyst::Stats|Catalyst::Stats> is used by default.
3896 =head2 $app->stats_class_traits
3898 A arrayref of L<Moose::Role>s that are applied to the stats_class before creating it.
3900 =head2 $app->composed_stats_class
3902 this is the stats_class composed with any 'stats_class_traits'.
3904 =head2 $c->use_stats
3906 Returns 1 when L<< stats collection|/"-Stats" >> is enabled.
3908 Note that this is a static method, not an accessor and should be overridden
3909 by declaring C<sub use_stats { 1 }> in your MyApp.pm, not by calling C<< $c->use_stats(1) >>.
3916 =head2 $c->write( $data )
3918 Writes $data to the output stream. When using this method directly, you
3919 will need to manually set the C<Content-Length> header to the length of
3920 your output data, if known.
3927 # Finalize headers if someone manually writes output (for compat)
3928 $c->finalize_headers;
3930 return $c->response->write( @_ );
3935 Returns the Catalyst version number. Mostly useful for "powered by"
3936 messages in template systems.
3940 sub version { return $Catalyst::VERSION }
3942 =head1 CONFIGURATION
3944 There are a number of 'base' config variables which can be set:
3950 C<always_catch_http_exceptions> - As of version 5.90060 Catalyst
3951 rethrows errors conforming to the interface described by
3952 L<Plack::Middleware::HTTPExceptions> and lets the middleware deal with it.
3953 Set true to get the deprecated behaviour and have Catalyst catch HTTP exceptions.
3957 C<default_model> - The default model picked if you say C<< $c->model >>. See L<< /$c->model($name) >>.
3961 C<default_view> - The default view to be rendered or returned when C<< $c->view >> is called. See L<< /$c->view($name) >>.
3965 C<disable_component_resolution_regex_fallback> - Turns
3966 off the deprecated component resolution functionality so
3967 that if any of the component methods (e.g. C<< $c->controller('Foo') >>)
3968 are called then regex search will not be attempted on string values and
3969 instead C<undef> will be returned.
3973 C<home> - The application home directory. In an uninstalled application,
3974 this is the top level application directory. In an installed application,
3975 this will be the directory containing C<< MyApp.pm >>.
3979 C<ignore_frontend_proxy> - See L</PROXY SUPPORT>
3983 C<name> - The name of the application in debug messages and the debug and
3988 C<parse_on_demand> - The request body (for example file uploads) will not be parsed
3989 until it is accessed. This allows you to (for example) check authentication (and reject
3990 the upload) before actually receiving all the data. See L</ON-DEMAND PARSER>
3994 C<root> - The root directory for templates. Usually this is just a
3995 subdirectory of the home directory, but you can set it to change the
3996 templates to a different directory.
4000 C<search_extra> - Array reference passed to Module::Pluggable to for additional
4001 namespaces from which components will be loaded (and constructed and stored in
4002 C<< $c->components >>).
4006 C<show_internal_actions> - If true, causes internal actions such as C<< _DISPATCH >>
4007 to be shown in hit debug tables in the test server.
4011 C<use_request_uri_for_path> - Controls if the C<REQUEST_URI> or C<PATH_INFO> environment
4012 variable should be used for determining the request path.
4014 Most web server environments pass the requested path to the application using environment variables,
4015 from which Catalyst has to reconstruct the request base (i.e. the top level path to / in the application,
4016 exposed as C<< $c->request->base >>) and the request path below that base.
4018 There are two methods of doing this, both of which have advantages and disadvantages. Which method is used
4019 is determined by the C<< $c->config(use_request_uri_for_path) >> setting (which can either be true or false).
4023 =item use_request_uri_for_path => 0
4025 This is the default (and the) traditional method that Catalyst has used for determining the path information.
4026 The path is generated from a combination of the C<PATH_INFO> and C<SCRIPT_NAME> environment variables.
4027 The allows the application to behave correctly when C<mod_rewrite> is being used to redirect requests
4028 into the application, as these variables are adjusted by mod_rewrite to take account for the redirect.
4030 However this method has the major disadvantage that it is impossible to correctly decode some elements
4031 of the path, as RFC 3875 says: "C<< Unlike a URI path, the PATH_INFO is not URL-encoded, and cannot
4032 contain path-segment parameters. >>" This means PATH_INFO is B<always> decoded, and therefore Catalyst
4033 can't distinguish / vs %2F in paths (in addition to other encoded values).
4035 =item use_request_uri_for_path => 1
4037 This method uses the C<REQUEST_URI> and C<SCRIPT_NAME> environment variables. As C<REQUEST_URI> is never
4038 decoded, this means that applications using this mode can correctly handle URIs including the %2F character
4039 (i.e. with C<AllowEncodedSlashes> set to C<On> in Apache).
4041 Given that this method of path resolution is provably more correct, it is recommended that you use
4042 this unless you have a specific need to deploy your application in a non-standard environment, and you are
4043 aware of the implications of not being able to handle encoded URI paths correctly.
4045 However it also means that in a number of cases when the app isn't installed directly at a path, but instead
4046 is having paths rewritten into it (e.g. as a .cgi/fcgi in a public_html directory, with mod_rewrite in a
4047 .htaccess file, or when SSI is used to rewrite pages into the app, or when sub-paths of the app are exposed
4048 at other URIs than that which the app is 'normally' based at with C<mod_rewrite>), the resolution of
4049 C<< $c->request->base >> will be incorrect.
4055 C<using_frontend_proxy> - See L</PROXY SUPPORT>.
4059 C<using_frontend_proxy_path> - Enabled L<Plack::Middleware::ReverseProxyPath> on your application (if
4060 installed, otherwise log an error). This is useful if your application is not running on the
4061 'root' (or /) of your host server. B<NOTE> if you use this feature you should add the required
4062 middleware to your project dependency list since its not automatically a dependency of L<Catalyst>.
4063 This has been done since not all people need this feature and we wish to restrict the growth of
4064 L<Catalyst> dependencies.
4068 C<encoding> - See L</ENCODING>
4070 This now defaults to 'UTF-8'. You my turn it off by setting this configuration
4075 C<abort_chain_on_error_fix>
4077 When there is an error in an action chain, the default behavior is to continue
4078 processing the remaining actions and then catch the error upon chain end. This
4079 can lead to running actions when the application is in an unexpected state. If
4080 you have this issue, setting this config value to true will promptly exit a
4081 chain when there is an error raised in any action (thus terminating the chain
4086 __PACKAGE__->config(abort_chain_on_error_fix => 1);
4088 In the future this might become the default behavior.
4092 C<use_hash_multivalue_in_request>
4094 In L<Catalyst::Request> the methods C<query_parameters>, C<body_parametes>
4095 and C<parameters> return a hashref where values might be scalar or an arrayref
4096 depending on the incoming data. In many cases this can be undesirable as it
4097 leads one to writing defensive code like the following:
4099 my ($val) = ref($c->req->parameters->{a}) ?
4100 @{$c->req->parameters->{a}} :
4101 $c->req->parameters->{a};
4103 Setting this configuration item to true will make L<Catalyst> populate the
4104 attributes underlying these methods with an instance of L<Hash::MultiValue>
4105 which is used by L<Plack::Request> and others to solve this very issue. You
4106 may prefer this behavior to the default, if so enable this option (be warned
4107 if you enable it in a legacy application we are not sure if it is completely
4108 backwardly compatible).
4112 C<skip_complex_post_part_handling>
4114 When creating body parameters from a POST, if we run into a multpart POST
4115 that does not contain uploads, but instead contains inlined complex data
4116 (very uncommon) we cannot reliably convert that into field => value pairs. So
4117 instead we create an instance of L<Catalyst::Request::PartData>. If this causes
4118 issue for you, you can disable this by setting C<skip_complex_post_part_handling>
4119 to true (default is false).
4123 C<skip_body_param_unicode_decoding>
4125 Generally we decode incoming POST params based on your declared encoding (the
4126 default for this is to decode UTF-8). If this is causing you trouble and you
4127 do not wish to turn all encoding support off (with the C<encoding> configuration
4128 parameter) you may disable this step atomically by setting this configuration
4133 C<do_not_decode_query>
4135 If true, then do not try to character decode any wide characters in your
4136 request URL query or keywords. Most readings of the relevent specifications
4137 suggest these should be UTF-* encoded, which is the default that L<Catalyst>
4138 will use, hwoever if you are creating a lot of URLs manually or have external
4139 evil clients, this might cause you trouble. If you find the changes introduced
4140 in Catalyst version 5.90080+ break some of your query code, you may disable
4141 the UTF-8 decoding globally using this configuration.
4143 This setting takes precedence over C<default_query_encoding> and
4144 C<decode_query_using_global_encoding>
4148 C<default_query_encoding>
4150 By default we decode query and keywords in your request URL using UTF-8, which
4151 is our reading of the relevent specifications. This setting allows one to
4152 specify a fixed value for how to decode your query. You might need this if
4153 you are doing a lot of custom encoding of your URLs and not using UTF-8.
4155 This setting take precedence over C<decode_query_using_global_encoding>.
4159 C<decode_query_using_global_encoding>
4161 Setting this to true will default your query decoding to whatever your
4162 general global encoding is (the default is UTF-8).
4166 C<use_chained_args_0_special_case>
4168 In older versions of Catalyst, when more than one action matched the same path
4169 AND all those matching actions declared Args(0), we'd break the tie by choosing
4170 the first action defined. We now normalized how Args(0) works so that it
4171 follows the same rule as Args(N), which is to say when we need to break a tie
4172 we choose the LAST action defined. If this breaks your code and you don't
4173 have time to update to follow the new normalized approach, you may set this
4174 value to true and it will globally revert to the original chaining behavior.
4178 C<psgi_middleware> - See L<PSGI MIDDLEWARE>.
4182 C<data_handlers> - See L<DATA HANDLERS>.
4186 C<stats_class_traits>
4188 An arrayref of L<Moose::Role>s that get componsed into your stats class.
4192 C<request_class_traits>
4194 An arrayref of L<Moose::Role>s that get componsed into your request class.
4198 C<response_class_traits>
4200 An arrayref of L<Moose::Role>s that get componsed into your response class.
4204 C<inject_components>
4206 A Hashref of L<Catalyst::Component> subclasses that are 'injected' into configuration.
4210 inject_components => {
4211 'Controller::Err' => { from_component => 'Local::Controller::Errors' },
4212 'Model::Zoo' => { from_component => 'Local::Model::Foo' },
4213 'Model::Foo' => { from_component => 'Local::Model::Foo', roles => ['TestRole'] },
4215 'Controller::Err' => { a => 100, b=>200, namespace=>'error' },
4216 'Model::Zoo' => { a => 2 },
4217 'Model::Foo' => { a => 100 },
4220 Generally L<Catalyst> looks for components in your Model/View or Controller directories.
4221 However for cases when you which to use an existing component and you don't need any
4222 customization (where for when you can apply a role to customize it) you may inject those
4223 components into your application. Please note any configuration should be done 'in the
4224 normal way', with a key under configuration named after the component affix, as in the
4227 Using this type of injection allows you to construct significant amounts of your application
4228 with only configuration!. This may or may not lead to increased code understanding.
4230 Please not you may also call the ->inject_components application method as well, although
4231 you must do so BEFORE setup.
4237 Generally when you throw an exception inside an Action (or somewhere in
4238 your stack, such as in a model that an Action is calling) that exception
4239 is caught by Catalyst and unless you either catch it yourself (via eval
4240 or something like L<Try::Tiny> or by reviewing the L</error> stack, it
4241 will eventually reach L</finalize_errors> and return either the debugging
4242 error stack page, or the default error page. However, if your exception
4243 can be caught by L<Plack::Middleware::HTTPExceptions>, L<Catalyst> will
4244 instead rethrow it so that it can be handled by that middleware (which
4245 is part of the default middleware). For example this would allow
4247 use HTTP::Throwable::Factory 'http_throw';
4249 sub throws_exception :Local {
4250 my ($self, $c) = @_;
4252 http_throw(SeeOther => { location =>
4253 $c->uri_for($self->action_for('redirect')) });
4257 =head1 INTERNAL ACTIONS
4259 Catalyst uses internal actions like C<_DISPATCH>, C<_BEGIN>, C<_AUTO>,
4260 C<_ACTION>, and C<_END>. These are by default not shown in the private
4261 action table, but you can make them visible with a config parameter.
4263 MyApp->config(show_internal_actions => 1);
4265 =head1 ON-DEMAND PARSER
4267 The request body is usually parsed at the beginning of a request,
4268 but if you want to handle input yourself, you can enable on-demand
4269 parsing with a config parameter.
4271 MyApp->config(parse_on_demand => 1);
4273 =head1 PROXY SUPPORT
4275 Many production servers operate using the common double-server approach,
4276 with a lightweight frontend web server passing requests to a larger
4277 backend server. An application running on the backend server must deal
4278 with two problems: the remote user always appears to be C<127.0.0.1> and
4279 the server's hostname will appear to be C<localhost> regardless of the
4280 virtual host that the user connected through.
4282 Catalyst will automatically detect this situation when you are running
4283 the frontend and backend servers on the same machine. The following
4284 changes are made to the request.
4286 $c->req->address is set to the user's real IP address, as read from
4287 the HTTP X-Forwarded-For header.
4289 The host value for $c->req->base and $c->req->uri is set to the real
4290 host, as read from the HTTP X-Forwarded-Host header.
4292 Additionally, you may be running your backend application on an insecure
4293 connection (port 80) while your frontend proxy is running under SSL. If there
4294 is a discrepancy in the ports, use the HTTP header C<X-Forwarded-Port> to
4295 tell Catalyst what port the frontend listens on. This will allow all URIs to
4296 be created properly.
4298 In the case of passing in:
4300 X-Forwarded-Port: 443
4302 All calls to C<uri_for> will result in an https link, as is expected.
4304 Obviously, your web server must support these headers for this to work.
4306 In a more complex server farm environment where you may have your
4307 frontend proxy server(s) on different machines, you will need to set a
4308 configuration option to tell Catalyst to read the proxied data from the
4311 MyApp->config(using_frontend_proxy => 1);
4313 If you do not wish to use the proxy support at all, you may set:
4315 MyApp->config(ignore_frontend_proxy => 0);
4317 =head2 Note about psgi files
4319 Note that if you supply your own .psgi file, calling
4320 C<< MyApp->psgi_app(@_); >>, then B<this will not happen automatically>.
4322 You either need to apply L<Plack::Middleware::ReverseProxy> yourself
4323 in your psgi, for example:
4326 enable "Plack::Middleware::ReverseProxy";
4330 This will unconditionally add the ReverseProxy support, or you need to call
4331 C<< $app = MyApp->apply_default_middlewares($app) >> (to conditionally
4332 apply the support depending upon your config).
4334 See L<Catalyst::PSGI> for more information.
4336 =head1 THREAD SAFETY
4338 Catalyst has been tested under Apache 2's threading C<mpm_worker>,
4339 C<mpm_winnt>, and the standalone forking HTTP server on Windows. We
4340 believe the Catalyst core to be thread-safe.
4342 If you plan to operate in a threaded environment, remember that all other
4343 modules you are using must also be thread-safe. Some modules, most notably
4344 L<DBD::SQLite>, are not thread-safe.
4346 =head1 DATA HANDLERS
4348 The L<Catalyst::Request> object uses L<HTTP::Body> to populate 'classic' HTML
4349 form parameters and URL search query fields. However it has become common
4350 for various alternative content types to be PUT or POSTed to your controllers
4351 and actions. People working on RESTful APIs, or using AJAX often use JSON,
4352 XML and other content types when communicating with an application server. In
4353 order to better support this use case, L<Catalyst> defines a global configuration
4354 option, C<data_handlers>, which lets you associate a content type with a coderef
4355 that parses that content type into something Perl can readily access.
4362 __PACKAGE__->config(
4364 'application/json' => sub { local $/; decode_json $_->getline },
4366 ## Any other configuration.
4371 By default L<Catalyst> comes with a generic JSON data handler similar to the
4372 example given above, which uses L<JSON::Maybe> to provide either L<JSON::PP>
4373 (a pure Perl, dependency free JSON parser) or L<Cpanel::JSON::XS> if you have
4374 it installed (if you want the faster XS parser, add it to you project Makefile.PL
4375 or dist.ini, cpanfile, etc.)
4377 The C<data_handlers> configuration is a hashref whose keys are HTTP Content-Types
4378 (matched against the incoming request type using a regexp such as to be case
4379 insensitive) and whose values are coderefs that receive a localized version of
4380 C<$_> which is a filehandle object pointing to received body.
4382 This feature is considered an early access release and we reserve the right
4383 to alter the interface in order to provide a performant and secure solution to
4384 alternative request body content. Your reports welcomed!
4386 =head1 PSGI MIDDLEWARE
4388 You can define middleware, defined as L<Plack::Middleware> or a compatible
4389 interface in configuration. Your middleware definitions are in the form of an
4390 arrayref under the configuration key C<psgi_middleware>. Here's an example
4391 with details to follow:
4396 use Plack::Middleware::StackTrace;
4398 my $stacktrace_middleware = Plack::Middleware::StackTrace->new;
4400 __PACKAGE__->config(
4401 'psgi_middleware', [
4404 $stacktrace_middleware,
4405 'Session' => {store => 'File'},
4410 $env->{myapp.customkey} = 'helloworld';
4419 So the general form is:
4421 __PACKAGE__->config(psgi_middleware => \@middleware_definitions);
4423 Where C<@middleware> is one or more of the following, applied in the REVERSE of
4424 the order listed (to make it function similarly to L<Plack::Builder>:
4426 Alternatively, you may also define middleware by calling the L</setup_middleware>
4433 __PACKAGE__->setup_middleware( \@middleware_definitions);
4436 In the case where you do both (use 'setup_middleware' and configuration) the
4437 package call to setup_middleware will be applied earlier (in other words its
4438 middleware will wrap closer to the application). Keep this in mind since in
4439 some cases the order of middleware is important.
4441 The two approaches are not exclusive.
4445 =item Middleware Object
4447 An already initialized object that conforms to the L<Plack::Middleware>
4450 my $stacktrace_middleware = Plack::Middleware::StackTrace->new;
4452 __PACKAGE__->config(
4453 'psgi_middleware', [
4454 $stacktrace_middleware,
4460 A coderef that is an inlined middleware:
4462 __PACKAGE__->config(
4463 'psgi_middleware', [
4468 if($env->{PATH_INFO} =~m/forced/) {
4470 ->new(file=>TestApp->path_to(qw/share static forced.txt/))
4473 return $app->($env);
4483 We assume the scalar refers to a namespace after normalizing it using the
4486 (1) If the scalar is prefixed with a "+" (as in C<+MyApp::Foo>) then the full string
4487 is assumed to be 'as is', and we just install and use the middleware.
4489 (2) If the scalar begins with "Plack::Middleware" or your application namespace
4490 (the package name of your Catalyst application subclass), we also assume then
4491 that it is a full namespace, and use it.
4493 (3) Lastly, we then assume that the scalar is a partial namespace, and attempt to
4494 resolve it first by looking for it under your application namespace (for example
4495 if you application is "MyApp::Web" and the scalar is "MyMiddleware", we'd look
4496 under "MyApp::Web::Middleware::MyMiddleware") and if we don't find it there, we
4497 will then look under the regular L<Plack::Middleware> namespace (i.e. for the
4498 previous we'd try "Plack::Middleware::MyMiddleware"). We look under your application
4499 namespace first to let you 'override' common L<Plack::Middleware> locally, should
4500 you find that a good idea.
4506 __PACKAGE__->config(
4507 'psgi_middleware', [
4508 'Debug', ## MyAppWeb::Middleware::Debug->wrap or Plack::Middleware::Debug->wrap
4509 'Plack::Middleware::Stacktrace', ## Plack::Middleware::Stacktrace->wrap
4510 '+MyApp::Custom', ## MyApp::Custom->wrap
4514 =item a scalar followed by a hashref
4516 Just like the previous, except the following C<HashRef> is used as arguments
4517 to initialize the middleware object.
4519 __PACKAGE__->config(
4520 'psgi_middleware', [
4521 'Session' => {store => 'File'},
4526 Please see L<PSGI> for more on middleware.
4530 Starting in L<Catalyst> version 5.90080 encoding is automatically enabled
4531 and set to encode all body responses to UTF8 when possible and applicable.
4532 Following is documentation on this process. If you are using an older
4533 version of L<Catalyst> you should review documentation for that version since
4536 By default encoding is now 'UTF-8'. You may turn it off by setting
4537 the encoding configuration to undef.
4539 MyApp->config(encoding => undef);
4541 This is recommended for temporary backwards compatibility only.
4543 Encoding is automatically applied when the content-type is set to
4544 a type that can be encoded. Currently we encode when the content type
4545 matches the following regular expression:
4547 $content_type =~ /^text|xml$|javascript$/
4549 Encoding is set on the application, but it is copied to the context object
4550 so that you can override it on a request basis.
4552 Be default we don't automatically encode 'application/json' since the most
4553 common approaches to generating this type of response (Either via L<Catalyst::View::JSON>
4554 or L<Catalyst::Action::REST>) will do so already and we want to avoid double
4557 If you are producing JSON response in an unconventional manner (such
4558 as via a template or manual strings) you should perform the UTF8 encoding
4559 manually as well such as to conform to the JSON specification.
4561 NOTE: We also examine the value of $c->response->content_encoding. If
4562 you set this (like for example 'gzip', and manually gzipping the body)
4563 we assume that you have done all the necessary encoding yourself, since
4564 we cannot encode the gzipped contents. If you use a plugin like
4565 L<Catalyst::Plugin::Compress> you need to update to a modern version in order
4566 to have this function correctly with the new UTF8 encoding code, or you
4567 can use L<Plack::Middleware::Deflater> or (probably best) do your compression on
4576 Returns an instance of an C<Encode> encoding
4578 print $c->encoding->name
4580 =item handle_unicode_encoding_exception ($exception_context)
4582 Method called when decoding process for a request fails.
4584 An C<$exception_context> hashref is provided to allow you to override the
4585 behaviour of your application when given data with incorrect encodings.
4587 The default method throws exceptions in the case of invalid request parameters
4588 (resulting in a 500 error), but ignores errors in upload filenames.
4590 The keys passed in the C<$exception_context> hash are:
4596 The value which was not able to be decoded.
4600 The exception received from L<Encode>.
4604 What type of data was being decoded. Valid values are (currently)
4605 C<params> - for request parameters / arguments / captures
4606 and C<uploads> - for request upload filenames.
4616 Join #catalyst on irc.perl.org.
4620 http://lists.scsys.co.uk/cgi-bin/mailman/listinfo/catalyst
4621 http://lists.scsys.co.uk/cgi-bin/mailman/listinfo/catalyst-dev
4625 http://catalyst.perl.org
4629 http://dev.catalyst.perl.org
4633 =head2 L<Task::Catalyst> - All you need to start with Catalyst
4635 =head2 L<Catalyst::Manual> - The Catalyst Manual
4637 =head2 L<Catalyst::Component>, L<Catalyst::Controller> - Base classes for components
4639 =head2 L<Catalyst::Engine> - Core engine
4641 =head2 L<Catalyst::Log> - Log class.
4643 =head2 L<Catalyst::Request> - Request object
4645 =head2 L<Catalyst::Response> - Response object
4647 =head2 L<Catalyst::Test> - The test suite.
4649 =head1 PROJECT FOUNDER
4651 sri: Sebastian Riedel <sri@cpan.org>
4657 acme: Leon Brocard <leon@astray.com>
4659 abraxxa: Alexander Hartmaier <abraxxa@cpan.org>
4661 andrewalker: André Walker <andre@cpan.org>
4665 Andrew Ford E<lt>A.Ford@ford-mason.co.ukE<gt>
4669 andyg: Andy Grundman <andy@hybridized.org>
4671 audreyt: Audrey Tang
4673 bricas: Brian Cassidy <bricas@cpan.org>
4675 Caelum: Rafael Kitover <rkitover@io.com>
4677 chansen: Christian Hansen
4679 chicks: Christopher Hicks
4681 Chisel Wright C<pause@herlpacker.co.uk>
4683 Danijel Milicevic C<me@danijel.de>
4685 davewood: David Schmidt <davewood@cpan.org>
4687 David Kamholz E<lt>dkamholz@cpan.orgE<gt>
4689 David Naughton, C<naughton@umn.edu>
4693 dhoss: Devin Austin <dhoss@cpan.org>
4695 dkubb: Dan Kubb <dan.kubb-cpan@onautopilot.com>
4699 dwc: Daniel Westermann-Clark <danieltwc@cpan.org>
4701 esskar: Sascha Kiefer
4703 fireartist: Carl Franks <cfranks@cpan.org>
4705 frew: Arthur Axel "fREW" Schmidt <frioux@gmail.com>
4707 gabb: Danijel Milicevic
4711 Gavin Henry C<ghenry@perl.me.uk>
4715 groditi: Guillermo Roditi <groditi@gmail.com>
4717 hobbs: Andrew Rodland <andrew@cleverdomain.org>
4719 ilmari: Dagfinn Ilmari Mannsåker <ilmari@ilmari.org>
4721 jcamacho: Juan Camacho
4723 jester: Jesse Sheidlower C<jester@panix.com>
4725 jhannah: Jay Hannah <jay@jays.net>
4731 jon: Jon Schutz <jjschutz@cpan.org>
4733 Jonathan Rockway C<< <jrockway@cpan.org> >>
4735 Kieren Diment C<kd@totaldatasolution.com>
4737 konobi: Scott McWhirter <konobi@cpan.org>
4739 marcus: Marcus Ramberg <mramberg@cpan.org>
4741 miyagawa: Tatsuhiko Miyagawa <miyagawa@bulknews.net>
4743 mgrimes: Mark Grimes <mgrimes@cpan.org>
4745 mst: Matt S. Trout <mst@shadowcatsystems.co.uk>
4749 naughton: David Naughton
4751 ningu: David Kamholz <dkamholz@cpan.org>
4753 nothingmuch: Yuval Kogman <nothingmuch@woobling.org>
4755 numa: Dan Sully <daniel@cpan.org>
4761 omega: Andreas Marienborg
4763 Oleg Kostyuk <cub.uanic@gmail.com>
4765 phaylon: Robert Sedlacek <phaylon@dunkelheit.at>
4767 rafl: Florian Ragwitz <rafl@debian.org>
4769 random: Roland Lammel <lammel@cpan.org>
4771 Robert Sedlacek C<< <rs@474.at> >>
4773 SpiceMan: Marcel Montes
4777 szbalint: Balint Szilakszi <szbalint@cpan.org>
4779 t0m: Tomas Doran <bobtfish@bobtfish.net>
4783 vanstyn: Henry Van Styn <vanstyn@cpan.org>
4785 Viljo Marrandi C<vilts@yahoo.com>
4787 Will Hawes C<info@whawes.co.uk>
4789 willert: Sebastian Willert <willert@cpan.org>
4791 wreis: Wallace Reis <wreis@cpan.org>
4793 Yuval Kogman, C<nothingmuch@woobling.org>
4795 rainboxx: Matthias Dietrich, C<perl@rainboxx.de>
4797 dd070: Dhaval Dhanani <dhaval070@gmail.com>
4799 Upasana <me@upasana.me>
4801 John Napiorkowski (jnap) <jjnapiork@cpan.org>
4805 Copyright (c) 2005-2015, the above named PROJECT FOUNDER and CONTRIBUTORS.
4809 This library is free software. You can redistribute it and/or modify it under
4810 the same terms as Perl itself.
4816 __PACKAGE__->meta->make_immutable;