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;
45 use Class::Load 'load_class';
47 BEGIN { require 5.008003; }
49 has stack => (is => 'ro', default => sub { [] });
50 has stash => (is => 'rw', default => sub { {} });
51 has state => (is => 'rw', default => 0);
52 has stats => (is => 'rw');
53 has action => (is => 'rw');
54 has counter => (is => 'rw', default => sub { {} });
59 $self->request_class->new($self->_build_request_constructor_args);
63 sub _build_request_constructor_args {
65 my %p = ( _log => $self->log );
66 $p{_uploadtmp} = $self->_uploadtmp if $self->_has_uploadtmp;
67 $p{data_handlers} = {$self->registered_data_handlers};
68 $p{_use_hash_multivalue} = $self->config->{use_hash_multivalue_in_request}
69 if $self->config->{use_hash_multivalue_in_request};
77 $self->response_class->new($self->_build_response_constructor_args);
81 sub _build_response_constructor_args {
83 { _log => $self->log };
86 has namespace => (is => 'rw');
88 sub depth { scalar @{ shift->stack || [] }; }
89 sub comp { shift->component(@_) }
92 my $self = shift; return $self->request(@_);
95 my $self = shift; return $self->response(@_);
98 # For backwards compatibility
99 sub finalize_output { shift->finalize_body(@_) };
104 our $RECURSION = 1000;
105 our $DETACH = Catalyst::Exception::Detach->new;
106 our $GO = Catalyst::Exception::Go->new;
108 #I imagine that very few of these really need to be class variables. if any.
109 #maybe we should just make them attributes with a default?
110 __PACKAGE__->mk_classdata($_)
111 for qw/components arguments dispatcher engine log dispatcher_class
112 engine_loader context_class request_class response_class stats_class
113 setup_finished _psgi_app loading_psgi_file run_options _psgi_middleware
116 __PACKAGE__->dispatcher_class('Catalyst::Dispatcher');
117 __PACKAGE__->request_class('Catalyst::Request');
118 __PACKAGE__->response_class('Catalyst::Response');
119 __PACKAGE__->stats_class('Catalyst::Stats');
121 # Remember to update this in Catalyst::Runtime as well!
123 our $VERSION = '5.90049_004';
126 my ( $class, @arguments ) = @_;
128 # We have to limit $class to Catalyst to avoid pushing Catalyst upon every
130 return unless $class eq 'Catalyst';
132 my $caller = caller();
133 return if $caller eq 'main';
135 my $meta = Moose::Meta::Class->initialize($caller);
136 unless ( $caller->isa('Catalyst') ) {
137 my @superclasses = ($meta->superclasses, $class, 'Catalyst::Controller');
138 $meta->superclasses(@superclasses);
140 # Avoid possible C3 issues if 'Moose::Object' is already on RHS of MyApp
141 $meta->superclasses(grep { $_ ne 'Moose::Object' } $meta->superclasses);
143 unless( $meta->has_method('meta') ){
144 if ($Moose::VERSION >= 1.15) {
145 $meta->_add_meta_method('meta');
148 $meta->add_method(meta => sub { Moose::Meta::Class->initialize("${caller}") } );
152 $caller->arguments( [@arguments] );
156 sub _application { $_[0] }
162 Catalyst - The Elegant MVC Web Application Framework
166 See the L<Catalyst::Manual> distribution for comprehensive
167 documentation and tutorials.
169 # Install Catalyst::Devel for helpers and other development tools
170 # use the helper to create a new application
173 # add models, views, controllers
174 script/myapp_create.pl model MyDatabase DBIC::Schema create=static dbi:SQLite:/path/to/db
175 script/myapp_create.pl view MyTemplate TT
176 script/myapp_create.pl controller Search
178 # built in testserver -- use -r to restart automatically on changes
179 # --help to see all available options
180 script/myapp_server.pl
182 # command line testing interface
183 script/myapp_test.pl /yada
186 use Catalyst qw/-Debug/; # include plugins here as well
188 ### In lib/MyApp/Controller/Root.pm (autocreated)
189 sub foo : Chained('/') Args() { # called for /foo, /foo/1, /foo/1/2, etc.
190 my ( $self, $c, @args ) = @_; # args are qw/1 2/ for /foo/1/2
191 $c->stash->{template} = 'foo.tt'; # set the template
192 # lookup something from db -- stash vars are passed to TT
194 $c->model('Database::Foo')->search( { country => $args[0] } );
195 if ( $c->req->params->{bar} ) { # access GET or POST parameters
196 $c->forward( 'bar' ); # process another action
197 # do something else after forward returns
201 # The foo.tt TT template can use the stash data from the database
202 [% WHILE (item = data.next) %]
206 # called for /bar/of/soap, /bar/of/soap/10, etc.
207 sub bar : Chained('/') PathPart('/bar/of/soap') Args() { ... }
209 # called after all actions are finished
211 my ( $self, $c ) = @_;
212 if ( scalar @{ $c->error } ) { ... } # handle errors
213 return if $c->res->body; # already have a response
214 $c->forward( 'MyApp::View::TT' ); # render template
217 See L<Catalyst::Manual::Intro> for additional information.
221 Catalyst is a modern framework for making web applications without the
222 pain usually associated with this process. This document is a reference
223 to the main Catalyst application. If you are a new user, we suggest you
224 start with L<Catalyst::Manual::Tutorial> or L<Catalyst::Manual::Intro>.
226 See L<Catalyst::Manual> for more documentation.
228 Catalyst plugins can be loaded by naming them as arguments to the "use
229 Catalyst" statement. Omit the C<Catalyst::Plugin::> prefix from the
230 plugin name, i.e., C<Catalyst::Plugin::My::Module> becomes
233 use Catalyst qw/My::Module/;
235 If your plugin starts with a name other than C<Catalyst::Plugin::>, you can
236 fully qualify the name by using a unary plus:
240 +Fully::Qualified::Plugin::Name
243 Special flags like C<-Debug> can also be specified as
244 arguments when Catalyst is loaded:
246 use Catalyst qw/-Debug My::Module/;
248 The position of plugins and flags in the chain is important, because
249 they are loaded in the order in which they appear.
251 The following flags are supported:
255 Enables debug output. You can also force this setting from the system
256 environment with CATALYST_DEBUG or <MYAPP>_DEBUG. The environment
257 settings override the application, with <MYAPP>_DEBUG having the highest
260 This sets the log level to 'debug' and enables full debug output on the
261 error screen. If you only want the latter, see L<< $c->debug >>.
265 Forces Catalyst to use a specific home directory, e.g.:
267 use Catalyst qw[-Home=/usr/mst];
269 This can also be done in the shell environment by setting either the
270 C<CATALYST_HOME> environment variable or C<MYAPP_HOME>; where C<MYAPP>
271 is replaced with the uppercased name of your application, any "::" in
272 the name will be replaced with underscores, e.g. MyApp::Web should use
273 MYAPP_WEB_HOME. If both variables are set, the MYAPP_HOME one will be used.
275 If none of these are set, Catalyst will attempt to automatically detect the
276 home directory. If you are working in a development environment, Catalyst
277 will try and find the directory containing either Makefile.PL, Build.PL,
278 dist.ini, or cpanfile. If the application has been installed into the system
279 (i.e. you have done C<make install>), then Catalyst will use the path to your
280 application module, without the .pm extension (e.g., /foo/MyApp if your
281 application was installed at /foo/MyApp.pm)
285 use Catalyst '-Log=warn,fatal,error';
287 Specifies a comma-delimited list of log levels.
291 Enables statistics collection and reporting.
293 use Catalyst qw/-Stats=1/;
295 You can also force this setting from the system environment with CATALYST_STATS
296 or <MYAPP>_STATS. The environment settings override the application, with
297 <MYAPP>_STATS having the highest priority.
299 Stats are also enabled if L<< debugging |/"-Debug" >> is enabled.
303 =head2 INFORMATION ABOUT THE CURRENT REQUEST
307 Returns a L<Catalyst::Action> object for the current action, which
308 stringifies to the action name. See L<Catalyst::Action>.
312 Returns the namespace of the current action, i.e., the URI prefix
313 corresponding to the controller of the current action. For example:
315 # in Controller::Foo::Bar
316 $c->namespace; # returns 'foo/bar';
322 Returns the current L<Catalyst::Request> object, giving access to
323 information about the current client request (including parameters,
324 cookies, HTTP headers, etc.). See L<Catalyst::Request>.
326 =head2 REQUEST FLOW HANDLING
328 =head2 $c->forward( $action [, \@arguments ] )
330 =head2 $c->forward( $class, $method, [, \@arguments ] )
332 This is one way of calling another action (method) in the same or
333 a different controller. You can also use C<< $self->my_method($c, @args) >>
334 in the same controller or C<< $c->controller('MyController')->my_method($c, @args) >>
335 in a different controller.
336 The main difference is that 'forward' uses some of the Catalyst request
337 cycle overhead, including debugging, which may be useful to you. On the
338 other hand, there are some complications to using 'forward', restrictions
339 on values returned from 'forward', and it may not handle errors as you prefer.
340 Whether you use 'forward' or not is up to you; it is not considered superior to
341 the other ways to call a method.
343 'forward' calls another action, by its private name. If you give a
344 class name but no method, C<process()> is called. You may also optionally
345 pass arguments in an arrayref. The action will receive the arguments in
346 C<@_> and C<< $c->req->args >>. Upon returning from the function,
347 C<< $c->req->args >> will be restored to the previous values.
349 Any data C<return>ed from the action forwarded to, will be returned by the
352 my $foodata = $c->forward('/foo');
353 $c->forward('index');
354 $c->forward(qw/Model::DBIC::Foo do_stuff/);
355 $c->forward('View::TT');
357 Note that L<< forward|/"$c->forward( $action [, \@arguments ] )" >> implies
358 an C<< eval { } >> around the call (actually
359 L<< execute|/"$c->execute( $class, $coderef )" >> does), thus rendering all
360 exceptions thrown by the called action non-fatal and pushing them onto
361 $c->error instead. If you want C<die> to propagate you need to do something
365 die join "\n", @{ $c->error } if @{ $c->error };
367 Or make sure to always return true values from your actions and write
370 $c->forward('foo') || return;
372 Another note is that C<< $c->forward >> always returns a scalar because it
373 actually returns $c->state which operates in a scalar context.
374 Thus, something like:
378 in an action that is forwarded to is going to return a scalar,
379 i.e. how many items are in that array, which is probably not what you want.
380 If you need to return an array then return a reference to it,
383 $c->stash->{array} = \@array;
385 and access it from the stash.
387 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.
391 sub forward { my $c = shift; no warnings 'recursion'; $c->dispatcher->forward( $c, @_ ) }
393 =head2 $c->detach( $action [, \@arguments ] )
395 =head2 $c->detach( $class, $method, [, \@arguments ] )
399 The same as L<< forward|/"$c->forward( $action [, \@arguments ] )" >>, but
400 doesn't return to the previous action when processing is finished.
402 When called with no arguments it escapes the processing chain entirely.
406 sub detach { my $c = shift; $c->dispatcher->detach( $c, @_ ) }
408 =head2 $c->visit( $action [, \@arguments ] )
410 =head2 $c->visit( $action [, \@captures, \@arguments ] )
412 =head2 $c->visit( $class, $method, [, \@arguments ] )
414 =head2 $c->visit( $class, $method, [, \@captures, \@arguments ] )
416 Almost the same as L<< forward|/"$c->forward( $action [, \@arguments ] )" >>,
417 but does a full dispatch, instead of just calling the new C<$action> /
418 C<< $class->$method >>. This means that C<begin>, C<auto> and the method
419 you go to are called, just like a new request.
421 In addition both C<< $c->action >> and C<< $c->namespace >> are localized.
422 This means, for example, that C<< $c->action >> methods such as
423 L<name|Catalyst::Action/name>, L<class|Catalyst::Action/class> and
424 L<reverse|Catalyst::Action/reverse> return information for the visited action
425 when they are invoked within the visited action. This is different from the
426 behavior of L<< forward|/"$c->forward( $action [, \@arguments ] )" >>, which
427 continues to use the $c->action object from the caller action even when
428 invoked from the called action.
430 C<< $c->stash >> is kept unchanged.
432 In effect, L<< visit|/"$c->visit( $action [, \@captures, \@arguments ] )" >>
433 allows you to "wrap" another action, just as it would have been called by
434 dispatching from a URL, while the analogous
435 L<< go|/"$c->go( $action [, \@captures, \@arguments ] )" >> allows you to
436 transfer control to another action as if it had been reached directly from a URL.
440 sub visit { my $c = shift; $c->dispatcher->visit( $c, @_ ) }
442 =head2 $c->go( $action [, \@arguments ] )
444 =head2 $c->go( $action [, \@captures, \@arguments ] )
446 =head2 $c->go( $class, $method, [, \@arguments ] )
448 =head2 $c->go( $class, $method, [, \@captures, \@arguments ] )
450 The relationship between C<go> and
451 L<< visit|/"$c->visit( $action [, \@captures, \@arguments ] )" >> is the same as
452 the relationship between
453 L<< forward|/"$c->forward( $class, $method, [, \@arguments ] )" >> and
454 L<< detach|/"$c->detach( $action [, \@arguments ] )" >>. Like C<< $c->visit >>,
455 C<< $c->go >> will perform a full dispatch on the specified action or method,
456 with localized C<< $c->action >> and C<< $c->namespace >>. Like C<detach>,
457 C<go> escapes the processing of the current request chain on completion, and
458 does not return to its caller.
460 @arguments are arguments to the final destination of $action. @captures are
461 arguments to the intermediate steps, if any, on the way to the final sub of
466 sub go { my $c = shift; $c->dispatcher->go( $c, @_ ) }
472 Returns the current L<Catalyst::Response> object, see there for details.
476 Returns a hashref to the stash, which may be used to store data and pass
477 it between components during a request. You can also set hash keys by
478 passing arguments. The stash is automatically sent to the view. The
479 stash is cleared at the end of a request; it cannot be used for
480 persistent storage (for this you must use a session; see
481 L<Catalyst::Plugin::Session> for a complete system integrated with
484 $c->stash->{foo} = $bar;
485 $c->stash( { moose => 'majestic', qux => 0 } );
486 $c->stash( bar => 1, gorch => 2 ); # equivalent to passing a hashref
488 # stash is automatically passed to the view for use in a template
489 $c->forward( 'MyApp::View::TT' );
493 around stash => sub {
496 my $stash = $orig->($c);
498 my $new_stash = @_ > 1 ? {@_} : $_[0];
499 croak('stash takes a hash or hashref') unless ref $new_stash;
500 foreach my $key ( keys %$new_stash ) {
501 $stash->{$key} = $new_stash->{$key};
511 =head2 $c->error($error, ...)
513 =head2 $c->error($arrayref)
515 Returns an arrayref containing error messages. If Catalyst encounters an
516 error while processing a request, it stores the error in $c->error. This
517 method should only be used to store fatal error messages.
519 my @error = @{ $c->error };
523 $c->error('Something bad happened');
530 my $error = ref $_[0] eq 'ARRAY' ? $_[0] : [@_];
531 croak @$error unless ref $c;
532 push @{ $c->{error} }, @$error;
534 elsif ( defined $_[0] ) { $c->{error} = undef }
535 return $c->{error} || [];
541 Contains the return value of the last executed action.
542 Note that << $c->state >> operates in a scalar context which means that all
543 values it returns are scalar.
545 =head2 $c->clear_errors
547 Clear errors. You probably don't want to clear the errors unless you are
548 implementing a custom error screen.
550 This is equivalent to running
561 sub _comp_search_prefixes {
563 return map $c->components->{ $_ }, $c->_comp_names_search_prefixes(@_);
566 # search components given a name and some prefixes
567 sub _comp_names_search_prefixes {
568 my ( $c, $name, @prefixes ) = @_;
569 my $appclass = ref $c || $c;
570 my $filter = "^${appclass}::(" . join( '|', @prefixes ) . ')::';
571 $filter = qr/$filter/; # Compile regex now rather than once per loop
573 # map the original component name to the sub part that we will search against
574 my %eligible = map { my $n = $_; $n =~ s{^$appclass\::[^:]+::}{}; $_ => $n; }
575 grep { /$filter/ } keys %{ $c->components };
577 # undef for a name will return all
578 return keys %eligible if !defined $name;
580 my $query = $name->$_isa('Regexp') ? $name : qr/^$name$/i;
581 my @result = grep { $eligible{$_} =~ m{$query} } keys %eligible;
583 return @result if @result;
585 # if we were given a regexp to search against, we're done.
586 return if $name->$_isa('Regexp');
588 # skip regexp fallback if configured
590 if $appclass->config->{disable_component_resolution_regex_fallback};
594 @result = grep { $eligible{ $_ } =~ m{$query} } keys %eligible;
596 # no results? try against full names
598 @result = grep { m{$query} } keys %eligible;
601 # don't warn if we didn't find any results, it just might not exist
603 # Disgusting hack to work out correct method name
604 my $warn_for = lc $prefixes[0];
605 my $msg = "Used regexp fallback for \$c->${warn_for}('${name}'), which found '" .
606 (join '", "', @result) . "'. Relying on regexp fallback behavior for " .
607 "component resolution is unreliable and unsafe.";
608 my $short = $result[0];
609 # remove the component namespace prefix
610 $short =~ s/.*?(Model|Controller|View):://;
611 my $shortmess = Carp::shortmess('');
612 if ($shortmess =~ m#Catalyst/Plugin#) {
613 $msg .= " You probably need to set '$short' instead of '${name}' in this " .
615 } elsif ($shortmess =~ m#Catalyst/lib/(View|Controller)#) {
616 $msg .= " You probably need to set '$short' instead of '${name}' in this " .
617 "component's config";
619 $msg .= " You probably meant \$c->${warn_for}('$short') instead of \$c->${warn_for}('${name}'), " .
620 "but if you really wanted to search, pass in a regexp as the argument " .
621 "like so: \$c->${warn_for}(qr/${name}/)";
623 $c->log->warn( "${msg}$shortmess" );
629 # Find possible names for a prefix
631 my ( $c, @prefixes ) = @_;
632 my $appclass = ref $c || $c;
634 my $filter = "^${appclass}::(" . join( '|', @prefixes ) . ')::';
636 my @names = map { s{$filter}{}; $_; }
637 $c->_comp_names_search_prefixes( undef, @prefixes );
642 # Filter a component before returning by calling ACCEPT_CONTEXT if available
643 sub _filter_component {
644 my ( $c, $comp, @args ) = @_;
646 if ( eval { $comp->can('ACCEPT_CONTEXT'); } ) {
647 return $comp->ACCEPT_CONTEXT( $c, @args );
653 =head2 COMPONENT ACCESSORS
655 =head2 $c->controller($name)
657 Gets a L<Catalyst::Controller> instance by name.
659 $c->controller('Foo')->do_stuff;
661 If the name is omitted, will return the controller for the dispatched
664 If you want to search for controllers, pass in a regexp as the argument.
666 # find all controllers that start with Foo
667 my @foo_controllers = $c->controller(qr{^Foo});
673 my ( $c, $name, @args ) = @_;
675 my $appclass = ref($c) || $c;
677 unless ( $name->$_isa('Regexp') ) { # Direct component hash lookup to avoid costly regexps
678 my $comps = $c->components;
679 my $check = $appclass."::Controller::".$name;
680 return $c->_filter_component( $comps->{$check}, @args ) if exists $comps->{$check};
682 my @result = $c->_comp_search_prefixes( $name, qw/Controller C/ );
683 return map { $c->_filter_component( $_, @args ) } @result if ref $name;
684 return $c->_filter_component( $result[ 0 ], @args );
687 return $c->component( $c->action->class );
690 =head2 $c->model($name)
692 Gets a L<Catalyst::Model> instance by name.
694 $c->model('Foo')->do_stuff;
696 Any extra arguments are directly passed to ACCEPT_CONTEXT.
698 If the name is omitted, it will look for
699 - a model object in $c->stash->{current_model_instance}, then
700 - a model name in $c->stash->{current_model}, then
701 - a config setting 'default_model', or
702 - check if there is only one model, and return it if that's the case.
704 If you want to search for models, pass in a regexp as the argument.
706 # find all models that start with Foo
707 my @foo_models = $c->model(qr{^Foo});
712 my ( $c, $name, @args ) = @_;
713 my $appclass = ref($c) || $c;
715 unless ( $name->$_isa('Regexp') ) { # Direct component hash lookup to avoid costly regexps
716 my $comps = $c->components;
717 my $check = $appclass."::Model::".$name;
718 return $c->_filter_component( $comps->{$check}, @args ) if exists $comps->{$check};
720 my @result = $c->_comp_search_prefixes( $name, qw/Model M/ );
721 return map { $c->_filter_component( $_, @args ) } @result if ref $name;
722 return $c->_filter_component( $result[ 0 ], @args );
726 return $c->stash->{current_model_instance}
727 if $c->stash->{current_model_instance};
728 return $c->model( $c->stash->{current_model} )
729 if $c->stash->{current_model};
731 return $c->model( $appclass->config->{default_model} )
732 if $appclass->config->{default_model};
734 my( $comp, $rest ) = $c->_comp_search_prefixes( undef, qw/Model M/);
737 $c->log->warn( Carp::shortmess('Calling $c->model() will return a random model unless you specify one of:') );
738 $c->log->warn( '* $c->config(default_model => "the name of the default model to use")' );
739 $c->log->warn( '* $c->stash->{current_model} # the name of the model to use for this request' );
740 $c->log->warn( '* $c->stash->{current_model_instance} # the instance of the model to use for this request' );
741 $c->log->warn( 'NB: in version 5.81, the "random" behavior will not work at all.' );
744 return $c->_filter_component( $comp );
748 =head2 $c->view($name)
750 Gets a L<Catalyst::View> instance by name.
752 $c->view('Foo')->do_stuff;
754 Any extra arguments are directly passed to ACCEPT_CONTEXT.
756 If the name is omitted, it will look for
757 - a view object in $c->stash->{current_view_instance}, then
758 - a view name in $c->stash->{current_view}, then
759 - a config setting 'default_view', or
760 - check if there is only one view, and return it if that's the case.
762 If you want to search for views, pass in a regexp as the argument.
764 # find all views that start with Foo
765 my @foo_views = $c->view(qr{^Foo});
770 my ( $c, $name, @args ) = @_;
772 my $appclass = ref($c) || $c;
774 unless ( $name->$_isa('Regexp') ) { # Direct component hash lookup to avoid costly regexps
775 my $comps = $c->components;
776 my $check = $appclass."::View::".$name;
777 if( exists $comps->{$check} ) {
778 return $c->_filter_component( $comps->{$check}, @args );
781 $c->log->warn( "Attempted to use view '$check', but does not exist" );
784 my @result = $c->_comp_search_prefixes( $name, qw/View V/ );
785 return map { $c->_filter_component( $_, @args ) } @result if ref $name;
786 return $c->_filter_component( $result[ 0 ], @args );
790 return $c->stash->{current_view_instance}
791 if $c->stash->{current_view_instance};
792 return $c->view( $c->stash->{current_view} )
793 if $c->stash->{current_view};
795 return $c->view( $appclass->config->{default_view} )
796 if $appclass->config->{default_view};
798 my( $comp, $rest ) = $c->_comp_search_prefixes( undef, qw/View V/);
801 $c->log->warn( 'Calling $c->view() will return a random view unless you specify one of:' );
802 $c->log->warn( '* $c->config(default_view => "the name of the default view to use")' );
803 $c->log->warn( '* $c->stash->{current_view} # the name of the view to use for this request' );
804 $c->log->warn( '* $c->stash->{current_view_instance} # the instance of the view to use for this request' );
805 $c->log->warn( 'NB: in version 5.81, the "random" behavior will not work at all.' );
808 return $c->_filter_component( $comp );
811 =head2 $c->controllers
813 Returns the available names which can be passed to $c->controller
819 return $c->_comp_names(qw/Controller C/);
824 Returns the available names which can be passed to $c->model
830 return $c->_comp_names(qw/Model M/);
836 Returns the available names which can be passed to $c->view
842 return $c->_comp_names(qw/View V/);
845 =head2 $c->comp($name)
847 =head2 $c->component($name)
849 Gets a component object by name. This method is not recommended,
850 unless you want to get a specific component by full
851 class. C<< $c->controller >>, C<< $c->model >>, and C<< $c->view >>
852 should be used instead.
854 If C<$name> is a regexp, a list of components matched against the full
855 component name will be returned.
857 If Catalyst can't find a component by name, it will fallback to regex
858 matching by default. To disable this behaviour set
859 disable_component_resolution_regex_fallback to a true value.
861 __PACKAGE__->config( disable_component_resolution_regex_fallback => 1 );
866 my ( $c, $name, @args ) = @_;
869 my $comps = $c->components;
872 # is it the exact name?
873 return $c->_filter_component( $comps->{ $name }, @args )
874 if exists $comps->{ $name };
876 # perhaps we just omitted "MyApp"?
877 my $composed = ( ref $c || $c ) . "::${name}";
878 return $c->_filter_component( $comps->{ $composed }, @args )
879 if exists $comps->{ $composed };
881 # search all of the models, views and controllers
882 my( $comp ) = $c->_comp_search_prefixes( $name, qw/Model M Controller C View V/ );
883 return $c->_filter_component( $comp, @args ) if $comp;
887 if $c->config->{disable_component_resolution_regex_fallback};
889 # This is here so $c->comp( '::M::' ) works
890 my $query = ref $name ? $name : qr{$name}i;
892 my @result = grep { m{$query} } keys %{ $c->components };
893 return map { $c->_filter_component( $_, @args ) } @result if ref $name;
896 $c->log->warn( Carp::shortmess(qq(Found results for "${name}" using regexp fallback)) );
897 $c->log->warn( 'Relying on the regexp fallback behavior for component resolution' );
898 $c->log->warn( 'is unreliable and unsafe. You have been warned' );
899 return $c->_filter_component( $result[ 0 ], @args );
902 # I would expect to return an empty list here, but that breaks back-compat
906 return sort keys %{ $c->components };
909 =head2 CLASS DATA AND HELPER CLASSES
913 Returns or takes a hashref containing the application's configuration.
915 __PACKAGE__->config( { db => 'dsn:SQLite:foo.db' } );
917 You can also use a C<YAML>, C<XML> or L<Config::General> config file
918 like C<myapp.conf> in your applications home directory. See
919 L<Catalyst::Plugin::ConfigLoader>.
921 =head3 Cascading configuration
923 The config method is present on all Catalyst components, and configuration
924 will be merged when an application is started. Configuration loaded with
925 L<Catalyst::Plugin::ConfigLoader> takes precedence over other configuration,
926 followed by configuration in your top level C<MyApp> class. These two
927 configurations are merged, and then configuration data whose hash key matches a
928 component name is merged with configuration for that component.
930 The configuration for a component is then passed to the C<new> method when a
931 component is constructed.
935 MyApp->config({ 'Model::Foo' => { bar => 'baz', overrides => 'me' } });
936 MyApp::Model::Foo->config({ quux => 'frob', overrides => 'this' });
938 will mean that C<MyApp::Model::Foo> receives the following data when
941 MyApp::Model::Foo->new({
947 It's common practice to use a Moose attribute
948 on the receiving component to access the config value.
950 package MyApp::Model::Foo;
954 # this attr will receive 'baz' at construction time
960 You can then get the value 'baz' by calling $c->model('Foo')->bar
961 (or $self->bar inside code in the model).
963 B<NOTE:> you MUST NOT call C<< $self->config >> or C<< __PACKAGE__->config >>
964 as a way of reading config within your code, as this B<will not> give you the
965 correctly merged config back. You B<MUST> take the config values supplied to
966 the constructor and use those instead.
970 around config => sub {
974 croak('Setting config after setup has been run is not allowed.')
975 if ( @_ and $c->setup_finished );
982 Returns the logging object instance. Unless it is already set, Catalyst
983 sets this up with a L<Catalyst::Log> object. To use your own log class,
984 set the logger with the C<< __PACKAGE__->log >> method prior to calling
985 C<< __PACKAGE__->setup >>.
987 __PACKAGE__->log( MyLogger->new );
992 $c->log->info( 'Now logging with my own logger!' );
994 Your log class should implement the methods described in
1000 Returns 1 if debug mode is enabled, 0 otherwise.
1002 You can enable debug mode in several ways:
1006 =item By calling myapp_server.pl with the -d flag
1008 =item With the environment variables MYAPP_DEBUG, or CATALYST_DEBUG
1010 =item The -Debug option in your MyApp.pm
1012 =item By declaring C<sub debug { 1 }> in your MyApp.pm.
1016 The first three also set the log level to 'debug'.
1018 Calling C<< $c->debug(1) >> has no effect.
1024 =head2 $c->dispatcher
1026 Returns the dispatcher instance. See L<Catalyst::Dispatcher>.
1030 Returns the engine instance. See L<Catalyst::Engine>.
1033 =head2 UTILITY METHODS
1035 =head2 $c->path_to(@path)
1037 Merges C<@path> with C<< $c->config->{home} >> and returns a
1038 L<Path::Class::Dir> object. Note you can usually use this object as
1039 a filename, but sometimes you will have to explicitly stringify it
1040 yourself by calling the C<< ->stringify >> method.
1044 $c->path_to( 'db', 'sqlite.db' );
1049 my ( $c, @path ) = @_;
1050 my $path = Path::Class::Dir->new( $c->config->{home}, @path );
1051 if ( -d $path ) { return $path }
1052 else { return Path::Class::File->new( $c->config->{home}, @path ) }
1056 my ( $class, $name, $plugin, @args ) = @_;
1058 # See block comment in t/unit_core_plugin.t
1059 $class->log->warn(qq/Adding plugin using the ->plugin method is deprecated, and will be removed in a future release/);
1061 $class->_register_plugin( $plugin, 1 );
1063 eval { $plugin->import };
1064 $class->mk_classdata($name);
1066 eval { $obj = $plugin->new(@args) };
1069 Catalyst::Exception->throw( message =>
1070 qq/Couldn't instantiate instant plugin "$plugin", "$@"/ );
1073 $class->$name($obj);
1074 $class->log->debug(qq/Initialized instant plugin "$plugin" as "$name"/)
1080 Initializes the dispatcher and engine, loads any plugins, and loads the
1081 model, view, and controller components. You may also specify an array
1082 of plugins to load here, if you choose to not load them in the C<use
1086 MyApp->setup( qw/-Debug/ );
1088 B<Note:> You B<should not> wrap this method with method modifiers
1089 or bad things will happen - wrap the C<setup_finalize> method instead.
1094 my ( $class, @arguments ) = @_;
1095 croak('Running setup more than once')
1096 if ( $class->setup_finished );
1098 unless ( $class->isa('Catalyst') ) {
1100 Catalyst::Exception->throw(
1101 message => qq/'$class' does not inherit from Catalyst/ );
1104 if ( $class->arguments ) {
1105 @arguments = ( @arguments, @{ $class->arguments } );
1111 foreach (@arguments) {
1115 ( $flags->{log} ) ? 'debug,' . $flags->{log} : 'debug';
1117 elsif (/^-(\w+)=?(.*)$/) {
1118 $flags->{ lc $1 } = $2;
1121 push @{ $flags->{plugins} }, $_;
1125 $class->setup_home( delete $flags->{home} );
1127 $class->setup_log( delete $flags->{log} );
1128 $class->setup_plugins( delete $flags->{plugins} );
1129 $class->setup_middleware();
1130 $class->setup_data_handlers();
1131 $class->setup_dispatcher( delete $flags->{dispatcher} );
1132 if (my $engine = delete $flags->{engine}) {
1133 $class->log->warn("Specifying the engine in ->setup is no longer supported, see Catalyst::Upgrading");
1135 $class->setup_engine();
1136 $class->setup_stats( delete $flags->{stats} );
1138 for my $flag ( sort keys %{$flags} ) {
1140 if ( my $code = $class->can( 'setup_' . $flag ) ) {
1141 &$code( $class, delete $flags->{$flag} );
1144 $class->log->warn(qq/Unknown flag "$flag"/);
1148 eval { require Catalyst::Devel; };
1149 if( !$@ && $ENV{CATALYST_SCRIPT_GEN} && ( $ENV{CATALYST_SCRIPT_GEN} < $Catalyst::Devel::CATALYST_SCRIPT_GEN ) ) {
1150 $class->log->warn(<<"EOF");
1151 You are running an old script!
1153 Please update by running (this will overwrite existing files):
1154 catalyst.pl -force -scripts $class
1156 or (this will not overwrite existing files):
1157 catalyst.pl -scripts $class
1162 if ( $class->debug ) {
1163 my @plugins = map { "$_ " . ( $_->VERSION || '' ) } $class->registered_plugins;
1166 my $column_width = Catalyst::Utils::term_width() - 6;
1167 my $t = Text::SimpleTable->new($column_width);
1168 $t->row($_) for @plugins;
1169 $class->log->debug( "Loaded plugins:\n" . $t->draw . "\n" );
1172 my @middleware = map {
1175 (ref($_) .' '. ($_->can('VERSION') ? $_->VERSION || '' : '')
1176 || '') } $class->registered_middlewares;
1179 my $column_width = Catalyst::Utils::term_width() - 6;
1180 my $t = Text::SimpleTable->new($column_width);
1181 $t->row($_) for @middleware;
1182 $class->log->debug( "Loaded PSGI Middleware:\n" . $t->draw . "\n" );
1185 my %dh = $class->registered_data_handlers;
1186 if (my @data_handlers = keys %dh) {
1187 my $column_width = Catalyst::Utils::term_width() - 6;
1188 my $t = Text::SimpleTable->new($column_width);
1189 $t->row($_) for @data_handlers;
1190 $class->log->debug( "Loaded Request Data Handlers:\n" . $t->draw . "\n" );
1193 my $dispatcher = $class->dispatcher;
1194 my $engine = $class->engine;
1195 my $home = $class->config->{home};
1197 $class->log->debug(sprintf(q/Loaded dispatcher "%s"/, blessed($dispatcher)));
1198 $class->log->debug(sprintf(q/Loaded engine "%s"/, blessed($engine)));
1202 ? $class->log->debug(qq/Found home "$home"/)
1203 : $class->log->debug(qq/Home "$home" doesn't exist/)
1204 : $class->log->debug(q/Couldn't find home/);
1207 # Call plugins setup, this is stupid and evil.
1208 # Also screws C3 badly on 5.10, hack to avoid.
1210 no warnings qw/redefine/;
1211 local *setup = sub { };
1212 $class->setup unless $Catalyst::__AM_RESTARTING;
1215 # Initialize our data structure
1216 $class->components( {} );
1218 $class->setup_components;
1220 if ( $class->debug ) {
1221 my $column_width = Catalyst::Utils::term_width() - 8 - 9;
1222 my $t = Text::SimpleTable->new( [ $column_width, 'Class' ], [ 8, 'Type' ] );
1223 for my $comp ( sort keys %{ $class->components } ) {
1224 my $type = ref $class->components->{$comp} ? 'instance' : 'class';
1225 $t->row( $comp, $type );
1227 $class->log->debug( "Loaded components:\n" . $t->draw . "\n" )
1228 if ( keys %{ $class->components } );
1231 # Add our self to components, since we are also a component
1232 if( $class->isa('Catalyst::Controller') ){
1233 $class->components->{$class} = $class;
1236 $class->setup_actions;
1238 if ( $class->debug ) {
1239 my $name = $class->config->{name} || 'Application';
1240 $class->log->info("$name powered by Catalyst $Catalyst::VERSION");
1243 if ($class->config->{case_sensitive}) {
1244 $class->log->warn($class . "->config->{case_sensitive} is set.");
1245 $class->log->warn("This setting is deprecated and planned to be removed in Catalyst 5.81.");
1248 $class->setup_finalize;
1249 # Should be the last thing we do so that user things hooking
1250 # setup_finalize can log..
1251 $class->log->_flush() if $class->log->can('_flush');
1252 return 1; # Explicit return true as people have __PACKAGE__->setup as the last thing in their class. HATE.
1255 =head2 $app->setup_finalize
1257 A hook to attach modifiers to. This method does not do anything except set the
1258 C<setup_finished> accessor.
1260 Applying method modifiers to the C<setup> method doesn't work, because of quirky things done for plugin setup.
1264 after setup_finalize => sub {
1272 sub setup_finalize {
1274 $class->setup_finished(1);
1277 =head2 $c->uri_for( $path?, @args?, \%query_values? )
1279 =head2 $c->uri_for( $action, \@captures?, @args?, \%query_values? )
1281 Constructs an absolute L<URI> object based on the application root, the
1282 provided path, and the additional arguments and query parameters provided.
1283 When used as a string, provides a textual URI. If you need more flexibility
1284 than this (i.e. the option to provide relative URIs etc.) see
1285 L<Catalyst::Plugin::SmartURI>.
1287 If no arguments are provided, the URI for the current action is returned.
1288 To return the current action and also provide @args, use
1289 C<< $c->uri_for( $c->action, @args ) >>.
1291 If the first argument is a string, it is taken as a public URI path relative
1292 to C<< $c->namespace >> (if it doesn't begin with a forward slash) or
1293 relative to the application root (if it does). It is then merged with
1294 C<< $c->request->base >>; any C<@args> are appended as additional path
1295 components; and any C<%query_values> are appended as C<?foo=bar> parameters.
1297 If the first argument is a L<Catalyst::Action> it represents an action which
1298 will have its path resolved using C<< $c->dispatcher->uri_for_action >>. The
1299 optional C<\@captures> argument (an arrayref) allows passing the captured
1300 variables that are needed to fill in the paths of Chained and Regex actions;
1301 once the path is resolved, C<uri_for> continues as though a path was
1302 provided, appending any arguments or parameters and creating an absolute
1305 The captures for the current request can be found in
1306 C<< $c->request->captures >>, and actions can be resolved using
1307 C<< Catalyst::Controller->action_for($name) >>. If you have a private action
1308 path, use C<< $c->uri_for_action >> instead.
1310 # Equivalent to $c->req->uri
1311 $c->uri_for($c->action, $c->req->captures,
1312 @{ $c->req->args }, $c->req->params);
1314 # For the Foo action in the Bar controller
1315 $c->uri_for($c->controller('Bar')->action_for('Foo'));
1317 # Path to a static resource
1318 $c->uri_for('/static/images/logo.png');
1323 my ( $c, $path, @args ) = @_;
1325 if ( $path->$_isa('Catalyst::Controller') ) {
1326 $path = $path->path_prefix;
1331 undef($path) if (defined $path && $path eq '');
1334 ( scalar @args && ref $args[$#args] eq 'HASH' ? pop @args : {} );
1336 carp "uri_for called with undef argument" if grep { ! defined $_ } @args;
1337 foreach my $arg (@args) {
1338 utf8::encode($arg) if utf8::is_utf8($arg);
1339 $arg =~ s/([^$URI::uric])/$URI::Escape::escapes{$1}/go;
1342 if ( $path->$_isa('Catalyst::Action') ) { # action object
1343 s|/|%2F|g for @args;
1344 my $captures = [ map { s|/|%2F|g; $_; }
1345 ( scalar @args && ref $args[0] eq 'ARRAY'
1349 foreach my $capture (@$captures) {
1350 utf8::encode($capture) if utf8::is_utf8($capture);
1351 $capture =~ s/([^$URI::uric])/$URI::Escape::escapes{$1}/go;
1355 # ->uri_for( $action, \@captures_and_args, \%query_values? )
1356 if( !@args && $action->number_of_args ) {
1357 my $expanded_action = $c->dispatcher->expand_action( $action );
1359 my $num_captures = $expanded_action->number_of_captures;
1360 unshift @args, splice @$captures, $num_captures;
1363 $path = $c->dispatcher->uri_for_action($action, $captures);
1364 if (not defined $path) {
1365 $c->log->debug(qq/Can't find uri_for action '$action' @$captures/)
1369 $path = '/' if $path eq '';
1372 unshift(@args, $path);
1374 unless (defined $path && $path =~ s!^/!!) { # in-place strip
1375 my $namespace = $c->namespace;
1376 if (defined $path) { # cheesy hack to handle path '../foo'
1377 $namespace =~ s{(?:^|/)[^/]+$}{} while $args[0] =~ s{^\.\./}{};
1379 unshift(@args, $namespace || '');
1382 # join args with '/', or a blank string
1383 my $args = join('/', grep { defined($_) } @args);
1384 $args =~ s/\?/%3F/g; # STUPID STUPID SPECIAL CASE
1387 my ($base, $class) = ('/', 'URI::_generic');
1389 $base = $c->req->base;
1390 $class = ref($base);
1391 $base =~ s{(?<!/)$}{/};
1396 if (my @keys = keys %$params) {
1397 # somewhat lifted from URI::_query's query_form
1398 $query = '?'.join('&', map {
1399 my $val = $params->{$_};
1400 s/([;\/?:@&=+,\$\[\]%])/$URI::Escape::escapes{$1}/go;
1403 $val = '' unless defined $val;
1406 utf8::encode( $param ) if utf8::is_utf8($param);
1407 # using the URI::Escape pattern here so utf8 chars survive
1408 $param =~ s/([^A-Za-z0-9\-_.!~*'() ])/$URI::Escape::escapes{$1}/go;
1410 "${key}=$param"; } ( ref $val eq 'ARRAY' ? @$val : $val ));
1414 my $res = bless(\"${base}${args}${query}", $class);
1418 =head2 $c->uri_for_action( $path, \@captures_and_args?, @args?, \%query_values? )
1420 =head2 $c->uri_for_action( $action, \@captures_and_args?, @args?, \%query_values? )
1426 A private path to the Catalyst action you want to create a URI for.
1428 This is a shortcut for calling C<< $c->dispatcher->get_action_by_path($path)
1429 >> and passing the resulting C<$action> and the remaining arguments to C<<
1432 You can also pass in a Catalyst::Action object, in which case it is passed to
1435 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.
1437 For example, if the action looks like:
1439 package MyApp::Controller::Users;
1441 sub lst : Path('the-list') {}
1445 $c->uri_for_action('/users/lst')
1447 and it will create the URI /users/the-list.
1449 =item \@captures_and_args?
1451 Optional array reference of Captures (i.e. C<<CaptureArgs or $c->req->captures>)
1452 and arguments to the request. Usually used with L<Catalyst::DispatchType::Chained>
1453 to interpolate all the parameters in the URI.
1457 Optional list of extra arguments - can be supplied in the
1458 C<< \@captures_and_args? >> array ref, or here - whichever is easier for your
1461 Your action can have zero, a fixed or a variable number of args (e.g.
1462 C<< Args(1) >> for a fixed number or C<< Args() >> for a variable number)..
1464 =item \%query_values?
1466 Optional array reference of query parameters to append. E.g.
1472 /rest/of/your/uri?foo=bar
1478 sub uri_for_action {
1479 my ( $c, $path, @args ) = @_;
1480 my $action = blessed($path)
1482 : $c->dispatcher->get_action_by_path($path);
1483 unless (defined $action) {
1484 croak "Can't find action for path '$path'";
1486 return $c->uri_for( $action, @args );
1489 =head2 $c->welcome_message
1491 Returns the Catalyst welcome HTML page.
1495 sub welcome_message {
1497 my $name = $c->config->{name};
1498 my $logo = $c->uri_for('/static/images/catalyst_logo.png');
1499 my $prefix = Catalyst::Utils::appprefix( ref $c );
1500 $c->response->content_type('text/html; charset=utf-8');
1502 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
1503 "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
1504 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
1506 <meta http-equiv="Content-Language" content="en" />
1507 <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
1508 <title>$name on Catalyst $VERSION</title>
1509 <style type="text/css">
1512 background-color: #eee;
1519 margin-bottom: 10px;
1521 background-color: #ccc;
1522 border: 1px solid #aaa;
1527 font-family: verdana, tahoma, sans-serif;
1530 font-family: verdana, tahoma, sans-serif;
1533 text-decoration: none;
1535 border-bottom: 1px dotted #bbb;
1537 :link:hover, :visited:hover {
1550 background-color: #fff;
1551 border: 1px solid #aaa;
1555 font-weight: normal;
1577 <h1><span id="appname">$name</span> on <a href="http://catalyst.perl.org">Catalyst</a>
1582 <img src="$logo" alt="Catalyst Logo" />
1584 <p>Welcome to the world of Catalyst.
1585 This <a href="http://en.wikipedia.org/wiki/MVC">MVC</a>
1586 framework will make web development something you had
1587 never expected it to be: Fun, rewarding, and quick.</p>
1588 <h2>What to do now?</h2>
1589 <p>That really depends on what <b>you</b> want to do.
1590 We do, however, provide you with a few starting points.</p>
1591 <p>If you want to jump right into web development with Catalyst
1592 you might want to start with a tutorial.</p>
1593 <pre>perldoc <a href="https://metacpan.org/module/Catalyst::Manual::Tutorial">Catalyst::Manual::Tutorial</a></code>
1595 <p>Afterwards you can go on to check out a more complete look at our features.</p>
1597 <code>perldoc <a href="https://metacpan.org/module/Catalyst::Manual::Intro">Catalyst::Manual::Intro</a>
1598 <!-- Something else should go here, but the Catalyst::Manual link seems unhelpful -->
1600 <h2>What to do next?</h2>
1601 <p>Next it's time to write an actual application. Use the
1602 helper scripts to generate <a href="https://metacpan.org/search?q=Catalyst%3A%3AController">controllers</a>,
1603 <a href="https://metacpan.org/search?q=Catalyst%3A%3AModel">models</a>, and
1604 <a href="https://metacpan.org/search?q=Catalyst%3A%3AView">views</a>;
1605 they can save you a lot of work.</p>
1606 <pre><code>script/${prefix}_create.pl --help</code></pre>
1607 <p>Also, be sure to check out the vast and growing
1608 collection of <a href="http://search.cpan.org/search?query=Catalyst">plugins for Catalyst on CPAN</a>;
1609 you are likely to find what you need there.
1613 <p>Catalyst has a very active community. Here are the main places to
1614 get in touch with us.</p>
1617 <a href="http://dev.catalyst.perl.org">Wiki</a>
1620 <a href="http://lists.scsys.co.uk/cgi-bin/mailman/listinfo/catalyst">Mailing-List</a>
1623 <a href="irc://irc.perl.org/catalyst">IRC channel #catalyst on irc.perl.org</a>
1626 <h2>In conclusion</h2>
1627 <p>The Catalyst team hopes you will enjoy using Catalyst as much
1628 as we enjoyed making it. Please contact us if you have ideas
1629 for improvement or other feedback.</p>
1639 Contains a hash of options passed from the application script, including
1640 the original ARGV the script received, the processed values from that
1641 ARGV and any extra arguments to the script which were not processed.
1643 This can be used to add custom options to your application's scripts
1644 and setup your application differently depending on the values of these
1647 =head1 INTERNAL METHODS
1649 These methods are not meant to be used by end users.
1651 =head2 $c->components
1653 Returns a hash of components.
1655 =head2 $c->context_class
1657 Returns or sets the context class.
1661 Returns a hashref containing coderefs and execution counts (needed for
1662 deep recursion detection).
1666 Returns the number of actions on the current internal execution stack.
1670 Dispatches a request to actions.
1674 sub dispatch { my $c = shift; $c->dispatcher->dispatch( $c, @_ ) }
1676 =head2 $c->dispatcher_class
1678 Returns or sets the dispatcher class.
1680 =head2 $c->dump_these
1682 Returns a list of 2-element array references (name, structure) pairs
1683 that will be dumped on the error page in debug mode.
1689 [ Request => $c->req ],
1690 [ Response => $c->res ],
1691 [ Stash => $c->stash ],
1692 [ Config => $c->config ];
1695 =head2 $c->engine_class
1697 Returns or sets the engine class.
1699 =head2 $c->execute( $class, $coderef )
1701 Execute a coderef in given class and catch exceptions. Errors are available
1707 my ( $c, $class, $code ) = @_;
1708 $class = $c->component($class) || $class;
1711 if ( $c->depth >= $RECURSION ) {
1712 my $action = $code->reverse();
1713 $action = "/$action" unless $action =~ /->/;
1714 my $error = qq/Deep recursion detected calling "${action}"/;
1715 $c->log->error($error);
1721 my $stats_info = $c->_stats_start_execute( $code ) if $c->use_stats;
1723 push( @{ $c->stack }, $code );
1725 no warnings 'recursion';
1726 # N.B. This used to be combined, but I have seen $c get clobbered if so, and
1727 # I have no idea how, ergo $ret (which appears to fix the issue)
1728 eval { my $ret = $code->execute( $class, $c, @{ $c->req->args } ) || 0; $c->state( $ret ) };
1730 $c->_stats_finish_execute( $stats_info ) if $c->use_stats and $stats_info;
1732 my $last = pop( @{ $c->stack } );
1734 if ( my $error = $@ ) {
1735 if ( blessed($error) and $error->isa('Catalyst::Exception::Detach') ) {
1736 $error->rethrow if $c->depth > 1;
1738 elsif ( blessed($error) and $error->isa('Catalyst::Exception::Go') ) {
1739 $error->rethrow if $c->depth > 0;
1742 unless ( ref $error ) {
1743 no warnings 'uninitialized';
1745 my $class = $last->class;
1746 my $name = $last->name;
1747 $error = qq/Caught exception in $class->$name "$error"/;
1756 sub _stats_start_execute {
1757 my ( $c, $code ) = @_;
1758 my $appclass = ref($c) || $c;
1759 return if ( ( $code->name =~ /^_.*/ )
1760 && ( !$appclass->config->{show_internal_actions} ) );
1762 my $action_name = $code->reverse();
1763 $c->counter->{$action_name}++;
1765 my $action = $action_name;
1766 $action = "/$action" unless $action =~ /->/;
1768 # determine if the call was the result of a forward
1769 # this is done by walking up the call stack and looking for a calling
1770 # sub of Catalyst::forward before the eval
1772 for my $index ( 2 .. 11 ) {
1774 if ( ( caller($index) )[0] eq 'Catalyst'
1775 && ( caller($index) )[3] eq '(eval)' );
1777 if ( ( caller($index) )[3] =~ /forward$/ ) {
1778 $callsub = ( caller($index) )[3];
1779 $action = "-> $action";
1784 my $uid = $action_name . $c->counter->{$action_name};
1786 # is this a root-level call or a forwarded call?
1787 if ( $callsub =~ /forward$/ ) {
1788 my $parent = $c->stack->[-1];
1790 # forward, locate the caller
1791 if ( defined $parent && exists $c->counter->{"$parent"} ) {
1794 parent => "$parent" . $c->counter->{"$parent"},
1800 # forward with no caller may come from a plugin
1819 sub _stats_finish_execute {
1820 my ( $c, $info ) = @_;
1821 $c->stats->profile( end => $info );
1826 Finalizes the request.
1833 for my $error ( @{ $c->error } ) {
1834 $c->log->error($error);
1837 # Support skipping finalize for psgix.io style 'jailbreak'. Used to support
1838 # stuff like cometd and websockets
1840 if($c->request->has_io_fh) {
1845 # Allow engine to handle finalize flow (for POE)
1846 my $engine = $c->engine;
1847 if ( my $code = $engine->can('finalize') ) {
1852 $c->finalize_uploads;
1855 if ( $#{ $c->error } >= 0 ) {
1859 $c->finalize_headers unless $c->response->finalized_headers;
1862 if ( $c->request->method eq 'HEAD' ) {
1863 $c->response->body('');
1871 if ($c->use_stats) {
1872 my $elapsed = $c->stats->elapsed;
1873 my $av = $elapsed == 0 ? '??' : sprintf '%.3f', 1 / $elapsed;
1875 "Request took ${elapsed}s ($av/s)\n" . $c->stats->report . "\n" );
1878 return $c->response->status;
1881 =head2 $c->finalize_body
1887 sub finalize_body { my $c = shift; $c->engine->finalize_body( $c, @_ ) }
1889 =head2 $c->finalize_cookies
1895 sub finalize_cookies { my $c = shift; $c->engine->finalize_cookies( $c, @_ ) }
1897 =head2 $c->finalize_error
1903 sub finalize_error { my $c = shift; $c->engine->finalize_error( $c, @_ ) }
1905 =head2 $c->finalize_headers
1911 sub finalize_headers {
1914 my $response = $c->response; #accessor calls can add up?
1916 # Check if we already finalized headers
1917 return if $response->finalized_headers;
1920 if ( my $location = $response->redirect ) {
1921 $c->log->debug(qq/Redirecting to "$location"/) if $c->debug;
1922 $response->header( Location => $location );
1924 if ( !$response->has_body ) {
1925 # Add a default body if none is already present
1926 my $encoded_location = encode_entities($location);
1927 $response->body(<<"EOF");
1928 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
1929 <html xmlns="http://www.w3.org/1999/xhtml">
1931 <title>Moved</title>
1934 <p>This item has moved <a href="$encoded_location">here</a>.</p>
1938 $response->content_type('text/html; charset=utf-8');
1943 if ( defined $response->body && length $response->body && !$response->content_length ) {
1945 # get the length from a filehandle
1946 if ( blessed( $response->body ) && $response->body->can('read') || ref( $response->body ) eq 'GLOB' )
1948 my $size = -s $response->body;
1950 $response->content_length( $size );
1953 $c->log->warn('Serving filehandle without a content-length');
1957 # everything should be bytes at this point, but just in case
1958 $response->content_length( length( $response->body ) );
1963 if ( $response->status =~ /^(1\d\d|[23]04)$/ ) {
1964 $response->headers->remove_header("Content-Length");
1965 $response->body('');
1968 $c->finalize_cookies;
1970 $c->response->finalize_headers();
1973 $response->finalized_headers(1);
1976 =head2 $c->finalize_output
1978 An alias for finalize_body.
1980 =head2 $c->finalize_read
1982 Finalizes the input after reading is complete.
1986 sub finalize_read { my $c = shift; $c->engine->finalize_read( $c, @_ ) }
1988 =head2 $c->finalize_uploads
1990 Finalizes uploads. Cleans up any temporary files.
1994 sub finalize_uploads { my $c = shift; $c->engine->finalize_uploads( $c, @_ ) }
1996 =head2 $c->get_action( $action, $namespace )
1998 Gets an action in a given namespace.
2002 sub get_action { my $c = shift; $c->dispatcher->get_action(@_) }
2004 =head2 $c->get_actions( $action, $namespace )
2006 Gets all actions of a given name in a namespace and all parent
2011 sub get_actions { my $c = shift; $c->dispatcher->get_actions( $c, @_ ) }
2013 =head2 $app->handle_request( @arguments )
2015 Called to handle each HTTP request.
2019 sub handle_request {
2020 my ( $class, @arguments ) = @_;
2022 # Always expect worst case!
2025 if ($class->debug) {
2026 my $secs = time - $START || 1;
2027 my $av = sprintf '%.3f', $COUNT / $secs;
2028 my $time = localtime time;
2029 $class->log->info("*** Request $COUNT ($av/s) [$$] [$time] ***");
2032 my $c = $class->prepare(@arguments);
2034 $status = $c->finalize;
2037 chomp(my $error = $_);
2038 $class->log->error(qq/Caught exception in engine "$error"/);
2043 if(my $coderef = $class->log->can('_flush')){
2044 $class->log->$coderef();
2049 =head2 $class->prepare( @arguments )
2051 Creates a Catalyst context from an engine-specific request (Apache, CGI,
2058 predicate => '_has_uploadtmp',
2062 my ( $class, @arguments ) = @_;
2065 # After the app/ctxt split, this should become an attribute based on something passed
2066 # into the application.
2067 $class->context_class( ref $class || $class ) unless $class->context_class;
2069 my $uploadtmp = $class->config->{uploadtmp};
2070 my $c = $class->context_class->new({ $uploadtmp ? (_uploadtmp => $uploadtmp) : ()});
2072 $c->response->_context($c);
2074 #surely this is not the most efficient way to do things...
2075 $c->stats($class->stats_class->new)->enable($c->use_stats);
2076 if ( $c->debug || $c->config->{enable_catalyst_header} ) {
2077 $c->res->headers->header( 'X-Catalyst' => $Catalyst::VERSION );
2081 # Allow engine to direct the prepare flow (for POE)
2082 if ( my $prepare = $c->engine->can('prepare') ) {
2083 $c->engine->$prepare( $c, @arguments );
2086 $c->prepare_request(@arguments);
2087 $c->prepare_connection;
2088 $c->prepare_query_parameters;
2089 $c->prepare_headers; # Just hooks, no longer needed - they just
2090 $c->prepare_cookies; # cause the lazy attribute on req to build
2093 # Prepare the body for reading, either by prepare_body
2094 # or the user, if they are using $c->read
2097 # Parse the body unless the user wants it on-demand
2098 unless ( ref($c)->config->{parse_on_demand} ) {
2104 # VERY ugly and probably shouldn't rely on ->finalize actually working
2106 # failed prepare is always due to an invalid request, right?
2107 $c->response->status(400);
2108 $c->response->content_type('text/plain');
2109 $c->response->body('Bad Request');
2110 # Note we call finalize and then die here, which escapes
2111 # finalize being called in the enclosing block..
2112 # It in fact couldn't be called, as we don't return $c..
2113 # This is a mess - but I'm unsure you can fix this without
2114 # breaking compat for people doing crazy things (we should set
2115 # the 400 and just return the ctx here IMO, letting finalize get called
2126 =head2 $c->prepare_action
2128 Prepares action. See L<Catalyst::Dispatcher>.
2132 sub prepare_action { my $c = shift; $c->dispatcher->prepare_action( $c, @_ ) }
2134 =head2 $c->prepare_body
2136 Prepares message body.
2143 return if $c->request->_has_body;
2145 # Initialize on-demand data
2146 $c->engine->prepare_body( $c, @_ );
2147 $c->prepare_parameters;
2148 $c->prepare_uploads;
2151 =head2 $c->prepare_body_chunk( $chunk )
2153 Prepares a chunk of data before sending it to L<HTTP::Body>.
2155 See L<Catalyst::Engine>.
2159 sub prepare_body_chunk {
2161 $c->engine->prepare_body_chunk( $c, @_ );
2164 =head2 $c->prepare_body_parameters
2166 Prepares body parameters.
2170 sub prepare_body_parameters {
2172 $c->engine->prepare_body_parameters( $c, @_ );
2175 =head2 $c->prepare_connection
2177 Prepares connection.
2181 sub prepare_connection {
2183 # XXX - This is called on the engine (not the request) to maintain
2184 # Engine::PSGI back compat.
2185 $c->engine->prepare_connection($c);
2188 =head2 $c->prepare_cookies
2190 Prepares cookies by ensuring that the attribute on the request
2191 object has been built.
2195 sub prepare_cookies { my $c = shift; $c->request->cookies }
2197 =head2 $c->prepare_headers
2199 Prepares request headers by ensuring that the attribute on the request
2200 object has been built.
2204 sub prepare_headers { my $c = shift; $c->request->headers }
2206 =head2 $c->prepare_parameters
2208 Prepares parameters.
2212 sub prepare_parameters {
2214 $c->prepare_body_parameters;
2215 $c->engine->prepare_parameters( $c, @_ );
2218 =head2 $c->prepare_path
2220 Prepares path and base.
2224 sub prepare_path { my $c = shift; $c->engine->prepare_path( $c, @_ ) }
2226 =head2 $c->prepare_query_parameters
2228 Prepares query parameters.
2232 sub prepare_query_parameters {
2235 $c->engine->prepare_query_parameters( $c, @_ );
2238 =head2 $c->log_request
2240 Writes information about the request to the debug logs. This includes:
2244 =item * Request method, path, and remote IP address
2246 =item * Query keywords (see L<Catalyst::Request/query_keywords>)
2248 =item * Request parameters
2250 =item * File uploads
2259 return unless $c->debug;
2261 my($dump) = grep {$_->[0] eq 'Request' } $c->dump_these;
2262 my $request = $dump->[1];
2264 my ( $method, $path, $address ) = ( $request->method, $request->path, $request->address );
2266 $path = '/' unless length $path;
2268 $c->log->debug(qq/"$method" request for "$path" from "$address"/);
2270 $c->log_request_headers($request->headers);
2272 if ( my $keywords = $request->query_keywords ) {
2273 $c->log->debug("Query keywords are: $keywords");
2276 $c->log_request_parameters( query => $request->query_parameters, $request->_has_body ? (body => $request->body_parameters) : () );
2278 $c->log_request_uploads($request);
2281 =head2 $c->log_response
2283 Writes information about the response to the debug logs by calling
2284 C<< $c->log_response_status_line >> and C<< $c->log_response_headers >>.
2291 return unless $c->debug;
2293 my($dump) = grep {$_->[0] eq 'Response' } $c->dump_these;
2294 my $response = $dump->[1];
2296 $c->log_response_status_line($response);
2297 $c->log_response_headers($response->headers);
2300 =head2 $c->log_response_status_line($response)
2302 Writes one line of information about the response to the debug logs. This includes:
2306 =item * Response status code
2308 =item * Content-Type header (if present)
2310 =item * Content-Length header (if present)
2316 sub log_response_status_line {
2317 my ($c, $response) = @_;
2321 'Response Code: %s; Content-Type: %s; Content-Length: %s',
2322 $response->status || 'unknown',
2323 $response->headers->header('Content-Type') || 'unknown',
2324 $response->headers->header('Content-Length') || 'unknown'
2329 =head2 $c->log_response_headers($headers);
2331 Hook method which can be wrapped by plugins to log the response headers.
2332 No-op in the default implementation.
2336 sub log_response_headers {}
2338 =head2 $c->log_request_parameters( query => {}, body => {} )
2340 Logs request parameters to debug logs
2344 sub log_request_parameters {
2346 my %all_params = @_;
2348 return unless $c->debug;
2350 my $column_width = Catalyst::Utils::term_width() - 44;
2351 foreach my $type (qw(query body)) {
2352 my $params = $all_params{$type};
2353 next if ! keys %$params;
2354 my $t = Text::SimpleTable->new( [ 35, 'Parameter' ], [ $column_width, 'Value' ] );
2355 for my $key ( sort keys %$params ) {
2356 my $param = $params->{$key};
2357 my $value = defined($param) ? $param : '';
2358 $t->row( $key, ref $value eq 'ARRAY' ? ( join ', ', @$value ) : $value );
2360 $c->log->debug( ucfirst($type) . " Parameters are:\n" . $t->draw );
2364 =head2 $c->log_request_uploads
2366 Logs file uploads included in the request to the debug logs.
2367 The parameter name, filename, file type, and file size are all included in
2372 sub log_request_uploads {
2374 my $request = shift;
2375 return unless $c->debug;
2376 my $uploads = $request->uploads;
2377 if ( keys %$uploads ) {
2378 my $t = Text::SimpleTable->new(
2379 [ 12, 'Parameter' ],
2384 for my $key ( sort keys %$uploads ) {
2385 my $upload = $uploads->{$key};
2386 for my $u ( ref $upload eq 'ARRAY' ? @{$upload} : ($upload) ) {
2387 $t->row( $key, $u->filename, $u->type, $u->size );
2390 $c->log->debug( "File Uploads are:\n" . $t->draw );
2394 =head2 $c->log_request_headers($headers);
2396 Hook method which can be wrapped by plugins to log the request headers.
2397 No-op in the default implementation.
2401 sub log_request_headers {}
2403 =head2 $c->log_headers($type => $headers)
2405 Logs L<HTTP::Headers> (either request or response) to the debug logs.
2412 my $headers = shift; # an HTTP::Headers instance
2414 return unless $c->debug;
2416 my $column_width = Catalyst::Utils::term_width() - 28;
2417 my $t = Text::SimpleTable->new( [ 15, 'Header Name' ], [ $column_width, 'Value' ] );
2420 my ( $name, $value ) = @_;
2421 $t->row( $name, $value );
2424 $c->log->debug( ucfirst($type) . " Headers:\n" . $t->draw );
2428 =head2 $c->prepare_read
2430 Prepares the input for reading.
2434 sub prepare_read { my $c = shift; $c->engine->prepare_read( $c, @_ ) }
2436 =head2 $c->prepare_request
2438 Prepares the engine request.
2442 sub prepare_request { my $c = shift; $c->engine->prepare_request( $c, @_ ) }
2444 =head2 $c->prepare_uploads
2450 sub prepare_uploads {
2453 $c->engine->prepare_uploads( $c, @_ );
2456 =head2 $c->prepare_write
2458 Prepares the output for writing.
2462 sub prepare_write { my $c = shift; $c->engine->prepare_write( $c, @_ ) }
2464 =head2 $c->request_class
2466 Returns or sets the request class. Defaults to L<Catalyst::Request>.
2468 =head2 $c->response_class
2470 Returns or sets the response class. Defaults to L<Catalyst::Response>.
2472 =head2 $c->read( [$maxlength] )
2474 Reads a chunk of data from the request body. This method is designed to
2475 be used in a while loop, reading C<$maxlength> bytes on every call.
2476 C<$maxlength> defaults to the size of the request if not specified.
2478 You have to set C<< MyApp->config(parse_on_demand => 1) >> to use this
2481 Warning: If you use read(), Catalyst will not process the body,
2482 so you will not be able to access POST parameters or file uploads via
2483 $c->request. You must handle all body parsing yourself.
2487 sub read { my $c = shift; return $c->request->read( @_ ) }
2497 $app->_make_immutable_if_needed;
2498 $app->engine_loader->needs_psgi_engine_compat_hack ?
2499 $app->engine->run($app, @_) :
2500 $app->engine->run( $app, $app->_finalized_psgi_app, @_ );
2503 sub _make_immutable_if_needed {
2505 my $meta = find_meta($class);
2506 my $isa_ca = $class->isa('Class::Accessor::Fast') || $class->isa('Class::Accessor');
2509 && ! { $meta->immutable_options }->{replace_constructor}
2512 warn("You made your application class ($class) immutable, "
2513 . "but did not inline the\nconstructor. "
2514 . "This will break catalyst, as your app \@ISA "
2515 . "Class::Accessor(::Fast)?\nPlease pass "
2516 . "(replace_constructor => 1)\nwhen making your class immutable.\n");
2518 unless ($meta->is_immutable) {
2519 # XXX - FIXME warning here as you should make your app immutable yourself.
2520 $meta->make_immutable(
2521 replace_constructor => 1,
2526 =head2 $c->set_action( $action, $code, $namespace, $attrs )
2528 Sets an action in a given namespace.
2532 sub set_action { my $c = shift; $c->dispatcher->set_action( $c, @_ ) }
2534 =head2 $c->setup_actions($component)
2536 Sets up actions for a component.
2540 sub setup_actions { my $c = shift; $c->dispatcher->setup_actions( $c, @_ ) }
2542 =head2 $c->setup_components
2544 This method is called internally to set up the application's components.
2546 It finds modules by calling the L<locate_components> method, expands them to
2547 package names with the L<expand_component_module> method, and then installs
2548 each component into the application.
2550 The C<setup_components> config option is passed to both of the above methods.
2552 Installation of each component is performed by the L<setup_component> method,
2557 sub setup_components {
2560 my $config = $class->config->{ setup_components };
2562 my @comps = $class->locate_components($config);
2563 my %comps = map { $_ => 1 } @comps;
2565 my $deprecatedcatalyst_component_names = grep { /::[CMV]::/ } @comps;
2566 $class->log->warn(qq{Your application is using the deprecated ::[MVC]:: type naming scheme.\n}.
2567 qq{Please switch your class names to ::Model::, ::View:: and ::Controller: as appropriate.\n}
2568 ) if $deprecatedcatalyst_component_names;
2570 for my $component ( @comps ) {
2572 # We pass ignore_loaded here so that overlay files for (e.g.)
2573 # Model::DBI::Schema sub-classes are loaded - if it's in @comps
2574 # we know M::P::O found a file on disk so this is safe
2576 Catalyst::Utils::ensure_class_loaded( $component, { ignore_loaded => 1 } );
2579 for my $component (@comps) {
2580 my $instance = $class->components->{ $component } = $class->setup_component($component);
2581 my @expanded_components = $instance->can('expand_modules')
2582 ? $instance->expand_modules( $component, $config )
2583 : $class->expand_component_module( $component, $config );
2584 for my $component (@expanded_components) {
2585 next if $comps{$component};
2586 $class->components->{ $component } = $class->setup_component($component);
2591 =head2 $c->locate_components( $setup_component_config )
2593 This method is meant to provide a list of component modules that should be
2594 setup for the application. By default, it will use L<Module::Pluggable>.
2596 Specify a C<setup_components> config option to pass additional options directly
2597 to L<Module::Pluggable>. To add additional search paths, specify a key named
2598 C<search_extra> as an array reference. Items in the array beginning with C<::>
2599 will have the application class name prepended to them.
2603 sub locate_components {
2607 my @paths = qw( ::Controller ::C ::Model ::M ::View ::V );
2608 my $extra = delete $config->{ search_extra } || [];
2610 push @paths, @$extra;
2612 my $locator = Module::Pluggable::Object->new(
2613 search_path => [ map { s/^(?=::)/$class/; $_; } @paths ],
2617 # XXX think about ditching this sort entirely
2618 my @comps = sort { length $a <=> length $b } $locator->plugins;
2623 =head2 $c->expand_component_module( $component, $setup_component_config )
2625 Components found by C<locate_components> will be passed to this method, which
2626 is expected to return a list of component (package) names to be set up.
2630 sub expand_component_module {
2631 my ($class, $module) = @_;
2632 return Devel::InnerPackage::list_packages( $module );
2635 =head2 $c->setup_component
2639 sub setup_component {
2640 my( $class, $component ) = @_;
2642 unless ( $component->can( 'COMPONENT' ) ) {
2646 my $suffix = Catalyst::Utils::class2classsuffix( $component );
2647 my $config = $class->config->{ $suffix } || {};
2648 # Stash catalyst_component_name in the config here, so that custom COMPONENT
2649 # methods also pass it. local to avoid pointlessly shitting in config
2650 # for the debug screen, as $component is already the key name.
2651 local $config->{catalyst_component_name} = $component;
2653 my $instance = eval { $component->COMPONENT( $class, $config ); };
2655 if ( my $error = $@ ) {
2657 Catalyst::Exception->throw(
2658 message => qq/Couldn't instantiate component "$component", "$error"/
2662 unless (blessed $instance) {
2663 my $metaclass = Moose::Util::find_meta($component);
2664 my $method_meta = $metaclass->find_method_by_name('COMPONENT');
2665 my $component_method_from = $method_meta->associated_metaclass->name;
2666 my $value = defined($instance) ? $instance : 'undef';
2667 Catalyst::Exception->throw(
2669 qq/Couldn't instantiate component "$component", COMPONENT() method (from $component_method_from) didn't return an object-like value (value was $value)./
2675 =head2 $c->setup_dispatcher
2681 sub setup_dispatcher {
2682 my ( $class, $dispatcher ) = @_;
2685 $dispatcher = 'Catalyst::Dispatcher::' . $dispatcher;
2688 if ( my $env = Catalyst::Utils::env_value( $class, 'DISPATCHER' ) ) {
2689 $dispatcher = 'Catalyst::Dispatcher::' . $env;
2692 unless ($dispatcher) {
2693 $dispatcher = $class->dispatcher_class;
2696 load_class($dispatcher);
2698 # dispatcher instance
2699 $class->dispatcher( $dispatcher->new );
2702 =head2 $c->setup_engine
2709 my ($class, $requested_engine) = @_;
2711 if (!$class->engine_loader || $requested_engine) {
2712 $class->engine_loader(
2713 Catalyst::EngineLoader->new({
2714 application_name => $class,
2715 (defined $requested_engine
2716 ? (catalyst_engine_class => $requested_engine) : ()),
2721 $class->engine_loader->catalyst_engine_class;
2725 my ($class, $requested_engine) = @_;
2728 my $loader = $class->engine_loader;
2730 if (!$loader || $requested_engine) {
2731 $loader = Catalyst::EngineLoader->new({
2732 application_name => $class,
2733 (defined $requested_engine
2734 ? (requested_engine => $requested_engine) : ()),
2737 $class->engine_loader($loader);
2740 $loader->catalyst_engine_class;
2743 # Don't really setup_engine -- see _setup_psgi_app for explanation.
2744 return if $class->loading_psgi_file;
2746 load_class($engine);
2748 if ($ENV{MOD_PERL}) {
2749 my $apache = $class->engine_loader->auto;
2751 my $meta = find_meta($class);
2752 my $was_immutable = $meta->is_immutable;
2753 my %immutable_options = $meta->immutable_options;
2754 $meta->make_mutable if $was_immutable;
2756 $meta->add_method(handler => sub {
2758 my $psgi_app = $class->_finalized_psgi_app;
2759 $apache->call_app($r, $psgi_app);
2762 $meta->make_immutable(%immutable_options) if $was_immutable;
2765 $class->engine( $engine->new );
2770 ## This exists just to supply a prebuild psgi app for mod_perl and for the
2771 ## build in server support (back compat support for pre psgi port behavior).
2772 ## This is so that we don't build a new psgi app for each request when using
2773 ## the mod_perl handler or the built in servers (http and fcgi, etc).
2775 sub _finalized_psgi_app {
2778 unless ($app->_psgi_app) {
2779 my $psgi_app = $app->_setup_psgi_app;
2780 $app->_psgi_app($psgi_app);
2783 return $app->_psgi_app;
2786 ## Look for a psgi file like 'myapp_web.psgi' (if the app is MyApp::Web) in the
2787 ## home directory and load that and return it (just assume it is doing the
2788 ## right thing :) ). If that does not exist, call $app->psgi_app, wrap that
2789 ## in default_middleware and return it ( this is for backward compatibility
2790 ## with pre psgi port behavior ).
2792 sub _setup_psgi_app {
2795 for my $home (Path::Class::Dir->new($app->config->{home})) {
2796 my $psgi_file = $home->file(
2797 Catalyst::Utils::appprefix($app) . '.psgi',
2800 next unless -e $psgi_file;
2802 # If $psgi_file calls ->setup_engine, it's doing so to load
2803 # Catalyst::Engine::PSGI. But if it does that, we're only going to
2804 # throw away the loaded PSGI-app and load the 5.9 Catalyst::Engine
2805 # anyway. So set a flag (ick) that tells setup_engine not to populate
2806 # $c->engine or do any other things we might regret.
2808 $app->loading_psgi_file(1);
2809 my $psgi_app = Plack::Util::load_psgi($psgi_file);
2810 $app->loading_psgi_file(0);
2813 unless $app->engine_loader->needs_psgi_engine_compat_hack;
2816 Found a legacy Catalyst::Engine::PSGI .psgi file at ${psgi_file}.
2818 Its content has been ignored. Please consult the Catalyst::Upgrading
2819 documentation on how to upgrade from Catalyst::Engine::PSGI.
2823 return $app->apply_default_middlewares($app->psgi_app);
2826 =head2 $c->apply_default_middlewares
2828 Adds the following L<Plack> middlewares to your application, since they are
2829 useful and commonly needed:
2831 L<Plack::Middleware::ReverseProxy>, (conditionally added based on the status
2832 of your $ENV{REMOTE_ADDR}, and can be forced on with C<using_frontend_proxy>
2833 or forced off with C<ignore_frontend_proxy>), L<Plack::Middleware::LighttpdScriptNameFix>
2834 (if you are using Lighttpd), L<Plack::Middleware::IIS6ScriptNameFix> (always
2835 applied since this middleware is smart enough to conditionally apply itself).
2837 Additionally if we detect we are using Nginx, we add a bit of custom middleware
2838 to solve some problems with the way that server handles $ENV{PATH_INFO} and
2844 sub apply_default_middlewares {
2845 my ($app, $psgi_app) = @_;
2847 $psgi_app = Plack::Middleware::Conditional->wrap(
2849 builder => sub { Plack::Middleware::ReverseProxy->wrap($_[0]) },
2852 return if $app->config->{ignore_frontend_proxy};
2853 return $env->{REMOTE_ADDR} eq '127.0.0.1'
2854 || $app->config->{using_frontend_proxy};
2858 # If we're running under Lighttpd, swap PATH_INFO and SCRIPT_NAME
2859 # http://lists.scsys.co.uk/pipermail/catalyst/2006-June/008361.html
2860 $psgi_app = Plack::Middleware::Conditional->wrap(
2862 builder => sub { Plack::Middleware::LighttpdScriptNameFix->wrap($_[0]) },
2865 return unless $env->{SERVER_SOFTWARE} && $env->{SERVER_SOFTWARE} =~ m!lighttpd[-/]1\.(\d+\.\d+)!;
2866 return unless $1 < 4.23;
2871 # we're applying this unconditionally as the middleware itself already makes
2872 # sure it doesn't fuck things up if it's not running under one of the right
2874 $psgi_app = Plack::Middleware::IIS6ScriptNameFix->wrap($psgi_app);
2876 # And another IIS issue, this time with IIS7.
2877 $psgi_app = Plack::Middleware::Conditional->wrap(
2879 builder => sub { Plack::Middleware::IIS7KeepAliveFix->wrap($_[0]) },
2882 return $env->{SERVER_SOFTWARE} && $env->{SERVER_SOFTWARE} =~ m!IIS/7\.[0-9]!;
2891 Returns a PSGI application code reference for the catalyst application
2892 C<$c>. This is the bare application without any middlewares
2893 applied. C<${myapp}.psgi> is not taken into account.
2895 This is what you want to be using to retrieve the PSGI application code
2896 reference of your Catalyst application for use in F<.psgi> files.
2902 my $psgi = $app->engine->build_psgi_app($app);
2903 return $app->Catalyst::Utils::apply_registered_middleware($psgi);
2906 =head2 $c->setup_home
2908 Sets up the home directory.
2913 my ( $class, $home ) = @_;
2915 if ( my $env = Catalyst::Utils::env_value( $class, 'HOME' ) ) {
2919 $home ||= Catalyst::Utils::home($class);
2922 #I remember recently being scolded for assigning config values like this
2923 $class->config->{home} ||= $home;
2924 $class->config->{root} ||= Path::Class::Dir->new($home)->subdir('root');
2928 =head2 $c->setup_log
2930 Sets up log by instantiating a L<Catalyst::Log|Catalyst::Log> object and
2931 passing it to C<log()>. Pass in a comma-delimited list of levels to set the
2934 This method also installs a C<debug> method that returns a true value into the
2935 catalyst subclass if the "debug" level is passed in the comma-delimited list,
2936 or if the C<$CATALYST_DEBUG> environment variable is set to a true value.
2938 Note that if the log has already been setup, by either a previous call to
2939 C<setup_log> or by a call such as C<< __PACKAGE__->log( MyLogger->new ) >>,
2940 that this method won't actually set up the log object.
2945 my ( $class, $levels ) = @_;
2948 $levels =~ s/^\s+//;
2949 $levels =~ s/\s+$//;
2950 my %levels = map { $_ => 1 } split /\s*,\s*/, $levels;
2952 my $env_debug = Catalyst::Utils::env_value( $class, 'DEBUG' );
2953 if ( defined $env_debug ) {
2954 $levels{debug} = 1 if $env_debug; # Ugly!
2955 delete($levels{debug}) unless $env_debug;
2958 unless ( $class->log ) {
2959 $class->log( Catalyst::Log->new(keys %levels) );
2962 if ( $levels{debug} ) {
2963 Class::MOP::get_metaclass_by_name($class)->add_method('debug' => sub { 1 });
2964 $class->log->debug('Debug messages enabled');
2968 =head2 $c->setup_plugins
2974 =head2 $c->setup_stats
2976 Sets up timing statistics class.
2981 my ( $class, $stats ) = @_;
2983 Catalyst::Utils::ensure_class_loaded($class->stats_class);
2985 my $env = Catalyst::Utils::env_value( $class, 'STATS' );
2986 if ( defined($env) ? $env : ($stats || $class->debug ) ) {
2987 Class::MOP::get_metaclass_by_name($class)->add_method('use_stats' => sub { 1 });
2988 $class->log->debug('Statistics enabled');
2993 =head2 $c->registered_plugins
2995 Returns a sorted list of the plugins which have either been stated in the
2998 If passed a given plugin name, it will report a boolean value indicating
2999 whether or not that plugin is loaded. A fully qualified name is required if
3000 the plugin name does not begin with C<Catalyst::Plugin::>.
3002 if ($c->registered_plugins('Some::Plugin')) {
3010 sub registered_plugins {
3012 return sort keys %{ $proto->_plugins } unless @_;
3014 return 1 if exists $proto->_plugins->{$plugin};
3015 return exists $proto->_plugins->{"Catalyst::Plugin::$plugin"};
3018 sub _register_plugin {
3019 my ( $proto, $plugin, $instant ) = @_;
3020 my $class = ref $proto || $proto;
3022 load_class( $plugin );
3023 $class->log->warn( "$plugin inherits from 'Catalyst::Component' - this is deprecated and will not work in 5.81" )
3024 if $plugin->isa( 'Catalyst::Component' );
3025 my $plugin_meta = Moose::Meta::Class->create($plugin);
3026 if (!$plugin_meta->has_method('new')
3027 && ( $plugin->isa('Class::Accessor::Fast') || $plugin->isa('Class::Accessor') ) ) {
3028 $plugin_meta->add_method('new', Moose::Object->meta->get_method('new'))
3030 if (!$instant && !$proto->_plugins->{$plugin}) {
3031 my $meta = Class::MOP::get_metaclass_by_name($class);
3032 $meta->superclasses($plugin, $meta->superclasses);
3034 $proto->_plugins->{$plugin} = 1;
3038 sub _default_plugins { return qw(Unicode::Encoding) }
3041 my ( $class, $plugins ) = @_;
3043 $class->_plugins( {} ) unless $class->_plugins;
3045 m/Unicode::Encoding/ ? do {
3047 'Unicode::Encoding plugin is auto-applied,'
3048 . ' please remove this from your appclass'
3049 . ' and make sure to define "encoding" config'
3051 unless (exists $class->config->{'encoding'}) {
3052 $class->config->{'encoding'} = 'UTF-8';
3057 push @$plugins, $class->_default_plugins;
3058 $plugins = Data::OptList::mkopt($plugins || []);
3061 [ Catalyst::Utils::resolve_namespace(
3062 $class . '::Plugin',
3063 'Catalyst::Plugin', $_->[0]
3069 for my $plugin ( reverse @plugins ) {
3070 load_class($plugin->[0], $plugin->[1]);
3071 my $meta = find_meta($plugin->[0]);
3072 next if $meta && $meta->isa('Moose::Meta::Role');
3074 $class->_register_plugin($plugin->[0]);
3078 map { $_->[0]->name, $_->[1] }
3079 grep { blessed($_->[0]) && $_->[0]->isa('Moose::Meta::Role') }
3080 map { [find_meta($_->[0]), $_->[1]] }
3083 Moose::Util::apply_all_roles(
3089 =head2 registered_middlewares
3091 Read only accessor that returns an array of all the middleware in the order
3092 that they were added (which is the REVERSE of the order they will be applied).
3094 The values returned will be either instances of L<Plack::Middleware> or of a
3095 compatible interface, or a coderef, which is assumed to be inlined middleware
3097 =head2 setup_middleware (?@middleware)
3099 Read configuration information stored in configuration key C<psgi_middleware> or
3102 See under L</CONFIGURATION> information regarding C<psgi_middleware> and how
3103 to use it to enable L<Plack::Middleware>
3105 This method is automatically called during 'setup' of your application, so
3106 you really don't need to invoke it.
3108 When we read middleware definitions from configuration, we reverse the list
3109 which sounds odd but is likely how you expect it to work if you have prior
3110 experience with L<Plack::Builder> or if you previously used the plugin
3111 L<Catalyst::Plugin::EnableMiddleware> (which is now considered deprecated)
3115 sub registered_middlewares {
3117 if(my $middleware = $class->_psgi_middleware) {
3118 return @$middleware;
3120 die "You cannot call ->registered_middlewares until middleware has been setup";
3124 sub setup_middleware {
3125 my ($class, @middleware_definitions) = @_;
3126 push @middleware_definitions, reverse(
3127 @{$class->config->{'psgi_middleware'}||[]});
3129 my @middleware = ();
3130 while(my $next = shift(@middleware_definitions)) {
3132 if(Scalar::Util::blessed $next && $next->can('wrap')) {
3133 push @middleware, $next;
3134 } elsif(ref $next eq 'CODE') {
3135 push @middleware, $next;
3136 } elsif(ref $next eq 'HASH') {
3137 my $namespace = shift @middleware_definitions;
3138 my $mw = $class->Catalyst::Utils::build_middleware($namespace, %$next);
3139 push @middleware, $mw;
3141 die "I can't handle middleware definition ${\ref $next}";
3144 my $mw = $class->Catalyst::Utils::build_middleware($next);
3145 push @middleware, $mw;
3149 $class->_psgi_middleware(\@middleware);
3152 =head2 registered_data_handlers
3154 A read only copy of registered Data Handlers returned as a Hash, where each key
3155 is a content type and each value is a subref that attempts to decode that content
3158 =head2 setup_data_handlers (?@data_handler)
3160 Read configuration information stored in configuration key C<data_handlers> or
3163 See under L</CONFIGURATION> information regarding C<data_handlers>.
3165 This method is automatically called during 'setup' of your application, so
3166 you really don't need to invoke it.
3168 =head2 default_data_handlers
3170 Default Data Handlers that come bundled with L<Catalyst>. Currently there is
3171 only one default data handler, for 'application/json'. This is used to parse
3172 incoming JSON into a Perl data structure. It used either L<JSON::MaybeXS> or
3173 L<JSON>, depending on which is installed. This allows you to fail back to
3174 L<JSON:PP>, which is a Pure Perl JSON decoder, and has the smallest dependency
3177 Because we don't wish to add more dependencies to L<Catalyst>, if you wish to
3178 use this new feature we recommend installing L<JSON> or L<JSON::MaybeXS> in
3179 order to get the best performance. You should add either to your dependency
3180 list (Makefile.PL, dist.ini, cpanfile, etc.)
3184 sub registered_data_handlers {
3186 if(my $data_handlers = $class->_data_handlers) {
3187 return %$data_handlers;
3189 die "You cannot call ->registered_data_handlers until data_handers has been setup";
3193 sub setup_data_handlers {
3194 my ($class, %data_handler_callbacks) = @_;
3195 %data_handler_callbacks = (
3196 %{$class->default_data_handlers},
3197 %{$class->config->{'data_handlers'}||+{}},
3198 %data_handler_callbacks);
3200 $class->_data_handlers(\%data_handler_callbacks);
3203 sub default_data_handlers {
3206 'application/json' => sub {
3207 Class::Load::load_first_existing_class('JSON::MaybeXS', 'JSON')
3208 ->can('decode_json')->(do { local $/; $_->getline });
3215 Returns an arrayref of the internal execution stack (actions that are
3216 currently executing).
3220 Returns the current timing statistics object. By default Catalyst uses
3221 L<Catalyst::Stats|Catalyst::Stats>, but can be set otherwise with
3222 L<< stats_class|/"$c->stats_class" >>.
3224 Even if L<< -Stats|/"-Stats" >> is not enabled, the stats object is still
3225 available. By enabling it with C< $c->stats->enabled(1) >, it can be used to
3226 profile explicitly, although MyApp.pm still won't profile nor output anything
3229 =head2 $c->stats_class
3231 Returns or sets the stats (timing statistics) class. L<Catalyst::Stats|Catalyst::Stats> is used by default.
3233 =head2 $c->use_stats
3235 Returns 1 when L<< stats collection|/"-Stats" >> is enabled.
3237 Note that this is a static method, not an accessor and should be overridden
3238 by declaring C<sub use_stats { 1 }> in your MyApp.pm, not by calling C<< $c->use_stats(1) >>.
3245 =head2 $c->write( $data )
3247 Writes $data to the output stream. When using this method directly, you
3248 will need to manually set the C<Content-Length> header to the length of
3249 your output data, if known.
3256 # Finalize headers if someone manually writes output (for compat)
3257 $c->finalize_headers;
3259 return $c->response->write( @_ );
3264 Returns the Catalyst version number. Mostly useful for "powered by"
3265 messages in template systems.
3269 sub version { return $Catalyst::VERSION }
3271 =head1 CONFIGURATION
3273 There are a number of 'base' config variables which can be set:
3279 C<default_model> - The default model picked if you say C<< $c->model >>. See L<< /$c->model($name) >>.
3283 C<default_view> - The default view to be rendered or returned when C<< $c->view >> is called. See L<< /$c->view($name) >>.
3287 C<disable_component_resolution_regex_fallback> - Turns
3288 off the deprecated component resolution functionality so
3289 that if any of the component methods (e.g. C<< $c->controller('Foo') >>)
3290 are called then regex search will not be attempted on string values and
3291 instead C<undef> will be returned.
3295 C<home> - The application home directory. In an uninstalled application,
3296 this is the top level application directory. In an installed application,
3297 this will be the directory containing C<< MyApp.pm >>.
3301 C<ignore_frontend_proxy> - See L</PROXY SUPPORT>
3305 C<name> - The name of the application in debug messages and the debug and
3310 C<parse_on_demand> - The request body (for example file uploads) will not be parsed
3311 until it is accessed. This allows you to (for example) check authentication (and reject
3312 the upload) before actually receiving all the data. See L</ON-DEMAND PARSER>
3316 C<root> - The root directory for templates. Usually this is just a
3317 subdirectory of the home directory, but you can set it to change the
3318 templates to a different directory.
3322 C<search_extra> - Array reference passed to Module::Pluggable to for additional
3323 namespaces from which components will be loaded (and constructed and stored in
3324 C<< $c->components >>).
3328 C<show_internal_actions> - If true, causes internal actions such as C<< _DISPATCH >>
3329 to be shown in hit debug tables in the test server.
3333 C<use_request_uri_for_path> - Controls if the C<REQUEST_URI> or C<PATH_INFO> environment
3334 variable should be used for determining the request path.
3336 Most web server environments pass the requested path to the application using environment variables,
3337 from which Catalyst has to reconstruct the request base (i.e. the top level path to / in the application,
3338 exposed as C<< $c->request->base >>) and the request path below that base.
3340 There are two methods of doing this, both of which have advantages and disadvantages. Which method is used
3341 is determined by the C<< $c->config(use_request_uri_for_path) >> setting (which can either be true or false).
3345 =item use_request_uri_for_path => 0
3347 This is the default (and the) traditional method that Catalyst has used for determining the path information.
3348 The path is generated from a combination of the C<PATH_INFO> and C<SCRIPT_NAME> environment variables.
3349 The allows the application to behave correctly when C<mod_rewrite> is being used to redirect requests
3350 into the application, as these variables are adjusted by mod_rewrite to take account for the redirect.
3352 However this method has the major disadvantage that it is impossible to correctly decode some elements
3353 of the path, as RFC 3875 says: "C<< Unlike a URI path, the PATH_INFO is not URL-encoded, and cannot
3354 contain path-segment parameters. >>" This means PATH_INFO is B<always> decoded, and therefore Catalyst
3355 can't distinguish / vs %2F in paths (in addition to other encoded values).
3357 =item use_request_uri_for_path => 1
3359 This method uses the C<REQUEST_URI> and C<SCRIPT_NAME> environment variables. As C<REQUEST_URI> is never
3360 decoded, this means that applications using this mode can correctly handle URIs including the %2F character
3361 (i.e. with C<AllowEncodedSlashes> set to C<On> in Apache).
3363 Given that this method of path resolution is provably more correct, it is recommended that you use
3364 this unless you have a specific need to deploy your application in a non-standard environment, and you are
3365 aware of the implications of not being able to handle encoded URI paths correctly.
3367 However it also means that in a number of cases when the app isn't installed directly at a path, but instead
3368 is having paths rewritten into it (e.g. as a .cgi/fcgi in a public_html directory, with mod_rewrite in a
3369 .htaccess file, or when SSI is used to rewrite pages into the app, or when sub-paths of the app are exposed
3370 at other URIs than that which the app is 'normally' based at with C<mod_rewrite>), the resolution of
3371 C<< $c->request->base >> will be incorrect.
3377 C<using_frontend_proxy> - See L</PROXY SUPPORT>.
3381 C<encoding> - See L</ENCODING>
3385 C<abort_chain_on_error_fix>
3387 When there is an error in an action chain, the default behavior is to continue
3388 processing the remaining actions and then catch the error upon chain end. This
3389 can lead to running actions when the application is in an unexpected state. If
3390 you have this issue, setting this config value to true will promptly exit a
3391 chain when there is an error raised in any action (thus terminating the chain
3396 __PACKAGE__->config(abort_chain_on_error_fix => 1);
3398 In the future this might become the default behavior.
3402 C<use_hash_multivalue_in_request>
3404 In L<Catalyst::Request> the methods C<query_parameters>, C<body_parametes>
3405 and C<parameters> return a hashref where values might be scalar or an arrayref
3406 depending on the incoming data. In many cases this can be undesirable as it
3407 leads one to writing defensive code like the following:
3409 my ($val) = ref($c->req->parameters->{a}) ?
3410 @{$c->req->parameters->{a}} :
3411 $c->req->parameters->{a};
3413 Setting this configuration item to true will make L<Catalyst> populate the
3414 attributes underlying these methods with an instance of L<Hash::MultiValue>
3415 which is used by L<Plack::Request> and others to solve this very issue. You
3416 may prefer this behavior to the default, if so enable this option (be warned
3417 if you enable it in a legacy application we are not sure if it is completely
3418 backwardly compatible).
3422 C<psgi_middleware> - See L<PSGI MIDDLEWARE>.
3426 C<data_handlers> - See L<DATA HANDLERS>.
3430 =head1 INTERNAL ACTIONS
3432 Catalyst uses internal actions like C<_DISPATCH>, C<_BEGIN>, C<_AUTO>,
3433 C<_ACTION>, and C<_END>. These are by default not shown in the private
3434 action table, but you can make them visible with a config parameter.
3436 MyApp->config(show_internal_actions => 1);
3438 =head1 ON-DEMAND PARSER
3440 The request body is usually parsed at the beginning of a request,
3441 but if you want to handle input yourself, you can enable on-demand
3442 parsing with a config parameter.
3444 MyApp->config(parse_on_demand => 1);
3446 =head1 PROXY SUPPORT
3448 Many production servers operate using the common double-server approach,
3449 with a lightweight frontend web server passing requests to a larger
3450 backend server. An application running on the backend server must deal
3451 with two problems: the remote user always appears to be C<127.0.0.1> and
3452 the server's hostname will appear to be C<localhost> regardless of the
3453 virtual host that the user connected through.
3455 Catalyst will automatically detect this situation when you are running
3456 the frontend and backend servers on the same machine. The following
3457 changes are made to the request.
3459 $c->req->address is set to the user's real IP address, as read from
3460 the HTTP X-Forwarded-For header.
3462 The host value for $c->req->base and $c->req->uri is set to the real
3463 host, as read from the HTTP X-Forwarded-Host header.
3465 Additionally, you may be running your backend application on an insecure
3466 connection (port 80) while your frontend proxy is running under SSL. If there
3467 is a discrepancy in the ports, use the HTTP header C<X-Forwarded-Port> to
3468 tell Catalyst what port the frontend listens on. This will allow all URIs to
3469 be created properly.
3471 In the case of passing in:
3473 X-Forwarded-Port: 443
3475 All calls to C<uri_for> will result in an https link, as is expected.
3477 Obviously, your web server must support these headers for this to work.
3479 In a more complex server farm environment where you may have your
3480 frontend proxy server(s) on different machines, you will need to set a
3481 configuration option to tell Catalyst to read the proxied data from the
3484 MyApp->config(using_frontend_proxy => 1);
3486 If you do not wish to use the proxy support at all, you may set:
3488 MyApp->config(ignore_frontend_proxy => 0);
3490 =head2 Note about psgi files
3492 Note that if you supply your own .psgi file, calling
3493 C<< MyApp->psgi_app(@_); >>, then B<this will not happen automatically>.
3495 You either need to apply L<Plack::Middleware::ReverseProxy> yourself
3496 in your psgi, for example:
3499 enable "Plack::Middleware::ReverseProxy";
3503 This will unconditionally add the ReverseProxy support, or you need to call
3504 C<< $app = MyApp->apply_default_middlewares($app) >> (to conditionally
3505 apply the support depending upon your config).
3507 See L<Catalyst::PSGI> for more information.
3509 =head1 THREAD SAFETY
3511 Catalyst has been tested under Apache 2's threading C<mpm_worker>,
3512 C<mpm_winnt>, and the standalone forking HTTP server on Windows. We
3513 believe the Catalyst core to be thread-safe.
3515 If you plan to operate in a threaded environment, remember that all other
3516 modules you are using must also be thread-safe. Some modules, most notably
3517 L<DBD::SQLite>, are not thread-safe.
3519 =head1 DATA HANDLERS
3521 The L<Catalyst::Request> object uses L<HTTP::Body> to populate 'classic' HTML
3522 form parameters and URL search query fields. However it has become common
3523 for various alternative content types to be PUT or POSTed to your controllers
3524 and actions. People working on RESTful APIs, or using AJAX often use JSON,
3525 XML and other content types when communicating with an application server. In
3526 order to better support this use case, L<Catalyst> defines a global configuration
3527 option, C<data_handlers>, which lets you associate a content type with a coderef
3528 that parses that content type into something Perl can readily access.
3535 __PACKAGE__->config(
3537 'application/json' => sub { local $/; decode_json $_->getline },
3539 ## Any other configuration.
3544 By default L<Catalyst> comes with a generic JSON data handler similar to the
3545 example given above, which uses L<JSON::Maybe> to provide either L<JSON::PP>
3546 (a pure Perl, dependency free JSON parser) or L<Cpanel::JSON::XS> if you have
3547 it installed (if you want the faster XS parser, add it to you project Makefile.PL
3548 or dist.ini, cpanfile, etc.)
3550 The C<data_handlers> configuation is a hashref whose keys are HTTP Content-Types
3551 (matched against the incoming request type using a regexp such as to be case
3552 insensitive) and whose values are coderefs that receive a localized version of
3553 C<$_> which is a filehandle object pointing to received body.
3555 This feature is considered an early access release and we reserve the right
3556 to alter the interface in order to provide a performant and secure solution to
3557 alternative request body content. Your reports welcomed!
3559 =head1 PSGI MIDDLEWARE
3561 You can define middleware, defined as L<Plack::Middleware> or a compatible
3562 interface in configuration. Your middleware definitions are in the form of an
3563 arrayref under the configuration key C<psgi_middleware>. Here's an example
3564 with details to follow:
3569 use Plack::Middleware::StackTrace;
3571 my $stacktrace_middleware = Plack::Middleware::StackTrace->new;
3573 __PACKAGE__->config(
3574 'psgi_middleware', [
3577 $stacktrace_middleware,
3578 'Session' => {store => 'File'},
3583 $env->{myapp.customkey} = 'helloworld';
3592 So the general form is:
3594 __PACKAGE__->config(psgi_middleware => \@middleware_definitions);
3596 Where C<@middleware> is one or more of the following, applied in the REVERSE of
3597 the order listed (to make it function similarly to L<Plack::Builder>:
3601 =item Middleware Object
3603 An already initialized object that conforms to the L<Plack::Middleware>
3606 my $stacktrace_middleware = Plack::Middleware::StackTrace->new;
3608 __PACKAGE__->config(
3609 'psgi_middleware', [
3610 $stacktrace_middleware,
3616 A coderef that is an inlined middleware:
3618 __PACKAGE__->config(
3619 'psgi_middleware', [
3624 if($env->{PATH_INFO} =~m/forced/) {
3626 ->new(file=>TestApp->path_to(qw/share static forced.txt/))
3629 return $app->($env);
3639 We assume the scalar refers to a namespace after normalizing it using the
3642 (1) If the scalar is prefixed with a "+" (as in C<+MyApp::Foo>) then the full string
3643 is assumed to be 'as is', and we just install and use the middleware.
3645 (2) If the scalar begins with "Plack::Middleware" or your application namespace
3646 (the package name of your Catalyst application subclass), we also assume then
3647 that it is a full namespace, and use it.
3649 (3) Lastly, we then assume that the scalar is a partial namespace, and attempt to
3650 resolve it first by looking for it under your application namespace (for example
3651 if you application is "MyApp::Web" and the scalar is "MyMiddleware", we'd look
3652 under "MyApp::Web::Middleware::MyMiddleware") and if we don't find it there, we
3653 will then look under the regular L<Plack::Middleware> namespace (i.e. for the
3654 previous we'd try "Plack::Middleware::MyMiddleware"). We look under your application
3655 namespace first to let you 'override' common L<Plack::Middleware> locally, should
3656 you find that a good idea.
3662 __PACKAGE__->config(
3663 'psgi_middleware', [
3664 'Debug', ## MyAppWeb::Middleware::Debug->wrap or Plack::Middleware::Debug->wrap
3665 'Plack::Middleware::Stacktrace', ## Plack::Middleware::Stacktrace->wrap
3666 '+MyApp::Custom', ## MyApp::Custom->wrap
3670 =item a scalar followed by a hashref
3672 Just like the previous, except the following C<HashRef> is used as arguments
3673 to initialize the middleware object.
3675 __PACKAGE__->config(
3676 'psgi_middleware', [
3677 'Session' => {store => 'File'},
3682 Please see L<PSGI> for more on middleware.
3686 On request, decodes all params from encoding into a sequence of
3687 logical characters. On response, encodes body into encoding.
3695 Returns an instance of an C<Encode> encoding
3697 print $c->encoding->name
3699 =item handle_unicode_encoding_exception ($exception_context)
3701 Method called when decoding process for a request fails.
3703 An C<$exception_context> hashref is provided to allow you to override the
3704 behaviour of your application when given data with incorrect encodings.
3706 The default method throws exceptions in the case of invalid request parameters
3707 (resulting in a 500 error), but ignores errors in upload filenames.
3709 The keys passed in the C<$exception_context> hash are:
3715 The value which was not able to be decoded.
3719 The exception received from L<Encode>.
3723 What type of data was being decoded. Valid values are (currently)
3724 C<params> - for request parameters / arguments / captures
3725 and C<uploads> - for request upload filenames.
3735 Join #catalyst on irc.perl.org.
3739 http://lists.scsys.co.uk/cgi-bin/mailman/listinfo/catalyst
3740 http://lists.scsys.co.uk/cgi-bin/mailman/listinfo/catalyst-dev
3744 http://catalyst.perl.org
3748 http://dev.catalyst.perl.org
3752 =head2 L<Task::Catalyst> - All you need to start with Catalyst
3754 =head2 L<Catalyst::Manual> - The Catalyst Manual
3756 =head2 L<Catalyst::Component>, L<Catalyst::Controller> - Base classes for components
3758 =head2 L<Catalyst::Engine> - Core engine
3760 =head2 L<Catalyst::Log> - Log class.
3762 =head2 L<Catalyst::Request> - Request object
3764 =head2 L<Catalyst::Response> - Response object
3766 =head2 L<Catalyst::Test> - The test suite.
3768 =head1 PROJECT FOUNDER
3770 sri: Sebastian Riedel <sri@cpan.org>
3776 acme: Leon Brocard <leon@astray.com>
3778 abraxxa: Alexander Hartmaier <abraxxa@cpan.org>
3782 Andrew Ford E<lt>A.Ford@ford-mason.co.ukE<gt>
3786 andyg: Andy Grundman <andy@hybridized.org>
3788 audreyt: Audrey Tang
3790 bricas: Brian Cassidy <bricas@cpan.org>
3792 Caelum: Rafael Kitover <rkitover@io.com>
3794 chansen: Christian Hansen
3796 chicks: Christopher Hicks
3798 Chisel Wright C<pause@herlpacker.co.uk>
3800 Danijel Milicevic C<me@danijel.de>
3802 David Kamholz E<lt>dkamholz@cpan.orgE<gt>
3804 David Naughton, C<naughton@umn.edu>
3808 dhoss: Devin Austin <dhoss@cpan.org>
3810 dkubb: Dan Kubb <dan.kubb-cpan@onautopilot.com>
3814 dwc: Daniel Westermann-Clark <danieltwc@cpan.org>
3816 esskar: Sascha Kiefer
3818 fireartist: Carl Franks <cfranks@cpan.org>
3820 frew: Arthur Axel "fREW" Schmidt <frioux@gmail.com>
3822 gabb: Danijel Milicevic
3826 Gavin Henry C<ghenry@perl.me.uk>
3830 groditi: Guillermo Roditi <groditi@gmail.com>
3832 hobbs: Andrew Rodland <andrew@cleverdomain.org>
3834 ilmari: Dagfinn Ilmari Mannsåker <ilmari@ilmari.org>
3836 jcamacho: Juan Camacho
3838 jester: Jesse Sheidlower C<jester@panix.com>
3840 jhannah: Jay Hannah <jay@jays.net>
3846 jon: Jon Schutz <jjschutz@cpan.org>
3848 Jonathan Rockway C<< <jrockway@cpan.org> >>
3850 Kieren Diment C<kd@totaldatasolution.com>
3852 konobi: Scott McWhirter <konobi@cpan.org>
3854 marcus: Marcus Ramberg <mramberg@cpan.org>
3856 miyagawa: Tatsuhiko Miyagawa <miyagawa@bulknews.net>
3858 mgrimes: Mark Grimes <mgrimes@cpan.org>
3860 mst: Matt S. Trout <mst@shadowcatsystems.co.uk>
3864 naughton: David Naughton
3866 ningu: David Kamholz <dkamholz@cpan.org>
3868 nothingmuch: Yuval Kogman <nothingmuch@woobling.org>
3870 numa: Dan Sully <daniel@cpan.org>
3876 omega: Andreas Marienborg
3878 Oleg Kostyuk <cub.uanic@gmail.com>
3880 phaylon: Robert Sedlacek <phaylon@dunkelheit.at>
3882 rafl: Florian Ragwitz <rafl@debian.org>
3884 random: Roland Lammel <lammel@cpan.org>
3886 Robert Sedlacek C<< <rs@474.at> >>
3888 SpiceMan: Marcel Montes
3892 szbalint: Balint Szilakszi <szbalint@cpan.org>
3894 t0m: Tomas Doran <bobtfish@bobtfish.net>
3898 Viljo Marrandi C<vilts@yahoo.com>
3900 Will Hawes C<info@whawes.co.uk>
3902 willert: Sebastian Willert <willert@cpan.org>
3904 wreis: Wallace Reis <wreis@cpan.org>
3906 Yuval Kogman, C<nothingmuch@woobling.org>
3908 rainboxx: Matthias Dietrich, C<perl@rainboxx.de>
3910 dd070: Dhaval Dhanani <dhaval070@gmail.com>
3914 Copyright (c) 2005, the above named PROJECT FOUNDER and CONTRIBUTORS.
3918 This library is free software. You can redistribute it and/or modify it under
3919 the same terms as Perl itself.
3925 __PACKAGE__->meta->make_immutable;