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';
53 use Encode 2.21 'decode_utf8', 'encode_utf8';
55 BEGIN { require 5.008003; }
57 has stack => (is => 'ro', default => sub { [] });
58 has state => (is => 'rw', default => 0);
59 has stats => (is => 'rw');
60 has action => (is => 'rw');
61 has counter => (is => 'rw', default => sub { {} });
66 $self->request_class->new($self->_build_request_constructor_args);
70 sub _build_request_constructor_args {
72 my %p = ( _log => $self->log );
73 $p{_uploadtmp} = $self->_uploadtmp if $self->_has_uploadtmp;
74 $p{data_handlers} = {$self->registered_data_handlers};
75 $p{_use_hash_multivalue} = $self->config->{use_hash_multivalue_in_request}
76 if $self->config->{use_hash_multivalue_in_request};
84 $self->response_class->new($self->_build_response_constructor_args);
88 sub _build_response_constructor_args {
90 { _log => $self->log };
93 has namespace => (is => 'rw');
95 sub depth { scalar @{ shift->stack || [] }; }
96 sub comp { shift->component(@_) }
99 my $self = shift; return $self->request(@_);
102 my $self = shift; return $self->response(@_);
105 # For backwards compatibility
106 sub finalize_output { shift->finalize_body(@_) };
111 our $RECURSION = 1000;
112 our $DETACH = Catalyst::Exception::Detach->new;
113 our $GO = Catalyst::Exception::Go->new;
115 #I imagine that very few of these really need to be class variables. if any.
116 #maybe we should just make them attributes with a default?
117 __PACKAGE__->mk_classdata($_)
118 for qw/components arguments dispatcher engine log dispatcher_class
119 engine_loader context_class request_class response_class stats_class
120 setup_finished _psgi_app loading_psgi_file run_options _psgi_middleware
121 _data_handlers _encoding _encode_check/;
123 __PACKAGE__->dispatcher_class('Catalyst::Dispatcher');
124 __PACKAGE__->request_class('Catalyst::Request');
125 __PACKAGE__->response_class('Catalyst::Response');
126 __PACKAGE__->stats_class('Catalyst::Stats');
127 __PACKAGE__->_encode_check(Encode::FB_CROAK | Encode::LEAVE_SRC);
129 # Remember to update this in Catalyst::Runtime as well!
130 our $VERSION = '5.90080_001';
131 $VERSION = eval $VERSION if $VERSION =~ /_/; # numify for warning-free dev releases
134 my ( $class, @arguments ) = @_;
136 # We have to limit $class to Catalyst to avoid pushing Catalyst upon every
138 return unless $class eq 'Catalyst';
140 my $caller = caller();
141 return if $caller eq 'main';
143 my $meta = Moose::Meta::Class->initialize($caller);
144 unless ( $caller->isa('Catalyst') ) {
145 my @superclasses = ($meta->superclasses, $class, 'Catalyst::Controller');
146 $meta->superclasses(@superclasses);
148 # Avoid possible C3 issues if 'Moose::Object' is already on RHS of MyApp
149 $meta->superclasses(grep { $_ ne 'Moose::Object' } $meta->superclasses);
151 unless( $meta->has_method('meta') ){
152 if ($Moose::VERSION >= 1.15) {
153 $meta->_add_meta_method('meta');
156 $meta->add_method(meta => sub { Moose::Meta::Class->initialize("${caller}") } );
160 $caller->arguments( [@arguments] );
164 sub _application { $_[0] }
170 Catalyst - The Elegant MVC Web Application Framework
174 See the L<Catalyst::Manual> distribution for comprehensive
175 documentation and tutorials.
177 # Install Catalyst::Devel for helpers and other development tools
178 # use the helper to create a new application
181 # add models, views, controllers
182 script/myapp_create.pl model MyDatabase DBIC::Schema create=static dbi:SQLite:/path/to/db
183 script/myapp_create.pl view MyTemplate TT
184 script/myapp_create.pl controller Search
186 # built in testserver -- use -r to restart automatically on changes
187 # --help to see all available options
188 script/myapp_server.pl
190 # command line testing interface
191 script/myapp_test.pl /yada
194 use Catalyst qw/-Debug/; # include plugins here as well
196 ### In lib/MyApp/Controller/Root.pm (autocreated)
197 sub foo : Chained('/') Args() { # called for /foo, /foo/1, /foo/1/2, etc.
198 my ( $self, $c, @args ) = @_; # args are qw/1 2/ for /foo/1/2
199 $c->stash->{template} = 'foo.tt'; # set the template
200 # lookup something from db -- stash vars are passed to TT
202 $c->model('Database::Foo')->search( { country => $args[0] } );
203 if ( $c->req->params->{bar} ) { # access GET or POST parameters
204 $c->forward( 'bar' ); # process another action
205 # do something else after forward returns
209 # The foo.tt TT template can use the stash data from the database
210 [% WHILE (item = data.next) %]
214 # called for /bar/of/soap, /bar/of/soap/10, etc.
215 sub bar : Chained('/') PathPart('/bar/of/soap') Args() { ... }
217 # called after all actions are finished
219 my ( $self, $c ) = @_;
220 if ( scalar @{ $c->error } ) { ... } # handle errors
221 return if $c->res->body; # already have a response
222 $c->forward( 'MyApp::View::TT' ); # render template
225 See L<Catalyst::Manual::Intro> for additional information.
229 Catalyst is a modern framework for making web applications without the
230 pain usually associated with this process. This document is a reference
231 to the main Catalyst application. If you are a new user, we suggest you
232 start with L<Catalyst::Manual::Tutorial> or L<Catalyst::Manual::Intro>.
234 See L<Catalyst::Manual> for more documentation.
236 Catalyst plugins can be loaded by naming them as arguments to the "use
237 Catalyst" statement. Omit the C<Catalyst::Plugin::> prefix from the
238 plugin name, i.e., C<Catalyst::Plugin::My::Module> becomes
241 use Catalyst qw/My::Module/;
243 If your plugin starts with a name other than C<Catalyst::Plugin::>, you can
244 fully qualify the name by using a unary plus:
248 +Fully::Qualified::Plugin::Name
251 Special flags like C<-Debug> can also be specified as
252 arguments when Catalyst is loaded:
254 use Catalyst qw/-Debug My::Module/;
256 The position of plugins and flags in the chain is important, because
257 they are loaded in the order in which they appear.
259 The following flags are supported:
263 Enables debug output. You can also force this setting from the system
264 environment with CATALYST_DEBUG or <MYAPP>_DEBUG. The environment
265 settings override the application, with <MYAPP>_DEBUG having the highest
268 This sets the log level to 'debug' and enables full debug output on the
269 error screen. If you only want the latter, see L<< $c->debug >>.
273 Forces Catalyst to use a specific home directory, e.g.:
275 use Catalyst qw[-Home=/usr/mst];
277 This can also be done in the shell environment by setting either the
278 C<CATALYST_HOME> environment variable or C<MYAPP_HOME>; where C<MYAPP>
279 is replaced with the uppercased name of your application, any "::" in
280 the name will be replaced with underscores, e.g. MyApp::Web should use
281 MYAPP_WEB_HOME. If both variables are set, the MYAPP_HOME one will be used.
283 If none of these are set, Catalyst will attempt to automatically detect the
284 home directory. If you are working in a development environment, Catalyst
285 will try and find the directory containing either Makefile.PL, Build.PL,
286 dist.ini, or cpanfile. If the application has been installed into the system
287 (i.e. you have done C<make install>), then Catalyst will use the path to your
288 application module, without the .pm extension (e.g., /foo/MyApp if your
289 application was installed at /foo/MyApp.pm)
293 use Catalyst '-Log=warn,fatal,error';
295 Specifies a comma-delimited list of log levels.
299 Enables statistics collection and reporting.
301 use Catalyst qw/-Stats=1/;
303 You can also force this setting from the system environment with CATALYST_STATS
304 or <MYAPP>_STATS. The environment settings override the application, with
305 <MYAPP>_STATS having the highest priority.
307 Stats are also enabled if L<< debugging |/"-Debug" >> is enabled.
311 =head2 INFORMATION ABOUT THE CURRENT REQUEST
315 Returns a L<Catalyst::Action> object for the current action, which
316 stringifies to the action name. See L<Catalyst::Action>.
320 Returns the namespace of the current action, i.e., the URI prefix
321 corresponding to the controller of the current action. For example:
323 # in Controller::Foo::Bar
324 $c->namespace; # returns 'foo/bar';
330 Returns the current L<Catalyst::Request> object, giving access to
331 information about the current client request (including parameters,
332 cookies, HTTP headers, etc.). See L<Catalyst::Request>.
334 =head2 REQUEST FLOW HANDLING
336 =head2 $c->forward( $action [, \@arguments ] )
338 =head2 $c->forward( $class, $method, [, \@arguments ] )
340 This is one way of calling another action (method) in the same or
341 a different controller. You can also use C<< $self->my_method($c, @args) >>
342 in the same controller or C<< $c->controller('MyController')->my_method($c, @args) >>
343 in a different controller.
344 The main difference is that 'forward' uses some of the Catalyst request
345 cycle overhead, including debugging, which may be useful to you. On the
346 other hand, there are some complications to using 'forward', restrictions
347 on values returned from 'forward', and it may not handle errors as you prefer.
348 Whether you use 'forward' or not is up to you; it is not considered superior to
349 the other ways to call a method.
351 'forward' calls another action, by its private name. If you give a
352 class name but no method, C<process()> is called. You may also optionally
353 pass arguments in an arrayref. The action will receive the arguments in
354 C<@_> and C<< $c->req->args >>. Upon returning from the function,
355 C<< $c->req->args >> will be restored to the previous values.
357 Any data C<return>ed from the action forwarded to, will be returned by the
360 my $foodata = $c->forward('/foo');
361 $c->forward('index');
362 $c->forward(qw/Model::DBIC::Foo do_stuff/);
363 $c->forward('View::TT');
365 Note that L<< forward|/"$c->forward( $action [, \@arguments ] )" >> implies
366 an C<< eval { } >> around the call (actually
367 L<< execute|/"$c->execute( $class, $coderef )" >> does), thus rendering all
368 exceptions thrown by the called action non-fatal and pushing them onto
369 $c->error instead. If you want C<die> to propagate you need to do something
373 die join "\n", @{ $c->error } if @{ $c->error };
375 Or make sure to always return true values from your actions and write
378 $c->forward('foo') || return;
380 Another note is that C<< $c->forward >> always returns a scalar because it
381 actually returns $c->state which operates in a scalar context.
382 Thus, something like:
386 in an action that is forwarded to is going to return a scalar,
387 i.e. how many items are in that array, which is probably not what you want.
388 If you need to return an array then return a reference to it,
391 $c->stash->{array} = \@array;
393 and access it from the stash.
395 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.
399 sub forward { my $c = shift; no warnings 'recursion'; $c->dispatcher->forward( $c, @_ ) }
401 =head2 $c->detach( $action [, \@arguments ] )
403 =head2 $c->detach( $class, $method, [, \@arguments ] )
407 The same as L<< forward|/"$c->forward( $action [, \@arguments ] )" >>, but
408 doesn't return to the previous action when processing is finished.
410 When called with no arguments it escapes the processing chain entirely.
414 sub detach { my $c = shift; $c->dispatcher->detach( $c, @_ ) }
416 =head2 $c->visit( $action [, \@arguments ] )
418 =head2 $c->visit( $action [, \@captures, \@arguments ] )
420 =head2 $c->visit( $class, $method, [, \@arguments ] )
422 =head2 $c->visit( $class, $method, [, \@captures, \@arguments ] )
424 Almost the same as L<< forward|/"$c->forward( $action [, \@arguments ] )" >>,
425 but does a full dispatch, instead of just calling the new C<$action> /
426 C<< $class->$method >>. This means that C<begin>, C<auto> and the method
427 you go to are called, just like a new request.
429 In addition both C<< $c->action >> and C<< $c->namespace >> are localized.
430 This means, for example, that C<< $c->action >> methods such as
431 L<name|Catalyst::Action/name>, L<class|Catalyst::Action/class> and
432 L<reverse|Catalyst::Action/reverse> return information for the visited action
433 when they are invoked within the visited action. This is different from the
434 behavior of L<< forward|/"$c->forward( $action [, \@arguments ] )" >>, which
435 continues to use the $c->action object from the caller action even when
436 invoked from the called action.
438 C<< $c->stash >> is kept unchanged.
440 In effect, L<< visit|/"$c->visit( $action [, \@captures, \@arguments ] )" >>
441 allows you to "wrap" another action, just as it would have been called by
442 dispatching from a URL, while the analogous
443 L<< go|/"$c->go( $action [, \@captures, \@arguments ] )" >> allows you to
444 transfer control to another action as if it had been reached directly from a URL.
448 sub visit { my $c = shift; $c->dispatcher->visit( $c, @_ ) }
450 =head2 $c->go( $action [, \@arguments ] )
452 =head2 $c->go( $action [, \@captures, \@arguments ] )
454 =head2 $c->go( $class, $method, [, \@arguments ] )
456 =head2 $c->go( $class, $method, [, \@captures, \@arguments ] )
458 The relationship between C<go> and
459 L<< visit|/"$c->visit( $action [, \@captures, \@arguments ] )" >> is the same as
460 the relationship between
461 L<< forward|/"$c->forward( $class, $method, [, \@arguments ] )" >> and
462 L<< detach|/"$c->detach( $action [, \@arguments ] )" >>. Like C<< $c->visit >>,
463 C<< $c->go >> will perform a full dispatch on the specified action or method,
464 with localized C<< $c->action >> and C<< $c->namespace >>. Like C<detach>,
465 C<go> escapes the processing of the current request chain on completion, and
466 does not return to its caller.
468 @arguments are arguments to the final destination of $action. @captures are
469 arguments to the intermediate steps, if any, on the way to the final sub of
474 sub go { my $c = shift; $c->dispatcher->go( $c, @_ ) }
480 Returns the current L<Catalyst::Response> object, see there for details.
484 Returns a hashref to the stash, which may be used to store data and pass
485 it between components during a request. You can also set hash keys by
486 passing arguments. The stash is automatically sent to the view. The
487 stash is cleared at the end of a request; it cannot be used for
488 persistent storage (for this you must use a session; see
489 L<Catalyst::Plugin::Session> for a complete system integrated with
492 $c->stash->{foo} = $bar;
493 $c->stash( { moose => 'majestic', qux => 0 } );
494 $c->stash( bar => 1, gorch => 2 ); # equivalent to passing a hashref
496 # stash is automatically passed to the view for use in a template
497 $c->forward( 'MyApp::View::TT' );
499 The stash hash is currently stored in the PSGI C<$env> and is managed by
500 L<Catalyst::Middleware::Stash>. Since it's part of the C<$env> items in
501 the stash can be accessed in sub applications mounted under your main
502 L<Catalyst> application. For example if you delegate the response of an
503 action to another L<Catalyst> application, that sub application will have
504 access to all the stash keys of the main one, and if can of course add
505 more keys of its own. However those new keys will not 'bubble' back up
506 to the main application.
508 For more information the best thing to do is to review the test case:
509 t/middleware-stash.t in the distribution /t directory.
515 return Catalyst::Middleware::Stash::get_stash($c->req->env)->(@_);
520 =head2 $c->error($error, ...)
522 =head2 $c->error($arrayref)
524 Returns an arrayref containing error messages. If Catalyst encounters an
525 error while processing a request, it stores the error in $c->error. This
526 method should only be used to store fatal error messages.
528 my @error = @{ $c->error };
532 $c->error('Something bad happened');
539 my $error = ref $_[0] eq 'ARRAY' ? $_[0] : [@_];
540 croak @$error unless ref $c;
541 push @{ $c->{error} }, @$error;
543 elsif ( defined $_[0] ) { $c->{error} = undef }
544 return $c->{error} || [];
550 Contains the return value of the last executed action.
551 Note that << $c->state >> operates in a scalar context which means that all
552 values it returns are scalar.
554 =head2 $c->clear_errors
556 Clear errors. You probably don't want to clear the errors unless you are
557 implementing a custom error screen.
559 This is equivalent to running
570 =head2 $c->has_errors
572 Returns true if you have errors
576 sub has_errors { scalar(@{shift->error}) ? 1:0 }
578 sub _comp_search_prefixes {
580 return map $c->components->{ $_ }, $c->_comp_names_search_prefixes(@_);
583 # search components given a name and some prefixes
584 sub _comp_names_search_prefixes {
585 my ( $c, $name, @prefixes ) = @_;
586 my $appclass = ref $c || $c;
587 my $filter = "^${appclass}::(" . join( '|', @prefixes ) . ')::';
588 $filter = qr/$filter/; # Compile regex now rather than once per loop
590 # map the original component name to the sub part that we will search against
591 my %eligible = map { my $n = $_; $n =~ s{^$appclass\::[^:]+::}{}; $_ => $n; }
592 grep { /$filter/ } keys %{ $c->components };
594 # undef for a name will return all
595 return keys %eligible if !defined $name;
597 my $query = $name->$_isa('Regexp') ? $name : qr/^$name$/i;
598 my @result = grep { $eligible{$_} =~ m{$query} } keys %eligible;
600 return @result if @result;
602 # if we were given a regexp to search against, we're done.
603 return if $name->$_isa('Regexp');
605 # skip regexp fallback if configured
607 if $appclass->config->{disable_component_resolution_regex_fallback};
611 @result = grep { $eligible{ $_ } =~ m{$query} } keys %eligible;
613 # no results? try against full names
615 @result = grep { m{$query} } keys %eligible;
618 # don't warn if we didn't find any results, it just might not exist
620 # Disgusting hack to work out correct method name
621 my $warn_for = lc $prefixes[0];
622 my $msg = "Used regexp fallback for \$c->${warn_for}('${name}'), which found '" .
623 (join '", "', @result) . "'. Relying on regexp fallback behavior for " .
624 "component resolution is unreliable and unsafe.";
625 my $short = $result[0];
626 # remove the component namespace prefix
627 $short =~ s/.*?(Model|Controller|View):://;
628 my $shortmess = Carp::shortmess('');
629 if ($shortmess =~ m#Catalyst/Plugin#) {
630 $msg .= " You probably need to set '$short' instead of '${name}' in this " .
632 } elsif ($shortmess =~ m#Catalyst/lib/(View|Controller)#) {
633 $msg .= " You probably need to set '$short' instead of '${name}' in this " .
634 "component's config";
636 $msg .= " You probably meant \$c->${warn_for}('$short') instead of \$c->${warn_for}('${name}'), " .
637 "but if you really wanted to search, pass in a regexp as the argument " .
638 "like so: \$c->${warn_for}(qr/${name}/)";
640 $c->log->warn( "${msg}$shortmess" );
646 # Find possible names for a prefix
648 my ( $c, @prefixes ) = @_;
649 my $appclass = ref $c || $c;
651 my $filter = "^${appclass}::(" . join( '|', @prefixes ) . ')::';
653 my @names = map { s{$filter}{}; $_; }
654 $c->_comp_names_search_prefixes( undef, @prefixes );
659 # Filter a component before returning by calling ACCEPT_CONTEXT if available
660 sub _filter_component {
661 my ( $c, $comp, @args ) = @_;
663 if ( eval { $comp->can('ACCEPT_CONTEXT'); } ) {
664 return $comp->ACCEPT_CONTEXT( $c, @args );
670 =head2 COMPONENT ACCESSORS
672 =head2 $c->controller($name)
674 Gets a L<Catalyst::Controller> instance by name.
676 $c->controller('Foo')->do_stuff;
678 If the name is omitted, will return the controller for the dispatched
681 If you want to search for controllers, pass in a regexp as the argument.
683 # find all controllers that start with Foo
684 my @foo_controllers = $c->controller(qr{^Foo});
690 my ( $c, $name, @args ) = @_;
692 my $appclass = ref($c) || $c;
694 unless ( $name->$_isa('Regexp') ) { # Direct component hash lookup to avoid costly regexps
695 my $comps = $c->components;
696 my $check = $appclass."::Controller::".$name;
697 return $c->_filter_component( $comps->{$check}, @args ) if exists $comps->{$check};
699 my @result = $c->_comp_search_prefixes( $name, qw/Controller C/ );
700 return map { $c->_filter_component( $_, @args ) } @result if ref $name;
701 return $c->_filter_component( $result[ 0 ], @args );
704 return $c->component( $c->action->class );
707 =head2 $c->model($name)
709 Gets a L<Catalyst::Model> instance by name.
711 $c->model('Foo')->do_stuff;
713 Any extra arguments are directly passed to ACCEPT_CONTEXT.
715 If the name is omitted, it will look for
716 - a model object in $c->stash->{current_model_instance}, then
717 - a model name in $c->stash->{current_model}, then
718 - a config setting 'default_model', or
719 - check if there is only one model, and return it if that's the case.
721 If you want to search for models, pass in a regexp as the argument.
723 # find all models that start with Foo
724 my @foo_models = $c->model(qr{^Foo});
729 my ( $c, $name, @args ) = @_;
730 my $appclass = ref($c) || $c;
732 unless ( $name->$_isa('Regexp') ) { # Direct component hash lookup to avoid costly regexps
733 my $comps = $c->components;
734 my $check = $appclass."::Model::".$name;
735 return $c->_filter_component( $comps->{$check}, @args ) if exists $comps->{$check};
737 my @result = $c->_comp_search_prefixes( $name, qw/Model M/ );
738 return map { $c->_filter_component( $_, @args ) } @result if ref $name;
739 return $c->_filter_component( $result[ 0 ], @args );
743 return $c->stash->{current_model_instance}
744 if $c->stash->{current_model_instance};
745 return $c->model( $c->stash->{current_model} )
746 if $c->stash->{current_model};
748 return $c->model( $appclass->config->{default_model} )
749 if $appclass->config->{default_model};
751 my( $comp, $rest ) = $c->_comp_search_prefixes( undef, qw/Model M/);
754 $c->log->warn( Carp::shortmess('Calling $c->model() will return a random model unless you specify one of:') );
755 $c->log->warn( '* $c->config(default_model => "the name of the default model to use")' );
756 $c->log->warn( '* $c->stash->{current_model} # the name of the model to use for this request' );
757 $c->log->warn( '* $c->stash->{current_model_instance} # the instance of the model to use for this request' );
758 $c->log->warn( 'NB: in version 5.81, the "random" behavior will not work at all.' );
761 return $c->_filter_component( $comp );
765 =head2 $c->view($name)
767 Gets a L<Catalyst::View> instance by name.
769 $c->view('Foo')->do_stuff;
771 Any extra arguments are directly passed to ACCEPT_CONTEXT.
773 If the name is omitted, it will look for
774 - a view object in $c->stash->{current_view_instance}, then
775 - a view name in $c->stash->{current_view}, then
776 - a config setting 'default_view', or
777 - check if there is only one view, and return it if that's the case.
779 If you want to search for views, pass in a regexp as the argument.
781 # find all views that start with Foo
782 my @foo_views = $c->view(qr{^Foo});
787 my ( $c, $name, @args ) = @_;
789 my $appclass = ref($c) || $c;
791 unless ( $name->$_isa('Regexp') ) { # Direct component hash lookup to avoid costly regexps
792 my $comps = $c->components;
793 my $check = $appclass."::View::".$name;
794 if( exists $comps->{$check} ) {
795 return $c->_filter_component( $comps->{$check}, @args );
798 $c->log->warn( "Attempted to use view '$check', but does not exist" );
801 my @result = $c->_comp_search_prefixes( $name, qw/View V/ );
802 return map { $c->_filter_component( $_, @args ) } @result if ref $name;
803 return $c->_filter_component( $result[ 0 ], @args );
807 return $c->stash->{current_view_instance}
808 if $c->stash->{current_view_instance};
809 return $c->view( $c->stash->{current_view} )
810 if $c->stash->{current_view};
812 return $c->view( $appclass->config->{default_view} )
813 if $appclass->config->{default_view};
815 my( $comp, $rest ) = $c->_comp_search_prefixes( undef, qw/View V/);
818 $c->log->warn( 'Calling $c->view() will return a random view unless you specify one of:' );
819 $c->log->warn( '* $c->config(default_view => "the name of the default view to use")' );
820 $c->log->warn( '* $c->stash->{current_view} # the name of the view to use for this request' );
821 $c->log->warn( '* $c->stash->{current_view_instance} # the instance of the view to use for this request' );
822 $c->log->warn( 'NB: in version 5.81, the "random" behavior will not work at all.' );
825 return $c->_filter_component( $comp );
828 =head2 $c->controllers
830 Returns the available names which can be passed to $c->controller
836 return $c->_comp_names(qw/Controller C/);
841 Returns the available names which can be passed to $c->model
847 return $c->_comp_names(qw/Model M/);
853 Returns the available names which can be passed to $c->view
859 return $c->_comp_names(qw/View V/);
862 =head2 $c->comp($name)
864 =head2 $c->component($name)
866 Gets a component object by name. This method is not recommended,
867 unless you want to get a specific component by full
868 class. C<< $c->controller >>, C<< $c->model >>, and C<< $c->view >>
869 should be used instead.
871 If C<$name> is a regexp, a list of components matched against the full
872 component name will be returned.
874 If Catalyst can't find a component by name, it will fallback to regex
875 matching by default. To disable this behaviour set
876 disable_component_resolution_regex_fallback to a true value.
878 __PACKAGE__->config( disable_component_resolution_regex_fallback => 1 );
883 my ( $c, $name, @args ) = @_;
886 my $comps = $c->components;
889 # is it the exact name?
890 return $c->_filter_component( $comps->{ $name }, @args )
891 if exists $comps->{ $name };
893 # perhaps we just omitted "MyApp"?
894 my $composed = ( ref $c || $c ) . "::${name}";
895 return $c->_filter_component( $comps->{ $composed }, @args )
896 if exists $comps->{ $composed };
898 # search all of the models, views and controllers
899 my( $comp ) = $c->_comp_search_prefixes( $name, qw/Model M Controller C View V/ );
900 return $c->_filter_component( $comp, @args ) if $comp;
904 if $c->config->{disable_component_resolution_regex_fallback};
906 # This is here so $c->comp( '::M::' ) works
907 my $query = ref $name ? $name : qr{$name}i;
909 my @result = grep { m{$query} } keys %{ $c->components };
910 return map { $c->_filter_component( $_, @args ) } @result if ref $name;
913 $c->log->warn( Carp::shortmess(qq(Found results for "${name}" using regexp fallback)) );
914 $c->log->warn( 'Relying on the regexp fallback behavior for component resolution' );
915 $c->log->warn( 'is unreliable and unsafe. You have been warned' );
916 return $c->_filter_component( $result[ 0 ], @args );
919 # I would expect to return an empty list here, but that breaks back-compat
923 return sort keys %{ $c->components };
926 =head2 CLASS DATA AND HELPER CLASSES
930 Returns or takes a hashref containing the application's configuration.
932 __PACKAGE__->config( { db => 'dsn:SQLite:foo.db' } );
934 You can also use a C<YAML>, C<XML> or L<Config::General> config file
935 like C<myapp.conf> in your applications home directory. See
936 L<Catalyst::Plugin::ConfigLoader>.
938 =head3 Cascading configuration
940 The config method is present on all Catalyst components, and configuration
941 will be merged when an application is started. Configuration loaded with
942 L<Catalyst::Plugin::ConfigLoader> takes precedence over other configuration,
943 followed by configuration in your top level C<MyApp> class. These two
944 configurations are merged, and then configuration data whose hash key matches a
945 component name is merged with configuration for that component.
947 The configuration for a component is then passed to the C<new> method when a
948 component is constructed.
952 MyApp->config({ 'Model::Foo' => { bar => 'baz', overrides => 'me' } });
953 MyApp::Model::Foo->config({ quux => 'frob', overrides => 'this' });
955 will mean that C<MyApp::Model::Foo> receives the following data when
958 MyApp::Model::Foo->new({
964 It's common practice to use a Moose attribute
965 on the receiving component to access the config value.
967 package MyApp::Model::Foo;
971 # this attr will receive 'baz' at construction time
977 You can then get the value 'baz' by calling $c->model('Foo')->bar
978 (or $self->bar inside code in the model).
980 B<NOTE:> you MUST NOT call C<< $self->config >> or C<< __PACKAGE__->config >>
981 as a way of reading config within your code, as this B<will not> give you the
982 correctly merged config back. You B<MUST> take the config values supplied to
983 the constructor and use those instead.
987 around config => sub {
991 croak('Setting config after setup has been run is not allowed.')
992 if ( @_ and $c->setup_finished );
999 Returns the logging object instance. Unless it is already set, Catalyst
1000 sets this up with a L<Catalyst::Log> object. To use your own log class,
1001 set the logger with the C<< __PACKAGE__->log >> method prior to calling
1002 C<< __PACKAGE__->setup >>.
1004 __PACKAGE__->log( MyLogger->new );
1009 $c->log->info( 'Now logging with my own logger!' );
1011 Your log class should implement the methods described in
1016 Sets or gets the application encoding.
1025 # Let it be set to undef
1026 if (my $wanted = shift) {
1027 $encoding = Encode::find_encoding($wanted)
1028 or Carp::croak( qq/Unknown encoding '$wanted'/ );
1029 binmode(STDERR, ':encoding(' . $encoding->name . ')');
1036 ? $c->{encoding} = $encoding
1037 : $c->_encoding($encoding);
1039 $encoding = ref $c && exists $c->{encoding}
1049 Returns 1 if debug mode is enabled, 0 otherwise.
1051 You can enable debug mode in several ways:
1055 =item By calling myapp_server.pl with the -d flag
1057 =item With the environment variables MYAPP_DEBUG, or CATALYST_DEBUG
1059 =item The -Debug option in your MyApp.pm
1061 =item By declaring C<sub debug { 1 }> in your MyApp.pm.
1065 The first three also set the log level to 'debug'.
1067 Calling C<< $c->debug(1) >> has no effect.
1073 =head2 $c->dispatcher
1075 Returns the dispatcher instance. See L<Catalyst::Dispatcher>.
1079 Returns the engine instance. See L<Catalyst::Engine>.
1082 =head2 UTILITY METHODS
1084 =head2 $c->path_to(@path)
1086 Merges C<@path> with C<< $c->config->{home} >> and returns a
1087 L<Path::Class::Dir> object. Note you can usually use this object as
1088 a filename, but sometimes you will have to explicitly stringify it
1089 yourself by calling the C<< ->stringify >> method.
1093 $c->path_to( 'db', 'sqlite.db' );
1098 my ( $c, @path ) = @_;
1099 my $path = Path::Class::Dir->new( $c->config->{home}, @path );
1100 if ( -d $path ) { return $path }
1101 else { return Path::Class::File->new( $c->config->{home}, @path ) }
1105 my ( $class, $name, $plugin, @args ) = @_;
1107 # See block comment in t/unit_core_plugin.t
1108 $class->log->warn(qq/Adding plugin using the ->plugin method is deprecated, and will be removed in a future release/);
1110 $class->_register_plugin( $plugin, 1 );
1112 eval { $plugin->import };
1113 $class->mk_classdata($name);
1115 eval { $obj = $plugin->new(@args) };
1118 Catalyst::Exception->throw( message =>
1119 qq/Couldn't instantiate instant plugin "$plugin", "$@"/ );
1122 $class->$name($obj);
1123 $class->log->debug(qq/Initialized instant plugin "$plugin" as "$name"/)
1129 Initializes the dispatcher and engine, loads any plugins, and loads the
1130 model, view, and controller components. You may also specify an array
1131 of plugins to load here, if you choose to not load them in the C<use
1135 MyApp->setup( qw/-Debug/ );
1137 B<Note:> You B<should not> wrap this method with method modifiers
1138 or bad things will happen - wrap the C<setup_finalize> method instead.
1143 my ( $class, @arguments ) = @_;
1144 croak('Running setup more than once')
1145 if ( $class->setup_finished );
1147 unless ( $class->isa('Catalyst') ) {
1149 Catalyst::Exception->throw(
1150 message => qq/'$class' does not inherit from Catalyst/ );
1153 if ( $class->arguments ) {
1154 @arguments = ( @arguments, @{ $class->arguments } );
1160 foreach (@arguments) {
1164 ( $flags->{log} ) ? 'debug,' . $flags->{log} : 'debug';
1166 elsif (/^-(\w+)=?(.*)$/) {
1167 $flags->{ lc $1 } = $2;
1170 push @{ $flags->{plugins} }, $_;
1174 $class->setup_home( delete $flags->{home} );
1176 $class->setup_log( delete $flags->{log} );
1177 $class->setup_plugins( delete $flags->{plugins} );
1179 $class->setup_data_handlers();
1180 $class->setup_dispatcher( delete $flags->{dispatcher} );
1181 if (my $engine = delete $flags->{engine}) {
1182 $class->log->warn("Specifying the engine in ->setup is no longer supported, see Catalyst::Upgrading");
1184 $class->setup_engine();
1185 $class->setup_stats( delete $flags->{stats} );
1187 for my $flag ( sort keys %{$flags} ) {
1189 if ( my $code = $class->can( 'setup_' . $flag ) ) {
1190 &$code( $class, delete $flags->{$flag} );
1193 $class->log->warn(qq/Unknown flag "$flag"/);
1197 eval { require Catalyst::Devel; };
1198 if( !$@ && $ENV{CATALYST_SCRIPT_GEN} && ( $ENV{CATALYST_SCRIPT_GEN} < $Catalyst::Devel::CATALYST_SCRIPT_GEN ) ) {
1199 $class->log->warn(<<"EOF");
1200 You are running an old script!
1202 Please update by running (this will overwrite existing files):
1203 catalyst.pl -force -scripts $class
1205 or (this will not overwrite existing files):
1206 catalyst.pl -scripts $class
1211 # Call plugins setup, this is stupid and evil.
1212 # Also screws C3 badly on 5.10, hack to avoid.
1214 no warnings qw/redefine/;
1215 local *setup = sub { };
1216 $class->setup unless $Catalyst::__AM_RESTARTING;
1219 # If you are expecting configuration info as part of your setup, it needs
1220 # to get called here and below, since we need the above line to support
1221 # ConfigLoader based configs.
1223 $class->setup_encoding();
1224 $class->setup_middleware();
1226 # Initialize our data structure
1227 $class->components( {} );
1229 $class->setup_components;
1231 if ( $class->debug ) {
1232 my @plugins = map { "$_ " . ( $_->VERSION || '' ) } $class->registered_plugins;
1235 my $column_width = Catalyst::Utils::term_width() - 6;
1236 my $t = Text::SimpleTable->new($column_width);
1237 $t->row($_) for @plugins;
1238 $class->log->debug( "Loaded plugins:\n" . $t->draw . "\n" );
1241 my @middleware = map {
1244 (ref($_) .' '. ($_->can('VERSION') ? $_->VERSION || '' : '')
1245 || '') } $class->registered_middlewares;
1248 my $column_width = Catalyst::Utils::term_width() - 6;
1249 my $t = Text::SimpleTable->new($column_width);
1250 $t->row($_) for @middleware;
1251 $class->log->debug( "Loaded PSGI Middleware:\n" . $t->draw . "\n" );
1254 my %dh = $class->registered_data_handlers;
1255 if (my @data_handlers = keys %dh) {
1256 my $column_width = Catalyst::Utils::term_width() - 6;
1257 my $t = Text::SimpleTable->new($column_width);
1258 $t->row($_) for @data_handlers;
1259 $class->log->debug( "Loaded Request Data Handlers:\n" . $t->draw . "\n" );
1262 my $dispatcher = $class->dispatcher;
1263 my $engine = $class->engine;
1264 my $home = $class->config->{home};
1266 $class->log->debug(sprintf(q/Loaded dispatcher "%s"/, blessed($dispatcher)));
1267 $class->log->debug(sprintf(q/Loaded engine "%s"/, blessed($engine)));
1271 ? $class->log->debug(qq/Found home "$home"/)
1272 : $class->log->debug(qq/Home "$home" doesn't exist/)
1273 : $class->log->debug(q/Couldn't find home/);
1275 my $column_width = Catalyst::Utils::term_width() - 8 - 9;
1276 my $t = Text::SimpleTable->new( [ $column_width, 'Class' ], [ 8, 'Type' ] );
1277 for my $comp ( sort keys %{ $class->components } ) {
1278 my $type = ref $class->components->{$comp} ? 'instance' : 'class';
1279 $t->row( $comp, $type );
1281 $class->log->debug( "Loaded components:\n" . $t->draw . "\n" )
1282 if ( keys %{ $class->components } );
1285 # Add our self to components, since we are also a component
1286 if( $class->isa('Catalyst::Controller') ){
1287 $class->components->{$class} = $class;
1290 $class->setup_actions;
1292 if ( $class->debug ) {
1293 my $name = $class->config->{name} || 'Application';
1294 $class->log->info("$name powered by Catalyst $Catalyst::VERSION");
1297 if ($class->config->{case_sensitive}) {
1298 $class->log->warn($class . "->config->{case_sensitive} is set.");
1299 $class->log->warn("This setting is deprecated and planned to be removed in Catalyst 5.81.");
1302 $class->setup_finalize;
1304 # Flush the log for good measure (in case something turned off 'autoflush' early)
1305 $class->log->_flush() if $class->log->can('_flush');
1307 return $class || 1; # Just in case someone named their Application 0...
1310 =head2 $app->setup_finalize
1312 A hook to attach modifiers to. This method does not do anything except set the
1313 C<setup_finished> accessor.
1315 Applying method modifiers to the C<setup> method doesn't work, because of quirky things done for plugin setup.
1319 after setup_finalize => sub {
1327 sub setup_finalize {
1329 $class->setup_finished(1);
1332 =head2 $c->uri_for( $path?, @args?, \%query_values? )
1334 =head2 $c->uri_for( $action, \@captures?, @args?, \%query_values? )
1336 Constructs an absolute L<URI> object based on the application root, the
1337 provided path, and the additional arguments and query parameters provided.
1338 When used as a string, provides a textual URI. If you need more flexibility
1339 than this (i.e. the option to provide relative URIs etc.) see
1340 L<Catalyst::Plugin::SmartURI>.
1342 If no arguments are provided, the URI for the current action is returned.
1343 To return the current action and also provide @args, use
1344 C<< $c->uri_for( $c->action, @args ) >>.
1346 If the first argument is a string, it is taken as a public URI path relative
1347 to C<< $c->namespace >> (if it doesn't begin with a forward slash) or
1348 relative to the application root (if it does). It is then merged with
1349 C<< $c->request->base >>; any C<@args> are appended as additional path
1350 components; and any C<%query_values> are appended as C<?foo=bar> parameters.
1352 If the first argument is a L<Catalyst::Action> it represents an action which
1353 will have its path resolved using C<< $c->dispatcher->uri_for_action >>. The
1354 optional C<\@captures> argument (an arrayref) allows passing the captured
1355 variables that are needed to fill in the paths of Chained and Regex actions;
1356 once the path is resolved, C<uri_for> continues as though a path was
1357 provided, appending any arguments or parameters and creating an absolute
1360 The captures for the current request can be found in
1361 C<< $c->request->captures >>, and actions can be resolved using
1362 C<< Catalyst::Controller->action_for($name) >>. If you have a private action
1363 path, use C<< $c->uri_for_action >> instead.
1365 # Equivalent to $c->req->uri
1366 $c->uri_for($c->action, $c->req->captures,
1367 @{ $c->req->args }, $c->req->params);
1369 # For the Foo action in the Bar controller
1370 $c->uri_for($c->controller('Bar')->action_for('Foo'));
1372 # Path to a static resource
1373 $c->uri_for('/static/images/logo.png');
1378 my ( $c, $path, @args ) = @_;
1380 if ( $path->$_isa('Catalyst::Controller') ) {
1381 $path = $path->path_prefix;
1386 undef($path) if (defined $path && $path eq '');
1389 ( scalar @args && ref $args[$#args] eq 'HASH' ? pop @args : {} );
1391 carp "uri_for called with undef argument" if grep { ! defined $_ } @args;
1393 my @encoded_args = ();
1394 foreach my $arg (@args) {
1395 if(ref($arg)||'' eq 'ARRAY') {
1396 push @encoded_args, [map {
1397 my $encoded = encode_utf8 $_;
1398 $encoded =~ s/([^$URI::uric])/$URI::Escape::escapes{$1}/go;
1402 push @encoded_args, do {
1403 my $encoded = encode_utf8 $arg;
1404 $encoded =~ s/([^$URI::uric])/$URI::Escape::escapes{$1}/go;
1410 if ( $path->$_isa('Catalyst::Action') ) { # action object
1411 s|/|%2F|g for @encoded_args;
1412 my $captures = [ map { s|/|%2F|g; $_; }
1413 ( scalar @encoded_args && ref $encoded_args[0] eq 'ARRAY'
1414 ? @{ shift(@encoded_args) }
1418 # ->uri_for( $action, \@captures_and_args, \%query_values? )
1419 if( !@encoded_args && $action->number_of_args ) {
1420 my $expanded_action = $c->dispatcher->expand_action( $action );
1422 my $num_captures = $expanded_action->number_of_captures;
1423 unshift @encoded_args, splice @$captures, $num_captures;
1426 $path = $c->dispatcher->uri_for_action($action, $captures);
1427 if (not defined $path) {
1428 $c->log->debug(qq/Can't find uri_for action '$action' @$captures/)
1432 $path = '/' if $path eq '';
1435 unshift(@encoded_args, $path);
1437 unless (defined $path && $path =~ s!^/!!) { # in-place strip
1438 my $namespace = $c->namespace;
1439 if (defined $path) { # cheesy hack to handle path '../foo'
1440 $namespace =~ s{(?:^|/)[^/]+$}{} while $encoded_args[0] =~ s{^\.\./}{};
1442 unshift(@encoded_args, $namespace || '');
1445 # join args with '/', or a blank string
1446 my $args = join('/', grep { defined($_) } @encoded_args);
1447 $args =~ s/\?/%3F/g; # STUPID STUPID SPECIAL CASE
1450 my ($base, $class) = ('/', 'URI::_generic');
1452 $base = $c->req->base;
1453 $class = ref($base);
1454 $base =~ s{(?<!/)$}{/};
1459 if (my @keys = keys %$params) {
1460 # somewhat lifted from URI::_query's query_form
1461 $query = '?'.join('&', map {
1462 my $val = $params->{$_};
1463 #s/([;\/?:@&=+,\$\[\]%])/$URI::Escape::escapes{$1}/go; ## Commented out because seems to lead to double encoding - JNAP
1466 $val = '' unless defined $val;
1469 $param = encode_utf8($param);
1470 # using the URI::Escape pattern here so utf8 chars survive
1471 $param =~ s/([^A-Za-z0-9\-_.!~*'() ])/$URI::Escape::escapes{$1}/go;
1474 $key = encode_utf8($key);
1475 # using the URI::Escape pattern here so utf8 chars survive
1476 $key =~ s/([^A-Za-z0-9\-_.!~*'() ])/$URI::Escape::escapes{$1}/go;
1479 "${key}=$param"; } ( ref $val eq 'ARRAY' ? @$val : $val ));
1483 my $res = bless(\"${base}${args}${query}", $class);
1487 =head2 $c->uri_for_action( $path, \@captures_and_args?, @args?, \%query_values? )
1489 =head2 $c->uri_for_action( $action, \@captures_and_args?, @args?, \%query_values? )
1495 A private path to the Catalyst action you want to create a URI for.
1497 This is a shortcut for calling C<< $c->dispatcher->get_action_by_path($path)
1498 >> and passing the resulting C<$action> and the remaining arguments to C<<
1501 You can also pass in a Catalyst::Action object, in which case it is passed to
1504 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.
1506 For example, if the action looks like:
1508 package MyApp::Controller::Users;
1510 sub lst : Path('the-list') {}
1514 $c->uri_for_action('/users/lst')
1516 and it will create the URI /users/the-list.
1518 =item \@captures_and_args?
1520 Optional array reference of Captures (i.e. C<<CaptureArgs or $c->req->captures>)
1521 and arguments to the request. Usually used with L<Catalyst::DispatchType::Chained>
1522 to interpolate all the parameters in the URI.
1526 Optional list of extra arguments - can be supplied in the
1527 C<< \@captures_and_args? >> array ref, or here - whichever is easier for your
1530 Your action can have zero, a fixed or a variable number of args (e.g.
1531 C<< Args(1) >> for a fixed number or C<< Args() >> for a variable number)..
1533 =item \%query_values?
1535 Optional array reference of query parameters to append. E.g.
1541 /rest/of/your/uri?foo=bar
1547 sub uri_for_action {
1548 my ( $c, $path, @args ) = @_;
1549 my $action = blessed($path)
1551 : $c->dispatcher->get_action_by_path($path);
1552 unless (defined $action) {
1553 croak "Can't find action for path '$path'";
1555 return $c->uri_for( $action, @args );
1558 =head2 $c->welcome_message
1560 Returns the Catalyst welcome HTML page.
1564 sub welcome_message {
1566 my $name = $c->config->{name};
1567 my $logo = $c->uri_for('/static/images/catalyst_logo.png');
1568 my $prefix = Catalyst::Utils::appprefix( ref $c );
1569 $c->response->content_type('text/html; charset=utf-8');
1571 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
1572 "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
1573 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
1575 <meta http-equiv="Content-Language" content="en" />
1576 <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
1577 <title>$name on Catalyst $VERSION</title>
1578 <style type="text/css">
1581 background-color: #eee;
1588 margin-bottom: 10px;
1590 background-color: #ccc;
1591 border: 1px solid #aaa;
1596 font-family: verdana, tahoma, sans-serif;
1599 font-family: verdana, tahoma, sans-serif;
1602 text-decoration: none;
1604 border-bottom: 1px dotted #bbb;
1606 :link:hover, :visited:hover {
1619 background-color: #fff;
1620 border: 1px solid #aaa;
1624 font-weight: normal;
1646 <h1><span id="appname">$name</span> on <a href="http://catalyst.perl.org">Catalyst</a>
1651 <img src="$logo" alt="Catalyst Logo" />
1653 <p>Welcome to the world of Catalyst.
1654 This <a href="http://en.wikipedia.org/wiki/MVC">MVC</a>
1655 framework will make web development something you had
1656 never expected it to be: Fun, rewarding, and quick.</p>
1657 <h2>What to do now?</h2>
1658 <p>That really depends on what <b>you</b> want to do.
1659 We do, however, provide you with a few starting points.</p>
1660 <p>If you want to jump right into web development with Catalyst
1661 you might want to start with a tutorial.</p>
1662 <pre>perldoc <a href="https://metacpan.org/module/Catalyst::Manual::Tutorial">Catalyst::Manual::Tutorial</a></code>
1664 <p>Afterwards you can go on to check out a more complete look at our features.</p>
1666 <code>perldoc <a href="https://metacpan.org/module/Catalyst::Manual::Intro">Catalyst::Manual::Intro</a>
1667 <!-- Something else should go here, but the Catalyst::Manual link seems unhelpful -->
1669 <h2>What to do next?</h2>
1670 <p>Next it's time to write an actual application. Use the
1671 helper scripts to generate <a href="https://metacpan.org/search?q=Catalyst%3A%3AController">controllers</a>,
1672 <a href="https://metacpan.org/search?q=Catalyst%3A%3AModel">models</a>, and
1673 <a href="https://metacpan.org/search?q=Catalyst%3A%3AView">views</a>;
1674 they can save you a lot of work.</p>
1675 <pre><code>script/${prefix}_create.pl --help</code></pre>
1676 <p>Also, be sure to check out the vast and growing
1677 collection of <a href="http://search.cpan.org/search?query=Catalyst">plugins for Catalyst on CPAN</a>;
1678 you are likely to find what you need there.
1682 <p>Catalyst has a very active community. Here are the main places to
1683 get in touch with us.</p>
1686 <a href="http://dev.catalyst.perl.org">Wiki</a>
1689 <a href="http://lists.scsys.co.uk/cgi-bin/mailman/listinfo/catalyst">Mailing-List</a>
1692 <a href="irc://irc.perl.org/catalyst">IRC channel #catalyst on irc.perl.org</a>
1695 <h2>In conclusion</h2>
1696 <p>The Catalyst team hopes you will enjoy using Catalyst as much
1697 as we enjoyed making it. Please contact us if you have ideas
1698 for improvement or other feedback.</p>
1708 Contains a hash of options passed from the application script, including
1709 the original ARGV the script received, the processed values from that
1710 ARGV and any extra arguments to the script which were not processed.
1712 This can be used to add custom options to your application's scripts
1713 and setup your application differently depending on the values of these
1716 =head1 INTERNAL METHODS
1718 These methods are not meant to be used by end users.
1720 =head2 $c->components
1722 Returns a hash of components.
1724 =head2 $c->context_class
1726 Returns or sets the context class.
1730 Returns a hashref containing coderefs and execution counts (needed for
1731 deep recursion detection).
1735 Returns the number of actions on the current internal execution stack.
1739 Dispatches a request to actions.
1743 sub dispatch { my $c = shift; $c->dispatcher->dispatch( $c, @_ ) }
1745 =head2 $c->dispatcher_class
1747 Returns or sets the dispatcher class.
1749 =head2 $c->dump_these
1751 Returns a list of 2-element array references (name, structure) pairs
1752 that will be dumped on the error page in debug mode.
1758 [ Request => $c->req ],
1759 [ Response => $c->res ],
1760 [ Stash => $c->stash ],
1761 [ Config => $c->config ];
1764 =head2 $c->engine_class
1766 Returns or sets the engine class.
1768 =head2 $c->execute( $class, $coderef )
1770 Execute a coderef in given class and catch exceptions. Errors are available
1776 my ( $c, $class, $code ) = @_;
1777 $class = $c->component($class) || $class;
1780 if ( $c->depth >= $RECURSION ) {
1781 my $action = $code->reverse();
1782 $action = "/$action" unless $action =~ /->/;
1783 my $error = qq/Deep recursion detected calling "${action}"/;
1784 $c->log->error($error);
1790 my $stats_info = $c->_stats_start_execute( $code ) if $c->use_stats;
1792 push( @{ $c->stack }, $code );
1794 no warnings 'recursion';
1795 # N.B. This used to be combined, but I have seen $c get clobbered if so, and
1796 # I have no idea how, ergo $ret (which appears to fix the issue)
1797 eval { my $ret = $code->execute( $class, $c, @{ $c->req->args } ) || 0; $c->state( $ret ) };
1799 $c->_stats_finish_execute( $stats_info ) if $c->use_stats and $stats_info;
1801 my $last = pop( @{ $c->stack } );
1803 if ( my $error = $@ ) {
1804 #rethow if this can be handled by middleware
1805 if(blessed $error && ($error->can('as_psgi') || $error->can('code'))) {
1806 foreach my $err (@{$c->error}) {
1807 $c->log->error($err);
1810 $c->log->_flush if $c->log->can('_flush');
1812 $error->can('rethrow') ? $error->rethrow : croak $error;
1814 if ( blessed($error) and $error->isa('Catalyst::Exception::Detach') ) {
1815 $error->rethrow if $c->depth > 1;
1817 elsif ( blessed($error) and $error->isa('Catalyst::Exception::Go') ) {
1818 $error->rethrow if $c->depth > 0;
1821 unless ( ref $error ) {
1822 no warnings 'uninitialized';
1824 my $class = $last->class;
1825 my $name = $last->name;
1826 $error = qq/Caught exception in $class->$name "$error"/;
1835 sub _stats_start_execute {
1836 my ( $c, $code ) = @_;
1837 my $appclass = ref($c) || $c;
1838 return if ( ( $code->name =~ /^_.*/ )
1839 && ( !$appclass->config->{show_internal_actions} ) );
1841 my $action_name = $code->reverse();
1842 $c->counter->{$action_name}++;
1844 my $action = $action_name;
1845 $action = "/$action" unless $action =~ /->/;
1847 # determine if the call was the result of a forward
1848 # this is done by walking up the call stack and looking for a calling
1849 # sub of Catalyst::forward before the eval
1851 for my $index ( 2 .. 11 ) {
1853 if ( ( caller($index) )[0] eq 'Catalyst'
1854 && ( caller($index) )[3] eq '(eval)' );
1856 if ( ( caller($index) )[3] =~ /forward$/ ) {
1857 $callsub = ( caller($index) )[3];
1858 $action = "-> $action";
1863 my $uid = $action_name . $c->counter->{$action_name};
1865 # is this a root-level call or a forwarded call?
1866 if ( $callsub =~ /forward$/ ) {
1867 my $parent = $c->stack->[-1];
1869 # forward, locate the caller
1870 if ( defined $parent && exists $c->counter->{"$parent"} ) {
1873 parent => "$parent" . $c->counter->{"$parent"},
1879 # forward with no caller may come from a plugin
1898 sub _stats_finish_execute {
1899 my ( $c, $info ) = @_;
1900 $c->stats->profile( end => $info );
1905 Finalizes the request.
1912 for my $error ( @{ $c->error } ) {
1913 $c->log->error($error);
1916 # Support skipping finalize for psgix.io style 'jailbreak'. Used to support
1917 # stuff like cometd and websockets
1919 if($c->request->_has_io_fh) {
1924 # Allow engine to handle finalize flow (for POE)
1925 my $engine = $c->engine;
1926 if ( my $code = $engine->can('finalize') ) {
1931 $c->finalize_uploads;
1934 if ( $#{ $c->error } >= 0 ) {
1938 $c->finalize_encoding;
1939 $c->finalize_headers unless $c->response->finalized_headers;
1945 if ($c->use_stats) {
1946 my $elapsed = $c->stats->elapsed;
1947 my $av = $elapsed == 0 ? '??' : sprintf '%.3f', 1 / $elapsed;
1949 "Request took ${elapsed}s ($av/s)\n" . $c->stats->report . "\n" );
1952 return $c->response->status;
1955 =head2 $c->finalize_body
1961 sub finalize_body { my $c = shift; $c->engine->finalize_body( $c, @_ ) }
1963 =head2 $c->finalize_cookies
1969 sub finalize_cookies { my $c = shift; $c->engine->finalize_cookies( $c, @_ ) }
1971 =head2 $c->finalize_error
1973 Finalizes error. If there is only one error in L</error> and it is an object that
1974 does C<as_psgi> or C<code> we rethrow the error and presume it caught by middleware
1975 up the ladder. Otherwise we return the debugging error page (in debug mode) or we
1976 return the default error page (production mode).
1980 sub finalize_error {
1982 if($#{$c->error} > 0) {
1983 $c->engine->finalize_error( $c, @_ );
1985 my ($error) = @{$c->error};
1988 ($error->can('as_psgi') || $error->can('code'))
1990 # In the case where the error 'knows what it wants', becauses its PSGI
1991 # aware, just rethow and let middleware catch it
1992 $error->can('rethrow') ? $error->rethrow : croak $error;
1994 $c->engine->finalize_error( $c, @_ )
1999 =head2 $c->finalize_headers
2005 sub finalize_headers {
2008 my $response = $c->response; #accessor calls can add up?
2010 # Check if we already finalized headers
2011 return if $response->finalized_headers;
2014 if ( my $location = $response->redirect ) {
2015 $c->log->debug(qq/Redirecting to "$location"/) if $c->debug;
2016 $response->header( Location => $location );
2019 # Remove incorrectly added body and content related meta data when returning
2020 # an information response, or a response the is required to not include a body
2022 $c->finalize_cookies;
2024 $c->response->finalize_headers();
2027 $response->finalized_headers(1);
2030 =head2 $c->finalize_encoding
2032 Make sure your headers and body are encoded properly IF you set an encoding.
2037 sub finalize_encoding {
2040 my $body = $c->response->body;
2042 return unless defined($body);
2044 my $enc = $c->encoding;
2048 my ($ct, $ct_enc) = $c->response->content_type;
2050 # Only touch 'text-like' contents
2051 return unless $c->response->content_type =~ /^text|xml$|javascript$/;
2053 if ($ct_enc && $ct_enc =~ /charset=([^;]*)/) {
2054 if (uc($1) ne uc($enc->mime_name)) {
2055 $c->log->debug("Unicode::Encoding is set to encode in '" .
2057 "', content type is '$1', not encoding ");
2061 $c->res->content_type($c->res->content_type . "; charset=" . $enc->mime_name);
2064 # Oh my, I wonder what filehandle responses and streams do... - jnap.
2065 # Encode expects plain scalars (IV, NV or PV) and segfaults on ref's
2066 if (ref(\$body) eq 'SCALAR') {
2067 $c->response->body( $c->encoding->encode( $body, $c->_encode_check ) );
2071 =head2 $c->finalize_output
2073 An alias for finalize_body.
2075 =head2 $c->finalize_read
2077 Finalizes the input after reading is complete.
2081 sub finalize_read { my $c = shift; $c->engine->finalize_read( $c, @_ ) }
2083 =head2 $c->finalize_uploads
2085 Finalizes uploads. Cleans up any temporary files.
2089 sub finalize_uploads { my $c = shift; $c->engine->finalize_uploads( $c, @_ ) }
2091 =head2 $c->get_action( $action, $namespace )
2093 Gets an action in a given namespace.
2097 sub get_action { my $c = shift; $c->dispatcher->get_action(@_) }
2099 =head2 $c->get_actions( $action, $namespace )
2101 Gets all actions of a given name in a namespace and all parent
2106 sub get_actions { my $c = shift; $c->dispatcher->get_actions( $c, @_ ) }
2108 =head2 $app->handle_request( @arguments )
2110 Called to handle each HTTP request.
2114 sub handle_request {
2115 my ( $class, @arguments ) = @_;
2117 # Always expect worst case!
2120 if ($class->debug) {
2121 my $secs = time - $START || 1;
2122 my $av = sprintf '%.3f', $COUNT / $secs;
2123 my $time = localtime time;
2124 $class->log->info("*** Request $COUNT ($av/s) [$$] [$time] ***");
2127 my $c = $class->prepare(@arguments);
2129 $status = $c->finalize;
2131 #rethow if this can be handled by middleware
2132 if(blessed $_ && ($_->can('as_psgi') || $_->can('code'))) {
2133 $_->can('rethrow') ? $_->rethrow : croak $_;
2135 chomp(my $error = $_);
2136 $class->log->error(qq/Caught exception in engine "$error"/);
2141 if(my $coderef = $class->log->can('_flush')){
2142 $class->log->$coderef();
2147 =head2 $class->prepare( @arguments )
2149 Creates a Catalyst context from an engine-specific request (Apache, CGI,
2156 predicate => '_has_uploadtmp',
2160 my ( $class, @arguments ) = @_;
2163 # After the app/ctxt split, this should become an attribute based on something passed
2164 # into the application.
2165 $class->context_class( ref $class || $class ) unless $class->context_class;
2167 my $uploadtmp = $class->config->{uploadtmp};
2168 my $c = $class->context_class->new({ $uploadtmp ? (_uploadtmp => $uploadtmp) : ()});
2170 $c->response->_context($c);
2172 #surely this is not the most efficient way to do things...
2173 $c->stats($class->stats_class->new)->enable($c->use_stats);
2174 if ( $c->debug || $c->config->{enable_catalyst_header} ) {
2175 $c->res->headers->header( 'X-Catalyst' => $Catalyst::VERSION );
2179 # Allow engine to direct the prepare flow (for POE)
2180 if ( my $prepare = $c->engine->can('prepare') ) {
2181 $c->engine->$prepare( $c, @arguments );
2184 $c->prepare_request(@arguments);
2185 $c->prepare_connection;
2186 $c->prepare_query_parameters;
2187 $c->prepare_headers; # Just hooks, no longer needed - they just
2188 $c->prepare_cookies; # cause the lazy attribute on req to build
2191 # Prepare the body for reading, either by prepare_body
2192 # or the user, if they are using $c->read
2195 # Parse the body unless the user wants it on-demand
2196 unless ( ref($c)->config->{parse_on_demand} ) {
2202 # VERY ugly and probably shouldn't rely on ->finalize actually working
2204 # failed prepare is always due to an invalid request, right?
2205 $c->response->status(400);
2206 $c->response->content_type('text/plain');
2207 $c->response->body('Bad Request');
2208 # Note we call finalize and then die here, which escapes
2209 # finalize being called in the enclosing block..
2210 # It in fact couldn't be called, as we don't return $c..
2211 # This is a mess - but I'm unsure you can fix this without
2212 # breaking compat for people doing crazy things (we should set
2213 # the 400 and just return the ctx here IMO, letting finalize get called
2224 =head2 $c->prepare_action
2226 Prepares action. See L<Catalyst::Dispatcher>.
2230 sub prepare_action {
2232 my $ret = $c->dispatcher->prepare_action( $c, @_);
2235 foreach (@{$c->req->arguments}, @{$c->req->captures}) {
2236 $_ = $c->_handle_param_unicode_decoding($_);
2244 =head2 $c->prepare_body
2246 Prepares message body.
2253 return if $c->request->_has_body;
2255 # Initialize on-demand data
2256 $c->engine->prepare_body( $c, @_ );
2257 $c->prepare_parameters;
2258 $c->prepare_uploads;
2261 =head2 $c->prepare_body_chunk( $chunk )
2263 Prepares a chunk of data before sending it to L<HTTP::Body>.
2265 See L<Catalyst::Engine>.
2269 sub prepare_body_chunk {
2271 $c->engine->prepare_body_chunk( $c, @_ );
2274 =head2 $c->prepare_body_parameters
2276 Prepares body parameters.
2280 sub prepare_body_parameters {
2282 $c->request->prepare_body_parameters( $c, @_ );
2284 # If we have an encoding configured (like UTF-8) in general we expect a client
2285 # to POST with the encoding we fufilled the request in. Otherwise don't do any
2286 # encoding (good change wide chars could be in HTML entity style llike the old
2289 # so, now that HTTP::Body prepared the body params, we gotta 'walk' the structure
2290 # and do any needed decoding.
2292 # This only does something if the encoding is set via the encoding param. Remember
2293 # this is assuming the client is not bad and responds with what you provided. In
2294 # general you can just use utf8 and get away with it.
2297 my $current_parameters = $c->request->body_parameters;
2298 $c->request->body_parameters($c->_handle_unicode_decoding($current_parameters));
2302 =head2 $c->prepare_connection
2304 Prepares connection.
2308 sub prepare_connection {
2310 $c->request->prepare_connection($c);
2313 =head2 $c->prepare_cookies
2315 Prepares cookies by ensuring that the attribute on the request
2316 object has been built.
2320 sub prepare_cookies { my $c = shift; $c->request->cookies }
2322 =head2 $c->prepare_headers
2324 Prepares request headers by ensuring that the attribute on the request
2325 object has been built.
2329 sub prepare_headers { my $c = shift; $c->request->headers }
2331 =head2 $c->prepare_parameters
2333 Prepares parameters.
2337 sub prepare_parameters {
2339 $c->prepare_body_parameters;
2340 $c->engine->prepare_parameters( $c, @_ );
2343 =head2 $c->prepare_path
2345 Prepares path and base.
2349 sub prepare_path { my $c = shift; $c->engine->prepare_path( $c, @_ ) }
2351 =head2 $c->prepare_query_parameters
2353 Prepares query parameters.
2357 sub prepare_query_parameters {
2360 $c->engine->prepare_query_parameters( $c, @_ );
2363 =head2 $c->log_request
2365 Writes information about the request to the debug logs. This includes:
2369 =item * Request method, path, and remote IP address
2371 =item * Query keywords (see L<Catalyst::Request/query_keywords>)
2373 =item * Request parameters
2375 =item * File uploads
2384 return unless $c->debug;
2386 my($dump) = grep {$_->[0] eq 'Request' } $c->dump_these;
2387 my $request = $dump->[1];
2389 my ( $method, $path, $address ) = ( $request->method, $request->path, $request->address );
2391 $path = '/' unless length $path;
2394 $path =~ s/%([0-9A-Fa-f]{2})/chr(hex($1))/eg;
2395 $path = decode_utf8($path);
2397 $c->log->debug(qq/"$method" request for "$path" from "$address"/);
2399 $c->log_request_headers($request->headers);
2401 if ( my $keywords = $request->query_keywords ) {
2402 $c->log->debug("Query keywords are: $keywords");
2405 $c->log_request_parameters( query => $request->query_parameters, $request->_has_body ? (body => $request->body_parameters) : () );
2407 $c->log_request_uploads($request);
2410 =head2 $c->log_response
2412 Writes information about the response to the debug logs by calling
2413 C<< $c->log_response_status_line >> and C<< $c->log_response_headers >>.
2420 return unless $c->debug;
2422 my($dump) = grep {$_->[0] eq 'Response' } $c->dump_these;
2423 my $response = $dump->[1];
2425 $c->log_response_status_line($response);
2426 $c->log_response_headers($response->headers);
2429 =head2 $c->log_response_status_line($response)
2431 Writes one line of information about the response to the debug logs. This includes:
2435 =item * Response status code
2437 =item * Content-Type header (if present)
2439 =item * Content-Length header (if present)
2445 sub log_response_status_line {
2446 my ($c, $response) = @_;
2450 'Response Code: %s; Content-Type: %s; Content-Length: %s',
2451 $response->status || 'unknown',
2452 $response->headers->header('Content-Type') || 'unknown',
2453 $response->headers->header('Content-Length') || 'unknown'
2458 =head2 $c->log_response_headers($headers);
2460 Hook method which can be wrapped by plugins to log the response headers.
2461 No-op in the default implementation.
2465 sub log_response_headers {}
2467 =head2 $c->log_request_parameters( query => {}, body => {} )
2469 Logs request parameters to debug logs
2473 sub log_request_parameters {
2475 my %all_params = @_;
2477 return unless $c->debug;
2479 my $column_width = Catalyst::Utils::term_width() - 44;
2480 foreach my $type (qw(query body)) {
2481 my $params = $all_params{$type};
2482 next if ! keys %$params;
2483 my $t = Text::SimpleTable->new( [ 35, 'Parameter' ], [ $column_width, 'Value' ] );
2484 for my $key ( sort keys %$params ) {
2485 my $param = $params->{$key};
2486 my $value = defined($param) ? $param : '';
2487 $t->row( $key, ref $value eq 'ARRAY' ? ( join ', ', @$value ) : $value );
2489 $c->log->debug( ucfirst($type) . " Parameters are:\n" . $t->draw );
2493 =head2 $c->log_request_uploads
2495 Logs file uploads included in the request to the debug logs.
2496 The parameter name, filename, file type, and file size are all included in
2501 sub log_request_uploads {
2503 my $request = shift;
2504 return unless $c->debug;
2505 my $uploads = $request->uploads;
2506 if ( keys %$uploads ) {
2507 my $t = Text::SimpleTable->new(
2508 [ 12, 'Parameter' ],
2513 for my $key ( sort keys %$uploads ) {
2514 my $upload = $uploads->{$key};
2515 for my $u ( ref $upload eq 'ARRAY' ? @{$upload} : ($upload) ) {
2516 $t->row( $key, $u->filename, $u->type, $u->size );
2519 $c->log->debug( "File Uploads are:\n" . $t->draw );
2523 =head2 $c->log_request_headers($headers);
2525 Hook method which can be wrapped by plugins to log the request headers.
2526 No-op in the default implementation.
2530 sub log_request_headers {}
2532 =head2 $c->log_headers($type => $headers)
2534 Logs L<HTTP::Headers> (either request or response) to the debug logs.
2541 my $headers = shift; # an HTTP::Headers instance
2543 return unless $c->debug;
2545 my $column_width = Catalyst::Utils::term_width() - 28;
2546 my $t = Text::SimpleTable->new( [ 15, 'Header Name' ], [ $column_width, 'Value' ] );
2549 my ( $name, $value ) = @_;
2550 $t->row( $name, $value );
2553 $c->log->debug( ucfirst($type) . " Headers:\n" . $t->draw );
2557 =head2 $c->prepare_read
2559 Prepares the input for reading.
2563 sub prepare_read { my $c = shift; $c->engine->prepare_read( $c, @_ ) }
2565 =head2 $c->prepare_request
2567 Prepares the engine request.
2571 sub prepare_request { my $c = shift; $c->engine->prepare_request( $c, @_ ) }
2573 =head2 $c->prepare_uploads
2579 sub prepare_uploads {
2581 $c->engine->prepare_uploads( $c, @_ );
2583 my $enc = $c->encoding;
2586 ## Only trying to decode the filenames.
2587 for my $value ( values %{ $c->request->uploads } ) {
2588 # skip if it fails for uploads, as we don't usually want uploads touched
2590 for my $inner_value ( ref($value) eq 'ARRAY' ? @{$value} : $value ) {
2591 $inner_value->{filename} = try {
2592 $enc->decode( $inner_value->{filename}, $c->_encode_check )
2594 $c->handle_unicode_encoding_exception({
2595 param_value => $inner_value->{filename},
2597 encoding_step => 'uploads',
2604 =head2 $c->prepare_write
2606 Prepares the output for writing.
2610 sub prepare_write { my $c = shift; $c->engine->prepare_write( $c, @_ ) }
2612 =head2 $c->request_class
2614 Returns or sets the request class. Defaults to L<Catalyst::Request>.
2616 =head2 $c->response_class
2618 Returns or sets the response class. Defaults to L<Catalyst::Response>.
2620 =head2 $c->read( [$maxlength] )
2622 Reads a chunk of data from the request body. This method is designed to
2623 be used in a while loop, reading C<$maxlength> bytes on every call.
2624 C<$maxlength> defaults to the size of the request if not specified.
2626 You have to set C<< MyApp->config(parse_on_demand => 1) >> to use this
2629 Warning: If you use read(), Catalyst will not process the body,
2630 so you will not be able to access POST parameters or file uploads via
2631 $c->request. You must handle all body parsing yourself.
2635 sub read { my $c = shift; return $c->request->read( @_ ) }
2645 $app->_make_immutable_if_needed;
2646 $app->engine_loader->needs_psgi_engine_compat_hack ?
2647 $app->engine->run($app, @_) :
2648 $app->engine->run( $app, $app->_finalized_psgi_app, @_ );
2651 sub _make_immutable_if_needed {
2653 my $meta = find_meta($class);
2654 my $isa_ca = $class->isa('Class::Accessor::Fast') || $class->isa('Class::Accessor');
2657 && ! { $meta->immutable_options }->{replace_constructor}
2660 warn("You made your application class ($class) immutable, "
2661 . "but did not inline the\nconstructor. "
2662 . "This will break catalyst, as your app \@ISA "
2663 . "Class::Accessor(::Fast)?\nPlease pass "
2664 . "(replace_constructor => 1)\nwhen making your class immutable.\n");
2666 unless ($meta->is_immutable) {
2667 # XXX - FIXME warning here as you should make your app immutable yourself.
2668 $meta->make_immutable(
2669 replace_constructor => 1,
2674 =head2 $c->set_action( $action, $code, $namespace, $attrs )
2676 Sets an action in a given namespace.
2680 sub set_action { my $c = shift; $c->dispatcher->set_action( $c, @_ ) }
2682 =head2 $c->setup_actions($component)
2684 Sets up actions for a component.
2688 sub setup_actions { my $c = shift; $c->dispatcher->setup_actions( $c, @_ ) }
2690 =head2 $c->setup_components
2692 This method is called internally to set up the application's components.
2694 It finds modules by calling the L<locate_components> method, expands them to
2695 package names with the L<expand_component_module> method, and then installs
2696 each component into the application.
2698 The C<setup_components> config option is passed to both of the above methods.
2700 Installation of each component is performed by the L<setup_component> method,
2705 sub setup_components {
2708 my $config = $class->config->{ setup_components };
2710 my @comps = $class->locate_components($config);
2711 my %comps = map { $_ => 1 } @comps;
2713 my $deprecatedcatalyst_component_names = grep { /::[CMV]::/ } @comps;
2714 $class->log->warn(qq{Your application is using the deprecated ::[MVC]:: type naming scheme.\n}.
2715 qq{Please switch your class names to ::Model::, ::View:: and ::Controller: as appropriate.\n}
2716 ) if $deprecatedcatalyst_component_names;
2718 for my $component ( @comps ) {
2720 # We pass ignore_loaded here so that overlay files for (e.g.)
2721 # Model::DBI::Schema sub-classes are loaded - if it's in @comps
2722 # we know M::P::O found a file on disk so this is safe
2724 Catalyst::Utils::ensure_class_loaded( $component, { ignore_loaded => 1 } );
2727 for my $component (@comps) {
2728 my $instance = $class->components->{ $component } = $class->setup_component($component);
2729 my @expanded_components = $instance->can('expand_modules')
2730 ? $instance->expand_modules( $component, $config )
2731 : $class->expand_component_module( $component, $config );
2732 for my $component (@expanded_components) {
2733 next if $comps{$component};
2734 $class->components->{ $component } = $class->setup_component($component);
2739 =head2 $c->locate_components( $setup_component_config )
2741 This method is meant to provide a list of component modules that should be
2742 setup for the application. By default, it will use L<Module::Pluggable>.
2744 Specify a C<setup_components> config option to pass additional options directly
2745 to L<Module::Pluggable>. To add additional search paths, specify a key named
2746 C<search_extra> as an array reference. Items in the array beginning with C<::>
2747 will have the application class name prepended to them.
2751 sub locate_components {
2755 my @paths = qw( ::M ::Model ::V ::View ::C ::Controller );
2756 my $extra = delete $config->{ search_extra } || [];
2758 unshift @paths, @$extra;
2760 my @comps = map { sort { length($a) <=> length($b) } Module::Pluggable::Object->new(
2761 search_path => [ map { s/^(?=::)/$class/; $_; } ($_) ],
2763 )->plugins } @paths;
2768 =head2 $c->expand_component_module( $component, $setup_component_config )
2770 Components found by C<locate_components> will be passed to this method, which
2771 is expected to return a list of component (package) names to be set up.
2775 sub expand_component_module {
2776 my ($class, $module) = @_;
2777 return Devel::InnerPackage::list_packages( $module );
2780 =head2 $c->setup_component
2784 sub setup_component {
2785 my( $class, $component ) = @_;
2787 unless ( $component->can( 'COMPONENT' ) ) {
2791 my $suffix = Catalyst::Utils::class2classsuffix( $component );
2792 my $config = $class->config->{ $suffix } || {};
2793 # Stash catalyst_component_name in the config here, so that custom COMPONENT
2794 # methods also pass it. local to avoid pointlessly shitting in config
2795 # for the debug screen, as $component is already the key name.
2796 local $config->{catalyst_component_name} = $component;
2798 my $instance = eval { $component->COMPONENT( $class, $config ); };
2800 if ( my $error = $@ ) {
2802 Catalyst::Exception->throw(
2803 message => qq/Couldn't instantiate component "$component", "$error"/
2807 unless (blessed $instance) {
2808 my $metaclass = Moose::Util::find_meta($component);
2809 my $method_meta = $metaclass->find_method_by_name('COMPONENT');
2810 my $component_method_from = $method_meta->associated_metaclass->name;
2811 my $value = defined($instance) ? $instance : 'undef';
2812 Catalyst::Exception->throw(
2814 qq/Couldn't instantiate component "$component", COMPONENT() method (from $component_method_from) didn't return an object-like value (value was $value)./
2820 =head2 $c->setup_dispatcher
2826 sub setup_dispatcher {
2827 my ( $class, $dispatcher ) = @_;
2830 $dispatcher = 'Catalyst::Dispatcher::' . $dispatcher;
2833 if ( my $env = Catalyst::Utils::env_value( $class, 'DISPATCHER' ) ) {
2834 $dispatcher = 'Catalyst::Dispatcher::' . $env;
2837 unless ($dispatcher) {
2838 $dispatcher = $class->dispatcher_class;
2841 load_class($dispatcher);
2843 # dispatcher instance
2844 $class->dispatcher( $dispatcher->new );
2847 =head2 $c->setup_engine
2854 my ($class, $requested_engine) = @_;
2856 if (!$class->engine_loader || $requested_engine) {
2857 $class->engine_loader(
2858 Catalyst::EngineLoader->new({
2859 application_name => $class,
2860 (defined $requested_engine
2861 ? (catalyst_engine_class => $requested_engine) : ()),
2866 $class->engine_loader->catalyst_engine_class;
2870 my ($class, $requested_engine) = @_;
2873 my $loader = $class->engine_loader;
2875 if (!$loader || $requested_engine) {
2876 $loader = Catalyst::EngineLoader->new({
2877 application_name => $class,
2878 (defined $requested_engine
2879 ? (requested_engine => $requested_engine) : ()),
2882 $class->engine_loader($loader);
2885 $loader->catalyst_engine_class;
2888 # Don't really setup_engine -- see _setup_psgi_app for explanation.
2889 return if $class->loading_psgi_file;
2891 load_class($engine);
2893 if ($ENV{MOD_PERL}) {
2894 my $apache = $class->engine_loader->auto;
2896 my $meta = find_meta($class);
2897 my $was_immutable = $meta->is_immutable;
2898 my %immutable_options = $meta->immutable_options;
2899 $meta->make_mutable if $was_immutable;
2901 $meta->add_method(handler => sub {
2903 my $psgi_app = $class->_finalized_psgi_app;
2904 $apache->call_app($r, $psgi_app);
2907 $meta->make_immutable(%immutable_options) if $was_immutable;
2910 $class->engine( $engine->new );
2915 ## This exists just to supply a prebuild psgi app for mod_perl and for the
2916 ## build in server support (back compat support for pre psgi port behavior).
2917 ## This is so that we don't build a new psgi app for each request when using
2918 ## the mod_perl handler or the built in servers (http and fcgi, etc).
2920 sub _finalized_psgi_app {
2923 unless ($app->_psgi_app) {
2924 my $psgi_app = $app->_setup_psgi_app;
2925 $app->_psgi_app($psgi_app);
2928 return $app->_psgi_app;
2931 ## Look for a psgi file like 'myapp_web.psgi' (if the app is MyApp::Web) in the
2932 ## home directory and load that and return it (just assume it is doing the
2933 ## right thing :) ). If that does not exist, call $app->psgi_app, wrap that
2934 ## in default_middleware and return it ( this is for backward compatibility
2935 ## with pre psgi port behavior ).
2937 sub _setup_psgi_app {
2940 for my $home (Path::Class::Dir->new($app->config->{home})) {
2941 my $psgi_file = $home->file(
2942 Catalyst::Utils::appprefix($app) . '.psgi',
2945 next unless -e $psgi_file;
2947 # If $psgi_file calls ->setup_engine, it's doing so to load
2948 # Catalyst::Engine::PSGI. But if it does that, we're only going to
2949 # throw away the loaded PSGI-app and load the 5.9 Catalyst::Engine
2950 # anyway. So set a flag (ick) that tells setup_engine not to populate
2951 # $c->engine or do any other things we might regret.
2953 $app->loading_psgi_file(1);
2954 my $psgi_app = Plack::Util::load_psgi($psgi_file);
2955 $app->loading_psgi_file(0);
2958 unless $app->engine_loader->needs_psgi_engine_compat_hack;
2961 Found a legacy Catalyst::Engine::PSGI .psgi file at ${psgi_file}.
2963 Its content has been ignored. Please consult the Catalyst::Upgrading
2964 documentation on how to upgrade from Catalyst::Engine::PSGI.
2968 return $app->apply_default_middlewares($app->psgi_app);
2971 =head2 $c->apply_default_middlewares
2973 Adds the following L<Plack> middlewares to your application, since they are
2974 useful and commonly needed:
2976 L<Plack::Middleware::ReverseProxy>, (conditionally added based on the status
2977 of your $ENV{REMOTE_ADDR}, and can be forced on with C<using_frontend_proxy>
2978 or forced off with C<ignore_frontend_proxy>), L<Plack::Middleware::LighttpdScriptNameFix>
2979 (if you are using Lighttpd), L<Plack::Middleware::IIS6ScriptNameFix> (always
2980 applied since this middleware is smart enough to conditionally apply itself).
2982 Additionally if we detect we are using Nginx, we add a bit of custom middleware
2983 to solve some problems with the way that server handles $ENV{PATH_INFO} and
2989 sub apply_default_middlewares {
2990 my ($app, $psgi_app) = @_;
2992 $psgi_app = Plack::Middleware::Conditional->wrap(
2994 builder => sub { Plack::Middleware::ReverseProxy->wrap($_[0]) },
2997 return if $app->config->{ignore_frontend_proxy};
2998 return $env->{REMOTE_ADDR} eq '127.0.0.1'
2999 || $app->config->{using_frontend_proxy};
3003 # If we're running under Lighttpd, swap PATH_INFO and SCRIPT_NAME
3004 # http://lists.scsys.co.uk/pipermail/catalyst/2006-June/008361.html
3005 $psgi_app = Plack::Middleware::Conditional->wrap(
3007 builder => sub { Plack::Middleware::LighttpdScriptNameFix->wrap($_[0]) },
3010 return unless $env->{SERVER_SOFTWARE} && $env->{SERVER_SOFTWARE} =~ m!lighttpd[-/]1\.(\d+\.\d+)!;
3011 return unless $1 < 4.23;
3016 # we're applying this unconditionally as the middleware itself already makes
3017 # sure it doesn't fuck things up if it's not running under one of the right
3019 $psgi_app = Plack::Middleware::IIS6ScriptNameFix->wrap($psgi_app);
3021 # And another IIS issue, this time with IIS7.
3022 $psgi_app = Plack::Middleware::Conditional->wrap(
3024 builder => sub { Plack::Middleware::IIS7KeepAliveFix->wrap($_[0]) },
3027 return $env->{SERVER_SOFTWARE} && $env->{SERVER_SOFTWARE} =~ m!IIS/7\.[0-9]!;
3034 =head2 App->psgi_app
3038 Returns a PSGI application code reference for the catalyst application
3039 C<$c>. This is the bare application without any middlewares
3040 applied. C<${myapp}.psgi> is not taken into account.
3042 This is what you want to be using to retrieve the PSGI application code
3043 reference of your Catalyst application for use in F<.psgi> files.
3047 *to_app = \&psgi_app;
3051 my $psgi = $app->engine->build_psgi_app($app);
3052 return $app->Catalyst::Utils::apply_registered_middleware($psgi);
3055 =head2 $c->setup_home
3057 Sets up the home directory.
3062 my ( $class, $home ) = @_;
3064 if ( my $env = Catalyst::Utils::env_value( $class, 'HOME' ) ) {
3068 $home ||= Catalyst::Utils::home($class);
3071 #I remember recently being scolded for assigning config values like this
3072 $class->config->{home} ||= $home;
3073 $class->config->{root} ||= Path::Class::Dir->new($home)->subdir('root');
3077 =head2 $c->setup_encoding
3079 Sets up the input/output encoding. See L<ENCODING>
3083 sub setup_encoding {
3085 my $enc = delete $c->config->{encoding};
3086 $c->encoding( $enc ) if defined $enc;
3089 =head2 handle_unicode_encoding_exception
3091 Hook to let you customize how encoding errors are handled. By default
3092 we just throw an exception. Receives a hashref of debug information.
3095 $c->handle_unicode_encoding_exception({
3096 param_value => $value,
3098 encoding_step => 'params',
3103 sub handle_unicode_encoding_exception {
3104 my ( $self, $exception_ctx ) = @_;
3105 die $exception_ctx->{error_msg};
3108 # Some unicode helpers cargo culted from the old plugin. These could likely
3111 sub _handle_unicode_decoding {
3112 my ( $self, $value ) = @_;
3114 return unless defined $value;
3116 ## I think this mess is to support the old nested
3117 if ( ref $value eq 'ARRAY' ) {
3118 foreach ( @$value ) {
3119 $_ = $self->_handle_unicode_decoding($_);
3123 elsif ( ref $value eq 'HASH' ) {
3124 foreach (keys %$value) {
3125 my $encoded_key = $self->_handle_param_unicode_decoding($_);
3126 $value->{$encoded_key} = $self->_handle_unicode_decoding($value->{$_});
3127 delete $value->{$_};
3132 return $self->_handle_param_unicode_decoding($value);
3136 sub _handle_param_unicode_decoding {
3137 my ( $self, $value ) = @_;
3138 return unless defined $value; # not in love with just ignoring undefs - jnap
3140 my $enc = $self->encoding;
3142 $enc->decode( $value, $self->_encode_check );
3145 $self->handle_unicode_encoding_exception({
3146 param_value => $value,
3148 encoding_step => 'params',
3153 =head2 $c->setup_log
3155 Sets up log by instantiating a L<Catalyst::Log|Catalyst::Log> object and
3156 passing it to C<log()>. Pass in a comma-delimited list of levels to set the
3159 This method also installs a C<debug> method that returns a true value into the
3160 catalyst subclass if the "debug" level is passed in the comma-delimited list,
3161 or if the C<$CATALYST_DEBUG> environment variable is set to a true value.
3163 Note that if the log has already been setup, by either a previous call to
3164 C<setup_log> or by a call such as C<< __PACKAGE__->log( MyLogger->new ) >>,
3165 that this method won't actually set up the log object.
3170 my ( $class, $levels ) = @_;
3173 $levels =~ s/^\s+//;
3174 $levels =~ s/\s+$//;
3175 my %levels = map { $_ => 1 } split /\s*,\s*/, $levels;
3177 my $env_debug = Catalyst::Utils::env_value( $class, 'DEBUG' );
3178 if ( defined $env_debug ) {
3179 $levels{debug} = 1 if $env_debug; # Ugly!
3180 delete($levels{debug}) unless $env_debug;
3183 unless ( $class->log ) {
3184 $class->log( Catalyst::Log->new(keys %levels) );
3187 if ( $levels{debug} ) {
3188 Class::MOP::get_metaclass_by_name($class)->add_method('debug' => sub { 1 });
3189 $class->log->debug('Debug messages enabled');
3193 =head2 $c->setup_plugins
3199 =head2 $c->setup_stats
3201 Sets up timing statistics class.
3206 my ( $class, $stats ) = @_;
3208 Catalyst::Utils::ensure_class_loaded($class->stats_class);
3210 my $env = Catalyst::Utils::env_value( $class, 'STATS' );
3211 if ( defined($env) ? $env : ($stats || $class->debug ) ) {
3212 Class::MOP::get_metaclass_by_name($class)->add_method('use_stats' => sub { 1 });
3213 $class->log->debug('Statistics enabled');
3218 =head2 $c->registered_plugins
3220 Returns a sorted list of the plugins which have either been stated in the
3223 If passed a given plugin name, it will report a boolean value indicating
3224 whether or not that plugin is loaded. A fully qualified name is required if
3225 the plugin name does not begin with C<Catalyst::Plugin::>.
3227 if ($c->registered_plugins('Some::Plugin')) {
3235 sub registered_plugins {
3237 return sort keys %{ $proto->_plugins } unless @_;
3239 return 1 if exists $proto->_plugins->{$plugin};
3240 return exists $proto->_plugins->{"Catalyst::Plugin::$plugin"};
3243 sub _register_plugin {
3244 my ( $proto, $plugin, $instant ) = @_;
3245 my $class = ref $proto || $proto;
3247 load_class( $plugin );
3248 $class->log->warn( "$plugin inherits from 'Catalyst::Component' - this is deprecated and will not work in 5.81" )
3249 if $plugin->isa( 'Catalyst::Component' );
3250 my $plugin_meta = Moose::Meta::Class->create($plugin);
3251 if (!$plugin_meta->has_method('new')
3252 && ( $plugin->isa('Class::Accessor::Fast') || $plugin->isa('Class::Accessor') ) ) {
3253 $plugin_meta->add_method('new', Moose::Object->meta->get_method('new'))
3255 if (!$instant && !$proto->_plugins->{$plugin}) {
3256 my $meta = Class::MOP::get_metaclass_by_name($class);
3257 $meta->superclasses($plugin, $meta->superclasses);
3259 $proto->_plugins->{$plugin} = 1;
3263 sub _default_plugins { return qw() }
3266 my ( $class, $plugins ) = @_;
3268 $class->_plugins( {} ) unless $class->_plugins;
3270 m/Unicode::Encoding/ ? do {
3272 'Unicode::Encoding plugin is auto-applied,'
3273 . ' please remove this from your appclass'
3274 . ' and make sure to define "encoding" config'
3276 unless (exists $class->config->{'encoding'}) {
3277 $class->config->{'encoding'} = 'UTF-8';
3282 push @$plugins, $class->_default_plugins;
3283 $plugins = Data::OptList::mkopt($plugins || []);
3286 [ Catalyst::Utils::resolve_namespace(
3287 $class . '::Plugin',
3288 'Catalyst::Plugin', $_->[0]
3294 for my $plugin ( reverse @plugins ) {
3295 load_class($plugin->[0], $plugin->[1]);
3296 my $meta = find_meta($plugin->[0]);
3297 next if $meta && $meta->isa('Moose::Meta::Role');
3299 $class->_register_plugin($plugin->[0]);
3303 map { $_->[0]->name, $_->[1] }
3304 grep { blessed($_->[0]) && $_->[0]->isa('Moose::Meta::Role') }
3305 map { [find_meta($_->[0]), $_->[1]] }
3308 Moose::Util::apply_all_roles(
3314 =head2 registered_middlewares
3316 Read only accessor that returns an array of all the middleware in the order
3317 that they were added (which is the REVERSE of the order they will be applied).
3319 The values returned will be either instances of L<Plack::Middleware> or of a
3320 compatible interface, or a coderef, which is assumed to be inlined middleware
3322 =head2 setup_middleware (?@middleware)
3324 Read configuration information stored in configuration key C<psgi_middleware> or
3327 See under L</CONFIGURATION> information regarding C<psgi_middleware> and how
3328 to use it to enable L<Plack::Middleware>
3330 This method is automatically called during 'setup' of your application, so
3331 you really don't need to invoke it. However you may do so if you find the idea
3332 of loading middleware via configuration weird :). For example:
3338 __PACKAGE__->setup_middleware('Head');
3341 When we read middleware definitions from configuration, we reverse the list
3342 which sounds odd but is likely how you expect it to work if you have prior
3343 experience with L<Plack::Builder> or if you previously used the plugin
3344 L<Catalyst::Plugin::EnableMiddleware> (which is now considered deprecated)
3346 So basically your middleware handles an incoming request from the first
3347 registered middleware, down and handles the response from the last middleware
3352 sub registered_middlewares {
3354 if(my $middleware = $class->_psgi_middleware) {
3356 Catalyst::Middleware::Stash->new,
3357 Plack::Middleware::HTTPExceptions->new,
3358 Plack::Middleware::RemoveRedundantBody->new,
3359 Plack::Middleware::FixMissingBodyInRedirect->new,
3360 Plack::Middleware::ContentLength->new,
3361 Plack::Middleware::MethodOverride->new,
3362 Plack::Middleware::Head->new,
3365 die "You cannot call ->registered_middlewares until middleware has been setup";
3369 sub setup_middleware {
3371 my @middleware_definitions = @_ ?
3372 reverse(@_) : reverse(@{$class->config->{'psgi_middleware'}||[]});
3374 my @middleware = ();
3375 while(my $next = shift(@middleware_definitions)) {
3377 if(Scalar::Util::blessed $next && $next->can('wrap')) {
3378 push @middleware, $next;
3379 } elsif(ref $next eq 'CODE') {
3380 push @middleware, $next;
3381 } elsif(ref $next eq 'HASH') {
3382 my $namespace = shift @middleware_definitions;
3383 my $mw = $class->Catalyst::Utils::build_middleware($namespace, %$next);
3384 push @middleware, $mw;
3386 die "I can't handle middleware definition ${\ref $next}";
3389 my $mw = $class->Catalyst::Utils::build_middleware($next);
3390 push @middleware, $mw;
3394 my @existing = @{$class->_psgi_middleware || []};
3395 $class->_psgi_middleware([@middleware,@existing,]);
3398 =head2 registered_data_handlers
3400 A read only copy of registered Data Handlers returned as a Hash, where each key
3401 is a content type and each value is a subref that attempts to decode that content
3404 =head2 setup_data_handlers (?@data_handler)
3406 Read configuration information stored in configuration key C<data_handlers> or
3409 See under L</CONFIGURATION> information regarding C<data_handlers>.
3411 This method is automatically called during 'setup' of your application, so
3412 you really don't need to invoke it.
3414 =head2 default_data_handlers
3416 Default Data Handlers that come bundled with L<Catalyst>. Currently there are
3417 only two default data handlers, for 'application/json' and an alternative to
3418 'application/x-www-form-urlencoded' which supposed nested form parameters via
3419 L<CGI::Struct> or via L<CGI::Struct::XS> IF you've installed it.
3421 The 'application/json' data handler is used to parse incoming JSON into a Perl
3422 data structure. It used either L<JSON::MaybeXS> or L<JSON>, depending on which
3423 is installed. This allows you to fail back to L<JSON:PP>, which is a Pure Perl
3424 JSON decoder, and has the smallest dependency impact.
3426 Because we don't wish to add more dependencies to L<Catalyst>, if you wish to
3427 use this new feature we recommend installing L<JSON> or L<JSON::MaybeXS> in
3428 order to get the best performance. You should add either to your dependency
3429 list (Makefile.PL, dist.ini, cpanfile, etc.)
3433 sub registered_data_handlers {
3435 if(my $data_handlers = $class->_data_handlers) {
3436 return %$data_handlers;
3438 $class->setup_data_handlers;
3439 return $class->registered_data_handlers;
3443 sub setup_data_handlers {
3444 my ($class, %data_handler_callbacks) = @_;
3445 %data_handler_callbacks = (
3446 %{$class->default_data_handlers},
3447 %{$class->config->{'data_handlers'}||+{}},
3448 %data_handler_callbacks);
3450 $class->_data_handlers(\%data_handler_callbacks);
3453 sub default_data_handlers {
3456 'application/x-www-form-urlencoded' => sub {
3457 my ($fh, $req) = @_;
3458 my $params = $req->_use_hash_multivalue ? $req->body_parameters->mixed : $req->body_parameters;
3459 Class::Load::load_first_existing_class('CGI::Struct::XS', 'CGI::Struct')
3460 ->can('build_cgi_struct')->($params);
3462 'application/json' => sub {
3463 Class::Load::load_first_existing_class('JSON::MaybeXS', 'JSON')
3464 ->can('decode_json')->(do { local $/; $_->getline });
3471 Returns an arrayref of the internal execution stack (actions that are
3472 currently executing).
3476 Returns the current timing statistics object. By default Catalyst uses
3477 L<Catalyst::Stats|Catalyst::Stats>, but can be set otherwise with
3478 L<< stats_class|/"$c->stats_class" >>.
3480 Even if L<< -Stats|/"-Stats" >> is not enabled, the stats object is still
3481 available. By enabling it with C< $c->stats->enabled(1) >, it can be used to
3482 profile explicitly, although MyApp.pm still won't profile nor output anything
3485 =head2 $c->stats_class
3487 Returns or sets the stats (timing statistics) class. L<Catalyst::Stats|Catalyst::Stats> is used by default.
3489 =head2 $c->use_stats
3491 Returns 1 when L<< stats collection|/"-Stats" >> is enabled.
3493 Note that this is a static method, not an accessor and should be overridden
3494 by declaring C<sub use_stats { 1 }> in your MyApp.pm, not by calling C<< $c->use_stats(1) >>.
3501 =head2 $c->write( $data )
3503 Writes $data to the output stream. When using this method directly, you
3504 will need to manually set the C<Content-Length> header to the length of
3505 your output data, if known.
3512 # Finalize headers if someone manually writes output (for compat)
3513 $c->finalize_headers;
3515 return $c->response->write( @_ );
3520 Returns the Catalyst version number. Mostly useful for "powered by"
3521 messages in template systems.
3525 sub version { return $Catalyst::VERSION }
3527 =head1 CONFIGURATION
3529 There are a number of 'base' config variables which can be set:
3535 C<default_model> - The default model picked if you say C<< $c->model >>. See L<< /$c->model($name) >>.
3539 C<default_view> - The default view to be rendered or returned when C<< $c->view >> is called. See L<< /$c->view($name) >>.
3543 C<disable_component_resolution_regex_fallback> - Turns
3544 off the deprecated component resolution functionality so
3545 that if any of the component methods (e.g. C<< $c->controller('Foo') >>)
3546 are called then regex search will not be attempted on string values and
3547 instead C<undef> will be returned.
3551 C<home> - The application home directory. In an uninstalled application,
3552 this is the top level application directory. In an installed application,
3553 this will be the directory containing C<< MyApp.pm >>.
3557 C<ignore_frontend_proxy> - See L</PROXY SUPPORT>
3561 C<name> - The name of the application in debug messages and the debug and
3566 C<parse_on_demand> - The request body (for example file uploads) will not be parsed
3567 until it is accessed. This allows you to (for example) check authentication (and reject
3568 the upload) before actually receiving all the data. See L</ON-DEMAND PARSER>
3572 C<root> - The root directory for templates. Usually this is just a
3573 subdirectory of the home directory, but you can set it to change the
3574 templates to a different directory.
3578 C<search_extra> - Array reference passed to Module::Pluggable to for additional
3579 namespaces from which components will be loaded (and constructed and stored in
3580 C<< $c->components >>).
3584 C<show_internal_actions> - If true, causes internal actions such as C<< _DISPATCH >>
3585 to be shown in hit debug tables in the test server.
3589 C<use_request_uri_for_path> - Controls if the C<REQUEST_URI> or C<PATH_INFO> environment
3590 variable should be used for determining the request path.
3592 Most web server environments pass the requested path to the application using environment variables,
3593 from which Catalyst has to reconstruct the request base (i.e. the top level path to / in the application,
3594 exposed as C<< $c->request->base >>) and the request path below that base.
3596 There are two methods of doing this, both of which have advantages and disadvantages. Which method is used
3597 is determined by the C<< $c->config(use_request_uri_for_path) >> setting (which can either be true or false).
3601 =item use_request_uri_for_path => 0
3603 This is the default (and the) traditional method that Catalyst has used for determining the path information.
3604 The path is generated from a combination of the C<PATH_INFO> and C<SCRIPT_NAME> environment variables.
3605 The allows the application to behave correctly when C<mod_rewrite> is being used to redirect requests
3606 into the application, as these variables are adjusted by mod_rewrite to take account for the redirect.
3608 However this method has the major disadvantage that it is impossible to correctly decode some elements
3609 of the path, as RFC 3875 says: "C<< Unlike a URI path, the PATH_INFO is not URL-encoded, and cannot
3610 contain path-segment parameters. >>" This means PATH_INFO is B<always> decoded, and therefore Catalyst
3611 can't distinguish / vs %2F in paths (in addition to other encoded values).
3613 =item use_request_uri_for_path => 1
3615 This method uses the C<REQUEST_URI> and C<SCRIPT_NAME> environment variables. As C<REQUEST_URI> is never
3616 decoded, this means that applications using this mode can correctly handle URIs including the %2F character
3617 (i.e. with C<AllowEncodedSlashes> set to C<On> in Apache).
3619 Given that this method of path resolution is provably more correct, it is recommended that you use
3620 this unless you have a specific need to deploy your application in a non-standard environment, and you are
3621 aware of the implications of not being able to handle encoded URI paths correctly.
3623 However it also means that in a number of cases when the app isn't installed directly at a path, but instead
3624 is having paths rewritten into it (e.g. as a .cgi/fcgi in a public_html directory, with mod_rewrite in a
3625 .htaccess file, or when SSI is used to rewrite pages into the app, or when sub-paths of the app are exposed
3626 at other URIs than that which the app is 'normally' based at with C<mod_rewrite>), the resolution of
3627 C<< $c->request->base >> will be incorrect.
3633 C<using_frontend_proxy> - See L</PROXY SUPPORT>.
3637 C<encoding> - See L</ENCODING>
3641 C<abort_chain_on_error_fix>
3643 When there is an error in an action chain, the default behavior is to continue
3644 processing the remaining actions and then catch the error upon chain end. This
3645 can lead to running actions when the application is in an unexpected state. If
3646 you have this issue, setting this config value to true will promptly exit a
3647 chain when there is an error raised in any action (thus terminating the chain
3652 __PACKAGE__->config(abort_chain_on_error_fix => 1);
3654 In the future this might become the default behavior.
3658 C<use_hash_multivalue_in_request>
3660 In L<Catalyst::Request> the methods C<query_parameters>, C<body_parametes>
3661 and C<parameters> return a hashref where values might be scalar or an arrayref
3662 depending on the incoming data. In many cases this can be undesirable as it
3663 leads one to writing defensive code like the following:
3665 my ($val) = ref($c->req->parameters->{a}) ?
3666 @{$c->req->parameters->{a}} :
3667 $c->req->parameters->{a};
3669 Setting this configuration item to true will make L<Catalyst> populate the
3670 attributes underlying these methods with an instance of L<Hash::MultiValue>
3671 which is used by L<Plack::Request> and others to solve this very issue. You
3672 may prefer this behavior to the default, if so enable this option (be warned
3673 if you enable it in a legacy application we are not sure if it is completely
3674 backwardly compatible).
3678 C<psgi_middleware> - See L<PSGI MIDDLEWARE>.
3682 C<data_handlers> - See L<DATA HANDLERS>.
3688 Generally when you throw an exception inside an Action (or somewhere in
3689 your stack, such as in a model that an Action is calling) that exception
3690 is caught by Catalyst and unless you either catch it yourself (via eval
3691 or something like L<Try::Tiny> or by reviewing the L</error> stack, it
3692 will eventually reach L</finalize_errors> and return either the debugging
3693 error stack page, or the default error page. However, if your exception
3694 can be caught by L<Plack::Middleware::HTTPExceptions>, L<Catalyst> will
3695 instead rethrow it so that it can be handled by that middleware (which
3696 is part of the default middleware). For example this would allow
3698 use HTTP::Throwable::Factory 'http_throw';
3700 sub throws_exception :Local {
3701 my ($self, $c) = @_;
3703 http_throw(SeeOther => { location =>
3704 $c->uri_for($self->action_for('redirect')) });
3708 =head1 INTERNAL ACTIONS
3710 Catalyst uses internal actions like C<_DISPATCH>, C<_BEGIN>, C<_AUTO>,
3711 C<_ACTION>, and C<_END>. These are by default not shown in the private
3712 action table, but you can make them visible with a config parameter.
3714 MyApp->config(show_internal_actions => 1);
3716 =head1 ON-DEMAND PARSER
3718 The request body is usually parsed at the beginning of a request,
3719 but if you want to handle input yourself, you can enable on-demand
3720 parsing with a config parameter.
3722 MyApp->config(parse_on_demand => 1);
3724 =head1 PROXY SUPPORT
3726 Many production servers operate using the common double-server approach,
3727 with a lightweight frontend web server passing requests to a larger
3728 backend server. An application running on the backend server must deal
3729 with two problems: the remote user always appears to be C<127.0.0.1> and
3730 the server's hostname will appear to be C<localhost> regardless of the
3731 virtual host that the user connected through.
3733 Catalyst will automatically detect this situation when you are running
3734 the frontend and backend servers on the same machine. The following
3735 changes are made to the request.
3737 $c->req->address is set to the user's real IP address, as read from
3738 the HTTP X-Forwarded-For header.
3740 The host value for $c->req->base and $c->req->uri is set to the real
3741 host, as read from the HTTP X-Forwarded-Host header.
3743 Additionally, you may be running your backend application on an insecure
3744 connection (port 80) while your frontend proxy is running under SSL. If there
3745 is a discrepancy in the ports, use the HTTP header C<X-Forwarded-Port> to
3746 tell Catalyst what port the frontend listens on. This will allow all URIs to
3747 be created properly.
3749 In the case of passing in:
3751 X-Forwarded-Port: 443
3753 All calls to C<uri_for> will result in an https link, as is expected.
3755 Obviously, your web server must support these headers for this to work.
3757 In a more complex server farm environment where you may have your
3758 frontend proxy server(s) on different machines, you will need to set a
3759 configuration option to tell Catalyst to read the proxied data from the
3762 MyApp->config(using_frontend_proxy => 1);
3764 If you do not wish to use the proxy support at all, you may set:
3766 MyApp->config(ignore_frontend_proxy => 0);
3768 =head2 Note about psgi files
3770 Note that if you supply your own .psgi file, calling
3771 C<< MyApp->psgi_app(@_); >>, then B<this will not happen automatically>.
3773 You either need to apply L<Plack::Middleware::ReverseProxy> yourself
3774 in your psgi, for example:
3777 enable "Plack::Middleware::ReverseProxy";
3781 This will unconditionally add the ReverseProxy support, or you need to call
3782 C<< $app = MyApp->apply_default_middlewares($app) >> (to conditionally
3783 apply the support depending upon your config).
3785 See L<Catalyst::PSGI> for more information.
3787 =head1 THREAD SAFETY
3789 Catalyst has been tested under Apache 2's threading C<mpm_worker>,
3790 C<mpm_winnt>, and the standalone forking HTTP server on Windows. We
3791 believe the Catalyst core to be thread-safe.
3793 If you plan to operate in a threaded environment, remember that all other
3794 modules you are using must also be thread-safe. Some modules, most notably
3795 L<DBD::SQLite>, are not thread-safe.
3797 =head1 DATA HANDLERS
3799 The L<Catalyst::Request> object uses L<HTTP::Body> to populate 'classic' HTML
3800 form parameters and URL search query fields. However it has become common
3801 for various alternative content types to be PUT or POSTed to your controllers
3802 and actions. People working on RESTful APIs, or using AJAX often use JSON,
3803 XML and other content types when communicating with an application server. In
3804 order to better support this use case, L<Catalyst> defines a global configuration
3805 option, C<data_handlers>, which lets you associate a content type with a coderef
3806 that parses that content type into something Perl can readily access.
3813 __PACKAGE__->config(
3815 'application/json' => sub { local $/; decode_json $_->getline },
3817 ## Any other configuration.
3822 By default L<Catalyst> comes with a generic JSON data handler similar to the
3823 example given above, which uses L<JSON::Maybe> to provide either L<JSON::PP>
3824 (a pure Perl, dependency free JSON parser) or L<Cpanel::JSON::XS> if you have
3825 it installed (if you want the faster XS parser, add it to you project Makefile.PL
3826 or dist.ini, cpanfile, etc.)
3828 The C<data_handlers> configuration is a hashref whose keys are HTTP Content-Types
3829 (matched against the incoming request type using a regexp such as to be case
3830 insensitive) and whose values are coderefs that receive a localized version of
3831 C<$_> which is a filehandle object pointing to received body.
3833 This feature is considered an early access release and we reserve the right
3834 to alter the interface in order to provide a performant and secure solution to
3835 alternative request body content. Your reports welcomed!
3837 =head1 PSGI MIDDLEWARE
3839 You can define middleware, defined as L<Plack::Middleware> or a compatible
3840 interface in configuration. Your middleware definitions are in the form of an
3841 arrayref under the configuration key C<psgi_middleware>. Here's an example
3842 with details to follow:
3847 use Plack::Middleware::StackTrace;
3849 my $stacktrace_middleware = Plack::Middleware::StackTrace->new;
3851 __PACKAGE__->config(
3852 'psgi_middleware', [
3855 $stacktrace_middleware,
3856 'Session' => {store => 'File'},
3861 $env->{myapp.customkey} = 'helloworld';
3870 So the general form is:
3872 __PACKAGE__->config(psgi_middleware => \@middleware_definitions);
3874 Where C<@middleware> is one or more of the following, applied in the REVERSE of
3875 the order listed (to make it function similarly to L<Plack::Builder>:
3877 Alternatively, you may also define middleware by calling the L</setup_middleware>
3884 __PACKAGE__->setup_middleware( \@middleware_definitions);
3887 In the case where you do both (use 'setup_middleware' and configuration) the
3888 package call to setup_middleware will be applied earlier (in other words its
3889 middleware will wrap closer to the application). Keep this in mind since in
3890 some cases the order of middleware is important.
3892 The two approaches are not exclusive.
3896 =item Middleware Object
3898 An already initialized object that conforms to the L<Plack::Middleware>
3901 my $stacktrace_middleware = Plack::Middleware::StackTrace->new;
3903 __PACKAGE__->config(
3904 'psgi_middleware', [
3905 $stacktrace_middleware,
3911 A coderef that is an inlined middleware:
3913 __PACKAGE__->config(
3914 'psgi_middleware', [
3919 if($env->{PATH_INFO} =~m/forced/) {
3921 ->new(file=>TestApp->path_to(qw/share static forced.txt/))
3924 return $app->($env);
3934 We assume the scalar refers to a namespace after normalizing it using the
3937 (1) If the scalar is prefixed with a "+" (as in C<+MyApp::Foo>) then the full string
3938 is assumed to be 'as is', and we just install and use the middleware.
3940 (2) If the scalar begins with "Plack::Middleware" or your application namespace
3941 (the package name of your Catalyst application subclass), we also assume then
3942 that it is a full namespace, and use it.
3944 (3) Lastly, we then assume that the scalar is a partial namespace, and attempt to
3945 resolve it first by looking for it under your application namespace (for example
3946 if you application is "MyApp::Web" and the scalar is "MyMiddleware", we'd look
3947 under "MyApp::Web::Middleware::MyMiddleware") and if we don't find it there, we
3948 will then look under the regular L<Plack::Middleware> namespace (i.e. for the
3949 previous we'd try "Plack::Middleware::MyMiddleware"). We look under your application
3950 namespace first to let you 'override' common L<Plack::Middleware> locally, should
3951 you find that a good idea.
3957 __PACKAGE__->config(
3958 'psgi_middleware', [
3959 'Debug', ## MyAppWeb::Middleware::Debug->wrap or Plack::Middleware::Debug->wrap
3960 'Plack::Middleware::Stacktrace', ## Plack::Middleware::Stacktrace->wrap
3961 '+MyApp::Custom', ## MyApp::Custom->wrap
3965 =item a scalar followed by a hashref
3967 Just like the previous, except the following C<HashRef> is used as arguments
3968 to initialize the middleware object.
3970 __PACKAGE__->config(
3971 'psgi_middleware', [
3972 'Session' => {store => 'File'},
3977 Please see L<PSGI> for more on middleware.
3981 On request, decodes all params from encoding into a sequence of
3982 logical characters. On response, encodes body into encoding.
3990 Returns an instance of an C<Encode> encoding
3992 print $c->encoding->name
3994 =item handle_unicode_encoding_exception ($exception_context)
3996 Method called when decoding process for a request fails.
3998 An C<$exception_context> hashref is provided to allow you to override the
3999 behaviour of your application when given data with incorrect encodings.
4001 The default method throws exceptions in the case of invalid request parameters
4002 (resulting in a 500 error), but ignores errors in upload filenames.
4004 The keys passed in the C<$exception_context> hash are:
4010 The value which was not able to be decoded.
4014 The exception received from L<Encode>.
4018 What type of data was being decoded. Valid values are (currently)
4019 C<params> - for request parameters / arguments / captures
4020 and C<uploads> - for request upload filenames.
4030 Join #catalyst on irc.perl.org.
4034 http://lists.scsys.co.uk/cgi-bin/mailman/listinfo/catalyst
4035 http://lists.scsys.co.uk/cgi-bin/mailman/listinfo/catalyst-dev
4039 http://catalyst.perl.org
4043 http://dev.catalyst.perl.org
4047 =head2 L<Task::Catalyst> - All you need to start with Catalyst
4049 =head2 L<Catalyst::Manual> - The Catalyst Manual
4051 =head2 L<Catalyst::Component>, L<Catalyst::Controller> - Base classes for components
4053 =head2 L<Catalyst::Engine> - Core engine
4055 =head2 L<Catalyst::Log> - Log class.
4057 =head2 L<Catalyst::Request> - Request object
4059 =head2 L<Catalyst::Response> - Response object
4061 =head2 L<Catalyst::Test> - The test suite.
4063 =head1 PROJECT FOUNDER
4065 sri: Sebastian Riedel <sri@cpan.org>
4071 acme: Leon Brocard <leon@astray.com>
4073 abraxxa: Alexander Hartmaier <abraxxa@cpan.org>
4077 Andrew Ford E<lt>A.Ford@ford-mason.co.ukE<gt>
4081 andyg: Andy Grundman <andy@hybridized.org>
4083 audreyt: Audrey Tang
4085 bricas: Brian Cassidy <bricas@cpan.org>
4087 Caelum: Rafael Kitover <rkitover@io.com>
4089 chansen: Christian Hansen
4091 chicks: Christopher Hicks
4093 Chisel Wright C<pause@herlpacker.co.uk>
4095 Danijel Milicevic C<me@danijel.de>
4097 David Kamholz E<lt>dkamholz@cpan.orgE<gt>
4099 David Naughton, C<naughton@umn.edu>
4103 dhoss: Devin Austin <dhoss@cpan.org>
4105 dkubb: Dan Kubb <dan.kubb-cpan@onautopilot.com>
4109 dwc: Daniel Westermann-Clark <danieltwc@cpan.org>
4111 esskar: Sascha Kiefer
4113 fireartist: Carl Franks <cfranks@cpan.org>
4115 frew: Arthur Axel "fREW" Schmidt <frioux@gmail.com>
4117 gabb: Danijel Milicevic
4121 Gavin Henry C<ghenry@perl.me.uk>
4125 groditi: Guillermo Roditi <groditi@gmail.com>
4127 hobbs: Andrew Rodland <andrew@cleverdomain.org>
4129 ilmari: Dagfinn Ilmari Mannsåker <ilmari@ilmari.org>
4131 jcamacho: Juan Camacho
4133 jester: Jesse Sheidlower C<jester@panix.com>
4135 jhannah: Jay Hannah <jay@jays.net>
4141 jon: Jon Schutz <jjschutz@cpan.org>
4143 Jonathan Rockway C<< <jrockway@cpan.org> >>
4145 Kieren Diment C<kd@totaldatasolution.com>
4147 konobi: Scott McWhirter <konobi@cpan.org>
4149 marcus: Marcus Ramberg <mramberg@cpan.org>
4151 miyagawa: Tatsuhiko Miyagawa <miyagawa@bulknews.net>
4153 mgrimes: Mark Grimes <mgrimes@cpan.org>
4155 mst: Matt S. Trout <mst@shadowcatsystems.co.uk>
4159 naughton: David Naughton
4161 ningu: David Kamholz <dkamholz@cpan.org>
4163 nothingmuch: Yuval Kogman <nothingmuch@woobling.org>
4165 numa: Dan Sully <daniel@cpan.org>
4171 omega: Andreas Marienborg
4173 Oleg Kostyuk <cub.uanic@gmail.com>
4175 phaylon: Robert Sedlacek <phaylon@dunkelheit.at>
4177 rafl: Florian Ragwitz <rafl@debian.org>
4179 random: Roland Lammel <lammel@cpan.org>
4181 Robert Sedlacek C<< <rs@474.at> >>
4183 SpiceMan: Marcel Montes
4187 szbalint: Balint Szilakszi <szbalint@cpan.org>
4189 t0m: Tomas Doran <bobtfish@bobtfish.net>
4193 vanstyn: Henry Van Styn <vanstyn@cpan.org>
4195 Viljo Marrandi C<vilts@yahoo.com>
4197 Will Hawes C<info@whawes.co.uk>
4199 willert: Sebastian Willert <willert@cpan.org>
4201 wreis: Wallace Reis <wreis@cpan.org>
4203 Yuval Kogman, C<nothingmuch@woobling.org>
4205 rainboxx: Matthias Dietrich, C<perl@rainboxx.de>
4207 dd070: Dhaval Dhanani <dhaval070@gmail.com>
4209 Upasana <me@upasana.me>
4213 Copyright (c) 2005-2014, the above named PROJECT FOUNDER and CONTRIBUTORS.
4217 This library is free software. You can redistribute it and/or modify it under
4218 the same terms as Perl itself.
4224 __PACKAGE__->meta->make_immutable;