4 use Moose::Meta::Class ();
5 extends 'Catalyst::Component';
6 use Moose::Util qw/find_meta/;
7 use namespace::clean -except => 'meta';
8 use Catalyst::Exception;
9 use Catalyst::Exception::Detach;
10 use Catalyst::Exception::Go;
12 use Catalyst::Request;
13 use Catalyst::Request::Upload;
14 use Catalyst::Response;
16 use Catalyst::Controller;
18 use Devel::InnerPackage ();
19 use Module::Pluggable::Object ();
20 use Text::SimpleTable ();
21 use Path::Class::Dir ();
22 use Path::Class::File ();
27 use Tree::Simple qw/use_weak_refs/;
28 use Tree::Simple::Visitor::FindByUID;
29 use Class::C3::Adopt::NEXT;
30 use List::MoreUtils qw/uniq/;
32 use String::RewritePrefix;
33 use Catalyst::EngineLoader;
35 use Carp qw/croak carp shortmess/;
38 use Moose::Util 'find_meta';
39 use Plack::Middleware::Conditional;
40 use Plack::Middleware::ReverseProxy;
41 use Plack::Middleware::IIS6ScriptNameFix;
42 use Plack::Middleware::IIS7KeepAliveFix;
43 use Plack::Middleware::LighttpdScriptNameFix;
44 use Plack::Middleware::ContentLength;
45 use Plack::Middleware::Head;
46 use Plack::Middleware::HTTPExceptions;
47 use Plack::Middleware::FixMissingBodyInRedirect;
48 use Plack::Middleware::MethodOverride;
49 use Plack::Middleware::RemoveRedundantBody;
51 use Class::Load 'load_class';
53 BEGIN { require 5.008003; }
55 has stack => (is => 'ro', default => sub { [] });
56 has stash => (is => 'rw', default => sub { {} });
57 has state => (is => 'rw', default => 0);
58 has stats => (is => 'rw');
59 has action => (is => 'rw');
60 has counter => (is => 'rw', default => sub { {} });
65 $self->request_class->new($self->_build_request_constructor_args);
69 sub _build_request_constructor_args {
71 my %p = ( _log => $self->log );
72 $p{_uploadtmp} = $self->_uploadtmp if $self->_has_uploadtmp;
73 $p{data_handlers} = {$self->registered_data_handlers};
74 $p{_use_hash_multivalue} = $self->config->{use_hash_multivalue_in_request}
75 if $self->config->{use_hash_multivalue_in_request};
83 $self->response_class->new($self->_build_response_constructor_args);
87 sub _build_response_constructor_args {
89 { _log => $self->log };
92 has namespace => (is => 'rw');
94 sub depth { scalar @{ shift->stack || [] }; }
95 sub comp { shift->component(@_) }
98 my $self = shift; return $self->request(@_);
101 my $self = shift; return $self->response(@_);
104 # For backwards compatibility
105 sub finalize_output { shift->finalize_body(@_) };
110 our $RECURSION = 1000;
111 our $DETACH = Catalyst::Exception::Detach->new;
112 our $GO = Catalyst::Exception::Go->new;
114 #I imagine that very few of these really need to be class variables. if any.
115 #maybe we should just make them attributes with a default?
116 __PACKAGE__->mk_classdata($_)
117 for qw/components arguments dispatcher engine log dispatcher_class
118 engine_loader context_class request_class response_class stats_class
119 setup_finished _psgi_app loading_psgi_file run_options _psgi_middleware
122 __PACKAGE__->dispatcher_class('Catalyst::Dispatcher');
123 __PACKAGE__->request_class('Catalyst::Request');
124 __PACKAGE__->response_class('Catalyst::Response');
125 __PACKAGE__->stats_class('Catalyst::Stats');
127 # Remember to update this in Catalyst::Runtime as well!
129 our $VERSION = '5.90069_001';
132 my ( $class, @arguments ) = @_;
134 # We have to limit $class to Catalyst to avoid pushing Catalyst upon every
136 return unless $class eq 'Catalyst';
138 my $caller = caller();
139 return if $caller eq 'main';
141 my $meta = Moose::Meta::Class->initialize($caller);
142 unless ( $caller->isa('Catalyst') ) {
143 my @superclasses = ($meta->superclasses, $class, 'Catalyst::Controller');
144 $meta->superclasses(@superclasses);
146 # Avoid possible C3 issues if 'Moose::Object' is already on RHS of MyApp
147 $meta->superclasses(grep { $_ ne 'Moose::Object' } $meta->superclasses);
149 unless( $meta->has_method('meta') ){
150 if ($Moose::VERSION >= 1.15) {
151 $meta->_add_meta_method('meta');
154 $meta->add_method(meta => sub { Moose::Meta::Class->initialize("${caller}") } );
158 $caller->arguments( [@arguments] );
162 sub _application { $_[0] }
168 Catalyst - The Elegant MVC Web Application Framework
172 See the L<Catalyst::Manual> distribution for comprehensive
173 documentation and tutorials.
175 # Install Catalyst::Devel for helpers and other development tools
176 # use the helper to create a new application
179 # add models, views, controllers
180 script/myapp_create.pl model MyDatabase DBIC::Schema create=static dbi:SQLite:/path/to/db
181 script/myapp_create.pl view MyTemplate TT
182 script/myapp_create.pl controller Search
184 # built in testserver -- use -r to restart automatically on changes
185 # --help to see all available options
186 script/myapp_server.pl
188 # command line testing interface
189 script/myapp_test.pl /yada
192 use Catalyst qw/-Debug/; # include plugins here as well
194 ### In lib/MyApp/Controller/Root.pm (autocreated)
195 sub foo : Chained('/') Args() { # called for /foo, /foo/1, /foo/1/2, etc.
196 my ( $self, $c, @args ) = @_; # args are qw/1 2/ for /foo/1/2
197 $c->stash->{template} = 'foo.tt'; # set the template
198 # lookup something from db -- stash vars are passed to TT
200 $c->model('Database::Foo')->search( { country => $args[0] } );
201 if ( $c->req->params->{bar} ) { # access GET or POST parameters
202 $c->forward( 'bar' ); # process another action
203 # do something else after forward returns
207 # The foo.tt TT template can use the stash data from the database
208 [% WHILE (item = data.next) %]
212 # called for /bar/of/soap, /bar/of/soap/10, etc.
213 sub bar : Chained('/') PathPart('/bar/of/soap') Args() { ... }
215 # called after all actions are finished
217 my ( $self, $c ) = @_;
218 if ( scalar @{ $c->error } ) { ... } # handle errors
219 return if $c->res->body; # already have a response
220 $c->forward( 'MyApp::View::TT' ); # render template
223 See L<Catalyst::Manual::Intro> for additional information.
227 Catalyst is a modern framework for making web applications without the
228 pain usually associated with this process. This document is a reference
229 to the main Catalyst application. If you are a new user, we suggest you
230 start with L<Catalyst::Manual::Tutorial> or L<Catalyst::Manual::Intro>.
232 See L<Catalyst::Manual> for more documentation.
234 Catalyst plugins can be loaded by naming them as arguments to the "use
235 Catalyst" statement. Omit the C<Catalyst::Plugin::> prefix from the
236 plugin name, i.e., C<Catalyst::Plugin::My::Module> becomes
239 use Catalyst qw/My::Module/;
241 If your plugin starts with a name other than C<Catalyst::Plugin::>, you can
242 fully qualify the name by using a unary plus:
246 +Fully::Qualified::Plugin::Name
249 Special flags like C<-Debug> can also be specified as
250 arguments when Catalyst is loaded:
252 use Catalyst qw/-Debug My::Module/;
254 The position of plugins and flags in the chain is important, because
255 they are loaded in the order in which they appear.
257 The following flags are supported:
261 Enables debug output. You can also force this setting from the system
262 environment with CATALYST_DEBUG or <MYAPP>_DEBUG. The environment
263 settings override the application, with <MYAPP>_DEBUG having the highest
266 This sets the log level to 'debug' and enables full debug output on the
267 error screen. If you only want the latter, see L<< $c->debug >>.
271 Forces Catalyst to use a specific home directory, e.g.:
273 use Catalyst qw[-Home=/usr/mst];
275 This can also be done in the shell environment by setting either the
276 C<CATALYST_HOME> environment variable or C<MYAPP_HOME>; where C<MYAPP>
277 is replaced with the uppercased name of your application, any "::" in
278 the name will be replaced with underscores, e.g. MyApp::Web should use
279 MYAPP_WEB_HOME. If both variables are set, the MYAPP_HOME one will be used.
281 If none of these are set, Catalyst will attempt to automatically detect the
282 home directory. If you are working in a development environment, Catalyst
283 will try and find the directory containing either Makefile.PL, Build.PL,
284 dist.ini, or cpanfile. If the application has been installed into the system
285 (i.e. you have done C<make install>), then Catalyst will use the path to your
286 application module, without the .pm extension (e.g., /foo/MyApp if your
287 application was installed at /foo/MyApp.pm)
291 use Catalyst '-Log=warn,fatal,error';
293 Specifies a comma-delimited list of log levels.
297 Enables statistics collection and reporting.
299 use Catalyst qw/-Stats=1/;
301 You can also force this setting from the system environment with CATALYST_STATS
302 or <MYAPP>_STATS. The environment settings override the application, with
303 <MYAPP>_STATS having the highest priority.
305 Stats are also enabled if L<< debugging |/"-Debug" >> is enabled.
309 =head2 INFORMATION ABOUT THE CURRENT REQUEST
313 Returns a L<Catalyst::Action> object for the current action, which
314 stringifies to the action name. See L<Catalyst::Action>.
318 Returns the namespace of the current action, i.e., the URI prefix
319 corresponding to the controller of the current action. For example:
321 # in Controller::Foo::Bar
322 $c->namespace; # returns 'foo/bar';
328 Returns the current L<Catalyst::Request> object, giving access to
329 information about the current client request (including parameters,
330 cookies, HTTP headers, etc.). See L<Catalyst::Request>.
332 =head2 REQUEST FLOW HANDLING
334 =head2 $c->forward( $action [, \@arguments ] )
336 =head2 $c->forward( $class, $method, [, \@arguments ] )
338 This is one way of calling another action (method) in the same or
339 a different controller. You can also use C<< $self->my_method($c, @args) >>
340 in the same controller or C<< $c->controller('MyController')->my_method($c, @args) >>
341 in a different controller.
342 The main difference is that 'forward' uses some of the Catalyst request
343 cycle overhead, including debugging, which may be useful to you. On the
344 other hand, there are some complications to using 'forward', restrictions
345 on values returned from 'forward', and it may not handle errors as you prefer.
346 Whether you use 'forward' or not is up to you; it is not considered superior to
347 the other ways to call a method.
349 'forward' calls another action, by its private name. If you give a
350 class name but no method, C<process()> is called. You may also optionally
351 pass arguments in an arrayref. The action will receive the arguments in
352 C<@_> and C<< $c->req->args >>. Upon returning from the function,
353 C<< $c->req->args >> will be restored to the previous values.
355 Any data C<return>ed from the action forwarded to, will be returned by the
358 my $foodata = $c->forward('/foo');
359 $c->forward('index');
360 $c->forward(qw/Model::DBIC::Foo do_stuff/);
361 $c->forward('View::TT');
363 Note that L<< forward|/"$c->forward( $action [, \@arguments ] )" >> implies
364 an C<< eval { } >> around the call (actually
365 L<< execute|/"$c->execute( $class, $coderef )" >> does), thus rendering all
366 exceptions thrown by the called action non-fatal and pushing them onto
367 $c->error instead. If you want C<die> to propagate you need to do something
371 die join "\n", @{ $c->error } if @{ $c->error };
373 Or make sure to always return true values from your actions and write
376 $c->forward('foo') || return;
378 Another note is that C<< $c->forward >> always returns a scalar because it
379 actually returns $c->state which operates in a scalar context.
380 Thus, something like:
384 in an action that is forwarded to is going to return a scalar,
385 i.e. how many items are in that array, which is probably not what you want.
386 If you need to return an array then return a reference to it,
389 $c->stash->{array} = \@array;
391 and access it from the stash.
393 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.
397 sub forward { my $c = shift; no warnings 'recursion'; $c->dispatcher->forward( $c, @_ ) }
399 =head2 $c->detach( $action [, \@arguments ] )
401 =head2 $c->detach( $class, $method, [, \@arguments ] )
405 The same as L<< forward|/"$c->forward( $action [, \@arguments ] )" >>, but
406 doesn't return to the previous action when processing is finished.
408 When called with no arguments it escapes the processing chain entirely.
412 sub detach { my $c = shift; $c->dispatcher->detach( $c, @_ ) }
414 =head2 $c->visit( $action [, \@arguments ] )
416 =head2 $c->visit( $action [, \@captures, \@arguments ] )
418 =head2 $c->visit( $class, $method, [, \@arguments ] )
420 =head2 $c->visit( $class, $method, [, \@captures, \@arguments ] )
422 Almost the same as L<< forward|/"$c->forward( $action [, \@arguments ] )" >>,
423 but does a full dispatch, instead of just calling the new C<$action> /
424 C<< $class->$method >>. This means that C<begin>, C<auto> and the method
425 you go to are called, just like a new request.
427 In addition both C<< $c->action >> and C<< $c->namespace >> are localized.
428 This means, for example, that C<< $c->action >> methods such as
429 L<name|Catalyst::Action/name>, L<class|Catalyst::Action/class> and
430 L<reverse|Catalyst::Action/reverse> return information for the visited action
431 when they are invoked within the visited action. This is different from the
432 behavior of L<< forward|/"$c->forward( $action [, \@arguments ] )" >>, which
433 continues to use the $c->action object from the caller action even when
434 invoked from the called action.
436 C<< $c->stash >> is kept unchanged.
438 In effect, L<< visit|/"$c->visit( $action [, \@captures, \@arguments ] )" >>
439 allows you to "wrap" another action, just as it would have been called by
440 dispatching from a URL, while the analogous
441 L<< go|/"$c->go( $action [, \@captures, \@arguments ] )" >> allows you to
442 transfer control to another action as if it had been reached directly from a URL.
446 sub visit { my $c = shift; $c->dispatcher->visit( $c, @_ ) }
448 =head2 $c->go( $action [, \@arguments ] )
450 =head2 $c->go( $action [, \@captures, \@arguments ] )
452 =head2 $c->go( $class, $method, [, \@arguments ] )
454 =head2 $c->go( $class, $method, [, \@captures, \@arguments ] )
456 The relationship between C<go> and
457 L<< visit|/"$c->visit( $action [, \@captures, \@arguments ] )" >> is the same as
458 the relationship between
459 L<< forward|/"$c->forward( $class, $method, [, \@arguments ] )" >> and
460 L<< detach|/"$c->detach( $action [, \@arguments ] )" >>. Like C<< $c->visit >>,
461 C<< $c->go >> will perform a full dispatch on the specified action or method,
462 with localized C<< $c->action >> and C<< $c->namespace >>. Like C<detach>,
463 C<go> escapes the processing of the current request chain on completion, and
464 does not return to its caller.
466 @arguments are arguments to the final destination of $action. @captures are
467 arguments to the intermediate steps, if any, on the way to the final sub of
472 sub go { my $c = shift; $c->dispatcher->go( $c, @_ ) }
478 Returns the current L<Catalyst::Response> object, see there for details.
482 Returns a hashref to the stash, which may be used to store data and pass
483 it between components during a request. You can also set hash keys by
484 passing arguments. The stash is automatically sent to the view. The
485 stash is cleared at the end of a request; it cannot be used for
486 persistent storage (for this you must use a session; see
487 L<Catalyst::Plugin::Session> for a complete system integrated with
490 $c->stash->{foo} = $bar;
491 $c->stash( { moose => 'majestic', qux => 0 } );
492 $c->stash( bar => 1, gorch => 2 ); # equivalent to passing a hashref
494 # stash is automatically passed to the view for use in a template
495 $c->forward( 'MyApp::View::TT' );
499 around stash => sub {
502 my $stash = $orig->($c);
504 my $new_stash = @_ > 1 ? {@_} : $_[0];
505 croak('stash takes a hash or hashref') unless ref $new_stash;
506 foreach my $key ( keys %$new_stash ) {
507 $stash->{$key} = $new_stash->{$key};
517 =head2 $c->error($error, ...)
519 =head2 $c->error($arrayref)
521 Returns an arrayref containing error messages. If Catalyst encounters an
522 error while processing a request, it stores the error in $c->error. This
523 method should only be used to store fatal error messages.
525 my @error = @{ $c->error };
529 $c->error('Something bad happened');
536 my $error = ref $_[0] eq 'ARRAY' ? $_[0] : [@_];
537 croak @$error unless ref $c;
538 push @{ $c->{error} }, @$error;
540 elsif ( defined $_[0] ) { $c->{error} = undef }
541 return $c->{error} || [];
547 Contains the return value of the last executed action.
548 Note that << $c->state >> operates in a scalar context which means that all
549 values it returns are scalar.
551 =head2 $c->clear_errors
553 Clear errors. You probably don't want to clear the errors unless you are
554 implementing a custom error screen.
556 This is equivalent to running
567 =head2 $c->has_errors
569 Returns true if you have errors
573 sub has_errors { scalar(@{shift->error}) ? 1:0 }
575 sub _comp_search_prefixes {
577 return map $c->components->{ $_ }, $c->_comp_names_search_prefixes(@_);
580 # search components given a name and some prefixes
581 sub _comp_names_search_prefixes {
582 my ( $c, $name, @prefixes ) = @_;
583 my $appclass = ref $c || $c;
584 my $filter = "^${appclass}::(" . join( '|', @prefixes ) . ')::';
585 $filter = qr/$filter/; # Compile regex now rather than once per loop
587 # map the original component name to the sub part that we will search against
588 my %eligible = map { my $n = $_; $n =~ s{^$appclass\::[^:]+::}{}; $_ => $n; }
589 grep { /$filter/ } keys %{ $c->components };
591 # undef for a name will return all
592 return keys %eligible if !defined $name;
594 my $query = $name->$_isa('Regexp') ? $name : qr/^$name$/i;
595 my @result = grep { $eligible{$_} =~ m{$query} } keys %eligible;
597 return @result if @result;
599 # if we were given a regexp to search against, we're done.
600 return if $name->$_isa('Regexp');
602 # skip regexp fallback if configured
604 if $appclass->config->{disable_component_resolution_regex_fallback};
608 @result = grep { $eligible{ $_ } =~ m{$query} } keys %eligible;
610 # no results? try against full names
612 @result = grep { m{$query} } keys %eligible;
615 # don't warn if we didn't find any results, it just might not exist
617 # Disgusting hack to work out correct method name
618 my $warn_for = lc $prefixes[0];
619 my $msg = "Used regexp fallback for \$c->${warn_for}('${name}'), which found '" .
620 (join '", "', @result) . "'. Relying on regexp fallback behavior for " .
621 "component resolution is unreliable and unsafe.";
622 my $short = $result[0];
623 # remove the component namespace prefix
624 $short =~ s/.*?(Model|Controller|View):://;
625 my $shortmess = Carp::shortmess('');
626 if ($shortmess =~ m#Catalyst/Plugin#) {
627 $msg .= " You probably need to set '$short' instead of '${name}' in this " .
629 } elsif ($shortmess =~ m#Catalyst/lib/(View|Controller)#) {
630 $msg .= " You probably need to set '$short' instead of '${name}' in this " .
631 "component's config";
633 $msg .= " You probably meant \$c->${warn_for}('$short') instead of \$c->${warn_for}('${name}'), " .
634 "but if you really wanted to search, pass in a regexp as the argument " .
635 "like so: \$c->${warn_for}(qr/${name}/)";
637 $c->log->warn( "${msg}$shortmess" );
643 # Find possible names for a prefix
645 my ( $c, @prefixes ) = @_;
646 my $appclass = ref $c || $c;
648 my $filter = "^${appclass}::(" . join( '|', @prefixes ) . ')::';
650 my @names = map { s{$filter}{}; $_; }
651 $c->_comp_names_search_prefixes( undef, @prefixes );
656 # Filter a component before returning by calling ACCEPT_CONTEXT if available
657 sub _filter_component {
658 my ( $c, $comp, @args ) = @_;
660 if ( eval { $comp->can('ACCEPT_CONTEXT'); } ) {
661 return $comp->ACCEPT_CONTEXT( $c, @args );
667 =head2 COMPONENT ACCESSORS
669 =head2 $c->controller($name)
671 Gets a L<Catalyst::Controller> instance by name.
673 $c->controller('Foo')->do_stuff;
675 If the name is omitted, will return the controller for the dispatched
678 If you want to search for controllers, pass in a regexp as the argument.
680 # find all controllers that start with Foo
681 my @foo_controllers = $c->controller(qr{^Foo});
687 my ( $c, $name, @args ) = @_;
689 my $appclass = ref($c) || $c;
691 unless ( $name->$_isa('Regexp') ) { # Direct component hash lookup to avoid costly regexps
692 my $comps = $c->components;
693 my $check = $appclass."::Controller::".$name;
694 return $c->_filter_component( $comps->{$check}, @args ) if exists $comps->{$check};
696 my @result = $c->_comp_search_prefixes( $name, qw/Controller C/ );
697 return map { $c->_filter_component( $_, @args ) } @result if ref $name;
698 return $c->_filter_component( $result[ 0 ], @args );
701 return $c->component( $c->action->class );
704 =head2 $c->model($name)
706 Gets a L<Catalyst::Model> instance by name.
708 $c->model('Foo')->do_stuff;
710 Any extra arguments are directly passed to ACCEPT_CONTEXT.
712 If the name is omitted, it will look for
713 - a model object in $c->stash->{current_model_instance}, then
714 - a model name in $c->stash->{current_model}, then
715 - a config setting 'default_model', or
716 - check if there is only one model, and return it if that's the case.
718 If you want to search for models, pass in a regexp as the argument.
720 # find all models that start with Foo
721 my @foo_models = $c->model(qr{^Foo});
726 my ( $c, $name, @args ) = @_;
727 my $appclass = ref($c) || $c;
729 unless ( $name->$_isa('Regexp') ) { # Direct component hash lookup to avoid costly regexps
730 my $comps = $c->components;
731 my $check = $appclass."::Model::".$name;
732 return $c->_filter_component( $comps->{$check}, @args ) if exists $comps->{$check};
734 my @result = $c->_comp_search_prefixes( $name, qw/Model M/ );
735 return map { $c->_filter_component( $_, @args ) } @result if ref $name;
736 return $c->_filter_component( $result[ 0 ], @args );
740 return $c->stash->{current_model_instance}
741 if $c->stash->{current_model_instance};
742 return $c->model( $c->stash->{current_model} )
743 if $c->stash->{current_model};
745 return $c->model( $appclass->config->{default_model} )
746 if $appclass->config->{default_model};
748 my( $comp, $rest ) = $c->_comp_search_prefixes( undef, qw/Model M/);
751 $c->log->warn( Carp::shortmess('Calling $c->model() will return a random model unless you specify one of:') );
752 $c->log->warn( '* $c->config(default_model => "the name of the default model to use")' );
753 $c->log->warn( '* $c->stash->{current_model} # the name of the model to use for this request' );
754 $c->log->warn( '* $c->stash->{current_model_instance} # the instance of the model to use for this request' );
755 $c->log->warn( 'NB: in version 5.81, the "random" behavior will not work at all.' );
758 return $c->_filter_component( $comp );
762 =head2 $c->view($name)
764 Gets a L<Catalyst::View> instance by name.
766 $c->view('Foo')->do_stuff;
768 Any extra arguments are directly passed to ACCEPT_CONTEXT.
770 If the name is omitted, it will look for
771 - a view object in $c->stash->{current_view_instance}, then
772 - a view name in $c->stash->{current_view}, then
773 - a config setting 'default_view', or
774 - check if there is only one view, and return it if that's the case.
776 If you want to search for views, pass in a regexp as the argument.
778 # find all views that start with Foo
779 my @foo_views = $c->view(qr{^Foo});
784 my ( $c, $name, @args ) = @_;
786 my $appclass = ref($c) || $c;
788 unless ( $name->$_isa('Regexp') ) { # Direct component hash lookup to avoid costly regexps
789 my $comps = $c->components;
790 my $check = $appclass."::View::".$name;
791 if( exists $comps->{$check} ) {
792 return $c->_filter_component( $comps->{$check}, @args );
795 $c->log->warn( "Attempted to use view '$check', but does not exist" );
798 my @result = $c->_comp_search_prefixes( $name, qw/View V/ );
799 return map { $c->_filter_component( $_, @args ) } @result if ref $name;
800 return $c->_filter_component( $result[ 0 ], @args );
804 return $c->stash->{current_view_instance}
805 if $c->stash->{current_view_instance};
806 return $c->view( $c->stash->{current_view} )
807 if $c->stash->{current_view};
809 return $c->view( $appclass->config->{default_view} )
810 if $appclass->config->{default_view};
812 my( $comp, $rest ) = $c->_comp_search_prefixes( undef, qw/View V/);
815 $c->log->warn( 'Calling $c->view() will return a random view unless you specify one of:' );
816 $c->log->warn( '* $c->config(default_view => "the name of the default view to use")' );
817 $c->log->warn( '* $c->stash->{current_view} # the name of the view to use for this request' );
818 $c->log->warn( '* $c->stash->{current_view_instance} # the instance of the view to use for this request' );
819 $c->log->warn( 'NB: in version 5.81, the "random" behavior will not work at all.' );
822 return $c->_filter_component( $comp );
825 =head2 $c->controllers
827 Returns the available names which can be passed to $c->controller
833 return $c->_comp_names(qw/Controller C/);
838 Returns the available names which can be passed to $c->model
844 return $c->_comp_names(qw/Model M/);
850 Returns the available names which can be passed to $c->view
856 return $c->_comp_names(qw/View V/);
859 =head2 $c->comp($name)
861 =head2 $c->component($name)
863 Gets a component object by name. This method is not recommended,
864 unless you want to get a specific component by full
865 class. C<< $c->controller >>, C<< $c->model >>, and C<< $c->view >>
866 should be used instead.
868 If C<$name> is a regexp, a list of components matched against the full
869 component name will be returned.
871 If Catalyst can't find a component by name, it will fallback to regex
872 matching by default. To disable this behaviour set
873 disable_component_resolution_regex_fallback to a true value.
875 __PACKAGE__->config( disable_component_resolution_regex_fallback => 1 );
880 my ( $c, $name, @args ) = @_;
883 my $comps = $c->components;
886 # is it the exact name?
887 return $c->_filter_component( $comps->{ $name }, @args )
888 if exists $comps->{ $name };
890 # perhaps we just omitted "MyApp"?
891 my $composed = ( ref $c || $c ) . "::${name}";
892 return $c->_filter_component( $comps->{ $composed }, @args )
893 if exists $comps->{ $composed };
895 # search all of the models, views and controllers
896 my( $comp ) = $c->_comp_search_prefixes( $name, qw/Model M Controller C View V/ );
897 return $c->_filter_component( $comp, @args ) if $comp;
901 if $c->config->{disable_component_resolution_regex_fallback};
903 # This is here so $c->comp( '::M::' ) works
904 my $query = ref $name ? $name : qr{$name}i;
906 my @result = grep { m{$query} } keys %{ $c->components };
907 return map { $c->_filter_component( $_, @args ) } @result if ref $name;
910 $c->log->warn( Carp::shortmess(qq(Found results for "${name}" using regexp fallback)) );
911 $c->log->warn( 'Relying on the regexp fallback behavior for component resolution' );
912 $c->log->warn( 'is unreliable and unsafe. You have been warned' );
913 return $c->_filter_component( $result[ 0 ], @args );
916 # I would expect to return an empty list here, but that breaks back-compat
920 return sort keys %{ $c->components };
923 =head2 CLASS DATA AND HELPER CLASSES
927 Returns or takes a hashref containing the application's configuration.
929 __PACKAGE__->config( { db => 'dsn:SQLite:foo.db' } );
931 You can also use a C<YAML>, C<XML> or L<Config::General> config file
932 like C<myapp.conf> in your applications home directory. See
933 L<Catalyst::Plugin::ConfigLoader>.
935 =head3 Cascading configuration
937 The config method is present on all Catalyst components, and configuration
938 will be merged when an application is started. Configuration loaded with
939 L<Catalyst::Plugin::ConfigLoader> takes precedence over other configuration,
940 followed by configuration in your top level C<MyApp> class. These two
941 configurations are merged, and then configuration data whose hash key matches a
942 component name is merged with configuration for that component.
944 The configuration for a component is then passed to the C<new> method when a
945 component is constructed.
949 MyApp->config({ 'Model::Foo' => { bar => 'baz', overrides => 'me' } });
950 MyApp::Model::Foo->config({ quux => 'frob', overrides => 'this' });
952 will mean that C<MyApp::Model::Foo> receives the following data when
955 MyApp::Model::Foo->new({
961 It's common practice to use a Moose attribute
962 on the receiving component to access the config value.
964 package MyApp::Model::Foo;
968 # this attr will receive 'baz' at construction time
974 You can then get the value 'baz' by calling $c->model('Foo')->bar
975 (or $self->bar inside code in the model).
977 B<NOTE:> you MUST NOT call C<< $self->config >> or C<< __PACKAGE__->config >>
978 as a way of reading config within your code, as this B<will not> give you the
979 correctly merged config back. You B<MUST> take the config values supplied to
980 the constructor and use those instead.
984 around config => sub {
988 croak('Setting config after setup has been run is not allowed.')
989 if ( @_ and $c->setup_finished );
996 Returns the logging object instance. Unless it is already set, Catalyst
997 sets this up with a L<Catalyst::Log> object. To use your own log class,
998 set the logger with the C<< __PACKAGE__->log >> method prior to calling
999 C<< __PACKAGE__->setup >>.
1001 __PACKAGE__->log( MyLogger->new );
1006 $c->log->info( 'Now logging with my own logger!' );
1008 Your log class should implement the methods described in
1014 Returns 1 if debug mode is enabled, 0 otherwise.
1016 You can enable debug mode in several ways:
1020 =item By calling myapp_server.pl with the -d flag
1022 =item With the environment variables MYAPP_DEBUG, or CATALYST_DEBUG
1024 =item The -Debug option in your MyApp.pm
1026 =item By declaring C<sub debug { 1 }> in your MyApp.pm.
1030 The first three also set the log level to 'debug'.
1032 Calling C<< $c->debug(1) >> has no effect.
1038 =head2 $c->dispatcher
1040 Returns the dispatcher instance. See L<Catalyst::Dispatcher>.
1044 Returns the engine instance. See L<Catalyst::Engine>.
1047 =head2 UTILITY METHODS
1049 =head2 $c->path_to(@path)
1051 Merges C<@path> with C<< $c->config->{home} >> and returns a
1052 L<Path::Class::Dir> object. Note you can usually use this object as
1053 a filename, but sometimes you will have to explicitly stringify it
1054 yourself by calling the C<< ->stringify >> method.
1058 $c->path_to( 'db', 'sqlite.db' );
1063 my ( $c, @path ) = @_;
1064 my $path = Path::Class::Dir->new( $c->config->{home}, @path );
1065 if ( -d $path ) { return $path }
1066 else { return Path::Class::File->new( $c->config->{home}, @path ) }
1070 my ( $class, $name, $plugin, @args ) = @_;
1072 # See block comment in t/unit_core_plugin.t
1073 $class->log->warn(qq/Adding plugin using the ->plugin method is deprecated, and will be removed in a future release/);
1075 $class->_register_plugin( $plugin, 1 );
1077 eval { $plugin->import };
1078 $class->mk_classdata($name);
1080 eval { $obj = $plugin->new(@args) };
1083 Catalyst::Exception->throw( message =>
1084 qq/Couldn't instantiate instant plugin "$plugin", "$@"/ );
1087 $class->$name($obj);
1088 $class->log->debug(qq/Initialized instant plugin "$plugin" as "$name"/)
1094 Initializes the dispatcher and engine, loads any plugins, and loads the
1095 model, view, and controller components. You may also specify an array
1096 of plugins to load here, if you choose to not load them in the C<use
1100 MyApp->setup( qw/-Debug/ );
1102 B<Note:> You B<should not> wrap this method with method modifiers
1103 or bad things will happen - wrap the C<setup_finalize> method instead.
1108 my ( $class, @arguments ) = @_;
1109 croak('Running setup more than once')
1110 if ( $class->setup_finished );
1112 unless ( $class->isa('Catalyst') ) {
1114 Catalyst::Exception->throw(
1115 message => qq/'$class' does not inherit from Catalyst/ );
1118 if ( $class->arguments ) {
1119 @arguments = ( @arguments, @{ $class->arguments } );
1125 foreach (@arguments) {
1129 ( $flags->{log} ) ? 'debug,' . $flags->{log} : 'debug';
1131 elsif (/^-(\w+)=?(.*)$/) {
1132 $flags->{ lc $1 } = $2;
1135 push @{ $flags->{plugins} }, $_;
1139 $class->setup_home( delete $flags->{home} );
1141 $class->setup_log( delete $flags->{log} );
1142 $class->setup_plugins( delete $flags->{plugins} );
1144 $class->setup_data_handlers();
1145 $class->setup_dispatcher( delete $flags->{dispatcher} );
1146 if (my $engine = delete $flags->{engine}) {
1147 $class->log->warn("Specifying the engine in ->setup is no longer supported, see Catalyst::Upgrading");
1149 $class->setup_engine();
1150 $class->setup_stats( delete $flags->{stats} );
1152 for my $flag ( sort keys %{$flags} ) {
1154 if ( my $code = $class->can( 'setup_' . $flag ) ) {
1155 &$code( $class, delete $flags->{$flag} );
1158 $class->log->warn(qq/Unknown flag "$flag"/);
1162 eval { require Catalyst::Devel; };
1163 if( !$@ && $ENV{CATALYST_SCRIPT_GEN} && ( $ENV{CATALYST_SCRIPT_GEN} < $Catalyst::Devel::CATALYST_SCRIPT_GEN ) ) {
1164 $class->log->warn(<<"EOF");
1165 You are running an old script!
1167 Please update by running (this will overwrite existing files):
1168 catalyst.pl -force -scripts $class
1170 or (this will not overwrite existing files):
1171 catalyst.pl -scripts $class
1176 # Call plugins setup, this is stupid and evil.
1177 # Also screws C3 badly on 5.10, hack to avoid.
1179 no warnings qw/redefine/;
1180 local *setup = sub { };
1181 $class->setup unless $Catalyst::__AM_RESTARTING;
1184 $class->setup_middleware();
1186 # Initialize our data structure
1187 $class->components( {} );
1189 $class->setup_components;
1191 if ( $class->debug ) {
1192 my @plugins = map { "$_ " . ( $_->VERSION || '' ) } $class->registered_plugins;
1195 my $column_width = Catalyst::Utils::term_width() - 6;
1196 my $t = Text::SimpleTable->new($column_width);
1197 $t->row($_) for @plugins;
1198 $class->log->debug( "Loaded plugins:\n" . $t->draw . "\n" );
1201 my @middleware = map {
1204 (ref($_) .' '. ($_->can('VERSION') ? $_->VERSION || '' : '')
1205 || '') } $class->registered_middlewares;
1208 my $column_width = Catalyst::Utils::term_width() - 6;
1209 my $t = Text::SimpleTable->new($column_width);
1210 $t->row($_) for @middleware;
1211 $class->log->debug( "Loaded PSGI Middleware:\n" . $t->draw . "\n" );
1214 my %dh = $class->registered_data_handlers;
1215 if (my @data_handlers = keys %dh) {
1216 my $column_width = Catalyst::Utils::term_width() - 6;
1217 my $t = Text::SimpleTable->new($column_width);
1218 $t->row($_) for @data_handlers;
1219 $class->log->debug( "Loaded Request Data Handlers:\n" . $t->draw . "\n" );
1222 my $dispatcher = $class->dispatcher;
1223 my $engine = $class->engine;
1224 my $home = $class->config->{home};
1226 $class->log->debug(sprintf(q/Loaded dispatcher "%s"/, blessed($dispatcher)));
1227 $class->log->debug(sprintf(q/Loaded engine "%s"/, blessed($engine)));
1231 ? $class->log->debug(qq/Found home "$home"/)
1232 : $class->log->debug(qq/Home "$home" doesn't exist/)
1233 : $class->log->debug(q/Couldn't find home/);
1235 my $column_width = Catalyst::Utils::term_width() - 8 - 9;
1236 my $t = Text::SimpleTable->new( [ $column_width, 'Class' ], [ 8, 'Type' ] );
1237 for my $comp ( sort keys %{ $class->components } ) {
1238 my $type = ref $class->components->{$comp} ? 'instance' : 'class';
1239 $t->row( $comp, $type );
1241 $class->log->debug( "Loaded components:\n" . $t->draw . "\n" )
1242 if ( keys %{ $class->components } );
1245 # Add our self to components, since we are also a component
1246 if( $class->isa('Catalyst::Controller') ){
1247 $class->components->{$class} = $class;
1250 $class->setup_actions;
1252 if ( $class->debug ) {
1253 my $name = $class->config->{name} || 'Application';
1254 $class->log->info("$name powered by Catalyst $Catalyst::VERSION");
1257 if ($class->config->{case_sensitive}) {
1258 $class->log->warn($class . "->config->{case_sensitive} is set.");
1259 $class->log->warn("This setting is deprecated and planned to be removed in Catalyst 5.81.");
1262 $class->setup_finalize;
1264 # Flush the log for good measure (in case something turned off 'autoflush' early)
1265 $class->log->_flush() if $class->log->can('_flush');
1267 return $class || 1; # Just in case someone named their Application 0...
1270 =head2 $app->setup_finalize
1272 A hook to attach modifiers to. This method does not do anything except set the
1273 C<setup_finished> accessor.
1275 Applying method modifiers to the C<setup> method doesn't work, because of quirky things done for plugin setup.
1279 after setup_finalize => sub {
1287 sub setup_finalize {
1289 $class->setup_finished(1);
1292 =head2 $c->uri_for( $path?, @args?, \%query_values? )
1294 =head2 $c->uri_for( $action, \@captures?, @args?, \%query_values? )
1296 Constructs an absolute L<URI> object based on the application root, the
1297 provided path, and the additional arguments and query parameters provided.
1298 When used as a string, provides a textual URI. If you need more flexibility
1299 than this (i.e. the option to provide relative URIs etc.) see
1300 L<Catalyst::Plugin::SmartURI>.
1302 If no arguments are provided, the URI for the current action is returned.
1303 To return the current action and also provide @args, use
1304 C<< $c->uri_for( $c->action, @args ) >>.
1306 If the first argument is a string, it is taken as a public URI path relative
1307 to C<< $c->namespace >> (if it doesn't begin with a forward slash) or
1308 relative to the application root (if it does). It is then merged with
1309 C<< $c->request->base >>; any C<@args> are appended as additional path
1310 components; and any C<%query_values> are appended as C<?foo=bar> parameters.
1312 If the first argument is a L<Catalyst::Action> it represents an action which
1313 will have its path resolved using C<< $c->dispatcher->uri_for_action >>. The
1314 optional C<\@captures> argument (an arrayref) allows passing the captured
1315 variables that are needed to fill in the paths of Chained and Regex actions;
1316 once the path is resolved, C<uri_for> continues as though a path was
1317 provided, appending any arguments or parameters and creating an absolute
1320 The captures for the current request can be found in
1321 C<< $c->request->captures >>, and actions can be resolved using
1322 C<< Catalyst::Controller->action_for($name) >>. If you have a private action
1323 path, use C<< $c->uri_for_action >> instead.
1325 # Equivalent to $c->req->uri
1326 $c->uri_for($c->action, $c->req->captures,
1327 @{ $c->req->args }, $c->req->params);
1329 # For the Foo action in the Bar controller
1330 $c->uri_for($c->controller('Bar')->action_for('Foo'));
1332 # Path to a static resource
1333 $c->uri_for('/static/images/logo.png');
1338 my ( $c, $path, @args ) = @_;
1340 if ( $path->$_isa('Catalyst::Controller') ) {
1341 $path = $path->path_prefix;
1346 undef($path) if (defined $path && $path eq '');
1349 ( scalar @args && ref $args[$#args] eq 'HASH' ? pop @args : {} );
1351 carp "uri_for called with undef argument" if grep { ! defined $_ } @args;
1352 foreach my $arg (@args) {
1353 utf8::encode($arg) if utf8::is_utf8($arg);
1354 $arg =~ s/([^$URI::uric])/$URI::Escape::escapes{$1}/go;
1357 if ( $path->$_isa('Catalyst::Action') ) { # action object
1358 s|/|%2F|g for @args;
1359 my $captures = [ map { s|/|%2F|g; $_; }
1360 ( scalar @args && ref $args[0] eq 'ARRAY'
1364 foreach my $capture (@$captures) {
1365 utf8::encode($capture) if utf8::is_utf8($capture);
1366 $capture =~ s/([^$URI::uric])/$URI::Escape::escapes{$1}/go;
1370 # ->uri_for( $action, \@captures_and_args, \%query_values? )
1371 if( !@args && $action->number_of_args ) {
1372 my $expanded_action = $c->dispatcher->expand_action( $action );
1374 my $num_captures = $expanded_action->number_of_captures;
1375 unshift @args, splice @$captures, $num_captures;
1378 $path = $c->dispatcher->uri_for_action($action, $captures);
1379 if (not defined $path) {
1380 $c->log->debug(qq/Can't find uri_for action '$action' @$captures/)
1384 $path = '/' if $path eq '';
1387 unshift(@args, $path);
1389 unless (defined $path && $path =~ s!^/!!) { # in-place strip
1390 my $namespace = $c->namespace;
1391 if (defined $path) { # cheesy hack to handle path '../foo'
1392 $namespace =~ s{(?:^|/)[^/]+$}{} while $args[0] =~ s{^\.\./}{};
1394 unshift(@args, $namespace || '');
1397 # join args with '/', or a blank string
1398 my $args = join('/', grep { defined($_) } @args);
1399 $args =~ s/\?/%3F/g; # STUPID STUPID SPECIAL CASE
1402 my ($base, $class) = ('/', 'URI::_generic');
1404 $base = $c->req->base;
1405 $class = ref($base);
1406 $base =~ s{(?<!/)$}{/};
1411 if (my @keys = keys %$params) {
1412 # somewhat lifted from URI::_query's query_form
1413 $query = '?'.join('&', map {
1414 my $val = $params->{$_};
1415 s/([;\/?:@&=+,\$\[\]%])/$URI::Escape::escapes{$1}/go;
1418 $val = '' unless defined $val;
1421 utf8::encode( $param ) if utf8::is_utf8($param);
1422 # using the URI::Escape pattern here so utf8 chars survive
1423 $param =~ s/([^A-Za-z0-9\-_.!~*'() ])/$URI::Escape::escapes{$1}/go;
1425 "${key}=$param"; } ( ref $val eq 'ARRAY' ? @$val : $val ));
1429 my $res = bless(\"${base}${args}${query}", $class);
1433 =head2 $c->uri_for_action( $path, \@captures_and_args?, @args?, \%query_values? )
1435 =head2 $c->uri_for_action( $action, \@captures_and_args?, @args?, \%query_values? )
1441 A private path to the Catalyst action you want to create a URI for.
1443 This is a shortcut for calling C<< $c->dispatcher->get_action_by_path($path)
1444 >> and passing the resulting C<$action> and the remaining arguments to C<<
1447 You can also pass in a Catalyst::Action object, in which case it is passed to
1450 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.
1452 For example, if the action looks like:
1454 package MyApp::Controller::Users;
1456 sub lst : Path('the-list') {}
1460 $c->uri_for_action('/users/lst')
1462 and it will create the URI /users/the-list.
1464 =item \@captures_and_args?
1466 Optional array reference of Captures (i.e. C<<CaptureArgs or $c->req->captures>)
1467 and arguments to the request. Usually used with L<Catalyst::DispatchType::Chained>
1468 to interpolate all the parameters in the URI.
1472 Optional list of extra arguments - can be supplied in the
1473 C<< \@captures_and_args? >> array ref, or here - whichever is easier for your
1476 Your action can have zero, a fixed or a variable number of args (e.g.
1477 C<< Args(1) >> for a fixed number or C<< Args() >> for a variable number)..
1479 =item \%query_values?
1481 Optional array reference of query parameters to append. E.g.
1487 /rest/of/your/uri?foo=bar
1493 sub uri_for_action {
1494 my ( $c, $path, @args ) = @_;
1495 my $action = blessed($path)
1497 : $c->dispatcher->get_action_by_path($path);
1498 unless (defined $action) {
1499 croak "Can't find action for path '$path'";
1501 return $c->uri_for( $action, @args );
1504 =head2 $c->welcome_message
1506 Returns the Catalyst welcome HTML page.
1510 sub welcome_message {
1512 my $name = $c->config->{name};
1513 my $logo = $c->uri_for('/static/images/catalyst_logo.png');
1514 my $prefix = Catalyst::Utils::appprefix( ref $c );
1515 $c->response->content_type('text/html; charset=utf-8');
1517 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
1518 "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
1519 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
1521 <meta http-equiv="Content-Language" content="en" />
1522 <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
1523 <title>$name on Catalyst $VERSION</title>
1524 <style type="text/css">
1527 background-color: #eee;
1534 margin-bottom: 10px;
1536 background-color: #ccc;
1537 border: 1px solid #aaa;
1542 font-family: verdana, tahoma, sans-serif;
1545 font-family: verdana, tahoma, sans-serif;
1548 text-decoration: none;
1550 border-bottom: 1px dotted #bbb;
1552 :link:hover, :visited:hover {
1565 background-color: #fff;
1566 border: 1px solid #aaa;
1570 font-weight: normal;
1592 <h1><span id="appname">$name</span> on <a href="http://catalyst.perl.org">Catalyst</a>
1597 <img src="$logo" alt="Catalyst Logo" />
1599 <p>Welcome to the world of Catalyst.
1600 This <a href="http://en.wikipedia.org/wiki/MVC">MVC</a>
1601 framework will make web development something you had
1602 never expected it to be: Fun, rewarding, and quick.</p>
1603 <h2>What to do now?</h2>
1604 <p>That really depends on what <b>you</b> want to do.
1605 We do, however, provide you with a few starting points.</p>
1606 <p>If you want to jump right into web development with Catalyst
1607 you might want to start with a tutorial.</p>
1608 <pre>perldoc <a href="https://metacpan.org/module/Catalyst::Manual::Tutorial">Catalyst::Manual::Tutorial</a></code>
1610 <p>Afterwards you can go on to check out a more complete look at our features.</p>
1612 <code>perldoc <a href="https://metacpan.org/module/Catalyst::Manual::Intro">Catalyst::Manual::Intro</a>
1613 <!-- Something else should go here, but the Catalyst::Manual link seems unhelpful -->
1615 <h2>What to do next?</h2>
1616 <p>Next it's time to write an actual application. Use the
1617 helper scripts to generate <a href="https://metacpan.org/search?q=Catalyst%3A%3AController">controllers</a>,
1618 <a href="https://metacpan.org/search?q=Catalyst%3A%3AModel">models</a>, and
1619 <a href="https://metacpan.org/search?q=Catalyst%3A%3AView">views</a>;
1620 they can save you a lot of work.</p>
1621 <pre><code>script/${prefix}_create.pl --help</code></pre>
1622 <p>Also, be sure to check out the vast and growing
1623 collection of <a href="http://search.cpan.org/search?query=Catalyst">plugins for Catalyst on CPAN</a>;
1624 you are likely to find what you need there.
1628 <p>Catalyst has a very active community. Here are the main places to
1629 get in touch with us.</p>
1632 <a href="http://dev.catalyst.perl.org">Wiki</a>
1635 <a href="http://lists.scsys.co.uk/cgi-bin/mailman/listinfo/catalyst">Mailing-List</a>
1638 <a href="irc://irc.perl.org/catalyst">IRC channel #catalyst on irc.perl.org</a>
1641 <h2>In conclusion</h2>
1642 <p>The Catalyst team hopes you will enjoy using Catalyst as much
1643 as we enjoyed making it. Please contact us if you have ideas
1644 for improvement or other feedback.</p>
1654 Contains a hash of options passed from the application script, including
1655 the original ARGV the script received, the processed values from that
1656 ARGV and any extra arguments to the script which were not processed.
1658 This can be used to add custom options to your application's scripts
1659 and setup your application differently depending on the values of these
1662 =head1 INTERNAL METHODS
1664 These methods are not meant to be used by end users.
1666 =head2 $c->components
1668 Returns a hash of components.
1670 =head2 $c->context_class
1672 Returns or sets the context class.
1676 Returns a hashref containing coderefs and execution counts (needed for
1677 deep recursion detection).
1681 Returns the number of actions on the current internal execution stack.
1685 Dispatches a request to actions.
1689 sub dispatch { my $c = shift; $c->dispatcher->dispatch( $c, @_ ) }
1691 =head2 $c->dispatcher_class
1693 Returns or sets the dispatcher class.
1695 =head2 $c->dump_these
1697 Returns a list of 2-element array references (name, structure) pairs
1698 that will be dumped on the error page in debug mode.
1704 [ Request => $c->req ],
1705 [ Response => $c->res ],
1706 [ Stash => $c->stash ],
1707 [ Config => $c->config ];
1710 =head2 $c->engine_class
1712 Returns or sets the engine class.
1714 =head2 $c->execute( $class, $coderef )
1716 Execute a coderef in given class and catch exceptions. Errors are available
1722 my ( $c, $class, $code ) = @_;
1723 $class = $c->component($class) || $class;
1726 if ( $c->depth >= $RECURSION ) {
1727 my $action = $code->reverse();
1728 $action = "/$action" unless $action =~ /->/;
1729 my $error = qq/Deep recursion detected calling "${action}"/;
1730 $c->log->error($error);
1736 my $stats_info = $c->_stats_start_execute( $code ) if $c->use_stats;
1738 push( @{ $c->stack }, $code );
1740 no warnings 'recursion';
1741 # N.B. This used to be combined, but I have seen $c get clobbered if so, and
1742 # I have no idea how, ergo $ret (which appears to fix the issue)
1743 eval { my $ret = $code->execute( $class, $c, @{ $c->req->args } ) || 0; $c->state( $ret ) };
1745 $c->_stats_finish_execute( $stats_info ) if $c->use_stats and $stats_info;
1747 my $last = pop( @{ $c->stack } );
1749 if ( my $error = $@ ) {
1750 #rethow if this can be handled by middleware
1751 if(blessed $error && ($error->can('as_psgi') || $error->can('code'))) {
1752 foreach my $err (@{$c->error}) {
1753 $c->log->error($err);
1756 $c->log->_flush if $c->log->can('_flush');
1758 $error->can('rethrow') ? $error->rethrow : croak $error;
1760 if ( blessed($error) and $error->isa('Catalyst::Exception::Detach') ) {
1761 $error->rethrow if $c->depth > 1;
1763 elsif ( blessed($error) and $error->isa('Catalyst::Exception::Go') ) {
1764 $error->rethrow if $c->depth > 0;
1767 unless ( ref $error ) {
1768 no warnings 'uninitialized';
1770 my $class = $last->class;
1771 my $name = $last->name;
1772 $error = qq/Caught exception in $class->$name "$error"/;
1781 sub _stats_start_execute {
1782 my ( $c, $code ) = @_;
1783 my $appclass = ref($c) || $c;
1784 return if ( ( $code->name =~ /^_.*/ )
1785 && ( !$appclass->config->{show_internal_actions} ) );
1787 my $action_name = $code->reverse();
1788 $c->counter->{$action_name}++;
1790 my $action = $action_name;
1791 $action = "/$action" unless $action =~ /->/;
1793 # determine if the call was the result of a forward
1794 # this is done by walking up the call stack and looking for a calling
1795 # sub of Catalyst::forward before the eval
1797 for my $index ( 2 .. 11 ) {
1799 if ( ( caller($index) )[0] eq 'Catalyst'
1800 && ( caller($index) )[3] eq '(eval)' );
1802 if ( ( caller($index) )[3] =~ /forward$/ ) {
1803 $callsub = ( caller($index) )[3];
1804 $action = "-> $action";
1809 my $uid = $action_name . $c->counter->{$action_name};
1811 # is this a root-level call or a forwarded call?
1812 if ( $callsub =~ /forward$/ ) {
1813 my $parent = $c->stack->[-1];
1815 # forward, locate the caller
1816 if ( defined $parent && exists $c->counter->{"$parent"} ) {
1819 parent => "$parent" . $c->counter->{"$parent"},
1825 # forward with no caller may come from a plugin
1844 sub _stats_finish_execute {
1845 my ( $c, $info ) = @_;
1846 $c->stats->profile( end => $info );
1851 Finalizes the request.
1858 for my $error ( @{ $c->error } ) {
1859 $c->log->error($error);
1862 # Support skipping finalize for psgix.io style 'jailbreak'. Used to support
1863 # stuff like cometd and websockets
1865 if($c->request->_has_io_fh) {
1870 # Allow engine to handle finalize flow (for POE)
1871 my $engine = $c->engine;
1872 if ( my $code = $engine->can('finalize') ) {
1877 $c->finalize_uploads;
1880 if ( $#{ $c->error } >= 0 ) {
1884 $c->finalize_headers unless $c->response->finalized_headers;
1891 if ($c->use_stats) {
1892 my $elapsed = $c->stats->elapsed;
1893 my $av = $elapsed == 0 ? '??' : sprintf '%.3f', 1 / $elapsed;
1895 "Request took ${elapsed}s ($av/s)\n" . $c->stats->report . "\n" );
1898 return $c->response->status;
1901 =head2 $c->finalize_body
1907 sub finalize_body { my $c = shift; $c->engine->finalize_body( $c, @_ ) }
1909 =head2 $c->finalize_cookies
1915 sub finalize_cookies { my $c = shift; $c->engine->finalize_cookies( $c, @_ ) }
1917 =head2 $c->finalize_error
1919 Finalizes error. If there is only one error in L</error> and it is an object that
1920 does C<as_psgi> or C<code> we rethrow the error and presume it caught by middleware
1921 up the ladder. Otherwise we return the debugging error page (in debug mode) or we
1922 return the default error page (production mode).
1926 sub finalize_error {
1928 if($#{$c->error} > 0) {
1929 $c->engine->finalize_error( $c, @_ );
1931 my ($error) = @{$c->error};
1934 ($error->can('as_psgi') || $error->can('code'))
1936 # In the case where the error 'knows what it wants', becauses its PSGI
1937 # aware, just rethow and let middleware catch it
1938 $error->can('rethrow') ? $error->rethrow : croak $error;
1940 $c->engine->finalize_error( $c, @_ )
1945 =head2 $c->finalize_headers
1951 sub finalize_headers {
1954 my $response = $c->response; #accessor calls can add up?
1956 # Check if we already finalized headers
1957 return if $response->finalized_headers;
1960 if ( my $location = $response->redirect ) {
1961 $c->log->debug(qq/Redirecting to "$location"/) if $c->debug;
1962 $response->header( Location => $location );
1965 # Remove incorrectly added body and content related meta data when returning
1966 # an information response, or a response the is required to not include a body
1968 $c->finalize_cookies;
1970 $c->response->finalize_headers();
1973 $response->finalized_headers(1);
1976 =head2 $c->finalize_output
1978 An alias for finalize_body.
1980 =head2 $c->finalize_read
1982 Finalizes the input after reading is complete.
1986 sub finalize_read { my $c = shift; $c->engine->finalize_read( $c, @_ ) }
1988 =head2 $c->finalize_uploads
1990 Finalizes uploads. Cleans up any temporary files.
1994 sub finalize_uploads { my $c = shift; $c->engine->finalize_uploads( $c, @_ ) }
1996 =head2 $c->get_action( $action, $namespace )
1998 Gets an action in a given namespace.
2002 sub get_action { my $c = shift; $c->dispatcher->get_action(@_) }
2004 =head2 $c->get_actions( $action, $namespace )
2006 Gets all actions of a given name in a namespace and all parent
2011 sub get_actions { my $c = shift; $c->dispatcher->get_actions( $c, @_ ) }
2013 =head2 $app->handle_request( @arguments )
2015 Called to handle each HTTP request.
2019 sub handle_request {
2020 my ( $class, @arguments ) = @_;
2022 # Always expect worst case!
2025 if ($class->debug) {
2026 my $secs = time - $START || 1;
2027 my $av = sprintf '%.3f', $COUNT / $secs;
2028 my $time = localtime time;
2029 $class->log->info("*** Request $COUNT ($av/s) [$$] [$time] ***");
2032 my $c = $class->prepare(@arguments);
2034 $status = $c->finalize;
2036 #rethow if this can be handled by middleware
2037 if(blessed $_ && ($_->can('as_psgi') || $_->can('code'))) {
2038 $_->can('rethrow') ? $_->rethrow : croak $_;
2040 chomp(my $error = $_);
2041 $class->log->error(qq/Caught exception in engine "$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( ::M ::Model ::V ::View ::C ::Controller );
2611 my $extra = delete $config->{ search_extra } || [];
2613 unshift @paths, @$extra;
2615 my @comps = map { sort { length($a) <=> length($b) } Module::Pluggable::Object->new(
2616 search_path => [ map { s/^(?=::)/$class/; $_; } ($_) ],
2618 )->plugins } @paths;
2623 =head2 $c->expand_component_module( $component, $setup_component_config )
2625 Components found by C<locate_components> will be passed to this method, which
2626 is expected to return a list of component (package) names to be set up.
2630 sub expand_component_module {
2631 my ($class, $module) = @_;
2632 return Devel::InnerPackage::list_packages( $module );
2635 =head2 $c->setup_component
2639 sub setup_component {
2640 my( $class, $component ) = @_;
2642 unless ( $component->can( 'COMPONENT' ) ) {
2646 my $suffix = Catalyst::Utils::class2classsuffix( $component );
2647 my $config = $class->config->{ $suffix } || {};
2648 # Stash catalyst_component_name in the config here, so that custom COMPONENT
2649 # methods also pass it. local to avoid pointlessly shitting in config
2650 # for the debug screen, as $component is already the key name.
2651 local $config->{catalyst_component_name} = $component;
2653 my $instance = eval { $component->COMPONENT( $class, $config ); };
2655 if ( my $error = $@ ) {
2657 Catalyst::Exception->throw(
2658 message => qq/Couldn't instantiate component "$component", "$error"/
2662 unless (blessed $instance) {
2663 my $metaclass = Moose::Util::find_meta($component);
2664 my $method_meta = $metaclass->find_method_by_name('COMPONENT');
2665 my $component_method_from = $method_meta->associated_metaclass->name;
2666 my $value = defined($instance) ? $instance : 'undef';
2667 Catalyst::Exception->throw(
2669 qq/Couldn't instantiate component "$component", COMPONENT() method (from $component_method_from) didn't return an object-like value (value was $value)./
2675 =head2 $c->setup_dispatcher
2681 sub setup_dispatcher {
2682 my ( $class, $dispatcher ) = @_;
2685 $dispatcher = 'Catalyst::Dispatcher::' . $dispatcher;
2688 if ( my $env = Catalyst::Utils::env_value( $class, 'DISPATCHER' ) ) {
2689 $dispatcher = 'Catalyst::Dispatcher::' . $env;
2692 unless ($dispatcher) {
2693 $dispatcher = $class->dispatcher_class;
2696 load_class($dispatcher);
2698 # dispatcher instance
2699 $class->dispatcher( $dispatcher->new );
2702 =head2 $c->setup_engine
2709 my ($class, $requested_engine) = @_;
2711 if (!$class->engine_loader || $requested_engine) {
2712 $class->engine_loader(
2713 Catalyst::EngineLoader->new({
2714 application_name => $class,
2715 (defined $requested_engine
2716 ? (catalyst_engine_class => $requested_engine) : ()),
2721 $class->engine_loader->catalyst_engine_class;
2725 my ($class, $requested_engine) = @_;
2728 my $loader = $class->engine_loader;
2730 if (!$loader || $requested_engine) {
2731 $loader = Catalyst::EngineLoader->new({
2732 application_name => $class,
2733 (defined $requested_engine
2734 ? (requested_engine => $requested_engine) : ()),
2737 $class->engine_loader($loader);
2740 $loader->catalyst_engine_class;
2743 # Don't really setup_engine -- see _setup_psgi_app for explanation.
2744 return if $class->loading_psgi_file;
2746 load_class($engine);
2748 if ($ENV{MOD_PERL}) {
2749 my $apache = $class->engine_loader->auto;
2751 my $meta = find_meta($class);
2752 my $was_immutable = $meta->is_immutable;
2753 my %immutable_options = $meta->immutable_options;
2754 $meta->make_mutable if $was_immutable;
2756 $meta->add_method(handler => sub {
2758 my $psgi_app = $class->_finalized_psgi_app;
2759 $apache->call_app($r, $psgi_app);
2762 $meta->make_immutable(%immutable_options) if $was_immutable;
2765 $class->engine( $engine->new );
2770 ## This exists just to supply a prebuild psgi app for mod_perl and for the
2771 ## build in server support (back compat support for pre psgi port behavior).
2772 ## This is so that we don't build a new psgi app for each request when using
2773 ## the mod_perl handler or the built in servers (http and fcgi, etc).
2775 sub _finalized_psgi_app {
2778 unless ($app->_psgi_app) {
2779 my $psgi_app = $app->_setup_psgi_app;
2780 $app->_psgi_app($psgi_app);
2783 return $app->_psgi_app;
2786 ## Look for a psgi file like 'myapp_web.psgi' (if the app is MyApp::Web) in the
2787 ## home directory and load that and return it (just assume it is doing the
2788 ## right thing :) ). If that does not exist, call $app->psgi_app, wrap that
2789 ## in default_middleware and return it ( this is for backward compatibility
2790 ## with pre psgi port behavior ).
2792 sub _setup_psgi_app {
2795 for my $home (Path::Class::Dir->new($app->config->{home})) {
2796 my $psgi_file = $home->file(
2797 Catalyst::Utils::appprefix($app) . '.psgi',
2800 next unless -e $psgi_file;
2802 # If $psgi_file calls ->setup_engine, it's doing so to load
2803 # Catalyst::Engine::PSGI. But if it does that, we're only going to
2804 # throw away the loaded PSGI-app and load the 5.9 Catalyst::Engine
2805 # anyway. So set a flag (ick) that tells setup_engine not to populate
2806 # $c->engine or do any other things we might regret.
2808 $app->loading_psgi_file(1);
2809 my $psgi_app = Plack::Util::load_psgi($psgi_file);
2810 $app->loading_psgi_file(0);
2813 unless $app->engine_loader->needs_psgi_engine_compat_hack;
2816 Found a legacy Catalyst::Engine::PSGI .psgi file at ${psgi_file}.
2818 Its content has been ignored. Please consult the Catalyst::Upgrading
2819 documentation on how to upgrade from Catalyst::Engine::PSGI.
2823 return $app->apply_default_middlewares($app->psgi_app);
2826 =head2 $c->apply_default_middlewares
2828 Adds the following L<Plack> middlewares to your application, since they are
2829 useful and commonly needed:
2831 L<Plack::Middleware::ReverseProxy>, (conditionally added based on the status
2832 of your $ENV{REMOTE_ADDR}, and can be forced on with C<using_frontend_proxy>
2833 or forced off with C<ignore_frontend_proxy>), L<Plack::Middleware::LighttpdScriptNameFix>
2834 (if you are using Lighttpd), L<Plack::Middleware::IIS6ScriptNameFix> (always
2835 applied since this middleware is smart enough to conditionally apply itself).
2837 Additionally if we detect we are using Nginx, we add a bit of custom middleware
2838 to solve some problems with the way that server handles $ENV{PATH_INFO} and
2844 sub apply_default_middlewares {
2845 my ($app, $psgi_app) = @_;
2847 $psgi_app = Plack::Middleware::Conditional->wrap(
2849 builder => sub { Plack::Middleware::ReverseProxy->wrap($_[0]) },
2852 return if $app->config->{ignore_frontend_proxy};
2853 return $env->{REMOTE_ADDR} eq '127.0.0.1'
2854 || $app->config->{using_frontend_proxy};
2858 # If we're running under Lighttpd, swap PATH_INFO and SCRIPT_NAME
2859 # http://lists.scsys.co.uk/pipermail/catalyst/2006-June/008361.html
2860 $psgi_app = Plack::Middleware::Conditional->wrap(
2862 builder => sub { Plack::Middleware::LighttpdScriptNameFix->wrap($_[0]) },
2865 return unless $env->{SERVER_SOFTWARE} && $env->{SERVER_SOFTWARE} =~ m!lighttpd[-/]1\.(\d+\.\d+)!;
2866 return unless $1 < 4.23;
2871 # we're applying this unconditionally as the middleware itself already makes
2872 # sure it doesn't fuck things up if it's not running under one of the right
2874 $psgi_app = Plack::Middleware::IIS6ScriptNameFix->wrap($psgi_app);
2876 # And another IIS issue, this time with IIS7.
2877 $psgi_app = Plack::Middleware::Conditional->wrap(
2879 builder => sub { Plack::Middleware::IIS7KeepAliveFix->wrap($_[0]) },
2882 return $env->{SERVER_SOFTWARE} && $env->{SERVER_SOFTWARE} =~ m!IIS/7\.[0-9]!;
2891 Returns a PSGI application code reference for the catalyst application
2892 C<$c>. This is the bare application without any middlewares
2893 applied. C<${myapp}.psgi> is not taken into account.
2895 This is what you want to be using to retrieve the PSGI application code
2896 reference of your Catalyst application for use in F<.psgi> files.
2902 my $psgi = $app->engine->build_psgi_app($app);
2903 return $app->Catalyst::Utils::apply_registered_middleware($psgi);
2906 =head2 $c->setup_home
2908 Sets up the home directory.
2913 my ( $class, $home ) = @_;
2915 if ( my $env = Catalyst::Utils::env_value( $class, 'HOME' ) ) {
2919 $home ||= Catalyst::Utils::home($class);
2922 #I remember recently being scolded for assigning config values like this
2923 $class->config->{home} ||= $home;
2924 $class->config->{root} ||= Path::Class::Dir->new($home)->subdir('root');
2928 =head2 $c->setup_log
2930 Sets up log by instantiating a L<Catalyst::Log|Catalyst::Log> object and
2931 passing it to C<log()>. Pass in a comma-delimited list of levels to set the
2934 This method also installs a C<debug> method that returns a true value into the
2935 catalyst subclass if the "debug" level is passed in the comma-delimited list,
2936 or if the C<$CATALYST_DEBUG> environment variable is set to a true value.
2938 Note that if the log has already been setup, by either a previous call to
2939 C<setup_log> or by a call such as C<< __PACKAGE__->log( MyLogger->new ) >>,
2940 that this method won't actually set up the log object.
2945 my ( $class, $levels ) = @_;
2948 $levels =~ s/^\s+//;
2949 $levels =~ s/\s+$//;
2950 my %levels = map { $_ => 1 } split /\s*,\s*/, $levels;
2952 my $env_debug = Catalyst::Utils::env_value( $class, 'DEBUG' );
2953 if ( defined $env_debug ) {
2954 $levels{debug} = 1 if $env_debug; # Ugly!
2955 delete($levels{debug}) unless $env_debug;
2958 unless ( $class->log ) {
2959 $class->log( Catalyst::Log->new(keys %levels) );
2962 if ( $levels{debug} ) {
2963 Class::MOP::get_metaclass_by_name($class)->add_method('debug' => sub { 1 });
2964 $class->log->debug('Debug messages enabled');
2968 =head2 $c->setup_plugins
2974 =head2 $c->setup_stats
2976 Sets up timing statistics class.
2981 my ( $class, $stats ) = @_;
2983 Catalyst::Utils::ensure_class_loaded($class->stats_class);
2985 my $env = Catalyst::Utils::env_value( $class, 'STATS' );
2986 if ( defined($env) ? $env : ($stats || $class->debug ) ) {
2987 Class::MOP::get_metaclass_by_name($class)->add_method('use_stats' => sub { 1 });
2988 $class->log->debug('Statistics enabled');
2993 =head2 $c->registered_plugins
2995 Returns a sorted list of the plugins which have either been stated in the
2998 If passed a given plugin name, it will report a boolean value indicating
2999 whether or not that plugin is loaded. A fully qualified name is required if
3000 the plugin name does not begin with C<Catalyst::Plugin::>.
3002 if ($c->registered_plugins('Some::Plugin')) {
3010 sub registered_plugins {
3012 return sort keys %{ $proto->_plugins } unless @_;
3014 return 1 if exists $proto->_plugins->{$plugin};
3015 return exists $proto->_plugins->{"Catalyst::Plugin::$plugin"};
3018 sub _register_plugin {
3019 my ( $proto, $plugin, $instant ) = @_;
3020 my $class = ref $proto || $proto;
3022 load_class( $plugin );
3023 $class->log->warn( "$plugin inherits from 'Catalyst::Component' - this is deprecated and will not work in 5.81" )
3024 if $plugin->isa( 'Catalyst::Component' );
3025 my $plugin_meta = Moose::Meta::Class->create($plugin);
3026 if (!$plugin_meta->has_method('new')
3027 && ( $plugin->isa('Class::Accessor::Fast') || $plugin->isa('Class::Accessor') ) ) {
3028 $plugin_meta->add_method('new', Moose::Object->meta->get_method('new'))
3030 if (!$instant && !$proto->_plugins->{$plugin}) {
3031 my $meta = Class::MOP::get_metaclass_by_name($class);
3032 $meta->superclasses($plugin, $meta->superclasses);
3034 $proto->_plugins->{$plugin} = 1;
3038 sub _default_plugins { return qw(Unicode::Encoding) }
3041 my ( $class, $plugins ) = @_;
3043 $class->_plugins( {} ) unless $class->_plugins;
3045 m/Unicode::Encoding/ ? do {
3047 'Unicode::Encoding plugin is auto-applied,'
3048 . ' please remove this from your appclass'
3049 . ' and make sure to define "encoding" config'
3051 unless (exists $class->config->{'encoding'}) {
3052 $class->config->{'encoding'} = 'UTF-8';
3057 push @$plugins, $class->_default_plugins;
3058 $plugins = Data::OptList::mkopt($plugins || []);
3061 [ Catalyst::Utils::resolve_namespace(
3062 $class . '::Plugin',
3063 'Catalyst::Plugin', $_->[0]
3069 for my $plugin ( reverse @plugins ) {
3070 load_class($plugin->[0], $plugin->[1]);
3071 my $meta = find_meta($plugin->[0]);
3072 next if $meta && $meta->isa('Moose::Meta::Role');
3074 $class->_register_plugin($plugin->[0]);
3078 map { $_->[0]->name, $_->[1] }
3079 grep { blessed($_->[0]) && $_->[0]->isa('Moose::Meta::Role') }
3080 map { [find_meta($_->[0]), $_->[1]] }
3083 Moose::Util::apply_all_roles(
3089 =head2 registered_middlewares
3091 Read only accessor that returns an array of all the middleware in the order
3092 that they were added (which is the REVERSE of the order they will be applied).
3094 The values returned will be either instances of L<Plack::Middleware> or of a
3095 compatible interface, or a coderef, which is assumed to be inlined middleware
3097 =head2 setup_middleware (?@middleware)
3099 Read configuration information stored in configuration key C<psgi_middleware> or
3102 See under L</CONFIGURATION> information regarding C<psgi_middleware> and how
3103 to use it to enable L<Plack::Middleware>
3105 This method is automatically called during 'setup' of your application, so
3106 you really don't need to invoke it. However you may do so if you find the idea
3107 of loading middleware via configuration weird :). For example:
3113 __PACKAGE__->setup_middleware('Head');
3116 When we read middleware definitions from configuration, we reverse the list
3117 which sounds odd but is likely how you expect it to work if you have prior
3118 experience with L<Plack::Builder> or if you previously used the plugin
3119 L<Catalyst::Plugin::EnableMiddleware> (which is now considered deprecated)
3121 So basically your middleware handles an incoming request from the first
3122 registered middleware, down and handles the response from the last middleware
3127 sub registered_middlewares {
3129 if(my $middleware = $class->_psgi_middleware) {
3131 Plack::Middleware::HTTPExceptions->new,
3132 Plack::Middleware::RemoveRedundantBody->new,
3133 Plack::Middleware::FixMissingBodyInRedirect->new,
3134 Plack::Middleware::ContentLength->new,
3135 Plack::Middleware::MethodOverride->new,
3136 Plack::Middleware::Head->new,
3139 die "You cannot call ->registered_middlewares until middleware has been setup";
3143 sub setup_middleware {
3145 my @middleware_definitions = @_ ?
3146 reverse(@_) : reverse(@{$class->config->{'psgi_middleware'}||[]});
3148 my @middleware = ();
3149 while(my $next = shift(@middleware_definitions)) {
3151 if(Scalar::Util::blessed $next && $next->can('wrap')) {
3152 push @middleware, $next;
3153 } elsif(ref $next eq 'CODE') {
3154 push @middleware, $next;
3155 } elsif(ref $next eq 'HASH') {
3156 my $namespace = shift @middleware_definitions;
3157 my $mw = $class->Catalyst::Utils::build_middleware($namespace, %$next);
3158 push @middleware, $mw;
3160 die "I can't handle middleware definition ${\ref $next}";
3163 my $mw = $class->Catalyst::Utils::build_middleware($next);
3164 push @middleware, $mw;
3168 my @existing = @{$class->_psgi_middleware || []};
3169 $class->_psgi_middleware([@middleware,@existing,]);
3172 =head2 registered_data_handlers
3174 A read only copy of registered Data Handlers returned as a Hash, where each key
3175 is a content type and each value is a subref that attempts to decode that content
3178 =head2 setup_data_handlers (?@data_handler)
3180 Read configuration information stored in configuration key C<data_handlers> or
3183 See under L</CONFIGURATION> information regarding C<data_handlers>.
3185 This method is automatically called during 'setup' of your application, so
3186 you really don't need to invoke it.
3188 =head2 default_data_handlers
3190 Default Data Handlers that come bundled with L<Catalyst>. Currently there are
3191 only two default data handlers, for 'application/json' and an alternative to
3192 'application/x-www-form-urlencoded' which supposed nested form parameters via
3193 L<CGI::Struct> or via L<CGI::Struct::XS> IF you've installed it.
3195 The 'application/json' data handler is used to parse incoming JSON into a Perl
3196 data structure. It used either L<JSON::MaybeXS> or L<JSON>, depending on which
3197 is installed. This allows you to fail back to L<JSON:PP>, which is a Pure Perl
3198 JSON decoder, and has the smallest dependency impact.
3200 Because we don't wish to add more dependencies to L<Catalyst>, if you wish to
3201 use this new feature we recommend installing L<JSON> or L<JSON::MaybeXS> in
3202 order to get the best performance. You should add either to your dependency
3203 list (Makefile.PL, dist.ini, cpanfile, etc.)
3207 sub registered_data_handlers {
3209 if(my $data_handlers = $class->_data_handlers) {
3210 return %$data_handlers;
3212 die "You cannot call ->registered_data_handlers until data_handers has been setup";
3216 sub setup_data_handlers {
3217 my ($class, %data_handler_callbacks) = @_;
3218 %data_handler_callbacks = (
3219 %{$class->default_data_handlers},
3220 %{$class->config->{'data_handlers'}||+{}},
3221 %data_handler_callbacks);
3223 $class->_data_handlers(\%data_handler_callbacks);
3226 sub default_data_handlers {
3229 'application/x-www-form-urlencoded' => sub {
3230 my ($fh, $req) = @_;
3231 my $params = $req->_use_hash_multivalue ? $req->body_parameters->mixed : $req->body_parameters;
3232 Class::Load::load_first_existing_class('CGI::Struct::XS', 'CGI::Struct')
3233 ->can('build_cgi_struct')->($params);
3235 'application/json' => sub {
3236 Class::Load::load_first_existing_class('JSON::MaybeXS', 'JSON')
3237 ->can('decode_json')->(do { local $/; $_->getline });
3244 Returns an arrayref of the internal execution stack (actions that are
3245 currently executing).
3249 Returns the current timing statistics object. By default Catalyst uses
3250 L<Catalyst::Stats|Catalyst::Stats>, but can be set otherwise with
3251 L<< stats_class|/"$c->stats_class" >>.
3253 Even if L<< -Stats|/"-Stats" >> is not enabled, the stats object is still
3254 available. By enabling it with C< $c->stats->enabled(1) >, it can be used to
3255 profile explicitly, although MyApp.pm still won't profile nor output anything
3258 =head2 $c->stats_class
3260 Returns or sets the stats (timing statistics) class. L<Catalyst::Stats|Catalyst::Stats> is used by default.
3262 =head2 $c->use_stats
3264 Returns 1 when L<< stats collection|/"-Stats" >> is enabled.
3266 Note that this is a static method, not an accessor and should be overridden
3267 by declaring C<sub use_stats { 1 }> in your MyApp.pm, not by calling C<< $c->use_stats(1) >>.
3274 =head2 $c->write( $data )
3276 Writes $data to the output stream. When using this method directly, you
3277 will need to manually set the C<Content-Length> header to the length of
3278 your output data, if known.
3285 # Finalize headers if someone manually writes output (for compat)
3286 $c->finalize_headers;
3288 return $c->response->write( @_ );
3293 Returns the Catalyst version number. Mostly useful for "powered by"
3294 messages in template systems.
3298 sub version { return $Catalyst::VERSION }
3300 =head1 CONFIGURATION
3302 There are a number of 'base' config variables which can be set:
3308 C<default_model> - The default model picked if you say C<< $c->model >>. See L<< /$c->model($name) >>.
3312 C<default_view> - The default view to be rendered or returned when C<< $c->view >> is called. See L<< /$c->view($name) >>.
3316 C<disable_component_resolution_regex_fallback> - Turns
3317 off the deprecated component resolution functionality so
3318 that if any of the component methods (e.g. C<< $c->controller('Foo') >>)
3319 are called then regex search will not be attempted on string values and
3320 instead C<undef> will be returned.
3324 C<home> - The application home directory. In an uninstalled application,
3325 this is the top level application directory. In an installed application,
3326 this will be the directory containing C<< MyApp.pm >>.
3330 C<ignore_frontend_proxy> - See L</PROXY SUPPORT>
3334 C<name> - The name of the application in debug messages and the debug and
3339 C<parse_on_demand> - The request body (for example file uploads) will not be parsed
3340 until it is accessed. This allows you to (for example) check authentication (and reject
3341 the upload) before actually receiving all the data. See L</ON-DEMAND PARSER>
3345 C<root> - The root directory for templates. Usually this is just a
3346 subdirectory of the home directory, but you can set it to change the
3347 templates to a different directory.
3351 C<search_extra> - Array reference passed to Module::Pluggable to for additional
3352 namespaces from which components will be loaded (and constructed and stored in
3353 C<< $c->components >>).
3357 C<show_internal_actions> - If true, causes internal actions such as C<< _DISPATCH >>
3358 to be shown in hit debug tables in the test server.
3362 C<use_request_uri_for_path> - Controls if the C<REQUEST_URI> or C<PATH_INFO> environment
3363 variable should be used for determining the request path.
3365 Most web server environments pass the requested path to the application using environment variables,
3366 from which Catalyst has to reconstruct the request base (i.e. the top level path to / in the application,
3367 exposed as C<< $c->request->base >>) and the request path below that base.
3369 There are two methods of doing this, both of which have advantages and disadvantages. Which method is used
3370 is determined by the C<< $c->config(use_request_uri_for_path) >> setting (which can either be true or false).
3374 =item use_request_uri_for_path => 0
3376 This is the default (and the) traditional method that Catalyst has used for determining the path information.
3377 The path is generated from a combination of the C<PATH_INFO> and C<SCRIPT_NAME> environment variables.
3378 The allows the application to behave correctly when C<mod_rewrite> is being used to redirect requests
3379 into the application, as these variables are adjusted by mod_rewrite to take account for the redirect.
3381 However this method has the major disadvantage that it is impossible to correctly decode some elements
3382 of the path, as RFC 3875 says: "C<< Unlike a URI path, the PATH_INFO is not URL-encoded, and cannot
3383 contain path-segment parameters. >>" This means PATH_INFO is B<always> decoded, and therefore Catalyst
3384 can't distinguish / vs %2F in paths (in addition to other encoded values).
3386 =item use_request_uri_for_path => 1
3388 This method uses the C<REQUEST_URI> and C<SCRIPT_NAME> environment variables. As C<REQUEST_URI> is never
3389 decoded, this means that applications using this mode can correctly handle URIs including the %2F character
3390 (i.e. with C<AllowEncodedSlashes> set to C<On> in Apache).
3392 Given that this method of path resolution is provably more correct, it is recommended that you use
3393 this unless you have a specific need to deploy your application in a non-standard environment, and you are
3394 aware of the implications of not being able to handle encoded URI paths correctly.
3396 However it also means that in a number of cases when the app isn't installed directly at a path, but instead
3397 is having paths rewritten into it (e.g. as a .cgi/fcgi in a public_html directory, with mod_rewrite in a
3398 .htaccess file, or when SSI is used to rewrite pages into the app, or when sub-paths of the app are exposed
3399 at other URIs than that which the app is 'normally' based at with C<mod_rewrite>), the resolution of
3400 C<< $c->request->base >> will be incorrect.
3406 C<using_frontend_proxy> - See L</PROXY SUPPORT>.
3410 C<encoding> - See L</ENCODING>
3414 C<abort_chain_on_error_fix>
3416 When there is an error in an action chain, the default behavior is to continue
3417 processing the remaining actions and then catch the error upon chain end. This
3418 can lead to running actions when the application is in an unexpected state. If
3419 you have this issue, setting this config value to true will promptly exit a
3420 chain when there is an error raised in any action (thus terminating the chain
3425 __PACKAGE__->config(abort_chain_on_error_fix => 1);
3427 In the future this might become the default behavior.
3431 C<use_hash_multivalue_in_request>
3433 In L<Catalyst::Request> the methods C<query_parameters>, C<body_parametes>
3434 and C<parameters> return a hashref where values might be scalar or an arrayref
3435 depending on the incoming data. In many cases this can be undesirable as it
3436 leads one to writing defensive code like the following:
3438 my ($val) = ref($c->req->parameters->{a}) ?
3439 @{$c->req->parameters->{a}} :
3440 $c->req->parameters->{a};
3442 Setting this configuration item to true will make L<Catalyst> populate the
3443 attributes underlying these methods with an instance of L<Hash::MultiValue>
3444 which is used by L<Plack::Request> and others to solve this very issue. You
3445 may prefer this behavior to the default, if so enable this option (be warned
3446 if you enable it in a legacy application we are not sure if it is completely
3447 backwardly compatible).
3451 C<psgi_middleware> - See L<PSGI MIDDLEWARE>.
3455 C<data_handlers> - See L<DATA HANDLERS>.
3461 Generally when you throw an exception inside an Action (or somewhere in
3462 your stack, such as in a model that an Action is calling) that exception
3463 is caught by Catalyst and unless you either catch it yourself (via eval
3464 or something like L<Try::Tiny> or by reviewing the L</error> stack, it
3465 will eventually reach L</finalize_errors> and return either the debugging
3466 error stack page, or the default error page. However, if your exception
3467 can be caught by L<Plack::Middleware::HTTPExceptions>, L<Catalyst> will
3468 instead rethrow it so that it can be handled by that middleware (which
3469 is part of the default middleware). For example this would allow
3471 use HTTP::Throwable::Factory 'http_throw';
3473 sub throws_exception :Local {
3474 my ($self, $c) = @_;
3476 http_throw(SeeOther => { location =>
3477 $c->uri_for($self->action_for('redirect')) });
3481 =head1 INTERNAL ACTIONS
3483 Catalyst uses internal actions like C<_DISPATCH>, C<_BEGIN>, C<_AUTO>,
3484 C<_ACTION>, and C<_END>. These are by default not shown in the private
3485 action table, but you can make them visible with a config parameter.
3487 MyApp->config(show_internal_actions => 1);
3489 =head1 ON-DEMAND PARSER
3491 The request body is usually parsed at the beginning of a request,
3492 but if you want to handle input yourself, you can enable on-demand
3493 parsing with a config parameter.
3495 MyApp->config(parse_on_demand => 1);
3497 =head1 PROXY SUPPORT
3499 Many production servers operate using the common double-server approach,
3500 with a lightweight frontend web server passing requests to a larger
3501 backend server. An application running on the backend server must deal
3502 with two problems: the remote user always appears to be C<127.0.0.1> and
3503 the server's hostname will appear to be C<localhost> regardless of the
3504 virtual host that the user connected through.
3506 Catalyst will automatically detect this situation when you are running
3507 the frontend and backend servers on the same machine. The following
3508 changes are made to the request.
3510 $c->req->address is set to the user's real IP address, as read from
3511 the HTTP X-Forwarded-For header.
3513 The host value for $c->req->base and $c->req->uri is set to the real
3514 host, as read from the HTTP X-Forwarded-Host header.
3516 Additionally, you may be running your backend application on an insecure
3517 connection (port 80) while your frontend proxy is running under SSL. If there
3518 is a discrepancy in the ports, use the HTTP header C<X-Forwarded-Port> to
3519 tell Catalyst what port the frontend listens on. This will allow all URIs to
3520 be created properly.
3522 In the case of passing in:
3524 X-Forwarded-Port: 443
3526 All calls to C<uri_for> will result in an https link, as is expected.
3528 Obviously, your web server must support these headers for this to work.
3530 In a more complex server farm environment where you may have your
3531 frontend proxy server(s) on different machines, you will need to set a
3532 configuration option to tell Catalyst to read the proxied data from the
3535 MyApp->config(using_frontend_proxy => 1);
3537 If you do not wish to use the proxy support at all, you may set:
3539 MyApp->config(ignore_frontend_proxy => 0);
3541 =head2 Note about psgi files
3543 Note that if you supply your own .psgi file, calling
3544 C<< MyApp->psgi_app(@_); >>, then B<this will not happen automatically>.
3546 You either need to apply L<Plack::Middleware::ReverseProxy> yourself
3547 in your psgi, for example:
3550 enable "Plack::Middleware::ReverseProxy";
3554 This will unconditionally add the ReverseProxy support, or you need to call
3555 C<< $app = MyApp->apply_default_middlewares($app) >> (to conditionally
3556 apply the support depending upon your config).
3558 See L<Catalyst::PSGI> for more information.
3560 =head1 THREAD SAFETY
3562 Catalyst has been tested under Apache 2's threading C<mpm_worker>,
3563 C<mpm_winnt>, and the standalone forking HTTP server on Windows. We
3564 believe the Catalyst core to be thread-safe.
3566 If you plan to operate in a threaded environment, remember that all other
3567 modules you are using must also be thread-safe. Some modules, most notably
3568 L<DBD::SQLite>, are not thread-safe.
3570 =head1 DATA HANDLERS
3572 The L<Catalyst::Request> object uses L<HTTP::Body> to populate 'classic' HTML
3573 form parameters and URL search query fields. However it has become common
3574 for various alternative content types to be PUT or POSTed to your controllers
3575 and actions. People working on RESTful APIs, or using AJAX often use JSON,
3576 XML and other content types when communicating with an application server. In
3577 order to better support this use case, L<Catalyst> defines a global configuration
3578 option, C<data_handlers>, which lets you associate a content type with a coderef
3579 that parses that content type into something Perl can readily access.
3586 __PACKAGE__->config(
3588 'application/json' => sub { local $/; decode_json $_->getline },
3590 ## Any other configuration.
3595 By default L<Catalyst> comes with a generic JSON data handler similar to the
3596 example given above, which uses L<JSON::Maybe> to provide either L<JSON::PP>
3597 (a pure Perl, dependency free JSON parser) or L<Cpanel::JSON::XS> if you have
3598 it installed (if you want the faster XS parser, add it to you project Makefile.PL
3599 or dist.ini, cpanfile, etc.)
3601 The C<data_handlers> configuration is a hashref whose keys are HTTP Content-Types
3602 (matched against the incoming request type using a regexp such as to be case
3603 insensitive) and whose values are coderefs that receive a localized version of
3604 C<$_> which is a filehandle object pointing to received body.
3606 This feature is considered an early access release and we reserve the right
3607 to alter the interface in order to provide a performant and secure solution to
3608 alternative request body content. Your reports welcomed!
3610 =head1 PSGI MIDDLEWARE
3612 You can define middleware, defined as L<Plack::Middleware> or a compatible
3613 interface in configuration. Your middleware definitions are in the form of an
3614 arrayref under the configuration key C<psgi_middleware>. Here's an example
3615 with details to follow:
3620 use Plack::Middleware::StackTrace;
3622 my $stacktrace_middleware = Plack::Middleware::StackTrace->new;
3624 __PACKAGE__->config(
3625 'psgi_middleware', [
3628 $stacktrace_middleware,
3629 'Session' => {store => 'File'},
3634 $env->{myapp.customkey} = 'helloworld';
3643 So the general form is:
3645 __PACKAGE__->config(psgi_middleware => \@middleware_definitions);
3647 Where C<@middleware> is one or more of the following, applied in the REVERSE of
3648 the order listed (to make it function similarly to L<Plack::Builder>:
3650 Alternatively, you may also define middleware by calling the L</setup_middleware>
3657 __PACKAGE__->setup_middleware( \@middleware_definitions);
3660 In the case where you do both (use 'setup_middleware' and configuration) the
3661 package call to setup_middleware will be applied earlier (in other words its
3662 middleware will wrap closer to the application). Keep this in mind since in
3663 some cases the order of middleware is important.
3665 The two approaches are not exclusive.
3669 =item Middleware Object
3671 An already initialized object that conforms to the L<Plack::Middleware>
3674 my $stacktrace_middleware = Plack::Middleware::StackTrace->new;
3676 __PACKAGE__->config(
3677 'psgi_middleware', [
3678 $stacktrace_middleware,
3684 A coderef that is an inlined middleware:
3686 __PACKAGE__->config(
3687 'psgi_middleware', [
3692 if($env->{PATH_INFO} =~m/forced/) {
3694 ->new(file=>TestApp->path_to(qw/share static forced.txt/))
3697 return $app->($env);
3707 We assume the scalar refers to a namespace after normalizing it using the
3710 (1) If the scalar is prefixed with a "+" (as in C<+MyApp::Foo>) then the full string
3711 is assumed to be 'as is', and we just install and use the middleware.
3713 (2) If the scalar begins with "Plack::Middleware" or your application namespace
3714 (the package name of your Catalyst application subclass), we also assume then
3715 that it is a full namespace, and use it.
3717 (3) Lastly, we then assume that the scalar is a partial namespace, and attempt to
3718 resolve it first by looking for it under your application namespace (for example
3719 if you application is "MyApp::Web" and the scalar is "MyMiddleware", we'd look
3720 under "MyApp::Web::Middleware::MyMiddleware") and if we don't find it there, we
3721 will then look under the regular L<Plack::Middleware> namespace (i.e. for the
3722 previous we'd try "Plack::Middleware::MyMiddleware"). We look under your application
3723 namespace first to let you 'override' common L<Plack::Middleware> locally, should
3724 you find that a good idea.
3730 __PACKAGE__->config(
3731 'psgi_middleware', [
3732 'Debug', ## MyAppWeb::Middleware::Debug->wrap or Plack::Middleware::Debug->wrap
3733 'Plack::Middleware::Stacktrace', ## Plack::Middleware::Stacktrace->wrap
3734 '+MyApp::Custom', ## MyApp::Custom->wrap
3738 =item a scalar followed by a hashref
3740 Just like the previous, except the following C<HashRef> is used as arguments
3741 to initialize the middleware object.
3743 __PACKAGE__->config(
3744 'psgi_middleware', [
3745 'Session' => {store => 'File'},
3750 Please see L<PSGI> for more on middleware.
3754 On request, decodes all params from encoding into a sequence of
3755 logical characters. On response, encodes body into encoding.
3763 Returns an instance of an C<Encode> encoding
3765 print $c->encoding->name
3767 =item handle_unicode_encoding_exception ($exception_context)
3769 Method called when decoding process for a request fails.
3771 An C<$exception_context> hashref is provided to allow you to override the
3772 behaviour of your application when given data with incorrect encodings.
3774 The default method throws exceptions in the case of invalid request parameters
3775 (resulting in a 500 error), but ignores errors in upload filenames.
3777 The keys passed in the C<$exception_context> hash are:
3783 The value which was not able to be decoded.
3787 The exception received from L<Encode>.
3791 What type of data was being decoded. Valid values are (currently)
3792 C<params> - for request parameters / arguments / captures
3793 and C<uploads> - for request upload filenames.
3803 Join #catalyst on irc.perl.org.
3807 http://lists.scsys.co.uk/cgi-bin/mailman/listinfo/catalyst
3808 http://lists.scsys.co.uk/cgi-bin/mailman/listinfo/catalyst-dev
3812 http://catalyst.perl.org
3816 http://dev.catalyst.perl.org
3820 =head2 L<Task::Catalyst> - All you need to start with Catalyst
3822 =head2 L<Catalyst::Manual> - The Catalyst Manual
3824 =head2 L<Catalyst::Component>, L<Catalyst::Controller> - Base classes for components
3826 =head2 L<Catalyst::Engine> - Core engine
3828 =head2 L<Catalyst::Log> - Log class.
3830 =head2 L<Catalyst::Request> - Request object
3832 =head2 L<Catalyst::Response> - Response object
3834 =head2 L<Catalyst::Test> - The test suite.
3836 =head1 PROJECT FOUNDER
3838 sri: Sebastian Riedel <sri@cpan.org>
3844 acme: Leon Brocard <leon@astray.com>
3846 abraxxa: Alexander Hartmaier <abraxxa@cpan.org>
3850 Andrew Ford E<lt>A.Ford@ford-mason.co.ukE<gt>
3854 andyg: Andy Grundman <andy@hybridized.org>
3856 audreyt: Audrey Tang
3858 bricas: Brian Cassidy <bricas@cpan.org>
3860 Caelum: Rafael Kitover <rkitover@io.com>
3862 chansen: Christian Hansen
3864 chicks: Christopher Hicks
3866 Chisel Wright C<pause@herlpacker.co.uk>
3868 Danijel Milicevic C<me@danijel.de>
3870 David Kamholz E<lt>dkamholz@cpan.orgE<gt>
3872 David Naughton, C<naughton@umn.edu>
3876 dhoss: Devin Austin <dhoss@cpan.org>
3878 dkubb: Dan Kubb <dan.kubb-cpan@onautopilot.com>
3882 dwc: Daniel Westermann-Clark <danieltwc@cpan.org>
3884 esskar: Sascha Kiefer
3886 fireartist: Carl Franks <cfranks@cpan.org>
3888 frew: Arthur Axel "fREW" Schmidt <frioux@gmail.com>
3890 gabb: Danijel Milicevic
3894 Gavin Henry C<ghenry@perl.me.uk>
3898 groditi: Guillermo Roditi <groditi@gmail.com>
3900 hobbs: Andrew Rodland <andrew@cleverdomain.org>
3902 ilmari: Dagfinn Ilmari Mannsåker <ilmari@ilmari.org>
3904 jcamacho: Juan Camacho
3906 jester: Jesse Sheidlower C<jester@panix.com>
3908 jhannah: Jay Hannah <jay@jays.net>
3914 jon: Jon Schutz <jjschutz@cpan.org>
3916 Jonathan Rockway C<< <jrockway@cpan.org> >>
3918 Kieren Diment C<kd@totaldatasolution.com>
3920 konobi: Scott McWhirter <konobi@cpan.org>
3922 marcus: Marcus Ramberg <mramberg@cpan.org>
3924 miyagawa: Tatsuhiko Miyagawa <miyagawa@bulknews.net>
3926 mgrimes: Mark Grimes <mgrimes@cpan.org>
3928 mst: Matt S. Trout <mst@shadowcatsystems.co.uk>
3932 naughton: David Naughton
3934 ningu: David Kamholz <dkamholz@cpan.org>
3936 nothingmuch: Yuval Kogman <nothingmuch@woobling.org>
3938 numa: Dan Sully <daniel@cpan.org>
3944 omega: Andreas Marienborg
3946 Oleg Kostyuk <cub.uanic@gmail.com>
3948 phaylon: Robert Sedlacek <phaylon@dunkelheit.at>
3950 rafl: Florian Ragwitz <rafl@debian.org>
3952 random: Roland Lammel <lammel@cpan.org>
3954 Robert Sedlacek C<< <rs@474.at> >>
3956 SpiceMan: Marcel Montes
3960 szbalint: Balint Szilakszi <szbalint@cpan.org>
3962 t0m: Tomas Doran <bobtfish@bobtfish.net>
3966 vanstyn: Henry Van Styn <vanstyn@cpan.org>
3968 Viljo Marrandi C<vilts@yahoo.com>
3970 Will Hawes C<info@whawes.co.uk>
3972 willert: Sebastian Willert <willert@cpan.org>
3974 wreis: Wallace Reis <wreis@cpan.org>
3976 Yuval Kogman, C<nothingmuch@woobling.org>
3978 rainboxx: Matthias Dietrich, C<perl@rainboxx.de>
3980 dd070: Dhaval Dhanani <dhaval070@gmail.com>
3982 Upasana <me@upasana.me>
3986 Copyright (c) 2005-2014, the above named PROJECT FOUNDER and CONTRIBUTORS.
3990 This library is free software. You can redistribute it and/or modify it under
3991 the same terms as Perl itself.
3997 __PACKAGE__->meta->make_immutable;