4 use Moose::Meta::Class ();
5 extends 'Catalyst::Component';
6 use Moose::Util qw/find_meta/;
7 use namespace::clean -except => 'meta';
8 use Catalyst::Exception;
9 use Catalyst::Exception::Detach;
10 use Catalyst::Exception::Go;
12 use Catalyst::Request;
13 use Catalyst::Request::Upload;
14 use Catalyst::Response;
16 use Catalyst::Controller;
18 use Devel::InnerPackage ();
19 use Module::Pluggable::Object ();
20 use Text::SimpleTable ();
21 use Path::Class::Dir ();
22 use Path::Class::File ();
27 use Tree::Simple qw/use_weak_refs/;
28 use Tree::Simple::Visitor::FindByUID;
29 use Class::C3::Adopt::NEXT;
30 use List::MoreUtils qw/uniq/;
32 use String::RewritePrefix;
33 use Catalyst::EngineLoader;
35 use Carp qw/croak carp shortmess/;
38 use Moose::Util 'find_meta';
39 use Plack::Middleware::Conditional;
40 use Plack::Middleware::ReverseProxy;
41 use Plack::Middleware::IIS6ScriptNameFix;
42 use Plack::Middleware::IIS7KeepAliveFix;
43 use Plack::Middleware::LighttpdScriptNameFix;
44 use Plack::Middleware::ContentLength;
45 use Plack::Middleware::Head;
46 use Plack::Middleware::HTTPExceptions;
47 use Plack::Middleware::FixMissingBodyInRedirect;
48 use Plack::Middleware::MethodOverride;
49 use Plack::Middleware::RemoveRedundantBody;
50 use Catalyst::Middleware::Stash;
52 use Class::Load 'load_class';
53 use Encode 2.21 'decode_utf8', 'encode_utf8';
55 BEGIN { require 5.008003; }
57 has stack => (is => 'ro', default => sub { [] });
58 has state => (is => 'rw', default => 0);
59 has stats => (is => 'rw');
60 has action => (is => 'rw');
61 has counter => (is => 'rw', default => sub { {} });
66 my $class = ref $self;
67 my $composed_request_class = $class->composed_request_class;
68 return $composed_request_class->new( $self->_build_request_constructor_args);
72 sub _build_request_constructor_args {
74 my %p = ( _log => $self->log );
75 $p{_uploadtmp} = $self->_uploadtmp if $self->_has_uploadtmp;
76 $p{data_handlers} = {$self->registered_data_handlers};
77 $p{_use_hash_multivalue} = $self->config->{use_hash_multivalue_in_request}
78 if $self->config->{use_hash_multivalue_in_request};
82 sub composed_request_class {
84 my @traits = (@{$class->request_class_traits||[]}, @{$class->config->{request_class_traits}||[]});
85 return $class->_composed_request_class ||
86 $class->_composed_request_class(Moose::Util::with_traits($class->request_class, @traits));
93 my $class = ref $self;
94 my $composed_response_class = $class->composed_response_class;
95 return $composed_response_class->new( $self->_build_response_constructor_args);
99 sub _build_response_constructor_args {
102 encoding => $_[0]->encoding,
106 sub composed_response_class {
108 my @traits = (@{$class->response_class_traits||[]}, @{$class->config->{response_class_traits}||[]});
109 return $class->_composed_response_class ||
110 $class->_composed_response_class(Moose::Util::with_traits($class->response_class, @traits));
113 has namespace => (is => 'rw');
115 sub depth { scalar @{ shift->stack || [] }; }
116 sub comp { shift->component(@_) }
119 my $self = shift; return $self->request(@_);
122 my $self = shift; return $self->response(@_);
125 # For backwards compatibility
126 sub finalize_output { shift->finalize_body(@_) };
131 our $RECURSION = 1000;
132 our $DETACH = Catalyst::Exception::Detach->new;
133 our $GO = Catalyst::Exception::Go->new;
135 #I imagine that very few of these really need to be class variables. if any.
136 #maybe we should just make them attributes with a default?
137 __PACKAGE__->mk_classdata($_)
138 for qw/components arguments dispatcher engine log dispatcher_class
139 engine_loader context_class request_class response_class stats_class
140 setup_finished _psgi_app loading_psgi_file run_options _psgi_middleware
141 _data_handlers _encoding _encode_check finalized_default_middleware
142 request_class_traits response_class_traits stats_class_traits
143 _composed_request_class _composed_response_class _composed_stats_class/;
145 __PACKAGE__->dispatcher_class('Catalyst::Dispatcher');
146 __PACKAGE__->request_class('Catalyst::Request');
147 __PACKAGE__->response_class('Catalyst::Response');
148 __PACKAGE__->stats_class('Catalyst::Stats');
150 sub composed_stats_class {
152 my @traits = (@{$class->stats_class_traits||[]}, @{$class->config->{stats_class_traits}||[]});
153 return $class->_composed_stats_class ||
154 $class->_composed_stats_class(Moose::Util::with_traits($class->stats_class, @traits));
157 __PACKAGE__->_encode_check(Encode::FB_CROAK | Encode::LEAVE_SRC);
159 # Remember to update this in Catalyst::Runtime as well!
160 our $VERSION = '5.90089_003';
161 $VERSION = eval $VERSION if $VERSION =~ /_/; # numify for warning-free dev releases
164 my ( $class, @arguments ) = @_;
166 # We have to limit $class to Catalyst to avoid pushing Catalyst upon every
168 return unless $class eq 'Catalyst';
170 my $caller = caller();
171 return if $caller eq 'main';
173 my $meta = Moose::Meta::Class->initialize($caller);
174 unless ( $caller->isa('Catalyst') ) {
175 my @superclasses = ($meta->superclasses, $class, 'Catalyst::Controller');
176 $meta->superclasses(@superclasses);
178 # Avoid possible C3 issues if 'Moose::Object' is already on RHS of MyApp
179 $meta->superclasses(grep { $_ ne 'Moose::Object' } $meta->superclasses);
181 unless( $meta->has_method('meta') ){
182 if ($Moose::VERSION >= 1.15) {
183 $meta->_add_meta_method('meta');
186 $meta->add_method(meta => sub { Moose::Meta::Class->initialize("${caller}") } );
190 $caller->arguments( [@arguments] );
194 sub _application { $_[0] }
200 Catalyst - The Elegant MVC Web Application Framework
204 See the L<Catalyst::Manual> distribution for comprehensive
205 documentation and tutorials.
207 # Install Catalyst::Devel for helpers and other development tools
208 # use the helper to create a new application
211 # add models, views, controllers
212 script/myapp_create.pl model MyDatabase DBIC::Schema create=static dbi:SQLite:/path/to/db
213 script/myapp_create.pl view MyTemplate TT
214 script/myapp_create.pl controller Search
216 # built in testserver -- use -r to restart automatically on changes
217 # --help to see all available options
218 script/myapp_server.pl
220 # command line testing interface
221 script/myapp_test.pl /yada
224 use Catalyst qw/-Debug/; # include plugins here as well
226 ### In lib/MyApp/Controller/Root.pm (autocreated)
227 sub foo : Chained('/') Args() { # called for /foo, /foo/1, /foo/1/2, etc.
228 my ( $self, $c, @args ) = @_; # args are qw/1 2/ for /foo/1/2
229 $c->stash->{template} = 'foo.tt'; # set the template
230 # lookup something from db -- stash vars are passed to TT
232 $c->model('Database::Foo')->search( { country => $args[0] } );
233 if ( $c->req->params->{bar} ) { # access GET or POST parameters
234 $c->forward( 'bar' ); # process another action
235 # do something else after forward returns
239 # The foo.tt TT template can use the stash data from the database
240 [% WHILE (item = data.next) %]
244 # called for /bar/of/soap, /bar/of/soap/10, etc.
245 sub bar : Chained('/') PathPart('/bar/of/soap') Args() { ... }
247 # called after all actions are finished
249 my ( $self, $c ) = @_;
250 if ( scalar @{ $c->error } ) { ... } # handle errors
251 return if $c->res->body; # already have a response
252 $c->forward( 'MyApp::View::TT' ); # render template
255 See L<Catalyst::Manual::Intro> for additional information.
259 Catalyst is a modern framework for making web applications without the
260 pain usually associated with this process. This document is a reference
261 to the main Catalyst application. If you are a new user, we suggest you
262 start with L<Catalyst::Manual::Tutorial> or L<Catalyst::Manual::Intro>.
264 See L<Catalyst::Manual> for more documentation.
266 Catalyst plugins can be loaded by naming them as arguments to the "use
267 Catalyst" statement. Omit the C<Catalyst::Plugin::> prefix from the
268 plugin name, i.e., C<Catalyst::Plugin::My::Module> becomes
271 use Catalyst qw/My::Module/;
273 If your plugin starts with a name other than C<Catalyst::Plugin::>, you can
274 fully qualify the name by using a unary plus:
278 +Fully::Qualified::Plugin::Name
281 Special flags like C<-Debug> can also be specified as
282 arguments when Catalyst is loaded:
284 use Catalyst qw/-Debug My::Module/;
286 The position of plugins and flags in the chain is important, because
287 they are loaded in the order in which they appear.
289 The following flags are supported:
293 Enables debug output. You can also force this setting from the system
294 environment with CATALYST_DEBUG or <MYAPP>_DEBUG. The environment
295 settings override the application, with <MYAPP>_DEBUG having the highest
298 This sets the log level to 'debug' and enables full debug output on the
299 error screen. If you only want the latter, see L<< $c->debug >>.
303 Forces Catalyst to use a specific home directory, e.g.:
305 use Catalyst qw[-Home=/usr/mst];
307 This can also be done in the shell environment by setting either the
308 C<CATALYST_HOME> environment variable or C<MYAPP_HOME>; where C<MYAPP>
309 is replaced with the uppercased name of your application, any "::" in
310 the name will be replaced with underscores, e.g. MyApp::Web should use
311 MYAPP_WEB_HOME. If both variables are set, the MYAPP_HOME one will be used.
313 If none of these are set, Catalyst will attempt to automatically detect the
314 home directory. If you are working in a development environment, Catalyst
315 will try and find the directory containing either Makefile.PL, Build.PL,
316 dist.ini, or cpanfile. If the application has been installed into the system
317 (i.e. you have done C<make install>), then Catalyst will use the path to your
318 application module, without the .pm extension (e.g., /foo/MyApp if your
319 application was installed at /foo/MyApp.pm)
323 use Catalyst '-Log=warn,fatal,error';
325 Specifies a comma-delimited list of log levels.
329 Enables statistics collection and reporting.
331 use Catalyst qw/-Stats=1/;
333 You can also force this setting from the system environment with CATALYST_STATS
334 or <MYAPP>_STATS. The environment settings override the application, with
335 <MYAPP>_STATS having the highest priority.
337 Stats are also enabled if L<< debugging |/"-Debug" >> is enabled.
341 =head2 INFORMATION ABOUT THE CURRENT REQUEST
345 Returns a L<Catalyst::Action> object for the current action, which
346 stringifies to the action name. See L<Catalyst::Action>.
350 Returns the namespace of the current action, i.e., the URI prefix
351 corresponding to the controller of the current action. For example:
353 # in Controller::Foo::Bar
354 $c->namespace; # returns 'foo/bar';
360 Returns the current L<Catalyst::Request> object, giving access to
361 information about the current client request (including parameters,
362 cookies, HTTP headers, etc.). See L<Catalyst::Request>.
364 =head2 REQUEST FLOW HANDLING
366 =head2 $c->forward( $action [, \@arguments ] )
368 =head2 $c->forward( $class, $method, [, \@arguments ] )
370 This is one way of calling another action (method) in the same or
371 a different controller. You can also use C<< $self->my_method($c, @args) >>
372 in the same controller or C<< $c->controller('MyController')->my_method($c, @args) >>
373 in a different controller.
374 The main difference is that 'forward' uses some of the Catalyst request
375 cycle overhead, including debugging, which may be useful to you. On the
376 other hand, there are some complications to using 'forward', restrictions
377 on values returned from 'forward', and it may not handle errors as you prefer.
378 Whether you use 'forward' or not is up to you; it is not considered superior to
379 the other ways to call a method.
381 'forward' calls another action, by its private name. If you give a
382 class name but no method, C<process()> is called. You may also optionally
383 pass arguments in an arrayref. The action will receive the arguments in
384 C<@_> and C<< $c->req->args >>. Upon returning from the function,
385 C<< $c->req->args >> will be restored to the previous values.
387 Any data C<return>ed from the action forwarded to, will be returned by the
390 my $foodata = $c->forward('/foo');
391 $c->forward('index');
392 $c->forward(qw/Model::DBIC::Foo do_stuff/);
393 $c->forward('View::TT');
395 Note that L<< forward|/"$c->forward( $action [, \@arguments ] )" >> implies
396 an C<< eval { } >> around the call (actually
397 L<< execute|/"$c->execute( $class, $coderef )" >> does), thus rendering all
398 exceptions thrown by the called action non-fatal and pushing them onto
399 $c->error instead. If you want C<die> to propagate you need to do something
403 die join "\n", @{ $c->error } if @{ $c->error };
405 Or make sure to always return true values from your actions and write
408 $c->forward('foo') || return;
410 Another note is that C<< $c->forward >> always returns a scalar because it
411 actually returns $c->state which operates in a scalar context.
412 Thus, something like:
416 in an action that is forwarded to is going to return a scalar,
417 i.e. how many items are in that array, which is probably not what you want.
418 If you need to return an array then return a reference to it,
421 $c->stash->{array} = \@array;
423 and access it from the stash.
425 Keep in mind that the C<end> method used is that of the caller action. So a C<$c-E<gt>detach> inside a forwarded action would run the C<end> method from the original action requested.
429 sub forward { my $c = shift; no warnings 'recursion'; $c->dispatcher->forward( $c, @_ ) }
431 =head2 $c->detach( $action [, \@arguments ] )
433 =head2 $c->detach( $class, $method, [, \@arguments ] )
437 The same as L<< forward|/"$c->forward( $action [, \@arguments ] )" >>, but
438 doesn't return to the previous action when processing is finished.
440 When called with no arguments it escapes the processing chain entirely.
444 sub detach { my $c = shift; $c->dispatcher->detach( $c, @_ ) }
446 =head2 $c->visit( $action [, \@arguments ] )
448 =head2 $c->visit( $action [, \@captures, \@arguments ] )
450 =head2 $c->visit( $class, $method, [, \@arguments ] )
452 =head2 $c->visit( $class, $method, [, \@captures, \@arguments ] )
454 Almost the same as L<< forward|/"$c->forward( $action [, \@arguments ] )" >>,
455 but does a full dispatch, instead of just calling the new C<$action> /
456 C<< $class->$method >>. This means that C<begin>, C<auto> and the method
457 you go to are called, just like a new request.
459 In addition both C<< $c->action >> and C<< $c->namespace >> are localized.
460 This means, for example, that C<< $c->action >> methods such as
461 L<name|Catalyst::Action/name>, L<class|Catalyst::Action/class> and
462 L<reverse|Catalyst::Action/reverse> return information for the visited action
463 when they are invoked within the visited action. This is different from the
464 behavior of L<< forward|/"$c->forward( $action [, \@arguments ] )" >>, which
465 continues to use the $c->action object from the caller action even when
466 invoked from the called action.
468 C<< $c->stash >> is kept unchanged.
470 In effect, L<< visit|/"$c->visit( $action [, \@captures, \@arguments ] )" >>
471 allows you to "wrap" another action, just as it would have been called by
472 dispatching from a URL, while the analogous
473 L<< go|/"$c->go( $action [, \@captures, \@arguments ] )" >> allows you to
474 transfer control to another action as if it had been reached directly from a URL.
478 sub visit { my $c = shift; $c->dispatcher->visit( $c, @_ ) }
480 =head2 $c->go( $action [, \@arguments ] )
482 =head2 $c->go( $action [, \@captures, \@arguments ] )
484 =head2 $c->go( $class, $method, [, \@arguments ] )
486 =head2 $c->go( $class, $method, [, \@captures, \@arguments ] )
488 The relationship between C<go> and
489 L<< visit|/"$c->visit( $action [, \@captures, \@arguments ] )" >> is the same as
490 the relationship between
491 L<< forward|/"$c->forward( $class, $method, [, \@arguments ] )" >> and
492 L<< detach|/"$c->detach( $action [, \@arguments ] )" >>. Like C<< $c->visit >>,
493 C<< $c->go >> will perform a full dispatch on the specified action or method,
494 with localized C<< $c->action >> and C<< $c->namespace >>. Like C<detach>,
495 C<go> escapes the processing of the current request chain on completion, and
496 does not return to its cunless blessed $cunless blessed $caller.
498 @arguments are arguments to the final destination of $action. @captures are
499 arguments to the intermediate steps, if any, on the way to the final sub of
504 sub go { my $c = shift; $c->dispatcher->go( $c, @_ ) }
510 Returns the current L<Catalyst::Response> object, see there for details.
514 Returns a hashref to the stash, which may be used to store data and pass
515 it between components during a request. You can also set hash keys by
516 passing arguments. The stash is automatically sent to the view. The
517 stash is cleared at the end of a request; it cannot be used for
518 persistent storage (for this you must use a session; see
519 L<Catalyst::Plugin::Session> for a complete system integrated with
522 $c->stash->{foo} = $bar;
523 $c->stash( { moose => 'majestic', qux => 0 } );
524 $c->stash( bar => 1, gorch => 2 ); # equivalent to passing a hashref
526 # stash is automatically passed to the view for use in a template
527 $c->forward( 'MyApp::View::TT' );
529 The stash hash is currently stored in the PSGI C<$env> and is managed by
530 L<Catalyst::Middleware::Stash>. Since it's part of the C<$env> items in
531 the stash can be accessed in sub applications mounted under your main
532 L<Catalyst> application. For example if you delegate the response of an
533 action to another L<Catalyst> application, that sub application will have
534 access to all the stash keys of the main one, and if can of course add
535 more keys of its own. However those new keys will not 'bubble' back up
536 to the main application.
538 For more information the best thing to do is to review the test case:
539 t/middleware-stash.t in the distribution /t directory.
545 $c->log->error("You are requesting the stash but you don't have a context") unless blessed $c;
546 return Catalyst::Middleware::Stash::get_stash($c->req->env)->(@_);
551 =head2 $c->error($error, ...)
553 =head2 $c->error($arrayref)
555 Returns an arrayref containing error messages. If Catalyst encounters an
556 error while processing a request, it stores the error in $c->error. This
557 method should only be used to store fatal error messages.
559 my @error = @{ $c->error };
563 $c->error('Something bad happened');
565 Calling this will always return an arrayref (if there are no errors it
566 will be an empty arrayref.
573 my $error = ref $_[0] eq 'ARRAY' ? $_[0] : [@_];
574 croak @$error unless ref $c;
575 push @{ $c->{error} }, @$error;
577 elsif ( defined $_[0] ) { $c->{error} = undef }
578 return $c->{error} || [];
584 Contains the return value of the last executed action.
585 Note that << $c->state >> operates in a scalar context which means that all
586 values it returns are scalar.
588 =head2 $c->clear_errors
590 Clear errors. You probably don't want to clear the errors unless you are
591 implementing a custom error screen.
593 This is equivalent to running
604 =head2 $c->has_errors
606 Returns true if you have errors
610 sub has_errors { scalar(@{shift->error}) ? 1:0 }
612 =head2 $c->last_error
614 Returns the most recent error in the stack (the one most recently added...)
615 or nothing if there are no errors.
619 sub last_error { my ($err, @errs) = @{shift->error}; return $err }
623 shifts the most recently added error off the error stack and returns if. Returns
624 nothing if there are no more errors.
630 my ($err, @errors) = @{$self->error};
631 $self->{error} = \@errors;
635 sub _comp_search_prefixes {
637 return map $c->components->{ $_ }, $c->_comp_names_search_prefixes(@_);
640 # search components given a name and some prefixes
641 sub _comp_names_search_prefixes {
642 my ( $c, $name, @prefixes ) = @_;
643 my $appclass = ref $c || $c;
644 my $filter = "^${appclass}::(" . join( '|', @prefixes ) . ')::';
645 $filter = qr/$filter/; # Compile regex now rather than once per loop
647 # map the original component name to the sub part that we will search against
648 my %eligible = map { my $n = $_; $n =~ s{^$appclass\::[^:]+::}{}; $_ => $n; }
649 grep { /$filter/ } keys %{ $c->components };
651 # undef for a name will return all
652 return keys %eligible if !defined $name;
654 my $query = $name->$_isa('Regexp') ? $name : qr/^$name$/i;
655 my @result = grep { $eligible{$_} =~ m{$query} } keys %eligible;
657 return @result if @result;
659 # if we were given a regexp to search against, we're done.
660 return if $name->$_isa('Regexp');
662 # skip regexp fallback if configured
664 if $appclass->config->{disable_component_resolution_regex_fallback};
668 @result = grep { $eligible{ $_ } =~ m{$query} } keys %eligible;
670 # no results? try against full names
672 @result = grep { m{$query} } keys %eligible;
675 # don't warn if we didn't find any results, it just might not exist
677 # Disgusting hack to work out correct method name
678 my $warn_for = lc $prefixes[0];
679 my $msg = "Used regexp fallback for \$c->${warn_for}('${name}'), which found '" .
680 (join '", "', @result) . "'. Relying on regexp fallback behavior for " .
681 "component resolution is unreliable and unsafe.";
682 my $short = $result[0];
683 # remove the component namespace prefix
684 $short =~ s/.*?(Model|Controller|View):://;
685 my $shortmess = Carp::shortmess('');
686 if ($shortmess =~ m#Catalyst/Plugin#) {
687 $msg .= " You probably need to set '$short' instead of '${name}' in this " .
689 } elsif ($shortmess =~ m#Catalyst/lib/(View|Controller)#) {
690 $msg .= " You probably need to set '$short' instead of '${name}' in this " .
691 "component's config";
693 $msg .= " You probably meant \$c->${warn_for}('$short') instead of \$c->${warn_for}('${name}'), " .
694 "but if you really wanted to search, pass in a regexp as the argument " .
695 "like so: \$c->${warn_for}(qr/${name}/)";
697 $c->log->warn( "${msg}$shortmess" );
703 # Find possible names for a prefix
705 my ( $c, @prefixes ) = @_;
706 my $appclass = ref $c || $c;
708 my $filter = "^${appclass}::(" . join( '|', @prefixes ) . ')::';
710 my @names = map { s{$filter}{}; $_; }
711 $c->_comp_names_search_prefixes( undef, @prefixes );
716 # Filter a component before returning by calling ACCEPT_CONTEXT if available
718 sub _filter_component {
719 my ( $c, $comp, @args ) = @_;
721 if(ref $comp eq 'CODE') {
725 if ( eval { $comp->can('ACCEPT_CONTEXT'); } ) {
726 return $comp->ACCEPT_CONTEXT( $c, @args );
729 $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;
734 =head2 COMPONENT ACCESSORS
736 =head2 $c->controller($name)
738 Gets a L<Catalyst::Controller> instance by name.
740 $c->controller('Foo')->do_stuff;
742 If the name is omitted, will return the controller for the dispatched
745 If you want to search for controllers, pass in a regexp as the argument.
747 # find all controllers that start with Foo
748 my @foo_controllers = $c->controller(qr{^Foo});
754 my ( $c, $name, @args ) = @_;
756 my $appclass = ref($c) || $c;
758 unless ( $name->$_isa('Regexp') ) { # Direct component hash lookup to avoid costly regexps
759 my $comps = $c->components;
760 my $check = $appclass."::Controller::".$name;
761 return $c->_filter_component( $comps->{$check}, @args ) if exists $comps->{$check};
763 my @result = $c->_comp_search_prefixes( $name, qw/Controller C/ );
764 return map { $c->_filter_component( $_, @args ) } @result if ref $name;
765 return $c->_filter_component( $result[ 0 ], @args );
768 return $c->component( $c->action->class );
771 =head2 $c->model($name)
773 Gets a L<Catalyst::Model> instance by name.
775 $c->model('Foo')->do_stuff;
777 Any extra arguments are directly passed to ACCEPT_CONTEXT, if the model
778 defines ACCEPT_CONTEXT. If it does not, the args are discarded.
780 If the name is omitted, it will look for
781 - a model object in $c->stash->{current_model_instance}, then
782 - a model name in $c->stash->{current_model}, then
783 - a config setting 'default_model', or
784 - check if there is only one model, and return it if that's the case.
786 If you want to search for models, pass in a regexp as the argument.
788 # find all models that start with Foo
789 my @foo_models = $c->model(qr{^Foo});
794 my ( $c, $name, @args ) = @_;
795 my $appclass = ref($c) || $c;
797 unless ( $name->$_isa('Regexp') ) { # Direct component hash lookup to avoid costly regexps
798 my $comps = $c->components;
799 my $check = $appclass."::Model::".$name;
800 return $c->_filter_component( $comps->{$check}, @args ) if exists $comps->{$check};
802 my @result = $c->_comp_search_prefixes( $name, qw/Model M/ );
803 return map { $c->_filter_component( $_, @args ) } @result if ref $name;
804 return $c->_filter_component( $result[ 0 ], @args );
808 return $c->stash->{current_model_instance}
809 if $c->stash->{current_model_instance};
810 return $c->model( $c->stash->{current_model} )
811 if $c->stash->{current_model};
813 return $c->model( $appclass->config->{default_model} )
814 if $appclass->config->{default_model};
816 my( $comp, $rest ) = $c->_comp_search_prefixes( undef, qw/Model M/);
819 $c->log->warn( Carp::shortmess('Calling $c->model() will return a random model unless you specify one of:') );
820 $c->log->warn( '* $c->config(default_model => "the name of the default model to use")' );
821 $c->log->warn( '* $c->stash->{current_model} # the name of the model to use for this request' );
822 $c->log->warn( '* $c->stash->{current_model_instance} # the instance of the model to use for this request' );
823 $c->log->warn( 'NB: in version 5.81, the "random" behavior will not work at all.' );
826 return $c->_filter_component( $comp );
830 =head2 $c->view($name)
832 Gets a L<Catalyst::View> instance by name.
834 $c->view('Foo')->do_stuff;
836 Any extra arguments are directly passed to ACCEPT_CONTEXT.
838 If the name is omitted, it will look for
839 - a view object in $c->stash->{current_view_instance}, then
840 - a view name in $c->stash->{current_view}, then
841 - a config setting 'default_view', or
842 - check if there is only one view, and return it if that's the case.
844 If you want to search for views, pass in a regexp as the argument.
846 # find all views that start with Foo
847 my @foo_views = $c->view(qr{^Foo});
852 my ( $c, $name, @args ) = @_;
854 my $appclass = ref($c) || $c;
856 unless ( $name->$_isa('Regexp') ) { # Direct component hash lookup to avoid costly regexps
857 my $comps = $c->components;
858 my $check = $appclass."::View::".$name;
859 if( exists $comps->{$check} ) {
860 return $c->_filter_component( $comps->{$check}, @args );
863 $c->log->warn( "Attempted to use view '$check', but does not exist" );
866 my @result = $c->_comp_search_prefixes( $name, qw/View V/ );
867 return map { $c->_filter_component( $_, @args ) } @result if ref $name;
868 return $c->_filter_component( $result[ 0 ], @args );
872 return $c->stash->{current_view_instance}
873 if $c->stash->{current_view_instance};
874 return $c->view( $c->stash->{current_view} )
875 if $c->stash->{current_view};
877 return $c->view( $appclass->config->{default_view} )
878 if $appclass->config->{default_view};
880 my( $comp, $rest ) = $c->_comp_search_prefixes( undef, qw/View V/);
883 $c->log->warn( 'Calling $c->view() will return a random view unless you specify one of:' );
884 $c->log->warn( '* $c->config(default_view => "the name of the default view to use")' );
885 $c->log->warn( '* $c->stash->{current_view} # the name of the view to use for this request' );
886 $c->log->warn( '* $c->stash->{current_view_instance} # the instance of the view to use for this request' );
887 $c->log->warn( 'NB: in version 5.81, the "random" behavior will not work at all.' );
890 return $c->_filter_component( $comp );
893 =head2 $c->controllers
895 Returns the available names which can be passed to $c->controller
901 return $c->_comp_names(qw/Controller C/);
906 Returns the available names which can be passed to $c->model
912 return $c->_comp_names(qw/Model M/);
918 Returns the available names which can be passed to $c->view
924 return $c->_comp_names(qw/View V/);
927 =head2 $c->comp($name)
929 =head2 $c->component($name)
931 Gets a component object by name. This method is not recommended,
932 unless you want to get a specific component by full
933 class. C<< $c->controller >>, C<< $c->model >>, and C<< $c->view >>
934 should be used instead.
936 If C<$name> is a regexp, a list of components matched against the full
937 component name will be returned.
939 If Catalyst can't find a component by name, it will fallback to regex
940 matching by default. To disable this behaviour set
941 disable_component_resolution_regex_fallback to a true value.
943 __PACKAGE__->config( disable_component_resolution_regex_fallback => 1 );
948 my ( $c, $name, @args ) = @_;
951 my $comps = $c->components;
954 # is it the exact name?
955 return $c->_filter_component( $comps->{ $name }, @args )
956 if exists $comps->{ $name };
958 # perhaps we just omitted "MyApp"?
959 my $composed = ( ref $c || $c ) . "::${name}";
960 return $c->_filter_component( $comps->{ $composed }, @args )
961 if exists $comps->{ $composed };
963 # search all of the models, views and controllers
964 my( $comp ) = $c->_comp_search_prefixes( $name, qw/Model M Controller C View V/ );
965 return $c->_filter_component( $comp, @args ) if $comp;
969 if $c->config->{disable_component_resolution_regex_fallback};
971 # This is here so $c->comp( '::M::' ) works
972 my $query = ref $name ? $name : qr{$name}i;
974 my @result = grep { m{$query} } keys %{ $c->components };
975 return map { $c->_filter_component( $_, @args ) } @result if ref $name;
978 $c->log->warn( Carp::shortmess(qq(Found results for "${name}" using regexp fallback)) );
979 $c->log->warn( 'Relying on the regexp fallback behavior for component resolution' );
980 $c->log->warn( 'is unreliable and unsafe. You have been warned' );
981 return $c->_filter_component( $result[ 0 ], @args );
984 # I would expect to return an empty list here, but that breaks back-compat
988 return sort keys %{ $c->components };
991 =head2 CLASS DATA AND HELPER CLASSES
995 Returns or takes a hashref containing the application's configuration.
997 __PACKAGE__->config( { db => 'dsn:SQLite:foo.db' } );
999 You can also use a C<YAML>, C<XML> or L<Config::General> config file
1000 like C<myapp.conf> in your applications home directory. See
1001 L<Catalyst::Plugin::ConfigLoader>.
1003 =head3 Cascading configuration
1005 The config method is present on all Catalyst components, and configuration
1006 will be merged when an application is started. Configuration loaded with
1007 L<Catalyst::Plugin::ConfigLoader> takes precedence over other configuration,
1008 followed by configuration in your top level C<MyApp> class. These two
1009 configurations are merged, and then configuration data whose hash key matches a
1010 component name is merged with configuration for that component.
1012 The configuration for a component is then passed to the C<new> method when a
1013 component is constructed.
1017 MyApp->config({ 'Model::Foo' => { bar => 'baz', overrides => 'me' } });
1018 MyApp::Model::Foo->config({ quux => 'frob', overrides => 'this' });
1020 will mean that C<MyApp::Model::Foo> receives the following data when
1023 MyApp::Model::Foo->new({
1029 It's common practice to use a Moose attribute
1030 on the receiving component to access the config value.
1032 package MyApp::Model::Foo;
1036 # this attr will receive 'baz' at construction time
1042 You can then get the value 'baz' by calling $c->model('Foo')->bar
1043 (or $self->bar inside code in the model).
1045 B<NOTE:> you MUST NOT call C<< $self->config >> or C<< __PACKAGE__->config >>
1046 as a way of reading config within your code, as this B<will not> give you the
1047 correctly merged config back. You B<MUST> take the config values supplied to
1048 the constructor and use those instead.
1052 around config => sub {
1056 croak('Setting config after setup has been run is not allowed.')
1057 if ( @_ and $c->setup_finished );
1064 Returns the logging object instance. Unless it is already set, Catalyst
1065 sets this up with a L<Catalyst::Log> object. To use your own log class,
1066 set the logger with the C<< __PACKAGE__->log >> method prior to calling
1067 C<< __PACKAGE__->setup >>.
1069 __PACKAGE__->log( MyLogger->new );
1074 $c->log->info( 'Now logging with my own logger!' );
1076 Your log class should implement the methods described in
1081 Returned True if there's a valid encoding
1083 =head2 clear_encoding
1085 Clears the encoding for the current context
1089 Sets or gets the application encoding. Setting encoding takes either an
1090 Encoding object or a string that we try to resolve via L<Encode::find_encoding>.
1092 You would expect to get the encoding object back if you attempt to set it. If
1093 there is a failure you will get undef returned and an error message in the log.
1097 sub has_encoding { shift->encoding ? 1:0 }
1099 sub clear_encoding {
1102 $c->encoding(undef);
1104 $c->log->error("You can't clear encoding on the application");
1114 # Don't let one change this once we are too far into the response
1115 if(blessed $c && $c->res->finalized_headers) {
1116 Carp::croak("You may not change the encoding once the headers are finalized");
1120 # Let it be set to undef
1121 if (my $wanted = shift) {
1122 $encoding = Encode::find_encoding($wanted)
1123 or Carp::croak( qq/Unknown encoding '$wanted'/ );
1124 binmode(STDERR, ':encoding(' . $encoding->name . ')');
1131 ? $c->{encoding} = $encoding
1132 : $c->_encoding($encoding);
1134 $encoding = ref $c && exists $c->{encoding}
1144 Returns 1 if debug mode is enabled, 0 otherwise.
1146 You can enable debug mode in several ways:
1150 =item By calling myapp_server.pl with the -d flag
1152 =item With the environment variables MYAPP_DEBUG, or CATALYST_DEBUG
1154 =item The -Debug option in your MyApp.pm
1156 =item By declaring C<sub debug { 1 }> in your MyApp.pm.
1160 The first three also set the log level to 'debug'.
1162 Calling C<< $c->debug(1) >> has no effect.
1168 =head2 $c->dispatcher
1170 Returns the dispatcher instance. See L<Catalyst::Dispatcher>.
1174 Returns the engine instance. See L<Catalyst::Engine>.
1177 =head2 UTILITY METHODS
1179 =head2 $c->path_to(@path)
1181 Merges C<@path> with C<< $c->config->{home} >> and returns a
1182 L<Path::Class::Dir> object. Note you can usually use this object as
1183 a filename, but sometimes you will have to explicitly stringify it
1184 yourself by calling the C<< ->stringify >> method.
1188 $c->path_to( 'db', 'sqlite.db' );
1193 my ( $c, @path ) = @_;
1194 my $path = Path::Class::Dir->new( $c->config->{home}, @path );
1195 if ( -d $path ) { return $path }
1196 else { return Path::Class::File->new( $c->config->{home}, @path ) }
1200 my ( $class, $name, $plugin, @args ) = @_;
1202 # See block comment in t/unit_core_plugin.t
1203 $class->log->warn(qq/Adding plugin using the ->plugin method is deprecated, and will be removed in a future release/);
1205 $class->_register_plugin( $plugin, 1 );
1207 eval { $plugin->import };
1208 $class->mk_classdata($name);
1210 eval { $obj = $plugin->new(@args) };
1213 Catalyst::Exception->throw( message =>
1214 qq/Couldn't instantiate instant plugin "$plugin", "$@"/ );
1217 $class->$name($obj);
1218 $class->log->debug(qq/Initialized instant plugin "$plugin" as "$name"/)
1224 Initializes the dispatcher and engine, loads any plugins, and loads the
1225 model, view, and controller components. You may also specify an array
1226 of plugins to load here, if you choose to not load them in the C<use
1230 MyApp->setup( qw/-Debug/ );
1232 B<Note:> You B<should not> wrap this method with method modifiers
1233 or bad things will happen - wrap the C<setup_finalize> method instead.
1235 B<Note:> You can create a custom setup stage that will execute when the
1236 application is starting. Use this to customize setup.
1238 MyApp->setup(-Custom=value);
1241 my ($class, $value) = @_;
1244 Can be handy if you want to hook into the setup phase.
1249 my ( $class, @arguments ) = @_;
1250 croak('Running setup more than once')
1251 if ( $class->setup_finished );
1253 unless ( $class->isa('Catalyst') ) {
1255 Catalyst::Exception->throw(
1256 message => qq/'$class' does not inherit from Catalyst/ );
1259 if ( $class->arguments ) {
1260 @arguments = ( @arguments, @{ $class->arguments } );
1266 foreach (@arguments) {
1270 ( $flags->{log} ) ? 'debug,' . $flags->{log} : 'debug';
1272 elsif (/^-(\w+)=?(.*)$/) {
1273 $flags->{ lc $1 } = $2;
1276 push @{ $flags->{plugins} }, $_;
1280 $class->setup_home( delete $flags->{home} );
1282 $class->setup_log( delete $flags->{log} );
1283 $class->setup_plugins( delete $flags->{plugins} );
1285 $class->setup_data_handlers();
1286 $class->setup_dispatcher( delete $flags->{dispatcher} );
1287 if (my $engine = delete $flags->{engine}) {
1288 $class->log->warn("Specifying the engine in ->setup is no longer supported, see Catalyst::Upgrading");
1290 $class->setup_engine();
1291 $class->setup_stats( delete $flags->{stats} );
1293 for my $flag ( sort keys %{$flags} ) {
1295 if ( my $code = $class->can( 'setup_' . $flag ) ) {
1296 &$code( $class, delete $flags->{$flag} );
1299 $class->log->warn(qq/Unknown flag "$flag"/);
1303 eval { require Catalyst::Devel; };
1304 if( !$@ && $ENV{CATALYST_SCRIPT_GEN} && ( $ENV{CATALYST_SCRIPT_GEN} < $Catalyst::Devel::CATALYST_SCRIPT_GEN ) ) {
1305 $class->log->warn(<<"EOF");
1306 You are running an old script!
1308 Please update by running (this will overwrite existing files):
1309 catalyst.pl -force -scripts $class
1311 or (this will not overwrite existing files):
1312 catalyst.pl -scripts $class
1317 # Call plugins setup, this is stupid and evil.
1318 # Also screws C3 badly on 5.10, hack to avoid.
1320 no warnings qw/redefine/;
1321 local *setup = sub { };
1322 $class->setup unless $Catalyst::__AM_RESTARTING;
1325 # If you are expecting configuration info as part of your setup, it needs
1326 # to get called here and below, since we need the above line to support
1327 # ConfigLoader based configs.
1329 $class->setup_encoding();
1330 $class->setup_middleware();
1332 # Initialize our data structure
1333 $class->components( {} );
1335 $class->setup_components;
1337 if ( $class->debug ) {
1338 my @plugins = map { "$_ " . ( $_->VERSION || '' ) } $class->registered_plugins;
1341 my $column_width = Catalyst::Utils::term_width() - 6;
1342 my $t = Text::SimpleTable->new($column_width);
1343 $t->row($_) for @plugins;
1344 $class->log->debug( "Loaded plugins:\n" . $t->draw . "\n" );
1347 my @middleware = map {
1350 (ref($_) .' '. ($_->can('VERSION') ? $_->VERSION || '' : '')
1351 || '') } $class->registered_middlewares;
1354 my $column_width = Catalyst::Utils::term_width() - 6;
1355 my $t = Text::SimpleTable->new($column_width);
1356 $t->row($_) for @middleware;
1357 $class->log->debug( "Loaded PSGI Middleware:\n" . $t->draw . "\n" );
1360 my %dh = $class->registered_data_handlers;
1361 if (my @data_handlers = keys %dh) {
1362 my $column_width = Catalyst::Utils::term_width() - 6;
1363 my $t = Text::SimpleTable->new($column_width);
1364 $t->row($_) for @data_handlers;
1365 $class->log->debug( "Loaded Request Data Handlers:\n" . $t->draw . "\n" );
1368 my $dispatcher = $class->dispatcher;
1369 my $engine = $class->engine;
1370 my $home = $class->config->{home};
1372 $class->log->debug(sprintf(q/Loaded dispatcher "%s"/, blessed($dispatcher)));
1373 $class->log->debug(sprintf(q/Loaded engine "%s"/, blessed($engine)));
1377 ? $class->log->debug(qq/Found home "$home"/)
1378 : $class->log->debug(qq/Home "$home" doesn't exist/)
1379 : $class->log->debug(q/Couldn't find home/);
1381 my $column_width = Catalyst::Utils::term_width() - 8 - 9;
1382 my $t = Text::SimpleTable->new( [ $column_width, 'Class' ], [ 8, 'Type' ] );
1383 for my $comp ( sort keys %{ $class->components } ) {
1384 my $type = ref $class->components->{$comp} ? 'instance' : 'class';
1385 $t->row( $comp, $type );
1387 $class->log->debug( "Loaded components:\n" . $t->draw . "\n" )
1388 if ( keys %{ $class->components } );
1391 # Add our self to components, since we are also a component
1392 if( $class->isa('Catalyst::Controller') ){
1393 $class->components->{$class} = $class;
1396 $class->setup_actions;
1398 if ( $class->debug ) {
1399 my $name = $class->config->{name} || 'Application';
1400 $class->log->info("$name powered by Catalyst $Catalyst::VERSION");
1403 if ($class->config->{case_sensitive}) {
1404 $class->log->warn($class . "->config->{case_sensitive} is set.");
1405 $class->log->warn("This setting is deprecated and planned to be removed in Catalyst 5.81.");
1408 $class->setup_finalize;
1410 # Flush the log for good measure (in case something turned off 'autoflush' early)
1411 $class->log->_flush() if $class->log->can('_flush');
1413 return $class || 1; # Just in case someone named their Application 0...
1416 =head2 $app->setup_finalize
1418 A hook to attach modifiers to. This method does not do anything except set the
1419 C<setup_finished> accessor.
1421 Applying method modifiers to the C<setup> method doesn't work, because of quirky things done for plugin setup.
1425 after setup_finalize => sub {
1433 sub setup_finalize {
1435 $class->setup_finished(1);
1438 =head2 $c->uri_for( $path?, @args?, \%query_values? )
1440 =head2 $c->uri_for( $action, \@captures?, @args?, \%query_values? )
1442 =head2 $c->uri_for( $action, [@captures, @args], \%query_values? )
1444 Constructs an absolute L<URI> object based on the application root, the
1445 provided path, and the additional arguments and query parameters provided.
1446 When used as a string, provides a textual URI. If you need more flexibility
1447 than this (i.e. the option to provide relative URIs etc.) see
1448 L<Catalyst::Plugin::SmartURI>.
1450 If no arguments are provided, the URI for the current action is returned.
1451 To return the current action and also provide @args, use
1452 C<< $c->uri_for( $c->action, @args ) >>.
1454 If the first argument is a string, it is taken as a public URI path relative
1455 to C<< $c->namespace >> (if it doesn't begin with a forward slash) or
1456 relative to the application root (if it does). It is then merged with
1457 C<< $c->request->base >>; any C<@args> are appended as additional path
1458 components; and any C<%query_values> are appended as C<?foo=bar> parameters.
1460 If the first argument is a L<Catalyst::Action> it represents an action which
1461 will have its path resolved using C<< $c->dispatcher->uri_for_action >>. The
1462 optional C<\@captures> argument (an arrayref) allows passing the captured
1463 variables that are needed to fill in the paths of Chained and Regex actions;
1464 once the path is resolved, C<uri_for> continues as though a path was
1465 provided, appending any arguments or parameters and creating an absolute
1468 The captures for the current request can be found in
1469 C<< $c->request->captures >>, and actions can be resolved using
1470 C<< Catalyst::Controller->action_for($name) >>. If you have a private action
1471 path, use C<< $c->uri_for_action >> instead.
1473 # Equivalent to $c->req->uri
1474 $c->uri_for($c->action, $c->req->captures,
1475 @{ $c->req->args }, $c->req->params);
1477 # For the Foo action in the Bar controller
1478 $c->uri_for($c->controller('Bar')->action_for('Foo'));
1480 # Path to a static resource
1481 $c->uri_for('/static/images/logo.png');
1483 In general the scheme of the generated URI object will follow the incoming request
1484 however if your targeted action or action chain has the Scheme attribute it will
1487 Also, if the targeted Action or Action chain declares Args/CaptureArgs that have
1488 type constraints, we will require that your proposed URL verify on those declared
1494 my ( $c, $path, @args ) = @_;
1496 if ( $path->$_isa('Catalyst::Controller') ) {
1497 $path = $path->path_prefix;
1502 undef($path) if (defined $path && $path eq '');
1505 ( scalar @args && ref $args[$#args] eq 'HASH' ? pop @args : {} );
1507 carp "uri_for called with undef argument" if grep { ! defined $_ } @args;
1509 my $target_action = $path->$_isa('Catalyst::Action') ? $path : undef;
1510 if ( $path->$_isa('Catalyst::Action') ) { # action object
1511 s|/|%2F|g for @args;
1512 my $captures = [ map { s|/|%2F|g; $_; }
1513 ( scalar @args && ref $args[0] eq 'ARRAY'
1518 my $expanded_action = $c->dispatcher->expand_action( $action );
1519 my $num_captures = $expanded_action->number_of_captures;
1521 # ->uri_for( $action, \@captures_and_args, \%query_values? )
1522 if( !@args && $action->number_of_args ) {
1523 unshift @args, splice @$captures, $num_captures;
1527 unless($expanded_action->match_captures_constraints($c, $captures)) {
1528 carp "captures [@{$captures}] do not match the type constraints in actionchain ending with '$expanded_action'";
1533 $path = $c->dispatcher->uri_for_action($action, $captures);
1534 if (not defined $path) {
1535 $c->log->debug(qq/Can't find uri_for action '$action' @$captures/)
1539 $path = '/' if $path eq '';
1541 # At this point @encoded_args is the remaining Args (all captures removed).
1542 if($expanded_action->has_args_constraints) {
1543 unless($expanded_action->match_args($c,\@args)) {
1544 carp "args [@args] do not match the type constraints in action '$expanded_action'";
1550 unshift(@args, $path);
1552 unless (defined $path && $path =~ s!^/!!) { # in-place strip
1553 my $namespace = $c->namespace;
1554 if (defined $path) { # cheesy hack to handle path '../foo'
1555 $namespace =~ s{(?:^|/)[^/]+$}{} while $args[0] =~ s{^\.\./}{};
1557 unshift(@args, $namespace || '');
1560 # join args with '/', or a blank string
1561 my $args = join('/', grep { defined($_) } @args);
1562 $args =~ s/\?/%3F/g; # STUPID STUPID SPECIAL CASE
1565 my ($base, $class) = ('/', 'URI::_generic');
1567 $base = $c->req->base;
1568 if($target_action) {
1569 $target_action = $c->dispatcher->expand_action($target_action);
1570 if(my $s = $target_action->scheme) {
1575 $class = ref($base);
1578 $class = ref($base);
1581 $base =~ s{(?<!/)$}{/};
1586 if (my @keys = keys %$params) {
1587 # somewhat lifted from URI::_query's query_form
1588 $query = '?'.join('&', map {
1589 my $val = $params->{$_};
1590 #s/([;\/?:@&=+,\$\[\]%])/$URI::Escape::escapes{$1}/go; ## Commented out because seems to lead to double encoding - JNAP
1593 $val = '' unless defined $val;
1596 $param = encode_utf8($param);
1597 # using the URI::Escape pattern here so utf8 chars survive
1598 $param =~ s/([^A-Za-z0-9\-_.!~*'() ])/$URI::Escape::escapes{$1}/go;
1601 $key = encode_utf8($key);
1602 # using the URI::Escape pattern here so utf8 chars survive
1603 $key =~ s/([^A-Za-z0-9\-_.!~*'() ])/$URI::Escape::escapes{$1}/go;
1606 "${key}=$param"; } ( ref $val eq 'ARRAY' ? @$val : $val ));
1610 $base = encode_utf8 $base;
1611 $base =~ s/([^$URI::uric])/$URI::Escape::escapes{$1}/go;
1612 $args = encode_utf8 $args;
1613 $args =~ s/([^$URI::uric])/$URI::Escape::escapes{$1}/go;
1615 my $res = bless(\"${base}${args}${query}", $class);
1619 =head2 $c->uri_for_action( $path, \@captures_and_args?, @args?, \%query_values? )
1621 =head2 $c->uri_for_action( $action, \@captures_and_args?, @args?, \%query_values? )
1627 A private path to the Catalyst action you want to create a URI for.
1629 This is a shortcut for calling C<< $c->dispatcher->get_action_by_path($path)
1630 >> and passing the resulting C<$action> and the remaining arguments to C<<
1633 You can also pass in a Catalyst::Action object, in which case it is passed to
1636 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.
1638 For example, if the action looks like:
1640 package MyApp::Controller::Users;
1642 sub lst : Path('the-list') {}
1646 $c->uri_for_action('/users/lst')
1648 and it will create the URI /users/the-list.
1650 =item \@captures_and_args?
1652 Optional array reference of Captures (i.e. C<<CaptureArgs or $c->req->captures>)
1653 and arguments to the request. Usually used with L<Catalyst::DispatchType::Chained>
1654 to interpolate all the parameters in the URI.
1658 Optional list of extra arguments - can be supplied in the
1659 C<< \@captures_and_args? >> array ref, or here - whichever is easier for your
1662 Your action can have zero, a fixed or a variable number of args (e.g.
1663 C<< Args(1) >> for a fixed number or C<< Args() >> for a variable number)..
1665 =item \%query_values?
1667 Optional array reference of query parameters to append. E.g.
1673 /rest/of/your/uri?foo=bar
1679 sub uri_for_action {
1680 my ( $c, $path, @args ) = @_;
1681 my $action = blessed($path)
1683 : $c->dispatcher->get_action_by_path($path);
1684 unless (defined $action) {
1685 croak "Can't find action for path '$path'";
1687 return $c->uri_for( $action, @args );
1690 =head2 $c->welcome_message
1692 Returns the Catalyst welcome HTML page.
1696 sub welcome_message {
1698 my $name = $c->config->{name};
1699 my $logo = $c->uri_for('/static/images/catalyst_logo.png');
1700 my $prefix = Catalyst::Utils::appprefix( ref $c );
1701 $c->response->content_type('text/html; charset=utf-8');
1703 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
1704 "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
1705 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
1707 <meta http-equiv="Content-Language" content="en" />
1708 <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
1709 <title>$name on Catalyst $VERSION</title>
1710 <style type="text/css">
1713 background-color: #eee;
1720 margin-bottom: 10px;
1722 background-color: #ccc;
1723 border: 1px solid #aaa;
1728 font-family: verdana, tahoma, sans-serif;
1731 font-family: verdana, tahoma, sans-serif;
1734 text-decoration: none;
1736 border-bottom: 1px dotted #bbb;
1738 :link:hover, :visited:hover {
1751 background-color: #fff;
1752 border: 1px solid #aaa;
1756 font-weight: normal;
1778 <h1><span id="appname">$name</span> on <a href="http://catalyst.perl.org">Catalyst</a>
1783 <img src="$logo" alt="Catalyst Logo" />
1785 <p>Welcome to the world of Catalyst.
1786 This <a href="http://en.wikipedia.org/wiki/MVC">MVC</a>
1787 framework will make web development something you had
1788 never expected it to be: Fun, rewarding, and quick.</p>
1789 <h2>What to do now?</h2>
1790 <p>That really depends on what <b>you</b> want to do.
1791 We do, however, provide you with a few starting points.</p>
1792 <p>If you want to jump right into web development with Catalyst
1793 you might want to start with a tutorial.</p>
1794 <pre>perldoc <a href="https://metacpan.org/module/Catalyst::Manual::Tutorial">Catalyst::Manual::Tutorial</a></code>
1796 <p>Afterwards you can go on to check out a more complete look at our features.</p>
1798 <code>perldoc <a href="https://metacpan.org/module/Catalyst::Manual::Intro">Catalyst::Manual::Intro</a>
1799 <!-- Something else should go here, but the Catalyst::Manual link seems unhelpful -->
1801 <h2>What to do next?</h2>
1802 <p>Next it's time to write an actual application. Use the
1803 helper scripts to generate <a href="https://metacpan.org/search?q=Catalyst%3A%3AController">controllers</a>,
1804 <a href="https://metacpan.org/search?q=Catalyst%3A%3AModel">models</a>, and
1805 <a href="https://metacpan.org/search?q=Catalyst%3A%3AView">views</a>;
1806 they can save you a lot of work.</p>
1807 <pre><code>script/${prefix}_create.pl --help</code></pre>
1808 <p>Also, be sure to check out the vast and growing
1809 collection of <a href="http://search.cpan.org/search?query=Catalyst">plugins for Catalyst on CPAN</a>;
1810 you are likely to find what you need there.
1814 <p>Catalyst has a very active community. Here are the main places to
1815 get in touch with us.</p>
1818 <a href="http://dev.catalyst.perl.org">Wiki</a>
1821 <a href="http://lists.scsys.co.uk/cgi-bin/mailman/listinfo/catalyst">Mailing-List</a>
1824 <a href="irc://irc.perl.org/catalyst">IRC channel #catalyst on irc.perl.org</a>
1827 <h2>In conclusion</h2>
1828 <p>The Catalyst team hopes you will enjoy using Catalyst as much
1829 as we enjoyed making it. Please contact us if you have ideas
1830 for improvement or other feedback.</p>
1840 Contains a hash of options passed from the application script, including
1841 the original ARGV the script received, the processed values from that
1842 ARGV and any extra arguments to the script which were not processed.
1844 This can be used to add custom options to your application's scripts
1845 and setup your application differently depending on the values of these
1848 =head1 INTERNAL METHODS
1850 These methods are not meant to be used by end users.
1852 =head2 $c->components
1854 Returns a hash of components.
1856 =head2 $c->context_class
1858 Returns or sets the context class.
1862 Returns a hashref containing coderefs and execution counts (needed for
1863 deep recursion detection).
1867 Returns the number of actions on the current internal execution stack.
1871 Dispatches a request to actions.
1875 sub dispatch { my $c = shift; $c->dispatcher->dispatch( $c, @_ ) }
1877 =head2 $c->dispatcher_class
1879 Returns or sets the dispatcher class.
1881 =head2 $c->dump_these
1883 Returns a list of 2-element array references (name, structure) pairs
1884 that will be dumped on the error page in debug mode.
1890 [ Request => $c->req ],
1891 [ Response => $c->res ],
1892 [ Stash => $c->stash ],
1893 [ Config => $c->config ];
1896 =head2 $c->engine_class
1898 Returns or sets the engine class.
1900 =head2 $c->execute( $class, $coderef )
1902 Execute a coderef in given class and catch exceptions. Errors are available
1908 my ( $c, $class, $code ) = @_;
1909 $class = $c->component($class) || $class;
1912 if ( $c->depth >= $RECURSION ) {
1913 my $action = $code->reverse();
1914 $action = "/$action" unless $action =~ /->/;
1915 my $error = qq/Deep recursion detected calling "${action}"/;
1916 $c->log->error($error);
1922 my $stats_info = $c->_stats_start_execute( $code ) if $c->use_stats;
1924 push( @{ $c->stack }, $code );
1926 no warnings 'recursion';
1927 # N.B. This used to be combined, but I have seen $c get clobbered if so, and
1928 # I have no idea how, ergo $ret (which appears to fix the issue)
1929 eval { my $ret = $code->execute( $class, $c, @{ $c->req->args } ) || 0; $c->state( $ret ) };
1931 $c->_stats_finish_execute( $stats_info ) if $c->use_stats and $stats_info;
1933 my $last = pop( @{ $c->stack } );
1935 if ( my $error = $@ ) {
1936 #rethow if this can be handled by middleware
1937 if ( $c->_handle_http_exception($error) ) {
1938 foreach my $err (@{$c->error}) {
1939 $c->log->error($err);
1942 $c->log->_flush if $c->log->can('_flush');
1944 $error->can('rethrow') ? $error->rethrow : croak $error;
1946 if ( blessed($error) and $error->isa('Catalyst::Exception::Detach') ) {
1947 $error->rethrow if $c->depth > 1;
1949 elsif ( blessed($error) and $error->isa('Catalyst::Exception::Go') ) {
1950 $error->rethrow if $c->depth > 0;
1953 unless ( ref $error ) {
1954 no warnings 'uninitialized';
1956 my $class = $last->class;
1957 my $name = $last->name;
1958 $error = qq/Caught exception in $class->$name "$error"/;
1967 sub _stats_start_execute {
1968 my ( $c, $code ) = @_;
1969 my $appclass = ref($c) || $c;
1970 return if ( ( $code->name =~ /^_.*/ )
1971 && ( !$appclass->config->{show_internal_actions} ) );
1973 my $action_name = $code->reverse();
1974 $c->counter->{$action_name}++;
1976 my $action = $action_name;
1977 $action = "/$action" unless $action =~ /->/;
1979 # determine if the call was the result of a forward
1980 # this is done by walking up the call stack and looking for a calling
1981 # sub of Catalyst::forward before the eval
1983 for my $index ( 2 .. 11 ) {
1985 if ( ( caller($index) )[0] eq 'Catalyst'
1986 && ( caller($index) )[3] eq '(eval)' );
1988 if ( ( caller($index) )[3] =~ /forward$/ ) {
1989 $callsub = ( caller($index) )[3];
1990 $action = "-> $action";
1995 my $uid = $action_name . $c->counter->{$action_name};
1997 # is this a root-level call or a forwarded call?
1998 if ( $callsub =~ /forward$/ ) {
1999 my $parent = $c->stack->[-1];
2001 # forward, locate the caller
2002 if ( defined $parent && exists $c->counter->{"$parent"} ) {
2005 parent => "$parent" . $c->counter->{"$parent"},
2011 # forward with no caller may come from a plugin
2030 sub _stats_finish_execute {
2031 my ( $c, $info ) = @_;
2032 $c->stats->profile( end => $info );
2037 Finalizes the request.
2044 for my $error ( @{ $c->error } ) {
2045 $c->log->error($error);
2048 # Support skipping finalize for psgix.io style 'jailbreak'. Used to support
2049 # stuff like cometd and websockets
2051 if($c->request->_has_io_fh) {
2056 # Allow engine to handle finalize flow (for POE)
2057 my $engine = $c->engine;
2058 if ( my $code = $engine->can('finalize') ) {
2063 $c->finalize_uploads;
2066 if ( $#{ $c->error } >= 0 ) {
2070 $c->finalize_encoding;
2071 $c->finalize_headers unless $c->response->finalized_headers;
2077 if ($c->use_stats) {
2078 my $elapsed = $c->stats->elapsed;
2079 my $av = $elapsed == 0 ? '??' : sprintf '%.3f', 1 / $elapsed;
2081 "Request took ${elapsed}s ($av/s)\n" . $c->stats->report . "\n" );
2084 return $c->response->status;
2087 =head2 $c->finalize_body
2093 sub finalize_body { my $c = shift; $c->engine->finalize_body( $c, @_ ) }
2095 =head2 $c->finalize_cookies
2101 sub finalize_cookies { my $c = shift; $c->engine->finalize_cookies( $c, @_ ) }
2103 =head2 $c->finalize_error
2105 Finalizes error. If there is only one error in L</error> and it is an object that
2106 does C<as_psgi> or C<code> we rethrow the error and presume it caught by middleware
2107 up the ladder. Otherwise we return the debugging error page (in debug mode) or we
2108 return the default error page (production mode).
2112 sub finalize_error {
2114 if($#{$c->error} > 0) {
2115 $c->engine->finalize_error( $c, @_ );
2117 my ($error) = @{$c->error};
2118 if ( $c->_handle_http_exception($error) ) {
2119 # In the case where the error 'knows what it wants', becauses its PSGI
2120 # aware, just rethow and let middleware catch it
2121 $error->can('rethrow') ? $error->rethrow : croak $error;
2123 $c->engine->finalize_error( $c, @_ )
2128 =head2 $c->finalize_headers
2134 sub finalize_headers {
2137 my $response = $c->response; #accessor calls can add up?
2139 # Check if we already finalized headers
2140 return if $response->finalized_headers;
2143 if ( my $location = $response->redirect ) {
2144 $c->log->debug(qq/Redirecting to "$location"/) if $c->debug;
2145 $response->header( Location => $location );
2148 # Remove incorrectly added body and content related meta data when returning
2149 # an information response, or a response the is required to not include a body
2151 $c->finalize_cookies;
2153 # This currently is a NOOP but I don't want to remove it since I guess people
2154 # might have Response subclasses that use it for something... (JNAP)
2155 $c->response->finalize_headers();
2158 $response->finalized_headers(1);
2161 =head2 $c->finalize_encoding
2163 Make sure your body is encoded properly IF you set an encoding. By
2164 default the encoding is UTF-8 but you can disable it by explicitly setting the
2165 encoding configuration value to undef.
2167 We can only encode when the body is a scalar. Methods for encoding via the
2168 streaming interfaces (such as C<write> and C<write_fh> on L<Catalyst::Response>
2175 sub finalize_encoding {
2177 my $res = $c->res || return;
2179 # Warn if the set charset is different from the one you put into encoding. We need
2180 # to do this early since encodable_response is false for this condition and we need
2181 # to match the debug output for backcompat (there's a test for this...) -JNAP
2183 $res->content_type_charset and $c->encoding and
2184 (uc($c->encoding->mime_name) ne uc($res->content_type_charset))
2186 my $ct = lc($res->content_type_charset);
2187 $c->log->debug("Catalyst encoding config is set to encode in '" .
2188 $c->encoding->mime_name .
2189 "', content type is '$ct', not encoding ");
2193 ($res->encodable_response) and
2194 (defined($res->body)) and
2195 (ref(\$res->body) eq 'SCALAR')
2197 $c->res->body( $c->encoding->encode( $c->res->body, $c->_encode_check ) );
2199 # Set the charset if necessary. This might be a bit bonkers since encodable response
2200 # is false when the set charset is not the same as the encoding mimetype (maybe
2201 # confusing action at a distance here..
2202 # Don't try to set the charset if one already exists
2203 $c->res->content_type($c->res->content_type . "; charset=" . $c->encoding->mime_name)
2204 unless($c->res->content_type_charset);
2208 =head2 $c->finalize_output
2210 An alias for finalize_body.
2212 =head2 $c->finalize_read
2214 Finalizes the input after reading is complete.
2218 sub finalize_read { my $c = shift; $c->engine->finalize_read( $c, @_ ) }
2220 =head2 $c->finalize_uploads
2222 Finalizes uploads. Cleans up any temporary files.
2226 sub finalize_uploads { my $c = shift; $c->engine->finalize_uploads( $c, @_ ) }
2228 =head2 $c->get_action( $action, $namespace )
2230 Gets an action in a given namespace.
2234 sub get_action { my $c = shift; $c->dispatcher->get_action(@_) }
2236 =head2 $c->get_actions( $action, $namespace )
2238 Gets all actions of a given name in a namespace and all parent
2243 sub get_actions { my $c = shift; $c->dispatcher->get_actions( $c, @_ ) }
2245 =head2 $app->handle_request( @arguments )
2247 Called to handle each HTTP request.
2251 sub handle_request {
2252 my ( $class, @arguments ) = @_;
2254 # Always expect worst case!
2257 if ($class->debug) {
2258 my $secs = time - $START || 1;
2259 my $av = sprintf '%.3f', $COUNT / $secs;
2260 my $time = localtime time;
2261 $class->log->info("*** Request $COUNT ($av/s) [$$] [$time] ***");
2264 my $c = $class->prepare(@arguments);
2266 $status = $c->finalize;
2268 #rethow if this can be handled by middleware
2269 if ( $class->_handle_http_exception($_) ) {
2270 $_->can('rethrow') ? $_->rethrow : croak $_;
2272 chomp(my $error = $_);
2273 $class->log->error(qq/Caught exception in engine "$error"/);
2278 if(my $coderef = $class->log->can('_flush')){
2279 $class->log->$coderef();
2284 =head2 $class->prepare( @arguments )
2286 Creates a Catalyst context from an engine-specific request (Apache, CGI,
2293 predicate => '_has_uploadtmp',
2297 my ( $class, @arguments ) = @_;
2300 # After the app/ctxt split, this should become an attribute based on something passed
2301 # into the application.
2302 $class->context_class( ref $class || $class ) unless $class->context_class;
2304 my $uploadtmp = $class->config->{uploadtmp};
2305 my $c = $class->context_class->new({ $uploadtmp ? (_uploadtmp => $uploadtmp) : ()});
2307 $c->response->_context($c);
2310 $c->stats($class->composed_stats_class->new)->enable;
2313 if ( $c->debug || $c->config->{enable_catalyst_header} ) {
2314 $c->res->headers->header( 'X-Catalyst' => $Catalyst::VERSION );
2318 # Allow engine to direct the prepare flow (for POE)
2319 if ( my $prepare = $c->engine->can('prepare') ) {
2320 $c->engine->$prepare( $c, @arguments );
2323 $c->prepare_request(@arguments);
2324 $c->prepare_connection;
2325 $c->prepare_query_parameters;
2326 $c->prepare_headers; # Just hooks, no longer needed - they just
2327 $c->prepare_cookies; # cause the lazy attribute on req to build
2330 # Prepare the body for reading, either by prepare_body
2331 # or the user, if they are using $c->read
2334 # Parse the body unless the user wants it on-demand
2335 unless ( ref($c)->config->{parse_on_demand} ) {
2341 # VERY ugly and probably shouldn't rely on ->finalize actually working
2343 # failed prepare is always due to an invalid request, right?
2344 $c->response->status(400);
2345 $c->response->content_type('text/plain');
2346 $c->response->body('Bad Request');
2347 # Note we call finalize and then die here, which escapes
2348 # finalize being called in the enclosing block..
2349 # It in fact couldn't be called, as we don't return $c..
2350 # This is a mess - but I'm unsure you can fix this without
2351 # breaking compat for people doing crazy things (we should set
2352 # the 400 and just return the ctx here IMO, letting finalize get called
2363 =head2 $c->prepare_action
2365 Prepares action. See L<Catalyst::Dispatcher>.
2369 sub prepare_action {
2371 my $ret = $c->dispatcher->prepare_action( $c, @_);
2374 foreach (@{$c->req->arguments}, @{$c->req->captures}) {
2375 $_ = $c->_handle_param_unicode_decoding($_);
2383 =head2 $c->prepare_body
2385 Prepares message body.
2392 return if $c->request->_has_body;
2394 # Initialize on-demand data
2395 $c->engine->prepare_body( $c, @_ );
2396 $c->prepare_parameters;
2397 $c->prepare_uploads;
2400 =head2 $c->prepare_body_chunk( $chunk )
2402 Prepares a chunk of data before sending it to L<HTTP::Body>.
2404 See L<Catalyst::Engine>.
2408 sub prepare_body_chunk {
2410 $c->engine->prepare_body_chunk( $c, @_ );
2413 =head2 $c->prepare_body_parameters
2415 Prepares body parameters.
2419 sub prepare_body_parameters {
2421 $c->request->prepare_body_parameters( $c, @_ );
2424 =head2 $c->prepare_connection
2426 Prepares connection.
2430 sub prepare_connection {
2432 $c->request->prepare_connection($c);
2435 =head2 $c->prepare_cookies
2437 Prepares cookies by ensuring that the attribute on the request
2438 object has been built.
2442 sub prepare_cookies { my $c = shift; $c->request->cookies }
2444 =head2 $c->prepare_headers
2446 Prepares request headers by ensuring that the attribute on the request
2447 object has been built.
2451 sub prepare_headers { my $c = shift; $c->request->headers }
2453 =head2 $c->prepare_parameters
2455 Prepares parameters.
2459 sub prepare_parameters {
2461 $c->prepare_body_parameters;
2462 $c->engine->prepare_parameters( $c, @_ );
2465 =head2 $c->prepare_path
2467 Prepares path and base.
2471 sub prepare_path { my $c = shift; $c->engine->prepare_path( $c, @_ ) }
2473 =head2 $c->prepare_query_parameters
2475 Prepares query parameters.
2479 sub prepare_query_parameters {
2482 $c->engine->prepare_query_parameters( $c, @_ );
2485 =head2 $c->log_request
2487 Writes information about the request to the debug logs. This includes:
2491 =item * Request method, path, and remote IP address
2493 =item * Query keywords (see L<Catalyst::Request/query_keywords>)
2495 =item * Request parameters
2497 =item * File uploads
2506 return unless $c->debug;
2508 my($dump) = grep {$_->[0] eq 'Request' } $c->dump_these;
2509 my $request = $dump->[1];
2511 my ( $method, $path, $address ) = ( $request->method, $request->path, $request->address );
2513 $path = '/' unless length $path;
2516 $path =~ s/%([0-9A-Fa-f]{2})/chr(hex($1))/eg;
2517 $path = decode_utf8($path);
2519 $c->log->debug(qq/"$method" request for "$path" from "$address"/);
2521 $c->log_request_headers($request->headers);
2523 if ( my $keywords = $request->query_keywords ) {
2524 $c->log->debug("Query keywords are: $keywords");
2527 $c->log_request_parameters( query => $request->query_parameters, $request->_has_body ? (body => $request->body_parameters) : () );
2529 $c->log_request_uploads($request);
2532 =head2 $c->log_response
2534 Writes information about the response to the debug logs by calling
2535 C<< $c->log_response_status_line >> and C<< $c->log_response_headers >>.
2542 return unless $c->debug;
2544 my($dump) = grep {$_->[0] eq 'Response' } $c->dump_these;
2545 my $response = $dump->[1];
2547 $c->log_response_status_line($response);
2548 $c->log_response_headers($response->headers);
2551 =head2 $c->log_response_status_line($response)
2553 Writes one line of information about the response to the debug logs. This includes:
2557 =item * Response status code
2559 =item * Content-Type header (if present)
2561 =item * Content-Length header (if present)
2567 sub log_response_status_line {
2568 my ($c, $response) = @_;
2572 'Response Code: %s; Content-Type: %s; Content-Length: %s',
2573 $response->status || 'unknown',
2574 $response->headers->header('Content-Type') || 'unknown',
2575 $response->headers->header('Content-Length') || 'unknown'
2580 =head2 $c->log_response_headers($headers);
2582 Hook method which can be wrapped by plugins to log the response headers.
2583 No-op in the default implementation.
2587 sub log_response_headers {}
2589 =head2 $c->log_request_parameters( query => {}, body => {} )
2591 Logs request parameters to debug logs
2595 sub log_request_parameters {
2597 my %all_params = @_;
2599 return unless $c->debug;
2601 my $column_width = Catalyst::Utils::term_width() - 44;
2602 foreach my $type (qw(query body)) {
2603 my $params = $all_params{$type};
2604 next if ! keys %$params;
2605 my $t = Text::SimpleTable->new( [ 35, 'Parameter' ], [ $column_width, 'Value' ] );
2606 for my $key ( sort keys %$params ) {
2607 my $param = $params->{$key};
2608 my $value = defined($param) ? $param : '';
2609 $t->row( $key, ref $value eq 'ARRAY' ? ( join ', ', @$value ) : $value );
2611 $c->log->debug( ucfirst($type) . " Parameters are:\n" . $t->draw );
2615 =head2 $c->log_request_uploads
2617 Logs file uploads included in the request to the debug logs.
2618 The parameter name, filename, file type, and file size are all included in
2623 sub log_request_uploads {
2625 my $request = shift;
2626 return unless $c->debug;
2627 my $uploads = $request->uploads;
2628 if ( keys %$uploads ) {
2629 my $t = Text::SimpleTable->new(
2630 [ 12, 'Parameter' ],
2635 for my $key ( sort keys %$uploads ) {
2636 my $upload = $uploads->{$key};
2637 for my $u ( ref $upload eq 'ARRAY' ? @{$upload} : ($upload) ) {
2638 $t->row( $key, $u->filename, $u->type, $u->size );
2641 $c->log->debug( "File Uploads are:\n" . $t->draw );
2645 =head2 $c->log_request_headers($headers);
2647 Hook method which can be wrapped by plugins to log the request headers.
2648 No-op in the default implementation.
2652 sub log_request_headers {}
2654 =head2 $c->log_headers($type => $headers)
2656 Logs L<HTTP::Headers> (either request or response) to the debug logs.
2663 my $headers = shift; # an HTTP::Headers instance
2665 return unless $c->debug;
2667 my $column_width = Catalyst::Utils::term_width() - 28;
2668 my $t = Text::SimpleTable->new( [ 15, 'Header Name' ], [ $column_width, 'Value' ] );
2671 my ( $name, $value ) = @_;
2672 $t->row( $name, $value );
2675 $c->log->debug( ucfirst($type) . " Headers:\n" . $t->draw );
2679 =head2 $c->prepare_read
2681 Prepares the input for reading.
2685 sub prepare_read { my $c = shift; $c->engine->prepare_read( $c, @_ ) }
2687 =head2 $c->prepare_request
2689 Prepares the engine request.
2693 sub prepare_request { my $c = shift; $c->engine->prepare_request( $c, @_ ) }
2695 =head2 $c->prepare_uploads
2701 sub prepare_uploads {
2703 $c->engine->prepare_uploads( $c, @_ );
2706 =head2 $c->prepare_write
2708 Prepares the output for writing.
2712 sub prepare_write { my $c = shift; $c->engine->prepare_write( $c, @_ ) }
2714 =head2 $c->request_class
2716 Returns or sets the request class. Defaults to L<Catalyst::Request>.
2718 =head2 $app->request_class_traits
2720 An arrayref of L<Moose::Role>s which are applied to the request class.
2722 =head2 $app->composed_request_class
2724 This is the request class which has been composed with any request_class_traits.
2726 =head2 $c->response_class
2728 Returns or sets the response class. Defaults to L<Catalyst::Response>.
2730 =head2 $app->response_class_traits
2732 An arrayref of L<Moose::Role>s which are applied to the response class.
2734 =head2 $app->composed_response_class
2736 This is the request class which has been composed with any response_class_traits.
2738 =head2 $c->read( [$maxlength] )
2740 Reads a chunk of data from the request body. This method is designed to
2741 be used in a while loop, reading C<$maxlength> bytes on every call.
2742 C<$maxlength> defaults to the size of the request if not specified.
2744 You have to set C<< MyApp->config(parse_on_demand => 1) >> to use this
2747 Warning: If you use read(), Catalyst will not process the body,
2748 so you will not be able to access POST parameters or file uploads via
2749 $c->request. You must handle all body parsing yourself.
2753 sub read { my $c = shift; return $c->request->read( @_ ) }
2763 $app->_make_immutable_if_needed;
2764 $app->engine_loader->needs_psgi_engine_compat_hack ?
2765 $app->engine->run($app, @_) :
2766 $app->engine->run( $app, $app->_finalized_psgi_app, @_ );
2769 sub _make_immutable_if_needed {
2771 my $meta = find_meta($class);
2772 my $isa_ca = $class->isa('Class::Accessor::Fast') || $class->isa('Class::Accessor');
2775 && ! { $meta->immutable_options }->{replace_constructor}
2778 warn("You made your application class ($class) immutable, "
2779 . "but did not inline the\nconstructor. "
2780 . "This will break catalyst, as your app \@ISA "
2781 . "Class::Accessor(::Fast)?\nPlease pass "
2782 . "(replace_constructor => 1)\nwhen making your class immutable.\n");
2784 unless ($meta->is_immutable) {
2785 # XXX - FIXME warning here as you should make your app immutable yourself.
2786 $meta->make_immutable(
2787 replace_constructor => 1,
2792 =head2 $c->set_action( $action, $code, $namespace, $attrs )
2794 Sets an action in a given namespace.
2798 sub set_action { my $c = shift; $c->dispatcher->set_action( $c, @_ ) }
2800 =head2 $c->setup_actions($component)
2802 Sets up actions for a component.
2806 sub setup_actions { my $c = shift; $c->dispatcher->setup_actions( $c, @_ ) }
2808 =head2 $c->setup_components
2810 This method is called internally to set up the application's components.
2812 It finds modules by calling the L<locate_components> method, expands them to
2813 package names with the L<expand_component_module> method, and then installs
2814 each component into the application.
2816 The C<setup_components> config option is passed to both of the above methods.
2818 Installation of each component is performed by the L<setup_component> method,
2823 sub setup_components {
2826 my $config = $class->config->{ setup_components };
2828 my @comps = $class->locate_components($config);
2829 my %comps = map { $_ => 1 } @comps;
2831 my $deprecatedcatalyst_component_names = grep { /::[CMV]::/ } @comps;
2832 $class->log->warn(qq{Your application is using the deprecated ::[MVC]:: type naming scheme.\n}.
2833 qq{Please switch your class names to ::Model::, ::View:: and ::Controller: as appropriate.\n}
2834 ) if $deprecatedcatalyst_component_names;
2836 for my $component ( @comps ) {
2838 # We pass ignore_loaded here so that overlay files for (e.g.)
2839 # Model::DBI::Schema sub-classes are loaded - if it's in @comps
2840 # we know M::P::O found a file on disk so this is safe
2842 Catalyst::Utils::ensure_class_loaded( $component, { ignore_loaded => 1 } );
2845 for my $component (@comps) {
2846 my $instance = $class->components->{ $component } = $class->delayed_setup_component($component);
2849 # Inject a component or wrap a stand alone class in an adaptor. This makes a list
2850 # of named components in the configuration that are not actually existing (not a
2853 my @injected_components = $class->setup_injected_components;
2855 # All components are registered, now we need to 'init' them.
2856 foreach my $component_name (@comps, @injected_components) {
2857 $class->components->{$component_name} = $class->components->{$component_name}->() if
2858 (ref($class->components->{$component_name}) || '') eq 'CODE';
2862 =head2 $app->setup_injected_components
2864 Called by setup_compoents to setup components that are injected.
2868 sub setup_injected_components {
2870 my @injected_components = keys %{$class->config->{inject_components} ||+{}};
2872 foreach my $injected_comp_name(@injected_components) {
2873 $class->setup_injected_component(
2874 $injected_comp_name,
2875 $class->config->{inject_components}->{$injected_comp_name});
2878 return @injected_components;
2881 =head2 $app->setup_injected_component( $injected_component_name, $config )
2883 Setup a given injected component.
2887 sub setup_injected_component {
2888 my ($class, $injected_comp_name, $config) = @_;
2889 if(my $component_class = $config->{from_component}) {
2890 my @roles = @{$config->{roles} ||[]};
2891 Catalyst::Utils::inject_component(
2893 component => $component_class,
2894 (scalar(@roles) ? (traits => \@roles) : ()),
2895 as => $injected_comp_name);
2899 =head2 $app->inject_component($MyApp_Component_name => \%args);
2901 Add a component that is injected at setup:
2903 MyApp->inject_component( 'Model::Foo' => { from_component => 'Common::Foo' } );
2905 Must be called before ->setup. Expects a component name for your
2906 current application and \%args where
2910 =item from_component
2912 The target component being injected into your application
2916 An arrayref of L<Moose::Role>s that are applied to your component.
2922 MyApp->inject_component(
2924 from_component => 'Common::Model::Foo',
2925 roles => ['Role1', 'Role2'],
2928 =head2 $app->inject_components
2930 Inject a list of components:
2932 MyApp->inject_components(
2933 'Model::FooOne' => {
2934 from_component => 'Common::Model::Foo',
2935 roles => ['Role1', 'Role2'],
2937 'Model::FooTwo' => {
2938 from_component => 'Common::Model::Foo',
2939 roles => ['Role1', 'Role2'],
2944 sub inject_component {
2945 my ($app, $name, $args) = @_;
2946 die "Component $name exists" if
2947 $app->config->{inject_components}->{$name};
2948 $app->config->{inject_components}->{$name} = $args;
2951 sub inject_components {
2954 $app->inject_component(shift, shift);
2958 =head2 $c->locate_components( $setup_component_config )
2960 This method is meant to provide a list of component modules that should be
2961 setup for the application. By default, it will use L<Module::Pluggable>.
2963 Specify a C<setup_components> config option to pass additional options directly
2964 to L<Module::Pluggable>. To add additional search paths, specify a key named
2965 C<search_extra> as an array reference. Items in the array beginning with C<::>
2966 will have the application class name prepended to them.
2970 sub locate_components {
2974 my @paths = qw( ::M ::Model ::V ::View ::C ::Controller );
2975 my $extra = delete $config->{ search_extra } || [];
2977 unshift @paths, @$extra;
2979 my @comps = map { sort { length($a) <=> length($b) } Module::Pluggable::Object->new(
2980 search_path => [ map { s/^(?=::)/$class/; $_; } ($_) ],
2982 )->plugins } @paths;
2987 =head2 $c->expand_component_module( $component, $setup_component_config )
2989 Components found by C<locate_components> will be passed to this method, which
2990 is expected to return a list of component (package) names to be set up.
2994 sub expand_component_module {
2995 my ($class, $module) = @_;
2996 return Devel::InnerPackage::list_packages( $module );
2999 =head2 $app->delayed_setup_component
3001 Returns a coderef that points to a setup_component instance. Used
3002 internally for when you want to delay setup until the first time
3003 the component is called.
3007 sub delayed_setup_component {
3008 my($class, $component, @more) = @_;
3010 return my $instance = $class->setup_component($component, @more);
3014 =head2 $c->setup_component
3018 sub setup_component {
3019 my( $class, $component ) = @_;
3021 unless ( $component->can( 'COMPONENT' ) ) {
3025 my $config = $class->config_for($component);
3026 # Stash catalyst_component_name in the config here, so that custom COMPONENT
3027 # methods also pass it. local to avoid pointlessly shitting in config
3028 # for the debug screen, as $component is already the key name.
3029 local $config->{catalyst_component_name} = $component;
3031 my $instance = eval {
3032 $component->COMPONENT( $class, $config );
3036 Catalyst::Exception->throw(
3037 message => qq/Couldn't instantiate component "$component", "$error"/
3041 unless (blessed $instance) {
3042 my $metaclass = Moose::Util::find_meta($component);
3043 my $method_meta = $metaclass->find_method_by_name('COMPONENT');
3044 my $component_method_from = $method_meta->associated_metaclass->name;
3045 my $value = defined($instance) ? $instance : 'undef';
3046 Catalyst::Exception->throw(
3048 qq/Couldn't instantiate component "$component", COMPONENT() method (from $component_method_from) didn't return an object-like value (value was $value)./
3052 my @expanded_components = $instance->can('expand_modules')
3053 ? $instance->expand_modules( $component, $config )
3054 : $class->expand_component_module( $component, $config );
3055 for my $component (@expanded_components) {
3056 next if $class->components->{ $component };
3057 $class->components->{ $component } = $class->setup_component($component);
3063 =head2 $app->config_for( $component_name )
3065 Return the application level configuration (which is not yet merged with any
3066 local component configuration, via $component_class->config) for the named
3067 component or component object. Example:
3070 'Model::Foo' => { a => 1, b => 2},
3073 my $config = MyApp->config_for('MyApp::Model::Foo');
3075 In this case $config is the hashref C< {a=>1, b=>2} >.
3077 This is also handy for looking up configuration for a plugin, to make sure you follow
3078 existing L<Catalyst> standards for where a plugin should put its configuration.
3083 my ($class, $component_name) = @_;
3084 my $component_suffix = Catalyst::Utils::class2classsuffix($component_name);
3085 my $config = $class->config->{ $component_suffix } || {};
3090 =head2 $c->setup_dispatcher
3096 sub setup_dispatcher {
3097 my ( $class, $dispatcher ) = @_;
3100 $dispatcher = 'Catalyst::Dispatcher::' . $dispatcher;
3103 if ( my $env = Catalyst::Utils::env_value( $class, 'DISPATCHER' ) ) {
3104 $dispatcher = 'Catalyst::Dispatcher::' . $env;
3107 unless ($dispatcher) {
3108 $dispatcher = $class->dispatcher_class;
3111 load_class($dispatcher);
3113 # dispatcher instance
3114 $class->dispatcher( $dispatcher->new );
3117 =head2 $c->setup_engine
3124 my ($class, $requested_engine) = @_;
3126 if (!$class->engine_loader || $requested_engine) {
3127 $class->engine_loader(
3128 Catalyst::EngineLoader->new({
3129 application_name => $class,
3130 (defined $requested_engine
3131 ? (catalyst_engine_class => $requested_engine) : ()),
3136 $class->engine_loader->catalyst_engine_class;
3140 my ($class, $requested_engine) = @_;
3143 my $loader = $class->engine_loader;
3145 if (!$loader || $requested_engine) {
3146 $loader = Catalyst::EngineLoader->new({
3147 application_name => $class,
3148 (defined $requested_engine
3149 ? (requested_engine => $requested_engine) : ()),
3152 $class->engine_loader($loader);
3155 $loader->catalyst_engine_class;
3158 # Don't really setup_engine -- see _setup_psgi_app for explanation.
3159 return if $class->loading_psgi_file;
3161 load_class($engine);
3163 if ($ENV{MOD_PERL}) {
3164 my $apache = $class->engine_loader->auto;
3166 my $meta = find_meta($class);
3167 my $was_immutable = $meta->is_immutable;
3168 my %immutable_options = $meta->immutable_options;
3169 $meta->make_mutable if $was_immutable;
3171 $meta->add_method(handler => sub {
3173 my $psgi_app = $class->_finalized_psgi_app;
3174 $apache->call_app($r, $psgi_app);
3177 $meta->make_immutable(%immutable_options) if $was_immutable;
3180 $class->engine( $engine->new );
3185 ## This exists just to supply a prebuild psgi app for mod_perl and for the
3186 ## build in server support (back compat support for pre psgi port behavior).
3187 ## This is so that we don't build a new psgi app for each request when using
3188 ## the mod_perl handler or the built in servers (http and fcgi, etc).
3190 sub _finalized_psgi_app {
3193 unless ($app->_psgi_app) {
3194 my $psgi_app = $app->_setup_psgi_app;
3195 $app->_psgi_app($psgi_app);
3198 return $app->_psgi_app;
3201 ## Look for a psgi file like 'myapp_web.psgi' (if the app is MyApp::Web) in the
3202 ## home directory and load that and return it (just assume it is doing the
3203 ## right thing :) ). If that does not exist, call $app->psgi_app, wrap that
3204 ## in default_middleware and return it ( this is for backward compatibility
3205 ## with pre psgi port behavior ).
3207 sub _setup_psgi_app {
3210 for my $home (Path::Class::Dir->new($app->config->{home})) {
3211 my $psgi_file = $home->file(
3212 Catalyst::Utils::appprefix($app) . '.psgi',
3215 next unless -e $psgi_file;
3217 # If $psgi_file calls ->setup_engine, it's doing so to load
3218 # Catalyst::Engine::PSGI. But if it does that, we're only going to
3219 # throw away the loaded PSGI-app and load the 5.9 Catalyst::Engine
3220 # anyway. So set a flag (ick) that tells setup_engine not to populate
3221 # $c->engine or do any other things we might regret.
3223 $app->loading_psgi_file(1);
3224 my $psgi_app = Plack::Util::load_psgi($psgi_file);
3225 $app->loading_psgi_file(0);
3228 unless $app->engine_loader->needs_psgi_engine_compat_hack;
3231 Found a legacy Catalyst::Engine::PSGI .psgi file at ${psgi_file}.
3233 Its content has been ignored. Please consult the Catalyst::Upgrading
3234 documentation on how to upgrade from Catalyst::Engine::PSGI.
3238 return $app->apply_default_middlewares($app->psgi_app);
3241 =head2 $c->apply_default_middlewares
3243 Adds the following L<Plack> middlewares to your application, since they are
3244 useful and commonly needed:
3246 L<Plack::Middleware::LighttpdScriptNameFix> (if you are using Lighttpd),
3247 L<Plack::Middleware::IIS6ScriptNameFix> (always applied since this middleware
3248 is smart enough to conditionally apply itself).
3250 We will also automatically add L<Plack::Middleware::ReverseProxy> if we notice
3251 that your HTTP $env variable C<REMOTE_ADDR> is '127.0.0.1'. This is usually
3252 an indication that your server is running behind a proxy frontend. However in
3253 2014 this is often not the case. We preserve this code for backwards compatibility
3254 however I B<highly> recommend that if you are running the server behind a front
3255 end proxy that you clearly indicate so with the C<using_frontend_proxy> configuration
3256 setting to true for your environment configurations that run behind a proxy. This
3257 way if you change your front end proxy address someday your code would inexplicably
3258 stop working as expected.
3260 Additionally if we detect we are using Nginx, we add a bit of custom middleware
3261 to solve some problems with the way that server handles $ENV{PATH_INFO} and
3264 Please B<NOTE> that if you do use C<using_frontend_proxy> the middleware is now
3265 adding via C<registered_middleware> rather than this method.
3267 If you are using Lighttpd or IIS6 you may wish to apply these middlewares. In
3268 general this is no longer a common case but we have this here for backward
3274 sub apply_default_middlewares {
3275 my ($app, $psgi_app) = @_;
3277 # Don't add this conditional IF we are explicitly saying we want the
3278 # frontend proxy support. We don't need it here since if that is the
3279 # case it will be always loaded in the default_middleware.
3281 unless($app->config->{using_frontend_proxy}) {
3282 $psgi_app = Plack::Middleware::Conditional->wrap(
3284 builder => sub { Plack::Middleware::ReverseProxy->wrap($_[0]) },
3287 return if $app->config->{ignore_frontend_proxy};
3288 return $env->{REMOTE_ADDR} eq '127.0.0.1';
3293 # If we're running under Lighttpd, swap PATH_INFO and SCRIPT_NAME
3294 # http://lists.scsys.co.uk/pipermail/catalyst/2006-June/008361.html
3295 $psgi_app = Plack::Middleware::Conditional->wrap(
3297 builder => sub { Plack::Middleware::LighttpdScriptNameFix->wrap($_[0]) },
3300 return unless $env->{SERVER_SOFTWARE} && $env->{SERVER_SOFTWARE} =~ m!lighttpd[-/]1\.(\d+\.\d+)!;
3301 return unless $1 < 4.23;
3306 # we're applying this unconditionally as the middleware itself already makes
3307 # sure it doesn't fuck things up if it's not running under one of the right
3309 $psgi_app = Plack::Middleware::IIS6ScriptNameFix->wrap($psgi_app);
3311 # And another IIS issue, this time with IIS7.
3312 $psgi_app = Plack::Middleware::Conditional->wrap(
3314 builder => sub { Plack::Middleware::IIS7KeepAliveFix->wrap($_[0]) },
3317 return $env->{SERVER_SOFTWARE} && $env->{SERVER_SOFTWARE} =~ m!IIS/7\.[0-9]!;
3324 =head2 App->psgi_app
3328 Returns a PSGI application code reference for the catalyst application
3329 C<$c>. This is the bare application created without the C<apply_default_middlewares>
3330 method called. We do however apply C<registered_middleware> since those are
3331 integral to how L<Catalyst> functions. Also, unlike starting your application
3332 with a generated server script (via L<Catalyst::Devel> and C<catalyst.pl>) we do
3333 not attempt to return a valid L<PSGI> application using any existing C<${myapp}.psgi>
3334 scripts in your $HOME directory.
3336 B<NOTE> C<apply_default_middlewares> was originally created when the first PSGI
3337 port was done for v5.90000. These are middlewares that are added to achieve
3338 backward compatibility with older applications. If you start your application
3339 using one of the supplied server scripts (generated with L<Catalyst::Devel> and
3340 the project skeleton script C<catalyst.pl>) we apply C<apply_default_middlewares>
3341 automatically. This was done so that pre and post PSGI port applications would
3344 This is what you want to be using to retrieve the PSGI application code
3345 reference of your Catalyst application for use in a custom F<.psgi> or in your
3346 own created server modules.
3350 *to_app = \&psgi_app;
3354 my $psgi = $app->engine->build_psgi_app($app);
3355 return $app->Catalyst::Utils::apply_registered_middleware($psgi);
3358 =head2 $c->setup_home
3360 Sets up the home directory.
3365 my ( $class, $home ) = @_;
3367 if ( my $env = Catalyst::Utils::env_value( $class, 'HOME' ) ) {
3371 $home ||= Catalyst::Utils::home($class);
3374 #I remember recently being scolded for assigning config values like this
3375 $class->config->{home} ||= $home;
3376 $class->config->{root} ||= Path::Class::Dir->new($home)->subdir('root');
3380 =head2 $c->setup_encoding
3382 Sets up the input/output encoding. See L<ENCODING>
3386 sub setup_encoding {
3388 if( exists($c->config->{encoding}) && !defined($c->config->{encoding}) ) {
3389 # Ok, so the user has explicitly said "I don't want encoding..."
3392 my $enc = defined($c->config->{encoding}) ?
3393 delete $c->config->{encoding} : 'UTF-8'; # not sure why we delete it... (JNAP)
3398 =head2 handle_unicode_encoding_exception
3400 Hook to let you customize how encoding errors are handled. By default
3401 we just throw an exception. Receives a hashref of debug information.
3404 $c->handle_unicode_encoding_exception({
3405 param_value => $value,
3407 encoding_step => 'params',
3412 sub handle_unicode_encoding_exception {
3413 my ( $self, $exception_ctx ) = @_;
3414 die $exception_ctx->{error_msg};
3417 # Some unicode helpers cargo culted from the old plugin. These could likely
3420 sub _handle_unicode_decoding {
3421 my ( $self, $value ) = @_;
3423 return unless defined $value;
3425 ## I think this mess is to support the old nested
3426 if ( ref $value eq 'ARRAY' ) {
3427 foreach ( @$value ) {
3428 $_ = $self->_handle_unicode_decoding($_);
3432 elsif ( ref $value eq 'HASH' ) {
3433 foreach (keys %$value) {
3434 my $encoded_key = $self->_handle_param_unicode_decoding($_);
3435 $value->{$encoded_key} = $self->_handle_unicode_decoding($value->{$_});
3437 # If the key was encoded we now have two (the original and current so
3438 # delete the original.
3439 delete $value->{$_} if $_ ne $encoded_key;
3444 return $self->_handle_param_unicode_decoding($value);
3448 sub _handle_param_unicode_decoding {
3449 my ( $self, $value ) = @_;
3450 return unless defined $value; # not in love with just ignoring undefs - jnap
3451 return $value if blessed($value); #don't decode when the value is an object.
3453 my $enc = $self->encoding;
3455 $enc->decode( $value, $self->_encode_check );
3458 $self->handle_unicode_encoding_exception({
3459 param_value => $value,
3461 encoding_step => 'params',
3466 =head2 $c->setup_log
3468 Sets up log by instantiating a L<Catalyst::Log|Catalyst::Log> object and
3469 passing it to C<log()>. Pass in a comma-delimited list of levels to set the
3472 This method also installs a C<debug> method that returns a true value into the
3473 catalyst subclass if the "debug" level is passed in the comma-delimited list,
3474 or if the C<$CATALYST_DEBUG> environment variable is set to a true value.
3476 Note that if the log has already been setup, by either a previous call to
3477 C<setup_log> or by a call such as C<< __PACKAGE__->log( MyLogger->new ) >>,
3478 that this method won't actually set up the log object.
3483 my ( $class, $levels ) = @_;
3486 $levels =~ s/^\s+//;
3487 $levels =~ s/\s+$//;
3488 my %levels = map { $_ => 1 } split /\s*,\s*/, $levels;
3490 my $env_debug = Catalyst::Utils::env_value( $class, 'DEBUG' );
3491 if ( defined $env_debug ) {
3492 $levels{debug} = 1 if $env_debug; # Ugly!
3493 delete($levels{debug}) unless $env_debug;
3496 unless ( $class->log ) {
3497 $class->log( Catalyst::Log->new(keys %levels) );
3500 if ( $levels{debug} ) {
3501 Class::MOP::get_metaclass_by_name($class)->add_method('debug' => sub { 1 });
3502 $class->log->debug('Debug messages enabled');
3506 =head2 $c->setup_plugins
3512 =head2 $c->setup_stats
3514 Sets up timing statistics class.
3519 my ( $class, $stats ) = @_;
3521 Catalyst::Utils::ensure_class_loaded($class->stats_class);
3523 my $env = Catalyst::Utils::env_value( $class, 'STATS' );
3524 if ( defined($env) ? $env : ($stats || $class->debug ) ) {
3525 Class::MOP::get_metaclass_by_name($class)->add_method('use_stats' => sub { 1 });
3526 $class->log->debug('Statistics enabled');
3531 =head2 $c->registered_plugins
3533 Returns a sorted list of the plugins which have either been stated in the
3536 If passed a given plugin name, it will report a boolean value indicating
3537 whether or not that plugin is loaded. A fully qualified name is required if
3538 the plugin name does not begin with C<Catalyst::Plugin::>.
3540 if ($c->registered_plugins('Some::Plugin')) {
3548 sub registered_plugins {
3550 return sort keys %{ $proto->_plugins } unless @_;
3552 return 1 if exists $proto->_plugins->{$plugin};
3553 return exists $proto->_plugins->{"Catalyst::Plugin::$plugin"};
3556 sub _register_plugin {
3557 my ( $proto, $plugin, $instant ) = @_;
3558 my $class = ref $proto || $proto;
3560 load_class( $plugin );
3561 $class->log->warn( "$plugin inherits from 'Catalyst::Component' - this is deprecated and will not work in 5.81" )
3562 if $plugin->isa( 'Catalyst::Component' );
3563 my $plugin_meta = Moose::Meta::Class->create($plugin);
3564 if (!$plugin_meta->has_method('new')
3565 && ( $plugin->isa('Class::Accessor::Fast') || $plugin->isa('Class::Accessor') ) ) {
3566 $plugin_meta->add_method('new', Moose::Object->meta->get_method('new'))
3568 if (!$instant && !$proto->_plugins->{$plugin}) {
3569 my $meta = Class::MOP::get_metaclass_by_name($class);
3570 $meta->superclasses($plugin, $meta->superclasses);
3572 $proto->_plugins->{$plugin} = 1;
3576 sub _default_plugins { return qw() }
3579 my ( $class, $plugins ) = @_;
3581 $class->_plugins( {} ) unless $class->_plugins;
3583 m/Unicode::Encoding/ ? do {
3585 'Unicode::Encoding plugin is auto-applied,'
3586 . ' please remove this from your appclass'
3587 . ' and make sure to define "encoding" config'
3589 unless (exists $class->config->{'encoding'}) {
3590 $class->config->{'encoding'} = 'UTF-8';
3595 push @$plugins, $class->_default_plugins;
3596 $plugins = Data::OptList::mkopt($plugins || []);
3599 [ Catalyst::Utils::resolve_namespace(
3600 $class . '::Plugin',
3601 'Catalyst::Plugin', $_->[0]
3607 for my $plugin ( reverse @plugins ) {
3608 load_class($plugin->[0], $plugin->[1]);
3609 my $meta = find_meta($plugin->[0]);
3610 next if $meta && $meta->isa('Moose::Meta::Role');
3612 $class->_register_plugin($plugin->[0]);
3616 map { $_->[0]->name, $_->[1] }
3617 grep { blessed($_->[0]) && $_->[0]->isa('Moose::Meta::Role') }
3618 map { [find_meta($_->[0]), $_->[1]] }
3621 Moose::Util::apply_all_roles(
3627 =head2 default_middleware
3629 Returns a list of instantiated PSGI middleware objects which is the default
3630 middleware that is active for this application (taking any configuration
3631 options into account, excluding your custom added middleware via the C<psgi_middleware>
3632 configuration option). You can override this method if you wish to change
3633 the default middleware (although do so at risk since some middleware is vital
3634 to application function.)
3636 The current default middleware list is:
3638 Catalyst::Middleware::Stash
3639 Plack::Middleware::HTTPExceptions
3640 Plack::Middleware::RemoveRedundantBody
3641 Plack::Middleware::FixMissingBodyInRedirect
3642 Plack::Middleware::ContentLength
3643 Plack::Middleware::MethodOverride
3644 Plack::Middleware::Head
3646 If the configuration setting C<using_frontend_proxy> is true we add:
3648 Plack::Middleware::ReverseProxy
3650 If the configuration setting C<using_frontend_proxy_path> is true we add:
3652 Plack::Middleware::ReverseProxyPath
3654 But B<NOTE> that L<Plack::Middleware::ReverseProxyPath> is not a dependency of the
3655 L<Catalyst> distribution so if you want to use this option you should add it to
3656 your project distribution file.
3658 These middlewares will be added at L</setup_middleware> during the
3659 L</setup> phase of application startup.
3663 sub default_middleware {
3666 Catalyst::Middleware::Stash->new,
3667 Plack::Middleware::HTTPExceptions->new,
3668 Plack::Middleware::RemoveRedundantBody->new,
3669 Plack::Middleware::FixMissingBodyInRedirect->new,
3670 Plack::Middleware::ContentLength->new,
3671 Plack::Middleware::MethodOverride->new,
3672 Plack::Middleware::Head->new);
3674 if($class->config->{using_frontend_proxy}) {
3675 push @mw, Plack::Middleware::ReverseProxy->new;
3678 if($class->config->{using_frontend_proxy_path}) {
3679 if(Class::Load::try_load_class('Plack::Middleware::ReverseProxyPath')) {
3680 push @mw, Plack::Middleware::ReverseProxyPath->new;
3682 $class->log->error("Cannot use configuration 'using_frontend_proxy_path' because 'Plack::Middleware::ReverseProxyPath' is not installed");
3689 =head2 registered_middlewares
3691 Read only accessor that returns an array of all the middleware in the order
3692 that they were added (which is the REVERSE of the order they will be applied).
3694 The values returned will be either instances of L<Plack::Middleware> or of a
3695 compatible interface, or a coderef, which is assumed to be inlined middleware
3697 =head2 setup_middleware (?@middleware)
3699 Read configuration information stored in configuration key C<psgi_middleware> or
3702 See under L</CONFIGURATION> information regarding C<psgi_middleware> and how
3703 to use it to enable L<Plack::Middleware>
3705 This method is automatically called during 'setup' of your application, so
3706 you really don't need to invoke it. However you may do so if you find the idea
3707 of loading middleware via configuration weird :). For example:
3713 __PACKAGE__->setup_middleware('Head');
3716 When we read middleware definitions from configuration, we reverse the list
3717 which sounds odd but is likely how you expect it to work if you have prior
3718 experience with L<Plack::Builder> or if you previously used the plugin
3719 L<Catalyst::Plugin::EnableMiddleware> (which is now considered deprecated)
3721 So basically your middleware handles an incoming request from the first
3722 registered middleware, down and handles the response from the last middleware
3727 sub registered_middlewares {
3729 if(my $middleware = $class->_psgi_middleware) {
3730 my @mw = ($class->default_middleware, @$middleware);
3732 if($class->config->{using_frontend_proxy}) {
3733 push @mw, Plack::Middleware::ReverseProxy->new;
3738 die "You cannot call ->registered_middlewares until middleware has been setup";
3742 sub setup_middleware {
3744 my @middleware_definitions;
3746 # If someone calls this method you can add middleware with args. However if its
3747 # called without an arg we need to setup the configuration middleware.
3749 @middleware_definitions = reverse(@_);
3751 @middleware_definitions = reverse(@{$class->config->{'psgi_middleware'}||[]})
3752 unless $class->finalized_default_middleware;
3753 $class->finalized_default_middleware(1); # Only do this once, just in case some people call setup over and over...
3756 my @middleware = ();
3757 while(my $next = shift(@middleware_definitions)) {
3759 if(Scalar::Util::blessed $next && $next->can('wrap')) {
3760 push @middleware, $next;
3761 } elsif(ref $next eq 'CODE') {
3762 push @middleware, $next;
3763 } elsif(ref $next eq 'HASH') {
3764 my $namespace = shift @middleware_definitions;
3765 my $mw = $class->Catalyst::Utils::build_middleware($namespace, %$next);
3766 push @middleware, $mw;
3768 die "I can't handle middleware definition ${\ref $next}";
3771 my $mw = $class->Catalyst::Utils::build_middleware($next);
3772 push @middleware, $mw;
3776 my @existing = @{$class->_psgi_middleware || []};
3777 $class->_psgi_middleware([@middleware,@existing,]);
3780 =head2 registered_data_handlers
3782 A read only copy of registered Data Handlers returned as a Hash, where each key
3783 is a content type and each value is a subref that attempts to decode that content
3786 =head2 setup_data_handlers (?@data_handler)
3788 Read configuration information stored in configuration key C<data_handlers> or
3791 See under L</CONFIGURATION> information regarding C<data_handlers>.
3793 This method is automatically called during 'setup' of your application, so
3794 you really don't need to invoke it.
3796 =head2 default_data_handlers
3798 Default Data Handlers that come bundled with L<Catalyst>. Currently there are
3799 only two default data handlers, for 'application/json' and an alternative to
3800 'application/x-www-form-urlencoded' which supposed nested form parameters via
3801 L<CGI::Struct> or via L<CGI::Struct::XS> IF you've installed it.
3803 The 'application/json' data handler is used to parse incoming JSON into a Perl
3804 data structure. It used either L<JSON::MaybeXS> or L<JSON>, depending on which
3805 is installed. This allows you to fail back to L<JSON:PP>, which is a Pure Perl
3806 JSON decoder, and has the smallest dependency impact.
3808 Because we don't wish to add more dependencies to L<Catalyst>, if you wish to
3809 use this new feature we recommend installing L<JSON> or L<JSON::MaybeXS> in
3810 order to get the best performance. You should add either to your dependency
3811 list (Makefile.PL, dist.ini, cpanfile, etc.)
3815 sub registered_data_handlers {
3817 if(my $data_handlers = $class->_data_handlers) {
3818 return %$data_handlers;
3820 $class->setup_data_handlers;
3821 return $class->registered_data_handlers;
3825 sub setup_data_handlers {
3826 my ($class, %data_handler_callbacks) = @_;
3827 %data_handler_callbacks = (
3828 %{$class->default_data_handlers},
3829 %{$class->config->{'data_handlers'}||+{}},
3830 %data_handler_callbacks);
3832 $class->_data_handlers(\%data_handler_callbacks);
3835 sub default_data_handlers {
3838 'application/x-www-form-urlencoded' => sub {
3839 my ($fh, $req) = @_;
3840 my $params = $req->_use_hash_multivalue ? $req->body_parameters->mixed : $req->body_parameters;
3841 Class::Load::load_first_existing_class('CGI::Struct::XS', 'CGI::Struct')
3842 ->can('build_cgi_struct')->($params);
3844 'application/json' => sub {
3845 my ($fh, $req) = @_;
3846 my $parser = Class::Load::load_first_existing_class('JSON::MaybeXS', 'JSON');
3850 $slurped = $fh->getline;
3851 $parser->can("decode_json")->($slurped); # decode_json does utf8 decoding for us
3852 } || Catalyst::Exception->throw(sprintf "Error Parsing POST '%s', Error: %s", (defined($slurped) ? $slurped : 'undef') ,$@);
3857 sub _handle_http_exception {
3858 my ( $self, $error ) = @_;
3860 !$self->config->{always_catch_http_exceptions}
3863 $error->can('as_psgi')
3864 || ( $error->can('code')
3865 && $error->code =~ m/^[1-5][0-9][0-9]$/ )
3875 Returns an arrayref of the internal execution stack (actions that are
3876 currently executing).
3880 Returns the current timing statistics object. By default Catalyst uses
3881 L<Catalyst::Stats|Catalyst::Stats>, but can be set otherwise with
3882 L<< stats_class|/"$c->stats_class" >>.
3884 Even if L<< -Stats|/"-Stats" >> is not enabled, the stats object is still
3885 available. By enabling it with C< $c->stats->enabled(1) >, it can be used to
3886 profile explicitly, although MyApp.pm still won't profile nor output anything
3889 =head2 $c->stats_class
3891 Returns or sets the stats (timing statistics) class. L<Catalyst::Stats|Catalyst::Stats> is used by default.
3893 =head2 $app->stats_class_traits
3895 A arrayref of L<Moose::Role>s that are applied to the stats_class before creating it.
3897 =head2 $app->composed_stats_class
3899 this is the stats_class composed with any 'stats_class_traits'.
3901 =head2 $c->use_stats
3903 Returns 1 when L<< stats collection|/"-Stats" >> is enabled.
3905 Note that this is a static method, not an accessor and should be overridden
3906 by declaring C<sub use_stats { 1 }> in your MyApp.pm, not by calling C<< $c->use_stats(1) >>.
3913 =head2 $c->write( $data )
3915 Writes $data to the output stream. When using this method directly, you
3916 will need to manually set the C<Content-Length> header to the length of
3917 your output data, if known.
3924 # Finalize headers if someone manually writes output (for compat)
3925 $c->finalize_headers;
3927 return $c->response->write( @_ );
3932 Returns the Catalyst version number. Mostly useful for "powered by"
3933 messages in template systems.
3937 sub version { return $Catalyst::VERSION }
3939 =head1 CONFIGURATION
3941 There are a number of 'base' config variables which can be set:
3947 C<always_catch_http_exceptions> - As of version 5.90060 Catalyst
3948 rethrows errors conforming to the interface described by
3949 L<Plack::Middleware::HTTPExceptions> and lets the middleware deal with it.
3950 Set true to get the deprecated behaviour and have Catalyst catch HTTP exceptions.
3954 C<default_model> - The default model picked if you say C<< $c->model >>. See L<< /$c->model($name) >>.
3958 C<default_view> - The default view to be rendered or returned when C<< $c->view >> is called. See L<< /$c->view($name) >>.
3962 C<disable_component_resolution_regex_fallback> - Turns
3963 off the deprecated component resolution functionality so
3964 that if any of the component methods (e.g. C<< $c->controller('Foo') >>)
3965 are called then regex search will not be attempted on string values and
3966 instead C<undef> will be returned.
3970 C<home> - The application home directory. In an uninstalled application,
3971 this is the top level application directory. In an installed application,
3972 this will be the directory containing C<< MyApp.pm >>.
3976 C<ignore_frontend_proxy> - See L</PROXY SUPPORT>
3980 C<name> - The name of the application in debug messages and the debug and
3985 C<parse_on_demand> - The request body (for example file uploads) will not be parsed
3986 until it is accessed. This allows you to (for example) check authentication (and reject
3987 the upload) before actually receiving all the data. See L</ON-DEMAND PARSER>
3991 C<root> - The root directory for templates. Usually this is just a
3992 subdirectory of the home directory, but you can set it to change the
3993 templates to a different directory.
3997 C<search_extra> - Array reference passed to Module::Pluggable to for additional
3998 namespaces from which components will be loaded (and constructed and stored in
3999 C<< $c->components >>).
4003 C<show_internal_actions> - If true, causes internal actions such as C<< _DISPATCH >>
4004 to be shown in hit debug tables in the test server.
4008 C<use_request_uri_for_path> - Controls if the C<REQUEST_URI> or C<PATH_INFO> environment
4009 variable should be used for determining the request path.
4011 Most web server environments pass the requested path to the application using environment variables,
4012 from which Catalyst has to reconstruct the request base (i.e. the top level path to / in the application,
4013 exposed as C<< $c->request->base >>) and the request path below that base.
4015 There are two methods of doing this, both of which have advantages and disadvantages. Which method is used
4016 is determined by the C<< $c->config(use_request_uri_for_path) >> setting (which can either be true or false).
4020 =item use_request_uri_for_path => 0
4022 This is the default (and the) traditional method that Catalyst has used for determining the path information.
4023 The path is generated from a combination of the C<PATH_INFO> and C<SCRIPT_NAME> environment variables.
4024 The allows the application to behave correctly when C<mod_rewrite> is being used to redirect requests
4025 into the application, as these variables are adjusted by mod_rewrite to take account for the redirect.
4027 However this method has the major disadvantage that it is impossible to correctly decode some elements
4028 of the path, as RFC 3875 says: "C<< Unlike a URI path, the PATH_INFO is not URL-encoded, and cannot
4029 contain path-segment parameters. >>" This means PATH_INFO is B<always> decoded, and therefore Catalyst
4030 can't distinguish / vs %2F in paths (in addition to other encoded values).
4032 =item use_request_uri_for_path => 1
4034 This method uses the C<REQUEST_URI> and C<SCRIPT_NAME> environment variables. As C<REQUEST_URI> is never
4035 decoded, this means that applications using this mode can correctly handle URIs including the %2F character
4036 (i.e. with C<AllowEncodedSlashes> set to C<On> in Apache).
4038 Given that this method of path resolution is provably more correct, it is recommended that you use
4039 this unless you have a specific need to deploy your application in a non-standard environment, and you are
4040 aware of the implications of not being able to handle encoded URI paths correctly.
4042 However it also means that in a number of cases when the app isn't installed directly at a path, but instead
4043 is having paths rewritten into it (e.g. as a .cgi/fcgi in a public_html directory, with mod_rewrite in a
4044 .htaccess file, or when SSI is used to rewrite pages into the app, or when sub-paths of the app are exposed
4045 at other URIs than that which the app is 'normally' based at with C<mod_rewrite>), the resolution of
4046 C<< $c->request->base >> will be incorrect.
4052 C<using_frontend_proxy> - See L</PROXY SUPPORT>.
4056 C<using_frontend_proxy_path> - Enabled L<Plack::Middleware::ReverseProxyPath> on your application (if
4057 installed, otherwise log an error). This is useful if your application is not running on the
4058 'root' (or /) of your host server. B<NOTE> if you use this feature you should add the required
4059 middleware to your project dependency list since its not automatically a dependency of L<Catalyst>.
4060 This has been done since not all people need this feature and we wish to restrict the growth of
4061 L<Catalyst> dependencies.
4065 C<encoding> - See L</ENCODING>
4067 This now defaults to 'UTF-8'. You my turn it off by setting this configuration
4072 C<abort_chain_on_error_fix>
4074 When there is an error in an action chain, the default behavior is to continue
4075 processing the remaining actions and then catch the error upon chain end. This
4076 can lead to running actions when the application is in an unexpected state. If
4077 you have this issue, setting this config value to true will promptly exit a
4078 chain when there is an error raised in any action (thus terminating the chain
4083 __PACKAGE__->config(abort_chain_on_error_fix => 1);
4085 In the future this might become the default behavior.
4089 C<use_hash_multivalue_in_request>
4091 In L<Catalyst::Request> the methods C<query_parameters>, C<body_parametes>
4092 and C<parameters> return a hashref where values might be scalar or an arrayref
4093 depending on the incoming data. In many cases this can be undesirable as it
4094 leads one to writing defensive code like the following:
4096 my ($val) = ref($c->req->parameters->{a}) ?
4097 @{$c->req->parameters->{a}} :
4098 $c->req->parameters->{a};
4100 Setting this configuration item to true will make L<Catalyst> populate the
4101 attributes underlying these methods with an instance of L<Hash::MultiValue>
4102 which is used by L<Plack::Request> and others to solve this very issue. You
4103 may prefer this behavior to the default, if so enable this option (be warned
4104 if you enable it in a legacy application we are not sure if it is completely
4105 backwardly compatible).
4109 C<skip_complex_post_part_handling>
4111 When creating body parameters from a POST, if we run into a multpart POST
4112 that does not contain uploads, but instead contains inlined complex data
4113 (very uncommon) we cannot reliably convert that into field => value pairs. So
4114 instead we create an instance of L<Catalyst::Request::PartData>. If this causes
4115 issue for you, you can disable this by setting C<skip_complex_post_part_handling>
4116 to true (default is false).
4120 C<skip_body_param_unicode_decoding>
4122 Generally we decode incoming POST params based on your declared encoding (the
4123 default for this is to decode UTF-8). If this is causing you trouble and you
4124 do not wish to turn all encoding support off (with the C<encoding> configuration
4125 parameter) you may disable this step atomically by setting this configuration
4130 C<do_not_decode_query>
4132 If true, then do not try to character decode any wide characters in your
4133 request URL query or keywords. Most readings of the relevent specifications
4134 suggest these should be UTF-* encoded, which is the default that L<Catalyst>
4135 will use, hwoever if you are creating a lot of URLs manually or have external
4136 evil clients, this might cause you trouble. If you find the changes introduced
4137 in Catalyst version 5.90080+ break some of your query code, you may disable
4138 the UTF-8 decoding globally using this configuration.
4140 This setting takes precedence over C<default_query_encoding> and
4141 C<decode_query_using_global_encoding>
4145 C<default_query_encoding>
4147 By default we decode query and keywords in your request URL using UTF-8, which
4148 is our reading of the relevent specifications. This setting allows one to
4149 specify a fixed value for how to decode your query. You might need this if
4150 you are doing a lot of custom encoding of your URLs and not using UTF-8.
4152 This setting take precedence over C<decode_query_using_global_encoding>.
4156 C<decode_query_using_global_encoding>
4158 Setting this to true will default your query decoding to whatever your
4159 general global encoding is (the default is UTF-8).
4163 C<use_chained_args_0_special_case>
4165 In older versions of Catalyst, when more than one action matched the same path
4166 AND all those matching actions declared Args(0), we'd break the tie by choosing
4167 the first action defined. We now normalized how Args(0) works so that it
4168 follows the same rule as Args(N), which is to say when we need to break a tie
4169 we choose the LAST action defined. If this breaks your code and you don't
4170 have time to update to follow the new normalized approach, you may set this
4171 value to true and it will globally revert to the original chaining behavior.
4175 C<psgi_middleware> - See L<PSGI MIDDLEWARE>.
4179 C<data_handlers> - See L<DATA HANDLERS>.
4183 C<stats_class_traits>
4185 An arrayref of L<Moose::Role>s that get componsed into your stats class.
4189 C<request_class_traits>
4191 An arrayref of L<Moose::Role>s that get componsed into your request class.
4195 C<response_class_traits>
4197 An arrayref of L<Moose::Role>s that get componsed into your response class.
4201 C<inject_components>
4203 A Hashref of L<Catalyst::Component> subclasses that are 'injected' into configuration.
4207 inject_components => {
4208 'Controller::Err' => { from_component => 'Local::Controller::Errors' },
4209 'Model::Zoo' => { from_component => 'Local::Model::Foo' },
4210 'Model::Foo' => { from_component => 'Local::Model::Foo', roles => ['TestRole'] },
4212 'Controller::Err' => { a => 100, b=>200, namespace=>'error' },
4213 'Model::Zoo' => { a => 2 },
4214 'Model::Foo' => { a => 100 },
4217 Generally L<Catalyst> looks for components in your Model/View or Controller directories.
4218 However for cases when you which to use an existing component and you don't need any
4219 customization (where for when you can apply a role to customize it) you may inject those
4220 components into your application. Please note any configuration should be done 'in the
4221 normal way', with a key under configuration named after the component affix, as in the
4224 Using this type of injection allows you to construct significant amounts of your application
4225 with only configuration!. This may or may not lead to increased code understanding.
4227 Please not you may also call the ->inject_components application method as well, although
4228 you must do so BEFORE setup.
4234 Generally when you throw an exception inside an Action (or somewhere in
4235 your stack, such as in a model that an Action is calling) that exception
4236 is caught by Catalyst and unless you either catch it yourself (via eval
4237 or something like L<Try::Tiny> or by reviewing the L</error> stack, it
4238 will eventually reach L</finalize_errors> and return either the debugging
4239 error stack page, or the default error page. However, if your exception
4240 can be caught by L<Plack::Middleware::HTTPExceptions>, L<Catalyst> will
4241 instead rethrow it so that it can be handled by that middleware (which
4242 is part of the default middleware). For example this would allow
4244 use HTTP::Throwable::Factory 'http_throw';
4246 sub throws_exception :Local {
4247 my ($self, $c) = @_;
4249 http_throw(SeeOther => { location =>
4250 $c->uri_for($self->action_for('redirect')) });
4254 =head1 INTERNAL ACTIONS
4256 Catalyst uses internal actions like C<_DISPATCH>, C<_BEGIN>, C<_AUTO>,
4257 C<_ACTION>, and C<_END>. These are by default not shown in the private
4258 action table, but you can make them visible with a config parameter.
4260 MyApp->config(show_internal_actions => 1);
4262 =head1 ON-DEMAND PARSER
4264 The request body is usually parsed at the beginning of a request,
4265 but if you want to handle input yourself, you can enable on-demand
4266 parsing with a config parameter.
4268 MyApp->config(parse_on_demand => 1);
4270 =head1 PROXY SUPPORT
4272 Many production servers operate using the common double-server approach,
4273 with a lightweight frontend web server passing requests to a larger
4274 backend server. An application running on the backend server must deal
4275 with two problems: the remote user always appears to be C<127.0.0.1> and
4276 the server's hostname will appear to be C<localhost> regardless of the
4277 virtual host that the user connected through.
4279 Catalyst will automatically detect this situation when you are running
4280 the frontend and backend servers on the same machine. The following
4281 changes are made to the request.
4283 $c->req->address is set to the user's real IP address, as read from
4284 the HTTP X-Forwarded-For header.
4286 The host value for $c->req->base and $c->req->uri is set to the real
4287 host, as read from the HTTP X-Forwarded-Host header.
4289 Additionally, you may be running your backend application on an insecure
4290 connection (port 80) while your frontend proxy is running under SSL. If there
4291 is a discrepancy in the ports, use the HTTP header C<X-Forwarded-Port> to
4292 tell Catalyst what port the frontend listens on. This will allow all URIs to
4293 be created properly.
4295 In the case of passing in:
4297 X-Forwarded-Port: 443
4299 All calls to C<uri_for> will result in an https link, as is expected.
4301 Obviously, your web server must support these headers for this to work.
4303 In a more complex server farm environment where you may have your
4304 frontend proxy server(s) on different machines, you will need to set a
4305 configuration option to tell Catalyst to read the proxied data from the
4308 MyApp->config(using_frontend_proxy => 1);
4310 If you do not wish to use the proxy support at all, you may set:
4312 MyApp->config(ignore_frontend_proxy => 0);
4314 =head2 Note about psgi files
4316 Note that if you supply your own .psgi file, calling
4317 C<< MyApp->psgi_app(@_); >>, then B<this will not happen automatically>.
4319 You either need to apply L<Plack::Middleware::ReverseProxy> yourself
4320 in your psgi, for example:
4323 enable "Plack::Middleware::ReverseProxy";
4327 This will unconditionally add the ReverseProxy support, or you need to call
4328 C<< $app = MyApp->apply_default_middlewares($app) >> (to conditionally
4329 apply the support depending upon your config).
4331 See L<Catalyst::PSGI> for more information.
4333 =head1 THREAD SAFETY
4335 Catalyst has been tested under Apache 2's threading C<mpm_worker>,
4336 C<mpm_winnt>, and the standalone forking HTTP server on Windows. We
4337 believe the Catalyst core to be thread-safe.
4339 If you plan to operate in a threaded environment, remember that all other
4340 modules you are using must also be thread-safe. Some modules, most notably
4341 L<DBD::SQLite>, are not thread-safe.
4343 =head1 DATA HANDLERS
4345 The L<Catalyst::Request> object uses L<HTTP::Body> to populate 'classic' HTML
4346 form parameters and URL search query fields. However it has become common
4347 for various alternative content types to be PUT or POSTed to your controllers
4348 and actions. People working on RESTful APIs, or using AJAX often use JSON,
4349 XML and other content types when communicating with an application server. In
4350 order to better support this use case, L<Catalyst> defines a global configuration
4351 option, C<data_handlers>, which lets you associate a content type with a coderef
4352 that parses that content type into something Perl can readily access.
4359 __PACKAGE__->config(
4361 'application/json' => sub { local $/; decode_json $_->getline },
4363 ## Any other configuration.
4368 By default L<Catalyst> comes with a generic JSON data handler similar to the
4369 example given above, which uses L<JSON::Maybe> to provide either L<JSON::PP>
4370 (a pure Perl, dependency free JSON parser) or L<Cpanel::JSON::XS> if you have
4371 it installed (if you want the faster XS parser, add it to you project Makefile.PL
4372 or dist.ini, cpanfile, etc.)
4374 The C<data_handlers> configuration is a hashref whose keys are HTTP Content-Types
4375 (matched against the incoming request type using a regexp such as to be case
4376 insensitive) and whose values are coderefs that receive a localized version of
4377 C<$_> which is a filehandle object pointing to received body.
4379 This feature is considered an early access release and we reserve the right
4380 to alter the interface in order to provide a performant and secure solution to
4381 alternative request body content. Your reports welcomed!
4383 =head1 PSGI MIDDLEWARE
4385 You can define middleware, defined as L<Plack::Middleware> or a compatible
4386 interface in configuration. Your middleware definitions are in the form of an
4387 arrayref under the configuration key C<psgi_middleware>. Here's an example
4388 with details to follow:
4393 use Plack::Middleware::StackTrace;
4395 my $stacktrace_middleware = Plack::Middleware::StackTrace->new;
4397 __PACKAGE__->config(
4398 'psgi_middleware', [
4401 $stacktrace_middleware,
4402 'Session' => {store => 'File'},
4407 $env->{myapp.customkey} = 'helloworld';
4416 So the general form is:
4418 __PACKAGE__->config(psgi_middleware => \@middleware_definitions);
4420 Where C<@middleware> is one or more of the following, applied in the REVERSE of
4421 the order listed (to make it function similarly to L<Plack::Builder>:
4423 Alternatively, you may also define middleware by calling the L</setup_middleware>
4430 __PACKAGE__->setup_middleware( \@middleware_definitions);
4433 In the case where you do both (use 'setup_middleware' and configuration) the
4434 package call to setup_middleware will be applied earlier (in other words its
4435 middleware will wrap closer to the application). Keep this in mind since in
4436 some cases the order of middleware is important.
4438 The two approaches are not exclusive.
4442 =item Middleware Object
4444 An already initialized object that conforms to the L<Plack::Middleware>
4447 my $stacktrace_middleware = Plack::Middleware::StackTrace->new;
4449 __PACKAGE__->config(
4450 'psgi_middleware', [
4451 $stacktrace_middleware,
4457 A coderef that is an inlined middleware:
4459 __PACKAGE__->config(
4460 'psgi_middleware', [
4465 if($env->{PATH_INFO} =~m/forced/) {
4467 ->new(file=>TestApp->path_to(qw/share static forced.txt/))
4470 return $app->($env);
4480 We assume the scalar refers to a namespace after normalizing it using the
4483 (1) If the scalar is prefixed with a "+" (as in C<+MyApp::Foo>) then the full string
4484 is assumed to be 'as is', and we just install and use the middleware.
4486 (2) If the scalar begins with "Plack::Middleware" or your application namespace
4487 (the package name of your Catalyst application subclass), we also assume then
4488 that it is a full namespace, and use it.
4490 (3) Lastly, we then assume that the scalar is a partial namespace, and attempt to
4491 resolve it first by looking for it under your application namespace (for example
4492 if you application is "MyApp::Web" and the scalar is "MyMiddleware", we'd look
4493 under "MyApp::Web::Middleware::MyMiddleware") and if we don't find it there, we
4494 will then look under the regular L<Plack::Middleware> namespace (i.e. for the
4495 previous we'd try "Plack::Middleware::MyMiddleware"). We look under your application
4496 namespace first to let you 'override' common L<Plack::Middleware> locally, should
4497 you find that a good idea.
4503 __PACKAGE__->config(
4504 'psgi_middleware', [
4505 'Debug', ## MyAppWeb::Middleware::Debug->wrap or Plack::Middleware::Debug->wrap
4506 'Plack::Middleware::Stacktrace', ## Plack::Middleware::Stacktrace->wrap
4507 '+MyApp::Custom', ## MyApp::Custom->wrap
4511 =item a scalar followed by a hashref
4513 Just like the previous, except the following C<HashRef> is used as arguments
4514 to initialize the middleware object.
4516 __PACKAGE__->config(
4517 'psgi_middleware', [
4518 'Session' => {store => 'File'},
4523 Please see L<PSGI> for more on middleware.
4527 Starting in L<Catalyst> version 5.90080 encoding is automatically enabled
4528 and set to encode all body responses to UTF8 when possible and applicable.
4529 Following is documentation on this process. If you are using an older
4530 version of L<Catalyst> you should review documentation for that version since
4533 By default encoding is now 'UTF-8'. You may turn it off by setting
4534 the encoding configuration to undef.
4536 MyApp->config(encoding => undef);
4538 This is recommended for temporary backwards compatibility only.
4540 Encoding is automatically applied when the content-type is set to
4541 a type that can be encoded. Currently we encode when the content type
4542 matches the following regular expression:
4544 $content_type =~ /^text|xml$|javascript$/
4546 Encoding is set on the application, but it is copied to the context object
4547 so that you can override it on a request basis.
4549 Be default we don't automatically encode 'application/json' since the most
4550 common approaches to generating this type of response (Either via L<Catalyst::View::JSON>
4551 or L<Catalyst::Action::REST>) will do so already and we want to avoid double
4554 If you are producing JSON response in an unconventional manner (such
4555 as via a template or manual strings) you should perform the UTF8 encoding
4556 manually as well such as to conform to the JSON specification.
4558 NOTE: We also examine the value of $c->response->content_encoding. If
4559 you set this (like for example 'gzip', and manually gzipping the body)
4560 we assume that you have done all the necessary encoding yourself, since
4561 we cannot encode the gzipped contents. If you use a plugin like
4562 L<Catalyst::Plugin::Compress> you need to update to a modern version in order
4563 to have this function correctly with the new UTF8 encoding code, or you
4564 can use L<Plack::Middleware::Deflater> or (probably best) do your compression on
4573 Returns an instance of an C<Encode> encoding
4575 print $c->encoding->name
4577 =item handle_unicode_encoding_exception ($exception_context)
4579 Method called when decoding process for a request fails.
4581 An C<$exception_context> hashref is provided to allow you to override the
4582 behaviour of your application when given data with incorrect encodings.
4584 The default method throws exceptions in the case of invalid request parameters
4585 (resulting in a 500 error), but ignores errors in upload filenames.
4587 The keys passed in the C<$exception_context> hash are:
4593 The value which was not able to be decoded.
4597 The exception received from L<Encode>.
4601 What type of data was being decoded. Valid values are (currently)
4602 C<params> - for request parameters / arguments / captures
4603 and C<uploads> - for request upload filenames.
4613 Join #catalyst on irc.perl.org.
4617 http://lists.scsys.co.uk/cgi-bin/mailman/listinfo/catalyst
4618 http://lists.scsys.co.uk/cgi-bin/mailman/listinfo/catalyst-dev
4622 http://catalyst.perl.org
4626 http://dev.catalyst.perl.org
4630 =head2 L<Task::Catalyst> - All you need to start with Catalyst
4632 =head2 L<Catalyst::Manual> - The Catalyst Manual
4634 =head2 L<Catalyst::Component>, L<Catalyst::Controller> - Base classes for components
4636 =head2 L<Catalyst::Engine> - Core engine
4638 =head2 L<Catalyst::Log> - Log class.
4640 =head2 L<Catalyst::Request> - Request object
4642 =head2 L<Catalyst::Response> - Response object
4644 =head2 L<Catalyst::Test> - The test suite.
4646 =head1 PROJECT FOUNDER
4648 sri: Sebastian Riedel <sri@cpan.org>
4654 acme: Leon Brocard <leon@astray.com>
4656 abraxxa: Alexander Hartmaier <abraxxa@cpan.org>
4658 andrewalker: André Walker <andre@cpan.org>
4662 Andrew Ford E<lt>A.Ford@ford-mason.co.ukE<gt>
4666 andyg: Andy Grundman <andy@hybridized.org>
4668 audreyt: Audrey Tang
4670 bricas: Brian Cassidy <bricas@cpan.org>
4672 Caelum: Rafael Kitover <rkitover@io.com>
4674 chansen: Christian Hansen
4676 chicks: Christopher Hicks
4678 Chisel Wright C<pause@herlpacker.co.uk>
4680 Danijel Milicevic C<me@danijel.de>
4682 davewood: David Schmidt <davewood@cpan.org>
4684 David Kamholz E<lt>dkamholz@cpan.orgE<gt>
4686 David Naughton, C<naughton@umn.edu>
4690 dhoss: Devin Austin <dhoss@cpan.org>
4692 dkubb: Dan Kubb <dan.kubb-cpan@onautopilot.com>
4696 dwc: Daniel Westermann-Clark <danieltwc@cpan.org>
4698 esskar: Sascha Kiefer
4700 fireartist: Carl Franks <cfranks@cpan.org>
4702 frew: Arthur Axel "fREW" Schmidt <frioux@gmail.com>
4704 gabb: Danijel Milicevic
4708 Gavin Henry C<ghenry@perl.me.uk>
4712 groditi: Guillermo Roditi <groditi@gmail.com>
4714 hobbs: Andrew Rodland <andrew@cleverdomain.org>
4716 ilmari: Dagfinn Ilmari Mannsåker <ilmari@ilmari.org>
4718 jcamacho: Juan Camacho
4720 jester: Jesse Sheidlower C<jester@panix.com>
4722 jhannah: Jay Hannah <jay@jays.net>
4728 jon: Jon Schutz <jjschutz@cpan.org>
4730 Jonathan Rockway C<< <jrockway@cpan.org> >>
4732 Kieren Diment C<kd@totaldatasolution.com>
4734 konobi: Scott McWhirter <konobi@cpan.org>
4736 marcus: Marcus Ramberg <mramberg@cpan.org>
4738 miyagawa: Tatsuhiko Miyagawa <miyagawa@bulknews.net>
4740 mgrimes: Mark Grimes <mgrimes@cpan.org>
4742 mst: Matt S. Trout <mst@shadowcatsystems.co.uk>
4746 naughton: David Naughton
4748 ningu: David Kamholz <dkamholz@cpan.org>
4750 nothingmuch: Yuval Kogman <nothingmuch@woobling.org>
4752 numa: Dan Sully <daniel@cpan.org>
4758 omega: Andreas Marienborg
4760 Oleg Kostyuk <cub.uanic@gmail.com>
4762 phaylon: Robert Sedlacek <phaylon@dunkelheit.at>
4764 rafl: Florian Ragwitz <rafl@debian.org>
4766 random: Roland Lammel <lammel@cpan.org>
4768 Robert Sedlacek C<< <rs@474.at> >>
4770 SpiceMan: Marcel Montes
4774 szbalint: Balint Szilakszi <szbalint@cpan.org>
4776 t0m: Tomas Doran <bobtfish@bobtfish.net>
4780 vanstyn: Henry Van Styn <vanstyn@cpan.org>
4782 Viljo Marrandi C<vilts@yahoo.com>
4784 Will Hawes C<info@whawes.co.uk>
4786 willert: Sebastian Willert <willert@cpan.org>
4788 wreis: Wallace Reis <wreis@cpan.org>
4790 Yuval Kogman, C<nothingmuch@woobling.org>
4792 rainboxx: Matthias Dietrich, C<perl@rainboxx.de>
4794 dd070: Dhaval Dhanani <dhaval070@gmail.com>
4796 Upasana <me@upasana.me>
4798 John Napiorkowski (jnap) <jjnapiork@cpan.org>
4802 Copyright (c) 2005-2015, the above named PROJECT FOUNDER and CONTRIBUTORS.
4806 This library is free software. You can redistribute it and/or modify it under
4807 the same terms as Perl itself.
4813 __PACKAGE__->meta->make_immutable;