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_001';
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 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 return Catalyst::Middleware::Stash::get_stash($c->req->env)->(@_);
550 =head2 $c->error($error, ...)
552 =head2 $c->error($arrayref)
554 Returns an arrayref containing error messages. If Catalyst encounters an
555 error while processing a request, it stores the error in $c->error. This
556 method should only be used to store fatal error messages.
558 my @error = @{ $c->error };
562 $c->error('Something bad happened');
564 Calling this will always return an arrayref (if there are no errors it
565 will be an empty arrayref.
572 my $error = ref $_[0] eq 'ARRAY' ? $_[0] : [@_];
573 croak @$error unless ref $c;
574 push @{ $c->{error} }, @$error;
576 elsif ( defined $_[0] ) { $c->{error} = undef }
577 return $c->{error} || [];
583 Contains the return value of the last executed action.
584 Note that << $c->state >> operates in a scalar context which means that all
585 values it returns are scalar.
587 =head2 $c->clear_errors
589 Clear errors. You probably don't want to clear the errors unless you are
590 implementing a custom error screen.
592 This is equivalent to running
603 =head2 $c->has_errors
605 Returns true if you have errors
609 sub has_errors { scalar(@{shift->error}) ? 1:0 }
611 =head2 $c->last_error
613 Returns the most recent error in the stack (the one most recently added...)
614 or nothing if there are no errors.
618 sub last_error { my ($err, @errs) = @{shift->error}; return $err }
622 shifts the most recently added error off the error stack and returns if. Returns
623 nothing if there are no more errors.
629 my ($err, @errors) = @{$self->error};
630 $self->{error} = \@errors;
634 sub _comp_search_prefixes {
636 return map $c->components->{ $_ }, $c->_comp_names_search_prefixes(@_);
639 # search components given a name and some prefixes
640 sub _comp_names_search_prefixes {
641 my ( $c, $name, @prefixes ) = @_;
642 my $appclass = ref $c || $c;
643 my $filter = "^${appclass}::(" . join( '|', @prefixes ) . ')::';
644 $filter = qr/$filter/; # Compile regex now rather than once per loop
646 # map the original component name to the sub part that we will search against
647 my %eligible = map { my $n = $_; $n =~ s{^$appclass\::[^:]+::}{}; $_ => $n; }
648 grep { /$filter/ } keys %{ $c->components };
650 # undef for a name will return all
651 return keys %eligible if !defined $name;
653 my $query = $name->$_isa('Regexp') ? $name : qr/^$name$/i;
654 my @result = grep { $eligible{$_} =~ m{$query} } keys %eligible;
656 return @result if @result;
658 # if we were given a regexp to search against, we're done.
659 return if $name->$_isa('Regexp');
661 # skip regexp fallback if configured
663 if $appclass->config->{disable_component_resolution_regex_fallback};
667 @result = grep { $eligible{ $_ } =~ m{$query} } keys %eligible;
669 # no results? try against full names
671 @result = grep { m{$query} } keys %eligible;
674 # don't warn if we didn't find any results, it just might not exist
676 # Disgusting hack to work out correct method name
677 my $warn_for = lc $prefixes[0];
678 my $msg = "Used regexp fallback for \$c->${warn_for}('${name}'), which found '" .
679 (join '", "', @result) . "'. Relying on regexp fallback behavior for " .
680 "component resolution is unreliable and unsafe.";
681 my $short = $result[0];
682 # remove the component namespace prefix
683 $short =~ s/.*?(Model|Controller|View):://;
684 my $shortmess = Carp::shortmess('');
685 if ($shortmess =~ m#Catalyst/Plugin#) {
686 $msg .= " You probably need to set '$short' instead of '${name}' in this " .
688 } elsif ($shortmess =~ m#Catalyst/lib/(View|Controller)#) {
689 $msg .= " You probably need to set '$short' instead of '${name}' in this " .
690 "component's config";
692 $msg .= " You probably meant \$c->${warn_for}('$short') instead of \$c->${warn_for}('${name}'), " .
693 "but if you really wanted to search, pass in a regexp as the argument " .
694 "like so: \$c->${warn_for}(qr/${name}/)";
696 $c->log->warn( "${msg}$shortmess" );
702 # Find possible names for a prefix
704 my ( $c, @prefixes ) = @_;
705 my $appclass = ref $c || $c;
707 my $filter = "^${appclass}::(" . join( '|', @prefixes ) . ')::';
709 my @names = map { s{$filter}{}; $_; }
710 $c->_comp_names_search_prefixes( undef, @prefixes );
715 # Filter a component before returning by calling ACCEPT_CONTEXT if available
718 sub _filter_component {
719 my ( $c, $comp, @args ) = @_;
721 # die "Circular Dependencies Detected." if $tracker{$comp};
723 if(ref $comp eq 'CODE') {
728 if ( eval { $comp->can('ACCEPT_CONTEXT'); } ) {
729 return $comp->ACCEPT_CONTEXT( $c, @args );
732 $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;
737 =head2 COMPONENT ACCESSORS
739 =head2 $c->controller($name)
741 Gets a L<Catalyst::Controller> instance by name.
743 $c->controller('Foo')->do_stuff;
745 If the name is omitted, will return the controller for the dispatched
748 If you want to search for controllers, pass in a regexp as the argument.
750 # find all controllers that start with Foo
751 my @foo_controllers = $c->controller(qr{^Foo});
757 my ( $c, $name, @args ) = @_;
759 my $appclass = ref($c) || $c;
761 unless ( $name->$_isa('Regexp') ) { # Direct component hash lookup to avoid costly regexps
762 my $comps = $c->components;
763 my $check = $appclass."::Controller::".$name;
764 return $c->_filter_component( $comps->{$check}, @args ) if exists $comps->{$check};
766 my @result = $c->_comp_search_prefixes( $name, qw/Controller C/ );
767 return map { $c->_filter_component( $_, @args ) } @result if ref $name;
768 return $c->_filter_component( $result[ 0 ], @args );
771 return $c->component( $c->action->class );
774 =head2 $c->model($name)
776 Gets a L<Catalyst::Model> instance by name.
778 $c->model('Foo')->do_stuff;
780 Any extra arguments are directly passed to ACCEPT_CONTEXT, if the model
781 defines ACCEPT_CONTEXT. If it does not, the args are discarded.
783 If the name is omitted, it will look for
784 - a model object in $c->stash->{current_model_instance}, then
785 - a model name in $c->stash->{current_model}, then
786 - a config setting 'default_model', or
787 - check if there is only one model, and return it if that's the case.
789 If you want to search for models, pass in a regexp as the argument.
791 # find all models that start with Foo
792 my @foo_models = $c->model(qr{^Foo});
797 my ( $c, $name, @args ) = @_;
798 my $appclass = ref($c) || $c;
800 unless ( $name->$_isa('Regexp') ) { # Direct component hash lookup to avoid costly regexps
801 my $comps = $c->components;
802 my $check = $appclass."::Model::".$name;
803 return $c->_filter_component( $comps->{$check}, @args ) if exists $comps->{$check};
805 my @result = $c->_comp_search_prefixes( $name, qw/Model M/ );
806 return map { $c->_filter_component( $_, @args ) } @result if ref $name;
807 return $c->_filter_component( $result[ 0 ], @args );
811 return $c->stash->{current_model_instance}
812 if $c->stash->{current_model_instance};
813 return $c->model( $c->stash->{current_model} )
814 if $c->stash->{current_model};
816 return $c->model( $appclass->config->{default_model} )
817 if $appclass->config->{default_model};
819 my( $comp, $rest ) = $c->_comp_search_prefixes( undef, qw/Model M/);
822 $c->log->warn( Carp::shortmess('Calling $c->model() will return a random model unless you specify one of:') );
823 $c->log->warn( '* $c->config(default_model => "the name of the default model to use")' );
824 $c->log->warn( '* $c->stash->{current_model} # the name of the model to use for this request' );
825 $c->log->warn( '* $c->stash->{current_model_instance} # the instance of the model to use for this request' );
826 $c->log->warn( 'NB: in version 5.81, the "random" behavior will not work at all.' );
829 return $c->_filter_component( $comp );
833 =head2 $c->view($name)
835 Gets a L<Catalyst::View> instance by name.
837 $c->view('Foo')->do_stuff;
839 Any extra arguments are directly passed to ACCEPT_CONTEXT.
841 If the name is omitted, it will look for
842 - a view object in $c->stash->{current_view_instance}, then
843 - a view name in $c->stash->{current_view}, then
844 - a config setting 'default_view', or
845 - check if there is only one view, and return it if that's the case.
847 If you want to search for views, pass in a regexp as the argument.
849 # find all views that start with Foo
850 my @foo_views = $c->view(qr{^Foo});
855 my ( $c, $name, @args ) = @_;
857 my $appclass = ref($c) || $c;
859 unless ( $name->$_isa('Regexp') ) { # Direct component hash lookup to avoid costly regexps
860 my $comps = $c->components;
861 my $check = $appclass."::View::".$name;
862 if( exists $comps->{$check} ) {
863 return $c->_filter_component( $comps->{$check}, @args );
866 $c->log->warn( "Attempted to use view '$check', but does not exist" );
869 my @result = $c->_comp_search_prefixes( $name, qw/View V/ );
870 return map { $c->_filter_component( $_, @args ) } @result if ref $name;
871 return $c->_filter_component( $result[ 0 ], @args );
875 return $c->stash->{current_view_instance}
876 if $c->stash->{current_view_instance};
877 return $c->view( $c->stash->{current_view} )
878 if $c->stash->{current_view};
880 return $c->view( $appclass->config->{default_view} )
881 if $appclass->config->{default_view};
883 my( $comp, $rest ) = $c->_comp_search_prefixes( undef, qw/View V/);
886 $c->log->warn( 'Calling $c->view() will return a random view unless you specify one of:' );
887 $c->log->warn( '* $c->config(default_view => "the name of the default view to use")' );
888 $c->log->warn( '* $c->stash->{current_view} # the name of the view to use for this request' );
889 $c->log->warn( '* $c->stash->{current_view_instance} # the instance of the view to use for this request' );
890 $c->log->warn( 'NB: in version 5.81, the "random" behavior will not work at all.' );
893 return $c->_filter_component( $comp );
896 =head2 $c->controllers
898 Returns the available names which can be passed to $c->controller
904 return $c->_comp_names(qw/Controller C/);
909 Returns the available names which can be passed to $c->model
915 return $c->_comp_names(qw/Model M/);
921 Returns the available names which can be passed to $c->view
927 return $c->_comp_names(qw/View V/);
930 =head2 $c->comp($name)
932 =head2 $c->component($name)
934 Gets a component object by name. This method is not recommended,
935 unless you want to get a specific component by full
936 class. C<< $c->controller >>, C<< $c->model >>, and C<< $c->view >>
937 should be used instead.
939 If C<$name> is a regexp, a list of components matched against the full
940 component name will be returned.
942 If Catalyst can't find a component by name, it will fallback to regex
943 matching by default. To disable this behaviour set
944 disable_component_resolution_regex_fallback to a true value.
946 __PACKAGE__->config( disable_component_resolution_regex_fallback => 1 );
951 my ( $c, $name, @args ) = @_;
954 my $comps = $c->components;
957 # is it the exact name?
958 return $c->_filter_component( $comps->{ $name }, @args )
959 if exists $comps->{ $name };
961 # perhaps we just omitted "MyApp"?
962 my $composed = ( ref $c || $c ) . "::${name}";
963 return $c->_filter_component( $comps->{ $composed }, @args )
964 if exists $comps->{ $composed };
966 # search all of the models, views and controllers
967 my( $comp ) = $c->_comp_search_prefixes( $name, qw/Model M Controller C View V/ );
968 return $c->_filter_component( $comp, @args ) if $comp;
972 if $c->config->{disable_component_resolution_regex_fallback};
974 # This is here so $c->comp( '::M::' ) works
975 my $query = ref $name ? $name : qr{$name}i;
977 my @result = grep { m{$query} } keys %{ $c->components };
978 return map { $c->_filter_component( $_, @args ) } @result if ref $name;
981 $c->log->warn( Carp::shortmess(qq(Found results for "${name}" using regexp fallback)) );
982 $c->log->warn( 'Relying on the regexp fallback behavior for component resolution' );
983 $c->log->warn( 'is unreliable and unsafe. You have been warned' );
984 return $c->_filter_component( $result[ 0 ], @args );
987 # I would expect to return an empty list here, but that breaks back-compat
991 return sort keys %{ $c->components };
994 =head2 CLASS DATA AND HELPER CLASSES
998 Returns or takes a hashref containing the application's configuration.
1000 __PACKAGE__->config( { db => 'dsn:SQLite:foo.db' } );
1002 You can also use a C<YAML>, C<XML> or L<Config::General> config file
1003 like C<myapp.conf> in your applications home directory. See
1004 L<Catalyst::Plugin::ConfigLoader>.
1006 =head3 Cascading configuration
1008 The config method is present on all Catalyst components, and configuration
1009 will be merged when an application is started. Configuration loaded with
1010 L<Catalyst::Plugin::ConfigLoader> takes precedence over other configuration,
1011 followed by configuration in your top level C<MyApp> class. These two
1012 configurations are merged, and then configuration data whose hash key matches a
1013 component name is merged with configuration for that component.
1015 The configuration for a component is then passed to the C<new> method when a
1016 component is constructed.
1020 MyApp->config({ 'Model::Foo' => { bar => 'baz', overrides => 'me' } });
1021 MyApp::Model::Foo->config({ quux => 'frob', overrides => 'this' });
1023 will mean that C<MyApp::Model::Foo> receives the following data when
1026 MyApp::Model::Foo->new({
1032 It's common practice to use a Moose attribute
1033 on the receiving component to access the config value.
1035 package MyApp::Model::Foo;
1039 # this attr will receive 'baz' at construction time
1045 You can then get the value 'baz' by calling $c->model('Foo')->bar
1046 (or $self->bar inside code in the model).
1048 B<NOTE:> you MUST NOT call C<< $self->config >> or C<< __PACKAGE__->config >>
1049 as a way of reading config within your code, as this B<will not> give you the
1050 correctly merged config back. You B<MUST> take the config values supplied to
1051 the constructor and use those instead.
1055 around config => sub {
1059 croak('Setting config after setup has been run is not allowed.')
1060 if ( @_ and $c->setup_finished );
1067 Returns the logging object instance. Unless it is already set, Catalyst
1068 sets this up with a L<Catalyst::Log> object. To use your own log class,
1069 set the logger with the C<< __PACKAGE__->log >> method prior to calling
1070 C<< __PACKAGE__->setup >>.
1072 __PACKAGE__->log( MyLogger->new );
1077 $c->log->info( 'Now logging with my own logger!' );
1079 Your log class should implement the methods described in
1084 Returned True if there's a valid encoding
1086 =head2 clear_encoding
1088 Clears the encoding for the current context
1092 Sets or gets the application encoding. Setting encoding takes either an
1093 Encoding object or a string that we try to resolve via L<Encode::find_encoding>.
1095 You would expect to get the encoding object back if you attempt to set it. If
1096 there is a failure you will get undef returned and an error message in the log.
1100 sub has_encoding { shift->encoding ? 1:0 }
1102 sub clear_encoding {
1105 $c->encoding(undef);
1107 $c->log->error("You can't clear encoding on the application");
1117 # Don't let one change this once we are too far into the response
1118 if(blessed $c && $c->res->finalized_headers) {
1119 Carp::croak("You may not change the encoding once the headers are finalized");
1123 # Let it be set to undef
1124 if (my $wanted = shift) {
1125 $encoding = Encode::find_encoding($wanted)
1126 or Carp::croak( qq/Unknown encoding '$wanted'/ );
1127 binmode(STDERR, ':encoding(' . $encoding->name . ')');
1134 ? $c->{encoding} = $encoding
1135 : $c->_encoding($encoding);
1137 $encoding = ref $c && exists $c->{encoding}
1147 Returns 1 if debug mode is enabled, 0 otherwise.
1149 You can enable debug mode in several ways:
1153 =item By calling myapp_server.pl with the -d flag
1155 =item With the environment variables MYAPP_DEBUG, or CATALYST_DEBUG
1157 =item The -Debug option in your MyApp.pm
1159 =item By declaring C<sub debug { 1 }> in your MyApp.pm.
1163 The first three also set the log level to 'debug'.
1165 Calling C<< $c->debug(1) >> has no effect.
1171 =head2 $c->dispatcher
1173 Returns the dispatcher instance. See L<Catalyst::Dispatcher>.
1177 Returns the engine instance. See L<Catalyst::Engine>.
1180 =head2 UTILITY METHODS
1182 =head2 $c->path_to(@path)
1184 Merges C<@path> with C<< $c->config->{home} >> and returns a
1185 L<Path::Class::Dir> object. Note you can usually use this object as
1186 a filename, but sometimes you will have to explicitly stringify it
1187 yourself by calling the C<< ->stringify >> method.
1191 $c->path_to( 'db', 'sqlite.db' );
1196 my ( $c, @path ) = @_;
1197 my $path = Path::Class::Dir->new( $c->config->{home}, @path );
1198 if ( -d $path ) { return $path }
1199 else { return Path::Class::File->new( $c->config->{home}, @path ) }
1203 my ( $class, $name, $plugin, @args ) = @_;
1205 # See block comment in t/unit_core_plugin.t
1206 $class->log->warn(qq/Adding plugin using the ->plugin method is deprecated, and will be removed in a future release/);
1208 $class->_register_plugin( $plugin, 1 );
1210 eval { $plugin->import };
1211 $class->mk_classdata($name);
1213 eval { $obj = $plugin->new(@args) };
1216 Catalyst::Exception->throw( message =>
1217 qq/Couldn't instantiate instant plugin "$plugin", "$@"/ );
1220 $class->$name($obj);
1221 $class->log->debug(qq/Initialized instant plugin "$plugin" as "$name"/)
1227 Initializes the dispatcher and engine, loads any plugins, and loads the
1228 model, view, and controller components. You may also specify an array
1229 of plugins to load here, if you choose to not load them in the C<use
1233 MyApp->setup( qw/-Debug/ );
1235 B<Note:> You B<should not> wrap this method with method modifiers
1236 or bad things will happen - wrap the C<setup_finalize> method instead.
1238 B<Note:> You can create a custom setup stage that will execute when the
1239 application is starting. Use this to customize setup.
1241 MyApp->setup(-Custom=value);
1244 my ($class, $value) = @_;
1247 Can be handy if you want to hook into the setup phase.
1252 my ( $class, @arguments ) = @_;
1253 croak('Running setup more than once')
1254 if ( $class->setup_finished );
1256 unless ( $class->isa('Catalyst') ) {
1258 Catalyst::Exception->throw(
1259 message => qq/'$class' does not inherit from Catalyst/ );
1262 if ( $class->arguments ) {
1263 @arguments = ( @arguments, @{ $class->arguments } );
1269 foreach (@arguments) {
1273 ( $flags->{log} ) ? 'debug,' . $flags->{log} : 'debug';
1275 elsif (/^-(\w+)=?(.*)$/) {
1276 $flags->{ lc $1 } = $2;
1279 push @{ $flags->{plugins} }, $_;
1283 $class->setup_home( delete $flags->{home} );
1285 $class->setup_log( delete $flags->{log} );
1286 $class->setup_plugins( delete $flags->{plugins} );
1288 $class->setup_data_handlers();
1289 $class->setup_dispatcher( delete $flags->{dispatcher} );
1290 if (my $engine = delete $flags->{engine}) {
1291 $class->log->warn("Specifying the engine in ->setup is no longer supported, see Catalyst::Upgrading");
1293 $class->setup_engine();
1294 $class->setup_stats( delete $flags->{stats} );
1296 for my $flag ( sort keys %{$flags} ) {
1298 if ( my $code = $class->can( 'setup_' . $flag ) ) {
1299 &$code( $class, delete $flags->{$flag} );
1302 $class->log->warn(qq/Unknown flag "$flag"/);
1306 eval { require Catalyst::Devel; };
1307 if( !$@ && $ENV{CATALYST_SCRIPT_GEN} && ( $ENV{CATALYST_SCRIPT_GEN} < $Catalyst::Devel::CATALYST_SCRIPT_GEN ) ) {
1308 $class->log->warn(<<"EOF");
1309 You are running an old script!
1311 Please update by running (this will overwrite existing files):
1312 catalyst.pl -force -scripts $class
1314 or (this will not overwrite existing files):
1315 catalyst.pl -scripts $class
1320 # Call plugins setup, this is stupid and evil.
1321 # Also screws C3 badly on 5.10, hack to avoid.
1323 no warnings qw/redefine/;
1324 local *setup = sub { };
1325 $class->setup unless $Catalyst::__AM_RESTARTING;
1328 # If you are expecting configuration info as part of your setup, it needs
1329 # to get called here and below, since we need the above line to support
1330 # ConfigLoader based configs.
1332 $class->setup_encoding();
1333 $class->setup_middleware();
1335 # Initialize our data structure
1336 $class->components( {} );
1338 $class->setup_components;
1340 if ( $class->debug ) {
1341 my @plugins = map { "$_ " . ( $_->VERSION || '' ) } $class->registered_plugins;
1344 my $column_width = Catalyst::Utils::term_width() - 6;
1345 my $t = Text::SimpleTable->new($column_width);
1346 $t->row($_) for @plugins;
1347 $class->log->debug( "Loaded plugins:\n" . $t->draw . "\n" );
1350 my @middleware = map {
1353 (ref($_) .' '. ($_->can('VERSION') ? $_->VERSION || '' : '')
1354 || '') } $class->registered_middlewares;
1357 my $column_width = Catalyst::Utils::term_width() - 6;
1358 my $t = Text::SimpleTable->new($column_width);
1359 $t->row($_) for @middleware;
1360 $class->log->debug( "Loaded PSGI Middleware:\n" . $t->draw . "\n" );
1363 my %dh = $class->registered_data_handlers;
1364 if (my @data_handlers = keys %dh) {
1365 my $column_width = Catalyst::Utils::term_width() - 6;
1366 my $t = Text::SimpleTable->new($column_width);
1367 $t->row($_) for @data_handlers;
1368 $class->log->debug( "Loaded Request Data Handlers:\n" . $t->draw . "\n" );
1371 my $dispatcher = $class->dispatcher;
1372 my $engine = $class->engine;
1373 my $home = $class->config->{home};
1375 $class->log->debug(sprintf(q/Loaded dispatcher "%s"/, blessed($dispatcher)));
1376 $class->log->debug(sprintf(q/Loaded engine "%s"/, blessed($engine)));
1380 ? $class->log->debug(qq/Found home "$home"/)
1381 : $class->log->debug(qq/Home "$home" doesn't exist/)
1382 : $class->log->debug(q/Couldn't find home/);
1384 my $column_width = Catalyst::Utils::term_width() - 8 - 9;
1385 my $t = Text::SimpleTable->new( [ $column_width, 'Class' ], [ 8, 'Type' ] );
1386 for my $comp ( sort keys %{ $class->components } ) {
1387 my $type = ref $class->components->{$comp} ? 'instance' : 'class';
1388 $t->row( $comp, $type );
1390 $class->log->debug( "Loaded components:\n" . $t->draw . "\n" )
1391 if ( keys %{ $class->components } );
1394 # Add our self to components, since we are also a component
1395 if( $class->isa('Catalyst::Controller') ){
1396 $class->components->{$class} = $class;
1399 $class->setup_actions;
1401 if ( $class->debug ) {
1402 my $name = $class->config->{name} || 'Application';
1403 $class->log->info("$name powered by Catalyst $Catalyst::VERSION");
1406 if ($class->config->{case_sensitive}) {
1407 $class->log->warn($class . "->config->{case_sensitive} is set.");
1408 $class->log->warn("This setting is deprecated and planned to be removed in Catalyst 5.81.");
1411 $class->setup_finalize;
1413 # Flush the log for good measure (in case something turned off 'autoflush' early)
1414 $class->log->_flush() if $class->log->can('_flush');
1416 return $class || 1; # Just in case someone named their Application 0...
1419 =head2 $app->setup_finalize
1421 A hook to attach modifiers to. This method does not do anything except set the
1422 C<setup_finished> accessor.
1424 Applying method modifiers to the C<setup> method doesn't work, because of quirky things done for plugin setup.
1428 after setup_finalize => sub {
1436 sub setup_finalize {
1438 $class->setup_finished(1);
1441 =head2 $c->uri_for( $path?, @args?, \%query_values? )
1443 =head2 $c->uri_for( $action, \@captures?, @args?, \%query_values? )
1445 =head2 $c->uri_for( $action, [@captures, @args], \%query_values? )
1447 Constructs an absolute L<URI> object based on the application root, the
1448 provided path, and the additional arguments and query parameters provided.
1449 When used as a string, provides a textual URI. If you need more flexibility
1450 than this (i.e. the option to provide relative URIs etc.) see
1451 L<Catalyst::Plugin::SmartURI>.
1453 If no arguments are provided, the URI for the current action is returned.
1454 To return the current action and also provide @args, use
1455 C<< $c->uri_for( $c->action, @args ) >>.
1457 If the first argument is a string, it is taken as a public URI path relative
1458 to C<< $c->namespace >> (if it doesn't begin with a forward slash) or
1459 relative to the application root (if it does). It is then merged with
1460 C<< $c->request->base >>; any C<@args> are appended as additional path
1461 components; and any C<%query_values> are appended as C<?foo=bar> parameters.
1463 If the first argument is a L<Catalyst::Action> it represents an action which
1464 will have its path resolved using C<< $c->dispatcher->uri_for_action >>. The
1465 optional C<\@captures> argument (an arrayref) allows passing the captured
1466 variables that are needed to fill in the paths of Chained and Regex actions;
1467 once the path is resolved, C<uri_for> continues as though a path was
1468 provided, appending any arguments or parameters and creating an absolute
1471 The captures for the current request can be found in
1472 C<< $c->request->captures >>, and actions can be resolved using
1473 C<< Catalyst::Controller->action_for($name) >>. If you have a private action
1474 path, use C<< $c->uri_for_action >> instead.
1476 # Equivalent to $c->req->uri
1477 $c->uri_for($c->action, $c->req->captures,
1478 @{ $c->req->args }, $c->req->params);
1480 # For the Foo action in the Bar controller
1481 $c->uri_for($c->controller('Bar')->action_for('Foo'));
1483 # Path to a static resource
1484 $c->uri_for('/static/images/logo.png');
1486 In general the scheme of the generated URI object will follow the incoming request
1487 however if your targeted action or action chain has the Scheme attribute it will
1490 Also, if the targeted Action or Action chain declares Args/CaptureArgs that have
1491 type constraints, we will require that your proposed URL verify on those declared
1497 my ( $c, $path, @args ) = @_;
1499 if ( $path->$_isa('Catalyst::Controller') ) {
1500 $path = $path->path_prefix;
1505 undef($path) if (defined $path && $path eq '');
1508 ( scalar @args && ref $args[$#args] eq 'HASH' ? pop @args : {} );
1510 carp "uri_for called with undef argument" if grep { ! defined $_ } @args;
1512 my $target_action = $path->$_isa('Catalyst::Action') ? $path : undef;
1513 if ( $path->$_isa('Catalyst::Action') ) { # action object
1514 s|/|%2F|g for @args;
1515 my $captures = [ map { s|/|%2F|g; $_; }
1516 ( scalar @args && ref $args[0] eq 'ARRAY'
1521 my $expanded_action = $c->dispatcher->expand_action( $action );
1522 my $num_captures = $expanded_action->number_of_captures;
1524 # ->uri_for( $action, \@captures_and_args, \%query_values? )
1525 if( !@args && $action->number_of_args ) {
1526 unshift @args, splice @$captures, $num_captures;
1530 unless($expanded_action->match_captures_constraints($c, $captures)) {
1531 carp "captures [@{$captures}] do not match the type constraints in actionchain ending with '$expanded_action'";
1536 $path = $c->dispatcher->uri_for_action($action, $captures);
1537 if (not defined $path) {
1538 $c->log->debug(qq/Can't find uri_for action '$action' @$captures/)
1542 $path = '/' if $path eq '';
1544 # At this point @encoded_args is the remaining Args (all captures removed).
1545 if($expanded_action->has_args_constraints) {
1546 unless($expanded_action->match_args($c,\@args)) {
1547 carp "args [@args] do not match the type constraints in action '$expanded_action'";
1553 unshift(@args, $path);
1555 unless (defined $path && $path =~ s!^/!!) { # in-place strip
1556 my $namespace = $c->namespace;
1557 if (defined $path) { # cheesy hack to handle path '../foo'
1558 $namespace =~ s{(?:^|/)[^/]+$}{} while $args[0] =~ s{^\.\./}{};
1560 unshift(@args, $namespace || '');
1563 # join args with '/', or a blank string
1564 my $args = join('/', grep { defined($_) } @args);
1565 $args =~ s/\?/%3F/g; # STUPID STUPID SPECIAL CASE
1568 my ($base, $class) = ('/', 'URI::_generic');
1570 $base = $c->req->base;
1571 if($target_action) {
1572 $target_action = $c->dispatcher->expand_action($target_action);
1573 if(my $s = $target_action->scheme) {
1578 $class = ref($base);
1581 $class = ref($base);
1584 $base =~ s{(?<!/)$}{/};
1589 if (my @keys = keys %$params) {
1590 # somewhat lifted from URI::_query's query_form
1591 $query = '?'.join('&', map {
1592 my $val = $params->{$_};
1593 #s/([;\/?:@&=+,\$\[\]%])/$URI::Escape::escapes{$1}/go; ## Commented out because seems to lead to double encoding - JNAP
1596 $val = '' unless defined $val;
1599 $param = encode_utf8($param);
1600 # using the URI::Escape pattern here so utf8 chars survive
1601 $param =~ s/([^A-Za-z0-9\-_.!~*'() ])/$URI::Escape::escapes{$1}/go;
1604 $key = encode_utf8($key);
1605 # using the URI::Escape pattern here so utf8 chars survive
1606 $key =~ s/([^A-Za-z0-9\-_.!~*'() ])/$URI::Escape::escapes{$1}/go;
1609 "${key}=$param"; } ( ref $val eq 'ARRAY' ? @$val : $val ));
1613 $base = encode_utf8 $base;
1614 $base =~ s/([^$URI::uric])/$URI::Escape::escapes{$1}/go;
1615 $args = encode_utf8 $args;
1616 $args =~ s/([^$URI::uric])/$URI::Escape::escapes{$1}/go;
1618 my $res = bless(\"${base}${args}${query}", $class);
1622 =head2 $c->uri_for_action( $path, \@captures_and_args?, @args?, \%query_values? )
1624 =head2 $c->uri_for_action( $action, \@captures_and_args?, @args?, \%query_values? )
1630 A private path to the Catalyst action you want to create a URI for.
1632 This is a shortcut for calling C<< $c->dispatcher->get_action_by_path($path)
1633 >> and passing the resulting C<$action> and the remaining arguments to C<<
1636 You can also pass in a Catalyst::Action object, in which case it is passed to
1639 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.
1641 For example, if the action looks like:
1643 package MyApp::Controller::Users;
1645 sub lst : Path('the-list') {}
1649 $c->uri_for_action('/users/lst')
1651 and it will create the URI /users/the-list.
1653 =item \@captures_and_args?
1655 Optional array reference of Captures (i.e. C<<CaptureArgs or $c->req->captures>)
1656 and arguments to the request. Usually used with L<Catalyst::DispatchType::Chained>
1657 to interpolate all the parameters in the URI.
1661 Optional list of extra arguments - can be supplied in the
1662 C<< \@captures_and_args? >> array ref, or here - whichever is easier for your
1665 Your action can have zero, a fixed or a variable number of args (e.g.
1666 C<< Args(1) >> for a fixed number or C<< Args() >> for a variable number)..
1668 =item \%query_values?
1670 Optional array reference of query parameters to append. E.g.
1676 /rest/of/your/uri?foo=bar
1682 sub uri_for_action {
1683 my ( $c, $path, @args ) = @_;
1684 my $action = blessed($path)
1686 : $c->dispatcher->get_action_by_path($path);
1687 unless (defined $action) {
1688 croak "Can't find action for path '$path'";
1690 return $c->uri_for( $action, @args );
1693 =head2 $c->welcome_message
1695 Returns the Catalyst welcome HTML page.
1699 sub welcome_message {
1701 my $name = $c->config->{name};
1702 my $logo = $c->uri_for('/static/images/catalyst_logo.png');
1703 my $prefix = Catalyst::Utils::appprefix( ref $c );
1704 $c->response->content_type('text/html; charset=utf-8');
1706 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
1707 "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
1708 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
1710 <meta http-equiv="Content-Language" content="en" />
1711 <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
1712 <title>$name on Catalyst $VERSION</title>
1713 <style type="text/css">
1716 background-color: #eee;
1723 margin-bottom: 10px;
1725 background-color: #ccc;
1726 border: 1px solid #aaa;
1731 font-family: verdana, tahoma, sans-serif;
1734 font-family: verdana, tahoma, sans-serif;
1737 text-decoration: none;
1739 border-bottom: 1px dotted #bbb;
1741 :link:hover, :visited:hover {
1754 background-color: #fff;
1755 border: 1px solid #aaa;
1759 font-weight: normal;
1781 <h1><span id="appname">$name</span> on <a href="http://catalyst.perl.org">Catalyst</a>
1786 <img src="$logo" alt="Catalyst Logo" />
1788 <p>Welcome to the world of Catalyst.
1789 This <a href="http://en.wikipedia.org/wiki/MVC">MVC</a>
1790 framework will make web development something you had
1791 never expected it to be: Fun, rewarding, and quick.</p>
1792 <h2>What to do now?</h2>
1793 <p>That really depends on what <b>you</b> want to do.
1794 We do, however, provide you with a few starting points.</p>
1795 <p>If you want to jump right into web development with Catalyst
1796 you might want to start with a tutorial.</p>
1797 <pre>perldoc <a href="https://metacpan.org/module/Catalyst::Manual::Tutorial">Catalyst::Manual::Tutorial</a></code>
1799 <p>Afterwards you can go on to check out a more complete look at our features.</p>
1801 <code>perldoc <a href="https://metacpan.org/module/Catalyst::Manual::Intro">Catalyst::Manual::Intro</a>
1802 <!-- Something else should go here, but the Catalyst::Manual link seems unhelpful -->
1804 <h2>What to do next?</h2>
1805 <p>Next it's time to write an actual application. Use the
1806 helper scripts to generate <a href="https://metacpan.org/search?q=Catalyst%3A%3AController">controllers</a>,
1807 <a href="https://metacpan.org/search?q=Catalyst%3A%3AModel">models</a>, and
1808 <a href="https://metacpan.org/search?q=Catalyst%3A%3AView">views</a>;
1809 they can save you a lot of work.</p>
1810 <pre><code>script/${prefix}_create.pl --help</code></pre>
1811 <p>Also, be sure to check out the vast and growing
1812 collection of <a href="http://search.cpan.org/search?query=Catalyst">plugins for Catalyst on CPAN</a>;
1813 you are likely to find what you need there.
1817 <p>Catalyst has a very active community. Here are the main places to
1818 get in touch with us.</p>
1821 <a href="http://dev.catalyst.perl.org">Wiki</a>
1824 <a href="http://lists.scsys.co.uk/cgi-bin/mailman/listinfo/catalyst">Mailing-List</a>
1827 <a href="irc://irc.perl.org/catalyst">IRC channel #catalyst on irc.perl.org</a>
1830 <h2>In conclusion</h2>
1831 <p>The Catalyst team hopes you will enjoy using Catalyst as much
1832 as we enjoyed making it. Please contact us if you have ideas
1833 for improvement or other feedback.</p>
1843 Contains a hash of options passed from the application script, including
1844 the original ARGV the script received, the processed values from that
1845 ARGV and any extra arguments to the script which were not processed.
1847 This can be used to add custom options to your application's scripts
1848 and setup your application differently depending on the values of these
1851 =head1 INTERNAL METHODS
1853 These methods are not meant to be used by end users.
1855 =head2 $c->components
1857 Returns a hash of components.
1859 =head2 $c->context_class
1861 Returns or sets the context class.
1865 Returns a hashref containing coderefs and execution counts (needed for
1866 deep recursion detection).
1870 Returns the number of actions on the current internal execution stack.
1874 Dispatches a request to actions.
1878 sub dispatch { my $c = shift; $c->dispatcher->dispatch( $c, @_ ) }
1880 =head2 $c->dispatcher_class
1882 Returns or sets the dispatcher class.
1884 =head2 $c->dump_these
1886 Returns a list of 2-element array references (name, structure) pairs
1887 that will be dumped on the error page in debug mode.
1893 [ Request => $c->req ],
1894 [ Response => $c->res ],
1895 [ Stash => $c->stash ],
1896 [ Config => $c->config ];
1899 =head2 $c->engine_class
1901 Returns or sets the engine class.
1903 =head2 $c->execute( $class, $coderef )
1905 Execute a coderef in given class and catch exceptions. Errors are available
1911 my ( $c, $class, $code ) = @_;
1912 $class = $c->component($class) || $class;
1915 if ( $c->depth >= $RECURSION ) {
1916 my $action = $code->reverse();
1917 $action = "/$action" unless $action =~ /->/;
1918 my $error = qq/Deep recursion detected calling "${action}"/;
1919 $c->log->error($error);
1925 my $stats_info = $c->_stats_start_execute( $code ) if $c->use_stats;
1927 push( @{ $c->stack }, $code );
1929 no warnings 'recursion';
1930 # N.B. This used to be combined, but I have seen $c get clobbered if so, and
1931 # I have no idea how, ergo $ret (which appears to fix the issue)
1932 eval { my $ret = $code->execute( $class, $c, @{ $c->req->args } ) || 0; $c->state( $ret ) };
1934 $c->_stats_finish_execute( $stats_info ) if $c->use_stats and $stats_info;
1936 my $last = pop( @{ $c->stack } );
1938 if ( my $error = $@ ) {
1939 #rethow if this can be handled by middleware
1940 if ( $c->_handle_http_exception($error) ) {
1941 foreach my $err (@{$c->error}) {
1942 $c->log->error($err);
1945 $c->log->_flush if $c->log->can('_flush');
1947 $error->can('rethrow') ? $error->rethrow : croak $error;
1949 if ( blessed($error) and $error->isa('Catalyst::Exception::Detach') ) {
1950 $error->rethrow if $c->depth > 1;
1952 elsif ( blessed($error) and $error->isa('Catalyst::Exception::Go') ) {
1953 $error->rethrow if $c->depth > 0;
1956 unless ( ref $error ) {
1957 no warnings 'uninitialized';
1959 my $class = $last->class;
1960 my $name = $last->name;
1961 $error = qq/Caught exception in $class->$name "$error"/;
1970 sub _stats_start_execute {
1971 my ( $c, $code ) = @_;
1972 my $appclass = ref($c) || $c;
1973 return if ( ( $code->name =~ /^_.*/ )
1974 && ( !$appclass->config->{show_internal_actions} ) );
1976 my $action_name = $code->reverse();
1977 $c->counter->{$action_name}++;
1979 my $action = $action_name;
1980 $action = "/$action" unless $action =~ /->/;
1982 # determine if the call was the result of a forward
1983 # this is done by walking up the call stack and looking for a calling
1984 # sub of Catalyst::forward before the eval
1986 for my $index ( 2 .. 11 ) {
1988 if ( ( caller($index) )[0] eq 'Catalyst'
1989 && ( caller($index) )[3] eq '(eval)' );
1991 if ( ( caller($index) )[3] =~ /forward$/ ) {
1992 $callsub = ( caller($index) )[3];
1993 $action = "-> $action";
1998 my $uid = $action_name . $c->counter->{$action_name};
2000 # is this a root-level call or a forwarded call?
2001 if ( $callsub =~ /forward$/ ) {
2002 my $parent = $c->stack->[-1];
2004 # forward, locate the caller
2005 if ( defined $parent && exists $c->counter->{"$parent"} ) {
2008 parent => "$parent" . $c->counter->{"$parent"},
2014 # forward with no caller may come from a plugin
2033 sub _stats_finish_execute {
2034 my ( $c, $info ) = @_;
2035 $c->stats->profile( end => $info );
2040 Finalizes the request.
2047 for my $error ( @{ $c->error } ) {
2048 $c->log->error($error);
2051 # Support skipping finalize for psgix.io style 'jailbreak'. Used to support
2052 # stuff like cometd and websockets
2054 if($c->request->_has_io_fh) {
2059 # Allow engine to handle finalize flow (for POE)
2060 my $engine = $c->engine;
2061 if ( my $code = $engine->can('finalize') ) {
2066 $c->finalize_uploads;
2069 if ( $#{ $c->error } >= 0 ) {
2073 $c->finalize_encoding;
2074 $c->finalize_headers unless $c->response->finalized_headers;
2080 if ($c->use_stats) {
2081 my $elapsed = $c->stats->elapsed;
2082 my $av = $elapsed == 0 ? '??' : sprintf '%.3f', 1 / $elapsed;
2084 "Request took ${elapsed}s ($av/s)\n" . $c->stats->report . "\n" );
2087 return $c->response->status;
2090 =head2 $c->finalize_body
2096 sub finalize_body { my $c = shift; $c->engine->finalize_body( $c, @_ ) }
2098 =head2 $c->finalize_cookies
2104 sub finalize_cookies { my $c = shift; $c->engine->finalize_cookies( $c, @_ ) }
2106 =head2 $c->finalize_error
2108 Finalizes error. If there is only one error in L</error> and it is an object that
2109 does C<as_psgi> or C<code> we rethrow the error and presume it caught by middleware
2110 up the ladder. Otherwise we return the debugging error page (in debug mode) or we
2111 return the default error page (production mode).
2115 sub finalize_error {
2117 if($#{$c->error} > 0) {
2118 $c->engine->finalize_error( $c, @_ );
2120 my ($error) = @{$c->error};
2121 if ( $c->_handle_http_exception($error) ) {
2122 # In the case where the error 'knows what it wants', becauses its PSGI
2123 # aware, just rethow and let middleware catch it
2124 $error->can('rethrow') ? $error->rethrow : croak $error;
2126 $c->engine->finalize_error( $c, @_ )
2131 =head2 $c->finalize_headers
2137 sub finalize_headers {
2140 my $response = $c->response; #accessor calls can add up?
2142 # Check if we already finalized headers
2143 return if $response->finalized_headers;
2146 if ( my $location = $response->redirect ) {
2147 $c->log->debug(qq/Redirecting to "$location"/) if $c->debug;
2148 $response->header( Location => $location );
2151 # Remove incorrectly added body and content related meta data when returning
2152 # an information response, or a response the is required to not include a body
2154 $c->finalize_cookies;
2156 # This currently is a NOOP but I don't want to remove it since I guess people
2157 # might have Response subclasses that use it for something... (JNAP)
2158 $c->response->finalize_headers();
2161 $response->finalized_headers(1);
2164 =head2 $c->finalize_encoding
2166 Make sure your body is encoded properly IF you set an encoding. By
2167 default the encoding is UTF-8 but you can disable it by explicitly setting the
2168 encoding configuration value to undef.
2170 We can only encode when the body is a scalar. Methods for encoding via the
2171 streaming interfaces (such as C<write> and C<write_fh> on L<Catalyst::Response>
2178 sub finalize_encoding {
2180 my $res = $c->res || return;
2182 # Warn if the set charset is different from the one you put into encoding. We need
2183 # to do this early since encodable_response is false for this condition and we need
2184 # to match the debug output for backcompat (there's a test for this...) -JNAP
2186 $res->content_type_charset and $c->encoding and
2187 (uc($c->encoding->mime_name) ne uc($res->content_type_charset))
2189 my $ct = lc($res->content_type_charset);
2190 $c->log->debug("Catalyst encoding config is set to encode in '" .
2191 $c->encoding->mime_name .
2192 "', content type is '$ct', not encoding ");
2196 ($res->encodable_response) and
2197 (defined($res->body)) and
2198 (ref(\$res->body) eq 'SCALAR')
2200 $c->res->body( $c->encoding->encode( $c->res->body, $c->_encode_check ) );
2202 # Set the charset if necessary. This might be a bit bonkers since encodable response
2203 # is false when the set charset is not the same as the encoding mimetype (maybe
2204 # confusing action at a distance here..
2205 # Don't try to set the charset if one already exists
2206 $c->res->content_type($c->res->content_type . "; charset=" . $c->encoding->mime_name)
2207 unless($c->res->content_type_charset);
2211 =head2 $c->finalize_output
2213 An alias for finalize_body.
2215 =head2 $c->finalize_read
2217 Finalizes the input after reading is complete.
2221 sub finalize_read { my $c = shift; $c->engine->finalize_read( $c, @_ ) }
2223 =head2 $c->finalize_uploads
2225 Finalizes uploads. Cleans up any temporary files.
2229 sub finalize_uploads { my $c = shift; $c->engine->finalize_uploads( $c, @_ ) }
2231 =head2 $c->get_action( $action, $namespace )
2233 Gets an action in a given namespace.
2237 sub get_action { my $c = shift; $c->dispatcher->get_action(@_) }
2239 =head2 $c->get_actions( $action, $namespace )
2241 Gets all actions of a given name in a namespace and all parent
2246 sub get_actions { my $c = shift; $c->dispatcher->get_actions( $c, @_ ) }
2248 =head2 $app->handle_request( @arguments )
2250 Called to handle each HTTP request.
2254 sub handle_request {
2255 my ( $class, @arguments ) = @_;
2257 # Always expect worst case!
2260 if ($class->debug) {
2261 my $secs = time - $START || 1;
2262 my $av = sprintf '%.3f', $COUNT / $secs;
2263 my $time = localtime time;
2264 $class->log->info("*** Request $COUNT ($av/s) [$$] [$time] ***");
2267 my $c = $class->prepare(@arguments);
2269 $status = $c->finalize;
2271 #rethow if this can be handled by middleware
2272 if ( $class->_handle_http_exception($_) ) {
2273 $_->can('rethrow') ? $_->rethrow : croak $_;
2275 chomp(my $error = $_);
2276 $class->log->error(qq/Caught exception in engine "$error"/);
2281 if(my $coderef = $class->log->can('_flush')){
2282 $class->log->$coderef();
2287 =head2 $class->prepare( @arguments )
2289 Creates a Catalyst context from an engine-specific request (Apache, CGI,
2296 predicate => '_has_uploadtmp',
2300 my ( $class, @arguments ) = @_;
2303 # After the app/ctxt split, this should become an attribute based on something passed
2304 # into the application.
2305 $class->context_class( ref $class || $class ) unless $class->context_class;
2307 my $uploadtmp = $class->config->{uploadtmp};
2308 my $c = $class->context_class->new({ $uploadtmp ? (_uploadtmp => $uploadtmp) : ()});
2310 $c->response->_context($c);
2313 $c->stats($class->composed_stats_class->new)->enable;
2316 if ( $c->debug || $c->config->{enable_catalyst_header} ) {
2317 $c->res->headers->header( 'X-Catalyst' => $Catalyst::VERSION );
2321 # Allow engine to direct the prepare flow (for POE)
2322 if ( my $prepare = $c->engine->can('prepare') ) {
2323 $c->engine->$prepare( $c, @arguments );
2326 $c->prepare_request(@arguments);
2327 $c->prepare_connection;
2328 $c->prepare_query_parameters;
2329 $c->prepare_headers; # Just hooks, no longer needed - they just
2330 $c->prepare_cookies; # cause the lazy attribute on req to build
2333 # Prepare the body for reading, either by prepare_body
2334 # or the user, if they are using $c->read
2337 # Parse the body unless the user wants it on-demand
2338 unless ( ref($c)->config->{parse_on_demand} ) {
2344 # VERY ugly and probably shouldn't rely on ->finalize actually working
2346 # failed prepare is always due to an invalid request, right?
2347 $c->response->status(400);
2348 $c->response->content_type('text/plain');
2349 $c->response->body('Bad Request');
2350 # Note we call finalize and then die here, which escapes
2351 # finalize being called in the enclosing block..
2352 # It in fact couldn't be called, as we don't return $c..
2353 # This is a mess - but I'm unsure you can fix this without
2354 # breaking compat for people doing crazy things (we should set
2355 # the 400 and just return the ctx here IMO, letting finalize get called
2366 =head2 $c->prepare_action
2368 Prepares action. See L<Catalyst::Dispatcher>.
2372 sub prepare_action {
2374 my $ret = $c->dispatcher->prepare_action( $c, @_);
2377 foreach (@{$c->req->arguments}, @{$c->req->captures}) {
2378 $_ = $c->_handle_param_unicode_decoding($_);
2386 =head2 $c->prepare_body
2388 Prepares message body.
2395 return if $c->request->_has_body;
2397 # Initialize on-demand data
2398 $c->engine->prepare_body( $c, @_ );
2399 $c->prepare_parameters;
2400 $c->prepare_uploads;
2403 =head2 $c->prepare_body_chunk( $chunk )
2405 Prepares a chunk of data before sending it to L<HTTP::Body>.
2407 See L<Catalyst::Engine>.
2411 sub prepare_body_chunk {
2413 $c->engine->prepare_body_chunk( $c, @_ );
2416 =head2 $c->prepare_body_parameters
2418 Prepares body parameters.
2422 sub prepare_body_parameters {
2424 $c->request->prepare_body_parameters( $c, @_ );
2427 =head2 $c->prepare_connection
2429 Prepares connection.
2433 sub prepare_connection {
2435 $c->request->prepare_connection($c);
2438 =head2 $c->prepare_cookies
2440 Prepares cookies by ensuring that the attribute on the request
2441 object has been built.
2445 sub prepare_cookies { my $c = shift; $c->request->cookies }
2447 =head2 $c->prepare_headers
2449 Prepares request headers by ensuring that the attribute on the request
2450 object has been built.
2454 sub prepare_headers { my $c = shift; $c->request->headers }
2456 =head2 $c->prepare_parameters
2458 Prepares parameters.
2462 sub prepare_parameters {
2464 $c->prepare_body_parameters;
2465 $c->engine->prepare_parameters( $c, @_ );
2468 =head2 $c->prepare_path
2470 Prepares path and base.
2474 sub prepare_path { my $c = shift; $c->engine->prepare_path( $c, @_ ) }
2476 =head2 $c->prepare_query_parameters
2478 Prepares query parameters.
2482 sub prepare_query_parameters {
2485 $c->engine->prepare_query_parameters( $c, @_ );
2488 =head2 $c->log_request
2490 Writes information about the request to the debug logs. This includes:
2494 =item * Request method, path, and remote IP address
2496 =item * Query keywords (see L<Catalyst::Request/query_keywords>)
2498 =item * Request parameters
2500 =item * File uploads
2509 return unless $c->debug;
2511 my($dump) = grep {$_->[0] eq 'Request' } $c->dump_these;
2512 my $request = $dump->[1];
2514 my ( $method, $path, $address ) = ( $request->method, $request->path, $request->address );
2516 $path = '/' unless length $path;
2519 $path =~ s/%([0-9A-Fa-f]{2})/chr(hex($1))/eg;
2520 $path = decode_utf8($path);
2522 $c->log->debug(qq/"$method" request for "$path" from "$address"/);
2524 $c->log_request_headers($request->headers);
2526 if ( my $keywords = $request->query_keywords ) {
2527 $c->log->debug("Query keywords are: $keywords");
2530 $c->log_request_parameters( query => $request->query_parameters, $request->_has_body ? (body => $request->body_parameters) : () );
2532 $c->log_request_uploads($request);
2535 =head2 $c->log_response
2537 Writes information about the response to the debug logs by calling
2538 C<< $c->log_response_status_line >> and C<< $c->log_response_headers >>.
2545 return unless $c->debug;
2547 my($dump) = grep {$_->[0] eq 'Response' } $c->dump_these;
2548 my $response = $dump->[1];
2550 $c->log_response_status_line($response);
2551 $c->log_response_headers($response->headers);
2554 =head2 $c->log_response_status_line($response)
2556 Writes one line of information about the response to the debug logs. This includes:
2560 =item * Response status code
2562 =item * Content-Type header (if present)
2564 =item * Content-Length header (if present)
2570 sub log_response_status_line {
2571 my ($c, $response) = @_;
2575 'Response Code: %s; Content-Type: %s; Content-Length: %s',
2576 $response->status || 'unknown',
2577 $response->headers->header('Content-Type') || 'unknown',
2578 $response->headers->header('Content-Length') || 'unknown'
2583 =head2 $c->log_response_headers($headers);
2585 Hook method which can be wrapped by plugins to log the response headers.
2586 No-op in the default implementation.
2590 sub log_response_headers {}
2592 =head2 $c->log_request_parameters( query => {}, body => {} )
2594 Logs request parameters to debug logs
2598 sub log_request_parameters {
2600 my %all_params = @_;
2602 return unless $c->debug;
2604 my $column_width = Catalyst::Utils::term_width() - 44;
2605 foreach my $type (qw(query body)) {
2606 my $params = $all_params{$type};
2607 next if ! keys %$params;
2608 my $t = Text::SimpleTable->new( [ 35, 'Parameter' ], [ $column_width, 'Value' ] );
2609 for my $key ( sort keys %$params ) {
2610 my $param = $params->{$key};
2611 my $value = defined($param) ? $param : '';
2612 $t->row( $key, ref $value eq 'ARRAY' ? ( join ', ', @$value ) : $value );
2614 $c->log->debug( ucfirst($type) . " Parameters are:\n" . $t->draw );
2618 =head2 $c->log_request_uploads
2620 Logs file uploads included in the request to the debug logs.
2621 The parameter name, filename, file type, and file size are all included in
2626 sub log_request_uploads {
2628 my $request = shift;
2629 return unless $c->debug;
2630 my $uploads = $request->uploads;
2631 if ( keys %$uploads ) {
2632 my $t = Text::SimpleTable->new(
2633 [ 12, 'Parameter' ],
2638 for my $key ( sort keys %$uploads ) {
2639 my $upload = $uploads->{$key};
2640 for my $u ( ref $upload eq 'ARRAY' ? @{$upload} : ($upload) ) {
2641 $t->row( $key, $u->filename, $u->type, $u->size );
2644 $c->log->debug( "File Uploads are:\n" . $t->draw );
2648 =head2 $c->log_request_headers($headers);
2650 Hook method which can be wrapped by plugins to log the request headers.
2651 No-op in the default implementation.
2655 sub log_request_headers {}
2657 =head2 $c->log_headers($type => $headers)
2659 Logs L<HTTP::Headers> (either request or response) to the debug logs.
2666 my $headers = shift; # an HTTP::Headers instance
2668 return unless $c->debug;
2670 my $column_width = Catalyst::Utils::term_width() - 28;
2671 my $t = Text::SimpleTable->new( [ 15, 'Header Name' ], [ $column_width, 'Value' ] );
2674 my ( $name, $value ) = @_;
2675 $t->row( $name, $value );
2678 $c->log->debug( ucfirst($type) . " Headers:\n" . $t->draw );
2682 =head2 $c->prepare_read
2684 Prepares the input for reading.
2688 sub prepare_read { my $c = shift; $c->engine->prepare_read( $c, @_ ) }
2690 =head2 $c->prepare_request
2692 Prepares the engine request.
2696 sub prepare_request { my $c = shift; $c->engine->prepare_request( $c, @_ ) }
2698 =head2 $c->prepare_uploads
2704 sub prepare_uploads {
2706 $c->engine->prepare_uploads( $c, @_ );
2709 =head2 $c->prepare_write
2711 Prepares the output for writing.
2715 sub prepare_write { my $c = shift; $c->engine->prepare_write( $c, @_ ) }
2717 =head2 $c->request_class
2719 Returns or sets the request class. Defaults to L<Catalyst::Request>.
2721 =head2 $app->request_class_traits
2723 An arrayref of L<Moose::Role>s which are applied to the request class.
2725 =head2 $app->composed_request_class
2727 This is the request class which has been composed with any request_class_traits.
2729 =head2 $c->response_class
2731 Returns or sets the response class. Defaults to L<Catalyst::Response>.
2733 =head2 $app->response_class_traits
2735 An arrayref of L<Moose::Role>s which are applied to the response class.
2737 =head2 $app->composed_response_class
2739 This is the request class which has been composed with any response_class_traits.
2741 =head2 $c->read( [$maxlength] )
2743 Reads a chunk of data from the request body. This method is designed to
2744 be used in a while loop, reading C<$maxlength> bytes on every call.
2745 C<$maxlength> defaults to the size of the request if not specified.
2747 You have to set C<< MyApp->config(parse_on_demand => 1) >> to use this
2750 Warning: If you use read(), Catalyst will not process the body,
2751 so you will not be able to access POST parameters or file uploads via
2752 $c->request. You must handle all body parsing yourself.
2756 sub read { my $c = shift; return $c->request->read( @_ ) }
2766 $app->_make_immutable_if_needed;
2767 $app->engine_loader->needs_psgi_engine_compat_hack ?
2768 $app->engine->run($app, @_) :
2769 $app->engine->run( $app, $app->_finalized_psgi_app, @_ );
2772 sub _make_immutable_if_needed {
2774 my $meta = find_meta($class);
2775 my $isa_ca = $class->isa('Class::Accessor::Fast') || $class->isa('Class::Accessor');
2778 && ! { $meta->immutable_options }->{replace_constructor}
2781 warn("You made your application class ($class) immutable, "
2782 . "but did not inline the\nconstructor. "
2783 . "This will break catalyst, as your app \@ISA "
2784 . "Class::Accessor(::Fast)?\nPlease pass "
2785 . "(replace_constructor => 1)\nwhen making your class immutable.\n");
2787 unless ($meta->is_immutable) {
2788 # XXX - FIXME warning here as you should make your app immutable yourself.
2789 $meta->make_immutable(
2790 replace_constructor => 1,
2795 =head2 $c->set_action( $action, $code, $namespace, $attrs )
2797 Sets an action in a given namespace.
2801 sub set_action { my $c = shift; $c->dispatcher->set_action( $c, @_ ) }
2803 =head2 $c->setup_actions($component)
2805 Sets up actions for a component.
2809 sub setup_actions { my $c = shift; $c->dispatcher->setup_actions( $c, @_ ) }
2811 =head2 $c->setup_components
2813 This method is called internally to set up the application's components.
2815 It finds modules by calling the L<locate_components> method, expands them to
2816 package names with the L<expand_component_module> method, and then installs
2817 each component into the application.
2819 The C<setup_components> config option is passed to both of the above methods.
2821 Installation of each component is performed by the L<setup_component> method,
2826 sub setup_components {
2829 my $config = $class->config->{ setup_components };
2831 my @comps = $class->locate_components($config);
2832 my %comps = map { $_ => 1 } @comps;
2834 my $deprecatedcatalyst_component_names = grep { /::[CMV]::/ } @comps;
2835 $class->log->warn(qq{Your application is using the deprecated ::[MVC]:: type naming scheme.\n}.
2836 qq{Please switch your class names to ::Model::, ::View:: and ::Controller: as appropriate.\n}
2837 ) if $deprecatedcatalyst_component_names;
2839 for my $component ( @comps ) {
2841 # We pass ignore_loaded here so that overlay files for (e.g.)
2842 # Model::DBI::Schema sub-classes are loaded - if it's in @comps
2843 # we know M::P::O found a file on disk so this is safe
2845 Catalyst::Utils::ensure_class_loaded( $component, { ignore_loaded => 1 } );
2848 for my $component (@comps) {
2849 my $instance = $class->components->{ $component } = $class->delayed_setup_component($component);
2852 # Inject a component or wrap a stand alone class in an adaptor. This makes a list
2853 # of named components in the configuration that are not actually existing (not a
2856 my @injected_components = keys %{$class->config->{inject_components} ||+{}};
2857 foreach my $injected_comp_name(@injected_components) {
2858 my $component_class = $class->config->{inject_components}->{$injected_comp_name}->{from_component} || '';
2859 if($component_class) {
2860 my @roles = @{$class->config->{inject_components}->{$injected_comp_name}->{roles} ||[]};
2861 my %args = %{ $class->config->{$injected_comp_name} || +{} };
2863 Catalyst::Utils::inject_component(
2865 component => $component_class,
2866 (scalar(@roles) ? (traits => \@roles) : ()),
2867 as => $injected_comp_name);
2871 # All components are registered, now we need to 'init' them.
2872 foreach my $component_name (keys %{$class->components||{}}) {
2873 $class->components->{$component_name} = $class->components->{$component_name}->() if
2874 (ref($class->components->{$component_name}) || '') eq 'CODE';
2878 =head2 $app->inject_component($MyApp_Component_name => \%args);
2880 Add a component that is injected at setup:
2882 MyApp->inject_component( 'Model::Foo' => { from_component => 'Common::Foo' } );
2884 Must be called before ->setup. Expects a component name for your
2885 current application and \%args where
2889 =item from_component
2891 The target component being injected into your application
2895 An arrayref of L<Moose::Role>s that are applied to your component.
2901 MyApp->inject_component(
2903 from_component => 'Common::Model::Foo',
2904 roles => ['Role1', 'Role2'],
2907 =head2 $app->inject_components
2909 Inject a list of components:
2911 MyApp->inject_components(
2912 'Model::FooOne' => {
2913 from_component => 'Common::Model::Foo',
2914 roles => ['Role1', 'Role2'],
2916 'Model::FooTwo' => {
2917 from_component => 'Common::Model::Foo',
2918 roles => ['Role1', 'Role2'],
2923 sub inject_component {
2924 my ($app, $name, $args) = @_;
2925 die "Component $name exists" if
2926 $app->config->{inject_components}->{$name};
2927 $app->config->{inject_components}->{$name} = $args;
2930 sub inject_components {
2933 $app->inject_component(shift, shift);
2937 =head2 $c->locate_components( $setup_component_config )
2939 This method is meant to provide a list of component modules that should be
2940 setup for the application. By default, it will use L<Module::Pluggable>.
2942 Specify a C<setup_components> config option to pass additional options directly
2943 to L<Module::Pluggable>. To add additional search paths, specify a key named
2944 C<search_extra> as an array reference. Items in the array beginning with C<::>
2945 will have the application class name prepended to them.
2949 sub locate_components {
2953 my @paths = qw( ::M ::Model ::V ::View ::C ::Controller );
2954 my $extra = delete $config->{ search_extra } || [];
2956 unshift @paths, @$extra;
2958 my @comps = map { sort { length($a) <=> length($b) } Module::Pluggable::Object->new(
2959 search_path => [ map { s/^(?=::)/$class/; $_; } ($_) ],
2961 )->plugins } @paths;
2966 =head2 $c->expand_component_module( $component, $setup_component_config )
2968 Components found by C<locate_components> will be passed to this method, which
2969 is expected to return a list of component (package) names to be set up.
2973 sub expand_component_module {
2974 my ($class, $module) = @_;
2975 return Devel::InnerPackage::list_packages( $module );
2978 =head2 $app->delayed_setup_component
2980 Returns a coderef that points to a setup_component instance. Used
2981 internally for when you want to delay setup until the first time
2982 the component is called.
2986 sub delayed_setup_component {
2987 my($class, $component, @more) = @_;
2989 return my $instance = $class->setup_component($component, @more);
2993 =head2 $c->setup_component
2997 sub setup_component {
2998 my( $class, $component ) = @_;
3000 unless ( $component->can( 'COMPONENT' ) ) {
3004 my $suffix = Catalyst::Utils::class2classsuffix( $component );
3005 my $config = $class->config->{ $suffix } || {};
3006 # Stash catalyst_component_name in the config here, so that custom COMPONENT
3007 # methods also pass it. local to avoid pointlessly shitting in config
3008 # for the debug screen, as $component is already the key name.
3009 local $config->{catalyst_component_name} = $component;
3011 my $instance = eval {
3012 $component->COMPONENT( $class, $config );
3016 Catalyst::Exception->throw(
3017 message => qq/Couldn't instantiate component "$component", "$error"/
3021 unless (blessed $instance) {
3022 my $metaclass = Moose::Util::find_meta($component);
3023 my $method_meta = $metaclass->find_method_by_name('COMPONENT');
3024 my $component_method_from = $method_meta->associated_metaclass->name;
3025 my $value = defined($instance) ? $instance : 'undef';
3026 Catalyst::Exception->throw(
3028 qq/Couldn't instantiate component "$component", COMPONENT() method (from $component_method_from) didn't return an object-like value (value was $value)./
3032 my @expanded_components = $instance->can('expand_modules')
3033 ? $instance->expand_modules( $component, $config )
3034 : $class->expand_component_module( $component, $config );
3035 for my $component (@expanded_components) {
3036 next if $class->components->{ $component };
3037 $class->components->{ $component } = $class->setup_component($component);
3043 =head2 $c->setup_dispatcher
3049 sub setup_dispatcher {
3050 my ( $class, $dispatcher ) = @_;
3053 $dispatcher = 'Catalyst::Dispatcher::' . $dispatcher;
3056 if ( my $env = Catalyst::Utils::env_value( $class, 'DISPATCHER' ) ) {
3057 $dispatcher = 'Catalyst::Dispatcher::' . $env;
3060 unless ($dispatcher) {
3061 $dispatcher = $class->dispatcher_class;
3064 load_class($dispatcher);
3066 # dispatcher instance
3067 $class->dispatcher( $dispatcher->new );
3070 =head2 $c->setup_engine
3077 my ($class, $requested_engine) = @_;
3079 if (!$class->engine_loader || $requested_engine) {
3080 $class->engine_loader(
3081 Catalyst::EngineLoader->new({
3082 application_name => $class,
3083 (defined $requested_engine
3084 ? (catalyst_engine_class => $requested_engine) : ()),
3089 $class->engine_loader->catalyst_engine_class;
3093 my ($class, $requested_engine) = @_;
3096 my $loader = $class->engine_loader;
3098 if (!$loader || $requested_engine) {
3099 $loader = Catalyst::EngineLoader->new({
3100 application_name => $class,
3101 (defined $requested_engine
3102 ? (requested_engine => $requested_engine) : ()),
3105 $class->engine_loader($loader);
3108 $loader->catalyst_engine_class;
3111 # Don't really setup_engine -- see _setup_psgi_app for explanation.
3112 return if $class->loading_psgi_file;
3114 load_class($engine);
3116 if ($ENV{MOD_PERL}) {
3117 my $apache = $class->engine_loader->auto;
3119 my $meta = find_meta($class);
3120 my $was_immutable = $meta->is_immutable;
3121 my %immutable_options = $meta->immutable_options;
3122 $meta->make_mutable if $was_immutable;
3124 $meta->add_method(handler => sub {
3126 my $psgi_app = $class->_finalized_psgi_app;
3127 $apache->call_app($r, $psgi_app);
3130 $meta->make_immutable(%immutable_options) if $was_immutable;
3133 $class->engine( $engine->new );
3138 ## This exists just to supply a prebuild psgi app for mod_perl and for the
3139 ## build in server support (back compat support for pre psgi port behavior).
3140 ## This is so that we don't build a new psgi app for each request when using
3141 ## the mod_perl handler or the built in servers (http and fcgi, etc).
3143 sub _finalized_psgi_app {
3146 unless ($app->_psgi_app) {
3147 my $psgi_app = $app->_setup_psgi_app;
3148 $app->_psgi_app($psgi_app);
3151 return $app->_psgi_app;
3154 ## Look for a psgi file like 'myapp_web.psgi' (if the app is MyApp::Web) in the
3155 ## home directory and load that and return it (just assume it is doing the
3156 ## right thing :) ). If that does not exist, call $app->psgi_app, wrap that
3157 ## in default_middleware and return it ( this is for backward compatibility
3158 ## with pre psgi port behavior ).
3160 sub _setup_psgi_app {
3163 for my $home (Path::Class::Dir->new($app->config->{home})) {
3164 my $psgi_file = $home->file(
3165 Catalyst::Utils::appprefix($app) . '.psgi',
3168 next unless -e $psgi_file;
3170 # If $psgi_file calls ->setup_engine, it's doing so to load
3171 # Catalyst::Engine::PSGI. But if it does that, we're only going to
3172 # throw away the loaded PSGI-app and load the 5.9 Catalyst::Engine
3173 # anyway. So set a flag (ick) that tells setup_engine not to populate
3174 # $c->engine or do any other things we might regret.
3176 $app->loading_psgi_file(1);
3177 my $psgi_app = Plack::Util::load_psgi($psgi_file);
3178 $app->loading_psgi_file(0);
3181 unless $app->engine_loader->needs_psgi_engine_compat_hack;
3184 Found a legacy Catalyst::Engine::PSGI .psgi file at ${psgi_file}.
3186 Its content has been ignored. Please consult the Catalyst::Upgrading
3187 documentation on how to upgrade from Catalyst::Engine::PSGI.
3191 return $app->apply_default_middlewares($app->psgi_app);
3194 =head2 $c->apply_default_middlewares
3196 Adds the following L<Plack> middlewares to your application, since they are
3197 useful and commonly needed:
3199 L<Plack::Middleware::LighttpdScriptNameFix> (if you are using Lighttpd),
3200 L<Plack::Middleware::IIS6ScriptNameFix> (always applied since this middleware
3201 is smart enough to conditionally apply itself).
3203 We will also automatically add L<Plack::Middleware::ReverseProxy> if we notice
3204 that your HTTP $env variable C<REMOTE_ADDR> is '127.0.0.1'. This is usually
3205 an indication that your server is running behind a proxy frontend. However in
3206 2014 this is often not the case. We preserve this code for backwards compatibility
3207 however I B<highly> recommend that if you are running the server behind a front
3208 end proxy that you clearly indicate so with the C<using_frontend_proxy> configuration
3209 setting to true for your environment configurations that run behind a proxy. This
3210 way if you change your front end proxy address someday your code would inexplicably
3211 stop working as expected.
3213 Additionally if we detect we are using Nginx, we add a bit of custom middleware
3214 to solve some problems with the way that server handles $ENV{PATH_INFO} and
3217 Please B<NOTE> that if you do use C<using_frontend_proxy> the middleware is now
3218 adding via C<registered_middleware> rather than this method.
3220 If you are using Lighttpd or IIS6 you may wish to apply these middlewares. In
3221 general this is no longer a common case but we have this here for backward
3227 sub apply_default_middlewares {
3228 my ($app, $psgi_app) = @_;
3230 # Don't add this conditional IF we are explicitly saying we want the
3231 # frontend proxy support. We don't need it here since if that is the
3232 # case it will be always loaded in the default_middleware.
3234 unless($app->config->{using_frontend_proxy}) {
3235 $psgi_app = Plack::Middleware::Conditional->wrap(
3237 builder => sub { Plack::Middleware::ReverseProxy->wrap($_[0]) },
3240 return if $app->config->{ignore_frontend_proxy};
3241 return $env->{REMOTE_ADDR} eq '127.0.0.1';
3246 # If we're running under Lighttpd, swap PATH_INFO and SCRIPT_NAME
3247 # http://lists.scsys.co.uk/pipermail/catalyst/2006-June/008361.html
3248 $psgi_app = Plack::Middleware::Conditional->wrap(
3250 builder => sub { Plack::Middleware::LighttpdScriptNameFix->wrap($_[0]) },
3253 return unless $env->{SERVER_SOFTWARE} && $env->{SERVER_SOFTWARE} =~ m!lighttpd[-/]1\.(\d+\.\d+)!;
3254 return unless $1 < 4.23;
3259 # we're applying this unconditionally as the middleware itself already makes
3260 # sure it doesn't fuck things up if it's not running under one of the right
3262 $psgi_app = Plack::Middleware::IIS6ScriptNameFix->wrap($psgi_app);
3264 # And another IIS issue, this time with IIS7.
3265 $psgi_app = Plack::Middleware::Conditional->wrap(
3267 builder => sub { Plack::Middleware::IIS7KeepAliveFix->wrap($_[0]) },
3270 return $env->{SERVER_SOFTWARE} && $env->{SERVER_SOFTWARE} =~ m!IIS/7\.[0-9]!;
3277 =head2 App->psgi_app
3281 Returns a PSGI application code reference for the catalyst application
3282 C<$c>. This is the bare application created without the C<apply_default_middlewares>
3283 method called. We do however apply C<registered_middleware> since those are
3284 integral to how L<Catalyst> functions. Also, unlike starting your application
3285 with a generated server script (via L<Catalyst::Devel> and C<catalyst.pl>) we do
3286 not attempt to return a valid L<PSGI> application using any existing C<${myapp}.psgi>
3287 scripts in your $HOME directory.
3289 B<NOTE> C<apply_default_middlewares> was originally created when the first PSGI
3290 port was done for v5.90000. These are middlewares that are added to achieve
3291 backward compatibility with older applications. If you start your application
3292 using one of the supplied server scripts (generated with L<Catalyst::Devel> and
3293 the project skeleton script C<catalyst.pl>) we apply C<apply_default_middlewares>
3294 automatically. This was done so that pre and post PSGI port applications would
3297 This is what you want to be using to retrieve the PSGI application code
3298 reference of your Catalyst application for use in a custom F<.psgi> or in your
3299 own created server modules.
3303 *to_app = \&psgi_app;
3307 my $psgi = $app->engine->build_psgi_app($app);
3308 return $app->Catalyst::Utils::apply_registered_middleware($psgi);
3311 =head2 $c->setup_home
3313 Sets up the home directory.
3318 my ( $class, $home ) = @_;
3320 if ( my $env = Catalyst::Utils::env_value( $class, 'HOME' ) ) {
3324 $home ||= Catalyst::Utils::home($class);
3327 #I remember recently being scolded for assigning config values like this
3328 $class->config->{home} ||= $home;
3329 $class->config->{root} ||= Path::Class::Dir->new($home)->subdir('root');
3333 =head2 $c->setup_encoding
3335 Sets up the input/output encoding. See L<ENCODING>
3339 sub setup_encoding {
3341 if( exists($c->config->{encoding}) && !defined($c->config->{encoding}) ) {
3342 # Ok, so the user has explicitly said "I don't want encoding..."
3345 my $enc = defined($c->config->{encoding}) ?
3346 delete $c->config->{encoding} : 'UTF-8'; # not sure why we delete it... (JNAP)
3351 =head2 handle_unicode_encoding_exception
3353 Hook to let you customize how encoding errors are handled. By default
3354 we just throw an exception. Receives a hashref of debug information.
3357 $c->handle_unicode_encoding_exception({
3358 param_value => $value,
3360 encoding_step => 'params',
3365 sub handle_unicode_encoding_exception {
3366 my ( $self, $exception_ctx ) = @_;
3367 die $exception_ctx->{error_msg};
3370 # Some unicode helpers cargo culted from the old plugin. These could likely
3373 sub _handle_unicode_decoding {
3374 my ( $self, $value ) = @_;
3376 return unless defined $value;
3378 ## I think this mess is to support the old nested
3379 if ( ref $value eq 'ARRAY' ) {
3380 foreach ( @$value ) {
3381 $_ = $self->_handle_unicode_decoding($_);
3385 elsif ( ref $value eq 'HASH' ) {
3386 foreach (keys %$value) {
3387 my $encoded_key = $self->_handle_param_unicode_decoding($_);
3388 $value->{$encoded_key} = $self->_handle_unicode_decoding($value->{$_});
3390 # If the key was encoded we now have two (the original and current so
3391 # delete the original.
3392 delete $value->{$_} if $_ ne $encoded_key;
3397 return $self->_handle_param_unicode_decoding($value);
3401 sub _handle_param_unicode_decoding {
3402 my ( $self, $value ) = @_;
3403 return unless defined $value; # not in love with just ignoring undefs - jnap
3404 return $value if blessed($value); #don't decode when the value is an object.
3406 my $enc = $self->encoding;
3408 $enc->decode( $value, $self->_encode_check );
3411 $self->handle_unicode_encoding_exception({
3412 param_value => $value,
3414 encoding_step => 'params',
3419 =head2 $c->setup_log
3421 Sets up log by instantiating a L<Catalyst::Log|Catalyst::Log> object and
3422 passing it to C<log()>. Pass in a comma-delimited list of levels to set the
3425 This method also installs a C<debug> method that returns a true value into the
3426 catalyst subclass if the "debug" level is passed in the comma-delimited list,
3427 or if the C<$CATALYST_DEBUG> environment variable is set to a true value.
3429 Note that if the log has already been setup, by either a previous call to
3430 C<setup_log> or by a call such as C<< __PACKAGE__->log( MyLogger->new ) >>,
3431 that this method won't actually set up the log object.
3436 my ( $class, $levels ) = @_;
3439 $levels =~ s/^\s+//;
3440 $levels =~ s/\s+$//;
3441 my %levels = map { $_ => 1 } split /\s*,\s*/, $levels;
3443 my $env_debug = Catalyst::Utils::env_value( $class, 'DEBUG' );
3444 if ( defined $env_debug ) {
3445 $levels{debug} = 1 if $env_debug; # Ugly!
3446 delete($levels{debug}) unless $env_debug;
3449 unless ( $class->log ) {
3450 $class->log( Catalyst::Log->new(keys %levels) );
3453 if ( $levels{debug} ) {
3454 Class::MOP::get_metaclass_by_name($class)->add_method('debug' => sub { 1 });
3455 $class->log->debug('Debug messages enabled');
3459 =head2 $c->setup_plugins
3465 =head2 $c->setup_stats
3467 Sets up timing statistics class.
3472 my ( $class, $stats ) = @_;
3474 Catalyst::Utils::ensure_class_loaded($class->stats_class);
3476 my $env = Catalyst::Utils::env_value( $class, 'STATS' );
3477 if ( defined($env) ? $env : ($stats || $class->debug ) ) {
3478 Class::MOP::get_metaclass_by_name($class)->add_method('use_stats' => sub { 1 });
3479 $class->log->debug('Statistics enabled');
3484 =head2 $c->registered_plugins
3486 Returns a sorted list of the plugins which have either been stated in the
3489 If passed a given plugin name, it will report a boolean value indicating
3490 whether or not that plugin is loaded. A fully qualified name is required if
3491 the plugin name does not begin with C<Catalyst::Plugin::>.
3493 if ($c->registered_plugins('Some::Plugin')) {
3501 sub registered_plugins {
3503 return sort keys %{ $proto->_plugins } unless @_;
3505 return 1 if exists $proto->_plugins->{$plugin};
3506 return exists $proto->_plugins->{"Catalyst::Plugin::$plugin"};
3509 sub _register_plugin {
3510 my ( $proto, $plugin, $instant ) = @_;
3511 my $class = ref $proto || $proto;
3513 load_class( $plugin );
3514 $class->log->warn( "$plugin inherits from 'Catalyst::Component' - this is deprecated and will not work in 5.81" )
3515 if $plugin->isa( 'Catalyst::Component' );
3516 my $plugin_meta = Moose::Meta::Class->create($plugin);
3517 if (!$plugin_meta->has_method('new')
3518 && ( $plugin->isa('Class::Accessor::Fast') || $plugin->isa('Class::Accessor') ) ) {
3519 $plugin_meta->add_method('new', Moose::Object->meta->get_method('new'))
3521 if (!$instant && !$proto->_plugins->{$plugin}) {
3522 my $meta = Class::MOP::get_metaclass_by_name($class);
3523 $meta->superclasses($plugin, $meta->superclasses);
3525 $proto->_plugins->{$plugin} = 1;
3529 sub _default_plugins { return qw() }
3532 my ( $class, $plugins ) = @_;
3534 $class->_plugins( {} ) unless $class->_plugins;
3536 m/Unicode::Encoding/ ? do {
3538 'Unicode::Encoding plugin is auto-applied,'
3539 . ' please remove this from your appclass'
3540 . ' and make sure to define "encoding" config'
3542 unless (exists $class->config->{'encoding'}) {
3543 $class->config->{'encoding'} = 'UTF-8';
3548 push @$plugins, $class->_default_plugins;
3549 $plugins = Data::OptList::mkopt($plugins || []);
3552 [ Catalyst::Utils::resolve_namespace(
3553 $class . '::Plugin',
3554 'Catalyst::Plugin', $_->[0]
3560 for my $plugin ( reverse @plugins ) {
3561 load_class($plugin->[0], $plugin->[1]);
3562 my $meta = find_meta($plugin->[0]);
3563 next if $meta && $meta->isa('Moose::Meta::Role');
3565 $class->_register_plugin($plugin->[0]);
3569 map { $_->[0]->name, $_->[1] }
3570 grep { blessed($_->[0]) && $_->[0]->isa('Moose::Meta::Role') }
3571 map { [find_meta($_->[0]), $_->[1]] }
3574 Moose::Util::apply_all_roles(
3580 =head2 default_middleware
3582 Returns a list of instantiated PSGI middleware objects which is the default
3583 middleware that is active for this application (taking any configuration
3584 options into account, excluding your custom added middleware via the C<psgi_middleware>
3585 configuration option). You can override this method if you wish to change
3586 the default middleware (although do so at risk since some middleware is vital
3587 to application function.)
3589 The current default middleware list is:
3591 Catalyst::Middleware::Stash
3592 Plack::Middleware::HTTPExceptions
3593 Plack::Middleware::RemoveRedundantBody
3594 Plack::Middleware::FixMissingBodyInRedirect
3595 Plack::Middleware::ContentLength
3596 Plack::Middleware::MethodOverride
3597 Plack::Middleware::Head
3599 If the configuration setting C<using_frontend_proxy> is true we add:
3601 Plack::Middleware::ReverseProxy
3603 If the configuration setting C<using_frontend_proxy_path> is true we add:
3605 Plack::Middleware::ReverseProxyPath
3607 But B<NOTE> that L<Plack::Middleware::ReverseProxyPath> is not a dependency of the
3608 L<Catalyst> distribution so if you want to use this option you should add it to
3609 your project distribution file.
3611 These middlewares will be added at L</setup_middleware> during the
3612 L</setup> phase of application startup.
3616 sub default_middleware {
3619 Catalyst::Middleware::Stash->new,
3620 Plack::Middleware::HTTPExceptions->new,
3621 Plack::Middleware::RemoveRedundantBody->new,
3622 Plack::Middleware::FixMissingBodyInRedirect->new,
3623 Plack::Middleware::ContentLength->new,
3624 Plack::Middleware::MethodOverride->new,
3625 Plack::Middleware::Head->new);
3627 if($class->config->{using_frontend_proxy}) {
3628 push @mw, Plack::Middleware::ReverseProxy->new;
3631 if($class->config->{using_frontend_proxy_path}) {
3632 if(Class::Load::try_load_class('Plack::Middleware::ReverseProxyPath')) {
3633 push @mw, Plack::Middleware::ReverseProxyPath->new;
3635 $class->log->error("Cannot use configuration 'using_frontend_proxy_path' because 'Plack::Middleware::ReverseProxyPath' is not installed");
3642 =head2 registered_middlewares
3644 Read only accessor that returns an array of all the middleware in the order
3645 that they were added (which is the REVERSE of the order they will be applied).
3647 The values returned will be either instances of L<Plack::Middleware> or of a
3648 compatible interface, or a coderef, which is assumed to be inlined middleware
3650 =head2 setup_middleware (?@middleware)
3652 Read configuration information stored in configuration key C<psgi_middleware> or
3655 See under L</CONFIGURATION> information regarding C<psgi_middleware> and how
3656 to use it to enable L<Plack::Middleware>
3658 This method is automatically called during 'setup' of your application, so
3659 you really don't need to invoke it. However you may do so if you find the idea
3660 of loading middleware via configuration weird :). For example:
3666 __PACKAGE__->setup_middleware('Head');
3669 When we read middleware definitions from configuration, we reverse the list
3670 which sounds odd but is likely how you expect it to work if you have prior
3671 experience with L<Plack::Builder> or if you previously used the plugin
3672 L<Catalyst::Plugin::EnableMiddleware> (which is now considered deprecated)
3674 So basically your middleware handles an incoming request from the first
3675 registered middleware, down and handles the response from the last middleware
3680 sub registered_middlewares {
3682 if(my $middleware = $class->_psgi_middleware) {
3683 my @mw = ($class->default_middleware, @$middleware);
3685 if($class->config->{using_frontend_proxy}) {
3686 push @mw, Plack::Middleware::ReverseProxy->new;
3691 die "You cannot call ->registered_middlewares until middleware has been setup";
3695 sub setup_middleware {
3697 my @middleware_definitions;
3699 # If someone calls this method you can add middleware with args. However if its
3700 # called without an arg we need to setup the configuration middleware.
3702 @middleware_definitions = reverse(@_);
3704 @middleware_definitions = reverse(@{$class->config->{'psgi_middleware'}||[]})
3705 unless $class->finalized_default_middleware;
3706 $class->finalized_default_middleware(1); # Only do this once, just in case some people call setup over and over...
3709 my @middleware = ();
3710 while(my $next = shift(@middleware_definitions)) {
3712 if(Scalar::Util::blessed $next && $next->can('wrap')) {
3713 push @middleware, $next;
3714 } elsif(ref $next eq 'CODE') {
3715 push @middleware, $next;
3716 } elsif(ref $next eq 'HASH') {
3717 my $namespace = shift @middleware_definitions;
3718 my $mw = $class->Catalyst::Utils::build_middleware($namespace, %$next);
3719 push @middleware, $mw;
3721 die "I can't handle middleware definition ${\ref $next}";
3724 my $mw = $class->Catalyst::Utils::build_middleware($next);
3725 push @middleware, $mw;
3729 my @existing = @{$class->_psgi_middleware || []};
3730 $class->_psgi_middleware([@middleware,@existing,]);
3733 =head2 registered_data_handlers
3735 A read only copy of registered Data Handlers returned as a Hash, where each key
3736 is a content type and each value is a subref that attempts to decode that content
3739 =head2 setup_data_handlers (?@data_handler)
3741 Read configuration information stored in configuration key C<data_handlers> or
3744 See under L</CONFIGURATION> information regarding C<data_handlers>.
3746 This method is automatically called during 'setup' of your application, so
3747 you really don't need to invoke it.
3749 =head2 default_data_handlers
3751 Default Data Handlers that come bundled with L<Catalyst>. Currently there are
3752 only two default data handlers, for 'application/json' and an alternative to
3753 'application/x-www-form-urlencoded' which supposed nested form parameters via
3754 L<CGI::Struct> or via L<CGI::Struct::XS> IF you've installed it.
3756 The 'application/json' data handler is used to parse incoming JSON into a Perl
3757 data structure. It used either L<JSON::MaybeXS> or L<JSON>, depending on which
3758 is installed. This allows you to fail back to L<JSON:PP>, which is a Pure Perl
3759 JSON decoder, and has the smallest dependency impact.
3761 Because we don't wish to add more dependencies to L<Catalyst>, if you wish to
3762 use this new feature we recommend installing L<JSON> or L<JSON::MaybeXS> in
3763 order to get the best performance. You should add either to your dependency
3764 list (Makefile.PL, dist.ini, cpanfile, etc.)
3768 sub registered_data_handlers {
3770 if(my $data_handlers = $class->_data_handlers) {
3771 return %$data_handlers;
3773 $class->setup_data_handlers;
3774 return $class->registered_data_handlers;
3778 sub setup_data_handlers {
3779 my ($class, %data_handler_callbacks) = @_;
3780 %data_handler_callbacks = (
3781 %{$class->default_data_handlers},
3782 %{$class->config->{'data_handlers'}||+{}},
3783 %data_handler_callbacks);
3785 $class->_data_handlers(\%data_handler_callbacks);
3788 sub default_data_handlers {
3791 'application/x-www-form-urlencoded' => sub {
3792 my ($fh, $req) = @_;
3793 my $params = $req->_use_hash_multivalue ? $req->body_parameters->mixed : $req->body_parameters;
3794 Class::Load::load_first_existing_class('CGI::Struct::XS', 'CGI::Struct')
3795 ->can('build_cgi_struct')->($params);
3797 'application/json' => sub {
3798 my ($fh, $req) = @_;
3799 my $parser = Class::Load::load_first_existing_class('JSON::MaybeXS', 'JSON');
3803 $slurped = $fh->getline;
3804 $parser->can("decode_json")->($slurped); # decode_json does utf8 decoding for us
3805 } || Catalyst::Exception->throw(sprintf "Error Parsing POST '%s', Error: %s", (defined($slurped) ? $slurped : 'undef') ,$@);
3810 sub _handle_http_exception {
3811 my ( $self, $error ) = @_;
3813 !$self->config->{always_catch_http_exceptions}
3816 $error->can('as_psgi')
3817 || ( $error->can('code')
3818 && $error->code =~ m/^[1-5][0-9][0-9]$/ )
3828 Returns an arrayref of the internal execution stack (actions that are
3829 currently executing).
3833 Returns the current timing statistics object. By default Catalyst uses
3834 L<Catalyst::Stats|Catalyst::Stats>, but can be set otherwise with
3835 L<< stats_class|/"$c->stats_class" >>.
3837 Even if L<< -Stats|/"-Stats" >> is not enabled, the stats object is still
3838 available. By enabling it with C< $c->stats->enabled(1) >, it can be used to
3839 profile explicitly, although MyApp.pm still won't profile nor output anything
3842 =head2 $c->stats_class
3844 Returns or sets the stats (timing statistics) class. L<Catalyst::Stats|Catalyst::Stats> is used by default.
3846 =head2 $app->stats_class_traits
3848 A arrayref of L<Moose::Role>s that are applied to the stats_class before creating it.
3850 =head2 $app->composed_stats_class
3852 this is the stats_class composed with any 'stats_class_traits'.
3854 =head2 $c->use_stats
3856 Returns 1 when L<< stats collection|/"-Stats" >> is enabled.
3858 Note that this is a static method, not an accessor and should be overridden
3859 by declaring C<sub use_stats { 1 }> in your MyApp.pm, not by calling C<< $c->use_stats(1) >>.
3866 =head2 $c->write( $data )
3868 Writes $data to the output stream. When using this method directly, you
3869 will need to manually set the C<Content-Length> header to the length of
3870 your output data, if known.
3877 # Finalize headers if someone manually writes output (for compat)
3878 $c->finalize_headers;
3880 return $c->response->write( @_ );
3885 Returns the Catalyst version number. Mostly useful for "powered by"
3886 messages in template systems.
3890 sub version { return $Catalyst::VERSION }
3892 =head1 CONFIGURATION
3894 There are a number of 'base' config variables which can be set:
3900 C<always_catch_http_exceptions> - As of version 5.90060 Catalyst
3901 rethrows errors conforming to the interface described by
3902 L<Plack::Middleware::HTTPExceptions> and lets the middleware deal with it.
3903 Set true to get the deprecated behaviour and have Catalyst catch HTTP exceptions.
3907 C<default_model> - The default model picked if you say C<< $c->model >>. See L<< /$c->model($name) >>.
3911 C<default_view> - The default view to be rendered or returned when C<< $c->view >> is called. See L<< /$c->view($name) >>.
3915 C<disable_component_resolution_regex_fallback> - Turns
3916 off the deprecated component resolution functionality so
3917 that if any of the component methods (e.g. C<< $c->controller('Foo') >>)
3918 are called then regex search will not be attempted on string values and
3919 instead C<undef> will be returned.
3923 C<home> - The application home directory. In an uninstalled application,
3924 this is the top level application directory. In an installed application,
3925 this will be the directory containing C<< MyApp.pm >>.
3929 C<ignore_frontend_proxy> - See L</PROXY SUPPORT>
3933 C<name> - The name of the application in debug messages and the debug and
3938 C<parse_on_demand> - The request body (for example file uploads) will not be parsed
3939 until it is accessed. This allows you to (for example) check authentication (and reject
3940 the upload) before actually receiving all the data. See L</ON-DEMAND PARSER>
3944 C<root> - The root directory for templates. Usually this is just a
3945 subdirectory of the home directory, but you can set it to change the
3946 templates to a different directory.
3950 C<search_extra> - Array reference passed to Module::Pluggable to for additional
3951 namespaces from which components will be loaded (and constructed and stored in
3952 C<< $c->components >>).
3956 C<show_internal_actions> - If true, causes internal actions such as C<< _DISPATCH >>
3957 to be shown in hit debug tables in the test server.
3961 C<use_request_uri_for_path> - Controls if the C<REQUEST_URI> or C<PATH_INFO> environment
3962 variable should be used for determining the request path.
3964 Most web server environments pass the requested path to the application using environment variables,
3965 from which Catalyst has to reconstruct the request base (i.e. the top level path to / in the application,
3966 exposed as C<< $c->request->base >>) and the request path below that base.
3968 There are two methods of doing this, both of which have advantages and disadvantages. Which method is used
3969 is determined by the C<< $c->config(use_request_uri_for_path) >> setting (which can either be true or false).
3973 =item use_request_uri_for_path => 0
3975 This is the default (and the) traditional method that Catalyst has used for determining the path information.
3976 The path is generated from a combination of the C<PATH_INFO> and C<SCRIPT_NAME> environment variables.
3977 The allows the application to behave correctly when C<mod_rewrite> is being used to redirect requests
3978 into the application, as these variables are adjusted by mod_rewrite to take account for the redirect.
3980 However this method has the major disadvantage that it is impossible to correctly decode some elements
3981 of the path, as RFC 3875 says: "C<< Unlike a URI path, the PATH_INFO is not URL-encoded, and cannot
3982 contain path-segment parameters. >>" This means PATH_INFO is B<always> decoded, and therefore Catalyst
3983 can't distinguish / vs %2F in paths (in addition to other encoded values).
3985 =item use_request_uri_for_path => 1
3987 This method uses the C<REQUEST_URI> and C<SCRIPT_NAME> environment variables. As C<REQUEST_URI> is never
3988 decoded, this means that applications using this mode can correctly handle URIs including the %2F character
3989 (i.e. with C<AllowEncodedSlashes> set to C<On> in Apache).
3991 Given that this method of path resolution is provably more correct, it is recommended that you use
3992 this unless you have a specific need to deploy your application in a non-standard environment, and you are
3993 aware of the implications of not being able to handle encoded URI paths correctly.
3995 However it also means that in a number of cases when the app isn't installed directly at a path, but instead
3996 is having paths rewritten into it (e.g. as a .cgi/fcgi in a public_html directory, with mod_rewrite in a
3997 .htaccess file, or when SSI is used to rewrite pages into the app, or when sub-paths of the app are exposed
3998 at other URIs than that which the app is 'normally' based at with C<mod_rewrite>), the resolution of
3999 C<< $c->request->base >> will be incorrect.
4005 C<using_frontend_proxy> - See L</PROXY SUPPORT>.
4009 C<using_frontend_proxy_path> - Enabled L<Plack::Middleware::ReverseProxyPath> on your application (if
4010 installed, otherwise log an error). This is useful if your application is not running on the
4011 'root' (or /) of your host server. B<NOTE> if you use this feature you should add the required
4012 middleware to your project dependency list since its not automatically a dependency of L<Catalyst>.
4013 This has been done since not all people need this feature and we wish to restrict the growth of
4014 L<Catalyst> dependencies.
4018 C<encoding> - See L</ENCODING>
4020 This now defaults to 'UTF-8'. You my turn it off by setting this configuration
4025 C<abort_chain_on_error_fix>
4027 When there is an error in an action chain, the default behavior is to continue
4028 processing the remaining actions and then catch the error upon chain end. This
4029 can lead to running actions when the application is in an unexpected state. If
4030 you have this issue, setting this config value to true will promptly exit a
4031 chain when there is an error raised in any action (thus terminating the chain
4036 __PACKAGE__->config(abort_chain_on_error_fix => 1);
4038 In the future this might become the default behavior.
4042 C<use_hash_multivalue_in_request>
4044 In L<Catalyst::Request> the methods C<query_parameters>, C<body_parametes>
4045 and C<parameters> return a hashref where values might be scalar or an arrayref
4046 depending on the incoming data. In many cases this can be undesirable as it
4047 leads one to writing defensive code like the following:
4049 my ($val) = ref($c->req->parameters->{a}) ?
4050 @{$c->req->parameters->{a}} :
4051 $c->req->parameters->{a};
4053 Setting this configuration item to true will make L<Catalyst> populate the
4054 attributes underlying these methods with an instance of L<Hash::MultiValue>
4055 which is used by L<Plack::Request> and others to solve this very issue. You
4056 may prefer this behavior to the default, if so enable this option (be warned
4057 if you enable it in a legacy application we are not sure if it is completely
4058 backwardly compatible).
4062 C<skip_complex_post_part_handling>
4064 When creating body parameters from a POST, if we run into a multpart POST
4065 that does not contain uploads, but instead contains inlined complex data
4066 (very uncommon) we cannot reliably convert that into field => value pairs. So
4067 instead we create an instance of L<Catalyst::Request::PartData>. If this causes
4068 issue for you, you can disable this by setting C<skip_complex_post_part_handling>
4069 to true (default is false).
4073 C<skip_body_param_unicode_decoding>
4075 Generally we decode incoming POST params based on your declared encoding (the
4076 default for this is to decode UTF-8). If this is causing you trouble and you
4077 do not wish to turn all encoding support off (with the C<encoding> configuration
4078 parameter) you may disable this step atomically by setting this configuration
4083 C<do_not_decode_query>
4085 If true, then do not try to character decode any wide characters in your
4086 request URL query or keywords. Most readings of the relevent specifications
4087 suggest these should be UTF-* encoded, which is the default that L<Catalyst>
4088 will use, hwoever if you are creating a lot of URLs manually or have external
4089 evil clients, this might cause you trouble. If you find the changes introduced
4090 in Catalyst version 5.90080+ break some of your query code, you may disable
4091 the UTF-8 decoding globally using this configuration.
4093 This setting takes precedence over C<default_query_encoding> and
4094 C<decode_query_using_global_encoding>
4098 C<default_query_encoding>
4100 By default we decode query and keywords in your request URL using UTF-8, which
4101 is our reading of the relevent specifications. This setting allows one to
4102 specify a fixed value for how to decode your query. You might need this if
4103 you are doing a lot of custom encoding of your URLs and not using UTF-8.
4105 This setting take precedence over C<decode_query_using_global_encoding>.
4109 C<decode_query_using_global_encoding>
4111 Setting this to true will default your query decoding to whatever your
4112 general global encoding is (the default is UTF-8).
4116 C<use_chained_args_0_special_case>
4118 In older versions of Catalyst, when more than one action matched the same path
4119 AND all those matching actions declared Args(0), we'd break the tie by choosing
4120 the first action defined. We now normalized how Args(0) works so that it
4121 follows the same rule as Args(N), which is to say when we need to break a tie
4122 we choose the LAST action defined. If this breaks your code and you don't
4123 have time to update to follow the new normalized approach, you may set this
4124 value to true and it will globally revert to the original chaining behavior.
4128 C<psgi_middleware> - See L<PSGI MIDDLEWARE>.
4132 C<data_handlers> - See L<DATA HANDLERS>.
4136 C<stats_class_traits>
4138 An arrayref of L<Moose::Role>s that get componsed into your stats class.
4142 C<request_class_traits>
4144 An arrayref of L<Moose::Role>s that get componsed into your request class.
4148 C<response_class_traits>
4150 An arrayref of L<Moose::Role>s that get componsed into your response class.
4154 C<inject_components>
4156 A Hashref of L<Catalyst::Component> subclasses that are 'injected' into configuration.
4160 inject_components => {
4161 'Controller::Err' => { from_component => 'Local::Controller::Errors' },
4162 'Model::Zoo' => { from_component => 'Local::Model::Foo' },
4163 'Model::Foo' => { from_component => 'Local::Model::Foo', roles => ['TestRole'] },
4165 'Controller::Err' => { a => 100, b=>200, namespace=>'error' },
4166 'Model::Zoo' => { a => 2 },
4167 'Model::Foo' => { a => 100 },
4170 Generally L<Catalyst> looks for components in your Model/View or Controller directories.
4171 However for cases when you which to use an existing component and you don't need any
4172 customization (where for when you can apply a role to customize it) you may inject those
4173 components into your application. Please note any configuration should be done 'in the
4174 normal way', with a key under configuration named after the component affix, as in the
4177 Using this type of injection allows you to construct significant amounts of your application
4178 with only configuration!. This may or may not lead to increased code understanding.
4180 Please not you may also call the ->inject_components application method as well, although
4181 you must do so BEFORE setup.
4187 Generally when you throw an exception inside an Action (or somewhere in
4188 your stack, such as in a model that an Action is calling) that exception
4189 is caught by Catalyst and unless you either catch it yourself (via eval
4190 or something like L<Try::Tiny> or by reviewing the L</error> stack, it
4191 will eventually reach L</finalize_errors> and return either the debugging
4192 error stack page, or the default error page. However, if your exception
4193 can be caught by L<Plack::Middleware::HTTPExceptions>, L<Catalyst> will
4194 instead rethrow it so that it can be handled by that middleware (which
4195 is part of the default middleware). For example this would allow
4197 use HTTP::Throwable::Factory 'http_throw';
4199 sub throws_exception :Local {
4200 my ($self, $c) = @_;
4202 http_throw(SeeOther => { location =>
4203 $c->uri_for($self->action_for('redirect')) });
4207 =head1 INTERNAL ACTIONS
4209 Catalyst uses internal actions like C<_DISPATCH>, C<_BEGIN>, C<_AUTO>,
4210 C<_ACTION>, and C<_END>. These are by default not shown in the private
4211 action table, but you can make them visible with a config parameter.
4213 MyApp->config(show_internal_actions => 1);
4215 =head1 ON-DEMAND PARSER
4217 The request body is usually parsed at the beginning of a request,
4218 but if you want to handle input yourself, you can enable on-demand
4219 parsing with a config parameter.
4221 MyApp->config(parse_on_demand => 1);
4223 =head1 PROXY SUPPORT
4225 Many production servers operate using the common double-server approach,
4226 with a lightweight frontend web server passing requests to a larger
4227 backend server. An application running on the backend server must deal
4228 with two problems: the remote user always appears to be C<127.0.0.1> and
4229 the server's hostname will appear to be C<localhost> regardless of the
4230 virtual host that the user connected through.
4232 Catalyst will automatically detect this situation when you are running
4233 the frontend and backend servers on the same machine. The following
4234 changes are made to the request.
4236 $c->req->address is set to the user's real IP address, as read from
4237 the HTTP X-Forwarded-For header.
4239 The host value for $c->req->base and $c->req->uri is set to the real
4240 host, as read from the HTTP X-Forwarded-Host header.
4242 Additionally, you may be running your backend application on an insecure
4243 connection (port 80) while your frontend proxy is running under SSL. If there
4244 is a discrepancy in the ports, use the HTTP header C<X-Forwarded-Port> to
4245 tell Catalyst what port the frontend listens on. This will allow all URIs to
4246 be created properly.
4248 In the case of passing in:
4250 X-Forwarded-Port: 443
4252 All calls to C<uri_for> will result in an https link, as is expected.
4254 Obviously, your web server must support these headers for this to work.
4256 In a more complex server farm environment where you may have your
4257 frontend proxy server(s) on different machines, you will need to set a
4258 configuration option to tell Catalyst to read the proxied data from the
4261 MyApp->config(using_frontend_proxy => 1);
4263 If you do not wish to use the proxy support at all, you may set:
4265 MyApp->config(ignore_frontend_proxy => 0);
4267 =head2 Note about psgi files
4269 Note that if you supply your own .psgi file, calling
4270 C<< MyApp->psgi_app(@_); >>, then B<this will not happen automatically>.
4272 You either need to apply L<Plack::Middleware::ReverseProxy> yourself
4273 in your psgi, for example:
4276 enable "Plack::Middleware::ReverseProxy";
4280 This will unconditionally add the ReverseProxy support, or you need to call
4281 C<< $app = MyApp->apply_default_middlewares($app) >> (to conditionally
4282 apply the support depending upon your config).
4284 See L<Catalyst::PSGI> for more information.
4286 =head1 THREAD SAFETY
4288 Catalyst has been tested under Apache 2's threading C<mpm_worker>,
4289 C<mpm_winnt>, and the standalone forking HTTP server on Windows. We
4290 believe the Catalyst core to be thread-safe.
4292 If you plan to operate in a threaded environment, remember that all other
4293 modules you are using must also be thread-safe. Some modules, most notably
4294 L<DBD::SQLite>, are not thread-safe.
4296 =head1 DATA HANDLERS
4298 The L<Catalyst::Request> object uses L<HTTP::Body> to populate 'classic' HTML
4299 form parameters and URL search query fields. However it has become common
4300 for various alternative content types to be PUT or POSTed to your controllers
4301 and actions. People working on RESTful APIs, or using AJAX often use JSON,
4302 XML and other content types when communicating with an application server. In
4303 order to better support this use case, L<Catalyst> defines a global configuration
4304 option, C<data_handlers>, which lets you associate a content type with a coderef
4305 that parses that content type into something Perl can readily access.
4312 __PACKAGE__->config(
4314 'application/json' => sub { local $/; decode_json $_->getline },
4316 ## Any other configuration.
4321 By default L<Catalyst> comes with a generic JSON data handler similar to the
4322 example given above, which uses L<JSON::Maybe> to provide either L<JSON::PP>
4323 (a pure Perl, dependency free JSON parser) or L<Cpanel::JSON::XS> if you have
4324 it installed (if you want the faster XS parser, add it to you project Makefile.PL
4325 or dist.ini, cpanfile, etc.)
4327 The C<data_handlers> configuration is a hashref whose keys are HTTP Content-Types
4328 (matched against the incoming request type using a regexp such as to be case
4329 insensitive) and whose values are coderefs that receive a localized version of
4330 C<$_> which is a filehandle object pointing to received body.
4332 This feature is considered an early access release and we reserve the right
4333 to alter the interface in order to provide a performant and secure solution to
4334 alternative request body content. Your reports welcomed!
4336 =head1 PSGI MIDDLEWARE
4338 You can define middleware, defined as L<Plack::Middleware> or a compatible
4339 interface in configuration. Your middleware definitions are in the form of an
4340 arrayref under the configuration key C<psgi_middleware>. Here's an example
4341 with details to follow:
4346 use Plack::Middleware::StackTrace;
4348 my $stacktrace_middleware = Plack::Middleware::StackTrace->new;
4350 __PACKAGE__->config(
4351 'psgi_middleware', [
4354 $stacktrace_middleware,
4355 'Session' => {store => 'File'},
4360 $env->{myapp.customkey} = 'helloworld';
4369 So the general form is:
4371 __PACKAGE__->config(psgi_middleware => \@middleware_definitions);
4373 Where C<@middleware> is one or more of the following, applied in the REVERSE of
4374 the order listed (to make it function similarly to L<Plack::Builder>:
4376 Alternatively, you may also define middleware by calling the L</setup_middleware>
4383 __PACKAGE__->setup_middleware( \@middleware_definitions);
4386 In the case where you do both (use 'setup_middleware' and configuration) the
4387 package call to setup_middleware will be applied earlier (in other words its
4388 middleware will wrap closer to the application). Keep this in mind since in
4389 some cases the order of middleware is important.
4391 The two approaches are not exclusive.
4395 =item Middleware Object
4397 An already initialized object that conforms to the L<Plack::Middleware>
4400 my $stacktrace_middleware = Plack::Middleware::StackTrace->new;
4402 __PACKAGE__->config(
4403 'psgi_middleware', [
4404 $stacktrace_middleware,
4410 A coderef that is an inlined middleware:
4412 __PACKAGE__->config(
4413 'psgi_middleware', [
4418 if($env->{PATH_INFO} =~m/forced/) {
4420 ->new(file=>TestApp->path_to(qw/share static forced.txt/))
4423 return $app->($env);
4433 We assume the scalar refers to a namespace after normalizing it using the
4436 (1) If the scalar is prefixed with a "+" (as in C<+MyApp::Foo>) then the full string
4437 is assumed to be 'as is', and we just install and use the middleware.
4439 (2) If the scalar begins with "Plack::Middleware" or your application namespace
4440 (the package name of your Catalyst application subclass), we also assume then
4441 that it is a full namespace, and use it.
4443 (3) Lastly, we then assume that the scalar is a partial namespace, and attempt to
4444 resolve it first by looking for it under your application namespace (for example
4445 if you application is "MyApp::Web" and the scalar is "MyMiddleware", we'd look
4446 under "MyApp::Web::Middleware::MyMiddleware") and if we don't find it there, we
4447 will then look under the regular L<Plack::Middleware> namespace (i.e. for the
4448 previous we'd try "Plack::Middleware::MyMiddleware"). We look under your application
4449 namespace first to let you 'override' common L<Plack::Middleware> locally, should
4450 you find that a good idea.
4456 __PACKAGE__->config(
4457 'psgi_middleware', [
4458 'Debug', ## MyAppWeb::Middleware::Debug->wrap or Plack::Middleware::Debug->wrap
4459 'Plack::Middleware::Stacktrace', ## Plack::Middleware::Stacktrace->wrap
4460 '+MyApp::Custom', ## MyApp::Custom->wrap
4464 =item a scalar followed by a hashref
4466 Just like the previous, except the following C<HashRef> is used as arguments
4467 to initialize the middleware object.
4469 __PACKAGE__->config(
4470 'psgi_middleware', [
4471 'Session' => {store => 'File'},
4476 Please see L<PSGI> for more on middleware.
4480 Starting in L<Catalyst> version 5.90080 encoding is automatically enabled
4481 and set to encode all body responses to UTF8 when possible and applicable.
4482 Following is documentation on this process. If you are using an older
4483 version of L<Catalyst> you should review documentation for that version since
4486 By default encoding is now 'UTF-8'. You may turn it off by setting
4487 the encoding configuration to undef.
4489 MyApp->config(encoding => undef);
4491 This is recommended for temporary backwards compatibility only.
4493 Encoding is automatically applied when the content-type is set to
4494 a type that can be encoded. Currently we encode when the content type
4495 matches the following regular expression:
4497 $content_type =~ /^text|xml$|javascript$/
4499 Encoding is set on the application, but it is copied to the context object
4500 so that you can override it on a request basis.
4502 Be default we don't automatically encode 'application/json' since the most
4503 common approaches to generating this type of response (Either via L<Catalyst::View::JSON>
4504 or L<Catalyst::Action::REST>) will do so already and we want to avoid double
4507 If you are producing JSON response in an unconventional manner (such
4508 as via a template or manual strings) you should perform the UTF8 encoding
4509 manually as well such as to conform to the JSON specification.
4511 NOTE: We also examine the value of $c->response->content_encoding. If
4512 you set this (like for example 'gzip', and manually gzipping the body)
4513 we assume that you have done all the necessary encoding yourself, since
4514 we cannot encode the gzipped contents. If you use a plugin like
4515 L<Catalyst::Plugin::Compress> you need to update to a modern version in order
4516 to have this function correctly with the new UTF8 encoding code, or you
4517 can use L<Plack::Middleware::Deflater> or (probably best) do your compression on
4526 Returns an instance of an C<Encode> encoding
4528 print $c->encoding->name
4530 =item handle_unicode_encoding_exception ($exception_context)
4532 Method called when decoding process for a request fails.
4534 An C<$exception_context> hashref is provided to allow you to override the
4535 behaviour of your application when given data with incorrect encodings.
4537 The default method throws exceptions in the case of invalid request parameters
4538 (resulting in a 500 error), but ignores errors in upload filenames.
4540 The keys passed in the C<$exception_context> hash are:
4546 The value which was not able to be decoded.
4550 The exception received from L<Encode>.
4554 What type of data was being decoded. Valid values are (currently)
4555 C<params> - for request parameters / arguments / captures
4556 and C<uploads> - for request upload filenames.
4566 Join #catalyst on irc.perl.org.
4570 http://lists.scsys.co.uk/cgi-bin/mailman/listinfo/catalyst
4571 http://lists.scsys.co.uk/cgi-bin/mailman/listinfo/catalyst-dev
4575 http://catalyst.perl.org
4579 http://dev.catalyst.perl.org
4583 =head2 L<Task::Catalyst> - All you need to start with Catalyst
4585 =head2 L<Catalyst::Manual> - The Catalyst Manual
4587 =head2 L<Catalyst::Component>, L<Catalyst::Controller> - Base classes for components
4589 =head2 L<Catalyst::Engine> - Core engine
4591 =head2 L<Catalyst::Log> - Log class.
4593 =head2 L<Catalyst::Request> - Request object
4595 =head2 L<Catalyst::Response> - Response object
4597 =head2 L<Catalyst::Test> - The test suite.
4599 =head1 PROJECT FOUNDER
4601 sri: Sebastian Riedel <sri@cpan.org>
4607 acme: Leon Brocard <leon@astray.com>
4609 abraxxa: Alexander Hartmaier <abraxxa@cpan.org>
4611 andrewalker: André Walker <andre@cpan.org>
4615 Andrew Ford E<lt>A.Ford@ford-mason.co.ukE<gt>
4619 andyg: Andy Grundman <andy@hybridized.org>
4621 audreyt: Audrey Tang
4623 bricas: Brian Cassidy <bricas@cpan.org>
4625 Caelum: Rafael Kitover <rkitover@io.com>
4627 chansen: Christian Hansen
4629 chicks: Christopher Hicks
4631 Chisel Wright C<pause@herlpacker.co.uk>
4633 Danijel Milicevic C<me@danijel.de>
4635 davewood: David Schmidt <davewood@cpan.org>
4637 David Kamholz E<lt>dkamholz@cpan.orgE<gt>
4639 David Naughton, C<naughton@umn.edu>
4643 dhoss: Devin Austin <dhoss@cpan.org>
4645 dkubb: Dan Kubb <dan.kubb-cpan@onautopilot.com>
4649 dwc: Daniel Westermann-Clark <danieltwc@cpan.org>
4651 esskar: Sascha Kiefer
4653 fireartist: Carl Franks <cfranks@cpan.org>
4655 frew: Arthur Axel "fREW" Schmidt <frioux@gmail.com>
4657 gabb: Danijel Milicevic
4661 Gavin Henry C<ghenry@perl.me.uk>
4665 groditi: Guillermo Roditi <groditi@gmail.com>
4667 hobbs: Andrew Rodland <andrew@cleverdomain.org>
4669 ilmari: Dagfinn Ilmari Mannsåker <ilmari@ilmari.org>
4671 jcamacho: Juan Camacho
4673 jester: Jesse Sheidlower C<jester@panix.com>
4675 jhannah: Jay Hannah <jay@jays.net>
4681 jon: Jon Schutz <jjschutz@cpan.org>
4683 Jonathan Rockway C<< <jrockway@cpan.org> >>
4685 Kieren Diment C<kd@totaldatasolution.com>
4687 konobi: Scott McWhirter <konobi@cpan.org>
4689 marcus: Marcus Ramberg <mramberg@cpan.org>
4691 miyagawa: Tatsuhiko Miyagawa <miyagawa@bulknews.net>
4693 mgrimes: Mark Grimes <mgrimes@cpan.org>
4695 mst: Matt S. Trout <mst@shadowcatsystems.co.uk>
4699 naughton: David Naughton
4701 ningu: David Kamholz <dkamholz@cpan.org>
4703 nothingmuch: Yuval Kogman <nothingmuch@woobling.org>
4705 numa: Dan Sully <daniel@cpan.org>
4711 omega: Andreas Marienborg
4713 Oleg Kostyuk <cub.uanic@gmail.com>
4715 phaylon: Robert Sedlacek <phaylon@dunkelheit.at>
4717 rafl: Florian Ragwitz <rafl@debian.org>
4719 random: Roland Lammel <lammel@cpan.org>
4721 Robert Sedlacek C<< <rs@474.at> >>
4723 SpiceMan: Marcel Montes
4727 szbalint: Balint Szilakszi <szbalint@cpan.org>
4729 t0m: Tomas Doran <bobtfish@bobtfish.net>
4733 vanstyn: Henry Van Styn <vanstyn@cpan.org>
4735 Viljo Marrandi C<vilts@yahoo.com>
4737 Will Hawes C<info@whawes.co.uk>
4739 willert: Sebastian Willert <willert@cpan.org>
4741 wreis: Wallace Reis <wreis@cpan.org>
4743 Yuval Kogman, C<nothingmuch@woobling.org>
4745 rainboxx: Matthias Dietrich, C<perl@rainboxx.de>
4747 dd070: Dhaval Dhanani <dhaval070@gmail.com>
4749 Upasana <me@upasana.me>
4751 John Napiorkowski (jnap) <jjnapiork@cpan.org>
4755 Copyright (c) 2005-2015, the above named PROJECT FOUNDER and CONTRIBUTORS.
4759 This library is free software. You can redistribute it and/or modify it under
4760 the same terms as Perl itself.
4766 __PACKAGE__->meta->make_immutable;