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;
33 use Catalyst::EngineLoader;
35 use Carp qw/croak carp shortmess/;
38 BEGIN { require 5.008004; }
40 has stack => (is => 'ro', default => sub { [] });
41 has stash => (is => 'rw', default => sub { {} });
42 has state => (is => 'rw', default => 0);
43 has stats => (is => 'rw');
44 has action => (is => 'rw');
45 has counter => (is => 'rw', default => sub { {} });
46 has request => (is => 'rw', default => sub { $_[0]->request_class->new({}) }, required => 1, lazy => 1);
47 has response => (is => 'rw', default => sub { $_[0]->response_class->new({}) }, required => 1, lazy => 1);
48 has namespace => (is => 'rw');
50 sub depth { scalar @{ shift->stack || [] }; }
51 sub comp { shift->component(@_) }
54 my $self = shift; return $self->request(@_);
57 my $self = shift; return $self->response(@_);
60 # For backwards compatibility
61 sub finalize_output { shift->finalize_body(@_) };
66 our $RECURSION = 1000;
67 our $DETACH = Catalyst::Exception::Detach->new;
68 our $GO = Catalyst::Exception::Go->new;
70 #I imagine that very few of these really need to be class variables. if any.
71 #maybe we should just make them attributes with a default?
72 __PACKAGE__->mk_classdata($_)
73 for qw/components arguments dispatcher engine log dispatcher_class
74 engine_loader context_class request_class response_class stats_class
75 setup_finished _psgi_app/;
77 __PACKAGE__->dispatcher_class('Catalyst::Dispatcher');
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 # N.B. This used to be combined, but I have seen $c get clobbered if so, and
1669 # I have no idea how, ergo $ret (which appears to fix the issue)
1670 eval { my $ret = $code->execute( $class, $c, @{ $c->req->args } ) || 0; $c->state( $ret ) };
1672 $c->_stats_finish_execute( $stats_info ) if $c->use_stats and $stats_info;
1674 my $last = pop( @{ $c->stack } );
1676 if ( my $error = $@ ) {
1677 if ( blessed($error) and $error->isa('Catalyst::Exception::Detach') ) {
1678 $error->rethrow if $c->depth > 1;
1680 elsif ( blessed($error) and $error->isa('Catalyst::Exception::Go') ) {
1681 $error->rethrow if $c->depth > 0;
1684 unless ( ref $error ) {
1685 no warnings 'uninitialized';
1687 my $class = $last->class;
1688 my $name = $last->name;
1689 $error = qq/Caught exception in $class->$name "$error"/;
1698 sub _stats_start_execute {
1699 my ( $c, $code ) = @_;
1700 my $appclass = ref($c) || $c;
1701 return if ( ( $code->name =~ /^_.*/ )
1702 && ( !$appclass->config->{show_internal_actions} ) );
1704 my $action_name = $code->reverse();
1705 $c->counter->{$action_name}++;
1707 my $action = $action_name;
1708 $action = "/$action" unless $action =~ /->/;
1710 # determine if the call was the result of a forward
1711 # this is done by walking up the call stack and looking for a calling
1712 # sub of Catalyst::forward before the eval
1714 for my $index ( 2 .. 11 ) {
1716 if ( ( caller($index) )[0] eq 'Catalyst'
1717 && ( caller($index) )[3] eq '(eval)' );
1719 if ( ( caller($index) )[3] =~ /forward$/ ) {
1720 $callsub = ( caller($index) )[3];
1721 $action = "-> $action";
1726 my $uid = $action_name . $c->counter->{$action_name};
1728 # is this a root-level call or a forwarded call?
1729 if ( $callsub =~ /forward$/ ) {
1730 my $parent = $c->stack->[-1];
1732 # forward, locate the caller
1733 if ( defined $parent && exists $c->counter->{"$parent"} ) {
1736 parent => "$parent" . $c->counter->{"$parent"},
1742 # forward with no caller may come from a plugin
1761 sub _stats_finish_execute {
1762 my ( $c, $info ) = @_;
1763 $c->stats->profile( end => $info );
1768 Finalizes the request.
1775 for my $error ( @{ $c->error } ) {
1776 $c->log->error($error);
1779 # Allow engine to handle finalize flow (for POE)
1780 my $engine = $c->engine;
1781 if ( my $code = $engine->can('finalize') ) {
1786 $c->finalize_uploads;
1789 if ( $#{ $c->error } >= 0 ) {
1793 $c->finalize_headers;
1796 if ( $c->request->method eq 'HEAD' ) {
1797 $c->response->body('');
1805 if ($c->use_stats) {
1806 my $elapsed = sprintf '%f', $c->stats->elapsed;
1807 my $av = $elapsed == 0 ? '??' : sprintf '%.3f', 1 / $elapsed;
1809 "Request took ${elapsed}s ($av/s)\n" . $c->stats->report . "\n" );
1812 return $c->response->status;
1815 =head2 $c->finalize_body
1821 sub finalize_body { my $c = shift; $c->engine->finalize_body( $c, @_ ) }
1823 =head2 $c->finalize_cookies
1829 sub finalize_cookies { my $c = shift; $c->engine->finalize_cookies( $c, @_ ) }
1831 =head2 $c->finalize_error
1837 sub finalize_error { my $c = shift; $c->engine->finalize_error( $c, @_ ) }
1839 =head2 $c->finalize_headers
1845 sub finalize_headers {
1848 my $response = $c->response; #accessor calls can add up?
1850 # Check if we already finalized headers
1851 return if $response->finalized_headers;
1854 if ( my $location = $response->redirect ) {
1855 $c->log->debug(qq/Redirecting to "$location"/) if $c->debug;
1856 $response->header( Location => $location );
1858 if ( !$response->has_body ) {
1859 # Add a default body if none is already present
1861 qq{<html><body><p>This item has moved <a href="$location">here</a>.</p></body></html>}
1867 if ( defined $response->body && length $response->body && !$response->content_length ) {
1869 # get the length from a filehandle
1870 if ( blessed( $response->body ) && $response->body->can('read') || ref( $response->body ) eq 'GLOB' )
1872 my $stat = stat $response->body;
1873 if ( $stat && $stat->size > 0 ) {
1874 $response->content_length( $stat->size );
1877 $c->log->warn('Serving filehandle without a content-length');
1881 # everything should be bytes at this point, but just in case
1882 $response->content_length( length( $response->body ) );
1887 if ( $response->status =~ /^(1\d\d|[23]04)$/ ) {
1888 $response->headers->remove_header("Content-Length");
1889 $response->body('');
1892 $c->finalize_cookies;
1894 $c->engine->finalize_headers( $c, @_ );
1897 $response->finalized_headers(1);
1900 =head2 $c->finalize_output
1902 An alias for finalize_body.
1904 =head2 $c->finalize_read
1906 Finalizes the input after reading is complete.
1910 sub finalize_read { my $c = shift; $c->engine->finalize_read( $c, @_ ) }
1912 =head2 $c->finalize_uploads
1914 Finalizes uploads. Cleans up any temporary files.
1918 sub finalize_uploads { my $c = shift; $c->engine->finalize_uploads( $c, @_ ) }
1920 =head2 $c->get_action( $action, $namespace )
1922 Gets an action in a given namespace.
1926 sub get_action { my $c = shift; $c->dispatcher->get_action(@_) }
1928 =head2 $c->get_actions( $action, $namespace )
1930 Gets all actions of a given name in a namespace and all parent
1935 sub get_actions { my $c = shift; $c->dispatcher->get_actions( $c, @_ ) }
1937 =head2 $app->handle_request( @arguments )
1939 Called to handle each HTTP request.
1943 sub handle_request {
1944 my ( $class, @arguments ) = @_;
1946 # Always expect worst case!
1949 if ($class->debug) {
1950 my $secs = time - $START || 1;
1951 my $av = sprintf '%.3f', $COUNT / $secs;
1952 my $time = localtime time;
1953 $class->log->info("*** Request $COUNT ($av/s) [$$] [$time] ***");
1956 my $c = $class->prepare(@arguments);
1958 $status = $c->finalize;
1961 chomp(my $error = $_);
1962 $class->log->error(qq/Caught exception in engine "$error"/);
1967 if(my $coderef = $class->log->can('_flush')){
1968 $class->log->$coderef();
1973 =head2 $c->prepare( @arguments )
1975 Creates a Catalyst context from an engine-specific request (Apache, CGI,
1981 my ( $class, @arguments ) = @_;
1984 # After the app/ctxt split, this should become an attribute based on something passed
1985 # into the application.
1986 $class->context_class( ref $class || $class ) unless $class->context_class;
1988 my $c = $class->context_class->new({});
1990 # For on-demand data
1991 $c->request->_context($c);
1992 $c->response->_context($c);
1994 #surely this is not the most efficient way to do things...
1995 $c->stats($class->stats_class->new)->enable($c->use_stats);
1996 if ( $c->debug || $c->config->{enable_catalyst_header} ) {
1997 $c->res->headers->header( 'X-Catalyst' => $Catalyst::VERSION );
2001 # Allow engine to direct the prepare flow (for POE)
2002 if ( my $prepare = $c->engine->can('prepare') ) {
2003 $c->engine->$prepare( $c, @arguments );
2006 $c->prepare_request(@arguments);
2007 $c->prepare_connection;
2008 $c->prepare_query_parameters;
2009 $c->prepare_headers;
2010 $c->prepare_cookies;
2013 # Prepare the body for reading, either by prepare_body
2014 # or the user, if they are using $c->read
2017 # Parse the body unless the user wants it on-demand
2018 unless ( ref($c)->config->{parse_on_demand} ) {
2023 # VERY ugly and probably shouldn't rely on ->finalize actually working
2025 # failed prepare is always due to an invalid request, right?
2026 $c->response->status(400);
2027 $c->response->content_type('text/plain');
2028 $c->response->body('Bad Request');
2033 my $method = $c->req->method || '';
2034 my $path = $c->req->path;
2035 $path = '/' unless length $path;
2036 my $address = $c->req->address || '';
2045 =head2 $c->prepare_action
2047 Prepares action. See L<Catalyst::Dispatcher>.
2051 sub prepare_action { my $c = shift; $c->dispatcher->prepare_action( $c, @_ ) }
2053 =head2 $c->prepare_body
2055 Prepares message body.
2062 return if $c->request->_has_body;
2064 # Initialize on-demand data
2065 $c->engine->prepare_body( $c, @_ );
2066 $c->prepare_parameters;
2067 $c->prepare_uploads;
2070 =head2 $c->prepare_body_chunk( $chunk )
2072 Prepares a chunk of data before sending it to L<HTTP::Body>.
2074 See L<Catalyst::Engine>.
2078 sub prepare_body_chunk {
2080 $c->engine->prepare_body_chunk( $c, @_ );
2083 =head2 $c->prepare_body_parameters
2085 Prepares body parameters.
2089 sub prepare_body_parameters {
2091 $c->engine->prepare_body_parameters( $c, @_ );
2094 =head2 $c->prepare_connection
2096 Prepares connection.
2100 sub prepare_connection {
2102 $c->engine->prepare_connection( $c, @_ );
2105 =head2 $c->prepare_cookies
2111 sub prepare_cookies { my $c = shift; $c->engine->prepare_cookies( $c, @_ ) }
2113 =head2 $c->prepare_headers
2119 sub prepare_headers { my $c = shift; $c->engine->prepare_headers( $c, @_ ) }
2121 =head2 $c->prepare_parameters
2123 Prepares parameters.
2127 sub prepare_parameters {
2129 $c->prepare_body_parameters;
2130 $c->engine->prepare_parameters( $c, @_ );
2133 =head2 $c->prepare_path
2135 Prepares path and base.
2139 sub prepare_path { my $c = shift; $c->engine->prepare_path( $c, @_ ) }
2141 =head2 $c->prepare_query_parameters
2143 Prepares query parameters.
2147 sub prepare_query_parameters {
2150 $c->engine->prepare_query_parameters( $c, @_ );
2153 =head2 $c->log_request
2155 Writes information about the request to the debug logs. This includes:
2159 =item * Request method, path, and remote IP address
2161 =item * Query keywords (see L<Catalyst::Request/query_keywords>)
2163 =item * Request parameters
2165 =item * File uploads
2174 return unless $c->debug;
2176 my($dump) = grep {$_->[0] eq 'Request' } $c->dump_these;
2177 my $request = $dump->[1];
2179 my ( $method, $path, $address ) = ( $request->method, $request->path, $request->address );
2181 $path = '/' unless length $path;
2183 $c->log->debug(qq/"$method" request for "$path" from "$address"/);
2185 $c->log_request_headers($request->headers);
2187 if ( my $keywords = $request->query_keywords ) {
2188 $c->log->debug("Query keywords are: $keywords");
2191 $c->log_request_parameters( query => $request->query_parameters, $request->_has_body ? (body => $request->body_parameters) : () );
2193 $c->log_request_uploads($request);
2196 =head2 $c->log_response
2198 Writes information about the response to the debug logs by calling
2199 C<< $c->log_response_status_line >> and C<< $c->log_response_headers >>.
2206 return unless $c->debug;
2208 my($dump) = grep {$_->[0] eq 'Response' } $c->dump_these;
2209 my $response = $dump->[1];
2211 $c->log_response_status_line($response);
2212 $c->log_response_headers($response->headers);
2215 =head2 $c->log_response_status_line($response)
2217 Writes one line of information about the response to the debug logs. This includes:
2221 =item * Response status code
2223 =item * Content-Type header (if present)
2225 =item * Content-Length header (if present)
2231 sub log_response_status_line {
2232 my ($c, $response) = @_;
2236 'Response Code: %s; Content-Type: %s; Content-Length: %s',
2237 $response->status || 'unknown',
2238 $response->headers->header('Content-Type') || 'unknown',
2239 $response->headers->header('Content-Length') || 'unknown'
2244 =head2 $c->log_response_headers($headers);
2246 Hook method which can be wrapped by plugins to log the responseheaders.
2247 No-op in the default implementation.
2251 sub log_response_headers {}
2253 =head2 $c->log_request_parameters( query => {}, body => {} )
2255 Logs request parameters to debug logs
2259 sub log_request_parameters {
2261 my %all_params = @_;
2263 return unless $c->debug;
2265 my $column_width = Catalyst::Utils::term_width() - 44;
2266 foreach my $type (qw(query body)) {
2267 my $params = $all_params{$type};
2268 next if ! keys %$params;
2269 my $t = Text::SimpleTable->new( [ 35, 'Parameter' ], [ $column_width, 'Value' ] );
2270 for my $key ( sort keys %$params ) {
2271 my $param = $params->{$key};
2272 my $value = defined($param) ? $param : '';
2273 $t->row( $key, ref $value eq 'ARRAY' ? ( join ', ', @$value ) : $value );
2275 $c->log->debug( ucfirst($type) . " Parameters are:\n" . $t->draw );
2279 =head2 $c->log_request_uploads
2281 Logs file uploads included in the request to the debug logs.
2282 The parameter name, filename, file type, and file size are all included in
2287 sub log_request_uploads {
2289 my $request = shift;
2290 return unless $c->debug;
2291 my $uploads = $request->uploads;
2292 if ( keys %$uploads ) {
2293 my $t = Text::SimpleTable->new(
2294 [ 12, 'Parameter' ],
2299 for my $key ( sort keys %$uploads ) {
2300 my $upload = $uploads->{$key};
2301 for my $u ( ref $upload eq 'ARRAY' ? @{$upload} : ($upload) ) {
2302 $t->row( $key, $u->filename, $u->type, $u->size );
2305 $c->log->debug( "File Uploads are:\n" . $t->draw );
2309 =head2 $c->log_request_headers($headers);
2311 Hook method which can be wrapped by plugins to log the request headers.
2312 No-op in the default implementation.
2316 sub log_request_headers {}
2318 =head2 $c->log_headers($type => $headers)
2320 Logs L<HTTP::Headers> (either request or response) to the debug logs.
2327 my $headers = shift; # an HTTP::Headers instance
2329 return unless $c->debug;
2331 my $column_width = Catalyst::Utils::term_width() - 28;
2332 my $t = Text::SimpleTable->new( [ 15, 'Header Name' ], [ $column_width, 'Value' ] );
2335 my ( $name, $value ) = @_;
2336 $t->row( $name, $value );
2339 $c->log->debug( ucfirst($type) . " Headers:\n" . $t->draw );
2343 =head2 $c->prepare_read
2345 Prepares the input for reading.
2349 sub prepare_read { my $c = shift; $c->engine->prepare_read( $c, @_ ) }
2351 =head2 $c->prepare_request
2353 Prepares the engine request.
2357 sub prepare_request { my $c = shift; $c->engine->prepare_request( $c, @_ ) }
2359 =head2 $c->prepare_uploads
2365 sub prepare_uploads {
2368 $c->engine->prepare_uploads( $c, @_ );
2371 =head2 $c->prepare_write
2373 Prepares the output for writing.
2377 sub prepare_write { my $c = shift; $c->engine->prepare_write( $c, @_ ) }
2379 =head2 $c->request_class
2381 Returns or sets the request class. Defaults to L<Catalyst::Request>.
2383 =head2 $c->response_class
2385 Returns or sets the response class. Defaults to L<Catalyst::Response>.
2387 =head2 $c->read( [$maxlength] )
2389 Reads a chunk of data from the request body. This method is designed to
2390 be used in a while loop, reading C<$maxlength> bytes on every call.
2391 C<$maxlength> defaults to the size of the request if not specified.
2393 You have to set C<< MyApp->config(parse_on_demand => 1) >> to use this
2396 Warning: If you use read(), Catalyst will not process the body,
2397 so you will not be able to access POST parameters or file uploads via
2398 $c->request. You must handle all body parsing yourself.
2402 sub read { my $c = shift; return $c->engine->read( $c, @_ ) }
2410 sub run { my $c = shift; return $c->engine->run( $c, $c->psgi_app, @_ ) }
2412 =head2 $c->set_action( $action, $code, $namespace, $attrs )
2414 Sets an action in a given namespace.
2418 sub set_action { my $c = shift; $c->dispatcher->set_action( $c, @_ ) }
2420 =head2 $c->setup_actions($component)
2422 Sets up actions for a component.
2426 sub setup_actions { my $c = shift; $c->dispatcher->setup_actions( $c, @_ ) }
2428 =head2 $c->setup_components
2430 This method is called internally to set up the application's components.
2432 It finds modules by calling the L<locate_components> method, expands them to
2433 package names with the L<expand_component_module> method, and then installs
2434 each component into the application.
2436 The C<setup_components> config option is passed to both of the above methods.
2438 Installation of each component is performed by the L<setup_component> method,
2443 sub setup_components {
2446 my $config = $class->config->{ setup_components };
2448 my @comps = $class->locate_components($config);
2449 my %comps = map { $_ => 1 } @comps;
2451 my $deprecatedcatalyst_component_names = grep { /::[CMV]::/ } @comps;
2452 $class->log->warn(qq{Your application is using the deprecated ::[MVC]:: type naming scheme.\n}.
2453 qq{Please switch your class names to ::Model::, ::View:: and ::Controller: as appropriate.\n}
2454 ) if $deprecatedcatalyst_component_names;
2456 for my $component ( @comps ) {
2458 # We pass ignore_loaded here so that overlay files for (e.g.)
2459 # Model::DBI::Schema sub-classes are loaded - if it's in @comps
2460 # we know M::P::O found a file on disk so this is safe
2462 Catalyst::Utils::ensure_class_loaded( $component, { ignore_loaded => 1 } );
2465 for my $component (@comps) {
2466 my $instance = $class->components->{ $component } = $class->setup_component($component);
2467 my @expanded_components = $instance->can('expand_modules')
2468 ? $instance->expand_modules( $component, $config )
2469 : $class->expand_component_module( $component, $config );
2470 for my $component (@expanded_components) {
2471 next if $comps{$component};
2472 $class->components->{ $component } = $class->setup_component($component);
2477 =head2 $c->locate_components( $setup_component_config )
2479 This method is meant to provide a list of component modules that should be
2480 setup for the application. By default, it will use L<Module::Pluggable>.
2482 Specify a C<setup_components> config option to pass additional options directly
2483 to L<Module::Pluggable>. To add additional search paths, specify a key named
2484 C<search_extra> as an array reference. Items in the array beginning with C<::>
2485 will have the application class name prepended to them.
2489 sub locate_components {
2493 my @paths = qw( ::Controller ::C ::Model ::M ::View ::V );
2494 my $extra = delete $config->{ search_extra } || [];
2496 push @paths, @$extra;
2498 my $locator = Module::Pluggable::Object->new(
2499 search_path => [ map { s/^(?=::)/$class/; $_; } @paths ],
2503 # XXX think about ditching this sort entirely
2504 my @comps = sort { length $a <=> length $b } $locator->plugins;
2509 =head2 $c->expand_component_module( $component, $setup_component_config )
2511 Components found by C<locate_components> will be passed to this method, which
2512 is expected to return a list of component (package) names to be set up.
2516 sub expand_component_module {
2517 my ($class, $module) = @_;
2518 return Devel::InnerPackage::list_packages( $module );
2521 =head2 $c->setup_component
2525 sub setup_component {
2526 my( $class, $component ) = @_;
2528 unless ( $component->can( 'COMPONENT' ) ) {
2532 my $suffix = Catalyst::Utils::class2classsuffix( $component );
2533 my $config = $class->config->{ $suffix } || {};
2534 # Stash catalyst_component_name in the config here, so that custom COMPONENT
2535 # methods also pass it. local to avoid pointlessly shitting in config
2536 # for the debug screen, as $component is already the key name.
2537 local $config->{catalyst_component_name} = $component;
2539 my $instance = eval { $component->COMPONENT( $class, $config ); };
2541 if ( my $error = $@ ) {
2543 Catalyst::Exception->throw(
2544 message => qq/Couldn't instantiate component "$component", "$error"/
2548 unless (blessed $instance) {
2549 my $metaclass = Moose::Util::find_meta($component);
2550 my $method_meta = $metaclass->find_method_by_name('COMPONENT');
2551 my $component_method_from = $method_meta->associated_metaclass->name;
2552 my $value = defined($instance) ? $instance : 'undef';
2553 Catalyst::Exception->throw(
2555 qq/Couldn't instantiate component "$component", COMPONENT() method (from $component_method_from) didn't return an object-like value (value was $value)./
2561 =head2 $c->setup_dispatcher
2567 sub setup_dispatcher {
2568 my ( $class, $dispatcher ) = @_;
2571 $dispatcher = 'Catalyst::Dispatcher::' . $dispatcher;
2574 if ( my $env = Catalyst::Utils::env_value( $class, 'DISPATCHER' ) ) {
2575 $dispatcher = 'Catalyst::Dispatcher::' . $env;
2578 unless ($dispatcher) {
2579 $dispatcher = $class->dispatcher_class;
2582 Class::MOP::load_class($dispatcher);
2584 # dispatcher instance
2585 $class->dispatcher( $dispatcher->new );
2588 =head2 $c->setup_engine
2596 $class->engine_loader->catalyst_engine_class(@_);
2602 $class->engine_loader(Catalyst::EngineLoader->new(application_name => $class));
2604 my $engine = $class->engine_class;
2605 Class::MOP::load_class($engine);
2607 if ($ENV{MOD_PERL}) {
2608 my $apache = $class->engine_loader->auto;
2610 $class->meta->add_method(handler => sub {
2612 my $psgi_app = $class->psgi_app;
2613 $apache->call_app($r, $psgi_app);
2617 $class->engine( $engine->new );
2624 Builds a PSGI application coderef for the catalyst application C<$c> using
2625 L</"$c->setup_psgi_app">, stores it internally, and returns it. On the next call
2626 to this method, C<setup_psgi_app> won't be invoked again, but its persisted
2627 return value of it will be returned.
2629 This is the top-level entrypoint for things that need a full blown Catalyst PSGI
2630 app. If you only need the raw PSGI application, without any middlewares, use
2631 L</"$c->raw_psgi_app"> instead.
2638 unless ($app->_psgi_app) {
2639 my $psgi_app = $app->setup_psgi_app;
2640 $app->_psgi_app($psgi_app);
2643 return $app->_psgi_app;
2646 =head2 $c->setup_psgi_app
2648 Builds a PSGI application coderef for the catalyst application C<$c>.
2650 If we're able to locate a C<${myapp}.psgi> file in the applications home
2651 directory, we'll use that to obtain our code reference.
2653 Otherwise the raw psgi app, without any middlewares is created using
2654 C<raw_psgi_app> and wrapped into L<Plack::Middleware::ReverseProxy>
2655 conditionally. See L</"PROXY SUPPORT">.
2659 sub setup_psgi_app {
2662 if (my $home = Path::Class::Dir->new($app->config->{home})) {
2663 my $psgi_file = $home->file(
2664 Catalyst::Utils::appprefix($app) . '.psgi',
2667 return Plack::Util::load_psgi($psgi_file)
2671 # Note - this is for back compatibility. Catalyst should not know
2672 # or care about how it's deployed. The recommended way of
2673 # configuring this is now to use the ReverseProxy middleware
2674 # yourself if you want it in a .psgi file.
2675 return Plack::Middleware::Conditional->wrap(
2677 builder => sub { Plack::Middleware::ReverseProxy->wrap($_[0]) },
2680 return if $app->config->{ignore_frontend_proxy};
2681 return $env->{REMOTE_ADDR} eq '127.0.0.1'
2682 || $app->config->{using_frontend_proxy};
2687 =head2 $c->raw_psgi_app
2689 Returns a PSGI application code reference for the catalyst application
2690 C<$c>. This is the bare application without any middlewares
2691 applied. C<${myapp}.psgi> is not taken into account. See
2692 L</"$c->setup_psgi_app">.
2698 return $app->engine->build_psgi_app($app);
2701 =head2 $c->setup_home
2703 Sets up the home directory.
2708 my ( $class, $home ) = @_;
2710 if ( my $env = Catalyst::Utils::env_value( $class, 'HOME' ) ) {
2714 $home ||= Catalyst::Utils::home($class);
2717 #I remember recently being scolded for assigning config values like this
2718 $class->config->{home} ||= $home;
2719 $class->config->{root} ||= Path::Class::Dir->new($home)->subdir('root');
2723 =head2 $c->setup_log
2725 Sets up log by instantiating a L<Catalyst::Log|Catalyst::Log> object and
2726 passing it to C<log()>. Pass in a comma-delimited list of levels to set the
2729 This method also installs a C<debug> method that returns a true value into the
2730 catalyst subclass if the "debug" level is passed in the comma-delimited list,
2731 or if the C<$CATALYST_DEBUG> environment variable is set to a true value.
2733 Note that if the log has already been setup, by either a previous call to
2734 C<setup_log> or by a call such as C<< __PACKAGE__->log( MyLogger->new ) >>,
2735 that this method won't actually set up the log object.
2740 my ( $class, $levels ) = @_;
2743 $levels =~ s/^\s+//;
2744 $levels =~ s/\s+$//;
2745 my %levels = map { $_ => 1 } split /\s*,\s*/, $levels;
2747 my $env_debug = Catalyst::Utils::env_value( $class, 'DEBUG' );
2748 if ( defined $env_debug ) {
2749 $levels{debug} = 1 if $env_debug; # Ugly!
2750 delete($levels{debug}) unless $env_debug;
2753 unless ( $class->log ) {
2754 $class->log( Catalyst::Log->new(keys %levels) );
2757 if ( $levels{debug} ) {
2758 Class::MOP::get_metaclass_by_name($class)->add_method('debug' => sub { 1 });
2759 $class->log->debug('Debug messages enabled');
2763 =head2 $c->setup_plugins
2769 =head2 $c->setup_stats
2771 Sets up timing statistics class.
2776 my ( $class, $stats ) = @_;
2778 Catalyst::Utils::ensure_class_loaded($class->stats_class);
2780 my $env = Catalyst::Utils::env_value( $class, 'STATS' );
2781 if ( defined($env) ? $env : ($stats || $class->debug ) ) {
2782 Class::MOP::get_metaclass_by_name($class)->add_method('use_stats' => sub { 1 });
2783 $class->log->debug('Statistics enabled');
2788 =head2 $c->registered_plugins
2790 Returns a sorted list of the plugins which have either been stated in the
2791 import list or which have been added via C<< MyApp->plugin(@args); >>.
2793 If passed a given plugin name, it will report a boolean value indicating
2794 whether or not that plugin is loaded. A fully qualified name is required if
2795 the plugin name does not begin with C<Catalyst::Plugin::>.
2797 if ($c->registered_plugins('Some::Plugin')) {
2805 sub registered_plugins {
2807 return sort keys %{ $proto->_plugins } unless @_;
2809 return 1 if exists $proto->_plugins->{$plugin};
2810 return exists $proto->_plugins->{"Catalyst::Plugin::$plugin"};
2813 sub _register_plugin {
2814 my ( $proto, $plugin, $instant ) = @_;
2815 my $class = ref $proto || $proto;
2817 Class::MOP::load_class( $plugin );
2818 $class->log->warn( "$plugin inherits from 'Catalyst::Component' - this is decated and will not work in 5.81" )
2819 if $plugin->isa( 'Catalyst::Component' );
2820 $proto->_plugins->{$plugin} = 1;
2822 my $meta = Class::MOP::get_metaclass_by_name($class);
2823 $meta->superclasses($plugin, $meta->superclasses);
2829 my ( $class, $plugins ) = @_;
2831 $class->_plugins( {} ) unless $class->_plugins;
2832 $plugins = Data::OptList::mkopt($plugins || []);
2835 [ Catalyst::Utils::resolve_namespace(
2836 $class . '::Plugin',
2837 'Catalyst::Plugin', $_->[0]
2843 for my $plugin ( reverse @plugins ) {
2844 Class::MOP::load_class($plugin->[0], $plugin->[1]);
2845 my $meta = find_meta($plugin->[0]);
2846 next if $meta && $meta->isa('Moose::Meta::Role');
2848 $class->_register_plugin($plugin->[0]);
2852 map { $_->[0]->name, $_->[1] }
2853 grep { blessed($_->[0]) && $_->[0]->isa('Moose::Meta::Role') }
2854 map { [find_meta($_->[0]), $_->[1]] }
2857 Moose::Util::apply_all_roles(
2865 Returns an arrayref of the internal execution stack (actions that are
2866 currently executing).
2870 Returns the current timing statistics object. By default Catalyst uses
2871 L<Catalyst::Stats|Catalyst::Stats>, but can be set otherwise with
2872 L<< stats_class|/"$c->stats_class" >>.
2874 Even if L<< -Stats|/"-Stats" >> is not enabled, the stats object is still
2875 available. By enabling it with C< $c->stats->enabled(1) >, it can be used to
2876 profile explicitly, although MyApp.pm still won't profile nor output anything
2879 =head2 $c->stats_class
2881 Returns or sets the stats (timing statistics) class. L<Catalyst::Stats|Catalyst::Stats> is used by default.
2883 =head2 $c->use_stats
2885 Returns 1 when L<< stats collection|/"-Stats" >> is enabled.
2887 Note that this is a static method, not an accessor and should be overridden
2888 by declaring C<sub use_stats { 1 }> in your MyApp.pm, not by calling C<< $c->use_stats(1) >>.
2895 =head2 $c->write( $data )
2897 Writes $data to the output stream. When using this method directly, you
2898 will need to manually set the C<Content-Length> header to the length of
2899 your output data, if known.
2906 # Finalize headers if someone manually writes output
2907 $c->finalize_headers;
2909 return $c->engine->write( $c, @_ );
2914 Returns the Catalyst version number. Mostly useful for "powered by"
2915 messages in template systems.
2919 sub version { return $Catalyst::VERSION }
2921 =head1 CONFIGURATION
2923 There are a number of 'base' config variables which can be set:
2929 C<default_model> - The default model picked if you say C<< $c->model >>. See L<< /$c->model($name) >>.
2933 C<default_view> - The default view to be rendered or returned when C<< $c->view >> is called. See L<< /$c->view($name) >>.
2937 C<disable_component_resolution_regex_fallback> - Turns
2938 off the deprecated component resolution functionality so
2939 that if any of the component methods (e.g. C<< $c->controller('Foo') >>)
2940 are called then regex search will not be attempted on string values and
2941 instead C<undef> will be returned.
2945 C<home> - The application home directory. In an uninstalled application,
2946 this is the top level application directory. In an installed application,
2947 this will be the directory containing C<< MyApp.pm >>.
2951 C<ignore_frontend_proxy> - See L</PROXY SUPPORT>
2955 C<name> - The name of the application in debug messages and the debug and
2960 C<parse_on_demand> - The request body (for example file uploads) will not be parsed
2961 until it is accessed. This allows you to (for example) check authentication (and reject
2962 the upload) before actually recieving all the data. See L</ON-DEMAND PARSER>
2966 C<root> - The root directory for templates. Usually this is just a
2967 subdirectory of the home directory, but you can set it to change the
2968 templates to a different directory.
2972 C<search_extra> - Array reference passed to Module::Pluggable to for additional
2973 namespaces from which components will be loaded (and constructed and stored in
2974 C<< $c->components >>).
2978 C<show_internal_actions> - If true, causes internal actions such as C<< _DISPATCH >>
2979 to be shown in hit debug tables in the test server.
2983 C<use_request_uri_for_path> - Controlls if the C<REQUEST_URI> or C<PATH_INFO> environment
2984 variable should be used for determining the request path. See L<Catalyst::Engine::CGI/PATH DECODING>
2985 for more information.
2989 C<using_frontend_proxy> - See L</PROXY SUPPORT>.
2993 =head1 INTERNAL ACTIONS
2995 Catalyst uses internal actions like C<_DISPATCH>, C<_BEGIN>, C<_AUTO>,
2996 C<_ACTION>, and C<_END>. These are by default not shown in the private
2997 action table, but you can make them visible with a config parameter.
2999 MyApp->config(show_internal_actions => 1);
3001 =head1 ON-DEMAND PARSER
3003 The request body is usually parsed at the beginning of a request,
3004 but if you want to handle input yourself, you can enable on-demand
3005 parsing with a config parameter.
3007 MyApp->config(parse_on_demand => 1);
3009 =head1 PROXY SUPPORT
3011 Many production servers operate using the common double-server approach,
3012 with a lightweight frontend web server passing requests to a larger
3013 backend server. An application running on the backend server must deal
3014 with two problems: the remote user always appears to be C<127.0.0.1> and
3015 the server's hostname will appear to be C<localhost> regardless of the
3016 virtual host that the user connected through.
3018 Catalyst will automatically detect this situation when you are running
3019 the frontend and backend servers on the same machine. The following
3020 changes are made to the request.
3022 $c->req->address is set to the user's real IP address, as read from
3023 the HTTP X-Forwarded-For header.
3025 The host value for $c->req->base and $c->req->uri is set to the real
3026 host, as read from the HTTP X-Forwarded-Host header.
3028 Additionally, you may be running your backend application on an insecure
3029 connection (port 80) while your frontend proxy is running under SSL. If there
3030 is a discrepancy in the ports, use the HTTP header C<X-Forwarded-Port> to
3031 tell Catalyst what port the frontend listens on. This will allow all URIs to
3032 be created properly.
3034 In the case of passing in:
3036 X-Forwarded-Port: 443
3038 All calls to C<uri_for> will result in an https link, as is expected.
3040 Obviously, your web server must support these headers for this to work.
3042 In a more complex server farm environment where you may have your
3043 frontend proxy server(s) on different machines, you will need to set a
3044 configuration option to tell Catalyst to read the proxied data from the
3047 MyApp->config(using_frontend_proxy => 1);
3049 If you do not wish to use the proxy support at all, you may set:
3051 MyApp->config(ignore_frontend_proxy => 1);
3053 =head1 THREAD SAFETY
3055 Catalyst has been tested under Apache 2's threading C<mpm_worker>,
3056 C<mpm_winnt>, and the standalone forking HTTP server on Windows. We
3057 believe the Catalyst core to be thread-safe.
3059 If you plan to operate in a threaded environment, remember that all other
3060 modules you are using must also be thread-safe. Some modules, most notably
3061 L<DBD::SQLite>, are not thread-safe.
3067 Join #catalyst on irc.perl.org.
3071 http://lists.scsys.co.uk/cgi-bin/mailman/listinfo/catalyst
3072 http://lists.scsys.co.uk/cgi-bin/mailman/listinfo/catalyst-dev
3076 http://catalyst.perl.org
3080 http://dev.catalyst.perl.org
3084 =head2 L<Task::Catalyst> - All you need to start with Catalyst
3086 =head2 L<Catalyst::Manual> - The Catalyst Manual
3088 =head2 L<Catalyst::Component>, L<Catalyst::Controller> - Base classes for components
3090 =head2 L<Catalyst::Engine> - Core engine
3092 =head2 L<Catalyst::Log> - Log class.
3094 =head2 L<Catalyst::Request> - Request object
3096 =head2 L<Catalyst::Response> - Response object
3098 =head2 L<Catalyst::Test> - The test suite.
3100 =head1 PROJECT FOUNDER
3102 sri: Sebastian Riedel <sri@cpan.org>
3108 acme: Leon Brocard <leon@astray.com>
3110 abraxxa: Alexander Hartmaier <abraxxa@cpan.org>
3114 Andrew Ford E<lt>A.Ford@ford-mason.co.ukE<gt>
3118 andyg: Andy Grundman <andy@hybridized.org>
3120 audreyt: Audrey Tang
3122 bricas: Brian Cassidy <bricas@cpan.org>
3124 Caelum: Rafael Kitover <rkitover@io.com>
3126 chansen: Christian Hansen
3128 chicks: Christopher Hicks
3130 Chisel Wright C<pause@herlpacker.co.uk>
3132 Danijel Milicevic C<me@danijel.de>
3134 David Kamholz E<lt>dkamholz@cpan.orgE<gt>
3136 David Naughton, C<naughton@umn.edu>
3140 dhoss: Devin Austin <dhoss@cpan.org>
3142 dkubb: Dan Kubb <dan.kubb-cpan@onautopilot.com>
3146 dwc: Daniel Westermann-Clark <danieltwc@cpan.org>
3148 esskar: Sascha Kiefer
3150 fireartist: Carl Franks <cfranks@cpan.org>
3152 frew: Arthur Axel "fREW" Schmidt <frioux@gmail.com>
3154 gabb: Danijel Milicevic
3158 Gavin Henry C<ghenry@perl.me.uk>
3162 groditi: Guillermo Roditi <groditi@gmail.com>
3164 hobbs: Andrew Rodland <andrew@cleverdomain.org>
3166 ilmari: Dagfinn Ilmari Mannsåker <ilmari@ilmari.org>
3168 jcamacho: Juan Camacho
3170 jester: Jesse Sheidlower C<jester@panix.com>
3172 jhannah: Jay Hannah <jay@jays.net>
3178 jon: Jon Schutz <jjschutz@cpan.org>
3180 Jonathan Rockway C<< <jrockway@cpan.org> >>
3182 Kieren Diment C<kd@totaldatasolution.com>
3184 konobi: Scott McWhirter <konobi@cpan.org>
3186 marcus: Marcus Ramberg <mramberg@cpan.org>
3188 miyagawa: Tatsuhiko Miyagawa <miyagawa@bulknews.net>
3190 mst: Matt S. Trout <mst@shadowcatsystems.co.uk>
3194 naughton: David Naughton
3196 ningu: David Kamholz <dkamholz@cpan.org>
3198 nothingmuch: Yuval Kogman <nothingmuch@woobling.org>
3200 numa: Dan Sully <daniel@cpan.org>
3206 omega: Andreas Marienborg
3208 Oleg Kostyuk <cub.uanic@gmail.com>
3210 phaylon: Robert Sedlacek <phaylon@dunkelheit.at>
3212 rafl: Florian Ragwitz <rafl@debian.org>
3214 random: Roland Lammel <lammel@cpan.org>
3216 Robert Sedlacek C<< <rs@474.at> >>
3218 SpiceMan: Marcel Montes
3222 szbalint: Balint Szilakszi <szbalint@cpan.org>
3224 t0m: Tomas Doran <bobtfish@bobtfish.net>
3228 Viljo Marrandi C<vilts@yahoo.com>
3230 Will Hawes C<info@whawes.co.uk>
3232 willert: Sebastian Willert <willert@cpan.org>
3234 wreis: Wallace Reis <wallace@reis.org.br>
3236 Yuval Kogman, C<nothingmuch@woobling.org>
3238 rainboxx: Matthias Dietrich, C<perl@rainboxx.de>
3240 dd070: Dhaval Dhanani <dhaval070@gmail.com>
3244 This library is free software. You can redistribute it and/or modify it under
3245 the same terms as Perl itself.
3251 __PACKAGE__->meta->make_immutable;