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.89000';
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 if (my $engine = delete $flags->{engine}) {
1120 $class->log->warn("Specifying the engine in ->setup is no longer supported, XXX FIXME");
1122 $class->setup_engine();
1123 $class->setup_stats( delete $flags->{stats} );
1125 for my $flag ( sort keys %{$flags} ) {
1127 if ( my $code = $class->can( 'setup_' . $flag ) ) {
1128 &$code( $class, delete $flags->{$flag} );
1131 $class->log->warn(qq/Unknown flag "$flag"/);
1135 eval { require Catalyst::Devel; };
1136 if( !$@ && $ENV{CATALYST_SCRIPT_GEN} && ( $ENV{CATALYST_SCRIPT_GEN} < $Catalyst::Devel::CATALYST_SCRIPT_GEN ) ) {
1137 $class->log->warn(<<"EOF");
1138 You are running an old script!
1140 Please update by running (this will overwrite existing files):
1141 catalyst.pl -force -scripts $class
1143 or (this will not overwrite existing files):
1144 catalyst.pl -scripts $class
1149 if ( $class->debug ) {
1150 my @plugins = map { "$_ " . ( $_->VERSION || '' ) } $class->registered_plugins;
1153 my $column_width = Catalyst::Utils::term_width() - 6;
1154 my $t = Text::SimpleTable->new($column_width);
1155 $t->row($_) for @plugins;
1156 $class->log->debug( "Loaded plugins:\n" . $t->draw . "\n" );
1159 my $dispatcher = $class->dispatcher;
1160 my $engine = $class->engine;
1161 my $home = $class->config->{home};
1163 $class->log->debug(sprintf(q/Loaded dispatcher "%s"/, blessed($dispatcher)));
1164 $class->log->debug(sprintf(q/Loaded engine "%s"/, blessed($engine)));
1168 ? $class->log->debug(qq/Found home "$home"/)
1169 : $class->log->debug(qq/Home "$home" doesn't exist/)
1170 : $class->log->debug(q/Couldn't find home/);
1173 # Call plugins setup, this is stupid and evil.
1174 # Also screws C3 badly on 5.10, hack to avoid.
1176 no warnings qw/redefine/;
1177 local *setup = sub { };
1178 $class->setup unless $Catalyst::__AM_RESTARTING;
1181 # Initialize our data structure
1182 $class->components( {} );
1184 $class->setup_components;
1186 if ( $class->debug ) {
1187 my $column_width = Catalyst::Utils::term_width() - 8 - 9;
1188 my $t = Text::SimpleTable->new( [ $column_width, 'Class' ], [ 8, 'Type' ] );
1189 for my $comp ( sort keys %{ $class->components } ) {
1190 my $type = ref $class->components->{$comp} ? 'instance' : 'class';
1191 $t->row( $comp, $type );
1193 $class->log->debug( "Loaded components:\n" . $t->draw . "\n" )
1194 if ( keys %{ $class->components } );
1197 # Add our self to components, since we are also a component
1198 if( $class->isa('Catalyst::Controller') ){
1199 $class->components->{$class} = $class;
1202 $class->setup_actions;
1204 if ( $class->debug ) {
1205 my $name = $class->config->{name} || 'Application';
1206 $class->log->info("$name powered by Catalyst $Catalyst::VERSION");
1209 # Make sure that the application class becomes immutable at this point,
1210 B::Hooks::EndOfScope::on_scope_end {
1212 my $meta = Class::MOP::get_metaclass_by_name($class);
1215 && ! { $meta->immutable_options }->{replace_constructor}
1217 $class->isa('Class::Accessor::Fast')
1218 || $class->isa('Class::Accessor')
1221 warn "You made your application class ($class) immutable, "
1222 . "but did not inline the\nconstructor. "
1223 . "This will break catalyst, as your app \@ISA "
1224 . "Class::Accessor(::Fast)?\nPlease pass "
1225 . "(replace_constructor => 1)\nwhen making your class immutable.\n";
1227 $meta->make_immutable(
1228 replace_constructor => 1,
1229 ) unless $meta->is_immutable;
1232 if ($class->config->{case_sensitive}) {
1233 $class->log->warn($class . "->config->{case_sensitive} is set.");
1234 $class->log->warn("This setting is deprecated and planned to be removed in Catalyst 5.81.");
1237 $class->setup_finalize;
1238 # Should be the last thing we do so that user things hooking
1239 # setup_finalize can log..
1240 $class->log->_flush() if $class->log->can('_flush');
1241 return 1; # Explicit return true as people have __PACKAGE__->setup as the last thing in their class. HATE.
1244 =head2 $app->setup_finalize
1246 A hook to attach modifiers to. This method does not do anything except set the
1247 C<setup_finished> accessor.
1249 Applying method modifiers to the C<setup> method doesn't work, because of quirky thingsdone for plugin setup.
1253 after setup_finalize => sub {
1261 sub setup_finalize {
1263 $class->setup_finished(1);
1266 =head2 $c->uri_for( $path?, @args?, \%query_values? )
1268 =head2 $c->uri_for( $action, \@captures?, @args?, \%query_values? )
1270 Constructs an absolute L<URI> object based on the application root, the
1271 provided path, and the additional arguments and query parameters provided.
1272 When used as a string, provides a textual URI. If you need more flexibility
1273 than this (i.e. the option to provide relative URIs etc.) see
1274 L<Catalyst::Plugin::SmartURI>.
1276 If no arguments are provided, the URI for the current action is returned.
1277 To return the current action and also provide @args, use
1278 C<< $c->uri_for( $c->action, @args ) >>.
1280 If the first argument is a string, it is taken as a public URI path relative
1281 to C<< $c->namespace >> (if it doesn't begin with a forward slash) or
1282 relative to the application root (if it does). It is then merged with
1283 C<< $c->request->base >>; any C<@args> are appended as additional path
1284 components; and any C<%query_values> are appended as C<?foo=bar> parameters.
1286 If the first argument is a L<Catalyst::Action> it represents an action which
1287 will have its path resolved using C<< $c->dispatcher->uri_for_action >>. The
1288 optional C<\@captures> argument (an arrayref) allows passing the captured
1289 variables that are needed to fill in the paths of Chained and Regex actions;
1290 once the path is resolved, C<uri_for> continues as though a path was
1291 provided, appending any arguments or parameters and creating an absolute
1294 The captures for the current request can be found in
1295 C<< $c->request->captures >>, and actions can be resolved using
1296 C<< Catalyst::Controller->action_for($name) >>. If you have a private action
1297 path, use C<< $c->uri_for_action >> instead.
1299 # Equivalent to $c->req->uri
1300 $c->uri_for($c->action, $c->req->captures,
1301 @{ $c->req->args }, $c->req->params);
1303 # For the Foo action in the Bar controller
1304 $c->uri_for($c->controller('Bar')->action_for('Foo'));
1306 # Path to a static resource
1307 $c->uri_for('/static/images/logo.png');
1312 my ( $c, $path, @args ) = @_;
1314 if (blessed($path) && $path->isa('Catalyst::Controller')) {
1315 $path = $path->path_prefix;
1320 undef($path) if (defined $path && $path eq '');
1323 ( scalar @args && ref $args[$#args] eq 'HASH' ? pop @args : {} );
1325 carp "uri_for called with undef argument" if grep { ! defined $_ } @args;
1326 foreach my $arg (@args) {
1327 utf8::encode($arg) if utf8::is_utf8($arg);
1328 $arg =~ s/([^$URI::uric])/$URI::Escape::escapes{$1}/go;
1331 if ( blessed($path) ) { # action object
1332 s|/|%2F|g for @args;
1333 my $captures = [ map { s|/|%2F|g; $_; }
1334 ( scalar @args && ref $args[0] eq 'ARRAY'
1338 foreach my $capture (@$captures) {
1339 utf8::encode($capture) if utf8::is_utf8($capture);
1340 $capture =~ s/([^$URI::uric])/$URI::Escape::escapes{$1}/go;
1344 $path = $c->dispatcher->uri_for_action($action, $captures);
1345 if (not defined $path) {
1346 $c->log->debug(qq/Can't find uri_for action '$action' @$captures/)
1350 $path = '/' if $path eq '';
1353 unshift(@args, $path);
1355 unless (defined $path && $path =~ s!^/!!) { # in-place strip
1356 my $namespace = $c->namespace;
1357 if (defined $path) { # cheesy hack to handle path '../foo'
1358 $namespace =~ s{(?:^|/)[^/]+$}{} while $args[0] =~ s{^\.\./}{};
1360 unshift(@args, $namespace || '');
1363 # join args with '/', or a blank string
1364 my $args = join('/', grep { defined($_) } @args);
1365 $args =~ s/\?/%3F/g; # STUPID STUPID SPECIAL CASE
1367 my $base = $c->req->base;
1368 my $class = ref($base);
1369 $base =~ s{(?<!/)$}{/};
1373 if (my @keys = keys %$params) {
1374 # somewhat lifted from URI::_query's query_form
1375 $query = '?'.join('&', map {
1376 my $val = $params->{$_};
1377 s/([;\/?:@&=+,\$\[\]%])/$URI::Escape::escapes{$1}/go;
1380 $val = '' unless defined $val;
1383 utf8::encode( $param ) if utf8::is_utf8($param);
1384 # using the URI::Escape pattern here so utf8 chars survive
1385 $param =~ s/([^A-Za-z0-9\-_.!~*'() ])/$URI::Escape::escapes{$1}/go;
1387 "${key}=$param"; } ( ref $val eq 'ARRAY' ? @$val : $val ));
1391 my $res = bless(\"${base}${args}${query}", $class);
1395 =head2 $c->uri_for_action( $path, \@captures?, @args?, \%query_values? )
1397 =head2 $c->uri_for_action( $action, \@captures?, @args?, \%query_values? )
1403 A private path to the Catalyst action you want to create a URI for.
1405 This is a shortcut for calling C<< $c->dispatcher->get_action_by_path($path)
1406 >> and passing the resulting C<$action> and the remaining arguments to C<<
1409 You can also pass in a Catalyst::Action object, in which case it is passed to
1412 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.
1414 For example, if the action looks like:
1416 package MyApp::Controller::Users;
1418 sub lst : Path('the-list') {}
1422 $c->uri_for_action('/users/lst')
1424 and it will create the URI /users/the-list.
1430 sub uri_for_action {
1431 my ( $c, $path, @args ) = @_;
1432 my $action = blessed($path)
1434 : $c->dispatcher->get_action_by_path($path);
1435 unless (defined $action) {
1436 croak "Can't find action for path '$path'";
1438 return $c->uri_for( $action, @args );
1441 =head2 $c->welcome_message
1443 Returns the Catalyst welcome HTML page.
1447 sub welcome_message {
1449 my $name = $c->config->{name};
1450 my $logo = $c->uri_for('/static/images/catalyst_logo.png');
1451 my $prefix = Catalyst::Utils::appprefix( ref $c );
1452 $c->response->content_type('text/html; charset=utf-8');
1454 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
1455 "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
1456 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
1458 <meta http-equiv="Content-Language" content="en" />
1459 <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
1460 <title>$name on Catalyst $VERSION</title>
1461 <style type="text/css">
1464 background-color: #eee;
1471 margin-bottom: 10px;
1473 background-color: #ccc;
1474 border: 1px solid #aaa;
1479 font-family: verdana, tahoma, sans-serif;
1482 font-family: verdana, tahoma, sans-serif;
1485 text-decoration: none;
1487 border-bottom: 1px dotted #bbb;
1489 :link:hover, :visited:hover {
1502 background-color: #fff;
1503 border: 1px solid #aaa;
1507 font-weight: normal;
1529 <h1><span id="appname">$name</span> on <a href="http://catalyst.perl.org">Catalyst</a>
1534 <img src="$logo" alt="Catalyst Logo" />
1536 <p>Welcome to the world of Catalyst.
1537 This <a href="http://en.wikipedia.org/wiki/MVC">MVC</a>
1538 framework will make web development something you had
1539 never expected it to be: Fun, rewarding, and quick.</p>
1540 <h2>What to do now?</h2>
1541 <p>That really depends on what <b>you</b> want to do.
1542 We do, however, provide you with a few starting points.</p>
1543 <p>If you want to jump right into web development with Catalyst
1544 you might want to start with a tutorial.</p>
1545 <pre>perldoc <a href="http://cpansearch.perl.org/dist/Catalyst-Manual/lib/Catalyst/Manual/Tutorial.pod">Catalyst::Manual::Tutorial</a></code>
1547 <p>Afterwards you can go on to check out a more complete look at our features.</p>
1549 <code>perldoc <a href="http://cpansearch.perl.org/dist/Catalyst-Manual/lib/Catalyst/Manual/Intro.pod">Catalyst::Manual::Intro</a>
1550 <!-- Something else should go here, but the Catalyst::Manual link seems unhelpful -->
1552 <h2>What to do next?</h2>
1553 <p>Next it's time to write an actual application. Use the
1554 helper scripts to generate <a href="http://cpansearch.perl.org/search?query=Catalyst%3A%3AController%3A%3A&mode=all">controllers</a>,
1555 <a href="http://cpansearch.perl.org/search?query=Catalyst%3A%3AModel%3A%3A&mode=all">models</a>, and
1556 <a href="http://cpansearch.perl.org/search?query=Catalyst%3A%3AView%3A%3A&mode=all">views</a>;
1557 they can save you a lot of work.</p>
1558 <pre><code>script/${prefix}_create.pl --help</code></pre>
1559 <p>Also, be sure to check out the vast and growing
1560 collection of <a href="http://search.cpan.org/search?query=Catalyst">plugins for Catalyst on CPAN</a>;
1561 you are likely to find what you need there.
1565 <p>Catalyst has a very active community. Here are the main places to
1566 get in touch with us.</p>
1569 <a href="http://dev.catalyst.perl.org">Wiki</a>
1572 <a href="http://lists.scsys.co.uk/cgi-bin/mailman/listinfo/catalyst">Mailing-List</a>
1575 <a href="irc://irc.perl.org/catalyst">IRC channel #catalyst on irc.perl.org</a>
1578 <h2>In conclusion</h2>
1579 <p>The Catalyst team hopes you will enjoy using Catalyst as much
1580 as we enjoyed making it. Please contact us if you have ideas
1581 for improvement or other feedback.</p>
1589 =head1 INTERNAL METHODS
1591 These methods are not meant to be used by end users.
1593 =head2 $c->components
1595 Returns a hash of components.
1597 =head2 $c->context_class
1599 Returns or sets the context class.
1603 Returns a hashref containing coderefs and execution counts (needed for
1604 deep recursion detection).
1608 Returns the number of actions on the current internal execution stack.
1612 Dispatches a request to actions.
1616 sub dispatch { my $c = shift; $c->dispatcher->dispatch( $c, @_ ) }
1618 =head2 $c->dispatcher_class
1620 Returns or sets the dispatcher class.
1622 =head2 $c->dump_these
1624 Returns a list of 2-element array references (name, structure) pairs
1625 that will be dumped on the error page in debug mode.
1631 [ Request => $c->req ],
1632 [ Response => $c->res ],
1633 [ Stash => $c->stash ],
1634 [ Config => $c->config ];
1637 =head2 $c->engine_class
1639 Returns or sets the engine class.
1641 =head2 $c->execute( $class, $coderef )
1643 Execute a coderef in given class and catch exceptions. Errors are available
1649 my ( $c, $class, $code ) = @_;
1650 $class = $c->component($class) || $class;
1653 if ( $c->depth >= $RECURSION ) {
1654 my $action = $code->reverse();
1655 $action = "/$action" unless $action =~ /->/;
1656 my $error = qq/Deep recursion detected calling "${action}"/;
1657 $c->log->error($error);
1663 my $stats_info = $c->_stats_start_execute( $code ) if $c->use_stats;
1665 push( @{ $c->stack }, $code );
1667 no warnings 'recursion';
1668 eval { $c->state( $code->execute( $class, $c, @{ $c->req->args } ) || 0 ) };
1670 $c->_stats_finish_execute( $stats_info ) if $c->use_stats and $stats_info;
1672 my $last = pop( @{ $c->stack } );
1674 if ( my $error = $@ ) {
1675 if ( blessed($error) and $error->isa('Catalyst::Exception::Detach') ) {
1676 $error->rethrow if $c->depth > 1;
1678 elsif ( blessed($error) and $error->isa('Catalyst::Exception::Go') ) {
1679 $error->rethrow if $c->depth > 0;
1682 unless ( ref $error ) {
1683 no warnings 'uninitialized';
1685 my $class = $last->class;
1686 my $name = $last->name;
1687 $error = qq/Caught exception in $class->$name "$error"/;
1696 sub _stats_start_execute {
1697 my ( $c, $code ) = @_;
1698 my $appclass = ref($c) || $c;
1699 return if ( ( $code->name =~ /^_.*/ )
1700 && ( !$appclass->config->{show_internal_actions} ) );
1702 my $action_name = $code->reverse();
1703 $c->counter->{$action_name}++;
1705 my $action = $action_name;
1706 $action = "/$action" unless $action =~ /->/;
1708 # determine if the call was the result of a forward
1709 # this is done by walking up the call stack and looking for a calling
1710 # sub of Catalyst::forward before the eval
1712 for my $index ( 2 .. 11 ) {
1714 if ( ( caller($index) )[0] eq 'Catalyst'
1715 && ( caller($index) )[3] eq '(eval)' );
1717 if ( ( caller($index) )[3] =~ /forward$/ ) {
1718 $callsub = ( caller($index) )[3];
1719 $action = "-> $action";
1724 my $uid = $action_name . $c->counter->{$action_name};
1726 # is this a root-level call or a forwarded call?
1727 if ( $callsub =~ /forward$/ ) {
1728 my $parent = $c->stack->[-1];
1730 # forward, locate the caller
1731 if ( defined $parent && exists $c->counter->{"$parent"} ) {
1734 parent => "$parent" . $c->counter->{"$parent"},
1740 # forward with no caller may come from a plugin
1759 sub _stats_finish_execute {
1760 my ( $c, $info ) = @_;
1761 $c->stats->profile( end => $info );
1766 Finalizes the request.
1773 for my $error ( @{ $c->error } ) {
1774 $c->log->error($error);
1777 # Allow engine to handle finalize flow (for POE)
1778 my $engine = $c->engine;
1779 if ( my $code = $engine->can('finalize') ) {
1784 $c->finalize_uploads;
1787 if ( $#{ $c->error } >= 0 ) {
1791 $c->finalize_headers;
1794 if ( $c->request->method eq 'HEAD' ) {
1795 $c->response->body('');
1803 if ($c->use_stats) {
1804 my $elapsed = sprintf '%f', $c->stats->elapsed;
1805 my $av = $elapsed == 0 ? '??' : sprintf '%.3f', 1 / $elapsed;
1807 "Request took ${elapsed}s ($av/s)\n" . $c->stats->report . "\n" );
1810 return $c->response->status;
1813 =head2 $c->finalize_body
1819 sub finalize_body { my $c = shift; $c->engine->finalize_body( $c, @_ ) }
1821 =head2 $c->finalize_cookies
1827 sub finalize_cookies { my $c = shift; $c->engine->finalize_cookies( $c, @_ ) }
1829 =head2 $c->finalize_error
1835 sub finalize_error { my $c = shift; $c->engine->finalize_error( $c, @_ ) }
1837 =head2 $c->finalize_headers
1843 sub finalize_headers {
1846 my $response = $c->response; #accessor calls can add up?
1848 # Check if we already finalized headers
1849 return if $response->finalized_headers;
1852 if ( my $location = $response->redirect ) {
1853 $c->log->debug(qq/Redirecting to "$location"/) if $c->debug;
1854 $response->header( Location => $location );
1856 if ( !$response->has_body ) {
1857 # Add a default body if none is already present
1859 qq{<html><body><p>This item has moved <a href="$location">here</a>.</p></body></html>}
1865 if ( defined $response->body && length $response->body && !$response->content_length ) {
1867 # get the length from a filehandle
1868 if ( blessed( $response->body ) && $response->body->can('read') || ref( $response->body ) eq 'GLOB' )
1870 my $stat = stat $response->body;
1871 if ( $stat && $stat->size > 0 ) {
1872 $response->content_length( $stat->size );
1875 $c->log->warn('Serving filehandle without a content-length');
1879 # everything should be bytes at this point, but just in case
1880 $response->content_length( length( $response->body ) );
1885 if ( $response->status =~ /^(1\d\d|[23]04)$/ ) {
1886 $response->headers->remove_header("Content-Length");
1887 $response->body('');
1890 $c->finalize_cookies;
1892 $c->engine->finalize_headers( $c, @_ );
1895 $response->finalized_headers(1);
1898 =head2 $c->finalize_output
1900 An alias for finalize_body.
1902 =head2 $c->finalize_read
1904 Finalizes the input after reading is complete.
1908 sub finalize_read { my $c = shift; $c->engine->finalize_read( $c, @_ ) }
1910 =head2 $c->finalize_uploads
1912 Finalizes uploads. Cleans up any temporary files.
1916 sub finalize_uploads { my $c = shift; $c->engine->finalize_uploads( $c, @_ ) }
1918 =head2 $c->get_action( $action, $namespace )
1920 Gets an action in a given namespace.
1924 sub get_action { my $c = shift; $c->dispatcher->get_action(@_) }
1926 =head2 $c->get_actions( $action, $namespace )
1928 Gets all actions of a given name in a namespace and all parent
1933 sub get_actions { my $c = shift; $c->dispatcher->get_actions( $c, @_ ) }
1935 =head2 $app->handle_request( @arguments )
1937 Called to handle each HTTP request.
1941 sub handle_request {
1942 my ( $class, @arguments ) = @_;
1944 # Always expect worst case!
1947 if ($class->debug) {
1948 my $secs = time - $START || 1;
1949 my $av = sprintf '%.3f', $COUNT / $secs;
1950 my $time = localtime time;
1951 $class->log->info("*** Request $COUNT ($av/s) [$$] [$time] ***");
1954 my $c = $class->prepare(@arguments);
1956 $status = $c->finalize;
1959 chomp(my $error = $_);
1960 $class->log->error(qq/Caught exception in engine "$error"/);
1965 if(my $coderef = $class->log->can('_flush')){
1966 $class->log->$coderef();
1971 =head2 $c->prepare( @arguments )
1973 Creates a Catalyst context from an engine-specific request (Apache, CGI,
1979 my ( $class, @arguments ) = @_;
1982 # After the app/ctxt split, this should become an attribute based on something passed
1983 # into the application.
1984 $class->context_class( ref $class || $class ) unless $class->context_class;
1986 my $c = $class->context_class->new({});
1988 # For on-demand data
1989 $c->request->_context($c);
1990 $c->response->_context($c);
1992 #surely this is not the most efficient way to do things...
1993 $c->stats($class->stats_class->new)->enable($c->use_stats);
1994 if ( $c->debug || $c->config->{enable_catalyst_header} ) {
1995 $c->res->headers->header( 'X-Catalyst' => $Catalyst::VERSION );
1999 # Allow engine to direct the prepare flow (for POE)
2000 if ( my $prepare = $c->engine->can('prepare') ) {
2001 $c->engine->$prepare( $c, @arguments );
2004 $c->prepare_request(@arguments);
2005 $c->prepare_connection;
2006 $c->prepare_query_parameters;
2007 $c->prepare_headers;
2008 $c->prepare_cookies;
2011 # Prepare the body for reading, either by prepare_body
2012 # or the user, if they are using $c->read
2015 # Parse the body unless the user wants it on-demand
2016 unless ( ref($c)->config->{parse_on_demand} ) {
2021 # VERY ugly and probably shouldn't rely on ->finalize actually working
2023 # failed prepare is always due to an invalid request, right?
2024 $c->response->status(400);
2025 $c->response->content_type('text/plain');
2026 $c->response->body('Bad Request');
2031 my $method = $c->req->method || '';
2032 my $path = $c->req->path;
2033 $path = '/' unless length $path;
2034 my $address = $c->req->address || '';
2043 =head2 $c->prepare_action
2045 Prepares action. See L<Catalyst::Dispatcher>.
2049 sub prepare_action { my $c = shift; $c->dispatcher->prepare_action( $c, @_ ) }
2051 =head2 $c->prepare_body
2053 Prepares message body.
2060 return if $c->request->_has_body;
2062 # Initialize on-demand data
2063 $c->engine->prepare_body( $c, @_ );
2064 $c->prepare_parameters;
2065 $c->prepare_uploads;
2068 =head2 $c->prepare_body_chunk( $chunk )
2070 Prepares a chunk of data before sending it to L<HTTP::Body>.
2072 See L<Catalyst::Engine>.
2076 sub prepare_body_chunk {
2078 $c->engine->prepare_body_chunk( $c, @_ );
2081 =head2 $c->prepare_body_parameters
2083 Prepares body parameters.
2087 sub prepare_body_parameters {
2089 $c->engine->prepare_body_parameters( $c, @_ );
2092 =head2 $c->prepare_connection
2094 Prepares connection.
2098 sub prepare_connection {
2100 $c->engine->prepare_connection( $c, @_ );
2103 =head2 $c->prepare_cookies
2109 sub prepare_cookies { my $c = shift; $c->engine->prepare_cookies( $c, @_ ) }
2111 =head2 $c->prepare_headers
2117 sub prepare_headers { my $c = shift; $c->engine->prepare_headers( $c, @_ ) }
2119 =head2 $c->prepare_parameters
2121 Prepares parameters.
2125 sub prepare_parameters {
2127 $c->prepare_body_parameters;
2128 $c->engine->prepare_parameters( $c, @_ );
2131 =head2 $c->prepare_path
2133 Prepares path and base.
2137 sub prepare_path { my $c = shift; $c->engine->prepare_path( $c, @_ ) }
2139 =head2 $c->prepare_query_parameters
2141 Prepares query parameters.
2145 sub prepare_query_parameters {
2148 $c->engine->prepare_query_parameters( $c, @_ );
2151 =head2 $c->log_request
2153 Writes information about the request to the debug logs. This includes:
2157 =item * Request method, path, and remote IP address
2159 =item * Query keywords (see L<Catalyst::Request/query_keywords>)
2161 =item * Request parameters
2163 =item * File uploads
2172 return unless $c->debug;
2174 my($dump) = grep {$_->[0] eq 'Request' } $c->dump_these;
2175 my $request = $dump->[1];
2177 my ( $method, $path, $address ) = ( $request->method, $request->path, $request->address );
2179 $path = '/' unless length $path;
2181 $c->log->debug(qq/"$method" request for "$path" from "$address"/);
2183 $c->log_request_headers($request->headers);
2185 if ( my $keywords = $request->query_keywords ) {
2186 $c->log->debug("Query keywords are: $keywords");
2189 $c->log_request_parameters( query => $request->query_parameters, $request->_has_body ? (body => $request->body_parameters) : () );
2191 $c->log_request_uploads($request);
2194 =head2 $c->log_response
2196 Writes information about the response to the debug logs by calling
2197 C<< $c->log_response_status_line >> and C<< $c->log_response_headers >>.
2204 return unless $c->debug;
2206 my($dump) = grep {$_->[0] eq 'Response' } $c->dump_these;
2207 my $response = $dump->[1];
2209 $c->log_response_status_line($response);
2210 $c->log_response_headers($response->headers);
2213 =head2 $c->log_response_status_line($response)
2215 Writes one line of information about the response to the debug logs. This includes:
2219 =item * Response status code
2221 =item * Content-Type header (if present)
2223 =item * Content-Length header (if present)
2229 sub log_response_status_line {
2230 my ($c, $response) = @_;
2234 'Response Code: %s; Content-Type: %s; Content-Length: %s',
2235 $response->status || 'unknown',
2236 $response->headers->header('Content-Type') || 'unknown',
2237 $response->headers->header('Content-Length') || 'unknown'
2242 =head2 $c->log_response_headers($headers);
2244 Hook method which can be wrapped by plugins to log the responseheaders.
2245 No-op in the default implementation.
2249 sub log_response_headers {}
2251 =head2 $c->log_request_parameters( query => {}, body => {} )
2253 Logs request parameters to debug logs
2257 sub log_request_parameters {
2259 my %all_params = @_;
2261 return unless $c->debug;
2263 my $column_width = Catalyst::Utils::term_width() - 44;
2264 foreach my $type (qw(query body)) {
2265 my $params = $all_params{$type};
2266 next if ! keys %$params;
2267 my $t = Text::SimpleTable->new( [ 35, 'Parameter' ], [ $column_width, 'Value' ] );
2268 for my $key ( sort keys %$params ) {
2269 my $param = $params->{$key};
2270 my $value = defined($param) ? $param : '';
2271 $t->row( $key, ref $value eq 'ARRAY' ? ( join ', ', @$value ) : $value );
2273 $c->log->debug( ucfirst($type) . " Parameters are:\n" . $t->draw );
2277 =head2 $c->log_request_uploads
2279 Logs file uploads included in the request to the debug logs.
2280 The parameter name, filename, file type, and file size are all included in
2285 sub log_request_uploads {
2287 my $request = shift;
2288 return unless $c->debug;
2289 my $uploads = $request->uploads;
2290 if ( keys %$uploads ) {
2291 my $t = Text::SimpleTable->new(
2292 [ 12, 'Parameter' ],
2297 for my $key ( sort keys %$uploads ) {
2298 my $upload = $uploads->{$key};
2299 for my $u ( ref $upload eq 'ARRAY' ? @{$upload} : ($upload) ) {
2300 $t->row( $key, $u->filename, $u->type, $u->size );
2303 $c->log->debug( "File Uploads are:\n" . $t->draw );
2307 =head2 $c->log_request_headers($headers);
2309 Hook method which can be wrapped by plugins to log the request headers.
2310 No-op in the default implementation.
2314 sub log_request_headers {}
2316 =head2 $c->log_headers($type => $headers)
2318 Logs L<HTTP::Headers> (either request or response) to the debug logs.
2325 my $headers = shift; # an HTTP::Headers instance
2327 return unless $c->debug;
2329 my $column_width = Catalyst::Utils::term_width() - 28;
2330 my $t = Text::SimpleTable->new( [ 15, 'Header Name' ], [ $column_width, 'Value' ] );
2333 my ( $name, $value ) = @_;
2334 $t->row( $name, $value );
2337 $c->log->debug( ucfirst($type) . " Headers:\n" . $t->draw );
2341 =head2 $c->prepare_read
2343 Prepares the input for reading.
2347 sub prepare_read { my $c = shift; $c->engine->prepare_read( $c, @_ ) }
2349 =head2 $c->prepare_request
2351 Prepares the engine request.
2355 sub prepare_request { my $c = shift; $c->engine->prepare_request( $c, @_ ) }
2357 =head2 $c->prepare_uploads
2363 sub prepare_uploads {
2366 $c->engine->prepare_uploads( $c, @_ );
2369 =head2 $c->prepare_write
2371 Prepares the output for writing.
2375 sub prepare_write { my $c = shift; $c->engine->prepare_write( $c, @_ ) }
2377 =head2 $c->request_class
2379 Returns or sets the request class. Defaults to L<Catalyst::Request>.
2381 =head2 $c->response_class
2383 Returns or sets the response class. Defaults to L<Catalyst::Response>.
2385 =head2 $c->read( [$maxlength] )
2387 Reads a chunk of data from the request body. This method is designed to
2388 be used in a while loop, reading C<$maxlength> bytes on every call.
2389 C<$maxlength> defaults to the size of the request if not specified.
2391 You have to set C<< MyApp->config(parse_on_demand => 1) >> to use this
2394 Warning: If you use read(), Catalyst will not process the body,
2395 so you will not be able to access POST parameters or file uploads via
2396 $c->request. You must handle all body parsing yourself.
2400 sub read { my $c = shift; return $c->engine->read( $c, @_ ) }
2408 sub run { my $c = shift; return $c->engine->run( $c, $c->psgi_app, @_ ) }
2410 =head2 $c->set_action( $action, $code, $namespace, $attrs )
2412 Sets an action in a given namespace.
2416 sub set_action { my $c = shift; $c->dispatcher->set_action( $c, @_ ) }
2418 =head2 $c->setup_actions($component)
2420 Sets up actions for a component.
2424 sub setup_actions { my $c = shift; $c->dispatcher->setup_actions( $c, @_ ) }
2426 =head2 $c->setup_components
2428 This method is called internally to set up the application's components.
2430 It finds modules by calling the L<locate_components> method, expands them to
2431 package names with the L<expand_component_module> method, and then installs
2432 each component into the application.
2434 The C<setup_components> config option is passed to both of the above methods.
2436 Installation of each component is performed by the L<setup_component> method,
2441 sub setup_components {
2444 my $config = $class->config->{ setup_components };
2446 my @comps = $class->locate_components($config);
2447 my %comps = map { $_ => 1 } @comps;
2449 my $deprecatedcatalyst_component_names = grep { /::[CMV]::/ } @comps;
2450 $class->log->warn(qq{Your application is using the deprecated ::[MVC]:: type naming scheme.\n}.
2451 qq{Please switch your class names to ::Model::, ::View:: and ::Controller: as appropriate.\n}
2452 ) if $deprecatedcatalyst_component_names;
2454 for my $component ( @comps ) {
2456 # We pass ignore_loaded here so that overlay files for (e.g.)
2457 # Model::DBI::Schema sub-classes are loaded - if it's in @comps
2458 # we know M::P::O found a file on disk so this is safe
2460 Catalyst::Utils::ensure_class_loaded( $component, { ignore_loaded => 1 } );
2463 for my $component (@comps) {
2464 my $instance = $class->components->{ $component } = $class->setup_component($component);
2465 my @expanded_components = $instance->can('expand_modules')
2466 ? $instance->expand_modules( $component, $config )
2467 : $class->expand_component_module( $component, $config );
2468 for my $component (@expanded_components) {
2469 next if $comps{$component};
2470 $class->components->{ $component } = $class->setup_component($component);
2475 =head2 $c->locate_components( $setup_component_config )
2477 This method is meant to provide a list of component modules that should be
2478 setup for the application. By default, it will use L<Module::Pluggable>.
2480 Specify a C<setup_components> config option to pass additional options directly
2481 to L<Module::Pluggable>. To add additional search paths, specify a key named
2482 C<search_extra> as an array reference. Items in the array beginning with C<::>
2483 will have the application class name prepended to them.
2487 sub locate_components {
2491 my @paths = qw( ::Controller ::C ::Model ::M ::View ::V );
2492 my $extra = delete $config->{ search_extra } || [];
2494 push @paths, @$extra;
2496 my $locator = Module::Pluggable::Object->new(
2497 search_path => [ map { s/^(?=::)/$class/; $_; } @paths ],
2501 # XXX think about ditching this sort entirely
2502 my @comps = sort { length $a <=> length $b } $locator->plugins;
2507 =head2 $c->expand_component_module( $component, $setup_component_config )
2509 Components found by C<locate_components> will be passed to this method, which
2510 is expected to return a list of component (package) names to be set up.
2514 sub expand_component_module {
2515 my ($class, $module) = @_;
2516 return Devel::InnerPackage::list_packages( $module );
2519 =head2 $c->setup_component
2523 sub setup_component {
2524 my( $class, $component ) = @_;
2526 unless ( $component->can( 'COMPONENT' ) ) {
2530 my $suffix = Catalyst::Utils::class2classsuffix( $component );
2531 my $config = $class->config->{ $suffix } || {};
2532 # Stash catalyst_component_name in the config here, so that custom COMPONENT
2533 # methods also pass it. local to avoid pointlessly shitting in config
2534 # for the debug screen, as $component is already the key name.
2535 local $config->{catalyst_component_name} = $component;
2537 my $instance = eval { $component->COMPONENT( $class, $config ); };
2539 if ( my $error = $@ ) {
2541 Catalyst::Exception->throw(
2542 message => qq/Couldn't instantiate component "$component", "$error"/
2546 unless (blessed $instance) {
2547 my $metaclass = Moose::Util::find_meta($component);
2548 my $method_meta = $metaclass->find_method_by_name('COMPONENT');
2549 my $component_method_from = $method_meta->associated_metaclass->name;
2550 my $value = defined($instance) ? $instance : 'undef';
2551 Catalyst::Exception->throw(
2553 qq/Couldn't instantiate component "$component", COMPONENT() method (from $component_method_from) didn't return an object-like value (value was $value)./
2559 =head2 $c->setup_dispatcher
2565 sub setup_dispatcher {
2566 my ( $class, $dispatcher ) = @_;
2569 $dispatcher = 'Catalyst::Dispatcher::' . $dispatcher;
2572 if ( my $env = Catalyst::Utils::env_value( $class, 'DISPATCHER' ) ) {
2573 $dispatcher = 'Catalyst::Dispatcher::' . $env;
2576 unless ($dispatcher) {
2577 $dispatcher = $class->dispatcher_class;
2580 Class::MOP::load_class($dispatcher);
2582 # dispatcher instance
2583 $class->dispatcher( $dispatcher->new );
2586 =head2 $c->setup_engine
2595 my $engine = $class->engine_class;
2596 Class::MOP::load_class($engine);
2598 if ($ENV{MOD_PERL}) {
2599 require 'Catalyst/Engine/Loader.pm';
2600 my $apache = Catalyst::Engine::Loader->auto;
2602 $class->meta->add_method(handler => sub {
2604 my $app = $class->psgi_app;
2605 $apache->call_app($r, $app);
2609 $class->engine( $engine->new );
2616 Builds a PSGI application coderef for the catalyst application C<$c> using
2617 L</"$c->setup_psgi_app">, stores it internally, and returns it. On the next call
2618 to this method, C<setup_psgi_app> won't be invoked again, but its persisted
2619 return value of it will be returned.
2621 This is the top-level entrypoint for things that need a full blown Catalyst PSGI
2622 app. If you only need the raw PSGI application, without any middlewares, use
2623 L</"$c->raw_psgi_app"> instead.
2630 unless ($app->_psgi_app) {
2631 my $psgi_app = $app->setup_psgi_app;
2632 $app->_psgi_app($psgi_app);
2635 return $app->_psgi_app;
2638 =head2 $c->setup_psgi_app
2640 Builds a PSGI application coderef for the catalyst application C<$c>.
2642 If we're able to locate a C<${myapp}.psgi> file in the applications home
2643 directory, we'll use that to obtain our code reference.
2645 Otherwise the raw psgi app, without any middlewares is created using
2646 C<raw_psgi_app> and wrapped into L<Plack::Middleware::ReverseProxy>
2647 conditionally. See L</"PROXY SUPPORT">.
2651 sub setup_psgi_app {
2654 if (my $home = Path::Class::Dir->new($app->config->{home})) {
2655 my $psgi_file = $home->file(
2656 Catalyst::Utils::appprefix($app) . '.psgi',
2659 return Plack::Util::load_psgi($psgi_file)
2663 # Note - this is for back compatibility. Catalyst should not know
2664 # or care about how it's deployed. The recommended way of
2665 # configuring this is now to use the ReverseProxy middleware
2666 # yourself if you want it in a .psgi file.
2667 return Plack::Middleware::Conditional->wrap(
2669 builder => sub { Plack::Middleware::ReverseProxy->wrap($_[0]) },
2672 return if $app->config->{ignore_frontend_proxy};
2673 return $env->{REMOTE_ADDR} eq '127.0.0.1'
2674 || $app->config->{using_frontend_proxy};
2679 =head2 $c->raw_psgi_app
2681 Returns a PSGI application code reference for the catalyst application
2682 C<$c>. This is the bare application without any middlewares
2683 applied. C<${myapp}.psgi> is not taken into account. See
2684 L</"$c->setup_psgi_app">.
2690 return $app->engine->build_psgi_app($app);
2693 =head2 $c->setup_home
2695 Sets up the home directory.
2700 my ( $class, $home ) = @_;
2702 if ( my $env = Catalyst::Utils::env_value( $class, 'HOME' ) ) {
2706 $home ||= Catalyst::Utils::home($class);
2709 #I remember recently being scolded for assigning config values like this
2710 $class->config->{home} ||= $home;
2711 $class->config->{root} ||= Path::Class::Dir->new($home)->subdir('root');
2715 =head2 $c->setup_log
2717 Sets up log by instantiating a L<Catalyst::Log|Catalyst::Log> object and
2718 passing it to C<log()>. Pass in a comma-delimited list of levels to set the
2721 This method also installs a C<debug> method that returns a true value into the
2722 catalyst subclass if the "debug" level is passed in the comma-delimited list,
2723 or if the C<$CATALYST_DEBUG> environment variable is set to a true value.
2725 Note that if the log has already been setup, by either a previous call to
2726 C<setup_log> or by a call such as C<< __PACKAGE__->log( MyLogger->new ) >>,
2727 that this method won't actually set up the log object.
2732 my ( $class, $levels ) = @_;
2735 $levels =~ s/^\s+//;
2736 $levels =~ s/\s+$//;
2737 my %levels = map { $_ => 1 } split /\s*,\s*/, $levels;
2739 my $env_debug = Catalyst::Utils::env_value( $class, 'DEBUG' );
2740 if ( defined $env_debug ) {
2741 $levels{debug} = 1 if $env_debug; # Ugly!
2742 delete($levels{debug}) unless $env_debug;
2745 unless ( $class->log ) {
2746 $class->log( Catalyst::Log->new(keys %levels) );
2749 if ( $levels{debug} ) {
2750 Class::MOP::get_metaclass_by_name($class)->add_method('debug' => sub { 1 });
2751 $class->log->debug('Debug messages enabled');
2755 =head2 $c->setup_plugins
2761 =head2 $c->setup_stats
2763 Sets up timing statistics class.
2768 my ( $class, $stats ) = @_;
2770 Catalyst::Utils::ensure_class_loaded($class->stats_class);
2772 my $env = Catalyst::Utils::env_value( $class, 'STATS' );
2773 if ( defined($env) ? $env : ($stats || $class->debug ) ) {
2774 Class::MOP::get_metaclass_by_name($class)->add_method('use_stats' => sub { 1 });
2775 $class->log->debug('Statistics enabled');
2780 =head2 $c->registered_plugins
2782 Returns a sorted list of the plugins which have either been stated in the
2783 import list or which have been added via C<< MyApp->plugin(@args); >>.
2785 If passed a given plugin name, it will report a boolean value indicating
2786 whether or not that plugin is loaded. A fully qualified name is required if
2787 the plugin name does not begin with C<Catalyst::Plugin::>.
2789 if ($c->registered_plugins('Some::Plugin')) {
2797 sub registered_plugins {
2799 return sort keys %{ $proto->_plugins } unless @_;
2801 return 1 if exists $proto->_plugins->{$plugin};
2802 return exists $proto->_plugins->{"Catalyst::Plugin::$plugin"};
2805 sub _register_plugin {
2806 my ( $proto, $plugin, $instant ) = @_;
2807 my $class = ref $proto || $proto;
2809 Class::MOP::load_class( $plugin );
2810 $class->log->warn( "$plugin inherits from 'Catalyst::Component' - this is decated and will not work in 5.81" )
2811 if $plugin->isa( 'Catalyst::Component' );
2812 $proto->_plugins->{$plugin} = 1;
2814 my $meta = Class::MOP::get_metaclass_by_name($class);
2815 $meta->superclasses($plugin, $meta->superclasses);
2821 my ( $class, $plugins ) = @_;
2823 $class->_plugins( {} ) unless $class->_plugins;
2824 $plugins = Data::OptList::mkopt($plugins || []);
2827 [ Catalyst::Utils::resolve_namespace(
2828 $class . '::Plugin',
2829 'Catalyst::Plugin', $_->[0]
2835 for my $plugin ( reverse @plugins ) {
2836 Class::MOP::load_class($plugin->[0], $plugin->[1]);
2837 my $meta = find_meta($plugin->[0]);
2838 next if $meta && $meta->isa('Moose::Meta::Role');
2840 $class->_register_plugin($plugin->[0]);
2844 map { $_->[0]->name, $_->[1] }
2845 grep { blessed($_->[0]) && $_->[0]->isa('Moose::Meta::Role') }
2846 map { [find_meta($_->[0]), $_->[1]] }
2849 Moose::Util::apply_all_roles(
2857 Returns an arrayref of the internal execution stack (actions that are
2858 currently executing).
2862 Returns the current timing statistics object. By default Catalyst uses
2863 L<Catalyst::Stats|Catalyst::Stats>, but can be set otherwise with
2864 L<< stats_class|/"$c->stats_class" >>.
2866 Even if L<< -Stats|/"-Stats" >> is not enabled, the stats object is still
2867 available. By enabling it with C< $c->stats->enabled(1) >, it can be used to
2868 profile explicitly, although MyApp.pm still won't profile nor output anything
2871 =head2 $c->stats_class
2873 Returns or sets the stats (timing statistics) class. L<Catalyst::Stats|Catalyst::Stats> is used by default.
2875 =head2 $c->use_stats
2877 Returns 1 when L<< stats collection|/"-Stats" >> is enabled.
2879 Note that this is a static method, not an accessor and should be overridden
2880 by declaring C<sub use_stats { 1 }> in your MyApp.pm, not by calling C<< $c->use_stats(1) >>.
2887 =head2 $c->write( $data )
2889 Writes $data to the output stream. When using this method directly, you
2890 will need to manually set the C<Content-Length> header to the length of
2891 your output data, if known.
2898 # Finalize headers if someone manually writes output
2899 $c->finalize_headers;
2901 return $c->engine->write( $c, @_ );
2906 Returns the Catalyst version number. Mostly useful for "powered by"
2907 messages in template systems.
2911 sub version { return $Catalyst::VERSION }
2913 =head1 CONFIGURATION
2915 There are a number of 'base' config variables which can be set:
2921 C<default_model> - The default model picked if you say C<< $c->model >>. See L<< /$c->model($name) >>.
2925 C<default_view> - The default view to be rendered or returned when C<< $c->view >> is called. See L<< /$c->view($name) >>.
2929 C<disable_component_resolution_regex_fallback> - Turns
2930 off the deprecated component resolution functionality so
2931 that if any of the component methods (e.g. C<< $c->controller('Foo') >>)
2932 are called then regex search will not be attempted on string values and
2933 instead C<undef> will be returned.
2937 C<home> - The application home directory. In an uninstalled application,
2938 this is the top level application directory. In an installed application,
2939 this will be the directory containing C<< MyApp.pm >>.
2943 C<ignore_frontend_proxy> - See L</PROXY SUPPORT>
2947 C<name> - The name of the application in debug messages and the debug and
2952 C<parse_on_demand> - The request body (for example file uploads) will not be parsed
2953 until it is accessed. This allows you to (for example) check authentication (and reject
2954 the upload) before actually recieving all the data. See L</ON-DEMAND PARSER>
2958 C<root> - The root directory for templates. Usually this is just a
2959 subdirectory of the home directory, but you can set it to change the
2960 templates to a different directory.
2964 C<search_extra> - Array reference passed to Module::Pluggable to for additional
2965 namespaces from which components will be loaded (and constructed and stored in
2966 C<< $c->components >>).
2970 C<show_internal_actions> - If true, causes internal actions such as C<< _DISPATCH >>
2971 to be shown in hit debug tables in the test server.
2975 C<use_request_uri_for_path> - Controlls if the C<REQUEST_URI> or C<PATH_INFO> environment
2976 variable should be used for determining the request path. See L<Catalyst::Engine::CGI/PATH DECODING>
2977 for more information.
2981 C<using_frontend_proxy> - See L</PROXY SUPPORT>.
2985 =head1 INTERNAL ACTIONS
2987 Catalyst uses internal actions like C<_DISPATCH>, C<_BEGIN>, C<_AUTO>,
2988 C<_ACTION>, and C<_END>. These are by default not shown in the private
2989 action table, but you can make them visible with a config parameter.
2991 MyApp->config(show_internal_actions => 1);
2993 =head1 ON-DEMAND PARSER
2995 The request body is usually parsed at the beginning of a request,
2996 but if you want to handle input yourself, you can enable on-demand
2997 parsing with a config parameter.
2999 MyApp->config(parse_on_demand => 1);
3001 =head1 PROXY SUPPORT
3003 Many production servers operate using the common double-server approach,
3004 with a lightweight frontend web server passing requests to a larger
3005 backend server. An application running on the backend server must deal
3006 with two problems: the remote user always appears to be C<127.0.0.1> and
3007 the server's hostname will appear to be C<localhost> regardless of the
3008 virtual host that the user connected through.
3010 Catalyst will automatically detect this situation when you are running
3011 the frontend and backend servers on the same machine. The following
3012 changes are made to the request.
3014 $c->req->address is set to the user's real IP address, as read from
3015 the HTTP X-Forwarded-For header.
3017 The host value for $c->req->base and $c->req->uri is set to the real
3018 host, as read from the HTTP X-Forwarded-Host header.
3020 Additionally, you may be running your backend application on an insecure
3021 connection (port 80) while your frontend proxy is running under SSL. If there
3022 is a discrepancy in the ports, use the HTTP header C<X-Forwarded-Port> to
3023 tell Catalyst what port the frontend listens on. This will allow all URIs to
3024 be created properly.
3026 In the case of passing in:
3028 X-Forwarded-Port: 443
3030 All calls to C<uri_for> will result in an https link, as is expected.
3032 Obviously, your web server must support these headers for this to work.
3034 In a more complex server farm environment where you may have your
3035 frontend proxy server(s) on different machines, you will need to set a
3036 configuration option to tell Catalyst to read the proxied data from the
3039 MyApp->config(using_frontend_proxy => 1);
3041 If you do not wish to use the proxy support at all, you may set:
3043 MyApp->config(ignore_frontend_proxy => 1);
3045 =head1 THREAD SAFETY
3047 Catalyst has been tested under Apache 2's threading C<mpm_worker>,
3048 C<mpm_winnt>, and the standalone forking HTTP server on Windows. We
3049 believe the Catalyst core to be thread-safe.
3051 If you plan to operate in a threaded environment, remember that all other
3052 modules you are using must also be thread-safe. Some modules, most notably
3053 L<DBD::SQLite>, are not thread-safe.
3059 Join #catalyst on irc.perl.org.
3063 http://lists.scsys.co.uk/cgi-bin/mailman/listinfo/catalyst
3064 http://lists.scsys.co.uk/cgi-bin/mailman/listinfo/catalyst-dev
3068 http://catalyst.perl.org
3072 http://dev.catalyst.perl.org
3076 =head2 L<Task::Catalyst> - All you need to start with Catalyst
3078 =head2 L<Catalyst::Manual> - The Catalyst Manual
3080 =head2 L<Catalyst::Component>, L<Catalyst::Controller> - Base classes for components
3082 =head2 L<Catalyst::Engine> - Core engine
3084 =head2 L<Catalyst::Log> - Log class.
3086 =head2 L<Catalyst::Request> - Request object
3088 =head2 L<Catalyst::Response> - Response object
3090 =head2 L<Catalyst::Test> - The test suite.
3092 =head1 PROJECT FOUNDER
3094 sri: Sebastian Riedel <sri@cpan.org>
3100 acme: Leon Brocard <leon@astray.com>
3102 abraxxa: Alexander Hartmaier <abraxxa@cpan.org>
3106 Andrew Ford E<lt>A.Ford@ford-mason.co.ukE<gt>
3110 andyg: Andy Grundman <andy@hybridized.org>
3112 audreyt: Audrey Tang
3114 bricas: Brian Cassidy <bricas@cpan.org>
3116 Caelum: Rafael Kitover <rkitover@io.com>
3118 chansen: Christian Hansen
3120 chicks: Christopher Hicks
3122 Chisel Wright C<pause@herlpacker.co.uk>
3124 Danijel Milicevic C<me@danijel.de>
3126 David Kamholz E<lt>dkamholz@cpan.orgE<gt>
3128 David Naughton, C<naughton@umn.edu>
3132 dhoss: Devin Austin <dhoss@cpan.org>
3134 dkubb: Dan Kubb <dan.kubb-cpan@onautopilot.com>
3138 dwc: Daniel Westermann-Clark <danieltwc@cpan.org>
3140 esskar: Sascha Kiefer
3142 fireartist: Carl Franks <cfranks@cpan.org>
3144 frew: Arthur Axel "fREW" Schmidt <frioux@gmail.com>
3146 gabb: Danijel Milicevic
3150 Gavin Henry C<ghenry@perl.me.uk>
3154 groditi: Guillermo Roditi <groditi@gmail.com>
3156 hobbs: Andrew Rodland <andrew@cleverdomain.org>
3158 ilmari: Dagfinn Ilmari Mannsåker <ilmari@ilmari.org>
3160 jcamacho: Juan Camacho
3162 jester: Jesse Sheidlower C<jester@panix.com>
3164 jhannah: Jay Hannah <jay@jays.net>
3170 jon: Jon Schutz <jjschutz@cpan.org>
3172 Jonathan Rockway C<< <jrockway@cpan.org> >>
3174 Kieren Diment C<kd@totaldatasolution.com>
3176 konobi: Scott McWhirter <konobi@cpan.org>
3178 marcus: Marcus Ramberg <mramberg@cpan.org>
3180 miyagawa: Tatsuhiko Miyagawa <miyagawa@bulknews.net>
3182 mst: Matt S. Trout <mst@shadowcatsystems.co.uk>
3186 naughton: David Naughton
3188 ningu: David Kamholz <dkamholz@cpan.org>
3190 nothingmuch: Yuval Kogman <nothingmuch@woobling.org>
3192 numa: Dan Sully <daniel@cpan.org>
3198 omega: Andreas Marienborg
3200 Oleg Kostyuk <cub.uanic@gmail.com>
3202 phaylon: Robert Sedlacek <phaylon@dunkelheit.at>
3204 rafl: Florian Ragwitz <rafl@debian.org>
3206 random: Roland Lammel <lammel@cpan.org>
3208 Robert Sedlacek C<< <rs@474.at> >>
3210 SpiceMan: Marcel Montes
3214 szbalint: Balint Szilakszi <szbalint@cpan.org>
3216 t0m: Tomas Doran <bobtfish@bobtfish.net>
3220 Viljo Marrandi C<vilts@yahoo.com>
3222 Will Hawes C<info@whawes.co.uk>
3224 willert: Sebastian Willert <willert@cpan.org>
3226 wreis: Wallace Reis <wallace@reis.org.br>
3228 Yuval Kogman, C<nothingmuch@woobling.org>
3230 rainboxx: Matthias Dietrich, C<perl@rainboxx.de>
3234 This library is free software. You can redistribute it and/or modify it under
3235 the same terms as Perl itself.
3241 __PACKAGE__->meta->make_immutable;