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.80024';
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 $meta->add_method(meta => sub { Moose::Meta::Class->initialize("${caller}") } );
108 $caller->arguments( [@arguments] );
112 sub _application { $_[0] }
116 Catalyst - The Elegant MVC Web Application Framework
120 See the L<Catalyst::Manual> distribution for comprehensive
121 documentation and tutorials.
123 # Install Catalyst::Devel for helpers and other development tools
124 # use the helper to create a new application
127 # add models, views, controllers
128 script/myapp_create.pl model MyDatabase DBIC::Schema create=static dbi:SQLite:/path/to/db
129 script/myapp_create.pl view MyTemplate TT
130 script/myapp_create.pl controller Search
132 # built in testserver -- use -r to restart automatically on changes
133 # --help to see all available options
134 script/myapp_server.pl
136 # command line testing interface
137 script/myapp_test.pl /yada
140 use Catalyst qw/-Debug/; # include plugins here as well
142 ### In lib/MyApp/Controller/Root.pm (autocreated)
143 sub foo : Global { # called for /foo, /foo/1, /foo/1/2, etc.
144 my ( $self, $c, @args ) = @_; # args are qw/1 2/ for /foo/1/2
145 $c->stash->{template} = 'foo.tt'; # set the template
146 # lookup something from db -- stash vars are passed to TT
148 $c->model('Database::Foo')->search( { country => $args[0] } );
149 if ( $c->req->params->{bar} ) { # access GET or POST parameters
150 $c->forward( 'bar' ); # process another action
151 # do something else after forward returns
155 # The foo.tt TT template can use the stash data from the database
156 [% WHILE (item = data.next) %]
160 # called for /bar/of/soap, /bar/of/soap/10, etc.
161 sub bar : Path('/bar/of/soap') { ... }
163 # called for all actions, from the top-most controller downwards
165 my ( $self, $c ) = @_;
166 if ( !$c->user_exists ) { # Catalyst::Plugin::Authentication
167 $c->res->redirect( '/login' ); # require login
168 return 0; # abort request and go immediately to end()
170 return 1; # success; carry on to next action
173 # called after all actions are finished
175 my ( $self, $c ) = @_;
176 if ( scalar @{ $c->error } ) { ... } # handle errors
177 return if $c->res->body; # already have a response
178 $c->forward( 'MyApp::View::TT' ); # render template
181 ### in MyApp/Controller/Foo.pm
182 # called for /foo/bar
183 sub bar : Local { ... }
185 # called for /blargle
186 sub blargle : Global { ... }
188 # an index action matches /foo, but not /foo/1, etc.
189 sub index : Private { ... }
191 ### in MyApp/Controller/Foo/Bar.pm
192 # called for /foo/bar/baz
193 sub baz : Local { ... }
195 # first Root auto is called, then Foo auto, then this
196 sub auto : Private { ... }
198 # powerful regular expression paths are also possible
199 sub details : Regex('^product/(\w+)/details$') {
200 my ( $self, $c ) = @_;
201 # extract the (\w+) from the URI
202 my $product = $c->req->captures->[0];
205 See L<Catalyst::Manual::Intro> for additional information.
209 Catalyst is a modern framework for making web applications without the
210 pain usually associated with this process. This document is a reference
211 to the main Catalyst application. If you are a new user, we suggest you
212 start with L<Catalyst::Manual::Tutorial> or L<Catalyst::Manual::Intro>.
214 See L<Catalyst::Manual> for more documentation.
216 Catalyst plugins can be loaded by naming them as arguments to the "use
217 Catalyst" statement. Omit the C<Catalyst::Plugin::> prefix from the
218 plugin name, i.e., C<Catalyst::Plugin::My::Module> becomes
221 use Catalyst qw/My::Module/;
223 If your plugin starts with a name other than C<Catalyst::Plugin::>, you can
224 fully qualify the name by using a unary plus:
228 +Fully::Qualified::Plugin::Name
231 Special flags like C<-Debug> and C<-Engine> can also be specified as
232 arguments when Catalyst is loaded:
234 use Catalyst qw/-Debug My::Module/;
236 The position of plugins and flags in the chain is important, because
237 they are loaded in the order in which they appear.
239 The following flags are supported:
243 Enables debug output. You can also force this setting from the system
244 environment with CATALYST_DEBUG or <MYAPP>_DEBUG. The environment
245 settings override the application, with <MYAPP>_DEBUG having the highest
248 This sets the log level to 'debug' and enables full debug output on the
249 error screen. If you only want the latter, see L<< $c->debug >>.
253 Forces Catalyst to use a specific engine. Omit the
254 C<Catalyst::Engine::> prefix of the engine name, i.e.:
256 use Catalyst qw/-Engine=CGI/;
260 Forces Catalyst to use a specific home directory, e.g.:
262 use Catalyst qw[-Home=/usr/mst];
264 This can also be done in the shell environment by setting either the
265 C<CATALYST_HOME> environment variable or C<MYAPP_HOME>; where C<MYAPP>
266 is replaced with the uppercased name of your application, any "::" in
267 the name will be replaced with underscores, e.g. MyApp::Web should use
268 MYAPP_WEB_HOME. If both variables are set, the MYAPP_HOME one will be used.
270 If none of these are set, Catalyst will attempt to automatically detect the
271 home directory. If you are working in a development envirnoment, Catalyst
272 will try and find the directory containing either Makefile.PL, Build.PL or
273 dist.ini. If the application has been installed into the system (i.e.
274 you have done C<make install>), then Catalyst will use the path to your
275 application module, without the .pm extension (ie, /foo/MyApp if your
276 application was installed at /foo/MyApp.pm)
280 use Catalyst '-Log=warn,fatal,error';
282 Specifies a comma-delimited list of log levels.
286 Enables statistics collection and reporting.
288 use Catalyst qw/-Stats=1/;
290 You can also force this setting from the system environment with CATALYST_STATS
291 or <MYAPP>_STATS. The environment settings override the application, with
292 <MYAPP>_STATS having the highest priority.
294 Stats are also enabled if L<< debugging |/"-Debug" >> is enabled.
298 =head2 INFORMATION ABOUT THE CURRENT REQUEST
302 Returns a L<Catalyst::Action> object for the current action, which
303 stringifies to the action name. See L<Catalyst::Action>.
307 Returns the namespace of the current action, i.e., the URI prefix
308 corresponding to the controller of the current action. For example:
310 # in Controller::Foo::Bar
311 $c->namespace; # returns 'foo/bar';
317 Returns the current L<Catalyst::Request> object, giving access to
318 information about the current client request (including parameters,
319 cookies, HTTP headers, etc.). See L<Catalyst::Request>.
321 =head2 REQUEST FLOW HANDLING
323 =head2 $c->forward( $action [, \@arguments ] )
325 =head2 $c->forward( $class, $method, [, \@arguments ] )
327 Forwards processing to another action, by its private name. If you give a
328 class name but no method, C<process()> is called. You may also optionally
329 pass arguments in an arrayref. The action will receive the arguments in
330 C<@_> and C<< $c->req->args >>. Upon returning from the function,
331 C<< $c->req->args >> will be restored to the previous values.
333 Any data C<return>ed from the action forwarded to, will be returned by the
336 my $foodata = $c->forward('/foo');
337 $c->forward('index');
338 $c->forward(qw/Model::DBIC::Foo do_stuff/);
339 $c->forward('View::TT');
341 Note that L<< forward|/"$c->forward( $action [, \@arguments ] )" >> implies
342 an C<< eval { } >> around the call (actually
343 L<< execute|/"$c->execute( $class, $coderef )" >> does), thus de-fatalizing
344 all 'dies' within the called action. If you want C<die> to propagate you
345 need to do something like:
348 die join "\n", @{ $c->error } if @{ $c->error };
350 Or make sure to always return true values from your actions and write
353 $c->forward('foo') || return;
355 Another note is that C<< $c->forward >> always returns a scalar because it
356 actually returns $c->state which operates in a scalar context.
357 Thus, something like:
361 in an action that is forwarded to is going to return a scalar,
362 i.e. how many items are in that array, which is probably not what you want.
363 If you need to return an array then return a reference to it,
366 $c->stash->{array} = \@array;
368 and access it from the stash.
372 sub forward { my $c = shift; no warnings 'recursion'; $c->dispatcher->forward( $c, @_ ) }
374 =head2 $c->detach( $action [, \@arguments ] )
376 =head2 $c->detach( $class, $method, [, \@arguments ] )
380 The same as L<< forward|/"$c->forward( $action [, \@arguments ] )" >>, but
381 doesn't return to the previous action when processing is finished.
383 When called with no arguments it escapes the processing chain entirely.
387 sub detach { my $c = shift; $c->dispatcher->detach( $c, @_ ) }
389 =head2 $c->visit( $action [, \@captures, \@arguments ] )
391 =head2 $c->visit( $class, $method, [, \@captures, \@arguments ] )
393 Almost the same as L<< forward|/"$c->forward( $action [, \@arguments ] )" >>,
394 but does a full dispatch, instead of just calling the new C<$action> /
395 C<< $class->$method >>. This means that C<begin>, C<auto> and the method
396 you go to are called, just like a new request.
398 In addition both C<< $c->action >> and C<< $c->namespace >> are localized.
399 This means, for example, that C<< $c->action >> methods such as
400 L<name|Catalyst::Action/name>, L<class|Catalyst::Action/class> and
401 L<reverse|Catalyst::Action/reverse> return information for the visited action
402 when they are invoked within the visited action. This is different from the
403 behavior of L<< forward|/"$c->forward( $action [, \@arguments ] )" >>, which
404 continues to use the $c->action object from the caller action even when
405 invoked from the callee.
407 C<< $c->stash >> is kept unchanged.
409 In effect, L<< visit|/"$c->visit( $action [, \@captures, \@arguments ] )" >>
410 allows you to "wrap" another action, just as it would have been called by
411 dispatching from a URL, while the analogous
412 L<< go|/"$c->go( $action [, \@captures, \@arguments ] )" >> allows you to
413 transfer control to another action as if it had been reached directly from a URL.
417 sub visit { my $c = shift; $c->dispatcher->visit( $c, @_ ) }
419 =head2 $c->go( $action [, \@captures, \@arguments ] )
421 =head2 $c->go( $class, $method, [, \@captures, \@arguments ] )
423 The relationship between C<go> and
424 L<< visit|/"$c->visit( $action [, \@captures, \@arguments ] )" >> is the same as
425 the relationship between
426 L<< forward|/"$c->forward( $class, $method, [, \@arguments ] )" >> and
427 L<< detach|/"$c->detach( $action [, \@arguments ] )" >>. Like C<< $c->visit >>,
428 C<< $c->go >> will perform a full dispatch on the specified action or method,
429 with localized C<< $c->action >> and C<< $c->namespace >>. Like C<detach>,
430 C<go> escapes the processing of the current request chain on completion, and
431 does not return to its caller.
435 sub go { my $c = shift; $c->dispatcher->go( $c, @_ ) }
441 Returns the current L<Catalyst::Response> object, see there for details.
445 Returns a hashref to the stash, which may be used to store data and pass
446 it between components during a request. You can also set hash keys by
447 passing arguments. The stash is automatically sent to the view. The
448 stash is cleared at the end of a request; it cannot be used for
449 persistent storage (for this you must use a session; see
450 L<Catalyst::Plugin::Session> for a complete system integrated with
453 $c->stash->{foo} = $bar;
454 $c->stash( { moose => 'majestic', qux => 0 } );
455 $c->stash( bar => 1, gorch => 2 ); # equivalent to passing a hashref
457 # stash is automatically passed to the view for use in a template
458 $c->forward( 'MyApp::View::TT' );
462 around stash => sub {
465 my $stash = $orig->($c);
467 my $new_stash = @_ > 1 ? {@_} : $_[0];
468 croak('stash takes a hash or hashref') unless ref $new_stash;
469 foreach my $key ( keys %$new_stash ) {
470 $stash->{$key} = $new_stash->{$key};
480 =head2 $c->error($error, ...)
482 =head2 $c->error($arrayref)
484 Returns an arrayref containing error messages. If Catalyst encounters an
485 error while processing a request, it stores the error in $c->error. This
486 method should only be used to store fatal error messages.
488 my @error = @{ $c->error };
492 $c->error('Something bad happened');
499 my $error = ref $_[0] eq 'ARRAY' ? $_[0] : [@_];
500 croak @$error unless ref $c;
501 push @{ $c->{error} }, @$error;
503 elsif ( defined $_[0] ) { $c->{error} = undef }
504 return $c->{error} || [];
510 Contains the return value of the last executed action.
511 Note that << $c->state >> operates in a scalar context which means that all
512 values it returns are scalar.
514 =head2 $c->clear_errors
516 Clear errors. You probably don't want to clear the errors unless you are
517 implementing a custom error screen.
519 This is equivalent to running
530 sub _comp_search_prefixes {
532 return map $c->components->{ $_ }, $c->_comp_names_search_prefixes(@_);
535 # search components given a name and some prefixes
536 sub _comp_names_search_prefixes {
537 my ( $c, $name, @prefixes ) = @_;
538 my $appclass = ref $c || $c;
539 my $filter = "^${appclass}::(" . join( '|', @prefixes ) . ')::';
540 $filter = qr/$filter/; # Compile regex now rather than once per loop
542 # map the original component name to the sub part that we will search against
543 my %eligible = map { my $n = $_; $n =~ s{^$appclass\::[^:]+::}{}; $_ => $n; }
544 grep { /$filter/ } keys %{ $c->components };
546 # undef for a name will return all
547 return keys %eligible if !defined $name;
549 my $query = ref $name ? $name : qr/^$name$/i;
550 my @result = grep { $eligible{$_} =~ m{$query} } keys %eligible;
552 return @result if @result;
554 # if we were given a regexp to search against, we're done.
557 # skip regexp fallback if configured
559 if $appclass->config->{disable_component_resolution_regex_fallback};
563 @result = grep { $eligible{ $_ } =~ m{$query} } keys %eligible;
565 # no results? try against full names
567 @result = grep { m{$query} } keys %eligible;
570 # don't warn if we didn't find any results, it just might not exist
572 # Disgusting hack to work out correct method name
573 my $warn_for = lc $prefixes[0];
574 my $msg = "Used regexp fallback for \$c->${warn_for}('${name}'), which found '" .
575 (join '", "', @result) . "'. Relying on regexp fallback behavior for " .
576 "component resolution is unreliable and unsafe.";
577 my $short = $result[0];
578 # remove the component namespace prefix
579 $short =~ s/.*?(Model|Controller|View):://;
580 my $shortmess = Carp::shortmess('');
581 if ($shortmess =~ m#Catalyst/Plugin#) {
582 $msg .= " You probably need to set '$short' instead of '${name}' in this " .
584 } elsif ($shortmess =~ m#Catalyst/lib/(View|Controller)#) {
585 $msg .= " You probably need to set '$short' instead of '${name}' in this " .
586 "component's config";
588 $msg .= " You probably meant \$c->${warn_for}('$short') instead of \$c->${warn_for}('${name}'), " .
589 "but if you really wanted to search, pass in a regexp as the argument " .
590 "like so: \$c->${warn_for}(qr/${name}/)";
592 $c->log->warn( "${msg}$shortmess" );
598 # Find possible names for a prefix
600 my ( $c, @prefixes ) = @_;
601 my $appclass = ref $c || $c;
603 my $filter = "^${appclass}::(" . join( '|', @prefixes ) . ')::';
605 my @names = map { s{$filter}{}; $_; }
606 $c->_comp_names_search_prefixes( undef, @prefixes );
611 # Filter a component before returning by calling ACCEPT_CONTEXT if available
612 sub _filter_component {
613 my ( $c, $comp, @args ) = @_;
615 if ( eval { $comp->can('ACCEPT_CONTEXT'); } ) {
616 return $comp->ACCEPT_CONTEXT( $c, @args );
622 =head2 COMPONENT ACCESSORS
624 =head2 $c->controller($name)
626 Gets a L<Catalyst::Controller> instance by name.
628 $c->controller('Foo')->do_stuff;
630 If the name is omitted, will return the controller for the dispatched
633 If you want to search for controllers, pass in a regexp as the argument.
635 # find all controllers that start with Foo
636 my @foo_controllers = $c->controller(qr{^Foo});
642 my ( $c, $name, @args ) = @_;
644 my $appclass = ref($c) || $c;
646 unless ( ref($name) ) { # Direct component hash lookup to avoid costly regexps
647 my $comps = $c->components;
648 my $check = $appclass."::Controller::".$name;
649 return $c->_filter_component( $comps->{$check}, @args ) if exists $comps->{$check};
651 my @result = $c->_comp_search_prefixes( $name, qw/Controller C/ );
652 return map { $c->_filter_component( $_, @args ) } @result if ref $name;
653 return $c->_filter_component( $result[ 0 ], @args );
656 return $c->component( $c->action->class );
659 =head2 $c->model($name)
661 Gets a L<Catalyst::Model> instance by name.
663 $c->model('Foo')->do_stuff;
665 Any extra arguments are directly passed to ACCEPT_CONTEXT.
667 If the name is omitted, it will look for
668 - a model object in $c->stash->{current_model_instance}, then
669 - a model name in $c->stash->{current_model}, then
670 - a config setting 'default_model', or
671 - check if there is only one model, and return it if that's the case.
673 If you want to search for models, pass in a regexp as the argument.
675 # find all models that start with Foo
676 my @foo_models = $c->model(qr{^Foo});
681 my ( $c, $name, @args ) = @_;
682 my $appclass = ref($c) || $c;
684 unless ( ref($name) ) { # Direct component hash lookup to avoid costly regexps
685 my $comps = $c->components;
686 my $check = $appclass."::Model::".$name;
687 return $c->_filter_component( $comps->{$check}, @args ) if exists $comps->{$check};
689 my @result = $c->_comp_search_prefixes( $name, qw/Model M/ );
690 return map { $c->_filter_component( $_, @args ) } @result if ref $name;
691 return $c->_filter_component( $result[ 0 ], @args );
695 return $c->stash->{current_model_instance}
696 if $c->stash->{current_model_instance};
697 return $c->model( $c->stash->{current_model} )
698 if $c->stash->{current_model};
700 return $c->model( $appclass->config->{default_model} )
701 if $appclass->config->{default_model};
703 my( $comp, $rest ) = $c->_comp_search_prefixes( undef, qw/Model M/);
706 $c->log->warn( Carp::shortmess('Calling $c->model() will return a random model unless you specify one of:') );
707 $c->log->warn( '* $c->config(default_model => "the name of the default model to use")' );
708 $c->log->warn( '* $c->stash->{current_model} # the name of the model to use for this request' );
709 $c->log->warn( '* $c->stash->{current_model_instance} # the instance of the model to use for this request' );
710 $c->log->warn( 'NB: in version 5.81, the "random" behavior will not work at all.' );
713 return $c->_filter_component( $comp );
717 =head2 $c->view($name)
719 Gets a L<Catalyst::View> instance by name.
721 $c->view('Foo')->do_stuff;
723 Any extra arguments are directly passed to ACCEPT_CONTEXT.
725 If the name is omitted, it will look for
726 - a view object in $c->stash->{current_view_instance}, then
727 - a view name in $c->stash->{current_view}, then
728 - a config setting 'default_view', or
729 - check if there is only one view, and return it if that's the case.
731 If you want to search for views, pass in a regexp as the argument.
733 # find all views that start with Foo
734 my @foo_views = $c->view(qr{^Foo});
739 my ( $c, $name, @args ) = @_;
741 my $appclass = ref($c) || $c;
743 unless ( ref($name) ) { # Direct component hash lookup to avoid costly regexps
744 my $comps = $c->components;
745 my $check = $appclass."::View::".$name;
746 return $c->_filter_component( $comps->{$check}, @args ) if exists $comps->{$check};
748 my @result = $c->_comp_search_prefixes( $name, qw/View V/ );
749 return map { $c->_filter_component( $_, @args ) } @result if ref $name;
750 return $c->_filter_component( $result[ 0 ], @args );
754 return $c->stash->{current_view_instance}
755 if $c->stash->{current_view_instance};
756 return $c->view( $c->stash->{current_view} )
757 if $c->stash->{current_view};
759 return $c->view( $appclass->config->{default_view} )
760 if $appclass->config->{default_view};
762 my( $comp, $rest ) = $c->_comp_search_prefixes( undef, qw/View V/);
765 $c->log->warn( 'Calling $c->view() will return a random view unless you specify one of:' );
766 $c->log->warn( '* $c->config(default_view => "the name of the default view to use")' );
767 $c->log->warn( '* $c->stash->{current_view} # the name of the view to use for this request' );
768 $c->log->warn( '* $c->stash->{current_view_instance} # the instance of the view to use for this request' );
769 $c->log->warn( 'NB: in version 5.81, the "random" behavior will not work at all.' );
772 return $c->_filter_component( $comp );
775 =head2 $c->controllers
777 Returns the available names which can be passed to $c->controller
783 return $c->_comp_names(qw/Controller C/);
788 Returns the available names which can be passed to $c->model
794 return $c->_comp_names(qw/Model M/);
800 Returns the available names which can be passed to $c->view
806 return $c->_comp_names(qw/View V/);
809 =head2 $c->comp($name)
811 =head2 $c->component($name)
813 Gets a component object by name. This method is not recommended,
814 unless you want to get a specific component by full
815 class. C<< $c->controller >>, C<< $c->model >>, and C<< $c->view >>
816 should be used instead.
818 If C<$name> is a regexp, a list of components matched against the full
819 component name will be returned.
821 If Catalyst can't find a component by name, it will fallback to regex
822 matching by default. To disable this behaviour set
823 disable_component_resolution_regex_fallback to a true value.
825 __PACKAGE__->config( disable_component_resolution_regex_fallback => 1 );
830 my ( $c, $name, @args ) = @_;
833 my $comps = $c->components;
836 # is it the exact name?
837 return $c->_filter_component( $comps->{ $name }, @args )
838 if exists $comps->{ $name };
840 # perhaps we just omitted "MyApp"?
841 my $composed = ( ref $c || $c ) . "::${name}";
842 return $c->_filter_component( $comps->{ $composed }, @args )
843 if exists $comps->{ $composed };
845 # search all of the models, views and controllers
846 my( $comp ) = $c->_comp_search_prefixes( $name, qw/Model M Controller C View V/ );
847 return $c->_filter_component( $comp, @args ) if $comp;
850 # This is here so $c->comp( '::M::' ) works
851 my $query = ref $name ? $name : qr{$name}i;
853 my @result = grep { m{$query} } keys %{ $c->components };
854 return map { $c->_filter_component( $_, @args ) } @result if ref $name;
857 $c->log->warn( Carp::shortmess(qq(Found results for "${name}" using regexp fallback)) );
858 $c->log->warn( 'Relying on the regexp fallback behavior for component resolution' );
859 $c->log->warn( 'is unreliable and unsafe. You have been warned' );
860 return $c->_filter_component( $result[ 0 ], @args );
863 # I would expect to return an empty list here, but that breaks back-compat
867 return sort keys %{ $c->components };
870 =head2 CLASS DATA AND HELPER CLASSES
874 Returns or takes a hashref containing the application's configuration.
876 __PACKAGE__->config( { db => 'dsn:SQLite:foo.db' } );
878 You can also use a C<YAML>, C<XML> or L<Config::General> config file
879 like C<myapp.conf> in your applications home directory. See
880 L<Catalyst::Plugin::ConfigLoader>.
882 =head3 Cascading configuration
884 The config method is present on all Catalyst components, and configuration
885 will be merged when an application is started. Configuration loaded with
886 L<Catalyst::Plugin::ConfigLoader> takes precedence over other configuration,
887 followed by configuration in your top level C<MyApp> class. These two
888 configurations are merged, and then configuration data whose hash key matches a
889 component name is merged with configuration for that component.
891 The configuration for a component is then passed to the C<new> method when a
892 component is constructed.
896 MyApp->config({ 'Model::Foo' => { bar => 'baz', overrides => 'me' } });
897 MyApp::Model::Foo->config({ quux => 'frob', 'overrides => 'this' });
899 will mean that C<MyApp::Model::Foo> receives the following data when
902 MyApp::Model::Foo->new({
910 around config => sub {
914 croak('Setting config after setup has been run is not allowed.')
915 if ( @_ and $c->setup_finished );
922 Returns the logging object instance. Unless it is already set, Catalyst
923 sets this up with a L<Catalyst::Log> object. To use your own log class,
924 set the logger with the C<< __PACKAGE__->log >> method prior to calling
925 C<< __PACKAGE__->setup >>.
927 __PACKAGE__->log( MyLogger->new );
932 $c->log->info( 'Now logging with my own logger!' );
934 Your log class should implement the methods described in
940 Returns 1 if debug mode is enabled, 0 otherwise.
942 You can enable debug mode in several ways:
946 =item By calling myapp_server.pl with the -d flag
948 =item With the environment variables MYAPP_DEBUG, or CATALYST_DEBUG
950 =item The -Debug option in your MyApp.pm
952 =item By declaring C<sub debug { 1 }> in your MyApp.pm.
956 The first three also set the log level to 'debug'.
958 Calling C<< $c->debug(1) >> has no effect.
964 =head2 $c->dispatcher
966 Returns the dispatcher instance. See L<Catalyst::Dispatcher>.
970 Returns the engine instance. See L<Catalyst::Engine>.
973 =head2 UTILITY METHODS
975 =head2 $c->path_to(@path)
977 Merges C<@path> with C<< $c->config->{home} >> and returns a
978 L<Path::Class::Dir> object. Note you can usually use this object as
979 a filename, but sometimes you will have to explicitly stringify it
980 yourself by calling the C<< ->stringify >> method.
984 $c->path_to( 'db', 'sqlite.db' );
989 my ( $c, @path ) = @_;
990 my $path = Path::Class::Dir->new( $c->config->{home}, @path );
991 if ( -d $path ) { return $path }
992 else { return Path::Class::File->new( $c->config->{home}, @path ) }
995 =head2 $c->plugin( $name, $class, @args )
997 Helper method for plugins. It creates a class data accessor/mutator and
998 loads and instantiates the given class.
1000 MyApp->plugin( 'prototype', 'HTML::Prototype' );
1002 $c->prototype->define_javascript_functions;
1004 B<Note:> This method of adding plugins is deprecated. The ability
1005 to add plugins like this B<will be removed> in a Catalyst 5.81.
1006 Please do not use this functionality in new code.
1011 my ( $class, $name, $plugin, @args ) = @_;
1013 # See block comment in t/unit_core_plugin.t
1014 $class->log->warn(qq/Adding plugin using the ->plugin method is deprecated, and will be removed in Catalyst 5.81/);
1016 $class->_register_plugin( $plugin, 1 );
1018 eval { $plugin->import };
1019 $class->mk_classdata($name);
1021 eval { $obj = $plugin->new(@args) };
1024 Catalyst::Exception->throw( message =>
1025 qq/Couldn't instantiate instant plugin "$plugin", "$@"/ );
1028 $class->$name($obj);
1029 $class->log->debug(qq/Initialized instant plugin "$plugin" as "$name"/)
1035 Initializes the dispatcher and engine, loads any plugins, and loads the
1036 model, view, and controller components. You may also specify an array
1037 of plugins to load here, if you choose to not load them in the C<use
1041 MyApp->setup( qw/-Debug/ );
1046 my ( $class, @arguments ) = @_;
1047 croak('Running setup more than once')
1048 if ( $class->setup_finished );
1050 unless ( $class->isa('Catalyst') ) {
1052 Catalyst::Exception->throw(
1053 message => qq/'$class' does not inherit from Catalyst/ );
1056 if ( $class->arguments ) {
1057 @arguments = ( @arguments, @{ $class->arguments } );
1063 foreach (@arguments) {
1067 ( $flags->{log} ) ? 'debug,' . $flags->{log} : 'debug';
1069 elsif (/^-(\w+)=?(.*)$/) {
1070 $flags->{ lc $1 } = $2;
1073 push @{ $flags->{plugins} }, $_;
1077 $class->setup_home( delete $flags->{home} );
1079 $class->setup_log( delete $flags->{log} );
1080 $class->setup_plugins( delete $flags->{plugins} );
1081 $class->setup_dispatcher( delete $flags->{dispatcher} );
1082 $class->setup_engine( delete $flags->{engine} );
1083 $class->setup_stats( delete $flags->{stats} );
1085 for my $flag ( sort keys %{$flags} ) {
1087 if ( my $code = $class->can( 'setup_' . $flag ) ) {
1088 &$code( $class, delete $flags->{$flag} );
1091 $class->log->warn(qq/Unknown flag "$flag"/);
1095 eval { require Catalyst::Devel; };
1096 if( !$@ && $ENV{CATALYST_SCRIPT_GEN} && ( $ENV{CATALYST_SCRIPT_GEN} < $Catalyst::Devel::CATALYST_SCRIPT_GEN ) ) {
1097 $class->log->warn(<<"EOF");
1098 You are running an old script!
1100 Please update by running (this will overwrite existing files):
1101 catalyst.pl -force -scripts $class
1103 or (this will not overwrite existing files):
1104 catalyst.pl -scripts $class
1109 if ( $class->debug ) {
1110 my @plugins = map { "$_ " . ( $_->VERSION || '' ) } $class->registered_plugins;
1113 my $column_width = Catalyst::Utils::term_width() - 6;
1114 my $t = Text::SimpleTable->new($column_width);
1115 $t->row($_) for @plugins;
1116 $class->log->debug( "Loaded plugins:\n" . $t->draw . "\n" );
1119 my $dispatcher = $class->dispatcher;
1120 my $engine = $class->engine;
1121 my $home = $class->config->{home};
1123 $class->log->debug(sprintf(q/Loaded dispatcher "%s"/, blessed($dispatcher)));
1124 $class->log->debug(sprintf(q/Loaded engine "%s"/, blessed($engine)));
1128 ? $class->log->debug(qq/Found home "$home"/)
1129 : $class->log->debug(qq/Home "$home" doesn't exist/)
1130 : $class->log->debug(q/Couldn't find home/);
1133 # Call plugins setup, this is stupid and evil.
1134 # Also screws C3 badly on 5.10, hack to avoid.
1136 no warnings qw/redefine/;
1137 local *setup = sub { };
1138 $class->setup unless $Catalyst::__AM_RESTARTING;
1141 # Initialize our data structure
1142 $class->components( {} );
1144 $class->setup_components;
1146 if ( $class->debug ) {
1147 my $column_width = Catalyst::Utils::term_width() - 8 - 9;
1148 my $t = Text::SimpleTable->new( [ $column_width, 'Class' ], [ 8, 'Type' ] );
1149 for my $comp ( sort keys %{ $class->components } ) {
1150 my $type = ref $class->components->{$comp} ? 'instance' : 'class';
1151 $t->row( $comp, $type );
1153 $class->log->debug( "Loaded components:\n" . $t->draw . "\n" )
1154 if ( keys %{ $class->components } );
1157 # Add our self to components, since we are also a component
1158 if( $class->isa('Catalyst::Controller') ){
1159 $class->components->{$class} = $class;
1162 $class->setup_actions;
1164 if ( $class->debug ) {
1165 my $name = $class->config->{name} || 'Application';
1166 $class->log->info("$name powered by Catalyst $Catalyst::VERSION");
1169 # Make sure that the application class becomes immutable at this point,
1170 B::Hooks::EndOfScope::on_scope_end {
1172 my $meta = Class::MOP::get_metaclass_by_name($class);
1175 && ! { $meta->immutable_options }->{replace_constructor}
1177 $class->isa('Class::Accessor::Fast')
1178 || $class->isa('Class::Accessor')
1181 warn "You made your application class ($class) immutable, "
1182 . "but did not inline the\nconstructor. "
1183 . "This will break catalyst, as your app \@ISA "
1184 . "Class::Accessor(::Fast)?\nPlease pass "
1185 . "(replace_constructor => 1)\nwhen making your class immutable.\n";
1187 $meta->make_immutable(
1188 replace_constructor => 1,
1189 ) unless $meta->is_immutable;
1192 if ($class->config->{case_sensitive}) {
1193 $class->log->warn($class . "->config->{case_sensitive} is set.");
1194 $class->log->warn("This setting is deprecated and planned to be removed in Catalyst 5.81.");
1197 $class->setup_finalize;
1198 # Should be the last thing we do so that user things hooking
1199 # setup_finalize can log..
1200 $class->log->_flush() if $class->log->can('_flush');
1201 return 1; # Explicit return true as people have __PACKAGE__->setup as the last thing in their class. HATE.
1204 =head2 $app->setup_finalize
1206 A hook to attach modifiers to. This method does not do anything except set the
1207 C<setup_finished> accessor.
1209 Applying method modifiers to the C<setup> method doesn't work, because of quirky thingsdone for plugin setup.
1213 after setup_finalize => sub {
1221 sub setup_finalize {
1223 $class->setup_finished(1);
1226 =head2 $c->uri_for( $path?, @args?, \%query_values? )
1228 =head2 $c->uri_for( $action, \@captures?, @args?, \%query_values? )
1230 Constructs an absolute L<URI> object based on the application root, the
1231 provided path, and the additional arguments and query parameters provided.
1232 When used as a string, provides a textual URI.
1234 If no arguments are provided, the URI for the current action is returned.
1235 To return the current action and also provide @args, use
1236 C<< $c->uri_for( $c->action, @args ) >>.
1238 If the first argument is a string, it is taken as a public URI path relative
1239 to C<< $c->namespace >> (if it doesn't begin with a forward slash) or
1240 relative to the application root (if it does). It is then merged with
1241 C<< $c->request->base >>; any C<@args> are appended as additional path
1242 components; and any C<%query_values> are appended as C<?foo=bar> parameters.
1244 If the first argument is a L<Catalyst::Action> it represents an action which
1245 will have its path resolved using C<< $c->dispatcher->uri_for_action >>. The
1246 optional C<\@captures> argument (an arrayref) allows passing the captured
1247 variables that are needed to fill in the paths of Chained and Regex actions;
1248 once the path is resolved, C<uri_for> continues as though a path was
1249 provided, appending any arguments or parameters and creating an absolute
1252 The captures for the current request can be found in
1253 C<< $c->request->captures >>, and actions can be resolved using
1254 C<< Catalyst::Controller->action_for($name) >>. If you have a private action
1255 path, use C<< $c->uri_for_action >> instead.
1257 # Equivalent to $c->req->uri
1258 $c->uri_for($c->action, $c->req->captures,
1259 @{ $c->req->args }, $c->req->params);
1261 # For the Foo action in the Bar controller
1262 $c->uri_for($c->controller('Bar')->action_for('Foo'));
1264 # Path to a static resource
1265 $c->uri_for('/static/images/logo.png');
1270 my ( $c, $path, @args ) = @_;
1272 if (blessed($path) && $path->isa('Catalyst::Controller')) {
1273 $path = $path->path_prefix;
1278 undef($path) if (defined $path && $path eq '');
1281 ( scalar @args && ref $args[$#args] eq 'HASH' ? pop @args : {} );
1283 carp "uri_for called with undef argument" if grep { ! defined $_ } @args;
1284 foreach my $arg (@args) {
1285 utf8::encode($arg) if utf8::is_utf8($arg);
1286 $arg =~ s/([^$URI::uric])/$URI::Escape::escapes{$1}/go;
1289 if ( blessed($path) ) { # action object
1290 s|/|%2F|g for @args;
1291 my $captures = [ map { s|/|%2F|g; $_; }
1292 ( scalar @args && ref $args[0] eq 'ARRAY'
1296 foreach my $capture (@$captures) {
1297 utf8::encode($capture) if utf8::is_utf8($capture);
1298 $capture =~ s/([^$URI::uric])/$URI::Escape::escapes{$1}/go;
1302 $path = $c->dispatcher->uri_for_action($action, $captures);
1303 if (not defined $path) {
1304 $c->log->debug(qq/Can't find uri_for action '$action' @$captures/)
1308 $path = '/' if $path eq '';
1311 unshift(@args, $path);
1313 unless (defined $path && $path =~ s!^/!!) { # in-place strip
1314 my $namespace = $c->namespace;
1315 if (defined $path) { # cheesy hack to handle path '../foo'
1316 $namespace =~ s{(?:^|/)[^/]+$}{} while $args[0] =~ s{^\.\./}{};
1318 unshift(@args, $namespace || '');
1321 # join args with '/', or a blank string
1322 my $args = join('/', grep { defined($_) } @args);
1323 $args =~ s/\?/%3F/g; # STUPID STUPID SPECIAL CASE
1325 my $base = $c->req->base;
1326 my $class = ref($base);
1327 $base =~ s{(?<!/)$}{/};
1331 if (my @keys = keys %$params) {
1332 # somewhat lifted from URI::_query's query_form
1333 $query = '?'.join('&', map {
1334 my $val = $params->{$_};
1335 s/([;\/?:@&=+,\$\[\]%])/$URI::Escape::escapes{$1}/go;
1338 $val = '' unless defined $val;
1341 utf8::encode( $param ) if utf8::is_utf8($param);
1342 # using the URI::Escape pattern here so utf8 chars survive
1343 $param =~ s/([^A-Za-z0-9\-_.!~*'() ])/$URI::Escape::escapes{$1}/go;
1345 "${key}=$param"; } ( ref $val eq 'ARRAY' ? @$val : $val ));
1349 my $res = bless(\"${base}${args}${query}", $class);
1353 =head2 $c->uri_for_action( $path, \@captures?, @args?, \%query_values? )
1355 =head2 $c->uri_for_action( $action, \@captures?, @args?, \%query_values? )
1361 A private path to the Catalyst action you want to create a URI for.
1363 This is a shortcut for calling C<< $c->dispatcher->get_action_by_path($path)
1364 >> and passing the resulting C<$action> and the remaining arguments to C<<
1367 You can also pass in a Catalyst::Action object, in which case it is passed to
1370 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.
1372 For example, if the action looks like:
1374 package MyApp::Controller::Users;
1376 sub lst : Path('the-list') {}
1380 $c->uri_for_action('/users/lst')
1382 and it will create the URI /users/the-list.
1388 sub uri_for_action {
1389 my ( $c, $path, @args ) = @_;
1390 my $action = blessed($path)
1392 : $c->dispatcher->get_action_by_path($path);
1393 unless (defined $action) {
1394 croak "Can't find action for path '$path'";
1396 return $c->uri_for( $action, @args );
1399 =head2 $c->welcome_message
1401 Returns the Catalyst welcome HTML page.
1405 sub welcome_message {
1407 my $name = $c->config->{name};
1408 my $logo = $c->uri_for('/static/images/catalyst_logo.png');
1409 my $prefix = Catalyst::Utils::appprefix( ref $c );
1410 $c->response->content_type('text/html; charset=utf-8');
1412 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
1413 "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
1414 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
1416 <meta http-equiv="Content-Language" content="en" />
1417 <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
1418 <title>$name on Catalyst $VERSION</title>
1419 <style type="text/css">
1422 background-color: #eee;
1429 margin-bottom: 10px;
1431 background-color: #ccc;
1432 border: 1px solid #aaa;
1437 font-family: verdana, tahoma, sans-serif;
1440 font-family: verdana, tahoma, sans-serif;
1443 text-decoration: none;
1445 border-bottom: 1px dotted #bbb;
1447 :link:hover, :visited:hover {
1460 background-color: #fff;
1461 border: 1px solid #aaa;
1465 font-weight: normal;
1487 <h1><span id="appname">$name</span> on <a href="http://catalyst.perl.org">Catalyst</a>
1492 <img src="$logo" alt="Catalyst Logo" />
1494 <p>Welcome to the world of Catalyst.
1495 This <a href="http://en.wikipedia.org/wiki/MVC">MVC</a>
1496 framework will make web development something you had
1497 never expected it to be: Fun, rewarding, and quick.</p>
1498 <h2>What to do now?</h2>
1499 <p>That really depends on what <b>you</b> want to do.
1500 We do, however, provide you with a few starting points.</p>
1501 <p>If you want to jump right into web development with Catalyst
1502 you might want to start with a tutorial.</p>
1503 <pre>perldoc <a href="http://cpansearch.perl.org/dist/Catalyst-Manual/lib/Catalyst/Manual/Tutorial.pod">Catalyst::Manual::Tutorial</a></code>
1505 <p>Afterwards you can go on to check out a more complete look at our features.</p>
1507 <code>perldoc <a href="http://cpansearch.perl.org/dist/Catalyst-Manual/lib/Catalyst/Manual/Intro.pod">Catalyst::Manual::Intro</a>
1508 <!-- Something else should go here, but the Catalyst::Manual link seems unhelpful -->
1510 <h2>What to do next?</h2>
1511 <p>Next it's time to write an actual application. Use the
1512 helper scripts to generate <a href="http://cpansearch.perl.org/search?query=Catalyst%3A%3AController%3A%3A&mode=all">controllers</a>,
1513 <a href="http://cpansearch.perl.org/search?query=Catalyst%3A%3AModel%3A%3A&mode=all">models</a>, and
1514 <a href="http://cpansearch.perl.org/search?query=Catalyst%3A%3AView%3A%3A&mode=all">views</a>;
1515 they can save you a lot of work.</p>
1516 <pre><code>script/${prefix}_create.pl --help</code></pre>
1517 <p>Also, be sure to check out the vast and growing
1518 collection of <a href="http://search.cpan.org/search?query=Catalyst">plugins for Catalyst on CPAN</a>;
1519 you are likely to find what you need there.
1523 <p>Catalyst has a very active community. Here are the main places to
1524 get in touch with us.</p>
1527 <a href="http://dev.catalyst.perl.org">Wiki</a>
1530 <a href="http://lists.scsys.co.uk/cgi-bin/mailman/listinfo/catalyst">Mailing-List</a>
1533 <a href="irc://irc.perl.org/catalyst">IRC channel #catalyst on irc.perl.org</a>
1536 <h2>In conclusion</h2>
1537 <p>The Catalyst team hopes you will enjoy using Catalyst as much
1538 as we enjoyed making it. Please contact us if you have ideas
1539 for improvement or other feedback.</p>
1547 =head1 INTERNAL METHODS
1549 These methods are not meant to be used by end users.
1551 =head2 $c->components
1553 Returns a hash of components.
1555 =head2 $c->context_class
1557 Returns or sets the context class.
1561 Returns a hashref containing coderefs and execution counts (needed for
1562 deep recursion detection).
1566 Returns the number of actions on the current internal execution stack.
1570 Dispatches a request to actions.
1574 sub dispatch { my $c = shift; $c->dispatcher->dispatch( $c, @_ ) }
1576 =head2 $c->dispatcher_class
1578 Returns or sets the dispatcher class.
1580 =head2 $c->dump_these
1582 Returns a list of 2-element array references (name, structure) pairs
1583 that will be dumped on the error page in debug mode.
1589 [ Request => $c->req ],
1590 [ Response => $c->res ],
1591 [ Stash => $c->stash ],
1592 [ Config => $c->config ];
1595 =head2 $c->engine_class
1597 Returns or sets the engine class.
1599 =head2 $c->execute( $class, $coderef )
1601 Execute a coderef in given class and catch exceptions. Errors are available
1607 my ( $c, $class, $code ) = @_;
1608 $class = $c->component($class) || $class;
1611 if ( $c->depth >= $RECURSION ) {
1612 my $action = $code->reverse();
1613 $action = "/$action" unless $action =~ /->/;
1614 my $error = qq/Deep recursion detected calling "${action}"/;
1615 $c->log->error($error);
1621 my $stats_info = $c->_stats_start_execute( $code ) if $c->use_stats;
1623 push( @{ $c->stack }, $code );
1625 no warnings 'recursion';
1626 eval { $c->state( $code->execute( $class, $c, @{ $c->req->args } ) || 0 ) };
1628 $c->_stats_finish_execute( $stats_info ) if $c->use_stats and $stats_info;
1630 my $last = pop( @{ $c->stack } );
1632 if ( my $error = $@ ) {
1633 if ( blessed($error) and $error->isa('Catalyst::Exception::Detach') ) {
1634 $error->rethrow if $c->depth > 1;
1636 elsif ( blessed($error) and $error->isa('Catalyst::Exception::Go') ) {
1637 $error->rethrow if $c->depth > 0;
1640 unless ( ref $error ) {
1641 no warnings 'uninitialized';
1643 my $class = $last->class;
1644 my $name = $last->name;
1645 $error = qq/Caught exception in $class->$name "$error"/;
1654 sub _stats_start_execute {
1655 my ( $c, $code ) = @_;
1656 my $appclass = ref($c) || $c;
1657 return if ( ( $code->name =~ /^_.*/ )
1658 && ( !$appclass->config->{show_internal_actions} ) );
1660 my $action_name = $code->reverse();
1661 $c->counter->{$action_name}++;
1663 my $action = $action_name;
1664 $action = "/$action" unless $action =~ /->/;
1666 # determine if the call was the result of a forward
1667 # this is done by walking up the call stack and looking for a calling
1668 # sub of Catalyst::forward before the eval
1670 for my $index ( 2 .. 11 ) {
1672 if ( ( caller($index) )[0] eq 'Catalyst'
1673 && ( caller($index) )[3] eq '(eval)' );
1675 if ( ( caller($index) )[3] =~ /forward$/ ) {
1676 $callsub = ( caller($index) )[3];
1677 $action = "-> $action";
1682 my $uid = $action_name . $c->counter->{$action_name};
1684 # is this a root-level call or a forwarded call?
1685 if ( $callsub =~ /forward$/ ) {
1686 my $parent = $c->stack->[-1];
1688 # forward, locate the caller
1689 if ( exists $c->counter->{"$parent"} ) {
1692 parent => "$parent" . $c->counter->{"$parent"},
1698 # forward with no caller may come from a plugin
1717 sub _stats_finish_execute {
1718 my ( $c, $info ) = @_;
1719 $c->stats->profile( end => $info );
1724 Finalizes the request.
1731 for my $error ( @{ $c->error } ) {
1732 $c->log->error($error);
1735 # Allow engine to handle finalize flow (for POE)
1736 my $engine = $c->engine;
1737 if ( my $code = $engine->can('finalize') ) {
1742 $c->finalize_uploads;
1745 if ( $#{ $c->error } >= 0 ) {
1749 $c->finalize_headers;
1752 if ( $c->request->method eq 'HEAD' ) {
1753 $c->response->body('');
1761 if ($c->use_stats) {
1762 my $elapsed = sprintf '%f', $c->stats->elapsed;
1763 my $av = $elapsed == 0 ? '??' : sprintf '%.3f', 1 / $elapsed;
1765 "Request took ${elapsed}s ($av/s)\n" . $c->stats->report . "\n" );
1768 return $c->response->status;
1771 =head2 $c->finalize_body
1777 sub finalize_body { my $c = shift; $c->engine->finalize_body( $c, @_ ) }
1779 =head2 $c->finalize_cookies
1785 sub finalize_cookies { my $c = shift; $c->engine->finalize_cookies( $c, @_ ) }
1787 =head2 $c->finalize_error
1793 sub finalize_error { my $c = shift; $c->engine->finalize_error( $c, @_ ) }
1795 =head2 $c->finalize_headers
1801 sub finalize_headers {
1804 my $response = $c->response; #accessor calls can add up?
1806 # Check if we already finalized headers
1807 return if $response->finalized_headers;
1810 if ( my $location = $response->redirect ) {
1811 $c->log->debug(qq/Redirecting to "$location"/) if $c->debug;
1812 $response->header( Location => $location );
1814 if ( !$response->has_body ) {
1815 # Add a default body if none is already present
1817 qq{<html><body><p>This item has moved <a href="$location">here</a>.</p></body></html>}
1823 if ( $response->body && !$response->content_length ) {
1825 # get the length from a filehandle
1826 if ( blessed( $response->body ) && $response->body->can('read') )
1828 my $stat = stat $response->body;
1829 if ( $stat && $stat->size > 0 ) {
1830 $response->content_length( $stat->size );
1833 $c->log->warn('Serving filehandle without a content-length');
1837 # everything should be bytes at this point, but just in case
1838 $response->content_length( length( $response->body ) );
1843 if ( $response->status =~ /^(1\d\d|[23]04)$/ ) {
1844 $response->headers->remove_header("Content-Length");
1845 $response->body('');
1848 $c->finalize_cookies;
1850 $c->engine->finalize_headers( $c, @_ );
1853 $response->finalized_headers(1);
1856 =head2 $c->finalize_output
1858 An alias for finalize_body.
1860 =head2 $c->finalize_read
1862 Finalizes the input after reading is complete.
1866 sub finalize_read { my $c = shift; $c->engine->finalize_read( $c, @_ ) }
1868 =head2 $c->finalize_uploads
1870 Finalizes uploads. Cleans up any temporary files.
1874 sub finalize_uploads { my $c = shift; $c->engine->finalize_uploads( $c, @_ ) }
1876 =head2 $c->get_action( $action, $namespace )
1878 Gets an action in a given namespace.
1882 sub get_action { my $c = shift; $c->dispatcher->get_action(@_) }
1884 =head2 $c->get_actions( $action, $namespace )
1886 Gets all actions of a given name in a namespace and all parent
1891 sub get_actions { my $c = shift; $c->dispatcher->get_actions( $c, @_ ) }
1893 =head2 $app->handle_request( @arguments )
1895 Called to handle each HTTP request.
1899 sub handle_request {
1900 my ( $class, @arguments ) = @_;
1902 # Always expect worst case!
1905 if ($class->debug) {
1906 my $secs = time - $START || 1;
1907 my $av = sprintf '%.3f', $COUNT / $secs;
1908 my $time = localtime time;
1909 $class->log->info("*** Request $COUNT ($av/s) [$$] [$time] ***");
1912 my $c = $class->prepare(@arguments);
1914 $status = $c->finalize;
1917 chomp(my $error = $_);
1918 $class->log->error(qq/Caught exception in engine "$error"/);
1923 if(my $coderef = $class->log->can('_flush')){
1924 $class->log->$coderef();
1929 =head2 $c->prepare( @arguments )
1931 Creates a Catalyst context from an engine-specific request (Apache, CGI,
1937 my ( $class, @arguments ) = @_;
1940 # After the app/ctxt split, this should become an attribute based on something passed
1941 # into the application.
1942 $class->context_class( ref $class || $class ) unless $class->context_class;
1944 my $c = $class->context_class->new({});
1946 # For on-demand data
1947 $c->request->_context($c);
1948 $c->response->_context($c);
1950 #surely this is not the most efficient way to do things...
1951 $c->stats($class->stats_class->new)->enable($c->use_stats);
1952 if ( $c->debug || $c->config->{enable_catalyst_header} ) {
1953 $c->res->headers->header( 'X-Catalyst' => $Catalyst::VERSION );
1957 # Allow engine to direct the prepare flow (for POE)
1958 if ( my $prepare = $c->engine->can('prepare') ) {
1959 $c->engine->$prepare( $c, @arguments );
1962 $c->prepare_request(@arguments);
1963 $c->prepare_connection;
1964 $c->prepare_query_parameters;
1965 $c->prepare_headers;
1966 $c->prepare_cookies;
1969 # Prepare the body for reading, either by prepare_body
1970 # or the user, if they are using $c->read
1973 # Parse the body unless the user wants it on-demand
1974 unless ( ref($c)->config->{parse_on_demand} ) {
1979 # VERY ugly and probably shouldn't rely on ->finalize actually working
1981 # failed prepare is always due to an invalid request, right?
1982 $c->response->status(400);
1983 $c->response->content_type('text/plain');
1984 $c->response->body('Bad Request');
1989 my $method = $c->req->method || '';
1990 my $path = $c->req->path;
1991 $path = '/' unless length $path;
1992 my $address = $c->req->address || '';
2001 =head2 $c->prepare_action
2003 Prepares action. See L<Catalyst::Dispatcher>.
2007 sub prepare_action { my $c = shift; $c->dispatcher->prepare_action( $c, @_ ) }
2009 =head2 $c->prepare_body
2011 Prepares message body.
2018 return if $c->request->_has_body;
2020 # Initialize on-demand data
2021 $c->engine->prepare_body( $c, @_ );
2022 $c->prepare_parameters;
2023 $c->prepare_uploads;
2026 =head2 $c->prepare_body_chunk( $chunk )
2028 Prepares a chunk of data before sending it to L<HTTP::Body>.
2030 See L<Catalyst::Engine>.
2034 sub prepare_body_chunk {
2036 $c->engine->prepare_body_chunk( $c, @_ );
2039 =head2 $c->prepare_body_parameters
2041 Prepares body parameters.
2045 sub prepare_body_parameters {
2047 $c->engine->prepare_body_parameters( $c, @_ );
2050 =head2 $c->prepare_connection
2052 Prepares connection.
2056 sub prepare_connection {
2058 $c->engine->prepare_connection( $c, @_ );
2061 =head2 $c->prepare_cookies
2067 sub prepare_cookies { my $c = shift; $c->engine->prepare_cookies( $c, @_ ) }
2069 =head2 $c->prepare_headers
2075 sub prepare_headers { my $c = shift; $c->engine->prepare_headers( $c, @_ ) }
2077 =head2 $c->prepare_parameters
2079 Prepares parameters.
2083 sub prepare_parameters {
2085 $c->prepare_body_parameters;
2086 $c->engine->prepare_parameters( $c, @_ );
2089 =head2 $c->prepare_path
2091 Prepares path and base.
2095 sub prepare_path { my $c = shift; $c->engine->prepare_path( $c, @_ ) }
2097 =head2 $c->prepare_query_parameters
2099 Prepares query parameters.
2103 sub prepare_query_parameters {
2106 $c->engine->prepare_query_parameters( $c, @_ );
2109 =head2 $c->log_request
2111 Writes information about the request to the debug logs. This includes:
2115 =item * Request method, path, and remote IP address
2117 =item * Query keywords (see L<Catalyst::Request/query_keywords>)
2119 =item * Request parameters
2121 =item * File uploads
2130 return unless $c->debug;
2132 my($dump) = grep {$_->[0] eq 'Request' } $c->dump_these;
2133 my $request = $dump->[1];
2135 my ( $method, $path, $address ) = ( $request->method, $request->path, $request->address );
2137 $path = '/' unless length $path;
2139 $c->log->debug(qq/"$method" request for "$path" from "$address"/);
2141 $c->log_request_headers($request->headers);
2143 if ( my $keywords = $request->query_keywords ) {
2144 $c->log->debug("Query keywords are: $keywords");
2147 $c->log_request_parameters( query => $request->query_parameters, body => $request->body_parameters );
2149 $c->log_request_uploads($request);
2152 =head2 $c->log_response
2154 Writes information about the response to the debug logs by calling
2155 C<< $c->log_response_status_line >> and C<< $c->log_response_headers >>.
2162 return unless $c->debug;
2164 my($dump) = grep {$_->[0] eq 'Response' } $c->dump_these;
2165 my $response = $dump->[1];
2167 $c->log_response_status_line($response);
2168 $c->log_response_headers($response->headers);
2171 =head2 $c->log_response_status_line($response)
2173 Writes one line of information about the response to the debug logs. This includes:
2177 =item * Response status code
2179 =item * Content-Type header (if present)
2181 =item * Content-Length header (if present)
2187 sub log_response_status_line {
2188 my ($c, $response) = @_;
2192 'Response Code: %s; Content-Type: %s; Content-Length: %s',
2193 $response->status || 'unknown',
2194 $response->headers->header('Content-Type') || 'unknown',
2195 $response->headers->header('Content-Length') || 'unknown'
2200 =head2 $c->log_response_headers($headers);
2202 Hook method which can be wrapped by plugins to log the responseheaders.
2203 No-op in the default implementation.
2207 sub log_response_headers {}
2209 =head2 $c->log_request_parameters( query => {}, body => {} )
2211 Logs request parameters to debug logs
2215 sub log_request_parameters {
2217 my %all_params = @_;
2219 return unless $c->debug;
2221 my $column_width = Catalyst::Utils::term_width() - 44;
2222 foreach my $type (qw(query body)) {
2223 my $params = $all_params{$type};
2224 next if ! keys %$params;
2225 my $t = Text::SimpleTable->new( [ 35, 'Parameter' ], [ $column_width, 'Value' ] );
2226 for my $key ( sort keys %$params ) {
2227 my $param = $params->{$key};
2228 my $value = defined($param) ? $param : '';
2229 $t->row( $key, ref $value eq 'ARRAY' ? ( join ', ', @$value ) : $value );
2231 $c->log->debug( ucfirst($type) . " Parameters are:\n" . $t->draw );
2235 =head2 $c->log_request_uploads
2237 Logs file uploads included in the request to the debug logs.
2238 The parameter name, filename, file type, and file size are all included in
2243 sub log_request_uploads {
2245 my $request = shift;
2246 return unless $c->debug;
2247 my $uploads = $request->uploads;
2248 if ( keys %$uploads ) {
2249 my $t = Text::SimpleTable->new(
2250 [ 12, 'Parameter' ],
2255 for my $key ( sort keys %$uploads ) {
2256 my $upload = $uploads->{$key};
2257 for my $u ( ref $upload eq 'ARRAY' ? @{$upload} : ($upload) ) {
2258 $t->row( $key, $u->filename, $u->type, $u->size );
2261 $c->log->debug( "File Uploads are:\n" . $t->draw );
2265 =head2 $c->log_request_headers($headers);
2267 Hook method which can be wrapped by plugins to log the request headers.
2268 No-op in the default implementation.
2272 sub log_request_headers {}
2274 =head2 $c->log_headers($type => $headers)
2276 Logs L<HTTP::Headers> (either request or response) to the debug logs.
2283 my $headers = shift; # an HTTP::Headers instance
2285 return unless $c->debug;
2287 my $column_width = Catalyst::Utils::term_width() - 28;
2288 my $t = Text::SimpleTable->new( [ 15, 'Header Name' ], [ $column_width, 'Value' ] );
2291 my ( $name, $value ) = @_;
2292 $t->row( $name, $value );
2295 $c->log->debug( ucfirst($type) . " Headers:\n" . $t->draw );
2299 =head2 $c->prepare_read
2301 Prepares the input for reading.
2305 sub prepare_read { my $c = shift; $c->engine->prepare_read( $c, @_ ) }
2307 =head2 $c->prepare_request
2309 Prepares the engine request.
2313 sub prepare_request { my $c = shift; $c->engine->prepare_request( $c, @_ ) }
2315 =head2 $c->prepare_uploads
2321 sub prepare_uploads {
2324 $c->engine->prepare_uploads( $c, @_ );
2327 =head2 $c->prepare_write
2329 Prepares the output for writing.
2333 sub prepare_write { my $c = shift; $c->engine->prepare_write( $c, @_ ) }
2335 =head2 $c->request_class
2337 Returns or sets the request class.
2339 =head2 $c->response_class
2341 Returns or sets the response class.
2343 =head2 $c->read( [$maxlength] )
2345 Reads a chunk of data from the request body. This method is designed to
2346 be used in a while loop, reading C<$maxlength> bytes on every call.
2347 C<$maxlength> defaults to the size of the request if not specified.
2349 You have to set C<< MyApp->config(parse_on_demand => 1) >> to use this
2352 Warning: If you use read(), Catalyst will not process the body,
2353 so you will not be able to access POST parameters or file uploads via
2354 $c->request. You must handle all body parsing yourself.
2358 sub read { my $c = shift; return $c->engine->read( $c, @_ ) }
2366 sub run { my $c = shift; return $c->engine->run( $c, @_ ) }
2368 =head2 $c->set_action( $action, $code, $namespace, $attrs )
2370 Sets an action in a given namespace.
2374 sub set_action { my $c = shift; $c->dispatcher->set_action( $c, @_ ) }
2376 =head2 $c->setup_actions($component)
2378 Sets up actions for a component.
2382 sub setup_actions { my $c = shift; $c->dispatcher->setup_actions( $c, @_ ) }
2384 =head2 $c->setup_components
2386 This method is called internally to set up the application's components.
2388 It finds modules by calling the L<locate_components> method, expands them to
2389 package names with the L<expand_component_module> method, and then installs
2390 each component into the application.
2392 The C<setup_components> config option is passed to both of the above methods.
2394 Installation of each component is performed by the L<setup_component> method,
2399 sub setup_components {
2402 my $config = $class->config->{ setup_components };
2404 my @comps = sort { length $a <=> length $b }
2405 $class->locate_components($config);
2406 my %comps = map { $_ => 1 } @comps;
2408 my $deprecatedcatalyst_component_names = grep { /::[CMV]::/ } @comps;
2409 $class->log->warn(qq{Your application is using the deprecated ::[MVC]:: type naming scheme.\n}.
2410 qq{Please switch your class names to ::Model::, ::View:: and ::Controller: as appropriate.\n}
2411 ) if $deprecatedcatalyst_component_names;
2413 for my $component ( @comps ) {
2415 # We pass ignore_loaded here so that overlay files for (e.g.)
2416 # Model::DBI::Schema sub-classes are loaded - if it's in @comps
2417 # we know M::P::O found a file on disk so this is safe
2419 Catalyst::Utils::ensure_class_loaded( $component, { ignore_loaded => 1 } );
2422 for my $component (@comps) {
2423 my $instance = $class->components->{ $component } = $class->setup_component($component);
2424 my @expanded_components = $instance->can('expand_modules')
2425 ? $instance->expand_modules( $component, $config )
2426 : $class->expand_component_module( $component, $config );
2427 for my $component (@expanded_components) {
2428 next if $comps{$component};
2429 $class->components->{ $component } = $class->setup_component($component);
2434 =head2 $c->locate_components( $setup_component_config )
2436 This method is meant to provide a list of component modules that should be
2437 setup for the application. By default, it will use L<Module::Pluggable>.
2439 Specify a C<setup_components> config option to pass additional options directly
2440 to L<Module::Pluggable>. To add additional search paths, specify a key named
2441 C<search_extra> as an array reference. Items in the array beginning with C<::>
2442 will have the application class name prepended to them.
2446 sub locate_components {
2450 my @paths = qw( ::Controller ::C ::Model ::M ::View ::V );
2451 my $extra = delete $config->{ search_extra } || [];
2453 push @paths, @$extra;
2455 my $locator = Module::Pluggable::Object->new(
2456 search_path => [ map { s/^(?=::)/$class/; $_; } @paths ],
2460 my @comps = $locator->plugins;
2465 =head2 $c->expand_component_module( $component, $setup_component_config )
2467 Components found by C<locate_components> will be passed to this method, which
2468 is expected to return a list of component (package) names to be set up.
2472 sub expand_component_module {
2473 my ($class, $module) = @_;
2474 return Devel::InnerPackage::list_packages( $module );
2477 =head2 $c->setup_component
2481 sub setup_component {
2482 my( $class, $component ) = @_;
2484 unless ( $component->can( 'COMPONENT' ) ) {
2488 my $suffix = Catalyst::Utils::class2classsuffix( $component );
2489 my $config = $class->config->{ $suffix } || {};
2490 # Stash catalyst_component_name in the config here, so that custom COMPONENT
2491 # methods also pass it. local to avoid pointlessly shitting in config
2492 # for the debug screen, as $component is already the key name.
2493 local $config->{catalyst_component_name} = $component;
2495 my $instance = eval { $component->COMPONENT( $class, $config ); };
2497 if ( my $error = $@ ) {
2499 Catalyst::Exception->throw(
2500 message => qq/Couldn't instantiate component "$component", "$error"/
2504 unless (blessed $instance) {
2505 my $metaclass = Moose::Util::find_meta($component);
2506 my $method_meta = $metaclass->find_method_by_name('COMPONENT');
2507 my $component_method_from = $method_meta->associated_metaclass->name;
2508 my $value = defined($instance) ? $instance : 'undef';
2509 Catalyst::Exception->throw(
2511 qq/Couldn't instantiate component "$component", COMPONENT() method (from $component_method_from) didn't return an object-like value (value was $value)./
2517 =head2 $c->setup_dispatcher
2523 sub setup_dispatcher {
2524 my ( $class, $dispatcher ) = @_;
2527 $dispatcher = 'Catalyst::Dispatcher::' . $dispatcher;
2530 if ( my $env = Catalyst::Utils::env_value( $class, 'DISPATCHER' ) ) {
2531 $dispatcher = 'Catalyst::Dispatcher::' . $env;
2534 unless ($dispatcher) {
2535 $dispatcher = $class->dispatcher_class;
2538 Class::MOP::load_class($dispatcher);
2540 # dispatcher instance
2541 $class->dispatcher( $dispatcher->new );
2544 =head2 $c->setup_engine
2551 my ($class, $engine) = @_;
2554 $engine = $class->engine_class;
2557 $engine = String::RewritePrefix->rewrite( { '' => 'Catalyst::Engine::', '+' => '' }, $engine );
2560 $engine = 'Catalyst::Engine' if $engine eq 'Catalyst::Engine::HTTP';
2562 Class::MOP::load_class($engine);
2564 # check for old engines that are no longer compatible
2566 if ( $engine->isa('Catalyst::Engine::Apache')
2567 && !Catalyst::Engine::Apache->VERSION )
2572 elsif ( $engine->isa('Catalyst::Engine::Server::Base')
2573 && Catalyst::Engine::Server->VERSION le '0.02' )
2578 elsif ($engine->isa('Catalyst::Engine::HTTP::POE')
2579 && $engine->VERSION eq '0.01' )
2584 elsif ($engine->isa('Catalyst::Engine::Zeus')
2585 && $engine->VERSION eq '0.01' )
2591 Catalyst::Exception->throw( message =>
2592 qq/Engine "$engine" is not supported by this version of Catalyst/
2596 if ($ENV{MOD_PERL}) {
2598 $class->meta->add_method(handler => sub { shift->handle_request(@_) });
2601 $class->engine( $engine->new );
2602 $class->psgi_app( $class->engine->build_psgi_app($class) );
2605 =head2 $c->setup_home
2607 Sets up the home directory.
2612 my ( $class, $home ) = @_;
2614 if ( my $env = Catalyst::Utils::env_value( $class, 'HOME' ) ) {
2618 $home ||= Catalyst::Utils::home($class);
2621 #I remember recently being scolded for assigning config values like this
2622 $class->config->{home} ||= $home;
2623 $class->config->{root} ||= Path::Class::Dir->new($home)->subdir('root');
2627 =head2 $c->setup_log
2629 Sets up log by instantiating a L<Catalyst::Log|Catalyst::Log> object and
2630 passing it to C<log()>. Pass in a comma-delimited list of levels to set the
2633 This method also installs a C<debug> method that returns a true value into the
2634 catalyst subclass if the "debug" level is passed in the comma-delimited list,
2635 or if the C<$CATALYST_DEBUG> environment variable is set to a true value.
2637 Note that if the log has already been setup, by either a previous call to
2638 C<setup_log> or by a call such as C<< __PACKAGE__->log( MyLogger->new ) >>,
2639 that this method won't actually set up the log object.
2644 my ( $class, $levels ) = @_;
2647 $levels =~ s/^\s+//;
2648 $levels =~ s/\s+$//;
2649 my %levels = map { $_ => 1 } split /\s*,\s*/, $levels;
2651 my $env_debug = Catalyst::Utils::env_value( $class, 'DEBUG' );
2652 if ( defined $env_debug ) {
2653 $levels{debug} = 1 if $env_debug; # Ugly!
2654 delete($levels{debug}) unless $env_debug;
2657 unless ( $class->log ) {
2658 $class->log( Catalyst::Log->new(keys %levels) );
2661 if ( $levels{debug} ) {
2662 Class::MOP::get_metaclass_by_name($class)->add_method('debug' => sub { 1 });
2663 $class->log->debug('Debug messages enabled');
2667 =head2 $c->setup_plugins
2673 =head2 $c->setup_stats
2675 Sets up timing statistics class.
2680 my ( $class, $stats ) = @_;
2682 Catalyst::Utils::ensure_class_loaded($class->stats_class);
2684 my $env = Catalyst::Utils::env_value( $class, 'STATS' );
2685 if ( defined($env) ? $env : ($stats || $class->debug ) ) {
2686 Class::MOP::get_metaclass_by_name($class)->add_method('use_stats' => sub { 1 });
2687 $class->log->debug('Statistics enabled');
2692 =head2 $c->registered_plugins
2694 Returns a sorted list of the plugins which have either been stated in the
2695 import list or which have been added via C<< MyApp->plugin(@args); >>.
2697 If passed a given plugin name, it will report a boolean value indicating
2698 whether or not that plugin is loaded. A fully qualified name is required if
2699 the plugin name does not begin with C<Catalyst::Plugin::>.
2701 if ($c->registered_plugins('Some::Plugin')) {
2709 sub registered_plugins {
2711 return sort keys %{ $proto->_plugins } unless @_;
2713 return 1 if exists $proto->_plugins->{$plugin};
2714 return exists $proto->_plugins->{"Catalyst::Plugin::$plugin"};
2717 sub _register_plugin {
2718 my ( $proto, $plugin, $instant ) = @_;
2719 my $class = ref $proto || $proto;
2721 Class::MOP::load_class( $plugin );
2722 $class->log->warn( "$plugin inherits from 'Catalyst::Component' - this is decated and will not work in 5.81" )
2723 if $plugin->isa( 'Catalyst::Component' );
2724 $proto->_plugins->{$plugin} = 1;
2726 my $meta = Class::MOP::get_metaclass_by_name($class);
2727 $meta->superclasses($plugin, $meta->superclasses);
2733 my ( $class, $plugins ) = @_;
2735 $class->_plugins( {} ) unless $class->_plugins;
2736 $plugins = Data::OptList::mkopt($plugins || []);
2739 [ Catalyst::Utils::resolve_namespace(
2740 $class . '::Plugin',
2741 'Catalyst::Plugin', $_->[0]
2747 for my $plugin ( reverse @plugins ) {
2748 Class::MOP::load_class($plugin->[0], $plugin->[1]);
2749 my $meta = find_meta($plugin->[0]);
2750 next if $meta && $meta->isa('Moose::Meta::Role');
2752 $class->_register_plugin($plugin->[0]);
2756 map { $_->[0]->name, $_->[1] }
2757 grep { blessed($_->[0]) && $_->[0]->isa('Moose::Meta::Role') }
2758 map { [find_meta($_->[0]), $_->[1]] }
2761 Moose::Util::apply_all_roles(
2769 Returns an arrayref of the internal execution stack (actions that are
2770 currently executing).
2774 Returns the current timing statistics object. By default Catalyst uses
2775 L<Catalyst::Stats|Catalyst::Stats>, but can be set otherwise with
2776 L<< stats_class|/"$c->stats_class" >>.
2778 Even if L<< -Stats|/"-Stats" >> is not enabled, the stats object is still
2779 available. By enabling it with C< $c->stats->enabled(1) >, it can be used to
2780 profile explicitly, although MyApp.pm still won't profile nor output anything
2783 =head2 $c->stats_class
2785 Returns or sets the stats (timing statistics) class. L<Catalyst::Stats|Catalyst::Stats> is used by default.
2787 =head2 $c->use_stats
2789 Returns 1 when L<< stats collection|/"-Stats" >> is enabled.
2791 Note that this is a static method, not an accessor and should be overridden
2792 by declaring C<sub use_stats { 1 }> in your MyApp.pm, not by calling C<< $c->use_stats(1) >>.
2799 =head2 $c->write( $data )
2801 Writes $data to the output stream. When using this method directly, you
2802 will need to manually set the C<Content-Length> header to the length of
2803 your output data, if known.
2810 # Finalize headers if someone manually writes output
2811 $c->finalize_headers;
2813 return $c->engine->write( $c, @_ );
2818 Returns the Catalyst version number. Mostly useful for "powered by"
2819 messages in template systems.
2823 sub version { return $Catalyst::VERSION }
2825 =head1 CONFIGURATION
2827 There are a number of 'base' config variables which can be set:
2833 C<default_model> - The default model picked if you say C<< $c->model >>. See L<< /$c->model($name) >>.
2837 C<default_view> - The default view to be rendered or returned when C<< $c->view >> is called. See L<< /$c->view($name) >>.
2841 C<disable_component_resolution_regex_fallback> - Turns
2842 off the deprecated component resolution functionality so
2843 that if any of the component methods (e.g. C<< $c->controller('Foo') >>)
2844 are called then regex search will not be attempted on string values and
2845 instead C<undef> will be returned.
2849 C<home> - The application home directory. In an uninstalled application,
2850 this is the top level application directory. In an installed application,
2851 this will be the directory containing C<< MyApp.pm >>.
2855 C<ignore_frontend_proxy> - See L</PROXY SUPPORT>
2859 C<name> - The name of the application in debug messages and the debug and
2864 C<parse_on_demand> - The request body (for example file uploads) will not be parsed
2865 until it is accessed. This allows you to (for example) check authentication (and reject
2866 the upload) before actually recieving all the data. See L</ON-DEMAND PARSER>
2870 C<root> - The root directory for templates. Usually this is just a
2871 subdirectory of the home directory, but you can set it to change the
2872 templates to a different directory.
2876 C<search_extra> - Array reference passed to Module::Pluggable to for additional
2877 namespaces from which components will be loaded (and constructed and stored in
2878 C<< $c->components >>).
2882 C<show_internal_actions> - If true, causes internal actions such as C<< _DISPATCH >>
2883 to be shown in hit debug tables in the test server.
2887 C<use_request_uri_for_path> - Controlls if the C<REQUEST_URI> or C<PATH_INFO> environment
2888 variable should be used for determining the request path. See L<Catalyst::Engine::CGI/PATH DECODING>
2889 for more information.
2893 C<using_frontend_proxy> - See L</PROXY SUPPORT>.
2897 =head1 INTERNAL ACTIONS
2899 Catalyst uses internal actions like C<_DISPATCH>, C<_BEGIN>, C<_AUTO>,
2900 C<_ACTION>, and C<_END>. These are by default not shown in the private
2901 action table, but you can make them visible with a config parameter.
2903 MyApp->config(show_internal_actions => 1);
2905 =head1 ON-DEMAND PARSER
2907 The request body is usually parsed at the beginning of a request,
2908 but if you want to handle input yourself, you can enable on-demand
2909 parsing with a config parameter.
2911 MyApp->config(parse_on_demand => 1);
2913 =head1 PROXY SUPPORT
2915 Many production servers operate using the common double-server approach,
2916 with a lightweight frontend web server passing requests to a larger
2917 backend server. An application running on the backend server must deal
2918 with two problems: the remote user always appears to be C<127.0.0.1> and
2919 the server's hostname will appear to be C<localhost> regardless of the
2920 virtual host that the user connected through.
2922 Catalyst will automatically detect this situation when you are running
2923 the frontend and backend servers on the same machine. The following
2924 changes are made to the request.
2926 $c->req->address is set to the user's real IP address, as read from
2927 the HTTP X-Forwarded-For header.
2929 The host value for $c->req->base and $c->req->uri is set to the real
2930 host, as read from the HTTP X-Forwarded-Host header.
2932 Additionally, you may be running your backend application on an insecure
2933 connection (port 80) while your frontend proxy is running under SSL. If there
2934 is a discrepancy in the ports, use the HTTP header C<X-Forwarded-Port> to
2935 tell Catalyst what port the frontend listens on. This will allow all URIs to
2936 be created properly.
2938 In the case of passing in:
2940 X-Forwarded-Port: 443
2942 All calls to C<uri_for> will result in an https link, as is expected.
2944 Obviously, your web server must support these headers for this to work.
2946 In a more complex server farm environment where you may have your
2947 frontend proxy server(s) on different machines, you will need to set a
2948 configuration option to tell Catalyst to read the proxied data from the
2951 MyApp->config(using_frontend_proxy => 1);
2953 If you do not wish to use the proxy support at all, you may set:
2955 MyApp->config(ignore_frontend_proxy => 1);
2957 =head1 THREAD SAFETY
2959 Catalyst has been tested under Apache 2's threading C<mpm_worker>,
2960 C<mpm_winnt>, and the standalone forking HTTP server on Windows. We
2961 believe the Catalyst core to be thread-safe.
2963 If you plan to operate in a threaded environment, remember that all other
2964 modules you are using must also be thread-safe. Some modules, most notably
2965 L<DBD::SQLite>, are not thread-safe.
2971 Join #catalyst on irc.perl.org.
2975 http://lists.scsys.co.uk/cgi-bin/mailman/listinfo/catalyst
2976 http://lists.scsys.co.uk/cgi-bin/mailman/listinfo/catalyst-dev
2980 http://catalyst.perl.org
2984 http://dev.catalyst.perl.org
2988 =head2 L<Task::Catalyst> - All you need to start with Catalyst
2990 =head2 L<Catalyst::Manual> - The Catalyst Manual
2992 =head2 L<Catalyst::Component>, L<Catalyst::Controller> - Base classes for components
2994 =head2 L<Catalyst::Engine> - Core engine
2996 =head2 L<Catalyst::Log> - Log class.
2998 =head2 L<Catalyst::Request> - Request object
3000 =head2 L<Catalyst::Response> - Response object
3002 =head2 L<Catalyst::Test> - The test suite.
3004 =head1 PROJECT FOUNDER
3006 sri: Sebastian Riedel <sri@cpan.org>
3012 acme: Leon Brocard <leon@astray.com>
3014 abraxxa: Alexander Hartmaier <abraxxa@cpan.org>
3018 Andrew Ford E<lt>A.Ford@ford-mason.co.ukE<gt>
3022 andyg: Andy Grundman <andy@hybridized.org>
3024 audreyt: Audrey Tang
3026 bricas: Brian Cassidy <bricas@cpan.org>
3028 Caelum: Rafael Kitover <rkitover@io.com>
3030 chansen: Christian Hansen
3032 chicks: Christopher Hicks
3034 Chisel Wright C<pause@herlpacker.co.uk>
3036 Danijel Milicevic C<me@danijel.de>
3038 David Kamholz E<lt>dkamholz@cpan.orgE<gt>
3040 David Naughton, C<naughton@umn.edu>
3044 dhoss: Devin Austin <dhoss@cpan.org>
3046 dkubb: Dan Kubb <dan.kubb-cpan@onautopilot.com>
3050 dwc: Daniel Westermann-Clark <danieltwc@cpan.org>
3052 esskar: Sascha Kiefer
3054 fireartist: Carl Franks <cfranks@cpan.org>
3056 frew: Arthur Axel "fREW" Schmidt <frioux@gmail.com>
3058 gabb: Danijel Milicevic
3062 Gavin Henry C<ghenry@perl.me.uk>
3066 groditi: Guillermo Roditi <groditi@gmail.com>
3068 hobbs: Andrew Rodland <andrew@cleverdomain.org>
3070 ilmari: Dagfinn Ilmari Mannsåker <ilmari@ilmari.org>
3072 jcamacho: Juan Camacho
3074 jester: Jesse Sheidlower C<jester@panix.com>
3076 jhannah: Jay Hannah <jay@jays.net>
3082 jon: Jon Schutz <jjschutz@cpan.org>
3084 Jonathan Rockway C<< <jrockway@cpan.org> >>
3086 Kieren Diment C<kd@totaldatasolution.com>
3088 konobi: Scott McWhirter <konobi@cpan.org>
3090 marcus: Marcus Ramberg <mramberg@cpan.org>
3092 miyagawa: Tatsuhiko Miyagawa <miyagawa@bulknews.net>
3094 mst: Matt S. Trout <mst@shadowcatsystems.co.uk>
3098 naughton: David Naughton
3100 ningu: David Kamholz <dkamholz@cpan.org>
3102 nothingmuch: Yuval Kogman <nothingmuch@woobling.org>
3104 numa: Dan Sully <daniel@cpan.org>
3110 omega: Andreas Marienborg
3112 Oleg Kostyuk <cub.uanic@gmail.com>
3114 phaylon: Robert Sedlacek <phaylon@dunkelheit.at>
3116 rafl: Florian Ragwitz <rafl@debian.org>
3118 random: Roland Lammel <lammel@cpan.org>
3120 Robert Sedlacek C<< <rs@474.at> >>
3122 SpiceMan: Marcel Montes
3126 szbalint: Balint Szilakszi <szbalint@cpan.org>
3128 t0m: Tomas Doran <bobtfish@bobtfish.net>
3132 Viljo Marrandi C<vilts@yahoo.com>
3134 Will Hawes C<info@whawes.co.uk>
3136 willert: Sebastian Willert <willert@cpan.org>
3138 wreis: Wallace Reis <wallace@reis.org.br>
3140 Yuval Kogman, C<nothingmuch@woobling.org>
3144 This library is free software. You can redistribute it and/or modify it under
3145 the same terms as Perl itself.
3151 __PACKAGE__->meta->make_immutable;