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';
56 BEGIN { require 5.008003; }
58 has stack => (is => 'ro', default => sub { [] });
59 has state => (is => 'rw', default => 0);
60 has stats => (is => 'rw');
61 has action => (is => 'rw');
62 has counter => (is => 'rw', default => sub { {} });
67 my $class = ref $self;
68 my $composed_request_class = $class->composed_request_class;
69 return $composed_request_class->new( $self->_build_request_constructor_args);
73 sub _build_request_constructor_args {
75 my %p = ( _log => $self->log );
76 $p{_uploadtmp} = $self->_uploadtmp if $self->_has_uploadtmp;
77 $p{data_handlers} = {$self->registered_data_handlers};
78 $p{_use_hash_multivalue} = $self->config->{use_hash_multivalue_in_request}
79 if $self->config->{use_hash_multivalue_in_request};
83 sub composed_request_class {
85 return $class->_composed_request_class if $class->_composed_request_class;
87 my @traits = (@{$class->request_class_traits||[]}, @{$class->config->{request_class_traits}||[]});
89 # For each trait listed, figure out what the namespace is. First we try the $trait
90 # as it is in the config. Then try $MyApp::TraitFor::Request:$trait. Last we try
91 # Catalyst::TraitFor::Request::$trait. If none load, throw error.
93 my $trait_ns = 'TraitFor::Request';
94 my @normalized_traits = map {
95 Class::Load::load_first_existing_class($_, $class.'::'.$trait_ns.'::'. $_, 'Catalyst::'.$trait_ns.'::'.$_)
98 if ($class->debug && scalar(@normalized_traits)) {
99 my $column_width = Catalyst::Utils::term_width() - 6;
100 my $t = Text::SimpleTable->new($column_width);
101 $t->row($_) for @normalized_traits;
102 $class->log->debug( "Composed Request Class Traits:\n" . $t->draw . "\n" );
105 return $class->_composed_request_class(Moose::Util::with_traits($class->request_class, @normalized_traits));
112 my $class = ref $self;
113 my $composed_response_class = $class->composed_response_class;
114 return $composed_response_class->new( $self->_build_response_constructor_args);
118 sub _build_response_constructor_args {
121 encoding => $_[0]->encoding,
125 sub composed_response_class {
127 return $class->_composed_response_class if $class->_composed_response_class;
129 my @traits = (@{$class->response_class_traits||[]}, @{$class->config->{response_class_traits}||[]});
131 my $trait_ns = 'TraitFor::Response';
132 my @normalized_traits = map {
133 Class::Load::load_first_existing_class($_, $class.'::'.$trait_ns.'::'. $_, 'Catalyst::'.$trait_ns.'::'.$_)
136 if ($class->debug && scalar(@normalized_traits)) {
137 my $column_width = Catalyst::Utils::term_width() - 6;
138 my $t = Text::SimpleTable->new($column_width);
139 $t->row($_) for @normalized_traits;
140 $class->log->debug( "Composed Response Class Traits:\n" . $t->draw . "\n" );
143 return $class->_composed_response_class(Moose::Util::with_traits($class->response_class, @normalized_traits));
146 has namespace => (is => 'rw');
148 sub depth { scalar @{ shift->stack || [] }; }
149 sub comp { shift->component(@_) }
152 my $self = shift; return $self->request(@_);
155 my $self = shift; return $self->response(@_);
158 # For backwards compatibility
159 sub finalize_output { shift->finalize_body(@_) };
164 our $RECURSION = 1000;
165 our $DETACH = Catalyst::Exception::Detach->new;
166 our $GO = Catalyst::Exception::Go->new;
168 #I imagine that very few of these really
169 #need to be class variables. if any.
170 #maybe we should just make them attributes with a default?
171 __PACKAGE__->mk_classdata($_)
172 for qw/components arguments dispatcher engine log dispatcher_class
173 engine_loader context_class request_class response_class stats_class
174 setup_finished _psgi_app loading_psgi_file run_options _psgi_middleware
175 _data_handlers _encoding _encode_check finalized_default_middleware
176 request_class_traits response_class_traits stats_class_traits
177 _composed_request_class _composed_response_class _composed_stats_class/;
179 __PACKAGE__->dispatcher_class('Catalyst::Dispatcher');
180 __PACKAGE__->request_class('Catalyst::Request');
181 __PACKAGE__->response_class('Catalyst::Response');
182 __PACKAGE__->stats_class('Catalyst::Stats');
184 sub composed_stats_class {
186 return $class->_composed_stats_class if $class->_composed_stats_class;
188 my @traits = (@{$class->stats_class_traits||[]}, @{$class->config->{stats_class_traits}||[]});
190 my $trait_ns = 'TraitFor::Stats';
191 my @normalized_traits = map {
192 Class::Load::load_first_existing_class($_, $class.'::'.$trait_ns.'::'. $_, 'Catalyst::'.$trait_ns.'::'.$_)
195 if ($class->debug && scalar(@normalized_traits)) {
196 my $column_width = Catalyst::Utils::term_width() - 6;
197 my $t = Text::SimpleTable->new($column_width);
198 $t->row($_) for @normalized_traits;
199 $class->log->debug( "Composed Stats Class Traits:\n" . $t->draw . "\n" );
202 return $class->_composed_stats_class(Moose::Util::with_traits($class->stats_class, @normalized_traits));
205 __PACKAGE__->_encode_check(Encode::FB_CROAK | Encode::LEAVE_SRC);
207 # Remember to update this in Catalyst::Runtime as well!
208 our $VERSION = '5.90114';
209 $VERSION = eval $VERSION if $VERSION =~ /_/; # numify for warning-free dev releases
212 my ( $class, @arguments ) = @_;
214 # We have to limit $class to Catalyst to avoid pushing Catalyst upon every
216 return unless $class eq 'Catalyst';
218 my $caller = caller();
219 return if $caller eq 'main';
221 my $meta = Moose::Meta::Class->initialize($caller);
222 unless ( $caller->isa('Catalyst') ) {
223 my @superclasses = ($meta->superclasses, $class, 'Catalyst::Controller');
224 $meta->superclasses(@superclasses);
226 # Avoid possible C3 issues if 'Moose::Object' is already on RHS of MyApp
227 $meta->superclasses(grep { $_ ne 'Moose::Object' } $meta->superclasses);
229 unless( $meta->has_method('meta') ){
230 if ($Moose::VERSION >= 1.15) {
231 $meta->_add_meta_method('meta');
234 $meta->add_method(meta => sub { Moose::Meta::Class->initialize("${caller}") } );
238 $caller->arguments( [@arguments] );
242 sub _application { $_[0] }
248 Catalyst - The Elegant MVC Web Application Framework
252 See the L<Catalyst::Manual> distribution for comprehensive
253 documentation and tutorials.
255 # Install Catalyst::Devel for helpers and other development tools
256 # use the helper to create a new application
259 # add models, views, controllers
260 script/myapp_create.pl model MyDatabase DBIC::Schema create=static dbi:SQLite:/path/to/db
261 script/myapp_create.pl view MyTemplate TT
262 script/myapp_create.pl controller Search
264 # built in testserver -- use -r to restart automatically on changes
265 # --help to see all available options
266 script/myapp_server.pl
268 # command line testing interface
269 script/myapp_test.pl /yada
272 use Catalyst qw/-Debug/; # include plugins here as well
274 ### In lib/MyApp/Controller/Root.pm (autocreated)
275 sub foo : Chained('/') Args() { # called for /foo, /foo/1, /foo/1/2, etc.
276 my ( $self, $c, @args ) = @_; # args are qw/1 2/ for /foo/1/2
277 $c->stash->{template} = 'foo.tt'; # set the template
278 # lookup something from db -- stash vars are passed to TT
280 $c->model('Database::Foo')->search( { country => $args[0] } );
281 if ( $c->req->params->{bar} ) { # access GET or POST parameters
282 $c->forward( 'bar' ); # process another action
283 # do something else after forward returns
287 # The foo.tt TT template can use the stash data from the database
288 [% WHILE (item = data.next) %]
292 # called for /bar/of/soap, /bar/of/soap/10, etc.
293 sub bar : Chained('/') PathPart('/bar/of/soap') Args() { ... }
295 # called after all actions are finished
297 my ( $self, $c ) = @_;
298 if ( scalar @{ $c->error } ) { ... } # handle errors
299 return if $c->res->body; # already have a response
300 $c->forward( 'MyApp::View::TT' ); # render template
303 See L<Catalyst::Manual::Intro> for additional information.
307 Catalyst is a modern framework for making web applications without the
308 pain usually associated with this process. This document is a reference
309 to the main Catalyst application. If you are a new user, we suggest you
310 start with L<Catalyst::Manual::Tutorial> or L<Catalyst::Manual::Intro>.
312 See L<Catalyst::Manual> for more documentation.
314 Catalyst plugins can be loaded by naming them as arguments to the "use
315 Catalyst" statement. Omit the C<Catalyst::Plugin::> prefix from the
316 plugin name, i.e., C<Catalyst::Plugin::My::Module> becomes
319 use Catalyst qw/My::Module/;
321 If your plugin starts with a name other than C<Catalyst::Plugin::>, you can
322 fully qualify the name by using a unary plus:
326 +Fully::Qualified::Plugin::Name
329 Special flags like C<-Debug> can also be specified as
330 arguments when Catalyst is loaded:
332 use Catalyst qw/-Debug My::Module/;
334 The position of plugins and flags in the chain is important, because
335 they are loaded in the order in which they appear.
337 The following flags are supported:
341 Enables debug output. You can also force this setting from the system
342 environment with CATALYST_DEBUG or <MYAPP>_DEBUG. The environment
343 settings override the application, with <MYAPP>_DEBUG having the highest
346 This sets the log level to 'debug' and enables full debug output on the
347 error screen. If you only want the latter, see L<< $c->debug >>.
351 Forces Catalyst to use a specific home directory, e.g.:
353 use Catalyst qw[-Home=/usr/mst];
355 This can also be done in the shell environment by setting either the
356 C<CATALYST_HOME> environment variable or C<MYAPP_HOME>; where C<MYAPP>
357 is replaced with the uppercased name of your application, any "::" in
358 the name will be replaced with underscores, e.g. MyApp::Web should use
359 MYAPP_WEB_HOME. If both variables are set, the MYAPP_HOME one will be used.
361 If none of these are set, Catalyst will attempt to automatically detect the
362 home directory. If you are working in a development environment, Catalyst
363 will try and find the directory containing either Makefile.PL, Build.PL,
364 dist.ini, or cpanfile. If the application has been installed into the system
365 (i.e. you have done C<make install>), then Catalyst will use the path to your
366 application module, without the .pm extension (e.g., /foo/MyApp if your
367 application was installed at /foo/MyApp.pm)
371 use Catalyst '-Log=warn,fatal,error';
373 Specifies a comma-delimited list of log levels.
377 Enables statistics collection and reporting.
379 use Catalyst qw/-Stats=1/;
381 You can also force this setting from the system environment with CATALYST_STATS
382 or <MYAPP>_STATS. The environment settings override the application, with
383 <MYAPP>_STATS having the highest priority.
385 Stats are also enabled if L<< debugging |/"-Debug" >> is enabled.
389 =head2 INFORMATION ABOUT THE CURRENT REQUEST
393 Returns a L<Catalyst::Action> object for the current action, which
394 stringifies to the action name. See L<Catalyst::Action>.
398 Returns the namespace of the current action, i.e., the URI prefix
399 corresponding to the controller of the current action. For example:
401 # in Controller::Foo::Bar
402 $c->namespace; # returns 'foo/bar';
408 Returns the current L<Catalyst::Request> object, giving access to
409 information about the current client request (including parameters,
410 cookies, HTTP headers, etc.). See L<Catalyst::Request>.
412 =head2 REQUEST FLOW HANDLING
414 =head2 $c->forward( $action [, \@arguments ] )
416 =head2 $c->forward( $class, $method, [, \@arguments ] )
418 This is one way of calling another action (method) in the same or
419 a different controller. You can also use C<< $self->my_method($c, @args) >>
420 in the same controller or C<< $c->controller('MyController')->my_method($c, @args) >>
421 in a different controller.
422 The main difference is that 'forward' uses some of the Catalyst request
423 cycle overhead, including debugging, which may be useful to you. On the
424 other hand, there are some complications to using 'forward', restrictions
425 on values returned from 'forward', and it may not handle errors as you prefer.
426 Whether you use 'forward' or not is up to you; it is not considered superior to
427 the other ways to call a method.
429 'forward' calls another action, by its private name. If you give a
430 class name but no method, C<process()> is called. You may also optionally
431 pass arguments in an arrayref. The action will receive the arguments in
432 C<@_> and C<< $c->req->args >>. Upon returning from the function,
433 C<< $c->req->args >> will be restored to the previous values.
435 Any data C<return>ed from the action forwarded to, will be returned by the
438 my $foodata = $c->forward('/foo');
439 $c->forward('index');
440 $c->forward(qw/Model::DBIC::Foo do_stuff/);
441 $c->forward('View::TT');
443 Note that L<< forward|/"$c->forward( $action [, \@arguments ] )" >> implies
444 an C<< eval { } >> around the call (actually
445 L<< execute|/"$c->execute( $class, $coderef )" >> does), thus rendering all
446 exceptions thrown by the called action non-fatal and pushing them onto
447 $c->error instead. If you want C<die> to propagate you need to do something
451 die join "\n", @{ $c->error } if @{ $c->error };
453 Or make sure to always return true values from your actions and write
456 $c->forward('foo') || return;
458 Another note is that C<< $c->forward >> always returns a scalar because it
459 actually returns $c->state which operates in a scalar context.
460 Thus, something like:
464 in an action that is forwarded to is going to return a scalar,
465 i.e. how many items are in that array, which is probably not what you want.
466 If you need to return an array then return a reference to it,
469 $c->stash->{array} = \@array;
471 and access it from the stash.
473 Keep in mind that the C<end> method used is that of the caller action. So a C<< $c->detach >> inside a forwarded action would run the C<end> method from the original action requested.
477 sub forward { my $c = shift; no warnings 'recursion'; $c->dispatcher->forward( $c, @_ ) }
479 =head2 $c->detach( $action [, \@arguments ] )
481 =head2 $c->detach( $class, $method, [, \@arguments ] )
485 The same as L<< forward|/"$c->forward( $action [, \@arguments ] )" >>, but
486 doesn't return to the previous action when processing is finished.
488 When called with no arguments it escapes the processing chain entirely.
492 sub detach { my $c = shift; $c->dispatcher->detach( $c, @_ ) }
494 =head2 $c->visit( $action [, \@arguments ] )
496 =head2 $c->visit( $action [, \@captures, \@arguments ] )
498 =head2 $c->visit( $class, $method, [, \@arguments ] )
500 =head2 $c->visit( $class, $method, [, \@captures, \@arguments ] )
502 Almost the same as L<< forward|/"$c->forward( $action [, \@arguments ] )" >>,
503 but does a full dispatch, instead of just calling the new C<$action> /
504 C<< $class->$method >>. This means that C<begin>, C<auto> and the method
505 you go to are called, just like a new request.
507 In addition both C<< $c->action >> and C<< $c->namespace >> are localized.
508 This means, for example, that C<< $c->action >> methods such as
509 L<name|Catalyst::Action/name>, L<class|Catalyst::Action/class> and
510 L<reverse|Catalyst::Action/reverse> return information for the visited action
511 when they are invoked within the visited action. This is different from the
512 behavior of L<< forward|/"$c->forward( $action [, \@arguments ] )" >>, which
513 continues to use the $c->action object from the caller action even when
514 invoked from the called action.
516 C<< $c->stash >> is kept unchanged.
518 In effect, L<< visit|/"$c->visit( $action [, \@captures, \@arguments ] )" >>
519 allows you to "wrap" another action, just as it would have been called by
520 dispatching from a URL, while the analogous
521 L<< go|/"$c->go( $action [, \@captures, \@arguments ] )" >> allows you to
522 transfer control to another action as if it had been reached directly from a URL.
526 sub visit { my $c = shift; $c->dispatcher->visit( $c, @_ ) }
528 =head2 $c->go( $action [, \@arguments ] )
530 =head2 $c->go( $action [, \@captures, \@arguments ] )
532 =head2 $c->go( $class, $method, [, \@arguments ] )
534 =head2 $c->go( $class, $method, [, \@captures, \@arguments ] )
536 The relationship between C<go> and
537 L<< visit|/"$c->visit( $action [, \@captures, \@arguments ] )" >> is the same as
538 the relationship between
539 L<< forward|/"$c->forward( $class, $method, [, \@arguments ] )" >> and
540 L<< detach|/"$c->detach( $action [, \@arguments ] )" >>. Like C<< $c->visit >>,
541 C<< $c->go >> will perform a full dispatch on the specified action or method,
542 with localized C<< $c->action >> and C<< $c->namespace >>. Like C<detach>,
543 C<go> escapes the processing of the current request chain on completion, and
544 does not return to its caller.
546 @arguments are arguments to the final destination of $action. @captures are
547 arguments to the intermediate steps, if any, on the way to the final sub of
552 sub go { my $c = shift; $c->dispatcher->go( $c, @_ ) }
558 Returns the current L<Catalyst::Response> object, see there for details.
562 Returns a hashref to the stash, which may be used to store data and pass
563 it between components during a request. You can also set hash keys by
564 passing arguments. The stash is automatically sent to the view. The
565 stash is cleared at the end of a request; it cannot be used for
566 persistent storage (for this you must use a session; see
567 L<Catalyst::Plugin::Session> for a complete system integrated with
570 $c->stash->{foo} = $bar;
571 $c->stash( { moose => 'majestic', qux => 0 } );
572 $c->stash( bar => 1, gorch => 2 ); # equivalent to passing a hashref
574 # stash is automatically passed to the view for use in a template
575 $c->forward( 'MyApp::View::TT' );
577 The stash hash is currently stored in the PSGI C<$env> and is managed by
578 L<Catalyst::Middleware::Stash>. Since it's part of the C<$env> items in
579 the stash can be accessed in sub applications mounted under your main
580 L<Catalyst> application. For example if you delegate the response of an
581 action to another L<Catalyst> application, that sub application will have
582 access to all the stash keys of the main one, and if can of course add
583 more keys of its own. However those new keys will not 'bubble' back up
584 to the main application.
586 For more information the best thing to do is to review the test case:
587 t/middleware-stash.t in the distribution /t directory.
593 $c->log->error("You are requesting the stash but you don't have a context") unless blessed $c;
594 return Catalyst::Middleware::Stash::get_stash($c->req->env)->(@_);
599 =head2 $c->error($error, ...)
601 =head2 $c->error($arrayref)
603 Returns an arrayref containing error messages. If Catalyst encounters an
604 error while processing a request, it stores the error in $c->error. This
605 method should only be used to store fatal error messages.
607 my @error = @{ $c->error };
611 $c->error('Something bad happened');
613 Calling this will always return an arrayref (if there are no errors it
614 will be an empty arrayref.
621 my $error = ref $_[0] eq 'ARRAY' ? $_[0] : [@_];
622 croak @$error unless ref $c;
623 push @{ $c->{error} }, @$error;
625 elsif ( defined $_[0] ) { $c->{error} = undef }
626 return $c->{error} || [];
631 Contains the return value of the last executed action.
632 Note that << $c->state >> operates in a scalar context which means that all
633 values it returns are scalar.
635 Please note that if an action throws an exception, the value of state
636 should no longer be considered the return if the last action. It is generally
637 going to be 0, which indicates an error state. Examine $c->error for error
640 =head2 $c->clear_errors
642 Clear errors. You probably don't want to clear the errors unless you are
643 implementing a custom error screen.
645 This is equivalent to running
656 =head2 $c->has_errors
658 Returns true if you have errors
662 sub has_errors { scalar(@{shift->error}) ? 1:0 }
664 =head2 $c->last_error
666 Returns the most recent error in the stack (the one most recently added...)
667 or nothing if there are no errors. This does not modify the contents of the
673 my (@errs) = @{shift->error};
674 return scalar(@errs) ? $errs[-1]: undef;
679 shifts the most recently added error off the error stack and returns it. Returns
680 nothing if there are no more errors.
686 my @errors = @{$self->error};
687 my $err = shift(@errors);
688 $self->{error} = \@errors;
694 pops the most recently added error off the error stack and returns it. Returns
695 nothing if there are no more errors.
701 my @errors = @{$self->error};
702 my $err = pop(@errors);
703 $self->{error} = \@errors;
707 sub _comp_search_prefixes {
709 return map $c->components->{ $_ }, $c->_comp_names_search_prefixes(@_);
712 # search components given a name and some prefixes
713 sub _comp_names_search_prefixes {
714 my ( $c, $name, @prefixes ) = @_;
715 my $appclass = ref $c || $c;
716 my $filter = "^${appclass}::(" . join( '|', @prefixes ) . ')::';
717 $filter = qr/$filter/; # Compile regex now rather than once per loop
719 # map the original component name to the sub part that we will search against
720 my %eligible = map { my $n = $_; $n =~ s{^$appclass\::[^:]+::}{}; $_ => $n; }
721 grep { /$filter/ } keys %{ $c->components };
723 # undef for a name will return all
724 return keys %eligible if !defined $name;
726 my $query = $name->$_isa('Regexp') ? $name : qr/^$name$/i;
727 my @result = grep { $eligible{$_} =~ m{$query} } keys %eligible;
729 return @result if @result;
731 # if we were given a regexp to search against, we're done.
732 return if $name->$_isa('Regexp');
734 # skip regexp fallback if configured
736 if $appclass->config->{disable_component_resolution_regex_fallback};
740 @result = grep { $eligible{ $_ } =~ m{$query} } keys %eligible;
742 # no results? try against full names
744 @result = grep { m{$query} } keys %eligible;
747 # don't warn if we didn't find any results, it just might not exist
749 # Disgusting hack to work out correct method name
750 my $warn_for = lc $prefixes[0];
751 my $msg = "Used regexp fallback for \$c->${warn_for}('${name}'), which found '" .
752 (join '", "', @result) . "'. Relying on regexp fallback behavior for " .
753 "component resolution is unreliable and unsafe.";
754 my $short = $result[0];
755 # remove the component namespace prefix
756 $short =~ s/.*?(Model|Controller|View):://;
757 my $shortmess = Carp::shortmess('');
758 if ($shortmess =~ m#Catalyst/Plugin#) {
759 $msg .= " You probably need to set '$short' instead of '${name}' in this " .
761 } elsif ($shortmess =~ m#Catalyst/lib/(View|Controller)#) {
762 $msg .= " You probably need to set '$short' instead of '${name}' in this " .
763 "component's config";
765 $msg .= " You probably meant \$c->${warn_for}('$short') instead of \$c->${warn_for}('${name}'), " .
766 "but if you really wanted to search, pass in a regexp as the argument " .
767 "like so: \$c->${warn_for}(qr/${name}/)";
769 $c->log->warn( "${msg}$shortmess" );
775 # Find possible names for a prefix
777 my ( $c, @prefixes ) = @_;
778 my $appclass = ref $c || $c;
780 my $filter = "^${appclass}::(" . join( '|', @prefixes ) . ')::';
782 my @names = map { s{$filter}{}; $_; }
783 $c->_comp_names_search_prefixes( undef, @prefixes );
788 # Filter a component before returning by calling ACCEPT_CONTEXT if available
790 sub _filter_component {
791 my ( $c, $comp, @args ) = @_;
793 if(ref $comp eq 'CODE') {
797 if ( eval { $comp->can('ACCEPT_CONTEXT'); } ) {
798 return $comp->ACCEPT_CONTEXT( $c, @args );
801 $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;
806 =head2 COMPONENT ACCESSORS
808 =head2 $c->controller($name)
810 Gets a L<Catalyst::Controller> instance by name.
812 $c->controller('Foo')->do_stuff;
814 If the name is omitted, will return the controller for the dispatched
817 If you want to search for controllers, pass in a regexp as the argument.
819 # find all controllers that start with Foo
820 my @foo_controllers = $c->controller(qr{^Foo});
826 my ( $c, $name, @args ) = @_;
828 my $appclass = ref($c) || $c;
830 unless ( $name->$_isa('Regexp') ) { # Direct component hash lookup to avoid costly regexps
831 my $comps = $c->components;
832 my $check = $appclass."::Controller::".$name;
833 return $c->_filter_component( $comps->{$check}, @args ) if exists $comps->{$check};
834 foreach my $path (@{$appclass->config->{ setup_components }->{ search_extra }}) {
835 next unless $path =~ /.*::Controller/;
836 $check = $path."::".$name;
837 return $c->_filter_component( $comps->{$check}, @args ) if exists $comps->{$check};
840 my @result = $c->_comp_search_prefixes( $name, qw/Controller C/ );
841 return map { $c->_filter_component( $_, @args ) } @result if ref $name;
842 return $c->_filter_component( $result[ 0 ], @args );
845 return $c->component( $c->action->class );
848 =head2 $c->model($name)
850 Gets a L<Catalyst::Model> instance by name.
852 $c->model('Foo')->do_stuff;
854 Any extra arguments are directly passed to ACCEPT_CONTEXT, if the model
855 defines ACCEPT_CONTEXT. If it does not, the args are discarded.
857 If the name is omitted, it will look for
858 - a model object in $c->stash->{current_model_instance}, then
859 - a model name in $c->stash->{current_model}, then
860 - a config setting 'default_model', or
861 - check if there is only one model, and return it if that's the case.
863 If you want to search for models, pass in a regexp as the argument.
865 # find all models that start with Foo
866 my @foo_models = $c->model(qr{^Foo});
871 my ( $c, $name, @args ) = @_;
872 my $appclass = ref($c) || $c;
874 unless ( $name->$_isa('Regexp') ) { # Direct component hash lookup to avoid costly regexps
875 my $comps = $c->components;
876 my $check = $appclass."::Model::".$name;
877 return $c->_filter_component( $comps->{$check}, @args ) if exists $comps->{$check};
878 foreach my $path (@{$appclass->config->{ setup_components }->{ search_extra }}) {
879 next unless $path =~ /.*::Model/;
880 $check = $path."::".$name;
881 return $c->_filter_component( $comps->{$check}, @args ) if exists $comps->{$check};
884 my @result = $c->_comp_search_prefixes( $name, qw/Model M/ );
885 return map { $c->_filter_component( $_, @args ) } @result if ref $name;
886 return $c->_filter_component( $result[ 0 ], @args );
890 return $c->stash->{current_model_instance}
891 if $c->stash->{current_model_instance};
892 return $c->model( $c->stash->{current_model} )
893 if $c->stash->{current_model};
895 return $c->model( $appclass->config->{default_model} )
896 if $appclass->config->{default_model};
898 my( $comp, $rest ) = $c->_comp_search_prefixes( undef, qw/Model M/);
901 $c->log->warn( Carp::shortmess('Calling $c->model() will return a random model unless you specify one of:') );
902 $c->log->warn( '* $c->config(default_model => "the name of the default model to use")' );
903 $c->log->warn( '* $c->stash->{current_model} # the name of the model to use for this request' );
904 $c->log->warn( '* $c->stash->{current_model_instance} # the instance of the model to use for this request' );
905 $c->log->warn( 'NB: in version 5.81, the "random" behavior will not work at all.' );
908 return $c->_filter_component( $comp );
912 =head2 $c->view($name)
914 Gets a L<Catalyst::View> instance by name.
916 $c->view('Foo')->do_stuff;
918 Any extra arguments are directly passed to ACCEPT_CONTEXT.
920 If the name is omitted, it will look for
921 - a view object in $c->stash->{current_view_instance}, then
922 - a view name in $c->stash->{current_view}, then
923 - a config setting 'default_view', or
924 - check if there is only one view, and return it if that's the case.
926 If you want to search for views, pass in a regexp as the argument.
928 # find all views that start with Foo
929 my @foo_views = $c->view(qr{^Foo});
934 my ( $c, $name, @args ) = @_;
936 my $appclass = ref($c) || $c;
938 unless ( $name->$_isa('Regexp') ) { # Direct component hash lookup to avoid costly regexps
939 my $comps = $c->components;
940 my $check = $appclass."::View::".$name;
941 if( exists $comps->{$check} ) {
942 return $c->_filter_component( $comps->{$check}, @args );
945 $c->log->warn( "Attempted to use view '$check', but does not exist" );
947 foreach my $path (@{$appclass->config->{ setup_components }->{ search_extra }}) {
948 next unless $path =~ /.*::View/;
949 $check = $path."::".$name;
950 return $c->_filter_component( $comps->{$check}, @args ) if exists $comps->{$check};
953 my @result = $c->_comp_search_prefixes( $name, qw/View V/ );
954 return map { $c->_filter_component( $_, @args ) } @result if ref $name;
955 return $c->_filter_component( $result[ 0 ], @args );
959 return $c->stash->{current_view_instance}
960 if $c->stash->{current_view_instance};
961 return $c->view( $c->stash->{current_view} )
962 if $c->stash->{current_view};
964 return $c->view( $appclass->config->{default_view} )
965 if $appclass->config->{default_view};
967 my( $comp, $rest ) = $c->_comp_search_prefixes( undef, qw/View V/);
970 $c->log->warn( 'Calling $c->view() will return a random view unless you specify one of:' );
971 $c->log->warn( '* $c->config(default_view => "the name of the default view to use")' );
972 $c->log->warn( '* $c->stash->{current_view} # the name of the view to use for this request' );
973 $c->log->warn( '* $c->stash->{current_view_instance} # the instance of the view to use for this request' );
974 $c->log->warn( 'NB: in version 5.81, the "random" behavior will not work at all.' );
977 return $c->_filter_component( $comp );
980 =head2 $c->controllers
982 Returns the available names which can be passed to $c->controller
988 return $c->_comp_names(qw/Controller C/);
993 Returns the available names which can be passed to $c->model
999 return $c->_comp_names(qw/Model M/);
1005 Returns the available names which can be passed to $c->view
1011 return $c->_comp_names(qw/View V/);
1014 =head2 $c->comp($name)
1016 =head2 $c->component($name)
1018 Gets a component object by name. This method is not recommended,
1019 unless you want to get a specific component by full
1020 class. C<< $c->controller >>, C<< $c->model >>, and C<< $c->view >>
1021 should be used instead.
1023 If C<$name> is a regexp, a list of components matched against the full
1024 component name will be returned.
1026 If Catalyst can't find a component by name, it will fallback to regex
1027 matching by default. To disable this behaviour set
1028 disable_component_resolution_regex_fallback to a true value.
1030 __PACKAGE__->config( disable_component_resolution_regex_fallback => 1 );
1035 my ( $c, $name, @args ) = @_;
1038 my $comps = $c->components;
1041 # is it the exact name?
1042 return $c->_filter_component( $comps->{ $name }, @args )
1043 if exists $comps->{ $name };
1045 # perhaps we just omitted "MyApp"?
1046 my $composed = ( ref $c || $c ) . "::${name}";
1047 return $c->_filter_component( $comps->{ $composed }, @args )
1048 if exists $comps->{ $composed };
1050 # search all of the models, views and controllers
1051 my( $comp ) = $c->_comp_search_prefixes( $name, qw/Model M Controller C View V/ );
1052 return $c->_filter_component( $comp, @args ) if $comp;
1056 if $c->config->{disable_component_resolution_regex_fallback};
1058 # This is here so $c->comp( '::M::' ) works
1059 my $query = ref $name ? $name : qr{$name}i;
1061 my @result = grep { m{$query} } keys %{ $c->components };
1062 return map { $c->_filter_component( $_, @args ) } @result if ref $name;
1064 if( $result[ 0 ] ) {
1065 $c->log->warn( Carp::shortmess(qq(Found results for "${name}" using regexp fallback)) );
1066 $c->log->warn( 'Relying on the regexp fallback behavior for component resolution' );
1067 $c->log->warn( 'is unreliable and unsafe. You have been warned' );
1068 return $c->_filter_component( $result[ 0 ], @args );
1071 # I would expect to return an empty list here, but that breaks back-compat
1075 return sort keys %{ $c->components };
1078 =head2 CLASS DATA AND HELPER CLASSES
1082 Returns or takes a hashref containing the application's configuration.
1084 __PACKAGE__->config( { db => 'dsn:SQLite:foo.db' } );
1086 You can also use a C<YAML>, C<XML> or L<Config::General> config file
1087 like C<myapp.conf> in your applications home directory. See
1088 L<Catalyst::Plugin::ConfigLoader>.
1090 =head3 Cascading configuration
1092 The config method is present on all Catalyst components, and configuration
1093 will be merged when an application is started. Configuration loaded with
1094 L<Catalyst::Plugin::ConfigLoader> takes precedence over other configuration,
1095 followed by configuration in your top level C<MyApp> class. These two
1096 configurations are merged, and then configuration data whose hash key matches a
1097 component name is merged with configuration for that component.
1099 The configuration for a component is then passed to the C<new> method when a
1100 component is constructed.
1104 MyApp->config({ 'Model::Foo' => { bar => 'baz', overrides => 'me' } });
1105 MyApp::Model::Foo->config({ quux => 'frob', overrides => 'this' });
1107 will mean that C<MyApp::Model::Foo> receives the following data when
1110 MyApp::Model::Foo->new({
1116 It's common practice to use a Moose attribute
1117 on the receiving component to access the config value.
1119 package MyApp::Model::Foo;
1123 # this attr will receive 'baz' at construction time
1129 You can then get the value 'baz' by calling $c->model('Foo')->bar
1130 (or $self->bar inside code in the model).
1132 B<NOTE:> you MUST NOT call C<< $self->config >> or C<< __PACKAGE__->config >>
1133 as a way of reading config within your code, as this B<will not> give you the
1134 correctly merged config back. You B<MUST> take the config values supplied to
1135 the constructor and use those instead.
1139 around config => sub {
1143 croak('Setting config after setup has been run is not allowed.')
1144 if ( @_ and $c->setup_finished );
1151 Returns the logging object instance. Unless it is already set, Catalyst
1152 sets this up with a L<Catalyst::Log> object. To use your own log class,
1153 set the logger with the C<< __PACKAGE__->log >> method prior to calling
1154 C<< __PACKAGE__->setup >>.
1156 __PACKAGE__->log( MyLogger->new );
1161 $c->log->info( 'Now logging with my own logger!' );
1163 Your log class should implement the methods described in
1168 Returned True if there's a valid encoding
1170 =head2 clear_encoding
1172 Clears the encoding for the current context
1176 Sets or gets the application encoding. Setting encoding takes either an
1177 Encoding object or a string that we try to resolve via L<Encode::find_encoding>.
1179 You would expect to get the encoding object back if you attempt to set it. If
1180 there is a failure you will get undef returned and an error message in the log.
1184 sub has_encoding { shift->encoding ? 1:0 }
1186 sub clear_encoding {
1189 $c->encoding(undef);
1191 $c->log->error("You can't clear encoding on the application");
1201 # Don't let one change this once we are too far into the response
1202 if(blessed $c && $c->res->finalized_headers) {
1203 Carp::croak("You may not change the encoding once the headers are finalized");
1207 # Let it be set to undef
1208 if (my $wanted = shift) {
1209 $encoding = Encode::find_encoding($wanted)
1210 or Carp::croak( qq/Unknown encoding '$wanted'/ );
1211 binmode(STDERR, ':encoding(' . $encoding->name . ')');
1218 ? $c->{encoding} = $encoding
1219 : $c->_encoding($encoding);
1221 $encoding = ref $c && exists $c->{encoding}
1231 Returns 1 if debug mode is enabled, 0 otherwise.
1233 You can enable debug mode in several ways:
1237 =item By calling myapp_server.pl with the -d flag
1239 =item With the environment variables MYAPP_DEBUG, or CATALYST_DEBUG
1241 =item The -Debug option in your MyApp.pm
1243 =item By declaring C<sub debug { 1 }> in your MyApp.pm.
1247 The first three also set the log level to 'debug'.
1249 Calling C<< $c->debug(1) >> has no effect.
1255 =head2 $c->dispatcher
1257 Returns the dispatcher instance. See L<Catalyst::Dispatcher>.
1261 Returns the engine instance. See L<Catalyst::Engine>.
1264 =head2 UTILITY METHODS
1266 =head2 $c->path_to(@path)
1268 Merges C<@path> with C<< $c->config->{home} >> and returns a
1269 L<Path::Class::Dir> object. Note you can usually use this object as
1270 a filename, but sometimes you will have to explicitly stringify it
1271 yourself by calling the C<< ->stringify >> method.
1275 $c->path_to( 'db', 'sqlite.db' );
1280 my ( $c, @path ) = @_;
1281 my $path = Path::Class::Dir->new( $c->config->{home}, @path );
1282 if ( -d $path ) { return $path }
1283 else { return Path::Class::File->new( $c->config->{home}, @path ) }
1287 my ( $class, $name, $plugin, @args ) = @_;
1289 # See block comment in t/unit_core_plugin.t
1290 $class->log->warn(qq/Adding plugin using the ->plugin method is deprecated, and will be removed in a future release/);
1292 $class->_register_plugin( $plugin, 1 );
1294 eval { $plugin->import };
1295 $class->mk_classdata($name);
1297 eval { $obj = $plugin->new(@args) };
1300 Catalyst::Exception->throw( message =>
1301 qq/Couldn't instantiate instant plugin "$plugin", "$@"/ );
1304 $class->$name($obj);
1305 $class->log->debug(qq/Initialized instant plugin "$plugin" as "$name"/)
1311 Initializes the dispatcher and engine, loads any plugins, and loads the
1312 model, view, and controller components. You may also specify an array
1313 of plugins to load here, if you choose to not load them in the C<use
1317 MyApp->setup( qw/-Debug/ );
1319 B<Note:> You B<should not> wrap this method with method modifiers
1320 or bad things will happen - wrap the C<setup_finalize> method instead.
1322 B<Note:> You can create a custom setup stage that will execute when the
1323 application is starting. Use this to customize setup.
1325 MyApp->setup(-Custom=value);
1328 my ($class, $value) = @_;
1331 Can be handy if you want to hook into the setup phase.
1336 my ( $class, @arguments ) = @_;
1337 croak('Running setup more than once')
1338 if ( $class->setup_finished );
1340 unless ( $class->isa('Catalyst') ) {
1342 Catalyst::Exception->throw(
1343 message => qq/'$class' does not inherit from Catalyst/ );
1346 if ( $class->arguments ) {
1347 @arguments = ( @arguments, @{ $class->arguments } );
1353 foreach (@arguments) {
1357 ( $flags->{log} ) ? 'debug,' . $flags->{log} : 'debug';
1359 elsif (/^-(\w+)=?(.*)$/) {
1360 $flags->{ lc $1 } = $2;
1363 push @{ $flags->{plugins} }, $_;
1367 $class->setup_home( delete $flags->{home} );
1369 $class->setup_log( delete $flags->{log} );
1370 $class->setup_plugins( delete $flags->{plugins} );
1372 $class->setup_data_handlers();
1373 $class->setup_dispatcher( delete $flags->{dispatcher} );
1374 if (my $engine = delete $flags->{engine}) {
1375 $class->log->warn("Specifying the engine in ->setup is no longer supported, see Catalyst::Upgrading");
1377 $class->setup_engine();
1378 $class->setup_stats( delete $flags->{stats} );
1380 for my $flag ( sort keys %{$flags} ) {
1382 if ( my $code = $class->can( 'setup_' . $flag ) ) {
1383 &$code( $class, delete $flags->{$flag} );
1386 $class->log->warn(qq/Unknown flag "$flag"/);
1390 eval { require Catalyst::Devel; };
1391 if( !$@ && $ENV{CATALYST_SCRIPT_GEN} && ( $ENV{CATALYST_SCRIPT_GEN} < $Catalyst::Devel::CATALYST_SCRIPT_GEN ) ) {
1392 $class->log->warn(<<"EOF");
1393 You are running an old script!
1395 Please update by running (this will overwrite existing files):
1396 catalyst.pl -force -scripts $class
1398 or (this will not overwrite existing files):
1399 catalyst.pl -scripts $class
1404 # Call plugins setup, this is stupid and evil.
1405 # Also screws C3 badly on 5.10, hack to avoid.
1407 no warnings qw/redefine/;
1408 local *setup = sub { };
1409 $class->setup unless $Catalyst::__AM_RESTARTING;
1412 # If you are expecting configuration info as part of your setup, it needs
1413 # to get called here and below, since we need the above line to support
1414 # ConfigLoader based configs.
1416 $class->setup_encoding();
1417 $class->setup_middleware();
1419 # Initialize our data structure
1420 $class->components( {} );
1422 $class->setup_components;
1424 if ( $class->debug ) {
1425 my @plugins = map { "$_ " . ( $_->VERSION || '' ) } $class->registered_plugins;
1428 my $column_width = Catalyst::Utils::term_width() - 6;
1429 my $t = Text::SimpleTable->new($column_width);
1430 $t->row($_) for @plugins;
1431 $class->log->debug( "Loaded plugins:\n" . $t->draw . "\n" );
1434 my @middleware = map {
1437 (ref($_) .' '. ($_->can('VERSION') ? $_->VERSION || '' : '')
1438 || '') } $class->registered_middlewares;
1441 my $column_width = Catalyst::Utils::term_width() - 6;
1442 my $t = Text::SimpleTable->new($column_width);
1443 $t->row($_) for @middleware;
1444 $class->log->debug( "Loaded PSGI Middleware:\n" . $t->draw . "\n" );
1447 my %dh = $class->registered_data_handlers;
1448 if (my @data_handlers = keys %dh) {
1449 my $column_width = Catalyst::Utils::term_width() - 6;
1450 my $t = Text::SimpleTable->new($column_width);
1451 $t->row($_) for @data_handlers;
1452 $class->log->debug( "Loaded Request Data Handlers:\n" . $t->draw . "\n" );
1455 my $dispatcher = $class->dispatcher;
1456 my $engine = $class->engine;
1457 my $home = $class->config->{home};
1459 $class->log->debug(sprintf(q/Loaded dispatcher "%s"/, blessed($dispatcher)));
1460 $class->log->debug(sprintf(q/Loaded engine "%s"/, blessed($engine)));
1464 ? $class->log->debug(qq/Found home "$home"/)
1465 : $class->log->debug(qq/Home "$home" doesn't exist/)
1466 : $class->log->debug(q/Couldn't find home/);
1468 my $column_width = Catalyst::Utils::term_width() - 8 - 9;
1470 my $t = Text::SimpleTable->new( [ $column_width, 'Class' ], [ 8, 'Type' ] );
1471 for my $comp ( sort keys %{ $class->components } ) {
1472 my $type = ref $class->components->{$comp} ? 'instance' : 'class';
1473 $t->row( $comp, $type );
1475 $class->log->debug( "Loaded components:\n" . $t->draw . "\n" )
1476 if ( keys %{ $class->components } );
1479 # Add our self to components, since we are also a component
1480 if( $class->isa('Catalyst::Controller') ){
1481 $class->components->{$class} = $class;
1484 $class->setup_actions;
1486 if ( $class->debug ) {
1487 my $name = $class->config->{name} || 'Application';
1488 $class->log->info("$name powered by Catalyst $Catalyst::VERSION");
1491 if ($class->config->{case_sensitive}) {
1492 $class->log->warn($class . "->config->{case_sensitive} is set.");
1493 $class->log->warn("This setting is deprecated and planned to be removed in Catalyst 5.81.");
1496 # call these so we pre setup the composed classes
1497 $class->composed_request_class;
1498 $class->composed_response_class;
1499 $class->composed_stats_class;
1501 $class->setup_finalize;
1503 # Flush the log for good measure (in case something turned off 'autoflush' early)
1504 $class->log->_flush() if $class->log->can('_flush');
1506 return $class || 1; # Just in case someone named their Application 0...
1509 =head2 $app->setup_finalize
1511 A hook to attach modifiers to. This method does not do anything except set the
1512 C<setup_finished> accessor.
1514 Applying method modifiers to the C<setup> method doesn't work, because of quirky things done for plugin setup.
1518 after setup_finalize => sub {
1526 sub setup_finalize {
1528 $class->setup_finished(1);
1531 =head2 $c->uri_for( $path?, @args?, \%query_values?, \$fragment? )
1533 =head2 $c->uri_for( $action, \@captures?, @args?, \%query_values?, \$fragment? )
1535 =head2 $c->uri_for( $action, [@captures, @args], \%query_values?, \$fragment? )
1537 Constructs an absolute L<URI> object based on the application root, the
1538 provided path, and the additional arguments and query parameters provided.
1539 When used as a string, provides a textual URI. If you need more flexibility
1540 than this (i.e. the option to provide relative URIs etc.) see
1541 L<Catalyst::Plugin::SmartURI>.
1543 If no arguments are provided, the URI for the current action is returned.
1544 To return the current action and also provide @args, use
1545 C<< $c->uri_for( $c->action, @args ) >>.
1547 If the first argument is a string, it is taken as a public URI path relative
1548 to C<< $c->namespace >> (if it doesn't begin with a forward slash) or
1549 relative to the application root (if it does). It is then merged with
1550 C<< $c->request->base >>; any C<@args> are appended as additional path
1551 components; and any C<%query_values> are appended as C<?foo=bar> parameters.
1553 B<NOTE> If you are using this 'stringy' first argument, we skip encoding and
1554 allow you to declare something like:
1556 $c->uri_for('/foo/bar#baz')
1558 Where 'baz' is a URI fragment. We consider this first argument string to be
1559 'expert' mode where you are expected to create a valid URL and we for the most
1560 part just pass it through without a lot of internal effort to escape and encode.
1562 If the first argument is a L<Catalyst::Action> it represents an action which
1563 will have its path resolved using C<< $c->dispatcher->uri_for_action >>. The
1564 optional C<\@captures> argument (an arrayref) allows passing the captured
1565 variables that are needed to fill in the paths of Chained and Regex actions;
1566 once the path is resolved, C<uri_for> continues as though a path was
1567 provided, appending any arguments or parameters and creating an absolute
1570 The captures for the current request can be found in
1571 C<< $c->request->captures >>, and actions can be resolved using
1572 C<< Catalyst::Controller->action_for($name) >>. If you have a private action
1573 path, use C<< $c->uri_for_action >> instead.
1575 # Equivalent to $c->req->uri
1576 $c->uri_for($c->action, $c->req->captures,
1577 @{ $c->req->args }, $c->req->params);
1579 # For the Foo action in the Bar controller
1580 $c->uri_for($c->controller('Bar')->action_for('Foo'));
1582 # Path to a static resource
1583 $c->uri_for('/static/images/logo.png');
1585 In general the scheme of the generated URI object will follow the incoming request
1586 however if your targeted action or action chain has the Scheme attribute it will
1589 Also, if the targeted Action or Action chain declares Args/CaptureArgs that have
1590 type constraints, we will require that your proposed URL verify on those declared
1596 my ( $c, $path, @args ) = @_;
1598 if ( $path->$_isa('Catalyst::Controller') ) {
1599 $path = $path->path_prefix;
1604 my $fragment = ((scalar(@args) && ref($args[-1]) eq 'SCALAR') ? pop @args : undef );
1606 unless(blessed $path) {
1607 if (defined($path) and $path =~ s/#(.+)$//) {
1608 if(defined($1) and $fragment) {
1609 carp "Abiguious fragment declaration: You cannot define a fragment in '$path' and as an argument '$fragment'";
1618 ( scalar @args && ref $args[$#args] eq 'HASH' ? pop @args : {} );
1620 undef($path) if (defined $path && $path eq '');
1622 carp "uri_for called with undef argument" if grep { ! defined $_ } @args;
1624 my $target_action = $path->$_isa('Catalyst::Action') ? $path : undef;
1625 if ( $path->$_isa('Catalyst::Action') ) { # action object
1626 s|/|%2F|g for @args;
1627 my $captures = [ map { s|/|%2F|g; $_; }
1628 ( scalar @args && ref $args[0] eq 'ARRAY'
1633 my $expanded_action = $c->dispatcher->expand_action( $action );
1634 my $num_captures = $expanded_action->number_of_captures;
1636 # ->uri_for( $action, \@captures_and_args, \%query_values? )
1637 if( !@args && $action->number_of_args ) {
1638 unshift @args, splice @$captures, $num_captures;
1642 unless($expanded_action->match_captures_constraints($c, $captures)) {
1643 carp "captures [@{$captures}] do not match the type constraints in actionchain ending with '$expanded_action'";
1648 $path = $c->dispatcher->uri_for_action($action, $captures);
1649 if (not defined $path) {
1650 $c->log->debug(qq/Can't find uri_for action '$action' @$captures/)
1654 $path = '/' if $path eq '';
1656 # At this point @encoded_args is the remaining Args (all captures removed).
1657 if($expanded_action->has_args_constraints) {
1658 unless($expanded_action->match_args($c,\@args)) {
1659 carp "args [@args] do not match the type constraints in action '$expanded_action'";
1665 unshift(@args, $path);
1667 unless (defined $path && $path =~ s!^/!!) { # in-place strip
1668 my $namespace = $c->namespace;
1669 if (defined $path) { # cheesy hack to handle path '../foo'
1670 $namespace =~ s{(?:^|/)[^/]+$}{} while $args[0] =~ s{^\.\./}{};
1672 unshift(@args, $namespace || '');
1675 # join args with '/', or a blank string
1676 my $args = join('/', grep { defined($_) } @args);
1677 $args =~ s/\?/%3F/g; # STUPID STUPID SPECIAL CASE
1680 my ($base, $class) = ('/', 'URI::_generic');
1682 $base = $c->req->base;
1683 if($target_action) {
1684 $target_action = $c->dispatcher->expand_action($target_action);
1685 if(my $s = $target_action->scheme) {
1690 $class = ref($base);
1693 $class = ref($base);
1696 $base =~ s{(?<!/)$}{/};
1700 if (my @keys = keys %$params) {
1701 # somewhat lifted from URI::_query's query_form
1702 $query = '?'.join('&', map {
1703 my $val = $params->{$_};
1704 #s/([;\/?:@&=+,\$\[\]%])/$URI::Escape::escapes{$1}/go; ## Commented out because seems to lead to double encoding - JNAP
1707 $val = '' unless defined $val;
1710 $param = encode_utf8($param);
1711 # using the URI::Escape pattern here so utf8 chars survive
1712 $param =~ s/([^A-Za-z0-9\-_.!~*'() ])/$URI::Escape::escapes{$1}/go;
1715 $key = encode_utf8($key);
1716 # using the URI::Escape pattern here so utf8 chars survive
1717 $key =~ s/([^A-Za-z0-9\-_.!~*'() ])/$URI::Escape::escapes{$1}/go;
1720 "${key}=$param"; } ( ref $val eq 'ARRAY' ? @$val : $val ));
1724 $base = encode_utf8 $base;
1725 $base =~ s/([^$URI::uric])/$URI::Escape::escapes{$1}/go;
1726 $args = encode_utf8 $args;
1727 $args =~ s/([^$URI::uric])/$URI::Escape::escapes{$1}/go;
1729 if(defined $fragment) {
1731 $fragment = encode_utf8(${$fragment});
1732 $fragment =~ s/([^A-Za-z0-9\-_.!~*'() ])/$URI::Escape::escapes{$1}/go;
1733 $fragment =~ s/ /+/g;
1735 $query .= "#$fragment";
1738 my $res = bless(\"${base}${args}${query}", $class);
1742 =head2 $c->uri_for_action( $path, \@captures_and_args?, @args?, \%query_values? )
1744 =head2 $c->uri_for_action( $action, \@captures_and_args?, @args?, \%query_values? )
1750 A private path to the Catalyst action you want to create a URI for.
1752 This is a shortcut for calling C<< $c->dispatcher->get_action_by_path($path)
1753 >> and passing the resulting C<$action> and the remaining arguments to C<<
1756 You can also pass in a Catalyst::Action object, in which case it is passed to
1759 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.
1761 For example, if the action looks like:
1763 package MyApp::Controller::Users;
1765 sub lst : Path('the-list') {}
1769 $c->uri_for_action('/users/lst')
1771 and it will create the URI /users/the-list.
1773 =item \@captures_and_args?
1775 Optional array reference of Captures (i.e. C<<CaptureArgs or $c->req->captures>)
1776 and arguments to the request. Usually used with L<Catalyst::DispatchType::Chained>
1777 to interpolate all the parameters in the URI.
1781 Optional list of extra arguments - can be supplied in the
1782 C<< \@captures_and_args? >> array ref, or here - whichever is easier for your
1785 Your action can have zero, a fixed or a variable number of args (e.g.
1786 C<< Args(1) >> for a fixed number or C<< Args() >> for a variable number)..
1788 =item \%query_values?
1790 Optional array reference of query parameters to append. E.g.
1796 /rest/of/your/uri?foo=bar
1802 sub uri_for_action {
1803 my ( $c, $path, @args ) = @_;
1804 my $action = blessed($path)
1806 : $c->dispatcher->get_action_by_path($path);
1807 unless (defined $action) {
1808 croak "Can't find action for path '$path'";
1810 return $c->uri_for( $action, @args );
1813 =head2 $c->welcome_message
1815 Returns the Catalyst welcome HTML page.
1819 sub welcome_message {
1821 my $name = $c->config->{name};
1822 my $logo = $c->uri_for('/static/images/catalyst_logo.png');
1823 my $prefix = Catalyst::Utils::appprefix( ref $c );
1824 $c->response->content_type('text/html; charset=utf-8');
1826 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
1827 "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
1828 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
1830 <meta http-equiv="Content-Language" content="en" />
1831 <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
1832 <title>$name on Catalyst $VERSION</title>
1833 <style type="text/css">
1836 background-color: #eee;
1843 margin-bottom: 10px;
1845 background-color: #ccc;
1846 border: 1px solid #aaa;
1851 font-family: verdana, tahoma, sans-serif;
1854 font-family: verdana, tahoma, sans-serif;
1857 text-decoration: none;
1859 border-bottom: 1px dotted #bbb;
1861 :link:hover, :visited:hover {
1874 background-color: #fff;
1875 border: 1px solid #aaa;
1879 font-weight: normal;
1901 <h1><span id="appname">$name</span> on <a href="http://catalyst.perl.org">Catalyst</a>
1906 <img src="$logo" alt="Catalyst Logo" />
1908 <p>Welcome to the world of Catalyst.
1909 This <a href="http://en.wikipedia.org/wiki/MVC">MVC</a>
1910 framework will make web development something you had
1911 never expected it to be: Fun, rewarding, and quick.</p>
1912 <h2>What to do now?</h2>
1913 <p>That really depends on what <b>you</b> want to do.
1914 We do, however, provide you with a few starting points.</p>
1915 <p>If you want to jump right into web development with Catalyst
1916 you might want to start with a tutorial.</p>
1917 <pre>perldoc <a href="https://metacpan.org/module/Catalyst::Manual::Tutorial">Catalyst::Manual::Tutorial</a></code>
1919 <p>Afterwards you can go on to check out a more complete look at our features.</p>
1921 <code>perldoc <a href="https://metacpan.org/module/Catalyst::Manual::Intro">Catalyst::Manual::Intro</a>
1922 <!-- Something else should go here, but the Catalyst::Manual link seems unhelpful -->
1924 <h2>What to do next?</h2>
1925 <p>Next it's time to write an actual application. Use the
1926 helper scripts to generate <a href="https://metacpan.org/search?q=Catalyst%3A%3AController">controllers</a>,
1927 <a href="https://metacpan.org/search?q=Catalyst%3A%3AModel">models</a>, and
1928 <a href="https://metacpan.org/search?q=Catalyst%3A%3AView">views</a>;
1929 they can save you a lot of work.</p>
1930 <pre><code>script/${prefix}_create.pl --help</code></pre>
1931 <p>Also, be sure to check out the vast and growing
1932 collection of <a href="http://search.cpan.org/search?query=Catalyst">plugins for Catalyst on CPAN</a>;
1933 you are likely to find what you need there.
1937 <p>Catalyst has a very active community. Here are the main places to
1938 get in touch with us.</p>
1941 <a href="http://dev.catalyst.perl.org">Wiki</a>
1944 <a href="http://lists.scsys.co.uk/cgi-bin/mailman/listinfo/catalyst">Mailing-List</a>
1947 <a href="irc://irc.perl.org/catalyst">IRC channel #catalyst on irc.perl.org</a>
1950 <h2>In conclusion</h2>
1951 <p>The Catalyst team hopes you will enjoy using Catalyst as much
1952 as we enjoyed making it. Please contact us if you have ideas
1953 for improvement or other feedback.</p>
1963 Contains a hash of options passed from the application script, including
1964 the original ARGV the script received, the processed values from that
1965 ARGV and any extra arguments to the script which were not processed.
1967 This can be used to add custom options to your application's scripts
1968 and setup your application differently depending on the values of these
1971 =head1 INTERNAL METHODS
1973 These methods are not meant to be used by end users.
1975 =head2 $c->components
1977 Returns a hash of components.
1979 =head2 $c->context_class
1981 Returns or sets the context class.
1985 Returns a hashref containing coderefs and execution counts (needed for
1986 deep recursion detection).
1990 Returns the number of actions on the current internal execution stack.
1994 Dispatches a request to actions.
1998 sub dispatch { my $c = shift; $c->dispatcher->dispatch( $c, @_ ) }
2000 =head2 $c->dispatcher_class
2002 Returns or sets the dispatcher class.
2004 =head2 $c->dump_these
2006 Returns a list of 2-element array references (name, structure) pairs
2007 that will be dumped on the error page in debug mode.
2013 [ Request => $c->req ],
2014 [ Response => $c->res ],
2015 [ Stash => $c->stash ],
2016 [ Config => $c->config ];
2019 =head2 $c->engine_class
2021 Returns or sets the engine class.
2023 =head2 $c->execute( $class, $coderef )
2025 Execute a coderef in given class and catch exceptions. Errors are available
2031 my ( $c, $class, $code ) = @_;
2032 $class = $c->component($class) || $class;
2035 if ( $c->depth >= $RECURSION ) {
2036 my $action = $code->reverse();
2037 $action = "/$action" unless $action =~ /->/;
2038 my $error = qq/Deep recursion detected calling "${action}"/;
2039 $c->log->error($error);
2045 my $stats_info = $c->_stats_start_execute( $code ) if $c->use_stats;
2047 push( @{ $c->stack }, $code );
2049 no warnings 'recursion';
2050 # N.B. This used to be combined, but I have seen $c get clobbered if so, and
2051 # I have no idea how, ergo $ret (which appears to fix the issue)
2052 eval { my $ret = $code->execute( $class, $c, @{ $c->req->args } ) || 0; $c->state( $ret ) };
2054 $c->_stats_finish_execute( $stats_info ) if $c->use_stats and $stats_info;
2056 my $last = pop( @{ $c->stack } );
2058 if ( my $error = $@ ) {
2059 #rethow if this can be handled by middleware
2060 if ( $c->_handle_http_exception($error) ) {
2061 foreach my $err (@{$c->error}) {
2062 $c->log->error($err);
2065 $c->log->_flush if $c->log->can('_flush');
2067 $error->can('rethrow') ? $error->rethrow : croak $error;
2069 if ( blessed($error) and $error->isa('Catalyst::Exception::Detach') ) {
2070 $error->rethrow if $c->depth > 1;
2072 elsif ( blessed($error) and $error->isa('Catalyst::Exception::Go') ) {
2073 $error->rethrow if $c->depth > 0;
2076 unless ( ref $error ) {
2077 no warnings 'uninitialized';
2079 my $class = $last->class;
2080 my $name = $last->name;
2081 $error = qq/Caught exception in $class->$name "$error"/;
2090 sub _stats_start_execute {
2091 my ( $c, $code ) = @_;
2092 my $appclass = ref($c) || $c;
2093 return if ( ( $code->name =~ /^_.*/ )
2094 && ( !$appclass->config->{show_internal_actions} ) );
2096 my $action_name = $code->reverse();
2097 $c->counter->{$action_name}++;
2099 my $action = $action_name;
2100 $action = "/$action" unless $action =~ /->/;
2102 # determine if the call was the result of a forward
2103 # this is done by walking up the call stack and looking for a calling
2104 # sub of Catalyst::forward before the eval
2106 for my $index ( 2 .. 11 ) {
2108 if ( ( caller($index) )[0] eq 'Catalyst'
2109 && ( caller($index) )[3] eq '(eval)' );
2111 if ( ( caller($index) )[3] =~ /forward$/ ) {
2112 $callsub = ( caller($index) )[3];
2113 $action = "-> $action";
2118 my $uid = $action_name . $c->counter->{$action_name};
2120 # is this a root-level call or a forwarded call?
2121 if ( $callsub =~ /forward$/ ) {
2122 my $parent = $c->stack->[-1];
2124 # forward, locate the caller
2125 if ( defined $parent && exists $c->counter->{"$parent"} ) {
2128 parent => "$parent" . $c->counter->{"$parent"},
2134 # forward with no caller may come from a plugin
2153 sub _stats_finish_execute {
2154 my ( $c, $info ) = @_;
2155 $c->stats->profile( end => $info );
2160 Finalizes the request.
2167 for my $error ( @{ $c->error } ) {
2168 $c->log->error($error);
2171 # Support skipping finalize for psgix.io style 'jailbreak'. Used to support
2172 # stuff like cometd and websockets
2174 if($c->request->_has_io_fh) {
2179 # Allow engine to handle finalize flow (for POE)
2180 my $engine = $c->engine;
2181 if ( my $code = $engine->can('finalize') ) {
2186 $c->finalize_uploads;
2189 if ( $#{ $c->error } >= 0 ) {
2193 $c->finalize_encoding;
2194 $c->finalize_headers unless $c->response->finalized_headers;
2200 if ($c->use_stats) {
2201 my $elapsed = $c->stats->elapsed;
2202 my $av = $elapsed == 0 ? '??' : sprintf '%.3f', 1 / $elapsed;
2204 "Request took ${elapsed}s ($av/s)\n" . $c->stats->report . "\n" );
2207 return $c->response->status;
2210 =head2 $c->finalize_body
2216 sub finalize_body { my $c = shift; $c->engine->finalize_body( $c, @_ ) }
2218 =head2 $c->finalize_cookies
2224 sub finalize_cookies { my $c = shift; $c->engine->finalize_cookies( $c, @_ ) }
2226 =head2 $c->finalize_error
2228 Finalizes error. If there is only one error in L</error> and it is an object that
2229 does C<as_psgi> or C<code> we rethrow the error and presume it caught by middleware
2230 up the ladder. Otherwise we return the debugging error page (in debug mode) or we
2231 return the default error page (production mode).
2235 sub finalize_error {
2237 if($#{$c->error} > 0) {
2238 $c->engine->finalize_error( $c, @_ );
2240 my ($error) = @{$c->error};
2241 if ( $c->_handle_http_exception($error) ) {
2242 # In the case where the error 'knows what it wants', becauses its PSGI
2243 # aware, just rethow and let middleware catch it
2244 $error->can('rethrow') ? $error->rethrow : croak $error;
2246 $c->engine->finalize_error( $c, @_ )
2251 =head2 $c->finalize_headers
2257 sub finalize_headers {
2260 my $response = $c->response; #accessor calls can add up?
2262 # Check if we already finalized headers
2263 return if $response->finalized_headers;
2266 if ( my $location = $response->redirect ) {
2267 $c->log->debug(qq/Redirecting to "$location"/) if $c->debug;
2268 $response->header( Location => $location );
2271 # Remove incorrectly added body and content related meta data when returning
2272 # an information response, or a response the is required to not include a body
2274 $c->finalize_cookies;
2276 # This currently is a NOOP but I don't want to remove it since I guess people
2277 # might have Response subclasses that use it for something... (JNAP)
2278 $c->response->finalize_headers();
2281 $response->finalized_headers(1);
2284 =head2 $c->finalize_encoding
2286 Make sure your body is encoded properly IF you set an encoding. By
2287 default the encoding is UTF-8 but you can disable it by explicitly setting the
2288 encoding configuration value to undef.
2290 We can only encode when the body is a scalar. Methods for encoding via the
2291 streaming interfaces (such as C<write> and C<write_fh> on L<Catalyst::Response>
2298 sub finalize_encoding {
2300 my $res = $c->res || return;
2302 # Warn if the set charset is different from the one you put into encoding. We need
2303 # to do this early since encodable_response is false for this condition and we need
2304 # to match the debug output for backcompat (there's a test for this...) -JNAP
2306 $res->content_type_charset and $c->encoding and
2307 (uc($c->encoding->mime_name) ne uc($res->content_type_charset))
2309 my $ct = lc($res->content_type_charset);
2310 $c->log->debug("Catalyst encoding config is set to encode in '" .
2311 $c->encoding->mime_name .
2312 "', content type is '$ct', not encoding ");
2316 ($res->encodable_response) and
2317 (defined($res->body)) and
2318 (ref(\$res->body) eq 'SCALAR')
2320 # if you are finding yourself here and your body is already encoded correctly
2321 # and you want to turn this off, use $c->clear_encoding to prevent encoding
2322 # at this step, or set encoding to undef in the config to do so for the whole
2323 # application. See the ENCODING documentaiton for better notes.
2324 $c->res->body( $c->encoding->encode( $c->res->body, $c->_encode_check ) );
2326 # Set the charset if necessary. This might be a bit bonkers since encodable response
2327 # is false when the set charset is not the same as the encoding mimetype (maybe
2328 # confusing action at a distance here..
2329 # Don't try to set the charset if one already exists or if headers are already finalized
2330 $c->res->content_type($c->res->content_type . "; charset=" . $c->encoding->mime_name)
2331 unless($c->res->content_type_charset ||
2332 ($c->res->_context && $c->res->finalized_headers && !$c->res->_has_response_cb));
2336 =head2 $c->finalize_output
2338 An alias for finalize_body.
2340 =head2 $c->finalize_read
2342 Finalizes the input after reading is complete.
2346 sub finalize_read { my $c = shift; $c->engine->finalize_read( $c, @_ ) }
2348 =head2 $c->finalize_uploads
2350 Finalizes uploads. Cleans up any temporary files.
2354 sub finalize_uploads { my $c = shift; $c->engine->finalize_uploads( $c, @_ ) }
2356 =head2 $c->get_action( $action, $namespace )
2358 Gets an action in a given namespace.
2362 sub get_action { my $c = shift; $c->dispatcher->get_action(@_) }
2364 =head2 $c->get_actions( $action, $namespace )
2366 Gets all actions of a given name in a namespace and all parent
2371 sub get_actions { my $c = shift; $c->dispatcher->get_actions( $c, @_ ) }
2373 =head2 $app->handle_request( @arguments )
2375 Called to handle each HTTP request.
2379 sub handle_request {
2380 my ( $class, @arguments ) = @_;
2382 # Always expect worst case!
2385 if ($class->debug) {
2386 my $secs = time - $START || 1;
2387 my $av = sprintf '%.3f', $COUNT / $secs;
2388 my $time = localtime time;
2389 $class->log->info("*** Request $COUNT ($av/s) [$$] [$time] ***");
2392 my $c = $class->prepare(@arguments);
2394 $status = $c->finalize;
2396 #rethow if this can be handled by middleware
2397 if ( $class->_handle_http_exception($_) ) {
2398 $_->can('rethrow') ? $_->rethrow : croak $_;
2400 chomp(my $error = $_);
2401 $class->log->error(qq/Caught exception in engine "$error"/);
2406 if(my $coderef = $class->log->can('_flush')){
2407 $class->log->$coderef();
2412 =head2 $class->prepare( @arguments )
2414 Creates a Catalyst context from an engine-specific request (Apache, CGI,
2421 predicate => '_has_uploadtmp',
2425 my ( $class, @arguments ) = @_;
2428 # After the app/ctxt split, this should become an attribute based on something passed
2429 # into the application.
2430 $class->context_class( ref $class || $class ) unless $class->context_class;
2432 my $uploadtmp = $class->config->{uploadtmp};
2433 my $c = $class->context_class->new({ $uploadtmp ? (_uploadtmp => $uploadtmp) : ()});
2435 $c->response->_context($c);
2436 $c->stats($class->stats_class->new)->enable($c->use_stats);
2438 if ( $c->debug || $c->config->{enable_catalyst_header} ) {
2439 $c->res->headers->header( 'X-Catalyst' => $Catalyst::VERSION );
2443 # Allow engine to direct the prepare flow (for POE)
2444 if ( my $prepare = $c->engine->can('prepare') ) {
2445 $c->engine->$prepare( $c, @arguments );
2448 $c->prepare_request(@arguments);
2449 $c->prepare_connection;
2450 $c->prepare_query_parameters;
2451 $c->prepare_headers; # Just hooks, no longer needed - they just
2452 $c->prepare_cookies; # cause the lazy attribute on req to build
2455 # Prepare the body for reading, either by prepare_body
2456 # or the user, if they are using $c->read
2459 # Parse the body unless the user wants it on-demand
2460 unless ( ref($c)->config->{parse_on_demand} ) {
2466 # VERY ugly and probably shouldn't rely on ->finalize actually working
2468 # failed prepare is always due to an invalid request, right?
2469 # Note we call finalize and then die here, which escapes
2470 # finalize being called in the enclosing block..
2471 # It in fact couldn't be called, as we don't return $c..
2472 # This is a mess - but I'm unsure you can fix this without
2473 # breaking compat for people doing crazy things (we should set
2474 # the 400 and just return the ctx here IMO, letting finalize get called
2476 if ( $c->_handle_http_exception($_) ) {
2477 foreach my $err (@{$c->error}) {
2478 $c->log->error($err);
2481 $c->log->_flush if $c->log->can('_flush');
2482 $_->can('rethrow') ? $_->rethrow : croak $_;
2484 $c->response->status(400);
2485 $c->response->content_type('text/plain');
2486 $c->response->body('Bad Request');
2493 $c->{stash} = $c->stash;
2494 Scalar::Util::weaken($c->{stash});
2499 =head2 $c->prepare_action
2501 Prepares action. See L<Catalyst::Dispatcher>.
2505 sub prepare_action {
2507 my $ret = $c->dispatcher->prepare_action( $c, @_);
2510 foreach (@{$c->req->arguments}, @{$c->req->captures}) {
2511 $_ = $c->_handle_param_unicode_decoding($_);
2519 =head2 $c->prepare_body
2521 Prepares message body.
2528 return if $c->request->_has_body;
2530 # Initialize on-demand data
2531 $c->engine->prepare_body( $c, @_ );
2532 $c->prepare_parameters;
2533 $c->prepare_uploads;
2536 =head2 $c->prepare_body_chunk( $chunk )
2538 Prepares a chunk of data before sending it to L<HTTP::Body>.
2540 See L<Catalyst::Engine>.
2544 sub prepare_body_chunk {
2546 $c->engine->prepare_body_chunk( $c, @_ );
2549 =head2 $c->prepare_body_parameters
2551 Prepares body parameters.
2555 sub prepare_body_parameters {
2557 $c->request->prepare_body_parameters( $c, @_ );
2560 =head2 $c->prepare_connection
2562 Prepares connection.
2566 sub prepare_connection {
2568 $c->request->prepare_connection($c);
2571 =head2 $c->prepare_cookies
2573 Prepares cookies by ensuring that the attribute on the request
2574 object has been built.
2578 sub prepare_cookies { my $c = shift; $c->request->cookies }
2580 =head2 $c->prepare_headers
2582 Prepares request headers by ensuring that the attribute on the request
2583 object has been built.
2587 sub prepare_headers { my $c = shift; $c->request->headers }
2589 =head2 $c->prepare_parameters
2591 Prepares parameters.
2595 sub prepare_parameters {
2597 $c->prepare_body_parameters;
2598 $c->engine->prepare_parameters( $c, @_ );
2601 =head2 $c->prepare_path
2603 Prepares path and base.
2607 sub prepare_path { my $c = shift; $c->engine->prepare_path( $c, @_ ) }
2609 =head2 $c->prepare_query_parameters
2611 Prepares query parameters.
2615 sub prepare_query_parameters {
2618 $c->engine->prepare_query_parameters( $c, @_ );
2621 =head2 $c->log_request
2623 Writes information about the request to the debug logs. This includes:
2627 =item * Request method, path, and remote IP address
2629 =item * Query keywords (see L<Catalyst::Request/query_keywords>)
2631 =item * Request parameters
2633 =item * File uploads
2642 return unless $c->debug;
2644 my($dump) = grep {$_->[0] eq 'Request' } $c->dump_these;
2645 my $request = $dump->[1];
2647 my ( $method, $path, $address ) = ( $request->method, $request->path, $request->address );
2649 $path = '/' unless length $path;
2652 $path =~ s/%([0-9A-Fa-f]{2})/chr(hex($1))/eg;
2653 $path = decode_utf8($path);
2655 $c->log->debug(qq/"$method" request for "$path" from "$address"/);
2657 $c->log_request_headers($request->headers);
2659 if ( my $keywords = $request->query_keywords ) {
2660 $c->log->debug("Query keywords are: $keywords");
2663 $c->log_request_parameters( query => $request->query_parameters, $request->_has_body ? (body => $request->body_parameters) : () );
2665 $c->log_request_uploads($request);
2668 =head2 $c->log_response
2670 Writes information about the response to the debug logs by calling
2671 C<< $c->log_response_status_line >> and C<< $c->log_response_headers >>.
2678 return unless $c->debug;
2680 my($dump) = grep {$_->[0] eq 'Response' } $c->dump_these;
2681 my $response = $dump->[1];
2683 $c->log_response_status_line($response);
2684 $c->log_response_headers($response->headers);
2687 =head2 $c->log_response_status_line($response)
2689 Writes one line of information about the response to the debug logs. This includes:
2693 =item * Response status code
2695 =item * Content-Type header (if present)
2697 =item * Content-Length header (if present)
2703 sub log_response_status_line {
2704 my ($c, $response) = @_;
2708 'Response Code: %s; Content-Type: %s; Content-Length: %s',
2709 $response->status || 'unknown',
2710 $response->headers->header('Content-Type') || 'unknown',
2711 $response->headers->header('Content-Length') || 'unknown'
2716 =head2 $c->log_response_headers($headers);
2718 Hook method which can be wrapped by plugins to log the response headers.
2719 No-op in the default implementation.
2723 sub log_response_headers {}
2725 =head2 $c->log_request_parameters( query => {}, body => {} )
2727 Logs request parameters to debug logs
2731 sub log_request_parameters {
2733 my %all_params = @_;
2735 return unless $c->debug;
2737 my $column_width = Catalyst::Utils::term_width() - 44;
2738 foreach my $type (qw(query body)) {
2739 my $params = $all_params{$type};
2740 next if ! keys %$params;
2741 my $t = Text::SimpleTable->new( [ 35, 'Parameter' ], [ $column_width, 'Value' ] );
2742 for my $key ( sort keys %$params ) {
2744 if(ref $params eq 'Hash::MultiValue') {
2745 @values = $params->get_all($key);
2747 my $param = $params->{$key};
2748 if( defined($param) ) {
2749 @values = ref $param eq 'ARRAY' ? @$param : $param;
2752 $t->row( $key.( scalar @values > 1 ? ' [multiple]' : ''), join(', ', @values) );
2754 $c->log->debug( ucfirst($type) . " Parameters are:\n" . $t->draw );
2758 =head2 $c->log_request_uploads
2760 Logs file uploads included in the request to the debug logs.
2761 The parameter name, filename, file type, and file size are all included in
2766 sub log_request_uploads {
2768 my $request = shift;
2769 return unless $c->debug;
2770 my $uploads = $request->uploads;
2771 if ( keys %$uploads ) {
2772 my $t = Text::SimpleTable->new(
2773 [ 12, 'Parameter' ],
2778 for my $key ( sort keys %$uploads ) {
2779 my $upload = $uploads->{$key};
2780 for my $u ( ref $upload eq 'ARRAY' ? @{$upload} : ($upload) ) {
2781 $t->row( $key, $u->filename, $u->type, $u->size );
2784 $c->log->debug( "File Uploads are:\n" . $t->draw );
2788 =head2 $c->log_request_headers($headers);
2790 Hook method which can be wrapped by plugins to log the request headers.
2791 No-op in the default implementation.
2795 sub log_request_headers {}
2797 =head2 $c->log_headers($type => $headers)
2799 Logs L<HTTP::Headers> (either request or response) to the debug logs.
2806 my $headers = shift; # an HTTP::Headers instance
2808 return unless $c->debug;
2810 my $column_width = Catalyst::Utils::term_width() - 28;
2811 my $t = Text::SimpleTable->new( [ 15, 'Header Name' ], [ $column_width, 'Value' ] );
2814 my ( $name, $value ) = @_;
2815 $t->row( $name, $value );
2818 $c->log->debug( ucfirst($type) . " Headers:\n" . $t->draw );
2822 =head2 $c->prepare_read
2824 Prepares the input for reading.
2828 sub prepare_read { my $c = shift; $c->engine->prepare_read( $c, @_ ) }
2830 =head2 $c->prepare_request
2832 Prepares the engine request.
2836 sub prepare_request { my $c = shift; $c->engine->prepare_request( $c, @_ ) }
2838 =head2 $c->prepare_uploads
2844 sub prepare_uploads {
2846 $c->engine->prepare_uploads( $c, @_ );
2849 =head2 $c->prepare_write
2851 Prepares the output for writing.
2855 sub prepare_write { my $c = shift; $c->engine->prepare_write( $c, @_ ) }
2857 =head2 $c->request_class
2859 Returns or sets the request class. Defaults to L<Catalyst::Request>.
2861 =head2 $app->request_class_traits
2863 An arrayref of L<Moose::Role>s which are applied to the request class. You can
2864 name the full namespace of the role, or a namespace suffix, which will then
2865 be tried against the following standard namespace prefixes.
2867 $MyApp::TraitFor::Request::$trait_suffix
2868 Catalyst::TraitFor::Request::$trait_suffix
2870 So for example if you set:
2872 MyApp->request_class_traits(['Foo']);
2874 We try each possible role in turn (and throw an error if none load)
2877 MyApp::TraitFor::Request::Foo
2878 Catalyst::TraitFor::Request::Foo
2880 The namespace part 'TraitFor::Request' was chosen to assist in backwards
2881 compatibility with L<CatalystX::RoleApplicator> which previously provided
2882 these features in a stand alone package.
2884 =head2 $app->composed_request_class
2886 This is the request class which has been composed with any request_class_traits.
2888 =head2 $c->response_class
2890 Returns or sets the response class. Defaults to L<Catalyst::Response>.
2892 =head2 $app->response_class_traits
2894 An arrayref of L<Moose::Role>s which are applied to the response class. You can
2895 name the full namespace of the role, or a namespace suffix, which will then
2896 be tried against the following standard namespace prefixes.
2898 $MyApp::TraitFor::Response::$trait_suffix
2899 Catalyst::TraitFor::Response::$trait_suffix
2901 So for example if you set:
2903 MyApp->response_class_traits(['Foo']);
2905 We try each possible role in turn (and throw an error if none load)
2908 MyApp::TraitFor::Response::Foo
2909 Catalyst::TraitFor::Responset::Foo
2911 The namespace part 'TraitFor::Response' was chosen to assist in backwards
2912 compatibility with L<CatalystX::RoleApplicator> which previously provided
2913 these features in a stand alone package.
2916 =head2 $app->composed_response_class
2918 This is the request class which has been composed with any response_class_traits.
2920 =head2 $c->read( [$maxlength] )
2922 Reads a chunk of data from the request body. This method is designed to
2923 be used in a while loop, reading C<$maxlength> bytes on every call.
2924 C<$maxlength> defaults to the size of the request if not specified.
2926 You have to set C<< MyApp->config(parse_on_demand => 1) >> to use this
2929 Warning: If you use read(), Catalyst will not process the body,
2930 so you will not be able to access POST parameters or file uploads via
2931 $c->request. You must handle all body parsing yourself.
2935 sub read { my $c = shift; return $c->request->read( @_ ) }
2945 $app->_make_immutable_if_needed;
2946 $app->engine_loader->needs_psgi_engine_compat_hack ?
2947 $app->engine->run($app, @_) :
2948 $app->engine->run( $app, $app->_finalized_psgi_app, @_ );
2951 sub _make_immutable_if_needed {
2953 my $meta = find_meta($class);
2954 my $isa_ca = $class->isa('Class::Accessor::Fast') || $class->isa('Class::Accessor');
2957 && ! { $meta->immutable_options }->{replace_constructor}
2960 warn("You made your application class ($class) immutable, "
2961 . "but did not inline the\nconstructor. "
2962 . "This will break catalyst, as your app \@ISA "
2963 . "Class::Accessor(::Fast)?\nPlease pass "
2964 . "(replace_constructor => 1)\nwhen making your class immutable.\n");
2966 unless ($meta->is_immutable) {
2967 # XXX - FIXME warning here as you should make your app immutable yourself.
2968 $meta->make_immutable(
2969 replace_constructor => 1,
2974 =head2 $c->set_action( $action, $code, $namespace, $attrs )
2976 Sets an action in a given namespace.
2980 sub set_action { my $c = shift; $c->dispatcher->set_action( $c, @_ ) }
2982 =head2 $c->setup_actions($component)
2984 Sets up actions for a component.
2988 sub setup_actions { my $c = shift; $c->dispatcher->setup_actions( $c, @_ ) }
2990 =head2 $c->setup_components
2992 This method is called internally to set up the application's components.
2994 It finds modules by calling the L<locate_components> method, expands them to
2995 package names with the L<expand_component_module> method, and then installs
2996 each component into the application.
2998 The C<setup_components> config option is passed to both of the above methods.
3000 Installation of each component is performed by the L<setup_component> method,
3005 sub setup_components {
3008 my $config = $class->config->{ setup_components };
3010 my @comps = $class->locate_components($config);
3011 my %comps = map { $_ => 1 } @comps;
3013 my $deprecatedcatalyst_component_names = grep { /::[CMV]::/ } @comps;
3014 $class->log->warn(qq{Your application is using the deprecated ::[MVC]:: type naming scheme.\n}.
3015 qq{Please switch your class names to ::Model::, ::View:: and ::Controller: as appropriate.\n}
3016 ) if $deprecatedcatalyst_component_names;
3018 for my $component ( @comps ) {
3020 # We pass ignore_loaded here so that overlay files for (e.g.)
3021 # Model::DBI::Schema sub-classes are loaded - if it's in @comps
3022 # we know M::P::O found a file on disk so this is safe
3024 Catalyst::Utils::ensure_class_loaded( $component, { ignore_loaded => 1 } );
3027 for my $component (@comps) {
3028 my $instance = $class->components->{ $component } = $class->delayed_setup_component($component);
3031 # Inject a component or wrap a stand alone class in an adaptor. This makes a list
3032 # of named components in the configuration that are not actually existing (not a
3035 my @injected = $class->setup_injected_components;
3037 # All components are registered, now we need to 'init' them.
3038 foreach my $component_name (@comps, @injected) {
3039 $class->components->{$component_name} = $class->components->{$component_name}->() if
3040 (ref($class->components->{$component_name}) || '') eq 'CODE';
3044 =head2 $app->setup_injected_components
3046 Called by setup_compoents to setup components that are injected.
3050 sub setup_injected_components {
3052 my @injected_components = keys %{$class->config->{inject_components} ||+{}};
3054 foreach my $injected_comp_name(@injected_components) {
3055 $class->setup_injected_component(
3056 $injected_comp_name,
3057 $class->config->{inject_components}->{$injected_comp_name});
3060 return map { $class ."::" . $_ }
3061 @injected_components;
3064 =head2 $app->setup_injected_component( $injected_component_name, $config )
3066 Setup a given injected component.
3070 sub setup_injected_component {
3071 my ($class, $injected_comp_name, $config) = @_;
3072 if(my $component_class = $config->{from_component}) {
3073 my @roles = @{$config->{roles} ||[]};
3074 Catalyst::Utils::inject_component(
3076 component => $component_class,
3077 (scalar(@roles) ? (traits => \@roles) : ()),
3078 as => $injected_comp_name);
3082 =head2 $app->inject_component($MyApp_Component_name => \%args);
3084 Add a component that is injected at setup:
3086 MyApp->inject_component( 'Model::Foo' => { from_component => 'Common::Foo' } );
3088 Must be called before ->setup. Expects a component name for your
3089 current application and \%args where
3093 =item from_component
3095 The target component being injected into your application
3099 An arrayref of L<Moose::Role>s that are applied to your component.
3105 MyApp->inject_component(
3107 from_component => 'Common::Model::Foo',
3108 roles => ['Role1', 'Role2'],
3111 =head2 $app->inject_components
3113 Inject a list of components:
3115 MyApp->inject_components(
3116 'Model::FooOne' => {
3117 from_component => 'Common::Model::Foo',
3118 roles => ['Role1', 'Role2'],
3120 'Model::FooTwo' => {
3121 from_component => 'Common::Model::Foo',
3122 roles => ['Role1', 'Role2'],
3127 sub inject_component {
3128 my ($app, $name, $args) = @_;
3129 die "Component $name exists" if
3130 $app->config->{inject_components}->{$name};
3131 $app->config->{inject_components}->{$name} = $args;
3134 sub inject_components {
3137 $app->inject_component(shift, shift);
3141 =head2 $c->locate_components( $setup_component_config )
3143 This method is meant to provide a list of component modules that should be
3144 setup for the application. By default, it will use L<Module::Pluggable>.
3146 Specify a C<setup_components> config option to pass additional options directly
3147 to L<Module::Pluggable>. To add additional search paths, specify a key named
3148 C<search_extra> as an array reference. Items in the array beginning with C<::>
3149 will have the application class name prepended to them.
3153 sub locate_components {
3157 my @paths = qw( ::M ::Model ::V ::View ::C ::Controller );
3158 my $extra = $config->{ search_extra } || [];
3160 unshift @paths, @$extra;
3162 my @comps = map { sort { length($a) <=> length($b) } Module::Pluggable::Object->new(
3163 search_path => [ map { s/^(?=::)/$class/; $_; } ($_) ],
3165 )->plugins } @paths;
3170 =head2 $c->expand_component_module( $component, $setup_component_config )
3172 Components found by C<locate_components> will be passed to this method, which
3173 is expected to return a list of component (package) names to be set up.
3177 sub expand_component_module {
3178 my ($class, $module) = @_;
3179 return Devel::InnerPackage::list_packages( $module );
3182 =head2 $app->delayed_setup_component
3184 Returns a coderef that points to a setup_component instance. Used
3185 internally for when you want to delay setup until the first time
3186 the component is called.
3190 sub delayed_setup_component {
3191 my($class, $component, @more) = @_;
3193 return my $instance = $class->setup_component($component, @more);
3197 =head2 $c->setup_component
3201 sub setup_component {
3202 my( $class, $component ) = @_;
3204 unless ( $component->can( 'COMPONENT' ) ) {
3208 my $config = $class->config_for($component);
3209 # Stash catalyst_component_name in the config here, so that custom COMPONENT
3210 # methods also pass it. local to avoid pointlessly shitting in config
3211 # for the debug screen, as $component is already the key name.
3212 local $config->{catalyst_component_name} = $component;
3214 my $instance = eval {
3215 $component->COMPONENT( $class, $config );
3219 Catalyst::Exception->throw(
3220 message => qq/Couldn't instantiate component "$component", "$error"/
3224 unless (blessed $instance) {
3225 my $metaclass = Moose::Util::find_meta($component);
3226 my $method_meta = $metaclass->find_method_by_name('COMPONENT');
3227 my $component_method_from = $method_meta->associated_metaclass->name;
3228 my $value = defined($instance) ? $instance : 'undef';
3229 Catalyst::Exception->throw(
3231 qq/Couldn't instantiate component "$component", COMPONENT() method (from $component_method_from) didn't return an object-like value (value was $value)./
3235 my @expanded_components = $instance->can('expand_modules')
3236 ? $instance->expand_modules( $component, $config )
3237 : $class->expand_component_module( $component, $config );
3238 for my $component (@expanded_components) {
3239 next if $class->components->{ $component };
3240 $class->components->{ $component } = $class->setup_component($component);
3246 =head2 $app->config_for( $component_name )
3248 Return the application level configuration (which is not yet merged with any
3249 local component configuration, via $component_class->config) for the named
3250 component or component object. Example:
3253 'Model::Foo' => { a => 1, b => 2},
3256 my $config = MyApp->config_for('MyApp::Model::Foo');
3258 In this case $config is the hashref C< {a=>1, b=>2} >.
3260 This is also handy for looking up configuration for a plugin, to make sure you follow
3261 existing L<Catalyst> standards for where a plugin should put its configuration.
3266 my ($class, $component_name) = @_;
3267 my $component_suffix = Catalyst::Utils::class2classsuffix($component_name);
3268 my $config = $class->config->{ $component_suffix } || {};
3273 =head2 $c->setup_dispatcher
3279 sub setup_dispatcher {
3280 my ( $class, $dispatcher ) = @_;
3283 $dispatcher = 'Catalyst::Dispatcher::' . $dispatcher;
3286 if ( my $env = Catalyst::Utils::env_value( $class, 'DISPATCHER' ) ) {
3287 $dispatcher = 'Catalyst::Dispatcher::' . $env;
3290 unless ($dispatcher) {
3291 $dispatcher = $class->dispatcher_class;
3294 load_class($dispatcher);
3296 # dispatcher instance
3297 $class->dispatcher( $dispatcher->new );
3300 =head2 $c->setup_engine
3307 my ($class, $requested_engine) = @_;
3309 if (!$class->engine_loader || $requested_engine) {
3310 $class->engine_loader(
3311 Catalyst::EngineLoader->new({
3312 application_name => $class,
3313 (defined $requested_engine
3314 ? (catalyst_engine_class => $requested_engine) : ()),
3319 $class->engine_loader->catalyst_engine_class;
3323 my ($class, $requested_engine) = @_;
3326 my $loader = $class->engine_loader;
3328 if (!$loader || $requested_engine) {
3329 $loader = Catalyst::EngineLoader->new({
3330 application_name => $class,
3331 (defined $requested_engine
3332 ? (requested_engine => $requested_engine) : ()),
3335 $class->engine_loader($loader);
3338 $loader->catalyst_engine_class;
3341 # Don't really setup_engine -- see _setup_psgi_app for explanation.
3342 return if $class->loading_psgi_file;
3344 load_class($engine);
3346 if ($ENV{MOD_PERL}) {
3347 my $apache = $class->engine_loader->auto;
3349 my $meta = find_meta($class);
3350 my $was_immutable = $meta->is_immutable;
3351 my %immutable_options = $meta->immutable_options;
3352 $meta->make_mutable if $was_immutable;
3354 $meta->add_method(handler => sub {
3356 my $psgi_app = $class->_finalized_psgi_app;
3357 $apache->call_app($r, $psgi_app);
3360 $meta->make_immutable(%immutable_options) if $was_immutable;
3363 $class->engine( $engine->new );
3368 ## This exists just to supply a prebuild psgi app for mod_perl and for the
3369 ## build in server support (back compat support for pre psgi port behavior).
3370 ## This is so that we don't build a new psgi app for each request when using
3371 ## the mod_perl handler or the built in servers (http and fcgi, etc).
3373 sub _finalized_psgi_app {
3376 unless ($app->_psgi_app) {
3377 my $psgi_app = $app->_setup_psgi_app;
3378 $app->_psgi_app($psgi_app);
3381 return $app->_psgi_app;
3384 ## Look for a psgi file like 'myapp_web.psgi' (if the app is MyApp::Web) in the
3385 ## home directory and load that and return it (just assume it is doing the
3386 ## right thing :) ). If that does not exist, call $app->psgi_app, wrap that
3387 ## in default_middleware and return it ( this is for backward compatibility
3388 ## with pre psgi port behavior ).
3390 sub _setup_psgi_app {
3393 for my $home (Path::Class::Dir->new($app->config->{home})) {
3394 my $psgi_file = $home->file(
3395 Catalyst::Utils::appprefix($app) . '.psgi',
3398 next unless -e $psgi_file;
3400 # If $psgi_file calls ->setup_engine, it's doing so to load
3401 # Catalyst::Engine::PSGI. But if it does that, we're only going to
3402 # throw away the loaded PSGI-app and load the 5.9 Catalyst::Engine
3403 # anyway. So set a flag (ick) that tells setup_engine not to populate
3404 # $c->engine or do any other things we might regret.
3406 $app->loading_psgi_file(1);
3407 my $psgi_app = Plack::Util::load_psgi($psgi_file);
3408 $app->loading_psgi_file(0);
3411 unless $app->engine_loader->needs_psgi_engine_compat_hack;
3414 Found a legacy Catalyst::Engine::PSGI .psgi file at ${psgi_file}.
3416 Its content has been ignored. Please consult the Catalyst::Upgrading
3417 documentation on how to upgrade from Catalyst::Engine::PSGI.
3421 return $app->apply_default_middlewares($app->psgi_app);
3424 =head2 $c->apply_default_middlewares
3426 Adds the following L<Plack> middlewares to your application, since they are
3427 useful and commonly needed:
3429 L<Plack::Middleware::LighttpdScriptNameFix> (if you are using Lighttpd),
3430 L<Plack::Middleware::IIS6ScriptNameFix> (always applied since this middleware
3431 is smart enough to conditionally apply itself).
3433 We will also automatically add L<Plack::Middleware::ReverseProxy> if we notice
3434 that your HTTP $env variable C<REMOTE_ADDR> is '127.0.0.1'. This is usually
3435 an indication that your server is running behind a proxy frontend. However in
3436 2014 this is often not the case. We preserve this code for backwards compatibility
3437 however I B<highly> recommend that if you are running the server behind a front
3438 end proxy that you clearly indicate so with the C<using_frontend_proxy> configuration
3439 setting to true for your environment configurations that run behind a proxy. This
3440 way if you change your front end proxy address someday your code would inexplicably
3441 stop working as expected.
3443 Additionally if we detect we are using Nginx, we add a bit of custom middleware
3444 to solve some problems with the way that server handles $ENV{PATH_INFO} and
3447 Please B<NOTE> that if you do use C<using_frontend_proxy> the middleware is now
3448 adding via C<registered_middleware> rather than this method.
3450 If you are using Lighttpd or IIS6 you may wish to apply these middlewares. In
3451 general this is no longer a common case but we have this here for backward
3457 sub apply_default_middlewares {
3458 my ($app, $psgi_app) = @_;
3460 # Don't add this conditional IF we are explicitly saying we want the
3461 # frontend proxy support. We don't need it here since if that is the
3462 # case it will be always loaded in the default_middleware.
3464 unless($app->config->{using_frontend_proxy}) {
3465 $psgi_app = Plack::Middleware::Conditional->wrap(
3467 builder => sub { Plack::Middleware::ReverseProxy->wrap($_[0]) },
3470 return if $app->config->{ignore_frontend_proxy};
3471 return $env->{REMOTE_ADDR} eq '127.0.0.1';
3476 # If we're running under Lighttpd, swap PATH_INFO and SCRIPT_NAME
3477 # http://lists.scsys.co.uk/pipermail/catalyst/2006-June/008361.html
3478 $psgi_app = Plack::Middleware::Conditional->wrap(
3480 builder => sub { Plack::Middleware::LighttpdScriptNameFix->wrap($_[0]) },
3483 return unless $env->{SERVER_SOFTWARE} && $env->{SERVER_SOFTWARE} =~ m!lighttpd[-/]1\.(\d+\.\d+)!;
3484 return unless $1 < 4.23;
3489 # we're applying this unconditionally as the middleware itself already makes
3490 # sure it doesn't fuck things up if it's not running under one of the right
3492 $psgi_app = Plack::Middleware::IIS6ScriptNameFix->wrap($psgi_app);
3494 # And another IIS issue, this time with IIS7.
3495 $psgi_app = Plack::Middleware::Conditional->wrap(
3497 builder => sub { Plack::Middleware::IIS7KeepAliveFix->wrap($_[0]) },
3500 return $env->{SERVER_SOFTWARE} && $env->{SERVER_SOFTWARE} =~ m!IIS/7\.[0-9]!;
3507 =head2 App->psgi_app
3511 Returns a PSGI application code reference for the catalyst application
3512 C<$c>. This is the bare application created without the C<apply_default_middlewares>
3513 method called. We do however apply C<registered_middleware> since those are
3514 integral to how L<Catalyst> functions. Also, unlike starting your application
3515 with a generated server script (via L<Catalyst::Devel> and C<catalyst.pl>) we do
3516 not attempt to return a valid L<PSGI> application using any existing C<${myapp}.psgi>
3517 scripts in your $HOME directory.
3519 B<NOTE> C<apply_default_middlewares> was originally created when the first PSGI
3520 port was done for v5.90000. These are middlewares that are added to achieve
3521 backward compatibility with older applications. If you start your application
3522 using one of the supplied server scripts (generated with L<Catalyst::Devel> and
3523 the project skeleton script C<catalyst.pl>) we apply C<apply_default_middlewares>
3524 automatically. This was done so that pre and post PSGI port applications would
3527 This is what you want to be using to retrieve the PSGI application code
3528 reference of your Catalyst application for use in a custom F<.psgi> or in your
3529 own created server modules.
3533 *to_app = \&psgi_app;
3537 my $psgi = $app->engine->build_psgi_app($app);
3538 return $app->Catalyst::Utils::apply_registered_middleware($psgi);
3541 =head2 $c->setup_home
3543 Sets up the home directory.
3548 my ( $class, $home ) = @_;
3550 if ( my $env = Catalyst::Utils::env_value( $class, 'HOME' ) ) {
3554 $home ||= Catalyst::Utils::home($class);
3557 #I remember recently being scolded for assigning config values like this
3558 $class->config->{home} ||= $home;
3559 $class->config->{root} ||= Path::Class::Dir->new($home)->subdir('root');
3563 =head2 $c->setup_encoding
3565 Sets up the input/output encoding. See L<ENCODING>
3569 sub setup_encoding {
3571 if( exists($c->config->{encoding}) && !defined($c->config->{encoding}) ) {
3572 # Ok, so the user has explicitly said "I don't want encoding..."
3575 my $enc = defined($c->config->{encoding}) ?
3576 delete $c->config->{encoding} : 'UTF-8'; # not sure why we delete it... (JNAP)
3581 =head2 handle_unicode_encoding_exception
3583 Hook to let you customize how encoding errors are handled. By default
3584 we just throw an exception and the default error page will pick it up.
3585 Receives a hashref of debug information. Example of call (from the
3586 Catalyst internals):
3588 my $decoded_after_fail = $c->handle_unicode_encoding_exception({
3589 param_value => $value,
3591 encoding_step => 'params',
3594 The calling code expects to receive a decoded string or an exception.
3596 You can override this for custom handling of unicode errors. By
3597 default we just die. If you want a custom response here, one approach
3598 is to throw an HTTP style exception, instead of returning a decoded
3599 string or throwing a generic exception.
3601 sub handle_unicode_encoding_exception {
3602 my ($c, $params) = @_;
3603 HTTP::Exception::BAD_REQUEST->throw(status_message=>$params->{error_msg});
3606 Alternatively you can 'catch' the error, stash it and write handling code later
3607 in your application:
3609 sub handle_unicode_encoding_exception {
3610 my ($c, $params) = @_;
3611 $c->stash(BAD_UNICODE_DATA=>$params);
3612 # return a dummy string.
3616 <B>NOTE:</b> Please keep in mind that once an error like this occurs,
3617 the request setup is still ongoing, which means the state of C<$c> and
3618 related context parts like the request and response may not be setup
3619 up correctly (since we haven't finished the setup yet). If you throw
3620 an exception the setup is aborted.
3624 sub handle_unicode_encoding_exception {
3625 my ( $self, $exception_ctx ) = @_;
3626 die $exception_ctx->{error_msg};
3629 # Some unicode helpers cargo culted from the old plugin. These could likely
3632 sub _handle_unicode_decoding {
3633 my ( $self, $value ) = @_;
3635 return unless defined $value;
3637 ## I think this mess is to support the old nested
3638 if ( ref $value eq 'ARRAY' ) {
3639 foreach ( @$value ) {
3640 $_ = $self->_handle_unicode_decoding($_);
3644 elsif ( ref $value eq 'HASH' ) {
3645 foreach (keys %$value) {
3646 my $encoded_key = $self->_handle_param_unicode_decoding($_);
3647 $value->{$encoded_key} = $self->_handle_unicode_decoding($value->{$_});
3649 # If the key was encoded we now have two (the original and current so
3650 # delete the original.
3651 delete $value->{$_} if $_ ne $encoded_key;
3656 return $self->_handle_param_unicode_decoding($value);
3660 sub _handle_param_unicode_decoding {
3661 my ( $self, $value, $check ) = @_;
3662 return unless defined $value; # not in love with just ignoring undefs - jnap
3663 return $value if blessed($value); #don't decode when the value is an object.
3665 my $enc = $self->encoding;
3667 return $value unless $enc; # don't decode if no encoding is specified
3669 $check ||= $self->_encode_check;
3671 $enc->decode( $value, $check);
3674 return $self->handle_unicode_encoding_exception({
3675 param_value => $value,
3677 encoding_step => 'params',
3682 =head2 $c->setup_log
3684 Sets up log by instantiating a L<Catalyst::Log|Catalyst::Log> object and
3685 passing it to C<log()>. Pass in a comma-delimited list of levels to set the
3688 This method also installs a C<debug> method that returns a true value into the
3689 catalyst subclass if the "debug" level is passed in the comma-delimited list,
3690 or if the C<$CATALYST_DEBUG> environment variable is set to a true value.
3692 Note that if the log has already been setup, by either a previous call to
3693 C<setup_log> or by a call such as C<< __PACKAGE__->log( MyLogger->new ) >>,
3694 that this method won't actually set up the log object.
3699 my ( $class, $levels ) = @_;
3702 $levels =~ s/^\s+//;
3703 $levels =~ s/\s+$//;
3704 my %levels = map { $_ => 1 } split /\s*,\s*/, $levels;
3706 my $env_debug = Catalyst::Utils::env_value( $class, 'DEBUG' );
3707 if ( defined $env_debug ) {
3708 $levels{debug} = 1 if $env_debug; # Ugly!
3709 delete($levels{debug}) unless $env_debug;
3712 unless ( $class->log ) {
3713 $class->log( Catalyst::Log->new(keys %levels) );
3716 if ( $levels{debug} ) {
3717 Class::MOP::get_metaclass_by_name($class)->add_method('debug' => sub { 1 });
3718 $class->log->debug('Debug messages enabled');
3722 =head2 $c->setup_plugins
3728 =head2 $c->setup_stats
3730 Sets up timing statistics class.
3735 my ( $class, $stats ) = @_;
3737 Catalyst::Utils::ensure_class_loaded($class->stats_class);
3739 my $env = Catalyst::Utils::env_value( $class, 'STATS' );
3740 if ( defined($env) ? $env : ($stats || $class->debug ) ) {
3741 Class::MOP::get_metaclass_by_name($class)->add_method('use_stats' => sub { 1 });
3742 $class->log->debug('Statistics enabled');
3747 =head2 $c->registered_plugins
3749 Returns a sorted list of the plugins which have either been stated in the
3752 If passed a given plugin name, it will report a boolean value indicating
3753 whether or not that plugin is loaded. A fully qualified name is required if
3754 the plugin name does not begin with C<Catalyst::Plugin::>.
3756 if ($c->registered_plugins('Some::Plugin')) {
3764 sub registered_plugins {
3766 return sort keys %{ $proto->_plugins } unless @_;
3768 return 1 if exists $proto->_plugins->{$plugin};
3769 return exists $proto->_plugins->{"Catalyst::Plugin::$plugin"};
3772 sub _register_plugin {
3773 my ( $proto, $plugin, $instant ) = @_;
3774 my $class = ref $proto || $proto;
3776 load_class( $plugin );
3777 $class->log->warn( "$plugin inherits from 'Catalyst::Component' - this is deprecated and will not work in 5.81" )
3778 if $plugin->isa( 'Catalyst::Component' );
3779 my $plugin_meta = Moose::Meta::Class->create($plugin);
3780 if (!$plugin_meta->has_method('new')
3781 && ( $plugin->isa('Class::Accessor::Fast') || $plugin->isa('Class::Accessor') ) ) {
3782 $plugin_meta->add_method('new', Moose::Object->meta->get_method('new'))
3784 if (!$instant && !$proto->_plugins->{$plugin}) {
3785 my $meta = Class::MOP::get_metaclass_by_name($class);
3786 $meta->superclasses($plugin, $meta->superclasses);
3788 $proto->_plugins->{$plugin} = 1;
3792 sub _default_plugins { return qw() }
3795 my ( $class, $plugins ) = @_;
3797 $class->_plugins( {} ) unless $class->_plugins;
3799 m/Unicode::Encoding/ ? do {
3801 'Unicode::Encoding plugin is auto-applied,'
3802 . ' please remove this from your appclass'
3803 . ' and make sure to define "encoding" config'
3805 unless (exists $class->config->{'encoding'}) {
3806 $class->config->{'encoding'} = 'UTF-8';
3811 push @$plugins, $class->_default_plugins;
3812 $plugins = Data::OptList::mkopt($plugins || []);
3815 [ Catalyst::Utils::resolve_namespace(
3816 $class . '::Plugin',
3817 'Catalyst::Plugin', $_->[0]
3823 for my $plugin ( reverse @plugins ) {
3824 load_class($plugin->[0], $plugin->[1]);
3825 my $meta = find_meta($plugin->[0]);
3826 next if $meta && $meta->isa('Moose::Meta::Role');
3828 $class->_register_plugin($plugin->[0]);
3832 map { $_->[0]->name, $_->[1] }
3833 grep { blessed($_->[0]) && $_->[0]->isa('Moose::Meta::Role') }
3834 map { [find_meta($_->[0]), $_->[1]] }
3837 Moose::Util::apply_all_roles(
3843 =head2 default_middleware
3845 Returns a list of instantiated PSGI middleware objects which is the default
3846 middleware that is active for this application (taking any configuration
3847 options into account, excluding your custom added middleware via the C<psgi_middleware>
3848 configuration option). You can override this method if you wish to change
3849 the default middleware (although do so at risk since some middleware is vital
3850 to application function.)
3852 The current default middleware list is:
3854 Catalyst::Middleware::Stash
3855 Plack::Middleware::HTTPExceptions
3856 Plack::Middleware::RemoveRedundantBody
3857 Plack::Middleware::FixMissingBodyInRedirect
3858 Plack::Middleware::ContentLength
3859 Plack::Middleware::MethodOverride
3860 Plack::Middleware::Head
3862 If the configuration setting C<using_frontend_proxy> is true we add:
3864 Plack::Middleware::ReverseProxy
3866 If the configuration setting C<using_frontend_proxy_path> is true we add:
3868 Plack::Middleware::ReverseProxyPath
3870 But B<NOTE> that L<Plack::Middleware::ReverseProxyPath> is not a dependency of the
3871 L<Catalyst> distribution so if you want to use this option you should add it to
3872 your project distribution file.
3874 These middlewares will be added at L</setup_middleware> during the
3875 L</setup> phase of application startup.
3879 sub default_middleware {
3882 Catalyst::Middleware::Stash->new,
3883 Plack::Middleware::HTTPExceptions->new,
3884 Plack::Middleware::RemoveRedundantBody->new,
3885 Plack::Middleware::FixMissingBodyInRedirect->new,
3886 Plack::Middleware::ContentLength->new,
3887 Plack::Middleware::MethodOverride->new,
3888 Plack::Middleware::Head->new);
3890 if($class->config->{using_frontend_proxy}) {
3891 push @mw, Plack::Middleware::ReverseProxy->new;
3894 if($class->config->{using_frontend_proxy_path}) {
3895 if(Class::Load::try_load_class('Plack::Middleware::ReverseProxyPath')) {
3896 push @mw, Plack::Middleware::ReverseProxyPath->new;
3898 $class->log->error("Cannot use configuration 'using_frontend_proxy_path' because 'Plack::Middleware::ReverseProxyPath' is not installed");
3905 =head2 registered_middlewares
3907 Read only accessor that returns an array of all the middleware in the order
3908 that they were added (which is the REVERSE of the order they will be applied).
3910 The values returned will be either instances of L<Plack::Middleware> or of a
3911 compatible interface, or a coderef, which is assumed to be inlined middleware
3913 =head2 setup_middleware (?@middleware)
3915 Read configuration information stored in configuration key C<psgi_middleware> or
3918 See under L</CONFIGURATION> information regarding C<psgi_middleware> and how
3919 to use it to enable L<Plack::Middleware>
3921 This method is automatically called during 'setup' of your application, so
3922 you really don't need to invoke it. However you may do so if you find the idea
3923 of loading middleware via configuration weird :). For example:
3929 __PACKAGE__->setup_middleware('Head');
3932 When we read middleware definitions from configuration, we reverse the list
3933 which sounds odd but is likely how you expect it to work if you have prior
3934 experience with L<Plack::Builder> or if you previously used the plugin
3935 L<Catalyst::Plugin::EnableMiddleware> (which is now considered deprecated)
3937 So basically your middleware handles an incoming request from the first
3938 registered middleware, down and handles the response from the last middleware
3943 sub registered_middlewares {
3945 if(my $middleware = $class->_psgi_middleware) {
3946 my @mw = ($class->default_middleware, @$middleware);
3948 if($class->config->{using_frontend_proxy}) {
3949 push @mw, Plack::Middleware::ReverseProxy->new;
3954 die "You cannot call ->registered_middlewares until middleware has been setup";
3958 sub setup_middleware {
3960 my @middleware_definitions;
3962 # If someone calls this method you can add middleware with args. However if its
3963 # called without an arg we need to setup the configuration middleware.
3965 @middleware_definitions = reverse(@_);
3967 @middleware_definitions = reverse(@{$class->config->{'psgi_middleware'}||[]})
3968 unless $class->finalized_default_middleware;
3969 $class->finalized_default_middleware(1); # Only do this once, just in case some people call setup over and over...
3972 my @middleware = ();
3973 while(my $next = shift(@middleware_definitions)) {
3975 if(Scalar::Util::blessed $next && $next->can('wrap')) {
3976 push @middleware, $next;
3977 } elsif(ref $next eq 'CODE') {
3978 push @middleware, $next;
3979 } elsif(ref $next eq 'HASH') {
3980 my $namespace = shift @middleware_definitions;
3981 my $mw = $class->Catalyst::Utils::build_middleware($namespace, %$next);
3982 push @middleware, $mw;
3984 die "I can't handle middleware definition ${\ref $next}";
3987 my $mw = $class->Catalyst::Utils::build_middleware($next);
3988 push @middleware, $mw;
3992 my @existing = @{$class->_psgi_middleware || []};
3993 $class->_psgi_middleware([@middleware,@existing,]);
3996 =head2 registered_data_handlers
3998 A read only copy of registered Data Handlers returned as a Hash, where each key
3999 is a content type and each value is a subref that attempts to decode that content
4002 =head2 setup_data_handlers (?@data_handler)
4004 Read configuration information stored in configuration key C<data_handlers> or
4007 See under L</CONFIGURATION> information regarding C<data_handlers>.
4009 This method is automatically called during 'setup' of your application, so
4010 you really don't need to invoke it.
4012 =head2 default_data_handlers
4014 Default Data Handlers that come bundled with L<Catalyst>. Currently there are
4015 only two default data handlers, for 'application/json' and an alternative to
4016 'application/x-www-form-urlencoded' which supposed nested form parameters via
4017 L<CGI::Struct> or via L<CGI::Struct::XS> IF you've installed it.
4019 The 'application/json' data handler is used to parse incoming JSON into a Perl
4020 data structure. It used either L<JSON::MaybeXS> or L<JSON>, depending on which
4021 is installed. This allows you to fail back to L<JSON:PP>, which is a Pure Perl
4022 JSON decoder, and has the smallest dependency impact.
4024 Because we don't wish to add more dependencies to L<Catalyst>, if you wish to
4025 use this new feature we recommend installing L<JSON> or L<JSON::MaybeXS> in
4026 order to get the best performance. You should add either to your dependency
4027 list (Makefile.PL, dist.ini, cpanfile, etc.)
4031 sub registered_data_handlers {
4033 if(my $data_handlers = $class->_data_handlers) {
4034 return %$data_handlers;
4036 $class->setup_data_handlers;
4037 return $class->registered_data_handlers;
4041 sub setup_data_handlers {
4042 my ($class, %data_handler_callbacks) = @_;
4043 %data_handler_callbacks = (
4044 %{$class->default_data_handlers},
4045 %{$class->config->{'data_handlers'}||+{}},
4046 %data_handler_callbacks);
4048 $class->_data_handlers(\%data_handler_callbacks);
4051 sub default_data_handlers {
4054 'application/x-www-form-urlencoded' => sub {
4055 my ($fh, $req) = @_;
4056 my $params = $req->_use_hash_multivalue ? $req->body_parameters->mixed : $req->body_parameters;
4057 Class::Load::load_first_existing_class('CGI::Struct::XS', 'CGI::Struct')
4058 ->can('build_cgi_struct')->($params);
4060 'application/json' => sub {
4061 my ($fh, $req) = @_;
4062 my $parser = Class::Load::load_first_existing_class('JSON::MaybeXS', 'JSON');
4066 $slurped = $fh->getline;
4067 $parser->can("decode_json")->($slurped); # decode_json does utf8 decoding for us
4068 } || Catalyst::Exception->throw(sprintf "Error Parsing POST '%s', Error: %s", (defined($slurped) ? $slurped : 'undef') ,$@);
4073 sub _handle_http_exception {
4074 my ( $self, $error ) = @_;
4076 !$self->config->{always_catch_http_exceptions}
4079 $error->can('as_psgi')
4080 || ( $error->can('code')
4081 && $error->code =~ m/^[1-5][0-9][0-9]$/ )
4091 Returns an arrayref of the internal execution stack (actions that are
4092 currently executing).
4096 Returns the current timing statistics object. By default Catalyst uses
4097 L<Catalyst::Stats|Catalyst::Stats>, but can be set otherwise with
4098 L<< stats_class|/"$c->stats_class" >>.
4100 Even if L<< -Stats|/"-Stats" >> is not enabled, the stats object is still
4101 available. By enabling it with C< $c->stats->enabled(1) >, it can be used to
4102 profile explicitly, although MyApp.pm still won't profile nor output anything
4105 =head2 $c->stats_class
4107 Returns or sets the stats (timing statistics) class. L<Catalyst::Stats|Catalyst::Stats> is used by default.
4109 =head2 $app->stats_class_traits
4111 A arrayref of L<Moose::Role>s that are applied to the stats_class before creating it.
4113 =head2 $app->composed_stats_class
4115 this is the stats_class composed with any 'stats_class_traits'. You can
4116 name the full namespace of the role, or a namespace suffix, which will then
4117 be tried against the following standard namespace prefixes.
4119 $MyApp::TraitFor::Stats::$trait_suffix
4120 Catalyst::TraitFor::Stats::$trait_suffix
4122 So for example if you set:
4124 MyApp->stats_class_traits(['Foo']);
4126 We try each possible role in turn (and throw an error if none load)
4129 MyApp::TraitFor::Stats::Foo
4130 Catalyst::TraitFor::Stats::Foo
4132 The namespace part 'TraitFor::Stats' was chosen to assist in backwards
4133 compatibility with L<CatalystX::RoleApplicator> which previously provided
4134 these features in a stand alone package.
4136 =head2 $c->use_stats
4138 Returns 1 when L<< stats collection|/"-Stats" >> is enabled.
4140 Note that this is a static method, not an accessor and should be overridden
4141 by declaring C<sub use_stats { 1 }> in your MyApp.pm, not by calling C<< $c->use_stats(1) >>.
4148 =head2 $c->write( $data )
4150 Writes $data to the output stream. When using this method directly, you
4151 will need to manually set the C<Content-Length> header to the length of
4152 your output data, if known.
4159 # Finalize headers if someone manually writes output (for compat)
4160 $c->finalize_headers;
4162 return $c->response->write( @_ );
4167 Returns the Catalyst version number. Mostly useful for "powered by"
4168 messages in template systems.
4172 sub version { return $Catalyst::VERSION }
4174 =head1 CONFIGURATION
4176 There are a number of 'base' config variables which can be set:
4182 C<always_catch_http_exceptions> - As of version 5.90060 Catalyst
4183 rethrows errors conforming to the interface described by
4184 L<Plack::Middleware::HTTPExceptions> and lets the middleware deal with it.
4185 Set true to get the deprecated behaviour and have Catalyst catch HTTP exceptions.
4189 C<default_model> - The default model picked if you say C<< $c->model >>. See L<< /$c->model($name) >>.
4193 C<default_view> - The default view to be rendered or returned when C<< $c->view >> is called. See L<< /$c->view($name) >>.
4197 C<disable_component_resolution_regex_fallback> - Turns
4198 off the deprecated component resolution functionality so
4199 that if any of the component methods (e.g. C<< $c->controller('Foo') >>)
4200 are called then regex search will not be attempted on string values and
4201 instead C<undef> will be returned.
4205 C<home> - The application home directory. In an uninstalled application,
4206 this is the top level application directory. In an installed application,
4207 this will be the directory containing C<< MyApp.pm >>.
4211 C<ignore_frontend_proxy> - See L</PROXY SUPPORT>
4215 C<name> - The name of the application in debug messages and the debug and
4220 C<parse_on_demand> - The request body (for example file uploads) will not be parsed
4221 until it is accessed. This allows you to (for example) check authentication (and reject
4222 the upload) before actually receiving all the data. See L</ON-DEMAND PARSER>
4226 C<root> - The root directory for templates. Usually this is just a
4227 subdirectory of the home directory, but you can set it to change the
4228 templates to a different directory.
4232 C<search_extra> - Array reference passed to Module::Pluggable to for additional
4233 namespaces from which components will be loaded (and constructed and stored in
4234 C<< $c->components >>).
4238 C<show_internal_actions> - If true, causes internal actions such as C<< _DISPATCH >>
4239 to be shown in hit debug tables in the test server.
4243 C<use_request_uri_for_path> - Controls if the C<REQUEST_URI> or C<PATH_INFO> environment
4244 variable should be used for determining the request path.
4246 Most web server environments pass the requested path to the application using environment variables,
4247 from which Catalyst has to reconstruct the request base (i.e. the top level path to / in the application,
4248 exposed as C<< $c->request->base >>) and the request path below that base.
4250 There are two methods of doing this, both of which have advantages and disadvantages. Which method is used
4251 is determined by the C<< $c->config(use_request_uri_for_path) >> setting (which can either be true or false).
4255 =item use_request_uri_for_path => 0
4257 This is the default (and the) traditional method that Catalyst has used for determining the path information.
4258 The path is generated from a combination of the C<PATH_INFO> and C<SCRIPT_NAME> environment variables.
4259 The allows the application to behave correctly when C<mod_rewrite> is being used to redirect requests
4260 into the application, as these variables are adjusted by mod_rewrite to take account for the redirect.
4262 However this method has the major disadvantage that it is impossible to correctly decode some elements
4263 of the path, as RFC 3875 says: "C<< Unlike a URI path, the PATH_INFO is not URL-encoded, and cannot
4264 contain path-segment parameters. >>" This means PATH_INFO is B<always> decoded, and therefore Catalyst
4265 can't distinguish / vs %2F in paths (in addition to other encoded values).
4267 =item use_request_uri_for_path => 1
4269 This method uses the C<REQUEST_URI> and C<SCRIPT_NAME> environment variables. As C<REQUEST_URI> is never
4270 decoded, this means that applications using this mode can correctly handle URIs including the %2F character
4271 (i.e. with C<AllowEncodedSlashes> set to C<On> in Apache).
4273 Given that this method of path resolution is provably more correct, it is recommended that you use
4274 this unless you have a specific need to deploy your application in a non-standard environment, and you are
4275 aware of the implications of not being able to handle encoded URI paths correctly.
4277 However it also means that in a number of cases when the app isn't installed directly at a path, but instead
4278 is having paths rewritten into it (e.g. as a .cgi/fcgi in a public_html directory, with mod_rewrite in a
4279 .htaccess file, or when SSI is used to rewrite pages into the app, or when sub-paths of the app are exposed
4280 at other URIs than that which the app is 'normally' based at with C<mod_rewrite>), the resolution of
4281 C<< $c->request->base >> will be incorrect.
4287 C<using_frontend_proxy> - See L</PROXY SUPPORT>.
4291 C<using_frontend_proxy_path> - Enabled L<Plack::Middleware::ReverseProxyPath> on your application (if
4292 installed, otherwise log an error). This is useful if your application is not running on the
4293 'root' (or /) of your host server. B<NOTE> if you use this feature you should add the required
4294 middleware to your project dependency list since its not automatically a dependency of L<Catalyst>.
4295 This has been done since not all people need this feature and we wish to restrict the growth of
4296 L<Catalyst> dependencies.
4300 C<encoding> - See L</ENCODING>
4302 This now defaults to 'UTF-8'. You my turn it off by setting this configuration
4307 C<abort_chain_on_error_fix>
4311 When there is an error in an action chain, the default behavior is to
4312 abort the processing of the remaining actions to avoid running them
4313 when the application is in an unexpected state.
4315 Before version 5.90070, the default used to be false. To keep the old
4316 behaviour, you can explicitely set the value to false. E.g.
4318 __PACKAGE__->config(abort_chain_on_error_fix => 0);
4320 If this setting is set to false, then the remaining actions are
4321 performed and the error is caught at the end of the chain.
4326 C<use_hash_multivalue_in_request>
4328 In L<Catalyst::Request> the methods C<query_parameters>, C<body_parametes>
4329 and C<parameters> return a hashref where values might be scalar or an arrayref
4330 depending on the incoming data. In many cases this can be undesirable as it
4331 leads one to writing defensive code like the following:
4333 my ($val) = ref($c->req->parameters->{a}) ?
4334 @{$c->req->parameters->{a}} :
4335 $c->req->parameters->{a};
4337 Setting this configuration item to true will make L<Catalyst> populate the
4338 attributes underlying these methods with an instance of L<Hash::MultiValue>
4339 which is used by L<Plack::Request> and others to solve this very issue. You
4340 may prefer this behavior to the default, if so enable this option (be warned
4341 if you enable it in a legacy application we are not sure if it is completely
4342 backwardly compatible).
4346 C<skip_complex_post_part_handling>
4348 When creating body parameters from a POST, if we run into a multipart POST
4349 that does not contain uploads, but instead contains inlined complex data
4350 (very uncommon) we cannot reliably convert that into field => value pairs. So
4351 instead we create an instance of L<Catalyst::Request::PartData>. If this causes
4352 issue for you, you can disable this by setting C<skip_complex_post_part_handling>
4353 to true (default is false).
4357 C<skip_body_param_unicode_decoding>
4359 Generally we decode incoming POST params based on your declared encoding (the
4360 default for this is to decode UTF-8). If this is causing you trouble and you
4361 do not wish to turn all encoding support off (with the C<encoding> configuration
4362 parameter) you may disable this step atomically by setting this configuration
4367 C<do_not_decode_query>
4369 If true, then do not try to character decode any wide characters in your
4370 request URL query or keywords. Most readings of the relevant specifications
4371 suggest these should be UTF-* encoded, which is the default that L<Catalyst>
4372 will use, however if you are creating a lot of URLs manually or have external
4373 evil clients, this might cause you trouble. If you find the changes introduced
4374 in Catalyst version 5.90080+ break some of your query code, you may disable
4375 the UTF-8 decoding globally using this configuration.
4377 This setting takes precedence over C<default_query_encoding>
4381 C<do_not_check_query_encoding>
4383 Catalyst versions 5.90080 - 5.90106 would decode query parts of an incoming
4384 request but would not raise an exception when the decoding failed due to
4385 incorrect unicode. It now does, but if this change is giving you trouble
4386 you may disable it by setting this configuration to true.
4390 C<default_query_encoding>
4392 By default we decode query and keywords in your request URL using UTF-8, which
4393 is our reading of the relevant specifications. This setting allows one to
4394 specify a fixed value for how to decode your query. You might need this if
4395 you are doing a lot of custom encoding of your URLs and not using UTF-8.
4399 C<use_chained_args_0_special_case>
4401 In older versions of Catalyst, when more than one action matched the same path
4402 AND all those matching actions declared Args(0), we'd break the tie by choosing
4403 the first action defined. We now normalized how Args(0) works so that it
4404 follows the same rule as Args(N), which is to say when we need to break a tie
4405 we choose the LAST action defined. If this breaks your code and you don't
4406 have time to update to follow the new normalized approach, you may set this
4407 value to true and it will globally revert to the original chaining behavior.
4411 C<psgi_middleware> - See L<PSGI MIDDLEWARE>.
4415 C<data_handlers> - See L<DATA HANDLERS>.
4419 C<stats_class_traits>
4421 An arrayref of L<Moose::Role>s that get composed into your stats class.
4425 C<request_class_traits>
4427 An arrayref of L<Moose::Role>s that get composed into your request class.
4431 C<response_class_traits>
4433 An arrayref of L<Moose::Role>s that get composed into your response class.
4437 C<inject_components>
4439 A Hashref of L<Catalyst::Component> subclasses that are 'injected' into configuration.
4443 inject_components => {
4444 'Controller::Err' => { from_component => 'Local::Controller::Errors' },
4445 'Model::Zoo' => { from_component => 'Local::Model::Foo' },
4446 'Model::Foo' => { from_component => 'Local::Model::Foo', roles => ['TestRole'] },
4448 'Controller::Err' => { a => 100, b=>200, namespace=>'error' },
4449 'Model::Zoo' => { a => 2 },
4450 'Model::Foo' => { a => 100 },
4453 Generally L<Catalyst> looks for components in your Model/View or Controller directories.
4454 However for cases when you which to use an existing component and you don't need any
4455 customization (where for when you can apply a role to customize it) you may inject those
4456 components into your application. Please note any configuration should be done 'in the
4457 normal way', with a key under configuration named after the component affix, as in the
4460 Using this type of injection allows you to construct significant amounts of your application
4461 with only configuration!. This may or may not lead to increased code understanding.
4463 Please not you may also call the ->inject_components application method as well, although
4464 you must do so BEFORE setup.
4470 Generally when you throw an exception inside an Action (or somewhere in
4471 your stack, such as in a model that an Action is calling) that exception
4472 is caught by Catalyst and unless you either catch it yourself (via eval
4473 or something like L<Try::Tiny> or by reviewing the L</error> stack, it
4474 will eventually reach L</finalize_errors> and return either the debugging
4475 error stack page, or the default error page. However, if your exception
4476 can be caught by L<Plack::Middleware::HTTPExceptions>, L<Catalyst> will
4477 instead rethrow it so that it can be handled by that middleware (which
4478 is part of the default middleware). For example this would allow
4480 use HTTP::Throwable::Factory 'http_throw';
4482 sub throws_exception :Local {
4483 my ($self, $c) = @_;
4485 http_throw(SeeOther => { location =>
4486 $c->uri_for($self->action_for('redirect')) });
4490 =head1 INTERNAL ACTIONS
4492 Catalyst uses internal actions like C<_DISPATCH>, C<_BEGIN>, C<_AUTO>,
4493 C<_ACTION>, and C<_END>. These are by default not shown in the private
4494 action table, but you can make them visible with a config parameter.
4496 MyApp->config(show_internal_actions => 1);
4498 =head1 ON-DEMAND PARSER
4500 The request body is usually parsed at the beginning of a request,
4501 but if you want to handle input yourself, you can enable on-demand
4502 parsing with a config parameter.
4504 MyApp->config(parse_on_demand => 1);
4506 =head1 PROXY SUPPORT
4508 Many production servers operate using the common double-server approach,
4509 with a lightweight frontend web server passing requests to a larger
4510 backend server. An application running on the backend server must deal
4511 with two problems: the remote user always appears to be C<127.0.0.1> and
4512 the server's hostname will appear to be C<localhost> regardless of the
4513 virtual host that the user connected through.
4515 Catalyst will automatically detect this situation when you are running
4516 the frontend and backend servers on the same machine. The following
4517 changes are made to the request.
4519 $c->req->address is set to the user's real IP address, as read from
4520 the HTTP X-Forwarded-For header.
4522 The host value for $c->req->base and $c->req->uri is set to the real
4523 host, as read from the HTTP X-Forwarded-Host header.
4525 Additionally, you may be running your backend application on an insecure
4526 connection (port 80) while your frontend proxy is running under SSL. If there
4527 is a discrepancy in the ports, use the HTTP header C<X-Forwarded-Port> to
4528 tell Catalyst what port the frontend listens on. This will allow all URIs to
4529 be created properly.
4531 In the case of passing in:
4533 X-Forwarded-Port: 443
4535 All calls to C<uri_for> will result in an https link, as is expected.
4537 Obviously, your web server must support these headers for this to work.
4539 In a more complex server farm environment where you may have your
4540 frontend proxy server(s) on different machines, you will need to set a
4541 configuration option to tell Catalyst to read the proxied data from the
4544 MyApp->config(using_frontend_proxy => 1);
4546 If you do not wish to use the proxy support at all, you may set:
4548 MyApp->config(ignore_frontend_proxy => 0);
4550 =head2 Note about psgi files
4552 Note that if you supply your own .psgi file, calling
4553 C<< MyApp->psgi_app(@_); >>, then B<this will not happen automatically>.
4555 You either need to apply L<Plack::Middleware::ReverseProxy> yourself
4556 in your psgi, for example:
4559 enable "Plack::Middleware::ReverseProxy";
4563 This will unconditionally add the ReverseProxy support, or you need to call
4564 C<< $app = MyApp->apply_default_middlewares($app) >> (to conditionally
4565 apply the support depending upon your config).
4567 See L<Catalyst::PSGI> for more information.
4569 =head1 THREAD SAFETY
4571 Catalyst has been tested under Apache 2's threading C<mpm_worker>,
4572 C<mpm_winnt>, and the standalone forking HTTP server on Windows. We
4573 believe the Catalyst core to be thread-safe.
4575 If you plan to operate in a threaded environment, remember that all other
4576 modules you are using must also be thread-safe. Some modules, most notably
4577 L<DBD::SQLite>, are not thread-safe.
4579 =head1 DATA HANDLERS
4581 The L<Catalyst::Request> object uses L<HTTP::Body> to populate 'classic' HTML
4582 form parameters and URL search query fields. However it has become common
4583 for various alternative content types to be PUT or POSTed to your controllers
4584 and actions. People working on RESTful APIs, or using AJAX often use JSON,
4585 XML and other content types when communicating with an application server. In
4586 order to better support this use case, L<Catalyst> defines a global configuration
4587 option, C<data_handlers>, which lets you associate a content type with a coderef
4588 that parses that content type into something Perl can readily access.
4595 __PACKAGE__->config(
4597 'application/json' => sub { local $/; decode_json $_->getline },
4599 ## Any other configuration.
4604 By default L<Catalyst> comes with a generic JSON data handler similar to the
4605 example given above, which uses L<JSON::Maybe> to provide either L<JSON::PP>
4606 (a pure Perl, dependency free JSON parser) or L<Cpanel::JSON::XS> if you have
4607 it installed (if you want the faster XS parser, add it to you project Makefile.PL
4608 or dist.ini, cpanfile, etc.)
4610 The C<data_handlers> configuration is a hashref whose keys are HTTP Content-Types
4611 (matched against the incoming request type using a regexp such as to be case
4612 insensitive) and whose values are coderefs that receive a localized version of
4613 C<$_> which is a filehandle object pointing to received body.
4615 This feature is considered an early access release and we reserve the right
4616 to alter the interface in order to provide a performant and secure solution to
4617 alternative request body content. Your reports welcomed!
4619 =head1 PSGI MIDDLEWARE
4621 You can define middleware, defined as L<Plack::Middleware> or a compatible
4622 interface in configuration. Your middleware definitions are in the form of an
4623 arrayref under the configuration key C<psgi_middleware>. Here's an example
4624 with details to follow:
4629 use Plack::Middleware::StackTrace;
4631 my $stacktrace_middleware = Plack::Middleware::StackTrace->new;
4633 __PACKAGE__->config(
4634 'psgi_middleware', [
4637 $stacktrace_middleware,
4638 'Session' => {store => 'File'},
4643 $env->{myapp.customkey} = 'helloworld';
4652 So the general form is:
4654 __PACKAGE__->config(psgi_middleware => \@middleware_definitions);
4656 Where C<@middleware> is one or more of the following, applied in the REVERSE of
4657 the order listed (to make it function similarly to L<Plack::Builder>:
4659 Alternatively, you may also define middleware by calling the L</setup_middleware>
4666 __PACKAGE__->setup_middleware( \@middleware_definitions);
4669 In the case where you do both (use 'setup_middleware' and configuration) the
4670 package call to setup_middleware will be applied earlier (in other words its
4671 middleware will wrap closer to the application). Keep this in mind since in
4672 some cases the order of middleware is important.
4674 The two approaches are not exclusive.
4678 =item Middleware Object
4680 An already initialized object that conforms to the L<Plack::Middleware>
4683 my $stacktrace_middleware = Plack::Middleware::StackTrace->new;
4685 __PACKAGE__->config(
4686 'psgi_middleware', [
4687 $stacktrace_middleware,
4693 A coderef that is an inlined middleware:
4695 __PACKAGE__->config(
4696 'psgi_middleware', [
4701 if($env->{PATH_INFO} =~m/forced/) {
4703 ->new(file=>TestApp->path_to(qw/share static forced.txt/))
4706 return $app->($env);
4716 We assume the scalar refers to a namespace after normalizing it using the
4719 (1) If the scalar is prefixed with a "+" (as in C<+MyApp::Foo>) then the full string
4720 is assumed to be 'as is', and we just install and use the middleware.
4722 (2) If the scalar begins with "Plack::Middleware" or your application namespace
4723 (the package name of your Catalyst application subclass), we also assume then
4724 that it is a full namespace, and use it.
4726 (3) Lastly, we then assume that the scalar is a partial namespace, and attempt to
4727 resolve it first by looking for it under your application namespace (for example
4728 if you application is "MyApp::Web" and the scalar is "MyMiddleware", we'd look
4729 under "MyApp::Web::Middleware::MyMiddleware") and if we don't find it there, we
4730 will then look under the regular L<Plack::Middleware> namespace (i.e. for the
4731 previous we'd try "Plack::Middleware::MyMiddleware"). We look under your application
4732 namespace first to let you 'override' common L<Plack::Middleware> locally, should
4733 you find that a good idea.
4739 __PACKAGE__->config(
4740 'psgi_middleware', [
4741 'Debug', ## MyAppWeb::Middleware::Debug->wrap or Plack::Middleware::Debug->wrap
4742 'Plack::Middleware::Stacktrace', ## Plack::Middleware::Stacktrace->wrap
4743 '+MyApp::Custom', ## MyApp::Custom->wrap
4747 =item a scalar followed by a hashref
4749 Just like the previous, except the following C<HashRef> is used as arguments
4750 to initialize the middleware object.
4752 __PACKAGE__->config(
4753 'psgi_middleware', [
4754 'Session' => {store => 'File'},
4759 Please see L<PSGI> for more on middleware.
4763 Starting in L<Catalyst> version 5.90080 encoding is automatically enabled
4764 and set to encode all body responses to UTF8 when possible and applicable.
4765 Following is documentation on this process. If you are using an older
4766 version of L<Catalyst> you should review documentation for that version since
4769 By default encoding is now 'UTF-8'. You may turn it off by setting
4770 the encoding configuration to undef.
4772 MyApp->config(encoding => undef);
4774 This is recommended for temporary backwards compatibility only.
4776 To turn it off for a single request use the L<clear_encoding>
4777 method to turn off encoding for this request. This can be useful
4778 when you are setting the body to be an arbitrary block of bytes,
4779 especially if that block happens to be a block of UTF8 text.
4781 Encoding is automatically applied when the content-type is set to
4782 a type that can be encoded. Currently we encode when the content type
4783 matches the following regular expression:
4785 $content_type =~ /^text|xml$|javascript$/
4787 Encoding is set on the application, but it is copied to the context object
4788 so that you can override it on a request basis.
4790 Be default we don't automatically encode 'application/json' since the most
4791 common approaches to generating this type of response (Either via L<Catalyst::View::JSON>
4792 or L<Catalyst::Action::REST>) will do so already and we want to avoid double
4795 If you are producing JSON response in an unconventional manner (such
4796 as via a template or manual strings) you should perform the UTF8 encoding
4797 manually as well such as to conform to the JSON specification.
4799 NOTE: We also examine the value of $c->response->content_encoding. If
4800 you set this (like for example 'gzip', and manually gzipping the body)
4801 we assume that you have done all the necessary encoding yourself, since
4802 we cannot encode the gzipped contents. If you use a plugin like
4803 L<Catalyst::Plugin::Compress> you need to update to a modern version in order
4804 to have this function correctly with the new UTF8 encoding code, or you
4805 can use L<Plack::Middleware::Deflater> or (probably best) do your compression on
4814 Returns an instance of an C<Encode> encoding
4816 print $c->encoding->name
4818 =item handle_unicode_encoding_exception ($exception_context)
4820 Method called when decoding process for a request fails.
4822 An C<$exception_context> hashref is provided to allow you to override the
4823 behaviour of your application when given data with incorrect encodings.
4825 The default method throws exceptions in the case of invalid request parameters
4826 (resulting in a 500 error), but ignores errors in upload filenames.
4828 The keys passed in the C<$exception_context> hash are:
4834 The value which was not able to be decoded.
4838 The exception received from L<Encode>.
4842 What type of data was being decoded. Valid values are (currently)
4843 C<params> - for request parameters / arguments / captures
4844 and C<uploads> - for request upload filenames.
4854 Join #catalyst on irc.perl.org.
4858 http://lists.scsys.co.uk/cgi-bin/mailman/listinfo/catalyst
4859 http://lists.scsys.co.uk/cgi-bin/mailman/listinfo/catalyst-dev
4863 http://catalyst.perl.org
4867 http://dev.catalyst.perl.org
4871 =head2 L<Task::Catalyst> - All you need to start with Catalyst
4873 =head2 L<Catalyst::Manual> - The Catalyst Manual
4875 =head2 L<Catalyst::Component>, L<Catalyst::Controller> - Base classes for components
4877 =head2 L<Catalyst::Engine> - Core engine
4879 =head2 L<Catalyst::Log> - Log class.
4881 =head2 L<Catalyst::Request> - Request object
4883 =head2 L<Catalyst::Response> - Response object
4885 =head2 L<Catalyst::Test> - The test suite.
4887 =head1 PROJECT FOUNDER
4889 sri: Sebastian Riedel <sri@cpan.org>
4895 acme: Leon Brocard <leon@astray.com>
4897 abraxxa: Alexander Hartmaier <abraxxa@cpan.org>
4899 andrewalker: André Walker <andre@cpan.org>
4903 Andrew Ford <A.Ford@ford-mason.co.uk>
4907 andyg: Andy Grundman <andy@hybridized.org>
4909 audreyt: Audrey Tang
4911 bricas: Brian Cassidy <bricas@cpan.org>
4913 Caelum: Rafael Kitover <rkitover@io.com>
4915 chansen: Christian Hansen
4917 Chase Venters C<chase.venters@gmail.com>
4919 chicks: Christopher Hicks
4921 Chisel Wright C<pause@herlpacker.co.uk>
4923 Danijel Milicevic C<me@danijel.de>
4925 davewood: David Schmidt <davewood@cpan.org>
4927 David Kamholz <dkamholz@cpan.org>
4929 David Naughton, C<naughton@umn.edu>
4933 dhoss: Devin Austin <dhoss@cpan.org>
4935 dkubb: Dan Kubb <dan.kubb-cpan@onautopilot.com>
4939 dwc: Daniel Westermann-Clark <danieltwc@cpan.org>
4941 esskar: Sascha Kiefer
4943 fireartist: Carl Franks <cfranks@cpan.org>
4945 frew: Arthur Axel "fREW" Schmidt <frioux@gmail.com>
4947 gabb: Danijel Milicevic
4951 Gavin Henry C<ghenry@perl.me.uk>
4955 groditi: Guillermo Roditi <groditi@gmail.com>
4957 hobbs: Andrew Rodland <andrew@cleverdomain.org>
4959 ilmari: Dagfinn Ilmari Mannsåker <ilmari@ilmari.org>
4961 jcamacho: Juan Camacho
4963 jester: Jesse Sheidlower C<jester@panix.com>
4965 jhannah: Jay Hannah <jay@jays.net>
4971 jon: Jon Schutz <jjschutz@cpan.org>
4973 Jonathan Rockway C<< <jrockway@cpan.org> >>
4975 Kieren Diment C<kd@totaldatasolution.com>
4977 konobi: Scott McWhirter <konobi@cpan.org>
4979 marcus: Marcus Ramberg <mramberg@cpan.org>
4981 miyagawa: Tatsuhiko Miyagawa <miyagawa@bulknews.net>
4983 mgrimes: Mark Grimes <mgrimes@cpan.org>
4985 mst: Matt S. Trout <mst@shadowcatsystems.co.uk>
4989 naughton: David Naughton
4991 ningu: David Kamholz <dkamholz@cpan.org>
4993 nothingmuch: Yuval Kogman <nothingmuch@woobling.org>
4995 numa: Dan Sully <daniel@cpan.org>
5001 omega: Andreas Marienborg
5003 Oleg Kostyuk <cub.uanic@gmail.com>
5005 phaylon: Robert Sedlacek <phaylon@dunkelheit.at>
5007 rafl: Florian Ragwitz <rafl@debian.org>
5009 random: Roland Lammel <lammel@cpan.org>
5011 Robert Sedlacek C<< <rs@474.at> >>
5013 SpiceMan: Marcel Montes
5017 szbalint: Balint Szilakszi <szbalint@cpan.org>
5019 t0m: Tomas Doran <bobtfish@bobtfish.net>
5023 vanstyn: Henry Van Styn <vanstyn@cpan.org>
5025 Viljo Marrandi C<vilts@yahoo.com>
5027 Will Hawes C<info@whawes.co.uk>
5029 willert: Sebastian Willert <willert@cpan.org>
5031 wreis: Wallace Reis <wreis@cpan.org>
5033 Yuval Kogman, C<nothingmuch@woobling.org>
5035 rainboxx: Matthias Dietrich, C<perl@rainboxx.de>
5037 dd070: Dhaval Dhanani <dhaval070@gmail.com>
5039 Upasana <me@upasana.me>
5041 John Napiorkowski (jnap) <jjnapiork@cpan.org>
5045 Copyright (c) 2005-2015, the above named PROJECT FOUNDER and CONTRIBUTORS.
5049 This library is free software. You can redistribute it and/or modify it under
5050 the same terms as Perl itself.
5056 __PACKAGE__->meta->make_immutable;