4 use Moose::Meta::Class ();
5 extends 'Catalyst::Component';
6 use Moose::Util qw/find_meta/;
7 use namespace::clean -except => 'meta';
8 use Catalyst::Exception;
9 use Catalyst::Exception::Detach;
10 use Catalyst::Exception::Go;
12 use Catalyst::Request;
13 use Catalyst::Request::Upload;
14 use Catalyst::Response;
16 use Catalyst::Controller;
18 use Devel::InnerPackage ();
19 use Module::Pluggable::Object ();
20 use Text::SimpleTable ();
21 use Path::Class::Dir ();
22 use Path::Class::File ();
27 use Tree::Simple qw/use_weak_refs/;
28 use Tree::Simple::Visitor::FindByUID;
29 use Class::C3::Adopt::NEXT;
30 use List::MoreUtils qw/uniq/;
32 use String::RewritePrefix;
33 use Catalyst::EngineLoader;
35 use Carp qw/croak carp shortmess/;
38 use Plack::Middleware::Conditional;
39 use Plack::Middleware::ReverseProxy;
40 use Plack::Middleware::IIS6ScriptNameFix;
41 use Plack::Middleware::IIS7KeepAliveFix;
42 use Plack::Middleware::LighttpdScriptNameFix;
43 use Class::Load 'load_class';
45 BEGIN { require 5.008003; }
47 has stack => (is => 'ro', default => sub { [] });
48 has stash => (is => 'rw', default => sub { {} });
49 has state => (is => 'rw', default => 0);
50 has stats => (is => 'rw');
51 has action => (is => 'rw');
52 has counter => (is => 'rw', default => sub { {} });
57 $self->request_class->new($self->_build_request_constructor_args);
61 sub _build_request_constructor_args {
63 my %p = ( _log => $self->log );
64 $p{_uploadtmp} = $self->_uploadtmp if $self->_has_uploadtmp;
72 $self->response_class->new($self->_build_response_constructor_args);
76 sub _build_response_constructor_args {
78 { _log => $self->log };
81 has namespace => (is => 'rw');
83 sub depth { scalar @{ shift->stack || [] }; }
84 sub comp { shift->component(@_) }
87 my $self = shift; return $self->request(@_);
90 my $self = shift; return $self->response(@_);
93 # For backwards compatibility
94 sub finalize_output { shift->finalize_body(@_) };
99 our $RECURSION = 1000;
100 our $DETACH = Catalyst::Exception::Detach->new;
101 our $GO = Catalyst::Exception::Go->new;
103 #I imagine that very few of these really need to be class variables. if any.
104 #maybe we should just make them attributes with a default?
105 __PACKAGE__->mk_classdata($_)
106 for qw/components arguments dispatcher engine log dispatcher_class
107 engine_loader context_class request_class response_class stats_class
108 setup_finished _psgi_app loading_psgi_file run_options/;
110 __PACKAGE__->dispatcher_class('Catalyst::Dispatcher');
111 __PACKAGE__->request_class('Catalyst::Request');
112 __PACKAGE__->response_class('Catalyst::Response');
113 __PACKAGE__->stats_class('Catalyst::Stats');
115 # Remember to update this in Catalyst::Runtime as well!
117 our $VERSION = '5.90042';
120 my ( $class, @arguments ) = @_;
122 # We have to limit $class to Catalyst to avoid pushing Catalyst upon every
124 return unless $class eq 'Catalyst';
126 my $caller = caller();
127 return if $caller eq 'main';
129 my $meta = Moose::Meta::Class->initialize($caller);
130 unless ( $caller->isa('Catalyst') ) {
131 my @superclasses = ($meta->superclasses, $class, 'Catalyst::Controller');
132 $meta->superclasses(@superclasses);
134 # Avoid possible C3 issues if 'Moose::Object' is already on RHS of MyApp
135 $meta->superclasses(grep { $_ ne 'Moose::Object' } $meta->superclasses);
137 unless( $meta->has_method('meta') ){
138 if ($Moose::VERSION >= 1.15) {
139 $meta->_add_meta_method('meta');
142 $meta->add_method(meta => sub { Moose::Meta::Class->initialize("${caller}") } );
146 $caller->arguments( [@arguments] );
150 sub _application { $_[0] }
156 Catalyst - The Elegant MVC Web Application Framework
160 See the L<Catalyst::Manual> distribution for comprehensive
161 documentation and tutorials.
163 # Install Catalyst::Devel for helpers and other development tools
164 # use the helper to create a new application
167 # add models, views, controllers
168 script/myapp_create.pl model MyDatabase DBIC::Schema create=static dbi:SQLite:/path/to/db
169 script/myapp_create.pl view MyTemplate TT
170 script/myapp_create.pl controller Search
172 # built in testserver -- use -r to restart automatically on changes
173 # --help to see all available options
174 script/myapp_server.pl
176 # command line testing interface
177 script/myapp_test.pl /yada
180 use Catalyst qw/-Debug/; # include plugins here as well
182 ### In lib/MyApp/Controller/Root.pm (autocreated)
183 sub foo : Chained('/') Args() { # called for /foo, /foo/1, /foo/1/2, etc.
184 my ( $self, $c, @args ) = @_; # args are qw/1 2/ for /foo/1/2
185 $c->stash->{template} = 'foo.tt'; # set the template
186 # lookup something from db -- stash vars are passed to TT
188 $c->model('Database::Foo')->search( { country => $args[0] } );
189 if ( $c->req->params->{bar} ) { # access GET or POST parameters
190 $c->forward( 'bar' ); # process another action
191 # do something else after forward returns
195 # The foo.tt TT template can use the stash data from the database
196 [% WHILE (item = data.next) %]
200 # called for /bar/of/soap, /bar/of/soap/10, etc.
201 sub bar : Chained('/') PathPart('/bar/of/soap') Args() { ... }
203 # called after all actions are finished
205 my ( $self, $c ) = @_;
206 if ( scalar @{ $c->error } ) { ... } # handle errors
207 return if $c->res->body; # already have a response
208 $c->forward( 'MyApp::View::TT' ); # render template
211 See L<Catalyst::Manual::Intro> for additional information.
215 Catalyst is a modern framework for making web applications without the
216 pain usually associated with this process. This document is a reference
217 to the main Catalyst application. If you are a new user, we suggest you
218 start with L<Catalyst::Manual::Tutorial> or L<Catalyst::Manual::Intro>.
220 See L<Catalyst::Manual> for more documentation.
222 Catalyst plugins can be loaded by naming them as arguments to the "use
223 Catalyst" statement. Omit the C<Catalyst::Plugin::> prefix from the
224 plugin name, i.e., C<Catalyst::Plugin::My::Module> becomes
227 use Catalyst qw/My::Module/;
229 If your plugin starts with a name other than C<Catalyst::Plugin::>, you can
230 fully qualify the name by using a unary plus:
234 +Fully::Qualified::Plugin::Name
237 Special flags like C<-Debug> can also be specified as
238 arguments when Catalyst is loaded:
240 use Catalyst qw/-Debug My::Module/;
242 The position of plugins and flags in the chain is important, because
243 they are loaded in the order in which they appear.
245 The following flags are supported:
249 Enables debug output. You can also force this setting from the system
250 environment with CATALYST_DEBUG or <MYAPP>_DEBUG. The environment
251 settings override the application, with <MYAPP>_DEBUG having the highest
254 This sets the log level to 'debug' and enables full debug output on the
255 error screen. If you only want the latter, see L<< $c->debug >>.
259 Forces Catalyst to use a specific home directory, e.g.:
261 use Catalyst qw[-Home=/usr/mst];
263 This can also be done in the shell environment by setting either the
264 C<CATALYST_HOME> environment variable or C<MYAPP_HOME>; where C<MYAPP>
265 is replaced with the uppercased name of your application, any "::" in
266 the name will be replaced with underscores, e.g. MyApp::Web should use
267 MYAPP_WEB_HOME. If both variables are set, the MYAPP_HOME one will be used.
269 If none of these are set, Catalyst will attempt to automatically detect the
270 home directory. If you are working in a development environment, Catalyst
271 will try and find the directory containing either Makefile.PL, Build.PL,
272 dist.ini, or cpanfile. If the application has been installed into the system
273 (i.e. you have done C<make install>), then Catalyst will use the path to your
274 application module, without the .pm extension (e.g., /foo/MyApp if your
275 application was installed at /foo/MyApp.pm)
279 use Catalyst '-Log=warn,fatal,error';
281 Specifies a comma-delimited list of log levels.
285 Enables statistics collection and reporting.
287 use Catalyst qw/-Stats=1/;
289 You can also force this setting from the system environment with CATALYST_STATS
290 or <MYAPP>_STATS. The environment settings override the application, with
291 <MYAPP>_STATS having the highest priority.
293 Stats are also enabled if L<< debugging |/"-Debug" >> is enabled.
297 =head2 INFORMATION ABOUT THE CURRENT REQUEST
301 Returns a L<Catalyst::Action> object for the current action, which
302 stringifies to the action name. See L<Catalyst::Action>.
306 Returns the namespace of the current action, i.e., the URI prefix
307 corresponding to the controller of the current action. For example:
309 # in Controller::Foo::Bar
310 $c->namespace; # returns 'foo/bar';
316 Returns the current L<Catalyst::Request> object, giving access to
317 information about the current client request (including parameters,
318 cookies, HTTP headers, etc.). See L<Catalyst::Request>.
320 =head2 REQUEST FLOW HANDLING
322 =head2 $c->forward( $action [, \@arguments ] )
324 =head2 $c->forward( $class, $method, [, \@arguments ] )
326 This is one way of calling another action (method) in the same or
327 a different controller. You can also use C<< $self->my_method($c, @args) >>
328 in the same controller or C<< $c->controller('MyController')->my_method($c, @args) >>
329 in a different controller.
330 The main difference is that 'forward' uses some of the Catalyst request
331 cycle overhead, including debugging, which may be useful to you. On the
332 other hand, there are some complications to using 'forward', restrictions
333 on values returned from 'forward', and it may not handle errors as you prefer.
334 Whether you use 'forward' or not is up to you; it is not considered superior to
335 the other ways to call a method.
337 'forward' calls another action, by its private name. If you give a
338 class name but no method, C<process()> is called. You may also optionally
339 pass arguments in an arrayref. The action will receive the arguments in
340 C<@_> and C<< $c->req->args >>. Upon returning from the function,
341 C<< $c->req->args >> will be restored to the previous values.
343 Any data C<return>ed from the action forwarded to, will be returned by the
346 my $foodata = $c->forward('/foo');
347 $c->forward('index');
348 $c->forward(qw/Model::DBIC::Foo do_stuff/);
349 $c->forward('View::TT');
351 Note that L<< forward|/"$c->forward( $action [, \@arguments ] )" >> implies
352 an C<< eval { } >> around the call (actually
353 L<< execute|/"$c->execute( $class, $coderef )" >> does), thus rendering all
354 exceptions thrown by the called action non-fatal and pushing them onto
355 $c->error instead. If you want C<die> to propagate you need to do something
359 die join "\n", @{ $c->error } if @{ $c->error };
361 Or make sure to always return true values from your actions and write
364 $c->forward('foo') || return;
366 Another note is that C<< $c->forward >> always returns a scalar because it
367 actually returns $c->state which operates in a scalar context.
368 Thus, something like:
372 in an action that is forwarded to is going to return a scalar,
373 i.e. how many items are in that array, which is probably not what you want.
374 If you need to return an array then return a reference to it,
377 $c->stash->{array} = \@array;
379 and access it from the stash.
381 Keep in mind that the C<end> method used is that of the caller action. So a C<$c-E<gt>detach> inside a forwarded action would run the C<end> method from the original action requested.
385 sub forward { my $c = shift; no warnings 'recursion'; $c->dispatcher->forward( $c, @_ ) }
387 =head2 $c->detach( $action [, \@arguments ] )
389 =head2 $c->detach( $class, $method, [, \@arguments ] )
393 The same as L<< forward|/"$c->forward( $action [, \@arguments ] )" >>, but
394 doesn't return to the previous action when processing is finished.
396 When called with no arguments it escapes the processing chain entirely.
400 sub detach { my $c = shift; $c->dispatcher->detach( $c, @_ ) }
402 =head2 $c->visit( $action [, \@arguments ] )
404 =head2 $c->visit( $action [, \@captures, \@arguments ] )
406 =head2 $c->visit( $class, $method, [, \@arguments ] )
408 =head2 $c->visit( $class, $method, [, \@captures, \@arguments ] )
410 Almost the same as L<< forward|/"$c->forward( $action [, \@arguments ] )" >>,
411 but does a full dispatch, instead of just calling the new C<$action> /
412 C<< $class->$method >>. This means that C<begin>, C<auto> and the method
413 you go to are called, just like a new request.
415 In addition both C<< $c->action >> and C<< $c->namespace >> are localized.
416 This means, for example, that C<< $c->action >> methods such as
417 L<name|Catalyst::Action/name>, L<class|Catalyst::Action/class> and
418 L<reverse|Catalyst::Action/reverse> return information for the visited action
419 when they are invoked within the visited action. This is different from the
420 behavior of L<< forward|/"$c->forward( $action [, \@arguments ] )" >>, which
421 continues to use the $c->action object from the caller action even when
422 invoked from the called action.
424 C<< $c->stash >> is kept unchanged.
426 In effect, L<< visit|/"$c->visit( $action [, \@captures, \@arguments ] )" >>
427 allows you to "wrap" another action, just as it would have been called by
428 dispatching from a URL, while the analogous
429 L<< go|/"$c->go( $action [, \@captures, \@arguments ] )" >> allows you to
430 transfer control to another action as if it had been reached directly from a URL.
434 sub visit { my $c = shift; $c->dispatcher->visit( $c, @_ ) }
436 =head2 $c->go( $action [, \@arguments ] )
438 =head2 $c->go( $action [, \@captures, \@arguments ] )
440 =head2 $c->go( $class, $method, [, \@arguments ] )
442 =head2 $c->go( $class, $method, [, \@captures, \@arguments ] )
444 The relationship between C<go> and
445 L<< visit|/"$c->visit( $action [, \@captures, \@arguments ] )" >> is the same as
446 the relationship between
447 L<< forward|/"$c->forward( $class, $method, [, \@arguments ] )" >> and
448 L<< detach|/"$c->detach( $action [, \@arguments ] )" >>. Like C<< $c->visit >>,
449 C<< $c->go >> will perform a full dispatch on the specified action or method,
450 with localized C<< $c->action >> and C<< $c->namespace >>. Like C<detach>,
451 C<go> escapes the processing of the current request chain on completion, and
452 does not return to its caller.
454 @arguments are arguments to the final destination of $action. @captures are
455 arguments to the intermediate steps, if any, on the way to the final sub of
460 sub go { my $c = shift; $c->dispatcher->go( $c, @_ ) }
466 Returns the current L<Catalyst::Response> object, see there for details.
470 Returns a hashref to the stash, which may be used to store data and pass
471 it between components during a request. You can also set hash keys by
472 passing arguments. The stash is automatically sent to the view. The
473 stash is cleared at the end of a request; it cannot be used for
474 persistent storage (for this you must use a session; see
475 L<Catalyst::Plugin::Session> for a complete system integrated with
478 $c->stash->{foo} = $bar;
479 $c->stash( { moose => 'majestic', qux => 0 } );
480 $c->stash( bar => 1, gorch => 2 ); # equivalent to passing a hashref
482 # stash is automatically passed to the view for use in a template
483 $c->forward( 'MyApp::View::TT' );
487 around stash => sub {
490 my $stash = $orig->($c);
492 my $new_stash = @_ > 1 ? {@_} : $_[0];
493 croak('stash takes a hash or hashref') unless ref $new_stash;
494 foreach my $key ( keys %$new_stash ) {
495 $stash->{$key} = $new_stash->{$key};
505 =head2 $c->error($error, ...)
507 =head2 $c->error($arrayref)
509 Returns an arrayref containing error messages. If Catalyst encounters an
510 error while processing a request, it stores the error in $c->error. This
511 method should only be used to store fatal error messages.
513 my @error = @{ $c->error };
517 $c->error('Something bad happened');
524 my $error = ref $_[0] eq 'ARRAY' ? $_[0] : [@_];
525 croak @$error unless ref $c;
526 push @{ $c->{error} }, @$error;
528 elsif ( defined $_[0] ) { $c->{error} = undef }
529 return $c->{error} || [];
535 Contains the return value of the last executed action.
536 Note that << $c->state >> operates in a scalar context which means that all
537 values it returns are scalar.
539 =head2 $c->clear_errors
541 Clear errors. You probably don't want to clear the errors unless you are
542 implementing a custom error screen.
544 This is equivalent to running
555 sub _comp_search_prefixes {
557 return map $c->components->{ $_ }, $c->_comp_names_search_prefixes(@_);
560 # search components given a name and some prefixes
561 sub _comp_names_search_prefixes {
562 my ( $c, $name, @prefixes ) = @_;
563 my $appclass = ref $c || $c;
564 my $filter = "^${appclass}::(" . join( '|', @prefixes ) . ')::';
565 $filter = qr/$filter/; # Compile regex now rather than once per loop
567 # map the original component name to the sub part that we will search against
568 my %eligible = map { my $n = $_; $n =~ s{^$appclass\::[^:]+::}{}; $_ => $n; }
569 grep { /$filter/ } keys %{ $c->components };
571 # undef for a name will return all
572 return keys %eligible if !defined $name;
574 my $query = $name->$_isa('Regexp') ? $name : qr/^$name$/i;
575 my @result = grep { $eligible{$_} =~ m{$query} } keys %eligible;
577 return @result if @result;
579 # if we were given a regexp to search against, we're done.
580 return if $name->$_isa('Regexp');
582 # skip regexp fallback if configured
584 if $appclass->config->{disable_component_resolution_regex_fallback};
588 @result = grep { $eligible{ $_ } =~ m{$query} } keys %eligible;
590 # no results? try against full names
592 @result = grep { m{$query} } keys %eligible;
595 # don't warn if we didn't find any results, it just might not exist
597 # Disgusting hack to work out correct method name
598 my $warn_for = lc $prefixes[0];
599 my $msg = "Used regexp fallback for \$c->${warn_for}('${name}'), which found '" .
600 (join '", "', @result) . "'. Relying on regexp fallback behavior for " .
601 "component resolution is unreliable and unsafe.";
602 my $short = $result[0];
603 # remove the component namespace prefix
604 $short =~ s/.*?(Model|Controller|View):://;
605 my $shortmess = Carp::shortmess('');
606 if ($shortmess =~ m#Catalyst/Plugin#) {
607 $msg .= " You probably need to set '$short' instead of '${name}' in this " .
609 } elsif ($shortmess =~ m#Catalyst/lib/(View|Controller)#) {
610 $msg .= " You probably need to set '$short' instead of '${name}' in this " .
611 "component's config";
613 $msg .= " You probably meant \$c->${warn_for}('$short') instead of \$c->${warn_for}('${name}'), " .
614 "but if you really wanted to search, pass in a regexp as the argument " .
615 "like so: \$c->${warn_for}(qr/${name}/)";
617 $c->log->warn( "${msg}$shortmess" );
623 # Find possible names for a prefix
625 my ( $c, @prefixes ) = @_;
626 my $appclass = ref $c || $c;
628 my $filter = "^${appclass}::(" . join( '|', @prefixes ) . ')::';
630 my @names = map { s{$filter}{}; $_; }
631 $c->_comp_names_search_prefixes( undef, @prefixes );
636 # Filter a component before returning by calling ACCEPT_CONTEXT if available
637 sub _filter_component {
638 my ( $c, $comp, @args ) = @_;
640 if ( eval { $comp->can('ACCEPT_CONTEXT'); } ) {
641 return $comp->ACCEPT_CONTEXT( $c, @args );
647 =head2 COMPONENT ACCESSORS
649 =head2 $c->controller($name)
651 Gets a L<Catalyst::Controller> instance by name.
653 $c->controller('Foo')->do_stuff;
655 If the name is omitted, will return the controller for the dispatched
658 If you want to search for controllers, pass in a regexp as the argument.
660 # find all controllers that start with Foo
661 my @foo_controllers = $c->controller(qr{^Foo});
667 my ( $c, $name, @args ) = @_;
669 my $appclass = ref($c) || $c;
671 unless ( $name->$_isa('Regexp') ) { # Direct component hash lookup to avoid costly regexps
672 my $comps = $c->components;
673 my $check = $appclass."::Controller::".$name;
674 return $c->_filter_component( $comps->{$check}, @args ) if exists $comps->{$check};
676 my @result = $c->_comp_search_prefixes( $name, qw/Controller C/ );
677 return map { $c->_filter_component( $_, @args ) } @result if ref $name;
678 return $c->_filter_component( $result[ 0 ], @args );
681 return $c->component( $c->action->class );
684 =head2 $c->model($name)
686 Gets a L<Catalyst::Model> instance by name.
688 $c->model('Foo')->do_stuff;
690 Any extra arguments are directly passed to ACCEPT_CONTEXT.
692 If the name is omitted, it will look for
693 - a model object in $c->stash->{current_model_instance}, then
694 - a model name in $c->stash->{current_model}, then
695 - a config setting 'default_model', or
696 - check if there is only one model, and return it if that's the case.
698 If you want to search for models, pass in a regexp as the argument.
700 # find all models that start with Foo
701 my @foo_models = $c->model(qr{^Foo});
706 my ( $c, $name, @args ) = @_;
707 my $appclass = ref($c) || $c;
709 unless ( $name->$_isa('Regexp') ) { # Direct component hash lookup to avoid costly regexps
710 my $comps = $c->components;
711 my $check = $appclass."::Model::".$name;
712 return $c->_filter_component( $comps->{$check}, @args ) if exists $comps->{$check};
714 my @result = $c->_comp_search_prefixes( $name, qw/Model M/ );
715 return map { $c->_filter_component( $_, @args ) } @result if ref $name;
716 return $c->_filter_component( $result[ 0 ], @args );
720 return $c->stash->{current_model_instance}
721 if $c->stash->{current_model_instance};
722 return $c->model( $c->stash->{current_model} )
723 if $c->stash->{current_model};
725 return $c->model( $appclass->config->{default_model} )
726 if $appclass->config->{default_model};
728 my( $comp, $rest ) = $c->_comp_search_prefixes( undef, qw/Model M/);
731 $c->log->warn( Carp::shortmess('Calling $c->model() will return a random model unless you specify one of:') );
732 $c->log->warn( '* $c->config(default_model => "the name of the default model to use")' );
733 $c->log->warn( '* $c->stash->{current_model} # the name of the model to use for this request' );
734 $c->log->warn( '* $c->stash->{current_model_instance} # the instance of the model to use for this request' );
735 $c->log->warn( 'NB: in version 5.81, the "random" behavior will not work at all.' );
738 return $c->_filter_component( $comp );
742 =head2 $c->view($name)
744 Gets a L<Catalyst::View> instance by name.
746 $c->view('Foo')->do_stuff;
748 Any extra arguments are directly passed to ACCEPT_CONTEXT.
750 If the name is omitted, it will look for
751 - a view object in $c->stash->{current_view_instance}, then
752 - a view name in $c->stash->{current_view}, then
753 - a config setting 'default_view', or
754 - check if there is only one view, and return it if that's the case.
756 If you want to search for views, pass in a regexp as the argument.
758 # find all views that start with Foo
759 my @foo_views = $c->view(qr{^Foo});
764 my ( $c, $name, @args ) = @_;
766 my $appclass = ref($c) || $c;
768 unless ( $name->$_isa('Regexp') ) { # Direct component hash lookup to avoid costly regexps
769 my $comps = $c->components;
770 my $check = $appclass."::View::".$name;
771 if( exists $comps->{$check} ) {
772 return $c->_filter_component( $comps->{$check}, @args );
775 $c->log->warn( "Attempted to use view '$check', but does not exist" );
778 my @result = $c->_comp_search_prefixes( $name, qw/View V/ );
779 return map { $c->_filter_component( $_, @args ) } @result if ref $name;
780 return $c->_filter_component( $result[ 0 ], @args );
784 return $c->stash->{current_view_instance}
785 if $c->stash->{current_view_instance};
786 return $c->view( $c->stash->{current_view} )
787 if $c->stash->{current_view};
789 return $c->view( $appclass->config->{default_view} )
790 if $appclass->config->{default_view};
792 my( $comp, $rest ) = $c->_comp_search_prefixes( undef, qw/View V/);
795 $c->log->warn( 'Calling $c->view() will return a random view unless you specify one of:' );
796 $c->log->warn( '* $c->config(default_view => "the name of the default view to use")' );
797 $c->log->warn( '* $c->stash->{current_view} # the name of the view to use for this request' );
798 $c->log->warn( '* $c->stash->{current_view_instance} # the instance of the view to use for this request' );
799 $c->log->warn( 'NB: in version 5.81, the "random" behavior will not work at all.' );
802 return $c->_filter_component( $comp );
805 =head2 $c->controllers
807 Returns the available names which can be passed to $c->controller
813 return $c->_comp_names(qw/Controller C/);
818 Returns the available names which can be passed to $c->model
824 return $c->_comp_names(qw/Model M/);
830 Returns the available names which can be passed to $c->view
836 return $c->_comp_names(qw/View V/);
839 =head2 $c->comp($name)
841 =head2 $c->component($name)
843 Gets a component object by name. This method is not recommended,
844 unless you want to get a specific component by full
845 class. C<< $c->controller >>, C<< $c->model >>, and C<< $c->view >>
846 should be used instead.
848 If C<$name> is a regexp, a list of components matched against the full
849 component name will be returned.
851 If Catalyst can't find a component by name, it will fallback to regex
852 matching by default. To disable this behaviour set
853 disable_component_resolution_regex_fallback to a true value.
855 __PACKAGE__->config( disable_component_resolution_regex_fallback => 1 );
860 my ( $c, $name, @args ) = @_;
863 my $comps = $c->components;
866 # is it the exact name?
867 return $c->_filter_component( $comps->{ $name }, @args )
868 if exists $comps->{ $name };
870 # perhaps we just omitted "MyApp"?
871 my $composed = ( ref $c || $c ) . "::${name}";
872 return $c->_filter_component( $comps->{ $composed }, @args )
873 if exists $comps->{ $composed };
875 # search all of the models, views and controllers
876 my( $comp ) = $c->_comp_search_prefixes( $name, qw/Model M Controller C View V/ );
877 return $c->_filter_component( $comp, @args ) if $comp;
881 if $c->config->{disable_component_resolution_regex_fallback};
883 # This is here so $c->comp( '::M::' ) works
884 my $query = ref $name ? $name : qr{$name}i;
886 my @result = grep { m{$query} } keys %{ $c->components };
887 return map { $c->_filter_component( $_, @args ) } @result if ref $name;
890 $c->log->warn( Carp::shortmess(qq(Found results for "${name}" using regexp fallback)) );
891 $c->log->warn( 'Relying on the regexp fallback behavior for component resolution' );
892 $c->log->warn( 'is unreliable and unsafe. You have been warned' );
893 return $c->_filter_component( $result[ 0 ], @args );
896 # I would expect to return an empty list here, but that breaks back-compat
900 return sort keys %{ $c->components };
903 =head2 CLASS DATA AND HELPER CLASSES
907 Returns or takes a hashref containing the application's configuration.
909 __PACKAGE__->config( { db => 'dsn:SQLite:foo.db' } );
911 You can also use a C<YAML>, C<XML> or L<Config::General> config file
912 like C<myapp.conf> in your applications home directory. See
913 L<Catalyst::Plugin::ConfigLoader>.
915 =head3 Cascading configuration
917 The config method is present on all Catalyst components, and configuration
918 will be merged when an application is started. Configuration loaded with
919 L<Catalyst::Plugin::ConfigLoader> takes precedence over other configuration,
920 followed by configuration in your top level C<MyApp> class. These two
921 configurations are merged, and then configuration data whose hash key matches a
922 component name is merged with configuration for that component.
924 The configuration for a component is then passed to the C<new> method when a
925 component is constructed.
929 MyApp->config({ 'Model::Foo' => { bar => 'baz', overrides => 'me' } });
930 MyApp::Model::Foo->config({ quux => 'frob', overrides => 'this' });
932 will mean that C<MyApp::Model::Foo> receives the following data when
935 MyApp::Model::Foo->new({
941 It's common practice to use a Moose attribute
942 on the receiving component to access the config value.
944 package MyApp::Model::Foo;
948 # this attr will receive 'baz' at construction time
954 You can then get the value 'baz' by calling $c->model('Foo')->bar
955 (or $self->bar inside code in the model).
957 B<NOTE:> you MUST NOT call C<< $self->config >> or C<< __PACKAGE__->config >>
958 as a way of reading config within your code, as this B<will not> give you the
959 correctly merged config back. You B<MUST> take the config values supplied to
960 the constructor and use those instead.
964 around config => sub {
968 croak('Setting config after setup has been run is not allowed.')
969 if ( @_ and $c->setup_finished );
976 Returns the logging object instance. Unless it is already set, Catalyst
977 sets this up with a L<Catalyst::Log> object. To use your own log class,
978 set the logger with the C<< __PACKAGE__->log >> method prior to calling
979 C<< __PACKAGE__->setup >>.
981 __PACKAGE__->log( MyLogger->new );
986 $c->log->info( 'Now logging with my own logger!' );
988 Your log class should implement the methods described in
994 Returns 1 if debug mode is enabled, 0 otherwise.
996 You can enable debug mode in several ways:
1000 =item By calling myapp_server.pl with the -d flag
1002 =item With the environment variables MYAPP_DEBUG, or CATALYST_DEBUG
1004 =item The -Debug option in your MyApp.pm
1006 =item By declaring C<sub debug { 1 }> in your MyApp.pm.
1010 The first three also set the log level to 'debug'.
1012 Calling C<< $c->debug(1) >> has no effect.
1018 =head2 $c->dispatcher
1020 Returns the dispatcher instance. See L<Catalyst::Dispatcher>.
1024 Returns the engine instance. See L<Catalyst::Engine>.
1027 =head2 UTILITY METHODS
1029 =head2 $c->path_to(@path)
1031 Merges C<@path> with C<< $c->config->{home} >> and returns a
1032 L<Path::Class::Dir> object. Note you can usually use this object as
1033 a filename, but sometimes you will have to explicitly stringify it
1034 yourself by calling the C<< ->stringify >> method.
1038 $c->path_to( 'db', 'sqlite.db' );
1043 my ( $c, @path ) = @_;
1044 my $path = Path::Class::Dir->new( $c->config->{home}, @path );
1045 if ( -d $path ) { return $path }
1046 else { return Path::Class::File->new( $c->config->{home}, @path ) }
1050 my ( $class, $name, $plugin, @args ) = @_;
1052 # See block comment in t/unit_core_plugin.t
1053 $class->log->warn(qq/Adding plugin using the ->plugin method is deprecated, and will be removed in a future release/);
1055 $class->_register_plugin( $plugin, 1 );
1057 eval { $plugin->import };
1058 $class->mk_classdata($name);
1060 eval { $obj = $plugin->new(@args) };
1063 Catalyst::Exception->throw( message =>
1064 qq/Couldn't instantiate instant plugin "$plugin", "$@"/ );
1067 $class->$name($obj);
1068 $class->log->debug(qq/Initialized instant plugin "$plugin" as "$name"/)
1074 Initializes the dispatcher and engine, loads any plugins, and loads the
1075 model, view, and controller components. You may also specify an array
1076 of plugins to load here, if you choose to not load them in the C<use
1080 MyApp->setup( qw/-Debug/ );
1082 B<Note:> You B<should not> wrap this method with method modifiers
1083 or bad things will happen - wrap the C<setup_finalize> method instead.
1088 my ( $class, @arguments ) = @_;
1089 croak('Running setup more than once')
1090 if ( $class->setup_finished );
1092 unless ( $class->isa('Catalyst') ) {
1094 Catalyst::Exception->throw(
1095 message => qq/'$class' does not inherit from Catalyst/ );
1098 if ( $class->arguments ) {
1099 @arguments = ( @arguments, @{ $class->arguments } );
1105 foreach (@arguments) {
1109 ( $flags->{log} ) ? 'debug,' . $flags->{log} : 'debug';
1111 elsif (/^-(\w+)=?(.*)$/) {
1112 $flags->{ lc $1 } = $2;
1115 push @{ $flags->{plugins} }, $_;
1119 $class->setup_home( delete $flags->{home} );
1121 $class->setup_log( delete $flags->{log} );
1122 $class->setup_plugins( delete $flags->{plugins} );
1123 $class->setup_dispatcher( delete $flags->{dispatcher} );
1124 if (my $engine = delete $flags->{engine}) {
1125 $class->log->warn("Specifying the engine in ->setup is no longer supported, see Catalyst::Upgrading");
1127 $class->setup_engine();
1128 $class->setup_stats( delete $flags->{stats} );
1130 for my $flag ( sort keys %{$flags} ) {
1132 if ( my $code = $class->can( 'setup_' . $flag ) ) {
1133 &$code( $class, delete $flags->{$flag} );
1136 $class->log->warn(qq/Unknown flag "$flag"/);
1140 eval { require Catalyst::Devel; };
1141 if( !$@ && $ENV{CATALYST_SCRIPT_GEN} && ( $ENV{CATALYST_SCRIPT_GEN} < $Catalyst::Devel::CATALYST_SCRIPT_GEN ) ) {
1142 $class->log->warn(<<"EOF");
1143 You are running an old script!
1145 Please update by running (this will overwrite existing files):
1146 catalyst.pl -force -scripts $class
1148 or (this will not overwrite existing files):
1149 catalyst.pl -scripts $class
1154 if ( $class->debug ) {
1155 my @plugins = map { "$_ " . ( $_->VERSION || '' ) } $class->registered_plugins;
1158 my $column_width = Catalyst::Utils::term_width() - 6;
1159 my $t = Text::SimpleTable->new($column_width);
1160 $t->row($_) for @plugins;
1161 $class->log->debug( "Loaded plugins:\n" . $t->draw . "\n" );
1164 my $dispatcher = $class->dispatcher;
1165 my $engine = $class->engine;
1166 my $home = $class->config->{home};
1168 $class->log->debug(sprintf(q/Loaded dispatcher "%s"/, blessed($dispatcher)));
1169 $class->log->debug(sprintf(q/Loaded engine "%s"/, blessed($engine)));
1173 ? $class->log->debug(qq/Found home "$home"/)
1174 : $class->log->debug(qq/Home "$home" doesn't exist/)
1175 : $class->log->debug(q/Couldn't find home/);
1178 # Call plugins setup, this is stupid and evil.
1179 # Also screws C3 badly on 5.10, hack to avoid.
1181 no warnings qw/redefine/;
1182 local *setup = sub { };
1183 $class->setup unless $Catalyst::__AM_RESTARTING;
1186 # Initialize our data structure
1187 $class->components( {} );
1189 $class->setup_components;
1191 if ( $class->debug ) {
1192 my $column_width = Catalyst::Utils::term_width() - 8 - 9;
1193 my $t = Text::SimpleTable->new( [ $column_width, 'Class' ], [ 8, 'Type' ] );
1194 for my $comp ( sort keys %{ $class->components } ) {
1195 my $type = ref $class->components->{$comp} ? 'instance' : 'class';
1196 $t->row( $comp, $type );
1198 $class->log->debug( "Loaded components:\n" . $t->draw . "\n" )
1199 if ( keys %{ $class->components } );
1202 # Add our self to components, since we are also a component
1203 if( $class->isa('Catalyst::Controller') ){
1204 $class->components->{$class} = $class;
1207 $class->setup_actions;
1209 if ( $class->debug ) {
1210 my $name = $class->config->{name} || 'Application';
1211 $class->log->info("$name powered by Catalyst $Catalyst::VERSION");
1214 if ($class->config->{case_sensitive}) {
1215 $class->log->warn($class . "->config->{case_sensitive} is set.");
1216 $class->log->warn("This setting is deprecated and planned to be removed in Catalyst 5.81.");
1219 $class->setup_finalize;
1220 # Should be the last thing we do so that user things hooking
1221 # setup_finalize can log..
1222 $class->log->_flush() if $class->log->can('_flush');
1223 return 1; # Explicit return true as people have __PACKAGE__->setup as the last thing in their class. HATE.
1226 =head2 $app->setup_finalize
1228 A hook to attach modifiers to. This method does not do anything except set the
1229 C<setup_finished> accessor.
1231 Applying method modifiers to the C<setup> method doesn't work, because of quirky things done for plugin setup.
1235 after setup_finalize => sub {
1243 sub setup_finalize {
1245 $class->setup_finished(1);
1248 =head2 $c->uri_for( $path?, @args?, \%query_values? )
1250 =head2 $c->uri_for( $action, \@captures?, @args?, \%query_values? )
1252 Constructs an absolute L<URI> object based on the application root, the
1253 provided path, and the additional arguments and query parameters provided.
1254 When used as a string, provides a textual URI. If you need more flexibility
1255 than this (i.e. the option to provide relative URIs etc.) see
1256 L<Catalyst::Plugin::SmartURI>.
1258 If no arguments are provided, the URI for the current action is returned.
1259 To return the current action and also provide @args, use
1260 C<< $c->uri_for( $c->action, @args ) >>.
1262 If the first argument is a string, it is taken as a public URI path relative
1263 to C<< $c->namespace >> (if it doesn't begin with a forward slash) or
1264 relative to the application root (if it does). It is then merged with
1265 C<< $c->request->base >>; any C<@args> are appended as additional path
1266 components; and any C<%query_values> are appended as C<?foo=bar> parameters.
1268 If the first argument is a L<Catalyst::Action> it represents an action which
1269 will have its path resolved using C<< $c->dispatcher->uri_for_action >>. The
1270 optional C<\@captures> argument (an arrayref) allows passing the captured
1271 variables that are needed to fill in the paths of Chained and Regex actions;
1272 once the path is resolved, C<uri_for> continues as though a path was
1273 provided, appending any arguments or parameters and creating an absolute
1276 The captures for the current request can be found in
1277 C<< $c->request->captures >>, and actions can be resolved using
1278 C<< Catalyst::Controller->action_for($name) >>. If you have a private action
1279 path, use C<< $c->uri_for_action >> instead.
1281 # Equivalent to $c->req->uri
1282 $c->uri_for($c->action, $c->req->captures,
1283 @{ $c->req->args }, $c->req->params);
1285 # For the Foo action in the Bar controller
1286 $c->uri_for($c->controller('Bar')->action_for('Foo'));
1288 # Path to a static resource
1289 $c->uri_for('/static/images/logo.png');
1294 my ( $c, $path, @args ) = @_;
1296 if ( $path->$_isa('Catalyst::Controller') ) {
1297 $path = $path->path_prefix;
1302 undef($path) if (defined $path && $path eq '');
1305 ( scalar @args && ref $args[$#args] eq 'HASH' ? pop @args : {} );
1307 carp "uri_for called with undef argument" if grep { ! defined $_ } @args;
1308 foreach my $arg (@args) {
1309 utf8::encode($arg) if utf8::is_utf8($arg);
1310 $arg =~ s/([^$URI::uric])/$URI::Escape::escapes{$1}/go;
1313 if ( $path->$_isa('Catalyst::Action') ) { # action object
1314 s|/|%2F|g for @args;
1315 my $captures = [ map { s|/|%2F|g; $_; }
1316 ( scalar @args && ref $args[0] eq 'ARRAY'
1320 foreach my $capture (@$captures) {
1321 utf8::encode($capture) if utf8::is_utf8($capture);
1322 $capture =~ s/([^$URI::uric])/$URI::Escape::escapes{$1}/go;
1326 # ->uri_for( $action, \@captures_and_args, \%query_values? )
1327 if( !@args && $action->number_of_args ) {
1328 my $expanded_action = $c->dispatcher->expand_action( $action );
1330 my $num_captures = $expanded_action->number_of_captures;
1331 unshift @args, splice @$captures, $num_captures;
1334 $path = $c->dispatcher->uri_for_action($action, $captures);
1335 if (not defined $path) {
1336 $c->log->debug(qq/Can't find uri_for action '$action' @$captures/)
1340 $path = '/' if $path eq '';
1343 unshift(@args, $path);
1345 unless (defined $path && $path =~ s!^/!!) { # in-place strip
1346 my $namespace = $c->namespace;
1347 if (defined $path) { # cheesy hack to handle path '../foo'
1348 $namespace =~ s{(?:^|/)[^/]+$}{} while $args[0] =~ s{^\.\./}{};
1350 unshift(@args, $namespace || '');
1353 # join args with '/', or a blank string
1354 my $args = join('/', grep { defined($_) } @args);
1355 $args =~ s/\?/%3F/g; # STUPID STUPID SPECIAL CASE
1358 my ($base, $class) = ('/', 'URI::_generic');
1360 $base = $c->req->base;
1361 $class = ref($base);
1362 $base =~ s{(?<!/)$}{/};
1367 if (my @keys = keys %$params) {
1368 # somewhat lifted from URI::_query's query_form
1369 $query = '?'.join('&', map {
1370 my $val = $params->{$_};
1371 s/([;\/?:@&=+,\$\[\]%])/$URI::Escape::escapes{$1}/go;
1374 $val = '' unless defined $val;
1377 utf8::encode( $param ) if utf8::is_utf8($param);
1378 # using the URI::Escape pattern here so utf8 chars survive
1379 $param =~ s/([^A-Za-z0-9\-_.!~*'() ])/$URI::Escape::escapes{$1}/go;
1381 "${key}=$param"; } ( ref $val eq 'ARRAY' ? @$val : $val ));
1385 my $res = bless(\"${base}${args}${query}", $class);
1389 =head2 $c->uri_for_action( $path, \@captures_and_args?, @args?, \%query_values? )
1391 =head2 $c->uri_for_action( $action, \@captures_and_args?, @args?, \%query_values? )
1397 A private path to the Catalyst action you want to create a URI for.
1399 This is a shortcut for calling C<< $c->dispatcher->get_action_by_path($path)
1400 >> and passing the resulting C<$action> and the remaining arguments to C<<
1403 You can also pass in a Catalyst::Action object, in which case it is passed to
1406 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.
1408 For example, if the action looks like:
1410 package MyApp::Controller::Users;
1412 sub lst : Path('the-list') {}
1416 $c->uri_for_action('/users/lst')
1418 and it will create the URI /users/the-list.
1420 =item \@captures_and_args?
1422 Optional array reference of Captures (i.e. C<<CaptureArgs or $c->req->captures>)
1423 and arguments to the request. Usually used with L<Catalyst::DispatchType::Chained>
1424 to interpolate all the parameters in the URI.
1428 Optional list of extra arguments - can be supplied in the
1429 C<< \@captures_and_args? >> array ref, or here - whichever is easier for your
1432 Your action can have zero, a fixed or a variable number of args (e.g.
1433 C<< Args(1) >> for a fixed number or C<< Args() >> for a variable number)..
1435 =item \%query_values?
1437 Optional array reference of query parameters to append. E.g.
1443 /rest/of/your/uri?foo=bar
1449 sub uri_for_action {
1450 my ( $c, $path, @args ) = @_;
1451 my $action = blessed($path)
1453 : $c->dispatcher->get_action_by_path($path);
1454 unless (defined $action) {
1455 croak "Can't find action for path '$path'";
1457 return $c->uri_for( $action, @args );
1460 =head2 $c->welcome_message
1462 Returns the Catalyst welcome HTML page.
1466 sub welcome_message {
1468 my $name = $c->config->{name};
1469 my $logo = $c->uri_for('/static/images/catalyst_logo.png');
1470 my $prefix = Catalyst::Utils::appprefix( ref $c );
1471 $c->response->content_type('text/html; charset=utf-8');
1473 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
1474 "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
1475 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
1477 <meta http-equiv="Content-Language" content="en" />
1478 <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
1479 <title>$name on Catalyst $VERSION</title>
1480 <style type="text/css">
1483 background-color: #eee;
1490 margin-bottom: 10px;
1492 background-color: #ccc;
1493 border: 1px solid #aaa;
1498 font-family: verdana, tahoma, sans-serif;
1501 font-family: verdana, tahoma, sans-serif;
1504 text-decoration: none;
1506 border-bottom: 1px dotted #bbb;
1508 :link:hover, :visited:hover {
1521 background-color: #fff;
1522 border: 1px solid #aaa;
1526 font-weight: normal;
1548 <h1><span id="appname">$name</span> on <a href="http://catalyst.perl.org">Catalyst</a>
1553 <img src="$logo" alt="Catalyst Logo" />
1555 <p>Welcome to the world of Catalyst.
1556 This <a href="http://en.wikipedia.org/wiki/MVC">MVC</a>
1557 framework will make web development something you had
1558 never expected it to be: Fun, rewarding, and quick.</p>
1559 <h2>What to do now?</h2>
1560 <p>That really depends on what <b>you</b> want to do.
1561 We do, however, provide you with a few starting points.</p>
1562 <p>If you want to jump right into web development with Catalyst
1563 you might want to start with a tutorial.</p>
1564 <pre>perldoc <a href="https://metacpan.org/module/Catalyst::Manual::Tutorial">Catalyst::Manual::Tutorial</a></code>
1566 <p>Afterwards you can go on to check out a more complete look at our features.</p>
1568 <code>perldoc <a href="https://metacpan.org/module/Catalyst::Manual::Intro">Catalyst::Manual::Intro</a>
1569 <!-- Something else should go here, but the Catalyst::Manual link seems unhelpful -->
1571 <h2>What to do next?</h2>
1572 <p>Next it's time to write an actual application. Use the
1573 helper scripts to generate <a href="https://metacpan.org/search?q=Catalyst%3A%3AController">controllers</a>,
1574 <a href="https://metacpan.org/search?q=Catalyst%3A%3AModel">models</a>, and
1575 <a href="https://metacpan.org/search?q=Catalyst%3A%3AView">views</a>;
1576 they can save you a lot of work.</p>
1577 <pre><code>script/${prefix}_create.pl --help</code></pre>
1578 <p>Also, be sure to check out the vast and growing
1579 collection of <a href="http://search.cpan.org/search?query=Catalyst">plugins for Catalyst on CPAN</a>;
1580 you are likely to find what you need there.
1584 <p>Catalyst has a very active community. Here are the main places to
1585 get in touch with us.</p>
1588 <a href="http://dev.catalyst.perl.org">Wiki</a>
1591 <a href="http://lists.scsys.co.uk/cgi-bin/mailman/listinfo/catalyst">Mailing-List</a>
1594 <a href="irc://irc.perl.org/catalyst">IRC channel #catalyst on irc.perl.org</a>
1597 <h2>In conclusion</h2>
1598 <p>The Catalyst team hopes you will enjoy using Catalyst as much
1599 as we enjoyed making it. Please contact us if you have ideas
1600 for improvement or other feedback.</p>
1610 Contains a hash of options passed from the application script, including
1611 the original ARGV the script received, the processed values from that
1612 ARGV and any extra arguments to the script which were not processed.
1614 This can be used to add custom options to your application's scripts
1615 and setup your application differently depending on the values of these
1618 =head1 INTERNAL METHODS
1620 These methods are not meant to be used by end users.
1622 =head2 $c->components
1624 Returns a hash of components.
1626 =head2 $c->context_class
1628 Returns or sets the context class.
1632 Returns a hashref containing coderefs and execution counts (needed for
1633 deep recursion detection).
1637 Returns the number of actions on the current internal execution stack.
1641 Dispatches a request to actions.
1645 sub dispatch { my $c = shift; $c->dispatcher->dispatch( $c, @_ ) }
1647 =head2 $c->dispatcher_class
1649 Returns or sets the dispatcher class.
1651 =head2 $c->dump_these
1653 Returns a list of 2-element array references (name, structure) pairs
1654 that will be dumped on the error page in debug mode.
1660 [ Request => $c->req ],
1661 [ Response => $c->res ],
1662 [ Stash => $c->stash ],
1663 [ Config => $c->config ];
1666 =head2 $c->engine_class
1668 Returns or sets the engine class.
1670 =head2 $c->execute( $class, $coderef )
1672 Execute a coderef in given class and catch exceptions. Errors are available
1678 my ( $c, $class, $code ) = @_;
1679 $class = $c->component($class) || $class;
1682 if ( $c->depth >= $RECURSION ) {
1683 my $action = $code->reverse();
1684 $action = "/$action" unless $action =~ /->/;
1685 my $error = qq/Deep recursion detected calling "${action}"/;
1686 $c->log->error($error);
1692 my $stats_info = $c->_stats_start_execute( $code ) if $c->use_stats;
1694 push( @{ $c->stack }, $code );
1696 no warnings 'recursion';
1697 # N.B. This used to be combined, but I have seen $c get clobbered if so, and
1698 # I have no idea how, ergo $ret (which appears to fix the issue)
1699 eval { my $ret = $code->execute( $class, $c, @{ $c->req->args } ) || 0; $c->state( $ret ) };
1701 $c->_stats_finish_execute( $stats_info ) if $c->use_stats and $stats_info;
1703 my $last = pop( @{ $c->stack } );
1705 if ( my $error = $@ ) {
1706 if ( blessed($error) and $error->isa('Catalyst::Exception::Detach') ) {
1707 $error->rethrow if $c->depth > 1;
1709 elsif ( blessed($error) and $error->isa('Catalyst::Exception::Go') ) {
1710 $error->rethrow if $c->depth > 0;
1713 unless ( ref $error ) {
1714 no warnings 'uninitialized';
1716 my $class = $last->class;
1717 my $name = $last->name;
1718 $error = qq/Caught exception in $class->$name "$error"/;
1727 sub _stats_start_execute {
1728 my ( $c, $code ) = @_;
1729 my $appclass = ref($c) || $c;
1730 return if ( ( $code->name =~ /^_.*/ )
1731 && ( !$appclass->config->{show_internal_actions} ) );
1733 my $action_name = $code->reverse();
1734 $c->counter->{$action_name}++;
1736 my $action = $action_name;
1737 $action = "/$action" unless $action =~ /->/;
1739 # determine if the call was the result of a forward
1740 # this is done by walking up the call stack and looking for a calling
1741 # sub of Catalyst::forward before the eval
1743 for my $index ( 2 .. 11 ) {
1745 if ( ( caller($index) )[0] eq 'Catalyst'
1746 && ( caller($index) )[3] eq '(eval)' );
1748 if ( ( caller($index) )[3] =~ /forward$/ ) {
1749 $callsub = ( caller($index) )[3];
1750 $action = "-> $action";
1755 my $uid = $action_name . $c->counter->{$action_name};
1757 # is this a root-level call or a forwarded call?
1758 if ( $callsub =~ /forward$/ ) {
1759 my $parent = $c->stack->[-1];
1761 # forward, locate the caller
1762 if ( defined $parent && exists $c->counter->{"$parent"} ) {
1765 parent => "$parent" . $c->counter->{"$parent"},
1771 # forward with no caller may come from a plugin
1790 sub _stats_finish_execute {
1791 my ( $c, $info ) = @_;
1792 $c->stats->profile( end => $info );
1797 Finalizes the request.
1804 for my $error ( @{ $c->error } ) {
1805 $c->log->error($error);
1808 # Support skipping finalize for psgix.io style 'jailbreak'. Used to support
1809 # stuff like cometd and websockets
1811 if($c->request->has_io_fh) {
1816 # Allow engine to handle finalize flow (for POE)
1817 my $engine = $c->engine;
1818 if ( my $code = $engine->can('finalize') ) {
1823 $c->finalize_uploads;
1826 if ( $#{ $c->error } >= 0 ) {
1830 $c->finalize_headers unless $c->response->finalized_headers;
1833 if ( $c->request->method eq 'HEAD' ) {
1834 $c->response->body('');
1842 if ($c->use_stats) {
1843 my $elapsed = $c->stats->elapsed;
1844 my $av = $elapsed == 0 ? '??' : sprintf '%.3f', 1 / $elapsed;
1846 "Request took ${elapsed}s ($av/s)\n" . $c->stats->report . "\n" );
1849 return $c->response->status;
1852 =head2 $c->finalize_body
1858 sub finalize_body { my $c = shift; $c->engine->finalize_body( $c, @_ ) }
1860 =head2 $c->finalize_cookies
1866 sub finalize_cookies { my $c = shift; $c->engine->finalize_cookies( $c, @_ ) }
1868 =head2 $c->finalize_error
1874 sub finalize_error { my $c = shift; $c->engine->finalize_error( $c, @_ ) }
1876 =head2 $c->finalize_headers
1882 sub finalize_headers {
1885 my $response = $c->response; #accessor calls can add up?
1887 # Check if we already finalized headers
1888 return if $response->finalized_headers;
1891 if ( my $location = $response->redirect ) {
1892 $c->log->debug(qq/Redirecting to "$location"/) if $c->debug;
1893 $response->header( Location => $location );
1895 if ( !$response->has_body ) {
1896 # Add a default body if none is already present
1897 my $encoded_location = encode_entities($location);
1898 $response->body(<<"EOF");
1899 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
1900 <html xmlns="http://www.w3.org/1999/xhtml">
1902 <title>Moved</title>
1905 <p>This item has moved <a href="$encoded_location">here</a>.</p>
1909 $response->content_type('text/html; charset=utf-8');
1914 if ( defined $response->body && length $response->body && !$response->content_length ) {
1916 # get the length from a filehandle
1917 if ( blessed( $response->body ) && $response->body->can('read') || ref( $response->body ) eq 'GLOB' )
1919 my $size = -s $response->body;
1921 $response->content_length( $size );
1924 $c->log->warn('Serving filehandle without a content-length');
1928 # everything should be bytes at this point, but just in case
1929 $response->content_length( length( $response->body ) );
1934 if ( $response->status =~ /^(1\d\d|[23]04)$/ ) {
1935 $response->headers->remove_header("Content-Length");
1936 $response->body('');
1939 $c->finalize_cookies;
1941 $c->response->finalize_headers();
1944 $response->finalized_headers(1);
1947 =head2 $c->finalize_output
1949 An alias for finalize_body.
1951 =head2 $c->finalize_read
1953 Finalizes the input after reading is complete.
1957 sub finalize_read { my $c = shift; $c->engine->finalize_read( $c, @_ ) }
1959 =head2 $c->finalize_uploads
1961 Finalizes uploads. Cleans up any temporary files.
1965 sub finalize_uploads { my $c = shift; $c->engine->finalize_uploads( $c, @_ ) }
1967 =head2 $c->get_action( $action, $namespace )
1969 Gets an action in a given namespace.
1973 sub get_action { my $c = shift; $c->dispatcher->get_action(@_) }
1975 =head2 $c->get_actions( $action, $namespace )
1977 Gets all actions of a given name in a namespace and all parent
1982 sub get_actions { my $c = shift; $c->dispatcher->get_actions( $c, @_ ) }
1984 =head2 $app->handle_request( @arguments )
1986 Called to handle each HTTP request.
1990 sub handle_request {
1991 my ( $class, @arguments ) = @_;
1993 # Always expect worst case!
1996 if ($class->debug) {
1997 my $secs = time - $START || 1;
1998 my $av = sprintf '%.3f', $COUNT / $secs;
1999 my $time = localtime time;
2000 $class->log->info("*** Request $COUNT ($av/s) [$$] [$time] ***");
2003 my $c = $class->prepare(@arguments);
2005 $status = $c->finalize;
2008 chomp(my $error = $_);
2009 $class->log->error(qq/Caught exception in engine "$error"/);
2014 if(my $coderef = $class->log->can('_flush')){
2015 $class->log->$coderef();
2020 =head2 $class->prepare( @arguments )
2022 Creates a Catalyst context from an engine-specific request (Apache, CGI,
2029 predicate => '_has_uploadtmp',
2033 my ( $class, @arguments ) = @_;
2036 # After the app/ctxt split, this should become an attribute based on something passed
2037 # into the application.
2038 $class->context_class( ref $class || $class ) unless $class->context_class;
2040 my $uploadtmp = $class->config->{uploadtmp};
2041 my $c = $class->context_class->new({ $uploadtmp ? (_uploadtmp => $uploadtmp) : ()});
2043 $c->response->_context($c);
2045 #surely this is not the most efficient way to do things...
2046 $c->stats($class->stats_class->new)->enable($c->use_stats);
2047 if ( $c->debug || $c->config->{enable_catalyst_header} ) {
2048 $c->res->headers->header( 'X-Catalyst' => $Catalyst::VERSION );
2052 # Allow engine to direct the prepare flow (for POE)
2053 if ( my $prepare = $c->engine->can('prepare') ) {
2054 $c->engine->$prepare( $c, @arguments );
2057 $c->prepare_request(@arguments);
2058 $c->prepare_connection;
2059 $c->prepare_query_parameters;
2060 $c->prepare_headers; # Just hooks, no longer needed - they just
2061 $c->prepare_cookies; # cause the lazy attribute on req to build
2064 # Prepare the body for reading, either by prepare_body
2065 # or the user, if they are using $c->read
2068 # Parse the body unless the user wants it on-demand
2069 unless ( ref($c)->config->{parse_on_demand} ) {
2075 # VERY ugly and probably shouldn't rely on ->finalize actually working
2077 # failed prepare is always due to an invalid request, right?
2078 $c->response->status(400);
2079 $c->response->content_type('text/plain');
2080 $c->response->body('Bad Request');
2081 # Note we call finalize and then die here, which escapes
2082 # finalize being called in the enclosing block..
2083 # It in fact couldn't be called, as we don't return $c..
2084 # This is a mess - but I'm unsure you can fix this without
2085 # breaking compat for people doing crazy things (we should set
2086 # the 400 and just return the ctx here IMO, letting finalize get called
2097 =head2 $c->prepare_action
2099 Prepares action. See L<Catalyst::Dispatcher>.
2103 sub prepare_action { my $c = shift; $c->dispatcher->prepare_action( $c, @_ ) }
2105 =head2 $c->prepare_body
2107 Prepares message body.
2114 return if $c->request->_has_body;
2116 # Initialize on-demand data
2117 $c->engine->prepare_body( $c, @_ );
2118 $c->prepare_parameters;
2119 $c->prepare_uploads;
2122 =head2 $c->prepare_body_chunk( $chunk )
2124 Prepares a chunk of data before sending it to L<HTTP::Body>.
2126 See L<Catalyst::Engine>.
2130 sub prepare_body_chunk {
2132 $c->engine->prepare_body_chunk( $c, @_ );
2135 =head2 $c->prepare_body_parameters
2137 Prepares body parameters.
2141 sub prepare_body_parameters {
2143 $c->engine->prepare_body_parameters( $c, @_ );
2146 =head2 $c->prepare_connection
2148 Prepares connection.
2152 sub prepare_connection {
2154 # XXX - This is called on the engine (not the request) to maintain
2155 # Engine::PSGI back compat.
2156 $c->engine->prepare_connection($c);
2159 =head2 $c->prepare_cookies
2161 Prepares cookies by ensuring that the attribute on the request
2162 object has been built.
2166 sub prepare_cookies { my $c = shift; $c->request->cookies }
2168 =head2 $c->prepare_headers
2170 Prepares request headers by ensuring that the attribute on the request
2171 object has been built.
2175 sub prepare_headers { my $c = shift; $c->request->headers }
2177 =head2 $c->prepare_parameters
2179 Prepares parameters.
2183 sub prepare_parameters {
2185 $c->prepare_body_parameters;
2186 $c->engine->prepare_parameters( $c, @_ );
2189 =head2 $c->prepare_path
2191 Prepares path and base.
2195 sub prepare_path { my $c = shift; $c->engine->prepare_path( $c, @_ ) }
2197 =head2 $c->prepare_query_parameters
2199 Prepares query parameters.
2203 sub prepare_query_parameters {
2206 $c->engine->prepare_query_parameters( $c, @_ );
2209 =head2 $c->log_request
2211 Writes information about the request to the debug logs. This includes:
2215 =item * Request method, path, and remote IP address
2217 =item * Query keywords (see L<Catalyst::Request/query_keywords>)
2219 =item * Request parameters
2221 =item * File uploads
2230 return unless $c->debug;
2232 my($dump) = grep {$_->[0] eq 'Request' } $c->dump_these;
2233 my $request = $dump->[1];
2235 my ( $method, $path, $address ) = ( $request->method, $request->path, $request->address );
2237 $path = '/' unless length $path;
2239 $c->log->debug(qq/"$method" request for "$path" from "$address"/);
2241 $c->log_request_headers($request->headers);
2243 if ( my $keywords = $request->query_keywords ) {
2244 $c->log->debug("Query keywords are: $keywords");
2247 $c->log_request_parameters( query => $request->query_parameters, $request->_has_body ? (body => $request->body_parameters) : () );
2249 $c->log_request_uploads($request);
2252 =head2 $c->log_response
2254 Writes information about the response to the debug logs by calling
2255 C<< $c->log_response_status_line >> and C<< $c->log_response_headers >>.
2262 return unless $c->debug;
2264 my($dump) = grep {$_->[0] eq 'Response' } $c->dump_these;
2265 my $response = $dump->[1];
2267 $c->log_response_status_line($response);
2268 $c->log_response_headers($response->headers);
2271 =head2 $c->log_response_status_line($response)
2273 Writes one line of information about the response to the debug logs. This includes:
2277 =item * Response status code
2279 =item * Content-Type header (if present)
2281 =item * Content-Length header (if present)
2287 sub log_response_status_line {
2288 my ($c, $response) = @_;
2292 'Response Code: %s; Content-Type: %s; Content-Length: %s',
2293 $response->status || 'unknown',
2294 $response->headers->header('Content-Type') || 'unknown',
2295 $response->headers->header('Content-Length') || 'unknown'
2300 =head2 $c->log_response_headers($headers);
2302 Hook method which can be wrapped by plugins to log the response headers.
2303 No-op in the default implementation.
2307 sub log_response_headers {}
2309 =head2 $c->log_request_parameters( query => {}, body => {} )
2311 Logs request parameters to debug logs
2315 sub log_request_parameters {
2317 my %all_params = @_;
2319 return unless $c->debug;
2321 my $column_width = Catalyst::Utils::term_width() - 44;
2322 foreach my $type (qw(query body)) {
2323 my $params = $all_params{$type};
2324 next if ! keys %$params;
2325 my $t = Text::SimpleTable->new( [ 35, 'Parameter' ], [ $column_width, 'Value' ] );
2326 for my $key ( sort keys %$params ) {
2327 my $param = $params->{$key};
2328 my $value = defined($param) ? $param : '';
2329 $t->row( $key, ref $value eq 'ARRAY' ? ( join ', ', @$value ) : $value );
2331 $c->log->debug( ucfirst($type) . " Parameters are:\n" . $t->draw );
2335 =head2 $c->log_request_uploads
2337 Logs file uploads included in the request to the debug logs.
2338 The parameter name, filename, file type, and file size are all included in
2343 sub log_request_uploads {
2345 my $request = shift;
2346 return unless $c->debug;
2347 my $uploads = $request->uploads;
2348 if ( keys %$uploads ) {
2349 my $t = Text::SimpleTable->new(
2350 [ 12, 'Parameter' ],
2355 for my $key ( sort keys %$uploads ) {
2356 my $upload = $uploads->{$key};
2357 for my $u ( ref $upload eq 'ARRAY' ? @{$upload} : ($upload) ) {
2358 $t->row( $key, $u->filename, $u->type, $u->size );
2361 $c->log->debug( "File Uploads are:\n" . $t->draw );
2365 =head2 $c->log_request_headers($headers);
2367 Hook method which can be wrapped by plugins to log the request headers.
2368 No-op in the default implementation.
2372 sub log_request_headers {}
2374 =head2 $c->log_headers($type => $headers)
2376 Logs L<HTTP::Headers> (either request or response) to the debug logs.
2383 my $headers = shift; # an HTTP::Headers instance
2385 return unless $c->debug;
2387 my $column_width = Catalyst::Utils::term_width() - 28;
2388 my $t = Text::SimpleTable->new( [ 15, 'Header Name' ], [ $column_width, 'Value' ] );
2391 my ( $name, $value ) = @_;
2392 $t->row( $name, $value );
2395 $c->log->debug( ucfirst($type) . " Headers:\n" . $t->draw );
2399 =head2 $c->prepare_read
2401 Prepares the input for reading.
2405 sub prepare_read { my $c = shift; $c->engine->prepare_read( $c, @_ ) }
2407 =head2 $c->prepare_request
2409 Prepares the engine request.
2413 sub prepare_request { my $c = shift; $c->engine->prepare_request( $c, @_ ) }
2415 =head2 $c->prepare_uploads
2421 sub prepare_uploads {
2424 $c->engine->prepare_uploads( $c, @_ );
2427 =head2 $c->prepare_write
2429 Prepares the output for writing.
2433 sub prepare_write { my $c = shift; $c->engine->prepare_write( $c, @_ ) }
2435 =head2 $c->request_class
2437 Returns or sets the request class. Defaults to L<Catalyst::Request>.
2439 =head2 $c->response_class
2441 Returns or sets the response class. Defaults to L<Catalyst::Response>.
2443 =head2 $c->read( [$maxlength] )
2445 Reads a chunk of data from the request body. This method is designed to
2446 be used in a while loop, reading C<$maxlength> bytes on every call.
2447 C<$maxlength> defaults to the size of the request if not specified.
2449 You have to set C<< MyApp->config(parse_on_demand => 1) >> to use this
2452 Warning: If you use read(), Catalyst will not process the body,
2453 so you will not be able to access POST parameters or file uploads via
2454 $c->request. You must handle all body parsing yourself.
2458 sub read { my $c = shift; return $c->request->read( @_ ) }
2468 $app->_make_immutable_if_needed;
2469 $app->engine_loader->needs_psgi_engine_compat_hack ?
2470 $app->engine->run($app, @_) :
2471 $app->engine->run( $app, $app->_finalized_psgi_app, @_ );
2474 sub _make_immutable_if_needed {
2476 my $meta = Class::MOP::get_metaclass_by_name($class);
2477 my $isa_ca = $class->isa('Class::Accessor::Fast') || $class->isa('Class::Accessor');
2480 && ! { $meta->immutable_options }->{replace_constructor}
2483 warn("You made your application class ($class) immutable, "
2484 . "but did not inline the\nconstructor. "
2485 . "This will break catalyst, as your app \@ISA "
2486 . "Class::Accessor(::Fast)?\nPlease pass "
2487 . "(replace_constructor => 1)\nwhen making your class immutable.\n");
2489 unless ($meta->is_immutable) {
2490 # XXX - FIXME warning here as you should make your app immutable yourself.
2491 $meta->make_immutable(
2492 replace_constructor => 1,
2497 =head2 $c->set_action( $action, $code, $namespace, $attrs )
2499 Sets an action in a given namespace.
2503 sub set_action { my $c = shift; $c->dispatcher->set_action( $c, @_ ) }
2505 =head2 $c->setup_actions($component)
2507 Sets up actions for a component.
2511 sub setup_actions { my $c = shift; $c->dispatcher->setup_actions( $c, @_ ) }
2513 =head2 $c->setup_components
2515 This method is called internally to set up the application's components.
2517 It finds modules by calling the L<locate_components> method, expands them to
2518 package names with the L<expand_component_module> method, and then installs
2519 each component into the application.
2521 The C<setup_components> config option is passed to both of the above methods.
2523 Installation of each component is performed by the L<setup_component> method,
2528 sub setup_components {
2531 my $config = $class->config->{ setup_components };
2533 my @comps = $class->locate_components($config);
2534 my %comps = map { $_ => 1 } @comps;
2536 my $deprecatedcatalyst_component_names = grep { /::[CMV]::/ } @comps;
2537 $class->log->warn(qq{Your application is using the deprecated ::[MVC]:: type naming scheme.\n}.
2538 qq{Please switch your class names to ::Model::, ::View:: and ::Controller: as appropriate.\n}
2539 ) if $deprecatedcatalyst_component_names;
2541 for my $component ( @comps ) {
2543 # We pass ignore_loaded here so that overlay files for (e.g.)
2544 # Model::DBI::Schema sub-classes are loaded - if it's in @comps
2545 # we know M::P::O found a file on disk so this is safe
2547 Catalyst::Utils::ensure_class_loaded( $component, { ignore_loaded => 1 } );
2550 for my $component (@comps) {
2551 my $instance = $class->components->{ $component } = $class->setup_component($component);
2552 my @expanded_components = $instance->can('expand_modules')
2553 ? $instance->expand_modules( $component, $config )
2554 : $class->expand_component_module( $component, $config );
2555 for my $component (@expanded_components) {
2556 next if $comps{$component};
2557 $class->components->{ $component } = $class->setup_component($component);
2562 =head2 $c->locate_components( $setup_component_config )
2564 This method is meant to provide a list of component modules that should be
2565 setup for the application. By default, it will use L<Module::Pluggable>.
2567 Specify a C<setup_components> config option to pass additional options directly
2568 to L<Module::Pluggable>. To add additional search paths, specify a key named
2569 C<search_extra> as an array reference. Items in the array beginning with C<::>
2570 will have the application class name prepended to them.
2574 sub locate_components {
2578 my @paths = qw( ::Controller ::C ::Model ::M ::View ::V );
2579 my $extra = delete $config->{ search_extra } || [];
2581 push @paths, @$extra;
2583 my $locator = Module::Pluggable::Object->new(
2584 search_path => [ map { s/^(?=::)/$class/; $_; } @paths ],
2588 # XXX think about ditching this sort entirely
2589 my @comps = sort { length $a <=> length $b } $locator->plugins;
2594 =head2 $c->expand_component_module( $component, $setup_component_config )
2596 Components found by C<locate_components> will be passed to this method, which
2597 is expected to return a list of component (package) names to be set up.
2601 sub expand_component_module {
2602 my ($class, $module) = @_;
2603 return Devel::InnerPackage::list_packages( $module );
2606 =head2 $c->setup_component
2610 sub setup_component {
2611 my( $class, $component ) = @_;
2613 unless ( $component->can( 'COMPONENT' ) ) {
2617 my $suffix = Catalyst::Utils::class2classsuffix( $component );
2618 my $config = $class->config->{ $suffix } || {};
2619 # Stash catalyst_component_name in the config here, so that custom COMPONENT
2620 # methods also pass it. local to avoid pointlessly shitting in config
2621 # for the debug screen, as $component is already the key name.
2622 local $config->{catalyst_component_name} = $component;
2624 my $instance = eval { $component->COMPONENT( $class, $config ); };
2626 if ( my $error = $@ ) {
2628 Catalyst::Exception->throw(
2629 message => qq/Couldn't instantiate component "$component", "$error"/
2633 unless (blessed $instance) {
2634 my $metaclass = Moose::Util::find_meta($component);
2635 my $method_meta = $metaclass->find_method_by_name('COMPONENT');
2636 my $component_method_from = $method_meta->associated_metaclass->name;
2637 my $value = defined($instance) ? $instance : 'undef';
2638 Catalyst::Exception->throw(
2640 qq/Couldn't instantiate component "$component", COMPONENT() method (from $component_method_from) didn't return an object-like value (value was $value)./
2646 =head2 $c->setup_dispatcher
2652 sub setup_dispatcher {
2653 my ( $class, $dispatcher ) = @_;
2656 $dispatcher = 'Catalyst::Dispatcher::' . $dispatcher;
2659 if ( my $env = Catalyst::Utils::env_value( $class, 'DISPATCHER' ) ) {
2660 $dispatcher = 'Catalyst::Dispatcher::' . $env;
2663 unless ($dispatcher) {
2664 $dispatcher = $class->dispatcher_class;
2667 load_class($dispatcher);
2669 # dispatcher instance
2670 $class->dispatcher( $dispatcher->new );
2673 =head2 $c->setup_engine
2680 my ($class, $requested_engine) = @_;
2682 if (!$class->engine_loader || $requested_engine) {
2683 $class->engine_loader(
2684 Catalyst::EngineLoader->new({
2685 application_name => $class,
2686 (defined $requested_engine
2687 ? (catalyst_engine_class => $requested_engine) : ()),
2692 $class->engine_loader->catalyst_engine_class;
2696 my ($class, $requested_engine) = @_;
2699 my $loader = $class->engine_loader;
2701 if (!$loader || $requested_engine) {
2702 $loader = Catalyst::EngineLoader->new({
2703 application_name => $class,
2704 (defined $requested_engine
2705 ? (requested_engine => $requested_engine) : ()),
2708 $class->engine_loader($loader);
2711 $loader->catalyst_engine_class;
2714 # Don't really setup_engine -- see _setup_psgi_app for explanation.
2715 return if $class->loading_psgi_file;
2717 load_class($engine);
2719 if ($ENV{MOD_PERL}) {
2720 my $apache = $class->engine_loader->auto;
2722 my $meta = find_meta($class);
2723 my $was_immutable = $meta->is_immutable;
2724 my %immutable_options = $meta->immutable_options;
2725 $meta->make_mutable if $was_immutable;
2727 $meta->add_method(handler => sub {
2729 my $psgi_app = $class->_finalized_psgi_app;
2730 $apache->call_app($r, $psgi_app);
2733 $meta->make_immutable(%immutable_options) if $was_immutable;
2736 $class->engine( $engine->new );
2741 sub _finalized_psgi_app {
2744 unless ($app->_psgi_app) {
2745 my $psgi_app = $app->_setup_psgi_app;
2746 $app->_psgi_app($psgi_app);
2749 return $app->_psgi_app;
2752 sub _setup_psgi_app {
2755 for my $home (Path::Class::Dir->new($app->config->{home})) {
2756 my $psgi_file = $home->file(
2757 Catalyst::Utils::appprefix($app) . '.psgi',
2760 next unless -e $psgi_file;
2762 # If $psgi_file calls ->setup_engine, it's doing so to load
2763 # Catalyst::Engine::PSGI. But if it does that, we're only going to
2764 # throw away the loaded PSGI-app and load the 5.9 Catalyst::Engine
2765 # anyway. So set a flag (ick) that tells setup_engine not to populate
2766 # $c->engine or do any other things we might regret.
2768 $app->loading_psgi_file(1);
2769 my $psgi_app = Plack::Util::load_psgi($psgi_file);
2770 $app->loading_psgi_file(0);
2773 unless $app->engine_loader->needs_psgi_engine_compat_hack;
2776 Found a legacy Catalyst::Engine::PSGI .psgi file at ${psgi_file}.
2778 Its content has been ignored. Please consult the Catalyst::Upgrading
2779 documentation on how to upgrade from Catalyst::Engine::PSGI.
2783 return $app->apply_default_middlewares($app->psgi_app);
2786 =head2 $c->apply_default_middlewares
2788 Adds the following L<Plack> middlewares to your application, since they are
2789 useful and commonly needed:
2791 L<Plack::Middleware::ReverseProxy>, (conditionally added based on the status
2792 of your $ENV{REMOTE_ADDR}, and can be forced on with C<using_frontend_proxy>
2793 or forced off with C<ignore_frontend_proxy>), L<Plack::Middleware::LighttpdScriptNameFix>
2794 (if you are using Lighttpd), L<Plack::Middleware::IIS6ScriptNameFix> (always
2795 applied since this middleware is smart enough to conditionally apply itself).
2797 Additionally if we detect we are using Nginx, we add a bit of custom middleware
2798 to solve some problems with the way that server handles $ENV{PATH_INFO} and
2804 sub apply_default_middlewares {
2805 my ($app, $psgi_app) = @_;
2807 $psgi_app = Plack::Middleware::Conditional->wrap(
2809 builder => sub { Plack::Middleware::ReverseProxy->wrap($_[0]) },
2812 return if $app->config->{ignore_frontend_proxy};
2813 return $env->{REMOTE_ADDR} eq '127.0.0.1'
2814 || $app->config->{using_frontend_proxy};
2818 # If we're running under Lighttpd, swap PATH_INFO and SCRIPT_NAME
2819 # http://lists.scsys.co.uk/pipermail/catalyst/2006-June/008361.html
2820 $psgi_app = Plack::Middleware::Conditional->wrap(
2822 builder => sub { Plack::Middleware::LighttpdScriptNameFix->wrap($_[0]) },
2825 return unless $env->{SERVER_SOFTWARE} && $env->{SERVER_SOFTWARE} =~ m!lighttpd[-/]1\.(\d+\.\d+)!;
2826 return unless $1 < 4.23;
2831 # we're applying this unconditionally as the middleware itself already makes
2832 # sure it doesn't fuck things up if it's not running under one of the right
2834 $psgi_app = Plack::Middleware::IIS6ScriptNameFix->wrap($psgi_app);
2836 # And another IIS issue, this time with IIS7.
2837 $psgi_app = Plack::Middleware::Conditional->wrap(
2839 builder => sub { Plack::Middleware::IIS7KeepAliveFix->wrap($_[0]) },
2842 return $env->{SERVER_SOFTWARE} && $env->{SERVER_SOFTWARE} =~ m!IIS/7\.[0-9]!;
2851 Returns a PSGI application code reference for the catalyst application
2852 C<$c>. This is the bare application without any middlewares
2853 applied. C<${myapp}.psgi> is not taken into account.
2855 This is what you want to be using to retrieve the PSGI application code
2856 reference of your Catalyst application for use in F<.psgi> files.
2862 return $app->engine->build_psgi_app($app);
2865 =head2 $c->setup_home
2867 Sets up the home directory.
2872 my ( $class, $home ) = @_;
2874 if ( my $env = Catalyst::Utils::env_value( $class, 'HOME' ) ) {
2878 $home ||= Catalyst::Utils::home($class);
2881 #I remember recently being scolded for assigning config values like this
2882 $class->config->{home} ||= $home;
2883 $class->config->{root} ||= Path::Class::Dir->new($home)->subdir('root');
2887 =head2 $c->setup_log
2889 Sets up log by instantiating a L<Catalyst::Log|Catalyst::Log> object and
2890 passing it to C<log()>. Pass in a comma-delimited list of levels to set the
2893 This method also installs a C<debug> method that returns a true value into the
2894 catalyst subclass if the "debug" level is passed in the comma-delimited list,
2895 or if the C<$CATALYST_DEBUG> environment variable is set to a true value.
2897 Note that if the log has already been setup, by either a previous call to
2898 C<setup_log> or by a call such as C<< __PACKAGE__->log( MyLogger->new ) >>,
2899 that this method won't actually set up the log object.
2904 my ( $class, $levels ) = @_;
2907 $levels =~ s/^\s+//;
2908 $levels =~ s/\s+$//;
2909 my %levels = map { $_ => 1 } split /\s*,\s*/, $levels;
2911 my $env_debug = Catalyst::Utils::env_value( $class, 'DEBUG' );
2912 if ( defined $env_debug ) {
2913 $levels{debug} = 1 if $env_debug; # Ugly!
2914 delete($levels{debug}) unless $env_debug;
2917 unless ( $class->log ) {
2918 $class->log( Catalyst::Log->new(keys %levels) );
2921 if ( $levels{debug} ) {
2922 Class::MOP::get_metaclass_by_name($class)->add_method('debug' => sub { 1 });
2923 $class->log->debug('Debug messages enabled');
2927 =head2 $c->setup_plugins
2933 =head2 $c->setup_stats
2935 Sets up timing statistics class.
2940 my ( $class, $stats ) = @_;
2942 Catalyst::Utils::ensure_class_loaded($class->stats_class);
2944 my $env = Catalyst::Utils::env_value( $class, 'STATS' );
2945 if ( defined($env) ? $env : ($stats || $class->debug ) ) {
2946 Class::MOP::get_metaclass_by_name($class)->add_method('use_stats' => sub { 1 });
2947 $class->log->debug('Statistics enabled');
2952 =head2 $c->registered_plugins
2954 Returns a sorted list of the plugins which have either been stated in the
2957 If passed a given plugin name, it will report a boolean value indicating
2958 whether or not that plugin is loaded. A fully qualified name is required if
2959 the plugin name does not begin with C<Catalyst::Plugin::>.
2961 if ($c->registered_plugins('Some::Plugin')) {
2969 sub registered_plugins {
2971 return sort keys %{ $proto->_plugins } unless @_;
2973 return 1 if exists $proto->_plugins->{$plugin};
2974 return exists $proto->_plugins->{"Catalyst::Plugin::$plugin"};
2977 sub _register_plugin {
2978 my ( $proto, $plugin, $instant ) = @_;
2979 my $class = ref $proto || $proto;
2981 load_class( $plugin );
2982 $class->log->warn( "$plugin inherits from 'Catalyst::Component' - this is deprecated and will not work in 5.81" )
2983 if $plugin->isa( 'Catalyst::Component' );
2984 my $plugin_meta = Moose::Meta::Class->create($plugin);
2985 if (!$plugin_meta->has_method('new')
2986 && ( $plugin->isa('Class::Accessor::Fast') || $plugin->isa('Class::Accessor') ) ) {
2987 $plugin_meta->add_method('new', Moose::Object->meta->get_method('new'))
2989 if (!$instant && !$proto->_plugins->{$plugin}) {
2990 my $meta = Class::MOP::get_metaclass_by_name($class);
2991 $meta->superclasses($plugin, $meta->superclasses);
2993 $proto->_plugins->{$plugin} = 1;
2997 sub _default_plugins { return qw(Unicode::Encoding) }
3000 my ( $class, $plugins ) = @_;
3002 $class->_plugins( {} ) unless $class->_plugins;
3004 m/Unicode::Encoding/ ? do {
3006 'Unicode::Encoding plugin is auto-applied,'
3007 . ' please remove this from your appclass'
3008 . ' and make sure to define "encoding" config'
3010 unless (exists $class->config->{'encoding'}) {
3011 $class->config->{'encoding'} = 'UTF-8';
3016 push @$plugins, $class->_default_plugins;
3017 $plugins = Data::OptList::mkopt($plugins || []);
3020 [ Catalyst::Utils::resolve_namespace(
3021 $class . '::Plugin',
3022 'Catalyst::Plugin', $_->[0]
3028 for my $plugin ( reverse @plugins ) {
3029 load_class($plugin->[0], $plugin->[1]);
3030 my $meta = find_meta($plugin->[0]);
3031 next if $meta && $meta->isa('Moose::Meta::Role');
3033 $class->_register_plugin($plugin->[0]);
3037 map { $_->[0]->name, $_->[1] }
3038 grep { blessed($_->[0]) && $_->[0]->isa('Moose::Meta::Role') }
3039 map { [find_meta($_->[0]), $_->[1]] }
3042 Moose::Util::apply_all_roles(
3050 Returns an arrayref of the internal execution stack (actions that are
3051 currently executing).
3055 Returns the current timing statistics object. By default Catalyst uses
3056 L<Catalyst::Stats|Catalyst::Stats>, but can be set otherwise with
3057 L<< stats_class|/"$c->stats_class" >>.
3059 Even if L<< -Stats|/"-Stats" >> is not enabled, the stats object is still
3060 available. By enabling it with C< $c->stats->enabled(1) >, it can be used to
3061 profile explicitly, although MyApp.pm still won't profile nor output anything
3064 =head2 $c->stats_class
3066 Returns or sets the stats (timing statistics) class. L<Catalyst::Stats|Catalyst::Stats> is used by default.
3068 =head2 $c->use_stats
3070 Returns 1 when L<< stats collection|/"-Stats" >> is enabled.
3072 Note that this is a static method, not an accessor and should be overridden
3073 by declaring C<sub use_stats { 1 }> in your MyApp.pm, not by calling C<< $c->use_stats(1) >>.
3080 =head2 $c->write( $data )
3082 Writes $data to the output stream. When using this method directly, you
3083 will need to manually set the C<Content-Length> header to the length of
3084 your output data, if known.
3091 # Finalize headers if someone manually writes output (for compat)
3092 $c->finalize_headers;
3094 return $c->response->write( @_ );
3099 Returns the Catalyst version number. Mostly useful for "powered by"
3100 messages in template systems.
3104 sub version { return $Catalyst::VERSION }
3106 =head1 CONFIGURATION
3108 There are a number of 'base' config variables which can be set:
3114 C<default_model> - The default model picked if you say C<< $c->model >>. See L<< /$c->model($name) >>.
3118 C<default_view> - The default view to be rendered or returned when C<< $c->view >> is called. See L<< /$c->view($name) >>.
3122 C<disable_component_resolution_regex_fallback> - Turns
3123 off the deprecated component resolution functionality so
3124 that if any of the component methods (e.g. C<< $c->controller('Foo') >>)
3125 are called then regex search will not be attempted on string values and
3126 instead C<undef> will be returned.
3130 C<home> - The application home directory. In an uninstalled application,
3131 this is the top level application directory. In an installed application,
3132 this will be the directory containing C<< MyApp.pm >>.
3136 C<ignore_frontend_proxy> - See L</PROXY SUPPORT>
3140 C<name> - The name of the application in debug messages and the debug and
3145 C<parse_on_demand> - The request body (for example file uploads) will not be parsed
3146 until it is accessed. This allows you to (for example) check authentication (and reject
3147 the upload) before actually receiving all the data. See L</ON-DEMAND PARSER>
3151 C<root> - The root directory for templates. Usually this is just a
3152 subdirectory of the home directory, but you can set it to change the
3153 templates to a different directory.
3157 C<search_extra> - Array reference passed to Module::Pluggable to for additional
3158 namespaces from which components will be loaded (and constructed and stored in
3159 C<< $c->components >>).
3163 C<show_internal_actions> - If true, causes internal actions such as C<< _DISPATCH >>
3164 to be shown in hit debug tables in the test server.
3168 C<use_request_uri_for_path> - Controls if the C<REQUEST_URI> or C<PATH_INFO> environment
3169 variable should be used for determining the request path.
3171 Most web server environments pass the requested path to the application using environment variables,
3172 from which Catalyst has to reconstruct the request base (i.e. the top level path to / in the application,
3173 exposed as C<< $c->request->base >>) and the request path below that base.
3175 There are two methods of doing this, both of which have advantages and disadvantages. Which method is used
3176 is determined by the C<< $c->config(use_request_uri_for_path) >> setting (which can either be true or false).
3180 =item use_request_uri_for_path => 0
3182 This is the default (and the) traditional method that Catalyst has used for determining the path information.
3183 The path is generated from a combination of the C<PATH_INFO> and C<SCRIPT_NAME> environment variables.
3184 The allows the application to behave correctly when C<mod_rewrite> is being used to redirect requests
3185 into the application, as these variables are adjusted by mod_rewrite to take account for the redirect.
3187 However this method has the major disadvantage that it is impossible to correctly decode some elements
3188 of the path, as RFC 3875 says: "C<< Unlike a URI path, the PATH_INFO is not URL-encoded, and cannot
3189 contain path-segment parameters. >>" This means PATH_INFO is B<always> decoded, and therefore Catalyst
3190 can't distinguish / vs %2F in paths (in addition to other encoded values).
3192 =item use_request_uri_for_path => 1
3194 This method uses the C<REQUEST_URI> and C<SCRIPT_NAME> environment variables. As C<REQUEST_URI> is never
3195 decoded, this means that applications using this mode can correctly handle URIs including the %2F character
3196 (i.e. with C<AllowEncodedSlashes> set to C<On> in Apache).
3198 Given that this method of path resolution is provably more correct, it is recommended that you use
3199 this unless you have a specific need to deploy your application in a non-standard environment, and you are
3200 aware of the implications of not being able to handle encoded URI paths correctly.
3202 However it also means that in a number of cases when the app isn't installed directly at a path, but instead
3203 is having paths rewritten into it (e.g. as a .cgi/fcgi in a public_html directory, with mod_rewrite in a
3204 .htaccess file, or when SSI is used to rewrite pages into the app, or when sub-paths of the app are exposed
3205 at other URIs than that which the app is 'normally' based at with C<mod_rewrite>), the resolution of
3206 C<< $c->request->base >> will be incorrect.
3212 C<using_frontend_proxy> - See L</PROXY SUPPORT>.
3216 C<encoding> - See L</ENCODING>
3220 C<abort_chain_on_error_fix>
3222 When there is an error in an action chain, the default behavior is to continue
3223 processing the remaining actions and then catch the error upon chain end. This
3224 can lead to running actions when the application is in an unexpected state. If
3225 you have this issue, setting this config value to true will promptly exit a
3226 chain when there is an error raised in any action (thus terminating the chain
3231 __PACKAGE__->config(abort_chain_on_error_fix => 1);
3233 In the future this might become the default behavior.
3237 =head1 INTERNAL ACTIONS
3239 Catalyst uses internal actions like C<_DISPATCH>, C<_BEGIN>, C<_AUTO>,
3240 C<_ACTION>, and C<_END>. These are by default not shown in the private
3241 action table, but you can make them visible with a config parameter.
3243 MyApp->config(show_internal_actions => 1);
3245 =head1 ON-DEMAND PARSER
3247 The request body is usually parsed at the beginning of a request,
3248 but if you want to handle input yourself, you can enable on-demand
3249 parsing with a config parameter.
3251 MyApp->config(parse_on_demand => 1);
3253 =head1 PROXY SUPPORT
3255 Many production servers operate using the common double-server approach,
3256 with a lightweight frontend web server passing requests to a larger
3257 backend server. An application running on the backend server must deal
3258 with two problems: the remote user always appears to be C<127.0.0.1> and
3259 the server's hostname will appear to be C<localhost> regardless of the
3260 virtual host that the user connected through.
3262 Catalyst will automatically detect this situation when you are running
3263 the frontend and backend servers on the same machine. The following
3264 changes are made to the request.
3266 $c->req->address is set to the user's real IP address, as read from
3267 the HTTP X-Forwarded-For header.
3269 The host value for $c->req->base and $c->req->uri is set to the real
3270 host, as read from the HTTP X-Forwarded-Host header.
3272 Additionally, you may be running your backend application on an insecure
3273 connection (port 80) while your frontend proxy is running under SSL. If there
3274 is a discrepancy in the ports, use the HTTP header C<X-Forwarded-Port> to
3275 tell Catalyst what port the frontend listens on. This will allow all URIs to
3276 be created properly.
3278 In the case of passing in:
3280 X-Forwarded-Port: 443
3282 All calls to C<uri_for> will result in an https link, as is expected.
3284 Obviously, your web server must support these headers for this to work.
3286 In a more complex server farm environment where you may have your
3287 frontend proxy server(s) on different machines, you will need to set a
3288 configuration option to tell Catalyst to read the proxied data from the
3291 MyApp->config(using_frontend_proxy => 1);
3293 If you do not wish to use the proxy support at all, you may set:
3295 MyApp->config(ignore_frontend_proxy => 0);
3297 =head2 Note about psgi files
3299 Note that if you supply your own .psgi file, calling
3300 C<< MyApp->psgi_app(@_); >>, then B<this will not happen automatically>.
3302 You either need to apply L<Plack::Middleware::ReverseProxy> yourself
3303 in your psgi, for example:
3306 enable "Plack::Middleware::ReverseProxy";
3310 This will unconditionally add the ReverseProxy support, or you need to call
3311 C<< $app = MyApp->apply_default_middlewares($app) >> (to conditionally
3312 apply the support depending upon your config).
3314 See L<Catalyst::PSGI> for more information.
3316 =head1 THREAD SAFETY
3318 Catalyst has been tested under Apache 2's threading C<mpm_worker>,
3319 C<mpm_winnt>, and the standalone forking HTTP server on Windows. We
3320 believe the Catalyst core to be thread-safe.
3322 If you plan to operate in a threaded environment, remember that all other
3323 modules you are using must also be thread-safe. Some modules, most notably
3324 L<DBD::SQLite>, are not thread-safe.
3328 On request, decodes all params from encoding into a sequence of
3329 logical characters. On response, encodes body into encoding.
3337 Returns an instance of an C<Encode> encoding
3339 print $c->encoding->name
3341 =item handle_unicode_encoding_exception ($exception_context)
3343 Method called when decoding process for a request fails.
3345 An C<$exception_context> hashref is provided to allow you to override the
3346 behaviour of your application when given data with incorrect encodings.
3348 The default method throws exceptions in the case of invalid request parameters
3349 (resulting in a 500 error), but ignores errors in upload filenames.
3351 The keys passed in the C<$exception_context> hash are:
3357 The value which was not able to be decoded.
3361 The exception received from L<Encode>.
3365 What type of data was being decoded. Valid values are (currently)
3366 C<params> - for request parameters / arguments / captures
3367 and C<uploads> - for request upload filenames.
3377 Join #catalyst on irc.perl.org.
3381 http://lists.scsys.co.uk/cgi-bin/mailman/listinfo/catalyst
3382 http://lists.scsys.co.uk/cgi-bin/mailman/listinfo/catalyst-dev
3386 http://catalyst.perl.org
3390 http://dev.catalyst.perl.org
3394 =head2 L<Task::Catalyst> - All you need to start with Catalyst
3396 =head2 L<Catalyst::Manual> - The Catalyst Manual
3398 =head2 L<Catalyst::Component>, L<Catalyst::Controller> - Base classes for components
3400 =head2 L<Catalyst::Engine> - Core engine
3402 =head2 L<Catalyst::Log> - Log class.
3404 =head2 L<Catalyst::Request> - Request object
3406 =head2 L<Catalyst::Response> - Response object
3408 =head2 L<Catalyst::Test> - The test suite.
3410 =head1 PROJECT FOUNDER
3412 sri: Sebastian Riedel <sri@cpan.org>
3418 acme: Leon Brocard <leon@astray.com>
3420 abraxxa: Alexander Hartmaier <abraxxa@cpan.org>
3424 Andrew Ford E<lt>A.Ford@ford-mason.co.ukE<gt>
3428 andyg: Andy Grundman <andy@hybridized.org>
3430 audreyt: Audrey Tang
3432 bricas: Brian Cassidy <bricas@cpan.org>
3434 Caelum: Rafael Kitover <rkitover@io.com>
3436 chansen: Christian Hansen
3438 chicks: Christopher Hicks
3440 Chisel Wright C<pause@herlpacker.co.uk>
3442 Danijel Milicevic C<me@danijel.de>
3444 David Kamholz E<lt>dkamholz@cpan.orgE<gt>
3446 David Naughton, C<naughton@umn.edu>
3450 dhoss: Devin Austin <dhoss@cpan.org>
3452 dkubb: Dan Kubb <dan.kubb-cpan@onautopilot.com>
3456 dwc: Daniel Westermann-Clark <danieltwc@cpan.org>
3458 esskar: Sascha Kiefer
3460 fireartist: Carl Franks <cfranks@cpan.org>
3462 frew: Arthur Axel "fREW" Schmidt <frioux@gmail.com>
3464 gabb: Danijel Milicevic
3468 Gavin Henry C<ghenry@perl.me.uk>
3472 groditi: Guillermo Roditi <groditi@gmail.com>
3474 hobbs: Andrew Rodland <andrew@cleverdomain.org>
3476 ilmari: Dagfinn Ilmari Mannsåker <ilmari@ilmari.org>
3478 jcamacho: Juan Camacho
3480 jester: Jesse Sheidlower C<jester@panix.com>
3482 jhannah: Jay Hannah <jay@jays.net>
3488 jon: Jon Schutz <jjschutz@cpan.org>
3490 Jonathan Rockway C<< <jrockway@cpan.org> >>
3492 Kieren Diment C<kd@totaldatasolution.com>
3494 konobi: Scott McWhirter <konobi@cpan.org>
3496 marcus: Marcus Ramberg <mramberg@cpan.org>
3498 miyagawa: Tatsuhiko Miyagawa <miyagawa@bulknews.net>
3500 mgrimes: Mark Grimes <mgrimes@cpan.org>
3502 mst: Matt S. Trout <mst@shadowcatsystems.co.uk>
3506 naughton: David Naughton
3508 ningu: David Kamholz <dkamholz@cpan.org>
3510 nothingmuch: Yuval Kogman <nothingmuch@woobling.org>
3512 numa: Dan Sully <daniel@cpan.org>
3518 omega: Andreas Marienborg
3520 Oleg Kostyuk <cub.uanic@gmail.com>
3522 phaylon: Robert Sedlacek <phaylon@dunkelheit.at>
3524 rafl: Florian Ragwitz <rafl@debian.org>
3526 random: Roland Lammel <lammel@cpan.org>
3528 Robert Sedlacek C<< <rs@474.at> >>
3530 SpiceMan: Marcel Montes
3534 szbalint: Balint Szilakszi <szbalint@cpan.org>
3536 t0m: Tomas Doran <bobtfish@bobtfish.net>
3540 Viljo Marrandi C<vilts@yahoo.com>
3542 Will Hawes C<info@whawes.co.uk>
3544 willert: Sebastian Willert <willert@cpan.org>
3546 wreis: Wallace Reis <wreis@cpan.org>
3548 Yuval Kogman, C<nothingmuch@woobling.org>
3550 rainboxx: Matthias Dietrich, C<perl@rainboxx.de>
3552 dd070: Dhaval Dhanani <dhaval070@gmail.com>
3556 Copyright (c) 2005, the above named PROJECT FOUNDER and CONTRIBUTORS.
3560 This library is free software. You can redistribute it and/or modify it under
3561 the same terms as Perl itself.
3567 __PACKAGE__->meta->make_immutable;