4 use Moose::Meta::Class ();
5 extends 'Catalyst::Component';
6 use Moose::Util qw/find_meta/;
7 use B::Hooks::EndOfScope ();
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 ();
20 use Module::Pluggable::Object ();
21 use Text::SimpleTable ();
22 use Path::Class::Dir ();
23 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;
34 use Carp qw/croak carp shortmess/;
37 BEGIN { require 5.008004; }
39 has stack => (is => 'ro', default => sub { [] });
40 has stash => (is => 'rw', default => sub { {} });
41 has state => (is => 'rw', default => 0);
42 has stats => (is => 'rw');
43 has action => (is => 'rw');
44 has counter => (is => 'rw', default => sub { {} });
45 has request => (is => 'rw', default => sub { $_[0]->request_class->new({}) }, required => 1, lazy => 1);
46 has response => (is => 'rw', default => sub { $_[0]->response_class->new({}) }, required => 1, lazy => 1);
47 has namespace => (is => 'rw');
49 sub depth { scalar @{ shift->stack || [] }; }
50 sub comp { shift->component(@_) }
53 my $self = shift; return $self->request(@_);
56 my $self = shift; return $self->response(@_);
59 # For backwards compatibility
60 sub finalize_output { shift->finalize_body(@_) };
65 our $RECURSION = 1000;
66 our $DETACH = Catalyst::Exception::Detach->new;
67 our $GO = Catalyst::Exception::Go->new;
69 #I imagine that very few of these really need to be class variables. if any.
70 #maybe we should just make them attributes with a default?
71 __PACKAGE__->mk_classdata($_)
72 for qw/components arguments dispatcher engine log dispatcher_class
73 engine_class context_class request_class response_class stats_class
74 setup_finished psgi_app/;
76 __PACKAGE__->dispatcher_class('Catalyst::Dispatcher');
77 __PACKAGE__->engine_class('Catalyst::Engine');
78 __PACKAGE__->request_class('Catalyst::Request');
79 __PACKAGE__->response_class('Catalyst::Response');
80 __PACKAGE__->stats_class('Catalyst::Stats');
82 # Remember to update this in Catalyst::Runtime as well!
84 our $VERSION = '5.80029';
87 my ( $class, @arguments ) = @_;
89 # We have to limit $class to Catalyst to avoid pushing Catalyst upon every
91 return unless $class eq 'Catalyst';
93 my $caller = caller();
94 return if $caller eq 'main';
96 my $meta = Moose::Meta::Class->initialize($caller);
97 unless ( $caller->isa('Catalyst') ) {
98 my @superclasses = ($meta->superclasses, $class, 'Catalyst::Controller');
99 $meta->superclasses(@superclasses);
101 # Avoid possible C3 issues if 'Moose::Object' is already on RHS of MyApp
102 $meta->superclasses(grep { $_ ne 'Moose::Object' } $meta->superclasses);
104 unless( $meta->has_method('meta') ){
105 if ($Moose::VERSION >= 1.15) {
106 $meta->_add_meta_method('meta');
109 $meta->add_method(meta => sub { Moose::Meta::Class->initialize("${caller}") } );
113 $caller->arguments( [@arguments] );
117 sub _application { $_[0] }
121 Catalyst - The Elegant MVC Web Application Framework
125 See the L<Catalyst::Manual> distribution for comprehensive
126 documentation and tutorials.
128 # Install Catalyst::Devel for helpers and other development tools
129 # use the helper to create a new application
132 # add models, views, controllers
133 script/myapp_create.pl model MyDatabase DBIC::Schema create=static dbi:SQLite:/path/to/db
134 script/myapp_create.pl view MyTemplate TT
135 script/myapp_create.pl controller Search
137 # built in testserver -- use -r to restart automatically on changes
138 # --help to see all available options
139 script/myapp_server.pl
141 # command line testing interface
142 script/myapp_test.pl /yada
145 use Catalyst qw/-Debug/; # include plugins here as well
147 ### In lib/MyApp/Controller/Root.pm (autocreated)
148 sub foo : Global { # called for /foo, /foo/1, /foo/1/2, etc.
149 my ( $self, $c, @args ) = @_; # args are qw/1 2/ for /foo/1/2
150 $c->stash->{template} = 'foo.tt'; # set the template
151 # lookup something from db -- stash vars are passed to TT
153 $c->model('Database::Foo')->search( { country => $args[0] } );
154 if ( $c->req->params->{bar} ) { # access GET or POST parameters
155 $c->forward( 'bar' ); # process another action
156 # do something else after forward returns
160 # The foo.tt TT template can use the stash data from the database
161 [% WHILE (item = data.next) %]
165 # called for /bar/of/soap, /bar/of/soap/10, etc.
166 sub bar : Path('/bar/of/soap') { ... }
168 # called for all actions, from the top-most controller downwards
170 my ( $self, $c ) = @_;
171 if ( !$c->user_exists ) { # Catalyst::Plugin::Authentication
172 $c->res->redirect( '/login' ); # require login
173 return 0; # abort request and go immediately to end()
175 return 1; # success; carry on to next action
178 # called after all actions are finished
180 my ( $self, $c ) = @_;
181 if ( scalar @{ $c->error } ) { ... } # handle errors
182 return if $c->res->body; # already have a response
183 $c->forward( 'MyApp::View::TT' ); # render template
186 ### in MyApp/Controller/Foo.pm
187 # called for /foo/bar
188 sub bar : Local { ... }
190 # called for /blargle
191 sub blargle : Global { ... }
193 # an index action matches /foo, but not /foo/1, etc.
194 sub index : Private { ... }
196 ### in MyApp/Controller/Foo/Bar.pm
197 # called for /foo/bar/baz
198 sub baz : Local { ... }
200 # first Root auto is called, then Foo auto, then this
201 sub auto : Private { ... }
203 # powerful regular expression paths are also possible
204 sub details : Regex('^product/(\w+)/details$') {
205 my ( $self, $c ) = @_;
206 # extract the (\w+) from the URI
207 my $product = $c->req->captures->[0];
210 See L<Catalyst::Manual::Intro> for additional information.
214 Catalyst is a modern framework for making web applications without the
215 pain usually associated with this process. This document is a reference
216 to the main Catalyst application. If you are a new user, we suggest you
217 start with L<Catalyst::Manual::Tutorial> or L<Catalyst::Manual::Intro>.
219 See L<Catalyst::Manual> for more documentation.
221 Catalyst plugins can be loaded by naming them as arguments to the "use
222 Catalyst" statement. Omit the C<Catalyst::Plugin::> prefix from the
223 plugin name, i.e., C<Catalyst::Plugin::My::Module> becomes
226 use Catalyst qw/My::Module/;
228 If your plugin starts with a name other than C<Catalyst::Plugin::>, you can
229 fully qualify the name by using a unary plus:
233 +Fully::Qualified::Plugin::Name
236 Special flags like C<-Debug> and C<-Engine> can also be specified as
237 arguments when Catalyst is loaded:
239 use Catalyst qw/-Debug My::Module/;
241 The position of plugins and flags in the chain is important, because
242 they are loaded in the order in which they appear.
244 The following flags are supported:
248 Enables debug output. You can also force this setting from the system
249 environment with CATALYST_DEBUG or <MYAPP>_DEBUG. The environment
250 settings override the application, with <MYAPP>_DEBUG having the highest
253 This sets the log level to 'debug' and enables full debug output on the
254 error screen. If you only want the latter, see L<< $c->debug >>.
258 Forces Catalyst to use a specific engine. Omit the
259 C<Catalyst::Engine::> prefix of the engine name, i.e.:
261 use Catalyst qw/-Engine=CGI/;
265 Forces Catalyst to use a specific home directory, e.g.:
267 use Catalyst qw[-Home=/usr/mst];
269 This can also be done in the shell environment by setting either the
270 C<CATALYST_HOME> environment variable or C<MYAPP_HOME>; where C<MYAPP>
271 is replaced with the uppercased name of your application, any "::" in
272 the name will be replaced with underscores, e.g. MyApp::Web should use
273 MYAPP_WEB_HOME. If both variables are set, the MYAPP_HOME one will be used.
275 If none of these are set, Catalyst will attempt to automatically detect the
276 home directory. If you are working in a development envirnoment, Catalyst
277 will try and find the directory containing either Makefile.PL, Build.PL or
278 dist.ini. If the application has been installed into the system (i.e.
279 you have done C<make install>), then Catalyst will use the path to your
280 application module, without the .pm extension (ie, /foo/MyApp if your
281 application was installed at /foo/MyApp.pm)
285 use Catalyst '-Log=warn,fatal,error';
287 Specifies a comma-delimited list of log levels.
291 Enables statistics collection and reporting.
293 use Catalyst qw/-Stats=1/;
295 You can also force this setting from the system environment with CATALYST_STATS
296 or <MYAPP>_STATS. The environment settings override the application, with
297 <MYAPP>_STATS having the highest priority.
299 Stats are also enabled if L<< debugging |/"-Debug" >> is enabled.
303 =head2 INFORMATION ABOUT THE CURRENT REQUEST
307 Returns a L<Catalyst::Action> object for the current action, which
308 stringifies to the action name. See L<Catalyst::Action>.
312 Returns the namespace of the current action, i.e., the URI prefix
313 corresponding to the controller of the current action. For example:
315 # in Controller::Foo::Bar
316 $c->namespace; # returns 'foo/bar';
322 Returns the current L<Catalyst::Request> object, giving access to
323 information about the current client request (including parameters,
324 cookies, HTTP headers, etc.). See L<Catalyst::Request>.
326 =head2 REQUEST FLOW HANDLING
328 =head2 $c->forward( $action [, \@arguments ] )
330 =head2 $c->forward( $class, $method, [, \@arguments ] )
332 Forwards processing to another action, by its private name. If you give a
333 class name but no method, C<process()> is called. You may also optionally
334 pass arguments in an arrayref. The action will receive the arguments in
335 C<@_> and C<< $c->req->args >>. Upon returning from the function,
336 C<< $c->req->args >> will be restored to the previous values.
338 Any data C<return>ed from the action forwarded to, will be returned by the
341 my $foodata = $c->forward('/foo');
342 $c->forward('index');
343 $c->forward(qw/Model::DBIC::Foo do_stuff/);
344 $c->forward('View::TT');
346 Note that L<< forward|/"$c->forward( $action [, \@arguments ] )" >> implies
347 an C<< eval { } >> around the call (actually
348 L<< execute|/"$c->execute( $class, $coderef )" >> does), thus de-fatalizing
349 all 'dies' within the called action. If you want C<die> to propagate you
350 need to do something like:
353 die join "\n", @{ $c->error } if @{ $c->error };
355 Or make sure to always return true values from your actions and write
358 $c->forward('foo') || return;
360 Another note is that C<< $c->forward >> always returns a scalar because it
361 actually returns $c->state which operates in a scalar context.
362 Thus, something like:
366 in an action that is forwarded to is going to return a scalar,
367 i.e. how many items are in that array, which is probably not what you want.
368 If you need to return an array then return a reference to it,
371 $c->stash->{array} = \@array;
373 and access it from the stash.
375 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.
379 sub forward { my $c = shift; no warnings 'recursion'; $c->dispatcher->forward( $c, @_ ) }
381 =head2 $c->detach( $action [, \@arguments ] )
383 =head2 $c->detach( $class, $method, [, \@arguments ] )
387 The same as L<< forward|/"$c->forward( $action [, \@arguments ] )" >>, but
388 doesn't return to the previous action when processing is finished.
390 When called with no arguments it escapes the processing chain entirely.
394 sub detach { my $c = shift; $c->dispatcher->detach( $c, @_ ) }
396 =head2 $c->visit( $action [, \@captures, \@arguments ] )
398 =head2 $c->visit( $class, $method, [, \@captures, \@arguments ] )
400 Almost the same as L<< forward|/"$c->forward( $action [, \@arguments ] )" >>,
401 but does a full dispatch, instead of just calling the new C<$action> /
402 C<< $class->$method >>. This means that C<begin>, C<auto> and the method
403 you go to are called, just like a new request.
405 In addition both C<< $c->action >> and C<< $c->namespace >> are localized.
406 This means, for example, that C<< $c->action >> methods such as
407 L<name|Catalyst::Action/name>, L<class|Catalyst::Action/class> and
408 L<reverse|Catalyst::Action/reverse> return information for the visited action
409 when they are invoked within the visited action. This is different from the
410 behavior of L<< forward|/"$c->forward( $action [, \@arguments ] )" >>, which
411 continues to use the $c->action object from the caller action even when
412 invoked from the callee.
414 C<< $c->stash >> is kept unchanged.
416 In effect, L<< visit|/"$c->visit( $action [, \@captures, \@arguments ] )" >>
417 allows you to "wrap" another action, just as it would have been called by
418 dispatching from a URL, while the analogous
419 L<< go|/"$c->go( $action [, \@captures, \@arguments ] )" >> allows you to
420 transfer control to another action as if it had been reached directly from a URL.
424 sub visit { my $c = shift; $c->dispatcher->visit( $c, @_ ) }
426 =head2 $c->go( $action [, \@captures, \@arguments ] )
428 =head2 $c->go( $class, $method, [, \@captures, \@arguments ] )
430 The relationship between C<go> and
431 L<< visit|/"$c->visit( $action [, \@captures, \@arguments ] )" >> is the same as
432 the relationship between
433 L<< forward|/"$c->forward( $class, $method, [, \@arguments ] )" >> and
434 L<< detach|/"$c->detach( $action [, \@arguments ] )" >>. Like C<< $c->visit >>,
435 C<< $c->go >> will perform a full dispatch on the specified action or method,
436 with localized C<< $c->action >> and C<< $c->namespace >>. Like C<detach>,
437 C<go> escapes the processing of the current request chain on completion, and
438 does not return to its caller.
440 @arguments are arguments to the final destination of $action. @captures are
441 arguments to the intermediate steps, if any, on the way to the final sub of
446 sub go { my $c = shift; $c->dispatcher->go( $c, @_ ) }
452 Returns the current L<Catalyst::Response> object, see there for details.
456 Returns a hashref to the stash, which may be used to store data and pass
457 it between components during a request. You can also set hash keys by
458 passing arguments. The stash is automatically sent to the view. The
459 stash is cleared at the end of a request; it cannot be used for
460 persistent storage (for this you must use a session; see
461 L<Catalyst::Plugin::Session> for a complete system integrated with
464 $c->stash->{foo} = $bar;
465 $c->stash( { moose => 'majestic', qux => 0 } );
466 $c->stash( bar => 1, gorch => 2 ); # equivalent to passing a hashref
468 # stash is automatically passed to the view for use in a template
469 $c->forward( 'MyApp::View::TT' );
473 around stash => sub {
476 my $stash = $orig->($c);
478 my $new_stash = @_ > 1 ? {@_} : $_[0];
479 croak('stash takes a hash or hashref') unless ref $new_stash;
480 foreach my $key ( keys %$new_stash ) {
481 $stash->{$key} = $new_stash->{$key};
491 =head2 $c->error($error, ...)
493 =head2 $c->error($arrayref)
495 Returns an arrayref containing error messages. If Catalyst encounters an
496 error while processing a request, it stores the error in $c->error. This
497 method should only be used to store fatal error messages.
499 my @error = @{ $c->error };
503 $c->error('Something bad happened');
510 my $error = ref $_[0] eq 'ARRAY' ? $_[0] : [@_];
511 croak @$error unless ref $c;
512 push @{ $c->{error} }, @$error;
514 elsif ( defined $_[0] ) { $c->{error} = undef }
515 return $c->{error} || [];
521 Contains the return value of the last executed action.
522 Note that << $c->state >> operates in a scalar context which means that all
523 values it returns are scalar.
525 =head2 $c->clear_errors
527 Clear errors. You probably don't want to clear the errors unless you are
528 implementing a custom error screen.
530 This is equivalent to running
541 sub _comp_search_prefixes {
543 return map $c->components->{ $_ }, $c->_comp_names_search_prefixes(@_);
546 # search components given a name and some prefixes
547 sub _comp_names_search_prefixes {
548 my ( $c, $name, @prefixes ) = @_;
549 my $appclass = ref $c || $c;
550 my $filter = "^${appclass}::(" . join( '|', @prefixes ) . ')::';
551 $filter = qr/$filter/; # Compile regex now rather than once per loop
553 # map the original component name to the sub part that we will search against
554 my %eligible = map { my $n = $_; $n =~ s{^$appclass\::[^:]+::}{}; $_ => $n; }
555 grep { /$filter/ } keys %{ $c->components };
557 # undef for a name will return all
558 return keys %eligible if !defined $name;
560 my $query = ref $name ? $name : qr/^$name$/i;
561 my @result = grep { $eligible{$_} =~ m{$query} } keys %eligible;
563 return @result if @result;
565 # if we were given a regexp to search against, we're done.
568 # skip regexp fallback if configured
570 if $appclass->config->{disable_component_resolution_regex_fallback};
574 @result = grep { $eligible{ $_ } =~ m{$query} } keys %eligible;
576 # no results? try against full names
578 @result = grep { m{$query} } keys %eligible;
581 # don't warn if we didn't find any results, it just might not exist
583 # Disgusting hack to work out correct method name
584 my $warn_for = lc $prefixes[0];
585 my $msg = "Used regexp fallback for \$c->${warn_for}('${name}'), which found '" .
586 (join '", "', @result) . "'. Relying on regexp fallback behavior for " .
587 "component resolution is unreliable and unsafe.";
588 my $short = $result[0];
589 # remove the component namespace prefix
590 $short =~ s/.*?(Model|Controller|View):://;
591 my $shortmess = Carp::shortmess('');
592 if ($shortmess =~ m#Catalyst/Plugin#) {
593 $msg .= " You probably need to set '$short' instead of '${name}' in this " .
595 } elsif ($shortmess =~ m#Catalyst/lib/(View|Controller)#) {
596 $msg .= " You probably need to set '$short' instead of '${name}' in this " .
597 "component's config";
599 $msg .= " You probably meant \$c->${warn_for}('$short') instead of \$c->${warn_for}('${name}'), " .
600 "but if you really wanted to search, pass in a regexp as the argument " .
601 "like so: \$c->${warn_for}(qr/${name}/)";
603 $c->log->warn( "${msg}$shortmess" );
609 # Find possible names for a prefix
611 my ( $c, @prefixes ) = @_;
612 my $appclass = ref $c || $c;
614 my $filter = "^${appclass}::(" . join( '|', @prefixes ) . ')::';
616 my @names = map { s{$filter}{}; $_; }
617 $c->_comp_names_search_prefixes( undef, @prefixes );
622 # Filter a component before returning by calling ACCEPT_CONTEXT if available
623 sub _filter_component {
624 my ( $c, $comp, @args ) = @_;
626 if ( eval { $comp->can('ACCEPT_CONTEXT'); } ) {
627 return $comp->ACCEPT_CONTEXT( $c, @args );
633 =head2 COMPONENT ACCESSORS
635 =head2 $c->controller($name)
637 Gets a L<Catalyst::Controller> instance by name.
639 $c->controller('Foo')->do_stuff;
641 If the name is omitted, will return the controller for the dispatched
644 If you want to search for controllers, pass in a regexp as the argument.
646 # find all controllers that start with Foo
647 my @foo_controllers = $c->controller(qr{^Foo});
653 my ( $c, $name, @args ) = @_;
655 my $appclass = ref($c) || $c;
657 unless ( ref($name) ) { # Direct component hash lookup to avoid costly regexps
658 my $comps = $c->components;
659 my $check = $appclass."::Controller::".$name;
660 return $c->_filter_component( $comps->{$check}, @args ) if exists $comps->{$check};
662 my @result = $c->_comp_search_prefixes( $name, qw/Controller C/ );
663 return map { $c->_filter_component( $_, @args ) } @result if ref $name;
664 return $c->_filter_component( $result[ 0 ], @args );
667 return $c->component( $c->action->class );
670 =head2 $c->model($name)
672 Gets a L<Catalyst::Model> instance by name.
674 $c->model('Foo')->do_stuff;
676 Any extra arguments are directly passed to ACCEPT_CONTEXT.
678 If the name is omitted, it will look for
679 - a model object in $c->stash->{current_model_instance}, then
680 - a model name in $c->stash->{current_model}, then
681 - a config setting 'default_model', or
682 - check if there is only one model, and return it if that's the case.
684 If you want to search for models, pass in a regexp as the argument.
686 # find all models that start with Foo
687 my @foo_models = $c->model(qr{^Foo});
692 my ( $c, $name, @args ) = @_;
693 my $appclass = ref($c) || $c;
695 unless ( ref($name) ) { # Direct component hash lookup to avoid costly regexps
696 my $comps = $c->components;
697 my $check = $appclass."::Model::".$name;
698 return $c->_filter_component( $comps->{$check}, @args ) if exists $comps->{$check};
700 my @result = $c->_comp_search_prefixes( $name, qw/Model M/ );
701 return map { $c->_filter_component( $_, @args ) } @result if ref $name;
702 return $c->_filter_component( $result[ 0 ], @args );
706 return $c->stash->{current_model_instance}
707 if $c->stash->{current_model_instance};
708 return $c->model( $c->stash->{current_model} )
709 if $c->stash->{current_model};
711 return $c->model( $appclass->config->{default_model} )
712 if $appclass->config->{default_model};
714 my( $comp, $rest ) = $c->_comp_search_prefixes( undef, qw/Model M/);
717 $c->log->warn( Carp::shortmess('Calling $c->model() will return a random model unless you specify one of:') );
718 $c->log->warn( '* $c->config(default_model => "the name of the default model to use")' );
719 $c->log->warn( '* $c->stash->{current_model} # the name of the model to use for this request' );
720 $c->log->warn( '* $c->stash->{current_model_instance} # the instance of the model to use for this request' );
721 $c->log->warn( 'NB: in version 5.81, the "random" behavior will not work at all.' );
724 return $c->_filter_component( $comp );
728 =head2 $c->view($name)
730 Gets a L<Catalyst::View> instance by name.
732 $c->view('Foo')->do_stuff;
734 Any extra arguments are directly passed to ACCEPT_CONTEXT.
736 If the name is omitted, it will look for
737 - a view object in $c->stash->{current_view_instance}, then
738 - a view name in $c->stash->{current_view}, then
739 - a config setting 'default_view', or
740 - check if there is only one view, and return it if that's the case.
742 If you want to search for views, pass in a regexp as the argument.
744 # find all views that start with Foo
745 my @foo_views = $c->view(qr{^Foo});
750 my ( $c, $name, @args ) = @_;
752 my $appclass = ref($c) || $c;
754 unless ( ref($name) ) { # Direct component hash lookup to avoid costly regexps
755 my $comps = $c->components;
756 my $check = $appclass."::View::".$name;
757 if( exists $comps->{$check} ) {
758 return $c->_filter_component( $comps->{$check}, @args );
761 $c->log->warn( "Attempted to use view '$check', but does not exist" );
764 my @result = $c->_comp_search_prefixes( $name, qw/View V/ );
765 return map { $c->_filter_component( $_, @args ) } @result if ref $name;
766 return $c->_filter_component( $result[ 0 ], @args );
770 return $c->stash->{current_view_instance}
771 if $c->stash->{current_view_instance};
772 return $c->view( $c->stash->{current_view} )
773 if $c->stash->{current_view};
775 return $c->view( $appclass->config->{default_view} )
776 if $appclass->config->{default_view};
778 my( $comp, $rest ) = $c->_comp_search_prefixes( undef, qw/View V/);
781 $c->log->warn( 'Calling $c->view() will return a random view unless you specify one of:' );
782 $c->log->warn( '* $c->config(default_view => "the name of the default view to use")' );
783 $c->log->warn( '* $c->stash->{current_view} # the name of the view to use for this request' );
784 $c->log->warn( '* $c->stash->{current_view_instance} # the instance of the view to use for this request' );
785 $c->log->warn( 'NB: in version 5.81, the "random" behavior will not work at all.' );
788 return $c->_filter_component( $comp );
791 =head2 $c->controllers
793 Returns the available names which can be passed to $c->controller
799 return $c->_comp_names(qw/Controller C/);
804 Returns the available names which can be passed to $c->model
810 return $c->_comp_names(qw/Model M/);
816 Returns the available names which can be passed to $c->view
822 return $c->_comp_names(qw/View V/);
825 =head2 $c->comp($name)
827 =head2 $c->component($name)
829 Gets a component object by name. This method is not recommended,
830 unless you want to get a specific component by full
831 class. C<< $c->controller >>, C<< $c->model >>, and C<< $c->view >>
832 should be used instead.
834 If C<$name> is a regexp, a list of components matched against the full
835 component name will be returned.
837 If Catalyst can't find a component by name, it will fallback to regex
838 matching by default. To disable this behaviour set
839 disable_component_resolution_regex_fallback to a true value.
841 __PACKAGE__->config( disable_component_resolution_regex_fallback => 1 );
846 my ( $c, $name, @args ) = @_;
849 my $comps = $c->components;
852 # is it the exact name?
853 return $c->_filter_component( $comps->{ $name }, @args )
854 if exists $comps->{ $name };
856 # perhaps we just omitted "MyApp"?
857 my $composed = ( ref $c || $c ) . "::${name}";
858 return $c->_filter_component( $comps->{ $composed }, @args )
859 if exists $comps->{ $composed };
861 # search all of the models, views and controllers
862 my( $comp ) = $c->_comp_search_prefixes( $name, qw/Model M Controller C View V/ );
863 return $c->_filter_component( $comp, @args ) if $comp;
866 # This is here so $c->comp( '::M::' ) works
867 my $query = ref $name ? $name : qr{$name}i;
869 my @result = grep { m{$query} } keys %{ $c->components };
870 return map { $c->_filter_component( $_, @args ) } @result if ref $name;
873 $c->log->warn( Carp::shortmess(qq(Found results for "${name}" using regexp fallback)) );
874 $c->log->warn( 'Relying on the regexp fallback behavior for component resolution' );
875 $c->log->warn( 'is unreliable and unsafe. You have been warned' );
876 return $c->_filter_component( $result[ 0 ], @args );
879 # I would expect to return an empty list here, but that breaks back-compat
883 return sort keys %{ $c->components };
886 =head2 CLASS DATA AND HELPER CLASSES
890 Returns or takes a hashref containing the application's configuration.
892 __PACKAGE__->config( { db => 'dsn:SQLite:foo.db' } );
894 You can also use a C<YAML>, C<XML> or L<Config::General> config file
895 like C<myapp.conf> in your applications home directory. See
896 L<Catalyst::Plugin::ConfigLoader>.
898 =head3 Cascading configuration
900 The config method is present on all Catalyst components, and configuration
901 will be merged when an application is started. Configuration loaded with
902 L<Catalyst::Plugin::ConfigLoader> takes precedence over other configuration,
903 followed by configuration in your top level C<MyApp> class. These two
904 configurations are merged, and then configuration data whose hash key matches a
905 component name is merged with configuration for that component.
907 The configuration for a component is then passed to the C<new> method when a
908 component is constructed.
912 MyApp->config({ 'Model::Foo' => { bar => 'baz', overrides => 'me' } });
913 MyApp::Model::Foo->config({ quux => 'frob', overrides => 'this' });
915 will mean that C<MyApp::Model::Foo> receives the following data when
918 MyApp::Model::Foo->new({
924 It's common practice to use a Moose attribute
925 on the receiving component to access the config value.
927 package MyApp::Model::Foo;
931 # this attr will receive 'baz' at construction time
937 You can then get the value 'baz' by calling $c->model('Foo')->bar
938 (or $self->bar inside code in the model).
940 B<NOTE:> you MUST NOT call C<< $self->config >> or C<< __PACKAGE__->config >>
941 as a way of reading config within your code, as this B<will not> give you the
942 correctly merged config back. You B<MUST> take the config values supplied to
943 the constructor and use those instead.
947 around config => sub {
951 croak('Setting config after setup has been run is not allowed.')
952 if ( @_ and $c->setup_finished );
959 Returns the logging object instance. Unless it is already set, Catalyst
960 sets this up with a L<Catalyst::Log> object. To use your own log class,
961 set the logger with the C<< __PACKAGE__->log >> method prior to calling
962 C<< __PACKAGE__->setup >>.
964 __PACKAGE__->log( MyLogger->new );
969 $c->log->info( 'Now logging with my own logger!' );
971 Your log class should implement the methods described in
977 Returns 1 if debug mode is enabled, 0 otherwise.
979 You can enable debug mode in several ways:
983 =item By calling myapp_server.pl with the -d flag
985 =item With the environment variables MYAPP_DEBUG, or CATALYST_DEBUG
987 =item The -Debug option in your MyApp.pm
989 =item By declaring C<sub debug { 1 }> in your MyApp.pm.
993 The first three also set the log level to 'debug'.
995 Calling C<< $c->debug(1) >> has no effect.
1001 =head2 $c->dispatcher
1003 Returns the dispatcher instance. See L<Catalyst::Dispatcher>.
1007 Returns the engine instance. See L<Catalyst::Engine>.
1010 =head2 UTILITY METHODS
1012 =head2 $c->path_to(@path)
1014 Merges C<@path> with C<< $c->config->{home} >> and returns a
1015 L<Path::Class::Dir> object. Note you can usually use this object as
1016 a filename, but sometimes you will have to explicitly stringify it
1017 yourself by calling the C<< ->stringify >> method.
1021 $c->path_to( 'db', 'sqlite.db' );
1026 my ( $c, @path ) = @_;
1027 my $path = Path::Class::Dir->new( $c->config->{home}, @path );
1028 if ( -d $path ) { return $path }
1029 else { return Path::Class::File->new( $c->config->{home}, @path ) }
1032 =head2 $c->plugin( $name, $class, @args )
1034 Helper method for plugins. It creates a class data accessor/mutator and
1035 loads and instantiates the given class.
1037 MyApp->plugin( 'prototype', 'HTML::Prototype' );
1039 $c->prototype->define_javascript_functions;
1041 B<Note:> This method of adding plugins is deprecated. The ability
1042 to add plugins like this B<will be removed> in a Catalyst 5.81.
1043 Please do not use this functionality in new code.
1048 my ( $class, $name, $plugin, @args ) = @_;
1050 # See block comment in t/unit_core_plugin.t
1051 $class->log->warn(qq/Adding plugin using the ->plugin method is deprecated, and will be removed in Catalyst 5.81/);
1053 $class->_register_plugin( $plugin, 1 );
1055 eval { $plugin->import };
1056 $class->mk_classdata($name);
1058 eval { $obj = $plugin->new(@args) };
1061 Catalyst::Exception->throw( message =>
1062 qq/Couldn't instantiate instant plugin "$plugin", "$@"/ );
1065 $class->$name($obj);
1066 $class->log->debug(qq/Initialized instant plugin "$plugin" as "$name"/)
1072 Initializes the dispatcher and engine, loads any plugins, and loads the
1073 model, view, and controller components. You may also specify an array
1074 of plugins to load here, if you choose to not load them in the C<use
1078 MyApp->setup( qw/-Debug/ );
1083 my ( $class, @arguments ) = @_;
1084 croak('Running setup more than once')
1085 if ( $class->setup_finished );
1087 unless ( $class->isa('Catalyst') ) {
1089 Catalyst::Exception->throw(
1090 message => qq/'$class' does not inherit from Catalyst/ );
1093 if ( $class->arguments ) {
1094 @arguments = ( @arguments, @{ $class->arguments } );
1100 foreach (@arguments) {
1104 ( $flags->{log} ) ? 'debug,' . $flags->{log} : 'debug';
1106 elsif (/^-(\w+)=?(.*)$/) {
1107 $flags->{ lc $1 } = $2;
1110 push @{ $flags->{plugins} }, $_;
1114 $class->setup_home( delete $flags->{home} );
1116 $class->setup_log( delete $flags->{log} );
1117 $class->setup_plugins( delete $flags->{plugins} );
1118 $class->setup_dispatcher( delete $flags->{dispatcher} );
1119 $class->setup_engine( delete $flags->{engine} );
1120 $class->setup_stats( delete $flags->{stats} );
1122 for my $flag ( sort keys %{$flags} ) {
1124 if ( my $code = $class->can( 'setup_' . $flag ) ) {
1125 &$code( $class, delete $flags->{$flag} );
1128 $class->log->warn(qq/Unknown flag "$flag"/);
1132 eval { require Catalyst::Devel; };
1133 if( !$@ && $ENV{CATALYST_SCRIPT_GEN} && ( $ENV{CATALYST_SCRIPT_GEN} < $Catalyst::Devel::CATALYST_SCRIPT_GEN ) ) {
1134 $class->log->warn(<<"EOF");
1135 You are running an old script!
1137 Please update by running (this will overwrite existing files):
1138 catalyst.pl -force -scripts $class
1140 or (this will not overwrite existing files):
1141 catalyst.pl -scripts $class
1146 if ( $class->debug ) {
1147 my @plugins = map { "$_ " . ( $_->VERSION || '' ) } $class->registered_plugins;
1150 my $column_width = Catalyst::Utils::term_width() - 6;
1151 my $t = Text::SimpleTable->new($column_width);
1152 $t->row($_) for @plugins;
1153 $class->log->debug( "Loaded plugins:\n" . $t->draw . "\n" );
1156 my $dispatcher = $class->dispatcher;
1157 my $engine = $class->engine;
1158 my $home = $class->config->{home};
1160 $class->log->debug(sprintf(q/Loaded dispatcher "%s"/, blessed($dispatcher)));
1161 $class->log->debug(sprintf(q/Loaded engine "%s"/, blessed($engine)));
1165 ? $class->log->debug(qq/Found home "$home"/)
1166 : $class->log->debug(qq/Home "$home" doesn't exist/)
1167 : $class->log->debug(q/Couldn't find home/);
1170 # Call plugins setup, this is stupid and evil.
1171 # Also screws C3 badly on 5.10, hack to avoid.
1173 no warnings qw/redefine/;
1174 local *setup = sub { };
1175 $class->setup unless $Catalyst::__AM_RESTARTING;
1178 # Initialize our data structure
1179 $class->components( {} );
1181 $class->setup_components;
1183 if ( $class->debug ) {
1184 my $column_width = Catalyst::Utils::term_width() - 8 - 9;
1185 my $t = Text::SimpleTable->new( [ $column_width, 'Class' ], [ 8, 'Type' ] );
1186 for my $comp ( sort keys %{ $class->components } ) {
1187 my $type = ref $class->components->{$comp} ? 'instance' : 'class';
1188 $t->row( $comp, $type );
1190 $class->log->debug( "Loaded components:\n" . $t->draw . "\n" )
1191 if ( keys %{ $class->components } );
1194 # Add our self to components, since we are also a component
1195 if( $class->isa('Catalyst::Controller') ){
1196 $class->components->{$class} = $class;
1199 $class->setup_actions;
1201 if ( $class->debug ) {
1202 my $name = $class->config->{name} || 'Application';
1203 $class->log->info("$name powered by Catalyst $Catalyst::VERSION");
1206 # Make sure that the application class becomes immutable at this point,
1207 B::Hooks::EndOfScope::on_scope_end {
1209 my $meta = Class::MOP::get_metaclass_by_name($class);
1212 && ! { $meta->immutable_options }->{replace_constructor}
1214 $class->isa('Class::Accessor::Fast')
1215 || $class->isa('Class::Accessor')
1218 warn "You made your application class ($class) immutable, "
1219 . "but did not inline the\nconstructor. "
1220 . "This will break catalyst, as your app \@ISA "
1221 . "Class::Accessor(::Fast)?\nPlease pass "
1222 . "(replace_constructor => 1)\nwhen making your class immutable.\n";
1224 $meta->make_immutable(
1225 replace_constructor => 1,
1226 ) unless $meta->is_immutable;
1229 if ($class->config->{case_sensitive}) {
1230 $class->log->warn($class . "->config->{case_sensitive} is set.");
1231 $class->log->warn("This setting is deprecated and planned to be removed in Catalyst 5.81.");
1234 $class->setup_finalize;
1235 # Should be the last thing we do so that user things hooking
1236 # setup_finalize can log..
1237 $class->log->_flush() if $class->log->can('_flush');
1238 return 1; # Explicit return true as people have __PACKAGE__->setup as the last thing in their class. HATE.
1241 =head2 $app->setup_finalize
1243 A hook to attach modifiers to. This method does not do anything except set the
1244 C<setup_finished> accessor.
1246 Applying method modifiers to the C<setup> method doesn't work, because of quirky thingsdone for plugin setup.
1250 after setup_finalize => sub {
1258 sub setup_finalize {
1260 $class->setup_finished(1);
1263 =head2 $c->uri_for( $path?, @args?, \%query_values? )
1265 =head2 $c->uri_for( $action, \@captures?, @args?, \%query_values? )
1267 Constructs an absolute L<URI> object based on the application root, the
1268 provided path, and the additional arguments and query parameters provided.
1269 When used as a string, provides a textual URI. If you need more flexibility
1270 than this (i.e. the option to provide relative URIs etc.) see
1271 L<Catalyst::Plugin::SmartURI>.
1273 If no arguments are provided, the URI for the current action is returned.
1274 To return the current action and also provide @args, use
1275 C<< $c->uri_for( $c->action, @args ) >>.
1277 If the first argument is a string, it is taken as a public URI path relative
1278 to C<< $c->namespace >> (if it doesn't begin with a forward slash) or
1279 relative to the application root (if it does). It is then merged with
1280 C<< $c->request->base >>; any C<@args> are appended as additional path
1281 components; and any C<%query_values> are appended as C<?foo=bar> parameters.
1283 If the first argument is a L<Catalyst::Action> it represents an action which
1284 will have its path resolved using C<< $c->dispatcher->uri_for_action >>. The
1285 optional C<\@captures> argument (an arrayref) allows passing the captured
1286 variables that are needed to fill in the paths of Chained and Regex actions;
1287 once the path is resolved, C<uri_for> continues as though a path was
1288 provided, appending any arguments or parameters and creating an absolute
1291 The captures for the current request can be found in
1292 C<< $c->request->captures >>, and actions can be resolved using
1293 C<< Catalyst::Controller->action_for($name) >>. If you have a private action
1294 path, use C<< $c->uri_for_action >> instead.
1296 # Equivalent to $c->req->uri
1297 $c->uri_for($c->action, $c->req->captures,
1298 @{ $c->req->args }, $c->req->params);
1300 # For the Foo action in the Bar controller
1301 $c->uri_for($c->controller('Bar')->action_for('Foo'));
1303 # Path to a static resource
1304 $c->uri_for('/static/images/logo.png');
1309 my ( $c, $path, @args ) = @_;
1311 if (blessed($path) && $path->isa('Catalyst::Controller')) {
1312 $path = $path->path_prefix;
1317 undef($path) if (defined $path && $path eq '');
1320 ( scalar @args && ref $args[$#args] eq 'HASH' ? pop @args : {} );
1322 carp "uri_for called with undef argument" if grep { ! defined $_ } @args;
1323 foreach my $arg (@args) {
1324 utf8::encode($arg) if utf8::is_utf8($arg);
1325 $arg =~ s/([^$URI::uric])/$URI::Escape::escapes{$1}/go;
1328 if ( blessed($path) ) { # action object
1329 s|/|%2F|g for @args;
1330 my $captures = [ map { s|/|%2F|g; $_; }
1331 ( scalar @args && ref $args[0] eq 'ARRAY'
1335 foreach my $capture (@$captures) {
1336 utf8::encode($capture) if utf8::is_utf8($capture);
1337 $capture =~ s/([^$URI::uric])/$URI::Escape::escapes{$1}/go;
1341 $path = $c->dispatcher->uri_for_action($action, $captures);
1342 if (not defined $path) {
1343 $c->log->debug(qq/Can't find uri_for action '$action' @$captures/)
1347 $path = '/' if $path eq '';
1350 unshift(@args, $path);
1352 unless (defined $path && $path =~ s!^/!!) { # in-place strip
1353 my $namespace = $c->namespace;
1354 if (defined $path) { # cheesy hack to handle path '../foo'
1355 $namespace =~ s{(?:^|/)[^/]+$}{} while $args[0] =~ s{^\.\./}{};
1357 unshift(@args, $namespace || '');
1360 # join args with '/', or a blank string
1361 my $args = join('/', grep { defined($_) } @args);
1362 $args =~ s/\?/%3F/g; # STUPID STUPID SPECIAL CASE
1364 my $base = $c->req->base;
1365 my $class = ref($base);
1366 $base =~ s{(?<!/)$}{/};
1370 if (my @keys = keys %$params) {
1371 # somewhat lifted from URI::_query's query_form
1372 $query = '?'.join('&', map {
1373 my $val = $params->{$_};
1374 s/([;\/?:@&=+,\$\[\]%])/$URI::Escape::escapes{$1}/go;
1377 $val = '' unless defined $val;
1380 utf8::encode( $param ) if utf8::is_utf8($param);
1381 # using the URI::Escape pattern here so utf8 chars survive
1382 $param =~ s/([^A-Za-z0-9\-_.!~*'() ])/$URI::Escape::escapes{$1}/go;
1384 "${key}=$param"; } ( ref $val eq 'ARRAY' ? @$val : $val ));
1388 my $res = bless(\"${base}${args}${query}", $class);
1392 =head2 $c->uri_for_action( $path, \@captures?, @args?, \%query_values? )
1394 =head2 $c->uri_for_action( $action, \@captures?, @args?, \%query_values? )
1400 A private path to the Catalyst action you want to create a URI for.
1402 This is a shortcut for calling C<< $c->dispatcher->get_action_by_path($path)
1403 >> and passing the resulting C<$action> and the remaining arguments to C<<
1406 You can also pass in a Catalyst::Action object, in which case it is passed to
1409 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.
1411 For example, if the action looks like:
1413 package MyApp::Controller::Users;
1415 sub lst : Path('the-list') {}
1419 $c->uri_for_action('/users/lst')
1421 and it will create the URI /users/the-list.
1427 sub uri_for_action {
1428 my ( $c, $path, @args ) = @_;
1429 my $action = blessed($path)
1431 : $c->dispatcher->get_action_by_path($path);
1432 unless (defined $action) {
1433 croak "Can't find action for path '$path'";
1435 return $c->uri_for( $action, @args );
1438 =head2 $c->welcome_message
1440 Returns the Catalyst welcome HTML page.
1444 sub welcome_message {
1446 my $name = $c->config->{name};
1447 my $logo = $c->uri_for('/static/images/catalyst_logo.png');
1448 my $prefix = Catalyst::Utils::appprefix( ref $c );
1449 $c->response->content_type('text/html; charset=utf-8');
1451 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
1452 "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
1453 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
1455 <meta http-equiv="Content-Language" content="en" />
1456 <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
1457 <title>$name on Catalyst $VERSION</title>
1458 <style type="text/css">
1461 background-color: #eee;
1468 margin-bottom: 10px;
1470 background-color: #ccc;
1471 border: 1px solid #aaa;
1476 font-family: verdana, tahoma, sans-serif;
1479 font-family: verdana, tahoma, sans-serif;
1482 text-decoration: none;
1484 border-bottom: 1px dotted #bbb;
1486 :link:hover, :visited:hover {
1499 background-color: #fff;
1500 border: 1px solid #aaa;
1504 font-weight: normal;
1526 <h1><span id="appname">$name</span> on <a href="http://catalyst.perl.org">Catalyst</a>
1531 <img src="$logo" alt="Catalyst Logo" />
1533 <p>Welcome to the world of Catalyst.
1534 This <a href="http://en.wikipedia.org/wiki/MVC">MVC</a>
1535 framework will make web development something you had
1536 never expected it to be: Fun, rewarding, and quick.</p>
1537 <h2>What to do now?</h2>
1538 <p>That really depends on what <b>you</b> want to do.
1539 We do, however, provide you with a few starting points.</p>
1540 <p>If you want to jump right into web development with Catalyst
1541 you might want to start with a tutorial.</p>
1542 <pre>perldoc <a href="http://cpansearch.perl.org/dist/Catalyst-Manual/lib/Catalyst/Manual/Tutorial.pod">Catalyst::Manual::Tutorial</a></code>
1544 <p>Afterwards you can go on to check out a more complete look at our features.</p>
1546 <code>perldoc <a href="http://cpansearch.perl.org/dist/Catalyst-Manual/lib/Catalyst/Manual/Intro.pod">Catalyst::Manual::Intro</a>
1547 <!-- Something else should go here, but the Catalyst::Manual link seems unhelpful -->
1549 <h2>What to do next?</h2>
1550 <p>Next it's time to write an actual application. Use the
1551 helper scripts to generate <a href="http://cpansearch.perl.org/search?query=Catalyst%3A%3AController%3A%3A&mode=all">controllers</a>,
1552 <a href="http://cpansearch.perl.org/search?query=Catalyst%3A%3AModel%3A%3A&mode=all">models</a>, and
1553 <a href="http://cpansearch.perl.org/search?query=Catalyst%3A%3AView%3A%3A&mode=all">views</a>;
1554 they can save you a lot of work.</p>
1555 <pre><code>script/${prefix}_create.pl --help</code></pre>
1556 <p>Also, be sure to check out the vast and growing
1557 collection of <a href="http://search.cpan.org/search?query=Catalyst">plugins for Catalyst on CPAN</a>;
1558 you are likely to find what you need there.
1562 <p>Catalyst has a very active community. Here are the main places to
1563 get in touch with us.</p>
1566 <a href="http://dev.catalyst.perl.org">Wiki</a>
1569 <a href="http://lists.scsys.co.uk/cgi-bin/mailman/listinfo/catalyst">Mailing-List</a>
1572 <a href="irc://irc.perl.org/catalyst">IRC channel #catalyst on irc.perl.org</a>
1575 <h2>In conclusion</h2>
1576 <p>The Catalyst team hopes you will enjoy using Catalyst as much
1577 as we enjoyed making it. Please contact us if you have ideas
1578 for improvement or other feedback.</p>
1586 =head1 INTERNAL METHODS
1588 These methods are not meant to be used by end users.
1590 =head2 $c->components
1592 Returns a hash of components.
1594 =head2 $c->context_class
1596 Returns or sets the context class.
1600 Returns a hashref containing coderefs and execution counts (needed for
1601 deep recursion detection).
1605 Returns the number of actions on the current internal execution stack.
1609 Dispatches a request to actions.
1613 sub dispatch { my $c = shift; $c->dispatcher->dispatch( $c, @_ ) }
1615 =head2 $c->dispatcher_class
1617 Returns or sets the dispatcher class.
1619 =head2 $c->dump_these
1621 Returns a list of 2-element array references (name, structure) pairs
1622 that will be dumped on the error page in debug mode.
1628 [ Request => $c->req ],
1629 [ Response => $c->res ],
1630 [ Stash => $c->stash ],
1631 [ Config => $c->config ];
1634 =head2 $c->engine_class
1636 Returns or sets the engine class.
1638 =head2 $c->execute( $class, $coderef )
1640 Execute a coderef in given class and catch exceptions. Errors are available
1646 my ( $c, $class, $code ) = @_;
1647 $class = $c->component($class) || $class;
1650 if ( $c->depth >= $RECURSION ) {
1651 my $action = $code->reverse();
1652 $action = "/$action" unless $action =~ /->/;
1653 my $error = qq/Deep recursion detected calling "${action}"/;
1654 $c->log->error($error);
1660 my $stats_info = $c->_stats_start_execute( $code ) if $c->use_stats;
1662 push( @{ $c->stack }, $code );
1664 no warnings 'recursion';
1665 eval { $c->state( $code->execute( $class, $c, @{ $c->req->args } ) || 0 ) };
1667 $c->_stats_finish_execute( $stats_info ) if $c->use_stats and $stats_info;
1669 my $last = pop( @{ $c->stack } );
1671 if ( my $error = $@ ) {
1672 if ( blessed($error) and $error->isa('Catalyst::Exception::Detach') ) {
1673 $error->rethrow if $c->depth > 1;
1675 elsif ( blessed($error) and $error->isa('Catalyst::Exception::Go') ) {
1676 $error->rethrow if $c->depth > 0;
1679 unless ( ref $error ) {
1680 no warnings 'uninitialized';
1682 my $class = $last->class;
1683 my $name = $last->name;
1684 $error = qq/Caught exception in $class->$name "$error"/;
1693 sub _stats_start_execute {
1694 my ( $c, $code ) = @_;
1695 my $appclass = ref($c) || $c;
1696 return if ( ( $code->name =~ /^_.*/ )
1697 && ( !$appclass->config->{show_internal_actions} ) );
1699 my $action_name = $code->reverse();
1700 $c->counter->{$action_name}++;
1702 my $action = $action_name;
1703 $action = "/$action" unless $action =~ /->/;
1705 # determine if the call was the result of a forward
1706 # this is done by walking up the call stack and looking for a calling
1707 # sub of Catalyst::forward before the eval
1709 for my $index ( 2 .. 11 ) {
1711 if ( ( caller($index) )[0] eq 'Catalyst'
1712 && ( caller($index) )[3] eq '(eval)' );
1714 if ( ( caller($index) )[3] =~ /forward$/ ) {
1715 $callsub = ( caller($index) )[3];
1716 $action = "-> $action";
1721 my $uid = $action_name . $c->counter->{$action_name};
1723 # is this a root-level call or a forwarded call?
1724 if ( $callsub =~ /forward$/ ) {
1725 my $parent = $c->stack->[-1];
1727 # forward, locate the caller
1728 if ( defined $parent && exists $c->counter->{"$parent"} ) {
1731 parent => "$parent" . $c->counter->{"$parent"},
1737 # forward with no caller may come from a plugin
1756 sub _stats_finish_execute {
1757 my ( $c, $info ) = @_;
1758 $c->stats->profile( end => $info );
1763 Finalizes the request.
1770 for my $error ( @{ $c->error } ) {
1771 $c->log->error($error);
1774 # Allow engine to handle finalize flow (for POE)
1775 my $engine = $c->engine;
1776 if ( my $code = $engine->can('finalize') ) {
1781 $c->finalize_uploads;
1784 if ( $#{ $c->error } >= 0 ) {
1788 $c->finalize_headers;
1791 if ( $c->request->method eq 'HEAD' ) {
1792 $c->response->body('');
1800 if ($c->use_stats) {
1801 my $elapsed = sprintf '%f', $c->stats->elapsed;
1802 my $av = $elapsed == 0 ? '??' : sprintf '%.3f', 1 / $elapsed;
1804 "Request took ${elapsed}s ($av/s)\n" . $c->stats->report . "\n" );
1807 return $c->response->status;
1810 =head2 $c->finalize_body
1816 sub finalize_body { my $c = shift; $c->engine->finalize_body( $c, @_ ) }
1818 =head2 $c->finalize_cookies
1824 sub finalize_cookies { my $c = shift; $c->engine->finalize_cookies( $c, @_ ) }
1826 =head2 $c->finalize_error
1832 sub finalize_error { my $c = shift; $c->engine->finalize_error( $c, @_ ) }
1834 =head2 $c->finalize_headers
1840 sub finalize_headers {
1843 my $response = $c->response; #accessor calls can add up?
1845 # Check if we already finalized headers
1846 return if $response->finalized_headers;
1849 if ( my $location = $response->redirect ) {
1850 $c->log->debug(qq/Redirecting to "$location"/) if $c->debug;
1851 $response->header( Location => $location );
1853 if ( !$response->has_body ) {
1854 # Add a default body if none is already present
1856 qq{<html><body><p>This item has moved <a href="$location">here</a>.</p></body></html>}
1862 if ( $response->body && !$response->content_length ) {
1864 # get the length from a filehandle
1865 if ( blessed( $response->body ) && $response->body->can('read') || ref( $response->body ) eq 'GLOB' )
1867 my $stat = stat $response->body;
1868 if ( $stat && $stat->size > 0 ) {
1869 $response->content_length( $stat->size );
1872 $c->log->warn('Serving filehandle without a content-length');
1876 # everything should be bytes at this point, but just in case
1877 $response->content_length( length( $response->body ) );
1882 if ( $response->status =~ /^(1\d\d|[23]04)$/ ) {
1883 $response->headers->remove_header("Content-Length");
1884 $response->body('');
1887 $c->finalize_cookies;
1889 $c->engine->finalize_headers( $c, @_ );
1892 $response->finalized_headers(1);
1895 =head2 $c->finalize_output
1897 An alias for finalize_body.
1899 =head2 $c->finalize_read
1901 Finalizes the input after reading is complete.
1905 sub finalize_read { my $c = shift; $c->engine->finalize_read( $c, @_ ) }
1907 =head2 $c->finalize_uploads
1909 Finalizes uploads. Cleans up any temporary files.
1913 sub finalize_uploads { my $c = shift; $c->engine->finalize_uploads( $c, @_ ) }
1915 =head2 $c->get_action( $action, $namespace )
1917 Gets an action in a given namespace.
1921 sub get_action { my $c = shift; $c->dispatcher->get_action(@_) }
1923 =head2 $c->get_actions( $action, $namespace )
1925 Gets all actions of a given name in a namespace and all parent
1930 sub get_actions { my $c = shift; $c->dispatcher->get_actions( $c, @_ ) }
1932 =head2 $app->handle_request( @arguments )
1934 Called to handle each HTTP request.
1938 sub handle_request {
1939 my ( $class, @arguments ) = @_;
1941 # Always expect worst case!
1944 if ($class->debug) {
1945 my $secs = time - $START || 1;
1946 my $av = sprintf '%.3f', $COUNT / $secs;
1947 my $time = localtime time;
1948 $class->log->info("*** Request $COUNT ($av/s) [$$] [$time] ***");
1951 my $c = $class->prepare(@arguments);
1953 $status = $c->finalize;
1956 chomp(my $error = $_);
1957 $class->log->error(qq/Caught exception in engine "$error"/);
1962 if(my $coderef = $class->log->can('_flush')){
1963 $class->log->$coderef();
1968 =head2 $c->prepare( @arguments )
1970 Creates a Catalyst context from an engine-specific request (Apache, CGI,
1976 my ( $class, @arguments ) = @_;
1979 # After the app/ctxt split, this should become an attribute based on something passed
1980 # into the application.
1981 $class->context_class( ref $class || $class ) unless $class->context_class;
1983 my $c = $class->context_class->new({});
1985 # For on-demand data
1986 $c->request->_context($c);
1987 $c->response->_context($c);
1989 #surely this is not the most efficient way to do things...
1990 $c->stats($class->stats_class->new)->enable($c->use_stats);
1991 if ( $c->debug || $c->config->{enable_catalyst_header} ) {
1992 $c->res->headers->header( 'X-Catalyst' => $Catalyst::VERSION );
1996 # Allow engine to direct the prepare flow (for POE)
1997 if ( my $prepare = $c->engine->can('prepare') ) {
1998 $c->engine->$prepare( $c, @arguments );
2001 $c->prepare_request(@arguments);
2002 $c->prepare_connection;
2003 $c->prepare_query_parameters;
2004 $c->prepare_headers;
2005 $c->prepare_cookies;
2008 # Prepare the body for reading, either by prepare_body
2009 # or the user, if they are using $c->read
2012 # Parse the body unless the user wants it on-demand
2013 unless ( ref($c)->config->{parse_on_demand} ) {
2018 # VERY ugly and probably shouldn't rely on ->finalize actually working
2020 # failed prepare is always due to an invalid request, right?
2021 $c->response->status(400);
2022 $c->response->content_type('text/plain');
2023 $c->response->body('Bad Request');
2028 my $method = $c->req->method || '';
2029 my $path = $c->req->path;
2030 $path = '/' unless length $path;
2031 my $address = $c->req->address || '';
2040 =head2 $c->prepare_action
2042 Prepares action. See L<Catalyst::Dispatcher>.
2046 sub prepare_action { my $c = shift; $c->dispatcher->prepare_action( $c, @_ ) }
2048 =head2 $c->prepare_body
2050 Prepares message body.
2057 return if $c->request->_has_body;
2059 # Initialize on-demand data
2060 $c->engine->prepare_body( $c, @_ );
2061 $c->prepare_parameters;
2062 $c->prepare_uploads;
2065 =head2 $c->prepare_body_chunk( $chunk )
2067 Prepares a chunk of data before sending it to L<HTTP::Body>.
2069 See L<Catalyst::Engine>.
2073 sub prepare_body_chunk {
2075 $c->engine->prepare_body_chunk( $c, @_ );
2078 =head2 $c->prepare_body_parameters
2080 Prepares body parameters.
2084 sub prepare_body_parameters {
2086 $c->engine->prepare_body_parameters( $c, @_ );
2089 =head2 $c->prepare_connection
2091 Prepares connection.
2095 sub prepare_connection {
2097 $c->engine->prepare_connection( $c, @_ );
2100 =head2 $c->prepare_cookies
2106 sub prepare_cookies { my $c = shift; $c->engine->prepare_cookies( $c, @_ ) }
2108 =head2 $c->prepare_headers
2114 sub prepare_headers { my $c = shift; $c->engine->prepare_headers( $c, @_ ) }
2116 =head2 $c->prepare_parameters
2118 Prepares parameters.
2122 sub prepare_parameters {
2124 $c->prepare_body_parameters;
2125 $c->engine->prepare_parameters( $c, @_ );
2128 =head2 $c->prepare_path
2130 Prepares path and base.
2134 sub prepare_path { my $c = shift; $c->engine->prepare_path( $c, @_ ) }
2136 =head2 $c->prepare_query_parameters
2138 Prepares query parameters.
2142 sub prepare_query_parameters {
2145 $c->engine->prepare_query_parameters( $c, @_ );
2148 =head2 $c->log_request
2150 Writes information about the request to the debug logs. This includes:
2154 =item * Request method, path, and remote IP address
2156 =item * Query keywords (see L<Catalyst::Request/query_keywords>)
2158 =item * Request parameters
2160 =item * File uploads
2169 return unless $c->debug;
2171 my($dump) = grep {$_->[0] eq 'Request' } $c->dump_these;
2172 my $request = $dump->[1];
2174 my ( $method, $path, $address ) = ( $request->method, $request->path, $request->address );
2176 $path = '/' unless length $path;
2178 $c->log->debug(qq/"$method" request for "$path" from "$address"/);
2180 $c->log_request_headers($request->headers);
2182 if ( my $keywords = $request->query_keywords ) {
2183 $c->log->debug("Query keywords are: $keywords");
2186 $c->log_request_parameters( query => $request->query_parameters, $request->_has_body ? (body => $request->body_parameters) : () );
2188 $c->log_request_uploads($request);
2191 =head2 $c->log_response
2193 Writes information about the response to the debug logs by calling
2194 C<< $c->log_response_status_line >> and C<< $c->log_response_headers >>.
2201 return unless $c->debug;
2203 my($dump) = grep {$_->[0] eq 'Response' } $c->dump_these;
2204 my $response = $dump->[1];
2206 $c->log_response_status_line($response);
2207 $c->log_response_headers($response->headers);
2210 =head2 $c->log_response_status_line($response)
2212 Writes one line of information about the response to the debug logs. This includes:
2216 =item * Response status code
2218 =item * Content-Type header (if present)
2220 =item * Content-Length header (if present)
2226 sub log_response_status_line {
2227 my ($c, $response) = @_;
2231 'Response Code: %s; Content-Type: %s; Content-Length: %s',
2232 $response->status || 'unknown',
2233 $response->headers->header('Content-Type') || 'unknown',
2234 $response->headers->header('Content-Length') || 'unknown'
2239 =head2 $c->log_response_headers($headers);
2241 Hook method which can be wrapped by plugins to log the responseheaders.
2242 No-op in the default implementation.
2246 sub log_response_headers {}
2248 =head2 $c->log_request_parameters( query => {}, body => {} )
2250 Logs request parameters to debug logs
2254 sub log_request_parameters {
2256 my %all_params = @_;
2258 return unless $c->debug;
2260 my $column_width = Catalyst::Utils::term_width() - 44;
2261 foreach my $type (qw(query body)) {
2262 my $params = $all_params{$type};
2263 next if ! keys %$params;
2264 my $t = Text::SimpleTable->new( [ 35, 'Parameter' ], [ $column_width, 'Value' ] );
2265 for my $key ( sort keys %$params ) {
2266 my $param = $params->{$key};
2267 my $value = defined($param) ? $param : '';
2268 $t->row( $key, ref $value eq 'ARRAY' ? ( join ', ', @$value ) : $value );
2270 $c->log->debug( ucfirst($type) . " Parameters are:\n" . $t->draw );
2274 =head2 $c->log_request_uploads
2276 Logs file uploads included in the request to the debug logs.
2277 The parameter name, filename, file type, and file size are all included in
2282 sub log_request_uploads {
2284 my $request = shift;
2285 return unless $c->debug;
2286 my $uploads = $request->uploads;
2287 if ( keys %$uploads ) {
2288 my $t = Text::SimpleTable->new(
2289 [ 12, 'Parameter' ],
2294 for my $key ( sort keys %$uploads ) {
2295 my $upload = $uploads->{$key};
2296 for my $u ( ref $upload eq 'ARRAY' ? @{$upload} : ($upload) ) {
2297 $t->row( $key, $u->filename, $u->type, $u->size );
2300 $c->log->debug( "File Uploads are:\n" . $t->draw );
2304 =head2 $c->log_request_headers($headers);
2306 Hook method which can be wrapped by plugins to log the request headers.
2307 No-op in the default implementation.
2311 sub log_request_headers {}
2313 =head2 $c->log_headers($type => $headers)
2315 Logs L<HTTP::Headers> (either request or response) to the debug logs.
2322 my $headers = shift; # an HTTP::Headers instance
2324 return unless $c->debug;
2326 my $column_width = Catalyst::Utils::term_width() - 28;
2327 my $t = Text::SimpleTable->new( [ 15, 'Header Name' ], [ $column_width, 'Value' ] );
2330 my ( $name, $value ) = @_;
2331 $t->row( $name, $value );
2334 $c->log->debug( ucfirst($type) . " Headers:\n" . $t->draw );
2338 =head2 $c->prepare_read
2340 Prepares the input for reading.
2344 sub prepare_read { my $c = shift; $c->engine->prepare_read( $c, @_ ) }
2346 =head2 $c->prepare_request
2348 Prepares the engine request.
2352 sub prepare_request { my $c = shift; $c->engine->prepare_request( $c, @_ ) }
2354 =head2 $c->prepare_uploads
2360 sub prepare_uploads {
2363 $c->engine->prepare_uploads( $c, @_ );
2366 =head2 $c->prepare_write
2368 Prepares the output for writing.
2372 sub prepare_write { my $c = shift; $c->engine->prepare_write( $c, @_ ) }
2374 =head2 $c->request_class
2376 Returns or sets the request class.
2378 =head2 $c->response_class
2380 Returns or sets the response class.
2382 =head2 $c->read( [$maxlength] )
2384 Reads a chunk of data from the request body. This method is designed to
2385 be used in a while loop, reading C<$maxlength> bytes on every call.
2386 C<$maxlength> defaults to the size of the request if not specified.
2388 You have to set C<< MyApp->config(parse_on_demand => 1) >> to use this
2391 Warning: If you use read(), Catalyst will not process the body,
2392 so you will not be able to access POST parameters or file uploads via
2393 $c->request. You must handle all body parsing yourself.
2397 sub read { my $c = shift; return $c->engine->read( $c, @_ ) }
2405 sub run { my $c = shift; return $c->engine->run( $c, $c->psgi_app, @_ ) }
2407 =head2 $c->set_action( $action, $code, $namespace, $attrs )
2409 Sets an action in a given namespace.
2413 sub set_action { my $c = shift; $c->dispatcher->set_action( $c, @_ ) }
2415 =head2 $c->setup_actions($component)
2417 Sets up actions for a component.
2421 sub setup_actions { my $c = shift; $c->dispatcher->setup_actions( $c, @_ ) }
2423 =head2 $c->setup_components
2425 This method is called internally to set up the application's components.
2427 It finds modules by calling the L<locate_components> method, expands them to
2428 package names with the L<expand_component_module> method, and then installs
2429 each component into the application.
2431 The C<setup_components> config option is passed to both of the above methods.
2433 Installation of each component is performed by the L<setup_component> method,
2438 sub setup_components {
2441 my $config = $class->config->{ setup_components };
2443 my @comps = $class->locate_components($config);
2444 my %comps = map { $_ => 1 } @comps;
2446 my $deprecatedcatalyst_component_names = grep { /::[CMV]::/ } @comps;
2447 $class->log->warn(qq{Your application is using the deprecated ::[MVC]:: type naming scheme.\n}.
2448 qq{Please switch your class names to ::Model::, ::View:: and ::Controller: as appropriate.\n}
2449 ) if $deprecatedcatalyst_component_names;
2451 for my $component ( @comps ) {
2453 # We pass ignore_loaded here so that overlay files for (e.g.)
2454 # Model::DBI::Schema sub-classes are loaded - if it's in @comps
2455 # we know M::P::O found a file on disk so this is safe
2457 Catalyst::Utils::ensure_class_loaded( $component, { ignore_loaded => 1 } );
2460 for my $component (@comps) {
2461 my $instance = $class->components->{ $component } = $class->setup_component($component);
2462 my @expanded_components = $instance->can('expand_modules')
2463 ? $instance->expand_modules( $component, $config )
2464 : $class->expand_component_module( $component, $config );
2465 for my $component (@expanded_components) {
2466 next if $comps{$component};
2467 $class->components->{ $component } = $class->setup_component($component);
2472 =head2 $c->locate_components( $setup_component_config )
2474 This method is meant to provide a list of component modules that should be
2475 setup for the application. By default, it will use L<Module::Pluggable>.
2477 Specify a C<setup_components> config option to pass additional options directly
2478 to L<Module::Pluggable>. To add additional search paths, specify a key named
2479 C<search_extra> as an array reference. Items in the array beginning with C<::>
2480 will have the application class name prepended to them.
2484 sub locate_components {
2488 my @paths = qw( ::Controller ::C ::Model ::M ::View ::V );
2489 my $extra = delete $config->{ search_extra } || [];
2491 push @paths, @$extra;
2493 my $locator = Module::Pluggable::Object->new(
2494 search_path => [ map { s/^(?=::)/$class/; $_; } @paths ],
2498 # XXX think about ditching this sort entirely
2499 my @comps = sort { length $a <=> length $b } $locator->plugins;
2504 =head2 $c->expand_component_module( $component, $setup_component_config )
2506 Components found by C<locate_components> will be passed to this method, which
2507 is expected to return a list of component (package) names to be set up.
2511 sub expand_component_module {
2512 my ($class, $module) = @_;
2513 return Devel::InnerPackage::list_packages( $module );
2516 =head2 $c->setup_component
2520 sub setup_component {
2521 my( $class, $component ) = @_;
2523 unless ( $component->can( 'COMPONENT' ) ) {
2527 my $suffix = Catalyst::Utils::class2classsuffix( $component );
2528 my $config = $class->config->{ $suffix } || {};
2529 # Stash catalyst_component_name in the config here, so that custom COMPONENT
2530 # methods also pass it. local to avoid pointlessly shitting in config
2531 # for the debug screen, as $component is already the key name.
2532 local $config->{catalyst_component_name} = $component;
2534 my $instance = eval { $component->COMPONENT( $class, $config ); };
2536 if ( my $error = $@ ) {
2538 Catalyst::Exception->throw(
2539 message => qq/Couldn't instantiate component "$component", "$error"/
2543 unless (blessed $instance) {
2544 my $metaclass = Moose::Util::find_meta($component);
2545 my $method_meta = $metaclass->find_method_by_name('COMPONENT');
2546 my $component_method_from = $method_meta->associated_metaclass->name;
2547 my $value = defined($instance) ? $instance : 'undef';
2548 Catalyst::Exception->throw(
2550 qq/Couldn't instantiate component "$component", COMPONENT() method (from $component_method_from) didn't return an object-like value (value was $value)./
2556 =head2 $c->setup_dispatcher
2562 sub setup_dispatcher {
2563 my ( $class, $dispatcher ) = @_;
2566 $dispatcher = 'Catalyst::Dispatcher::' . $dispatcher;
2569 if ( my $env = Catalyst::Utils::env_value( $class, 'DISPATCHER' ) ) {
2570 $dispatcher = 'Catalyst::Dispatcher::' . $env;
2573 unless ($dispatcher) {
2574 $dispatcher = $class->dispatcher_class;
2577 Class::MOP::load_class($dispatcher);
2579 # dispatcher instance
2580 $class->dispatcher( $dispatcher->new );
2583 =head2 $c->setup_engine
2590 my ($class, $engine) = @_;
2593 $engine = $class->engine_class;
2596 $engine = String::RewritePrefix->rewrite( { '' => 'Catalyst::Engine::', '+' => '' }, $engine );
2599 $engine = 'Catalyst::Engine' if $engine eq 'Catalyst::Engine::HTTP';
2601 Class::MOP::load_class($engine);
2603 # check for old engines that are no longer compatible
2605 if ( $engine->isa('Catalyst::Engine::Apache')
2606 && !Catalyst::Engine::Apache->VERSION )
2611 elsif ( $engine->isa('Catalyst::Engine::Server::Base')
2612 && Catalyst::Engine::Server->VERSION le '0.02' )
2617 elsif ($engine->isa('Catalyst::Engine::HTTP::POE')
2618 && $engine->VERSION eq '0.01' )
2623 elsif ($engine->isa('Catalyst::Engine::Zeus')
2624 && $engine->VERSION eq '0.01' )
2630 Catalyst::Exception->throw( message =>
2631 qq/Engine "$engine" is not supported by this version of Catalyst/
2635 if ($ENV{MOD_PERL}) {
2636 require 'Catalyst/Engine/Loader.pm';
2637 my $apache = Catalyst::Engine::Loader->auto;
2639 $class->meta->add_method(handler => sub {
2641 my $app = $class->psgi_app;
2642 $apache->call_app($r, $app);
2646 $class->engine( $engine->new );
2648 $class->psgi_app( $class->setup_psgi_app );
2653 =head2 $c->setup_psgi_app
2655 Builds a PSGI application coderef for the catalyst application C<$c>.
2657 If we're able to locate a C<${myapp}.psgi> file in the applications home
2658 directory, we'll use that to obtain our code reference.
2660 Otherwise the raw psgi app, without any middlewares is created using
2661 C<raw_psgi_app> and wrapped into L<Plack::Middleware::ReverseProxy>
2662 conditionally. See L</"PROXY SUPPORT">.
2666 sub setup_psgi_app {
2669 if (my $home = Path::Class::Dir->new($app->config->{home})) {
2670 my $psgi_file = $home->file(
2671 Catalyst::Utils::appprefix($app) . '.psgi',
2674 return Plack::Util::load_psgi($psgi_file)
2678 return Plack::Middleware::Conditional->wrap(
2680 builder => sub { Plack::Middleware::ReverseProxy->wrap($_[0]) },
2683 return if $app->config->{ignore_frontend_proxy};
2684 return $env->{REMOTE_ADDR} eq '127.0.0.1'
2685 || $app->config->{using_frontend_proxy};
2690 =head2 $c->raw_psgi_app
2692 Returns a PSGI application code reference for the catalyst application
2693 C<$c>. This is the bare application without any middlewares
2694 applied. C<${myapp}.psgi> is not taken into account. See
2695 L</"$c->setup_psgi_app">.
2701 return $app->engine->build_psgi_app($app);
2704 =head2 $c->setup_home
2706 Sets up the home directory.
2711 my ( $class, $home ) = @_;
2713 if ( my $env = Catalyst::Utils::env_value( $class, 'HOME' ) ) {
2717 $home ||= Catalyst::Utils::home($class);
2720 #I remember recently being scolded for assigning config values like this
2721 $class->config->{home} ||= $home;
2722 $class->config->{root} ||= Path::Class::Dir->new($home)->subdir('root');
2726 =head2 $c->setup_log
2728 Sets up log by instantiating a L<Catalyst::Log|Catalyst::Log> object and
2729 passing it to C<log()>. Pass in a comma-delimited list of levels to set the
2732 This method also installs a C<debug> method that returns a true value into the
2733 catalyst subclass if the "debug" level is passed in the comma-delimited list,
2734 or if the C<$CATALYST_DEBUG> environment variable is set to a true value.
2736 Note that if the log has already been setup, by either a previous call to
2737 C<setup_log> or by a call such as C<< __PACKAGE__->log( MyLogger->new ) >>,
2738 that this method won't actually set up the log object.
2743 my ( $class, $levels ) = @_;
2746 $levels =~ s/^\s+//;
2747 $levels =~ s/\s+$//;
2748 my %levels = map { $_ => 1 } split /\s*,\s*/, $levels;
2750 my $env_debug = Catalyst::Utils::env_value( $class, 'DEBUG' );
2751 if ( defined $env_debug ) {
2752 $levels{debug} = 1 if $env_debug; # Ugly!
2753 delete($levels{debug}) unless $env_debug;
2756 unless ( $class->log ) {
2757 $class->log( Catalyst::Log->new(keys %levels) );
2760 if ( $levels{debug} ) {
2761 Class::MOP::get_metaclass_by_name($class)->add_method('debug' => sub { 1 });
2762 $class->log->debug('Debug messages enabled');
2766 =head2 $c->setup_plugins
2772 =head2 $c->setup_stats
2774 Sets up timing statistics class.
2779 my ( $class, $stats ) = @_;
2781 Catalyst::Utils::ensure_class_loaded($class->stats_class);
2783 my $env = Catalyst::Utils::env_value( $class, 'STATS' );
2784 if ( defined($env) ? $env : ($stats || $class->debug ) ) {
2785 Class::MOP::get_metaclass_by_name($class)->add_method('use_stats' => sub { 1 });
2786 $class->log->debug('Statistics enabled');
2791 =head2 $c->registered_plugins
2793 Returns a sorted list of the plugins which have either been stated in the
2794 import list or which have been added via C<< MyApp->plugin(@args); >>.
2796 If passed a given plugin name, it will report a boolean value indicating
2797 whether or not that plugin is loaded. A fully qualified name is required if
2798 the plugin name does not begin with C<Catalyst::Plugin::>.
2800 if ($c->registered_plugins('Some::Plugin')) {
2808 sub registered_plugins {
2810 return sort keys %{ $proto->_plugins } unless @_;
2812 return 1 if exists $proto->_plugins->{$plugin};
2813 return exists $proto->_plugins->{"Catalyst::Plugin::$plugin"};
2816 sub _register_plugin {
2817 my ( $proto, $plugin, $instant ) = @_;
2818 my $class = ref $proto || $proto;
2820 Class::MOP::load_class( $plugin );
2821 $class->log->warn( "$plugin inherits from 'Catalyst::Component' - this is decated and will not work in 5.81" )
2822 if $plugin->isa( 'Catalyst::Component' );
2823 $proto->_plugins->{$plugin} = 1;
2825 my $meta = Class::MOP::get_metaclass_by_name($class);
2826 $meta->superclasses($plugin, $meta->superclasses);
2832 my ( $class, $plugins ) = @_;
2834 $class->_plugins( {} ) unless $class->_plugins;
2835 $plugins = Data::OptList::mkopt($plugins || []);
2838 [ Catalyst::Utils::resolve_namespace(
2839 $class . '::Plugin',
2840 'Catalyst::Plugin', $_->[0]
2846 for my $plugin ( reverse @plugins ) {
2847 Class::MOP::load_class($plugin->[0], $plugin->[1]);
2848 my $meta = find_meta($plugin->[0]);
2849 next if $meta && $meta->isa('Moose::Meta::Role');
2851 $class->_register_plugin($plugin->[0]);
2855 map { $_->[0]->name, $_->[1] }
2856 grep { blessed($_->[0]) && $_->[0]->isa('Moose::Meta::Role') }
2857 map { [find_meta($_->[0]), $_->[1]] }
2860 Moose::Util::apply_all_roles(
2868 Returns an arrayref of the internal execution stack (actions that are
2869 currently executing).
2873 Returns the current timing statistics object. By default Catalyst uses
2874 L<Catalyst::Stats|Catalyst::Stats>, but can be set otherwise with
2875 L<< stats_class|/"$c->stats_class" >>.
2877 Even if L<< -Stats|/"-Stats" >> is not enabled, the stats object is still
2878 available. By enabling it with C< $c->stats->enabled(1) >, it can be used to
2879 profile explicitly, although MyApp.pm still won't profile nor output anything
2882 =head2 $c->stats_class
2884 Returns or sets the stats (timing statistics) class. L<Catalyst::Stats|Catalyst::Stats> is used by default.
2886 =head2 $c->use_stats
2888 Returns 1 when L<< stats collection|/"-Stats" >> is enabled.
2890 Note that this is a static method, not an accessor and should be overridden
2891 by declaring C<sub use_stats { 1 }> in your MyApp.pm, not by calling C<< $c->use_stats(1) >>.
2898 =head2 $c->write( $data )
2900 Writes $data to the output stream. When using this method directly, you
2901 will need to manually set the C<Content-Length> header to the length of
2902 your output data, if known.
2909 # Finalize headers if someone manually writes output
2910 $c->finalize_headers;
2912 return $c->engine->write( $c, @_ );
2917 Returns the Catalyst version number. Mostly useful for "powered by"
2918 messages in template systems.
2922 sub version { return $Catalyst::VERSION }
2924 =head1 CONFIGURATION
2926 There are a number of 'base' config variables which can be set:
2932 C<default_model> - The default model picked if you say C<< $c->model >>. See L<< /$c->model($name) >>.
2936 C<default_view> - The default view to be rendered or returned when C<< $c->view >> is called. See L<< /$c->view($name) >>.
2940 C<disable_component_resolution_regex_fallback> - Turns
2941 off the deprecated component resolution functionality so
2942 that if any of the component methods (e.g. C<< $c->controller('Foo') >>)
2943 are called then regex search will not be attempted on string values and
2944 instead C<undef> will be returned.
2948 C<home> - The application home directory. In an uninstalled application,
2949 this is the top level application directory. In an installed application,
2950 this will be the directory containing C<< MyApp.pm >>.
2954 C<ignore_frontend_proxy> - See L</PROXY SUPPORT>
2958 C<name> - The name of the application in debug messages and the debug and
2963 C<parse_on_demand> - The request body (for example file uploads) will not be parsed
2964 until it is accessed. This allows you to (for example) check authentication (and reject
2965 the upload) before actually recieving all the data. See L</ON-DEMAND PARSER>
2969 C<root> - The root directory for templates. Usually this is just a
2970 subdirectory of the home directory, but you can set it to change the
2971 templates to a different directory.
2975 C<search_extra> - Array reference passed to Module::Pluggable to for additional
2976 namespaces from which components will be loaded (and constructed and stored in
2977 C<< $c->components >>).
2981 C<show_internal_actions> - If true, causes internal actions such as C<< _DISPATCH >>
2982 to be shown in hit debug tables in the test server.
2986 C<use_request_uri_for_path> - Controlls if the C<REQUEST_URI> or C<PATH_INFO> environment
2987 variable should be used for determining the request path. See L<Catalyst::Engine::CGI/PATH DECODING>
2988 for more information.
2992 C<using_frontend_proxy> - See L</PROXY SUPPORT>.
2996 =head1 INTERNAL ACTIONS
2998 Catalyst uses internal actions like C<_DISPATCH>, C<_BEGIN>, C<_AUTO>,
2999 C<_ACTION>, and C<_END>. These are by default not shown in the private
3000 action table, but you can make them visible with a config parameter.
3002 MyApp->config(show_internal_actions => 1);
3004 =head1 ON-DEMAND PARSER
3006 The request body is usually parsed at the beginning of a request,
3007 but if you want to handle input yourself, you can enable on-demand
3008 parsing with a config parameter.
3010 MyApp->config(parse_on_demand => 1);
3012 =head1 PROXY SUPPORT
3014 Many production servers operate using the common double-server approach,
3015 with a lightweight frontend web server passing requests to a larger
3016 backend server. An application running on the backend server must deal
3017 with two problems: the remote user always appears to be C<127.0.0.1> and
3018 the server's hostname will appear to be C<localhost> regardless of the
3019 virtual host that the user connected through.
3021 Catalyst will automatically detect this situation when you are running
3022 the frontend and backend servers on the same machine. The following
3023 changes are made to the request.
3025 $c->req->address is set to the user's real IP address, as read from
3026 the HTTP X-Forwarded-For header.
3028 The host value for $c->req->base and $c->req->uri is set to the real
3029 host, as read from the HTTP X-Forwarded-Host header.
3031 Additionally, you may be running your backend application on an insecure
3032 connection (port 80) while your frontend proxy is running under SSL. If there
3033 is a discrepancy in the ports, use the HTTP header C<X-Forwarded-Port> to
3034 tell Catalyst what port the frontend listens on. This will allow all URIs to
3035 be created properly.
3037 In the case of passing in:
3039 X-Forwarded-Port: 443
3041 All calls to C<uri_for> will result in an https link, as is expected.
3043 Obviously, your web server must support these headers for this to work.
3045 In a more complex server farm environment where you may have your
3046 frontend proxy server(s) on different machines, you will need to set a
3047 configuration option to tell Catalyst to read the proxied data from the
3050 MyApp->config(using_frontend_proxy => 1);
3052 If you do not wish to use the proxy support at all, you may set:
3054 MyApp->config(ignore_frontend_proxy => 1);
3056 =head1 THREAD SAFETY
3058 Catalyst has been tested under Apache 2's threading C<mpm_worker>,
3059 C<mpm_winnt>, and the standalone forking HTTP server on Windows. We
3060 believe the Catalyst core to be thread-safe.
3062 If you plan to operate in a threaded environment, remember that all other
3063 modules you are using must also be thread-safe. Some modules, most notably
3064 L<DBD::SQLite>, are not thread-safe.
3070 Join #catalyst on irc.perl.org.
3074 http://lists.scsys.co.uk/cgi-bin/mailman/listinfo/catalyst
3075 http://lists.scsys.co.uk/cgi-bin/mailman/listinfo/catalyst-dev
3079 http://catalyst.perl.org
3083 http://dev.catalyst.perl.org
3087 =head2 L<Task::Catalyst> - All you need to start with Catalyst
3089 =head2 L<Catalyst::Manual> - The Catalyst Manual
3091 =head2 L<Catalyst::Component>, L<Catalyst::Controller> - Base classes for components
3093 =head2 L<Catalyst::Engine> - Core engine
3095 =head2 L<Catalyst::Log> - Log class.
3097 =head2 L<Catalyst::Request> - Request object
3099 =head2 L<Catalyst::Response> - Response object
3101 =head2 L<Catalyst::Test> - The test suite.
3103 =head1 PROJECT FOUNDER
3105 sri: Sebastian Riedel <sri@cpan.org>
3111 acme: Leon Brocard <leon@astray.com>
3113 abraxxa: Alexander Hartmaier <abraxxa@cpan.org>
3117 Andrew Ford E<lt>A.Ford@ford-mason.co.ukE<gt>
3121 andyg: Andy Grundman <andy@hybridized.org>
3123 audreyt: Audrey Tang
3125 bricas: Brian Cassidy <bricas@cpan.org>
3127 Caelum: Rafael Kitover <rkitover@io.com>
3129 chansen: Christian Hansen
3131 chicks: Christopher Hicks
3133 Chisel Wright C<pause@herlpacker.co.uk>
3135 Danijel Milicevic C<me@danijel.de>
3137 David Kamholz E<lt>dkamholz@cpan.orgE<gt>
3139 David Naughton, C<naughton@umn.edu>
3143 dhoss: Devin Austin <dhoss@cpan.org>
3145 dkubb: Dan Kubb <dan.kubb-cpan@onautopilot.com>
3149 dwc: Daniel Westermann-Clark <danieltwc@cpan.org>
3151 esskar: Sascha Kiefer
3153 fireartist: Carl Franks <cfranks@cpan.org>
3155 frew: Arthur Axel "fREW" Schmidt <frioux@gmail.com>
3157 gabb: Danijel Milicevic
3161 Gavin Henry C<ghenry@perl.me.uk>
3165 groditi: Guillermo Roditi <groditi@gmail.com>
3167 hobbs: Andrew Rodland <andrew@cleverdomain.org>
3169 ilmari: Dagfinn Ilmari Mannsåker <ilmari@ilmari.org>
3171 jcamacho: Juan Camacho
3173 jester: Jesse Sheidlower C<jester@panix.com>
3175 jhannah: Jay Hannah <jay@jays.net>
3181 jon: Jon Schutz <jjschutz@cpan.org>
3183 Jonathan Rockway C<< <jrockway@cpan.org> >>
3185 Kieren Diment C<kd@totaldatasolution.com>
3187 konobi: Scott McWhirter <konobi@cpan.org>
3189 marcus: Marcus Ramberg <mramberg@cpan.org>
3191 miyagawa: Tatsuhiko Miyagawa <miyagawa@bulknews.net>
3193 mst: Matt S. Trout <mst@shadowcatsystems.co.uk>
3197 naughton: David Naughton
3199 ningu: David Kamholz <dkamholz@cpan.org>
3201 nothingmuch: Yuval Kogman <nothingmuch@woobling.org>
3203 numa: Dan Sully <daniel@cpan.org>
3209 omega: Andreas Marienborg
3211 Oleg Kostyuk <cub.uanic@gmail.com>
3213 phaylon: Robert Sedlacek <phaylon@dunkelheit.at>
3215 rafl: Florian Ragwitz <rafl@debian.org>
3217 random: Roland Lammel <lammel@cpan.org>
3219 Robert Sedlacek C<< <rs@474.at> >>
3221 SpiceMan: Marcel Montes
3225 szbalint: Balint Szilakszi <szbalint@cpan.org>
3227 t0m: Tomas Doran <bobtfish@bobtfish.net>
3231 Viljo Marrandi C<vilts@yahoo.com>
3233 Will Hawes C<info@whawes.co.uk>
3235 willert: Sebastian Willert <willert@cpan.org>
3237 wreis: Wallace Reis <wallace@reis.org.br>
3239 Yuval Kogman, C<nothingmuch@woobling.org>
3241 rainboxx: Matthias Dietrich, C<perl@rainboxx.de>
3245 This library is free software. You can redistribute it and/or modify it under
3246 the same terms as Perl itself.
3252 __PACKAGE__->meta->make_immutable;