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 my $class = ref $self;
67 my $composed_request_class = $class->composed_request_class;
68 return $composed_request_class->new( $self->_build_request_constructor_args);
72 sub _build_request_constructor_args {
74 my %p = ( _log => $self->log );
75 $p{_uploadtmp} = $self->_uploadtmp if $self->_has_uploadtmp;
76 $p{data_handlers} = {$self->registered_data_handlers};
77 $p{_use_hash_multivalue} = $self->config->{use_hash_multivalue_in_request}
78 if $self->config->{use_hash_multivalue_in_request};
82 sub composed_request_class {
84 my @traits = (@{$class->request_class_traits||[]}, @{$class->config->{request_class_traits}||[]});
86 # For each trait listed, figure out what the namespace is. First we try the $trait
87 # as it is in the config. Then try $MyApp::TraitFor::Request:$trait. Last we try
88 # Catalyst::TraitFor::Request::$trait. If none load, throw error.
90 my $trait_ns = 'TraitFor::Request';
91 my @normalized_traits = map {
92 Class::Load::load_first_existing_class($_, $class.'::'.$trait_ns.'::'. $_, 'Catalyst::'.$trait_ns.'::'.$_)
95 return $class->_composed_request_class ||
96 $class->_composed_request_class(Moose::Util::with_traits($class->request_class, @normalized_traits));
103 my $class = ref $self;
104 my $composed_response_class = $class->composed_response_class;
105 return $composed_response_class->new( $self->_build_response_constructor_args);
109 sub _build_response_constructor_args {
112 encoding => $_[0]->encoding,
116 sub composed_response_class {
118 my @traits = (@{$class->response_class_traits||[]}, @{$class->config->{response_class_traits}||[]});
120 my $trait_ns = 'TraitFor::Response';
121 my @normalized_traits = map {
122 Class::Load::load_first_existing_class($_, $class.'::'.$trait_ns.'::'. $_, 'Catalyst::'.$trait_ns.'::'.$_)
125 return $class->_composed_response_class ||
126 $class->_composed_response_class(Moose::Util::with_traits($class->response_class, @normalized_traits));
129 has namespace => (is => 'rw');
131 sub depth { scalar @{ shift->stack || [] }; }
132 sub comp { shift->component(@_) }
135 my $self = shift; return $self->request(@_);
138 my $self = shift; return $self->response(@_);
141 # For backwards compatibility
142 sub finalize_output { shift->finalize_body(@_) };
147 our $RECURSION = 1000;
148 our $DETACH = Catalyst::Exception::Detach->new;
149 our $GO = Catalyst::Exception::Go->new;
151 #I imagine that very few of these really
152 #need to be class variables. if any.
153 #maybe we should just make them attributes with a default?
154 __PACKAGE__->mk_classdata($_)
155 for qw/components arguments dispatcher engine log dispatcher_class
156 engine_loader context_class request_class response_class stats_class
157 setup_finished _psgi_app loading_psgi_file run_options _psgi_middleware
158 _data_handlers _encoding _encode_check finalized_default_middleware
159 request_class_traits response_class_traits stats_class_traits
160 _composed_request_class _composed_response_class _composed_stats_class/;
162 __PACKAGE__->dispatcher_class('Catalyst::Dispatcher');
163 __PACKAGE__->request_class('Catalyst::Request');
164 __PACKAGE__->response_class('Catalyst::Response');
165 __PACKAGE__->stats_class('Catalyst::Stats');
167 sub composed_stats_class {
169 my @traits = (@{$class->stats_class_traits||[]}, @{$class->config->{stats_class_traits}||[]});
171 my $trait_ns = 'TraitFor::Stats';
172 my @normalized_traits = map {
173 Class::Load::load_first_existing_class($_, $class.'::'.$trait_ns.'::'. $_, 'Catalyst::'.$trait_ns.'::'.$_)
176 return $class->_composed_stats_class ||
177 $class->_composed_stats_class(Moose::Util::with_traits($class->stats_class, @normalized_traits));
180 __PACKAGE__->_encode_check(Encode::FB_CROAK | Encode::LEAVE_SRC);
182 # Remember to update this in Catalyst::Runtime as well!
183 our $VERSION = '5.90093';
184 $VERSION = eval $VERSION if $VERSION =~ /_/; # numify for warning-free dev releases
187 my ( $class, @arguments ) = @_;
189 # We have to limit $class to Catalyst to avoid pushing Catalyst upon every
191 return unless $class eq 'Catalyst';
193 my $caller = caller();
194 return if $caller eq 'main';
196 my $meta = Moose::Meta::Class->initialize($caller);
197 unless ( $caller->isa('Catalyst') ) {
198 my @superclasses = ($meta->superclasses, $class, 'Catalyst::Controller');
199 $meta->superclasses(@superclasses);
201 # Avoid possible C3 issues if 'Moose::Object' is already on RHS of MyApp
202 $meta->superclasses(grep { $_ ne 'Moose::Object' } $meta->superclasses);
204 unless( $meta->has_method('meta') ){
205 if ($Moose::VERSION >= 1.15) {
206 $meta->_add_meta_method('meta');
209 $meta->add_method(meta => sub { Moose::Meta::Class->initialize("${caller}") } );
213 $caller->arguments( [@arguments] );
217 sub _application { $_[0] }
223 Catalyst - The Elegant MVC Web Application Framework
226 <a href="https://badge.fury.io/pl/Catalyst-Runtime"><img src="https://badge.fury.io/pl/Catalyst-Runtime.svg" alt="CPAN version" height="18"></a>
227 <a href="https://travis-ci.org/perl-catalyst/catalyst-runtime/"><img src="https://api.travis-ci.org/perl-catalyst/catalyst-runtime.png" alt="Catalyst></a>
228 <a href="http://cpants.cpanauthors.org/dist/Catalyst-Runtime"><img src="http://cpants.cpanauthors.org/dist/Catalyst-Runtime.png" alt='Kwalitee Score' /></a>
232 See the L<Catalyst::Manual> distribution for comprehensive
233 documentation and tutorials.
235 # Install Catalyst::Devel for helpers and other development tools
236 # use the helper to create a new application
239 # add models, views, controllers
240 script/myapp_create.pl model MyDatabase DBIC::Schema create=static dbi:SQLite:/path/to/db
241 script/myapp_create.pl view MyTemplate TT
242 script/myapp_create.pl controller Search
244 # built in testserver -- use -r to restart automatically on changes
245 # --help to see all available options
246 script/myapp_server.pl
248 # command line testing interface
249 script/myapp_test.pl /yada
252 use Catalyst qw/-Debug/; # include plugins here as well
254 ### In lib/MyApp/Controller/Root.pm (autocreated)
255 sub foo : Chained('/') Args() { # called for /foo, /foo/1, /foo/1/2, etc.
256 my ( $self, $c, @args ) = @_; # args are qw/1 2/ for /foo/1/2
257 $c->stash->{template} = 'foo.tt'; # set the template
258 # lookup something from db -- stash vars are passed to TT
260 $c->model('Database::Foo')->search( { country => $args[0] } );
261 if ( $c->req->params->{bar} ) { # access GET or POST parameters
262 $c->forward( 'bar' ); # process another action
263 # do something else after forward returns
267 # The foo.tt TT template can use the stash data from the database
268 [% WHILE (item = data.next) %]
272 # called for /bar/of/soap, /bar/of/soap/10, etc.
273 sub bar : Chained('/') PathPart('/bar/of/soap') Args() { ... }
275 # called after all actions are finished
277 my ( $self, $c ) = @_;
278 if ( scalar @{ $c->error } ) { ... } # handle errors
279 return if $c->res->body; # already have a response
280 $c->forward( 'MyApp::View::TT' ); # render template
283 See L<Catalyst::Manual::Intro> for additional information.
287 Catalyst is a modern framework for making web applications without the
288 pain usually associated with this process. This document is a reference
289 to the main Catalyst application. If you are a new user, we suggest you
290 start with L<Catalyst::Manual::Tutorial> or L<Catalyst::Manual::Intro>.
292 See L<Catalyst::Manual> for more documentation.
294 Catalyst plugins can be loaded by naming them as arguments to the "use
295 Catalyst" statement. Omit the C<Catalyst::Plugin::> prefix from the
296 plugin name, i.e., C<Catalyst::Plugin::My::Module> becomes
299 use Catalyst qw/My::Module/;
301 If your plugin starts with a name other than C<Catalyst::Plugin::>, you can
302 fully qualify the name by using a unary plus:
306 +Fully::Qualified::Plugin::Name
309 Special flags like C<-Debug> can also be specified as
310 arguments when Catalyst is loaded:
312 use Catalyst qw/-Debug My::Module/;
314 The position of plugins and flags in the chain is important, because
315 they are loaded in the order in which they appear.
317 The following flags are supported:
321 Enables debug output. You can also force this setting from the system
322 environment with CATALYST_DEBUG or <MYAPP>_DEBUG. The environment
323 settings override the application, with <MYAPP>_DEBUG having the highest
326 This sets the log level to 'debug' and enables full debug output on the
327 error screen. If you only want the latter, see L<< $c->debug >>.
331 Forces Catalyst to use a specific home directory, e.g.:
333 use Catalyst qw[-Home=/usr/mst];
335 This can also be done in the shell environment by setting either the
336 C<CATALYST_HOME> environment variable or C<MYAPP_HOME>; where C<MYAPP>
337 is replaced with the uppercased name of your application, any "::" in
338 the name will be replaced with underscores, e.g. MyApp::Web should use
339 MYAPP_WEB_HOME. If both variables are set, the MYAPP_HOME one will be used.
341 If none of these are set, Catalyst will attempt to automatically detect the
342 home directory. If you are working in a development environment, Catalyst
343 will try and find the directory containing either Makefile.PL, Build.PL,
344 dist.ini, or cpanfile. If the application has been installed into the system
345 (i.e. you have done C<make install>), then Catalyst will use the path to your
346 application module, without the .pm extension (e.g., /foo/MyApp if your
347 application was installed at /foo/MyApp.pm)
351 use Catalyst '-Log=warn,fatal,error';
353 Specifies a comma-delimited list of log levels.
357 Enables statistics collection and reporting.
359 use Catalyst qw/-Stats=1/;
361 You can also force this setting from the system environment with CATALYST_STATS
362 or <MYAPP>_STATS. The environment settings override the application, with
363 <MYAPP>_STATS having the highest priority.
365 Stats are also enabled if L<< debugging |/"-Debug" >> is enabled.
369 =head2 INFORMATION ABOUT THE CURRENT REQUEST
373 Returns a L<Catalyst::Action> object for the current action, which
374 stringifies to the action name. See L<Catalyst::Action>.
378 Returns the namespace of the current action, i.e., the URI prefix
379 corresponding to the controller of the current action. For example:
381 # in Controller::Foo::Bar
382 $c->namespace; # returns 'foo/bar';
388 Returns the current L<Catalyst::Request> object, giving access to
389 information about the current client request (including parameters,
390 cookies, HTTP headers, etc.). See L<Catalyst::Request>.
392 =head2 REQUEST FLOW HANDLING
394 =head2 $c->forward( $action [, \@arguments ] )
396 =head2 $c->forward( $class, $method, [, \@arguments ] )
398 This is one way of calling another action (method) in the same or
399 a different controller. You can also use C<< $self->my_method($c, @args) >>
400 in the same controller or C<< $c->controller('MyController')->my_method($c, @args) >>
401 in a different controller.
402 The main difference is that 'forward' uses some of the Catalyst request
403 cycle overhead, including debugging, which may be useful to you. On the
404 other hand, there are some complications to using 'forward', restrictions
405 on values returned from 'forward', and it may not handle errors as you prefer.
406 Whether you use 'forward' or not is up to you; it is not considered superior to
407 the other ways to call a method.
409 'forward' calls another action, by its private name. If you give a
410 class name but no method, C<process()> is called. You may also optionally
411 pass arguments in an arrayref. The action will receive the arguments in
412 C<@_> and C<< $c->req->args >>. Upon returning from the function,
413 C<< $c->req->args >> will be restored to the previous values.
415 Any data C<return>ed from the action forwarded to, will be returned by the
418 my $foodata = $c->forward('/foo');
419 $c->forward('index');
420 $c->forward(qw/Model::DBIC::Foo do_stuff/);
421 $c->forward('View::TT');
423 Note that L<< forward|/"$c->forward( $action [, \@arguments ] )" >> implies
424 an C<< eval { } >> around the call (actually
425 L<< execute|/"$c->execute( $class, $coderef )" >> does), thus rendering all
426 exceptions thrown by the called action non-fatal and pushing them onto
427 $c->error instead. If you want C<die> to propagate you need to do something
431 die join "\n", @{ $c->error } if @{ $c->error };
433 Or make sure to always return true values from your actions and write
436 $c->forward('foo') || return;
438 Another note is that C<< $c->forward >> always returns a scalar because it
439 actually returns $c->state which operates in a scalar context.
440 Thus, something like:
444 in an action that is forwarded to is going to return a scalar,
445 i.e. how many items are in that array, which is probably not what you want.
446 If you need to return an array then return a reference to it,
449 $c->stash->{array} = \@array;
451 and access it from the stash.
453 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.
457 sub forward { my $c = shift; no warnings 'recursion'; $c->dispatcher->forward( $c, @_ ) }
459 =head2 $c->detach( $action [, \@arguments ] )
461 =head2 $c->detach( $class, $method, [, \@arguments ] )
465 The same as L<< forward|/"$c->forward( $action [, \@arguments ] )" >>, but
466 doesn't return to the previous action when processing is finished.
468 When called with no arguments it escapes the processing chain entirely.
472 sub detach { my $c = shift; $c->dispatcher->detach( $c, @_ ) }
474 =head2 $c->visit( $action [, \@arguments ] )
476 =head2 $c->visit( $action [, \@captures, \@arguments ] )
478 =head2 $c->visit( $class, $method, [, \@arguments ] )
480 =head2 $c->visit( $class, $method, [, \@captures, \@arguments ] )
482 Almost the same as L<< forward|/"$c->forward( $action [, \@arguments ] )" >>,
483 but does a full dispatch, instead of just calling the new C<$action> /
484 C<< $class->$method >>. This means that C<begin>, C<auto> and the method
485 you go to are called, just like a new request.
487 In addition both C<< $c->action >> and C<< $c->namespace >> are localized.
488 This means, for example, that C<< $c->action >> methods such as
489 L<name|Catalyst::Action/name>, L<class|Catalyst::Action/class> and
490 L<reverse|Catalyst::Action/reverse> return information for the visited action
491 when they are invoked within the visited action. This is different from the
492 behavior of L<< forward|/"$c->forward( $action [, \@arguments ] )" >>, which
493 continues to use the $c->action object from the caller action even when
494 invoked from the called action.
496 C<< $c->stash >> is kept unchanged.
498 In effect, L<< visit|/"$c->visit( $action [, \@captures, \@arguments ] )" >>
499 allows you to "wrap" another action, just as it would have been called by
500 dispatching from a URL, while the analogous
501 L<< go|/"$c->go( $action [, \@captures, \@arguments ] )" >> allows you to
502 transfer control to another action as if it had been reached directly from a URL.
506 sub visit { my $c = shift; $c->dispatcher->visit( $c, @_ ) }
508 =head2 $c->go( $action [, \@arguments ] )
510 =head2 $c->go( $action [, \@captures, \@arguments ] )
512 =head2 $c->go( $class, $method, [, \@arguments ] )
514 =head2 $c->go( $class, $method, [, \@captures, \@arguments ] )
516 The relationship between C<go> and
517 L<< visit|/"$c->visit( $action [, \@captures, \@arguments ] )" >> is the same as
518 the relationship between
519 L<< forward|/"$c->forward( $class, $method, [, \@arguments ] )" >> and
520 L<< detach|/"$c->detach( $action [, \@arguments ] )" >>. Like C<< $c->visit >>,
521 C<< $c->go >> will perform a full dispatch on the specified action or method,
522 with localized C<< $c->action >> and C<< $c->namespace >>. Like C<detach>,
523 C<go> escapes the processing of the current request chain on completion, and
524 does not return to its cunless blessed $cunless blessed $caller.
526 @arguments are arguments to the final destination of $action. @captures are
527 arguments to the intermediate steps, if any, on the way to the final sub of
532 sub go { my $c = shift; $c->dispatcher->go( $c, @_ ) }
538 Returns the current L<Catalyst::Response> object, see there for details.
542 Returns a hashref to the stash, which may be used to store data and pass
543 it between components during a request. You can also set hash keys by
544 passing arguments. The stash is automatically sent to the view. The
545 stash is cleared at the end of a request; it cannot be used for
546 persistent storage (for this you must use a session; see
547 L<Catalyst::Plugin::Session> for a complete system integrated with
550 $c->stash->{foo} = $bar;
551 $c->stash( { moose => 'majestic', qux => 0 } );
552 $c->stash( bar => 1, gorch => 2 ); # equivalent to passing a hashref
554 # stash is automatically passed to the view for use in a template
555 $c->forward( 'MyApp::View::TT' );
557 The stash hash is currently stored in the PSGI C<$env> and is managed by
558 L<Catalyst::Middleware::Stash>. Since it's part of the C<$env> items in
559 the stash can be accessed in sub applications mounted under your main
560 L<Catalyst> application. For example if you delegate the response of an
561 action to another L<Catalyst> application, that sub application will have
562 access to all the stash keys of the main one, and if can of course add
563 more keys of its own. However those new keys will not 'bubble' back up
564 to the main application.
566 For more information the best thing to do is to review the test case:
567 t/middleware-stash.t in the distribution /t directory.
573 $c->log->error("You are requesting the stash but you don't have a context") unless blessed $c;
574 return Catalyst::Middleware::Stash::get_stash($c->req->env)->(@_);
579 =head2 $c->error($error, ...)
581 =head2 $c->error($arrayref)
583 Returns an arrayref containing error messages. If Catalyst encounters an
584 error while processing a request, it stores the error in $c->error. This
585 method should only be used to store fatal error messages.
587 my @error = @{ $c->error };
591 $c->error('Something bad happened');
593 Calling this will always return an arrayref (if there are no errors it
594 will be an empty arrayref.
601 my $error = ref $_[0] eq 'ARRAY' ? $_[0] : [@_];
602 croak @$error unless ref $c;
603 push @{ $c->{error} }, @$error;
605 elsif ( defined $_[0] ) { $c->{error} = undef }
606 return $c->{error} || [];
612 Contains the return value of the last executed action.
613 Note that << $c->state >> operates in a scalar context which means that all
614 values it returns are scalar.
616 =head2 $c->clear_errors
618 Clear errors. You probably don't want to clear the errors unless you are
619 implementing a custom error screen.
621 This is equivalent to running
632 =head2 $c->has_errors
634 Returns true if you have errors
638 sub has_errors { scalar(@{shift->error}) ? 1:0 }
640 =head2 $c->last_error
642 Returns the most recent error in the stack (the one most recently added...)
643 or nothing if there are no errors.
647 sub last_error { my ($err, @errs) = @{shift->error}; return $err }
651 shifts the most recently added error off the error stack and returns if. Returns
652 nothing if there are no more errors.
658 my ($err, @errors) = @{$self->error};
659 $self->{error} = \@errors;
663 sub _comp_search_prefixes {
665 return map $c->components->{ $_ }, $c->_comp_names_search_prefixes(@_);
668 # search components given a name and some prefixes
669 sub _comp_names_search_prefixes {
670 my ( $c, $name, @prefixes ) = @_;
671 my $appclass = ref $c || $c;
672 my $filter = "^${appclass}::(" . join( '|', @prefixes ) . ')::';
673 $filter = qr/$filter/; # Compile regex now rather than once per loop
675 # map the original component name to the sub part that we will search against
676 my %eligible = map { my $n = $_; $n =~ s{^$appclass\::[^:]+::}{}; $_ => $n; }
677 grep { /$filter/ } keys %{ $c->components };
679 # undef for a name will return all
680 return keys %eligible if !defined $name;
682 my $query = $name->$_isa('Regexp') ? $name : qr/^$name$/i;
683 my @result = grep { $eligible{$_} =~ m{$query} } keys %eligible;
685 return @result if @result;
687 # if we were given a regexp to search against, we're done.
688 return if $name->$_isa('Regexp');
690 # skip regexp fallback if configured
692 if $appclass->config->{disable_component_resolution_regex_fallback};
696 @result = grep { $eligible{ $_ } =~ m{$query} } keys %eligible;
698 # no results? try against full names
700 @result = grep { m{$query} } keys %eligible;
703 # don't warn if we didn't find any results, it just might not exist
705 # Disgusting hack to work out correct method name
706 my $warn_for = lc $prefixes[0];
707 my $msg = "Used regexp fallback for \$c->${warn_for}('${name}'), which found '" .
708 (join '", "', @result) . "'. Relying on regexp fallback behavior for " .
709 "component resolution is unreliable and unsafe.";
710 my $short = $result[0];
711 # remove the component namespace prefix
712 $short =~ s/.*?(Model|Controller|View):://;
713 my $shortmess = Carp::shortmess('');
714 if ($shortmess =~ m#Catalyst/Plugin#) {
715 $msg .= " You probably need to set '$short' instead of '${name}' in this " .
717 } elsif ($shortmess =~ m#Catalyst/lib/(View|Controller)#) {
718 $msg .= " You probably need to set '$short' instead of '${name}' in this " .
719 "component's config";
721 $msg .= " You probably meant \$c->${warn_for}('$short') instead of \$c->${warn_for}('${name}'), " .
722 "but if you really wanted to search, pass in a regexp as the argument " .
723 "like so: \$c->${warn_for}(qr/${name}/)";
725 $c->log->warn( "${msg}$shortmess" );
731 # Find possible names for a prefix
733 my ( $c, @prefixes ) = @_;
734 my $appclass = ref $c || $c;
736 my $filter = "^${appclass}::(" . join( '|', @prefixes ) . ')::';
738 my @names = map { s{$filter}{}; $_; }
739 $c->_comp_names_search_prefixes( undef, @prefixes );
744 # Filter a component before returning by calling ACCEPT_CONTEXT if available
746 sub _filter_component {
747 my ( $c, $comp, @args ) = @_;
749 if(ref $comp eq 'CODE') {
753 if ( eval { $comp->can('ACCEPT_CONTEXT'); } ) {
754 return $comp->ACCEPT_CONTEXT( $c, @args );
757 $c->log->warn("You called component '${\$comp->catalyst_component_name}' with arguments [@args], but this component does not ACCEPT_CONTEXT, so args are ignored.") if scalar(@args) && $c->debug;
762 =head2 COMPONENT ACCESSORS
764 =head2 $c->controller($name)
766 Gets a L<Catalyst::Controller> instance by name.
768 $c->controller('Foo')->do_stuff;
770 If the name is omitted, will return the controller for the dispatched
773 If you want to search for controllers, pass in a regexp as the argument.
775 # find all controllers that start with Foo
776 my @foo_controllers = $c->controller(qr{^Foo});
782 my ( $c, $name, @args ) = @_;
784 my $appclass = ref($c) || $c;
786 unless ( $name->$_isa('Regexp') ) { # Direct component hash lookup to avoid costly regexps
787 my $comps = $c->components;
788 my $check = $appclass."::Controller::".$name;
789 return $c->_filter_component( $comps->{$check}, @args ) if exists $comps->{$check};
791 my @result = $c->_comp_search_prefixes( $name, qw/Controller C/ );
792 return map { $c->_filter_component( $_, @args ) } @result if ref $name;
793 return $c->_filter_component( $result[ 0 ], @args );
796 return $c->component( $c->action->class );
799 =head2 $c->model($name)
801 Gets a L<Catalyst::Model> instance by name.
803 $c->model('Foo')->do_stuff;
805 Any extra arguments are directly passed to ACCEPT_CONTEXT, if the model
806 defines ACCEPT_CONTEXT. If it does not, the args are discarded.
808 If the name is omitted, it will look for
809 - a model object in $c->stash->{current_model_instance}, then
810 - a model name in $c->stash->{current_model}, then
811 - a config setting 'default_model', or
812 - check if there is only one model, and return it if that's the case.
814 If you want to search for models, pass in a regexp as the argument.
816 # find all models that start with Foo
817 my @foo_models = $c->model(qr{^Foo});
822 my ( $c, $name, @args ) = @_;
823 my $appclass = ref($c) || $c;
825 unless ( $name->$_isa('Regexp') ) { # Direct component hash lookup to avoid costly regexps
826 my $comps = $c->components;
827 my $check = $appclass."::Model::".$name;
828 return $c->_filter_component( $comps->{$check}, @args ) if exists $comps->{$check};
830 my @result = $c->_comp_search_prefixes( $name, qw/Model M/ );
831 return map { $c->_filter_component( $_, @args ) } @result if ref $name;
832 return $c->_filter_component( $result[ 0 ], @args );
836 return $c->stash->{current_model_instance}
837 if $c->stash->{current_model_instance};
838 return $c->model( $c->stash->{current_model} )
839 if $c->stash->{current_model};
841 return $c->model( $appclass->config->{default_model} )
842 if $appclass->config->{default_model};
844 my( $comp, $rest ) = $c->_comp_search_prefixes( undef, qw/Model M/);
847 $c->log->warn( Carp::shortmess('Calling $c->model() will return a random model unless you specify one of:') );
848 $c->log->warn( '* $c->config(default_model => "the name of the default model to use")' );
849 $c->log->warn( '* $c->stash->{current_model} # the name of the model to use for this request' );
850 $c->log->warn( '* $c->stash->{current_model_instance} # the instance of the model to use for this request' );
851 $c->log->warn( 'NB: in version 5.81, the "random" behavior will not work at all.' );
854 return $c->_filter_component( $comp );
858 =head2 $c->view($name)
860 Gets a L<Catalyst::View> instance by name.
862 $c->view('Foo')->do_stuff;
864 Any extra arguments are directly passed to ACCEPT_CONTEXT.
866 If the name is omitted, it will look for
867 - a view object in $c->stash->{current_view_instance}, then
868 - a view name in $c->stash->{current_view}, then
869 - a config setting 'default_view', or
870 - check if there is only one view, and return it if that's the case.
872 If you want to search for views, pass in a regexp as the argument.
874 # find all views that start with Foo
875 my @foo_views = $c->view(qr{^Foo});
880 my ( $c, $name, @args ) = @_;
882 my $appclass = ref($c) || $c;
884 unless ( $name->$_isa('Regexp') ) { # Direct component hash lookup to avoid costly regexps
885 my $comps = $c->components;
886 my $check = $appclass."::View::".$name;
887 if( exists $comps->{$check} ) {
888 return $c->_filter_component( $comps->{$check}, @args );
891 $c->log->warn( "Attempted to use view '$check', but does not exist" );
894 my @result = $c->_comp_search_prefixes( $name, qw/View V/ );
895 return map { $c->_filter_component( $_, @args ) } @result if ref $name;
896 return $c->_filter_component( $result[ 0 ], @args );
900 return $c->stash->{current_view_instance}
901 if $c->stash->{current_view_instance};
902 return $c->view( $c->stash->{current_view} )
903 if $c->stash->{current_view};
905 return $c->view( $appclass->config->{default_view} )
906 if $appclass->config->{default_view};
908 my( $comp, $rest ) = $c->_comp_search_prefixes( undef, qw/View V/);
911 $c->log->warn( 'Calling $c->view() will return a random view unless you specify one of:' );
912 $c->log->warn( '* $c->config(default_view => "the name of the default view to use")' );
913 $c->log->warn( '* $c->stash->{current_view} # the name of the view to use for this request' );
914 $c->log->warn( '* $c->stash->{current_view_instance} # the instance of the view to use for this request' );
915 $c->log->warn( 'NB: in version 5.81, the "random" behavior will not work at all.' );
918 return $c->_filter_component( $comp );
921 =head2 $c->controllers
923 Returns the available names which can be passed to $c->controller
929 return $c->_comp_names(qw/Controller C/);
934 Returns the available names which can be passed to $c->model
940 return $c->_comp_names(qw/Model M/);
946 Returns the available names which can be passed to $c->view
952 return $c->_comp_names(qw/View V/);
955 =head2 $c->comp($name)
957 =head2 $c->component($name)
959 Gets a component object by name. This method is not recommended,
960 unless you want to get a specific component by full
961 class. C<< $c->controller >>, C<< $c->model >>, and C<< $c->view >>
962 should be used instead.
964 If C<$name> is a regexp, a list of components matched against the full
965 component name will be returned.
967 If Catalyst can't find a component by name, it will fallback to regex
968 matching by default. To disable this behaviour set
969 disable_component_resolution_regex_fallback to a true value.
971 __PACKAGE__->config( disable_component_resolution_regex_fallback => 1 );
976 my ( $c, $name, @args ) = @_;
979 my $comps = $c->components;
982 # is it the exact name?
983 return $c->_filter_component( $comps->{ $name }, @args )
984 if exists $comps->{ $name };
986 # perhaps we just omitted "MyApp"?
987 my $composed = ( ref $c || $c ) . "::${name}";
988 return $c->_filter_component( $comps->{ $composed }, @args )
989 if exists $comps->{ $composed };
991 # search all of the models, views and controllers
992 my( $comp ) = $c->_comp_search_prefixes( $name, qw/Model M Controller C View V/ );
993 return $c->_filter_component( $comp, @args ) if $comp;
997 if $c->config->{disable_component_resolution_regex_fallback};
999 # This is here so $c->comp( '::M::' ) works
1000 my $query = ref $name ? $name : qr{$name}i;
1002 my @result = grep { m{$query} } keys %{ $c->components };
1003 return map { $c->_filter_component( $_, @args ) } @result if ref $name;
1005 if( $result[ 0 ] ) {
1006 $c->log->warn( Carp::shortmess(qq(Found results for "${name}" using regexp fallback)) );
1007 $c->log->warn( 'Relying on the regexp fallback behavior for component resolution' );
1008 $c->log->warn( 'is unreliable and unsafe. You have been warned' );
1009 return $c->_filter_component( $result[ 0 ], @args );
1012 # I would expect to return an empty list here, but that breaks back-compat
1016 return sort keys %{ $c->components };
1019 =head2 CLASS DATA AND HELPER CLASSES
1023 Returns or takes a hashref containing the application's configuration.
1025 __PACKAGE__->config( { db => 'dsn:SQLite:foo.db' } );
1027 You can also use a C<YAML>, C<XML> or L<Config::General> config file
1028 like C<myapp.conf> in your applications home directory. See
1029 L<Catalyst::Plugin::ConfigLoader>.
1031 =head3 Cascading configuration
1033 The config method is present on all Catalyst components, and configuration
1034 will be merged when an application is started. Configuration loaded with
1035 L<Catalyst::Plugin::ConfigLoader> takes precedence over other configuration,
1036 followed by configuration in your top level C<MyApp> class. These two
1037 configurations are merged, and then configuration data whose hash key matches a
1038 component name is merged with configuration for that component.
1040 The configuration for a component is then passed to the C<new> method when a
1041 component is constructed.
1045 MyApp->config({ 'Model::Foo' => { bar => 'baz', overrides => 'me' } });
1046 MyApp::Model::Foo->config({ quux => 'frob', overrides => 'this' });
1048 will mean that C<MyApp::Model::Foo> receives the following data when
1051 MyApp::Model::Foo->new({
1057 It's common practice to use a Moose attribute
1058 on the receiving component to access the config value.
1060 package MyApp::Model::Foo;
1064 # this attr will receive 'baz' at construction time
1070 You can then get the value 'baz' by calling $c->model('Foo')->bar
1071 (or $self->bar inside code in the model).
1073 B<NOTE:> you MUST NOT call C<< $self->config >> or C<< __PACKAGE__->config >>
1074 as a way of reading config within your code, as this B<will not> give you the
1075 correctly merged config back. You B<MUST> take the config values supplied to
1076 the constructor and use those instead.
1080 around config => sub {
1084 croak('Setting config after setup has been run is not allowed.')
1085 if ( @_ and $c->setup_finished );
1092 Returns the logging object instance. Unless it is already set, Catalyst
1093 sets this up with a L<Catalyst::Log> object. To use your own log class,
1094 set the logger with the C<< __PACKAGE__->log >> method prior to calling
1095 C<< __PACKAGE__->setup >>.
1097 __PACKAGE__->log( MyLogger->new );
1102 $c->log->info( 'Now logging with my own logger!' );
1104 Your log class should implement the methods described in
1109 Returned True if there's a valid encoding
1111 =head2 clear_encoding
1113 Clears the encoding for the current context
1117 Sets or gets the application encoding. Setting encoding takes either an
1118 Encoding object or a string that we try to resolve via L<Encode::find_encoding>.
1120 You would expect to get the encoding object back if you attempt to set it. If
1121 there is a failure you will get undef returned and an error message in the log.
1125 sub has_encoding { shift->encoding ? 1:0 }
1127 sub clear_encoding {
1130 $c->encoding(undef);
1132 $c->log->error("You can't clear encoding on the application");
1142 # Don't let one change this once we are too far into the response
1143 if(blessed $c && $c->res->finalized_headers) {
1144 Carp::croak("You may not change the encoding once the headers are finalized");
1148 # Let it be set to undef
1149 if (my $wanted = shift) {
1150 $encoding = Encode::find_encoding($wanted)
1151 or Carp::croak( qq/Unknown encoding '$wanted'/ );
1152 binmode(STDERR, ':encoding(' . $encoding->name . ')');
1159 ? $c->{encoding} = $encoding
1160 : $c->_encoding($encoding);
1162 $encoding = ref $c && exists $c->{encoding}
1172 Returns 1 if debug mode is enabled, 0 otherwise.
1174 You can enable debug mode in several ways:
1178 =item By calling myapp_server.pl with the -d flag
1180 =item With the environment variables MYAPP_DEBUG, or CATALYST_DEBUG
1182 =item The -Debug option in your MyApp.pm
1184 =item By declaring C<sub debug { 1 }> in your MyApp.pm.
1188 The first three also set the log level to 'debug'.
1190 Calling C<< $c->debug(1) >> has no effect.
1196 =head2 $c->dispatcher
1198 Returns the dispatcher instance. See L<Catalyst::Dispatcher>.
1202 Returns the engine instance. See L<Catalyst::Engine>.
1205 =head2 UTILITY METHODS
1207 =head2 $c->path_to(@path)
1209 Merges C<@path> with C<< $c->config->{home} >> and returns a
1210 L<Path::Class::Dir> object. Note you can usually use this object as
1211 a filename, but sometimes you will have to explicitly stringify it
1212 yourself by calling the C<< ->stringify >> method.
1216 $c->path_to( 'db', 'sqlite.db' );
1221 my ( $c, @path ) = @_;
1222 my $path = Path::Class::Dir->new( $c->config->{home}, @path );
1223 if ( -d $path ) { return $path }
1224 else { return Path::Class::File->new( $c->config->{home}, @path ) }
1228 my ( $class, $name, $plugin, @args ) = @_;
1230 # See block comment in t/unit_core_plugin.t
1231 $class->log->warn(qq/Adding plugin using the ->plugin method is deprecated, and will be removed in a future release/);
1233 $class->_register_plugin( $plugin, 1 );
1235 eval { $plugin->import };
1236 $class->mk_classdata($name);
1238 eval { $obj = $plugin->new(@args) };
1241 Catalyst::Exception->throw( message =>
1242 qq/Couldn't instantiate instant plugin "$plugin", "$@"/ );
1245 $class->$name($obj);
1246 $class->log->debug(qq/Initialized instant plugin "$plugin" as "$name"/)
1252 Initializes the dispatcher and engine, loads any plugins, and loads the
1253 model, view, and controller components. You may also specify an array
1254 of plugins to load here, if you choose to not load them in the C<use
1258 MyApp->setup( qw/-Debug/ );
1260 B<Note:> You B<should not> wrap this method with method modifiers
1261 or bad things will happen - wrap the C<setup_finalize> method instead.
1263 B<Note:> You can create a custom setup stage that will execute when the
1264 application is starting. Use this to customize setup.
1266 MyApp->setup(-Custom=value);
1269 my ($class, $value) = @_;
1272 Can be handy if you want to hook into the setup phase.
1277 my ( $class, @arguments ) = @_;
1278 croak('Running setup more than once')
1279 if ( $class->setup_finished );
1281 unless ( $class->isa('Catalyst') ) {
1283 Catalyst::Exception->throw(
1284 message => qq/'$class' does not inherit from Catalyst/ );
1287 if ( $class->arguments ) {
1288 @arguments = ( @arguments, @{ $class->arguments } );
1294 foreach (@arguments) {
1298 ( $flags->{log} ) ? 'debug,' . $flags->{log} : 'debug';
1300 elsif (/^-(\w+)=?(.*)$/) {
1301 $flags->{ lc $1 } = $2;
1304 push @{ $flags->{plugins} }, $_;
1308 $class->setup_home( delete $flags->{home} );
1310 $class->setup_log( delete $flags->{log} );
1311 $class->setup_plugins( delete $flags->{plugins} );
1313 $class->setup_data_handlers();
1314 $class->setup_dispatcher( delete $flags->{dispatcher} );
1315 if (my $engine = delete $flags->{engine}) {
1316 $class->log->warn("Specifying the engine in ->setup is no longer supported, see Catalyst::Upgrading");
1318 $class->setup_engine();
1319 $class->setup_stats( delete $flags->{stats} );
1321 for my $flag ( sort keys %{$flags} ) {
1323 if ( my $code = $class->can( 'setup_' . $flag ) ) {
1324 &$code( $class, delete $flags->{$flag} );
1327 $class->log->warn(qq/Unknown flag "$flag"/);
1331 eval { require Catalyst::Devel; };
1332 if( !$@ && $ENV{CATALYST_SCRIPT_GEN} && ( $ENV{CATALYST_SCRIPT_GEN} < $Catalyst::Devel::CATALYST_SCRIPT_GEN ) ) {
1333 $class->log->warn(<<"EOF");
1334 You are running an old script!
1336 Please update by running (this will overwrite existing files):
1337 catalyst.pl -force -scripts $class
1339 or (this will not overwrite existing files):
1340 catalyst.pl -scripts $class
1345 # Call plugins setup, this is stupid and evil.
1346 # Also screws C3 badly on 5.10, hack to avoid.
1348 no warnings qw/redefine/;
1349 local *setup = sub { };
1350 $class->setup unless $Catalyst::__AM_RESTARTING;
1353 # If you are expecting configuration info as part of your setup, it needs
1354 # to get called here and below, since we need the above line to support
1355 # ConfigLoader based configs.
1357 $class->setup_encoding();
1358 $class->setup_middleware();
1360 # Initialize our data structure
1361 $class->components( {} );
1363 $class->setup_components;
1365 if ( $class->debug ) {
1366 my @plugins = map { "$_ " . ( $_->VERSION || '' ) } $class->registered_plugins;
1369 my $column_width = Catalyst::Utils::term_width() - 6;
1370 my $t = Text::SimpleTable->new($column_width);
1371 $t->row($_) for @plugins;
1372 $class->log->debug( "Loaded plugins:\n" . $t->draw . "\n" );
1375 my @middleware = map {
1378 (ref($_) .' '. ($_->can('VERSION') ? $_->VERSION || '' : '')
1379 || '') } $class->registered_middlewares;
1382 my $column_width = Catalyst::Utils::term_width() - 6;
1383 my $t = Text::SimpleTable->new($column_width);
1384 $t->row($_) for @middleware;
1385 $class->log->debug( "Loaded PSGI Middleware:\n" . $t->draw . "\n" );
1388 my %dh = $class->registered_data_handlers;
1389 if (my @data_handlers = keys %dh) {
1390 my $column_width = Catalyst::Utils::term_width() - 6;
1391 my $t = Text::SimpleTable->new($column_width);
1392 $t->row($_) for @data_handlers;
1393 $class->log->debug( "Loaded Request Data Handlers:\n" . $t->draw . "\n" );
1396 my $dispatcher = $class->dispatcher;
1397 my $engine = $class->engine;
1398 my $home = $class->config->{home};
1400 $class->log->debug(sprintf(q/Loaded dispatcher "%s"/, blessed($dispatcher)));
1401 $class->log->debug(sprintf(q/Loaded engine "%s"/, blessed($engine)));
1405 ? $class->log->debug(qq/Found home "$home"/)
1406 : $class->log->debug(qq/Home "$home" doesn't exist/)
1407 : $class->log->debug(q/Couldn't find home/);
1409 my $column_width = Catalyst::Utils::term_width() - 8 - 9;
1411 my $t = Text::SimpleTable->new( [ $column_width, 'Class' ], [ 8, 'Type' ] );
1412 for my $comp ( sort keys %{ $class->components } ) {
1413 my $type = ref $class->components->{$comp} ? 'instance' : 'class';
1414 $t->row( $comp, $type );
1416 $class->log->debug( "Loaded components:\n" . $t->draw . "\n" )
1417 if ( keys %{ $class->components } );
1420 # Add our self to components, since we are also a component
1421 if( $class->isa('Catalyst::Controller') ){
1422 $class->components->{$class} = $class;
1425 $class->setup_actions;
1427 if ( $class->debug ) {
1428 my $name = $class->config->{name} || 'Application';
1429 $class->log->info("$name powered by Catalyst $Catalyst::VERSION");
1432 if ($class->config->{case_sensitive}) {
1433 $class->log->warn($class . "->config->{case_sensitive} is set.");
1434 $class->log->warn("This setting is deprecated and planned to be removed in Catalyst 5.81.");
1437 $class->setup_finalize;
1439 # Flush the log for good measure (in case something turned off 'autoflush' early)
1440 $class->log->_flush() if $class->log->can('_flush');
1442 return $class || 1; # Just in case someone named their Application 0...
1445 =head2 $app->setup_finalize
1447 A hook to attach modifiers to. This method does not do anything except set the
1448 C<setup_finished> accessor.
1450 Applying method modifiers to the C<setup> method doesn't work, because of quirky things done for plugin setup.
1454 after setup_finalize => sub {
1462 sub setup_finalize {
1464 $class->setup_finished(1);
1467 =head2 $c->uri_for( $path?, @args?, \%query_values? )
1469 =head2 $c->uri_for( $action, \@captures?, @args?, \%query_values? )
1471 =head2 $c->uri_for( $action, [@captures, @args], \%query_values? )
1473 Constructs an absolute L<URI> object based on the application root, the
1474 provided path, and the additional arguments and query parameters provided.
1475 When used as a string, provides a textual URI. If you need more flexibility
1476 than this (i.e. the option to provide relative URIs etc.) see
1477 L<Catalyst::Plugin::SmartURI>.
1479 If no arguments are provided, the URI for the current action is returned.
1480 To return the current action and also provide @args, use
1481 C<< $c->uri_for( $c->action, @args ) >>.
1483 If the first argument is a string, it is taken as a public URI path relative
1484 to C<< $c->namespace >> (if it doesn't begin with a forward slash) or
1485 relative to the application root (if it does). It is then merged with
1486 C<< $c->request->base >>; any C<@args> are appended as additional path
1487 components; and any C<%query_values> are appended as C<?foo=bar> parameters.
1489 If the first argument is a L<Catalyst::Action> it represents an action which
1490 will have its path resolved using C<< $c->dispatcher->uri_for_action >>. The
1491 optional C<\@captures> argument (an arrayref) allows passing the captured
1492 variables that are needed to fill in the paths of Chained and Regex actions;
1493 once the path is resolved, C<uri_for> continues as though a path was
1494 provided, appending any arguments or parameters and creating an absolute
1497 The captures for the current request can be found in
1498 C<< $c->request->captures >>, and actions can be resolved using
1499 C<< Catalyst::Controller->action_for($name) >>. If you have a private action
1500 path, use C<< $c->uri_for_action >> instead.
1502 # Equivalent to $c->req->uri
1503 $c->uri_for($c->action, $c->req->captures,
1504 @{ $c->req->args }, $c->req->params);
1506 # For the Foo action in the Bar controller
1507 $c->uri_for($c->controller('Bar')->action_for('Foo'));
1509 # Path to a static resource
1510 $c->uri_for('/static/images/logo.png');
1512 In general the scheme of the generated URI object will follow the incoming request
1513 however if your targeted action or action chain has the Scheme attribute it will
1516 Also, if the targeted Action or Action chain declares Args/CaptureArgs that have
1517 type constraints, we will require that your proposed URL verify on those declared
1523 my ( $c, $path, @args ) = @_;
1525 if ( $path->$_isa('Catalyst::Controller') ) {
1526 $path = $path->path_prefix;
1531 undef($path) if (defined $path && $path eq '');
1534 ( scalar @args && ref $args[$#args] eq 'HASH' ? pop @args : {} );
1536 carp "uri_for called with undef argument" if grep { ! defined $_ } @args;
1538 my $target_action = $path->$_isa('Catalyst::Action') ? $path : undef;
1539 if ( $path->$_isa('Catalyst::Action') ) { # action object
1540 s|/|%2F|g for @args;
1541 my $captures = [ map { s|/|%2F|g; $_; }
1542 ( scalar @args && ref $args[0] eq 'ARRAY'
1547 my $expanded_action = $c->dispatcher->expand_action( $action );
1548 my $num_captures = $expanded_action->number_of_captures;
1550 # ->uri_for( $action, \@captures_and_args, \%query_values? )
1551 if( !@args && $action->number_of_args ) {
1552 unshift @args, splice @$captures, $num_captures;
1556 unless($expanded_action->match_captures_constraints($c, $captures)) {
1557 carp "captures [@{$captures}] do not match the type constraints in actionchain ending with '$expanded_action'";
1562 $path = $c->dispatcher->uri_for_action($action, $captures);
1563 if (not defined $path) {
1564 $c->log->debug(qq/Can't find uri_for action '$action' @$captures/)
1568 $path = '/' if $path eq '';
1570 # At this point @encoded_args is the remaining Args (all captures removed).
1571 if($expanded_action->has_args_constraints) {
1572 unless($expanded_action->match_args($c,\@args)) {
1573 carp "args [@args] do not match the type constraints in action '$expanded_action'";
1579 unshift(@args, $path);
1581 unless (defined $path && $path =~ s!^/!!) { # in-place strip
1582 my $namespace = $c->namespace;
1583 if (defined $path) { # cheesy hack to handle path '../foo'
1584 $namespace =~ s{(?:^|/)[^/]+$}{} while $args[0] =~ s{^\.\./}{};
1586 unshift(@args, $namespace || '');
1589 # join args with '/', or a blank string
1590 my $args = join('/', grep { defined($_) } @args);
1591 $args =~ s/\?/%3F/g; # STUPID STUPID SPECIAL CASE
1594 my ($base, $class) = ('/', 'URI::_generic');
1596 $base = $c->req->base;
1597 if($target_action) {
1598 $target_action = $c->dispatcher->expand_action($target_action);
1599 if(my $s = $target_action->scheme) {
1604 $class = ref($base);
1607 $class = ref($base);
1610 $base =~ s{(?<!/)$}{/};
1615 if (my @keys = keys %$params) {
1616 # somewhat lifted from URI::_query's query_form
1617 $query = '?'.join('&', map {
1618 my $val = $params->{$_};
1619 #s/([;\/?:@&=+,\$\[\]%])/$URI::Escape::escapes{$1}/go; ## Commented out because seems to lead to double encoding - JNAP
1622 $val = '' unless defined $val;
1625 $param = encode_utf8($param);
1626 # using the URI::Escape pattern here so utf8 chars survive
1627 $param =~ s/([^A-Za-z0-9\-_.!~*'() ])/$URI::Escape::escapes{$1}/go;
1630 $key = encode_utf8($key);
1631 # using the URI::Escape pattern here so utf8 chars survive
1632 $key =~ s/([^A-Za-z0-9\-_.!~*'() ])/$URI::Escape::escapes{$1}/go;
1635 "${key}=$param"; } ( ref $val eq 'ARRAY' ? @$val : $val ));
1639 $base = encode_utf8 $base;
1640 $base =~ s/([^$URI::uric])/$URI::Escape::escapes{$1}/go;
1641 $args = encode_utf8 $args;
1642 $args =~ s/([^$URI::uric])/$URI::Escape::escapes{$1}/go;
1644 my $res = bless(\"${base}${args}${query}", $class);
1648 =head2 $c->uri_for_action( $path, \@captures_and_args?, @args?, \%query_values? )
1650 =head2 $c->uri_for_action( $action, \@captures_and_args?, @args?, \%query_values? )
1656 A private path to the Catalyst action you want to create a URI for.
1658 This is a shortcut for calling C<< $c->dispatcher->get_action_by_path($path)
1659 >> and passing the resulting C<$action> and the remaining arguments to C<<
1662 You can also pass in a Catalyst::Action object, in which case it is passed to
1665 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.
1667 For example, if the action looks like:
1669 package MyApp::Controller::Users;
1671 sub lst : Path('the-list') {}
1675 $c->uri_for_action('/users/lst')
1677 and it will create the URI /users/the-list.
1679 =item \@captures_and_args?
1681 Optional array reference of Captures (i.e. C<<CaptureArgs or $c->req->captures>)
1682 and arguments to the request. Usually used with L<Catalyst::DispatchType::Chained>
1683 to interpolate all the parameters in the URI.
1687 Optional list of extra arguments - can be supplied in the
1688 C<< \@captures_and_args? >> array ref, or here - whichever is easier for your
1691 Your action can have zero, a fixed or a variable number of args (e.g.
1692 C<< Args(1) >> for a fixed number or C<< Args() >> for a variable number)..
1694 =item \%query_values?
1696 Optional array reference of query parameters to append. E.g.
1702 /rest/of/your/uri?foo=bar
1708 sub uri_for_action {
1709 my ( $c, $path, @args ) = @_;
1710 my $action = blessed($path)
1712 : $c->dispatcher->get_action_by_path($path);
1713 unless (defined $action) {
1714 croak "Can't find action for path '$path'";
1716 return $c->uri_for( $action, @args );
1719 =head2 $c->welcome_message
1721 Returns the Catalyst welcome HTML page.
1725 sub welcome_message {
1727 my $name = $c->config->{name};
1728 my $logo = $c->uri_for('/static/images/catalyst_logo.png');
1729 my $prefix = Catalyst::Utils::appprefix( ref $c );
1730 $c->response->content_type('text/html; charset=utf-8');
1732 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
1733 "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
1734 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
1736 <meta http-equiv="Content-Language" content="en" />
1737 <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
1738 <title>$name on Catalyst $VERSION</title>
1739 <style type="text/css">
1742 background-color: #eee;
1749 margin-bottom: 10px;
1751 background-color: #ccc;
1752 border: 1px solid #aaa;
1757 font-family: verdana, tahoma, sans-serif;
1760 font-family: verdana, tahoma, sans-serif;
1763 text-decoration: none;
1765 border-bottom: 1px dotted #bbb;
1767 :link:hover, :visited:hover {
1780 background-color: #fff;
1781 border: 1px solid #aaa;
1785 font-weight: normal;
1807 <h1><span id="appname">$name</span> on <a href="http://catalyst.perl.org">Catalyst</a>
1812 <img src="$logo" alt="Catalyst Logo" />
1814 <p>Welcome to the world of Catalyst.
1815 This <a href="http://en.wikipedia.org/wiki/MVC">MVC</a>
1816 framework will make web development something you had
1817 never expected it to be: Fun, rewarding, and quick.</p>
1818 <h2>What to do now?</h2>
1819 <p>That really depends on what <b>you</b> want to do.
1820 We do, however, provide you with a few starting points.</p>
1821 <p>If you want to jump right into web development with Catalyst
1822 you might want to start with a tutorial.</p>
1823 <pre>perldoc <a href="https://metacpan.org/module/Catalyst::Manual::Tutorial">Catalyst::Manual::Tutorial</a></code>
1825 <p>Afterwards you can go on to check out a more complete look at our features.</p>
1827 <code>perldoc <a href="https://metacpan.org/module/Catalyst::Manual::Intro">Catalyst::Manual::Intro</a>
1828 <!-- Something else should go here, but the Catalyst::Manual link seems unhelpful -->
1830 <h2>What to do next?</h2>
1831 <p>Next it's time to write an actual application. Use the
1832 helper scripts to generate <a href="https://metacpan.org/search?q=Catalyst%3A%3AController">controllers</a>,
1833 <a href="https://metacpan.org/search?q=Catalyst%3A%3AModel">models</a>, and
1834 <a href="https://metacpan.org/search?q=Catalyst%3A%3AView">views</a>;
1835 they can save you a lot of work.</p>
1836 <pre><code>script/${prefix}_create.pl --help</code></pre>
1837 <p>Also, be sure to check out the vast and growing
1838 collection of <a href="http://search.cpan.org/search?query=Catalyst">plugins for Catalyst on CPAN</a>;
1839 you are likely to find what you need there.
1843 <p>Catalyst has a very active community. Here are the main places to
1844 get in touch with us.</p>
1847 <a href="http://dev.catalyst.perl.org">Wiki</a>
1850 <a href="http://lists.scsys.co.uk/cgi-bin/mailman/listinfo/catalyst">Mailing-List</a>
1853 <a href="irc://irc.perl.org/catalyst">IRC channel #catalyst on irc.perl.org</a>
1856 <h2>In conclusion</h2>
1857 <p>The Catalyst team hopes you will enjoy using Catalyst as much
1858 as we enjoyed making it. Please contact us if you have ideas
1859 for improvement or other feedback.</p>
1869 Contains a hash of options passed from the application script, including
1870 the original ARGV the script received, the processed values from that
1871 ARGV and any extra arguments to the script which were not processed.
1873 This can be used to add custom options to your application's scripts
1874 and setup your application differently depending on the values of these
1877 =head1 INTERNAL METHODS
1879 These methods are not meant to be used by end users.
1881 =head2 $c->components
1883 Returns a hash of components.
1885 =head2 $c->context_class
1887 Returns or sets the context class.
1891 Returns a hashref containing coderefs and execution counts (needed for
1892 deep recursion detection).
1896 Returns the number of actions on the current internal execution stack.
1900 Dispatches a request to actions.
1904 sub dispatch { my $c = shift; $c->dispatcher->dispatch( $c, @_ ) }
1906 =head2 $c->dispatcher_class
1908 Returns or sets the dispatcher class.
1910 =head2 $c->dump_these
1912 Returns a list of 2-element array references (name, structure) pairs
1913 that will be dumped on the error page in debug mode.
1919 [ Request => $c->req ],
1920 [ Response => $c->res ],
1921 [ Stash => $c->stash ],
1922 [ Config => $c->config ];
1925 =head2 $c->engine_class
1927 Returns or sets the engine class.
1929 =head2 $c->execute( $class, $coderef )
1931 Execute a coderef in given class and catch exceptions. Errors are available
1937 my ( $c, $class, $code ) = @_;
1938 $class = $c->component($class) || $class;
1941 if ( $c->depth >= $RECURSION ) {
1942 my $action = $code->reverse();
1943 $action = "/$action" unless $action =~ /->/;
1944 my $error = qq/Deep recursion detected calling "${action}"/;
1945 $c->log->error($error);
1951 my $stats_info = $c->_stats_start_execute( $code ) if $c->use_stats;
1953 push( @{ $c->stack }, $code );
1955 no warnings 'recursion';
1956 # N.B. This used to be combined, but I have seen $c get clobbered if so, and
1957 # I have no idea how, ergo $ret (which appears to fix the issue)
1958 eval { my $ret = $code->execute( $class, $c, @{ $c->req->args } ) || 0; $c->state( $ret ) };
1960 $c->_stats_finish_execute( $stats_info ) if $c->use_stats and $stats_info;
1962 my $last = pop( @{ $c->stack } );
1964 if ( my $error = $@ ) {
1965 #rethow if this can be handled by middleware
1966 if ( $c->_handle_http_exception($error) ) {
1967 foreach my $err (@{$c->error}) {
1968 $c->log->error($err);
1971 $c->log->_flush if $c->log->can('_flush');
1973 $error->can('rethrow') ? $error->rethrow : croak $error;
1975 if ( blessed($error) and $error->isa('Catalyst::Exception::Detach') ) {
1976 $error->rethrow if $c->depth > 1;
1978 elsif ( blessed($error) and $error->isa('Catalyst::Exception::Go') ) {
1979 $error->rethrow if $c->depth > 0;
1982 unless ( ref $error ) {
1983 no warnings 'uninitialized';
1985 my $class = $last->class;
1986 my $name = $last->name;
1987 $error = qq/Caught exception in $class->$name "$error"/;
1996 sub _stats_start_execute {
1997 my ( $c, $code ) = @_;
1998 my $appclass = ref($c) || $c;
1999 return if ( ( $code->name =~ /^_.*/ )
2000 && ( !$appclass->config->{show_internal_actions} ) );
2002 my $action_name = $code->reverse();
2003 $c->counter->{$action_name}++;
2005 my $action = $action_name;
2006 $action = "/$action" unless $action =~ /->/;
2008 # determine if the call was the result of a forward
2009 # this is done by walking up the call stack and looking for a calling
2010 # sub of Catalyst::forward before the eval
2012 for my $index ( 2 .. 11 ) {
2014 if ( ( caller($index) )[0] eq 'Catalyst'
2015 && ( caller($index) )[3] eq '(eval)' );
2017 if ( ( caller($index) )[3] =~ /forward$/ ) {
2018 $callsub = ( caller($index) )[3];
2019 $action = "-> $action";
2024 my $uid = $action_name . $c->counter->{$action_name};
2026 # is this a root-level call or a forwarded call?
2027 if ( $callsub =~ /forward$/ ) {
2028 my $parent = $c->stack->[-1];
2030 # forward, locate the caller
2031 if ( defined $parent && exists $c->counter->{"$parent"} ) {
2034 parent => "$parent" . $c->counter->{"$parent"},
2040 # forward with no caller may come from a plugin
2059 sub _stats_finish_execute {
2060 my ( $c, $info ) = @_;
2061 $c->stats->profile( end => $info );
2066 Finalizes the request.
2073 for my $error ( @{ $c->error } ) {
2074 $c->log->error($error);
2077 # Support skipping finalize for psgix.io style 'jailbreak'. Used to support
2078 # stuff like cometd and websockets
2080 if($c->request->_has_io_fh) {
2085 # Allow engine to handle finalize flow (for POE)
2086 my $engine = $c->engine;
2087 if ( my $code = $engine->can('finalize') ) {
2092 $c->finalize_uploads;
2095 if ( $#{ $c->error } >= 0 ) {
2099 $c->finalize_encoding;
2100 $c->finalize_headers unless $c->response->finalized_headers;
2106 if ($c->use_stats) {
2107 my $elapsed = $c->stats->elapsed;
2108 my $av = $elapsed == 0 ? '??' : sprintf '%.3f', 1 / $elapsed;
2110 "Request took ${elapsed}s ($av/s)\n" . $c->stats->report . "\n" );
2113 return $c->response->status;
2116 =head2 $c->finalize_body
2122 sub finalize_body { my $c = shift; $c->engine->finalize_body( $c, @_ ) }
2124 =head2 $c->finalize_cookies
2130 sub finalize_cookies { my $c = shift; $c->engine->finalize_cookies( $c, @_ ) }
2132 =head2 $c->finalize_error
2134 Finalizes error. If there is only one error in L</error> and it is an object that
2135 does C<as_psgi> or C<code> we rethrow the error and presume it caught by middleware
2136 up the ladder. Otherwise we return the debugging error page (in debug mode) or we
2137 return the default error page (production mode).
2141 sub finalize_error {
2143 if($#{$c->error} > 0) {
2144 $c->engine->finalize_error( $c, @_ );
2146 my ($error) = @{$c->error};
2147 if ( $c->_handle_http_exception($error) ) {
2148 # In the case where the error 'knows what it wants', becauses its PSGI
2149 # aware, just rethow and let middleware catch it
2150 $error->can('rethrow') ? $error->rethrow : croak $error;
2152 $c->engine->finalize_error( $c, @_ )
2157 =head2 $c->finalize_headers
2163 sub finalize_headers {
2166 my $response = $c->response; #accessor calls can add up?
2168 # Check if we already finalized headers
2169 return if $response->finalized_headers;
2172 if ( my $location = $response->redirect ) {
2173 $c->log->debug(qq/Redirecting to "$location"/) if $c->debug;
2174 $response->header( Location => $location );
2177 # Remove incorrectly added body and content related meta data when returning
2178 # an information response, or a response the is required to not include a body
2180 $c->finalize_cookies;
2182 # This currently is a NOOP but I don't want to remove it since I guess people
2183 # might have Response subclasses that use it for something... (JNAP)
2184 $c->response->finalize_headers();
2187 $response->finalized_headers(1);
2190 =head2 $c->finalize_encoding
2192 Make sure your body is encoded properly IF you set an encoding. By
2193 default the encoding is UTF-8 but you can disable it by explicitly setting the
2194 encoding configuration value to undef.
2196 We can only encode when the body is a scalar. Methods for encoding via the
2197 streaming interfaces (such as C<write> and C<write_fh> on L<Catalyst::Response>
2204 sub finalize_encoding {
2206 my $res = $c->res || return;
2208 # Warn if the set charset is different from the one you put into encoding. We need
2209 # to do this early since encodable_response is false for this condition and we need
2210 # to match the debug output for backcompat (there's a test for this...) -JNAP
2212 $res->content_type_charset and $c->encoding and
2213 (uc($c->encoding->mime_name) ne uc($res->content_type_charset))
2215 my $ct = lc($res->content_type_charset);
2216 $c->log->debug("Catalyst encoding config is set to encode in '" .
2217 $c->encoding->mime_name .
2218 "', content type is '$ct', not encoding ");
2222 ($res->encodable_response) and
2223 (defined($res->body)) and
2224 (ref(\$res->body) eq 'SCALAR')
2226 $c->res->body( $c->encoding->encode( $c->res->body, $c->_encode_check ) );
2228 # Set the charset if necessary. This might be a bit bonkers since encodable response
2229 # is false when the set charset is not the same as the encoding mimetype (maybe
2230 # confusing action at a distance here..
2231 # Don't try to set the charset if one already exists or if headers are already finalized
2232 $c->res->content_type($c->res->content_type . "; charset=" . $c->encoding->mime_name)
2233 unless($c->res->content_type_charset ||
2234 ($c->res->_context && $c->res->finalized_headers && !$c->res->_has_response_cb));
2238 =head2 $c->finalize_output
2240 An alias for finalize_body.
2242 =head2 $c->finalize_read
2244 Finalizes the input after reading is complete.
2248 sub finalize_read { my $c = shift; $c->engine->finalize_read( $c, @_ ) }
2250 =head2 $c->finalize_uploads
2252 Finalizes uploads. Cleans up any temporary files.
2256 sub finalize_uploads { my $c = shift; $c->engine->finalize_uploads( $c, @_ ) }
2258 =head2 $c->get_action( $action, $namespace )
2260 Gets an action in a given namespace.
2264 sub get_action { my $c = shift; $c->dispatcher->get_action(@_) }
2266 =head2 $c->get_actions( $action, $namespace )
2268 Gets all actions of a given name in a namespace and all parent
2273 sub get_actions { my $c = shift; $c->dispatcher->get_actions( $c, @_ ) }
2275 =head2 $app->handle_request( @arguments )
2277 Called to handle each HTTP request.
2281 sub handle_request {
2282 my ( $class, @arguments ) = @_;
2284 # Always expect worst case!
2287 if ($class->debug) {
2288 my $secs = time - $START || 1;
2289 my $av = sprintf '%.3f', $COUNT / $secs;
2290 my $time = localtime time;
2291 $class->log->info("*** Request $COUNT ($av/s) [$$] [$time] ***");
2294 my $c = $class->prepare(@arguments);
2296 $status = $c->finalize;
2298 #rethow if this can be handled by middleware
2299 if ( $class->_handle_http_exception($_) ) {
2300 $_->can('rethrow') ? $_->rethrow : croak $_;
2302 chomp(my $error = $_);
2303 $class->log->error(qq/Caught exception in engine "$error"/);
2308 if(my $coderef = $class->log->can('_flush')){
2309 $class->log->$coderef();
2314 =head2 $class->prepare( @arguments )
2316 Creates a Catalyst context from an engine-specific request (Apache, CGI,
2323 predicate => '_has_uploadtmp',
2327 my ( $class, @arguments ) = @_;
2330 # After the app/ctxt split, this should become an attribute based on something passed
2331 # into the application.
2332 $class->context_class( ref $class || $class ) unless $class->context_class;
2334 my $uploadtmp = $class->config->{uploadtmp};
2335 my $c = $class->context_class->new({ $uploadtmp ? (_uploadtmp => $uploadtmp) : ()});
2337 $c->response->_context($c);
2339 $c->stats($class->stats_class->new)->enable($c->use_stats);
2341 if ( $c->debug || $c->config->{enable_catalyst_header} ) {
2342 $c->res->headers->header( 'X-Catalyst' => $Catalyst::VERSION );
2346 # Allow engine to direct the prepare flow (for POE)
2347 if ( my $prepare = $c->engine->can('prepare') ) {
2348 $c->engine->$prepare( $c, @arguments );
2351 $c->prepare_request(@arguments);
2352 $c->prepare_connection;
2353 $c->prepare_query_parameters;
2354 $c->prepare_headers; # Just hooks, no longer needed - they just
2355 $c->prepare_cookies; # cause the lazy attribute on req to build
2358 # Prepare the body for reading, either by prepare_body
2359 # or the user, if they are using $c->read
2362 # Parse the body unless the user wants it on-demand
2363 unless ( ref($c)->config->{parse_on_demand} ) {
2369 # VERY ugly and probably shouldn't rely on ->finalize actually working
2371 # failed prepare is always due to an invalid request, right?
2372 $c->response->status(400);
2373 $c->response->content_type('text/plain');
2374 $c->response->body('Bad Request');
2375 # Note we call finalize and then die here, which escapes
2376 # finalize being called in the enclosing block..
2377 # It in fact couldn't be called, as we don't return $c..
2378 # This is a mess - but I'm unsure you can fix this without
2379 # breaking compat for people doing crazy things (we should set
2380 # the 400 and just return the ctx here IMO, letting finalize get called
2391 =head2 $c->prepare_action
2393 Prepares action. See L<Catalyst::Dispatcher>.
2397 sub prepare_action {
2399 my $ret = $c->dispatcher->prepare_action( $c, @_);
2402 foreach (@{$c->req->arguments}, @{$c->req->captures}) {
2403 $_ = $c->_handle_param_unicode_decoding($_);
2411 =head2 $c->prepare_body
2413 Prepares message body.
2420 return if $c->request->_has_body;
2422 # Initialize on-demand data
2423 $c->engine->prepare_body( $c, @_ );
2424 $c->prepare_parameters;
2425 $c->prepare_uploads;
2428 =head2 $c->prepare_body_chunk( $chunk )
2430 Prepares a chunk of data before sending it to L<HTTP::Body>.
2432 See L<Catalyst::Engine>.
2436 sub prepare_body_chunk {
2438 $c->engine->prepare_body_chunk( $c, @_ );
2441 =head2 $c->prepare_body_parameters
2443 Prepares body parameters.
2447 sub prepare_body_parameters {
2449 $c->request->prepare_body_parameters( $c, @_ );
2452 =head2 $c->prepare_connection
2454 Prepares connection.
2458 sub prepare_connection {
2460 $c->request->prepare_connection($c);
2463 =head2 $c->prepare_cookies
2465 Prepares cookies by ensuring that the attribute on the request
2466 object has been built.
2470 sub prepare_cookies { my $c = shift; $c->request->cookies }
2472 =head2 $c->prepare_headers
2474 Prepares request headers by ensuring that the attribute on the request
2475 object has been built.
2479 sub prepare_headers { my $c = shift; $c->request->headers }
2481 =head2 $c->prepare_parameters
2483 Prepares parameters.
2487 sub prepare_parameters {
2489 $c->prepare_body_parameters;
2490 $c->engine->prepare_parameters( $c, @_ );
2493 =head2 $c->prepare_path
2495 Prepares path and base.
2499 sub prepare_path { my $c = shift; $c->engine->prepare_path( $c, @_ ) }
2501 =head2 $c->prepare_query_parameters
2503 Prepares query parameters.
2507 sub prepare_query_parameters {
2510 $c->engine->prepare_query_parameters( $c, @_ );
2513 =head2 $c->log_request
2515 Writes information about the request to the debug logs. This includes:
2519 =item * Request method, path, and remote IP address
2521 =item * Query keywords (see L<Catalyst::Request/query_keywords>)
2523 =item * Request parameters
2525 =item * File uploads
2534 return unless $c->debug;
2536 my($dump) = grep {$_->[0] eq 'Request' } $c->dump_these;
2537 my $request = $dump->[1];
2539 my ( $method, $path, $address ) = ( $request->method, $request->path, $request->address );
2541 $path = '/' unless length $path;
2544 $path =~ s/%([0-9A-Fa-f]{2})/chr(hex($1))/eg;
2545 $path = decode_utf8($path);
2547 $c->log->debug(qq/"$method" request for "$path" from "$address"/);
2549 $c->log_request_headers($request->headers);
2551 if ( my $keywords = $request->query_keywords ) {
2552 $c->log->debug("Query keywords are: $keywords");
2555 $c->log_request_parameters( query => $request->query_parameters, $request->_has_body ? (body => $request->body_parameters) : () );
2557 $c->log_request_uploads($request);
2560 =head2 $c->log_response
2562 Writes information about the response to the debug logs by calling
2563 C<< $c->log_response_status_line >> and C<< $c->log_response_headers >>.
2570 return unless $c->debug;
2572 my($dump) = grep {$_->[0] eq 'Response' } $c->dump_these;
2573 my $response = $dump->[1];
2575 $c->log_response_status_line($response);
2576 $c->log_response_headers($response->headers);
2579 =head2 $c->log_response_status_line($response)
2581 Writes one line of information about the response to the debug logs. This includes:
2585 =item * Response status code
2587 =item * Content-Type header (if present)
2589 =item * Content-Length header (if present)
2595 sub log_response_status_line {
2596 my ($c, $response) = @_;
2600 'Response Code: %s; Content-Type: %s; Content-Length: %s',
2601 $response->status || 'unknown',
2602 $response->headers->header('Content-Type') || 'unknown',
2603 $response->headers->header('Content-Length') || 'unknown'
2608 =head2 $c->log_response_headers($headers);
2610 Hook method which can be wrapped by plugins to log the response headers.
2611 No-op in the default implementation.
2615 sub log_response_headers {}
2617 =head2 $c->log_request_parameters( query => {}, body => {} )
2619 Logs request parameters to debug logs
2623 sub log_request_parameters {
2625 my %all_params = @_;
2627 return unless $c->debug;
2629 my $column_width = Catalyst::Utils::term_width() - 44;
2630 foreach my $type (qw(query body)) {
2631 my $params = $all_params{$type};
2632 next if ! keys %$params;
2633 my $t = Text::SimpleTable->new( [ 35, 'Parameter' ], [ $column_width, 'Value' ] );
2634 for my $key ( sort keys %$params ) {
2635 my $param = $params->{$key};
2636 my $value = defined($param) ? $param : '';
2637 $t->row( $key, ref $value eq 'ARRAY' ? ( join ', ', @$value ) : $value );
2639 $c->log->debug( ucfirst($type) . " Parameters are:\n" . $t->draw );
2643 =head2 $c->log_request_uploads
2645 Logs file uploads included in the request to the debug logs.
2646 The parameter name, filename, file type, and file size are all included in
2651 sub log_request_uploads {
2653 my $request = shift;
2654 return unless $c->debug;
2655 my $uploads = $request->uploads;
2656 if ( keys %$uploads ) {
2657 my $t = Text::SimpleTable->new(
2658 [ 12, 'Parameter' ],
2663 for my $key ( sort keys %$uploads ) {
2664 my $upload = $uploads->{$key};
2665 for my $u ( ref $upload eq 'ARRAY' ? @{$upload} : ($upload) ) {
2666 $t->row( $key, $u->filename, $u->type, $u->size );
2669 $c->log->debug( "File Uploads are:\n" . $t->draw );
2673 =head2 $c->log_request_headers($headers);
2675 Hook method which can be wrapped by plugins to log the request headers.
2676 No-op in the default implementation.
2680 sub log_request_headers {}
2682 =head2 $c->log_headers($type => $headers)
2684 Logs L<HTTP::Headers> (either request or response) to the debug logs.
2691 my $headers = shift; # an HTTP::Headers instance
2693 return unless $c->debug;
2695 my $column_width = Catalyst::Utils::term_width() - 28;
2696 my $t = Text::SimpleTable->new( [ 15, 'Header Name' ], [ $column_width, 'Value' ] );
2699 my ( $name, $value ) = @_;
2700 $t->row( $name, $value );
2703 $c->log->debug( ucfirst($type) . " Headers:\n" . $t->draw );
2707 =head2 $c->prepare_read
2709 Prepares the input for reading.
2713 sub prepare_read { my $c = shift; $c->engine->prepare_read( $c, @_ ) }
2715 =head2 $c->prepare_request
2717 Prepares the engine request.
2721 sub prepare_request { my $c = shift; $c->engine->prepare_request( $c, @_ ) }
2723 =head2 $c->prepare_uploads
2729 sub prepare_uploads {
2731 $c->engine->prepare_uploads( $c, @_ );
2734 =head2 $c->prepare_write
2736 Prepares the output for writing.
2740 sub prepare_write { my $c = shift; $c->engine->prepare_write( $c, @_ ) }
2742 =head2 $c->request_class
2744 Returns or sets the request class. Defaults to L<Catalyst::Request>.
2746 =head2 $app->request_class_traits
2748 An arrayref of L<Moose::Role>s which are applied to the request class. You can
2749 name the full namespace of the role, or a namespace suffix, which will then
2750 be tried against the following standard namespace prefixes.
2752 $MyApp::TraitFor::Request::$trait_suffix
2753 Catalyst::TraitFor::Request::$trait_suffix
2755 So for example if you set:
2757 MyApp->request_class_traits(['Foo']);
2759 We try each possible role in turn (and throw an error if none load)
2762 MyApp::TraitFor::Request::Foo
2763 Catalyst::TraitFor::Request::Foo
2765 The namespace part 'TraitFor::Request' was choosen to assist in backwards
2766 compatibility with L<CatalystX::RoleApplicator> which previously provided
2767 these features in a stand alone package.
2769 =head2 $app->composed_request_class
2771 This is the request class which has been composed with any request_class_traits.
2773 =head2 $c->response_class
2775 Returns or sets the response class. Defaults to L<Catalyst::Response>.
2777 =head2 $app->response_class_traits
2779 An arrayref of L<Moose::Role>s which are applied to the response class. You can
2780 name the full namespace of the role, or a namespace suffix, which will then
2781 be tried against the following standard namespace prefixes.
2783 $MyApp::TraitFor::Response::$trait_suffix
2784 Catalyst::TraitFor::Response::$trait_suffix
2786 So for example if you set:
2788 MyApp->response_class_traits(['Foo']);
2790 We try each possible role in turn (and throw an error if none load)
2793 MyApp::TraitFor::Response::Foo
2794 Catalyst::TraitFor::Responset::Foo
2796 The namespace part 'TraitFor::Response' was choosen to assist in backwards
2797 compatibility with L<CatalystX::RoleApplicator> which previously provided
2798 these features in a stand alone package.
2801 =head2 $app->composed_response_class
2803 This is the request class which has been composed with any response_class_traits.
2805 =head2 $c->read( [$maxlength] )
2807 Reads a chunk of data from the request body. This method is designed to
2808 be used in a while loop, reading C<$maxlength> bytes on every call.
2809 C<$maxlength> defaults to the size of the request if not specified.
2811 You have to set C<< MyApp->config(parse_on_demand => 1) >> to use this
2814 Warning: If you use read(), Catalyst will not process the body,
2815 so you will not be able to access POST parameters or file uploads via
2816 $c->request. You must handle all body parsing yourself.
2820 sub read { my $c = shift; return $c->request->read( @_ ) }
2830 $app->_make_immutable_if_needed;
2831 $app->engine_loader->needs_psgi_engine_compat_hack ?
2832 $app->engine->run($app, @_) :
2833 $app->engine->run( $app, $app->_finalized_psgi_app, @_ );
2836 sub _make_immutable_if_needed {
2838 my $meta = find_meta($class);
2839 my $isa_ca = $class->isa('Class::Accessor::Fast') || $class->isa('Class::Accessor');
2842 && ! { $meta->immutable_options }->{replace_constructor}
2845 warn("You made your application class ($class) immutable, "
2846 . "but did not inline the\nconstructor. "
2847 . "This will break catalyst, as your app \@ISA "
2848 . "Class::Accessor(::Fast)?\nPlease pass "
2849 . "(replace_constructor => 1)\nwhen making your class immutable.\n");
2851 unless ($meta->is_immutable) {
2852 # XXX - FIXME warning here as you should make your app immutable yourself.
2853 $meta->make_immutable(
2854 replace_constructor => 1,
2859 =head2 $c->set_action( $action, $code, $namespace, $attrs )
2861 Sets an action in a given namespace.
2865 sub set_action { my $c = shift; $c->dispatcher->set_action( $c, @_ ) }
2867 =head2 $c->setup_actions($component)
2869 Sets up actions for a component.
2873 sub setup_actions { my $c = shift; $c->dispatcher->setup_actions( $c, @_ ) }
2875 =head2 $c->setup_components
2877 This method is called internally to set up the application's components.
2879 It finds modules by calling the L<locate_components> method, expands them to
2880 package names with the L<expand_component_module> method, and then installs
2881 each component into the application.
2883 The C<setup_components> config option is passed to both of the above methods.
2885 Installation of each component is performed by the L<setup_component> method,
2890 sub setup_components {
2893 my $config = $class->config->{ setup_components };
2895 my @comps = $class->locate_components($config);
2896 my %comps = map { $_ => 1 } @comps;
2898 my $deprecatedcatalyst_component_names = grep { /::[CMV]::/ } @comps;
2899 $class->log->warn(qq{Your application is using the deprecated ::[MVC]:: type naming scheme.\n}.
2900 qq{Please switch your class names to ::Model::, ::View:: and ::Controller: as appropriate.\n}
2901 ) if $deprecatedcatalyst_component_names;
2903 for my $component ( @comps ) {
2905 # We pass ignore_loaded here so that overlay files for (e.g.)
2906 # Model::DBI::Schema sub-classes are loaded - if it's in @comps
2907 # we know M::P::O found a file on disk so this is safe
2909 Catalyst::Utils::ensure_class_loaded( $component, { ignore_loaded => 1 } );
2912 for my $component (@comps) {
2913 my $instance = $class->components->{ $component } = $class->delayed_setup_component($component);
2916 # Inject a component or wrap a stand alone class in an adaptor. This makes a list
2917 # of named components in the configuration that are not actually existing (not a
2920 my @injected = $class->setup_injected_components;
2922 # All components are registered, now we need to 'init' them.
2923 foreach my $component_name (@comps, @injected) {
2924 $class->components->{$component_name} = $class->components->{$component_name}->() if
2925 (ref($class->components->{$component_name}) || '') eq 'CODE';
2929 =head2 $app->setup_injected_components
2931 Called by setup_compoents to setup components that are injected.
2935 sub setup_injected_components {
2937 my @injected_components = keys %{$class->config->{inject_components} ||+{}};
2939 foreach my $injected_comp_name(@injected_components) {
2940 $class->setup_injected_component(
2941 $injected_comp_name,
2942 $class->config->{inject_components}->{$injected_comp_name});
2945 return map { $class ."::" . $_ }
2946 @injected_components;
2949 =head2 $app->setup_injected_component( $injected_component_name, $config )
2951 Setup a given injected component.
2955 sub setup_injected_component {
2956 my ($class, $injected_comp_name, $config) = @_;
2957 if(my $component_class = $config->{from_component}) {
2958 my @roles = @{$config->{roles} ||[]};
2959 Catalyst::Utils::inject_component(
2961 component => $component_class,
2962 (scalar(@roles) ? (traits => \@roles) : ()),
2963 as => $injected_comp_name);
2967 =head2 $app->inject_component($MyApp_Component_name => \%args);
2969 Add a component that is injected at setup:
2971 MyApp->inject_component( 'Model::Foo' => { from_component => 'Common::Foo' } );
2973 Must be called before ->setup. Expects a component name for your
2974 current application and \%args where
2978 =item from_component
2980 The target component being injected into your application
2984 An arrayref of L<Moose::Role>s that are applied to your component.
2990 MyApp->inject_component(
2992 from_component => 'Common::Model::Foo',
2993 roles => ['Role1', 'Role2'],
2996 =head2 $app->inject_components
2998 Inject a list of components:
3000 MyApp->inject_components(
3001 'Model::FooOne' => {
3002 from_component => 'Common::Model::Foo',
3003 roles => ['Role1', 'Role2'],
3005 'Model::FooTwo' => {
3006 from_component => 'Common::Model::Foo',
3007 roles => ['Role1', 'Role2'],
3012 sub inject_component {
3013 my ($app, $name, $args) = @_;
3014 die "Component $name exists" if
3015 $app->config->{inject_components}->{$name};
3016 $app->config->{inject_components}->{$name} = $args;
3019 sub inject_components {
3022 $app->inject_component(shift, shift);
3026 =head2 $c->locate_components( $setup_component_config )
3028 This method is meant to provide a list of component modules that should be
3029 setup for the application. By default, it will use L<Module::Pluggable>.
3031 Specify a C<setup_components> config option to pass additional options directly
3032 to L<Module::Pluggable>. To add additional search paths, specify a key named
3033 C<search_extra> as an array reference. Items in the array beginning with C<::>
3034 will have the application class name prepended to them.
3038 sub locate_components {
3042 my @paths = qw( ::M ::Model ::V ::View ::C ::Controller );
3043 my $extra = delete $config->{ search_extra } || [];
3045 unshift @paths, @$extra;
3047 my @comps = map { sort { length($a) <=> length($b) } Module::Pluggable::Object->new(
3048 search_path => [ map { s/^(?=::)/$class/; $_; } ($_) ],
3050 )->plugins } @paths;
3055 =head2 $c->expand_component_module( $component, $setup_component_config )
3057 Components found by C<locate_components> will be passed to this method, which
3058 is expected to return a list of component (package) names to be set up.
3062 sub expand_component_module {
3063 my ($class, $module) = @_;
3064 return Devel::InnerPackage::list_packages( $module );
3067 =head2 $app->delayed_setup_component
3069 Returns a coderef that points to a setup_component instance. Used
3070 internally for when you want to delay setup until the first time
3071 the component is called.
3075 sub delayed_setup_component {
3076 my($class, $component, @more) = @_;
3078 return my $instance = $class->setup_component($component, @more);
3082 =head2 $c->setup_component
3086 sub setup_component {
3087 my( $class, $component ) = @_;
3089 unless ( $component->can( 'COMPONENT' ) ) {
3093 my $config = $class->config_for($component);
3094 # Stash catalyst_component_name in the config here, so that custom COMPONENT
3095 # methods also pass it. local to avoid pointlessly shitting in config
3096 # for the debug screen, as $component is already the key name.
3097 local $config->{catalyst_component_name} = $component;
3099 my $instance = eval {
3100 $component->COMPONENT( $class, $config );
3104 Catalyst::Exception->throw(
3105 message => qq/Couldn't instantiate component "$component", "$error"/
3109 unless (blessed $instance) {
3110 my $metaclass = Moose::Util::find_meta($component);
3111 my $method_meta = $metaclass->find_method_by_name('COMPONENT');
3112 my $component_method_from = $method_meta->associated_metaclass->name;
3113 my $value = defined($instance) ? $instance : 'undef';
3114 Catalyst::Exception->throw(
3116 qq/Couldn't instantiate component "$component", COMPONENT() method (from $component_method_from) didn't return an object-like value (value was $value)./
3120 my @expanded_components = $instance->can('expand_modules')
3121 ? $instance->expand_modules( $component, $config )
3122 : $class->expand_component_module( $component, $config );
3123 for my $component (@expanded_components) {
3124 next if $class->components->{ $component };
3125 $class->components->{ $component } = $class->setup_component($component);
3131 =head2 $app->config_for( $component_name )
3133 Return the application level configuration (which is not yet merged with any
3134 local component configuration, via $component_class->config) for the named
3135 component or component object. Example:
3138 'Model::Foo' => { a => 1, b => 2},
3141 my $config = MyApp->config_for('MyApp::Model::Foo');
3143 In this case $config is the hashref C< {a=>1, b=>2} >.
3145 This is also handy for looking up configuration for a plugin, to make sure you follow
3146 existing L<Catalyst> standards for where a plugin should put its configuration.
3151 my ($class, $component_name) = @_;
3152 my $component_suffix = Catalyst::Utils::class2classsuffix($component_name);
3153 my $config = $class->config->{ $component_suffix } || {};
3158 =head2 $c->setup_dispatcher
3164 sub setup_dispatcher {
3165 my ( $class, $dispatcher ) = @_;
3168 $dispatcher = 'Catalyst::Dispatcher::' . $dispatcher;
3171 if ( my $env = Catalyst::Utils::env_value( $class, 'DISPATCHER' ) ) {
3172 $dispatcher = 'Catalyst::Dispatcher::' . $env;
3175 unless ($dispatcher) {
3176 $dispatcher = $class->dispatcher_class;
3179 load_class($dispatcher);
3181 # dispatcher instance
3182 $class->dispatcher( $dispatcher->new );
3185 =head2 $c->setup_engine
3192 my ($class, $requested_engine) = @_;
3194 if (!$class->engine_loader || $requested_engine) {
3195 $class->engine_loader(
3196 Catalyst::EngineLoader->new({
3197 application_name => $class,
3198 (defined $requested_engine
3199 ? (catalyst_engine_class => $requested_engine) : ()),
3204 $class->engine_loader->catalyst_engine_class;
3208 my ($class, $requested_engine) = @_;
3211 my $loader = $class->engine_loader;
3213 if (!$loader || $requested_engine) {
3214 $loader = Catalyst::EngineLoader->new({
3215 application_name => $class,
3216 (defined $requested_engine
3217 ? (requested_engine => $requested_engine) : ()),
3220 $class->engine_loader($loader);
3223 $loader->catalyst_engine_class;
3226 # Don't really setup_engine -- see _setup_psgi_app for explanation.
3227 return if $class->loading_psgi_file;
3229 load_class($engine);
3231 if ($ENV{MOD_PERL}) {
3232 my $apache = $class->engine_loader->auto;
3234 my $meta = find_meta($class);
3235 my $was_immutable = $meta->is_immutable;
3236 my %immutable_options = $meta->immutable_options;
3237 $meta->make_mutable if $was_immutable;
3239 $meta->add_method(handler => sub {
3241 my $psgi_app = $class->_finalized_psgi_app;
3242 $apache->call_app($r, $psgi_app);
3245 $meta->make_immutable(%immutable_options) if $was_immutable;
3248 $class->engine( $engine->new );
3253 ## This exists just to supply a prebuild psgi app for mod_perl and for the
3254 ## build in server support (back compat support for pre psgi port behavior).
3255 ## This is so that we don't build a new psgi app for each request when using
3256 ## the mod_perl handler or the built in servers (http and fcgi, etc).
3258 sub _finalized_psgi_app {
3261 unless ($app->_psgi_app) {
3262 my $psgi_app = $app->_setup_psgi_app;
3263 $app->_psgi_app($psgi_app);
3266 return $app->_psgi_app;
3269 ## Look for a psgi file like 'myapp_web.psgi' (if the app is MyApp::Web) in the
3270 ## home directory and load that and return it (just assume it is doing the
3271 ## right thing :) ). If that does not exist, call $app->psgi_app, wrap that
3272 ## in default_middleware and return it ( this is for backward compatibility
3273 ## with pre psgi port behavior ).
3275 sub _setup_psgi_app {
3278 for my $home (Path::Class::Dir->new($app->config->{home})) {
3279 my $psgi_file = $home->file(
3280 Catalyst::Utils::appprefix($app) . '.psgi',
3283 next unless -e $psgi_file;
3285 # If $psgi_file calls ->setup_engine, it's doing so to load
3286 # Catalyst::Engine::PSGI. But if it does that, we're only going to
3287 # throw away the loaded PSGI-app and load the 5.9 Catalyst::Engine
3288 # anyway. So set a flag (ick) that tells setup_engine not to populate
3289 # $c->engine or do any other things we might regret.
3291 $app->loading_psgi_file(1);
3292 my $psgi_app = Plack::Util::load_psgi($psgi_file);
3293 $app->loading_psgi_file(0);
3296 unless $app->engine_loader->needs_psgi_engine_compat_hack;
3299 Found a legacy Catalyst::Engine::PSGI .psgi file at ${psgi_file}.
3301 Its content has been ignored. Please consult the Catalyst::Upgrading
3302 documentation on how to upgrade from Catalyst::Engine::PSGI.
3306 return $app->apply_default_middlewares($app->psgi_app);
3309 =head2 $c->apply_default_middlewares
3311 Adds the following L<Plack> middlewares to your application, since they are
3312 useful and commonly needed:
3314 L<Plack::Middleware::LighttpdScriptNameFix> (if you are using Lighttpd),
3315 L<Plack::Middleware::IIS6ScriptNameFix> (always applied since this middleware
3316 is smart enough to conditionally apply itself).
3318 We will also automatically add L<Plack::Middleware::ReverseProxy> if we notice
3319 that your HTTP $env variable C<REMOTE_ADDR> is '127.0.0.1'. This is usually
3320 an indication that your server is running behind a proxy frontend. However in
3321 2014 this is often not the case. We preserve this code for backwards compatibility
3322 however I B<highly> recommend that if you are running the server behind a front
3323 end proxy that you clearly indicate so with the C<using_frontend_proxy> configuration
3324 setting to true for your environment configurations that run behind a proxy. This
3325 way if you change your front end proxy address someday your code would inexplicably
3326 stop working as expected.
3328 Additionally if we detect we are using Nginx, we add a bit of custom middleware
3329 to solve some problems with the way that server handles $ENV{PATH_INFO} and
3332 Please B<NOTE> that if you do use C<using_frontend_proxy> the middleware is now
3333 adding via C<registered_middleware> rather than this method.
3335 If you are using Lighttpd or IIS6 you may wish to apply these middlewares. In
3336 general this is no longer a common case but we have this here for backward
3342 sub apply_default_middlewares {
3343 my ($app, $psgi_app) = @_;
3345 # Don't add this conditional IF we are explicitly saying we want the
3346 # frontend proxy support. We don't need it here since if that is the
3347 # case it will be always loaded in the default_middleware.
3349 unless($app->config->{using_frontend_proxy}) {
3350 $psgi_app = Plack::Middleware::Conditional->wrap(
3352 builder => sub { Plack::Middleware::ReverseProxy->wrap($_[0]) },
3355 return if $app->config->{ignore_frontend_proxy};
3356 return $env->{REMOTE_ADDR} eq '127.0.0.1';
3361 # If we're running under Lighttpd, swap PATH_INFO and SCRIPT_NAME
3362 # http://lists.scsys.co.uk/pipermail/catalyst/2006-June/008361.html
3363 $psgi_app = Plack::Middleware::Conditional->wrap(
3365 builder => sub { Plack::Middleware::LighttpdScriptNameFix->wrap($_[0]) },
3368 return unless $env->{SERVER_SOFTWARE} && $env->{SERVER_SOFTWARE} =~ m!lighttpd[-/]1\.(\d+\.\d+)!;
3369 return unless $1 < 4.23;
3374 # we're applying this unconditionally as the middleware itself already makes
3375 # sure it doesn't fuck things up if it's not running under one of the right
3377 $psgi_app = Plack::Middleware::IIS6ScriptNameFix->wrap($psgi_app);
3379 # And another IIS issue, this time with IIS7.
3380 $psgi_app = Plack::Middleware::Conditional->wrap(
3382 builder => sub { Plack::Middleware::IIS7KeepAliveFix->wrap($_[0]) },
3385 return $env->{SERVER_SOFTWARE} && $env->{SERVER_SOFTWARE} =~ m!IIS/7\.[0-9]!;
3392 =head2 App->psgi_app
3396 Returns a PSGI application code reference for the catalyst application
3397 C<$c>. This is the bare application created without the C<apply_default_middlewares>
3398 method called. We do however apply C<registered_middleware> since those are
3399 integral to how L<Catalyst> functions. Also, unlike starting your application
3400 with a generated server script (via L<Catalyst::Devel> and C<catalyst.pl>) we do
3401 not attempt to return a valid L<PSGI> application using any existing C<${myapp}.psgi>
3402 scripts in your $HOME directory.
3404 B<NOTE> C<apply_default_middlewares> was originally created when the first PSGI
3405 port was done for v5.90000. These are middlewares that are added to achieve
3406 backward compatibility with older applications. If you start your application
3407 using one of the supplied server scripts (generated with L<Catalyst::Devel> and
3408 the project skeleton script C<catalyst.pl>) we apply C<apply_default_middlewares>
3409 automatically. This was done so that pre and post PSGI port applications would
3412 This is what you want to be using to retrieve the PSGI application code
3413 reference of your Catalyst application for use in a custom F<.psgi> or in your
3414 own created server modules.
3418 *to_app = \&psgi_app;
3422 my $psgi = $app->engine->build_psgi_app($app);
3423 return $app->Catalyst::Utils::apply_registered_middleware($psgi);
3426 =head2 $c->setup_home
3428 Sets up the home directory.
3433 my ( $class, $home ) = @_;
3435 if ( my $env = Catalyst::Utils::env_value( $class, 'HOME' ) ) {
3439 $home ||= Catalyst::Utils::home($class);
3442 #I remember recently being scolded for assigning config values like this
3443 $class->config->{home} ||= $home;
3444 $class->config->{root} ||= Path::Class::Dir->new($home)->subdir('root');
3448 =head2 $c->setup_encoding
3450 Sets up the input/output encoding. See L<ENCODING>
3454 sub setup_encoding {
3456 if( exists($c->config->{encoding}) && !defined($c->config->{encoding}) ) {
3457 # Ok, so the user has explicitly said "I don't want encoding..."
3460 my $enc = defined($c->config->{encoding}) ?
3461 delete $c->config->{encoding} : 'UTF-8'; # not sure why we delete it... (JNAP)
3466 =head2 handle_unicode_encoding_exception
3468 Hook to let you customize how encoding errors are handled. By default
3469 we just throw an exception. Receives a hashref of debug information.
3472 $c->handle_unicode_encoding_exception({
3473 param_value => $value,
3475 encoding_step => 'params',
3480 sub handle_unicode_encoding_exception {
3481 my ( $self, $exception_ctx ) = @_;
3482 die $exception_ctx->{error_msg};
3485 # Some unicode helpers cargo culted from the old plugin. These could likely
3488 sub _handle_unicode_decoding {
3489 my ( $self, $value ) = @_;
3491 return unless defined $value;
3493 ## I think this mess is to support the old nested
3494 if ( ref $value eq 'ARRAY' ) {
3495 foreach ( @$value ) {
3496 $_ = $self->_handle_unicode_decoding($_);
3500 elsif ( ref $value eq 'HASH' ) {
3501 foreach (keys %$value) {
3502 my $encoded_key = $self->_handle_param_unicode_decoding($_);
3503 $value->{$encoded_key} = $self->_handle_unicode_decoding($value->{$_});
3505 # If the key was encoded we now have two (the original and current so
3506 # delete the original.
3507 delete $value->{$_} if $_ ne $encoded_key;
3512 return $self->_handle_param_unicode_decoding($value);
3516 sub _handle_param_unicode_decoding {
3517 my ( $self, $value ) = @_;
3518 return unless defined $value; # not in love with just ignoring undefs - jnap
3519 return $value if blessed($value); #don't decode when the value is an object.
3521 my $enc = $self->encoding;
3523 $enc->decode( $value, $self->_encode_check );
3526 $self->handle_unicode_encoding_exception({
3527 param_value => $value,
3529 encoding_step => 'params',
3534 =head2 $c->setup_log
3536 Sets up log by instantiating a L<Catalyst::Log|Catalyst::Log> object and
3537 passing it to C<log()>. Pass in a comma-delimited list of levels to set the
3540 This method also installs a C<debug> method that returns a true value into the
3541 catalyst subclass if the "debug" level is passed in the comma-delimited list,
3542 or if the C<$CATALYST_DEBUG> environment variable is set to a true value.
3544 Note that if the log has already been setup, by either a previous call to
3545 C<setup_log> or by a call such as C<< __PACKAGE__->log( MyLogger->new ) >>,
3546 that this method won't actually set up the log object.
3551 my ( $class, $levels ) = @_;
3554 $levels =~ s/^\s+//;
3555 $levels =~ s/\s+$//;
3556 my %levels = map { $_ => 1 } split /\s*,\s*/, $levels;
3558 my $env_debug = Catalyst::Utils::env_value( $class, 'DEBUG' );
3559 if ( defined $env_debug ) {
3560 $levels{debug} = 1 if $env_debug; # Ugly!
3561 delete($levels{debug}) unless $env_debug;
3564 unless ( $class->log ) {
3565 $class->log( Catalyst::Log->new(keys %levels) );
3568 if ( $levels{debug} ) {
3569 Class::MOP::get_metaclass_by_name($class)->add_method('debug' => sub { 1 });
3570 $class->log->debug('Debug messages enabled');
3574 =head2 $c->setup_plugins
3580 =head2 $c->setup_stats
3582 Sets up timing statistics class.
3587 my ( $class, $stats ) = @_;
3589 Catalyst::Utils::ensure_class_loaded($class->stats_class);
3591 my $env = Catalyst::Utils::env_value( $class, 'STATS' );
3592 if ( defined($env) ? $env : ($stats || $class->debug ) ) {
3593 Class::MOP::get_metaclass_by_name($class)->add_method('use_stats' => sub { 1 });
3594 $class->log->debug('Statistics enabled');
3599 =head2 $c->registered_plugins
3601 Returns a sorted list of the plugins which have either been stated in the
3604 If passed a given plugin name, it will report a boolean value indicating
3605 whether or not that plugin is loaded. A fully qualified name is required if
3606 the plugin name does not begin with C<Catalyst::Plugin::>.
3608 if ($c->registered_plugins('Some::Plugin')) {
3616 sub registered_plugins {
3618 return sort keys %{ $proto->_plugins } unless @_;
3620 return 1 if exists $proto->_plugins->{$plugin};
3621 return exists $proto->_plugins->{"Catalyst::Plugin::$plugin"};
3624 sub _register_plugin {
3625 my ( $proto, $plugin, $instant ) = @_;
3626 my $class = ref $proto || $proto;
3628 load_class( $plugin );
3629 $class->log->warn( "$plugin inherits from 'Catalyst::Component' - this is deprecated and will not work in 5.81" )
3630 if $plugin->isa( 'Catalyst::Component' );
3631 my $plugin_meta = Moose::Meta::Class->create($plugin);
3632 if (!$plugin_meta->has_method('new')
3633 && ( $plugin->isa('Class::Accessor::Fast') || $plugin->isa('Class::Accessor') ) ) {
3634 $plugin_meta->add_method('new', Moose::Object->meta->get_method('new'))
3636 if (!$instant && !$proto->_plugins->{$plugin}) {
3637 my $meta = Class::MOP::get_metaclass_by_name($class);
3638 $meta->superclasses($plugin, $meta->superclasses);
3640 $proto->_plugins->{$plugin} = 1;
3644 sub _default_plugins { return qw() }
3647 my ( $class, $plugins ) = @_;
3649 $class->_plugins( {} ) unless $class->_plugins;
3651 m/Unicode::Encoding/ ? do {
3653 'Unicode::Encoding plugin is auto-applied,'
3654 . ' please remove this from your appclass'
3655 . ' and make sure to define "encoding" config'
3657 unless (exists $class->config->{'encoding'}) {
3658 $class->config->{'encoding'} = 'UTF-8';
3663 push @$plugins, $class->_default_plugins;
3664 $plugins = Data::OptList::mkopt($plugins || []);
3667 [ Catalyst::Utils::resolve_namespace(
3668 $class . '::Plugin',
3669 'Catalyst::Plugin', $_->[0]
3675 for my $plugin ( reverse @plugins ) {
3676 load_class($plugin->[0], $plugin->[1]);
3677 my $meta = find_meta($plugin->[0]);
3678 next if $meta && $meta->isa('Moose::Meta::Role');
3680 $class->_register_plugin($plugin->[0]);
3684 map { $_->[0]->name, $_->[1] }
3685 grep { blessed($_->[0]) && $_->[0]->isa('Moose::Meta::Role') }
3686 map { [find_meta($_->[0]), $_->[1]] }
3689 Moose::Util::apply_all_roles(
3695 =head2 default_middleware
3697 Returns a list of instantiated PSGI middleware objects which is the default
3698 middleware that is active for this application (taking any configuration
3699 options into account, excluding your custom added middleware via the C<psgi_middleware>
3700 configuration option). You can override this method if you wish to change
3701 the default middleware (although do so at risk since some middleware is vital
3702 to application function.)
3704 The current default middleware list is:
3706 Catalyst::Middleware::Stash
3707 Plack::Middleware::HTTPExceptions
3708 Plack::Middleware::RemoveRedundantBody
3709 Plack::Middleware::FixMissingBodyInRedirect
3710 Plack::Middleware::ContentLength
3711 Plack::Middleware::MethodOverride
3712 Plack::Middleware::Head
3714 If the configuration setting C<using_frontend_proxy> is true we add:
3716 Plack::Middleware::ReverseProxy
3718 If the configuration setting C<using_frontend_proxy_path> is true we add:
3720 Plack::Middleware::ReverseProxyPath
3722 But B<NOTE> that L<Plack::Middleware::ReverseProxyPath> is not a dependency of the
3723 L<Catalyst> distribution so if you want to use this option you should add it to
3724 your project distribution file.
3726 These middlewares will be added at L</setup_middleware> during the
3727 L</setup> phase of application startup.
3731 sub default_middleware {
3734 Catalyst::Middleware::Stash->new,
3735 Plack::Middleware::HTTPExceptions->new,
3736 Plack::Middleware::RemoveRedundantBody->new,
3737 Plack::Middleware::FixMissingBodyInRedirect->new,
3738 Plack::Middleware::ContentLength->new,
3739 Plack::Middleware::MethodOverride->new,
3740 Plack::Middleware::Head->new);
3742 if($class->config->{using_frontend_proxy}) {
3743 push @mw, Plack::Middleware::ReverseProxy->new;
3746 if($class->config->{using_frontend_proxy_path}) {
3747 if(Class::Load::try_load_class('Plack::Middleware::ReverseProxyPath')) {
3748 push @mw, Plack::Middleware::ReverseProxyPath->new;
3750 $class->log->error("Cannot use configuration 'using_frontend_proxy_path' because 'Plack::Middleware::ReverseProxyPath' is not installed");
3757 =head2 registered_middlewares
3759 Read only accessor that returns an array of all the middleware in the order
3760 that they were added (which is the REVERSE of the order they will be applied).
3762 The values returned will be either instances of L<Plack::Middleware> or of a
3763 compatible interface, or a coderef, which is assumed to be inlined middleware
3765 =head2 setup_middleware (?@middleware)
3767 Read configuration information stored in configuration key C<psgi_middleware> or
3770 See under L</CONFIGURATION> information regarding C<psgi_middleware> and how
3771 to use it to enable L<Plack::Middleware>
3773 This method is automatically called during 'setup' of your application, so
3774 you really don't need to invoke it. However you may do so if you find the idea
3775 of loading middleware via configuration weird :). For example:
3781 __PACKAGE__->setup_middleware('Head');
3784 When we read middleware definitions from configuration, we reverse the list
3785 which sounds odd but is likely how you expect it to work if you have prior
3786 experience with L<Plack::Builder> or if you previously used the plugin
3787 L<Catalyst::Plugin::EnableMiddleware> (which is now considered deprecated)
3789 So basically your middleware handles an incoming request from the first
3790 registered middleware, down and handles the response from the last middleware
3795 sub registered_middlewares {
3797 if(my $middleware = $class->_psgi_middleware) {
3798 my @mw = ($class->default_middleware, @$middleware);
3800 if($class->config->{using_frontend_proxy}) {
3801 push @mw, Plack::Middleware::ReverseProxy->new;
3806 die "You cannot call ->registered_middlewares until middleware has been setup";
3810 sub setup_middleware {
3812 my @middleware_definitions;
3814 # If someone calls this method you can add middleware with args. However if its
3815 # called without an arg we need to setup the configuration middleware.
3817 @middleware_definitions = reverse(@_);
3819 @middleware_definitions = reverse(@{$class->config->{'psgi_middleware'}||[]})
3820 unless $class->finalized_default_middleware;
3821 $class->finalized_default_middleware(1); # Only do this once, just in case some people call setup over and over...
3824 my @middleware = ();
3825 while(my $next = shift(@middleware_definitions)) {
3827 if(Scalar::Util::blessed $next && $next->can('wrap')) {
3828 push @middleware, $next;
3829 } elsif(ref $next eq 'CODE') {
3830 push @middleware, $next;
3831 } elsif(ref $next eq 'HASH') {
3832 my $namespace = shift @middleware_definitions;
3833 my $mw = $class->Catalyst::Utils::build_middleware($namespace, %$next);
3834 push @middleware, $mw;
3836 die "I can't handle middleware definition ${\ref $next}";
3839 my $mw = $class->Catalyst::Utils::build_middleware($next);
3840 push @middleware, $mw;
3844 my @existing = @{$class->_psgi_middleware || []};
3845 $class->_psgi_middleware([@middleware,@existing,]);
3848 =head2 registered_data_handlers
3850 A read only copy of registered Data Handlers returned as a Hash, where each key
3851 is a content type and each value is a subref that attempts to decode that content
3854 =head2 setup_data_handlers (?@data_handler)
3856 Read configuration information stored in configuration key C<data_handlers> or
3859 See under L</CONFIGURATION> information regarding C<data_handlers>.
3861 This method is automatically called during 'setup' of your application, so
3862 you really don't need to invoke it.
3864 =head2 default_data_handlers
3866 Default Data Handlers that come bundled with L<Catalyst>. Currently there are
3867 only two default data handlers, for 'application/json' and an alternative to
3868 'application/x-www-form-urlencoded' which supposed nested form parameters via
3869 L<CGI::Struct> or via L<CGI::Struct::XS> IF you've installed it.
3871 The 'application/json' data handler is used to parse incoming JSON into a Perl
3872 data structure. It used either L<JSON::MaybeXS> or L<JSON>, depending on which
3873 is installed. This allows you to fail back to L<JSON:PP>, which is a Pure Perl
3874 JSON decoder, and has the smallest dependency impact.
3876 Because we don't wish to add more dependencies to L<Catalyst>, if you wish to
3877 use this new feature we recommend installing L<JSON> or L<JSON::MaybeXS> in
3878 order to get the best performance. You should add either to your dependency
3879 list (Makefile.PL, dist.ini, cpanfile, etc.)
3883 sub registered_data_handlers {
3885 if(my $data_handlers = $class->_data_handlers) {
3886 return %$data_handlers;
3888 $class->setup_data_handlers;
3889 return $class->registered_data_handlers;
3893 sub setup_data_handlers {
3894 my ($class, %data_handler_callbacks) = @_;
3895 %data_handler_callbacks = (
3896 %{$class->default_data_handlers},
3897 %{$class->config->{'data_handlers'}||+{}},
3898 %data_handler_callbacks);
3900 $class->_data_handlers(\%data_handler_callbacks);
3903 sub default_data_handlers {
3906 'application/x-www-form-urlencoded' => sub {
3907 my ($fh, $req) = @_;
3908 my $params = $req->_use_hash_multivalue ? $req->body_parameters->mixed : $req->body_parameters;
3909 Class::Load::load_first_existing_class('CGI::Struct::XS', 'CGI::Struct')
3910 ->can('build_cgi_struct')->($params);
3912 'application/json' => sub {
3913 my ($fh, $req) = @_;
3914 my $parser = Class::Load::load_first_existing_class('JSON::MaybeXS', 'JSON');
3918 $slurped = $fh->getline;
3919 $parser->can("decode_json")->($slurped); # decode_json does utf8 decoding for us
3920 } || Catalyst::Exception->throw(sprintf "Error Parsing POST '%s', Error: %s", (defined($slurped) ? $slurped : 'undef') ,$@);
3925 sub _handle_http_exception {
3926 my ( $self, $error ) = @_;
3928 !$self->config->{always_catch_http_exceptions}
3931 $error->can('as_psgi')
3932 || ( $error->can('code')
3933 && $error->code =~ m/^[1-5][0-9][0-9]$/ )
3943 Returns an arrayref of the internal execution stack (actions that are
3944 currently executing).
3948 Returns the current timing statistics object. By default Catalyst uses
3949 L<Catalyst::Stats|Catalyst::Stats>, but can be set otherwise with
3950 L<< stats_class|/"$c->stats_class" >>.
3952 Even if L<< -Stats|/"-Stats" >> is not enabled, the stats object is still
3953 available. By enabling it with C< $c->stats->enabled(1) >, it can be used to
3954 profile explicitly, although MyApp.pm still won't profile nor output anything
3957 =head2 $c->stats_class
3959 Returns or sets the stats (timing statistics) class. L<Catalyst::Stats|Catalyst::Stats> is used by default.
3961 =head2 $app->stats_class_traits
3963 A arrayref of L<Moose::Role>s that are applied to the stats_class before creating it.
3965 =head2 $app->composed_stats_class
3967 this is the stats_class composed with any 'stats_class_traits'. You can
3968 name the full namespace of the role, or a namespace suffix, which will then
3969 be tried against the following standard namespace prefixes.
3971 $MyApp::TraitFor::Stats::$trait_suffix
3972 Catalyst::TraitFor::Stats::$trait_suffix
3974 So for example if you set:
3976 MyApp->stats_class_traits(['Foo']);
3978 We try each possible role in turn (and throw an error if none load)
3981 MyApp::TraitFor::Stats::Foo
3982 Catalyst::TraitFor::Stats::Foo
3984 The namespace part 'TraitFor::Stats' was choosen to assist in backwards
3985 compatibility with L<CatalystX::RoleApplicator> which previously provided
3986 these features in a stand alone package.
3988 =head2 $c->use_stats
3990 Returns 1 when L<< stats collection|/"-Stats" >> is enabled.
3992 Note that this is a static method, not an accessor and should be overridden
3993 by declaring C<sub use_stats { 1 }> in your MyApp.pm, not by calling C<< $c->use_stats(1) >>.
4000 =head2 $c->write( $data )
4002 Writes $data to the output stream. When using this method directly, you
4003 will need to manually set the C<Content-Length> header to the length of
4004 your output data, if known.
4011 # Finalize headers if someone manually writes output (for compat)
4012 $c->finalize_headers;
4014 return $c->response->write( @_ );
4019 Returns the Catalyst version number. Mostly useful for "powered by"
4020 messages in template systems.
4024 sub version { return $Catalyst::VERSION }
4026 =head1 CONFIGURATION
4028 There are a number of 'base' config variables which can be set:
4034 C<always_catch_http_exceptions> - As of version 5.90060 Catalyst
4035 rethrows errors conforming to the interface described by
4036 L<Plack::Middleware::HTTPExceptions> and lets the middleware deal with it.
4037 Set true to get the deprecated behaviour and have Catalyst catch HTTP exceptions.
4041 C<default_model> - The default model picked if you say C<< $c->model >>. See L<< /$c->model($name) >>.
4045 C<default_view> - The default view to be rendered or returned when C<< $c->view >> is called. See L<< /$c->view($name) >>.
4049 C<disable_component_resolution_regex_fallback> - Turns
4050 off the deprecated component resolution functionality so
4051 that if any of the component methods (e.g. C<< $c->controller('Foo') >>)
4052 are called then regex search will not be attempted on string values and
4053 instead C<undef> will be returned.
4057 C<home> - The application home directory. In an uninstalled application,
4058 this is the top level application directory. In an installed application,
4059 this will be the directory containing C<< MyApp.pm >>.
4063 C<ignore_frontend_proxy> - See L</PROXY SUPPORT>
4067 C<name> - The name of the application in debug messages and the debug and
4072 C<parse_on_demand> - The request body (for example file uploads) will not be parsed
4073 until it is accessed. This allows you to (for example) check authentication (and reject
4074 the upload) before actually receiving all the data. See L</ON-DEMAND PARSER>
4078 C<root> - The root directory for templates. Usually this is just a
4079 subdirectory of the home directory, but you can set it to change the
4080 templates to a different directory.
4084 C<search_extra> - Array reference passed to Module::Pluggable to for additional
4085 namespaces from which components will be loaded (and constructed and stored in
4086 C<< $c->components >>).
4090 C<show_internal_actions> - If true, causes internal actions such as C<< _DISPATCH >>
4091 to be shown in hit debug tables in the test server.
4095 C<use_request_uri_for_path> - Controls if the C<REQUEST_URI> or C<PATH_INFO> environment
4096 variable should be used for determining the request path.
4098 Most web server environments pass the requested path to the application using environment variables,
4099 from which Catalyst has to reconstruct the request base (i.e. the top level path to / in the application,
4100 exposed as C<< $c->request->base >>) and the request path below that base.
4102 There are two methods of doing this, both of which have advantages and disadvantages. Which method is used
4103 is determined by the C<< $c->config(use_request_uri_for_path) >> setting (which can either be true or false).
4107 =item use_request_uri_for_path => 0
4109 This is the default (and the) traditional method that Catalyst has used for determining the path information.
4110 The path is generated from a combination of the C<PATH_INFO> and C<SCRIPT_NAME> environment variables.
4111 The allows the application to behave correctly when C<mod_rewrite> is being used to redirect requests
4112 into the application, as these variables are adjusted by mod_rewrite to take account for the redirect.
4114 However this method has the major disadvantage that it is impossible to correctly decode some elements
4115 of the path, as RFC 3875 says: "C<< Unlike a URI path, the PATH_INFO is not URL-encoded, and cannot
4116 contain path-segment parameters. >>" This means PATH_INFO is B<always> decoded, and therefore Catalyst
4117 can't distinguish / vs %2F in paths (in addition to other encoded values).
4119 =item use_request_uri_for_path => 1
4121 This method uses the C<REQUEST_URI> and C<SCRIPT_NAME> environment variables. As C<REQUEST_URI> is never
4122 decoded, this means that applications using this mode can correctly handle URIs including the %2F character
4123 (i.e. with C<AllowEncodedSlashes> set to C<On> in Apache).
4125 Given that this method of path resolution is provably more correct, it is recommended that you use
4126 this unless you have a specific need to deploy your application in a non-standard environment, and you are
4127 aware of the implications of not being able to handle encoded URI paths correctly.
4129 However it also means that in a number of cases when the app isn't installed directly at a path, but instead
4130 is having paths rewritten into it (e.g. as a .cgi/fcgi in a public_html directory, with mod_rewrite in a
4131 .htaccess file, or when SSI is used to rewrite pages into the app, or when sub-paths of the app are exposed
4132 at other URIs than that which the app is 'normally' based at with C<mod_rewrite>), the resolution of
4133 C<< $c->request->base >> will be incorrect.
4139 C<using_frontend_proxy> - See L</PROXY SUPPORT>.
4143 C<using_frontend_proxy_path> - Enabled L<Plack::Middleware::ReverseProxyPath> on your application (if
4144 installed, otherwise log an error). This is useful if your application is not running on the
4145 'root' (or /) of your host server. B<NOTE> if you use this feature you should add the required
4146 middleware to your project dependency list since its not automatically a dependency of L<Catalyst>.
4147 This has been done since not all people need this feature and we wish to restrict the growth of
4148 L<Catalyst> dependencies.
4152 C<encoding> - See L</ENCODING>
4154 This now defaults to 'UTF-8'. You my turn it off by setting this configuration
4159 C<abort_chain_on_error_fix>
4161 When there is an error in an action chain, the default behavior is to continue
4162 processing the remaining actions and then catch the error upon chain end. This
4163 can lead to running actions when the application is in an unexpected state. If
4164 you have this issue, setting this config value to true will promptly exit a
4165 chain when there is an error raised in any action (thus terminating the chain
4170 __PACKAGE__->config(abort_chain_on_error_fix => 1);
4172 In the future this might become the default behavior.
4176 C<use_hash_multivalue_in_request>
4178 In L<Catalyst::Request> the methods C<query_parameters>, C<body_parametes>
4179 and C<parameters> return a hashref where values might be scalar or an arrayref
4180 depending on the incoming data. In many cases this can be undesirable as it
4181 leads one to writing defensive code like the following:
4183 my ($val) = ref($c->req->parameters->{a}) ?
4184 @{$c->req->parameters->{a}} :
4185 $c->req->parameters->{a};
4187 Setting this configuration item to true will make L<Catalyst> populate the
4188 attributes underlying these methods with an instance of L<Hash::MultiValue>
4189 which is used by L<Plack::Request> and others to solve this very issue. You
4190 may prefer this behavior to the default, if so enable this option (be warned
4191 if you enable it in a legacy application we are not sure if it is completely
4192 backwardly compatible).
4196 C<skip_complex_post_part_handling>
4198 When creating body parameters from a POST, if we run into a multpart POST
4199 that does not contain uploads, but instead contains inlined complex data
4200 (very uncommon) we cannot reliably convert that into field => value pairs. So
4201 instead we create an instance of L<Catalyst::Request::PartData>. If this causes
4202 issue for you, you can disable this by setting C<skip_complex_post_part_handling>
4203 to true (default is false).
4207 C<skip_body_param_unicode_decoding>
4209 Generally we decode incoming POST params based on your declared encoding (the
4210 default for this is to decode UTF-8). If this is causing you trouble and you
4211 do not wish to turn all encoding support off (with the C<encoding> configuration
4212 parameter) you may disable this step atomically by setting this configuration
4217 C<do_not_decode_query>
4219 If true, then do not try to character decode any wide characters in your
4220 request URL query or keywords. Most readings of the relevent specifications
4221 suggest these should be UTF-* encoded, which is the default that L<Catalyst>
4222 will use, hwoever if you are creating a lot of URLs manually or have external
4223 evil clients, this might cause you trouble. If you find the changes introduced
4224 in Catalyst version 5.90080+ break some of your query code, you may disable
4225 the UTF-8 decoding globally using this configuration.
4227 This setting takes precedence over C<default_query_encoding> and
4228 C<decode_query_using_global_encoding>
4232 C<default_query_encoding>
4234 By default we decode query and keywords in your request URL using UTF-8, which
4235 is our reading of the relevent specifications. This setting allows one to
4236 specify a fixed value for how to decode your query. You might need this if
4237 you are doing a lot of custom encoding of your URLs and not using UTF-8.
4239 This setting take precedence over C<decode_query_using_global_encoding>.
4243 C<decode_query_using_global_encoding>
4245 Setting this to true will default your query decoding to whatever your
4246 general global encoding is (the default is UTF-8).
4250 C<use_chained_args_0_special_case>
4252 In older versions of Catalyst, when more than one action matched the same path
4253 AND all those matching actions declared Args(0), we'd break the tie by choosing
4254 the first action defined. We now normalized how Args(0) works so that it
4255 follows the same rule as Args(N), which is to say when we need to break a tie
4256 we choose the LAST action defined. If this breaks your code and you don't
4257 have time to update to follow the new normalized approach, you may set this
4258 value to true and it will globally revert to the original chaining behavior.
4262 C<psgi_middleware> - See L<PSGI MIDDLEWARE>.
4266 C<data_handlers> - See L<DATA HANDLERS>.
4270 C<stats_class_traits>
4272 An arrayref of L<Moose::Role>s that get componsed into your stats class.
4276 C<request_class_traits>
4278 An arrayref of L<Moose::Role>s that get componsed into your request class.
4282 C<response_class_traits>
4284 An arrayref of L<Moose::Role>s that get componsed into your response class.
4288 C<inject_components>
4290 A Hashref of L<Catalyst::Component> subclasses that are 'injected' into configuration.
4294 inject_components => {
4295 'Controller::Err' => { from_component => 'Local::Controller::Errors' },
4296 'Model::Zoo' => { from_component => 'Local::Model::Foo' },
4297 'Model::Foo' => { from_component => 'Local::Model::Foo', roles => ['TestRole'] },
4299 'Controller::Err' => { a => 100, b=>200, namespace=>'error' },
4300 'Model::Zoo' => { a => 2 },
4301 'Model::Foo' => { a => 100 },
4304 Generally L<Catalyst> looks for components in your Model/View or Controller directories.
4305 However for cases when you which to use an existing component and you don't need any
4306 customization (where for when you can apply a role to customize it) you may inject those
4307 components into your application. Please note any configuration should be done 'in the
4308 normal way', with a key under configuration named after the component affix, as in the
4311 Using this type of injection allows you to construct significant amounts of your application
4312 with only configuration!. This may or may not lead to increased code understanding.
4314 Please not you may also call the ->inject_components application method as well, although
4315 you must do so BEFORE setup.
4321 Generally when you throw an exception inside an Action (or somewhere in
4322 your stack, such as in a model that an Action is calling) that exception
4323 is caught by Catalyst and unless you either catch it yourself (via eval
4324 or something like L<Try::Tiny> or by reviewing the L</error> stack, it
4325 will eventually reach L</finalize_errors> and return either the debugging
4326 error stack page, or the default error page. However, if your exception
4327 can be caught by L<Plack::Middleware::HTTPExceptions>, L<Catalyst> will
4328 instead rethrow it so that it can be handled by that middleware (which
4329 is part of the default middleware). For example this would allow
4331 use HTTP::Throwable::Factory 'http_throw';
4333 sub throws_exception :Local {
4334 my ($self, $c) = @_;
4336 http_throw(SeeOther => { location =>
4337 $c->uri_for($self->action_for('redirect')) });
4341 =head1 INTERNAL ACTIONS
4343 Catalyst uses internal actions like C<_DISPATCH>, C<_BEGIN>, C<_AUTO>,
4344 C<_ACTION>, and C<_END>. These are by default not shown in the private
4345 action table, but you can make them visible with a config parameter.
4347 MyApp->config(show_internal_actions => 1);
4349 =head1 ON-DEMAND PARSER
4351 The request body is usually parsed at the beginning of a request,
4352 but if you want to handle input yourself, you can enable on-demand
4353 parsing with a config parameter.
4355 MyApp->config(parse_on_demand => 1);
4357 =head1 PROXY SUPPORT
4359 Many production servers operate using the common double-server approach,
4360 with a lightweight frontend web server passing requests to a larger
4361 backend server. An application running on the backend server must deal
4362 with two problems: the remote user always appears to be C<127.0.0.1> and
4363 the server's hostname will appear to be C<localhost> regardless of the
4364 virtual host that the user connected through.
4366 Catalyst will automatically detect this situation when you are running
4367 the frontend and backend servers on the same machine. The following
4368 changes are made to the request.
4370 $c->req->address is set to the user's real IP address, as read from
4371 the HTTP X-Forwarded-For header.
4373 The host value for $c->req->base and $c->req->uri is set to the real
4374 host, as read from the HTTP X-Forwarded-Host header.
4376 Additionally, you may be running your backend application on an insecure
4377 connection (port 80) while your frontend proxy is running under SSL. If there
4378 is a discrepancy in the ports, use the HTTP header C<X-Forwarded-Port> to
4379 tell Catalyst what port the frontend listens on. This will allow all URIs to
4380 be created properly.
4382 In the case of passing in:
4384 X-Forwarded-Port: 443
4386 All calls to C<uri_for> will result in an https link, as is expected.
4388 Obviously, your web server must support these headers for this to work.
4390 In a more complex server farm environment where you may have your
4391 frontend proxy server(s) on different machines, you will need to set a
4392 configuration option to tell Catalyst to read the proxied data from the
4395 MyApp->config(using_frontend_proxy => 1);
4397 If you do not wish to use the proxy support at all, you may set:
4399 MyApp->config(ignore_frontend_proxy => 0);
4401 =head2 Note about psgi files
4403 Note that if you supply your own .psgi file, calling
4404 C<< MyApp->psgi_app(@_); >>, then B<this will not happen automatically>.
4406 You either need to apply L<Plack::Middleware::ReverseProxy> yourself
4407 in your psgi, for example:
4410 enable "Plack::Middleware::ReverseProxy";
4414 This will unconditionally add the ReverseProxy support, or you need to call
4415 C<< $app = MyApp->apply_default_middlewares($app) >> (to conditionally
4416 apply the support depending upon your config).
4418 See L<Catalyst::PSGI> for more information.
4420 =head1 THREAD SAFETY
4422 Catalyst has been tested under Apache 2's threading C<mpm_worker>,
4423 C<mpm_winnt>, and the standalone forking HTTP server on Windows. We
4424 believe the Catalyst core to be thread-safe.
4426 If you plan to operate in a threaded environment, remember that all other
4427 modules you are using must also be thread-safe. Some modules, most notably
4428 L<DBD::SQLite>, are not thread-safe.
4430 =head1 DATA HANDLERS
4432 The L<Catalyst::Request> object uses L<HTTP::Body> to populate 'classic' HTML
4433 form parameters and URL search query fields. However it has become common
4434 for various alternative content types to be PUT or POSTed to your controllers
4435 and actions. People working on RESTful APIs, or using AJAX often use JSON,
4436 XML and other content types when communicating with an application server. In
4437 order to better support this use case, L<Catalyst> defines a global configuration
4438 option, C<data_handlers>, which lets you associate a content type with a coderef
4439 that parses that content type into something Perl can readily access.
4446 __PACKAGE__->config(
4448 'application/json' => sub { local $/; decode_json $_->getline },
4450 ## Any other configuration.
4455 By default L<Catalyst> comes with a generic JSON data handler similar to the
4456 example given above, which uses L<JSON::Maybe> to provide either L<JSON::PP>
4457 (a pure Perl, dependency free JSON parser) or L<Cpanel::JSON::XS> if you have
4458 it installed (if you want the faster XS parser, add it to you project Makefile.PL
4459 or dist.ini, cpanfile, etc.)
4461 The C<data_handlers> configuration is a hashref whose keys are HTTP Content-Types
4462 (matched against the incoming request type using a regexp such as to be case
4463 insensitive) and whose values are coderefs that receive a localized version of
4464 C<$_> which is a filehandle object pointing to received body.
4466 This feature is considered an early access release and we reserve the right
4467 to alter the interface in order to provide a performant and secure solution to
4468 alternative request body content. Your reports welcomed!
4470 =head1 PSGI MIDDLEWARE
4472 You can define middleware, defined as L<Plack::Middleware> or a compatible
4473 interface in configuration. Your middleware definitions are in the form of an
4474 arrayref under the configuration key C<psgi_middleware>. Here's an example
4475 with details to follow:
4480 use Plack::Middleware::StackTrace;
4482 my $stacktrace_middleware = Plack::Middleware::StackTrace->new;
4484 __PACKAGE__->config(
4485 'psgi_middleware', [
4488 $stacktrace_middleware,
4489 'Session' => {store => 'File'},
4494 $env->{myapp.customkey} = 'helloworld';
4503 So the general form is:
4505 __PACKAGE__->config(psgi_middleware => \@middleware_definitions);
4507 Where C<@middleware> is one or more of the following, applied in the REVERSE of
4508 the order listed (to make it function similarly to L<Plack::Builder>:
4510 Alternatively, you may also define middleware by calling the L</setup_middleware>
4517 __PACKAGE__->setup_middleware( \@middleware_definitions);
4520 In the case where you do both (use 'setup_middleware' and configuration) the
4521 package call to setup_middleware will be applied earlier (in other words its
4522 middleware will wrap closer to the application). Keep this in mind since in
4523 some cases the order of middleware is important.
4525 The two approaches are not exclusive.
4529 =item Middleware Object
4531 An already initialized object that conforms to the L<Plack::Middleware>
4534 my $stacktrace_middleware = Plack::Middleware::StackTrace->new;
4536 __PACKAGE__->config(
4537 'psgi_middleware', [
4538 $stacktrace_middleware,
4544 A coderef that is an inlined middleware:
4546 __PACKAGE__->config(
4547 'psgi_middleware', [
4552 if($env->{PATH_INFO} =~m/forced/) {
4554 ->new(file=>TestApp->path_to(qw/share static forced.txt/))
4557 return $app->($env);
4567 We assume the scalar refers to a namespace after normalizing it using the
4570 (1) If the scalar is prefixed with a "+" (as in C<+MyApp::Foo>) then the full string
4571 is assumed to be 'as is', and we just install and use the middleware.
4573 (2) If the scalar begins with "Plack::Middleware" or your application namespace
4574 (the package name of your Catalyst application subclass), we also assume then
4575 that it is a full namespace, and use it.
4577 (3) Lastly, we then assume that the scalar is a partial namespace, and attempt to
4578 resolve it first by looking for it under your application namespace (for example
4579 if you application is "MyApp::Web" and the scalar is "MyMiddleware", we'd look
4580 under "MyApp::Web::Middleware::MyMiddleware") and if we don't find it there, we
4581 will then look under the regular L<Plack::Middleware> namespace (i.e. for the
4582 previous we'd try "Plack::Middleware::MyMiddleware"). We look under your application
4583 namespace first to let you 'override' common L<Plack::Middleware> locally, should
4584 you find that a good idea.
4590 __PACKAGE__->config(
4591 'psgi_middleware', [
4592 'Debug', ## MyAppWeb::Middleware::Debug->wrap or Plack::Middleware::Debug->wrap
4593 'Plack::Middleware::Stacktrace', ## Plack::Middleware::Stacktrace->wrap
4594 '+MyApp::Custom', ## MyApp::Custom->wrap
4598 =item a scalar followed by a hashref
4600 Just like the previous, except the following C<HashRef> is used as arguments
4601 to initialize the middleware object.
4603 __PACKAGE__->config(
4604 'psgi_middleware', [
4605 'Session' => {store => 'File'},
4610 Please see L<PSGI> for more on middleware.
4614 Starting in L<Catalyst> version 5.90080 encoding is automatically enabled
4615 and set to encode all body responses to UTF8 when possible and applicable.
4616 Following is documentation on this process. If you are using an older
4617 version of L<Catalyst> you should review documentation for that version since
4620 By default encoding is now 'UTF-8'. You may turn it off by setting
4621 the encoding configuration to undef.
4623 MyApp->config(encoding => undef);
4625 This is recommended for temporary backwards compatibility only.
4627 Encoding is automatically applied when the content-type is set to
4628 a type that can be encoded. Currently we encode when the content type
4629 matches the following regular expression:
4631 $content_type =~ /^text|xml$|javascript$/
4633 Encoding is set on the application, but it is copied to the context object
4634 so that you can override it on a request basis.
4636 Be default we don't automatically encode 'application/json' since the most
4637 common approaches to generating this type of response (Either via L<Catalyst::View::JSON>
4638 or L<Catalyst::Action::REST>) will do so already and we want to avoid double
4641 If you are producing JSON response in an unconventional manner (such
4642 as via a template or manual strings) you should perform the UTF8 encoding
4643 manually as well such as to conform to the JSON specification.
4645 NOTE: We also examine the value of $c->response->content_encoding. If
4646 you set this (like for example 'gzip', and manually gzipping the body)
4647 we assume that you have done all the necessary encoding yourself, since
4648 we cannot encode the gzipped contents. If you use a plugin like
4649 L<Catalyst::Plugin::Compress> you need to update to a modern version in order
4650 to have this function correctly with the new UTF8 encoding code, or you
4651 can use L<Plack::Middleware::Deflater> or (probably best) do your compression on
4660 Returns an instance of an C<Encode> encoding
4662 print $c->encoding->name
4664 =item handle_unicode_encoding_exception ($exception_context)
4666 Method called when decoding process for a request fails.
4668 An C<$exception_context> hashref is provided to allow you to override the
4669 behaviour of your application when given data with incorrect encodings.
4671 The default method throws exceptions in the case of invalid request parameters
4672 (resulting in a 500 error), but ignores errors in upload filenames.
4674 The keys passed in the C<$exception_context> hash are:
4680 The value which was not able to be decoded.
4684 The exception received from L<Encode>.
4688 What type of data was being decoded. Valid values are (currently)
4689 C<params> - for request parameters / arguments / captures
4690 and C<uploads> - for request upload filenames.
4700 Join #catalyst on irc.perl.org.
4704 http://lists.scsys.co.uk/cgi-bin/mailman/listinfo/catalyst
4705 http://lists.scsys.co.uk/cgi-bin/mailman/listinfo/catalyst-dev
4709 http://catalyst.perl.org
4713 http://dev.catalyst.perl.org
4717 =head2 L<Task::Catalyst> - All you need to start with Catalyst
4719 =head2 L<Catalyst::Manual> - The Catalyst Manual
4721 =head2 L<Catalyst::Component>, L<Catalyst::Controller> - Base classes for components
4723 =head2 L<Catalyst::Engine> - Core engine
4725 =head2 L<Catalyst::Log> - Log class.
4727 =head2 L<Catalyst::Request> - Request object
4729 =head2 L<Catalyst::Response> - Response object
4731 =head2 L<Catalyst::Test> - The test suite.
4733 =head1 PROJECT FOUNDER
4735 sri: Sebastian Riedel <sri@cpan.org>
4741 acme: Leon Brocard <leon@astray.com>
4743 abraxxa: Alexander Hartmaier <abraxxa@cpan.org>
4745 andrewalker: André Walker <andre@cpan.org>
4749 Andrew Ford E<lt>A.Ford@ford-mason.co.ukE<gt>
4753 andyg: Andy Grundman <andy@hybridized.org>
4755 audreyt: Audrey Tang
4757 bricas: Brian Cassidy <bricas@cpan.org>
4759 Caelum: Rafael Kitover <rkitover@io.com>
4761 chansen: Christian Hansen
4763 chicks: Christopher Hicks
4765 Chisel Wright C<pause@herlpacker.co.uk>
4767 Danijel Milicevic C<me@danijel.de>
4769 davewood: David Schmidt <davewood@cpan.org>
4771 David Kamholz E<lt>dkamholz@cpan.orgE<gt>
4773 David Naughton, C<naughton@umn.edu>
4777 dhoss: Devin Austin <dhoss@cpan.org>
4779 dkubb: Dan Kubb <dan.kubb-cpan@onautopilot.com>
4783 dwc: Daniel Westermann-Clark <danieltwc@cpan.org>
4785 esskar: Sascha Kiefer
4787 fireartist: Carl Franks <cfranks@cpan.org>
4789 frew: Arthur Axel "fREW" Schmidt <frioux@gmail.com>
4791 gabb: Danijel Milicevic
4795 Gavin Henry C<ghenry@perl.me.uk>
4799 groditi: Guillermo Roditi <groditi@gmail.com>
4801 hobbs: Andrew Rodland <andrew@cleverdomain.org>
4803 ilmari: Dagfinn Ilmari Mannsåker <ilmari@ilmari.org>
4805 jcamacho: Juan Camacho
4807 jester: Jesse Sheidlower C<jester@panix.com>
4809 jhannah: Jay Hannah <jay@jays.net>
4815 jon: Jon Schutz <jjschutz@cpan.org>
4817 Jonathan Rockway C<< <jrockway@cpan.org> >>
4819 Kieren Diment C<kd@totaldatasolution.com>
4821 konobi: Scott McWhirter <konobi@cpan.org>
4823 marcus: Marcus Ramberg <mramberg@cpan.org>
4825 miyagawa: Tatsuhiko Miyagawa <miyagawa@bulknews.net>
4827 mgrimes: Mark Grimes <mgrimes@cpan.org>
4829 mst: Matt S. Trout <mst@shadowcatsystems.co.uk>
4833 naughton: David Naughton
4835 ningu: David Kamholz <dkamholz@cpan.org>
4837 nothingmuch: Yuval Kogman <nothingmuch@woobling.org>
4839 numa: Dan Sully <daniel@cpan.org>
4845 omega: Andreas Marienborg
4847 Oleg Kostyuk <cub.uanic@gmail.com>
4849 phaylon: Robert Sedlacek <phaylon@dunkelheit.at>
4851 rafl: Florian Ragwitz <rafl@debian.org>
4853 random: Roland Lammel <lammel@cpan.org>
4855 Robert Sedlacek C<< <rs@474.at> >>
4857 SpiceMan: Marcel Montes
4861 szbalint: Balint Szilakszi <szbalint@cpan.org>
4863 t0m: Tomas Doran <bobtfish@bobtfish.net>
4867 vanstyn: Henry Van Styn <vanstyn@cpan.org>
4869 Viljo Marrandi C<vilts@yahoo.com>
4871 Will Hawes C<info@whawes.co.uk>
4873 willert: Sebastian Willert <willert@cpan.org>
4875 wreis: Wallace Reis <wreis@cpan.org>
4877 Yuval Kogman, C<nothingmuch@woobling.org>
4879 rainboxx: Matthias Dietrich, C<perl@rainboxx.de>
4881 dd070: Dhaval Dhanani <dhaval070@gmail.com>
4883 Upasana <me@upasana.me>
4885 John Napiorkowski (jnap) <jjnapiork@cpan.org>
4889 Copyright (c) 2005-2015, the above named PROJECT FOUNDER and CONTRIBUTORS.
4893 This library is free software. You can redistribute it and/or modify it under
4894 the same terms as Perl itself.
4900 __PACKAGE__->meta->make_immutable;