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::Util 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);
71 predicate => 'has_request',
74 sub _build_request_constructor_args {
76 my %p = ( _log => $self->log );
77 $p{_uploadtmp} = $self->_uploadtmp if $self->_has_uploadtmp;
78 $p{data_handlers} = {$self->registered_data_handlers};
79 $p{_use_hash_multivalue} = $self->config->{use_hash_multivalue_in_request}
80 if $self->config->{use_hash_multivalue_in_request};
84 sub composed_request_class {
86 return $class->_composed_request_class if $class->_composed_request_class;
88 my @traits = (@{$class->request_class_traits||[]}, @{$class->config->{request_class_traits}||[]});
90 # For each trait listed, figure out what the namespace is. First we try the $trait
91 # as it is in the config. Then try $MyApp::TraitFor::Request:$trait. Last we try
92 # Catalyst::TraitFor::Request::$trait. If none load, throw error.
94 my $trait_ns = 'TraitFor::Request';
95 my @normalized_traits = map {
96 Class::Load::load_first_existing_class($_, $class.'::'.$trait_ns.'::'. $_, 'Catalyst::'.$trait_ns.'::'.$_)
99 if ($class->debug && scalar(@normalized_traits)) {
100 my $column_width = Catalyst::Utils::term_width() - 6;
101 my $t = Text::SimpleTable->new($column_width);
102 $t->row($_) for @normalized_traits;
103 $class->log->debug( "Composed Request Class Traits:\n" . $t->draw . "\n" );
106 return $class->_composed_request_class(Moose::Util::with_traits($class->request_class, @normalized_traits));
113 my $class = ref $self;
114 my $composed_response_class = $class->composed_response_class;
115 return $composed_response_class->new( $self->_build_response_constructor_args);
117 predicate=>'has_response',
120 sub _build_response_constructor_args {
123 encoding => $_[0]->encoding,
127 sub composed_response_class {
129 return $class->_composed_response_class if $class->_composed_response_class;
131 my @traits = (@{$class->response_class_traits||[]}, @{$class->config->{response_class_traits}||[]});
133 my $trait_ns = 'TraitFor::Response';
134 my @normalized_traits = map {
135 Class::Load::load_first_existing_class($_, $class.'::'.$trait_ns.'::'. $_, 'Catalyst::'.$trait_ns.'::'.$_)
138 if ($class->debug && scalar(@normalized_traits)) {
139 my $column_width = Catalyst::Utils::term_width() - 6;
140 my $t = Text::SimpleTable->new($column_width);
141 $t->row($_) for @normalized_traits;
142 $class->log->debug( "Composed Response Class Traits:\n" . $t->draw . "\n" );
145 return $class->_composed_response_class(Moose::Util::with_traits($class->response_class, @normalized_traits));
148 has namespace => (is => 'rw');
150 sub depth { scalar @{ shift->stack || [] }; }
151 sub comp { shift->component(@_) }
154 my $self = shift; return $self->request(@_);
157 my $self = shift; return $self->response(@_);
160 # For backwards compatibility
161 sub finalize_output { shift->finalize_body(@_) };
166 our $RECURSION = 1000;
167 our $DETACH = Catalyst::Exception::Detach->new;
168 our $GO = Catalyst::Exception::Go->new;
170 #I imagine that very few of these really
171 #need to be class variables. if any.
172 #maybe we should just make them attributes with a default?
173 __PACKAGE__->mk_classdata($_)
174 for qw/components arguments dispatcher engine log dispatcher_class
175 engine_loader context_class request_class response_class stats_class
176 setup_finished _psgi_app loading_psgi_file run_options _psgi_middleware
177 _data_handlers _encoding _encode_check finalized_default_middleware
178 request_class_traits response_class_traits stats_class_traits
179 _composed_request_class _composed_response_class _composed_stats_class/;
181 __PACKAGE__->dispatcher_class('Catalyst::Dispatcher');
182 __PACKAGE__->request_class('Catalyst::Request');
183 __PACKAGE__->response_class('Catalyst::Response');
184 __PACKAGE__->stats_class('Catalyst::Stats');
186 sub composed_stats_class {
188 return $class->_composed_stats_class if $class->_composed_stats_class;
190 my @traits = (@{$class->stats_class_traits||[]}, @{$class->config->{stats_class_traits}||[]});
192 my $trait_ns = 'TraitFor::Stats';
193 my @normalized_traits = map {
194 Class::Load::load_first_existing_class($_, $class.'::'.$trait_ns.'::'. $_, 'Catalyst::'.$trait_ns.'::'.$_)
197 if ($class->debug && scalar(@normalized_traits)) {
198 my $column_width = Catalyst::Utils::term_width() - 6;
199 my $t = Text::SimpleTable->new($column_width);
200 $t->row($_) for @normalized_traits;
201 $class->log->debug( "Composed Stats Class Traits:\n" . $t->draw . "\n" );
204 return $class->_composed_stats_class(Moose::Util::with_traits($class->stats_class, @normalized_traits));
207 __PACKAGE__->_encode_check(Encode::FB_CROAK | Encode::LEAVE_SRC);
209 # Remember to update this in Catalyst::Runtime as well!
210 our $VERSION = '5.90126';
211 $VERSION = eval $VERSION if $VERSION =~ /_/; # numify for warning-free dev releases
214 my ( $class, @arguments ) = @_;
216 # We have to limit $class to Catalyst to avoid pushing Catalyst upon every
218 return unless $class eq 'Catalyst';
220 my $caller = caller();
221 return if $caller eq 'main';
223 my $meta = Moose::Meta::Class->initialize($caller);
224 unless ( $caller->isa('Catalyst') ) {
225 my @superclasses = ($meta->superclasses, $class, 'Catalyst::Controller');
226 $meta->superclasses(@superclasses);
228 # Avoid possible C3 issues if 'Moose::Object' is already on RHS of MyApp
229 $meta->superclasses(grep { $_ ne 'Moose::Object' } $meta->superclasses);
231 unless( $meta->has_method('meta') ){
232 if ($Moose::VERSION >= 1.15) {
233 $meta->_add_meta_method('meta');
236 $meta->add_method(meta => sub { Moose::Meta::Class->initialize("${caller}") } );
240 $caller->arguments( [@arguments] );
244 sub _application { $_[0] }
250 Catalyst - The Elegant MVC Web Application Framework
254 See the L<Catalyst::Manual> distribution for comprehensive
255 documentation and tutorials.
257 # Install Catalyst::Devel for helpers and other development tools
258 # use the helper to create a new application
261 # add models, views, controllers
262 script/myapp_create.pl model MyDatabase DBIC::Schema create=static dbi:SQLite:/path/to/db
263 script/myapp_create.pl view MyTemplate TT
264 script/myapp_create.pl controller Search
266 # built in testserver -- use -r to restart automatically on changes
267 # --help to see all available options
268 script/myapp_server.pl
270 # command line testing interface
271 script/myapp_test.pl /yada
274 use Catalyst qw/-Debug/; # include plugins here as well
276 ### In lib/MyApp/Controller/Root.pm (autocreated)
277 sub foo : Chained('/') Args() { # called for /foo, /foo/1, /foo/1/2, etc.
278 my ( $self, $c, @args ) = @_; # args are qw/1 2/ for /foo/1/2
279 $c->stash->{template} = 'foo.tt'; # set the template
280 # lookup something from db -- stash vars are passed to TT
282 $c->model('Database::Foo')->search( { country => $args[0] } );
283 if ( $c->req->params->{bar} ) { # access GET or POST parameters
284 $c->forward( 'bar' ); # process another action
285 # do something else after forward returns
289 # The foo.tt TT template can use the stash data from the database
290 [% WHILE (item = data.next) %]
294 # called for /bar/of/soap, /bar/of/soap/10, etc.
295 sub bar : Chained('/') PathPart('/bar/of/soap') Args() { ... }
297 # called after all actions are finished
299 my ( $self, $c ) = @_;
300 if ( scalar @{ $c->error } ) { ... } # handle errors
301 return if $c->res->body; # already have a response
302 $c->forward( 'MyApp::View::TT' ); # render template
305 See L<Catalyst::Manual::Intro> for additional information.
309 Catalyst is a modern framework for making web applications without the
310 pain usually associated with this process. This document is a reference
311 to the main Catalyst application. If you are a new user, we suggest you
312 start with L<Catalyst::Manual::Tutorial> or L<Catalyst::Manual::Intro>.
314 See L<Catalyst::Manual> for more documentation.
316 Catalyst plugins can be loaded by naming them as arguments to the "use
317 Catalyst" statement. Omit the C<Catalyst::Plugin::> prefix from the
318 plugin name, i.e., C<Catalyst::Plugin::My::Module> becomes
321 use Catalyst qw/My::Module/;
323 If your plugin starts with a name other than C<Catalyst::Plugin::>, you can
324 fully qualify the name by using a unary plus:
328 +Fully::Qualified::Plugin::Name
331 Special flags like C<-Debug> can also be specified as
332 arguments when Catalyst is loaded:
334 use Catalyst qw/-Debug My::Module/;
336 The position of plugins and flags in the chain is important, because
337 they are loaded in the order in which they appear.
339 The following flags are supported:
343 Enables debug output. You can also force this setting from the system
344 environment with CATALYST_DEBUG or <MYAPP>_DEBUG. The environment
345 settings override the application, with <MYAPP>_DEBUG having the highest
348 This sets the log level to 'debug' and enables full debug output on the
349 error screen. If you only want the latter, see L<< $c->debug >>.
353 Forces Catalyst to use a specific home directory, e.g.:
355 use Catalyst qw[-Home=/usr/mst];
357 This can also be done in the shell environment by setting either the
358 C<CATALYST_HOME> environment variable or C<MYAPP_HOME>; where C<MYAPP>
359 is replaced with the uppercased name of your application, any "::" in
360 the name will be replaced with underscores, e.g. MyApp::Web should use
361 MYAPP_WEB_HOME. If both variables are set, the MYAPP_HOME one will be used.
363 If none of these are set, Catalyst will attempt to automatically detect the
364 home directory. If you are working in a development environment, Catalyst
365 will try and find the directory containing either Makefile.PL, Build.PL,
366 dist.ini, or cpanfile. If the application has been installed into the system
367 (i.e. you have done C<make install>), then Catalyst will use the path to your
368 application module, without the .pm extension (e.g., /foo/MyApp if your
369 application was installed at /foo/MyApp.pm)
373 use Catalyst '-Log=warn,fatal,error';
375 Specifies a comma-delimited list of log levels.
379 Enables statistics collection and reporting.
381 use Catalyst qw/-Stats=1/;
383 You can also force this setting from the system environment with CATALYST_STATS
384 or <MYAPP>_STATS. The environment settings override the application, with
385 <MYAPP>_STATS having the highest priority.
387 Stats are also enabled if L<< debugging |/"-Debug" >> is enabled.
391 =head2 INFORMATION ABOUT THE CURRENT REQUEST
395 Returns a L<Catalyst::Action> object for the current action, which
396 stringifies to the action name. See L<Catalyst::Action>.
400 Returns the namespace of the current action, i.e., the URI prefix
401 corresponding to the controller of the current action. For example:
403 # in Controller::Foo::Bar
404 $c->namespace; # returns 'foo/bar';
410 Returns the current L<Catalyst::Request> object, giving access to
411 information about the current client request (including parameters,
412 cookies, HTTP headers, etc.). See L<Catalyst::Request>.
414 There is a predicate method C<has_request> that returns true if the
415 request object has been created. This is something you might need to
416 check if you are writing plugins that run before a request is finalized.
418 =head2 REQUEST FLOW HANDLING
420 =head2 $c->forward( $action [, \@arguments ] )
422 =head2 $c->forward( $class, $method, [, \@arguments ] )
424 This is one way of calling another action (method) in the same or
425 a different controller. You can also use C<< $self->my_method($c, @args) >>
426 in the same controller or C<< $c->controller('MyController')->my_method($c, @args) >>
427 in a different controller.
428 The main difference is that 'forward' uses some of the Catalyst request
429 cycle overhead, including debugging, which may be useful to you. On the
430 other hand, there are some complications to using 'forward', restrictions
431 on values returned from 'forward', and it may not handle errors as you prefer.
432 Whether you use 'forward' or not is up to you; it is not considered superior to
433 the other ways to call a method.
435 'forward' calls another action, by its private name. If you give a
436 class name but no method, C<process()> is called. You may also optionally
437 pass arguments in an arrayref. The action will receive the arguments in
438 C<@_> and C<< $c->req->args >>. Upon returning from the function,
439 C<< $c->req->args >> will be restored to the previous values.
441 Any data C<return>ed from the action forwarded to, will be returned by the
444 my $foodata = $c->forward('/foo');
445 $c->forward('index');
446 $c->forward(qw/Model::DBIC::Foo do_stuff/);
447 $c->forward('View::TT');
449 Note that L<< forward|/"$c->forward( $action [, \@arguments ] )" >> implies
450 an C<< eval { } >> around the call (actually
451 L<< execute|/"$c->execute( $class, $coderef )" >> does), thus rendering all
452 exceptions thrown by the called action non-fatal and pushing them onto
453 $c->error instead. If you want C<die> to propagate you need to do something
457 die join "\n", @{ $c->error } if @{ $c->error };
459 Or make sure to always return true values from your actions and write
462 $c->forward('foo') || return;
464 Another note is that C<< $c->forward >> always returns a scalar because it
465 actually returns $c->state which operates in a scalar context.
466 Thus, something like:
470 in an action that is forwarded to is going to return a scalar,
471 i.e. how many items are in that array, which is probably not what you want.
472 If you need to return an array then return a reference to it,
475 $c->stash->{array} = \@array;
477 and access it from the stash.
479 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.
483 sub forward { my $c = shift; no warnings 'recursion'; $c->dispatcher->forward( $c, @_ ) }
485 =head2 $c->detach( $action [, \@arguments ] )
487 =head2 $c->detach( $class, $method, [, \@arguments ] )
491 The same as L<< forward|/"$c->forward( $action [, \@arguments ] )" >>, but
492 doesn't return to the previous action when processing is finished.
494 When called with no arguments it escapes the processing chain entirely.
498 sub detach { my $c = shift; $c->dispatcher->detach( $c, @_ ) }
500 =head2 $c->visit( $action [, \@arguments ] )
502 =head2 $c->visit( $action [, \@captures, \@arguments ] )
504 =head2 $c->visit( $class, $method, [, \@arguments ] )
506 =head2 $c->visit( $class, $method, [, \@captures, \@arguments ] )
508 Almost the same as L<< forward|/"$c->forward( $action [, \@arguments ] )" >>,
509 but does a full dispatch, instead of just calling the new C<$action> /
510 C<< $class->$method >>. This means that C<begin>, C<auto> and the method
511 you go to are called, just like a new request.
513 In addition both C<< $c->action >> and C<< $c->namespace >> are localized.
514 This means, for example, that C<< $c->action >> methods such as
515 L<name|Catalyst::Action/name>, L<class|Catalyst::Action/class> and
516 L<reverse|Catalyst::Action/reverse> return information for the visited action
517 when they are invoked within the visited action. This is different from the
518 behavior of L<< forward|/"$c->forward( $action [, \@arguments ] )" >>, which
519 continues to use the $c->action object from the caller action even when
520 invoked from the called action.
522 C<< $c->stash >> is kept unchanged.
524 In effect, L<< visit|/"$c->visit( $action [, \@captures, \@arguments ] )" >>
525 allows you to "wrap" another action, just as it would have been called by
526 dispatching from a URL, while the analogous
527 L<< go|/"$c->go( $action [, \@captures, \@arguments ] )" >> allows you to
528 transfer control to another action as if it had been reached directly from a URL.
532 sub visit { my $c = shift; $c->dispatcher->visit( $c, @_ ) }
534 =head2 $c->go( $action [, \@arguments ] )
536 =head2 $c->go( $action [, \@captures, \@arguments ] )
538 =head2 $c->go( $class, $method, [, \@arguments ] )
540 =head2 $c->go( $class, $method, [, \@captures, \@arguments ] )
542 The relationship between C<go> and
543 L<< visit|/"$c->visit( $action [, \@captures, \@arguments ] )" >> is the same as
544 the relationship between
545 L<< forward|/"$c->forward( $class, $method, [, \@arguments ] )" >> and
546 L<< detach|/"$c->detach( $action [, \@arguments ] )" >>. Like C<< $c->visit >>,
547 C<< $c->go >> will perform a full dispatch on the specified action or method,
548 with localized C<< $c->action >> and C<< $c->namespace >>. Like C<detach>,
549 C<go> escapes the processing of the current request chain on completion, and
550 does not return to its caller.
552 @arguments are arguments to the final destination of $action. @captures are
553 arguments to the intermediate steps, if any, on the way to the final sub of
558 sub go { my $c = shift; $c->dispatcher->go( $c, @_ ) }
564 Returns the current L<Catalyst::Response> object, see there for details.
566 There is a predicate method C<has_response> that returns true if the
567 request object has been created. This is something you might need to
568 check if you are writing plugins that run before a request is finalized.
572 Returns a hashref to the stash, which may be used to store data and pass
573 it between components during a request. You can also set hash keys by
574 passing arguments. The stash is automatically sent to the view. The
575 stash is cleared at the end of a request; it cannot be used for
576 persistent storage (for this you must use a session; see
577 L<Catalyst::Plugin::Session> for a complete system integrated with
580 $c->stash->{foo} = $bar;
581 $c->stash( { moose => 'majestic', qux => 0 } );
582 $c->stash( bar => 1, gorch => 2 ); # equivalent to passing a hashref
584 # stash is automatically passed to the view for use in a template
585 $c->forward( 'MyApp::View::TT' );
587 The stash hash is currently stored in the PSGI C<$env> and is managed by
588 L<Catalyst::Middleware::Stash>. Since it's part of the C<$env> items in
589 the stash can be accessed in sub applications mounted under your main
590 L<Catalyst> application. For example if you delegate the response of an
591 action to another L<Catalyst> application, that sub application will have
592 access to all the stash keys of the main one, and if can of course add
593 more keys of its own. However those new keys will not 'bubble' back up
594 to the main application.
596 For more information the best thing to do is to review the test case:
597 t/middleware-stash.t in the distribution /t directory.
603 $c->log->error("You are requesting the stash but you don't have a context") unless blessed $c;
604 return Catalyst::Middleware::Stash::get_stash($c->req->env)->(@_);
609 =head2 $c->error($error, ...)
611 =head2 $c->error($arrayref)
613 Returns an arrayref containing error messages. If Catalyst encounters an
614 error while processing a request, it stores the error in $c->error. This
615 method should only be used to store fatal error messages.
617 my @error = @{ $c->error };
621 $c->error('Something bad happened');
623 Calling this will always return an arrayref (if there are no errors it
624 will be an empty arrayref.
631 my $error = ref $_[0] eq 'ARRAY' ? $_[0] : [@_];
632 croak @$error unless ref $c;
633 push @{ $c->{error} }, @$error;
635 elsif ( defined $_[0] ) { $c->{error} = undef }
636 return $c->{error} || [];
641 Contains the return value of the last executed action.
642 Note that << $c->state >> operates in a scalar context which means that all
643 values it returns are scalar.
645 Please note that if an action throws an exception, the value of state
646 should no longer be considered the return if the last action. It is generally
647 going to be 0, which indicates an error state. Examine $c->error for error
650 =head2 $c->clear_errors
652 Clear errors. You probably don't want to clear the errors unless you are
653 implementing a custom error screen.
655 This is equivalent to running
666 =head2 $c->has_errors
668 Returns true if you have errors
672 sub has_errors { scalar(@{shift->error}) ? 1:0 }
674 =head2 $c->last_error
676 Returns the most recent error in the stack (the one most recently added...)
677 or nothing if there are no errors. This does not modify the contents of the
683 my (@errs) = @{shift->error};
684 return scalar(@errs) ? $errs[-1]: undef;
689 shifts the most recently added error off the error stack and returns it. Returns
690 nothing if there are no more errors.
696 my @errors = @{$self->error};
697 my $err = shift(@errors);
698 $self->{error} = \@errors;
704 pops the most recently added error off the error stack and returns it. Returns
705 nothing if there are no more errors.
711 my @errors = @{$self->error};
712 my $err = pop(@errors);
713 $self->{error} = \@errors;
717 sub _comp_search_prefixes {
719 return map $c->components->{ $_ }, $c->_comp_names_search_prefixes(@_);
722 # search components given a name and some prefixes
723 sub _comp_names_search_prefixes {
724 my ( $c, $name, @prefixes ) = @_;
725 my $appclass = ref $c || $c;
726 my $filter = "^${appclass}::(" . join( '|', @prefixes ) . ')::';
727 $filter = qr/$filter/; # Compile regex now rather than once per loop
729 # map the original component name to the sub part that we will search against
730 my %eligible = map { my $n = $_; $n =~ s{^$appclass\::[^:]+::}{}; $_ => $n; }
731 grep { /$filter/ } keys %{ $c->components };
733 # undef for a name will return all
734 return keys %eligible if !defined $name;
736 my $query = $name->$_isa('Regexp') ? $name : qr/^$name$/i;
737 my @result = grep { $eligible{$_} =~ m{$query} } keys %eligible;
739 return @result if @result;
741 # if we were given a regexp to search against, we're done.
742 return if $name->$_isa('Regexp');
744 # skip regexp fallback if configured
746 if $appclass->config->{disable_component_resolution_regex_fallback};
750 @result = grep { $eligible{ $_ } =~ m{$query} } keys %eligible;
752 # no results? try against full names
754 @result = grep { m{$query} } keys %eligible;
757 # don't warn if we didn't find any results, it just might not exist
759 # Disgusting hack to work out correct method name
760 my $warn_for = lc $prefixes[0];
761 my $msg = "Used regexp fallback for \$c->${warn_for}('${name}'), which found '" .
762 (join '", "', @result) . "'. Relying on regexp fallback behavior for " .
763 "component resolution is unreliable and unsafe.";
764 my $short = $result[0];
765 # remove the component namespace prefix
766 $short =~ s/.*?(Model|Controller|View):://;
767 my $shortmess = Carp::shortmess('');
768 if ($shortmess =~ m#Catalyst/Plugin#) {
769 $msg .= " You probably need to set '$short' instead of '${name}' in this " .
771 } elsif ($shortmess =~ m#Catalyst/lib/(View|Controller)#) {
772 $msg .= " You probably need to set '$short' instead of '${name}' in this " .
773 "component's config";
775 $msg .= " You probably meant \$c->${warn_for}('$short') instead of \$c->${warn_for}('${name}'), " .
776 "but if you really wanted to search, pass in a regexp as the argument " .
777 "like so: \$c->${warn_for}(qr/${name}/)";
779 $c->log->warn( "${msg}$shortmess" );
785 # Find possible names for a prefix
787 my ( $c, @prefixes ) = @_;
788 my $appclass = ref $c || $c;
790 my $filter = "^${appclass}::(" . join( '|', @prefixes ) . ')::';
792 my @names = map { s{$filter}{}; $_; }
793 $c->_comp_names_search_prefixes( undef, @prefixes );
798 # Filter a component before returning by calling ACCEPT_CONTEXT if available
800 sub _filter_component {
801 my ( $c, $comp, @args ) = @_;
803 if(ref $comp eq 'CODE') {
807 if ( eval { $comp->can('ACCEPT_CONTEXT'); } ) {
808 return $comp->ACCEPT_CONTEXT( $c, @args );
811 $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;
816 =head2 COMPONENT ACCESSORS
818 =head2 $c->controller($name)
820 Gets a L<Catalyst::Controller> instance by name.
822 $c->controller('Foo')->do_stuff;
824 If the name is omitted, will return the controller for the dispatched
827 If you want to search for controllers, pass in a regexp as the argument.
829 # find all controllers that start with Foo
830 my @foo_controllers = $c->controller(qr{^Foo});
836 my ( $c, $name, @args ) = @_;
838 my $appclass = ref($c) || $c;
840 unless ( $name->$_isa('Regexp') ) { # Direct component hash lookup to avoid costly regexps
841 my $comps = $c->components;
842 my $check = $appclass."::Controller::".$name;
843 return $c->_filter_component( $comps->{$check}, @args ) if exists $comps->{$check};
844 foreach my $path (@{$appclass->config->{ setup_components }->{ search_extra }}) {
845 next unless $path =~ /.*::Controller/;
846 $check = $path."::".$name;
847 return $c->_filter_component( $comps->{$check}, @args ) if exists $comps->{$check};
850 my @result = $c->_comp_search_prefixes( $name, qw/Controller C/ );
851 return map { $c->_filter_component( $_, @args ) } @result if ref $name;
852 return $c->_filter_component( $result[ 0 ], @args );
855 return $c->component( $c->action->class );
858 =head2 $c->model($name)
860 Gets a L<Catalyst::Model> instance by name.
862 $c->model('Foo')->do_stuff;
864 Any extra arguments are directly passed to ACCEPT_CONTEXT, if the model
865 defines ACCEPT_CONTEXT. If it does not, the args are discarded.
867 If the name is omitted, it will look for
868 - a model object in $c->stash->{current_model_instance}, then
869 - a model name in $c->stash->{current_model}, then
870 - a config setting 'default_model', or
871 - check if there is only one model, and return it if that's the case.
873 If you want to search for models, pass in a regexp as the argument.
875 # find all models that start with Foo
876 my @foo_models = $c->model(qr{^Foo});
881 my ( $c, $name, @args ) = @_;
882 my $appclass = ref($c) || $c;
884 unless ( $name->$_isa('Regexp') ) { # Direct component hash lookup to avoid costly regexps
885 my $comps = $c->components;
886 my $check = $appclass."::Model::".$name;
887 return $c->_filter_component( $comps->{$check}, @args ) if exists $comps->{$check};
888 foreach my $path (@{$appclass->config->{ setup_components }->{ search_extra }}) {
889 next unless $path =~ /.*::Model/;
890 $check = $path."::".$name;
891 return $c->_filter_component( $comps->{$check}, @args ) if exists $comps->{$check};
894 my @result = $c->_comp_search_prefixes( $name, qw/Model M/ );
895 return map { $c->_filter_component( $_, @args ) } @result if ref $name;
896 return $c->_filter_component( $result[ 0 ], @args );
900 return $c->stash->{current_model_instance}
901 if $c->stash->{current_model_instance};
902 return $c->model( $c->stash->{current_model} )
903 if $c->stash->{current_model};
905 return $c->model( $appclass->config->{default_model} )
906 if $appclass->config->{default_model};
908 my( $comp, $rest ) = $c->_comp_search_prefixes( undef, qw/Model M/);
911 $c->log->warn( Carp::shortmess('Calling $c->model() will return a random model unless you specify one of:') );
912 $c->log->warn( '* $c->config(default_model => "the name of the default model to use")' );
913 $c->log->warn( '* $c->stash->{current_model} # the name of the model to use for this request' );
914 $c->log->warn( '* $c->stash->{current_model_instance} # the instance of the model to use for this request' );
915 $c->log->warn( 'NB: in version 5.81, the "random" behavior will not work at all.' );
918 return $c->_filter_component( $comp );
922 =head2 $c->view($name)
924 Gets a L<Catalyst::View> instance by name.
926 $c->view('Foo')->do_stuff;
928 Any extra arguments are directly passed to ACCEPT_CONTEXT.
930 If the name is omitted, it will look for
931 - a view object in $c->stash->{current_view_instance}, then
932 - a view name in $c->stash->{current_view}, then
933 - a config setting 'default_view', or
934 - check if there is only one view, and return it if that's the case.
936 If you want to search for views, pass in a regexp as the argument.
938 # find all views that start with Foo
939 my @foo_views = $c->view(qr{^Foo});
944 my ( $c, $name, @args ) = @_;
946 my $appclass = ref($c) || $c;
948 unless ( $name->$_isa('Regexp') ) { # Direct component hash lookup to avoid costly regexps
949 my $comps = $c->components;
950 my $check = $appclass."::View::".$name;
951 if( exists $comps->{$check} ) {
952 return $c->_filter_component( $comps->{$check}, @args );
955 $c->log->warn( "Attempted to use view '$check', but does not exist" );
957 foreach my $path (@{$appclass->config->{ setup_components }->{ search_extra }}) {
958 next unless $path =~ /.*::View/;
959 $check = $path."::".$name;
960 return $c->_filter_component( $comps->{$check}, @args ) if exists $comps->{$check};
963 my @result = $c->_comp_search_prefixes( $name, qw/View V/ );
964 return map { $c->_filter_component( $_, @args ) } @result if ref $name;
965 return $c->_filter_component( $result[ 0 ], @args );
969 return $c->stash->{current_view_instance}
970 if $c->stash->{current_view_instance};
971 return $c->view( $c->stash->{current_view} )
972 if $c->stash->{current_view};
974 return $c->view( $appclass->config->{default_view} )
975 if $appclass->config->{default_view};
977 my( $comp, $rest ) = $c->_comp_search_prefixes( undef, qw/View V/);
980 $c->log->warn( 'Calling $c->view() will return a random view unless you specify one of:' );
981 $c->log->warn( '* $c->config(default_view => "the name of the default view to use")' );
982 $c->log->warn( '* $c->stash->{current_view} # the name of the view to use for this request' );
983 $c->log->warn( '* $c->stash->{current_view_instance} # the instance of the view to use for this request' );
984 $c->log->warn( 'NB: in version 5.81, the "random" behavior will not work at all.' );
987 return $c->_filter_component( $comp );
990 =head2 $c->controllers
992 Returns the available names which can be passed to $c->controller
998 return $c->_comp_names(qw/Controller C/);
1003 Returns the available names which can be passed to $c->model
1009 return $c->_comp_names(qw/Model M/);
1015 Returns the available names which can be passed to $c->view
1021 return $c->_comp_names(qw/View V/);
1024 =head2 $c->comp($name)
1026 =head2 $c->component($name)
1028 Gets a component object by name. This method is not recommended,
1029 unless you want to get a specific component by full
1030 class. C<< $c->controller >>, C<< $c->model >>, and C<< $c->view >>
1031 should be used instead.
1033 If C<$name> is a regexp, a list of components matched against the full
1034 component name will be returned.
1036 If Catalyst can't find a component by name, it will fallback to regex
1037 matching by default. To disable this behaviour set
1038 disable_component_resolution_regex_fallback to a true value.
1040 __PACKAGE__->config( disable_component_resolution_regex_fallback => 1 );
1045 my ( $c, $name, @args ) = @_;
1048 my $comps = $c->components;
1051 # is it the exact name?
1052 return $c->_filter_component( $comps->{ $name }, @args )
1053 if exists $comps->{ $name };
1055 # perhaps we just omitted "MyApp"?
1056 my $composed = ( ref $c || $c ) . "::${name}";
1057 return $c->_filter_component( $comps->{ $composed }, @args )
1058 if exists $comps->{ $composed };
1060 # search all of the models, views and controllers
1061 my( $comp ) = $c->_comp_search_prefixes( $name, qw/Model M Controller C View V/ );
1062 return $c->_filter_component( $comp, @args ) if $comp;
1066 if $c->config->{disable_component_resolution_regex_fallback};
1068 # This is here so $c->comp( '::M::' ) works
1069 my $query = ref $name ? $name : qr{$name}i;
1071 my @result = grep { m{$query} } keys %{ $c->components };
1072 return map { $c->_filter_component( $_, @args ) } @result if ref $name;
1074 if( $result[ 0 ] ) {
1075 $c->log->warn( Carp::shortmess(qq(Found results for "${name}" using regexp fallback)) );
1076 $c->log->warn( 'Relying on the regexp fallback behavior for component resolution' );
1077 $c->log->warn( 'is unreliable and unsafe. You have been warned' );
1078 return $c->_filter_component( $result[ 0 ], @args );
1081 # I would expect to return an empty list here, but that breaks back-compat
1085 return sort keys %{ $c->components };
1088 =head2 CLASS DATA AND HELPER CLASSES
1092 Returns or takes a hashref containing the application's configuration.
1094 __PACKAGE__->config( { db => 'dsn:SQLite:foo.db' } );
1096 You can also use a C<YAML>, C<XML> or L<Config::General> config file
1097 like C<myapp.conf> in your applications home directory. See
1098 L<Catalyst::Plugin::ConfigLoader>.
1100 =head3 Cascading configuration
1102 The config method is present on all Catalyst components, and configuration
1103 will be merged when an application is started. Configuration loaded with
1104 L<Catalyst::Plugin::ConfigLoader> takes precedence over other configuration,
1105 followed by configuration in your top level C<MyApp> class. These two
1106 configurations are merged, and then configuration data whose hash key matches a
1107 component name is merged with configuration for that component.
1109 The configuration for a component is then passed to the C<new> method when a
1110 component is constructed.
1114 MyApp->config({ 'Model::Foo' => { bar => 'baz', overrides => 'me' } });
1115 MyApp::Model::Foo->config({ quux => 'frob', overrides => 'this' });
1117 will mean that C<MyApp::Model::Foo> receives the following data when
1120 MyApp::Model::Foo->new({
1126 It's common practice to use a Moose attribute
1127 on the receiving component to access the config value.
1129 package MyApp::Model::Foo;
1133 # this attr will receive 'baz' at construction time
1139 You can then get the value 'baz' by calling $c->model('Foo')->bar
1140 (or $self->bar inside code in the model).
1142 B<NOTE:> you MUST NOT call C<< $self->config >> or C<< __PACKAGE__->config >>
1143 as a way of reading config within your code, as this B<will not> give you the
1144 correctly merged config back. You B<MUST> take the config values supplied to
1145 the constructor and use those instead.
1149 around config => sub {
1153 croak('Setting config after setup has been run is not allowed.')
1154 if ( @_ and $c->setup_finished );
1161 Returns the logging object instance. Unless it is already set, Catalyst
1162 sets this up with a L<Catalyst::Log> object. To use your own log class,
1163 set the logger with the C<< __PACKAGE__->log >> method prior to calling
1164 C<< __PACKAGE__->setup >>.
1166 __PACKAGE__->log( MyLogger->new );
1171 $c->log->info( 'Now logging with my own logger!' );
1173 Your log class should implement the methods described in
1178 Returned True if there's a valid encoding
1180 =head2 clear_encoding
1182 Clears the encoding for the current context
1186 Sets or gets the application encoding. Setting encoding takes either an
1187 Encoding object or a string that we try to resolve via L<Encode::find_encoding>.
1189 You would expect to get the encoding object back if you attempt to set it. If
1190 there is a failure you will get undef returned and an error message in the log.
1194 sub has_encoding { shift->encoding ? 1:0 }
1196 sub clear_encoding {
1199 $c->encoding(undef);
1201 $c->log->error("You can't clear encoding on the application");
1211 # Don't let one change this once we are too far into the response
1212 if(blessed $c && $c->res->finalized_headers) {
1213 Carp::croak("You may not change the encoding once the headers are finalized");
1217 # Let it be set to undef
1218 if (my $wanted = shift) {
1219 $encoding = Encode::find_encoding($wanted)
1220 or Carp::croak( qq/Unknown encoding '$wanted'/ );
1221 binmode(STDERR, ':encoding(' . $encoding->name . ')');
1228 ? $c->{encoding} = $encoding
1229 : $c->_encoding($encoding);
1231 $encoding = ref $c && exists $c->{encoding}
1241 Returns 1 if debug mode is enabled, 0 otherwise.
1243 You can enable debug mode in several ways:
1247 =item By calling myapp_server.pl with the -d flag
1249 =item With the environment variables MYAPP_DEBUG, or CATALYST_DEBUG
1251 =item The -Debug option in your MyApp.pm
1253 =item By declaring C<sub debug { 1 }> in your MyApp.pm.
1257 The first three also set the log level to 'debug'.
1259 Calling C<< $c->debug(1) >> has no effect.
1265 =head2 $c->dispatcher
1267 Returns the dispatcher instance. See L<Catalyst::Dispatcher>.
1271 Returns the engine instance. See L<Catalyst::Engine>.
1274 =head2 UTILITY METHODS
1276 =head2 $c->path_to(@path)
1278 Merges C<@path> with C<< $c->config->{home} >> and returns a
1279 L<Path::Class::Dir> object. Note you can usually use this object as
1280 a filename, but sometimes you will have to explicitly stringify it
1281 yourself by calling the C<< ->stringify >> method.
1285 $c->path_to( 'db', 'sqlite.db' );
1290 my ( $c, @path ) = @_;
1291 my $path = Path::Class::Dir->new( $c->config->{home}, @path );
1292 if ( -d $path ) { return $path }
1293 else { return Path::Class::File->new( $c->config->{home}, @path ) }
1297 my ( $class, $name, $plugin, @args ) = @_;
1299 # See block comment in t/unit_core_plugin.t
1300 $class->log->warn(qq/Adding plugin using the ->plugin method is deprecated, and will be removed in a future release/);
1302 $class->_register_plugin( $plugin, 1 );
1304 eval { $plugin->import };
1305 $class->mk_classdata($name);
1307 eval { $obj = $plugin->new(@args) };
1310 Catalyst::Exception->throw( message =>
1311 qq/Couldn't instantiate instant plugin "$plugin", "$@"/ );
1314 $class->$name($obj);
1315 $class->log->debug(qq/Initialized instant plugin "$plugin" as "$name"/)
1321 Initializes the dispatcher and engine, loads any plugins, and loads the
1322 model, view, and controller components. You may also specify an array
1323 of plugins to load here, if you choose to not load them in the C<use
1327 MyApp->setup( qw/-Debug/ );
1329 B<Note:> You B<should not> wrap this method with method modifiers
1330 or bad things will happen - wrap the C<setup_finalize> method instead.
1332 B<Note:> You can create a custom setup stage that will execute when the
1333 application is starting. Use this to customize setup.
1335 MyApp->setup(-Custom=value);
1338 my ($class, $value) = @_;
1341 Can be handy if you want to hook into the setup phase.
1346 my ( $class, @arguments ) = @_;
1347 croak('Running setup more than once')
1348 if ( $class->setup_finished );
1350 unless ( $class->isa('Catalyst') ) {
1352 Catalyst::Exception->throw(
1353 message => qq/'$class' does not inherit from Catalyst/ );
1356 if ( $class->arguments ) {
1357 @arguments = ( @arguments, @{ $class->arguments } );
1363 foreach (@arguments) {
1367 ( $flags->{log} ) ? 'debug,' . $flags->{log} : 'debug';
1369 elsif (/^-(\w+)=?(.*)$/) {
1370 $flags->{ lc $1 } = $2;
1373 push @{ $flags->{plugins} }, $_;
1377 $class->setup_home( delete $flags->{home} );
1379 $class->setup_log( delete $flags->{log} );
1380 $class->setup_plugins( delete $flags->{plugins} );
1382 $class->setup_data_handlers();
1383 $class->setup_dispatcher( delete $flags->{dispatcher} );
1384 if (my $engine = delete $flags->{engine}) {
1385 $class->log->warn("Specifying the engine in ->setup is no longer supported, see Catalyst::Upgrading");
1387 $class->setup_engine();
1388 $class->setup_stats( delete $flags->{stats} );
1390 for my $flag ( sort keys %{$flags} ) {
1392 if ( my $code = $class->can( 'setup_' . $flag ) ) {
1393 &$code( $class, delete $flags->{$flag} );
1396 $class->log->warn(qq/Unknown flag "$flag"/);
1400 eval { require Catalyst::Devel; };
1401 if( !$@ && $ENV{CATALYST_SCRIPT_GEN} && ( $ENV{CATALYST_SCRIPT_GEN} < $Catalyst::Devel::CATALYST_SCRIPT_GEN ) ) {
1402 $class->log->warn(<<"EOF");
1403 You are running an old script!
1405 Please update by running (this will overwrite existing files):
1406 catalyst.pl -force -scripts $class
1408 or (this will not overwrite existing files):
1409 catalyst.pl -scripts $class
1414 # Call plugins setup, this is stupid and evil.
1415 # Also screws C3 badly on 5.10, hack to avoid.
1417 no warnings qw/redefine/;
1418 local *setup = sub { };
1419 $class->setup unless $Catalyst::__AM_RESTARTING;
1422 # If you are expecting configuration info as part of your setup, it needs
1423 # to get called here and below, since we need the above line to support
1424 # ConfigLoader based configs.
1426 $class->setup_encoding();
1427 $class->setup_middleware();
1429 # Initialize our data structure
1430 $class->components( {} );
1432 $class->setup_components;
1434 if ( $class->debug ) {
1435 my @plugins = map { "$_ " . ( $_->VERSION || '' ) } $class->registered_plugins;
1438 my $column_width = Catalyst::Utils::term_width() - 6;
1439 my $t = Text::SimpleTable->new($column_width);
1440 $t->row($_) for @plugins;
1441 $class->log->debug( "Loaded plugins:\n" . $t->draw . "\n" );
1444 my @middleware = map {
1447 (ref($_) .' '. ($_->can('VERSION') ? $_->VERSION || '' : '')
1448 || '') } $class->registered_middlewares;
1451 my $column_width = Catalyst::Utils::term_width() - 6;
1452 my $t = Text::SimpleTable->new($column_width);
1453 $t->row($_) for @middleware;
1454 $class->log->debug( "Loaded PSGI Middleware:\n" . $t->draw . "\n" );
1457 my %dh = $class->registered_data_handlers;
1458 if (my @data_handlers = keys %dh) {
1459 my $column_width = Catalyst::Utils::term_width() - 6;
1460 my $t = Text::SimpleTable->new($column_width);
1461 $t->row($_) for @data_handlers;
1462 $class->log->debug( "Loaded Request Data Handlers:\n" . $t->draw . "\n" );
1465 my $dispatcher = $class->dispatcher;
1466 my $engine = $class->engine;
1467 my $home = $class->config->{home};
1469 $class->log->debug(sprintf(q/Loaded dispatcher "%s"/, blessed($dispatcher)));
1470 $class->log->debug(sprintf(q/Loaded engine "%s"/, blessed($engine)));
1474 ? $class->log->debug(qq/Found home "$home"/)
1475 : $class->log->debug(qq/Home "$home" doesn't exist/)
1476 : $class->log->debug(q/Couldn't find home/);
1478 my $column_width = Catalyst::Utils::term_width() - 8 - 9;
1480 my $t = Text::SimpleTable->new( [ $column_width, 'Class' ], [ 8, 'Type' ] );
1481 for my $comp ( sort keys %{ $class->components } ) {
1482 my $type = ref $class->components->{$comp} ? 'instance' : 'class';
1483 $t->row( $comp, $type );
1485 $class->log->debug( "Loaded components:\n" . $t->draw . "\n" )
1486 if ( keys %{ $class->components } );
1489 # Add our self to components, since we are also a component
1490 if( $class->isa('Catalyst::Controller') ){
1491 $class->components->{$class} = $class;
1494 $class->setup_actions;
1496 if ( $class->debug ) {
1497 my $name = $class->config->{name} || 'Application';
1498 $class->log->info("$name powered by Catalyst $Catalyst::VERSION");
1501 if ($class->config->{case_sensitive}) {
1502 $class->log->warn($class . "->config->{case_sensitive} is set.");
1503 $class->log->warn("This setting is deprecated and planned to be removed in Catalyst 5.81.");
1506 # call these so we pre setup the composed classes
1507 $class->composed_request_class;
1508 $class->composed_response_class;
1509 $class->composed_stats_class;
1511 $class->setup_finalize;
1513 # Flush the log for good measure (in case something turned off 'autoflush' early)
1514 $class->log->_flush() if $class->log->can('_flush');
1516 return $class || 1; # Just in case someone named their Application 0...
1519 =head2 $app->setup_finalize
1521 A hook to attach modifiers to. This method does not do anything except set the
1522 C<setup_finished> accessor.
1524 Applying method modifiers to the C<setup> method doesn't work, because of quirky things done for plugin setup.
1528 after setup_finalize => sub {
1536 sub setup_finalize {
1538 $class->setup_finished(1);
1541 =head2 $c->uri_for( $path?, @args?, \%query_values?, \$fragment? )
1543 =head2 $c->uri_for( $action, \@captures?, @args?, \%query_values?, \$fragment? )
1545 =head2 $c->uri_for( $action, [@captures, @args], \%query_values?, \$fragment? )
1547 Constructs an absolute L<URI> object based on the application root, the
1548 provided path, and the additional arguments and query parameters provided.
1549 When used as a string, provides a textual URI. If you need more flexibility
1550 than this (i.e. the option to provide relative URIs etc.) see
1551 L<Catalyst::Plugin::SmartURI>.
1553 If no arguments are provided, the URI for the current action is returned.
1554 To return the current action and also provide @args, use
1555 C<< $c->uri_for( $c->action, @args ) >>.
1557 If the first argument is a string, it is taken as a public URI path relative
1558 to C<< $c->namespace >> (if it doesn't begin with a forward slash) or
1559 relative to the application root (if it does). It is then merged with
1560 C<< $c->request->base >>; any C<@args> are appended as additional path
1561 components; and any C<%query_values> are appended as C<?foo=bar> parameters.
1563 B<NOTE> If you are using this 'stringy' first argument, we skip encoding and
1564 allow you to declare something like:
1566 $c->uri_for('/foo/bar#baz')
1568 Where 'baz' is a URI fragment. We consider this first argument string to be
1569 'expert' mode where you are expected to create a valid URL and we for the most
1570 part just pass it through without a lot of internal effort to escape and encode.
1572 If the first argument is a L<Catalyst::Action> it represents an action which
1573 will have its path resolved using C<< $c->dispatcher->uri_for_action >>. The
1574 optional C<\@captures> argument (an arrayref) allows passing the captured
1575 variables that are needed to fill in the paths of Chained and Regex actions;
1576 once the path is resolved, C<uri_for> continues as though a path was
1577 provided, appending any arguments or parameters and creating an absolute
1580 The captures for the current request can be found in
1581 C<< $c->request->captures >>, and actions can be resolved using
1582 C<< Catalyst::Controller->action_for($name) >>. If you have a private action
1583 path, use C<< $c->uri_for_action >> instead.
1585 # Equivalent to $c->req->uri
1586 $c->uri_for($c->action, $c->req->captures,
1587 @{ $c->req->args }, $c->req->params);
1589 # For the Foo action in the Bar controller
1590 $c->uri_for($c->controller('Bar')->action_for('Foo'));
1592 # Path to a static resource
1593 $c->uri_for('/static/images/logo.png');
1595 In general the scheme of the generated URI object will follow the incoming request
1596 however if your targeted action or action chain has the Scheme attribute it will
1599 Also, if the targeted Action or Action chain declares Args/CaptureArgs that have
1600 type constraints, we will require that your proposed URL verify on those declared
1606 my ( $c, $path, @args ) = @_;
1608 if ( $path->$_isa('Catalyst::Controller') ) {
1609 $path = $path->path_prefix;
1614 my $fragment = ((scalar(@args) && ref($args[-1]) eq 'SCALAR') ? ${pop @args} : undef );
1616 unless(blessed $path) {
1617 if (defined($path) and $path =~ s/#(.+)$//) {
1618 if(defined($1) and defined $fragment) {
1619 carp "Abiguious fragment declaration: You cannot define a fragment in '$path' and as an argument '$fragment'";
1628 ( scalar @args && ref $args[$#args] eq 'HASH' ? pop @args : {} );
1630 undef($path) if (defined $path && $path eq '');
1632 carp "uri_for called with undef argument" if grep { ! defined $_ } @args;
1634 my $target_action = $path->$_isa('Catalyst::Action') ? $path : undef;
1635 if ( $path->$_isa('Catalyst::Action') ) { # action object
1636 s|/|%2F|g for @args;
1637 my $captures = [ map { s|/|%2F|g; $_; }
1638 ( scalar @args && ref $args[0] eq 'ARRAY'
1643 my $expanded_action = $c->dispatcher->expand_action( $action );
1644 my $num_captures = $expanded_action->number_of_captures;
1646 # ->uri_for( $action, \@captures_and_args, \%query_values? )
1647 if( !@args && $action->number_of_args ) {
1648 unshift @args, splice @$captures, $num_captures;
1652 unless($expanded_action->match_captures_constraints($c, $captures)) {
1653 $c->log->debug("captures [@{$captures}] do not match the type constraints in actionchain ending with '$expanded_action'")
1659 $path = $c->dispatcher->uri_for_action($action, $captures);
1660 if (not defined $path) {
1661 $c->log->debug(qq/Can't find uri_for action '$action' @$captures/)
1665 $path = '/' if $path eq '';
1667 # At this point @encoded_args is the remaining Args (all captures removed).
1668 if($expanded_action->has_args_constraints) {
1669 unless($expanded_action->match_args($c,\@args)) {
1670 $c->log->debug("args [@args] do not match the type constraints in action '$expanded_action'")
1677 unshift(@args, $path);
1679 unless (defined $path && $path =~ s!^/!!) { # in-place strip
1680 my $namespace = $c->namespace;
1681 if (defined $path) { # cheesy hack to handle path '../foo'
1682 $namespace =~ s{(?:^|/)[^/]+$}{} while $args[0] =~ s{^\.\./}{};
1684 unshift(@args, $namespace || '');
1687 # join args with '/', or a blank string
1688 my $args = join('/', grep { defined($_) } @args);
1689 $args =~ s/\?/%3F/g; # STUPID STUPID SPECIAL CASE
1692 my ($base, $class) = ('/', 'URI::_generic');
1694 $base = $c->req->base;
1695 if($target_action) {
1696 $target_action = $c->dispatcher->expand_action($target_action);
1697 if(my $s = $target_action->scheme) {
1702 $class = ref($base);
1705 $class = ref($base);
1708 $base =~ s{(?<!/)$}{/};
1712 if (my @keys = keys %$params) {
1713 # somewhat lifted from URI::_query's query_form
1714 $query = '?'.join('&', map {
1715 my $val = $params->{$_};
1716 my $key = encode_utf8($_);
1717 # using the URI::Escape pattern here so utf8 chars survive
1718 $key =~ s/([^A-Za-z0-9\-_.!~*'() ])/$URI::Escape::escapes{$1}/go;
1721 $val = '' unless defined $val;
1723 my $param = encode_utf8($_);
1724 # using the URI::Escape pattern here so utf8 chars survive
1725 $param =~ s/([^A-Za-z0-9\-_.!~*'() ])/$URI::Escape::escapes{$1}/go;
1729 } ( ref $val eq 'ARRAY' ? @$val : $val ));
1733 $base = encode_utf8 $base;
1734 $base =~ s/([^$URI::uric])/$URI::Escape::escapes{$1}/go;
1735 $args = encode_utf8 $args;
1736 $args =~ s/([^$URI::uric])/$URI::Escape::escapes{$1}/go;
1738 if(defined $fragment) {
1740 $fragment = encode_utf8($fragment);
1741 $fragment =~ s/([^A-Za-z0-9\-_.!~*'() ])/$URI::Escape::escapes{$1}/go;
1742 $fragment =~ s/ /+/g;
1744 $query .= "#$fragment";
1747 my $res = bless(\"${base}${args}${query}", $class);
1751 =head2 $c->uri_for_action( $path, \@captures_and_args?, @args?, \%query_values? )
1753 =head2 $c->uri_for_action( $action, \@captures_and_args?, @args?, \%query_values? )
1759 A private path to the Catalyst action you want to create a URI for.
1761 This is a shortcut for calling C<< $c->dispatcher->get_action_by_path($path)
1762 >> and passing the resulting C<$action> and the remaining arguments to C<<
1765 You can also pass in a Catalyst::Action object, in which case it is passed to
1768 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.
1770 For example, if the action looks like:
1772 package MyApp::Controller::Users;
1774 sub lst : Path('the-list') {}
1778 $c->uri_for_action('/users/lst')
1780 and it will create the URI /users/the-list.
1782 =item \@captures_and_args?
1784 Optional array reference of Captures (i.e. C<CaptureArgs> or C<< $c->req->captures >>)
1785 and arguments to the request. Usually used with L<Catalyst::DispatchType::Chained>
1786 to interpolate all the parameters in the URI.
1790 Optional list of extra arguments - can be supplied in the
1791 C<< \@captures_and_args? >> array ref, or here - whichever is easier for your
1794 Your action can have zero, a fixed or a variable number of args (e.g.
1795 C<< Args(1) >> for a fixed number or C<< Args() >> for a variable number)..
1797 =item \%query_values?
1799 Optional array reference of query parameters to append. E.g.
1805 /rest/of/your/uri?foo=bar
1811 sub uri_for_action {
1812 my ( $c, $path, @args ) = @_;
1813 my $action = blessed($path)
1815 : $c->dispatcher->get_action_by_path($path);
1816 unless (defined $action) {
1817 croak "Can't find action for path '$path'";
1819 return $c->uri_for( $action, @args );
1822 =head2 $c->welcome_message
1824 Returns the Catalyst welcome HTML page.
1828 sub welcome_message {
1830 my $name = $c->config->{name};
1831 my $logo = $c->uri_for('/static/images/catalyst_logo.png');
1832 my $prefix = Catalyst::Utils::appprefix( ref $c );
1833 $c->response->content_type('text/html; charset=utf-8');
1835 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
1836 "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
1837 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
1839 <meta http-equiv="Content-Language" content="en" />
1840 <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
1841 <title>$name on Catalyst $VERSION</title>
1842 <style type="text/css">
1845 background-color: #eee;
1852 margin-bottom: 10px;
1854 background-color: #ccc;
1855 border: 1px solid #aaa;
1860 font-family: verdana, tahoma, sans-serif;
1863 font-family: verdana, tahoma, sans-serif;
1866 text-decoration: none;
1868 border-bottom: 1px dotted #bbb;
1870 :link:hover, :visited:hover {
1883 background-color: #fff;
1884 border: 1px solid #aaa;
1888 font-weight: normal;
1910 <h1><span id="appname">$name</span> on <a href="http://catalyst.perl.org">Catalyst</a>
1915 <img src="$logo" alt="Catalyst Logo" />
1917 <p>Welcome to the world of Catalyst.
1918 This <a href="http://en.wikipedia.org/wiki/MVC">MVC</a>
1919 framework will make web development something you had
1920 never expected it to be: Fun, rewarding, and quick.</p>
1921 <h2>What to do now?</h2>
1922 <p>That really depends on what <b>you</b> want to do.
1923 We do, however, provide you with a few starting points.</p>
1924 <p>If you want to jump right into web development with Catalyst
1925 you might want to start with a tutorial.</p>
1926 <pre>perldoc <a href="https://metacpan.org/module/Catalyst::Manual::Tutorial">Catalyst::Manual::Tutorial</a></code>
1928 <p>Afterwards you can go on to check out a more complete look at our features.</p>
1930 <code>perldoc <a href="https://metacpan.org/module/Catalyst::Manual::Intro">Catalyst::Manual::Intro</a>
1931 <!-- Something else should go here, but the Catalyst::Manual link seems unhelpful -->
1933 <h2>What to do next?</h2>
1934 <p>Next it's time to write an actual application. Use the
1935 helper scripts to generate <a href="https://metacpan.org/search?q=Catalyst%3A%3AController">controllers</a>,
1936 <a href="https://metacpan.org/search?q=Catalyst%3A%3AModel">models</a>, and
1937 <a href="https://metacpan.org/search?q=Catalyst%3A%3AView">views</a>;
1938 they can save you a lot of work.</p>
1939 <pre><code>script/${prefix}_create.pl --help</code></pre>
1940 <p>Also, be sure to check out the vast and growing
1941 collection of <a href="http://search.cpan.org/search?query=Catalyst">plugins for Catalyst on CPAN</a>;
1942 you are likely to find what you need there.
1946 <p>Catalyst has a very active community. Here are the main places to
1947 get in touch with us.</p>
1950 <a href="http://dev.catalyst.perl.org">Wiki</a>
1953 <a href="http://lists.scsys.co.uk/cgi-bin/mailman/listinfo/catalyst">Mailing-List</a>
1956 <a href="irc://irc.perl.org/catalyst">IRC channel #catalyst on irc.perl.org</a>
1959 <h2>In conclusion</h2>
1960 <p>The Catalyst team hopes you will enjoy using Catalyst as much
1961 as we enjoyed making it. Please contact us if you have ideas
1962 for improvement or other feedback.</p>
1972 Contains a hash of options passed from the application script, including
1973 the original ARGV the script received, the processed values from that
1974 ARGV and any extra arguments to the script which were not processed.
1976 This can be used to add custom options to your application's scripts
1977 and setup your application differently depending on the values of these
1980 =head1 INTERNAL METHODS
1982 These methods are not meant to be used by end users.
1984 =head2 $c->components
1986 Returns a hash of components.
1988 =head2 $c->context_class
1990 Returns or sets the context class.
1994 Returns a hashref containing coderefs and execution counts (needed for
1995 deep recursion detection).
1999 Returns the number of actions on the current internal execution stack.
2003 Dispatches a request to actions.
2007 sub dispatch { my $c = shift; $c->dispatcher->dispatch( $c, @_ ) }
2009 =head2 $c->dispatcher_class
2011 Returns or sets the dispatcher class.
2013 =head2 $c->dump_these
2015 Returns a list of 2-element array references (name, structure) pairs
2016 that will be dumped on the error page in debug mode.
2022 [ Request => $c->req ],
2023 [ Response => $c->res ],
2024 [ Stash => $c->stash ],
2025 [ Config => $c->config ];
2028 =head2 $c->engine_class
2030 Returns or sets the engine class.
2032 =head2 $c->execute( $class, $coderef )
2034 Execute a coderef in given class and catch exceptions. Errors are available
2040 my ( $c, $class, $code ) = @_;
2041 $class = $c->component($class) || $class;
2044 if ( $c->depth >= $RECURSION ) {
2045 my $action = $code->reverse();
2046 $action = "/$action" unless $action =~ /->/;
2047 my $error = qq/Deep recursion detected calling "${action}"/;
2048 $c->log->error($error);
2054 my $stats_info = $c->_stats_start_execute( $code ) if $c->use_stats;
2056 push( @{ $c->stack }, $code );
2058 no warnings 'recursion';
2059 # N.B. This used to be combined, but I have seen $c get clobbered if so, and
2060 # I have no idea how, ergo $ret (which appears to fix the issue)
2061 eval { my $ret = $code->execute( $class, $c, @{ $c->req->args } ) || 0; $c->state( $ret ) };
2063 $c->_stats_finish_execute( $stats_info ) if $c->use_stats and $stats_info;
2065 my $last = pop( @{ $c->stack } );
2067 if ( my $error = $@ ) {
2068 #rethow if this can be handled by middleware
2069 if ( $c->_handle_http_exception($error) ) {
2070 foreach my $err (@{$c->error}) {
2071 $c->log->error($err);
2074 $c->log->_flush if $c->log->can('_flush');
2076 $error->can('rethrow') ? $error->rethrow : croak $error;
2078 if ( blessed($error) and $error->isa('Catalyst::Exception::Detach') ) {
2079 $error->rethrow if $c->depth > 1;
2081 elsif ( blessed($error) and $error->isa('Catalyst::Exception::Go') ) {
2082 $error->rethrow if $c->depth > 0;
2085 unless ( ref $error ) {
2086 no warnings 'uninitialized';
2088 my $class = $last->class;
2089 my $name = $last->name;
2090 $error = qq/Caught exception in $class->$name "$error"/;
2099 sub _stats_start_execute {
2100 my ( $c, $code ) = @_;
2101 my $appclass = ref($c) || $c;
2102 return if ( ( $code->name =~ /^_.*/ )
2103 && ( !$appclass->config->{show_internal_actions} ) );
2105 my $action_name = $code->reverse();
2106 $c->counter->{$action_name}++;
2108 my $action = $action_name;
2109 $action = "/$action" unless $action =~ /->/;
2111 # determine if the call was the result of a forward
2112 # this is done by walking up the call stack and looking for a calling
2113 # sub of Catalyst::forward before the eval
2115 for my $index ( 2 .. 11 ) {
2117 if ( ( caller($index) )[0] eq 'Catalyst'
2118 && ( caller($index) )[3] eq '(eval)' );
2120 if ( ( caller($index) )[3] =~ /forward$/ ) {
2121 $callsub = ( caller($index) )[3];
2122 $action = "-> $action";
2127 my $uid = $action_name . $c->counter->{$action_name};
2129 # is this a root-level call or a forwarded call?
2130 if ( $callsub =~ /forward$/ ) {
2131 my $parent = $c->stack->[-1];
2133 # forward, locate the caller
2134 if ( defined $parent && exists $c->counter->{"$parent"} ) {
2137 parent => "$parent" . $c->counter->{"$parent"},
2143 # forward with no caller may come from a plugin
2162 sub _stats_finish_execute {
2163 my ( $c, $info ) = @_;
2164 $c->stats->profile( end => $info );
2169 Finalizes the request.
2176 for my $error ( @{ $c->error } ) {
2177 $c->log->error($error);
2180 # Support skipping finalize for psgix.io style 'jailbreak'. Used to support
2181 # stuff like cometd and websockets
2183 if($c->request->_has_io_fh) {
2188 # Allow engine to handle finalize flow (for POE)
2189 my $engine = $c->engine;
2190 if ( my $code = $engine->can('finalize') ) {
2195 $c->finalize_uploads;
2198 if ( $#{ $c->error } >= 0 ) {
2202 $c->finalize_encoding;
2203 $c->finalize_headers unless $c->response->finalized_headers;
2209 $c->log_stats if $c->use_stats;
2211 return $c->response->status;
2214 =head2 $c->log_stats
2223 my $elapsed = $c->stats->elapsed;
2224 my $av = $elapsed == 0 ? '??' : sprintf '%.3f', 1 / $elapsed;
2226 "Request took ${elapsed}s ($av/s)\n" . $c->stats->report . "\n" );
2230 =head2 $c->finalize_body
2236 sub finalize_body { my $c = shift; $c->engine->finalize_body( $c, @_ ) }
2238 =head2 $c->finalize_cookies
2244 sub finalize_cookies { my $c = shift; $c->engine->finalize_cookies( $c, @_ ) }
2246 =head2 $c->finalize_error
2248 Finalizes error. If there is only one error in L</error> and it is an object that
2249 does C<as_psgi> or C<code> we rethrow the error and presume it caught by middleware
2250 up the ladder. Otherwise we return the debugging error page (in debug mode) or we
2251 return the default error page (production mode).
2255 sub finalize_error {
2257 if($#{$c->error} > 0) {
2258 $c->engine->finalize_error( $c, @_ );
2260 my ($error) = @{$c->error};
2261 if ( $c->_handle_http_exception($error) ) {
2262 # In the case where the error 'knows what it wants', becauses its PSGI
2263 # aware, just rethow and let middleware catch it
2264 $error->can('rethrow') ? $error->rethrow : croak $error;
2266 $c->engine->finalize_error( $c, @_ )
2271 =head2 $c->finalize_headers
2277 sub finalize_headers {
2280 my $response = $c->response; #accessor calls can add up?
2282 # Check if we already finalized headers
2283 return if $response->finalized_headers;
2286 if ( my $location = $response->redirect ) {
2287 $c->log->debug(qq/Redirecting to "$location"/) if $c->debug;
2288 $response->header( Location => $location );
2291 # Remove incorrectly added body and content related meta data when returning
2292 # an information response, or a response the is required to not include a body
2294 $c->finalize_cookies;
2296 # This currently is a NOOP but I don't want to remove it since I guess people
2297 # might have Response subclasses that use it for something... (JNAP)
2298 $c->response->finalize_headers();
2301 $response->finalized_headers(1);
2304 =head2 $c->finalize_encoding
2306 Make sure your body is encoded properly IF you set an encoding. By
2307 default the encoding is UTF-8 but you can disable it by explicitly setting the
2308 encoding configuration value to undef.
2310 We can only encode when the body is a scalar. Methods for encoding via the
2311 streaming interfaces (such as C<write> and C<write_fh> on L<Catalyst::Response>
2318 sub finalize_encoding {
2320 my $res = $c->res || return;
2322 # Warn if the set charset is different from the one you put into encoding. We need
2323 # to do this early since encodable_response is false for this condition and we need
2324 # to match the debug output for backcompat (there's a test for this...) -JNAP
2326 $res->content_type_charset and $c->encoding and
2327 (uc($c->encoding->mime_name) ne uc($res->content_type_charset))
2329 my $ct = lc($res->content_type_charset);
2330 $c->log->debug("Catalyst encoding config is set to encode in '" .
2331 $c->encoding->mime_name .
2332 "', content type is '$ct', not encoding ");
2336 ($res->encodable_response) and
2337 (defined($res->body)) and
2338 (ref(\$res->body) eq 'SCALAR')
2340 # if you are finding yourself here and your body is already encoded correctly
2341 # and you want to turn this off, use $c->clear_encoding to prevent encoding
2342 # at this step, or set encoding to undef in the config to do so for the whole
2343 # application. See the ENCODING documentaiton for better notes.
2344 $c->res->body( $c->encoding->encode( $c->res->body, $c->_encode_check ) );
2346 # Set the charset if necessary. This might be a bit bonkers since encodable response
2347 # is false when the set charset is not the same as the encoding mimetype (maybe
2348 # confusing action at a distance here..
2349 # Don't try to set the charset if one already exists or if headers are already finalized
2350 $c->res->content_type($c->res->content_type . "; charset=" . $c->encoding->mime_name)
2351 unless($c->res->content_type_charset ||
2352 ($c->res->_context && $c->res->finalized_headers && !$c->res->_has_response_cb));
2356 =head2 $c->finalize_output
2358 An alias for finalize_body.
2360 =head2 $c->finalize_read
2362 Finalizes the input after reading is complete.
2366 sub finalize_read { my $c = shift; $c->engine->finalize_read( $c, @_ ) }
2368 =head2 $c->finalize_uploads
2370 Finalizes uploads. Cleans up any temporary files.
2374 sub finalize_uploads { my $c = shift; $c->engine->finalize_uploads( $c, @_ ) }
2376 =head2 $c->get_action( $action, $namespace )
2378 Gets an action in a given namespace.
2382 sub get_action { my $c = shift; $c->dispatcher->get_action(@_) }
2384 =head2 $c->get_actions( $action, $namespace )
2386 Gets all actions of a given name in a namespace and all parent
2391 sub get_actions { my $c = shift; $c->dispatcher->get_actions( $c, @_ ) }
2393 =head2 $app->handle_request( @arguments )
2395 Called to handle each HTTP request.
2399 sub handle_request {
2400 my ( $class, @arguments ) = @_;
2402 # Always expect worst case!
2405 if ($class->debug) {
2406 my $secs = time - $START || 1;
2407 my $av = sprintf '%.3f', $COUNT / $secs;
2408 my $time = localtime time;
2409 $class->log->info("*** Request $COUNT ($av/s) [$$] [$time] ***");
2412 my $c = $class->prepare(@arguments);
2414 $status = $c->finalize;
2416 #rethow if this can be handled by middleware
2417 if ( $class->_handle_http_exception($_) ) {
2418 $_->can('rethrow') ? $_->rethrow : croak $_;
2420 chomp(my $error = $_);
2421 $class->log->error(qq/Caught exception in engine "$error"/);
2426 if(my $coderef = $class->log->can('_flush')){
2427 $class->log->$coderef();
2432 =head2 $class->prepare( @arguments )
2434 Creates a Catalyst context from an engine-specific request (Apache, CGI,
2441 predicate => '_has_uploadtmp',
2445 my ( $class, @arguments ) = @_;
2448 # After the app/ctxt split, this should become an attribute based on something passed
2449 # into the application.
2450 $class->context_class( ref $class || $class ) unless $class->context_class;
2452 my $uploadtmp = $class->config->{uploadtmp};
2453 my $c = $class->context_class->new({ $uploadtmp ? (_uploadtmp => $uploadtmp) : ()});
2455 $c->response->_context($c);
2456 $c->stats($class->stats_class->new)->enable($c->use_stats);
2458 if ( $c->debug || $c->config->{enable_catalyst_header} ) {
2459 $c->res->headers->header( 'X-Catalyst' => $Catalyst::VERSION );
2463 # Allow engine to direct the prepare flow (for POE)
2464 if ( my $prepare = $c->engine->can('prepare') ) {
2465 $c->engine->$prepare( $c, @arguments );
2468 $c->prepare_request(@arguments);
2469 $c->prepare_connection;
2470 $c->prepare_query_parameters;
2471 $c->prepare_headers; # Just hooks, no longer needed - they just
2472 $c->prepare_cookies; # cause the lazy attribute on req to build
2475 # Prepare the body for reading, either by prepare_body
2476 # or the user, if they are using $c->read
2479 # Parse the body unless the user wants it on-demand
2480 unless ( ref($c)->config->{parse_on_demand} ) {
2486 # VERY ugly and probably shouldn't rely on ->finalize actually working
2488 # failed prepare is always due to an invalid request, right?
2489 # Note we call finalize and then die here, which escapes
2490 # finalize being called in the enclosing block..
2491 # It in fact couldn't be called, as we don't return $c..
2492 # This is a mess - but I'm unsure you can fix this without
2493 # breaking compat for people doing crazy things (we should set
2494 # the 400 and just return the ctx here IMO, letting finalize get called
2496 if ( $c->_handle_http_exception($_) ) {
2497 foreach my $err (@{$c->error}) {
2498 $c->log->error($err);
2501 $c->log->_flush if $c->log->can('_flush');
2502 $_->can('rethrow') ? $_->rethrow : croak $_;
2504 $c->response->status(400);
2505 $c->response->content_type('text/plain');
2506 $c->response->body('Bad Request');
2513 $c->{stash} = $c->stash;
2514 Scalar::Util::weaken($c->{stash});
2519 =head2 $c->prepare_action
2521 Prepares action. See L<Catalyst::Dispatcher>.
2525 sub prepare_action {
2527 my $ret = $c->dispatcher->prepare_action( $c, @_);
2530 foreach (@{$c->req->arguments}, @{$c->req->captures}) {
2531 $_ = $c->_handle_param_unicode_decoding($_);
2539 =head2 $c->prepare_body
2541 Prepares message body.
2548 return if $c->request->_has_body;
2550 # Initialize on-demand data
2551 $c->engine->prepare_body( $c, @_ );
2552 $c->prepare_parameters;
2553 $c->prepare_uploads;
2556 =head2 $c->prepare_body_chunk( $chunk )
2558 Prepares a chunk of data before sending it to L<HTTP::Body>.
2560 See L<Catalyst::Engine>.
2564 sub prepare_body_chunk {
2566 $c->engine->prepare_body_chunk( $c, @_ );
2569 =head2 $c->prepare_body_parameters
2571 Prepares body parameters.
2575 sub prepare_body_parameters {
2577 $c->request->prepare_body_parameters( $c, @_ );
2580 =head2 $c->prepare_connection
2582 Prepares connection.
2586 sub prepare_connection {
2588 $c->request->prepare_connection($c);
2591 =head2 $c->prepare_cookies
2593 Prepares cookies by ensuring that the attribute on the request
2594 object has been built.
2598 sub prepare_cookies { my $c = shift; $c->request->cookies }
2600 =head2 $c->prepare_headers
2602 Prepares request headers by ensuring that the attribute on the request
2603 object has been built.
2607 sub prepare_headers { my $c = shift; $c->request->headers }
2609 =head2 $c->prepare_parameters
2611 Prepares parameters.
2615 sub prepare_parameters {
2617 $c->prepare_body_parameters;
2618 $c->engine->prepare_parameters( $c, @_ );
2621 =head2 $c->prepare_path
2623 Prepares path and base.
2627 sub prepare_path { my $c = shift; $c->engine->prepare_path( $c, @_ ) }
2629 =head2 $c->prepare_query_parameters
2631 Prepares query parameters.
2635 sub prepare_query_parameters {
2638 $c->engine->prepare_query_parameters( $c, @_ );
2641 =head2 $c->log_request
2643 Writes information about the request to the debug logs. This includes:
2647 =item * Request method, path, and remote IP address
2649 =item * Query keywords (see L<Catalyst::Request/query_keywords>)
2651 =item * Request parameters
2653 =item * File uploads
2662 return unless $c->debug;
2664 my($dump) = grep {$_->[0] eq 'Request' } $c->dump_these;
2665 my $request = $dump->[1];
2667 my ( $method, $path, $address ) = ( $request->method, $request->path, $request->address );
2669 $path = '/' unless length $path;
2672 $path =~ s/%([0-9A-Fa-f]{2})/chr(hex($1))/eg;
2673 $path = decode_utf8($path);
2675 $c->log->debug(qq/"$method" request for "$path" from "$address"/);
2677 $c->log_request_headers($request->headers);
2679 if ( my $keywords = $request->query_keywords ) {
2680 $c->log->debug("Query keywords are: $keywords");
2683 $c->log_request_parameters( query => $request->query_parameters, $request->_has_body ? (body => $request->body_parameters) : () );
2685 $c->log_request_uploads($request);
2688 =head2 $c->log_response
2690 Writes information about the response to the debug logs by calling
2691 C<< $c->log_response_status_line >> and C<< $c->log_response_headers >>.
2698 return unless $c->debug;
2700 my($dump) = grep {$_->[0] eq 'Response' } $c->dump_these;
2701 my $response = $dump->[1];
2703 $c->log_response_status_line($response);
2704 $c->log_response_headers($response->headers);
2707 =head2 $c->log_response_status_line($response)
2709 Writes one line of information about the response to the debug logs. This includes:
2713 =item * Response status code
2715 =item * Content-Type header (if present)
2717 =item * Content-Length header (if present)
2723 sub log_response_status_line {
2724 my ($c, $response) = @_;
2728 'Response Code: %s; Content-Type: %s; Content-Length: %s',
2729 $response->status || 'unknown',
2730 $response->headers->header('Content-Type') || 'unknown',
2731 $response->headers->header('Content-Length') || 'unknown'
2736 =head2 $c->log_response_headers($headers);
2738 Hook method which can be wrapped by plugins to log the response headers.
2739 No-op in the default implementation.
2743 sub log_response_headers {}
2745 =head2 $c->log_request_parameters( query => {}, body => {} )
2747 Logs request parameters to debug logs
2751 sub log_request_parameters {
2753 my %all_params = @_;
2755 return unless $c->debug;
2757 my $column_width = Catalyst::Utils::term_width() - 44;
2758 foreach my $type (qw(query body)) {
2759 my $params = $all_params{$type};
2760 next if ! keys %$params;
2761 my $t = Text::SimpleTable->new( [ 35, 'Parameter' ], [ $column_width, 'Value' ] );
2762 for my $key ( sort keys %$params ) {
2764 if(ref $params eq 'Hash::MultiValue') {
2765 @values = $params->get_all($key);
2767 my $param = $params->{$key};
2768 if( defined($param) ) {
2769 @values = ref $param eq 'ARRAY' ? @$param : $param;
2772 $t->row( $key.( scalar @values > 1 ? ' [multiple]' : ''), join(', ', @values) );
2774 $c->log->debug( ucfirst($type) . " Parameters are:\n" . $t->draw );
2778 =head2 $c->log_request_uploads
2780 Logs file uploads included in the request to the debug logs.
2781 The parameter name, filename, file type, and file size are all included in
2786 sub log_request_uploads {
2788 my $request = shift;
2789 return unless $c->debug;
2790 my $uploads = $request->uploads;
2791 if ( keys %$uploads ) {
2792 my $t = Text::SimpleTable->new(
2793 [ 12, 'Parameter' ],
2798 for my $key ( sort keys %$uploads ) {
2799 my $upload = $uploads->{$key};
2800 for my $u ( ref $upload eq 'ARRAY' ? @{$upload} : ($upload) ) {
2801 $t->row( $key, $u->filename, $u->type, $u->size );
2804 $c->log->debug( "File Uploads are:\n" . $t->draw );
2808 =head2 $c->log_request_headers($headers);
2810 Hook method which can be wrapped by plugins to log the request headers.
2811 No-op in the default implementation.
2815 sub log_request_headers {}
2817 =head2 $c->log_headers($type => $headers)
2819 Logs L<HTTP::Headers> (either request or response) to the debug logs.
2826 my $headers = shift; # an HTTP::Headers instance
2828 return unless $c->debug;
2830 my $column_width = Catalyst::Utils::term_width() - 28;
2831 my $t = Text::SimpleTable->new( [ 15, 'Header Name' ], [ $column_width, 'Value' ] );
2834 my ( $name, $value ) = @_;
2835 $t->row( $name, $value );
2838 $c->log->debug( ucfirst($type) . " Headers:\n" . $t->draw );
2842 =head2 $c->prepare_read
2844 Prepares the input for reading.
2848 sub prepare_read { my $c = shift; $c->engine->prepare_read( $c, @_ ) }
2850 =head2 $c->prepare_request
2852 Prepares the engine request.
2856 sub prepare_request { my $c = shift; $c->engine->prepare_request( $c, @_ ) }
2858 =head2 $c->prepare_uploads
2864 sub prepare_uploads {
2866 $c->engine->prepare_uploads( $c, @_ );
2869 =head2 $c->prepare_write
2871 Prepares the output for writing.
2875 sub prepare_write { my $c = shift; $c->engine->prepare_write( $c, @_ ) }
2877 =head2 $c->request_class
2879 Returns or sets the request class. Defaults to L<Catalyst::Request>.
2881 =head2 $app->request_class_traits
2883 An arrayref of L<Moose::Role>s which are applied to the request class. You can
2884 name the full namespace of the role, or a namespace suffix, which will then
2885 be tried against the following standard namespace prefixes.
2887 $MyApp::TraitFor::Request::$trait_suffix
2888 Catalyst::TraitFor::Request::$trait_suffix
2890 So for example if you set:
2892 MyApp->request_class_traits(['Foo']);
2894 We try each possible role in turn (and throw an error if none load)
2897 MyApp::TraitFor::Request::Foo
2898 Catalyst::TraitFor::Request::Foo
2900 The namespace part 'TraitFor::Request' was chosen to assist in backwards
2901 compatibility with L<CatalystX::RoleApplicator> which previously provided
2902 these features in a stand alone package.
2904 =head2 $app->composed_request_class
2906 This is the request class which has been composed with any request_class_traits.
2908 =head2 $c->response_class
2910 Returns or sets the response class. Defaults to L<Catalyst::Response>.
2912 =head2 $app->response_class_traits
2914 An arrayref of L<Moose::Role>s which are applied to the response class. You can
2915 name the full namespace of the role, or a namespace suffix, which will then
2916 be tried against the following standard namespace prefixes.
2918 $MyApp::TraitFor::Response::$trait_suffix
2919 Catalyst::TraitFor::Response::$trait_suffix
2921 So for example if you set:
2923 MyApp->response_class_traits(['Foo']);
2925 We try each possible role in turn (and throw an error if none load)
2928 MyApp::TraitFor::Response::Foo
2929 Catalyst::TraitFor::Responset::Foo
2931 The namespace part 'TraitFor::Response' was chosen to assist in backwards
2932 compatibility with L<CatalystX::RoleApplicator> which previously provided
2933 these features in a stand alone package.
2936 =head2 $app->composed_response_class
2938 This is the request class which has been composed with any response_class_traits.
2940 =head2 $c->read( [$maxlength] )
2942 Reads a chunk of data from the request body. This method is designed to
2943 be used in a while loop, reading C<$maxlength> bytes on every call.
2944 C<$maxlength> defaults to the size of the request if not specified.
2946 You have to set C<< MyApp->config(parse_on_demand => 1) >> to use this
2949 Warning: If you use read(), Catalyst will not process the body,
2950 so you will not be able to access POST parameters or file uploads via
2951 $c->request. You must handle all body parsing yourself.
2955 sub read { my $c = shift; return $c->request->read( @_ ) }
2965 $app->_make_immutable_if_needed;
2966 $app->engine_loader->needs_psgi_engine_compat_hack ?
2967 $app->engine->run($app, @_) :
2968 $app->engine->run( $app, $app->_finalized_psgi_app, @_ );
2971 sub _make_immutable_if_needed {
2973 my $meta = find_meta($class);
2974 my $isa_ca = $class->isa('Class::Accessor::Fast') || $class->isa('Class::Accessor');
2977 && ! { $meta->immutable_options }->{replace_constructor}
2980 warn("You made your application class ($class) immutable, "
2981 . "but did not inline the\nconstructor. "
2982 . "This will break catalyst, as your app \@ISA "
2983 . "Class::Accessor(::Fast)?\nPlease pass "
2984 . "(replace_constructor => 1)\nwhen making your class immutable.\n");
2986 unless ($meta->is_immutable) {
2987 # XXX - FIXME warning here as you should make your app immutable yourself.
2988 $meta->make_immutable(
2989 replace_constructor => 1,
2994 =head2 $c->set_action( $action, $code, $namespace, $attrs )
2996 Sets an action in a given namespace.
3000 sub set_action { my $c = shift; $c->dispatcher->set_action( $c, @_ ) }
3002 =head2 $c->setup_actions($component)
3004 Sets up actions for a component.
3008 sub setup_actions { my $c = shift; $c->dispatcher->setup_actions( $c, @_ ) }
3010 =head2 $c->setup_components
3012 This method is called internally to set up the application's components.
3014 It finds modules by calling the L<locate_components> method, expands them to
3015 package names with the L<expand_component_module> method, and then installs
3016 each component into the application.
3018 The C<setup_components> config option is passed to both of the above methods.
3020 Installation of each component is performed by the L<setup_component> method,
3025 sub setup_components {
3028 my $config = $class->config->{ setup_components };
3030 my @comps = $class->locate_components($config);
3031 my %comps = map { $_ => 1 } @comps;
3033 my $deprecatedcatalyst_component_names = grep { /::[CMV]::/ } @comps;
3034 $class->log->warn(qq{Your application is using the deprecated ::[MVC]:: type naming scheme.\n}.
3035 qq{Please switch your class names to ::Model::, ::View:: and ::Controller: as appropriate.\n}
3036 ) if $deprecatedcatalyst_component_names;
3038 for my $component ( @comps ) {
3040 # We pass ignore_loaded here so that overlay files for (e.g.)
3041 # Model::DBI::Schema sub-classes are loaded - if it's in @comps
3042 # we know M::P::O found a file on disk so this is safe
3044 Catalyst::Utils::ensure_class_loaded( $component, { ignore_loaded => 1 } );
3047 for my $component (@comps) {
3048 my $instance = $class->components->{ $component } = $class->delayed_setup_component($component);
3051 # Inject a component or wrap a stand alone class in an adaptor. This makes a list
3052 # of named components in the configuration that are not actually existing (not a
3055 my @injected = $class->setup_injected_components;
3057 # All components are registered, now we need to 'init' them.
3058 foreach my $component_name (@comps, @injected) {
3059 $class->components->{$component_name} = $class->components->{$component_name}->() if
3060 (ref($class->components->{$component_name}) || '') eq 'CODE';
3064 =head2 $app->setup_injected_components
3066 Called by setup_compoents to setup components that are injected.
3070 sub setup_injected_components {
3072 my @injected_components = keys %{$class->config->{inject_components} ||+{}};
3074 foreach my $injected_comp_name(@injected_components) {
3075 $class->setup_injected_component(
3076 $injected_comp_name,
3077 $class->config->{inject_components}->{$injected_comp_name});
3080 return map { $class ."::" . $_ }
3081 @injected_components;
3084 =head2 $app->setup_injected_component( $injected_component_name, $config )
3086 Setup a given injected component.
3090 sub setup_injected_component {
3091 my ($class, $injected_comp_name, $config) = @_;
3092 if(my $component_class = $config->{from_component}) {
3093 my @roles = @{$config->{roles} ||[]};
3094 Catalyst::Utils::inject_component(
3096 component => $component_class,
3097 (scalar(@roles) ? (traits => \@roles) : ()),
3098 as => $injected_comp_name);
3102 =head2 $app->inject_component($MyApp_Component_name => \%args);
3104 Add a component that is injected at setup:
3106 MyApp->inject_component( 'Model::Foo' => { from_component => 'Common::Foo' } );
3108 Must be called before ->setup. Expects a component name for your
3109 current application and \%args where
3113 =item from_component
3115 The target component being injected into your application
3119 An arrayref of L<Moose::Role>s that are applied to your component.
3125 MyApp->inject_component(
3127 from_component => 'Common::Model::Foo',
3128 roles => ['Role1', 'Role2'],
3131 =head2 $app->inject_components
3133 Inject a list of components:
3135 MyApp->inject_components(
3136 'Model::FooOne' => {
3137 from_component => 'Common::Model::Foo',
3138 roles => ['Role1', 'Role2'],
3140 'Model::FooTwo' => {
3141 from_component => 'Common::Model::Foo',
3142 roles => ['Role1', 'Role2'],
3147 sub inject_component {
3148 my ($app, $name, $args) = @_;
3149 die "Component $name exists" if
3150 $app->config->{inject_components}->{$name};
3151 $app->config->{inject_components}->{$name} = $args;
3154 sub inject_components {
3157 $app->inject_component(shift, shift);
3161 =head2 $c->locate_components( $setup_component_config )
3163 This method is meant to provide a list of component modules that should be
3164 setup for the application. By default, it will use L<Module::Pluggable>.
3166 Specify a C<setup_components> config option to pass additional options directly
3167 to L<Module::Pluggable>. To add additional search paths, specify a key named
3168 C<search_extra> as an array reference. Items in the array beginning with C<::>
3169 will have the application class name prepended to them.
3173 sub locate_components {
3177 my @paths = qw( ::M ::Model ::V ::View ::C ::Controller );
3178 my $extra = $config->{ search_extra } || [];
3180 unshift @paths, @$extra;
3182 my @comps = map { sort { length($a) <=> length($b) } Module::Pluggable::Object->new(
3183 search_path => [ map { s/^(?=::)/$class/; $_; } ($_) ],
3185 )->plugins } @paths;
3190 =head2 $c->expand_component_module( $component, $setup_component_config )
3192 Components found by C<locate_components> will be passed to this method, which
3193 is expected to return a list of component (package) names to be set up.
3197 sub expand_component_module {
3198 my ($class, $module) = @_;
3199 return Devel::InnerPackage::list_packages( $module );
3202 =head2 $app->delayed_setup_component
3204 Returns a coderef that points to a setup_component instance. Used
3205 internally for when you want to delay setup until the first time
3206 the component is called.
3210 sub delayed_setup_component {
3211 my($class, $component, @more) = @_;
3213 return my $instance = $class->setup_component($component, @more);
3217 =head2 $c->setup_component
3221 sub setup_component {
3222 my( $class, $component ) = @_;
3224 unless ( $component->can( 'COMPONENT' ) ) {
3228 my $config = $class->config_for($component);
3229 # Stash catalyst_component_name in the config here, so that custom COMPONENT
3230 # methods also pass it. local to avoid pointlessly shitting in config
3231 # for the debug screen, as $component is already the key name.
3232 local $config->{catalyst_component_name} = $component;
3234 my $instance = eval {
3235 $component->COMPONENT( $class, $config );
3239 Catalyst::Exception->throw(
3240 message => qq/Couldn't instantiate component "$component", "$error"/
3244 unless (blessed $instance) {
3245 my $metaclass = Moose::Util::find_meta($component);
3246 my $method_meta = $metaclass->find_method_by_name('COMPONENT');
3247 my $component_method_from = $method_meta->associated_metaclass->name;
3248 my $value = defined($instance) ? $instance : 'undef';
3249 Catalyst::Exception->throw(
3251 qq/Couldn't instantiate component "$component", COMPONENT() method (from $component_method_from) didn't return an object-like value (value was $value)./
3255 my @expanded_components = $instance->can('expand_modules')
3256 ? $instance->expand_modules( $component, $config )
3257 : $class->expand_component_module( $component, $config );
3258 for my $component (@expanded_components) {
3259 next if $class->components->{ $component };
3260 $class->components->{ $component } = $class->setup_component($component);
3266 =head2 $app->config_for( $component_name )
3268 Return the application level configuration (which is not yet merged with any
3269 local component configuration, via $component_class->config) for the named
3270 component or component object. Example:
3273 'Model::Foo' => { a => 1, b => 2},
3276 my $config = MyApp->config_for('MyApp::Model::Foo');
3278 In this case $config is the hashref C<< {a=>1, b=>2} >>.
3280 This is also handy for looking up configuration for a plugin, to make sure you follow
3281 existing L<Catalyst> standards for where a plugin should put its configuration.
3286 my ($class, $component_name) = @_;
3287 my $component_suffix = Catalyst::Utils::class2classsuffix($component_name);
3288 my $config = $class->config->{ $component_suffix } || {};
3293 =head2 $c->setup_dispatcher
3299 sub setup_dispatcher {
3300 my ( $class, $dispatcher ) = @_;
3303 $dispatcher = 'Catalyst::Dispatcher::' . $dispatcher;
3306 if ( my $env = Catalyst::Utils::env_value( $class, 'DISPATCHER' ) ) {
3307 $dispatcher = 'Catalyst::Dispatcher::' . $env;
3310 unless ($dispatcher) {
3311 $dispatcher = $class->dispatcher_class;
3314 load_class($dispatcher);
3316 # dispatcher instance
3317 $class->dispatcher( $dispatcher->new );
3320 =head2 $c->setup_engine
3327 my ($class, $requested_engine) = @_;
3329 if (!$class->engine_loader || $requested_engine) {
3330 $class->engine_loader(
3331 Catalyst::EngineLoader->new({
3332 application_name => $class,
3333 (defined $requested_engine
3334 ? (catalyst_engine_class => $requested_engine) : ()),
3339 $class->engine_loader->catalyst_engine_class;
3343 my ($class, $requested_engine) = @_;
3346 my $loader = $class->engine_loader;
3348 if (!$loader || $requested_engine) {
3349 $loader = Catalyst::EngineLoader->new({
3350 application_name => $class,
3351 (defined $requested_engine
3352 ? (requested_engine => $requested_engine) : ()),
3355 $class->engine_loader($loader);
3358 $loader->catalyst_engine_class;
3361 # Don't really setup_engine -- see _setup_psgi_app for explanation.
3362 return if $class->loading_psgi_file;
3364 load_class($engine);
3366 if ($ENV{MOD_PERL}) {
3367 my $apache = $class->engine_loader->auto;
3369 my $meta = find_meta($class);
3370 my $was_immutable = $meta->is_immutable;
3371 my %immutable_options = $meta->immutable_options;
3372 $meta->make_mutable if $was_immutable;
3374 $meta->add_method(handler => sub {
3376 my $psgi_app = $class->_finalized_psgi_app;
3377 $apache->call_app($r, $psgi_app);
3380 $meta->make_immutable(%immutable_options) if $was_immutable;
3383 $class->engine( $engine->new );
3388 ## This exists just to supply a prebuild psgi app for mod_perl and for the
3389 ## build in server support (back compat support for pre psgi port behavior).
3390 ## This is so that we don't build a new psgi app for each request when using
3391 ## the mod_perl handler or the built in servers (http and fcgi, etc).
3393 sub _finalized_psgi_app {
3396 unless ($app->_psgi_app) {
3397 my $psgi_app = $app->_setup_psgi_app;
3398 $app->_psgi_app($psgi_app);
3401 return $app->_psgi_app;
3404 ## Look for a psgi file like 'myapp_web.psgi' (if the app is MyApp::Web) in the
3405 ## home directory and load that and return it (just assume it is doing the
3406 ## right thing :) ). If that does not exist, call $app->psgi_app, wrap that
3407 ## in default_middleware and return it ( this is for backward compatibility
3408 ## with pre psgi port behavior ).
3410 sub _setup_psgi_app {
3413 for my $home (Path::Class::Dir->new($app->config->{home})) {
3414 my $psgi_file = $home->file(
3415 Catalyst::Utils::appprefix($app) . '.psgi',
3418 next unless -e $psgi_file;
3420 # If $psgi_file calls ->setup_engine, it's doing so to load
3421 # Catalyst::Engine::PSGI. But if it does that, we're only going to
3422 # throw away the loaded PSGI-app and load the 5.9 Catalyst::Engine
3423 # anyway. So set a flag (ick) that tells setup_engine not to populate
3424 # $c->engine or do any other things we might regret.
3426 $app->loading_psgi_file(1);
3427 my $psgi_app = Plack::Util::load_psgi($psgi_file);
3428 $app->loading_psgi_file(0);
3431 unless $app->engine_loader->needs_psgi_engine_compat_hack;
3434 Found a legacy Catalyst::Engine::PSGI .psgi file at ${psgi_file}.
3436 Its content has been ignored. Please consult the Catalyst::Upgrading
3437 documentation on how to upgrade from Catalyst::Engine::PSGI.
3441 return $app->apply_default_middlewares($app->psgi_app);
3444 =head2 $c->apply_default_middlewares
3446 Adds the following L<Plack> middlewares to your application, since they are
3447 useful and commonly needed:
3449 L<Plack::Middleware::LighttpdScriptNameFix> (if you are using Lighttpd),
3450 L<Plack::Middleware::IIS6ScriptNameFix> (always applied since this middleware
3451 is smart enough to conditionally apply itself).
3453 We will also automatically add L<Plack::Middleware::ReverseProxy> if we notice
3454 that your HTTP $env variable C<REMOTE_ADDR> is '127.0.0.1'. This is usually
3455 an indication that your server is running behind a proxy frontend. However in
3456 2014 this is often not the case. We preserve this code for backwards compatibility
3457 however I B<highly> recommend that if you are running the server behind a front
3458 end proxy that you clearly indicate so with the C<using_frontend_proxy> configuration
3459 setting to true for your environment configurations that run behind a proxy. This
3460 way if you change your front end proxy address someday your code would inexplicably
3461 stop working as expected.
3463 Additionally if we detect we are using Nginx, we add a bit of custom middleware
3464 to solve some problems with the way that server handles $ENV{PATH_INFO} and
3467 Please B<NOTE> that if you do use C<using_frontend_proxy> the middleware is now
3468 adding via C<registered_middleware> rather than this method.
3470 If you are using Lighttpd or IIS6 you may wish to apply these middlewares. In
3471 general this is no longer a common case but we have this here for backward
3477 sub apply_default_middlewares {
3478 my ($app, $psgi_app) = @_;
3480 # Don't add this conditional IF we are explicitly saying we want the
3481 # frontend proxy support. We don't need it here since if that is the
3482 # case it will be always loaded in the default_middleware.
3484 unless($app->config->{using_frontend_proxy}) {
3485 $psgi_app = Plack::Middleware::Conditional->wrap(
3487 builder => sub { Plack::Middleware::ReverseProxy->wrap($_[0]) },
3490 return if $app->config->{ignore_frontend_proxy};
3491 return $env->{REMOTE_ADDR} && $env->{REMOTE_ADDR} eq '127.0.0.1';
3496 # If we're running under Lighttpd, swap PATH_INFO and SCRIPT_NAME
3497 # http://lists.scsys.co.uk/pipermail/catalyst/2006-June/008361.html
3498 $psgi_app = Plack::Middleware::Conditional->wrap(
3500 builder => sub { Plack::Middleware::LighttpdScriptNameFix->wrap($_[0]) },
3503 return unless $env->{SERVER_SOFTWARE} && $env->{SERVER_SOFTWARE} =~ m!lighttpd[-/]1\.(\d+\.\d+)!;
3504 return unless $1 < 4.23;
3509 # we're applying this unconditionally as the middleware itself already makes
3510 # sure it doesn't fuck things up if it's not running under one of the right
3512 $psgi_app = Plack::Middleware::IIS6ScriptNameFix->wrap($psgi_app);
3514 # And another IIS issue, this time with IIS7.
3515 $psgi_app = Plack::Middleware::Conditional->wrap(
3517 builder => sub { Plack::Middleware::IIS7KeepAliveFix->wrap($_[0]) },
3520 return $env->{SERVER_SOFTWARE} && $env->{SERVER_SOFTWARE} =~ m!IIS/7\.[0-9]!;
3527 =head2 App->psgi_app
3531 Returns a PSGI application code reference for the catalyst application
3532 C<$c>. This is the bare application created without the C<apply_default_middlewares>
3533 method called. We do however apply C<registered_middleware> since those are
3534 integral to how L<Catalyst> functions. Also, unlike starting your application
3535 with a generated server script (via L<Catalyst::Devel> and C<catalyst.pl>) we do
3536 not attempt to return a valid L<PSGI> application using any existing C<${myapp}.psgi>
3537 scripts in your $HOME directory.
3539 B<NOTE> C<apply_default_middlewares> was originally created when the first PSGI
3540 port was done for v5.90000. These are middlewares that are added to achieve
3541 backward compatibility with older applications. If you start your application
3542 using one of the supplied server scripts (generated with L<Catalyst::Devel> and
3543 the project skeleton script C<catalyst.pl>) we apply C<apply_default_middlewares>
3544 automatically. This was done so that pre and post PSGI port applications would
3547 This is what you want to be using to retrieve the PSGI application code
3548 reference of your Catalyst application for use in a custom F<.psgi> or in your
3549 own created server modules.
3553 *to_app = \&psgi_app;
3557 my $psgi = $app->engine->build_psgi_app($app);
3558 return $app->Catalyst::Utils::apply_registered_middleware($psgi);
3561 =head2 $c->setup_home
3563 Sets up the home directory.
3568 my ( $class, $home ) = @_;
3570 if ( my $env = Catalyst::Utils::env_value( $class, 'HOME' ) ) {
3574 $home ||= Catalyst::Utils::home($class);
3577 #I remember recently being scolded for assigning config values like this
3578 $class->config->{home} ||= $home;
3579 $class->config->{root} ||= Path::Class::Dir->new($home)->subdir('root');
3583 =head2 $c->setup_encoding
3585 Sets up the input/output encoding. See L<ENCODING>
3589 sub setup_encoding {
3591 if( exists($c->config->{encoding}) && !defined($c->config->{encoding}) ) {
3592 # Ok, so the user has explicitly said "I don't want encoding..."
3595 my $enc = defined($c->config->{encoding}) ?
3596 delete $c->config->{encoding} : 'UTF-8'; # not sure why we delete it... (JNAP)
3601 =head2 handle_unicode_encoding_exception
3603 Hook to let you customize how encoding errors are handled. By default
3604 we just throw an exception and the default error page will pick it up.
3605 Receives a hashref of debug information. Example of call (from the
3606 Catalyst internals):
3608 my $decoded_after_fail = $c->handle_unicode_encoding_exception({
3609 param_value => $value,
3611 encoding_step => 'params',
3614 The calling code expects to receive a decoded string or an exception.
3616 You can override this for custom handling of unicode errors. By
3617 default we just die. If you want a custom response here, one approach
3618 is to throw an HTTP style exception, instead of returning a decoded
3619 string or throwing a generic exception.
3621 sub handle_unicode_encoding_exception {
3622 my ($c, $params) = @_;
3623 HTTP::Exception::BAD_REQUEST->throw(status_message=>$params->{error_msg});
3626 Alternatively you can 'catch' the error, stash it and write handling code later
3627 in your application:
3629 sub handle_unicode_encoding_exception {
3630 my ($c, $params) = @_;
3631 $c->stash(BAD_UNICODE_DATA=>$params);
3632 # return a dummy string.
3636 <B>NOTE:</b> Please keep in mind that once an error like this occurs,
3637 the request setup is still ongoing, which means the state of C<$c> and
3638 related context parts like the request and response may not be setup
3639 up correctly (since we haven't finished the setup yet). If you throw
3640 an exception the setup is aborted.
3644 sub handle_unicode_encoding_exception {
3645 my ( $self, $exception_ctx ) = @_;
3646 die $exception_ctx->{error_msg};
3649 # Some unicode helpers cargo culted from the old plugin. These could likely
3652 sub _handle_unicode_decoding {
3653 my ( $self, $value ) = @_;
3655 return unless defined $value;
3657 ## I think this mess is to support the old nested
3658 if ( ref $value eq 'ARRAY' ) {
3659 foreach ( @$value ) {
3660 $_ = $self->_handle_unicode_decoding($_);
3664 elsif ( ref $value eq 'HASH' ) {
3665 foreach (keys %$value) {
3666 my $encoded_key = $self->_handle_param_unicode_decoding($_);
3667 $value->{$encoded_key} = $self->_handle_unicode_decoding($value->{$_});
3669 # If the key was encoded we now have two (the original and current so
3670 # delete the original.
3671 delete $value->{$_} if $_ ne $encoded_key;
3676 return $self->_handle_param_unicode_decoding($value);
3680 sub _handle_param_unicode_decoding {
3681 my ( $self, $value, $check ) = @_;
3682 return unless defined $value; # not in love with just ignoring undefs - jnap
3683 return $value if blessed($value); #don't decode when the value is an object.
3685 my $enc = $self->encoding;
3687 return $value unless $enc; # don't decode if no encoding is specified
3689 $check ||= $self->_encode_check;
3691 $enc->decode( $value, $check);
3694 return $self->handle_unicode_encoding_exception({
3695 param_value => $value,
3697 encoding_step => 'params',
3702 =head2 $c->setup_log
3704 Sets up log by instantiating a L<Catalyst::Log|Catalyst::Log> object and
3705 passing it to C<log()>. Pass in a comma-delimited list of levels to set the
3708 This method also installs a C<debug> method that returns a true value into the
3709 catalyst subclass if the "debug" level is passed in the comma-delimited list,
3710 or if the C<$CATALYST_DEBUG> environment variable is set to a true value.
3712 Note that if the log has already been setup, by either a previous call to
3713 C<setup_log> or by a call such as C<< __PACKAGE__->log( MyLogger->new ) >>,
3714 that this method won't actually set up the log object.
3719 my ( $class, $levels ) = @_;
3722 $levels =~ s/^\s+//;
3723 $levels =~ s/\s+$//;
3724 my %levels = map { $_ => 1 } split /\s*,\s*/, $levels;
3726 my $env_debug = Catalyst::Utils::env_value( $class, 'DEBUG' );
3727 if ( defined $env_debug ) {
3728 $levels{debug} = 1 if $env_debug; # Ugly!
3729 delete($levels{debug}) unless $env_debug;
3732 unless ( $class->log ) {
3733 $class->log( Catalyst::Log->new(keys %levels) );
3736 if ( $levels{debug} ) {
3737 Class::MOP::get_metaclass_by_name($class)->add_method('debug' => sub { 1 });
3738 $class->log->debug('Debug messages enabled');
3742 =head2 $c->setup_plugins
3748 =head2 $c->setup_stats
3750 Sets up timing statistics class.
3755 my ( $class, $stats ) = @_;
3757 Catalyst::Utils::ensure_class_loaded($class->stats_class);
3759 my $env = Catalyst::Utils::env_value( $class, 'STATS' );
3760 if ( defined($env) ? $env : ($stats || $class->debug ) ) {
3761 Class::MOP::get_metaclass_by_name($class)->add_method('use_stats' => sub { 1 });
3762 $class->log->debug('Statistics enabled');
3767 =head2 $c->registered_plugins
3769 Returns a sorted list of the plugins which have either been stated in the
3772 If passed a given plugin name, it will report a boolean value indicating
3773 whether or not that plugin is loaded. A fully qualified name is required if
3774 the plugin name does not begin with C<Catalyst::Plugin::>.
3776 if ($c->registered_plugins('Some::Plugin')) {
3784 sub registered_plugins {
3786 return sort keys %{ $proto->_plugins } unless @_;
3788 return 1 if exists $proto->_plugins->{$plugin};
3789 return exists $proto->_plugins->{"Catalyst::Plugin::$plugin"};
3792 sub _register_plugin {
3793 my ( $proto, $plugin, $instant ) = @_;
3794 my $class = ref $proto || $proto;
3796 load_class( $plugin );
3797 $class->log->warn( "$plugin inherits from 'Catalyst::Component' - this is deprecated and will not work in 5.81" )
3798 if $plugin->isa( 'Catalyst::Component' );
3799 my $plugin_meta = Moose::Meta::Class->create($plugin);
3800 if (!$plugin_meta->has_method('new')
3801 && ( $plugin->isa('Class::Accessor::Fast') || $plugin->isa('Class::Accessor') ) ) {
3802 $plugin_meta->add_method('new', Moose::Object->meta->get_method('new'))
3804 if (!$instant && !$proto->_plugins->{$plugin}) {
3805 my $meta = Class::MOP::get_metaclass_by_name($class);
3806 $meta->superclasses($plugin, $meta->superclasses);
3808 $proto->_plugins->{$plugin} = 1;
3812 sub _default_plugins { return qw() }
3815 my ( $class, $plugins ) = @_;
3817 $class->_plugins( {} ) unless $class->_plugins;
3819 m/Unicode::Encoding/ ? do {
3821 'Unicode::Encoding plugin is auto-applied,'
3822 . ' please remove this from your appclass'
3823 . ' and make sure to define "encoding" config'
3825 unless (exists $class->config->{'encoding'}) {
3826 $class->config->{'encoding'} = 'UTF-8';
3831 push @$plugins, $class->_default_plugins;
3832 $plugins = Data::OptList::mkopt($plugins || []);
3835 [ Catalyst::Utils::resolve_namespace(
3836 $class . '::Plugin',
3837 'Catalyst::Plugin', $_->[0]
3843 for my $plugin ( reverse @plugins ) {
3844 load_class($plugin->[0], $plugin->[1]);
3845 my $meta = find_meta($plugin->[0]);
3846 next if $meta && $meta->isa('Moose::Meta::Role');
3848 $class->_register_plugin($plugin->[0]);
3852 map { $_->[0]->name, $_->[1] }
3853 grep { blessed($_->[0]) && $_->[0]->isa('Moose::Meta::Role') }
3854 map { [find_meta($_->[0]), $_->[1]] }
3857 Moose::Util::apply_all_roles(
3863 =head2 default_middleware
3865 Returns a list of instantiated PSGI middleware objects which is the default
3866 middleware that is active for this application (taking any configuration
3867 options into account, excluding your custom added middleware via the C<psgi_middleware>
3868 configuration option). You can override this method if you wish to change
3869 the default middleware (although do so at risk since some middleware is vital
3870 to application function.)
3872 The current default middleware list is:
3874 Catalyst::Middleware::Stash
3875 Plack::Middleware::HTTPExceptions
3876 Plack::Middleware::RemoveRedundantBody
3877 Plack::Middleware::FixMissingBodyInRedirect
3878 Plack::Middleware::ContentLength
3879 Plack::Middleware::MethodOverride
3880 Plack::Middleware::Head
3882 If the configuration setting C<using_frontend_proxy> is true we add:
3884 Plack::Middleware::ReverseProxy
3886 If the configuration setting C<using_frontend_proxy_path> is true we add:
3888 Plack::Middleware::ReverseProxyPath
3890 But B<NOTE> that L<Plack::Middleware::ReverseProxyPath> is not a dependency of the
3891 L<Catalyst> distribution so if you want to use this option you should add it to
3892 your project distribution file.
3894 These middlewares will be added at L</setup_middleware> during the
3895 L</setup> phase of application startup.
3899 sub default_middleware {
3902 Catalyst::Middleware::Stash->new,
3903 Plack::Middleware::HTTPExceptions->new,
3904 Plack::Middleware::RemoveRedundantBody->new,
3905 Plack::Middleware::FixMissingBodyInRedirect->new,
3906 Plack::Middleware::ContentLength->new,
3907 Plack::Middleware::MethodOverride->new,
3908 Plack::Middleware::Head->new);
3910 if($class->config->{using_frontend_proxy}) {
3911 push @mw, Plack::Middleware::ReverseProxy->new;
3914 if($class->config->{using_frontend_proxy_path}) {
3915 if(Class::Load::try_load_class('Plack::Middleware::ReverseProxyPath')) {
3916 push @mw, Plack::Middleware::ReverseProxyPath->new;
3918 $class->log->error("Cannot use configuration 'using_frontend_proxy_path' because 'Plack::Middleware::ReverseProxyPath' is not installed");
3925 =head2 registered_middlewares
3927 Read only accessor that returns an array of all the middleware in the order
3928 that they were added (which is the REVERSE of the order they will be applied).
3930 The values returned will be either instances of L<Plack::Middleware> or of a
3931 compatible interface, or a coderef, which is assumed to be inlined middleware
3933 =head2 setup_middleware (?@middleware)
3935 Read configuration information stored in configuration key C<psgi_middleware> or
3938 See under L</CONFIGURATION> information regarding C<psgi_middleware> and how
3939 to use it to enable L<Plack::Middleware>
3941 This method is automatically called during 'setup' of your application, so
3942 you really don't need to invoke it. However you may do so if you find the idea
3943 of loading middleware via configuration weird :). For example:
3949 __PACKAGE__->setup_middleware('Head');
3952 When we read middleware definitions from configuration, we reverse the list
3953 which sounds odd but is likely how you expect it to work if you have prior
3954 experience with L<Plack::Builder> or if you previously used the plugin
3955 L<Catalyst::Plugin::EnableMiddleware> (which is now considered deprecated)
3957 So basically your middleware handles an incoming request from the first
3958 registered middleware, down and handles the response from the last middleware
3963 sub registered_middlewares {
3965 if(my $middleware = $class->_psgi_middleware) {
3966 my @mw = ($class->default_middleware, @$middleware);
3968 if($class->config->{using_frontend_proxy}) {
3969 push @mw, Plack::Middleware::ReverseProxy->new;
3974 die "You cannot call ->registered_middlewares until middleware has been setup";
3978 sub setup_middleware {
3980 my @middleware_definitions;
3982 # If someone calls this method you can add middleware with args. However if its
3983 # called without an arg we need to setup the configuration middleware.
3985 @middleware_definitions = reverse(@_);
3987 @middleware_definitions = reverse(@{$class->config->{'psgi_middleware'}||[]})
3988 unless $class->finalized_default_middleware;
3989 $class->finalized_default_middleware(1); # Only do this once, just in case some people call setup over and over...
3992 my @middleware = ();
3993 while(my $next = shift(@middleware_definitions)) {
3995 if(Scalar::Util::blessed $next && $next->can('wrap')) {
3996 push @middleware, $next;
3997 } elsif(ref $next eq 'CODE') {
3998 push @middleware, $next;
3999 } elsif(ref $next eq 'HASH') {
4000 my $namespace = shift @middleware_definitions;
4001 my $mw = $class->Catalyst::Utils::build_middleware($namespace, %$next);
4002 push @middleware, $mw;
4004 die "I can't handle middleware definition ${\ref $next}";
4007 my $mw = $class->Catalyst::Utils::build_middleware($next);
4008 push @middleware, $mw;
4012 my @existing = @{$class->_psgi_middleware || []};
4013 $class->_psgi_middleware([@middleware,@existing,]);
4016 =head2 registered_data_handlers
4018 A read only copy of registered Data Handlers returned as a Hash, where each key
4019 is a content type and each value is a subref that attempts to decode that content
4022 =head2 setup_data_handlers (?@data_handler)
4024 Read configuration information stored in configuration key C<data_handlers> or
4027 See under L</CONFIGURATION> information regarding C<data_handlers>.
4029 This method is automatically called during 'setup' of your application, so
4030 you really don't need to invoke it.
4032 =head2 default_data_handlers
4034 Default Data Handlers that come bundled with L<Catalyst>. Currently there are
4035 only two default data handlers, for 'application/json' and an alternative to
4036 'application/x-www-form-urlencoded' which supposed nested form parameters via
4037 L<CGI::Struct> or via L<CGI::Struct::XS> IF you've installed it.
4039 The 'application/json' data handler is used to parse incoming JSON into a Perl
4040 data structure. It uses L<JSON::MaybeXS>. This allows you to fail back to
4041 L<JSON::PP>, which is a Pure Perl JSON decoder, and has the smallest dependency
4044 Because we don't wish to add more dependencies to L<Catalyst>, if you wish to
4045 use this new feature we recommend installing L<Cpanel::JSON::XS> in order to get
4046 the best performance. You should add either to your dependency list
4047 (Makefile.PL, dist.ini, cpanfile, etc.)
4051 sub registered_data_handlers {
4053 if(my $data_handlers = $class->_data_handlers) {
4054 return %$data_handlers;
4056 $class->setup_data_handlers;
4057 return $class->registered_data_handlers;
4061 sub setup_data_handlers {
4062 my ($class, %data_handler_callbacks) = @_;
4063 %data_handler_callbacks = (
4064 %{$class->default_data_handlers},
4065 %{$class->config->{'data_handlers'}||+{}},
4066 %data_handler_callbacks);
4068 $class->_data_handlers(\%data_handler_callbacks);
4071 sub default_data_handlers {
4074 'application/x-www-form-urlencoded' => sub {
4075 my ($fh, $req) = @_;
4076 my $params = $req->_use_hash_multivalue ? $req->body_parameters->mixed : $req->body_parameters;
4077 Class::Load::load_first_existing_class('CGI::Struct::XS', 'CGI::Struct')
4078 ->can('build_cgi_struct')->($params);
4080 'application/json' => sub {
4081 my ($fh, $req) = @_;
4082 require JSON::MaybeXS;
4086 $slurped = $fh->getline;
4087 JSON::MaybeXS::decode_json($slurped); # decode_json does utf8 decoding for us
4088 } || Catalyst::Exception->throw(sprintf "Error Parsing POST '%s', Error: %s", (defined($slurped) ? $slurped : 'undef') ,$@);
4093 sub _handle_http_exception {
4094 my ( $self, $error ) = @_;
4096 !$self->config->{always_catch_http_exceptions}
4099 $error->can('as_psgi')
4100 || ( $error->can('code')
4101 && $error->code =~ m/^[1-5][0-9][0-9]$/ )
4111 Returns an arrayref of the internal execution stack (actions that are
4112 currently executing).
4116 Returns the current timing statistics object. By default Catalyst uses
4117 L<Catalyst::Stats|Catalyst::Stats>, but can be set otherwise with
4118 L<< stats_class|/"$c->stats_class" >>.
4120 Even if L<< -Stats|/"-Stats" >> is not enabled, the stats object is still
4121 available. By enabling it with C<< $c->stats->enabled(1) >>, it can be used to
4122 profile explicitly, although MyApp.pm still won't profile nor output anything
4125 =head2 $c->stats_class
4127 Returns or sets the stats (timing statistics) class. L<Catalyst::Stats|Catalyst::Stats> is used by default.
4129 =head2 $app->stats_class_traits
4131 A arrayref of L<Moose::Role>s that are applied to the stats_class before creating it.
4133 =head2 $app->composed_stats_class
4135 this is the stats_class composed with any 'stats_class_traits'. You can
4136 name the full namespace of the role, or a namespace suffix, which will then
4137 be tried against the following standard namespace prefixes.
4139 $MyApp::TraitFor::Stats::$trait_suffix
4140 Catalyst::TraitFor::Stats::$trait_suffix
4142 So for example if you set:
4144 MyApp->stats_class_traits(['Foo']);
4146 We try each possible role in turn (and throw an error if none load)
4149 MyApp::TraitFor::Stats::Foo
4150 Catalyst::TraitFor::Stats::Foo
4152 The namespace part 'TraitFor::Stats' was chosen to assist in backwards
4153 compatibility with L<CatalystX::RoleApplicator> which previously provided
4154 these features in a stand alone package.
4156 =head2 $c->use_stats
4158 Returns 1 when L<< stats collection|/"-Stats" >> is enabled.
4160 Note that this is a static method, not an accessor and should be overridden
4161 by declaring C<sub use_stats { 1 }> in your MyApp.pm, not by calling C<< $c->use_stats(1) >>.
4168 =head2 $c->write( $data )
4170 Writes $data to the output stream. When using this method directly, you
4171 will need to manually set the C<Content-Length> header to the length of
4172 your output data, if known.
4179 # Finalize headers if someone manually writes output (for compat)
4180 $c->finalize_headers;
4182 return $c->response->write( @_ );
4187 Returns the Catalyst version number. Mostly useful for "powered by"
4188 messages in template systems.
4192 sub version { return $Catalyst::VERSION }
4194 =head1 CONFIGURATION
4196 There are a number of 'base' config variables which can be set:
4202 C<always_catch_http_exceptions> - As of version 5.90060 Catalyst
4203 rethrows errors conforming to the interface described by
4204 L<Plack::Middleware::HTTPExceptions> and lets the middleware deal with it.
4205 Set true to get the deprecated behaviour and have Catalyst catch HTTP exceptions.
4209 C<default_model> - The default model picked if you say C<< $c->model >>. See L<< /$c->model($name) >>.
4213 C<default_view> - The default view to be rendered or returned when C<< $c->view >> is called. See L<< /$c->view($name) >>.
4217 C<disable_component_resolution_regex_fallback> - Turns
4218 off the deprecated component resolution functionality so
4219 that if any of the component methods (e.g. C<< $c->controller('Foo') >>)
4220 are called then regex search will not be attempted on string values and
4221 instead C<undef> will be returned.
4225 C<home> - The application home directory. In an uninstalled application,
4226 this is the top level application directory. In an installed application,
4227 this will be the directory containing C<< MyApp.pm >>.
4231 C<ignore_frontend_proxy> - See L</PROXY SUPPORT>
4235 C<name> - The name of the application in debug messages and the debug and
4240 C<parse_on_demand> - The request body (for example file uploads) will not be parsed
4241 until it is accessed. This allows you to (for example) check authentication (and reject
4242 the upload) before actually receiving all the data. See L</ON-DEMAND PARSER>
4246 C<root> - The root directory for templates. Usually this is just a
4247 subdirectory of the home directory, but you can set it to change the
4248 templates to a different directory.
4252 C<search_extra> - Array reference passed to Module::Pluggable to for additional
4253 namespaces from which components will be loaded (and constructed and stored in
4254 C<< $c->components >>).
4258 C<show_internal_actions> - If true, causes internal actions such as C<< _DISPATCH >>
4259 to be shown in hit debug tables in the test server.
4263 C<use_request_uri_for_path> - Controls if the C<REQUEST_URI> or C<PATH_INFO> environment
4264 variable should be used for determining the request path.
4266 Most web server environments pass the requested path to the application using environment variables,
4267 from which Catalyst has to reconstruct the request base (i.e. the top level path to / in the application,
4268 exposed as C<< $c->request->base >>) and the request path below that base.
4270 There are two methods of doing this, both of which have advantages and disadvantages. Which method is used
4271 is determined by the C<< $c->config(use_request_uri_for_path) >> setting (which can either be true or false).
4275 =item use_request_uri_for_path => 0
4277 This is the default (and the) traditional method that Catalyst has used for determining the path information.
4278 The path is generated from a combination of the C<PATH_INFO> and C<SCRIPT_NAME> environment variables.
4279 The allows the application to behave correctly when C<mod_rewrite> is being used to redirect requests
4280 into the application, as these variables are adjusted by mod_rewrite to take account for the redirect.
4282 However this method has the major disadvantage that it is impossible to correctly decode some elements
4283 of the path, as RFC 3875 says: "C<< Unlike a URI path, the PATH_INFO is not URL-encoded, and cannot
4284 contain path-segment parameters. >>" This means PATH_INFO is B<always> decoded, and therefore Catalyst
4285 can't distinguish / vs %2F in paths (in addition to other encoded values).
4287 =item use_request_uri_for_path => 1
4289 This method uses the C<REQUEST_URI> and C<SCRIPT_NAME> environment variables. As C<REQUEST_URI> is never
4290 decoded, this means that applications using this mode can correctly handle URIs including the %2F character
4291 (i.e. with C<AllowEncodedSlashes> set to C<On> in Apache).
4293 Given that this method of path resolution is provably more correct, it is recommended that you use
4294 this unless you have a specific need to deploy your application in a non-standard environment, and you are
4295 aware of the implications of not being able to handle encoded URI paths correctly.
4297 However it also means that in a number of cases when the app isn't installed directly at a path, but instead
4298 is having paths rewritten into it (e.g. as a .cgi/fcgi in a public_html directory, with mod_rewrite in a
4299 .htaccess file, or when SSI is used to rewrite pages into the app, or when sub-paths of the app are exposed
4300 at other URIs than that which the app is 'normally' based at with C<mod_rewrite>), the resolution of
4301 C<< $c->request->base >> will be incorrect.
4307 C<using_frontend_proxy> - See L</PROXY SUPPORT>.
4311 C<using_frontend_proxy_path> - Enabled L<Plack::Middleware::ReverseProxyPath> on your application (if
4312 installed, otherwise log an error). This is useful if your application is not running on the
4313 'root' (or /) of your host server. B<NOTE> if you use this feature you should add the required
4314 middleware to your project dependency list since its not automatically a dependency of L<Catalyst>.
4315 This has been done since not all people need this feature and we wish to restrict the growth of
4316 L<Catalyst> dependencies.
4320 C<encoding> - See L</ENCODING>
4322 This now defaults to 'UTF-8'. You my turn it off by setting this configuration
4327 C<abort_chain_on_error_fix>
4331 When there is an error in an action chain, the default behavior is to
4332 abort the processing of the remaining actions to avoid running them
4333 when the application is in an unexpected state.
4335 Before version 5.90070, the default used to be false. To keep the old
4336 behaviour, you can explicitly set the value to false. E.g.
4338 __PACKAGE__->config(abort_chain_on_error_fix => 0);
4340 If this setting is set to false, then the remaining actions are
4341 performed and the error is caught at the end of the chain.
4346 C<use_hash_multivalue_in_request>
4348 In L<Catalyst::Request> the methods C<query_parameters>, C<body_parametes>
4349 and C<parameters> return a hashref where values might be scalar or an arrayref
4350 depending on the incoming data. In many cases this can be undesirable as it
4351 leads one to writing defensive code like the following:
4353 my ($val) = ref($c->req->parameters->{a}) ?
4354 @{$c->req->parameters->{a}} :
4355 $c->req->parameters->{a};
4357 Setting this configuration item to true will make L<Catalyst> populate the
4358 attributes underlying these methods with an instance of L<Hash::MultiValue>
4359 which is used by L<Plack::Request> and others to solve this very issue. You
4360 may prefer this behavior to the default, if so enable this option (be warned
4361 if you enable it in a legacy application we are not sure if it is completely
4362 backwardly compatible).
4366 C<skip_complex_post_part_handling>
4368 When creating body parameters from a POST, if we run into a multipart POST
4369 that does not contain uploads, but instead contains inlined complex data
4370 (very uncommon) we cannot reliably convert that into field => value pairs. So
4371 instead we create an instance of L<Catalyst::Request::PartData>. If this causes
4372 issue for you, you can disable this by setting C<skip_complex_post_part_handling>
4373 to true (default is false).
4377 C<skip_body_param_unicode_decoding>
4379 Generally we decode incoming POST params based on your declared encoding (the
4380 default for this is to decode UTF-8). If this is causing you trouble and you
4381 do not wish to turn all encoding support off (with the C<encoding> configuration
4382 parameter) you may disable this step atomically by setting this configuration
4387 C<do_not_decode_query>
4389 If true, then do not try to character decode any wide characters in your
4390 request URL query or keywords. Most readings of the relevant specifications
4391 suggest these should be UTF-* encoded, which is the default that L<Catalyst>
4392 will use, however if you are creating a lot of URLs manually or have external
4393 evil clients, this might cause you trouble. If you find the changes introduced
4394 in Catalyst version 5.90080+ break some of your query code, you may disable
4395 the UTF-8 decoding globally using this configuration.
4397 This setting takes precedence over C<default_query_encoding>
4401 C<do_not_check_query_encoding>
4403 Catalyst versions 5.90080 - 5.90106 would decode query parts of an incoming
4404 request but would not raise an exception when the decoding failed due to
4405 incorrect unicode. It now does, but if this change is giving you trouble
4406 you may disable it by setting this configuration to true.
4410 C<default_query_encoding>
4412 By default we decode query and keywords in your request URL using UTF-8, which
4413 is our reading of the relevant specifications. This setting allows one to
4414 specify a fixed value for how to decode your query. You might need this if
4415 you are doing a lot of custom encoding of your URLs and not using UTF-8.
4419 C<use_chained_args_0_special_case>
4421 In older versions of Catalyst, when more than one action matched the same path
4422 AND all those matching actions declared Args(0), we'd break the tie by choosing
4423 the first action defined. We now normalized how Args(0) works so that it
4424 follows the same rule as Args(N), which is to say when we need to break a tie
4425 we choose the LAST action defined. If this breaks your code and you don't
4426 have time to update to follow the new normalized approach, you may set this
4427 value to true and it will globally revert to the original chaining behavior.
4431 C<psgi_middleware> - See L<PSGI MIDDLEWARE>.
4435 C<data_handlers> - See L<DATA HANDLERS>.
4439 C<stats_class_traits>
4441 An arrayref of L<Moose::Role>s that get composed into your stats class.
4445 C<request_class_traits>
4447 An arrayref of L<Moose::Role>s that get composed into your request class.
4451 C<response_class_traits>
4453 An arrayref of L<Moose::Role>s that get composed into your response class.
4457 C<inject_components>
4459 A Hashref of L<Catalyst::Component> subclasses that are 'injected' into configuration.
4463 inject_components => {
4464 'Controller::Err' => { from_component => 'Local::Controller::Errors' },
4465 'Model::Zoo' => { from_component => 'Local::Model::Foo' },
4466 'Model::Foo' => { from_component => 'Local::Model::Foo', roles => ['TestRole'] },
4468 'Controller::Err' => { a => 100, b=>200, namespace=>'error' },
4469 'Model::Zoo' => { a => 2 },
4470 'Model::Foo' => { a => 100 },
4473 Generally L<Catalyst> looks for components in your Model/View or Controller directories.
4474 However for cases when you which to use an existing component and you don't need any
4475 customization (where for when you can apply a role to customize it) you may inject those
4476 components into your application. Please note any configuration should be done 'in the
4477 normal way', with a key under configuration named after the component affix, as in the
4480 Using this type of injection allows you to construct significant amounts of your application
4481 with only configuration!. This may or may not lead to increased code understanding.
4483 Please not you may also call the ->inject_components application method as well, although
4484 you must do so BEFORE setup.
4490 Generally when you throw an exception inside an Action (or somewhere in
4491 your stack, such as in a model that an Action is calling) that exception
4492 is caught by Catalyst and unless you either catch it yourself (via eval
4493 or something like L<Try::Tiny> or by reviewing the L</error> stack, it
4494 will eventually reach L</finalize_errors> and return either the debugging
4495 error stack page, or the default error page. However, if your exception
4496 can be caught by L<Plack::Middleware::HTTPExceptions>, L<Catalyst> will
4497 instead rethrow it so that it can be handled by that middleware (which
4498 is part of the default middleware). For example this would allow
4500 use HTTP::Throwable::Factory 'http_throw';
4502 sub throws_exception :Local {
4503 my ($self, $c) = @_;
4505 http_throw(SeeOther => { location =>
4506 $c->uri_for($self->action_for('redirect')) });
4510 =head1 INTERNAL ACTIONS
4512 Catalyst uses internal actions like C<_DISPATCH>, C<_BEGIN>, C<_AUTO>,
4513 C<_ACTION>, and C<_END>. These are by default not shown in the private
4514 action table, but you can make them visible with a config parameter.
4516 MyApp->config(show_internal_actions => 1);
4518 =head1 ON-DEMAND PARSER
4520 The request body is usually parsed at the beginning of a request,
4521 but if you want to handle input yourself, you can enable on-demand
4522 parsing with a config parameter.
4524 MyApp->config(parse_on_demand => 1);
4526 =head1 PROXY SUPPORT
4528 Many production servers operate using the common double-server approach,
4529 with a lightweight frontend web server passing requests to a larger
4530 backend server. An application running on the backend server must deal
4531 with two problems: the remote user always appears to be C<127.0.0.1> and
4532 the server's hostname will appear to be C<localhost> regardless of the
4533 virtual host that the user connected through.
4535 Catalyst will automatically detect this situation when you are running
4536 the frontend and backend servers on the same machine. The following
4537 changes are made to the request.
4539 $c->req->address is set to the user's real IP address, as read from
4540 the HTTP X-Forwarded-For header.
4542 The host value for $c->req->base and $c->req->uri is set to the real
4543 host, as read from the HTTP X-Forwarded-Host header.
4545 Additionally, you may be running your backend application on an insecure
4546 connection (port 80) while your frontend proxy is running under SSL. If there
4547 is a discrepancy in the ports, use the HTTP header C<X-Forwarded-Port> to
4548 tell Catalyst what port the frontend listens on. This will allow all URIs to
4549 be created properly.
4551 In the case of passing in:
4553 X-Forwarded-Port: 443
4555 All calls to C<uri_for> will result in an https link, as is expected.
4557 Obviously, your web server must support these headers for this to work.
4559 In a more complex server farm environment where you may have your
4560 frontend proxy server(s) on different machines, you will need to set a
4561 configuration option to tell Catalyst to read the proxied data from the
4564 MyApp->config(using_frontend_proxy => 1);
4566 If you do not wish to use the proxy support at all, you may set:
4568 MyApp->config(ignore_frontend_proxy => 0);
4570 =head2 Note about psgi files
4572 Note that if you supply your own .psgi file, calling
4573 C<< MyApp->psgi_app(@_); >>, then B<this will not happen automatically>.
4575 You either need to apply L<Plack::Middleware::ReverseProxy> yourself
4576 in your psgi, for example:
4579 enable "Plack::Middleware::ReverseProxy";
4583 This will unconditionally add the ReverseProxy support, or you need to call
4584 C<< $app = MyApp->apply_default_middlewares($app) >> (to conditionally
4585 apply the support depending upon your config).
4587 See L<Catalyst::PSGI> for more information.
4589 =head1 THREAD SAFETY
4591 Catalyst has been tested under Apache 2's threading C<mpm_worker>,
4592 C<mpm_winnt>, and the standalone forking HTTP server on Windows. We
4593 believe the Catalyst core to be thread-safe.
4595 If you plan to operate in a threaded environment, remember that all other
4596 modules you are using must also be thread-safe. Some modules, most notably
4597 L<DBD::SQLite>, are not thread-safe.
4599 =head1 DATA HANDLERS
4601 The L<Catalyst::Request> object uses L<HTTP::Body> to populate 'classic' HTML
4602 form parameters and URL search query fields. However it has become common
4603 for various alternative content types to be PUT or POSTed to your controllers
4604 and actions. People working on RESTful APIs, or using AJAX often use JSON,
4605 XML and other content types when communicating with an application server. In
4606 order to better support this use case, L<Catalyst> defines a global configuration
4607 option, C<data_handlers>, which lets you associate a content type with a coderef
4608 that parses that content type into something Perl can readily access.
4615 __PACKAGE__->config(
4617 'application/json' => sub { local $/; decode_json $_->getline },
4619 ## Any other configuration.
4624 By default L<Catalyst> comes with a generic JSON data handler similar to the
4625 example given above, which uses L<JSON::MaybeXS> to provide either L<JSON::PP>
4626 (a pure Perl, dependency free JSON parser) or L<Cpanel::JSON::XS> if you have
4627 it installed (if you want the faster XS parser, add it to you project Makefile.PL
4628 or dist.ini, cpanfile, etc.)
4630 The C<data_handlers> configuration is a hashref whose keys are HTTP Content-Types
4631 (matched against the incoming request type using a regexp such as to be case
4632 insensitive) and whose values are coderefs that receive a localized version of
4633 C<$_> which is a filehandle object pointing to received body.
4635 This feature is considered an early access release and we reserve the right
4636 to alter the interface in order to provide a performant and secure solution to
4637 alternative request body content. Your reports welcomed!
4639 =head1 PSGI MIDDLEWARE
4641 You can define middleware, defined as L<Plack::Middleware> or a compatible
4642 interface in configuration. Your middleware definitions are in the form of an
4643 arrayref under the configuration key C<psgi_middleware>. Here's an example
4644 with details to follow:
4649 use Plack::Middleware::StackTrace;
4651 my $stacktrace_middleware = Plack::Middleware::StackTrace->new;
4653 __PACKAGE__->config(
4654 'psgi_middleware', [
4657 $stacktrace_middleware,
4658 'Session' => {store => 'File'},
4663 $env->{myapp.customkey} = 'helloworld';
4672 So the general form is:
4674 __PACKAGE__->config(psgi_middleware => \@middleware_definitions);
4676 Where C<@middleware> is one or more of the following, applied in the REVERSE of
4677 the order listed (to make it function similarly to L<Plack::Builder>:
4679 Alternatively, you may also define middleware by calling the L</setup_middleware>
4686 __PACKAGE__->setup_middleware( \@middleware_definitions);
4689 In the case where you do both (use 'setup_middleware' and configuration) the
4690 package call to setup_middleware will be applied earlier (in other words its
4691 middleware will wrap closer to the application). Keep this in mind since in
4692 some cases the order of middleware is important.
4694 The two approaches are not exclusive.
4698 =item Middleware Object
4700 An already initialized object that conforms to the L<Plack::Middleware>
4703 my $stacktrace_middleware = Plack::Middleware::StackTrace->new;
4705 __PACKAGE__->config(
4706 'psgi_middleware', [
4707 $stacktrace_middleware,
4713 A coderef that is an inlined middleware:
4715 __PACKAGE__->config(
4716 'psgi_middleware', [
4721 if($env->{PATH_INFO} =~m/forced/) {
4723 ->new(file=>TestApp->path_to(qw/share static forced.txt/))
4726 return $app->($env);
4736 We assume the scalar refers to a namespace after normalizing it using the
4739 (1) If the scalar is prefixed with a "+" (as in C<+MyApp::Foo>) then the full string
4740 is assumed to be 'as is', and we just install and use the middleware.
4742 (2) If the scalar begins with "Plack::Middleware" or your application namespace
4743 (the package name of your Catalyst application subclass), we also assume then
4744 that it is a full namespace, and use it.
4746 (3) Lastly, we then assume that the scalar is a partial namespace, and attempt to
4747 resolve it first by looking for it under your application namespace (for example
4748 if you application is "MyApp::Web" and the scalar is "MyMiddleware", we'd look
4749 under "MyApp::Web::Middleware::MyMiddleware") and if we don't find it there, we
4750 will then look under the regular L<Plack::Middleware> namespace (i.e. for the
4751 previous we'd try "Plack::Middleware::MyMiddleware"). We look under your application
4752 namespace first to let you 'override' common L<Plack::Middleware> locally, should
4753 you find that a good idea.
4759 __PACKAGE__->config(
4760 'psgi_middleware', [
4761 'Debug', ## MyAppWeb::Middleware::Debug->wrap or Plack::Middleware::Debug->wrap
4762 'Plack::Middleware::Stacktrace', ## Plack::Middleware::Stacktrace->wrap
4763 '+MyApp::Custom', ## MyApp::Custom->wrap
4767 =item a scalar followed by a hashref
4769 Just like the previous, except the following C<HashRef> is used as arguments
4770 to initialize the middleware object.
4772 __PACKAGE__->config(
4773 'psgi_middleware', [
4774 'Session' => {store => 'File'},
4779 Please see L<PSGI> for more on middleware.
4783 Starting in L<Catalyst> version 5.90080 encoding is automatically enabled
4784 and set to encode all body responses to UTF8 when possible and applicable.
4785 Following is documentation on this process. If you are using an older
4786 version of L<Catalyst> you should review documentation for that version since
4789 By default encoding is now 'UTF-8'. You may turn it off by setting
4790 the encoding configuration to undef.
4792 MyApp->config(encoding => undef);
4794 This is recommended for temporary backwards compatibility only.
4796 To turn it off for a single request use the L<clear_encoding>
4797 method to turn off encoding for this request. This can be useful
4798 when you are setting the body to be an arbitrary block of bytes,
4799 especially if that block happens to be a block of UTF8 text.
4801 Encoding is automatically applied when the content-type is set to
4802 a type that can be encoded. Currently we encode when the content type
4803 matches the following regular expression:
4805 $content_type =~ /^text|xml$|javascript$/
4807 Encoding is set on the application, but it is copied to the context object
4808 so that you can override it on a request basis.
4810 Be default we don't automatically encode 'application/json' since the most
4811 common approaches to generating this type of response (Either via L<Catalyst::View::JSON>
4812 or L<Catalyst::Action::REST>) will do so already and we want to avoid double
4815 If you are producing JSON response in an unconventional manner (such
4816 as via a template or manual strings) you should perform the UTF8 encoding
4817 manually as well such as to conform to the JSON specification.
4819 NOTE: We also examine the value of $c->response->content_encoding. If
4820 you set this (like for example 'gzip', and manually gzipping the body)
4821 we assume that you have done all the necessary encoding yourself, since
4822 we cannot encode the gzipped contents. If you use a plugin like
4823 L<Catalyst::Plugin::Compress> you need to update to a modern version in order
4824 to have this function correctly with the new UTF8 encoding code, or you
4825 can use L<Plack::Middleware::Deflater> or (probably best) do your compression on
4834 Returns an instance of an C<Encode> encoding
4836 print $c->encoding->name
4838 =item handle_unicode_encoding_exception ($exception_context)
4840 Method called when decoding process for a request fails.
4842 An C<$exception_context> hashref is provided to allow you to override the
4843 behaviour of your application when given data with incorrect encodings.
4845 The default method throws exceptions in the case of invalid request parameters
4846 (resulting in a 500 error), but ignores errors in upload filenames.
4848 The keys passed in the C<$exception_context> hash are:
4854 The value which was not able to be decoded.
4858 The exception received from L<Encode>.
4862 What type of data was being decoded. Valid values are (currently)
4863 C<params> - for request parameters / arguments / captures
4864 and C<uploads> - for request upload filenames.
4874 Join #catalyst on irc.perl.org.
4878 http://lists.scsys.co.uk/cgi-bin/mailman/listinfo/catalyst
4879 http://lists.scsys.co.uk/cgi-bin/mailman/listinfo/catalyst-dev
4883 http://catalyst.perl.org
4887 http://dev.catalyst.perl.org
4891 =head2 L<Task::Catalyst> - All you need to start with Catalyst
4893 =head2 L<Catalyst::Manual> - The Catalyst Manual
4895 =head2 L<Catalyst::Component>, L<Catalyst::Controller> - Base classes for components
4897 =head2 L<Catalyst::Engine> - Core engine
4899 =head2 L<Catalyst::Log> - Log class.
4901 =head2 L<Catalyst::Request> - Request object
4903 =head2 L<Catalyst::Response> - Response object
4905 =head2 L<Catalyst::Test> - The test suite.
4907 =head1 PROJECT FOUNDER
4909 sri: Sebastian Riedel <sri@cpan.org>
4915 acme: Leon Brocard <leon@astray.com>
4917 abraxxa: Alexander Hartmaier <abraxxa@cpan.org>
4919 andrewalker: André Walker <andre@cpan.org>
4923 Andrew Ford <A.Ford@ford-mason.co.uk>
4927 andyg: Andy Grundman <andy@hybridized.org>
4929 audreyt: Audrey Tang
4931 bricas: Brian Cassidy <bricas@cpan.org>
4933 Caelum: Rafael Kitover <rkitover@io.com>
4935 chansen: Christian Hansen
4937 Chase Venters <chase.venters@gmail.com>
4939 chicks: Christopher Hicks
4941 Chisel Wright <pause@herlpacker.co.uk>
4943 Danijel Milicevic <me@danijel.de>
4945 davewood: David Schmidt <davewood@cpan.org>
4947 David Kamholz <dkamholz@cpan.org>
4949 David Naughton <naughton@umn.edu>
4953 dhoss: Devin Austin <dhoss@cpan.org>
4955 dkubb: Dan Kubb <dan.kubb-cpan@onautopilot.com>
4959 dwc: Daniel Westermann-Clark <danieltwc@cpan.org>
4961 esskar: Sascha Kiefer
4963 fireartist: Carl Franks <cfranks@cpan.org>
4965 frew: Arthur Axel "fREW" Schmidt <frioux@gmail.com>
4967 gabb: Danijel Milicevic
4971 Gavin Henry <ghenry@perl.me.uk>
4975 groditi: Guillermo Roditi <groditi@gmail.com>
4977 hobbs: Andrew Rodland <andrew@cleverdomain.org>
4979 ilmari: Dagfinn Ilmari Mannsåker <ilmari@ilmari.org>
4981 jcamacho: Juan Camacho
4983 jester: Jesse Sheidlower <jester@panix.com>
4985 jhannah: Jay Hannah <jay@jays.net>
4991 jon: Jon Schutz <jjschutz@cpan.org>
4993 Jonathan Rockway <jrockway@cpan.org>
4995 Kieren Diment <kd@totaldatasolution.com>
4997 konobi: Scott McWhirter <konobi@cpan.org>
4999 marcus: Marcus Ramberg <mramberg@cpan.org>
5001 miyagawa: Tatsuhiko Miyagawa <miyagawa@bulknews.net>
5003 mgrimes: Mark Grimes <mgrimes@cpan.org>
5005 mst: Matt S. Trout <mst@shadowcatsystems.co.uk>
5009 naughton: David Naughton
5011 ningu: David Kamholz <dkamholz@cpan.org>
5013 nothingmuch: Yuval Kogman <nothingmuch@woobling.org>
5015 numa: Dan Sully <daniel@cpan.org>
5021 omega: Andreas Marienborg
5023 Oleg Kostyuk <cub.uanic@gmail.com>
5025 phaylon: Robert Sedlacek <phaylon@dunkelheit.at>
5027 rafl: Florian Ragwitz <rafl@debian.org>
5029 random: Roland Lammel <lammel@cpan.org>
5031 revmischa: Mischa Spiegelmock <revmischa@cpan.org>
5033 Robert Sedlacek <rs@474.at>
5035 rrwo: Robert Rothenberg <rrwo@cpan.org>
5037 SpiceMan: Marcel Montes
5041 szbalint: Balint Szilakszi <szbalint@cpan.org>
5043 t0m: Tomas Doran <bobtfish@bobtfish.net>
5047 vanstyn: Henry Van Styn <vanstyn@cpan.org>
5049 Viljo Marrandi <vilts@yahoo.com>
5051 Will Hawes <info@whawes.co.uk>
5053 willert: Sebastian Willert <willert@cpan.org>
5055 wreis: Wallace Reis <wreis@cpan.org>
5057 Yuval Kogman <nothingmuch@woobling.org>
5059 rainboxx: Matthias Dietrich <perl@rainboxx.de>
5061 dd070: Dhaval Dhanani <dhaval070@gmail.com>
5063 Upasana <me@upasana.me>
5065 John Napiorkowski (jnap) <jjnapiork@cpan.org>
5069 Copyright (c) 2005-2015, the above named PROJECT FOUNDER and CONTRIBUTORS.
5073 This library is free software. You can redistribute it and/or modify it under
5074 the same terms as Perl itself.
5080 __PACKAGE__->meta->make_immutable;