4 use Moose::Meta::Class ();
5 extends 'Catalyst::Component';
6 use Moose::Util qw/find_meta/;
7 use namespace::clean -except => 'meta';
8 use Catalyst::Exception;
9 use Catalyst::Exception::Detach;
10 use Catalyst::Exception::Go;
12 use Catalyst::Request;
13 use Catalyst::Request::Upload;
14 use Catalyst::Response;
16 use Catalyst::Controller;
18 use Devel::InnerPackage ();
19 use Module::Pluggable::Object ();
20 use Text::SimpleTable ();
21 use Path::Class::Dir ();
22 use Path::Class::File ();
27 use Tree::Simple qw/use_weak_refs/;
28 use Tree::Simple::Visitor::FindByUID;
29 use Class::C3::Adopt::NEXT;
30 use List::MoreUtils qw/uniq/;
32 use String::RewritePrefix;
33 use Catalyst::EngineLoader;
35 use Carp qw/croak carp shortmess/;
38 use Moose::Util 'find_meta';
39 use Plack::Middleware::Conditional;
40 use Plack::Middleware::ReverseProxy;
41 use Plack::Middleware::IIS6ScriptNameFix;
42 use Plack::Middleware::IIS7KeepAliveFix;
43 use Plack::Middleware::LighttpdScriptNameFix;
44 use Plack::Middleware::ContentLength;
45 use Plack::Middleware::Head;
46 use Plack::Middleware::HTTPExceptions;
47 use Plack::Middleware::FixMissingBodyInRedirect;
48 use Plack::Middleware::MethodOverride;
49 use Plack::Middleware::RemoveRedundantBody;
50 use Catalyst::Middleware::Stash;
52 use Class::Load 'load_class';
54 BEGIN { require 5.008003; }
56 has stack => (is => 'ro', 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
120 _data_handlers trace_level trace_logger/;
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_002';
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' );
501 my $stash = Catalyst::Middleware::Stash->get($c->req->env);
503 my $new_stash = @_ > 1 ? {@_} : $_[0];
504 croak('stash takes a hash or hashref') unless ref $new_stash;
505 foreach my $key ( keys %$new_stash ) {
506 $stash->{$key} = $new_stash->{$key};
514 =head2 $c->error($error, ...)
516 =head2 $c->error($arrayref)
518 Returns an arrayref containing error messages. If Catalyst encounters an
519 error while processing a request, it stores the error in $c->error. This
520 method should only be used to store fatal error messages.
522 my @error = @{ $c->error };
526 $c->error('Something bad happened');
533 my $error = ref $_[0] eq 'ARRAY' ? $_[0] : [@_];
534 croak @$error unless ref $c;
535 push @{ $c->{error} }, @$error;
537 elsif ( defined $_[0] ) { $c->{error} = undef }
538 return $c->{error} || [];
544 Contains the return value of the last executed action.
545 Note that << $c->state >> operates in a scalar context which means that all
546 values it returns are scalar.
548 =head2 $c->clear_errors
550 Clear errors. You probably don't want to clear the errors unless you are
551 implementing a custom error screen.
553 This is equivalent to running
564 =head2 $c->has_errors
566 Returns true if you have errors
570 sub has_errors { scalar(@{shift->error}) ? 1:0 }
572 sub _comp_search_prefixes {
574 return map $c->components->{ $_ }, $c->_comp_names_search_prefixes(@_);
577 # search components given a name and some prefixes
578 sub _comp_names_search_prefixes {
579 my ( $c, $name, @prefixes ) = @_;
580 my $appclass = ref $c || $c;
581 my $filter = "^${appclass}::(" . join( '|', @prefixes ) . ')::';
582 $filter = qr/$filter/; # Compile regex now rather than once per loop
584 # map the original component name to the sub part that we will search against
585 my %eligible = map { my $n = $_; $n =~ s{^$appclass\::[^:]+::}{}; $_ => $n; }
586 grep { /$filter/ } keys %{ $c->components };
588 # undef for a name will return all
589 return keys %eligible if !defined $name;
591 my $query = $name->$_isa('Regexp') ? $name : qr/^$name$/i;
592 my @result = grep { $eligible{$_} =~ m{$query} } keys %eligible;
594 return @result if @result;
596 # if we were given a regexp to search against, we're done.
597 return if $name->$_isa('Regexp');
599 # skip regexp fallback if configured
601 if $appclass->config->{disable_component_resolution_regex_fallback};
605 @result = grep { $eligible{ $_ } =~ m{$query} } keys %eligible;
607 # no results? try against full names
609 @result = grep { m{$query} } keys %eligible;
612 # don't warn if we didn't find any results, it just might not exist
614 # Disgusting hack to work out correct method name
615 my $warn_for = lc $prefixes[0];
616 my $msg = "Used regexp fallback for \$c->${warn_for}('${name}'), which found '" .
617 (join '", "', @result) . "'. Relying on regexp fallback behavior for " .
618 "component resolution is unreliable and unsafe.";
619 my $short = $result[0];
620 # remove the component namespace prefix
621 $short =~ s/.*?(Model|Controller|View):://;
622 my $shortmess = Carp::shortmess('');
623 if ($shortmess =~ m#Catalyst/Plugin#) {
624 $msg .= " You probably need to set '$short' instead of '${name}' in this " .
626 } elsif ($shortmess =~ m#Catalyst/lib/(View|Controller)#) {
627 $msg .= " You probably need to set '$short' instead of '${name}' in this " .
628 "component's config";
630 $msg .= " You probably meant \$c->${warn_for}('$short') instead of \$c->${warn_for}('${name}'), " .
631 "but if you really wanted to search, pass in a regexp as the argument " .
632 "like so: \$c->${warn_for}(qr/${name}/)";
634 $c->log->warn( "${msg}$shortmess" );
640 # Find possible names for a prefix
642 my ( $c, @prefixes ) = @_;
643 my $appclass = ref $c || $c;
645 my $filter = "^${appclass}::(" . join( '|', @prefixes ) . ')::';
647 my @names = map { s{$filter}{}; $_; }
648 $c->_comp_names_search_prefixes( undef, @prefixes );
653 # Filter a component before returning by calling ACCEPT_CONTEXT if available
654 sub _filter_component {
655 my ( $c, $comp, @args ) = @_;
657 if ( eval { $comp->can('ACCEPT_CONTEXT'); } ) {
658 return $comp->ACCEPT_CONTEXT( $c, @args );
664 =head2 COMPONENT ACCESSORS
666 =head2 $c->controller($name)
668 Gets a L<Catalyst::Controller> instance by name.
670 $c->controller('Foo')->do_stuff;
672 If the name is omitted, will return the controller for the dispatched
675 If you want to search for controllers, pass in a regexp as the argument.
677 # find all controllers that start with Foo
678 my @foo_controllers = $c->controller(qr{^Foo});
684 my ( $c, $name, @args ) = @_;
686 my $appclass = ref($c) || $c;
688 unless ( $name->$_isa('Regexp') ) { # Direct component hash lookup to avoid costly regexps
689 my $comps = $c->components;
690 my $check = $appclass."::Controller::".$name;
691 return $c->_filter_component( $comps->{$check}, @args ) if exists $comps->{$check};
693 my @result = $c->_comp_search_prefixes( $name, qw/Controller C/ );
694 return map { $c->_filter_component( $_, @args ) } @result if ref $name;
695 return $c->_filter_component( $result[ 0 ], @args );
698 return $c->component( $c->action->class );
701 =head2 $c->model($name)
703 Gets a L<Catalyst::Model> instance by name.
705 $c->model('Foo')->do_stuff;
707 Any extra arguments are directly passed to ACCEPT_CONTEXT.
709 If the name is omitted, it will look for
710 - a model object in $c->stash->{current_model_instance}, then
711 - a model name in $c->stash->{current_model}, then
712 - a config setting 'default_model', or
713 - check if there is only one model, and return it if that's the case.
715 If you want to search for models, pass in a regexp as the argument.
717 # find all models that start with Foo
718 my @foo_models = $c->model(qr{^Foo});
723 my ( $c, $name, @args ) = @_;
724 my $appclass = ref($c) || $c;
726 unless ( $name->$_isa('Regexp') ) { # Direct component hash lookup to avoid costly regexps
727 my $comps = $c->components;
728 my $check = $appclass."::Model::".$name;
729 return $c->_filter_component( $comps->{$check}, @args ) if exists $comps->{$check};
731 my @result = $c->_comp_search_prefixes( $name, qw/Model M/ );
732 return map { $c->_filter_component( $_, @args ) } @result if ref $name;
733 return $c->_filter_component( $result[ 0 ], @args );
737 return $c->stash->{current_model_instance}
738 if $c->stash->{current_model_instance};
739 return $c->model( $c->stash->{current_model} )
740 if $c->stash->{current_model};
742 return $c->model( $appclass->config->{default_model} )
743 if $appclass->config->{default_model};
745 my( $comp, $rest ) = $c->_comp_search_prefixes( undef, qw/Model M/);
748 $c->log->warn( Carp::shortmess('Calling $c->model() will return a random model unless you specify one of:') );
749 $c->log->warn( '* $c->config(default_model => "the name of the default model to use")' );
750 $c->log->warn( '* $c->stash->{current_model} # the name of the model to use for this request' );
751 $c->log->warn( '* $c->stash->{current_model_instance} # the instance of the model to use for this request' );
752 $c->log->warn( 'NB: in version 5.81, the "random" behavior will not work at all.' );
755 return $c->_filter_component( $comp );
759 =head2 $c->view($name)
761 Gets a L<Catalyst::View> instance by name.
763 $c->view('Foo')->do_stuff;
765 Any extra arguments are directly passed to ACCEPT_CONTEXT.
767 If the name is omitted, it will look for
768 - a view object in $c->stash->{current_view_instance}, then
769 - a view name in $c->stash->{current_view}, then
770 - a config setting 'default_view', or
771 - check if there is only one view, and return it if that's the case.
773 If you want to search for views, pass in a regexp as the argument.
775 # find all views that start with Foo
776 my @foo_views = $c->view(qr{^Foo});
781 my ( $c, $name, @args ) = @_;
783 my $appclass = ref($c) || $c;
785 unless ( $name->$_isa('Regexp') ) { # Direct component hash lookup to avoid costly regexps
786 my $comps = $c->components;
787 my $check = $appclass."::View::".$name;
788 if( exists $comps->{$check} ) {
789 return $c->_filter_component( $comps->{$check}, @args );
792 $c->log->warn( "Attempted to use view '$check', but does not exist" );
795 my @result = $c->_comp_search_prefixes( $name, qw/View V/ );
796 return map { $c->_filter_component( $_, @args ) } @result if ref $name;
797 return $c->_filter_component( $result[ 0 ], @args );
801 return $c->stash->{current_view_instance}
802 if $c->stash->{current_view_instance};
803 return $c->view( $c->stash->{current_view} )
804 if $c->stash->{current_view};
806 return $c->view( $appclass->config->{default_view} )
807 if $appclass->config->{default_view};
809 my( $comp, $rest ) = $c->_comp_search_prefixes( undef, qw/View V/);
812 $c->log->warn( 'Calling $c->view() will return a random view unless you specify one of:' );
813 $c->log->warn( '* $c->config(default_view => "the name of the default view to use")' );
814 $c->log->warn( '* $c->stash->{current_view} # the name of the view to use for this request' );
815 $c->log->warn( '* $c->stash->{current_view_instance} # the instance of the view to use for this request' );
816 $c->log->warn( 'NB: in version 5.81, the "random" behavior will not work at all.' );
819 return $c->_filter_component( $comp );
822 =head2 $c->controllers
824 Returns the available names which can be passed to $c->controller
830 return $c->_comp_names(qw/Controller C/);
835 Returns the available names which can be passed to $c->model
841 return $c->_comp_names(qw/Model M/);
847 Returns the available names which can be passed to $c->view
853 return $c->_comp_names(qw/View V/);
856 =head2 $c->comp($name)
858 =head2 $c->component($name)
860 Gets a component object by name. This method is not recommended,
861 unless you want to get a specific component by full
862 class. C<< $c->controller >>, C<< $c->model >>, and C<< $c->view >>
863 should be used instead.
865 If C<$name> is a regexp, a list of components matched against the full
866 component name will be returned.
868 If Catalyst can't find a component by name, it will fallback to regex
869 matching by default. To disable this behaviour set
870 disable_component_resolution_regex_fallback to a true value.
872 __PACKAGE__->config( disable_component_resolution_regex_fallback => 1 );
877 my ( $c, $name, @args ) = @_;
880 my $comps = $c->components;
883 # is it the exact name?
884 return $c->_filter_component( $comps->{ $name }, @args )
885 if exists $comps->{ $name };
887 # perhaps we just omitted "MyApp"?
888 my $composed = ( ref $c || $c ) . "::${name}";
889 return $c->_filter_component( $comps->{ $composed }, @args )
890 if exists $comps->{ $composed };
892 # search all of the models, views and controllers
893 my( $comp ) = $c->_comp_search_prefixes( $name, qw/Model M Controller C View V/ );
894 return $c->_filter_component( $comp, @args ) if $comp;
898 if $c->config->{disable_component_resolution_regex_fallback};
900 # This is here so $c->comp( '::M::' ) works
901 my $query = ref $name ? $name : qr{$name}i;
903 my @result = grep { m{$query} } keys %{ $c->components };
904 return map { $c->_filter_component( $_, @args ) } @result if ref $name;
907 $c->log->warn( Carp::shortmess(qq(Found results for "${name}" using regexp fallback)) );
908 $c->log->warn( 'Relying on the regexp fallback behavior for component resolution' );
909 $c->log->warn( 'is unreliable and unsafe. You have been warned' );
910 return $c->_filter_component( $result[ 0 ], @args );
913 # I would expect to return an empty list here, but that breaks back-compat
917 return sort keys %{ $c->components };
920 =head2 CLASS DATA AND HELPER CLASSES
924 Returns or takes a hashref containing the application's configuration.
926 __PACKAGE__->config( { db => 'dsn:SQLite:foo.db' } );
928 You can also use a C<YAML>, C<XML> or L<Config::General> config file
929 like C<myapp.conf> in your applications home directory. See
930 L<Catalyst::Plugin::ConfigLoader>.
932 =head3 Cascading configuration
934 The config method is present on all Catalyst components, and configuration
935 will be merged when an application is started. Configuration loaded with
936 L<Catalyst::Plugin::ConfigLoader> takes precedence over other configuration,
937 followed by configuration in your top level C<MyApp> class. These two
938 configurations are merged, and then configuration data whose hash key matches a
939 component name is merged with configuration for that component.
941 The configuration for a component is then passed to the C<new> method when a
942 component is constructed.
946 MyApp->config({ 'Model::Foo' => { bar => 'baz', overrides => 'me' } });
947 MyApp::Model::Foo->config({ quux => 'frob', overrides => 'this' });
949 will mean that C<MyApp::Model::Foo> receives the following data when
952 MyApp::Model::Foo->new({
958 It's common practice to use a Moose attribute
959 on the receiving component to access the config value.
961 package MyApp::Model::Foo;
965 # this attr will receive 'baz' at construction time
971 You can then get the value 'baz' by calling $c->model('Foo')->bar
972 (or $self->bar inside code in the model).
974 B<NOTE:> you MUST NOT call C<< $self->config >> or C<< __PACKAGE__->config >>
975 as a way of reading config within your code, as this B<will not> give you the
976 correctly merged config back. You B<MUST> take the config values supplied to
977 the constructor and use those instead.
981 around config => sub {
985 croak('Setting config after setup has been run is not allowed.')
986 if ( @_ and $c->setup_finished );
993 Returns the logging object instance. Unless it is already set, Catalyst
994 sets this up with a L<Catalyst::Log> object. To use your own log class,
995 set the logger with the C<< __PACKAGE__->log >> method prior to calling
996 C<< __PACKAGE__->setup >>.
998 __PACKAGE__->log( MyLogger->new );
1003 $c->log->info( 'Now logging with my own logger!' );
1005 Your log class should implement the methods described in
1011 Returns 1 if debug mode is enabled, 0 otherwise.
1013 You can enable debug mode in several ways:
1017 =item By calling myapp_server.pl with the -d flag
1019 =item With the environment variables MYAPP_DEBUG, or CATALYST_DEBUG
1021 =item The -Debug option in your MyApp.pm
1023 =item By declaring C<sub debug { 1 }> in your MyApp.pm.
1027 The first three also set the log level to 'debug'.
1029 Calling C<< $c->debug(1) >> has no effect.
1035 =head2 $c->dispatcher
1037 Returns the dispatcher instance. See L<Catalyst::Dispatcher>.
1041 Returns the engine instance. See L<Catalyst::Engine>.
1044 =head2 UTILITY METHODS
1046 =head2 $c->path_to(@path)
1048 Merges C<@path> with C<< $c->config->{home} >> and returns a
1049 L<Path::Class::Dir> object. Note you can usually use this object as
1050 a filename, but sometimes you will have to explicitly stringify it
1051 yourself by calling the C<< ->stringify >> method.
1055 $c->path_to( 'db', 'sqlite.db' );
1060 my ( $c, @path ) = @_;
1061 my $path = Path::Class::Dir->new( $c->config->{home}, @path );
1062 if ( -d $path ) { return $path }
1063 else { return Path::Class::File->new( $c->config->{home}, @path ) }
1067 my ( $class, $name, $plugin, @args ) = @_;
1069 # See block comment in t/unit_core_plugin.t
1070 $class->log->warn(qq/Adding plugin using the ->plugin method is deprecated, and will be removed in a future release/);
1072 $class->_register_plugin( $plugin, 1 );
1074 eval { $plugin->import };
1075 $class->mk_classdata($name);
1077 eval { $obj = $plugin->new(@args) };
1080 Catalyst::Exception->throw( message =>
1081 qq/Couldn't instantiate instant plugin "$plugin", "$@"/ );
1084 $class->$name($obj);
1085 $class->log->debug(qq/Initialized instant plugin "$plugin" as "$name"/)
1091 Initializes the dispatcher and engine, loads any plugins, and loads the
1092 model, view, and controller components. You may also specify an array
1093 of plugins to load here, if you choose to not load them in the C<use
1097 MyApp->setup( qw/-Debug/ );
1099 B<Note:> You B<should not> wrap this method with method modifiers
1100 or bad things will happen - wrap the C<setup_finalize> method instead.
1105 my ( $class, @arguments ) = @_;
1106 croak('Running setup more than once')
1107 if ( $class->setup_finished );
1109 unless ( $class->isa('Catalyst') ) {
1111 Catalyst::Exception->throw(
1112 message => qq/'$class' does not inherit from Catalyst/ );
1115 if ( $class->arguments ) {
1116 @arguments = ( @arguments, @{ $class->arguments } );
1122 foreach (@arguments) {
1126 ( $flags->{log} ) ? 'debug,' . $flags->{log} : 'debug';
1128 elsif (/^-(\w+)=?(.*)$/) {
1129 $flags->{ lc $1 } = $2;
1132 push @{ $flags->{plugins} }, $_;
1136 $class->setup_home( delete $flags->{home} );
1138 $class->setup_log( delete $flags->{log} );
1139 $class->setup_plugins( delete $flags->{plugins} );
1140 $class->setup_trace();
1142 $class->setup_data_handlers();
1143 $class->setup_dispatcher( delete $flags->{dispatcher} );
1144 if (my $engine = delete $flags->{engine}) {
1145 $class->log->warn("Specifying the engine in ->setup is no longer supported, see Catalyst::Upgrading");
1147 $class->setup_engine();
1148 $class->setup_stats( delete $flags->{stats} );
1150 for my $flag ( sort keys %{$flags} ) {
1152 if ( my $code = $class->can( 'setup_' . $flag ) ) {
1153 &$code( $class, delete $flags->{$flag} );
1156 $class->log->warn(qq/Unknown flag "$flag"/);
1160 eval { require Catalyst::Devel; };
1161 if( !$@ && $ENV{CATALYST_SCRIPT_GEN} && ( $ENV{CATALYST_SCRIPT_GEN} < $Catalyst::Devel::CATALYST_SCRIPT_GEN ) ) {
1162 $class->log->warn(<<"EOF");
1163 You are running an old script!
1165 Please update by running (this will overwrite existing files):
1166 catalyst.pl -force -scripts $class
1168 or (this will not overwrite existing files):
1169 catalyst.pl -scripts $class
1174 # Call plugins setup, this is stupid and evil.
1175 # Also screws C3 badly on 5.10, hack to avoid.
1177 no warnings qw/redefine/;
1178 local *setup = sub { };
1179 $class->setup unless $Catalyst::__AM_RESTARTING;
1182 $class->setup_middleware();
1184 # Initialize our data structure
1185 $class->components( {} );
1187 $class->setup_components;
1189 if ( $class->debug ) {
1190 my @plugins = map { "$_ " . ( $_->VERSION || '' ) } $class->registered_plugins;
1193 my $column_width = Catalyst::Utils::term_width() - 6;
1194 my $t = Text::SimpleTable->new($column_width);
1195 $t->row($_) for @plugins;
1196 $class->log->debug( "Loaded plugins:\n" . $t->draw . "\n" );
1199 my @middleware = map {
1202 (ref($_) .' '. ($_->can('VERSION') ? $_->VERSION || '' : '')
1203 || '') } $class->registered_middlewares;
1206 my $column_width = Catalyst::Utils::term_width() - 6;
1207 my $t = Text::SimpleTable->new($column_width);
1208 $t->row($_) for @middleware;
1209 $class->log->debug( "Loaded PSGI Middleware:\n" . $t->draw . "\n" );
1212 my %dh = $class->registered_data_handlers;
1213 if (my @data_handlers = keys %dh) {
1214 my $column_width = Catalyst::Utils::term_width() - 6;
1215 my $t = Text::SimpleTable->new($column_width);
1216 $t->row($_) for @data_handlers;
1217 $class->log->debug( "Loaded Request Data Handlers:\n" . $t->draw . "\n" );
1220 my $dispatcher = $class->dispatcher;
1221 my $engine = $class->engine;
1222 my $home = $class->config->{home};
1224 $class->log->debug(sprintf(q/Loaded dispatcher "%s"/, blessed($dispatcher)));
1225 $class->log->debug(sprintf(q/Loaded engine "%s"/, blessed($engine)));
1229 ? $class->log->debug(qq/Found home "$home"/)
1230 : $class->log->debug(qq/Home "$home" doesn't exist/)
1231 : $class->log->debug(q/Couldn't find home/);
1233 my $column_width = Catalyst::Utils::term_width() - 8 - 9;
1234 my $t = Text::SimpleTable->new( [ $column_width, 'Class' ], [ 8, 'Type' ] );
1235 for my $comp ( sort keys %{ $class->components } ) {
1236 my $type = ref $class->components->{$comp} ? 'instance' : 'class';
1237 $t->row( $comp, $type );
1239 $class->log->debug( "Loaded components:\n" . $t->draw . "\n" )
1240 if ( keys %{ $class->components } );
1243 # Add our self to components, since we are also a component
1244 if( $class->isa('Catalyst::Controller') ){
1245 $class->components->{$class} = $class;
1248 $class->setup_actions;
1250 if ( $class->debug ) {
1251 my $name = $class->config->{name} || 'Application';
1252 $class->log->info("$name powered by Catalyst $Catalyst::VERSION");
1255 if ($class->config->{case_sensitive}) {
1256 $class->log->warn($class . "->config->{case_sensitive} is set.");
1257 $class->log->warn("This setting is deprecated and planned to be removed in Catalyst 5.81.");
1260 $class->setup_finalize;
1262 # Flush the log for good measure (in case something turned off 'autoflush' early)
1263 $class->log->_flush() if $class->log->can('_flush');
1265 return $class || 1; # Just in case someone named their Application 0...
1268 =head2 $app->setup_finalize
1270 A hook to attach modifiers to. This method does not do anything except set the
1271 C<setup_finished> accessor.
1273 Applying method modifiers to the C<setup> method doesn't work, because of quirky things done for plugin setup.
1277 after setup_finalize => sub {
1285 sub setup_finalize {
1287 $class->setup_finished(1);
1290 =head2 $c->uri_for( $path?, @args?, \%query_values? )
1292 =head2 $c->uri_for( $action, \@captures?, @args?, \%query_values? )
1294 Constructs an absolute L<URI> object based on the application root, the
1295 provided path, and the additional arguments and query parameters provided.
1296 When used as a string, provides a textual URI. If you need more flexibility
1297 than this (i.e. the option to provide relative URIs etc.) see
1298 L<Catalyst::Plugin::SmartURI>.
1300 If no arguments are provided, the URI for the current action is returned.
1301 To return the current action and also provide @args, use
1302 C<< $c->uri_for( $c->action, @args ) >>.
1304 If the first argument is a string, it is taken as a public URI path relative
1305 to C<< $c->namespace >> (if it doesn't begin with a forward slash) or
1306 relative to the application root (if it does). It is then merged with
1307 C<< $c->request->base >>; any C<@args> are appended as additional path
1308 components; and any C<%query_values> are appended as C<?foo=bar> parameters.
1310 If the first argument is a L<Catalyst::Action> it represents an action which
1311 will have its path resolved using C<< $c->dispatcher->uri_for_action >>. The
1312 optional C<\@captures> argument (an arrayref) allows passing the captured
1313 variables that are needed to fill in the paths of Chained and Regex actions;
1314 once the path is resolved, C<uri_for> continues as though a path was
1315 provided, appending any arguments or parameters and creating an absolute
1318 The captures for the current request can be found in
1319 C<< $c->request->captures >>, and actions can be resolved using
1320 C<< Catalyst::Controller->action_for($name) >>. If you have a private action
1321 path, use C<< $c->uri_for_action >> instead.
1323 # Equivalent to $c->req->uri
1324 $c->uri_for($c->action, $c->req->captures,
1325 @{ $c->req->args }, $c->req->params);
1327 # For the Foo action in the Bar controller
1328 $c->uri_for($c->controller('Bar')->action_for('Foo'));
1330 # Path to a static resource
1331 $c->uri_for('/static/images/logo.png');
1336 my ( $c, $path, @args ) = @_;
1338 if ( $path->$_isa('Catalyst::Controller') ) {
1339 $path = $path->path_prefix;
1344 undef($path) if (defined $path && $path eq '');
1347 ( scalar @args && ref $args[$#args] eq 'HASH' ? pop @args : {} );
1349 carp "uri_for called with undef argument" if grep { ! defined $_ } @args;
1350 foreach my $arg (@args) {
1351 utf8::encode($arg) if utf8::is_utf8($arg);
1352 $arg =~ s/([^$URI::uric])/$URI::Escape::escapes{$1}/go;
1355 if ( $path->$_isa('Catalyst::Action') ) { # action object
1356 s|/|%2F|g for @args;
1357 my $captures = [ map { s|/|%2F|g; $_; }
1358 ( scalar @args && ref $args[0] eq 'ARRAY'
1362 foreach my $capture (@$captures) {
1363 utf8::encode($capture) if utf8::is_utf8($capture);
1364 $capture =~ s/([^$URI::uric])/$URI::Escape::escapes{$1}/go;
1368 # ->uri_for( $action, \@captures_and_args, \%query_values? )
1369 if( !@args && $action->number_of_args ) {
1370 my $expanded_action = $c->dispatcher->expand_action( $action );
1372 my $num_captures = $expanded_action->number_of_captures;
1373 unshift @args, splice @$captures, $num_captures;
1376 $path = $c->dispatcher->uri_for_action($action, $captures);
1377 if (not defined $path) {
1378 $c->log->debug(qq/Can't find uri_for action '$action' @$captures/)
1382 $path = '/' if $path eq '';
1385 unshift(@args, $path);
1387 unless (defined $path && $path =~ s!^/!!) { # in-place strip
1388 my $namespace = $c->namespace;
1389 if (defined $path) { # cheesy hack to handle path '../foo'
1390 $namespace =~ s{(?:^|/)[^/]+$}{} while $args[0] =~ s{^\.\./}{};
1392 unshift(@args, $namespace || '');
1395 # join args with '/', or a blank string
1396 my $args = join('/', grep { defined($_) } @args);
1397 $args =~ s/\?/%3F/g; # STUPID STUPID SPECIAL CASE
1400 my ($base, $class) = ('/', 'URI::_generic');
1402 $base = $c->req->base;
1403 $class = ref($base);
1404 $base =~ s{(?<!/)$}{/};
1409 if (my @keys = keys %$params) {
1410 # somewhat lifted from URI::_query's query_form
1411 $query = '?'.join('&', map {
1412 my $val = $params->{$_};
1413 s/([;\/?:@&=+,\$\[\]%])/$URI::Escape::escapes{$1}/go;
1416 $val = '' unless defined $val;
1419 utf8::encode( $param ) if utf8::is_utf8($param);
1420 # using the URI::Escape pattern here so utf8 chars survive
1421 $param =~ s/([^A-Za-z0-9\-_.!~*'() ])/$URI::Escape::escapes{$1}/go;
1423 "${key}=$param"; } ( ref $val eq 'ARRAY' ? @$val : $val ));
1427 my $res = bless(\"${base}${args}${query}", $class);
1431 =head2 $c->uri_for_action( $path, \@captures_and_args?, @args?, \%query_values? )
1433 =head2 $c->uri_for_action( $action, \@captures_and_args?, @args?, \%query_values? )
1439 A private path to the Catalyst action you want to create a URI for.
1441 This is a shortcut for calling C<< $c->dispatcher->get_action_by_path($path)
1442 >> and passing the resulting C<$action> and the remaining arguments to C<<
1445 You can also pass in a Catalyst::Action object, in which case it is passed to
1448 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.
1450 For example, if the action looks like:
1452 package MyApp::Controller::Users;
1454 sub lst : Path('the-list') {}
1458 $c->uri_for_action('/users/lst')
1460 and it will create the URI /users/the-list.
1462 =item \@captures_and_args?
1464 Optional array reference of Captures (i.e. C<<CaptureArgs or $c->req->captures>)
1465 and arguments to the request. Usually used with L<Catalyst::DispatchType::Chained>
1466 to interpolate all the parameters in the URI.
1470 Optional list of extra arguments - can be supplied in the
1471 C<< \@captures_and_args? >> array ref, or here - whichever is easier for your
1474 Your action can have zero, a fixed or a variable number of args (e.g.
1475 C<< Args(1) >> for a fixed number or C<< Args() >> for a variable number)..
1477 =item \%query_values?
1479 Optional array reference of query parameters to append. E.g.
1485 /rest/of/your/uri?foo=bar
1491 sub uri_for_action {
1492 my ( $c, $path, @args ) = @_;
1493 my $action = blessed($path)
1495 : $c->dispatcher->get_action_by_path($path);
1496 unless (defined $action) {
1497 croak "Can't find action for path '$path'";
1499 return $c->uri_for( $action, @args );
1502 =head2 $c->welcome_message
1504 Returns the Catalyst welcome HTML page.
1508 sub welcome_message {
1510 my $name = $c->config->{name};
1511 my $logo = $c->uri_for('/static/images/catalyst_logo.png');
1512 my $prefix = Catalyst::Utils::appprefix( ref $c );
1513 $c->response->content_type('text/html; charset=utf-8');
1515 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
1516 "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
1517 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
1519 <meta http-equiv="Content-Language" content="en" />
1520 <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
1521 <title>$name on Catalyst $VERSION</title>
1522 <style type="text/css">
1525 background-color: #eee;
1532 margin-bottom: 10px;
1534 background-color: #ccc;
1535 border: 1px solid #aaa;
1540 font-family: verdana, tahoma, sans-serif;
1543 font-family: verdana, tahoma, sans-serif;
1546 text-decoration: none;
1548 border-bottom: 1px dotted #bbb;
1550 :link:hover, :visited:hover {
1563 background-color: #fff;
1564 border: 1px solid #aaa;
1568 font-weight: normal;
1590 <h1><span id="appname">$name</span> on <a href="http://catalyst.perl.org">Catalyst</a>
1595 <img src="$logo" alt="Catalyst Logo" />
1597 <p>Welcome to the world of Catalyst.
1598 This <a href="http://en.wikipedia.org/wiki/MVC">MVC</a>
1599 framework will make web development something you had
1600 never expected it to be: Fun, rewarding, and quick.</p>
1601 <h2>What to do now?</h2>
1602 <p>That really depends on what <b>you</b> want to do.
1603 We do, however, provide you with a few starting points.</p>
1604 <p>If you want to jump right into web development with Catalyst
1605 you might want to start with a tutorial.</p>
1606 <pre>perldoc <a href="https://metacpan.org/module/Catalyst::Manual::Tutorial">Catalyst::Manual::Tutorial</a></code>
1608 <p>Afterwards you can go on to check out a more complete look at our features.</p>
1610 <code>perldoc <a href="https://metacpan.org/module/Catalyst::Manual::Intro">Catalyst::Manual::Intro</a>
1611 <!-- Something else should go here, but the Catalyst::Manual link seems unhelpful -->
1613 <h2>What to do next?</h2>
1614 <p>Next it's time to write an actual application. Use the
1615 helper scripts to generate <a href="https://metacpan.org/search?q=Catalyst%3A%3AController">controllers</a>,
1616 <a href="https://metacpan.org/search?q=Catalyst%3A%3AModel">models</a>, and
1617 <a href="https://metacpan.org/search?q=Catalyst%3A%3AView">views</a>;
1618 they can save you a lot of work.</p>
1619 <pre><code>script/${prefix}_create.pl --help</code></pre>
1620 <p>Also, be sure to check out the vast and growing
1621 collection of <a href="http://search.cpan.org/search?query=Catalyst">plugins for Catalyst on CPAN</a>;
1622 you are likely to find what you need there.
1626 <p>Catalyst has a very active community. Here are the main places to
1627 get in touch with us.</p>
1630 <a href="http://dev.catalyst.perl.org">Wiki</a>
1633 <a href="http://lists.scsys.co.uk/cgi-bin/mailman/listinfo/catalyst">Mailing-List</a>
1636 <a href="irc://irc.perl.org/catalyst">IRC channel #catalyst on irc.perl.org</a>
1639 <h2>In conclusion</h2>
1640 <p>The Catalyst team hopes you will enjoy using Catalyst as much
1641 as we enjoyed making it. Please contact us if you have ideas
1642 for improvement or other feedback.</p>
1652 Contains a hash of options passed from the application script, including
1653 the original ARGV the script received, the processed values from that
1654 ARGV and any extra arguments to the script which were not processed.
1656 This can be used to add custom options to your application's scripts
1657 and setup your application differently depending on the values of these
1660 =head1 INTERNAL METHODS
1662 These methods are not meant to be used by end users.
1664 =head2 $c->components
1666 Returns a hash of components.
1668 =head2 $c->context_class
1670 Returns or sets the context class.
1674 Returns a hashref containing coderefs and execution counts (needed for
1675 deep recursion detection).
1679 Returns the number of actions on the current internal execution stack.
1683 Dispatches a request to actions.
1687 sub dispatch { my $c = shift; $c->dispatcher->dispatch( $c, @_ ) }
1689 =head2 $c->dispatcher_class
1691 Returns or sets the dispatcher class.
1693 =head2 $c->dump_these
1695 Returns a list of 2-element array references (name, structure) pairs
1696 that will be dumped on the error page in debug mode.
1702 [ Request => $c->req ],
1703 [ Response => $c->res ],
1704 [ Stash => $c->stash ],
1705 [ Config => $c->config ];
1708 =head2 $c->engine_class
1710 Returns or sets the engine class.
1712 =head2 $c->execute( $class, $coderef )
1714 Execute a coderef in given class and catch exceptions. Errors are available
1720 my ( $c, $class, $code ) = @_;
1721 $class = $c->component($class) || $class;
1724 if ( $c->depth >= $RECURSION ) {
1725 my $action = $code->reverse();
1726 $action = "/$action" unless $action =~ /->/;
1727 my $error = qq/Deep recursion detected calling "${action}"/;
1728 $c->log->error($error);
1734 my $stats_info = $c->_stats_start_execute( $code ) if $c->use_stats;
1736 push( @{ $c->stack }, $code );
1738 no warnings 'recursion';
1739 # N.B. This used to be combined, but I have seen $c get clobbered if so, and
1740 # I have no idea how, ergo $ret (which appears to fix the issue)
1741 eval { my $ret = $code->execute( $class, $c, @{ $c->req->args } ) || 0; $c->state( $ret ) };
1743 $c->_stats_finish_execute( $stats_info ) if $c->use_stats and $stats_info;
1745 my $last = pop( @{ $c->stack } );
1747 if ( my $error = $@ ) {
1748 #rethow if this can be handled by middleware
1749 if(blessed $error && ($error->can('as_psgi') || $error->can('code'))) {
1750 foreach my $err (@{$c->error}) {
1751 $c->log->error($err);
1754 $c->log->_flush if $c->log->can('_flush');
1756 $error->can('rethrow') ? $error->rethrow : croak $error;
1758 if ( blessed($error) and $error->isa('Catalyst::Exception::Detach') ) {
1759 $error->rethrow if $c->depth > 1;
1761 elsif ( blessed($error) and $error->isa('Catalyst::Exception::Go') ) {
1762 $error->rethrow if $c->depth > 0;
1765 unless ( ref $error ) {
1766 no warnings 'uninitialized';
1768 my $class = $last->class;
1769 my $name = $last->name;
1770 $error = qq/Caught exception in $class->$name "$error"/;
1779 sub _stats_start_execute {
1780 my ( $c, $code ) = @_;
1781 my $appclass = ref($c) || $c;
1782 return if ( ( $code->name =~ /^_.*/ )
1783 && ( !$appclass->config->{show_internal_actions} ) );
1785 my $action_name = $code->reverse();
1786 $c->counter->{$action_name}++;
1788 my $action = $action_name;
1789 $action = "/$action" unless $action =~ /->/;
1791 # determine if the call was the result of a forward
1792 # this is done by walking up the call stack and looking for a calling
1793 # sub of Catalyst::forward before the eval
1795 for my $index ( 2 .. 11 ) {
1797 if ( ( caller($index) )[0] eq 'Catalyst'
1798 && ( caller($index) )[3] eq '(eval)' );
1800 if ( ( caller($index) )[3] =~ /forward$/ ) {
1801 $callsub = ( caller($index) )[3];
1802 $action = "-> $action";
1807 my $uid = $action_name . $c->counter->{$action_name};
1809 # is this a root-level call or a forwarded call?
1810 if ( $callsub =~ /forward$/ ) {
1811 my $parent = $c->stack->[-1];
1813 # forward, locate the caller
1814 if ( defined $parent && exists $c->counter->{"$parent"} ) {
1817 parent => "$parent" . $c->counter->{"$parent"},
1823 # forward with no caller may come from a plugin
1842 sub _stats_finish_execute {
1843 my ( $c, $info ) = @_;
1844 $c->stats->profile( end => $info );
1849 Finalizes the request.
1856 for my $error ( @{ $c->error } ) {
1857 $c->log->error($error);
1860 # Support skipping finalize for psgix.io style 'jailbreak'. Used to support
1861 # stuff like cometd and websockets
1863 if($c->request->_has_io_fh) {
1868 # Allow engine to handle finalize flow (for POE)
1869 my $engine = $c->engine;
1870 if ( my $code = $engine->can('finalize') ) {
1875 $c->finalize_uploads;
1878 if ( $#{ $c->error } >= 0 ) {
1882 $c->finalize_headers unless $c->response->finalized_headers;
1889 if ($c->use_stats) {
1890 my $elapsed = $c->stats->elapsed;
1891 my $av = $elapsed == 0 ? '??' : sprintf '%.3f', 1 / $elapsed;
1893 "Request took ${elapsed}s ($av/s)\n" . $c->stats->report . "\n" );
1896 return $c->response->status;
1899 =head2 $c->finalize_body
1905 sub finalize_body { my $c = shift; $c->engine->finalize_body( $c, @_ ) }
1907 =head2 $c->finalize_cookies
1913 sub finalize_cookies { my $c = shift; $c->engine->finalize_cookies( $c, @_ ) }
1915 =head2 $c->finalize_error
1917 Finalizes error. If there is only one error in L</error> and it is an object that
1918 does C<as_psgi> or C<code> we rethrow the error and presume it caught by middleware
1919 up the ladder. Otherwise we return the debugging error page (in debug mode) or we
1920 return the default error page (production mode).
1924 sub finalize_error {
1926 if($#{$c->error} > 0) {
1927 $c->engine->finalize_error( $c, @_ );
1929 my ($error) = @{$c->error};
1932 ($error->can('as_psgi') || $error->can('code'))
1934 # In the case where the error 'knows what it wants', becauses its PSGI
1935 # aware, just rethow and let middleware catch it
1936 $error->can('rethrow') ? $error->rethrow : croak $error;
1938 $c->engine->finalize_error( $c, @_ )
1943 =head2 $c->finalize_headers
1949 sub finalize_headers {
1952 my $response = $c->response; #accessor calls can add up?
1954 # Check if we already finalized headers
1955 return if $response->finalized_headers;
1958 if ( my $location = $response->redirect ) {
1959 $c->log->debug(qq/Redirecting to "$location"/) if $c->debug;
1960 $response->header( Location => $location );
1963 # Remove incorrectly added body and content related meta data when returning
1964 # an information response, or a response the is required to not include a body
1966 $c->finalize_cookies;
1968 $c->response->finalize_headers();
1971 $response->finalized_headers(1);
1974 =head2 $c->finalize_output
1976 An alias for finalize_body.
1978 =head2 $c->finalize_read
1980 Finalizes the input after reading is complete.
1984 sub finalize_read { my $c = shift; $c->engine->finalize_read( $c, @_ ) }
1986 =head2 $c->finalize_uploads
1988 Finalizes uploads. Cleans up any temporary files.
1992 sub finalize_uploads { my $c = shift; $c->engine->finalize_uploads( $c, @_ ) }
1994 =head2 $c->get_action( $action, $namespace )
1996 Gets an action in a given namespace.
2000 sub get_action { my $c = shift; $c->dispatcher->get_action(@_) }
2002 =head2 $c->get_actions( $action, $namespace )
2004 Gets all actions of a given name in a namespace and all parent
2009 sub get_actions { my $c = shift; $c->dispatcher->get_actions( $c, @_ ) }
2011 =head2 $app->handle_request( @arguments )
2013 Called to handle each HTTP request.
2017 sub handle_request {
2018 my ( $class, @arguments ) = @_;
2020 # Always expect worst case!
2023 if ($class->debug) {
2024 my $secs = time - $START || 1;
2025 my $av = sprintf '%.3f', $COUNT / $secs;
2026 my $time = localtime time;
2027 $class->log->info("*** Request $COUNT ($av/s) [$$] [$time] ***");
2030 my $c = $class->prepare(@arguments);
2032 $status = $c->finalize;
2034 #rethow if this can be handled by middleware
2035 if(blessed $_ && ($_->can('as_psgi') || $_->can('code'))) {
2036 $_->can('rethrow') ? $_->rethrow : croak $_;
2038 chomp(my $error = $_);
2039 $class->log->error(qq/Caught exception in engine "$error"/);
2044 if(my $coderef = $class->log->can('_flush')){
2045 $class->log->$coderef();
2050 =head2 $class->prepare( @arguments )
2052 Creates a Catalyst context from an engine-specific request (Apache, CGI,
2059 predicate => '_has_uploadtmp',
2063 my ( $class, @arguments ) = @_;
2066 # After the app/ctxt split, this should become an attribute based on something passed
2067 # into the application.
2068 $class->context_class( ref $class || $class ) unless $class->context_class;
2070 my $uploadtmp = $class->config->{uploadtmp};
2071 my $c = $class->context_class->new({ $uploadtmp ? (_uploadtmp => $uploadtmp) : ()});
2073 $c->response->_context($c);
2075 #surely this is not the most efficient way to do things...
2076 $c->stats($class->stats_class->new)->enable($c->use_stats);
2077 if ( $c->debug || $c->config->{enable_catalyst_header} ) {
2078 $c->res->headers->header( 'X-Catalyst' => $Catalyst::VERSION );
2082 # Allow engine to direct the prepare flow (for POE)
2083 if ( my $prepare = $c->engine->can('prepare') ) {
2084 $c->engine->$prepare( $c, @arguments );
2087 $c->prepare_request(@arguments);
2088 $c->prepare_connection;
2089 $c->prepare_query_parameters;
2090 $c->prepare_headers; # Just hooks, no longer needed - they just
2091 $c->prepare_cookies; # cause the lazy attribute on req to build
2094 # Prepare the body for reading, either by prepare_body
2095 # or the user, if they are using $c->read
2098 # Parse the body unless the user wants it on-demand
2099 unless ( ref($c)->config->{parse_on_demand} ) {
2105 # VERY ugly and probably shouldn't rely on ->finalize actually working
2107 # failed prepare is always due to an invalid request, right?
2108 $c->response->status(400);
2109 $c->response->content_type('text/plain');
2110 $c->response->body('Bad Request');
2111 # Note we call finalize and then die here, which escapes
2112 # finalize being called in the enclosing block..
2113 # It in fact couldn't be called, as we don't return $c..
2114 # This is a mess - but I'm unsure you can fix this without
2115 # breaking compat for people doing crazy things (we should set
2116 # the 400 and just return the ctx here IMO, letting finalize get called
2127 =head2 $c->prepare_action
2129 Prepares action. See L<Catalyst::Dispatcher>.
2133 sub prepare_action { my $c = shift; $c->dispatcher->prepare_action( $c, @_ ) }
2135 =head2 $c->prepare_body
2137 Prepares message body.
2144 return if $c->request->_has_body;
2146 # Initialize on-demand data
2147 $c->engine->prepare_body( $c, @_ );
2148 $c->prepare_parameters;
2149 $c->prepare_uploads;
2152 =head2 $c->prepare_body_chunk( $chunk )
2154 Prepares a chunk of data before sending it to L<HTTP::Body>.
2156 See L<Catalyst::Engine>.
2160 sub prepare_body_chunk {
2162 $c->engine->prepare_body_chunk( $c, @_ );
2165 =head2 $c->prepare_body_parameters
2167 Prepares body parameters.
2171 sub prepare_body_parameters {
2173 $c->engine->prepare_body_parameters( $c, @_ );
2176 =head2 $c->prepare_connection
2178 Prepares connection.
2182 sub prepare_connection {
2184 # XXX - This is called on the engine (not the request) to maintain
2185 # Engine::PSGI back compat.
2186 $c->engine->prepare_connection($c);
2189 =head2 $c->prepare_cookies
2191 Prepares cookies by ensuring that the attribute on the request
2192 object has been built.
2196 sub prepare_cookies { my $c = shift; $c->request->cookies }
2198 =head2 $c->prepare_headers
2200 Prepares request headers by ensuring that the attribute on the request
2201 object has been built.
2205 sub prepare_headers { my $c = shift; $c->request->headers }
2207 =head2 $c->prepare_parameters
2209 Prepares parameters.
2213 sub prepare_parameters {
2215 $c->prepare_body_parameters;
2216 $c->engine->prepare_parameters( $c, @_ );
2219 =head2 $c->prepare_path
2221 Prepares path and base.
2225 sub prepare_path { my $c = shift; $c->engine->prepare_path( $c, @_ ) }
2227 =head2 $c->prepare_query_parameters
2229 Prepares query parameters.
2233 sub prepare_query_parameters {
2236 $c->engine->prepare_query_parameters( $c, @_ );
2239 =head2 $c->log_request
2241 Writes information about the request to the debug logs. This includes:
2245 =item * Request method, path, and remote IP address
2247 =item * Query keywords (see L<Catalyst::Request/query_keywords>)
2249 =item * Request parameters
2251 =item * File uploads
2260 return unless $c->debug;
2262 my($dump) = grep {$_->[0] eq 'Request' } $c->dump_these;
2263 my $request = $dump->[1];
2265 my ( $method, $path, $address ) = ( $request->method, $request->path, $request->address );
2267 $path = '/' unless length $path;
2269 $c->log->debug(qq/"$method" request for "$path" from "$address"/);
2271 $c->log_request_headers($request->headers);
2273 if ( my $keywords = $request->query_keywords ) {
2274 $c->log->debug("Query keywords are: $keywords");
2277 $c->log_request_parameters( query => $request->query_parameters, $request->_has_body ? (body => $request->body_parameters) : () );
2279 $c->log_request_uploads($request);
2282 =head2 $c->log_response
2284 Writes information about the response to the debug logs by calling
2285 C<< $c->log_response_status_line >> and C<< $c->log_response_headers >>.
2292 return unless $c->debug;
2294 my($dump) = grep {$_->[0] eq 'Response' } $c->dump_these;
2295 my $response = $dump->[1];
2297 $c->log_response_status_line($response);
2298 $c->log_response_headers($response->headers);
2301 =head2 $c->log_response_status_line($response)
2303 Writes one line of information about the response to the debug logs. This includes:
2307 =item * Response status code
2309 =item * Content-Type header (if present)
2311 =item * Content-Length header (if present)
2317 sub log_response_status_line {
2318 my ($c, $response) = @_;
2322 'Response Code: %s; Content-Type: %s; Content-Length: %s',
2323 $response->status || 'unknown',
2324 $response->headers->header('Content-Type') || 'unknown',
2325 $response->headers->header('Content-Length') || 'unknown'
2330 =head2 $c->log_response_headers($headers);
2332 Hook method which can be wrapped by plugins to log the response headers.
2333 No-op in the default implementation.
2337 sub log_response_headers {}
2339 =head2 $c->log_request_parameters( query => {}, body => {} )
2341 Logs request parameters to debug logs
2345 sub log_request_parameters {
2347 my %all_params = @_;
2349 return unless $c->debug;
2351 my $column_width = Catalyst::Utils::term_width() - 44;
2352 foreach my $type (qw(query body)) {
2353 my $params = $all_params{$type};
2354 next if ! keys %$params;
2355 my $t = Text::SimpleTable->new( [ 35, 'Parameter' ], [ $column_width, 'Value' ] );
2356 for my $key ( sort keys %$params ) {
2357 my $param = $params->{$key};
2358 my $value = defined($param) ? $param : '';
2359 $t->row( $key, ref $value eq 'ARRAY' ? ( join ', ', @$value ) : $value );
2361 $c->log->debug( ucfirst($type) . " Parameters are:\n" . $t->draw );
2365 =head2 $c->log_request_uploads
2367 Logs file uploads included in the request to the debug logs.
2368 The parameter name, filename, file type, and file size are all included in
2373 sub log_request_uploads {
2375 my $request = shift;
2376 return unless $c->debug;
2377 my $uploads = $request->uploads;
2378 if ( keys %$uploads ) {
2379 my $t = Text::SimpleTable->new(
2380 [ 12, 'Parameter' ],
2385 for my $key ( sort keys %$uploads ) {
2386 my $upload = $uploads->{$key};
2387 for my $u ( ref $upload eq 'ARRAY' ? @{$upload} : ($upload) ) {
2388 $t->row( $key, $u->filename, $u->type, $u->size );
2391 $c->log->debug( "File Uploads are:\n" . $t->draw );
2395 =head2 $c->log_request_headers($headers);
2397 Hook method which can be wrapped by plugins to log the request headers.
2398 No-op in the default implementation.
2402 sub log_request_headers {}
2404 =head2 $c->log_headers($type => $headers)
2406 Logs L<HTTP::Headers> (either request or response) to the debug logs.
2413 my $headers = shift; # an HTTP::Headers instance
2415 return unless $c->debug;
2417 my $column_width = Catalyst::Utils::term_width() - 28;
2418 my $t = Text::SimpleTable->new( [ 15, 'Header Name' ], [ $column_width, 'Value' ] );
2421 my ( $name, $value ) = @_;
2422 $t->row( $name, $value );
2425 $c->log->debug( ucfirst($type) . " Headers:\n" . $t->draw );
2429 =head2 $c->prepare_read
2431 Prepares the input for reading.
2435 sub prepare_read { my $c = shift; $c->engine->prepare_read( $c, @_ ) }
2437 =head2 $c->prepare_request
2439 Prepares the engine request.
2443 sub prepare_request { my $c = shift; $c->engine->prepare_request( $c, @_ ) }
2445 =head2 $c->prepare_uploads
2451 sub prepare_uploads {
2454 $c->engine->prepare_uploads( $c, @_ );
2457 =head2 $c->prepare_write
2459 Prepares the output for writing.
2463 sub prepare_write { my $c = shift; $c->engine->prepare_write( $c, @_ ) }
2465 =head2 $c->request_class
2467 Returns or sets the request class. Defaults to L<Catalyst::Request>.
2469 =head2 $c->response_class
2471 Returns or sets the response class. Defaults to L<Catalyst::Response>.
2473 =head2 $c->read( [$maxlength] )
2475 Reads a chunk of data from the request body. This method is designed to
2476 be used in a while loop, reading C<$maxlength> bytes on every call.
2477 C<$maxlength> defaults to the size of the request if not specified.
2479 You have to set C<< MyApp->config(parse_on_demand => 1) >> to use this
2482 Warning: If you use read(), Catalyst will not process the body,
2483 so you will not be able to access POST parameters or file uploads via
2484 $c->request. You must handle all body parsing yourself.
2488 sub read { my $c = shift; return $c->request->read( @_ ) }
2498 $app->_make_immutable_if_needed;
2499 $app->engine_loader->needs_psgi_engine_compat_hack ?
2500 $app->engine->run($app, @_) :
2501 $app->engine->run( $app, $app->_finalized_psgi_app, @_ );
2504 sub _make_immutable_if_needed {
2506 my $meta = find_meta($class);
2507 my $isa_ca = $class->isa('Class::Accessor::Fast') || $class->isa('Class::Accessor');
2510 && ! { $meta->immutable_options }->{replace_constructor}
2513 warn("You made your application class ($class) immutable, "
2514 . "but did not inline the\nconstructor. "
2515 . "This will break catalyst, as your app \@ISA "
2516 . "Class::Accessor(::Fast)?\nPlease pass "
2517 . "(replace_constructor => 1)\nwhen making your class immutable.\n");
2519 unless ($meta->is_immutable) {
2520 # XXX - FIXME warning here as you should make your app immutable yourself.
2521 $meta->make_immutable(
2522 replace_constructor => 1,
2527 =head2 $c->set_action( $action, $code, $namespace, $attrs )
2529 Sets an action in a given namespace.
2533 sub set_action { my $c = shift; $c->dispatcher->set_action( $c, @_ ) }
2535 =head2 $c->setup_actions($component)
2537 Sets up actions for a component.
2541 sub setup_actions { my $c = shift; $c->dispatcher->setup_actions( $c, @_ ) }
2543 =head2 $c->setup_components
2545 This method is called internally to set up the application's components.
2547 It finds modules by calling the L<locate_components> method, expands them to
2548 package names with the L<expand_component_module> method, and then installs
2549 each component into the application.
2551 The C<setup_components> config option is passed to both of the above methods.
2553 Installation of each component is performed by the L<setup_component> method,
2558 sub setup_components {
2561 my $config = $class->config->{ setup_components };
2563 my @comps = $class->locate_components($config);
2564 my %comps = map { $_ => 1 } @comps;
2566 my $deprecatedcatalyst_component_names = grep { /::[CMV]::/ } @comps;
2567 $class->log->warn(qq{Your application is using the deprecated ::[MVC]:: type naming scheme.\n}.
2568 qq{Please switch your class names to ::Model::, ::View:: and ::Controller: as appropriate.\n}
2569 ) if $deprecatedcatalyst_component_names;
2571 for my $component ( @comps ) {
2573 # We pass ignore_loaded here so that overlay files for (e.g.)
2574 # Model::DBI::Schema sub-classes are loaded - if it's in @comps
2575 # we know M::P::O found a file on disk so this is safe
2577 Catalyst::Utils::ensure_class_loaded( $component, { ignore_loaded => 1 } );
2580 for my $component (@comps) {
2581 my $instance = $class->components->{ $component } = $class->setup_component($component);
2582 my @expanded_components = $instance->can('expand_modules')
2583 ? $instance->expand_modules( $component, $config )
2584 : $class->expand_component_module( $component, $config );
2585 for my $component (@expanded_components) {
2586 next if $comps{$component};
2587 $class->components->{ $component } = $class->setup_component($component);
2592 =head2 $c->locate_components( $setup_component_config )
2594 This method is meant to provide a list of component modules that should be
2595 setup for the application. By default, it will use L<Module::Pluggable>.
2597 Specify a C<setup_components> config option to pass additional options directly
2598 to L<Module::Pluggable>. To add additional search paths, specify a key named
2599 C<search_extra> as an array reference. Items in the array beginning with C<::>
2600 will have the application class name prepended to them.
2604 sub locate_components {
2608 my @paths = qw( ::M ::Model ::V ::View ::C ::Controller );
2609 my $extra = delete $config->{ search_extra } || [];
2611 unshift @paths, @$extra;
2613 my @comps = map { sort { length($a) <=> length($b) } Module::Pluggable::Object->new(
2614 search_path => [ map { s/^(?=::)/$class/; $_; } ($_) ],
2616 )->plugins } @paths;
2621 =head2 $c->expand_component_module( $component, $setup_component_config )
2623 Components found by C<locate_components> will be passed to this method, which
2624 is expected to return a list of component (package) names to be set up.
2628 sub expand_component_module {
2629 my ($class, $module) = @_;
2630 return Devel::InnerPackage::list_packages( $module );
2633 =head2 $c->setup_component
2637 sub setup_component {
2638 my( $class, $component ) = @_;
2640 unless ( $component->can( 'COMPONENT' ) ) {
2644 my $suffix = Catalyst::Utils::class2classsuffix( $component );
2645 my $config = $class->config->{ $suffix } || {};
2646 # Stash catalyst_component_name in the config here, so that custom COMPONENT
2647 # methods also pass it. local to avoid pointlessly shitting in config
2648 # for the debug screen, as $component is already the key name.
2649 local $config->{catalyst_component_name} = $component;
2651 my $instance = eval { $component->COMPONENT( $class, $config ); };
2653 if ( my $error = $@ ) {
2655 Catalyst::Exception->throw(
2656 message => qq/Couldn't instantiate component "$component", "$error"/
2660 unless (blessed $instance) {
2661 my $metaclass = Moose::Util::find_meta($component);
2662 my $method_meta = $metaclass->find_method_by_name('COMPONENT');
2663 my $component_method_from = $method_meta->associated_metaclass->name;
2664 my $value = defined($instance) ? $instance : 'undef';
2665 Catalyst::Exception->throw(
2667 qq/Couldn't instantiate component "$component", COMPONENT() method (from $component_method_from) didn't return an object-like value (value was $value)./
2673 =head2 $c->setup_dispatcher
2679 sub setup_dispatcher {
2680 my ( $class, $dispatcher ) = @_;
2683 $dispatcher = 'Catalyst::Dispatcher::' . $dispatcher;
2686 if ( my $env = Catalyst::Utils::env_value( $class, 'DISPATCHER' ) ) {
2687 $dispatcher = 'Catalyst::Dispatcher::' . $env;
2690 unless ($dispatcher) {
2691 $dispatcher = $class->dispatcher_class;
2694 load_class($dispatcher);
2696 # dispatcher instance
2697 $class->dispatcher( $dispatcher->new );
2700 =head2 $c->setup_engine
2707 my ($class, $requested_engine) = @_;
2709 if (!$class->engine_loader || $requested_engine) {
2710 $class->engine_loader(
2711 Catalyst::EngineLoader->new({
2712 application_name => $class,
2713 (defined $requested_engine
2714 ? (catalyst_engine_class => $requested_engine) : ()),
2719 $class->engine_loader->catalyst_engine_class;
2723 my ($class, $requested_engine) = @_;
2726 my $loader = $class->engine_loader;
2728 if (!$loader || $requested_engine) {
2729 $loader = Catalyst::EngineLoader->new({
2730 application_name => $class,
2731 (defined $requested_engine
2732 ? (requested_engine => $requested_engine) : ()),
2735 $class->engine_loader($loader);
2738 $loader->catalyst_engine_class;
2741 # Don't really setup_engine -- see _setup_psgi_app for explanation.
2742 return if $class->loading_psgi_file;
2744 load_class($engine);
2746 if ($ENV{MOD_PERL}) {
2747 my $apache = $class->engine_loader->auto;
2749 my $meta = find_meta($class);
2750 my $was_immutable = $meta->is_immutable;
2751 my %immutable_options = $meta->immutable_options;
2752 $meta->make_mutable if $was_immutable;
2754 $meta->add_method(handler => sub {
2756 my $psgi_app = $class->_finalized_psgi_app;
2757 $apache->call_app($r, $psgi_app);
2760 $meta->make_immutable(%immutable_options) if $was_immutable;
2763 $class->engine( $engine->new );
2768 ## This exists just to supply a prebuild psgi app for mod_perl and for the
2769 ## build in server support (back compat support for pre psgi port behavior).
2770 ## This is so that we don't build a new psgi app for each request when using
2771 ## the mod_perl handler or the built in servers (http and fcgi, etc).
2773 sub _finalized_psgi_app {
2776 unless ($app->_psgi_app) {
2777 my $psgi_app = $app->_setup_psgi_app;
2778 $app->_psgi_app($psgi_app);
2781 return $app->_psgi_app;
2784 ## Look for a psgi file like 'myapp_web.psgi' (if the app is MyApp::Web) in the
2785 ## home directory and load that and return it (just assume it is doing the
2786 ## right thing :) ). If that does not exist, call $app->psgi_app, wrap that
2787 ## in default_middleware and return it ( this is for backward compatibility
2788 ## with pre psgi port behavior ).
2790 sub _setup_psgi_app {
2793 for my $home (Path::Class::Dir->new($app->config->{home})) {
2794 my $psgi_file = $home->file(
2795 Catalyst::Utils::appprefix($app) . '.psgi',
2798 next unless -e $psgi_file;
2800 # If $psgi_file calls ->setup_engine, it's doing so to load
2801 # Catalyst::Engine::PSGI. But if it does that, we're only going to
2802 # throw away the loaded PSGI-app and load the 5.9 Catalyst::Engine
2803 # anyway. So set a flag (ick) that tells setup_engine not to populate
2804 # $c->engine or do any other things we might regret.
2806 $app->loading_psgi_file(1);
2807 my $psgi_app = Plack::Util::load_psgi($psgi_file);
2808 $app->loading_psgi_file(0);
2811 unless $app->engine_loader->needs_psgi_engine_compat_hack;
2814 Found a legacy Catalyst::Engine::PSGI .psgi file at ${psgi_file}.
2816 Its content has been ignored. Please consult the Catalyst::Upgrading
2817 documentation on how to upgrade from Catalyst::Engine::PSGI.
2821 return $app->apply_default_middlewares($app->psgi_app);
2824 =head2 $c->apply_default_middlewares
2826 Adds the following L<Plack> middlewares to your application, since they are
2827 useful and commonly needed:
2829 L<Plack::Middleware::ReverseProxy>, (conditionally added based on the status
2830 of your $ENV{REMOTE_ADDR}, and can be forced on with C<using_frontend_proxy>
2831 or forced off with C<ignore_frontend_proxy>), L<Plack::Middleware::LighttpdScriptNameFix>
2832 (if you are using Lighttpd), L<Plack::Middleware::IIS6ScriptNameFix> (always
2833 applied since this middleware is smart enough to conditionally apply itself).
2835 Additionally if we detect we are using Nginx, we add a bit of custom middleware
2836 to solve some problems with the way that server handles $ENV{PATH_INFO} and
2842 sub apply_default_middlewares {
2843 my ($app, $psgi_app) = @_;
2845 $psgi_app = Plack::Middleware::Conditional->wrap(
2847 builder => sub { Plack::Middleware::ReverseProxy->wrap($_[0]) },
2850 return if $app->config->{ignore_frontend_proxy};
2851 return $env->{REMOTE_ADDR} eq '127.0.0.1'
2852 || $app->config->{using_frontend_proxy};
2856 # If we're running under Lighttpd, swap PATH_INFO and SCRIPT_NAME
2857 # http://lists.scsys.co.uk/pipermail/catalyst/2006-June/008361.html
2858 $psgi_app = Plack::Middleware::Conditional->wrap(
2860 builder => sub { Plack::Middleware::LighttpdScriptNameFix->wrap($_[0]) },
2863 return unless $env->{SERVER_SOFTWARE} && $env->{SERVER_SOFTWARE} =~ m!lighttpd[-/]1\.(\d+\.\d+)!;
2864 return unless $1 < 4.23;
2869 # we're applying this unconditionally as the middleware itself already makes
2870 # sure it doesn't fuck things up if it's not running under one of the right
2872 $psgi_app = Plack::Middleware::IIS6ScriptNameFix->wrap($psgi_app);
2874 # And another IIS issue, this time with IIS7.
2875 $psgi_app = Plack::Middleware::Conditional->wrap(
2877 builder => sub { Plack::Middleware::IIS7KeepAliveFix->wrap($_[0]) },
2880 return $env->{SERVER_SOFTWARE} && $env->{SERVER_SOFTWARE} =~ m!IIS/7\.[0-9]!;
2889 Returns a PSGI application code reference for the catalyst application
2890 C<$c>. This is the bare application without any middlewares
2891 applied. C<${myapp}.psgi> is not taken into account.
2893 This is what you want to be using to retrieve the PSGI application code
2894 reference of your Catalyst application for use in F<.psgi> files.
2900 my $psgi = $app->engine->build_psgi_app($app);
2901 return $app->Catalyst::Utils::apply_registered_middleware($psgi);
2907 Class attribute which is a positive number and defines the noiseness of the
2908 application trace. See L</TRACING>.
2912 Class attribute which is a handler for reporting your traces. See L</TRACING>.
2914 =head2 $c->setup_trace
2916 Examples your %ENV, configuation and application settings to setup how and if
2917 application tracing is enabled. See L</TRACING>.
2921 Accepts a string $message and level for a trace message. The configured
2922 trace level must equal or exceed the level given. Level is required and should
2923 be a positive integer. For more see L</TRACING>.
2928 my ($app, @args) = @_;
2930 # first we look for %ENV
2931 if(my $trace = Catalyst::Utils::env_value( $app, 'TRACE' )) {
2932 # extract a file path if it exists;
2933 my ($level,$op, $path) = ($trace=~m/^(.+)(\=|\+\=)(.+)$/);
2934 if($level && $op && $path) {
2935 open(my $fh, '>', $path)
2936 ||die "Cannot open trace file at $path: $!";
2937 $app->trace_logger($fh);
2938 $app->trace_level($level);
2940 $app->trace_level($trace);
2944 # Next, we look at config
2945 $app->trace_level($app->config->{trace_level}) unless defined($app->trace_level);
2946 $app->trace_logger($app->config->{trace_logger}) unless defined($app->trace_logger);
2948 # We do setup_trace AFTER setup_log, so this stuff should be all good to
2949 # use by this point in application setup. For BackCompat, we will try to
2953 $app->trace_level(1) unless defined($app->trace_level);
2954 $app->trace_logger(sub { shift->log->debug }) unless defined($app->trace_logger);
2957 # Last, we set defaults if the settings are still emtpy
2958 # Setup the defaults
2960 $app->trace_level(0) unless defined($app->trace_level);
2961 $app->trace_logger(sub { shift->log->debug }) unless defined($app->trace_logger);
2967 my ($class, $level, $message) = @_;
2968 die "Level is required" unless defined $level;
2969 die "Message is required unless defined $message;
2970 if($class->trace_level >= $level) {
2971 ref($class->trace_logger) eq 'CODE' ?
2972 $class->trace_logger->($class, $message, $level) :
2973 $class->trace_logger->print($message);
2977 =head2 $c->setup_home
2979 Sets up the home directory.
2984 my ( $class, $home ) = @_;
2986 if ( my $env = Catalyst::Utils::env_value( $class, 'HOME' ) ) {
2990 $home ||= Catalyst::Utils::home($class);
2993 #I remember recently being scolded for assigning config values like this
2994 $class->config->{home} ||= $home;
2995 $class->config->{root} ||= Path::Class::Dir->new($home)->subdir('root');
2999 =head2 $c->setup_log
3001 Sets up log by instantiating a L<Catalyst::Log|Catalyst::Log> object and
3002 passing it to C<log()>. Pass in a comma-delimited list of levels to set the
3005 This method also installs a C<debug> method that returns a true value into the
3006 catalyst subclass if the "debug" level is passed in the comma-delimited list,
3007 or if the C<$CATALYST_DEBUG> environment variable is set to a true value.
3009 Note that if the log has already been setup, by either a previous call to
3010 C<setup_log> or by a call such as C<< __PACKAGE__->log( MyLogger->new ) >>,
3011 that this method won't actually set up the log object.
3016 my ( $class, $levels ) = @_;
3019 $levels =~ s/^\s+//;
3020 $levels =~ s/\s+$//;
3021 my %levels = map { $_ => 1 } split /\s*,\s*/, $levels;
3023 my $env_debug = Catalyst::Utils::env_value( $class, 'DEBUG' );
3024 if ( defined $env_debug ) {
3025 $levels{debug} = 1 if $env_debug; # Ugly!
3026 delete($levels{debug}) unless $env_debug;
3029 unless ( $class->log ) {
3030 $class->log( Catalyst::Log->new(keys %levels) );
3033 if ( $levels{debug} ) {
3034 Class::MOP::get_metaclass_by_name($class)->add_method('debug' => sub { 1 });
3035 $class->log->debug('Debug messages enabled');
3039 =head2 $c->setup_plugins
3045 =head2 $c->setup_stats
3047 Sets up timing statistics class.
3052 my ( $class, $stats ) = @_;
3054 Catalyst::Utils::ensure_class_loaded($class->stats_class);
3056 my $env = Catalyst::Utils::env_value( $class, 'STATS' );
3057 if ( defined($env) ? $env : ($stats || $class->debug ) ) {
3058 Class::MOP::get_metaclass_by_name($class)->add_method('use_stats' => sub { 1 });
3059 $class->log->debug('Statistics enabled');
3064 =head2 $c->registered_plugins
3066 Returns a sorted list of the plugins which have either been stated in the
3069 If passed a given plugin name, it will report a boolean value indicating
3070 whether or not that plugin is loaded. A fully qualified name is required if
3071 the plugin name does not begin with C<Catalyst::Plugin::>.
3073 if ($c->registered_plugins('Some::Plugin')) {
3081 sub registered_plugins {
3083 return sort keys %{ $proto->_plugins } unless @_;
3085 return 1 if exists $proto->_plugins->{$plugin};
3086 return exists $proto->_plugins->{"Catalyst::Plugin::$plugin"};
3089 sub _register_plugin {
3090 my ( $proto, $plugin, $instant ) = @_;
3091 my $class = ref $proto || $proto;
3093 load_class( $plugin );
3094 $class->log->warn( "$plugin inherits from 'Catalyst::Component' - this is deprecated and will not work in 5.81" )
3095 if $plugin->isa( 'Catalyst::Component' );
3096 my $plugin_meta = Moose::Meta::Class->create($plugin);
3097 if (!$plugin_meta->has_method('new')
3098 && ( $plugin->isa('Class::Accessor::Fast') || $plugin->isa('Class::Accessor') ) ) {
3099 $plugin_meta->add_method('new', Moose::Object->meta->get_method('new'))
3101 if (!$instant && !$proto->_plugins->{$plugin}) {
3102 my $meta = Class::MOP::get_metaclass_by_name($class);
3103 $meta->superclasses($plugin, $meta->superclasses);
3105 $proto->_plugins->{$plugin} = 1;
3109 sub _default_plugins { return qw(Unicode::Encoding) }
3112 my ( $class, $plugins ) = @_;
3114 $class->_plugins( {} ) unless $class->_plugins;
3116 m/Unicode::Encoding/ ? do {
3118 'Unicode::Encoding plugin is auto-applied,'
3119 . ' please remove this from your appclass'
3120 . ' and make sure to define "encoding" config'
3122 unless (exists $class->config->{'encoding'}) {
3123 $class->config->{'encoding'} = 'UTF-8';
3128 push @$plugins, $class->_default_plugins;
3129 $plugins = Data::OptList::mkopt($plugins || []);
3132 [ Catalyst::Utils::resolve_namespace(
3133 $class . '::Plugin',
3134 'Catalyst::Plugin', $_->[0]
3140 for my $plugin ( reverse @plugins ) {
3141 load_class($plugin->[0], $plugin->[1]);
3142 my $meta = find_meta($plugin->[0]);
3143 next if $meta && $meta->isa('Moose::Meta::Role');
3145 $class->_register_plugin($plugin->[0]);
3149 map { $_->[0]->name, $_->[1] }
3150 grep { blessed($_->[0]) && $_->[0]->isa('Moose::Meta::Role') }
3151 map { [find_meta($_->[0]), $_->[1]] }
3154 Moose::Util::apply_all_roles(
3160 =head2 registered_middlewares
3162 Read only accessor that returns an array of all the middleware in the order
3163 that they were added (which is the REVERSE of the order they will be applied).
3165 The values returned will be either instances of L<Plack::Middleware> or of a
3166 compatible interface, or a coderef, which is assumed to be inlined middleware
3168 =head2 setup_middleware (?@middleware)
3170 Read configuration information stored in configuration key C<psgi_middleware> or
3173 See under L</CONFIGURATION> information regarding C<psgi_middleware> and how
3174 to use it to enable L<Plack::Middleware>
3176 This method is automatically called during 'setup' of your application, so
3177 you really don't need to invoke it. However you may do so if you find the idea
3178 of loading middleware via configuration weird :). For example:
3184 __PACKAGE__->setup_middleware('Head');
3187 When we read middleware definitions from configuration, we reverse the list
3188 which sounds odd but is likely how you expect it to work if you have prior
3189 experience with L<Plack::Builder> or if you previously used the plugin
3190 L<Catalyst::Plugin::EnableMiddleware> (which is now considered deprecated)
3192 So basically your middleware handles an incoming request from the first
3193 registered middleware, down and handles the response from the last middleware
3198 sub registered_middlewares {
3200 if(my $middleware = $class->_psgi_middleware) {
3202 Catalyst::Middleware::Stash->new,
3203 Plack::Middleware::HTTPExceptions->new,
3204 Plack::Middleware::RemoveRedundantBody->new,
3205 Plack::Middleware::FixMissingBodyInRedirect->new,
3206 Plack::Middleware::ContentLength->new,
3207 Plack::Middleware::MethodOverride->new,
3208 Plack::Middleware::Head->new,
3211 die "You cannot call ->registered_middlewares until middleware has been setup";
3215 sub setup_middleware {
3217 my @middleware_definitions = @_ ?
3218 reverse(@_) : reverse(@{$class->config->{'psgi_middleware'}||[]});
3220 my @middleware = ();
3221 while(my $next = shift(@middleware_definitions)) {
3223 if(Scalar::Util::blessed $next && $next->can('wrap')) {
3224 push @middleware, $next;
3225 } elsif(ref $next eq 'CODE') {
3226 push @middleware, $next;
3227 } elsif(ref $next eq 'HASH') {
3228 my $namespace = shift @middleware_definitions;
3229 my $mw = $class->Catalyst::Utils::build_middleware($namespace, %$next);
3230 push @middleware, $mw;
3232 die "I can't handle middleware definition ${\ref $next}";
3235 my $mw = $class->Catalyst::Utils::build_middleware($next);
3236 push @middleware, $mw;
3240 my @existing = @{$class->_psgi_middleware || []};
3241 $class->_psgi_middleware([@middleware,@existing,]);
3244 =head2 registered_data_handlers
3246 A read only copy of registered Data Handlers returned as a Hash, where each key
3247 is a content type and each value is a subref that attempts to decode that content
3250 =head2 setup_data_handlers (?@data_handler)
3252 Read configuration information stored in configuration key C<data_handlers> or
3255 See under L</CONFIGURATION> information regarding C<data_handlers>.
3257 This method is automatically called during 'setup' of your application, so
3258 you really don't need to invoke it.
3260 =head2 default_data_handlers
3262 Default Data Handlers that come bundled with L<Catalyst>. Currently there are
3263 only two default data handlers, for 'application/json' and an alternative to
3264 'application/x-www-form-urlencoded' which supposed nested form parameters via
3265 L<CGI::Struct> or via L<CGI::Struct::XS> IF you've installed it.
3267 The 'application/json' data handler is used to parse incoming JSON into a Perl
3268 data structure. It used either L<JSON::MaybeXS> or L<JSON>, depending on which
3269 is installed. This allows you to fail back to L<JSON:PP>, which is a Pure Perl
3270 JSON decoder, and has the smallest dependency impact.
3272 Because we don't wish to add more dependencies to L<Catalyst>, if you wish to
3273 use this new feature we recommend installing L<JSON> or L<JSON::MaybeXS> in
3274 order to get the best performance. You should add either to your dependency
3275 list (Makefile.PL, dist.ini, cpanfile, etc.)
3279 sub registered_data_handlers {
3281 if(my $data_handlers = $class->_data_handlers) {
3282 return %$data_handlers;
3284 $class->setup_data_handlers;
3285 return $class->registered_data_handlers;
3289 sub setup_data_handlers {
3290 my ($class, %data_handler_callbacks) = @_;
3291 %data_handler_callbacks = (
3292 %{$class->default_data_handlers},
3293 %{$class->config->{'data_handlers'}||+{}},
3294 %data_handler_callbacks);
3296 $class->_data_handlers(\%data_handler_callbacks);
3299 sub default_data_handlers {
3302 'application/x-www-form-urlencoded' => sub {
3303 my ($fh, $req) = @_;
3304 my $params = $req->_use_hash_multivalue ? $req->body_parameters->mixed : $req->body_parameters;
3305 Class::Load::load_first_existing_class('CGI::Struct::XS', 'CGI::Struct')
3306 ->can('build_cgi_struct')->($params);
3308 'application/json' => sub {
3309 Class::Load::load_first_existing_class('JSON::MaybeXS', 'JSON')
3310 ->can('decode_json')->(do { local $/; $_->getline });
3317 Returns an arrayref of the internal execution stack (actions that are
3318 currently executing).
3322 Returns the current timing statistics object. By default Catalyst uses
3323 L<Catalyst::Stats|Catalyst::Stats>, but can be set otherwise with
3324 L<< stats_class|/"$c->stats_class" >>.
3326 Even if L<< -Stats|/"-Stats" >> is not enabled, the stats object is still
3327 available. By enabling it with C< $c->stats->enabled(1) >, it can be used to
3328 profile explicitly, although MyApp.pm still won't profile nor output anything
3331 =head2 $c->stats_class
3333 Returns or sets the stats (timing statistics) class. L<Catalyst::Stats|Catalyst::Stats> is used by default.
3335 =head2 $c->use_stats
3337 Returns 1 when L<< stats collection|/"-Stats" >> is enabled.
3339 Note that this is a static method, not an accessor and should be overridden
3340 by declaring C<sub use_stats { 1 }> in your MyApp.pm, not by calling C<< $c->use_stats(1) >>.
3347 =head2 $c->write( $data )
3349 Writes $data to the output stream. When using this method directly, you
3350 will need to manually set the C<Content-Length> header to the length of
3351 your output data, if known.
3358 # Finalize headers if someone manually writes output (for compat)
3359 $c->finalize_headers;
3361 return $c->response->write( @_ );
3366 Returns the Catalyst version number. Mostly useful for "powered by"
3367 messages in template systems.
3371 sub version { return $Catalyst::VERSION }
3373 =head1 CONFIGURATION
3375 There are a number of 'base' config variables which can be set:
3381 C<default_model> - The default model picked if you say C<< $c->model >>. See L<< /$c->model($name) >>.
3385 C<default_view> - The default view to be rendered or returned when C<< $c->view >> is called. See L<< /$c->view($name) >>.
3389 C<disable_component_resolution_regex_fallback> - Turns
3390 off the deprecated component resolution functionality so
3391 that if any of the component methods (e.g. C<< $c->controller('Foo') >>)
3392 are called then regex search will not be attempted on string values and
3393 instead C<undef> will be returned.
3397 C<home> - The application home directory. In an uninstalled application,
3398 this is the top level application directory. In an installed application,
3399 this will be the directory containing C<< MyApp.pm >>.
3403 C<ignore_frontend_proxy> - See L</PROXY SUPPORT>
3407 C<name> - The name of the application in debug messages and the debug and
3412 C<parse_on_demand> - The request body (for example file uploads) will not be parsed
3413 until it is accessed. This allows you to (for example) check authentication (and reject
3414 the upload) before actually receiving all the data. See L</ON-DEMAND PARSER>
3418 C<root> - The root directory for templates. Usually this is just a
3419 subdirectory of the home directory, but you can set it to change the
3420 templates to a different directory.
3424 C<search_extra> - Array reference passed to Module::Pluggable to for additional
3425 namespaces from which components will be loaded (and constructed and stored in
3426 C<< $c->components >>).
3430 C<show_internal_actions> - If true, causes internal actions such as C<< _DISPATCH >>
3431 to be shown in hit debug tables in the test server.
3435 C<use_request_uri_for_path> - Controls if the C<REQUEST_URI> or C<PATH_INFO> environment
3436 variable should be used for determining the request path.
3438 Most web server environments pass the requested path to the application using environment variables,
3439 from which Catalyst has to reconstruct the request base (i.e. the top level path to / in the application,
3440 exposed as C<< $c->request->base >>) and the request path below that base.
3442 There are two methods of doing this, both of which have advantages and disadvantages. Which method is used
3443 is determined by the C<< $c->config(use_request_uri_for_path) >> setting (which can either be true or false).
3447 =item use_request_uri_for_path => 0
3449 This is the default (and the) traditional method that Catalyst has used for determining the path information.
3450 The path is generated from a combination of the C<PATH_INFO> and C<SCRIPT_NAME> environment variables.
3451 The allows the application to behave correctly when C<mod_rewrite> is being used to redirect requests
3452 into the application, as these variables are adjusted by mod_rewrite to take account for the redirect.
3454 However this method has the major disadvantage that it is impossible to correctly decode some elements
3455 of the path, as RFC 3875 says: "C<< Unlike a URI path, the PATH_INFO is not URL-encoded, and cannot
3456 contain path-segment parameters. >>" This means PATH_INFO is B<always> decoded, and therefore Catalyst
3457 can't distinguish / vs %2F in paths (in addition to other encoded values).
3459 =item use_request_uri_for_path => 1
3461 This method uses the C<REQUEST_URI> and C<SCRIPT_NAME> environment variables. As C<REQUEST_URI> is never
3462 decoded, this means that applications using this mode can correctly handle URIs including the %2F character
3463 (i.e. with C<AllowEncodedSlashes> set to C<On> in Apache).
3465 Given that this method of path resolution is provably more correct, it is recommended that you use
3466 this unless you have a specific need to deploy your application in a non-standard environment, and you are
3467 aware of the implications of not being able to handle encoded URI paths correctly.
3469 However it also means that in a number of cases when the app isn't installed directly at a path, but instead
3470 is having paths rewritten into it (e.g. as a .cgi/fcgi in a public_html directory, with mod_rewrite in a
3471 .htaccess file, or when SSI is used to rewrite pages into the app, or when sub-paths of the app are exposed
3472 at other URIs than that which the app is 'normally' based at with C<mod_rewrite>), the resolution of
3473 C<< $c->request->base >> will be incorrect.
3479 C<using_frontend_proxy> - See L</PROXY SUPPORT>.
3483 C<encoding> - See L</ENCODING>
3487 C<abort_chain_on_error_fix>
3489 When there is an error in an action chain, the default behavior is to continue
3490 processing the remaining actions and then catch the error upon chain end. This
3491 can lead to running actions when the application is in an unexpected state. If
3492 you have this issue, setting this config value to true will promptly exit a
3493 chain when there is an error raised in any action (thus terminating the chain
3498 __PACKAGE__->config(abort_chain_on_error_fix => 1);
3500 In the future this might become the default behavior.
3504 C<use_hash_multivalue_in_request>
3506 In L<Catalyst::Request> the methods C<query_parameters>, C<body_parametes>
3507 and C<parameters> return a hashref where values might be scalar or an arrayref
3508 depending on the incoming data. In many cases this can be undesirable as it
3509 leads one to writing defensive code like the following:
3511 my ($val) = ref($c->req->parameters->{a}) ?
3512 @{$c->req->parameters->{a}} :
3513 $c->req->parameters->{a};
3515 Setting this configuration item to true will make L<Catalyst> populate the
3516 attributes underlying these methods with an instance of L<Hash::MultiValue>
3517 which is used by L<Plack::Request> and others to solve this very issue. You
3518 may prefer this behavior to the default, if so enable this option (be warned
3519 if you enable it in a legacy application we are not sure if it is completely
3520 backwardly compatible).
3524 C<psgi_middleware> - See L</PSGI MIDDLEWARE>.
3528 C<data_handlers> - See L</DATA HANDLERS>.
3532 trace_level - This sets your application trace level - See L</TRACING>.
3536 trace_logger - This sets your application trace logger - See L</TRACING>.
3542 Generally when you throw an exception inside an Action (or somewhere in
3543 your stack, such as in a model that an Action is calling) that exception
3544 is caught by Catalyst and unless you either catch it yourself (via eval
3545 or something like L<Try::Tiny> or by reviewing the L</error> stack, it
3546 will eventually reach L</finalize_errors> and return either the debugging
3547 error stack page, or the default error page. However, if your exception
3548 can be caught by L<Plack::Middleware::HTTPExceptions>, L<Catalyst> will
3549 instead rethrow it so that it can be handled by that middleware (which
3550 is part of the default middleware). For example this would allow
3552 use HTTP::Throwable::Factory 'http_throw';
3554 sub throws_exception :Local {
3555 my ($self, $c) = @_;
3557 http_throw(SeeOther => { location =>
3558 $c->uri_for($self->action_for('redirect')) });
3562 =head1 INTERNAL ACTIONS
3564 Catalyst uses internal actions like C<_DISPATCH>, C<_BEGIN>, C<_AUTO>,
3565 C<_ACTION>, and C<_END>. These are by default not shown in the private
3566 action table, but you can make them visible with a config parameter.
3568 MyApp->config(show_internal_actions => 1);
3570 =head1 ON-DEMAND PARSER
3572 The request body is usually parsed at the beginning of a request,
3573 but if you want to handle input yourself, you can enable on-demand
3574 parsing with a config parameter.
3576 MyApp->config(parse_on_demand => 1);
3578 =head1 PROXY SUPPORT
3580 Many production servers operate using the common double-server approach,
3581 with a lightweight frontend web server passing requests to a larger
3582 backend server. An application running on the backend server must deal
3583 with two problems: the remote user always appears to be C<127.0.0.1> and
3584 the server's hostname will appear to be C<localhost> regardless of the
3585 virtual host that the user connected through.
3587 Catalyst will automatically detect this situation when you are running
3588 the frontend and backend servers on the same machine. The following
3589 changes are made to the request.
3591 $c->req->address is set to the user's real IP address, as read from
3592 the HTTP X-Forwarded-For header.
3594 The host value for $c->req->base and $c->req->uri is set to the real
3595 host, as read from the HTTP X-Forwarded-Host header.
3597 Additionally, you may be running your backend application on an insecure
3598 connection (port 80) while your frontend proxy is running under SSL. If there
3599 is a discrepancy in the ports, use the HTTP header C<X-Forwarded-Port> to
3600 tell Catalyst what port the frontend listens on. This will allow all URIs to
3601 be created properly.
3603 In the case of passing in:
3605 X-Forwarded-Port: 443
3607 All calls to C<uri_for> will result in an https link, as is expected.
3609 Obviously, your web server must support these headers for this to work.
3611 In a more complex server farm environment where you may have your
3612 frontend proxy server(s) on different machines, you will need to set a
3613 configuration option to tell Catalyst to read the proxied data from the
3616 MyApp->config(using_frontend_proxy => 1);
3618 If you do not wish to use the proxy support at all, you may set:
3620 MyApp->config(ignore_frontend_proxy => 0);
3622 =head2 Note about psgi files
3624 Note that if you supply your own .psgi file, calling
3625 C<< MyApp->psgi_app(@_); >>, then B<this will not happen automatically>.
3627 You either need to apply L<Plack::Middleware::ReverseProxy> yourself
3628 in your psgi, for example:
3631 enable "Plack::Middleware::ReverseProxy";
3635 This will unconditionally add the ReverseProxy support, or you need to call
3636 C<< $app = MyApp->apply_default_middlewares($app) >> (to conditionally
3637 apply the support depending upon your config).
3639 See L<Catalyst::PSGI> for more information.
3641 =head1 THREAD SAFETY
3643 Catalyst has been tested under Apache 2's threading C<mpm_worker>,
3644 C<mpm_winnt>, and the standalone forking HTTP server on Windows. We
3645 believe the Catalyst core to be thread-safe.
3647 If you plan to operate in a threaded environment, remember that all other
3648 modules you are using must also be thread-safe. Some modules, most notably
3649 L<DBD::SQLite>, are not thread-safe.
3651 =head1 DATA HANDLERS
3653 The L<Catalyst::Request> object uses L<HTTP::Body> to populate 'classic' HTML
3654 form parameters and URL search query fields. However it has become common
3655 for various alternative content types to be PUT or POSTed to your controllers
3656 and actions. People working on RESTful APIs, or using AJAX often use JSON,
3657 XML and other content types when communicating with an application server. In
3658 order to better support this use case, L<Catalyst> defines a global configuration
3659 option, C<data_handlers>, which lets you associate a content type with a coderef
3660 that parses that content type into something Perl can readily access.
3667 __PACKAGE__->config(
3669 'application/json' => sub { local $/; decode_json $_->getline },
3671 ## Any other configuration.
3676 By default L<Catalyst> comes with a generic JSON data handler similar to the
3677 example given above, which uses L<JSON::Maybe> to provide either L<JSON::PP>
3678 (a pure Perl, dependency free JSON parser) or L<Cpanel::JSON::XS> if you have
3679 it installed (if you want the faster XS parser, add it to you project Makefile.PL
3680 or dist.ini, cpanfile, etc.)
3682 The C<data_handlers> configuration is a hashref whose keys are HTTP Content-Types
3683 (matched against the incoming request type using a regexp such as to be case
3684 insensitive) and whose values are coderefs that receive a localized version of
3685 C<$_> which is a filehandle object pointing to received body.
3687 This feature is considered an early access release and we reserve the right
3688 to alter the interface in order to provide a performant and secure solution to
3689 alternative request body content. Your reports welcomed!
3691 =head1 PSGI MIDDLEWARE
3693 You can define middleware, defined as L<Plack::Middleware> or a compatible
3694 interface in configuration. Your middleware definitions are in the form of an
3695 arrayref under the configuration key C<psgi_middleware>. Here's an example
3696 with details to follow:
3701 use Plack::Middleware::StackTrace;
3703 my $stacktrace_middleware = Plack::Middleware::StackTrace->new;
3705 __PACKAGE__->config(
3706 'psgi_middleware', [
3709 $stacktrace_middleware,
3710 'Session' => {store => 'File'},
3715 $env->{myapp.customkey} = 'helloworld';
3724 So the general form is:
3726 __PACKAGE__->config(psgi_middleware => \@middleware_definitions);
3728 Where C<@middleware> is one or more of the following, applied in the REVERSE of
3729 the order listed (to make it function similarly to L<Plack::Builder>:
3731 Alternatively, you may also define middleware by calling the L</setup_middleware>
3738 __PACKAGE__->setup_middleware( \@middleware_definitions);
3741 In the case where you do both (use 'setup_middleware' and configuration) the
3742 package call to setup_middleware will be applied earlier (in other words its
3743 middleware will wrap closer to the application). Keep this in mind since in
3744 some cases the order of middleware is important.
3746 The two approaches are not exclusive.
3750 =item Middleware Object
3752 An already initialized object that conforms to the L<Plack::Middleware>
3755 my $stacktrace_middleware = Plack::Middleware::StackTrace->new;
3757 __PACKAGE__->config(
3758 'psgi_middleware', [
3759 $stacktrace_middleware,
3765 A coderef that is an inlined middleware:
3767 __PACKAGE__->config(
3768 'psgi_middleware', [
3773 if($env->{PATH_INFO} =~m/forced/) {
3775 ->new(file=>TestApp->path_to(qw/share static forced.txt/))
3778 return $app->($env);
3788 We assume the scalar refers to a namespace after normalizing it using the
3791 (1) If the scalar is prefixed with a "+" (as in C<+MyApp::Foo>) then the full string
3792 is assumed to be 'as is', and we just install and use the middleware.
3794 (2) If the scalar begins with "Plack::Middleware" or your application namespace
3795 (the package name of your Catalyst application subclass), we also assume then
3796 that it is a full namespace, and use it.
3798 (3) Lastly, we then assume that the scalar is a partial namespace, and attempt to
3799 resolve it first by looking for it under your application namespace (for example
3800 if you application is "MyApp::Web" and the scalar is "MyMiddleware", we'd look
3801 under "MyApp::Web::Middleware::MyMiddleware") and if we don't find it there, we
3802 will then look under the regular L<Plack::Middleware> namespace (i.e. for the
3803 previous we'd try "Plack::Middleware::MyMiddleware"). We look under your application
3804 namespace first to let you 'override' common L<Plack::Middleware> locally, should
3805 you find that a good idea.
3811 __PACKAGE__->config(
3812 'psgi_middleware', [
3813 'Debug', ## MyAppWeb::Middleware::Debug->wrap or Plack::Middleware::Debug->wrap
3814 'Plack::Middleware::Stacktrace', ## Plack::Middleware::Stacktrace->wrap
3815 '+MyApp::Custom', ## MyApp::Custom->wrap
3819 =item a scalar followed by a hashref
3821 Just like the previous, except the following C<HashRef> is used as arguments
3822 to initialize the middleware object.
3824 __PACKAGE__->config(
3825 'psgi_middleware', [
3826 'Session' => {store => 'File'},
3831 Please see L<PSGI> for more on middleware.
3835 B<NOTE> Tracing replaces the functionality of L<Debug>. For now both
3836 interfaces will be supported but it is suggested that you become familiar with
3837 the new interface and begin using it.
3839 Application tracing is debugging information about the state of your L<Catalyst>
3840 application and a request / response cycle. This is often used when you want a
3841 peek into the 'Catalyst Black Box' without needing to actually hack into the
3842 core code and add debugging statements. Examples of application tracing include
3843 startup information about loaded plugins, middleware, models, controllers and
3844 views. It also includes details about how a request is dispatched (what actions
3845 in what controllers are hit, and approximately how long each took) and how a
3846 response is generated. Additional trace information includes details about errors
3847 and some basic statistics on your running application.
3849 It is often the case when running an application in a development environment
3850 for development purposes that you will enable tracing to assist you in your work.
3851 However, application tracing is not strictly tied to environment so trace levels
3852 are not automatically enabled based on any environment settings (although you are
3853 allowed to set trace levels via configuration, which can be environment specific,
3856 Application tracing is also not the same thing as logging. Logging is custom messages
3857 that you've added to your custom application for the purposes of better understanding
3858 your application and how effective your application is in achieving its goals.
3859 Often logging is extended, unstructured meta data around your core business logic
3860 such as details about when a user account is created or failed to be created, what
3861 types of validation issues are occuring in your forms, page views, user engagement
3862 and timestamps to help you understand your application performance. Basically this
3863 is often information of business value that doesn't cleanly or meaningfully fit
3864 into a database. Catalyst provides an interface for adding various kinds of
3865 Loggers which can assist you in these tasks. Most Loggers allow one to log
3866 messages at different levels of priority, such as debug, warning, critical, etc.
3867 This is a useful feature since it permits one to turn the logging level down in
3868 high traffic environments. In the past Catalyst tracing (previously called
3869 'Debug') was conflated with log levels of debug, in that in order to enable
3870 application tracing (or debugging) one was required to turn log level debug on
3871 globally. Additionally, the Catalyst application tracing (or debugging) used
3872 the defined logger to 'record' its messages. Neither is ideal since it leads
3873 one to be forced to accept more logging than may be wished, and it also does
3874 not allow one to separate development tracing from application debug logging.
3876 Application tracing fixes this issues by allowing you to turn on tracing
3877 independently of setting your log level. It also lets you define a trace
3878 log message handler separately from your logger. So for example you might
3879 wish to send trace messages to STDOUT, but send your logging to Elasticsearch.
3886 __PACKAGE__->trace_level(1);
3887 __PACKAGE__->trace_logger(sub { my $class = shift; ...});
3890 You may also configure tracing via configuration:
3896 __PACKAGE__->config({
3898 trace_logger => sub { my $class = shift; ...},
3903 Or, you may set tracing via environment varables, for example:
3905 CATALYST_TRACE=1 perl script/myapp_server.pl
3906 MYAPP_TRACE=1 perl script/myapp_server.pl
3907 MYAPP_TRACE=1=/var/log/traces perl script/myapp_server.pl
3909 The order of precidence is that custom application environment variables
3910 ('MYAPP_TRACE') come first, followed by global environment variables
3911 ('CATALYST_TRACE'), followed by configuration settings and lastly application
3914 For backwards compatiblity, we respect classic Catalyst debugging (L<Debug>) in
3915 the following way. If debugging is true, we automatically set
3916 C<trace_level=1> and set the C<trace_logger> to your the debug method of your
3917 defined log object (basically it works just as described in L<Debug>). In this
3918 case $c->debug will also be set to true.
3920 Please note that if you set C<trace_level> but not debugging then debugging
3921 ($c->debug) will NOT be set to true.
3923 Please note that if you set BOTH trace_level and 'class' debugging, your trace
3924 level and trace configuation is respected at a high priority, however the state
3925 of the debug method will be set as requested (although overridden). This is
3926 done for backcompatibility with applications that overloaded the debug method
3927 in custom applications.
3929 Please note that when setting trace levels via environment, you may use an
3930 extended form of the value, which opens a filehandled to a specified path
3931 and sends all trace information there:
3933 MYAPP_TRACE=1=/var/log/traces perl script/myapp_server.pl
3935 This would override any other settings for L<\trace_logger>. I
3939 This is a number that defaults to 0. It indicates the level of application
3940 tracing that is desired. Larger numbers indicate greater level of tracing.
3941 Currently trace levels are defined, although at this time respect is limited,
3942 as this is a new feature.
3944 Levels 1,2 and 3 are reserved for Catalyst core code (code that is part of the
3945 L<Catalyst> distribution).
3947 Levels 4,5 and 6 are reserved for Catalyst extended ecosystem (Catalyst plugins,
3948 models, views and distributions under the CatalystX namespace).
3950 Levels 7,8 and 9 are reserved but not currently defined.
3952 Levels 10 and higher are reserved for local (not on CPAN) application use.
3956 This handles a trace message, if it is determined that one should be sent based
3957 on the running L<\trace_level>. This can accept the following values
3963 This is a code reference that gets the application class (your Catalyst.pm
3964 subclass) as argument0, the message as argument1 and the level as argument3.
3965 The message is expected to be a string. For example:
3967 __PACKAGE__->trace_logger( sub {
3968 my ($app, $message, $level) = @_;
3969 $app->log->debug($message);
3972 Would send trace messages to the debug log handler (This is currently the
3975 =item A Filehandle or Object
3977 This must be an open filehandle setup to received output. We really
3978 just look for a 'print' method, so strictly speaking this could be
3979 any object that satisfies the duck type.
3983 A path that be be resolved as a file that we open a filehandle to.
3989 On request, decodes all params from encoding into a sequence of
3990 logical characters. On response, encodes body into encoding.
3998 Returns an instance of an C<Encode> encoding
4000 print $c->encoding->name
4002 =item handle_unicode_encoding_exception ($exception_context)
4004 Method called when decoding process for a request fails.
4006 An C<$exception_context> hashref is provided to allow you to override the
4007 behaviour of your application when given data with incorrect encodings.
4009 The default method throws exceptions in the case of invalid request parameters
4010 (resulting in a 500 error), but ignores errors in upload filenames.
4012 The keys passed in the C<$exception_context> hash are:
4018 The value which was not able to be decoded.
4022 The exception received from L<Encode>.
4026 What type of data was being decoded. Valid values are (currently)
4027 C<params> - for request parameters / arguments / captures
4028 and C<uploads> - for request upload filenames.
4038 Join #catalyst on irc.perl.org.
4042 http://lists.scsys.co.uk/cgi-bin/mailman/listinfo/catalyst
4043 http://lists.scsys.co.uk/cgi-bin/mailman/listinfo/catalyst-dev
4047 http://catalyst.perl.org
4051 http://dev.catalyst.perl.org
4055 =head2 L<Task::Catalyst> - All you need to start with Catalyst
4057 =head2 L<Catalyst::Manual> - The Catalyst Manual
4059 =head2 L<Catalyst::Component>, L<Catalyst::Controller> - Base classes for components
4061 =head2 L<Catalyst::Engine> - Core engine
4063 =head2 L<Catalyst::Log> - Log class.
4065 =head2 L<Catalyst::Request> - Request object
4067 =head2 L<Catalyst::Response> - Response object
4069 =head2 L<Catalyst::Test> - The test suite.
4071 =head1 PROJECT FOUNDER
4073 sri: Sebastian Riedel <sri@cpan.org>
4079 acme: Leon Brocard <leon@astray.com>
4081 abraxxa: Alexander Hartmaier <abraxxa@cpan.org>
4085 Andrew Ford E<lt>A.Ford@ford-mason.co.ukE<gt>
4089 andyg: Andy Grundman <andy@hybridized.org>
4091 audreyt: Audrey Tang
4093 bricas: Brian Cassidy <bricas@cpan.org>
4095 Caelum: Rafael Kitover <rkitover@io.com>
4097 chansen: Christian Hansen
4099 chicks: Christopher Hicks
4101 Chisel Wright C<pause@herlpacker.co.uk>
4103 Danijel Milicevic C<me@danijel.de>
4105 David Kamholz E<lt>dkamholz@cpan.orgE<gt>
4107 David Naughton, C<naughton@umn.edu>
4111 dhoss: Devin Austin <dhoss@cpan.org>
4113 dkubb: Dan Kubb <dan.kubb-cpan@onautopilot.com>
4117 dwc: Daniel Westermann-Clark <danieltwc@cpan.org>
4119 esskar: Sascha Kiefer
4121 fireartist: Carl Franks <cfranks@cpan.org>
4123 frew: Arthur Axel "fREW" Schmidt <frioux@gmail.com>
4125 gabb: Danijel Milicevic
4129 Gavin Henry C<ghenry@perl.me.uk>
4133 groditi: Guillermo Roditi <groditi@gmail.com>
4135 hobbs: Andrew Rodland <andrew@cleverdomain.org>
4137 ilmari: Dagfinn Ilmari Mannsåker <ilmari@ilmari.org>
4139 jcamacho: Juan Camacho
4141 jester: Jesse Sheidlower C<jester@panix.com>
4143 jhannah: Jay Hannah <jay@jays.net>
4149 jon: Jon Schutz <jjschutz@cpan.org>
4151 Jonathan Rockway C<< <jrockway@cpan.org> >>
4153 Kieren Diment C<kd@totaldatasolution.com>
4155 konobi: Scott McWhirter <konobi@cpan.org>
4157 marcus: Marcus Ramberg <mramberg@cpan.org>
4159 miyagawa: Tatsuhiko Miyagawa <miyagawa@bulknews.net>
4161 mgrimes: Mark Grimes <mgrimes@cpan.org>
4163 mst: Matt S. Trout <mst@shadowcatsystems.co.uk>
4167 naughton: David Naughton
4169 ningu: David Kamholz <dkamholz@cpan.org>
4171 nothingmuch: Yuval Kogman <nothingmuch@woobling.org>
4173 numa: Dan Sully <daniel@cpan.org>
4179 omega: Andreas Marienborg
4181 Oleg Kostyuk <cub.uanic@gmail.com>
4183 phaylon: Robert Sedlacek <phaylon@dunkelheit.at>
4185 rafl: Florian Ragwitz <rafl@debian.org>
4187 random: Roland Lammel <lammel@cpan.org>
4189 Robert Sedlacek C<< <rs@474.at> >>
4191 SpiceMan: Marcel Montes
4195 szbalint: Balint Szilakszi <szbalint@cpan.org>
4197 t0m: Tomas Doran <bobtfish@bobtfish.net>
4201 vanstyn: Henry Van Styn <vanstyn@cpan.org>
4203 Viljo Marrandi C<vilts@yahoo.com>
4205 Will Hawes C<info@whawes.co.uk>
4207 willert: Sebastian Willert <willert@cpan.org>
4209 wreis: Wallace Reis <wreis@cpan.org>
4211 Yuval Kogman, C<nothingmuch@woobling.org>
4213 rainboxx: Matthias Dietrich, C<perl@rainboxx.de>
4215 dd070: Dhaval Dhanani <dhaval070@gmail.com>
4217 Upasana <me@upasana.me>
4221 Copyright (c) 2005-2014, the above named PROJECT FOUNDER and CONTRIBUTORS.
4225 This library is free software. You can redistribute it and/or modify it under
4226 the same terms as Perl itself.
4232 __PACKAGE__->meta->make_immutable;