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
204 See the L<Catalyst::Manual> distribution for comprehensive
205 documentation and tutorials.
207 # Install Catalyst::Devel for helpers and other development tools
208 # use the helper to create a new application
211 # add models, views, controllers
212 script/myapp_create.pl model MyDatabase DBIC::Schema create=static dbi:SQLite:/path/to/db
213 script/myapp_create.pl view MyTemplate TT
214 script/myapp_create.pl controller Search
216 # built in testserver -- use -r to restart automatically on changes
217 # --help to see all available options
218 script/myapp_server.pl
220 # command line testing interface
221 script/myapp_test.pl /yada
224 use Catalyst qw/-Debug/; # include plugins here as well
226 ### In lib/MyApp/Controller/Root.pm (autocreated)
227 sub foo : Chained('/') Args() { # called for /foo, /foo/1, /foo/1/2, etc.
228 my ( $self, $c, @args ) = @_; # args are qw/1 2/ for /foo/1/2
229 $c->stash->{template} = 'foo.tt'; # set the template
230 # lookup something from db -- stash vars are passed to TT
232 $c->model('Database::Foo')->search( { country => $args[0] } );
233 if ( $c->req->params->{bar} ) { # access GET or POST parameters
234 $c->forward( 'bar' ); # process another action
235 # do something else after forward returns
239 # The foo.tt TT template can use the stash data from the database
240 [% WHILE (item = data.next) %]
244 # called for /bar/of/soap, /bar/of/soap/10, etc.
245 sub bar : Chained('/') PathPart('/bar/of/soap') Args() { ... }
247 # called after all actions are finished
249 my ( $self, $c ) = @_;
250 if ( scalar @{ $c->error } ) { ... } # handle errors
251 return if $c->res->body; # already have a response
252 $c->forward( 'MyApp::View::TT' ); # render template
255 See L<Catalyst::Manual::Intro> for additional information.
259 Catalyst is a modern framework for making web applications without the
260 pain usually associated with this process. This document is a reference
261 to the main Catalyst application. If you are a new user, we suggest you
262 start with L<Catalyst::Manual::Tutorial> or L<Catalyst::Manual::Intro>.
264 See L<Catalyst::Manual> for more documentation.
266 Catalyst plugins can be loaded by naming them as arguments to the "use
267 Catalyst" statement. Omit the C<Catalyst::Plugin::> prefix from the
268 plugin name, i.e., C<Catalyst::Plugin::My::Module> becomes
271 use Catalyst qw/My::Module/;
273 If your plugin starts with a name other than C<Catalyst::Plugin::>, you can
274 fully qualify the name by using a unary plus:
278 +Fully::Qualified::Plugin::Name
281 Special flags like C<-Debug> can also be specified as
282 arguments when Catalyst is loaded:
284 use Catalyst qw/-Debug My::Module/;
286 The position of plugins and flags in the chain is important, because
287 they are loaded in the order in which they appear.
289 The following flags are supported:
293 Enables debug output. You can also force this setting from the system
294 environment with CATALYST_DEBUG or <MYAPP>_DEBUG. The environment
295 settings override the application, with <MYAPP>_DEBUG having the highest
298 This sets the log level to 'debug' and enables full debug output on the
299 error screen. If you only want the latter, see L<< $c->debug >>.
303 Forces Catalyst to use a specific home directory, e.g.:
305 use Catalyst qw[-Home=/usr/mst];
307 This can also be done in the shell environment by setting either the
308 C<CATALYST_HOME> environment variable or C<MYAPP_HOME>; where C<MYAPP>
309 is replaced with the uppercased name of your application, any "::" in
310 the name will be replaced with underscores, e.g. MyApp::Web should use
311 MYAPP_WEB_HOME. If both variables are set, the MYAPP_HOME one will be used.
313 If none of these are set, Catalyst will attempt to automatically detect the
314 home directory. If you are working in a development environment, Catalyst
315 will try and find the directory containing either Makefile.PL, Build.PL,
316 dist.ini, or cpanfile. If the application has been installed into the system
317 (i.e. you have done C<make install>), then Catalyst will use the path to your
318 application module, without the .pm extension (e.g., /foo/MyApp if your
319 application was installed at /foo/MyApp.pm)
323 use Catalyst '-Log=warn,fatal,error';
325 Specifies a comma-delimited list of log levels.
329 Enables statistics collection and reporting.
331 use Catalyst qw/-Stats=1/;
333 You can also force this setting from the system environment with CATALYST_STATS
334 or <MYAPP>_STATS. The environment settings override the application, with
335 <MYAPP>_STATS having the highest priority.
337 Stats are also enabled if L<< debugging |/"-Debug" >> is enabled.
341 =head2 INFORMATION ABOUT THE CURRENT REQUEST
345 Returns a L<Catalyst::Action> object for the current action, which
346 stringifies to the action name. See L<Catalyst::Action>.
350 Returns the namespace of the current action, i.e., the URI prefix
351 corresponding to the controller of the current action. For example:
353 # in Controller::Foo::Bar
354 $c->namespace; # returns 'foo/bar';
360 Returns the current L<Catalyst::Request> object, giving access to
361 information about the current client request (including parameters,
362 cookies, HTTP headers, etc.). See L<Catalyst::Request>.
364 =head2 REQUEST FLOW HANDLING
366 =head2 $c->forward( $action [, \@arguments ] )
368 =head2 $c->forward( $class, $method, [, \@arguments ] )
370 This is one way of calling another action (method) in the same or
371 a different controller. You can also use C<< $self->my_method($c, @args) >>
372 in the same controller or C<< $c->controller('MyController')->my_method($c, @args) >>
373 in a different controller.
374 The main difference is that 'forward' uses some of the Catalyst request
375 cycle overhead, including debugging, which may be useful to you. On the
376 other hand, there are some complications to using 'forward', restrictions
377 on values returned from 'forward', and it may not handle errors as you prefer.
378 Whether you use 'forward' or not is up to you; it is not considered superior to
379 the other ways to call a method.
381 'forward' calls another action, by its private name. If you give a
382 class name but no method, C<process()> is called. You may also optionally
383 pass arguments in an arrayref. The action will receive the arguments in
384 C<@_> and C<< $c->req->args >>. Upon returning from the function,
385 C<< $c->req->args >> will be restored to the previous values.
387 Any data C<return>ed from the action forwarded to, will be returned by the
390 my $foodata = $c->forward('/foo');
391 $c->forward('index');
392 $c->forward(qw/Model::DBIC::Foo do_stuff/);
393 $c->forward('View::TT');
395 Note that L<< forward|/"$c->forward( $action [, \@arguments ] )" >> implies
396 an C<< eval { } >> around the call (actually
397 L<< execute|/"$c->execute( $class, $coderef )" >> does), thus rendering all
398 exceptions thrown by the called action non-fatal and pushing them onto
399 $c->error instead. If you want C<die> to propagate you need to do something
403 die join "\n", @{ $c->error } if @{ $c->error };
405 Or make sure to always return true values from your actions and write
408 $c->forward('foo') || return;
410 Another note is that C<< $c->forward >> always returns a scalar because it
411 actually returns $c->state which operates in a scalar context.
412 Thus, something like:
416 in an action that is forwarded to is going to return a scalar,
417 i.e. how many items are in that array, which is probably not what you want.
418 If you need to return an array then return a reference to it,
421 $c->stash->{array} = \@array;
423 and access it from the stash.
425 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.
429 sub forward { my $c = shift; no warnings 'recursion'; $c->dispatcher->forward( $c, @_ ) }
431 =head2 $c->detach( $action [, \@arguments ] )
433 =head2 $c->detach( $class, $method, [, \@arguments ] )
437 The same as L<< forward|/"$c->forward( $action [, \@arguments ] )" >>, but
438 doesn't return to the previous action when processing is finished.
440 When called with no arguments it escapes the processing chain entirely.
444 sub detach { my $c = shift; $c->dispatcher->detach( $c, @_ ) }
446 =head2 $c->visit( $action [, \@arguments ] )
448 =head2 $c->visit( $action [, \@captures, \@arguments ] )
450 =head2 $c->visit( $class, $method, [, \@arguments ] )
452 =head2 $c->visit( $class, $method, [, \@captures, \@arguments ] )
454 Almost the same as L<< forward|/"$c->forward( $action [, \@arguments ] )" >>,
455 but does a full dispatch, instead of just calling the new C<$action> /
456 C<< $class->$method >>. This means that C<begin>, C<auto> and the method
457 you go to are called, just like a new request.
459 In addition both C<< $c->action >> and C<< $c->namespace >> are localized.
460 This means, for example, that C<< $c->action >> methods such as
461 L<name|Catalyst::Action/name>, L<class|Catalyst::Action/class> and
462 L<reverse|Catalyst::Action/reverse> return information for the visited action
463 when they are invoked within the visited action. This is different from the
464 behavior of L<< forward|/"$c->forward( $action [, \@arguments ] )" >>, which
465 continues to use the $c->action object from the caller action even when
466 invoked from the called action.
468 C<< $c->stash >> is kept unchanged.
470 In effect, L<< visit|/"$c->visit( $action [, \@captures, \@arguments ] )" >>
471 allows you to "wrap" another action, just as it would have been called by
472 dispatching from a URL, while the analogous
473 L<< go|/"$c->go( $action [, \@captures, \@arguments ] )" >> allows you to
474 transfer control to another action as if it had been reached directly from a URL.
478 sub visit { my $c = shift; $c->dispatcher->visit( $c, @_ ) }
480 =head2 $c->go( $action [, \@arguments ] )
482 =head2 $c->go( $action [, \@captures, \@arguments ] )
484 =head2 $c->go( $class, $method, [, \@arguments ] )
486 =head2 $c->go( $class, $method, [, \@captures, \@arguments ] )
488 The relationship between C<go> and
489 L<< visit|/"$c->visit( $action [, \@captures, \@arguments ] )" >> is the same as
490 the relationship between
491 L<< forward|/"$c->forward( $class, $method, [, \@arguments ] )" >> and
492 L<< detach|/"$c->detach( $action [, \@arguments ] )" >>. Like C<< $c->visit >>,
493 C<< $c->go >> will perform a full dispatch on the specified action or method,
494 with localized C<< $c->action >> and C<< $c->namespace >>. Like C<detach>,
495 C<go> escapes the processing of the current request chain on completion, and
496 does not return to its cunless blessed $cunless blessed $caller.
498 @arguments are arguments to the final destination of $action. @captures are
499 arguments to the intermediate steps, if any, on the way to the final sub of
504 sub go { my $c = shift; $c->dispatcher->go( $c, @_ ) }
510 Returns the current L<Catalyst::Response> object, see there for details.
514 Returns a hashref to the stash, which may be used to store data and pass
515 it between components during a request. You can also set hash keys by
516 passing arguments. The stash is automatically sent to the view. The
517 stash is cleared at the end of a request; it cannot be used for
518 persistent storage (for this you must use a session; see
519 L<Catalyst::Plugin::Session> for a complete system integrated with
522 $c->stash->{foo} = $bar;
523 $c->stash( { moose => 'majestic', qux => 0 } );
524 $c->stash( bar => 1, gorch => 2 ); # equivalent to passing a hashref
526 # stash is automatically passed to the view for use in a template
527 $c->forward( 'MyApp::View::TT' );
529 The stash hash is currently stored in the PSGI C<$env> and is managed by
530 L<Catalyst::Middleware::Stash>. Since it's part of the C<$env> items in
531 the stash can be accessed in sub applications mounted under your main
532 L<Catalyst> application. For example if you delegate the response of an
533 action to another L<Catalyst> application, that sub application will have
534 access to all the stash keys of the main one, and if can of course add
535 more keys of its own. However those new keys will not 'bubble' back up
536 to the main application.
538 For more information the best thing to do is to review the test case:
539 t/middleware-stash.t in the distribution /t directory.
545 $c->log->error("You are requesting the stash but you don't have a context") unless blessed $c;
546 return Catalyst::Middleware::Stash::get_stash($c->req->env)->(@_);
551 =head2 $c->error($error, ...)
553 =head2 $c->error($arrayref)
555 Returns an arrayref containing error messages. If Catalyst encounters an
556 error while processing a request, it stores the error in $c->error. This
557 method should only be used to store fatal error messages.
559 my @error = @{ $c->error };
563 $c->error('Something bad happened');
565 Calling this will always return an arrayref (if there are no errors it
566 will be an empty arrayref.
573 my $error = ref $_[0] eq 'ARRAY' ? $_[0] : [@_];
574 croak @$error unless ref $c;
575 push @{ $c->{error} }, @$error;
577 elsif ( defined $_[0] ) { $c->{error} = undef }
578 return $c->{error} || [];
584 Contains the return value of the last executed action.
585 Note that << $c->state >> operates in a scalar context which means that all
586 values it returns are scalar.
588 =head2 $c->clear_errors
590 Clear errors. You probably don't want to clear the errors unless you are
591 implementing a custom error screen.
593 This is equivalent to running
604 =head2 $c->has_errors
606 Returns true if you have errors
610 sub has_errors { scalar(@{shift->error}) ? 1:0 }
612 =head2 $c->last_error
614 Returns the most recent error in the stack (the one most recently added...)
615 or nothing if there are no errors.
619 sub last_error { my ($err, @errs) = @{shift->error}; return $err }
623 shifts the most recently added error off the error stack and returns if. Returns
624 nothing if there are no more errors.
630 my ($err, @errors) = @{$self->error};
631 $self->{error} = \@errors;
635 sub _comp_search_prefixes {
637 return map $c->components->{ $_ }, $c->_comp_names_search_prefixes(@_);
640 # search components given a name and some prefixes
641 sub _comp_names_search_prefixes {
642 my ( $c, $name, @prefixes ) = @_;
643 my $appclass = ref $c || $c;
644 my $filter = "^${appclass}::(" . join( '|', @prefixes ) . ')::';
645 $filter = qr/$filter/; # Compile regex now rather than once per loop
647 # map the original component name to the sub part that we will search against
648 my %eligible = map { my $n = $_; $n =~ s{^$appclass\::[^:]+::}{}; $_ => $n; }
649 grep { /$filter/ } keys %{ $c->components };
651 # undef for a name will return all
652 return keys %eligible if !defined $name;
654 my $query = $name->$_isa('Regexp') ? $name : qr/^$name$/i;
655 my @result = grep { $eligible{$_} =~ m{$query} } keys %eligible;
657 return @result if @result;
659 # if we were given a regexp to search against, we're done.
660 return if $name->$_isa('Regexp');
662 # skip regexp fallback if configured
664 if $appclass->config->{disable_component_resolution_regex_fallback};
668 @result = grep { $eligible{ $_ } =~ m{$query} } keys %eligible;
670 # no results? try against full names
672 @result = grep { m{$query} } keys %eligible;
675 # don't warn if we didn't find any results, it just might not exist
677 # Disgusting hack to work out correct method name
678 my $warn_for = lc $prefixes[0];
679 my $msg = "Used regexp fallback for \$c->${warn_for}('${name}'), which found '" .
680 (join '", "', @result) . "'. Relying on regexp fallback behavior for " .
681 "component resolution is unreliable and unsafe.";
682 my $short = $result[0];
683 # remove the component namespace prefix
684 $short =~ s/.*?(Model|Controller|View):://;
685 my $shortmess = Carp::shortmess('');
686 if ($shortmess =~ m#Catalyst/Plugin#) {
687 $msg .= " You probably need to set '$short' instead of '${name}' in this " .
689 } elsif ($shortmess =~ m#Catalyst/lib/(View|Controller)#) {
690 $msg .= " You probably need to set '$short' instead of '${name}' in this " .
691 "component's config";
693 $msg .= " You probably meant \$c->${warn_for}('$short') instead of \$c->${warn_for}('${name}'), " .
694 "but if you really wanted to search, pass in a regexp as the argument " .
695 "like so: \$c->${warn_for}(qr/${name}/)";
697 $c->log->warn( "${msg}$shortmess" );
703 # Find possible names for a prefix
705 my ( $c, @prefixes ) = @_;
706 my $appclass = ref $c || $c;
708 my $filter = "^${appclass}::(" . join( '|', @prefixes ) . ')::';
710 my @names = map { s{$filter}{}; $_; }
711 $c->_comp_names_search_prefixes( undef, @prefixes );
716 # Filter a component before returning by calling ACCEPT_CONTEXT if available
719 sub _filter_component {
720 my ( $c, $comp, @args ) = @_;
722 # die "Circular Dependencies Detected." if $tracker{$comp};
724 if(ref $comp eq 'CODE') {
729 if ( eval { $comp->can('ACCEPT_CONTEXT'); } ) {
730 die "Component '${\$comp->catalyst_component_name}' does ACCEPT_CONTEXT but I am in application scope" unless blessed $c;
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);
2315 $c->stats($class->composed_stats_class->new)->enable;
2318 if ( $c->debug || $c->config->{enable_catalyst_header} ) {
2319 $c->res->headers->header( 'X-Catalyst' => $Catalyst::VERSION );
2323 # Allow engine to direct the prepare flow (for POE)
2324 if ( my $prepare = $c->engine->can('prepare') ) {
2325 $c->engine->$prepare( $c, @arguments );
2328 $c->prepare_request(@arguments);
2329 $c->prepare_connection;
2330 $c->prepare_query_parameters;
2331 $c->prepare_headers; # Just hooks, no longer needed - they just
2332 $c->prepare_cookies; # cause the lazy attribute on req to build
2335 # Prepare the body for reading, either by prepare_body
2336 # or the user, if they are using $c->read
2339 # Parse the body unless the user wants it on-demand
2340 unless ( ref($c)->config->{parse_on_demand} ) {
2346 # VERY ugly and probably shouldn't rely on ->finalize actually working
2348 # failed prepare is always due to an invalid request, right?
2349 $c->response->status(400);
2350 $c->response->content_type('text/plain');
2351 $c->response->body('Bad Request');
2352 # Note we call finalize and then die here, which escapes
2353 # finalize being called in the enclosing block..
2354 # It in fact couldn't be called, as we don't return $c..
2355 # This is a mess - but I'm unsure you can fix this without
2356 # breaking compat for people doing crazy things (we should set
2357 # the 400 and just return the ctx here IMO, letting finalize get called
2368 =head2 $c->prepare_action
2370 Prepares action. See L<Catalyst::Dispatcher>.
2374 sub prepare_action {
2376 my $ret = $c->dispatcher->prepare_action( $c, @_);
2379 foreach (@{$c->req->arguments}, @{$c->req->captures}) {
2380 $_ = $c->_handle_param_unicode_decoding($_);
2388 =head2 $c->prepare_body
2390 Prepares message body.
2397 return if $c->request->_has_body;
2399 # Initialize on-demand data
2400 $c->engine->prepare_body( $c, @_ );
2401 $c->prepare_parameters;
2402 $c->prepare_uploads;
2405 =head2 $c->prepare_body_chunk( $chunk )
2407 Prepares a chunk of data before sending it to L<HTTP::Body>.
2409 See L<Catalyst::Engine>.
2413 sub prepare_body_chunk {
2415 $c->engine->prepare_body_chunk( $c, @_ );
2418 =head2 $c->prepare_body_parameters
2420 Prepares body parameters.
2424 sub prepare_body_parameters {
2426 $c->request->prepare_body_parameters( $c, @_ );
2429 =head2 $c->prepare_connection
2431 Prepares connection.
2435 sub prepare_connection {
2437 $c->request->prepare_connection($c);
2440 =head2 $c->prepare_cookies
2442 Prepares cookies by ensuring that the attribute on the request
2443 object has been built.
2447 sub prepare_cookies { my $c = shift; $c->request->cookies }
2449 =head2 $c->prepare_headers
2451 Prepares request headers by ensuring that the attribute on the request
2452 object has been built.
2456 sub prepare_headers { my $c = shift; $c->request->headers }
2458 =head2 $c->prepare_parameters
2460 Prepares parameters.
2464 sub prepare_parameters {
2466 $c->prepare_body_parameters;
2467 $c->engine->prepare_parameters( $c, @_ );
2470 =head2 $c->prepare_path
2472 Prepares path and base.
2476 sub prepare_path { my $c = shift; $c->engine->prepare_path( $c, @_ ) }
2478 =head2 $c->prepare_query_parameters
2480 Prepares query parameters.
2484 sub prepare_query_parameters {
2487 $c->engine->prepare_query_parameters( $c, @_ );
2490 =head2 $c->log_request
2492 Writes information about the request to the debug logs. This includes:
2496 =item * Request method, path, and remote IP address
2498 =item * Query keywords (see L<Catalyst::Request/query_keywords>)
2500 =item * Request parameters
2502 =item * File uploads
2511 return unless $c->debug;
2513 my($dump) = grep {$_->[0] eq 'Request' } $c->dump_these;
2514 my $request = $dump->[1];
2516 my ( $method, $path, $address ) = ( $request->method, $request->path, $request->address );
2518 $path = '/' unless length $path;
2521 $path =~ s/%([0-9A-Fa-f]{2})/chr(hex($1))/eg;
2522 $path = decode_utf8($path);
2524 $c->log->debug(qq/"$method" request for "$path" from "$address"/);
2526 $c->log_request_headers($request->headers);
2528 if ( my $keywords = $request->query_keywords ) {
2529 $c->log->debug("Query keywords are: $keywords");
2532 $c->log_request_parameters( query => $request->query_parameters, $request->_has_body ? (body => $request->body_parameters) : () );
2534 $c->log_request_uploads($request);
2537 =head2 $c->log_response
2539 Writes information about the response to the debug logs by calling
2540 C<< $c->log_response_status_line >> and C<< $c->log_response_headers >>.
2547 return unless $c->debug;
2549 my($dump) = grep {$_->[0] eq 'Response' } $c->dump_these;
2550 my $response = $dump->[1];
2552 $c->log_response_status_line($response);
2553 $c->log_response_headers($response->headers);
2556 =head2 $c->log_response_status_line($response)
2558 Writes one line of information about the response to the debug logs. This includes:
2562 =item * Response status code
2564 =item * Content-Type header (if present)
2566 =item * Content-Length header (if present)
2572 sub log_response_status_line {
2573 my ($c, $response) = @_;
2577 'Response Code: %s; Content-Type: %s; Content-Length: %s',
2578 $response->status || 'unknown',
2579 $response->headers->header('Content-Type') || 'unknown',
2580 $response->headers->header('Content-Length') || 'unknown'
2585 =head2 $c->log_response_headers($headers);
2587 Hook method which can be wrapped by plugins to log the response headers.
2588 No-op in the default implementation.
2592 sub log_response_headers {}
2594 =head2 $c->log_request_parameters( query => {}, body => {} )
2596 Logs request parameters to debug logs
2600 sub log_request_parameters {
2602 my %all_params = @_;
2604 return unless $c->debug;
2606 my $column_width = Catalyst::Utils::term_width() - 44;
2607 foreach my $type (qw(query body)) {
2608 my $params = $all_params{$type};
2609 next if ! keys %$params;
2610 my $t = Text::SimpleTable->new( [ 35, 'Parameter' ], [ $column_width, 'Value' ] );
2611 for my $key ( sort keys %$params ) {
2612 my $param = $params->{$key};
2613 my $value = defined($param) ? $param : '';
2614 $t->row( $key, ref $value eq 'ARRAY' ? ( join ', ', @$value ) : $value );
2616 $c->log->debug( ucfirst($type) . " Parameters are:\n" . $t->draw );
2620 =head2 $c->log_request_uploads
2622 Logs file uploads included in the request to the debug logs.
2623 The parameter name, filename, file type, and file size are all included in
2628 sub log_request_uploads {
2630 my $request = shift;
2631 return unless $c->debug;
2632 my $uploads = $request->uploads;
2633 if ( keys %$uploads ) {
2634 my $t = Text::SimpleTable->new(
2635 [ 12, 'Parameter' ],
2640 for my $key ( sort keys %$uploads ) {
2641 my $upload = $uploads->{$key};
2642 for my $u ( ref $upload eq 'ARRAY' ? @{$upload} : ($upload) ) {
2643 $t->row( $key, $u->filename, $u->type, $u->size );
2646 $c->log->debug( "File Uploads are:\n" . $t->draw );
2650 =head2 $c->log_request_headers($headers);
2652 Hook method which can be wrapped by plugins to log the request headers.
2653 No-op in the default implementation.
2657 sub log_request_headers {}
2659 =head2 $c->log_headers($type => $headers)
2661 Logs L<HTTP::Headers> (either request or response) to the debug logs.
2668 my $headers = shift; # an HTTP::Headers instance
2670 return unless $c->debug;
2672 my $column_width = Catalyst::Utils::term_width() - 28;
2673 my $t = Text::SimpleTable->new( [ 15, 'Header Name' ], [ $column_width, 'Value' ] );
2676 my ( $name, $value ) = @_;
2677 $t->row( $name, $value );
2680 $c->log->debug( ucfirst($type) . " Headers:\n" . $t->draw );
2684 =head2 $c->prepare_read
2686 Prepares the input for reading.
2690 sub prepare_read { my $c = shift; $c->engine->prepare_read( $c, @_ ) }
2692 =head2 $c->prepare_request
2694 Prepares the engine request.
2698 sub prepare_request { my $c = shift; $c->engine->prepare_request( $c, @_ ) }
2700 =head2 $c->prepare_uploads
2706 sub prepare_uploads {
2708 $c->engine->prepare_uploads( $c, @_ );
2711 =head2 $c->prepare_write
2713 Prepares the output for writing.
2717 sub prepare_write { my $c = shift; $c->engine->prepare_write( $c, @_ ) }
2719 =head2 $c->request_class
2721 Returns or sets the request class. Defaults to L<Catalyst::Request>.
2723 =head2 $app->request_class_traits
2725 An arrayref of L<Moose::Role>s which are applied to the request class.
2727 =head2 $app->composed_request_class
2729 This is the request class which has been composed with any request_class_traits.
2731 =head2 $c->response_class
2733 Returns or sets the response class. Defaults to L<Catalyst::Response>.
2735 =head2 $app->response_class_traits
2737 An arrayref of L<Moose::Role>s which are applied to the response class.
2739 =head2 $app->composed_response_class
2741 This is the request class which has been composed with any response_class_traits.
2743 =head2 $c->read( [$maxlength] )
2745 Reads a chunk of data from the request body. This method is designed to
2746 be used in a while loop, reading C<$maxlength> bytes on every call.
2747 C<$maxlength> defaults to the size of the request if not specified.
2749 You have to set C<< MyApp->config(parse_on_demand => 1) >> to use this
2752 Warning: If you use read(), Catalyst will not process the body,
2753 so you will not be able to access POST parameters or file uploads via
2754 $c->request. You must handle all body parsing yourself.
2758 sub read { my $c = shift; return $c->request->read( @_ ) }
2768 $app->_make_immutable_if_needed;
2769 $app->engine_loader->needs_psgi_engine_compat_hack ?
2770 $app->engine->run($app, @_) :
2771 $app->engine->run( $app, $app->_finalized_psgi_app, @_ );
2774 sub _make_immutable_if_needed {
2776 my $meta = find_meta($class);
2777 my $isa_ca = $class->isa('Class::Accessor::Fast') || $class->isa('Class::Accessor');
2780 && ! { $meta->immutable_options }->{replace_constructor}
2783 warn("You made your application class ($class) immutable, "
2784 . "but did not inline the\nconstructor. "
2785 . "This will break catalyst, as your app \@ISA "
2786 . "Class::Accessor(::Fast)?\nPlease pass "
2787 . "(replace_constructor => 1)\nwhen making your class immutable.\n");
2789 unless ($meta->is_immutable) {
2790 # XXX - FIXME warning here as you should make your app immutable yourself.
2791 $meta->make_immutable(
2792 replace_constructor => 1,
2797 =head2 $c->set_action( $action, $code, $namespace, $attrs )
2799 Sets an action in a given namespace.
2803 sub set_action { my $c = shift; $c->dispatcher->set_action( $c, @_ ) }
2805 =head2 $c->setup_actions($component)
2807 Sets up actions for a component.
2811 sub setup_actions { my $c = shift; $c->dispatcher->setup_actions( $c, @_ ) }
2813 =head2 $c->setup_components
2815 This method is called internally to set up the application's components.
2817 It finds modules by calling the L<locate_components> method, expands them to
2818 package names with the L<expand_component_module> method, and then installs
2819 each component into the application.
2821 The C<setup_components> config option is passed to both of the above methods.
2823 Installation of each component is performed by the L<setup_component> method,
2828 sub setup_components {
2831 my $config = $class->config->{ setup_components };
2833 my @comps = $class->locate_components($config);
2834 my %comps = map { $_ => 1 } @comps;
2836 my $deprecatedcatalyst_component_names = grep { /::[CMV]::/ } @comps;
2837 $class->log->warn(qq{Your application is using the deprecated ::[MVC]:: type naming scheme.\n}.
2838 qq{Please switch your class names to ::Model::, ::View:: and ::Controller: as appropriate.\n}
2839 ) if $deprecatedcatalyst_component_names;
2841 for my $component ( @comps ) {
2843 # We pass ignore_loaded here so that overlay files for (e.g.)
2844 # Model::DBI::Schema sub-classes are loaded - if it's in @comps
2845 # we know M::P::O found a file on disk so this is safe
2847 Catalyst::Utils::ensure_class_loaded( $component, { ignore_loaded => 1 } );
2850 for my $component (@comps) {
2851 my $instance = $class->components->{ $component } = $class->delayed_setup_component($component);
2854 # Inject a component or wrap a stand alone class in an adaptor. This makes a list
2855 # of named components in the configuration that are not actually existing (not a
2858 my @injected_components = keys %{$class->config->{inject_components} ||+{}};
2859 foreach my $injected_comp_name(@injected_components) {
2860 my $component_class = $class->config->{inject_components}->{$injected_comp_name}->{from_component} || '';
2861 if($component_class) {
2862 my @roles = @{$class->config->{inject_components}->{$injected_comp_name}->{roles} ||[]};
2863 my %args = %{ $class->config->{$injected_comp_name} || +{} };
2865 Catalyst::Utils::inject_component(
2867 component => $component_class,
2868 (scalar(@roles) ? (traits => \@roles) : ()),
2869 as => $injected_comp_name);
2873 # All components are registered, now we need to 'init' them.
2874 foreach my $component_name (@comps, @injected_components) {
2875 $class->components->{$component_name} = $class->components->{$component_name}->() if
2876 (ref($class->components->{$component_name}) || '') eq 'CODE';
2880 =head2 $app->inject_component($MyApp_Component_name => \%args);
2882 Add a component that is injected at setup:
2884 MyApp->inject_component( 'Model::Foo' => { from_component => 'Common::Foo' } );
2886 Must be called before ->setup. Expects a component name for your
2887 current application and \%args where
2891 =item from_component
2893 The target component being injected into your application
2897 An arrayref of L<Moose::Role>s that are applied to your component.
2903 MyApp->inject_component(
2905 from_component => 'Common::Model::Foo',
2906 roles => ['Role1', 'Role2'],
2909 =head2 $app->inject_components
2911 Inject a list of components:
2913 MyApp->inject_components(
2914 'Model::FooOne' => {
2915 from_component => 'Common::Model::Foo',
2916 roles => ['Role1', 'Role2'],
2918 'Model::FooTwo' => {
2919 from_component => 'Common::Model::Foo',
2920 roles => ['Role1', 'Role2'],
2925 sub inject_component {
2926 my ($app, $name, $args) = @_;
2927 die "Component $name exists" if
2928 $app->config->{inject_components}->{$name};
2929 $app->config->{inject_components}->{$name} = $args;
2932 sub inject_components {
2935 $app->inject_component(shift, shift);
2939 =head2 $c->locate_components( $setup_component_config )
2941 This method is meant to provide a list of component modules that should be
2942 setup for the application. By default, it will use L<Module::Pluggable>.
2944 Specify a C<setup_components> config option to pass additional options directly
2945 to L<Module::Pluggable>. To add additional search paths, specify a key named
2946 C<search_extra> as an array reference. Items in the array beginning with C<::>
2947 will have the application class name prepended to them.
2951 sub locate_components {
2955 my @paths = qw( ::M ::Model ::V ::View ::C ::Controller );
2956 my $extra = delete $config->{ search_extra } || [];
2958 unshift @paths, @$extra;
2960 my @comps = map { sort { length($a) <=> length($b) } Module::Pluggable::Object->new(
2961 search_path => [ map { s/^(?=::)/$class/; $_; } ($_) ],
2963 )->plugins } @paths;
2968 =head2 $c->expand_component_module( $component, $setup_component_config )
2970 Components found by C<locate_components> will be passed to this method, which
2971 is expected to return a list of component (package) names to be set up.
2975 sub expand_component_module {
2976 my ($class, $module) = @_;
2977 return Devel::InnerPackage::list_packages( $module );
2980 =head2 $app->delayed_setup_component
2982 Returns a coderef that points to a setup_component instance. Used
2983 internally for when you want to delay setup until the first time
2984 the component is called.
2988 sub delayed_setup_component {
2989 my($class, $component, @more) = @_;
2991 return my $instance = $class->setup_component($component, @more);
2995 =head2 $c->setup_component
2999 sub setup_component {
3000 my( $class, $component ) = @_;
3002 unless ( $component->can( 'COMPONENT' ) ) {
3006 my $suffix = Catalyst::Utils::class2classsuffix( $component );
3007 my $config = $class->config->{ $suffix } || {};
3008 # Stash catalyst_component_name in the config here, so that custom COMPONENT
3009 # methods also pass it. local to avoid pointlessly shitting in config
3010 # for the debug screen, as $component is already the key name.
3011 local $config->{catalyst_component_name} = $component;
3013 my $instance = eval {
3014 $component->COMPONENT( $class, $config );
3018 Catalyst::Exception->throw(
3019 message => qq/Couldn't instantiate component "$component", "$error"/
3023 unless (blessed $instance) {
3024 my $metaclass = Moose::Util::find_meta($component);
3025 my $method_meta = $metaclass->find_method_by_name('COMPONENT');
3026 my $component_method_from = $method_meta->associated_metaclass->name;
3027 my $value = defined($instance) ? $instance : 'undef';
3028 Catalyst::Exception->throw(
3030 qq/Couldn't instantiate component "$component", COMPONENT() method (from $component_method_from) didn't return an object-like value (value was $value)./
3034 my @expanded_components = $instance->can('expand_modules')
3035 ? $instance->expand_modules( $component, $config )
3036 : $class->expand_component_module( $component, $config );
3037 for my $component (@expanded_components) {
3038 next if $class->components->{ $component };
3039 $class->components->{ $component } = $class->setup_component($component);
3045 =head2 $c->setup_dispatcher
3051 sub setup_dispatcher {
3052 my ( $class, $dispatcher ) = @_;
3055 $dispatcher = 'Catalyst::Dispatcher::' . $dispatcher;
3058 if ( my $env = Catalyst::Utils::env_value( $class, 'DISPATCHER' ) ) {
3059 $dispatcher = 'Catalyst::Dispatcher::' . $env;
3062 unless ($dispatcher) {
3063 $dispatcher = $class->dispatcher_class;
3066 load_class($dispatcher);
3068 # dispatcher instance
3069 $class->dispatcher( $dispatcher->new );
3072 =head2 $c->setup_engine
3079 my ($class, $requested_engine) = @_;
3081 if (!$class->engine_loader || $requested_engine) {
3082 $class->engine_loader(
3083 Catalyst::EngineLoader->new({
3084 application_name => $class,
3085 (defined $requested_engine
3086 ? (catalyst_engine_class => $requested_engine) : ()),
3091 $class->engine_loader->catalyst_engine_class;
3095 my ($class, $requested_engine) = @_;
3098 my $loader = $class->engine_loader;
3100 if (!$loader || $requested_engine) {
3101 $loader = Catalyst::EngineLoader->new({
3102 application_name => $class,
3103 (defined $requested_engine
3104 ? (requested_engine => $requested_engine) : ()),
3107 $class->engine_loader($loader);
3110 $loader->catalyst_engine_class;
3113 # Don't really setup_engine -- see _setup_psgi_app for explanation.
3114 return if $class->loading_psgi_file;
3116 load_class($engine);
3118 if ($ENV{MOD_PERL}) {
3119 my $apache = $class->engine_loader->auto;
3121 my $meta = find_meta($class);
3122 my $was_immutable = $meta->is_immutable;
3123 my %immutable_options = $meta->immutable_options;
3124 $meta->make_mutable if $was_immutable;
3126 $meta->add_method(handler => sub {
3128 my $psgi_app = $class->_finalized_psgi_app;
3129 $apache->call_app($r, $psgi_app);
3132 $meta->make_immutable(%immutable_options) if $was_immutable;
3135 $class->engine( $engine->new );
3140 ## This exists just to supply a prebuild psgi app for mod_perl and for the
3141 ## build in server support (back compat support for pre psgi port behavior).
3142 ## This is so that we don't build a new psgi app for each request when using
3143 ## the mod_perl handler or the built in servers (http and fcgi, etc).
3145 sub _finalized_psgi_app {
3148 unless ($app->_psgi_app) {
3149 my $psgi_app = $app->_setup_psgi_app;
3150 $app->_psgi_app($psgi_app);
3153 return $app->_psgi_app;
3156 ## Look for a psgi file like 'myapp_web.psgi' (if the app is MyApp::Web) in the
3157 ## home directory and load that and return it (just assume it is doing the
3158 ## right thing :) ). If that does not exist, call $app->psgi_app, wrap that
3159 ## in default_middleware and return it ( this is for backward compatibility
3160 ## with pre psgi port behavior ).
3162 sub _setup_psgi_app {
3165 for my $home (Path::Class::Dir->new($app->config->{home})) {
3166 my $psgi_file = $home->file(
3167 Catalyst::Utils::appprefix($app) . '.psgi',
3170 next unless -e $psgi_file;
3172 # If $psgi_file calls ->setup_engine, it's doing so to load
3173 # Catalyst::Engine::PSGI. But if it does that, we're only going to
3174 # throw away the loaded PSGI-app and load the 5.9 Catalyst::Engine
3175 # anyway. So set a flag (ick) that tells setup_engine not to populate
3176 # $c->engine or do any other things we might regret.
3178 $app->loading_psgi_file(1);
3179 my $psgi_app = Plack::Util::load_psgi($psgi_file);
3180 $app->loading_psgi_file(0);
3183 unless $app->engine_loader->needs_psgi_engine_compat_hack;
3186 Found a legacy Catalyst::Engine::PSGI .psgi file at ${psgi_file}.
3188 Its content has been ignored. Please consult the Catalyst::Upgrading
3189 documentation on how to upgrade from Catalyst::Engine::PSGI.
3193 return $app->apply_default_middlewares($app->psgi_app);
3196 =head2 $c->apply_default_middlewares
3198 Adds the following L<Plack> middlewares to your application, since they are
3199 useful and commonly needed:
3201 L<Plack::Middleware::LighttpdScriptNameFix> (if you are using Lighttpd),
3202 L<Plack::Middleware::IIS6ScriptNameFix> (always applied since this middleware
3203 is smart enough to conditionally apply itself).
3205 We will also automatically add L<Plack::Middleware::ReverseProxy> if we notice
3206 that your HTTP $env variable C<REMOTE_ADDR> is '127.0.0.1'. This is usually
3207 an indication that your server is running behind a proxy frontend. However in
3208 2014 this is often not the case. We preserve this code for backwards compatibility
3209 however I B<highly> recommend that if you are running the server behind a front
3210 end proxy that you clearly indicate so with the C<using_frontend_proxy> configuration
3211 setting to true for your environment configurations that run behind a proxy. This
3212 way if you change your front end proxy address someday your code would inexplicably
3213 stop working as expected.
3215 Additionally if we detect we are using Nginx, we add a bit of custom middleware
3216 to solve some problems with the way that server handles $ENV{PATH_INFO} and
3219 Please B<NOTE> that if you do use C<using_frontend_proxy> the middleware is now
3220 adding via C<registered_middleware> rather than this method.
3222 If you are using Lighttpd or IIS6 you may wish to apply these middlewares. In
3223 general this is no longer a common case but we have this here for backward
3229 sub apply_default_middlewares {
3230 my ($app, $psgi_app) = @_;
3232 # Don't add this conditional IF we are explicitly saying we want the
3233 # frontend proxy support. We don't need it here since if that is the
3234 # case it will be always loaded in the default_middleware.
3236 unless($app->config->{using_frontend_proxy}) {
3237 $psgi_app = Plack::Middleware::Conditional->wrap(
3239 builder => sub { Plack::Middleware::ReverseProxy->wrap($_[0]) },
3242 return if $app->config->{ignore_frontend_proxy};
3243 return $env->{REMOTE_ADDR} eq '127.0.0.1';
3248 # If we're running under Lighttpd, swap PATH_INFO and SCRIPT_NAME
3249 # http://lists.scsys.co.uk/pipermail/catalyst/2006-June/008361.html
3250 $psgi_app = Plack::Middleware::Conditional->wrap(
3252 builder => sub { Plack::Middleware::LighttpdScriptNameFix->wrap($_[0]) },
3255 return unless $env->{SERVER_SOFTWARE} && $env->{SERVER_SOFTWARE} =~ m!lighttpd[-/]1\.(\d+\.\d+)!;
3256 return unless $1 < 4.23;
3261 # we're applying this unconditionally as the middleware itself already makes
3262 # sure it doesn't fuck things up if it's not running under one of the right
3264 $psgi_app = Plack::Middleware::IIS6ScriptNameFix->wrap($psgi_app);
3266 # And another IIS issue, this time with IIS7.
3267 $psgi_app = Plack::Middleware::Conditional->wrap(
3269 builder => sub { Plack::Middleware::IIS7KeepAliveFix->wrap($_[0]) },
3272 return $env->{SERVER_SOFTWARE} && $env->{SERVER_SOFTWARE} =~ m!IIS/7\.[0-9]!;
3279 =head2 App->psgi_app
3283 Returns a PSGI application code reference for the catalyst application
3284 C<$c>. This is the bare application created without the C<apply_default_middlewares>
3285 method called. We do however apply C<registered_middleware> since those are
3286 integral to how L<Catalyst> functions. Also, unlike starting your application
3287 with a generated server script (via L<Catalyst::Devel> and C<catalyst.pl>) we do
3288 not attempt to return a valid L<PSGI> application using any existing C<${myapp}.psgi>
3289 scripts in your $HOME directory.
3291 B<NOTE> C<apply_default_middlewares> was originally created when the first PSGI
3292 port was done for v5.90000. These are middlewares that are added to achieve
3293 backward compatibility with older applications. If you start your application
3294 using one of the supplied server scripts (generated with L<Catalyst::Devel> and
3295 the project skeleton script C<catalyst.pl>) we apply C<apply_default_middlewares>
3296 automatically. This was done so that pre and post PSGI port applications would
3299 This is what you want to be using to retrieve the PSGI application code
3300 reference of your Catalyst application for use in a custom F<.psgi> or in your
3301 own created server modules.
3305 *to_app = \&psgi_app;
3309 my $psgi = $app->engine->build_psgi_app($app);
3310 return $app->Catalyst::Utils::apply_registered_middleware($psgi);
3313 =head2 $c->setup_home
3315 Sets up the home directory.
3320 my ( $class, $home ) = @_;
3322 if ( my $env = Catalyst::Utils::env_value( $class, 'HOME' ) ) {
3326 $home ||= Catalyst::Utils::home($class);
3329 #I remember recently being scolded for assigning config values like this
3330 $class->config->{home} ||= $home;
3331 $class->config->{root} ||= Path::Class::Dir->new($home)->subdir('root');
3335 =head2 $c->setup_encoding
3337 Sets up the input/output encoding. See L<ENCODING>
3341 sub setup_encoding {
3343 if( exists($c->config->{encoding}) && !defined($c->config->{encoding}) ) {
3344 # Ok, so the user has explicitly said "I don't want encoding..."
3347 my $enc = defined($c->config->{encoding}) ?
3348 delete $c->config->{encoding} : 'UTF-8'; # not sure why we delete it... (JNAP)
3353 =head2 handle_unicode_encoding_exception
3355 Hook to let you customize how encoding errors are handled. By default
3356 we just throw an exception. Receives a hashref of debug information.
3359 $c->handle_unicode_encoding_exception({
3360 param_value => $value,
3362 encoding_step => 'params',
3367 sub handle_unicode_encoding_exception {
3368 my ( $self, $exception_ctx ) = @_;
3369 die $exception_ctx->{error_msg};
3372 # Some unicode helpers cargo culted from the old plugin. These could likely
3375 sub _handle_unicode_decoding {
3376 my ( $self, $value ) = @_;
3378 return unless defined $value;
3380 ## I think this mess is to support the old nested
3381 if ( ref $value eq 'ARRAY' ) {
3382 foreach ( @$value ) {
3383 $_ = $self->_handle_unicode_decoding($_);
3387 elsif ( ref $value eq 'HASH' ) {
3388 foreach (keys %$value) {
3389 my $encoded_key = $self->_handle_param_unicode_decoding($_);
3390 $value->{$encoded_key} = $self->_handle_unicode_decoding($value->{$_});
3392 # If the key was encoded we now have two (the original and current so
3393 # delete the original.
3394 delete $value->{$_} if $_ ne $encoded_key;
3399 return $self->_handle_param_unicode_decoding($value);
3403 sub _handle_param_unicode_decoding {
3404 my ( $self, $value ) = @_;
3405 return unless defined $value; # not in love with just ignoring undefs - jnap
3406 return $value if blessed($value); #don't decode when the value is an object.
3408 my $enc = $self->encoding;
3410 $enc->decode( $value, $self->_encode_check );
3413 $self->handle_unicode_encoding_exception({
3414 param_value => $value,
3416 encoding_step => 'params',
3421 =head2 $c->setup_log
3423 Sets up log by instantiating a L<Catalyst::Log|Catalyst::Log> object and
3424 passing it to C<log()>. Pass in a comma-delimited list of levels to set the
3427 This method also installs a C<debug> method that returns a true value into the
3428 catalyst subclass if the "debug" level is passed in the comma-delimited list,
3429 or if the C<$CATALYST_DEBUG> environment variable is set to a true value.
3431 Note that if the log has already been setup, by either a previous call to
3432 C<setup_log> or by a call such as C<< __PACKAGE__->log( MyLogger->new ) >>,
3433 that this method won't actually set up the log object.
3438 my ( $class, $levels ) = @_;
3441 $levels =~ s/^\s+//;
3442 $levels =~ s/\s+$//;
3443 my %levels = map { $_ => 1 } split /\s*,\s*/, $levels;
3445 my $env_debug = Catalyst::Utils::env_value( $class, 'DEBUG' );
3446 if ( defined $env_debug ) {
3447 $levels{debug} = 1 if $env_debug; # Ugly!
3448 delete($levels{debug}) unless $env_debug;
3451 unless ( $class->log ) {
3452 $class->log( Catalyst::Log->new(keys %levels) );
3455 if ( $levels{debug} ) {
3456 Class::MOP::get_metaclass_by_name($class)->add_method('debug' => sub { 1 });
3457 $class->log->debug('Debug messages enabled');
3461 =head2 $c->setup_plugins
3467 =head2 $c->setup_stats
3469 Sets up timing statistics class.
3474 my ( $class, $stats ) = @_;
3476 Catalyst::Utils::ensure_class_loaded($class->stats_class);
3478 my $env = Catalyst::Utils::env_value( $class, 'STATS' );
3479 if ( defined($env) ? $env : ($stats || $class->debug ) ) {
3480 Class::MOP::get_metaclass_by_name($class)->add_method('use_stats' => sub { 1 });
3481 $class->log->debug('Statistics enabled');
3486 =head2 $c->registered_plugins
3488 Returns a sorted list of the plugins which have either been stated in the
3491 If passed a given plugin name, it will report a boolean value indicating
3492 whether or not that plugin is loaded. A fully qualified name is required if
3493 the plugin name does not begin with C<Catalyst::Plugin::>.
3495 if ($c->registered_plugins('Some::Plugin')) {
3503 sub registered_plugins {
3505 return sort keys %{ $proto->_plugins } unless @_;
3507 return 1 if exists $proto->_plugins->{$plugin};
3508 return exists $proto->_plugins->{"Catalyst::Plugin::$plugin"};
3511 sub _register_plugin {
3512 my ( $proto, $plugin, $instant ) = @_;
3513 my $class = ref $proto || $proto;
3515 load_class( $plugin );
3516 $class->log->warn( "$plugin inherits from 'Catalyst::Component' - this is deprecated and will not work in 5.81" )
3517 if $plugin->isa( 'Catalyst::Component' );
3518 my $plugin_meta = Moose::Meta::Class->create($plugin);
3519 if (!$plugin_meta->has_method('new')
3520 && ( $plugin->isa('Class::Accessor::Fast') || $plugin->isa('Class::Accessor') ) ) {
3521 $plugin_meta->add_method('new', Moose::Object->meta->get_method('new'))
3523 if (!$instant && !$proto->_plugins->{$plugin}) {
3524 my $meta = Class::MOP::get_metaclass_by_name($class);
3525 $meta->superclasses($plugin, $meta->superclasses);
3527 $proto->_plugins->{$plugin} = 1;
3531 sub _default_plugins { return qw() }
3534 my ( $class, $plugins ) = @_;
3536 $class->_plugins( {} ) unless $class->_plugins;
3538 m/Unicode::Encoding/ ? do {
3540 'Unicode::Encoding plugin is auto-applied,'
3541 . ' please remove this from your appclass'
3542 . ' and make sure to define "encoding" config'
3544 unless (exists $class->config->{'encoding'}) {
3545 $class->config->{'encoding'} = 'UTF-8';
3550 push @$plugins, $class->_default_plugins;
3551 $plugins = Data::OptList::mkopt($plugins || []);
3554 [ Catalyst::Utils::resolve_namespace(
3555 $class . '::Plugin',
3556 'Catalyst::Plugin', $_->[0]
3562 for my $plugin ( reverse @plugins ) {
3563 load_class($plugin->[0], $plugin->[1]);
3564 my $meta = find_meta($plugin->[0]);
3565 next if $meta && $meta->isa('Moose::Meta::Role');
3567 $class->_register_plugin($plugin->[0]);
3571 map { $_->[0]->name, $_->[1] }
3572 grep { blessed($_->[0]) && $_->[0]->isa('Moose::Meta::Role') }
3573 map { [find_meta($_->[0]), $_->[1]] }
3576 Moose::Util::apply_all_roles(
3582 =head2 default_middleware
3584 Returns a list of instantiated PSGI middleware objects which is the default
3585 middleware that is active for this application (taking any configuration
3586 options into account, excluding your custom added middleware via the C<psgi_middleware>
3587 configuration option). You can override this method if you wish to change
3588 the default middleware (although do so at risk since some middleware is vital
3589 to application function.)
3591 The current default middleware list is:
3593 Catalyst::Middleware::Stash
3594 Plack::Middleware::HTTPExceptions
3595 Plack::Middleware::RemoveRedundantBody
3596 Plack::Middleware::FixMissingBodyInRedirect
3597 Plack::Middleware::ContentLength
3598 Plack::Middleware::MethodOverride
3599 Plack::Middleware::Head
3601 If the configuration setting C<using_frontend_proxy> is true we add:
3603 Plack::Middleware::ReverseProxy
3605 If the configuration setting C<using_frontend_proxy_path> is true we add:
3607 Plack::Middleware::ReverseProxyPath
3609 But B<NOTE> that L<Plack::Middleware::ReverseProxyPath> is not a dependency of the
3610 L<Catalyst> distribution so if you want to use this option you should add it to
3611 your project distribution file.
3613 These middlewares will be added at L</setup_middleware> during the
3614 L</setup> phase of application startup.
3618 sub default_middleware {
3621 Catalyst::Middleware::Stash->new,
3622 Plack::Middleware::HTTPExceptions->new,
3623 Plack::Middleware::RemoveRedundantBody->new,
3624 Plack::Middleware::FixMissingBodyInRedirect->new,
3625 Plack::Middleware::ContentLength->new,
3626 Plack::Middleware::MethodOverride->new,
3627 Plack::Middleware::Head->new);
3629 if($class->config->{using_frontend_proxy}) {
3630 push @mw, Plack::Middleware::ReverseProxy->new;
3633 if($class->config->{using_frontend_proxy_path}) {
3634 if(Class::Load::try_load_class('Plack::Middleware::ReverseProxyPath')) {
3635 push @mw, Plack::Middleware::ReverseProxyPath->new;
3637 $class->log->error("Cannot use configuration 'using_frontend_proxy_path' because 'Plack::Middleware::ReverseProxyPath' is not installed");
3644 =head2 registered_middlewares
3646 Read only accessor that returns an array of all the middleware in the order
3647 that they were added (which is the REVERSE of the order they will be applied).
3649 The values returned will be either instances of L<Plack::Middleware> or of a
3650 compatible interface, or a coderef, which is assumed to be inlined middleware
3652 =head2 setup_middleware (?@middleware)
3654 Read configuration information stored in configuration key C<psgi_middleware> or
3657 See under L</CONFIGURATION> information regarding C<psgi_middleware> and how
3658 to use it to enable L<Plack::Middleware>
3660 This method is automatically called during 'setup' of your application, so
3661 you really don't need to invoke it. However you may do so if you find the idea
3662 of loading middleware via configuration weird :). For example:
3668 __PACKAGE__->setup_middleware('Head');
3671 When we read middleware definitions from configuration, we reverse the list
3672 which sounds odd but is likely how you expect it to work if you have prior
3673 experience with L<Plack::Builder> or if you previously used the plugin
3674 L<Catalyst::Plugin::EnableMiddleware> (which is now considered deprecated)
3676 So basically your middleware handles an incoming request from the first
3677 registered middleware, down and handles the response from the last middleware
3682 sub registered_middlewares {
3684 if(my $middleware = $class->_psgi_middleware) {
3685 my @mw = ($class->default_middleware, @$middleware);
3687 if($class->config->{using_frontend_proxy}) {
3688 push @mw, Plack::Middleware::ReverseProxy->new;
3693 die "You cannot call ->registered_middlewares until middleware has been setup";
3697 sub setup_middleware {
3699 my @middleware_definitions;
3701 # If someone calls this method you can add middleware with args. However if its
3702 # called without an arg we need to setup the configuration middleware.
3704 @middleware_definitions = reverse(@_);
3706 @middleware_definitions = reverse(@{$class->config->{'psgi_middleware'}||[]})
3707 unless $class->finalized_default_middleware;
3708 $class->finalized_default_middleware(1); # Only do this once, just in case some people call setup over and over...
3711 my @middleware = ();
3712 while(my $next = shift(@middleware_definitions)) {
3714 if(Scalar::Util::blessed $next && $next->can('wrap')) {
3715 push @middleware, $next;
3716 } elsif(ref $next eq 'CODE') {
3717 push @middleware, $next;
3718 } elsif(ref $next eq 'HASH') {
3719 my $namespace = shift @middleware_definitions;
3720 my $mw = $class->Catalyst::Utils::build_middleware($namespace, %$next);
3721 push @middleware, $mw;
3723 die "I can't handle middleware definition ${\ref $next}";
3726 my $mw = $class->Catalyst::Utils::build_middleware($next);
3727 push @middleware, $mw;
3731 my @existing = @{$class->_psgi_middleware || []};
3732 $class->_psgi_middleware([@middleware,@existing,]);
3735 =head2 registered_data_handlers
3737 A read only copy of registered Data Handlers returned as a Hash, where each key
3738 is a content type and each value is a subref that attempts to decode that content
3741 =head2 setup_data_handlers (?@data_handler)
3743 Read configuration information stored in configuration key C<data_handlers> or
3746 See under L</CONFIGURATION> information regarding C<data_handlers>.
3748 This method is automatically called during 'setup' of your application, so
3749 you really don't need to invoke it.
3751 =head2 default_data_handlers
3753 Default Data Handlers that come bundled with L<Catalyst>. Currently there are
3754 only two default data handlers, for 'application/json' and an alternative to
3755 'application/x-www-form-urlencoded' which supposed nested form parameters via
3756 L<CGI::Struct> or via L<CGI::Struct::XS> IF you've installed it.
3758 The 'application/json' data handler is used to parse incoming JSON into a Perl
3759 data structure. It used either L<JSON::MaybeXS> or L<JSON>, depending on which
3760 is installed. This allows you to fail back to L<JSON:PP>, which is a Pure Perl
3761 JSON decoder, and has the smallest dependency impact.
3763 Because we don't wish to add more dependencies to L<Catalyst>, if you wish to
3764 use this new feature we recommend installing L<JSON> or L<JSON::MaybeXS> in
3765 order to get the best performance. You should add either to your dependency
3766 list (Makefile.PL, dist.ini, cpanfile, etc.)
3770 sub registered_data_handlers {
3772 if(my $data_handlers = $class->_data_handlers) {
3773 return %$data_handlers;
3775 $class->setup_data_handlers;
3776 return $class->registered_data_handlers;
3780 sub setup_data_handlers {
3781 my ($class, %data_handler_callbacks) = @_;
3782 %data_handler_callbacks = (
3783 %{$class->default_data_handlers},
3784 %{$class->config->{'data_handlers'}||+{}},
3785 %data_handler_callbacks);
3787 $class->_data_handlers(\%data_handler_callbacks);
3790 sub default_data_handlers {
3793 'application/x-www-form-urlencoded' => sub {
3794 my ($fh, $req) = @_;
3795 my $params = $req->_use_hash_multivalue ? $req->body_parameters->mixed : $req->body_parameters;
3796 Class::Load::load_first_existing_class('CGI::Struct::XS', 'CGI::Struct')
3797 ->can('build_cgi_struct')->($params);
3799 'application/json' => sub {
3800 my ($fh, $req) = @_;
3801 my $parser = Class::Load::load_first_existing_class('JSON::MaybeXS', 'JSON');
3805 $slurped = $fh->getline;
3806 $parser->can("decode_json")->($slurped); # decode_json does utf8 decoding for us
3807 } || Catalyst::Exception->throw(sprintf "Error Parsing POST '%s', Error: %s", (defined($slurped) ? $slurped : 'undef') ,$@);
3812 sub _handle_http_exception {
3813 my ( $self, $error ) = @_;
3815 !$self->config->{always_catch_http_exceptions}
3818 $error->can('as_psgi')
3819 || ( $error->can('code')
3820 && $error->code =~ m/^[1-5][0-9][0-9]$/ )
3830 Returns an arrayref of the internal execution stack (actions that are
3831 currently executing).
3835 Returns the current timing statistics object. By default Catalyst uses
3836 L<Catalyst::Stats|Catalyst::Stats>, but can be set otherwise with
3837 L<< stats_class|/"$c->stats_class" >>.
3839 Even if L<< -Stats|/"-Stats" >> is not enabled, the stats object is still
3840 available. By enabling it with C< $c->stats->enabled(1) >, it can be used to
3841 profile explicitly, although MyApp.pm still won't profile nor output anything
3844 =head2 $c->stats_class
3846 Returns or sets the stats (timing statistics) class. L<Catalyst::Stats|Catalyst::Stats> is used by default.
3848 =head2 $app->stats_class_traits
3850 A arrayref of L<Moose::Role>s that are applied to the stats_class before creating it.
3852 =head2 $app->composed_stats_class
3854 this is the stats_class composed with any 'stats_class_traits'.
3856 =head2 $c->use_stats
3858 Returns 1 when L<< stats collection|/"-Stats" >> is enabled.
3860 Note that this is a static method, not an accessor and should be overridden
3861 by declaring C<sub use_stats { 1 }> in your MyApp.pm, not by calling C<< $c->use_stats(1) >>.
3868 =head2 $c->write( $data )
3870 Writes $data to the output stream. When using this method directly, you
3871 will need to manually set the C<Content-Length> header to the length of
3872 your output data, if known.
3879 # Finalize headers if someone manually writes output (for compat)
3880 $c->finalize_headers;
3882 return $c->response->write( @_ );
3887 Returns the Catalyst version number. Mostly useful for "powered by"
3888 messages in template systems.
3892 sub version { return $Catalyst::VERSION }
3894 =head1 CONFIGURATION
3896 There are a number of 'base' config variables which can be set:
3902 C<always_catch_http_exceptions> - As of version 5.90060 Catalyst
3903 rethrows errors conforming to the interface described by
3904 L<Plack::Middleware::HTTPExceptions> and lets the middleware deal with it.
3905 Set true to get the deprecated behaviour and have Catalyst catch HTTP exceptions.
3909 C<default_model> - The default model picked if you say C<< $c->model >>. See L<< /$c->model($name) >>.
3913 C<default_view> - The default view to be rendered or returned when C<< $c->view >> is called. See L<< /$c->view($name) >>.
3917 C<disable_component_resolution_regex_fallback> - Turns
3918 off the deprecated component resolution functionality so
3919 that if any of the component methods (e.g. C<< $c->controller('Foo') >>)
3920 are called then regex search will not be attempted on string values and
3921 instead C<undef> will be returned.
3925 C<home> - The application home directory. In an uninstalled application,
3926 this is the top level application directory. In an installed application,
3927 this will be the directory containing C<< MyApp.pm >>.
3931 C<ignore_frontend_proxy> - See L</PROXY SUPPORT>
3935 C<name> - The name of the application in debug messages and the debug and
3940 C<parse_on_demand> - The request body (for example file uploads) will not be parsed
3941 until it is accessed. This allows you to (for example) check authentication (and reject
3942 the upload) before actually receiving all the data. See L</ON-DEMAND PARSER>
3946 C<root> - The root directory for templates. Usually this is just a
3947 subdirectory of the home directory, but you can set it to change the
3948 templates to a different directory.
3952 C<search_extra> - Array reference passed to Module::Pluggable to for additional
3953 namespaces from which components will be loaded (and constructed and stored in
3954 C<< $c->components >>).
3958 C<show_internal_actions> - If true, causes internal actions such as C<< _DISPATCH >>
3959 to be shown in hit debug tables in the test server.
3963 C<use_request_uri_for_path> - Controls if the C<REQUEST_URI> or C<PATH_INFO> environment
3964 variable should be used for determining the request path.
3966 Most web server environments pass the requested path to the application using environment variables,
3967 from which Catalyst has to reconstruct the request base (i.e. the top level path to / in the application,
3968 exposed as C<< $c->request->base >>) and the request path below that base.
3970 There are two methods of doing this, both of which have advantages and disadvantages. Which method is used
3971 is determined by the C<< $c->config(use_request_uri_for_path) >> setting (which can either be true or false).
3975 =item use_request_uri_for_path => 0
3977 This is the default (and the) traditional method that Catalyst has used for determining the path information.
3978 The path is generated from a combination of the C<PATH_INFO> and C<SCRIPT_NAME> environment variables.
3979 The allows the application to behave correctly when C<mod_rewrite> is being used to redirect requests
3980 into the application, as these variables are adjusted by mod_rewrite to take account for the redirect.
3982 However this method has the major disadvantage that it is impossible to correctly decode some elements
3983 of the path, as RFC 3875 says: "C<< Unlike a URI path, the PATH_INFO is not URL-encoded, and cannot
3984 contain path-segment parameters. >>" This means PATH_INFO is B<always> decoded, and therefore Catalyst
3985 can't distinguish / vs %2F in paths (in addition to other encoded values).
3987 =item use_request_uri_for_path => 1
3989 This method uses the C<REQUEST_URI> and C<SCRIPT_NAME> environment variables. As C<REQUEST_URI> is never
3990 decoded, this means that applications using this mode can correctly handle URIs including the %2F character
3991 (i.e. with C<AllowEncodedSlashes> set to C<On> in Apache).
3993 Given that this method of path resolution is provably more correct, it is recommended that you use
3994 this unless you have a specific need to deploy your application in a non-standard environment, and you are
3995 aware of the implications of not being able to handle encoded URI paths correctly.
3997 However it also means that in a number of cases when the app isn't installed directly at a path, but instead
3998 is having paths rewritten into it (e.g. as a .cgi/fcgi in a public_html directory, with mod_rewrite in a
3999 .htaccess file, or when SSI is used to rewrite pages into the app, or when sub-paths of the app are exposed
4000 at other URIs than that which the app is 'normally' based at with C<mod_rewrite>), the resolution of
4001 C<< $c->request->base >> will be incorrect.
4007 C<using_frontend_proxy> - See L</PROXY SUPPORT>.
4011 C<using_frontend_proxy_path> - Enabled L<Plack::Middleware::ReverseProxyPath> on your application (if
4012 installed, otherwise log an error). This is useful if your application is not running on the
4013 'root' (or /) of your host server. B<NOTE> if you use this feature you should add the required
4014 middleware to your project dependency list since its not automatically a dependency of L<Catalyst>.
4015 This has been done since not all people need this feature and we wish to restrict the growth of
4016 L<Catalyst> dependencies.
4020 C<encoding> - See L</ENCODING>
4022 This now defaults to 'UTF-8'. You my turn it off by setting this configuration
4027 C<abort_chain_on_error_fix>
4029 When there is an error in an action chain, the default behavior is to continue
4030 processing the remaining actions and then catch the error upon chain end. This
4031 can lead to running actions when the application is in an unexpected state. If
4032 you have this issue, setting this config value to true will promptly exit a
4033 chain when there is an error raised in any action (thus terminating the chain
4038 __PACKAGE__->config(abort_chain_on_error_fix => 1);
4040 In the future this might become the default behavior.
4044 C<use_hash_multivalue_in_request>
4046 In L<Catalyst::Request> the methods C<query_parameters>, C<body_parametes>
4047 and C<parameters> return a hashref where values might be scalar or an arrayref
4048 depending on the incoming data. In many cases this can be undesirable as it
4049 leads one to writing defensive code like the following:
4051 my ($val) = ref($c->req->parameters->{a}) ?
4052 @{$c->req->parameters->{a}} :
4053 $c->req->parameters->{a};
4055 Setting this configuration item to true will make L<Catalyst> populate the
4056 attributes underlying these methods with an instance of L<Hash::MultiValue>
4057 which is used by L<Plack::Request> and others to solve this very issue. You
4058 may prefer this behavior to the default, if so enable this option (be warned
4059 if you enable it in a legacy application we are not sure if it is completely
4060 backwardly compatible).
4064 C<skip_complex_post_part_handling>
4066 When creating body parameters from a POST, if we run into a multpart POST
4067 that does not contain uploads, but instead contains inlined complex data
4068 (very uncommon) we cannot reliably convert that into field => value pairs. So
4069 instead we create an instance of L<Catalyst::Request::PartData>. If this causes
4070 issue for you, you can disable this by setting C<skip_complex_post_part_handling>
4071 to true (default is false).
4075 C<skip_body_param_unicode_decoding>
4077 Generally we decode incoming POST params based on your declared encoding (the
4078 default for this is to decode UTF-8). If this is causing you trouble and you
4079 do not wish to turn all encoding support off (with the C<encoding> configuration
4080 parameter) you may disable this step atomically by setting this configuration
4085 C<do_not_decode_query>
4087 If true, then do not try to character decode any wide characters in your
4088 request URL query or keywords. Most readings of the relevent specifications
4089 suggest these should be UTF-* encoded, which is the default that L<Catalyst>
4090 will use, hwoever if you are creating a lot of URLs manually or have external
4091 evil clients, this might cause you trouble. If you find the changes introduced
4092 in Catalyst version 5.90080+ break some of your query code, you may disable
4093 the UTF-8 decoding globally using this configuration.
4095 This setting takes precedence over C<default_query_encoding> and
4096 C<decode_query_using_global_encoding>
4100 C<default_query_encoding>
4102 By default we decode query and keywords in your request URL using UTF-8, which
4103 is our reading of the relevent specifications. This setting allows one to
4104 specify a fixed value for how to decode your query. You might need this if
4105 you are doing a lot of custom encoding of your URLs and not using UTF-8.
4107 This setting take precedence over C<decode_query_using_global_encoding>.
4111 C<decode_query_using_global_encoding>
4113 Setting this to true will default your query decoding to whatever your
4114 general global encoding is (the default is UTF-8).
4118 C<use_chained_args_0_special_case>
4120 In older versions of Catalyst, when more than one action matched the same path
4121 AND all those matching actions declared Args(0), we'd break the tie by choosing
4122 the first action defined. We now normalized how Args(0) works so that it
4123 follows the same rule as Args(N), which is to say when we need to break a tie
4124 we choose the LAST action defined. If this breaks your code and you don't
4125 have time to update to follow the new normalized approach, you may set this
4126 value to true and it will globally revert to the original chaining behavior.
4130 C<psgi_middleware> - See L<PSGI MIDDLEWARE>.
4134 C<data_handlers> - See L<DATA HANDLERS>.
4138 C<stats_class_traits>
4140 An arrayref of L<Moose::Role>s that get componsed into your stats class.
4144 C<request_class_traits>
4146 An arrayref of L<Moose::Role>s that get componsed into your request class.
4150 C<response_class_traits>
4152 An arrayref of L<Moose::Role>s that get componsed into your response class.
4156 C<inject_components>
4158 A Hashref of L<Catalyst::Component> subclasses that are 'injected' into configuration.
4162 inject_components => {
4163 'Controller::Err' => { from_component => 'Local::Controller::Errors' },
4164 'Model::Zoo' => { from_component => 'Local::Model::Foo' },
4165 'Model::Foo' => { from_component => 'Local::Model::Foo', roles => ['TestRole'] },
4167 'Controller::Err' => { a => 100, b=>200, namespace=>'error' },
4168 'Model::Zoo' => { a => 2 },
4169 'Model::Foo' => { a => 100 },
4172 Generally L<Catalyst> looks for components in your Model/View or Controller directories.
4173 However for cases when you which to use an existing component and you don't need any
4174 customization (where for when you can apply a role to customize it) you may inject those
4175 components into your application. Please note any configuration should be done 'in the
4176 normal way', with a key under configuration named after the component affix, as in the
4179 Using this type of injection allows you to construct significant amounts of your application
4180 with only configuration!. This may or may not lead to increased code understanding.
4182 Please not you may also call the ->inject_components application method as well, although
4183 you must do so BEFORE setup.
4189 Generally when you throw an exception inside an Action (or somewhere in
4190 your stack, such as in a model that an Action is calling) that exception
4191 is caught by Catalyst and unless you either catch it yourself (via eval
4192 or something like L<Try::Tiny> or by reviewing the L</error> stack, it
4193 will eventually reach L</finalize_errors> and return either the debugging
4194 error stack page, or the default error page. However, if your exception
4195 can be caught by L<Plack::Middleware::HTTPExceptions>, L<Catalyst> will
4196 instead rethrow it so that it can be handled by that middleware (which
4197 is part of the default middleware). For example this would allow
4199 use HTTP::Throwable::Factory 'http_throw';
4201 sub throws_exception :Local {
4202 my ($self, $c) = @_;
4204 http_throw(SeeOther => { location =>
4205 $c->uri_for($self->action_for('redirect')) });
4209 =head1 INTERNAL ACTIONS
4211 Catalyst uses internal actions like C<_DISPATCH>, C<_BEGIN>, C<_AUTO>,
4212 C<_ACTION>, and C<_END>. These are by default not shown in the private
4213 action table, but you can make them visible with a config parameter.
4215 MyApp->config(show_internal_actions => 1);
4217 =head1 ON-DEMAND PARSER
4219 The request body is usually parsed at the beginning of a request,
4220 but if you want to handle input yourself, you can enable on-demand
4221 parsing with a config parameter.
4223 MyApp->config(parse_on_demand => 1);
4225 =head1 PROXY SUPPORT
4227 Many production servers operate using the common double-server approach,
4228 with a lightweight frontend web server passing requests to a larger
4229 backend server. An application running on the backend server must deal
4230 with two problems: the remote user always appears to be C<127.0.0.1> and
4231 the server's hostname will appear to be C<localhost> regardless of the
4232 virtual host that the user connected through.
4234 Catalyst will automatically detect this situation when you are running
4235 the frontend and backend servers on the same machine. The following
4236 changes are made to the request.
4238 $c->req->address is set to the user's real IP address, as read from
4239 the HTTP X-Forwarded-For header.
4241 The host value for $c->req->base and $c->req->uri is set to the real
4242 host, as read from the HTTP X-Forwarded-Host header.
4244 Additionally, you may be running your backend application on an insecure
4245 connection (port 80) while your frontend proxy is running under SSL. If there
4246 is a discrepancy in the ports, use the HTTP header C<X-Forwarded-Port> to
4247 tell Catalyst what port the frontend listens on. This will allow all URIs to
4248 be created properly.
4250 In the case of passing in:
4252 X-Forwarded-Port: 443
4254 All calls to C<uri_for> will result in an https link, as is expected.
4256 Obviously, your web server must support these headers for this to work.
4258 In a more complex server farm environment where you may have your
4259 frontend proxy server(s) on different machines, you will need to set a
4260 configuration option to tell Catalyst to read the proxied data from the
4263 MyApp->config(using_frontend_proxy => 1);
4265 If you do not wish to use the proxy support at all, you may set:
4267 MyApp->config(ignore_frontend_proxy => 0);
4269 =head2 Note about psgi files
4271 Note that if you supply your own .psgi file, calling
4272 C<< MyApp->psgi_app(@_); >>, then B<this will not happen automatically>.
4274 You either need to apply L<Plack::Middleware::ReverseProxy> yourself
4275 in your psgi, for example:
4278 enable "Plack::Middleware::ReverseProxy";
4282 This will unconditionally add the ReverseProxy support, or you need to call
4283 C<< $app = MyApp->apply_default_middlewares($app) >> (to conditionally
4284 apply the support depending upon your config).
4286 See L<Catalyst::PSGI> for more information.
4288 =head1 THREAD SAFETY
4290 Catalyst has been tested under Apache 2's threading C<mpm_worker>,
4291 C<mpm_winnt>, and the standalone forking HTTP server on Windows. We
4292 believe the Catalyst core to be thread-safe.
4294 If you plan to operate in a threaded environment, remember that all other
4295 modules you are using must also be thread-safe. Some modules, most notably
4296 L<DBD::SQLite>, are not thread-safe.
4298 =head1 DATA HANDLERS
4300 The L<Catalyst::Request> object uses L<HTTP::Body> to populate 'classic' HTML
4301 form parameters and URL search query fields. However it has become common
4302 for various alternative content types to be PUT or POSTed to your controllers
4303 and actions. People working on RESTful APIs, or using AJAX often use JSON,
4304 XML and other content types when communicating with an application server. In
4305 order to better support this use case, L<Catalyst> defines a global configuration
4306 option, C<data_handlers>, which lets you associate a content type with a coderef
4307 that parses that content type into something Perl can readily access.
4314 __PACKAGE__->config(
4316 'application/json' => sub { local $/; decode_json $_->getline },
4318 ## Any other configuration.
4323 By default L<Catalyst> comes with a generic JSON data handler similar to the
4324 example given above, which uses L<JSON::Maybe> to provide either L<JSON::PP>
4325 (a pure Perl, dependency free JSON parser) or L<Cpanel::JSON::XS> if you have
4326 it installed (if you want the faster XS parser, add it to you project Makefile.PL
4327 or dist.ini, cpanfile, etc.)
4329 The C<data_handlers> configuration is a hashref whose keys are HTTP Content-Types
4330 (matched against the incoming request type using a regexp such as to be case
4331 insensitive) and whose values are coderefs that receive a localized version of
4332 C<$_> which is a filehandle object pointing to received body.
4334 This feature is considered an early access release and we reserve the right
4335 to alter the interface in order to provide a performant and secure solution to
4336 alternative request body content. Your reports welcomed!
4338 =head1 PSGI MIDDLEWARE
4340 You can define middleware, defined as L<Plack::Middleware> or a compatible
4341 interface in configuration. Your middleware definitions are in the form of an
4342 arrayref under the configuration key C<psgi_middleware>. Here's an example
4343 with details to follow:
4348 use Plack::Middleware::StackTrace;
4350 my $stacktrace_middleware = Plack::Middleware::StackTrace->new;
4352 __PACKAGE__->config(
4353 'psgi_middleware', [
4356 $stacktrace_middleware,
4357 'Session' => {store => 'File'},
4362 $env->{myapp.customkey} = 'helloworld';
4371 So the general form is:
4373 __PACKAGE__->config(psgi_middleware => \@middleware_definitions);
4375 Where C<@middleware> is one or more of the following, applied in the REVERSE of
4376 the order listed (to make it function similarly to L<Plack::Builder>:
4378 Alternatively, you may also define middleware by calling the L</setup_middleware>
4385 __PACKAGE__->setup_middleware( \@middleware_definitions);
4388 In the case where you do both (use 'setup_middleware' and configuration) the
4389 package call to setup_middleware will be applied earlier (in other words its
4390 middleware will wrap closer to the application). Keep this in mind since in
4391 some cases the order of middleware is important.
4393 The two approaches are not exclusive.
4397 =item Middleware Object
4399 An already initialized object that conforms to the L<Plack::Middleware>
4402 my $stacktrace_middleware = Plack::Middleware::StackTrace->new;
4404 __PACKAGE__->config(
4405 'psgi_middleware', [
4406 $stacktrace_middleware,
4412 A coderef that is an inlined middleware:
4414 __PACKAGE__->config(
4415 'psgi_middleware', [
4420 if($env->{PATH_INFO} =~m/forced/) {
4422 ->new(file=>TestApp->path_to(qw/share static forced.txt/))
4425 return $app->($env);
4435 We assume the scalar refers to a namespace after normalizing it using the
4438 (1) If the scalar is prefixed with a "+" (as in C<+MyApp::Foo>) then the full string
4439 is assumed to be 'as is', and we just install and use the middleware.
4441 (2) If the scalar begins with "Plack::Middleware" or your application namespace
4442 (the package name of your Catalyst application subclass), we also assume then
4443 that it is a full namespace, and use it.
4445 (3) Lastly, we then assume that the scalar is a partial namespace, and attempt to
4446 resolve it first by looking for it under your application namespace (for example
4447 if you application is "MyApp::Web" and the scalar is "MyMiddleware", we'd look
4448 under "MyApp::Web::Middleware::MyMiddleware") and if we don't find it there, we
4449 will then look under the regular L<Plack::Middleware> namespace (i.e. for the
4450 previous we'd try "Plack::Middleware::MyMiddleware"). We look under your application
4451 namespace first to let you 'override' common L<Plack::Middleware> locally, should
4452 you find that a good idea.
4458 __PACKAGE__->config(
4459 'psgi_middleware', [
4460 'Debug', ## MyAppWeb::Middleware::Debug->wrap or Plack::Middleware::Debug->wrap
4461 'Plack::Middleware::Stacktrace', ## Plack::Middleware::Stacktrace->wrap
4462 '+MyApp::Custom', ## MyApp::Custom->wrap
4466 =item a scalar followed by a hashref
4468 Just like the previous, except the following C<HashRef> is used as arguments
4469 to initialize the middleware object.
4471 __PACKAGE__->config(
4472 'psgi_middleware', [
4473 'Session' => {store => 'File'},
4478 Please see L<PSGI> for more on middleware.
4482 Starting in L<Catalyst> version 5.90080 encoding is automatically enabled
4483 and set to encode all body responses to UTF8 when possible and applicable.
4484 Following is documentation on this process. If you are using an older
4485 version of L<Catalyst> you should review documentation for that version since
4488 By default encoding is now 'UTF-8'. You may turn it off by setting
4489 the encoding configuration to undef.
4491 MyApp->config(encoding => undef);
4493 This is recommended for temporary backwards compatibility only.
4495 Encoding is automatically applied when the content-type is set to
4496 a type that can be encoded. Currently we encode when the content type
4497 matches the following regular expression:
4499 $content_type =~ /^text|xml$|javascript$/
4501 Encoding is set on the application, but it is copied to the context object
4502 so that you can override it on a request basis.
4504 Be default we don't automatically encode 'application/json' since the most
4505 common approaches to generating this type of response (Either via L<Catalyst::View::JSON>
4506 or L<Catalyst::Action::REST>) will do so already and we want to avoid double
4509 If you are producing JSON response in an unconventional manner (such
4510 as via a template or manual strings) you should perform the UTF8 encoding
4511 manually as well such as to conform to the JSON specification.
4513 NOTE: We also examine the value of $c->response->content_encoding. If
4514 you set this (like for example 'gzip', and manually gzipping the body)
4515 we assume that you have done all the necessary encoding yourself, since
4516 we cannot encode the gzipped contents. If you use a plugin like
4517 L<Catalyst::Plugin::Compress> you need to update to a modern version in order
4518 to have this function correctly with the new UTF8 encoding code, or you
4519 can use L<Plack::Middleware::Deflater> or (probably best) do your compression on
4528 Returns an instance of an C<Encode> encoding
4530 print $c->encoding->name
4532 =item handle_unicode_encoding_exception ($exception_context)
4534 Method called when decoding process for a request fails.
4536 An C<$exception_context> hashref is provided to allow you to override the
4537 behaviour of your application when given data with incorrect encodings.
4539 The default method throws exceptions in the case of invalid request parameters
4540 (resulting in a 500 error), but ignores errors in upload filenames.
4542 The keys passed in the C<$exception_context> hash are:
4548 The value which was not able to be decoded.
4552 The exception received from L<Encode>.
4556 What type of data was being decoded. Valid values are (currently)
4557 C<params> - for request parameters / arguments / captures
4558 and C<uploads> - for request upload filenames.
4568 Join #catalyst on irc.perl.org.
4572 http://lists.scsys.co.uk/cgi-bin/mailman/listinfo/catalyst
4573 http://lists.scsys.co.uk/cgi-bin/mailman/listinfo/catalyst-dev
4577 http://catalyst.perl.org
4581 http://dev.catalyst.perl.org
4585 =head2 L<Task::Catalyst> - All you need to start with Catalyst
4587 =head2 L<Catalyst::Manual> - The Catalyst Manual
4589 =head2 L<Catalyst::Component>, L<Catalyst::Controller> - Base classes for components
4591 =head2 L<Catalyst::Engine> - Core engine
4593 =head2 L<Catalyst::Log> - Log class.
4595 =head2 L<Catalyst::Request> - Request object
4597 =head2 L<Catalyst::Response> - Response object
4599 =head2 L<Catalyst::Test> - The test suite.
4601 =head1 PROJECT FOUNDER
4603 sri: Sebastian Riedel <sri@cpan.org>
4609 acme: Leon Brocard <leon@astray.com>
4611 abraxxa: Alexander Hartmaier <abraxxa@cpan.org>
4613 andrewalker: André Walker <andre@cpan.org>
4617 Andrew Ford E<lt>A.Ford@ford-mason.co.ukE<gt>
4621 andyg: Andy Grundman <andy@hybridized.org>
4623 audreyt: Audrey Tang
4625 bricas: Brian Cassidy <bricas@cpan.org>
4627 Caelum: Rafael Kitover <rkitover@io.com>
4629 chansen: Christian Hansen
4631 chicks: Christopher Hicks
4633 Chisel Wright C<pause@herlpacker.co.uk>
4635 Danijel Milicevic C<me@danijel.de>
4637 davewood: David Schmidt <davewood@cpan.org>
4639 David Kamholz E<lt>dkamholz@cpan.orgE<gt>
4641 David Naughton, C<naughton@umn.edu>
4645 dhoss: Devin Austin <dhoss@cpan.org>
4647 dkubb: Dan Kubb <dan.kubb-cpan@onautopilot.com>
4651 dwc: Daniel Westermann-Clark <danieltwc@cpan.org>
4653 esskar: Sascha Kiefer
4655 fireartist: Carl Franks <cfranks@cpan.org>
4657 frew: Arthur Axel "fREW" Schmidt <frioux@gmail.com>
4659 gabb: Danijel Milicevic
4663 Gavin Henry C<ghenry@perl.me.uk>
4667 groditi: Guillermo Roditi <groditi@gmail.com>
4669 hobbs: Andrew Rodland <andrew@cleverdomain.org>
4671 ilmari: Dagfinn Ilmari Mannsåker <ilmari@ilmari.org>
4673 jcamacho: Juan Camacho
4675 jester: Jesse Sheidlower C<jester@panix.com>
4677 jhannah: Jay Hannah <jay@jays.net>
4683 jon: Jon Schutz <jjschutz@cpan.org>
4685 Jonathan Rockway C<< <jrockway@cpan.org> >>
4687 Kieren Diment C<kd@totaldatasolution.com>
4689 konobi: Scott McWhirter <konobi@cpan.org>
4691 marcus: Marcus Ramberg <mramberg@cpan.org>
4693 miyagawa: Tatsuhiko Miyagawa <miyagawa@bulknews.net>
4695 mgrimes: Mark Grimes <mgrimes@cpan.org>
4697 mst: Matt S. Trout <mst@shadowcatsystems.co.uk>
4701 naughton: David Naughton
4703 ningu: David Kamholz <dkamholz@cpan.org>
4705 nothingmuch: Yuval Kogman <nothingmuch@woobling.org>
4707 numa: Dan Sully <daniel@cpan.org>
4713 omega: Andreas Marienborg
4715 Oleg Kostyuk <cub.uanic@gmail.com>
4717 phaylon: Robert Sedlacek <phaylon@dunkelheit.at>
4719 rafl: Florian Ragwitz <rafl@debian.org>
4721 random: Roland Lammel <lammel@cpan.org>
4723 Robert Sedlacek C<< <rs@474.at> >>
4725 SpiceMan: Marcel Montes
4729 szbalint: Balint Szilakszi <szbalint@cpan.org>
4731 t0m: Tomas Doran <bobtfish@bobtfish.net>
4735 vanstyn: Henry Van Styn <vanstyn@cpan.org>
4737 Viljo Marrandi C<vilts@yahoo.com>
4739 Will Hawes C<info@whawes.co.uk>
4741 willert: Sebastian Willert <willert@cpan.org>
4743 wreis: Wallace Reis <wreis@cpan.org>
4745 Yuval Kogman, C<nothingmuch@woobling.org>
4747 rainboxx: Matthias Dietrich, C<perl@rainboxx.de>
4749 dd070: Dhaval Dhanani <dhaval070@gmail.com>
4751 Upasana <me@upasana.me>
4753 John Napiorkowski (jnap) <jjnapiork@cpan.org>
4757 Copyright (c) 2005-2015, the above named PROJECT FOUNDER and CONTRIBUTORS.
4761 This library is free software. You can redistribute it and/or modify it under
4762 the same terms as Perl itself.
4768 __PACKAGE__->meta->make_immutable;