4 use Moose::Meta::Class ();
5 extends 'Catalyst::Component';
6 use Moose::Util qw/find_meta/;
7 use namespace::clean -except => 'meta';
8 use Catalyst::Exception;
9 use Catalyst::Exception::Detach;
10 use Catalyst::Exception::Go;
12 use Catalyst::Request;
13 use Catalyst::Request::Upload;
14 use Catalyst::Response;
16 use Catalyst::Controller;
18 use Devel::InnerPackage ();
19 use Module::Pluggable::Object ();
20 use Text::SimpleTable ();
21 use Path::Class::Dir ();
22 use Path::Class::File ();
27 use Tree::Simple qw/use_weak_refs/;
28 use Tree::Simple::Visitor::FindByUID;
29 use Class::C3::Adopt::NEXT;
30 use List::MoreUtils qw/uniq/;
32 use String::RewritePrefix;
33 use Catalyst::EngineLoader;
35 use Carp qw/croak carp shortmess/;
38 use Moose::Util 'find_meta';
39 use Plack::Middleware::Conditional;
40 use Plack::Middleware::ReverseProxy;
41 use Plack::Middleware::IIS6ScriptNameFix;
42 use Plack::Middleware::IIS7KeepAliveFix;
43 use Plack::Middleware::LighttpdScriptNameFix;
44 use Plack::Middleware::ContentLength;
45 use Plack::Middleware::Head;
46 use Plack::Middleware::HTTPExceptions;
48 use Class::Load 'load_class';
50 BEGIN { require 5.008003; }
52 has stack => (is => 'ro', default => sub { [] });
53 has stash => (is => 'rw', default => sub { {} });
54 has state => (is => 'rw', default => 0);
55 has stats => (is => 'rw');
56 has action => (is => 'rw');
57 has counter => (is => 'rw', default => sub { {} });
62 $self->request_class->new($self->_build_request_constructor_args);
66 sub _build_request_constructor_args {
68 my %p = ( _log => $self->log );
69 $p{_uploadtmp} = $self->_uploadtmp if $self->_has_uploadtmp;
70 $p{data_handlers} = {$self->registered_data_handlers};
71 $p{_use_hash_multivalue} = $self->config->{use_hash_multivalue_in_request}
72 if $self->config->{use_hash_multivalue_in_request};
80 $self->response_class->new($self->_build_response_constructor_args);
84 sub _build_response_constructor_args {
86 { _log => $self->log };
89 has namespace => (is => 'rw');
91 sub depth { scalar @{ shift->stack || [] }; }
92 sub comp { shift->component(@_) }
95 my $self = shift; return $self->request(@_);
98 my $self = shift; return $self->response(@_);
101 # For backwards compatibility
102 sub finalize_output { shift->finalize_body(@_) };
107 our $RECURSION = 1000;
108 our $DETACH = Catalyst::Exception::Detach->new;
109 our $GO = Catalyst::Exception::Go->new;
111 #I imagine that very few of these really need to be class variables. if any.
112 #maybe we should just make them attributes with a default?
113 __PACKAGE__->mk_classdata($_)
114 for qw/components arguments dispatcher engine log dispatcher_class
115 engine_loader context_class request_class response_class stats_class
116 setup_finished _psgi_app loading_psgi_file run_options _psgi_middleware
119 __PACKAGE__->dispatcher_class('Catalyst::Dispatcher');
120 __PACKAGE__->request_class('Catalyst::Request');
121 __PACKAGE__->response_class('Catalyst::Response');
122 __PACKAGE__->stats_class('Catalyst::Stats');
124 # Remember to update this in Catalyst::Runtime as well!
126 our $VERSION = '5.90059_004';
129 my ( $class, @arguments ) = @_;
131 # We have to limit $class to Catalyst to avoid pushing Catalyst upon every
133 return unless $class eq 'Catalyst';
135 my $caller = caller();
136 return if $caller eq 'main';
138 my $meta = Moose::Meta::Class->initialize($caller);
139 unless ( $caller->isa('Catalyst') ) {
140 my @superclasses = ($meta->superclasses, $class, 'Catalyst::Controller');
141 $meta->superclasses(@superclasses);
143 # Avoid possible C3 issues if 'Moose::Object' is already on RHS of MyApp
144 $meta->superclasses(grep { $_ ne 'Moose::Object' } $meta->superclasses);
146 unless( $meta->has_method('meta') ){
147 if ($Moose::VERSION >= 1.15) {
148 $meta->_add_meta_method('meta');
151 $meta->add_method(meta => sub { Moose::Meta::Class->initialize("${caller}") } );
155 $caller->arguments( [@arguments] );
159 sub _application { $_[0] }
165 Catalyst - The Elegant MVC Web Application Framework
169 See the L<Catalyst::Manual> distribution for comprehensive
170 documentation and tutorials.
172 # Install Catalyst::Devel for helpers and other development tools
173 # use the helper to create a new application
176 # add models, views, controllers
177 script/myapp_create.pl model MyDatabase DBIC::Schema create=static dbi:SQLite:/path/to/db
178 script/myapp_create.pl view MyTemplate TT
179 script/myapp_create.pl controller Search
181 # built in testserver -- use -r to restart automatically on changes
182 # --help to see all available options
183 script/myapp_server.pl
185 # command line testing interface
186 script/myapp_test.pl /yada
189 use Catalyst qw/-Debug/; # include plugins here as well
191 ### In lib/MyApp/Controller/Root.pm (autocreated)
192 sub foo : Chained('/') Args() { # called for /foo, /foo/1, /foo/1/2, etc.
193 my ( $self, $c, @args ) = @_; # args are qw/1 2/ for /foo/1/2
194 $c->stash->{template} = 'foo.tt'; # set the template
195 # lookup something from db -- stash vars are passed to TT
197 $c->model('Database::Foo')->search( { country => $args[0] } );
198 if ( $c->req->params->{bar} ) { # access GET or POST parameters
199 $c->forward( 'bar' ); # process another action
200 # do something else after forward returns
204 # The foo.tt TT template can use the stash data from the database
205 [% WHILE (item = data.next) %]
209 # called for /bar/of/soap, /bar/of/soap/10, etc.
210 sub bar : Chained('/') PathPart('/bar/of/soap') Args() { ... }
212 # called after all actions are finished
214 my ( $self, $c ) = @_;
215 if ( scalar @{ $c->error } ) { ... } # handle errors
216 return if $c->res->body; # already have a response
217 $c->forward( 'MyApp::View::TT' ); # render template
220 See L<Catalyst::Manual::Intro> for additional information.
224 Catalyst is a modern framework for making web applications without the
225 pain usually associated with this process. This document is a reference
226 to the main Catalyst application. If you are a new user, we suggest you
227 start with L<Catalyst::Manual::Tutorial> or L<Catalyst::Manual::Intro>.
229 See L<Catalyst::Manual> for more documentation.
231 Catalyst plugins can be loaded by naming them as arguments to the "use
232 Catalyst" statement. Omit the C<Catalyst::Plugin::> prefix from the
233 plugin name, i.e., C<Catalyst::Plugin::My::Module> becomes
236 use Catalyst qw/My::Module/;
238 If your plugin starts with a name other than C<Catalyst::Plugin::>, you can
239 fully qualify the name by using a unary plus:
243 +Fully::Qualified::Plugin::Name
246 Special flags like C<-Debug> can also be specified as
247 arguments when Catalyst is loaded:
249 use Catalyst qw/-Debug My::Module/;
251 The position of plugins and flags in the chain is important, because
252 they are loaded in the order in which they appear.
254 The following flags are supported:
258 Enables debug output. You can also force this setting from the system
259 environment with CATALYST_DEBUG or <MYAPP>_DEBUG. The environment
260 settings override the application, with <MYAPP>_DEBUG having the highest
263 This sets the log level to 'debug' and enables full debug output on the
264 error screen. If you only want the latter, see L<< $c->debug >>.
268 Forces Catalyst to use a specific home directory, e.g.:
270 use Catalyst qw[-Home=/usr/mst];
272 This can also be done in the shell environment by setting either the
273 C<CATALYST_HOME> environment variable or C<MYAPP_HOME>; where C<MYAPP>
274 is replaced with the uppercased name of your application, any "::" in
275 the name will be replaced with underscores, e.g. MyApp::Web should use
276 MYAPP_WEB_HOME. If both variables are set, the MYAPP_HOME one will be used.
278 If none of these are set, Catalyst will attempt to automatically detect the
279 home directory. If you are working in a development environment, Catalyst
280 will try and find the directory containing either Makefile.PL, Build.PL,
281 dist.ini, or cpanfile. If the application has been installed into the system
282 (i.e. you have done C<make install>), then Catalyst will use the path to your
283 application module, without the .pm extension (e.g., /foo/MyApp if your
284 application was installed at /foo/MyApp.pm)
288 use Catalyst '-Log=warn,fatal,error';
290 Specifies a comma-delimited list of log levels.
294 Enables statistics collection and reporting.
296 use Catalyst qw/-Stats=1/;
298 You can also force this setting from the system environment with CATALYST_STATS
299 or <MYAPP>_STATS. The environment settings override the application, with
300 <MYAPP>_STATS having the highest priority.
302 Stats are also enabled if L<< debugging |/"-Debug" >> is enabled.
306 =head2 INFORMATION ABOUT THE CURRENT REQUEST
310 Returns a L<Catalyst::Action> object for the current action, which
311 stringifies to the action name. See L<Catalyst::Action>.
315 Returns the namespace of the current action, i.e., the URI prefix
316 corresponding to the controller of the current action. For example:
318 # in Controller::Foo::Bar
319 $c->namespace; # returns 'foo/bar';
325 Returns the current L<Catalyst::Request> object, giving access to
326 information about the current client request (including parameters,
327 cookies, HTTP headers, etc.). See L<Catalyst::Request>.
329 =head2 REQUEST FLOW HANDLING
331 =head2 $c->forward( $action [, \@arguments ] )
333 =head2 $c->forward( $class, $method, [, \@arguments ] )
335 This is one way of calling another action (method) in the same or
336 a different controller. You can also use C<< $self->my_method($c, @args) >>
337 in the same controller or C<< $c->controller('MyController')->my_method($c, @args) >>
338 in a different controller.
339 The main difference is that 'forward' uses some of the Catalyst request
340 cycle overhead, including debugging, which may be useful to you. On the
341 other hand, there are some complications to using 'forward', restrictions
342 on values returned from 'forward', and it may not handle errors as you prefer.
343 Whether you use 'forward' or not is up to you; it is not considered superior to
344 the other ways to call a method.
346 'forward' calls another action, by its private name. If you give a
347 class name but no method, C<process()> is called. You may also optionally
348 pass arguments in an arrayref. The action will receive the arguments in
349 C<@_> and C<< $c->req->args >>. Upon returning from the function,
350 C<< $c->req->args >> will be restored to the previous values.
352 Any data C<return>ed from the action forwarded to, will be returned by the
355 my $foodata = $c->forward('/foo');
356 $c->forward('index');
357 $c->forward(qw/Model::DBIC::Foo do_stuff/);
358 $c->forward('View::TT');
360 Note that L<< forward|/"$c->forward( $action [, \@arguments ] )" >> implies
361 an C<< eval { } >> around the call (actually
362 L<< execute|/"$c->execute( $class, $coderef )" >> does), thus rendering all
363 exceptions thrown by the called action non-fatal and pushing them onto
364 $c->error instead. If you want C<die> to propagate you need to do something
368 die join "\n", @{ $c->error } if @{ $c->error };
370 Or make sure to always return true values from your actions and write
373 $c->forward('foo') || return;
375 Another note is that C<< $c->forward >> always returns a scalar because it
376 actually returns $c->state which operates in a scalar context.
377 Thus, something like:
381 in an action that is forwarded to is going to return a scalar,
382 i.e. how many items are in that array, which is probably not what you want.
383 If you need to return an array then return a reference to it,
386 $c->stash->{array} = \@array;
388 and access it from the stash.
390 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.
394 sub forward { my $c = shift; no warnings 'recursion'; $c->dispatcher->forward( $c, @_ ) }
396 =head2 $c->detach( $action [, \@arguments ] )
398 =head2 $c->detach( $class, $method, [, \@arguments ] )
402 The same as L<< forward|/"$c->forward( $action [, \@arguments ] )" >>, but
403 doesn't return to the previous action when processing is finished.
405 When called with no arguments it escapes the processing chain entirely.
409 sub detach { my $c = shift; $c->dispatcher->detach( $c, @_ ) }
411 =head2 $c->visit( $action [, \@arguments ] )
413 =head2 $c->visit( $action [, \@captures, \@arguments ] )
415 =head2 $c->visit( $class, $method, [, \@arguments ] )
417 =head2 $c->visit( $class, $method, [, \@captures, \@arguments ] )
419 Almost the same as L<< forward|/"$c->forward( $action [, \@arguments ] )" >>,
420 but does a full dispatch, instead of just calling the new C<$action> /
421 C<< $class->$method >>. This means that C<begin>, C<auto> and the method
422 you go to are called, just like a new request.
424 In addition both C<< $c->action >> and C<< $c->namespace >> are localized.
425 This means, for example, that C<< $c->action >> methods such as
426 L<name|Catalyst::Action/name>, L<class|Catalyst::Action/class> and
427 L<reverse|Catalyst::Action/reverse> return information for the visited action
428 when they are invoked within the visited action. This is different from the
429 behavior of L<< forward|/"$c->forward( $action [, \@arguments ] )" >>, which
430 continues to use the $c->action object from the caller action even when
431 invoked from the called action.
433 C<< $c->stash >> is kept unchanged.
435 In effect, L<< visit|/"$c->visit( $action [, \@captures, \@arguments ] )" >>
436 allows you to "wrap" another action, just as it would have been called by
437 dispatching from a URL, while the analogous
438 L<< go|/"$c->go( $action [, \@captures, \@arguments ] )" >> allows you to
439 transfer control to another action as if it had been reached directly from a URL.
443 sub visit { my $c = shift; $c->dispatcher->visit( $c, @_ ) }
445 =head2 $c->go( $action [, \@arguments ] )
447 =head2 $c->go( $action [, \@captures, \@arguments ] )
449 =head2 $c->go( $class, $method, [, \@arguments ] )
451 =head2 $c->go( $class, $method, [, \@captures, \@arguments ] )
453 The relationship between C<go> and
454 L<< visit|/"$c->visit( $action [, \@captures, \@arguments ] )" >> is the same as
455 the relationship between
456 L<< forward|/"$c->forward( $class, $method, [, \@arguments ] )" >> and
457 L<< detach|/"$c->detach( $action [, \@arguments ] )" >>. Like C<< $c->visit >>,
458 C<< $c->go >> will perform a full dispatch on the specified action or method,
459 with localized C<< $c->action >> and C<< $c->namespace >>. Like C<detach>,
460 C<go> escapes the processing of the current request chain on completion, and
461 does not return to its caller.
463 @arguments are arguments to the final destination of $action. @captures are
464 arguments to the intermediate steps, if any, on the way to the final sub of
469 sub go { my $c = shift; $c->dispatcher->go( $c, @_ ) }
475 Returns the current L<Catalyst::Response> object, see there for details.
479 Returns a hashref to the stash, which may be used to store data and pass
480 it between components during a request. You can also set hash keys by
481 passing arguments. The stash is automatically sent to the view. The
482 stash is cleared at the end of a request; it cannot be used for
483 persistent storage (for this you must use a session; see
484 L<Catalyst::Plugin::Session> for a complete system integrated with
487 $c->stash->{foo} = $bar;
488 $c->stash( { moose => 'majestic', qux => 0 } );
489 $c->stash( bar => 1, gorch => 2 ); # equivalent to passing a hashref
491 # stash is automatically passed to the view for use in a template
492 $c->forward( 'MyApp::View::TT' );
496 around stash => sub {
499 my $stash = $orig->($c);
501 my $new_stash = @_ > 1 ? {@_} : $_[0];
502 croak('stash takes a hash or hashref') unless ref $new_stash;
503 foreach my $key ( keys %$new_stash ) {
504 $stash->{$key} = $new_stash->{$key};
514 =head2 $c->error($error, ...)
516 =head2 $c->error($arrayref)
518 Returns an arrayref containing error messages. If Catalyst encounters an
519 error while processing a request, it stores the error in $c->error. This
520 method should only be used to store fatal error messages.
522 my @error = @{ $c->error };
526 $c->error('Something bad happened');
533 my $error = ref $_[0] eq 'ARRAY' ? $_[0] : [@_];
534 croak @$error unless ref $c;
535 push @{ $c->{error} }, @$error;
537 elsif ( defined $_[0] ) { $c->{error} = undef }
538 return $c->{error} || [];
544 Contains the return value of the last executed action.
545 Note that << $c->state >> operates in a scalar context which means that all
546 values it returns are scalar.
548 =head2 $c->clear_errors
550 Clear errors. You probably don't want to clear the errors unless you are
551 implementing a custom error screen.
553 This is equivalent to running
564 sub _comp_search_prefixes {
566 return map $c->components->{ $_ }, $c->_comp_names_search_prefixes(@_);
569 # search components given a name and some prefixes
570 sub _comp_names_search_prefixes {
571 my ( $c, $name, @prefixes ) = @_;
572 my $appclass = ref $c || $c;
573 my $filter = "^${appclass}::(" . join( '|', @prefixes ) . ')::';
574 $filter = qr/$filter/; # Compile regex now rather than once per loop
576 # map the original component name to the sub part that we will search against
577 my %eligible = map { my $n = $_; $n =~ s{^$appclass\::[^:]+::}{}; $_ => $n; }
578 grep { /$filter/ } keys %{ $c->components };
580 # undef for a name will return all
581 return keys %eligible if !defined $name;
583 my $query = $name->$_isa('Regexp') ? $name : qr/^$name$/i;
584 my @result = grep { $eligible{$_} =~ m{$query} } keys %eligible;
586 return @result if @result;
588 # if we were given a regexp to search against, we're done.
589 return if $name->$_isa('Regexp');
591 # skip regexp fallback if configured
593 if $appclass->config->{disable_component_resolution_regex_fallback};
597 @result = grep { $eligible{ $_ } =~ m{$query} } keys %eligible;
599 # no results? try against full names
601 @result = grep { m{$query} } keys %eligible;
604 # don't warn if we didn't find any results, it just might not exist
606 # Disgusting hack to work out correct method name
607 my $warn_for = lc $prefixes[0];
608 my $msg = "Used regexp fallback for \$c->${warn_for}('${name}'), which found '" .
609 (join '", "', @result) . "'. Relying on regexp fallback behavior for " .
610 "component resolution is unreliable and unsafe.";
611 my $short = $result[0];
612 # remove the component namespace prefix
613 $short =~ s/.*?(Model|Controller|View):://;
614 my $shortmess = Carp::shortmess('');
615 if ($shortmess =~ m#Catalyst/Plugin#) {
616 $msg .= " You probably need to set '$short' instead of '${name}' in this " .
618 } elsif ($shortmess =~ m#Catalyst/lib/(View|Controller)#) {
619 $msg .= " You probably need to set '$short' instead of '${name}' in this " .
620 "component's config";
622 $msg .= " You probably meant \$c->${warn_for}('$short') instead of \$c->${warn_for}('${name}'), " .
623 "but if you really wanted to search, pass in a regexp as the argument " .
624 "like so: \$c->${warn_for}(qr/${name}/)";
626 $c->log->warn( "${msg}$shortmess" );
632 # Find possible names for a prefix
634 my ( $c, @prefixes ) = @_;
635 my $appclass = ref $c || $c;
637 my $filter = "^${appclass}::(" . join( '|', @prefixes ) . ')::';
639 my @names = map { s{$filter}{}; $_; }
640 $c->_comp_names_search_prefixes( undef, @prefixes );
645 # Filter a component before returning by calling ACCEPT_CONTEXT if available
646 sub _filter_component {
647 my ( $c, $comp, @args ) = @_;
649 if ( eval { $comp->can('ACCEPT_CONTEXT'); } ) {
650 return $comp->ACCEPT_CONTEXT( $c, @args );
656 =head2 COMPONENT ACCESSORS
658 =head2 $c->controller($name)
660 Gets a L<Catalyst::Controller> instance by name.
662 $c->controller('Foo')->do_stuff;
664 If the name is omitted, will return the controller for the dispatched
667 If you want to search for controllers, pass in a regexp as the argument.
669 # find all controllers that start with Foo
670 my @foo_controllers = $c->controller(qr{^Foo});
676 my ( $c, $name, @args ) = @_;
678 my $appclass = ref($c) || $c;
680 unless ( $name->$_isa('Regexp') ) { # Direct component hash lookup to avoid costly regexps
681 my $comps = $c->components;
682 my $check = $appclass."::Controller::".$name;
683 return $c->_filter_component( $comps->{$check}, @args ) if exists $comps->{$check};
685 my @result = $c->_comp_search_prefixes( $name, qw/Controller C/ );
686 return map { $c->_filter_component( $_, @args ) } @result if ref $name;
687 return $c->_filter_component( $result[ 0 ], @args );
690 return $c->component( $c->action->class );
693 =head2 $c->model($name)
695 Gets a L<Catalyst::Model> instance by name.
697 $c->model('Foo')->do_stuff;
699 Any extra arguments are directly passed to ACCEPT_CONTEXT.
701 If the name is omitted, it will look for
702 - a model object in $c->stash->{current_model_instance}, then
703 - a model name in $c->stash->{current_model}, then
704 - a config setting 'default_model', or
705 - check if there is only one model, and return it if that's the case.
707 If you want to search for models, pass in a regexp as the argument.
709 # find all models that start with Foo
710 my @foo_models = $c->model(qr{^Foo});
715 my ( $c, $name, @args ) = @_;
716 my $appclass = ref($c) || $c;
718 unless ( $name->$_isa('Regexp') ) { # Direct component hash lookup to avoid costly regexps
719 my $comps = $c->components;
720 my $check = $appclass."::Model::".$name;
721 return $c->_filter_component( $comps->{$check}, @args ) if exists $comps->{$check};
723 my @result = $c->_comp_search_prefixes( $name, qw/Model M/ );
724 return map { $c->_filter_component( $_, @args ) } @result if ref $name;
725 return $c->_filter_component( $result[ 0 ], @args );
729 return $c->stash->{current_model_instance}
730 if $c->stash->{current_model_instance};
731 return $c->model( $c->stash->{current_model} )
732 if $c->stash->{current_model};
734 return $c->model( $appclass->config->{default_model} )
735 if $appclass->config->{default_model};
737 my( $comp, $rest ) = $c->_comp_search_prefixes( undef, qw/Model M/);
740 $c->log->warn( Carp::shortmess('Calling $c->model() will return a random model unless you specify one of:') );
741 $c->log->warn( '* $c->config(default_model => "the name of the default model to use")' );
742 $c->log->warn( '* $c->stash->{current_model} # the name of the model to use for this request' );
743 $c->log->warn( '* $c->stash->{current_model_instance} # the instance of the model to use for this request' );
744 $c->log->warn( 'NB: in version 5.81, the "random" behavior will not work at all.' );
747 return $c->_filter_component( $comp );
751 =head2 $c->view($name)
753 Gets a L<Catalyst::View> instance by name.
755 $c->view('Foo')->do_stuff;
757 Any extra arguments are directly passed to ACCEPT_CONTEXT.
759 If the name is omitted, it will look for
760 - a view object in $c->stash->{current_view_instance}, then
761 - a view name in $c->stash->{current_view}, then
762 - a config setting 'default_view', or
763 - check if there is only one view, and return it if that's the case.
765 If you want to search for views, pass in a regexp as the argument.
767 # find all views that start with Foo
768 my @foo_views = $c->view(qr{^Foo});
773 my ( $c, $name, @args ) = @_;
775 my $appclass = ref($c) || $c;
777 unless ( $name->$_isa('Regexp') ) { # Direct component hash lookup to avoid costly regexps
778 my $comps = $c->components;
779 my $check = $appclass."::View::".$name;
780 if( exists $comps->{$check} ) {
781 return $c->_filter_component( $comps->{$check}, @args );
784 $c->log->warn( "Attempted to use view '$check', but does not exist" );
787 my @result = $c->_comp_search_prefixes( $name, qw/View V/ );
788 return map { $c->_filter_component( $_, @args ) } @result if ref $name;
789 return $c->_filter_component( $result[ 0 ], @args );
793 return $c->stash->{current_view_instance}
794 if $c->stash->{current_view_instance};
795 return $c->view( $c->stash->{current_view} )
796 if $c->stash->{current_view};
798 return $c->view( $appclass->config->{default_view} )
799 if $appclass->config->{default_view};
801 my( $comp, $rest ) = $c->_comp_search_prefixes( undef, qw/View V/);
804 $c->log->warn( 'Calling $c->view() will return a random view unless you specify one of:' );
805 $c->log->warn( '* $c->config(default_view => "the name of the default view to use")' );
806 $c->log->warn( '* $c->stash->{current_view} # the name of the view to use for this request' );
807 $c->log->warn( '* $c->stash->{current_view_instance} # the instance of the view to use for this request' );
808 $c->log->warn( 'NB: in version 5.81, the "random" behavior will not work at all.' );
811 return $c->_filter_component( $comp );
814 =head2 $c->controllers
816 Returns the available names which can be passed to $c->controller
822 return $c->_comp_names(qw/Controller C/);
827 Returns the available names which can be passed to $c->model
833 return $c->_comp_names(qw/Model M/);
839 Returns the available names which can be passed to $c->view
845 return $c->_comp_names(qw/View V/);
848 =head2 $c->comp($name)
850 =head2 $c->component($name)
852 Gets a component object by name. This method is not recommended,
853 unless you want to get a specific component by full
854 class. C<< $c->controller >>, C<< $c->model >>, and C<< $c->view >>
855 should be used instead.
857 If C<$name> is a regexp, a list of components matched against the full
858 component name will be returned.
860 If Catalyst can't find a component by name, it will fallback to regex
861 matching by default. To disable this behaviour set
862 disable_component_resolution_regex_fallback to a true value.
864 __PACKAGE__->config( disable_component_resolution_regex_fallback => 1 );
869 my ( $c, $name, @args ) = @_;
872 my $comps = $c->components;
875 # is it the exact name?
876 return $c->_filter_component( $comps->{ $name }, @args )
877 if exists $comps->{ $name };
879 # perhaps we just omitted "MyApp"?
880 my $composed = ( ref $c || $c ) . "::${name}";
881 return $c->_filter_component( $comps->{ $composed }, @args )
882 if exists $comps->{ $composed };
884 # search all of the models, views and controllers
885 my( $comp ) = $c->_comp_search_prefixes( $name, qw/Model M Controller C View V/ );
886 return $c->_filter_component( $comp, @args ) if $comp;
890 if $c->config->{disable_component_resolution_regex_fallback};
892 # This is here so $c->comp( '::M::' ) works
893 my $query = ref $name ? $name : qr{$name}i;
895 my @result = grep { m{$query} } keys %{ $c->components };
896 return map { $c->_filter_component( $_, @args ) } @result if ref $name;
899 $c->log->warn( Carp::shortmess(qq(Found results for "${name}" using regexp fallback)) );
900 $c->log->warn( 'Relying on the regexp fallback behavior for component resolution' );
901 $c->log->warn( 'is unreliable and unsafe. You have been warned' );
902 return $c->_filter_component( $result[ 0 ], @args );
905 # I would expect to return an empty list here, but that breaks back-compat
909 return sort keys %{ $c->components };
912 =head2 CLASS DATA AND HELPER CLASSES
916 Returns or takes a hashref containing the application's configuration.
918 __PACKAGE__->config( { db => 'dsn:SQLite:foo.db' } );
920 You can also use a C<YAML>, C<XML> or L<Config::General> config file
921 like C<myapp.conf> in your applications home directory. See
922 L<Catalyst::Plugin::ConfigLoader>.
924 =head3 Cascading configuration
926 The config method is present on all Catalyst components, and configuration
927 will be merged when an application is started. Configuration loaded with
928 L<Catalyst::Plugin::ConfigLoader> takes precedence over other configuration,
929 followed by configuration in your top level C<MyApp> class. These two
930 configurations are merged, and then configuration data whose hash key matches a
931 component name is merged with configuration for that component.
933 The configuration for a component is then passed to the C<new> method when a
934 component is constructed.
938 MyApp->config({ 'Model::Foo' => { bar => 'baz', overrides => 'me' } });
939 MyApp::Model::Foo->config({ quux => 'frob', overrides => 'this' });
941 will mean that C<MyApp::Model::Foo> receives the following data when
944 MyApp::Model::Foo->new({
950 It's common practice to use a Moose attribute
951 on the receiving component to access the config value.
953 package MyApp::Model::Foo;
957 # this attr will receive 'baz' at construction time
963 You can then get the value 'baz' by calling $c->model('Foo')->bar
964 (or $self->bar inside code in the model).
966 B<NOTE:> you MUST NOT call C<< $self->config >> or C<< __PACKAGE__->config >>
967 as a way of reading config within your code, as this B<will not> give you the
968 correctly merged config back. You B<MUST> take the config values supplied to
969 the constructor and use those instead.
973 around config => sub {
977 croak('Setting config after setup has been run is not allowed.')
978 if ( @_ and $c->setup_finished );
985 Returns the logging object instance. Unless it is already set, Catalyst
986 sets this up with a L<Catalyst::Log> object. To use your own log class,
987 set the logger with the C<< __PACKAGE__->log >> method prior to calling
988 C<< __PACKAGE__->setup >>.
990 __PACKAGE__->log( MyLogger->new );
995 $c->log->info( 'Now logging with my own logger!' );
997 Your log class should implement the methods described in
1003 Returns 1 if debug mode is enabled, 0 otherwise.
1005 You can enable debug mode in several ways:
1009 =item By calling myapp_server.pl with the -d flag
1011 =item With the environment variables MYAPP_DEBUG, or CATALYST_DEBUG
1013 =item The -Debug option in your MyApp.pm
1015 =item By declaring C<sub debug { 1 }> in your MyApp.pm.
1019 The first three also set the log level to 'debug'.
1021 Calling C<< $c->debug(1) >> has no effect.
1027 =head2 $c->dispatcher
1029 Returns the dispatcher instance. See L<Catalyst::Dispatcher>.
1033 Returns the engine instance. See L<Catalyst::Engine>.
1036 =head2 UTILITY METHODS
1038 =head2 $c->path_to(@path)
1040 Merges C<@path> with C<< $c->config->{home} >> and returns a
1041 L<Path::Class::Dir> object. Note you can usually use this object as
1042 a filename, but sometimes you will have to explicitly stringify it
1043 yourself by calling the C<< ->stringify >> method.
1047 $c->path_to( 'db', 'sqlite.db' );
1052 my ( $c, @path ) = @_;
1053 my $path = Path::Class::Dir->new( $c->config->{home}, @path );
1054 if ( -d $path ) { return $path }
1055 else { return Path::Class::File->new( $c->config->{home}, @path ) }
1059 my ( $class, $name, $plugin, @args ) = @_;
1061 # See block comment in t/unit_core_plugin.t
1062 $class->log->warn(qq/Adding plugin using the ->plugin method is deprecated, and will be removed in a future release/);
1064 $class->_register_plugin( $plugin, 1 );
1066 eval { $plugin->import };
1067 $class->mk_classdata($name);
1069 eval { $obj = $plugin->new(@args) };
1072 Catalyst::Exception->throw( message =>
1073 qq/Couldn't instantiate instant plugin "$plugin", "$@"/ );
1076 $class->$name($obj);
1077 $class->log->debug(qq/Initialized instant plugin "$plugin" as "$name"/)
1083 Initializes the dispatcher and engine, loads any plugins, and loads the
1084 model, view, and controller components. You may also specify an array
1085 of plugins to load here, if you choose to not load them in the C<use
1089 MyApp->setup( qw/-Debug/ );
1091 B<Note:> You B<should not> wrap this method with method modifiers
1092 or bad things will happen - wrap the C<setup_finalize> method instead.
1097 my ( $class, @arguments ) = @_;
1098 croak('Running setup more than once')
1099 if ( $class->setup_finished );
1101 unless ( $class->isa('Catalyst') ) {
1103 Catalyst::Exception->throw(
1104 message => qq/'$class' does not inherit from Catalyst/ );
1107 if ( $class->arguments ) {
1108 @arguments = ( @arguments, @{ $class->arguments } );
1114 foreach (@arguments) {
1118 ( $flags->{log} ) ? 'debug,' . $flags->{log} : 'debug';
1120 elsif (/^-(\w+)=?(.*)$/) {
1121 $flags->{ lc $1 } = $2;
1124 push @{ $flags->{plugins} }, $_;
1128 $class->setup_home( delete $flags->{home} );
1130 $class->setup_log( delete $flags->{log} );
1131 $class->setup_plugins( delete $flags->{plugins} );
1133 # Call plugins setup, this is stupid and evil.
1134 # Also screws C3 badly on 5.10, hack to avoid.
1136 no warnings qw/redefine/;
1137 local *setup = sub { };
1138 $class->setup unless $Catalyst::__AM_RESTARTING;
1141 $class->setup_middleware();
1142 $class->setup_data_handlers();
1143 $class->setup_dispatcher( delete $flags->{dispatcher} );
1144 if (my $engine = delete $flags->{engine}) {
1145 $class->log->warn("Specifying the engine in ->setup is no longer supported, see Catalyst::Upgrading");
1147 $class->setup_engine();
1148 $class->setup_stats( delete $flags->{stats} );
1150 for my $flag ( sort keys %{$flags} ) {
1152 if ( my $code = $class->can( 'setup_' . $flag ) ) {
1153 &$code( $class, delete $flags->{$flag} );
1156 $class->log->warn(qq/Unknown flag "$flag"/);
1160 eval { require Catalyst::Devel; };
1161 if( !$@ && $ENV{CATALYST_SCRIPT_GEN} && ( $ENV{CATALYST_SCRIPT_GEN} < $Catalyst::Devel::CATALYST_SCRIPT_GEN ) ) {
1162 $class->log->warn(<<"EOF");
1163 You are running an old script!
1165 Please update by running (this will overwrite existing files):
1166 catalyst.pl -force -scripts $class
1168 or (this will not overwrite existing files):
1169 catalyst.pl -scripts $class
1174 # Initialize our data structure
1175 $class->components( {} );
1177 $class->setup_components;
1179 if ( $class->debug ) {
1180 my @plugins = map { "$_ " . ( $_->VERSION || '' ) } $class->registered_plugins;
1183 my $column_width = Catalyst::Utils::term_width() - 6;
1184 my $t = Text::SimpleTable->new($column_width);
1185 $t->row($_) for @plugins;
1186 $class->log->debug( "Loaded plugins:\n" . $t->draw . "\n" );
1189 my @middleware = map {
1192 (ref($_) .' '. ($_->can('VERSION') ? $_->VERSION || '' : '')
1193 || '') } $class->registered_middlewares;
1196 my $column_width = Catalyst::Utils::term_width() - 6;
1197 my $t = Text::SimpleTable->new($column_width);
1198 $t->row($_) for @middleware;
1199 $class->log->debug( "Loaded PSGI Middleware:\n" . $t->draw . "\n" );
1202 my %dh = $class->registered_data_handlers;
1203 if (my @data_handlers = keys %dh) {
1204 my $column_width = Catalyst::Utils::term_width() - 6;
1205 my $t = Text::SimpleTable->new($column_width);
1206 $t->row($_) for @data_handlers;
1207 $class->log->debug( "Loaded Request Data Handlers:\n" . $t->draw . "\n" );
1210 my $dispatcher = $class->dispatcher;
1211 my $engine = $class->engine;
1212 my $home = $class->config->{home};
1214 $class->log->debug(sprintf(q/Loaded dispatcher "%s"/, blessed($dispatcher)));
1215 $class->log->debug(sprintf(q/Loaded engine "%s"/, blessed($engine)));
1219 ? $class->log->debug(qq/Found home "$home"/)
1220 : $class->log->debug(qq/Home "$home" doesn't exist/)
1221 : $class->log->debug(q/Couldn't find home/);
1223 my $column_width = Catalyst::Utils::term_width() - 8 - 9;
1224 my $t = Text::SimpleTable->new( [ $column_width, 'Class' ], [ 8, 'Type' ] );
1225 for my $comp ( sort keys %{ $class->components } ) {
1226 my $type = ref $class->components->{$comp} ? 'instance' : 'class';
1227 $t->row( $comp, $type );
1229 $class->log->debug( "Loaded components:\n" . $t->draw . "\n" )
1230 if ( keys %{ $class->components } );
1233 # Add our self to components, since we are also a component
1234 if( $class->isa('Catalyst::Controller') ){
1235 $class->components->{$class} = $class;
1238 $class->setup_actions;
1240 if ( $class->debug ) {
1241 my $name = $class->config->{name} || 'Application';
1242 $class->log->info("$name powered by Catalyst $Catalyst::VERSION");
1245 if ($class->config->{case_sensitive}) {
1246 $class->log->warn($class . "->config->{case_sensitive} is set.");
1247 $class->log->warn("This setting is deprecated and planned to be removed in Catalyst 5.81.");
1250 $class->setup_finalize;
1251 # Should be the last thing we do so that user things hooking
1252 # setup_finalize can log..
1253 $class->log->_flush() if $class->log->can('_flush');
1254 return 1; # Explicit return true as people have __PACKAGE__->setup as the last thing in their class. HATE.
1257 =head2 $app->setup_finalize
1259 A hook to attach modifiers to. This method does not do anything except set the
1260 C<setup_finished> accessor.
1262 Applying method modifiers to the C<setup> method doesn't work, because of quirky things done for plugin setup.
1266 after setup_finalize => sub {
1274 sub setup_finalize {
1276 $class->setup_finished(1);
1279 =head2 $c->uri_for( $path?, @args?, \%query_values? )
1281 =head2 $c->uri_for( $action, \@captures?, @args?, \%query_values? )
1283 Constructs an absolute L<URI> object based on the application root, the
1284 provided path, and the additional arguments and query parameters provided.
1285 When used as a string, provides a textual URI. If you need more flexibility
1286 than this (i.e. the option to provide relative URIs etc.) see
1287 L<Catalyst::Plugin::SmartURI>.
1289 If no arguments are provided, the URI for the current action is returned.
1290 To return the current action and also provide @args, use
1291 C<< $c->uri_for( $c->action, @args ) >>.
1293 If the first argument is a string, it is taken as a public URI path relative
1294 to C<< $c->namespace >> (if it doesn't begin with a forward slash) or
1295 relative to the application root (if it does). It is then merged with
1296 C<< $c->request->base >>; any C<@args> are appended as additional path
1297 components; and any C<%query_values> are appended as C<?foo=bar> parameters.
1299 If the first argument is a L<Catalyst::Action> it represents an action which
1300 will have its path resolved using C<< $c->dispatcher->uri_for_action >>. The
1301 optional C<\@captures> argument (an arrayref) allows passing the captured
1302 variables that are needed to fill in the paths of Chained and Regex actions;
1303 once the path is resolved, C<uri_for> continues as though a path was
1304 provided, appending any arguments or parameters and creating an absolute
1307 The captures for the current request can be found in
1308 C<< $c->request->captures >>, and actions can be resolved using
1309 C<< Catalyst::Controller->action_for($name) >>. If you have a private action
1310 path, use C<< $c->uri_for_action >> instead.
1312 # Equivalent to $c->req->uri
1313 $c->uri_for($c->action, $c->req->captures,
1314 @{ $c->req->args }, $c->req->params);
1316 # For the Foo action in the Bar controller
1317 $c->uri_for($c->controller('Bar')->action_for('Foo'));
1319 # Path to a static resource
1320 $c->uri_for('/static/images/logo.png');
1325 my ( $c, $path, @args ) = @_;
1327 if ( $path->$_isa('Catalyst::Controller') ) {
1328 $path = $path->path_prefix;
1333 undef($path) if (defined $path && $path eq '');
1336 ( scalar @args && ref $args[$#args] eq 'HASH' ? pop @args : {} );
1338 carp "uri_for called with undef argument" if grep { ! defined $_ } @args;
1339 foreach my $arg (@args) {
1340 utf8::encode($arg) if utf8::is_utf8($arg);
1341 $arg =~ s/([^$URI::uric])/$URI::Escape::escapes{$1}/go;
1344 if ( $path->$_isa('Catalyst::Action') ) { # action object
1345 s|/|%2F|g for @args;
1346 my $captures = [ map { s|/|%2F|g; $_; }
1347 ( scalar @args && ref $args[0] eq 'ARRAY'
1351 foreach my $capture (@$captures) {
1352 utf8::encode($capture) if utf8::is_utf8($capture);
1353 $capture =~ s/([^$URI::uric])/$URI::Escape::escapes{$1}/go;
1357 # ->uri_for( $action, \@captures_and_args, \%query_values? )
1358 if( !@args && $action->number_of_args ) {
1359 my $expanded_action = $c->dispatcher->expand_action( $action );
1361 my $num_captures = $expanded_action->number_of_captures;
1362 unshift @args, splice @$captures, $num_captures;
1365 $path = $c->dispatcher->uri_for_action($action, $captures);
1366 if (not defined $path) {
1367 $c->log->debug(qq/Can't find uri_for action '$action' @$captures/)
1371 $path = '/' if $path eq '';
1374 unshift(@args, $path);
1376 unless (defined $path && $path =~ s!^/!!) { # in-place strip
1377 my $namespace = $c->namespace;
1378 if (defined $path) { # cheesy hack to handle path '../foo'
1379 $namespace =~ s{(?:^|/)[^/]+$}{} while $args[0] =~ s{^\.\./}{};
1381 unshift(@args, $namespace || '');
1384 # join args with '/', or a blank string
1385 my $args = join('/', grep { defined($_) } @args);
1386 $args =~ s/\?/%3F/g; # STUPID STUPID SPECIAL CASE
1389 my ($base, $class) = ('/', 'URI::_generic');
1391 $base = $c->req->base;
1392 $class = ref($base);
1393 $base =~ s{(?<!/)$}{/};
1398 if (my @keys = keys %$params) {
1399 # somewhat lifted from URI::_query's query_form
1400 $query = '?'.join('&', map {
1401 my $val = $params->{$_};
1402 s/([;\/?:@&=+,\$\[\]%])/$URI::Escape::escapes{$1}/go;
1405 $val = '' unless defined $val;
1408 utf8::encode( $param ) if utf8::is_utf8($param);
1409 # using the URI::Escape pattern here so utf8 chars survive
1410 $param =~ s/([^A-Za-z0-9\-_.!~*'() ])/$URI::Escape::escapes{$1}/go;
1412 "${key}=$param"; } ( ref $val eq 'ARRAY' ? @$val : $val ));
1416 my $res = bless(\"${base}${args}${query}", $class);
1420 =head2 $c->uri_for_action( $path, \@captures_and_args?, @args?, \%query_values? )
1422 =head2 $c->uri_for_action( $action, \@captures_and_args?, @args?, \%query_values? )
1428 A private path to the Catalyst action you want to create a URI for.
1430 This is a shortcut for calling C<< $c->dispatcher->get_action_by_path($path)
1431 >> and passing the resulting C<$action> and the remaining arguments to C<<
1434 You can also pass in a Catalyst::Action object, in which case it is passed to
1437 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.
1439 For example, if the action looks like:
1441 package MyApp::Controller::Users;
1443 sub lst : Path('the-list') {}
1447 $c->uri_for_action('/users/lst')
1449 and it will create the URI /users/the-list.
1451 =item \@captures_and_args?
1453 Optional array reference of Captures (i.e. C<<CaptureArgs or $c->req->captures>)
1454 and arguments to the request. Usually used with L<Catalyst::DispatchType::Chained>
1455 to interpolate all the parameters in the URI.
1459 Optional list of extra arguments - can be supplied in the
1460 C<< \@captures_and_args? >> array ref, or here - whichever is easier for your
1463 Your action can have zero, a fixed or a variable number of args (e.g.
1464 C<< Args(1) >> for a fixed number or C<< Args() >> for a variable number)..
1466 =item \%query_values?
1468 Optional array reference of query parameters to append. E.g.
1474 /rest/of/your/uri?foo=bar
1480 sub uri_for_action {
1481 my ( $c, $path, @args ) = @_;
1482 my $action = blessed($path)
1484 : $c->dispatcher->get_action_by_path($path);
1485 unless (defined $action) {
1486 croak "Can't find action for path '$path'";
1488 return $c->uri_for( $action, @args );
1491 =head2 $c->welcome_message
1493 Returns the Catalyst welcome HTML page.
1497 sub welcome_message {
1499 my $name = $c->config->{name};
1500 my $logo = $c->uri_for('/static/images/catalyst_logo.png');
1501 my $prefix = Catalyst::Utils::appprefix( ref $c );
1502 $c->response->content_type('text/html; charset=utf-8');
1504 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
1505 "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
1506 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
1508 <meta http-equiv="Content-Language" content="en" />
1509 <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
1510 <title>$name on Catalyst $VERSION</title>
1511 <style type="text/css">
1514 background-color: #eee;
1521 margin-bottom: 10px;
1523 background-color: #ccc;
1524 border: 1px solid #aaa;
1529 font-family: verdana, tahoma, sans-serif;
1532 font-family: verdana, tahoma, sans-serif;
1535 text-decoration: none;
1537 border-bottom: 1px dotted #bbb;
1539 :link:hover, :visited:hover {
1552 background-color: #fff;
1553 border: 1px solid #aaa;
1557 font-weight: normal;
1579 <h1><span id="appname">$name</span> on <a href="http://catalyst.perl.org">Catalyst</a>
1584 <img src="$logo" alt="Catalyst Logo" />
1586 <p>Welcome to the world of Catalyst.
1587 This <a href="http://en.wikipedia.org/wiki/MVC">MVC</a>
1588 framework will make web development something you had
1589 never expected it to be: Fun, rewarding, and quick.</p>
1590 <h2>What to do now?</h2>
1591 <p>That really depends on what <b>you</b> want to do.
1592 We do, however, provide you with a few starting points.</p>
1593 <p>If you want to jump right into web development with Catalyst
1594 you might want to start with a tutorial.</p>
1595 <pre>perldoc <a href="https://metacpan.org/module/Catalyst::Manual::Tutorial">Catalyst::Manual::Tutorial</a></code>
1597 <p>Afterwards you can go on to check out a more complete look at our features.</p>
1599 <code>perldoc <a href="https://metacpan.org/module/Catalyst::Manual::Intro">Catalyst::Manual::Intro</a>
1600 <!-- Something else should go here, but the Catalyst::Manual link seems unhelpful -->
1602 <h2>What to do next?</h2>
1603 <p>Next it's time to write an actual application. Use the
1604 helper scripts to generate <a href="https://metacpan.org/search?q=Catalyst%3A%3AController">controllers</a>,
1605 <a href="https://metacpan.org/search?q=Catalyst%3A%3AModel">models</a>, and
1606 <a href="https://metacpan.org/search?q=Catalyst%3A%3AView">views</a>;
1607 they can save you a lot of work.</p>
1608 <pre><code>script/${prefix}_create.pl --help</code></pre>
1609 <p>Also, be sure to check out the vast and growing
1610 collection of <a href="http://search.cpan.org/search?query=Catalyst">plugins for Catalyst on CPAN</a>;
1611 you are likely to find what you need there.
1615 <p>Catalyst has a very active community. Here are the main places to
1616 get in touch with us.</p>
1619 <a href="http://dev.catalyst.perl.org">Wiki</a>
1622 <a href="http://lists.scsys.co.uk/cgi-bin/mailman/listinfo/catalyst">Mailing-List</a>
1625 <a href="irc://irc.perl.org/catalyst">IRC channel #catalyst on irc.perl.org</a>
1628 <h2>In conclusion</h2>
1629 <p>The Catalyst team hopes you will enjoy using Catalyst as much
1630 as we enjoyed making it. Please contact us if you have ideas
1631 for improvement or other feedback.</p>
1641 Contains a hash of options passed from the application script, including
1642 the original ARGV the script received, the processed values from that
1643 ARGV and any extra arguments to the script which were not processed.
1645 This can be used to add custom options to your application's scripts
1646 and setup your application differently depending on the values of these
1649 =head1 INTERNAL METHODS
1651 These methods are not meant to be used by end users.
1653 =head2 $c->components
1655 Returns a hash of components.
1657 =head2 $c->context_class
1659 Returns or sets the context class.
1663 Returns a hashref containing coderefs and execution counts (needed for
1664 deep recursion detection).
1668 Returns the number of actions on the current internal execution stack.
1672 Dispatches a request to actions.
1676 sub dispatch { my $c = shift; $c->dispatcher->dispatch( $c, @_ ) }
1678 =head2 $c->dispatcher_class
1680 Returns or sets the dispatcher class.
1682 =head2 $c->dump_these
1684 Returns a list of 2-element array references (name, structure) pairs
1685 that will be dumped on the error page in debug mode.
1691 [ Request => $c->req ],
1692 [ Response => $c->res ],
1693 [ Stash => $c->stash ],
1694 [ Config => $c->config ];
1697 =head2 $c->engine_class
1699 Returns or sets the engine class.
1701 =head2 $c->execute( $class, $coderef )
1703 Execute a coderef in given class and catch exceptions. Errors are available
1709 my ( $c, $class, $code ) = @_;
1710 $class = $c->component($class) || $class;
1713 if ( $c->depth >= $RECURSION ) {
1714 my $action = $code->reverse();
1715 $action = "/$action" unless $action =~ /->/;
1716 my $error = qq/Deep recursion detected calling "${action}"/;
1717 $c->log->error($error);
1723 my $stats_info = $c->_stats_start_execute( $code ) if $c->use_stats;
1725 push( @{ $c->stack }, $code );
1727 no warnings 'recursion';
1728 # N.B. This used to be combined, but I have seen $c get clobbered if so, and
1729 # I have no idea how, ergo $ret (which appears to fix the issue)
1730 eval { my $ret = $code->execute( $class, $c, @{ $c->req->args } ) || 0; $c->state( $ret ) };
1732 $c->_stats_finish_execute( $stats_info ) if $c->use_stats and $stats_info;
1734 my $last = pop( @{ $c->stack } );
1736 if ( my $error = $@ ) {
1737 if ( blessed($error) and $error->isa('Catalyst::Exception::Detach') ) {
1738 $error->rethrow if $c->depth > 1;
1740 elsif ( blessed($error) and $error->isa('Catalyst::Exception::Go') ) {
1741 $error->rethrow if $c->depth > 0;
1744 unless ( ref $error ) {
1745 no warnings 'uninitialized';
1747 my $class = $last->class;
1748 my $name = $last->name;
1749 $error = qq/Caught exception in $class->$name "$error"/;
1758 sub _stats_start_execute {
1759 my ( $c, $code ) = @_;
1760 my $appclass = ref($c) || $c;
1761 return if ( ( $code->name =~ /^_.*/ )
1762 && ( !$appclass->config->{show_internal_actions} ) );
1764 my $action_name = $code->reverse();
1765 $c->counter->{$action_name}++;
1767 my $action = $action_name;
1768 $action = "/$action" unless $action =~ /->/;
1770 # determine if the call was the result of a forward
1771 # this is done by walking up the call stack and looking for a calling
1772 # sub of Catalyst::forward before the eval
1774 for my $index ( 2 .. 11 ) {
1776 if ( ( caller($index) )[0] eq 'Catalyst'
1777 && ( caller($index) )[3] eq '(eval)' );
1779 if ( ( caller($index) )[3] =~ /forward$/ ) {
1780 $callsub = ( caller($index) )[3];
1781 $action = "-> $action";
1786 my $uid = $action_name . $c->counter->{$action_name};
1788 # is this a root-level call or a forwarded call?
1789 if ( $callsub =~ /forward$/ ) {
1790 my $parent = $c->stack->[-1];
1792 # forward, locate the caller
1793 if ( defined $parent && exists $c->counter->{"$parent"} ) {
1796 parent => "$parent" . $c->counter->{"$parent"},
1802 # forward with no caller may come from a plugin
1821 sub _stats_finish_execute {
1822 my ( $c, $info ) = @_;
1823 $c->stats->profile( end => $info );
1828 Finalizes the request.
1835 for my $error ( @{ $c->error } ) {
1836 $c->log->error($error);
1839 # Support skipping finalize for psgix.io style 'jailbreak'. Used to support
1840 # stuff like cometd and websockets
1842 if($c->request->_has_io_fh) {
1847 # Allow engine to handle finalize flow (for POE)
1848 my $engine = $c->engine;
1849 if ( my $code = $engine->can('finalize') ) {
1854 $c->finalize_uploads;
1857 if ( $#{ $c->error } >= 0 ) {
1861 $c->finalize_headers unless $c->response->finalized_headers;
1868 if ($c->use_stats) {
1869 my $elapsed = $c->stats->elapsed;
1870 my $av = $elapsed == 0 ? '??' : sprintf '%.3f', 1 / $elapsed;
1872 "Request took ${elapsed}s ($av/s)\n" . $c->stats->report . "\n" );
1875 return $c->response->status;
1878 =head2 $c->finalize_body
1884 sub finalize_body { my $c = shift; $c->engine->finalize_body( $c, @_ ) }
1886 =head2 $c->finalize_cookies
1892 sub finalize_cookies { my $c = shift; $c->engine->finalize_cookies( $c, @_ ) }
1894 =head2 $c->finalize_error
1900 sub finalize_error {
1902 if($#{$c->error} > 0) {
1903 $c->engine->finalize_error( $c, @_ );
1905 my ($error) = @{$c->error};
1908 ($error->can('as_psgi') || $error->can('code'))
1910 # In the case where the error 'knows what it wants', becauses its PSGI
1911 # aware, just rethow and let middleware catch it
1912 $error->can('rethrow') ? $error->rethrow : croak $error;
1915 $c->engine->finalize_error( $c, @_ )
1920 =head2 $c->finalize_headers
1926 sub finalize_headers {
1929 my $response = $c->response; #accessor calls can add up?
1931 # Check if we already finalized headers
1932 return if $response->finalized_headers;
1935 if ( my $location = $response->redirect ) {
1936 $c->log->debug(qq/Redirecting to "$location"/) if $c->debug;
1937 $response->header( Location => $location );
1939 if ( !$response->has_body ) {
1940 # Add a default body if none is already present
1941 my $encoded_location = encode_entities($location);
1942 $response->body(<<"EOF");
1943 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
1944 <html xmlns="http://www.w3.org/1999/xhtml">
1946 <title>Moved</title>
1949 <p>This item has moved <a href="$encoded_location">here</a>.</p>
1953 $response->content_type('text/html; charset=utf-8');
1957 # Remove incorrectly added body and content related meta data when returning
1958 # an information response, or a response the is required to not include a body
1960 if ( $response->status =~ /^(1\d\d|[23]04)$/ ) {
1961 if($response->has_body) {
1962 $c->log->debug('Removing body for informational or no content http responses');
1963 $response->body('');
1964 $response->headers->remove_header("Content-Length");
1968 $c->finalize_cookies;
1970 $c->response->finalize_headers();
1973 $response->finalized_headers(1);
1976 =head2 $c->finalize_output
1978 An alias for finalize_body.
1980 =head2 $c->finalize_read
1982 Finalizes the input after reading is complete.
1986 sub finalize_read { my $c = shift; $c->engine->finalize_read( $c, @_ ) }
1988 =head2 $c->finalize_uploads
1990 Finalizes uploads. Cleans up any temporary files.
1994 sub finalize_uploads { my $c = shift; $c->engine->finalize_uploads( $c, @_ ) }
1996 =head2 $c->get_action( $action, $namespace )
1998 Gets an action in a given namespace.
2002 sub get_action { my $c = shift; $c->dispatcher->get_action(@_) }
2004 =head2 $c->get_actions( $action, $namespace )
2006 Gets all actions of a given name in a namespace and all parent
2011 sub get_actions { my $c = shift; $c->dispatcher->get_actions( $c, @_ ) }
2013 =head2 $app->handle_request( @arguments )
2015 Called to handle each HTTP request.
2019 sub handle_request {
2020 my ( $class, @arguments ) = @_;
2022 # Always expect worst case!
2025 if ($class->debug) {
2026 my $secs = time - $START || 1;
2027 my $av = sprintf '%.3f', $COUNT / $secs;
2028 my $time = localtime time;
2029 $class->log->info("*** Request $COUNT ($av/s) [$$] [$time] ***");
2032 my $c = $class->prepare(@arguments);
2034 $status = $c->finalize;
2036 chomp(my $error = $_);
2037 $class->log->error(qq/Caught exception in engine "$error"/);
2038 #rethow if this can be handled by middleware
2039 if(blessed $error && ($error->can('as_psgi') || $error->can('code'))) {
2040 $error->can('rethrow') ? $error->rethrow : croak $error;
2046 if(my $coderef = $class->log->can('_flush')){
2047 $class->log->$coderef();
2052 =head2 $class->prepare( @arguments )
2054 Creates a Catalyst context from an engine-specific request (Apache, CGI,
2061 predicate => '_has_uploadtmp',
2065 my ( $class, @arguments ) = @_;
2068 # After the app/ctxt split, this should become an attribute based on something passed
2069 # into the application.
2070 $class->context_class( ref $class || $class ) unless $class->context_class;
2072 my $uploadtmp = $class->config->{uploadtmp};
2073 my $c = $class->context_class->new({ $uploadtmp ? (_uploadtmp => $uploadtmp) : ()});
2075 $c->response->_context($c);
2077 #surely this is not the most efficient way to do things...
2078 $c->stats($class->stats_class->new)->enable($c->use_stats);
2079 if ( $c->debug || $c->config->{enable_catalyst_header} ) {
2080 $c->res->headers->header( 'X-Catalyst' => $Catalyst::VERSION );
2084 # Allow engine to direct the prepare flow (for POE)
2085 if ( my $prepare = $c->engine->can('prepare') ) {
2086 $c->engine->$prepare( $c, @arguments );
2089 $c->prepare_request(@arguments);
2090 $c->prepare_connection;
2091 $c->prepare_query_parameters;
2092 $c->prepare_headers; # Just hooks, no longer needed - they just
2093 $c->prepare_cookies; # cause the lazy attribute on req to build
2096 # Prepare the body for reading, either by prepare_body
2097 # or the user, if they are using $c->read
2100 # Parse the body unless the user wants it on-demand
2101 unless ( ref($c)->config->{parse_on_demand} ) {
2107 # VERY ugly and probably shouldn't rely on ->finalize actually working
2109 # failed prepare is always due to an invalid request, right?
2110 $c->response->status(400);
2111 $c->response->content_type('text/plain');
2112 $c->response->body('Bad Request');
2113 # Note we call finalize and then die here, which escapes
2114 # finalize being called in the enclosing block..
2115 # It in fact couldn't be called, as we don't return $c..
2116 # This is a mess - but I'm unsure you can fix this without
2117 # breaking compat for people doing crazy things (we should set
2118 # the 400 and just return the ctx here IMO, letting finalize get called
2129 =head2 $c->prepare_action
2131 Prepares action. See L<Catalyst::Dispatcher>.
2135 sub prepare_action { my $c = shift; $c->dispatcher->prepare_action( $c, @_ ) }
2137 =head2 $c->prepare_body
2139 Prepares message body.
2146 return if $c->request->_has_body;
2148 # Initialize on-demand data
2149 $c->engine->prepare_body( $c, @_ );
2150 $c->prepare_parameters;
2151 $c->prepare_uploads;
2154 =head2 $c->prepare_body_chunk( $chunk )
2156 Prepares a chunk of data before sending it to L<HTTP::Body>.
2158 See L<Catalyst::Engine>.
2162 sub prepare_body_chunk {
2164 $c->engine->prepare_body_chunk( $c, @_ );
2167 =head2 $c->prepare_body_parameters
2169 Prepares body parameters.
2173 sub prepare_body_parameters {
2175 $c->engine->prepare_body_parameters( $c, @_ );
2178 =head2 $c->prepare_connection
2180 Prepares connection.
2184 sub prepare_connection {
2186 # XXX - This is called on the engine (not the request) to maintain
2187 # Engine::PSGI back compat.
2188 $c->engine->prepare_connection($c);
2191 =head2 $c->prepare_cookies
2193 Prepares cookies by ensuring that the attribute on the request
2194 object has been built.
2198 sub prepare_cookies { my $c = shift; $c->request->cookies }
2200 =head2 $c->prepare_headers
2202 Prepares request headers by ensuring that the attribute on the request
2203 object has been built.
2207 sub prepare_headers { my $c = shift; $c->request->headers }
2209 =head2 $c->prepare_parameters
2211 Prepares parameters.
2215 sub prepare_parameters {
2217 $c->prepare_body_parameters;
2218 $c->engine->prepare_parameters( $c, @_ );
2221 =head2 $c->prepare_path
2223 Prepares path and base.
2227 sub prepare_path { my $c = shift; $c->engine->prepare_path( $c, @_ ) }
2229 =head2 $c->prepare_query_parameters
2231 Prepares query parameters.
2235 sub prepare_query_parameters {
2238 $c->engine->prepare_query_parameters( $c, @_ );
2241 =head2 $c->log_request
2243 Writes information about the request to the debug logs. This includes:
2247 =item * Request method, path, and remote IP address
2249 =item * Query keywords (see L<Catalyst::Request/query_keywords>)
2251 =item * Request parameters
2253 =item * File uploads
2262 return unless $c->debug;
2264 my($dump) = grep {$_->[0] eq 'Request' } $c->dump_these;
2265 my $request = $dump->[1];
2267 my ( $method, $path, $address ) = ( $request->method, $request->path, $request->address );
2269 $path = '/' unless length $path;
2271 $c->log->debug(qq/"$method" request for "$path" from "$address"/);
2273 $c->log_request_headers($request->headers);
2275 if ( my $keywords = $request->query_keywords ) {
2276 $c->log->debug("Query keywords are: $keywords");
2279 $c->log_request_parameters( query => $request->query_parameters, $request->_has_body ? (body => $request->body_parameters) : () );
2281 $c->log_request_uploads($request);
2284 =head2 $c->log_response
2286 Writes information about the response to the debug logs by calling
2287 C<< $c->log_response_status_line >> and C<< $c->log_response_headers >>.
2294 return unless $c->debug;
2296 my($dump) = grep {$_->[0] eq 'Response' } $c->dump_these;
2297 my $response = $dump->[1];
2299 $c->log_response_status_line($response);
2300 $c->log_response_headers($response->headers);
2303 =head2 $c->log_response_status_line($response)
2305 Writes one line of information about the response to the debug logs. This includes:
2309 =item * Response status code
2311 =item * Content-Type header (if present)
2313 =item * Content-Length header (if present)
2319 sub log_response_status_line {
2320 my ($c, $response) = @_;
2324 'Response Code: %s; Content-Type: %s; Content-Length: %s',
2325 $response->status || 'unknown',
2326 $response->headers->header('Content-Type') || 'unknown',
2327 $response->headers->header('Content-Length') || 'unknown'
2332 =head2 $c->log_response_headers($headers);
2334 Hook method which can be wrapped by plugins to log the response headers.
2335 No-op in the default implementation.
2339 sub log_response_headers {}
2341 =head2 $c->log_request_parameters( query => {}, body => {} )
2343 Logs request parameters to debug logs
2347 sub log_request_parameters {
2349 my %all_params = @_;
2351 return unless $c->debug;
2353 my $column_width = Catalyst::Utils::term_width() - 44;
2354 foreach my $type (qw(query body)) {
2355 my $params = $all_params{$type};
2356 next if ! keys %$params;
2357 my $t = Text::SimpleTable->new( [ 35, 'Parameter' ], [ $column_width, 'Value' ] );
2358 for my $key ( sort keys %$params ) {
2359 my $param = $params->{$key};
2360 my $value = defined($param) ? $param : '';
2361 $t->row( $key, ref $value eq 'ARRAY' ? ( join ', ', @$value ) : $value );
2363 $c->log->debug( ucfirst($type) . " Parameters are:\n" . $t->draw );
2367 =head2 $c->log_request_uploads
2369 Logs file uploads included in the request to the debug logs.
2370 The parameter name, filename, file type, and file size are all included in
2375 sub log_request_uploads {
2377 my $request = shift;
2378 return unless $c->debug;
2379 my $uploads = $request->uploads;
2380 if ( keys %$uploads ) {
2381 my $t = Text::SimpleTable->new(
2382 [ 12, 'Parameter' ],
2387 for my $key ( sort keys %$uploads ) {
2388 my $upload = $uploads->{$key};
2389 for my $u ( ref $upload eq 'ARRAY' ? @{$upload} : ($upload) ) {
2390 $t->row( $key, $u->filename, $u->type, $u->size );
2393 $c->log->debug( "File Uploads are:\n" . $t->draw );
2397 =head2 $c->log_request_headers($headers);
2399 Hook method which can be wrapped by plugins to log the request headers.
2400 No-op in the default implementation.
2404 sub log_request_headers {}
2406 =head2 $c->log_headers($type => $headers)
2408 Logs L<HTTP::Headers> (either request or response) to the debug logs.
2415 my $headers = shift; # an HTTP::Headers instance
2417 return unless $c->debug;
2419 my $column_width = Catalyst::Utils::term_width() - 28;
2420 my $t = Text::SimpleTable->new( [ 15, 'Header Name' ], [ $column_width, 'Value' ] );
2423 my ( $name, $value ) = @_;
2424 $t->row( $name, $value );
2427 $c->log->debug( ucfirst($type) . " Headers:\n" . $t->draw );
2431 =head2 $c->prepare_read
2433 Prepares the input for reading.
2437 sub prepare_read { my $c = shift; $c->engine->prepare_read( $c, @_ ) }
2439 =head2 $c->prepare_request
2441 Prepares the engine request.
2445 sub prepare_request { my $c = shift; $c->engine->prepare_request( $c, @_ ) }
2447 =head2 $c->prepare_uploads
2453 sub prepare_uploads {
2456 $c->engine->prepare_uploads( $c, @_ );
2459 =head2 $c->prepare_write
2461 Prepares the output for writing.
2465 sub prepare_write { my $c = shift; $c->engine->prepare_write( $c, @_ ) }
2467 =head2 $c->request_class
2469 Returns or sets the request class. Defaults to L<Catalyst::Request>.
2471 =head2 $c->response_class
2473 Returns or sets the response class. Defaults to L<Catalyst::Response>.
2475 =head2 $c->read( [$maxlength] )
2477 Reads a chunk of data from the request body. This method is designed to
2478 be used in a while loop, reading C<$maxlength> bytes on every call.
2479 C<$maxlength> defaults to the size of the request if not specified.
2481 You have to set C<< MyApp->config(parse_on_demand => 1) >> to use this
2484 Warning: If you use read(), Catalyst will not process the body,
2485 so you will not be able to access POST parameters or file uploads via
2486 $c->request. You must handle all body parsing yourself.
2490 sub read { my $c = shift; return $c->request->read( @_ ) }
2500 $app->_make_immutable_if_needed;
2501 $app->engine_loader->needs_psgi_engine_compat_hack ?
2502 $app->engine->run($app, @_) :
2503 $app->engine->run( $app, $app->_finalized_psgi_app, @_ );
2506 sub _make_immutable_if_needed {
2508 my $meta = find_meta($class);
2509 my $isa_ca = $class->isa('Class::Accessor::Fast') || $class->isa('Class::Accessor');
2512 && ! { $meta->immutable_options }->{replace_constructor}
2515 warn("You made your application class ($class) immutable, "
2516 . "but did not inline the\nconstructor. "
2517 . "This will break catalyst, as your app \@ISA "
2518 . "Class::Accessor(::Fast)?\nPlease pass "
2519 . "(replace_constructor => 1)\nwhen making your class immutable.\n");
2521 unless ($meta->is_immutable) {
2522 # XXX - FIXME warning here as you should make your app immutable yourself.
2523 $meta->make_immutable(
2524 replace_constructor => 1,
2529 =head2 $c->set_action( $action, $code, $namespace, $attrs )
2531 Sets an action in a given namespace.
2535 sub set_action { my $c = shift; $c->dispatcher->set_action( $c, @_ ) }
2537 =head2 $c->setup_actions($component)
2539 Sets up actions for a component.
2543 sub setup_actions { my $c = shift; $c->dispatcher->setup_actions( $c, @_ ) }
2545 =head2 $c->setup_components
2547 This method is called internally to set up the application's components.
2549 It finds modules by calling the L<locate_components> method, expands them to
2550 package names with the L<expand_component_module> method, and then installs
2551 each component into the application.
2553 The C<setup_components> config option is passed to both of the above methods.
2555 Installation of each component is performed by the L<setup_component> method,
2560 sub setup_components {
2563 my $config = $class->config->{ setup_components };
2565 my @comps = $class->locate_components($config);
2566 my %comps = map { $_ => 1 } @comps;
2568 my $deprecatedcatalyst_component_names = grep { /::[CMV]::/ } @comps;
2569 $class->log->warn(qq{Your application is using the deprecated ::[MVC]:: type naming scheme.\n}.
2570 qq{Please switch your class names to ::Model::, ::View:: and ::Controller: as appropriate.\n}
2571 ) if $deprecatedcatalyst_component_names;
2573 for my $component ( @comps ) {
2575 # We pass ignore_loaded here so that overlay files for (e.g.)
2576 # Model::DBI::Schema sub-classes are loaded - if it's in @comps
2577 # we know M::P::O found a file on disk so this is safe
2579 Catalyst::Utils::ensure_class_loaded( $component, { ignore_loaded => 1 } );
2582 for my $component (@comps) {
2583 my $instance = $class->components->{ $component } = $class->setup_component($component);
2584 my @expanded_components = $instance->can('expand_modules')
2585 ? $instance->expand_modules( $component, $config )
2586 : $class->expand_component_module( $component, $config );
2587 for my $component (@expanded_components) {
2588 next if $comps{$component};
2589 $class->components->{ $component } = $class->setup_component($component);
2594 =head2 $c->locate_components( $setup_component_config )
2596 This method is meant to provide a list of component modules that should be
2597 setup for the application. By default, it will use L<Module::Pluggable>.
2599 Specify a C<setup_components> config option to pass additional options directly
2600 to L<Module::Pluggable>. To add additional search paths, specify a key named
2601 C<search_extra> as an array reference. Items in the array beginning with C<::>
2602 will have the application class name prepended to them.
2606 sub locate_components {
2610 my @paths = qw( ::Controller ::C ::Model ::M ::View ::V );
2611 my $extra = delete $config->{ search_extra } || [];
2613 push @paths, @$extra;
2615 my $locator = Module::Pluggable::Object->new(
2616 search_path => [ map { s/^(?=::)/$class/; $_; } @paths ],
2620 # XXX think about ditching this sort entirely
2621 my @comps = sort { length $a <=> length $b } $locator->plugins;
2626 =head2 $c->expand_component_module( $component, $setup_component_config )
2628 Components found by C<locate_components> will be passed to this method, which
2629 is expected to return a list of component (package) names to be set up.
2633 sub expand_component_module {
2634 my ($class, $module) = @_;
2635 return Devel::InnerPackage::list_packages( $module );
2638 =head2 $c->setup_component
2642 sub setup_component {
2643 my( $class, $component ) = @_;
2645 unless ( $component->can( 'COMPONENT' ) ) {
2649 my $suffix = Catalyst::Utils::class2classsuffix( $component );
2650 my $config = $class->config->{ $suffix } || {};
2651 # Stash catalyst_component_name in the config here, so that custom COMPONENT
2652 # methods also pass it. local to avoid pointlessly shitting in config
2653 # for the debug screen, as $component is already the key name.
2654 local $config->{catalyst_component_name} = $component;
2656 my $instance = eval { $component->COMPONENT( $class, $config ); };
2658 if ( my $error = $@ ) {
2660 Catalyst::Exception->throw(
2661 message => qq/Couldn't instantiate component "$component", "$error"/
2665 unless (blessed $instance) {
2666 my $metaclass = Moose::Util::find_meta($component);
2667 my $method_meta = $metaclass->find_method_by_name('COMPONENT');
2668 my $component_method_from = $method_meta->associated_metaclass->name;
2669 my $value = defined($instance) ? $instance : 'undef';
2670 Catalyst::Exception->throw(
2672 qq/Couldn't instantiate component "$component", COMPONENT() method (from $component_method_from) didn't return an object-like value (value was $value)./
2678 =head2 $c->setup_dispatcher
2684 sub setup_dispatcher {
2685 my ( $class, $dispatcher ) = @_;
2688 $dispatcher = 'Catalyst::Dispatcher::' . $dispatcher;
2691 if ( my $env = Catalyst::Utils::env_value( $class, 'DISPATCHER' ) ) {
2692 $dispatcher = 'Catalyst::Dispatcher::' . $env;
2695 unless ($dispatcher) {
2696 $dispatcher = $class->dispatcher_class;
2699 load_class($dispatcher);
2701 # dispatcher instance
2702 $class->dispatcher( $dispatcher->new );
2705 =head2 $c->setup_engine
2712 my ($class, $requested_engine) = @_;
2714 if (!$class->engine_loader || $requested_engine) {
2715 $class->engine_loader(
2716 Catalyst::EngineLoader->new({
2717 application_name => $class,
2718 (defined $requested_engine
2719 ? (catalyst_engine_class => $requested_engine) : ()),
2724 $class->engine_loader->catalyst_engine_class;
2728 my ($class, $requested_engine) = @_;
2731 my $loader = $class->engine_loader;
2733 if (!$loader || $requested_engine) {
2734 $loader = Catalyst::EngineLoader->new({
2735 application_name => $class,
2736 (defined $requested_engine
2737 ? (requested_engine => $requested_engine) : ()),
2740 $class->engine_loader($loader);
2743 $loader->catalyst_engine_class;
2746 # Don't really setup_engine -- see _setup_psgi_app for explanation.
2747 return if $class->loading_psgi_file;
2749 load_class($engine);
2751 if ($ENV{MOD_PERL}) {
2752 my $apache = $class->engine_loader->auto;
2754 my $meta = find_meta($class);
2755 my $was_immutable = $meta->is_immutable;
2756 my %immutable_options = $meta->immutable_options;
2757 $meta->make_mutable if $was_immutable;
2759 $meta->add_method(handler => sub {
2761 my $psgi_app = $class->_finalized_psgi_app;
2762 $apache->call_app($r, $psgi_app);
2765 $meta->make_immutable(%immutable_options) if $was_immutable;
2768 $class->engine( $engine->new );
2773 ## This exists just to supply a prebuild psgi app for mod_perl and for the
2774 ## build in server support (back compat support for pre psgi port behavior).
2775 ## This is so that we don't build a new psgi app for each request when using
2776 ## the mod_perl handler or the built in servers (http and fcgi, etc).
2778 sub _finalized_psgi_app {
2781 unless ($app->_psgi_app) {
2782 my $psgi_app = $app->_setup_psgi_app;
2783 $app->_psgi_app($psgi_app);
2786 return $app->_psgi_app;
2789 ## Look for a psgi file like 'myapp_web.psgi' (if the app is MyApp::Web) in the
2790 ## home directory and load that and return it (just assume it is doing the
2791 ## right thing :) ). If that does not exist, call $app->psgi_app, wrap that
2792 ## in default_middleware and return it ( this is for backward compatibility
2793 ## with pre psgi port behavior ).
2795 sub _setup_psgi_app {
2798 for my $home (Path::Class::Dir->new($app->config->{home})) {
2799 my $psgi_file = $home->file(
2800 Catalyst::Utils::appprefix($app) . '.psgi',
2803 next unless -e $psgi_file;
2805 # If $psgi_file calls ->setup_engine, it's doing so to load
2806 # Catalyst::Engine::PSGI. But if it does that, we're only going to
2807 # throw away the loaded PSGI-app and load the 5.9 Catalyst::Engine
2808 # anyway. So set a flag (ick) that tells setup_engine not to populate
2809 # $c->engine or do any other things we might regret.
2811 $app->loading_psgi_file(1);
2812 my $psgi_app = Plack::Util::load_psgi($psgi_file);
2813 $app->loading_psgi_file(0);
2816 unless $app->engine_loader->needs_psgi_engine_compat_hack;
2819 Found a legacy Catalyst::Engine::PSGI .psgi file at ${psgi_file}.
2821 Its content has been ignored. Please consult the Catalyst::Upgrading
2822 documentation on how to upgrade from Catalyst::Engine::PSGI.
2826 return $app->apply_default_middlewares($app->psgi_app);
2829 =head2 $c->apply_default_middlewares
2831 Adds the following L<Plack> middlewares to your application, since they are
2832 useful and commonly needed:
2834 L<Plack::Middleware::ReverseProxy>, (conditionally added based on the status
2835 of your $ENV{REMOTE_ADDR}, and can be forced on with C<using_frontend_proxy>
2836 or forced off with C<ignore_frontend_proxy>), L<Plack::Middleware::LighttpdScriptNameFix>
2837 (if you are using Lighttpd), L<Plack::Middleware::IIS6ScriptNameFix> (always
2838 applied since this middleware is smart enough to conditionally apply itself).
2840 Additionally if we detect we are using Nginx, we add a bit of custom middleware
2841 to solve some problems with the way that server handles $ENV{PATH_INFO} and
2847 sub apply_default_middlewares {
2848 my ($app, $psgi_app) = @_;
2850 $psgi_app = Plack::Middleware::Conditional->wrap(
2852 builder => sub { Plack::Middleware::ReverseProxy->wrap($_[0]) },
2855 return if $app->config->{ignore_frontend_proxy};
2856 return $env->{REMOTE_ADDR} eq '127.0.0.1'
2857 || $app->config->{using_frontend_proxy};
2861 # If we're running under Lighttpd, swap PATH_INFO and SCRIPT_NAME
2862 # http://lists.scsys.co.uk/pipermail/catalyst/2006-June/008361.html
2863 $psgi_app = Plack::Middleware::Conditional->wrap(
2865 builder => sub { Plack::Middleware::LighttpdScriptNameFix->wrap($_[0]) },
2868 return unless $env->{SERVER_SOFTWARE} && $env->{SERVER_SOFTWARE} =~ m!lighttpd[-/]1\.(\d+\.\d+)!;
2869 return unless $1 < 4.23;
2874 # we're applying this unconditionally as the middleware itself already makes
2875 # sure it doesn't fuck things up if it's not running under one of the right
2877 $psgi_app = Plack::Middleware::IIS6ScriptNameFix->wrap($psgi_app);
2879 # And another IIS issue, this time with IIS7.
2880 $psgi_app = Plack::Middleware::Conditional->wrap(
2882 builder => sub { Plack::Middleware::IIS7KeepAliveFix->wrap($_[0]) },
2885 return $env->{SERVER_SOFTWARE} && $env->{SERVER_SOFTWARE} =~ m!IIS/7\.[0-9]!;
2894 Returns a PSGI application code reference for the catalyst application
2895 C<$c>. This is the bare application without any middlewares
2896 applied. C<${myapp}.psgi> is not taken into account.
2898 This is what you want to be using to retrieve the PSGI application code
2899 reference of your Catalyst application for use in F<.psgi> files.
2905 my $psgi = $app->engine->build_psgi_app($app);
2906 return $app->Catalyst::Utils::apply_registered_middleware($psgi);
2909 =head2 $c->setup_home
2911 Sets up the home directory.
2916 my ( $class, $home ) = @_;
2918 if ( my $env = Catalyst::Utils::env_value( $class, 'HOME' ) ) {
2922 $home ||= Catalyst::Utils::home($class);
2925 #I remember recently being scolded for assigning config values like this
2926 $class->config->{home} ||= $home;
2927 $class->config->{root} ||= Path::Class::Dir->new($home)->subdir('root');
2931 =head2 $c->setup_log
2933 Sets up log by instantiating a L<Catalyst::Log|Catalyst::Log> object and
2934 passing it to C<log()>. Pass in a comma-delimited list of levels to set the
2937 This method also installs a C<debug> method that returns a true value into the
2938 catalyst subclass if the "debug" level is passed in the comma-delimited list,
2939 or if the C<$CATALYST_DEBUG> environment variable is set to a true value.
2941 Note that if the log has already been setup, by either a previous call to
2942 C<setup_log> or by a call such as C<< __PACKAGE__->log( MyLogger->new ) >>,
2943 that this method won't actually set up the log object.
2948 my ( $class, $levels ) = @_;
2951 $levels =~ s/^\s+//;
2952 $levels =~ s/\s+$//;
2953 my %levels = map { $_ => 1 } split /\s*,\s*/, $levels;
2955 my $env_debug = Catalyst::Utils::env_value( $class, 'DEBUG' );
2956 if ( defined $env_debug ) {
2957 $levels{debug} = 1 if $env_debug; # Ugly!
2958 delete($levels{debug}) unless $env_debug;
2961 unless ( $class->log ) {
2962 $class->log( Catalyst::Log->new(keys %levels) );
2965 if ( $levels{debug} ) {
2966 Class::MOP::get_metaclass_by_name($class)->add_method('debug' => sub { 1 });
2967 $class->log->debug('Debug messages enabled');
2971 =head2 $c->setup_plugins
2977 =head2 $c->setup_stats
2979 Sets up timing statistics class.
2984 my ( $class, $stats ) = @_;
2986 Catalyst::Utils::ensure_class_loaded($class->stats_class);
2988 my $env = Catalyst::Utils::env_value( $class, 'STATS' );
2989 if ( defined($env) ? $env : ($stats || $class->debug ) ) {
2990 Class::MOP::get_metaclass_by_name($class)->add_method('use_stats' => sub { 1 });
2991 $class->log->debug('Statistics enabled');
2996 =head2 $c->registered_plugins
2998 Returns a sorted list of the plugins which have either been stated in the
3001 If passed a given plugin name, it will report a boolean value indicating
3002 whether or not that plugin is loaded. A fully qualified name is required if
3003 the plugin name does not begin with C<Catalyst::Plugin::>.
3005 if ($c->registered_plugins('Some::Plugin')) {
3013 sub registered_plugins {
3015 return sort keys %{ $proto->_plugins } unless @_;
3017 return 1 if exists $proto->_plugins->{$plugin};
3018 return exists $proto->_plugins->{"Catalyst::Plugin::$plugin"};
3021 sub _register_plugin {
3022 my ( $proto, $plugin, $instant ) = @_;
3023 my $class = ref $proto || $proto;
3025 load_class( $plugin );
3026 $class->log->warn( "$plugin inherits from 'Catalyst::Component' - this is deprecated and will not work in 5.81" )
3027 if $plugin->isa( 'Catalyst::Component' );
3028 my $plugin_meta = Moose::Meta::Class->create($plugin);
3029 if (!$plugin_meta->has_method('new')
3030 && ( $plugin->isa('Class::Accessor::Fast') || $plugin->isa('Class::Accessor') ) ) {
3031 $plugin_meta->add_method('new', Moose::Object->meta->get_method('new'))
3033 if (!$instant && !$proto->_plugins->{$plugin}) {
3034 my $meta = Class::MOP::get_metaclass_by_name($class);
3035 $meta->superclasses($plugin, $meta->superclasses);
3037 $proto->_plugins->{$plugin} = 1;
3041 sub _default_plugins { return qw(Unicode::Encoding) }
3044 my ( $class, $plugins ) = @_;
3046 $class->_plugins( {} ) unless $class->_plugins;
3048 m/Unicode::Encoding/ ? do {
3050 'Unicode::Encoding plugin is auto-applied,'
3051 . ' please remove this from your appclass'
3052 . ' and make sure to define "encoding" config'
3054 unless (exists $class->config->{'encoding'}) {
3055 $class->config->{'encoding'} = 'UTF-8';
3060 push @$plugins, $class->_default_plugins;
3061 $plugins = Data::OptList::mkopt($plugins || []);
3064 [ Catalyst::Utils::resolve_namespace(
3065 $class . '::Plugin',
3066 'Catalyst::Plugin', $_->[0]
3072 for my $plugin ( reverse @plugins ) {
3073 load_class($plugin->[0], $plugin->[1]);
3074 my $meta = find_meta($plugin->[0]);
3075 next if $meta && $meta->isa('Moose::Meta::Role');
3077 $class->_register_plugin($plugin->[0]);
3081 map { $_->[0]->name, $_->[1] }
3082 grep { blessed($_->[0]) && $_->[0]->isa('Moose::Meta::Role') }
3083 map { [find_meta($_->[0]), $_->[1]] }
3086 Moose::Util::apply_all_roles(
3092 =head2 registered_middlewares
3094 Read only accessor that returns an array of all the middleware in the order
3095 that they were added (which is the REVERSE of the order they will be applied).
3097 The values returned will be either instances of L<Plack::Middleware> or of a
3098 compatible interface, or a coderef, which is assumed to be inlined middleware
3100 =head2 setup_middleware (?@middleware)
3102 Read configuration information stored in configuration key C<psgi_middleware> or
3105 See under L</CONFIGURATION> information regarding C<psgi_middleware> and how
3106 to use it to enable L<Plack::Middleware>
3108 This method is automatically called during 'setup' of your application, so
3109 you really don't need to invoke it. However you may do so if you find the idea
3110 of loading middleware via configuration weird :). For example:
3116 __PACKAGE__->setup_middleware('Head');
3119 When we read middleware definitions from configuration, we reverse the list
3120 which sounds odd but is likely how you expect it to work if you have prior
3121 experience with L<Plack::Builder> or if you previously used the plugin
3122 L<Catalyst::Plugin::EnableMiddleware> (which is now considered deprecated)
3126 sub registered_middlewares {
3128 if(my $middleware = $class->_psgi_middleware) {
3130 Plack::Middleware::HTTPExceptions->new,
3131 Plack::Middleware::ContentLength->new,
3132 Plack::Middleware::Head->new,
3135 die "You cannot call ->registered_middlewares until middleware has been setup";
3139 sub setup_middleware {
3141 my @middleware_definitions = @_ ?
3142 @_ : reverse(@{$class->config->{'psgi_middleware'}||[]});
3144 my @middleware = ();
3145 while(my $next = shift(@middleware_definitions)) {
3147 if(Scalar::Util::blessed $next && $next->can('wrap')) {
3148 push @middleware, $next;
3149 } elsif(ref $next eq 'CODE') {
3150 push @middleware, $next;
3151 } elsif(ref $next eq 'HASH') {
3152 my $namespace = shift @middleware_definitions;
3153 my $mw = $class->Catalyst::Utils::build_middleware($namespace, %$next);
3154 push @middleware, $mw;
3156 die "I can't handle middleware definition ${\ref $next}";
3159 my $mw = $class->Catalyst::Utils::build_middleware($next);
3160 push @middleware, $mw;
3164 my @existing = @{$class->_psgi_middleware || []};
3165 $class->_psgi_middleware([@middleware,@existing,]);
3168 =head2 registered_data_handlers
3170 A read only copy of registered Data Handlers returned as a Hash, where each key
3171 is a content type and each value is a subref that attempts to decode that content
3174 =head2 setup_data_handlers (?@data_handler)
3176 Read configuration information stored in configuration key C<data_handlers> or
3179 See under L</CONFIGURATION> information regarding C<data_handlers>.
3181 This method is automatically called during 'setup' of your application, so
3182 you really don't need to invoke it.
3184 =head2 default_data_handlers
3186 Default Data Handlers that come bundled with L<Catalyst>. Currently there are
3187 only two default data handlers, for 'application/json' and an alternative to
3188 'application/x-www-form-urlencoded' which supposed nested form parameters via
3189 L<CGI::Struct> or via L<CGI::Struct::XS> IF you've installed it.
3191 The 'application/json' data handler is used to parse incoming JSON into a Perl
3192 data structure. It used either L<JSON::MaybeXS> or L<JSON>, depending on which
3193 is installed. This allows you to fail back to L<JSON:PP>, which is a Pure Perl
3194 JSON decoder, and has the smallest dependency impact.
3196 Because we don't wish to add more dependencies to L<Catalyst>, if you wish to
3197 use this new feature we recommend installing L<JSON> or L<JSON::MaybeXS> in
3198 order to get the best performance. You should add either to your dependency
3199 list (Makefile.PL, dist.ini, cpanfile, etc.)
3203 sub registered_data_handlers {
3205 if(my $data_handlers = $class->_data_handlers) {
3206 return %$data_handlers;
3208 die "You cannot call ->registered_data_handlers until data_handers has been setup";
3212 sub setup_data_handlers {
3213 my ($class, %data_handler_callbacks) = @_;
3214 %data_handler_callbacks = (
3215 %{$class->default_data_handlers},
3216 %{$class->config->{'data_handlers'}||+{}},
3217 %data_handler_callbacks);
3219 $class->_data_handlers(\%data_handler_callbacks);
3222 sub default_data_handlers {
3225 'application/x-www-form-urlencoded' => sub {
3226 my ($fh, $req) = @_;
3227 my $params = $req->_use_hash_multivalue ? $req->body_parameters->mixed : $req->body_parameters;
3228 Class::Load::load_first_existing_class('CGI::Struct::XS', 'CGI::Struct')
3229 ->can('build_cgi_struct')->($params);
3231 'application/json' => sub {
3232 Class::Load::load_first_existing_class('JSON::MaybeXS', 'JSON')
3233 ->can('decode_json')->(do { local $/; $_->getline });
3240 Returns an arrayref of the internal execution stack (actions that are
3241 currently executing).
3245 Returns the current timing statistics object. By default Catalyst uses
3246 L<Catalyst::Stats|Catalyst::Stats>, but can be set otherwise with
3247 L<< stats_class|/"$c->stats_class" >>.
3249 Even if L<< -Stats|/"-Stats" >> is not enabled, the stats object is still
3250 available. By enabling it with C< $c->stats->enabled(1) >, it can be used to
3251 profile explicitly, although MyApp.pm still won't profile nor output anything
3254 =head2 $c->stats_class
3256 Returns or sets the stats (timing statistics) class. L<Catalyst::Stats|Catalyst::Stats> is used by default.
3258 =head2 $c->use_stats
3260 Returns 1 when L<< stats collection|/"-Stats" >> is enabled.
3262 Note that this is a static method, not an accessor and should be overridden
3263 by declaring C<sub use_stats { 1 }> in your MyApp.pm, not by calling C<< $c->use_stats(1) >>.
3270 =head2 $c->write( $data )
3272 Writes $data to the output stream. When using this method directly, you
3273 will need to manually set the C<Content-Length> header to the length of
3274 your output data, if known.
3281 # Finalize headers if someone manually writes output (for compat)
3282 $c->finalize_headers;
3284 return $c->response->write( @_ );
3289 Returns the Catalyst version number. Mostly useful for "powered by"
3290 messages in template systems.
3294 sub version { return $Catalyst::VERSION }
3296 =head1 CONFIGURATION
3298 There are a number of 'base' config variables which can be set:
3304 C<default_model> - The default model picked if you say C<< $c->model >>. See L<< /$c->model($name) >>.
3308 C<default_view> - The default view to be rendered or returned when C<< $c->view >> is called. See L<< /$c->view($name) >>.
3312 C<disable_component_resolution_regex_fallback> - Turns
3313 off the deprecated component resolution functionality so
3314 that if any of the component methods (e.g. C<< $c->controller('Foo') >>)
3315 are called then regex search will not be attempted on string values and
3316 instead C<undef> will be returned.
3320 C<home> - The application home directory. In an uninstalled application,
3321 this is the top level application directory. In an installed application,
3322 this will be the directory containing C<< MyApp.pm >>.
3326 C<ignore_frontend_proxy> - See L</PROXY SUPPORT>
3330 C<name> - The name of the application in debug messages and the debug and
3335 C<parse_on_demand> - The request body (for example file uploads) will not be parsed
3336 until it is accessed. This allows you to (for example) check authentication (and reject
3337 the upload) before actually receiving all the data. See L</ON-DEMAND PARSER>
3341 C<root> - The root directory for templates. Usually this is just a
3342 subdirectory of the home directory, but you can set it to change the
3343 templates to a different directory.
3347 C<search_extra> - Array reference passed to Module::Pluggable to for additional
3348 namespaces from which components will be loaded (and constructed and stored in
3349 C<< $c->components >>).
3353 C<show_internal_actions> - If true, causes internal actions such as C<< _DISPATCH >>
3354 to be shown in hit debug tables in the test server.
3358 C<use_request_uri_for_path> - Controls if the C<REQUEST_URI> or C<PATH_INFO> environment
3359 variable should be used for determining the request path.
3361 Most web server environments pass the requested path to the application using environment variables,
3362 from which Catalyst has to reconstruct the request base (i.e. the top level path to / in the application,
3363 exposed as C<< $c->request->base >>) and the request path below that base.
3365 There are two methods of doing this, both of which have advantages and disadvantages. Which method is used
3366 is determined by the C<< $c->config(use_request_uri_for_path) >> setting (which can either be true or false).
3370 =item use_request_uri_for_path => 0
3372 This is the default (and the) traditional method that Catalyst has used for determining the path information.
3373 The path is generated from a combination of the C<PATH_INFO> and C<SCRIPT_NAME> environment variables.
3374 The allows the application to behave correctly when C<mod_rewrite> is being used to redirect requests
3375 into the application, as these variables are adjusted by mod_rewrite to take account for the redirect.
3377 However this method has the major disadvantage that it is impossible to correctly decode some elements
3378 of the path, as RFC 3875 says: "C<< Unlike a URI path, the PATH_INFO is not URL-encoded, and cannot
3379 contain path-segment parameters. >>" This means PATH_INFO is B<always> decoded, and therefore Catalyst
3380 can't distinguish / vs %2F in paths (in addition to other encoded values).
3382 =item use_request_uri_for_path => 1
3384 This method uses the C<REQUEST_URI> and C<SCRIPT_NAME> environment variables. As C<REQUEST_URI> is never
3385 decoded, this means that applications using this mode can correctly handle URIs including the %2F character
3386 (i.e. with C<AllowEncodedSlashes> set to C<On> in Apache).
3388 Given that this method of path resolution is provably more correct, it is recommended that you use
3389 this unless you have a specific need to deploy your application in a non-standard environment, and you are
3390 aware of the implications of not being able to handle encoded URI paths correctly.
3392 However it also means that in a number of cases when the app isn't installed directly at a path, but instead
3393 is having paths rewritten into it (e.g. as a .cgi/fcgi in a public_html directory, with mod_rewrite in a
3394 .htaccess file, or when SSI is used to rewrite pages into the app, or when sub-paths of the app are exposed
3395 at other URIs than that which the app is 'normally' based at with C<mod_rewrite>), the resolution of
3396 C<< $c->request->base >> will be incorrect.
3402 C<using_frontend_proxy> - See L</PROXY SUPPORT>.
3406 C<encoding> - See L</ENCODING>
3410 C<abort_chain_on_error_fix>
3412 When there is an error in an action chain, the default behavior is to continue
3413 processing the remaining actions and then catch the error upon chain end. This
3414 can lead to running actions when the application is in an unexpected state. If
3415 you have this issue, setting this config value to true will promptly exit a
3416 chain when there is an error raised in any action (thus terminating the chain
3421 __PACKAGE__->config(abort_chain_on_error_fix => 1);
3423 In the future this might become the default behavior.
3427 C<use_hash_multivalue_in_request>
3429 In L<Catalyst::Request> the methods C<query_parameters>, C<body_parametes>
3430 and C<parameters> return a hashref where values might be scalar or an arrayref
3431 depending on the incoming data. In many cases this can be undesirable as it
3432 leads one to writing defensive code like the following:
3434 my ($val) = ref($c->req->parameters->{a}) ?
3435 @{$c->req->parameters->{a}} :
3436 $c->req->parameters->{a};
3438 Setting this configuration item to true will make L<Catalyst> populate the
3439 attributes underlying these methods with an instance of L<Hash::MultiValue>
3440 which is used by L<Plack::Request> and others to solve this very issue. You
3441 may prefer this behavior to the default, if so enable this option (be warned
3442 if you enable it in a legacy application we are not sure if it is completely
3443 backwardly compatible).
3447 C<psgi_middleware> - See L<PSGI MIDDLEWARE>.
3451 C<data_handlers> - See L<DATA HANDLERS>.
3455 =head1 INTERNAL ACTIONS
3457 Catalyst uses internal actions like C<_DISPATCH>, C<_BEGIN>, C<_AUTO>,
3458 C<_ACTION>, and C<_END>. These are by default not shown in the private
3459 action table, but you can make them visible with a config parameter.
3461 MyApp->config(show_internal_actions => 1);
3463 =head1 ON-DEMAND PARSER
3465 The request body is usually parsed at the beginning of a request,
3466 but if you want to handle input yourself, you can enable on-demand
3467 parsing with a config parameter.
3469 MyApp->config(parse_on_demand => 1);
3471 =head1 PROXY SUPPORT
3473 Many production servers operate using the common double-server approach,
3474 with a lightweight frontend web server passing requests to a larger
3475 backend server. An application running on the backend server must deal
3476 with two problems: the remote user always appears to be C<127.0.0.1> and
3477 the server's hostname will appear to be C<localhost> regardless of the
3478 virtual host that the user connected through.
3480 Catalyst will automatically detect this situation when you are running
3481 the frontend and backend servers on the same machine. The following
3482 changes are made to the request.
3484 $c->req->address is set to the user's real IP address, as read from
3485 the HTTP X-Forwarded-For header.
3487 The host value for $c->req->base and $c->req->uri is set to the real
3488 host, as read from the HTTP X-Forwarded-Host header.
3490 Additionally, you may be running your backend application on an insecure
3491 connection (port 80) while your frontend proxy is running under SSL. If there
3492 is a discrepancy in the ports, use the HTTP header C<X-Forwarded-Port> to
3493 tell Catalyst what port the frontend listens on. This will allow all URIs to
3494 be created properly.
3496 In the case of passing in:
3498 X-Forwarded-Port: 443
3500 All calls to C<uri_for> will result in an https link, as is expected.
3502 Obviously, your web server must support these headers for this to work.
3504 In a more complex server farm environment where you may have your
3505 frontend proxy server(s) on different machines, you will need to set a
3506 configuration option to tell Catalyst to read the proxied data from the
3509 MyApp->config(using_frontend_proxy => 1);
3511 If you do not wish to use the proxy support at all, you may set:
3513 MyApp->config(ignore_frontend_proxy => 0);
3515 =head2 Note about psgi files
3517 Note that if you supply your own .psgi file, calling
3518 C<< MyApp->psgi_app(@_); >>, then B<this will not happen automatically>.
3520 You either need to apply L<Plack::Middleware::ReverseProxy> yourself
3521 in your psgi, for example:
3524 enable "Plack::Middleware::ReverseProxy";
3528 This will unconditionally add the ReverseProxy support, or you need to call
3529 C<< $app = MyApp->apply_default_middlewares($app) >> (to conditionally
3530 apply the support depending upon your config).
3532 See L<Catalyst::PSGI> for more information.
3534 =head1 THREAD SAFETY
3536 Catalyst has been tested under Apache 2's threading C<mpm_worker>,
3537 C<mpm_winnt>, and the standalone forking HTTP server on Windows. We
3538 believe the Catalyst core to be thread-safe.
3540 If you plan to operate in a threaded environment, remember that all other
3541 modules you are using must also be thread-safe. Some modules, most notably
3542 L<DBD::SQLite>, are not thread-safe.
3544 =head1 DATA HANDLERS
3546 The L<Catalyst::Request> object uses L<HTTP::Body> to populate 'classic' HTML
3547 form parameters and URL search query fields. However it has become common
3548 for various alternative content types to be PUT or POSTed to your controllers
3549 and actions. People working on RESTful APIs, or using AJAX often use JSON,
3550 XML and other content types when communicating with an application server. In
3551 order to better support this use case, L<Catalyst> defines a global configuration
3552 option, C<data_handlers>, which lets you associate a content type with a coderef
3553 that parses that content type into something Perl can readily access.
3560 __PACKAGE__->config(
3562 'application/json' => sub { local $/; decode_json $_->getline },
3564 ## Any other configuration.
3569 By default L<Catalyst> comes with a generic JSON data handler similar to the
3570 example given above, which uses L<JSON::Maybe> to provide either L<JSON::PP>
3571 (a pure Perl, dependency free JSON parser) or L<Cpanel::JSON::XS> if you have
3572 it installed (if you want the faster XS parser, add it to you project Makefile.PL
3573 or dist.ini, cpanfile, etc.)
3575 The C<data_handlers> configuation is a hashref whose keys are HTTP Content-Types
3576 (matched against the incoming request type using a regexp such as to be case
3577 insensitive) and whose values are coderefs that receive a localized version of
3578 C<$_> which is a filehandle object pointing to received body.
3580 This feature is considered an early access release and we reserve the right
3581 to alter the interface in order to provide a performant and secure solution to
3582 alternative request body content. Your reports welcomed!
3584 =head1 PSGI MIDDLEWARE
3586 You can define middleware, defined as L<Plack::Middleware> or a compatible
3587 interface in configuration. Your middleware definitions are in the form of an
3588 arrayref under the configuration key C<psgi_middleware>. Here's an example
3589 with details to follow:
3594 use Plack::Middleware::StackTrace;
3596 my $stacktrace_middleware = Plack::Middleware::StackTrace->new;
3598 __PACKAGE__->config(
3599 'psgi_middleware', [
3602 $stacktrace_middleware,
3603 'Session' => {store => 'File'},
3608 $env->{myapp.customkey} = 'helloworld';
3617 So the general form is:
3619 __PACKAGE__->config(psgi_middleware => \@middleware_definitions);
3621 Where C<@middleware> is one or more of the following, applied in the REVERSE of
3622 the order listed (to make it function similarly to L<Plack::Builder>:
3624 Alternatively, you may also define middleware by calling the L</setup_middleware>
3631 __PACKAGE__->setup_middleware( \@middleware_definitions);
3634 In the case where you do both (use 'setup_middleware' and configuration) the
3635 package call to setup_middleware will be applied earlier (in other words its
3636 middleware will wrap closer to the application). Keep this in mind since in
3637 some cases the order of middleware is important.
3639 The two approaches are not exclusive.
3643 =item Middleware Object
3645 An already initialized object that conforms to the L<Plack::Middleware>
3648 my $stacktrace_middleware = Plack::Middleware::StackTrace->new;
3650 __PACKAGE__->config(
3651 'psgi_middleware', [
3652 $stacktrace_middleware,
3658 A coderef that is an inlined middleware:
3660 __PACKAGE__->config(
3661 'psgi_middleware', [
3666 if($env->{PATH_INFO} =~m/forced/) {
3668 ->new(file=>TestApp->path_to(qw/share static forced.txt/))
3671 return $app->($env);
3681 We assume the scalar refers to a namespace after normalizing it using the
3684 (1) If the scalar is prefixed with a "+" (as in C<+MyApp::Foo>) then the full string
3685 is assumed to be 'as is', and we just install and use the middleware.
3687 (2) If the scalar begins with "Plack::Middleware" or your application namespace
3688 (the package name of your Catalyst application subclass), we also assume then
3689 that it is a full namespace, and use it.
3691 (3) Lastly, we then assume that the scalar is a partial namespace, and attempt to
3692 resolve it first by looking for it under your application namespace (for example
3693 if you application is "MyApp::Web" and the scalar is "MyMiddleware", we'd look
3694 under "MyApp::Web::Middleware::MyMiddleware") and if we don't find it there, we
3695 will then look under the regular L<Plack::Middleware> namespace (i.e. for the
3696 previous we'd try "Plack::Middleware::MyMiddleware"). We look under your application
3697 namespace first to let you 'override' common L<Plack::Middleware> locally, should
3698 you find that a good idea.
3704 __PACKAGE__->config(
3705 'psgi_middleware', [
3706 'Debug', ## MyAppWeb::Middleware::Debug->wrap or Plack::Middleware::Debug->wrap
3707 'Plack::Middleware::Stacktrace', ## Plack::Middleware::Stacktrace->wrap
3708 '+MyApp::Custom', ## MyApp::Custom->wrap
3712 =item a scalar followed by a hashref
3714 Just like the previous, except the following C<HashRef> is used as arguments
3715 to initialize the middleware object.
3717 __PACKAGE__->config(
3718 'psgi_middleware', [
3719 'Session' => {store => 'File'},
3724 Please see L<PSGI> for more on middleware.
3728 On request, decodes all params from encoding into a sequence of
3729 logical characters. On response, encodes body into encoding.
3737 Returns an instance of an C<Encode> encoding
3739 print $c->encoding->name
3741 =item handle_unicode_encoding_exception ($exception_context)
3743 Method called when decoding process for a request fails.
3745 An C<$exception_context> hashref is provided to allow you to override the
3746 behaviour of your application when given data with incorrect encodings.
3748 The default method throws exceptions in the case of invalid request parameters
3749 (resulting in a 500 error), but ignores errors in upload filenames.
3751 The keys passed in the C<$exception_context> hash are:
3757 The value which was not able to be decoded.
3761 The exception received from L<Encode>.
3765 What type of data was being decoded. Valid values are (currently)
3766 C<params> - for request parameters / arguments / captures
3767 and C<uploads> - for request upload filenames.
3777 Join #catalyst on irc.perl.org.
3781 http://lists.scsys.co.uk/cgi-bin/mailman/listinfo/catalyst
3782 http://lists.scsys.co.uk/cgi-bin/mailman/listinfo/catalyst-dev
3786 http://catalyst.perl.org
3790 http://dev.catalyst.perl.org
3794 =head2 L<Task::Catalyst> - All you need to start with Catalyst
3796 =head2 L<Catalyst::Manual> - The Catalyst Manual
3798 =head2 L<Catalyst::Component>, L<Catalyst::Controller> - Base classes for components
3800 =head2 L<Catalyst::Engine> - Core engine
3802 =head2 L<Catalyst::Log> - Log class.
3804 =head2 L<Catalyst::Request> - Request object
3806 =head2 L<Catalyst::Response> - Response object
3808 =head2 L<Catalyst::Test> - The test suite.
3810 =head1 PROJECT FOUNDER
3812 sri: Sebastian Riedel <sri@cpan.org>
3818 acme: Leon Brocard <leon@astray.com>
3820 abraxxa: Alexander Hartmaier <abraxxa@cpan.org>
3824 Andrew Ford E<lt>A.Ford@ford-mason.co.ukE<gt>
3828 andyg: Andy Grundman <andy@hybridized.org>
3830 audreyt: Audrey Tang
3832 bricas: Brian Cassidy <bricas@cpan.org>
3834 Caelum: Rafael Kitover <rkitover@io.com>
3836 chansen: Christian Hansen
3838 chicks: Christopher Hicks
3840 Chisel Wright C<pause@herlpacker.co.uk>
3842 Danijel Milicevic C<me@danijel.de>
3844 David Kamholz E<lt>dkamholz@cpan.orgE<gt>
3846 David Naughton, C<naughton@umn.edu>
3850 dhoss: Devin Austin <dhoss@cpan.org>
3852 dkubb: Dan Kubb <dan.kubb-cpan@onautopilot.com>
3856 dwc: Daniel Westermann-Clark <danieltwc@cpan.org>
3858 esskar: Sascha Kiefer
3860 fireartist: Carl Franks <cfranks@cpan.org>
3862 frew: Arthur Axel "fREW" Schmidt <frioux@gmail.com>
3864 gabb: Danijel Milicevic
3868 Gavin Henry C<ghenry@perl.me.uk>
3872 groditi: Guillermo Roditi <groditi@gmail.com>
3874 hobbs: Andrew Rodland <andrew@cleverdomain.org>
3876 ilmari: Dagfinn Ilmari Mannsåker <ilmari@ilmari.org>
3878 jcamacho: Juan Camacho
3880 jester: Jesse Sheidlower C<jester@panix.com>
3882 jhannah: Jay Hannah <jay@jays.net>
3888 jon: Jon Schutz <jjschutz@cpan.org>
3890 Jonathan Rockway C<< <jrockway@cpan.org> >>
3892 Kieren Diment C<kd@totaldatasolution.com>
3894 konobi: Scott McWhirter <konobi@cpan.org>
3896 marcus: Marcus Ramberg <mramberg@cpan.org>
3898 miyagawa: Tatsuhiko Miyagawa <miyagawa@bulknews.net>
3900 mgrimes: Mark Grimes <mgrimes@cpan.org>
3902 mst: Matt S. Trout <mst@shadowcatsystems.co.uk>
3906 naughton: David Naughton
3908 ningu: David Kamholz <dkamholz@cpan.org>
3910 nothingmuch: Yuval Kogman <nothingmuch@woobling.org>
3912 numa: Dan Sully <daniel@cpan.org>
3918 omega: Andreas Marienborg
3920 Oleg Kostyuk <cub.uanic@gmail.com>
3922 phaylon: Robert Sedlacek <phaylon@dunkelheit.at>
3924 rafl: Florian Ragwitz <rafl@debian.org>
3926 random: Roland Lammel <lammel@cpan.org>
3928 Robert Sedlacek C<< <rs@474.at> >>
3930 SpiceMan: Marcel Montes
3934 szbalint: Balint Szilakszi <szbalint@cpan.org>
3936 t0m: Tomas Doran <bobtfish@bobtfish.net>
3940 Viljo Marrandi C<vilts@yahoo.com>
3942 Will Hawes C<info@whawes.co.uk>
3944 willert: Sebastian Willert <willert@cpan.org>
3946 wreis: Wallace Reis <wreis@cpan.org>
3948 Yuval Kogman, C<nothingmuch@woobling.org>
3950 rainboxx: Matthias Dietrich, C<perl@rainboxx.de>
3952 dd070: Dhaval Dhanani <dhaval070@gmail.com>
3956 Copyright (c) 2005, the above named PROJECT FOUNDER and CONTRIBUTORS.
3960 This library is free software. You can redistribute it and/or modify it under
3961 the same terms as Perl itself.
3967 __PACKAGE__->meta->make_immutable;