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.90059_001';
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_plugins( delete $flags->{plugins} );
1129 # Call plugins setup, this is stupid and evil.
1130 # Also screws C3 badly on 5.10, hack to avoid.
1132 no warnings qw/redefine/;
1133 local *setup = sub { };
1134 $class->setup unless $Catalyst::__AM_RESTARTING;
1137 $class->setup_log( delete $flags->{log} );
1138 $class->setup_middleware();
1139 $class->setup_data_handlers();
1140 $class->setup_dispatcher( delete $flags->{dispatcher} );
1141 if (my $engine = delete $flags->{engine}) {
1142 $class->log->warn("Specifying the engine in ->setup is no longer supported, see Catalyst::Upgrading");
1144 $class->setup_engine();
1145 $class->setup_stats( delete $flags->{stats} );
1147 for my $flag ( sort keys %{$flags} ) {
1149 if ( my $code = $class->can( 'setup_' . $flag ) ) {
1150 &$code( $class, delete $flags->{$flag} );
1153 $class->log->warn(qq/Unknown flag "$flag"/);
1157 eval { require Catalyst::Devel; };
1158 if( !$@ && $ENV{CATALYST_SCRIPT_GEN} && ( $ENV{CATALYST_SCRIPT_GEN} < $Catalyst::Devel::CATALYST_SCRIPT_GEN ) ) {
1159 $class->log->warn(<<"EOF");
1160 You are running an old script!
1162 Please update by running (this will overwrite existing files):
1163 catalyst.pl -force -scripts $class
1165 or (this will not overwrite existing files):
1166 catalyst.pl -scripts $class
1171 # Initialize our data structure
1172 $class->components( {} );
1174 $class->setup_components;
1176 if ( $class->debug ) {
1177 my @plugins = map { "$_ " . ( $_->VERSION || '' ) } $class->registered_plugins;
1180 my $column_width = Catalyst::Utils::term_width() - 6;
1181 my $t = Text::SimpleTable->new($column_width);
1182 $t->row($_) for @plugins;
1183 $class->log->debug( "Loaded plugins:\n" . $t->draw . "\n" );
1186 my @middleware = map {
1189 (ref($_) .' '. ($_->can('VERSION') ? $_->VERSION || '' : '')
1190 || '') } $class->registered_middlewares;
1193 my $column_width = Catalyst::Utils::term_width() - 6;
1194 my $t = Text::SimpleTable->new($column_width);
1195 $t->row($_) for @middleware;
1196 $class->log->debug( "Loaded PSGI Middleware:\n" . $t->draw . "\n" );
1199 my %dh = $class->registered_data_handlers;
1200 if (my @data_handlers = keys %dh) {
1201 my $column_width = Catalyst::Utils::term_width() - 6;
1202 my $t = Text::SimpleTable->new($column_width);
1203 $t->row($_) for @data_handlers;
1204 $class->log->debug( "Loaded Request Data Handlers:\n" . $t->draw . "\n" );
1207 my $dispatcher = $class->dispatcher;
1208 my $engine = $class->engine;
1209 my $home = $class->config->{home};
1211 $class->log->debug(sprintf(q/Loaded dispatcher "%s"/, blessed($dispatcher)));
1212 $class->log->debug(sprintf(q/Loaded engine "%s"/, blessed($engine)));
1216 ? $class->log->debug(qq/Found home "$home"/)
1217 : $class->log->debug(qq/Home "$home" doesn't exist/)
1218 : $class->log->debug(q/Couldn't find home/);
1220 my $column_width = Catalyst::Utils::term_width() - 8 - 9;
1221 my $t = Text::SimpleTable->new( [ $column_width, 'Class' ], [ 8, 'Type' ] );
1222 for my $comp ( sort keys %{ $class->components } ) {
1223 my $type = ref $class->components->{$comp} ? 'instance' : 'class';
1224 $t->row( $comp, $type );
1226 $class->log->debug( "Loaded components:\n" . $t->draw . "\n" )
1227 if ( keys %{ $class->components } );
1230 # Add our self to components, since we are also a component
1231 if( $class->isa('Catalyst::Controller') ){
1232 $class->components->{$class} = $class;
1235 $class->setup_actions;
1237 if ( $class->debug ) {
1238 my $name = $class->config->{name} || 'Application';
1239 $class->log->info("$name powered by Catalyst $Catalyst::VERSION");
1242 if ($class->config->{case_sensitive}) {
1243 $class->log->warn($class . "->config->{case_sensitive} is set.");
1244 $class->log->warn("This setting is deprecated and planned to be removed in Catalyst 5.81.");
1247 $class->setup_finalize;
1248 # Should be the last thing we do so that user things hooking
1249 # setup_finalize can log..
1250 $class->log->_flush() if $class->log->can('_flush');
1251 return 1; # Explicit return true as people have __PACKAGE__->setup as the last thing in their class. HATE.
1254 =head2 $app->setup_finalize
1256 A hook to attach modifiers to. This method does not do anything except set the
1257 C<setup_finished> accessor.
1259 Applying method modifiers to the C<setup> method doesn't work, because of quirky things done for plugin setup.
1263 after setup_finalize => sub {
1271 sub setup_finalize {
1273 $class->setup_finished(1);
1276 =head2 $c->uri_for( $path?, @args?, \%query_values? )
1278 =head2 $c->uri_for( $action, \@captures?, @args?, \%query_values? )
1280 Constructs an absolute L<URI> object based on the application root, the
1281 provided path, and the additional arguments and query parameters provided.
1282 When used as a string, provides a textual URI. If you need more flexibility
1283 than this (i.e. the option to provide relative URIs etc.) see
1284 L<Catalyst::Plugin::SmartURI>.
1286 If no arguments are provided, the URI for the current action is returned.
1287 To return the current action and also provide @args, use
1288 C<< $c->uri_for( $c->action, @args ) >>.
1290 If the first argument is a string, it is taken as a public URI path relative
1291 to C<< $c->namespace >> (if it doesn't begin with a forward slash) or
1292 relative to the application root (if it does). It is then merged with
1293 C<< $c->request->base >>; any C<@args> are appended as additional path
1294 components; and any C<%query_values> are appended as C<?foo=bar> parameters.
1296 If the first argument is a L<Catalyst::Action> it represents an action which
1297 will have its path resolved using C<< $c->dispatcher->uri_for_action >>. The
1298 optional C<\@captures> argument (an arrayref) allows passing the captured
1299 variables that are needed to fill in the paths of Chained and Regex actions;
1300 once the path is resolved, C<uri_for> continues as though a path was
1301 provided, appending any arguments or parameters and creating an absolute
1304 The captures for the current request can be found in
1305 C<< $c->request->captures >>, and actions can be resolved using
1306 C<< Catalyst::Controller->action_for($name) >>. If you have a private action
1307 path, use C<< $c->uri_for_action >> instead.
1309 # Equivalent to $c->req->uri
1310 $c->uri_for($c->action, $c->req->captures,
1311 @{ $c->req->args }, $c->req->params);
1313 # For the Foo action in the Bar controller
1314 $c->uri_for($c->controller('Bar')->action_for('Foo'));
1316 # Path to a static resource
1317 $c->uri_for('/static/images/logo.png');
1322 my ( $c, $path, @args ) = @_;
1324 if ( $path->$_isa('Catalyst::Controller') ) {
1325 $path = $path->path_prefix;
1330 undef($path) if (defined $path && $path eq '');
1333 ( scalar @args && ref $args[$#args] eq 'HASH' ? pop @args : {} );
1335 carp "uri_for called with undef argument" if grep { ! defined $_ } @args;
1336 foreach my $arg (@args) {
1337 utf8::encode($arg) if utf8::is_utf8($arg);
1338 $arg =~ s/([^$URI::uric])/$URI::Escape::escapes{$1}/go;
1341 if ( $path->$_isa('Catalyst::Action') ) { # action object
1342 s|/|%2F|g for @args;
1343 my $captures = [ map { s|/|%2F|g; $_; }
1344 ( scalar @args && ref $args[0] eq 'ARRAY'
1348 foreach my $capture (@$captures) {
1349 utf8::encode($capture) if utf8::is_utf8($capture);
1350 $capture =~ s/([^$URI::uric])/$URI::Escape::escapes{$1}/go;
1354 # ->uri_for( $action, \@captures_and_args, \%query_values? )
1355 if( !@args && $action->number_of_args ) {
1356 my $expanded_action = $c->dispatcher->expand_action( $action );
1358 my $num_captures = $expanded_action->number_of_captures;
1359 unshift @args, splice @$captures, $num_captures;
1362 $path = $c->dispatcher->uri_for_action($action, $captures);
1363 if (not defined $path) {
1364 $c->log->debug(qq/Can't find uri_for action '$action' @$captures/)
1368 $path = '/' if $path eq '';
1371 unshift(@args, $path);
1373 unless (defined $path && $path =~ s!^/!!) { # in-place strip
1374 my $namespace = $c->namespace;
1375 if (defined $path) { # cheesy hack to handle path '../foo'
1376 $namespace =~ s{(?:^|/)[^/]+$}{} while $args[0] =~ s{^\.\./}{};
1378 unshift(@args, $namespace || '');
1381 # join args with '/', or a blank string
1382 my $args = join('/', grep { defined($_) } @args);
1383 $args =~ s/\?/%3F/g; # STUPID STUPID SPECIAL CASE
1386 my ($base, $class) = ('/', 'URI::_generic');
1388 $base = $c->req->base;
1389 $class = ref($base);
1390 $base =~ s{(?<!/)$}{/};
1395 if (my @keys = keys %$params) {
1396 # somewhat lifted from URI::_query's query_form
1397 $query = '?'.join('&', map {
1398 my $val = $params->{$_};
1399 s/([;\/?:@&=+,\$\[\]%])/$URI::Escape::escapes{$1}/go;
1402 $val = '' unless defined $val;
1405 utf8::encode( $param ) if utf8::is_utf8($param);
1406 # using the URI::Escape pattern here so utf8 chars survive
1407 $param =~ s/([^A-Za-z0-9\-_.!~*'() ])/$URI::Escape::escapes{$1}/go;
1409 "${key}=$param"; } ( ref $val eq 'ARRAY' ? @$val : $val ));
1413 my $res = bless(\"${base}${args}${query}", $class);
1417 =head2 $c->uri_for_action( $path, \@captures_and_args?, @args?, \%query_values? )
1419 =head2 $c->uri_for_action( $action, \@captures_and_args?, @args?, \%query_values? )
1425 A private path to the Catalyst action you want to create a URI for.
1427 This is a shortcut for calling C<< $c->dispatcher->get_action_by_path($path)
1428 >> and passing the resulting C<$action> and the remaining arguments to C<<
1431 You can also pass in a Catalyst::Action object, in which case it is passed to
1434 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.
1436 For example, if the action looks like:
1438 package MyApp::Controller::Users;
1440 sub lst : Path('the-list') {}
1444 $c->uri_for_action('/users/lst')
1446 and it will create the URI /users/the-list.
1448 =item \@captures_and_args?
1450 Optional array reference of Captures (i.e. C<<CaptureArgs or $c->req->captures>)
1451 and arguments to the request. Usually used with L<Catalyst::DispatchType::Chained>
1452 to interpolate all the parameters in the URI.
1456 Optional list of extra arguments - can be supplied in the
1457 C<< \@captures_and_args? >> array ref, or here - whichever is easier for your
1460 Your action can have zero, a fixed or a variable number of args (e.g.
1461 C<< Args(1) >> for a fixed number or C<< Args() >> for a variable number)..
1463 =item \%query_values?
1465 Optional array reference of query parameters to append. E.g.
1471 /rest/of/your/uri?foo=bar
1477 sub uri_for_action {
1478 my ( $c, $path, @args ) = @_;
1479 my $action = blessed($path)
1481 : $c->dispatcher->get_action_by_path($path);
1482 unless (defined $action) {
1483 croak "Can't find action for path '$path'";
1485 return $c->uri_for( $action, @args );
1488 =head2 $c->welcome_message
1490 Returns the Catalyst welcome HTML page.
1494 sub welcome_message {
1496 my $name = $c->config->{name};
1497 my $logo = $c->uri_for('/static/images/catalyst_logo.png');
1498 my $prefix = Catalyst::Utils::appprefix( ref $c );
1499 $c->response->content_type('text/html; charset=utf-8');
1501 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
1502 "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
1503 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
1505 <meta http-equiv="Content-Language" content="en" />
1506 <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
1507 <title>$name on Catalyst $VERSION</title>
1508 <style type="text/css">
1511 background-color: #eee;
1518 margin-bottom: 10px;
1520 background-color: #ccc;
1521 border: 1px solid #aaa;
1526 font-family: verdana, tahoma, sans-serif;
1529 font-family: verdana, tahoma, sans-serif;
1532 text-decoration: none;
1534 border-bottom: 1px dotted #bbb;
1536 :link:hover, :visited:hover {
1549 background-color: #fff;
1550 border: 1px solid #aaa;
1554 font-weight: normal;
1576 <h1><span id="appname">$name</span> on <a href="http://catalyst.perl.org">Catalyst</a>
1581 <img src="$logo" alt="Catalyst Logo" />
1583 <p>Welcome to the world of Catalyst.
1584 This <a href="http://en.wikipedia.org/wiki/MVC">MVC</a>
1585 framework will make web development something you had
1586 never expected it to be: Fun, rewarding, and quick.</p>
1587 <h2>What to do now?</h2>
1588 <p>That really depends on what <b>you</b> want to do.
1589 We do, however, provide you with a few starting points.</p>
1590 <p>If you want to jump right into web development with Catalyst
1591 you might want to start with a tutorial.</p>
1592 <pre>perldoc <a href="https://metacpan.org/module/Catalyst::Manual::Tutorial">Catalyst::Manual::Tutorial</a></code>
1594 <p>Afterwards you can go on to check out a more complete look at our features.</p>
1596 <code>perldoc <a href="https://metacpan.org/module/Catalyst::Manual::Intro">Catalyst::Manual::Intro</a>
1597 <!-- Something else should go here, but the Catalyst::Manual link seems unhelpful -->
1599 <h2>What to do next?</h2>
1600 <p>Next it's time to write an actual application. Use the
1601 helper scripts to generate <a href="https://metacpan.org/search?q=Catalyst%3A%3AController">controllers</a>,
1602 <a href="https://metacpan.org/search?q=Catalyst%3A%3AModel">models</a>, and
1603 <a href="https://metacpan.org/search?q=Catalyst%3A%3AView">views</a>;
1604 they can save you a lot of work.</p>
1605 <pre><code>script/${prefix}_create.pl --help</code></pre>
1606 <p>Also, be sure to check out the vast and growing
1607 collection of <a href="http://search.cpan.org/search?query=Catalyst">plugins for Catalyst on CPAN</a>;
1608 you are likely to find what you need there.
1612 <p>Catalyst has a very active community. Here are the main places to
1613 get in touch with us.</p>
1616 <a href="http://dev.catalyst.perl.org">Wiki</a>
1619 <a href="http://lists.scsys.co.uk/cgi-bin/mailman/listinfo/catalyst">Mailing-List</a>
1622 <a href="irc://irc.perl.org/catalyst">IRC channel #catalyst on irc.perl.org</a>
1625 <h2>In conclusion</h2>
1626 <p>The Catalyst team hopes you will enjoy using Catalyst as much
1627 as we enjoyed making it. Please contact us if you have ideas
1628 for improvement or other feedback.</p>
1638 Contains a hash of options passed from the application script, including
1639 the original ARGV the script received, the processed values from that
1640 ARGV and any extra arguments to the script which were not processed.
1642 This can be used to add custom options to your application's scripts
1643 and setup your application differently depending on the values of these
1646 =head1 INTERNAL METHODS
1648 These methods are not meant to be used by end users.
1650 =head2 $c->components
1652 Returns a hash of components.
1654 =head2 $c->context_class
1656 Returns or sets the context class.
1660 Returns a hashref containing coderefs and execution counts (needed for
1661 deep recursion detection).
1665 Returns the number of actions on the current internal execution stack.
1669 Dispatches a request to actions.
1673 sub dispatch { my $c = shift; $c->dispatcher->dispatch( $c, @_ ) }
1675 =head2 $c->dispatcher_class
1677 Returns or sets the dispatcher class.
1679 =head2 $c->dump_these
1681 Returns a list of 2-element array references (name, structure) pairs
1682 that will be dumped on the error page in debug mode.
1688 [ Request => $c->req ],
1689 [ Response => $c->res ],
1690 [ Stash => $c->stash ],
1691 [ Config => $c->config ];
1694 =head2 $c->engine_class
1696 Returns or sets the engine class.
1698 =head2 $c->execute( $class, $coderef )
1700 Execute a coderef in given class and catch exceptions. Errors are available
1706 my ( $c, $class, $code ) = @_;
1707 $class = $c->component($class) || $class;
1710 if ( $c->depth >= $RECURSION ) {
1711 my $action = $code->reverse();
1712 $action = "/$action" unless $action =~ /->/;
1713 my $error = qq/Deep recursion detected calling "${action}"/;
1714 $c->log->error($error);
1720 my $stats_info = $c->_stats_start_execute( $code ) if $c->use_stats;
1722 push( @{ $c->stack }, $code );
1724 no warnings 'recursion';
1725 # N.B. This used to be combined, but I have seen $c get clobbered if so, and
1726 # I have no idea how, ergo $ret (which appears to fix the issue)
1727 eval { my $ret = $code->execute( $class, $c, @{ $c->req->args } ) || 0; $c->state( $ret ) };
1729 $c->_stats_finish_execute( $stats_info ) if $c->use_stats and $stats_info;
1731 my $last = pop( @{ $c->stack } );
1733 if ( my $error = $@ ) {
1734 if ( blessed($error) and $error->isa('Catalyst::Exception::Detach') ) {
1735 $error->rethrow if $c->depth > 1;
1737 elsif ( blessed($error) and $error->isa('Catalyst::Exception::Go') ) {
1738 $error->rethrow if $c->depth > 0;
1741 unless ( ref $error ) {
1742 no warnings 'uninitialized';
1744 my $class = $last->class;
1745 my $name = $last->name;
1746 $error = qq/Caught exception in $class->$name "$error"/;
1755 sub _stats_start_execute {
1756 my ( $c, $code ) = @_;
1757 my $appclass = ref($c) || $c;
1758 return if ( ( $code->name =~ /^_.*/ )
1759 && ( !$appclass->config->{show_internal_actions} ) );
1761 my $action_name = $code->reverse();
1762 $c->counter->{$action_name}++;
1764 my $action = $action_name;
1765 $action = "/$action" unless $action =~ /->/;
1767 # determine if the call was the result of a forward
1768 # this is done by walking up the call stack and looking for a calling
1769 # sub of Catalyst::forward before the eval
1771 for my $index ( 2 .. 11 ) {
1773 if ( ( caller($index) )[0] eq 'Catalyst'
1774 && ( caller($index) )[3] eq '(eval)' );
1776 if ( ( caller($index) )[3] =~ /forward$/ ) {
1777 $callsub = ( caller($index) )[3];
1778 $action = "-> $action";
1783 my $uid = $action_name . $c->counter->{$action_name};
1785 # is this a root-level call or a forwarded call?
1786 if ( $callsub =~ /forward$/ ) {
1787 my $parent = $c->stack->[-1];
1789 # forward, locate the caller
1790 if ( defined $parent && exists $c->counter->{"$parent"} ) {
1793 parent => "$parent" . $c->counter->{"$parent"},
1799 # forward with no caller may come from a plugin
1818 sub _stats_finish_execute {
1819 my ( $c, $info ) = @_;
1820 $c->stats->profile( end => $info );
1825 Finalizes the request.
1832 for my $error ( @{ $c->error } ) {
1833 $c->log->error($error);
1836 # Support skipping finalize for psgix.io style 'jailbreak'. Used to support
1837 # stuff like cometd and websockets
1839 if($c->request->_has_io_fh) {
1844 # Allow engine to handle finalize flow (for POE)
1845 my $engine = $c->engine;
1846 if ( my $code = $engine->can('finalize') ) {
1851 $c->finalize_uploads;
1854 if ( $#{ $c->error } >= 0 ) {
1858 $c->finalize_headers unless $c->response->finalized_headers;
1861 if ( $c->request->method eq 'HEAD' ) {
1862 $c->response->body('');
1870 if ($c->use_stats) {
1871 my $elapsed = $c->stats->elapsed;
1872 my $av = $elapsed == 0 ? '??' : sprintf '%.3f', 1 / $elapsed;
1874 "Request took ${elapsed}s ($av/s)\n" . $c->stats->report . "\n" );
1877 return $c->response->status;
1880 =head2 $c->finalize_body
1886 sub finalize_body { my $c = shift; $c->engine->finalize_body( $c, @_ ) }
1888 =head2 $c->finalize_cookies
1894 sub finalize_cookies { my $c = shift; $c->engine->finalize_cookies( $c, @_ ) }
1896 =head2 $c->finalize_error
1902 sub finalize_error { my $c = shift; $c->engine->finalize_error( $c, @_ ) }
1904 =head2 $c->finalize_headers
1910 sub finalize_headers {
1913 my $response = $c->response; #accessor calls can add up?
1915 # Check if we already finalized headers
1916 return if $response->finalized_headers;
1919 if ( my $location = $response->redirect ) {
1920 $c->log->debug(qq/Redirecting to "$location"/) if $c->debug;
1921 $response->header( Location => $location );
1923 if ( !$response->has_body ) {
1924 # Add a default body if none is already present
1925 my $encoded_location = encode_entities($location);
1926 $response->body(<<"EOF");
1927 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
1928 <html xmlns="http://www.w3.org/1999/xhtml">
1930 <title>Moved</title>
1933 <p>This item has moved <a href="$encoded_location">here</a>.</p>
1937 $response->content_type('text/html; charset=utf-8');
1942 if ( defined $response->body && length $response->body && !$response->content_length ) {
1944 # get the length from a filehandle
1945 if ( blessed( $response->body ) && $response->body->can('read') || ref( $response->body ) eq 'GLOB' )
1947 my $size = -s $response->body;
1949 $response->content_length( $size );
1952 $c->log->warn('Serving filehandle without a content-length');
1956 # everything should be bytes at this point, but just in case
1957 $response->content_length( length( $response->body ) );
1961 # Remove incorrectly added body and content related meta data when returning
1962 # an information response, or a response the is required to not include a body
1964 if ( $response->status =~ /^(1\d\d|[23]04)$/ ) {
1965 if($response->has_body) {
1966 $c->log->debug('Removing body for informational or no content http responses');
1967 $response->body('');
1968 $response->headers->remove_header("Content-Length");
1972 $c->finalize_cookies;
1974 $c->response->finalize_headers();
1977 $response->finalized_headers(1);
1980 =head2 $c->finalize_output
1982 An alias for finalize_body.
1984 =head2 $c->finalize_read
1986 Finalizes the input after reading is complete.
1990 sub finalize_read { my $c = shift; $c->engine->finalize_read( $c, @_ ) }
1992 =head2 $c->finalize_uploads
1994 Finalizes uploads. Cleans up any temporary files.
1998 sub finalize_uploads { my $c = shift; $c->engine->finalize_uploads( $c, @_ ) }
2000 =head2 $c->get_action( $action, $namespace )
2002 Gets an action in a given namespace.
2006 sub get_action { my $c = shift; $c->dispatcher->get_action(@_) }
2008 =head2 $c->get_actions( $action, $namespace )
2010 Gets all actions of a given name in a namespace and all parent
2015 sub get_actions { my $c = shift; $c->dispatcher->get_actions( $c, @_ ) }
2017 =head2 $app->handle_request( @arguments )
2019 Called to handle each HTTP request.
2023 sub handle_request {
2024 my ( $class, @arguments ) = @_;
2026 # Always expect worst case!
2029 if ($class->debug) {
2030 my $secs = time - $START || 1;
2031 my $av = sprintf '%.3f', $COUNT / $secs;
2032 my $time = localtime time;
2033 $class->log->info("*** Request $COUNT ($av/s) [$$] [$time] ***");
2036 my $c = $class->prepare(@arguments);
2038 $status = $c->finalize;
2041 chomp(my $error = $_);
2042 $class->log->error(qq/Caught exception in engine "$error"/);
2047 if(my $coderef = $class->log->can('_flush')){
2048 $class->log->$coderef();
2053 =head2 $class->prepare( @arguments )
2055 Creates a Catalyst context from an engine-specific request (Apache, CGI,
2062 predicate => '_has_uploadtmp',
2066 my ( $class, @arguments ) = @_;
2069 # After the app/ctxt split, this should become an attribute based on something passed
2070 # into the application.
2071 $class->context_class( ref $class || $class ) unless $class->context_class;
2073 my $uploadtmp = $class->config->{uploadtmp};
2074 my $c = $class->context_class->new({ $uploadtmp ? (_uploadtmp => $uploadtmp) : ()});
2076 $c->response->_context($c);
2078 #surely this is not the most efficient way to do things...
2079 $c->stats($class->stats_class->new)->enable($c->use_stats);
2080 if ( $c->debug || $c->config->{enable_catalyst_header} ) {
2081 $c->res->headers->header( 'X-Catalyst' => $Catalyst::VERSION );
2085 # Allow engine to direct the prepare flow (for POE)
2086 if ( my $prepare = $c->engine->can('prepare') ) {
2087 $c->engine->$prepare( $c, @arguments );
2090 $c->prepare_request(@arguments);
2091 $c->prepare_connection;
2092 $c->prepare_query_parameters;
2093 $c->prepare_headers; # Just hooks, no longer needed - they just
2094 $c->prepare_cookies; # cause the lazy attribute on req to build
2097 # Prepare the body for reading, either by prepare_body
2098 # or the user, if they are using $c->read
2101 # Parse the body unless the user wants it on-demand
2102 unless ( ref($c)->config->{parse_on_demand} ) {
2108 # VERY ugly and probably shouldn't rely on ->finalize actually working
2110 # failed prepare is always due to an invalid request, right?
2111 $c->response->status(400);
2112 $c->response->content_type('text/plain');
2113 $c->response->body('Bad Request');
2114 # Note we call finalize and then die here, which escapes
2115 # finalize being called in the enclosing block..
2116 # It in fact couldn't be called, as we don't return $c..
2117 # This is a mess - but I'm unsure you can fix this without
2118 # breaking compat for people doing crazy things (we should set
2119 # the 400 and just return the ctx here IMO, letting finalize get called
2130 =head2 $c->prepare_action
2132 Prepares action. See L<Catalyst::Dispatcher>.
2136 sub prepare_action { my $c = shift; $c->dispatcher->prepare_action( $c, @_ ) }
2138 =head2 $c->prepare_body
2140 Prepares message body.
2147 return if $c->request->_has_body;
2149 # Initialize on-demand data
2150 $c->engine->prepare_body( $c, @_ );
2151 $c->prepare_parameters;
2152 $c->prepare_uploads;
2155 =head2 $c->prepare_body_chunk( $chunk )
2157 Prepares a chunk of data before sending it to L<HTTP::Body>.
2159 See L<Catalyst::Engine>.
2163 sub prepare_body_chunk {
2165 $c->engine->prepare_body_chunk( $c, @_ );
2168 =head2 $c->prepare_body_parameters
2170 Prepares body parameters.
2174 sub prepare_body_parameters {
2176 $c->engine->prepare_body_parameters( $c, @_ );
2179 =head2 $c->prepare_connection
2181 Prepares connection.
2185 sub prepare_connection {
2187 # XXX - This is called on the engine (not the request) to maintain
2188 # Engine::PSGI back compat.
2189 $c->engine->prepare_connection($c);
2192 =head2 $c->prepare_cookies
2194 Prepares cookies by ensuring that the attribute on the request
2195 object has been built.
2199 sub prepare_cookies { my $c = shift; $c->request->cookies }
2201 =head2 $c->prepare_headers
2203 Prepares request headers by ensuring that the attribute on the request
2204 object has been built.
2208 sub prepare_headers { my $c = shift; $c->request->headers }
2210 =head2 $c->prepare_parameters
2212 Prepares parameters.
2216 sub prepare_parameters {
2218 $c->prepare_body_parameters;
2219 $c->engine->prepare_parameters( $c, @_ );
2222 =head2 $c->prepare_path
2224 Prepares path and base.
2228 sub prepare_path { my $c = shift; $c->engine->prepare_path( $c, @_ ) }
2230 =head2 $c->prepare_query_parameters
2232 Prepares query parameters.
2236 sub prepare_query_parameters {
2239 $c->engine->prepare_query_parameters( $c, @_ );
2242 =head2 $c->log_request
2244 Writes information about the request to the debug logs. This includes:
2248 =item * Request method, path, and remote IP address
2250 =item * Query keywords (see L<Catalyst::Request/query_keywords>)
2252 =item * Request parameters
2254 =item * File uploads
2263 return unless $c->debug;
2265 my($dump) = grep {$_->[0] eq 'Request' } $c->dump_these;
2266 my $request = $dump->[1];
2268 my ( $method, $path, $address ) = ( $request->method, $request->path, $request->address );
2270 $path = '/' unless length $path;
2272 $c->log->debug(qq/"$method" request for "$path" from "$address"/);
2274 $c->log_request_headers($request->headers);
2276 if ( my $keywords = $request->query_keywords ) {
2277 $c->log->debug("Query keywords are: $keywords");
2280 $c->log_request_parameters( query => $request->query_parameters, $request->_has_body ? (body => $request->body_parameters) : () );
2282 $c->log_request_uploads($request);
2285 =head2 $c->log_response
2287 Writes information about the response to the debug logs by calling
2288 C<< $c->log_response_status_line >> and C<< $c->log_response_headers >>.
2295 return unless $c->debug;
2297 my($dump) = grep {$_->[0] eq 'Response' } $c->dump_these;
2298 my $response = $dump->[1];
2300 $c->log_response_status_line($response);
2301 $c->log_response_headers($response->headers);
2304 =head2 $c->log_response_status_line($response)
2306 Writes one line of information about the response to the debug logs. This includes:
2310 =item * Response status code
2312 =item * Content-Type header (if present)
2314 =item * Content-Length header (if present)
2320 sub log_response_status_line {
2321 my ($c, $response) = @_;
2325 'Response Code: %s; Content-Type: %s; Content-Length: %s',
2326 $response->status || 'unknown',
2327 $response->headers->header('Content-Type') || 'unknown',
2328 $response->headers->header('Content-Length') || 'unknown'
2333 =head2 $c->log_response_headers($headers);
2335 Hook method which can be wrapped by plugins to log the response headers.
2336 No-op in the default implementation.
2340 sub log_response_headers {}
2342 =head2 $c->log_request_parameters( query => {}, body => {} )
2344 Logs request parameters to debug logs
2348 sub log_request_parameters {
2350 my %all_params = @_;
2352 return unless $c->debug;
2354 my $column_width = Catalyst::Utils::term_width() - 44;
2355 foreach my $type (qw(query body)) {
2356 my $params = $all_params{$type};
2357 next if ! keys %$params;
2358 my $t = Text::SimpleTable->new( [ 35, 'Parameter' ], [ $column_width, 'Value' ] );
2359 for my $key ( sort keys %$params ) {
2360 my $param = $params->{$key};
2361 my $value = defined($param) ? $param : '';
2362 $t->row( $key, ref $value eq 'ARRAY' ? ( join ', ', @$value ) : $value );
2364 $c->log->debug( ucfirst($type) . " Parameters are:\n" . $t->draw );
2368 =head2 $c->log_request_uploads
2370 Logs file uploads included in the request to the debug logs.
2371 The parameter name, filename, file type, and file size are all included in
2376 sub log_request_uploads {
2378 my $request = shift;
2379 return unless $c->debug;
2380 my $uploads = $request->uploads;
2381 if ( keys %$uploads ) {
2382 my $t = Text::SimpleTable->new(
2383 [ 12, 'Parameter' ],
2388 for my $key ( sort keys %$uploads ) {
2389 my $upload = $uploads->{$key};
2390 for my $u ( ref $upload eq 'ARRAY' ? @{$upload} : ($upload) ) {
2391 $t->row( $key, $u->filename, $u->type, $u->size );
2394 $c->log->debug( "File Uploads are:\n" . $t->draw );
2398 =head2 $c->log_request_headers($headers);
2400 Hook method which can be wrapped by plugins to log the request headers.
2401 No-op in the default implementation.
2405 sub log_request_headers {}
2407 =head2 $c->log_headers($type => $headers)
2409 Logs L<HTTP::Headers> (either request or response) to the debug logs.
2416 my $headers = shift; # an HTTP::Headers instance
2418 return unless $c->debug;
2420 my $column_width = Catalyst::Utils::term_width() - 28;
2421 my $t = Text::SimpleTable->new( [ 15, 'Header Name' ], [ $column_width, 'Value' ] );
2424 my ( $name, $value ) = @_;
2425 $t->row( $name, $value );
2428 $c->log->debug( ucfirst($type) . " Headers:\n" . $t->draw );
2432 =head2 $c->prepare_read
2434 Prepares the input for reading.
2438 sub prepare_read { my $c = shift; $c->engine->prepare_read( $c, @_ ) }
2440 =head2 $c->prepare_request
2442 Prepares the engine request.
2446 sub prepare_request { my $c = shift; $c->engine->prepare_request( $c, @_ ) }
2448 =head2 $c->prepare_uploads
2454 sub prepare_uploads {
2457 $c->engine->prepare_uploads( $c, @_ );
2460 =head2 $c->prepare_write
2462 Prepares the output for writing.
2466 sub prepare_write { my $c = shift; $c->engine->prepare_write( $c, @_ ) }
2468 =head2 $c->request_class
2470 Returns or sets the request class. Defaults to L<Catalyst::Request>.
2472 =head2 $c->response_class
2474 Returns or sets the response class. Defaults to L<Catalyst::Response>.
2476 =head2 $c->read( [$maxlength] )
2478 Reads a chunk of data from the request body. This method is designed to
2479 be used in a while loop, reading C<$maxlength> bytes on every call.
2480 C<$maxlength> defaults to the size of the request if not specified.
2482 You have to set C<< MyApp->config(parse_on_demand => 1) >> to use this
2485 Warning: If you use read(), Catalyst will not process the body,
2486 so you will not be able to access POST parameters or file uploads via
2487 $c->request. You must handle all body parsing yourself.
2491 sub read { my $c = shift; return $c->request->read( @_ ) }
2501 $app->_make_immutable_if_needed;
2502 $app->engine_loader->needs_psgi_engine_compat_hack ?
2503 $app->engine->run($app, @_) :
2504 $app->engine->run( $app, $app->_finalized_psgi_app, @_ );
2507 sub _make_immutable_if_needed {
2509 my $meta = find_meta($class);
2510 my $isa_ca = $class->isa('Class::Accessor::Fast') || $class->isa('Class::Accessor');
2513 && ! { $meta->immutable_options }->{replace_constructor}
2516 warn("You made your application class ($class) immutable, "
2517 . "but did not inline the\nconstructor. "
2518 . "This will break catalyst, as your app \@ISA "
2519 . "Class::Accessor(::Fast)?\nPlease pass "
2520 . "(replace_constructor => 1)\nwhen making your class immutable.\n");
2522 unless ($meta->is_immutable) {
2523 # XXX - FIXME warning here as you should make your app immutable yourself.
2524 $meta->make_immutable(
2525 replace_constructor => 1,
2530 =head2 $c->set_action( $action, $code, $namespace, $attrs )
2532 Sets an action in a given namespace.
2536 sub set_action { my $c = shift; $c->dispatcher->set_action( $c, @_ ) }
2538 =head2 $c->setup_actions($component)
2540 Sets up actions for a component.
2544 sub setup_actions { my $c = shift; $c->dispatcher->setup_actions( $c, @_ ) }
2546 =head2 $c->setup_components
2548 This method is called internally to set up the application's components.
2550 It finds modules by calling the L<locate_components> method, expands them to
2551 package names with the L<expand_component_module> method, and then installs
2552 each component into the application.
2554 The C<setup_components> config option is passed to both of the above methods.
2556 Installation of each component is performed by the L<setup_component> method,
2561 sub setup_components {
2564 my $config = $class->config->{ setup_components };
2566 my @comps = $class->locate_components($config);
2567 my %comps = map { $_ => 1 } @comps;
2569 my $deprecatedcatalyst_component_names = grep { /::[CMV]::/ } @comps;
2570 $class->log->warn(qq{Your application is using the deprecated ::[MVC]:: type naming scheme.\n}.
2571 qq{Please switch your class names to ::Model::, ::View:: and ::Controller: as appropriate.\n}
2572 ) if $deprecatedcatalyst_component_names;
2574 for my $component ( @comps ) {
2576 # We pass ignore_loaded here so that overlay files for (e.g.)
2577 # Model::DBI::Schema sub-classes are loaded - if it's in @comps
2578 # we know M::P::O found a file on disk so this is safe
2580 Catalyst::Utils::ensure_class_loaded( $component, { ignore_loaded => 1 } );
2583 for my $component (@comps) {
2584 my $instance = $class->components->{ $component } = $class->setup_component($component);
2585 my @expanded_components = $instance->can('expand_modules')
2586 ? $instance->expand_modules( $component, $config )
2587 : $class->expand_component_module( $component, $config );
2588 for my $component (@expanded_components) {
2589 next if $comps{$component};
2590 $class->components->{ $component } = $class->setup_component($component);
2595 =head2 $c->locate_components( $setup_component_config )
2597 This method is meant to provide a list of component modules that should be
2598 setup for the application. By default, it will use L<Module::Pluggable>.
2600 Specify a C<setup_components> config option to pass additional options directly
2601 to L<Module::Pluggable>. To add additional search paths, specify a key named
2602 C<search_extra> as an array reference. Items in the array beginning with C<::>
2603 will have the application class name prepended to them.
2607 sub locate_components {
2611 my @paths = qw( ::Controller ::C ::Model ::M ::View ::V );
2612 my $extra = delete $config->{ search_extra } || [];
2614 push @paths, @$extra;
2616 my $locator = Module::Pluggable::Object->new(
2617 search_path => [ map { s/^(?=::)/$class/; $_; } @paths ],
2621 # XXX think about ditching this sort entirely
2622 my @comps = sort { length $a <=> length $b } $locator->plugins;
2627 =head2 $c->expand_component_module( $component, $setup_component_config )
2629 Components found by C<locate_components> will be passed to this method, which
2630 is expected to return a list of component (package) names to be set up.
2634 sub expand_component_module {
2635 my ($class, $module) = @_;
2636 return Devel::InnerPackage::list_packages( $module );
2639 =head2 $c->setup_component
2643 sub setup_component {
2644 my( $class, $component ) = @_;
2646 unless ( $component->can( 'COMPONENT' ) ) {
2650 my $suffix = Catalyst::Utils::class2classsuffix( $component );
2651 my $config = $class->config->{ $suffix } || {};
2652 # Stash catalyst_component_name in the config here, so that custom COMPONENT
2653 # methods also pass it. local to avoid pointlessly shitting in config
2654 # for the debug screen, as $component is already the key name.
2655 local $config->{catalyst_component_name} = $component;
2657 my $instance = eval { $component->COMPONENT( $class, $config ); };
2659 if ( my $error = $@ ) {
2661 Catalyst::Exception->throw(
2662 message => qq/Couldn't instantiate component "$component", "$error"/
2666 unless (blessed $instance) {
2667 my $metaclass = Moose::Util::find_meta($component);
2668 my $method_meta = $metaclass->find_method_by_name('COMPONENT');
2669 my $component_method_from = $method_meta->associated_metaclass->name;
2670 my $value = defined($instance) ? $instance : 'undef';
2671 Catalyst::Exception->throw(
2673 qq/Couldn't instantiate component "$component", COMPONENT() method (from $component_method_from) didn't return an object-like value (value was $value)./
2679 =head2 $c->setup_dispatcher
2685 sub setup_dispatcher {
2686 my ( $class, $dispatcher ) = @_;
2689 $dispatcher = 'Catalyst::Dispatcher::' . $dispatcher;
2692 if ( my $env = Catalyst::Utils::env_value( $class, 'DISPATCHER' ) ) {
2693 $dispatcher = 'Catalyst::Dispatcher::' . $env;
2696 unless ($dispatcher) {
2697 $dispatcher = $class->dispatcher_class;
2700 load_class($dispatcher);
2702 # dispatcher instance
2703 $class->dispatcher( $dispatcher->new );
2706 =head2 $c->setup_engine
2713 my ($class, $requested_engine) = @_;
2715 if (!$class->engine_loader || $requested_engine) {
2716 $class->engine_loader(
2717 Catalyst::EngineLoader->new({
2718 application_name => $class,
2719 (defined $requested_engine
2720 ? (catalyst_engine_class => $requested_engine) : ()),
2725 $class->engine_loader->catalyst_engine_class;
2729 my ($class, $requested_engine) = @_;
2732 my $loader = $class->engine_loader;
2734 if (!$loader || $requested_engine) {
2735 $loader = Catalyst::EngineLoader->new({
2736 application_name => $class,
2737 (defined $requested_engine
2738 ? (requested_engine => $requested_engine) : ()),
2741 $class->engine_loader($loader);
2744 $loader->catalyst_engine_class;
2747 # Don't really setup_engine -- see _setup_psgi_app for explanation.
2748 return if $class->loading_psgi_file;
2750 load_class($engine);
2752 if ($ENV{MOD_PERL}) {
2753 my $apache = $class->engine_loader->auto;
2755 my $meta = find_meta($class);
2756 my $was_immutable = $meta->is_immutable;
2757 my %immutable_options = $meta->immutable_options;
2758 $meta->make_mutable if $was_immutable;
2760 $meta->add_method(handler => sub {
2762 my $psgi_app = $class->_finalized_psgi_app;
2763 $apache->call_app($r, $psgi_app);
2766 $meta->make_immutable(%immutable_options) if $was_immutable;
2769 $class->engine( $engine->new );
2774 ## This exists just to supply a prebuild psgi app for mod_perl and for the
2775 ## build in server support (back compat support for pre psgi port behavior).
2776 ## This is so that we don't build a new psgi app for each request when using
2777 ## the mod_perl handler or the built in servers (http and fcgi, etc).
2779 sub _finalized_psgi_app {
2782 unless ($app->_psgi_app) {
2783 my $psgi_app = $app->_setup_psgi_app;
2784 $app->_psgi_app($psgi_app);
2787 return $app->_psgi_app;
2790 ## Look for a psgi file like 'myapp_web.psgi' (if the app is MyApp::Web) in the
2791 ## home directory and load that and return it (just assume it is doing the
2792 ## right thing :) ). If that does not exist, call $app->psgi_app, wrap that
2793 ## in default_middleware and return it ( this is for backward compatibility
2794 ## with pre psgi port behavior ).
2796 sub _setup_psgi_app {
2799 for my $home (Path::Class::Dir->new($app->config->{home})) {
2800 my $psgi_file = $home->file(
2801 Catalyst::Utils::appprefix($app) . '.psgi',
2804 next unless -e $psgi_file;
2806 # If $psgi_file calls ->setup_engine, it's doing so to load
2807 # Catalyst::Engine::PSGI. But if it does that, we're only going to
2808 # throw away the loaded PSGI-app and load the 5.9 Catalyst::Engine
2809 # anyway. So set a flag (ick) that tells setup_engine not to populate
2810 # $c->engine or do any other things we might regret.
2812 $app->loading_psgi_file(1);
2813 my $psgi_app = Plack::Util::load_psgi($psgi_file);
2814 $app->loading_psgi_file(0);
2817 unless $app->engine_loader->needs_psgi_engine_compat_hack;
2820 Found a legacy Catalyst::Engine::PSGI .psgi file at ${psgi_file}.
2822 Its content has been ignored. Please consult the Catalyst::Upgrading
2823 documentation on how to upgrade from Catalyst::Engine::PSGI.
2827 return $app->apply_default_middlewares($app->psgi_app);
2830 =head2 $c->apply_default_middlewares
2832 Adds the following L<Plack> middlewares to your application, since they are
2833 useful and commonly needed:
2835 L<Plack::Middleware::ReverseProxy>, (conditionally added based on the status
2836 of your $ENV{REMOTE_ADDR}, and can be forced on with C<using_frontend_proxy>
2837 or forced off with C<ignore_frontend_proxy>), L<Plack::Middleware::LighttpdScriptNameFix>
2838 (if you are using Lighttpd), L<Plack::Middleware::IIS6ScriptNameFix> (always
2839 applied since this middleware is smart enough to conditionally apply itself).
2841 Additionally if we detect we are using Nginx, we add a bit of custom middleware
2842 to solve some problems with the way that server handles $ENV{PATH_INFO} and
2848 sub apply_default_middlewares {
2849 my ($app, $psgi_app) = @_;
2851 $psgi_app = Plack::Middleware::Conditional->wrap(
2853 builder => sub { Plack::Middleware::ReverseProxy->wrap($_[0]) },
2856 return if $app->config->{ignore_frontend_proxy};
2857 return $env->{REMOTE_ADDR} eq '127.0.0.1'
2858 || $app->config->{using_frontend_proxy};
2862 # If we're running under Lighttpd, swap PATH_INFO and SCRIPT_NAME
2863 # http://lists.scsys.co.uk/pipermail/catalyst/2006-June/008361.html
2864 $psgi_app = Plack::Middleware::Conditional->wrap(
2866 builder => sub { Plack::Middleware::LighttpdScriptNameFix->wrap($_[0]) },
2869 return unless $env->{SERVER_SOFTWARE} && $env->{SERVER_SOFTWARE} =~ m!lighttpd[-/]1\.(\d+\.\d+)!;
2870 return unless $1 < 4.23;
2875 # we're applying this unconditionally as the middleware itself already makes
2876 # sure it doesn't fuck things up if it's not running under one of the right
2878 $psgi_app = Plack::Middleware::IIS6ScriptNameFix->wrap($psgi_app);
2880 # And another IIS issue, this time with IIS7.
2881 $psgi_app = Plack::Middleware::Conditional->wrap(
2883 builder => sub { Plack::Middleware::IIS7KeepAliveFix->wrap($_[0]) },
2886 return $env->{SERVER_SOFTWARE} && $env->{SERVER_SOFTWARE} =~ m!IIS/7\.[0-9]!;
2895 Returns a PSGI application code reference for the catalyst application
2896 C<$c>. This is the bare application without any middlewares
2897 applied. C<${myapp}.psgi> is not taken into account.
2899 This is what you want to be using to retrieve the PSGI application code
2900 reference of your Catalyst application for use in F<.psgi> files.
2906 my $psgi = $app->engine->build_psgi_app($app);
2907 return $app->Catalyst::Utils::apply_registered_middleware($psgi);
2910 =head2 $c->setup_home
2912 Sets up the home directory.
2917 my ( $class, $home ) = @_;
2919 if ( my $env = Catalyst::Utils::env_value( $class, 'HOME' ) ) {
2923 $home ||= Catalyst::Utils::home($class);
2926 #I remember recently being scolded for assigning config values like this
2927 $class->config->{home} ||= $home;
2928 $class->config->{root} ||= Path::Class::Dir->new($home)->subdir('root');
2932 =head2 $c->setup_log
2934 Sets up log by instantiating a L<Catalyst::Log|Catalyst::Log> object and
2935 passing it to C<log()>. Pass in a comma-delimited list of levels to set the
2938 This method also installs a C<debug> method that returns a true value into the
2939 catalyst subclass if the "debug" level is passed in the comma-delimited list,
2940 or if the C<$CATALYST_DEBUG> environment variable is set to a true value.
2942 Note that if the log has already been setup, by either a previous call to
2943 C<setup_log> or by a call such as C<< __PACKAGE__->log( MyLogger->new ) >>,
2944 that this method won't actually set up the log object.
2949 my ( $class, $levels ) = @_;
2952 $levels =~ s/^\s+//;
2953 $levels =~ s/\s+$//;
2954 my %levels = map { $_ => 1 } split /\s*,\s*/, $levels;
2956 my $env_debug = Catalyst::Utils::env_value( $class, 'DEBUG' );
2957 if ( defined $env_debug ) {
2958 $levels{debug} = 1 if $env_debug; # Ugly!
2959 delete($levels{debug}) unless $env_debug;
2962 unless ( $class->log ) {
2963 $class->log( Catalyst::Log->new(keys %levels) );
2966 if ( $levels{debug} ) {
2967 Class::MOP::get_metaclass_by_name($class)->add_method('debug' => sub { 1 });
2968 $class->log->debug('Debug messages enabled');
2972 =head2 $c->setup_plugins
2978 =head2 $c->setup_stats
2980 Sets up timing statistics class.
2985 my ( $class, $stats ) = @_;
2987 Catalyst::Utils::ensure_class_loaded($class->stats_class);
2989 my $env = Catalyst::Utils::env_value( $class, 'STATS' );
2990 if ( defined($env) ? $env : ($stats || $class->debug ) ) {
2991 Class::MOP::get_metaclass_by_name($class)->add_method('use_stats' => sub { 1 });
2992 $class->log->debug('Statistics enabled');
2997 =head2 $c->registered_plugins
2999 Returns a sorted list of the plugins which have either been stated in the
3002 If passed a given plugin name, it will report a boolean value indicating
3003 whether or not that plugin is loaded. A fully qualified name is required if
3004 the plugin name does not begin with C<Catalyst::Plugin::>.
3006 if ($c->registered_plugins('Some::Plugin')) {
3014 sub registered_plugins {
3016 return sort keys %{ $proto->_plugins } unless @_;
3018 return 1 if exists $proto->_plugins->{$plugin};
3019 return exists $proto->_plugins->{"Catalyst::Plugin::$plugin"};
3022 sub _register_plugin {
3023 my ( $proto, $plugin, $instant ) = @_;
3024 my $class = ref $proto || $proto;
3026 load_class( $plugin );
3027 $class->log->warn( "$plugin inherits from 'Catalyst::Component' - this is deprecated and will not work in 5.81" )
3028 if $plugin->isa( 'Catalyst::Component' );
3029 my $plugin_meta = Moose::Meta::Class->create($plugin);
3030 if (!$plugin_meta->has_method('new')
3031 && ( $plugin->isa('Class::Accessor::Fast') || $plugin->isa('Class::Accessor') ) ) {
3032 $plugin_meta->add_method('new', Moose::Object->meta->get_method('new'))
3034 if (!$instant && !$proto->_plugins->{$plugin}) {
3035 my $meta = Class::MOP::get_metaclass_by_name($class);
3036 $meta->superclasses($plugin, $meta->superclasses);
3038 $proto->_plugins->{$plugin} = 1;
3042 sub _default_plugins { return qw(Unicode::Encoding) }
3045 my ( $class, $plugins ) = @_;
3047 $class->_plugins( {} ) unless $class->_plugins;
3049 m/Unicode::Encoding/ ? do {
3051 'Unicode::Encoding plugin is auto-applied,'
3052 . ' please remove this from your appclass'
3053 . ' and make sure to define "encoding" config'
3055 unless (exists $class->config->{'encoding'}) {
3056 $class->config->{'encoding'} = 'UTF-8';
3061 push @$plugins, $class->_default_plugins;
3062 $plugins = Data::OptList::mkopt($plugins || []);
3065 [ Catalyst::Utils::resolve_namespace(
3066 $class . '::Plugin',
3067 'Catalyst::Plugin', $_->[0]
3073 for my $plugin ( reverse @plugins ) {
3074 load_class($plugin->[0], $plugin->[1]);
3075 my $meta = find_meta($plugin->[0]);
3076 next if $meta && $meta->isa('Moose::Meta::Role');
3078 $class->_register_plugin($plugin->[0]);
3082 map { $_->[0]->name, $_->[1] }
3083 grep { blessed($_->[0]) && $_->[0]->isa('Moose::Meta::Role') }
3084 map { [find_meta($_->[0]), $_->[1]] }
3087 Moose::Util::apply_all_roles(
3093 =head2 registered_middlewares
3095 Read only accessor that returns an array of all the middleware in the order
3096 that they were added (which is the REVERSE of the order they will be applied).
3098 The values returned will be either instances of L<Plack::Middleware> or of a
3099 compatible interface, or a coderef, which is assumed to be inlined middleware
3101 =head2 setup_middleware (?@middleware)
3103 Read configuration information stored in configuration key C<psgi_middleware> or
3106 See under L</CONFIGURATION> information regarding C<psgi_middleware> and how
3107 to use it to enable L<Plack::Middleware>
3109 This method is automatically called during 'setup' of your application, so
3110 you really don't need to invoke it. However you may do so if you find the idea
3111 of loading middleware via configuration weird :). For example:
3117 __PACKAGE__->setup_middleware('Head');
3120 When we read middleware definitions from configuration, we reverse the list
3121 which sounds odd but is likely how you expect it to work if you have prior
3122 experience with L<Plack::Builder> or if you previously used the plugin
3123 L<Catalyst::Plugin::EnableMiddleware> (which is now considered deprecated)
3127 sub registered_middlewares {
3129 if(my $middleware = $class->_psgi_middleware) {
3130 return @$middleware;
3132 die "You cannot call ->registered_middlewares until middleware has been setup";
3136 sub setup_middleware {
3138 my @middleware_definitions = @_ ?
3139 @_ : reverse(@{$class->config->{'psgi_middleware'}||[]});
3141 my @middleware = ();
3142 while(my $next = shift(@middleware_definitions)) {
3144 if(Scalar::Util::blessed $next && $next->can('wrap')) {
3145 push @middleware, $next;
3146 } elsif(ref $next eq 'CODE') {
3147 push @middleware, $next;
3148 } elsif(ref $next eq 'HASH') {
3149 my $namespace = shift @middleware_definitions;
3150 my $mw = $class->Catalyst::Utils::build_middleware($namespace, %$next);
3151 push @middleware, $mw;
3153 die "I can't handle middleware definition ${\ref $next}";
3156 my $mw = $class->Catalyst::Utils::build_middleware($next);
3157 push @middleware, $mw;
3161 my @existing = @{$class->_psgi_middleware || []};
3162 $class->_psgi_middleware([@middleware,@existing,]);
3165 =head2 registered_data_handlers
3167 A read only copy of registered Data Handlers returned as a Hash, where each key
3168 is a content type and each value is a subref that attempts to decode that content
3171 =head2 setup_data_handlers (?@data_handler)
3173 Read configuration information stored in configuration key C<data_handlers> or
3176 See under L</CONFIGURATION> information regarding C<data_handlers>.
3178 This method is automatically called during 'setup' of your application, so
3179 you really don't need to invoke it.
3181 =head2 default_data_handlers
3183 Default Data Handlers that come bundled with L<Catalyst>. Currently there are
3184 only two default data handlers, for 'application/json' and an alternative to
3185 'application/x-www-form-urlencoded' which supposed nested form parameters via
3186 L<CGI::Struct> or via L<CGI::Struct::XS> IF you've installed it.
3188 The 'application/json' data handler is used to parse incoming JSON into a Perl
3189 data structure. It used either L<JSON::MaybeXS> or L<JSON>, depending on which
3190 is installed. This allows you to fail back to L<JSON:PP>, which is a Pure Perl
3191 JSON decoder, and has the smallest dependency impact.
3193 Because we don't wish to add more dependencies to L<Catalyst>, if you wish to
3194 use this new feature we recommend installing L<JSON> or L<JSON::MaybeXS> in
3195 order to get the best performance. You should add either to your dependency
3196 list (Makefile.PL, dist.ini, cpanfile, etc.)
3200 sub registered_data_handlers {
3202 if(my $data_handlers = $class->_data_handlers) {
3203 return %$data_handlers;
3205 die "You cannot call ->registered_data_handlers until data_handers has been setup";
3209 sub setup_data_handlers {
3210 my ($class, %data_handler_callbacks) = @_;
3211 %data_handler_callbacks = (
3212 %{$class->default_data_handlers},
3213 %{$class->config->{'data_handlers'}||+{}},
3214 %data_handler_callbacks);
3216 $class->_data_handlers(\%data_handler_callbacks);
3219 sub default_data_handlers {
3222 'application/x-www-form-urlencoded' => sub {
3223 my ($fh, $req) = @_;
3224 my $params = $req->_use_hash_multivalue ? $req->body_parameters->mixed : $req->body_parameters;
3225 Class::Load::load_first_existing_class('CGI::Struct::XS', 'CGI::Struct')
3226 ->can('build_cgi_struct')->($params);
3228 'application/json' => sub {
3229 Class::Load::load_first_existing_class('JSON::MaybeXS', 'JSON')
3230 ->can('decode_json')->(do { local $/; $_->getline });
3237 Returns an arrayref of the internal execution stack (actions that are
3238 currently executing).
3242 Returns the current timing statistics object. By default Catalyst uses
3243 L<Catalyst::Stats|Catalyst::Stats>, but can be set otherwise with
3244 L<< stats_class|/"$c->stats_class" >>.
3246 Even if L<< -Stats|/"-Stats" >> is not enabled, the stats object is still
3247 available. By enabling it with C< $c->stats->enabled(1) >, it can be used to
3248 profile explicitly, although MyApp.pm still won't profile nor output anything
3251 =head2 $c->stats_class
3253 Returns or sets the stats (timing statistics) class. L<Catalyst::Stats|Catalyst::Stats> is used by default.
3255 =head2 $c->use_stats
3257 Returns 1 when L<< stats collection|/"-Stats" >> is enabled.
3259 Note that this is a static method, not an accessor and should be overridden
3260 by declaring C<sub use_stats { 1 }> in your MyApp.pm, not by calling C<< $c->use_stats(1) >>.
3267 =head2 $c->write( $data )
3269 Writes $data to the output stream. When using this method directly, you
3270 will need to manually set the C<Content-Length> header to the length of
3271 your output data, if known.
3278 # Finalize headers if someone manually writes output (for compat)
3279 $c->finalize_headers;
3281 return $c->response->write( @_ );
3286 Returns the Catalyst version number. Mostly useful for "powered by"
3287 messages in template systems.
3291 sub version { return $Catalyst::VERSION }
3293 =head1 CONFIGURATION
3295 There are a number of 'base' config variables which can be set:
3301 C<default_model> - The default model picked if you say C<< $c->model >>. See L<< /$c->model($name) >>.
3305 C<default_view> - The default view to be rendered or returned when C<< $c->view >> is called. See L<< /$c->view($name) >>.
3309 C<disable_component_resolution_regex_fallback> - Turns
3310 off the deprecated component resolution functionality so
3311 that if any of the component methods (e.g. C<< $c->controller('Foo') >>)
3312 are called then regex search will not be attempted on string values and
3313 instead C<undef> will be returned.
3317 C<home> - The application home directory. In an uninstalled application,
3318 this is the top level application directory. In an installed application,
3319 this will be the directory containing C<< MyApp.pm >>.
3323 C<ignore_frontend_proxy> - See L</PROXY SUPPORT>
3327 C<name> - The name of the application in debug messages and the debug and
3332 C<parse_on_demand> - The request body (for example file uploads) will not be parsed
3333 until it is accessed. This allows you to (for example) check authentication (and reject
3334 the upload) before actually receiving all the data. See L</ON-DEMAND PARSER>
3338 C<root> - The root directory for templates. Usually this is just a
3339 subdirectory of the home directory, but you can set it to change the
3340 templates to a different directory.
3344 C<search_extra> - Array reference passed to Module::Pluggable to for additional
3345 namespaces from which components will be loaded (and constructed and stored in
3346 C<< $c->components >>).
3350 C<show_internal_actions> - If true, causes internal actions such as C<< _DISPATCH >>
3351 to be shown in hit debug tables in the test server.
3355 C<use_request_uri_for_path> - Controls if the C<REQUEST_URI> or C<PATH_INFO> environment
3356 variable should be used for determining the request path.
3358 Most web server environments pass the requested path to the application using environment variables,
3359 from which Catalyst has to reconstruct the request base (i.e. the top level path to / in the application,
3360 exposed as C<< $c->request->base >>) and the request path below that base.
3362 There are two methods of doing this, both of which have advantages and disadvantages. Which method is used
3363 is determined by the C<< $c->config(use_request_uri_for_path) >> setting (which can either be true or false).
3367 =item use_request_uri_for_path => 0
3369 This is the default (and the) traditional method that Catalyst has used for determining the path information.
3370 The path is generated from a combination of the C<PATH_INFO> and C<SCRIPT_NAME> environment variables.
3371 The allows the application to behave correctly when C<mod_rewrite> is being used to redirect requests
3372 into the application, as these variables are adjusted by mod_rewrite to take account for the redirect.
3374 However this method has the major disadvantage that it is impossible to correctly decode some elements
3375 of the path, as RFC 3875 says: "C<< Unlike a URI path, the PATH_INFO is not URL-encoded, and cannot
3376 contain path-segment parameters. >>" This means PATH_INFO is B<always> decoded, and therefore Catalyst
3377 can't distinguish / vs %2F in paths (in addition to other encoded values).
3379 =item use_request_uri_for_path => 1
3381 This method uses the C<REQUEST_URI> and C<SCRIPT_NAME> environment variables. As C<REQUEST_URI> is never
3382 decoded, this means that applications using this mode can correctly handle URIs including the %2F character
3383 (i.e. with C<AllowEncodedSlashes> set to C<On> in Apache).
3385 Given that this method of path resolution is provably more correct, it is recommended that you use
3386 this unless you have a specific need to deploy your application in a non-standard environment, and you are
3387 aware of the implications of not being able to handle encoded URI paths correctly.
3389 However it also means that in a number of cases when the app isn't installed directly at a path, but instead
3390 is having paths rewritten into it (e.g. as a .cgi/fcgi in a public_html directory, with mod_rewrite in a
3391 .htaccess file, or when SSI is used to rewrite pages into the app, or when sub-paths of the app are exposed
3392 at other URIs than that which the app is 'normally' based at with C<mod_rewrite>), the resolution of
3393 C<< $c->request->base >> will be incorrect.
3399 C<using_frontend_proxy> - See L</PROXY SUPPORT>.
3403 C<encoding> - See L</ENCODING>
3407 C<abort_chain_on_error_fix>
3409 When there is an error in an action chain, the default behavior is to continue
3410 processing the remaining actions and then catch the error upon chain end. This
3411 can lead to running actions when the application is in an unexpected state. If
3412 you have this issue, setting this config value to true will promptly exit a
3413 chain when there is an error raised in any action (thus terminating the chain
3418 __PACKAGE__->config(abort_chain_on_error_fix => 1);
3420 In the future this might become the default behavior.
3424 C<use_hash_multivalue_in_request>
3426 In L<Catalyst::Request> the methods C<query_parameters>, C<body_parametes>
3427 and C<parameters> return a hashref where values might be scalar or an arrayref
3428 depending on the incoming data. In many cases this can be undesirable as it
3429 leads one to writing defensive code like the following:
3431 my ($val) = ref($c->req->parameters->{a}) ?
3432 @{$c->req->parameters->{a}} :
3433 $c->req->parameters->{a};
3435 Setting this configuration item to true will make L<Catalyst> populate the
3436 attributes underlying these methods with an instance of L<Hash::MultiValue>
3437 which is used by L<Plack::Request> and others to solve this very issue. You
3438 may prefer this behavior to the default, if so enable this option (be warned
3439 if you enable it in a legacy application we are not sure if it is completely
3440 backwardly compatible).
3444 C<psgi_middleware> - See L<PSGI MIDDLEWARE>.
3448 C<data_handlers> - See L<DATA HANDLERS>.
3452 =head1 INTERNAL ACTIONS
3454 Catalyst uses internal actions like C<_DISPATCH>, C<_BEGIN>, C<_AUTO>,
3455 C<_ACTION>, and C<_END>. These are by default not shown in the private
3456 action table, but you can make them visible with a config parameter.
3458 MyApp->config(show_internal_actions => 1);
3460 =head1 ON-DEMAND PARSER
3462 The request body is usually parsed at the beginning of a request,
3463 but if you want to handle input yourself, you can enable on-demand
3464 parsing with a config parameter.
3466 MyApp->config(parse_on_demand => 1);
3468 =head1 PROXY SUPPORT
3470 Many production servers operate using the common double-server approach,
3471 with a lightweight frontend web server passing requests to a larger
3472 backend server. An application running on the backend server must deal
3473 with two problems: the remote user always appears to be C<127.0.0.1> and
3474 the server's hostname will appear to be C<localhost> regardless of the
3475 virtual host that the user connected through.
3477 Catalyst will automatically detect this situation when you are running
3478 the frontend and backend servers on the same machine. The following
3479 changes are made to the request.
3481 $c->req->address is set to the user's real IP address, as read from
3482 the HTTP X-Forwarded-For header.
3484 The host value for $c->req->base and $c->req->uri is set to the real
3485 host, as read from the HTTP X-Forwarded-Host header.
3487 Additionally, you may be running your backend application on an insecure
3488 connection (port 80) while your frontend proxy is running under SSL. If there
3489 is a discrepancy in the ports, use the HTTP header C<X-Forwarded-Port> to
3490 tell Catalyst what port the frontend listens on. This will allow all URIs to
3491 be created properly.
3493 In the case of passing in:
3495 X-Forwarded-Port: 443
3497 All calls to C<uri_for> will result in an https link, as is expected.
3499 Obviously, your web server must support these headers for this to work.
3501 In a more complex server farm environment where you may have your
3502 frontend proxy server(s) on different machines, you will need to set a
3503 configuration option to tell Catalyst to read the proxied data from the
3506 MyApp->config(using_frontend_proxy => 1);
3508 If you do not wish to use the proxy support at all, you may set:
3510 MyApp->config(ignore_frontend_proxy => 0);
3512 =head2 Note about psgi files
3514 Note that if you supply your own .psgi file, calling
3515 C<< MyApp->psgi_app(@_); >>, then B<this will not happen automatically>.
3517 You either need to apply L<Plack::Middleware::ReverseProxy> yourself
3518 in your psgi, for example:
3521 enable "Plack::Middleware::ReverseProxy";
3525 This will unconditionally add the ReverseProxy support, or you need to call
3526 C<< $app = MyApp->apply_default_middlewares($app) >> (to conditionally
3527 apply the support depending upon your config).
3529 See L<Catalyst::PSGI> for more information.
3531 =head1 THREAD SAFETY
3533 Catalyst has been tested under Apache 2's threading C<mpm_worker>,
3534 C<mpm_winnt>, and the standalone forking HTTP server on Windows. We
3535 believe the Catalyst core to be thread-safe.
3537 If you plan to operate in a threaded environment, remember that all other
3538 modules you are using must also be thread-safe. Some modules, most notably
3539 L<DBD::SQLite>, are not thread-safe.
3541 =head1 DATA HANDLERS
3543 The L<Catalyst::Request> object uses L<HTTP::Body> to populate 'classic' HTML
3544 form parameters and URL search query fields. However it has become common
3545 for various alternative content types to be PUT or POSTed to your controllers
3546 and actions. People working on RESTful APIs, or using AJAX often use JSON,
3547 XML and other content types when communicating with an application server. In
3548 order to better support this use case, L<Catalyst> defines a global configuration
3549 option, C<data_handlers>, which lets you associate a content type with a coderef
3550 that parses that content type into something Perl can readily access.
3557 __PACKAGE__->config(
3559 'application/json' => sub { local $/; decode_json $_->getline },
3561 ## Any other configuration.
3566 By default L<Catalyst> comes with a generic JSON data handler similar to the
3567 example given above, which uses L<JSON::Maybe> to provide either L<JSON::PP>
3568 (a pure Perl, dependency free JSON parser) or L<Cpanel::JSON::XS> if you have
3569 it installed (if you want the faster XS parser, add it to you project Makefile.PL
3570 or dist.ini, cpanfile, etc.)
3572 The C<data_handlers> configuation is a hashref whose keys are HTTP Content-Types
3573 (matched against the incoming request type using a regexp such as to be case
3574 insensitive) and whose values are coderefs that receive a localized version of
3575 C<$_> which is a filehandle object pointing to received body.
3577 This feature is considered an early access release and we reserve the right
3578 to alter the interface in order to provide a performant and secure solution to
3579 alternative request body content. Your reports welcomed!
3581 =head1 PSGI MIDDLEWARE
3583 You can define middleware, defined as L<Plack::Middleware> or a compatible
3584 interface in configuration. Your middleware definitions are in the form of an
3585 arrayref under the configuration key C<psgi_middleware>. Here's an example
3586 with details to follow:
3591 use Plack::Middleware::StackTrace;
3593 my $stacktrace_middleware = Plack::Middleware::StackTrace->new;
3595 __PACKAGE__->config(
3596 'psgi_middleware', [
3599 $stacktrace_middleware,
3600 'Session' => {store => 'File'},
3605 $env->{myapp.customkey} = 'helloworld';
3614 So the general form is:
3616 __PACKAGE__->config(psgi_middleware => \@middleware_definitions);
3618 Where C<@middleware> is one or more of the following, applied in the REVERSE of
3619 the order listed (to make it function similarly to L<Plack::Builder>:
3623 =item Middleware Object
3625 An already initialized object that conforms to the L<Plack::Middleware>
3628 my $stacktrace_middleware = Plack::Middleware::StackTrace->new;
3630 __PACKAGE__->config(
3631 'psgi_middleware', [
3632 $stacktrace_middleware,
3638 A coderef that is an inlined middleware:
3640 __PACKAGE__->config(
3641 'psgi_middleware', [
3646 if($env->{PATH_INFO} =~m/forced/) {
3648 ->new(file=>TestApp->path_to(qw/share static forced.txt/))
3651 return $app->($env);
3661 We assume the scalar refers to a namespace after normalizing it using the
3664 (1) If the scalar is prefixed with a "+" (as in C<+MyApp::Foo>) then the full string
3665 is assumed to be 'as is', and we just install and use the middleware.
3667 (2) If the scalar begins with "Plack::Middleware" or your application namespace
3668 (the package name of your Catalyst application subclass), we also assume then
3669 that it is a full namespace, and use it.
3671 (3) Lastly, we then assume that the scalar is a partial namespace, and attempt to
3672 resolve it first by looking for it under your application namespace (for example
3673 if you application is "MyApp::Web" and the scalar is "MyMiddleware", we'd look
3674 under "MyApp::Web::Middleware::MyMiddleware") and if we don't find it there, we
3675 will then look under the regular L<Plack::Middleware> namespace (i.e. for the
3676 previous we'd try "Plack::Middleware::MyMiddleware"). We look under your application
3677 namespace first to let you 'override' common L<Plack::Middleware> locally, should
3678 you find that a good idea.
3684 __PACKAGE__->config(
3685 'psgi_middleware', [
3686 'Debug', ## MyAppWeb::Middleware::Debug->wrap or Plack::Middleware::Debug->wrap
3687 'Plack::Middleware::Stacktrace', ## Plack::Middleware::Stacktrace->wrap
3688 '+MyApp::Custom', ## MyApp::Custom->wrap
3692 =item a scalar followed by a hashref
3694 Just like the previous, except the following C<HashRef> is used as arguments
3695 to initialize the middleware object.
3697 __PACKAGE__->config(
3698 'psgi_middleware', [
3699 'Session' => {store => 'File'},
3704 Please see L<PSGI> for more on middleware.
3708 On request, decodes all params from encoding into a sequence of
3709 logical characters. On response, encodes body into encoding.
3717 Returns an instance of an C<Encode> encoding
3719 print $c->encoding->name
3721 =item handle_unicode_encoding_exception ($exception_context)
3723 Method called when decoding process for a request fails.
3725 An C<$exception_context> hashref is provided to allow you to override the
3726 behaviour of your application when given data with incorrect encodings.
3728 The default method throws exceptions in the case of invalid request parameters
3729 (resulting in a 500 error), but ignores errors in upload filenames.
3731 The keys passed in the C<$exception_context> hash are:
3737 The value which was not able to be decoded.
3741 The exception received from L<Encode>.
3745 What type of data was being decoded. Valid values are (currently)
3746 C<params> - for request parameters / arguments / captures
3747 and C<uploads> - for request upload filenames.
3757 Join #catalyst on irc.perl.org.
3761 http://lists.scsys.co.uk/cgi-bin/mailman/listinfo/catalyst
3762 http://lists.scsys.co.uk/cgi-bin/mailman/listinfo/catalyst-dev
3766 http://catalyst.perl.org
3770 http://dev.catalyst.perl.org
3774 =head2 L<Task::Catalyst> - All you need to start with Catalyst
3776 =head2 L<Catalyst::Manual> - The Catalyst Manual
3778 =head2 L<Catalyst::Component>, L<Catalyst::Controller> - Base classes for components
3780 =head2 L<Catalyst::Engine> - Core engine
3782 =head2 L<Catalyst::Log> - Log class.
3784 =head2 L<Catalyst::Request> - Request object
3786 =head2 L<Catalyst::Response> - Response object
3788 =head2 L<Catalyst::Test> - The test suite.
3790 =head1 PROJECT FOUNDER
3792 sri: Sebastian Riedel <sri@cpan.org>
3798 acme: Leon Brocard <leon@astray.com>
3800 abraxxa: Alexander Hartmaier <abraxxa@cpan.org>
3804 Andrew Ford E<lt>A.Ford@ford-mason.co.ukE<gt>
3808 andyg: Andy Grundman <andy@hybridized.org>
3810 audreyt: Audrey Tang
3812 bricas: Brian Cassidy <bricas@cpan.org>
3814 Caelum: Rafael Kitover <rkitover@io.com>
3816 chansen: Christian Hansen
3818 chicks: Christopher Hicks
3820 Chisel Wright C<pause@herlpacker.co.uk>
3822 Danijel Milicevic C<me@danijel.de>
3824 David Kamholz E<lt>dkamholz@cpan.orgE<gt>
3826 David Naughton, C<naughton@umn.edu>
3830 dhoss: Devin Austin <dhoss@cpan.org>
3832 dkubb: Dan Kubb <dan.kubb-cpan@onautopilot.com>
3836 dwc: Daniel Westermann-Clark <danieltwc@cpan.org>
3838 esskar: Sascha Kiefer
3840 fireartist: Carl Franks <cfranks@cpan.org>
3842 frew: Arthur Axel "fREW" Schmidt <frioux@gmail.com>
3844 gabb: Danijel Milicevic
3848 Gavin Henry C<ghenry@perl.me.uk>
3852 groditi: Guillermo Roditi <groditi@gmail.com>
3854 hobbs: Andrew Rodland <andrew@cleverdomain.org>
3856 ilmari: Dagfinn Ilmari Mannsåker <ilmari@ilmari.org>
3858 jcamacho: Juan Camacho
3860 jester: Jesse Sheidlower C<jester@panix.com>
3862 jhannah: Jay Hannah <jay@jays.net>
3868 jon: Jon Schutz <jjschutz@cpan.org>
3870 Jonathan Rockway C<< <jrockway@cpan.org> >>
3872 Kieren Diment C<kd@totaldatasolution.com>
3874 konobi: Scott McWhirter <konobi@cpan.org>
3876 marcus: Marcus Ramberg <mramberg@cpan.org>
3878 miyagawa: Tatsuhiko Miyagawa <miyagawa@bulknews.net>
3880 mgrimes: Mark Grimes <mgrimes@cpan.org>
3882 mst: Matt S. Trout <mst@shadowcatsystems.co.uk>
3886 naughton: David Naughton
3888 ningu: David Kamholz <dkamholz@cpan.org>
3890 nothingmuch: Yuval Kogman <nothingmuch@woobling.org>
3892 numa: Dan Sully <daniel@cpan.org>
3898 omega: Andreas Marienborg
3900 Oleg Kostyuk <cub.uanic@gmail.com>
3902 phaylon: Robert Sedlacek <phaylon@dunkelheit.at>
3904 rafl: Florian Ragwitz <rafl@debian.org>
3906 random: Roland Lammel <lammel@cpan.org>
3908 Robert Sedlacek C<< <rs@474.at> >>
3910 SpiceMan: Marcel Montes
3914 szbalint: Balint Szilakszi <szbalint@cpan.org>
3916 t0m: Tomas Doran <bobtfish@bobtfish.net>
3920 Viljo Marrandi C<vilts@yahoo.com>
3922 Will Hawes C<info@whawes.co.uk>
3924 willert: Sebastian Willert <willert@cpan.org>
3926 wreis: Wallace Reis <wreis@cpan.org>
3928 Yuval Kogman, C<nothingmuch@woobling.org>
3930 rainboxx: Matthias Dietrich, C<perl@rainboxx.de>
3932 dd070: Dhaval Dhanani <dhaval070@gmail.com>
3936 Copyright (c) 2005, the above named PROJECT FOUNDER and CONTRIBUTORS.
3940 This library is free software. You can redistribute it and/or modify it under
3941 the same terms as Perl itself.
3947 __PACKAGE__->meta->make_immutable;