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::Util qw/first/;
31 use List::MoreUtils qw/uniq/;
34 use Carp qw/croak carp shortmess/;
36 BEGIN { require 5.008004; }
38 has stack => (is => 'ro', default => sub { [] });
39 has stash => (is => 'rw', default => sub { {} });
40 has state => (is => 'rw', default => 0);
41 has stats => (is => 'rw');
42 has action => (is => 'rw');
43 has counter => (is => 'rw', default => sub { {} });
44 has request => (is => 'rw', default => sub { $_[0]->request_class->new({}) }, required => 1, lazy => 1);
45 has response => (is => 'rw', default => sub { $_[0]->response_class->new({}) }, required => 1, lazy => 1);
46 has namespace => (is => 'rw');
48 sub depth { scalar @{ shift->stack || [] }; }
49 sub comp { shift->component(@_) }
52 my $self = shift; return $self->request(@_);
55 my $self = shift; return $self->response(@_);
58 # For backwards compatibility
59 sub finalize_output { shift->finalize_body(@_) };
64 our $RECURSION = 1000;
65 our $DETACH = Catalyst::Exception::Detach->new;
66 our $GO = Catalyst::Exception::Go->new;
68 #I imagine that very few of these really need to be class variables. if any.
69 #maybe we should just make them attributes with a default?
70 __PACKAGE__->mk_classdata($_)
71 for qw/container components arguments dispatcher engine log dispatcher_class
72 engine_class context_class request_class response_class stats_class
75 __PACKAGE__->dispatcher_class('Catalyst::Dispatcher');
76 __PACKAGE__->engine_class('Catalyst::Engine::CGI');
77 __PACKAGE__->request_class('Catalyst::Request');
78 __PACKAGE__->response_class('Catalyst::Response');
79 __PACKAGE__->stats_class('Catalyst::Stats');
81 # Remember to update this in Catalyst::Runtime as well!
83 our $VERSION = '5.80032';
86 my ( $class, @arguments ) = @_;
88 # We have to limit $class to Catalyst to avoid pushing Catalyst upon every
90 return unless $class eq 'Catalyst';
92 my $caller = caller();
93 return if $caller eq 'main';
95 my $meta = Moose::Meta::Class->initialize($caller);
96 unless ( $caller->isa('Catalyst') ) {
97 my @superclasses = ($meta->superclasses, $class, 'Catalyst::Controller');
98 $meta->superclasses(@superclasses);
100 # Avoid possible C3 issues if 'Moose::Object' is already on RHS of MyApp
101 $meta->superclasses(grep { $_ ne 'Moose::Object' } $meta->superclasses);
103 unless( $meta->has_method('meta') ){
104 if ($Moose::VERSION >= 1.15) {
105 $meta->_add_meta_method('meta');
108 $meta->add_method(meta => sub { Moose::Meta::Class->initialize("${caller}") } );
112 $caller->arguments( [@arguments] );
116 sub _application { $_[0] }
120 Catalyst - The Elegant MVC Web Application Framework
124 See the L<Catalyst::Manual> distribution for comprehensive
125 documentation and tutorials.
127 # Install Catalyst::Devel for helpers and other development tools
128 # use the helper to create a new application
131 # add models, views, controllers
132 script/myapp_create.pl model MyDatabase DBIC::Schema create=static dbi:SQLite:/path/to/db
133 script/myapp_create.pl view MyTemplate TT
134 script/myapp_create.pl controller Search
136 # built in testserver -- use -r to restart automatically on changes
137 # --help to see all available options
138 script/myapp_server.pl
140 # command line testing interface
141 script/myapp_test.pl /yada
144 use Catalyst qw/-Debug/; # include plugins here as well
146 ### In lib/MyApp/Controller/Root.pm (autocreated)
147 sub foo : Global { # called for /foo, /foo/1, /foo/1/2, etc.
148 my ( $self, $c, @args ) = @_; # args are qw/1 2/ for /foo/1/2
149 $c->stash->{template} = 'foo.tt'; # set the template
150 # lookup something from db -- stash vars are passed to TT
152 $c->model('Database::Foo')->search( { country => $args[0] } );
153 if ( $c->req->params->{bar} ) { # access GET or POST parameters
154 $c->forward( 'bar' ); # process another action
155 # do something else after forward returns
159 # The foo.tt TT template can use the stash data from the database
160 [% WHILE (item = data.next) %]
164 # called for /bar/of/soap, /bar/of/soap/10, etc.
165 sub bar : Path('/bar/of/soap') { ... }
167 # called for all actions, from the top-most controller downwards
169 my ( $self, $c ) = @_;
170 if ( !$c->user_exists ) { # Catalyst::Plugin::Authentication
171 $c->res->redirect( '/login' ); # require login
172 return 0; # abort request and go immediately to end()
174 return 1; # success; carry on to next action
177 # called after all actions are finished
179 my ( $self, $c ) = @_;
180 if ( scalar @{ $c->error } ) { ... } # handle errors
181 return if $c->res->body; # already have a response
182 $c->forward( 'MyApp::View::TT' ); # render template
185 ### in MyApp/Controller/Foo.pm
186 # called for /foo/bar
187 sub bar : Local { ... }
189 # called for /blargle
190 sub blargle : Global { ... }
192 # an index action matches /foo, but not /foo/1, etc.
193 sub index : Private { ... }
195 ### in MyApp/Controller/Foo/Bar.pm
196 # called for /foo/bar/baz
197 sub baz : Local { ... }
199 # first Root auto is called, then Foo auto, then this
200 sub auto : Private { ... }
202 # powerful regular expression paths are also possible
203 sub details : Regex('^product/(\w+)/details$') {
204 my ( $self, $c ) = @_;
205 # extract the (\w+) from the URI
206 my $product = $c->req->captures->[0];
209 See L<Catalyst::Manual::Intro> for additional information.
213 Catalyst is a modern framework for making web applications without the
214 pain usually associated with this process. This document is a reference
215 to the main Catalyst application. If you are a new user, we suggest you
216 start with L<Catalyst::Manual::Tutorial> or L<Catalyst::Manual::Intro>.
218 See L<Catalyst::Manual> for more documentation.
220 Catalyst plugins can be loaded by naming them as arguments to the "use
221 Catalyst" statement. Omit the C<Catalyst::Plugin::> prefix from the
222 plugin name, i.e., C<Catalyst::Plugin::My::Module> becomes
225 use Catalyst qw/My::Module/;
227 If your plugin starts with a name other than C<Catalyst::Plugin::>, you can
228 fully qualify the name by using a unary plus:
232 +Fully::Qualified::Plugin::Name
235 Special flags like C<-Debug> and C<-Engine> can also be specified as
236 arguments when Catalyst is loaded:
238 use Catalyst qw/-Debug My::Module/;
240 The position of plugins and flags in the chain is important, because
241 they are loaded in the order in which they appear.
243 The following flags are supported:
247 Enables debug output. You can also force this setting from the system
248 environment with CATALYST_DEBUG or <MYAPP>_DEBUG. The environment
249 settings override the application, with <MYAPP>_DEBUG having the highest
252 This sets the log level to 'debug' and enables full debug output on the
253 error screen. If you only want the latter, see L<< $c->debug >>.
257 Forces Catalyst to use a specific engine. Omit the
258 C<Catalyst::Engine::> prefix of the engine name, i.e.:
260 use Catalyst qw/-Engine=CGI/;
264 Forces Catalyst to use a specific home directory, e.g.:
266 use Catalyst qw[-Home=/usr/mst];
268 This can also be done in the shell environment by setting either the
269 C<CATALYST_HOME> environment variable or C<MYAPP_HOME>; where C<MYAPP>
270 is replaced with the uppercased name of your application, any "::" in
271 the name will be replaced with underscores, e.g. MyApp::Web should use
272 MYAPP_WEB_HOME. If both variables are set, the MYAPP_HOME one will be used.
274 If none of these are set, Catalyst will attempt to automatically detect the
275 home directory. If you are working in a development envirnoment, Catalyst
276 will try and find the directory containing either Makefile.PL, Build.PL or
277 dist.ini. If the application has been installed into the system (i.e.
278 you have done C<make install>), then Catalyst will use the path to your
279 application module, without the .pm extension (ie, /foo/MyApp if your
280 application was installed at /foo/MyApp.pm)
284 use Catalyst '-Log=warn,fatal,error';
286 Specifies a comma-delimited list of log levels.
290 Enables statistics collection and reporting.
292 use Catalyst qw/-Stats=1/;
294 You can also force this setting from the system environment with CATALYST_STATS
295 or <MYAPP>_STATS. The environment settings override the application, with
296 <MYAPP>_STATS having the highest priority.
298 Stats are also enabled if L<< debugging |/"-Debug" >> is enabled.
302 =head2 INFORMATION ABOUT THE CURRENT REQUEST
306 Returns a L<Catalyst::Action> object for the current action, which
307 stringifies to the action name. See L<Catalyst::Action>.
311 Returns the namespace of the current action, i.e., the URI prefix
312 corresponding to the controller of the current action. For example:
314 # in Controller::Foo::Bar
315 $c->namespace; # returns 'foo/bar';
321 Returns the current L<Catalyst::Request> object, giving access to
322 information about the current client request (including parameters,
323 cookies, HTTP headers, etc.). See L<Catalyst::Request>.
325 =head2 REQUEST FLOW HANDLING
327 =head2 $c->forward( $action [, \@arguments ] )
329 =head2 $c->forward( $class, $method, [, \@arguments ] )
331 Forwards processing to another action, by its private name. If you give a
332 class name but no method, C<process()> is called. You may also optionally
333 pass arguments in an arrayref. The action will receive the arguments in
334 C<@_> and C<< $c->req->args >>. Upon returning from the function,
335 C<< $c->req->args >> will be restored to the previous values.
337 Any data C<return>ed from the action forwarded to, will be returned by the
340 my $foodata = $c->forward('/foo');
341 $c->forward('index');
342 $c->forward(qw/Model::DBIC::Foo do_stuff/);
343 $c->forward('View::TT');
345 Note that L<< forward|/"$c->forward( $action [, \@arguments ] )" >> implies
346 an C<< eval { } >> around the call (actually
347 L<< execute|/"$c->execute( $class, $coderef )" >> does), thus de-fatalizing
348 all 'dies' within the called action. If you want C<die> to propagate you
349 need to do something like:
352 die join "\n", @{ $c->error } if @{ $c->error };
354 Or make sure to always return true values from your actions and write
357 $c->forward('foo') || return;
359 Another note is that C<< $c->forward >> always returns a scalar because it
360 actually returns $c->state which operates in a scalar context.
361 Thus, something like:
365 in an action that is forwarded to is going to return a scalar,
366 i.e. how many items are in that array, which is probably not what you want.
367 If you need to return an array then return a reference to it,
370 $c->stash->{array} = \@array;
372 and access it from the stash.
374 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.
378 sub forward { my $c = shift; no warnings 'recursion'; $c->dispatcher->forward( $c, @_ ) }
380 =head2 $c->detach( $action [, \@arguments ] )
382 =head2 $c->detach( $class, $method, [, \@arguments ] )
386 The same as L<< forward|/"$c->forward( $action [, \@arguments ] )" >>, but
387 doesn't return to the previous action when processing is finished.
389 When called with no arguments it escapes the processing chain entirely.
393 sub detach { my $c = shift; $c->dispatcher->detach( $c, @_ ) }
395 =head2 $c->visit( $action [, \@captures, \@arguments ] )
397 =head2 $c->visit( $class, $method, [, \@captures, \@arguments ] )
399 Almost the same as L<< forward|/"$c->forward( $action [, \@arguments ] )" >>,
400 but does a full dispatch, instead of just calling the new C<$action> /
401 C<< $class->$method >>. This means that C<begin>, C<auto> and the method
402 you go to are called, just like a new request.
404 In addition both C<< $c->action >> and C<< $c->namespace >> are localized.
405 This means, for example, that C<< $c->action >> methods such as
406 L<name|Catalyst::Action/name>, L<class|Catalyst::Action/class> and
407 L<reverse|Catalyst::Action/reverse> return information for the visited action
408 when they are invoked within the visited action. This is different from the
409 behavior of L<< forward|/"$c->forward( $action [, \@arguments ] )" >>, which
410 continues to use the $c->action object from the caller action even when
411 invoked from the callee.
413 C<< $c->stash >> is kept unchanged.
415 In effect, L<< visit|/"$c->visit( $action [, \@captures, \@arguments ] )" >>
416 allows you to "wrap" another action, just as it would have been called by
417 dispatching from a URL, while the analogous
418 L<< go|/"$c->go( $action [, \@captures, \@arguments ] )" >> allows you to
419 transfer control to another action as if it had been reached directly from a URL.
423 sub visit { my $c = shift; $c->dispatcher->visit( $c, @_ ) }
425 =head2 $c->go( $action [, \@captures, \@arguments ] )
427 =head2 $c->go( $class, $method, [, \@captures, \@arguments ] )
429 The relationship between C<go> and
430 L<< visit|/"$c->visit( $action [, \@captures, \@arguments ] )" >> is the same as
431 the relationship between
432 L<< forward|/"$c->forward( $class, $method, [, \@arguments ] )" >> and
433 L<< detach|/"$c->detach( $action [, \@arguments ] )" >>. Like C<< $c->visit >>,
434 C<< $c->go >> will perform a full dispatch on the specified action or method,
435 with localized C<< $c->action >> and C<< $c->namespace >>. Like C<detach>,
436 C<go> escapes the processing of the current request chain on completion, and
437 does not return to its caller.
439 @arguments are arguments to the final destination of $action. @captures are
440 arguments to the intermediate steps, if any, on the way to the final sub of
445 sub go { my $c = shift; $c->dispatcher->go( $c, @_ ) }
451 Returns the current L<Catalyst::Response> object, see there for details.
455 Returns a hashref to the stash, which may be used to store data and pass
456 it between components during a request. You can also set hash keys by
457 passing arguments. The stash is automatically sent to the view. The
458 stash is cleared at the end of a request; it cannot be used for
459 persistent storage (for this you must use a session; see
460 L<Catalyst::Plugin::Session> for a complete system integrated with
463 $c->stash->{foo} = $bar;
464 $c->stash( { moose => 'majestic', qux => 0 } );
465 $c->stash( bar => 1, gorch => 2 ); # equivalent to passing a hashref
467 # stash is automatically passed to the view for use in a template
468 $c->forward( 'MyApp::View::TT' );
472 around stash => sub {
475 my $stash = $orig->($c);
477 my $new_stash = @_ > 1 ? {@_} : $_[0];
478 croak('stash takes a hash or hashref') unless ref $new_stash;
479 foreach my $key ( keys %$new_stash ) {
480 $stash->{$key} = $new_stash->{$key};
490 =head2 $c->error($error, ...)
492 =head2 $c->error($arrayref)
494 Returns an arrayref containing error messages. If Catalyst encounters an
495 error while processing a request, it stores the error in $c->error. This
496 method should only be used to store fatal error messages.
498 my @error = @{ $c->error };
502 $c->error('Something bad happened');
509 my $error = ref $_[0] eq 'ARRAY' ? $_[0] : [@_];
510 croak @$error unless ref $c;
511 push @{ $c->{error} }, @$error;
513 elsif ( defined $_[0] ) { $c->{error} = undef }
514 return $c->{error} || [];
520 Contains the return value of the last executed action.
521 Note that << $c->state >> operates in a scalar context which means that all
522 values it returns are scalar.
524 =head2 $c->clear_errors
526 Clear errors. You probably don't want to clear the errors unless you are
527 implementing a custom error screen.
529 This is equivalent to running
540 =head2 COMPONENT ACCESSORS
542 =head2 $c->controller($name)
544 Gets a L<Catalyst::Controller> instance by name.
546 $c->controller('Foo')->do_stuff;
548 If the name is omitted, will return the controller for the dispatched
551 If you want to search for controllers, pass in a regexp as the argument.
553 # find all controllers that start with Foo
554 my @foo_controllers = $c->controller(qr{^Foo});
560 my ( $c, $name, @args ) = @_;
562 # FIXME: should this be a Catalyst::Utils method?
564 my $class = $c->action->class;
566 my $prefix = length Catalyst::Utils::class2classprefix($class);
568 # MyApp::Controller::Foo becomes Foo
569 # the + 2 is because of the ::
570 $name = substr $class, $prefix + 2;
573 return $c->container->get_component_from_sub_container( 'controller', $name, $c, @args);
576 =head2 $c->model($name)
578 Gets a L<Catalyst::Model> instance by name.
580 $c->model('Foo')->do_stuff;
582 Any extra arguments are directly passed to ACCEPT_CONTEXT.
584 If the name is omitted, it will look for
585 - a model object in $c->stash->{current_model_instance}, then
586 - a model name in $c->stash->{current_model}, then
587 - a config setting 'default_model', or
588 - check if there is only one model, and return it if that's the case.
590 If you want to search for models, pass in a regexp as the argument.
592 # find all models that start with Foo
593 my @foo_models = $c->model(qr{^Foo});
598 my ( $c, $name, @args ) = @_;
600 if (ref $c && !$name) {
601 return $c->stash->{current_model_instance}
602 if $c->stash->{current_model_instance};
604 $name = $c->stash->{current_model}
605 if $c->stash->{current_model};
608 return $c->container->get_component_from_sub_container( 'model', $name, $c, @args);
612 =head2 $c->view($name)
614 Gets a L<Catalyst::View> instance by name.
616 $c->view('Foo')->do_stuff;
618 Any extra arguments are directly passed to ACCEPT_CONTEXT.
620 If the name is omitted, it will look for
621 - a view object in $c->stash->{current_view_instance}, then
622 - a view name in $c->stash->{current_view}, then
623 - a config setting 'default_view', or
624 - check if there is only one view, and return it if that's the case.
626 If you want to search for views, pass in a regexp as the argument.
628 # find all views that start with Foo
629 my @foo_views = $c->view(qr{^Foo});
634 my ( $c, $name, @args ) = @_;
636 if (ref $c && !$name) {
637 return $c->stash->{current_view_instance}
638 if $c->stash->{current_view_instance};
640 $name = $c->stash->{current_view}
641 if $c->stash->{current_view};
644 return $c->container->get_component_from_sub_container( 'view', $name, $c, @args);
647 =head2 $c->controllers
649 Returns the available names which can be passed to $c->controller
655 return $c->container->get_sub_container('controller')->get_service_list;
660 Returns the available names which can be passed to $c->model
666 return $c->container->get_sub_container('model')->get_service_list;
672 Returns the available names which can be passed to $c->view
678 return $c->container->get_sub_container('view')->get_service_list;
681 =head2 $c->comp($name)
683 =head2 $c->component($name)
685 Gets a component object by name. This method is not recommended,
686 unless you want to get a specific component by full
687 class. C<< $c->controller >>, C<< $c->model >>, and C<< $c->view >>
688 should be used instead.
690 If C<$name> is a regexp, a list of components matched against the full
691 component name will be returned.
696 my ( $c, $component, @args ) = @_;
699 if (ref $component) {
701 for my $subcontainer_name (qw/model view controller/) {
702 my $subcontainer = $c->container->get_sub_container($subcontainer_name);
703 my @components = $subcontainer->get_service_list;
704 @result = grep { m{$component} } @components;
706 return map { $subcontainer->get_component( $_, $c, @args ) } @result
710 # it expects an empty list on failed searches
714 my ($type, $name) = _get_component_type_name($component);
716 if ($type && $c->container->has_sub_container($type)) {
717 my $container = $c->container->get_sub_container($type);
719 if ( !ref $component && $container->has_service($name) ) {
720 return $container->get_component( $name, $c, @args );
723 return $container->get_component_regexp( $name, $c, @args );
726 for my $subcontainer_name (qw/model view controller/) {
727 my $subcontainer = $c->container->get_sub_container($subcontainer_name);
728 my @components = $subcontainer->get_service_list;
729 my $result = first { $_ eq $component } @components;
731 return $subcontainer->get_component( $result, $c, @args )
737 # FIXME: I probably shouldn't be doing this
738 # I'm keeping it temporarily for things like $c->comp('MyApp')
739 return $c->components->{$component}
740 if exists $c->components->{$component} and !@args;
742 $c->log->warn("Looking for '$component', but nothing was found.");
744 # I would expect to return an empty list here, but that breaks back-compat
748 return sort keys %{ $c->components };
751 =head2 CLASS DATA AND HELPER CLASSES
755 Returns or takes a hashref containing the application's configuration.
757 __PACKAGE__->config( { db => 'dsn:SQLite:foo.db' } );
759 You can also use a C<YAML>, C<XML> or L<Config::General> config file
760 like C<myapp.conf> in your applications home directory. See
761 L<Catalyst::Plugin::ConfigLoader>.
763 =head3 Cascading configuration
765 The config method is present on all Catalyst components, and configuration
766 will be merged when an application is started. Configuration loaded with
767 L<Catalyst::Plugin::ConfigLoader> takes precedence over other configuration,
768 followed by configuration in your top level C<MyApp> class. These two
769 configurations are merged, and then configuration data whose hash key matches a
770 component name is merged with configuration for that component.
772 The configuration for a component is then passed to the C<new> method when a
773 component is constructed.
777 MyApp->config({ 'Model::Foo' => { bar => 'baz', overrides => 'me' } });
778 MyApp::Model::Foo->config({ quux => 'frob', overrides => 'this' });
780 will mean that C<MyApp::Model::Foo> receives the following data when
783 MyApp::Model::Foo->new({
789 It's common practice to use a Moose attribute
790 on the receiving component to access the config value.
792 package MyApp::Model::Foo;
796 # this attr will receive 'baz' at construction time
802 You can then get the value 'baz' by calling $c->model('Foo')->bar
803 (or $self->bar inside code in the model).
805 B<NOTE:> you MUST NOT call C<< $self->config >> or C<< __PACKAGE__->config >>
806 as a way of reading config within your code, as this B<will not> give you the
807 correctly merged config back. You B<MUST> take the config values supplied to
808 the constructor and use those instead.
812 around config => sub {
816 croak('Setting config after setup has been run is not allowed.')
817 if ( @_ and $c->setup_finished );
824 Returns the logging object instance. Unless it is already set, Catalyst
825 sets this up with a L<Catalyst::Log> object. To use your own log class,
826 set the logger with the C<< __PACKAGE__->log >> method prior to calling
827 C<< __PACKAGE__->setup >>.
829 __PACKAGE__->log( MyLogger->new );
834 $c->log->info( 'Now logging with my own logger!' );
836 Your log class should implement the methods described in
842 Returns 1 if debug mode is enabled, 0 otherwise.
844 You can enable debug mode in several ways:
848 =item By calling myapp_server.pl with the -d flag
850 =item With the environment variables MYAPP_DEBUG, or CATALYST_DEBUG
852 =item The -Debug option in your MyApp.pm
854 =item By declaring C<sub debug { 1 }> in your MyApp.pm.
858 The first three also set the log level to 'debug'.
860 Calling C<< $c->debug(1) >> has no effect.
866 =head2 $c->dispatcher
868 Returns the dispatcher instance. See L<Catalyst::Dispatcher>.
872 Returns the engine instance. See L<Catalyst::Engine>.
875 =head2 UTILITY METHODS
877 =head2 $c->path_to(@path)
879 Merges C<@path> with C<< $c->config->{home} >> and returns a
880 L<Path::Class::Dir> object. Note you can usually use this object as
881 a filename, but sometimes you will have to explicitly stringify it
882 yourself by calling the C<< ->stringify >> method.
886 $c->path_to( 'db', 'sqlite.db' );
891 my ( $c, @path ) = @_;
892 my $path = Path::Class::Dir->new( $c->config->{home}, @path );
893 if ( -d $path ) { return $path }
894 else { return Path::Class::File->new( $c->config->{home}, @path ) }
897 =head2 $c->plugin( $name, $class, @args )
899 Helper method for plugins. It creates a class data accessor/mutator and
900 loads and instantiates the given class.
902 MyApp->plugin( 'prototype', 'HTML::Prototype' );
904 $c->prototype->define_javascript_functions;
906 B<Note:> This method of adding plugins is deprecated. The ability
907 to add plugins like this B<will be removed> in a Catalyst 5.81.
908 Please do not use this functionality in new code.
913 my ( $class, $name, $plugin, @args ) = @_;
915 # See block comment in t/unit_core_plugin.t
916 $class->log->warn(qq/Adding plugin using the ->plugin method is deprecated, and will be removed in Catalyst 5.81/);
918 $class->_register_plugin( $plugin, 1 );
920 eval { $plugin->import };
921 $class->mk_classdata($name);
923 eval { $obj = $plugin->new(@args) };
926 Catalyst::Exception->throw( message =>
927 qq/Couldn't instantiate instant plugin "$plugin", "$@"/ );
931 $class->log->debug(qq/Initialized instant plugin "$plugin" as "$name"/)
937 Initializes the dispatcher and engine, loads any plugins, and loads the
938 model, view, and controller components. You may also specify an array
939 of plugins to load here, if you choose to not load them in the C<use
943 MyApp->setup( qw/-Debug/ );
948 my ( $class, @arguments ) = @_;
949 croak('Running setup more than once')
950 if ( $class->setup_finished );
952 unless ( $class->isa('Catalyst') ) {
954 Catalyst::Exception->throw(
955 message => qq/'$class' does not inherit from Catalyst/ );
958 if ( $class->arguments ) {
959 @arguments = ( @arguments, @{ $class->arguments } );
965 foreach (@arguments) {
969 ( $flags->{log} ) ? 'debug,' . $flags->{log} : 'debug';
971 elsif (/^-(\w+)=?(.*)$/) {
972 $flags->{ lc $1 } = $2;
975 push @{ $flags->{plugins} }, $_;
979 $class->setup_config();
980 $class->setup_home( delete $flags->{home} );
982 $class->setup_log( delete $flags->{log} );
983 $class->setup_plugins( delete $flags->{plugins} );
984 $class->setup_dispatcher( delete $flags->{dispatcher} );
985 $class->setup_engine( delete $flags->{engine} );
986 $class->setup_stats( delete $flags->{stats} );
988 for my $flag ( sort keys %{$flags} ) {
990 if ( my $code = $class->can( 'setup_' . $flag ) ) {
991 &$code( $class, delete $flags->{$flag} );
994 $class->log->warn(qq/Unknown flag "$flag"/);
998 eval { require Catalyst::Devel; };
999 if( !$@ && $ENV{CATALYST_SCRIPT_GEN} && ( $ENV{CATALYST_SCRIPT_GEN} < $Catalyst::Devel::CATALYST_SCRIPT_GEN ) ) {
1000 $class->log->warn(<<"EOF");
1001 You are running an old script!
1003 Please update by running (this will overwrite existing files):
1004 catalyst.pl -force -scripts $class
1006 or (this will not overwrite existing files):
1007 catalyst.pl -scripts $class
1012 if ( $class->debug ) {
1013 my @plugins = map { "$_ " . ( $_->VERSION || '' ) } $class->registered_plugins;
1016 my $column_width = Catalyst::Utils::term_width() - 6;
1017 my $t = Text::SimpleTable->new($column_width);
1018 $t->row($_) for @plugins;
1019 $class->log->debug( "Loaded plugins:\n" . $t->draw . "\n" );
1022 my $dispatcher = $class->dispatcher;
1023 my $engine = $class->engine;
1024 my $home = $class->config->{home};
1026 $class->log->debug(sprintf(q/Loaded dispatcher "%s"/, blessed($dispatcher)));
1027 $class->log->debug(sprintf(q/Loaded engine "%s"/, blessed($engine)));
1031 ? $class->log->debug(qq/Found home "$home"/)
1032 : $class->log->debug(qq/Home "$home" doesn't exist/)
1033 : $class->log->debug(q/Couldn't find home/);
1036 # Call plugins setup, this is stupid and evil.
1037 # Also screws C3 badly on 5.10, hack to avoid.
1039 no warnings qw/redefine/;
1040 local *setup = sub { };
1041 $class->setup unless $Catalyst::__AM_RESTARTING;
1044 # Initialize our data structure
1045 $class->components( {} );
1047 $class->setup_components;
1049 if ( $class->debug ) {
1050 my $column_width = Catalyst::Utils::term_width() - 8 - 9;
1051 my $t = Text::SimpleTable->new( [ $column_width, 'Class' ], [ 8, 'Type' ] );
1052 for my $comp ( sort keys %{ $class->components } ) {
1053 my $type = ref $class->components->{$comp} ? 'instance' : 'class';
1054 $t->row( $comp, $type );
1056 $class->log->debug( "Loaded components:\n" . $t->draw . "\n" )
1057 if ( keys %{ $class->components } );
1060 # Add our self to components, since we are also a component
1061 if( $class->isa('Catalyst::Controller') ){
1062 $class->components->{$class} = $class;
1065 $class->setup_actions;
1067 if ( $class->debug ) {
1068 my $name = $class->config->{name} || 'Application';
1069 $class->log->info("$name powered by Catalyst $Catalyst::VERSION");
1072 # Make sure that the application class becomes immutable at this point,
1073 B::Hooks::EndOfScope::on_scope_end {
1075 my $meta = Class::MOP::get_metaclass_by_name($class);
1078 && ! { $meta->immutable_options }->{replace_constructor}
1080 $class->isa('Class::Accessor::Fast')
1081 || $class->isa('Class::Accessor')
1084 warn "You made your application class ($class) immutable, "
1085 . "but did not inline the\nconstructor. "
1086 . "This will break catalyst, as your app \@ISA "
1087 . "Class::Accessor(::Fast)?\nPlease pass "
1088 . "(replace_constructor => 1)\nwhen making your class immutable.\n";
1090 $meta->make_immutable(
1091 replace_constructor => 1,
1092 ) unless $meta->is_immutable;
1095 if ($class->config->{case_sensitive}) {
1096 $class->log->warn($class . "->config->{case_sensitive} is set.");
1097 $class->log->warn("This setting is deprecated and planned to be removed in Catalyst 5.81.");
1100 $class->setup_finalize;
1101 # Should be the last thing we do so that user things hooking
1102 # setup_finalize can log..
1103 $class->log->_flush() if $class->log->can('_flush');
1104 return 1; # Explicit return true as people have __PACKAGE__->setup as the last thing in their class. HATE.
1107 =head2 $app->setup_finalize
1109 A hook to attach modifiers to. This method does not do anything except set the
1110 C<setup_finished> accessor.
1112 Applying method modifiers to the C<setup> method doesn't work, because of quirky things done for plugin setup.
1116 after setup_finalize => sub {
1124 sub setup_finalize {
1126 $class->setup_finished(1);
1129 =head2 $c->uri_for( $path?, @args?, \%query_values? )
1131 =head2 $c->uri_for( $action, \@captures?, @args?, \%query_values? )
1133 Constructs an absolute L<URI> object based on the application root, the
1134 provided path, and the additional arguments and query parameters provided.
1135 When used as a string, provides a textual URI. If you need more flexibility
1136 than this (i.e. the option to provide relative URIs etc.) see
1137 L<Catalyst::Plugin::SmartURI>.
1139 If no arguments are provided, the URI for the current action is returned.
1140 To return the current action and also provide @args, use
1141 C<< $c->uri_for( $c->action, @args ) >>.
1143 If the first argument is a string, it is taken as a public URI path relative
1144 to C<< $c->namespace >> (if it doesn't begin with a forward slash) or
1145 relative to the application root (if it does). It is then merged with
1146 C<< $c->request->base >>; any C<@args> are appended as additional path
1147 components; and any C<%query_values> are appended as C<?foo=bar> parameters.
1149 If the first argument is a L<Catalyst::Action> it represents an action which
1150 will have its path resolved using C<< $c->dispatcher->uri_for_action >>. The
1151 optional C<\@captures> argument (an arrayref) allows passing the captured
1152 variables that are needed to fill in the paths of Chained and Regex actions;
1153 once the path is resolved, C<uri_for> continues as though a path was
1154 provided, appending any arguments or parameters and creating an absolute
1157 The captures for the current request can be found in
1158 C<< $c->request->captures >>, and actions can be resolved using
1159 C<< Catalyst::Controller->action_for($name) >>. If you have a private action
1160 path, use C<< $c->uri_for_action >> instead.
1162 # Equivalent to $c->req->uri
1163 $c->uri_for($c->action, $c->req->captures,
1164 @{ $c->req->args }, $c->req->params);
1166 # For the Foo action in the Bar controller
1167 $c->uri_for($c->controller('Bar')->action_for('Foo'));
1169 # Path to a static resource
1170 $c->uri_for('/static/images/logo.png');
1175 my ( $c, $path, @args ) = @_;
1177 if (blessed($path) && $path->isa('Catalyst::Controller')) {
1178 $path = $path->path_prefix;
1183 undef($path) if (defined $path && $path eq '');
1186 ( scalar @args && ref $args[$#args] eq 'HASH' ? pop @args : {} );
1188 carp "uri_for called with undef argument" if grep { ! defined $_ } @args;
1189 foreach my $arg (@args) {
1190 utf8::encode($arg) if utf8::is_utf8($arg);
1191 $arg =~ s/([^$URI::uric])/$URI::Escape::escapes{$1}/go;
1194 if ( blessed($path) ) { # action object
1195 s|/|%2F|g for @args;
1196 my $captures = [ map { s|/|%2F|g; $_; }
1197 ( scalar @args && ref $args[0] eq 'ARRAY'
1201 foreach my $capture (@$captures) {
1202 utf8::encode($capture) if utf8::is_utf8($capture);
1203 $capture =~ s/([^$URI::uric])/$URI::Escape::escapes{$1}/go;
1207 $path = $c->dispatcher->uri_for_action($action, $captures);
1208 if (not defined $path) {
1209 $c->log->debug(qq/Can't find uri_for action '$action' @$captures/)
1213 $path = '/' if $path eq '';
1216 unshift(@args, $path);
1218 unless (defined $path && $path =~ s!^/!!) { # in-place strip
1219 my $namespace = $c->namespace;
1220 if (defined $path) { # cheesy hack to handle path '../foo'
1221 $namespace =~ s{(?:^|/)[^/]+$}{} while $args[0] =~ s{^\.\./}{};
1223 unshift(@args, $namespace || '');
1226 # join args with '/', or a blank string
1227 my $args = join('/', grep { defined($_) } @args);
1228 $args =~ s/\?/%3F/g; # STUPID STUPID SPECIAL CASE
1230 my $base = $c->req->base;
1231 my $class = ref($base);
1232 $base =~ s{(?<!/)$}{/};
1236 if (my @keys = keys %$params) {
1237 # somewhat lifted from URI::_query's query_form
1238 $query = '?'.join('&', map {
1239 my $val = $params->{$_};
1240 s/([;\/?:@&=+,\$\[\]%])/$URI::Escape::escapes{$1}/go;
1243 $val = '' unless defined $val;
1246 utf8::encode( $param ) if utf8::is_utf8($param);
1247 # using the URI::Escape pattern here so utf8 chars survive
1248 $param =~ s/([^A-Za-z0-9\-_.!~*'() ])/$URI::Escape::escapes{$1}/go;
1250 "${key}=$param"; } ( ref $val eq 'ARRAY' ? @$val : $val ));
1254 my $res = bless(\"${base}${args}${query}", $class);
1258 =head2 $c->uri_for_action( $path, \@captures?, @args?, \%query_values? )
1260 =head2 $c->uri_for_action( $action, \@captures?, @args?, \%query_values? )
1266 A private path to the Catalyst action you want to create a URI for.
1268 This is a shortcut for calling C<< $c->dispatcher->get_action_by_path($path)
1269 >> and passing the resulting C<$action> and the remaining arguments to C<<
1272 You can also pass in a Catalyst::Action object, in which case it is passed to
1275 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.
1277 For example, if the action looks like:
1279 package MyApp::Controller::Users;
1281 sub lst : Path('the-list') {}
1285 $c->uri_for_action('/users/lst')
1287 and it will create the URI /users/the-list.
1293 sub uri_for_action {
1294 my ( $c, $path, @args ) = @_;
1295 my $action = blessed($path)
1297 : $c->dispatcher->get_action_by_path($path);
1298 unless (defined $action) {
1299 croak "Can't find action for path '$path'";
1301 return $c->uri_for( $action, @args );
1304 =head2 $c->welcome_message
1306 Returns the Catalyst welcome HTML page.
1310 sub welcome_message {
1312 my $name = $c->config->{name};
1313 my $logo = $c->uri_for('/static/images/catalyst_logo.png');
1314 my $prefix = Catalyst::Utils::appprefix( ref $c );
1315 $c->response->content_type('text/html; charset=utf-8');
1317 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
1318 "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
1319 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
1321 <meta http-equiv="Content-Language" content="en" />
1322 <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
1323 <title>$name on Catalyst $VERSION</title>
1324 <style type="text/css">
1327 background-color: #eee;
1334 margin-bottom: 10px;
1336 background-color: #ccc;
1337 border: 1px solid #aaa;
1342 font-family: verdana, tahoma, sans-serif;
1345 font-family: verdana, tahoma, sans-serif;
1348 text-decoration: none;
1350 border-bottom: 1px dotted #bbb;
1352 :link:hover, :visited:hover {
1365 background-color: #fff;
1366 border: 1px solid #aaa;
1370 font-weight: normal;
1392 <h1><span id="appname">$name</span> on <a href="http://catalyst.perl.org">Catalyst</a>
1397 <img src="$logo" alt="Catalyst Logo" />
1399 <p>Welcome to the world of Catalyst.
1400 This <a href="http://en.wikipedia.org/wiki/MVC">MVC</a>
1401 framework will make web development something you had
1402 never expected it to be: Fun, rewarding, and quick.</p>
1403 <h2>What to do now?</h2>
1404 <p>That really depends on what <b>you</b> want to do.
1405 We do, however, provide you with a few starting points.</p>
1406 <p>If you want to jump right into web development with Catalyst
1407 you might want to start with a tutorial.</p>
1408 <pre>perldoc <a href="http://cpansearch.perl.org/dist/Catalyst-Manual/lib/Catalyst/Manual/Tutorial.pod">Catalyst::Manual::Tutorial</a></code>
1410 <p>Afterwards you can go on to check out a more complete look at our features.</p>
1412 <code>perldoc <a href="http://cpansearch.perl.org/dist/Catalyst-Manual/lib/Catalyst/Manual/Intro.pod">Catalyst::Manual::Intro</a>
1413 <!-- Something else should go here, but the Catalyst::Manual link seems unhelpful -->
1415 <h2>What to do next?</h2>
1416 <p>Next it's time to write an actual application. Use the
1417 helper scripts to generate <a href="http://cpansearch.perl.org/search?query=Catalyst%3A%3AController%3A%3A&mode=all">controllers</a>,
1418 <a href="http://cpansearch.perl.org/search?query=Catalyst%3A%3AModel%3A%3A&mode=all">models</a>, and
1419 <a href="http://cpansearch.perl.org/search?query=Catalyst%3A%3AView%3A%3A&mode=all">views</a>;
1420 they can save you a lot of work.</p>
1421 <pre><code>script/${prefix}_create.pl --help</code></pre>
1422 <p>Also, be sure to check out the vast and growing
1423 collection of <a href="http://search.cpan.org/search?query=Catalyst">plugins for Catalyst on CPAN</a>;
1424 you are likely to find what you need there.
1428 <p>Catalyst has a very active community. Here are the main places to
1429 get in touch with us.</p>
1432 <a href="http://dev.catalyst.perl.org">Wiki</a>
1435 <a href="http://lists.scsys.co.uk/cgi-bin/mailman/listinfo/catalyst">Mailing-List</a>
1438 <a href="irc://irc.perl.org/catalyst">IRC channel #catalyst on irc.perl.org</a>
1441 <h2>In conclusion</h2>
1442 <p>The Catalyst team hopes you will enjoy using Catalyst as much
1443 as we enjoyed making it. Please contact us if you have ideas
1444 for improvement or other feedback.</p>
1452 =head1 INTERNAL METHODS
1454 These methods are not meant to be used by end users.
1456 =head2 $c->components
1458 Returns a hash of components.
1462 around components => sub {
1467 return $class->$orig if ( !$comps );
1469 # FIXME: should this ugly kludge exist?
1470 $class->setup_config unless defined $class->container;
1472 # FIXME: should there be a warning here, not to use this accessor to create the components?
1473 my $components = {};
1476 $containers->{$_} = $class->container->get_sub_container($_) for qw(model view controller);
1478 for my $component ( keys %$comps ) {
1479 $components->{ $component } = $comps->{$component};
1481 my ($type, $name) = _get_component_type_name($component);
1483 $containers->{$type}->add_service(Catalyst::IOC::BlockInjection->new( name => $name, block => sub { return $class->setup_component($component) } ));
1486 return $class->$orig($components);
1489 =head2 $c->context_class
1491 Returns or sets the context class.
1495 Returns a hashref containing coderefs and execution counts (needed for
1496 deep recursion detection).
1500 Returns the number of actions on the current internal execution stack.
1504 Dispatches a request to actions.
1508 sub dispatch { my $c = shift; $c->dispatcher->dispatch( $c, @_ ) }
1510 =head2 $c->dispatcher_class
1512 Returns or sets the dispatcher class.
1514 =head2 $c->dump_these
1516 Returns a list of 2-element array references (name, structure) pairs
1517 that will be dumped on the error page in debug mode.
1523 [ Request => $c->req ],
1524 [ Response => $c->res ],
1525 [ Stash => $c->stash ],
1526 [ Config => $c->config ];
1529 =head2 $c->engine_class
1531 Returns or sets the engine class.
1533 =head2 $c->execute( $class, $coderef )
1535 Execute a coderef in given class and catch exceptions. Errors are available
1541 my ( $c, $class, $code ) = @_;
1542 $class = $c->component($class) || $class;
1545 if ( $c->depth >= $RECURSION ) {
1546 my $action = $code->reverse();
1547 $action = "/$action" unless $action =~ /->/;
1548 my $error = qq/Deep recursion detected calling "${action}"/;
1549 $c->log->error($error);
1555 my $stats_info = $c->_stats_start_execute( $code ) if $c->use_stats;
1557 push( @{ $c->stack }, $code );
1559 no warnings 'recursion';
1560 # N.B. This used to be combined, but I have seen $c get clobbered if so, and
1561 # I have no idea how, ergo $ret (which appears to fix the issue)
1562 eval { my $ret = $code->execute( $class, $c, @{ $c->req->args } ) || 0; $c->state( $ret ) };
1564 $c->_stats_finish_execute( $stats_info ) if $c->use_stats and $stats_info;
1566 my $last = pop( @{ $c->stack } );
1568 if ( my $error = $@ ) {
1569 if ( blessed($error) and $error->isa('Catalyst::Exception::Detach') ) {
1570 $error->rethrow if $c->depth > 1;
1572 elsif ( blessed($error) and $error->isa('Catalyst::Exception::Go') ) {
1573 $error->rethrow if $c->depth > 0;
1576 unless ( ref $error ) {
1577 no warnings 'uninitialized';
1579 my $class = $last->class;
1580 my $name = $last->name;
1581 $error = qq/Caught exception in $class->$name "$error"/;
1590 sub _stats_start_execute {
1591 my ( $c, $code ) = @_;
1592 my $appclass = ref($c) || $c;
1593 return if ( ( $code->name =~ /^_.*/ )
1594 && ( !$appclass->config->{show_internal_actions} ) );
1596 my $action_name = $code->reverse();
1597 $c->counter->{$action_name}++;
1599 my $action = $action_name;
1600 $action = "/$action" unless $action =~ /->/;
1602 # determine if the call was the result of a forward
1603 # this is done by walking up the call stack and looking for a calling
1604 # sub of Catalyst::forward before the eval
1606 for my $index ( 2 .. 11 ) {
1608 if ( ( caller($index) )[0] eq 'Catalyst'
1609 && ( caller($index) )[3] eq '(eval)' );
1611 if ( ( caller($index) )[3] =~ /forward$/ ) {
1612 $callsub = ( caller($index) )[3];
1613 $action = "-> $action";
1618 my $uid = $action_name . $c->counter->{$action_name};
1620 # is this a root-level call or a forwarded call?
1621 if ( $callsub =~ /forward$/ ) {
1622 my $parent = $c->stack->[-1];
1624 # forward, locate the caller
1625 if ( defined $parent && exists $c->counter->{"$parent"} ) {
1628 parent => "$parent" . $c->counter->{"$parent"},
1634 # forward with no caller may come from a plugin
1653 sub _stats_finish_execute {
1654 my ( $c, $info ) = @_;
1655 $c->stats->profile( end => $info );
1660 Finalizes the request.
1667 for my $error ( @{ $c->error } ) {
1668 $c->log->error($error);
1671 # Allow engine to handle finalize flow (for POE)
1672 my $engine = $c->engine;
1673 if ( my $code = $engine->can('finalize') ) {
1678 $c->finalize_uploads;
1681 if ( $#{ $c->error } >= 0 ) {
1685 $c->finalize_headers;
1688 if ( $c->request->method eq 'HEAD' ) {
1689 $c->response->body('');
1697 if ($c->use_stats) {
1698 my $elapsed = sprintf '%f', $c->stats->elapsed;
1699 my $av = $elapsed == 0 ? '??' : sprintf '%.3f', 1 / $elapsed;
1701 "Request took ${elapsed}s ($av/s)\n" . $c->stats->report . "\n" );
1704 return $c->response->status;
1707 =head2 $c->finalize_body
1713 sub finalize_body { my $c = shift; $c->engine->finalize_body( $c, @_ ) }
1715 =head2 $c->finalize_cookies
1721 sub finalize_cookies { my $c = shift; $c->engine->finalize_cookies( $c, @_ ) }
1723 =head2 $c->finalize_error
1729 sub finalize_error { my $c = shift; $c->engine->finalize_error( $c, @_ ) }
1731 =head2 $c->finalize_headers
1737 sub finalize_headers {
1740 my $response = $c->response; #accessor calls can add up?
1742 # Check if we already finalized headers
1743 return if $response->finalized_headers;
1746 if ( my $location = $response->redirect ) {
1747 $c->log->debug(qq/Redirecting to "$location"/) if $c->debug;
1748 $response->header( Location => $location );
1750 if ( !$response->has_body ) {
1751 # Add a default body if none is already present
1753 qq{<html><body><p>This item has moved <a href="$location">here</a>.</p></body></html>}
1759 if ( defined $response->body && length $response->body && !$response->content_length ) {
1761 # get the length from a filehandle
1762 if ( blessed( $response->body ) && $response->body->can('read') || ref( $response->body ) eq 'GLOB' )
1764 my $stat = stat $response->body;
1765 if ( $stat && $stat->size > 0 ) {
1766 $response->content_length( $stat->size );
1769 $c->log->warn('Serving filehandle without a content-length');
1773 # everything should be bytes at this point, but just in case
1774 $response->content_length( length( $response->body ) );
1779 if ( $response->status =~ /^(1\d\d|[23]04)$/ ) {
1780 $response->headers->remove_header("Content-Length");
1781 $response->body('');
1784 $c->finalize_cookies;
1786 $c->engine->finalize_headers( $c, @_ );
1789 $response->finalized_headers(1);
1792 =head2 $c->finalize_output
1794 An alias for finalize_body.
1796 =head2 $c->finalize_read
1798 Finalizes the input after reading is complete.
1802 sub finalize_read { my $c = shift; $c->engine->finalize_read( $c, @_ ) }
1804 =head2 $c->finalize_uploads
1806 Finalizes uploads. Cleans up any temporary files.
1810 sub finalize_uploads { my $c = shift; $c->engine->finalize_uploads( $c, @_ ) }
1812 =head2 $c->get_action( $action, $namespace )
1814 Gets an action in a given namespace.
1818 sub get_action { my $c = shift; $c->dispatcher->get_action(@_) }
1820 =head2 $c->get_actions( $action, $namespace )
1822 Gets all actions of a given name in a namespace and all parent
1827 sub get_actions { my $c = shift; $c->dispatcher->get_actions( $c, @_ ) }
1829 =head2 $app->handle_request( @arguments )
1831 Called to handle each HTTP request.
1835 sub handle_request {
1836 my ( $class, @arguments ) = @_;
1838 # Always expect worst case!
1841 if ($class->debug) {
1842 my $secs = time - $START || 1;
1843 my $av = sprintf '%.3f', $COUNT / $secs;
1844 my $time = localtime time;
1845 $class->log->info("*** Request $COUNT ($av/s) [$$] [$time] ***");
1848 my $c = $class->prepare(@arguments);
1850 $status = $c->finalize;
1853 if ( my $error = $@ ) {
1855 $class->log->error(qq/Caught exception in engine "$error"/);
1860 if(my $coderef = $class->log->can('_flush')){
1861 $class->log->$coderef();
1866 =head2 $c->prepare( @arguments )
1868 Creates a Catalyst context from an engine-specific request (Apache, CGI,
1874 my ( $class, @arguments ) = @_;
1877 # After the app/ctxt split, this should become an attribute based on something passed
1878 # into the application.
1879 $class->context_class( ref $class || $class ) unless $class->context_class;
1881 my $c = $class->context_class->new({});
1883 # For on-demand data
1884 $c->request->_context($c);
1885 $c->response->_context($c);
1887 #surely this is not the most efficient way to do things...
1888 $c->stats($class->stats_class->new)->enable($c->use_stats);
1889 if ( $c->debug || $c->config->{enable_catalyst_header} ) {
1890 $c->res->headers->header( 'X-Catalyst' => $Catalyst::VERSION );
1893 #XXX reuse coderef from can
1894 # Allow engine to direct the prepare flow (for POE)
1895 if ( $c->engine->can('prepare') ) {
1896 $c->engine->prepare( $c, @arguments );
1899 $c->prepare_request(@arguments);
1900 $c->prepare_connection;
1901 $c->prepare_query_parameters;
1902 $c->prepare_headers;
1903 $c->prepare_cookies;
1906 # Prepare the body for reading, either by prepare_body
1907 # or the user, if they are using $c->read
1910 # Parse the body unless the user wants it on-demand
1911 unless ( ref($c)->config->{parse_on_demand} ) {
1916 my $method = $c->req->method || '';
1917 my $path = $c->req->path;
1918 $path = '/' unless length $path;
1919 my $address = $c->req->address || '';
1928 =head2 $c->prepare_action
1930 Prepares action. See L<Catalyst::Dispatcher>.
1934 sub prepare_action { my $c = shift; $c->dispatcher->prepare_action( $c, @_ ) }
1936 =head2 $c->prepare_body
1938 Prepares message body.
1945 return if $c->request->_has_body;
1947 # Initialize on-demand data
1948 $c->engine->prepare_body( $c, @_ );
1949 $c->prepare_parameters;
1950 $c->prepare_uploads;
1953 =head2 $c->prepare_body_chunk( $chunk )
1955 Prepares a chunk of data before sending it to L<HTTP::Body>.
1957 See L<Catalyst::Engine>.
1961 sub prepare_body_chunk {
1963 $c->engine->prepare_body_chunk( $c, @_ );
1966 =head2 $c->prepare_body_parameters
1968 Prepares body parameters.
1972 sub prepare_body_parameters {
1974 $c->engine->prepare_body_parameters( $c, @_ );
1977 =head2 $c->prepare_connection
1979 Prepares connection.
1983 sub prepare_connection {
1985 $c->engine->prepare_connection( $c, @_ );
1988 =head2 $c->prepare_cookies
1994 sub prepare_cookies { my $c = shift; $c->engine->prepare_cookies( $c, @_ ) }
1996 =head2 $c->prepare_headers
2002 sub prepare_headers { my $c = shift; $c->engine->prepare_headers( $c, @_ ) }
2004 =head2 $c->prepare_parameters
2006 Prepares parameters.
2010 sub prepare_parameters {
2012 $c->prepare_body_parameters;
2013 $c->engine->prepare_parameters( $c, @_ );
2016 =head2 $c->prepare_path
2018 Prepares path and base.
2022 sub prepare_path { my $c = shift; $c->engine->prepare_path( $c, @_ ) }
2024 =head2 $c->prepare_query_parameters
2026 Prepares query parameters.
2030 sub prepare_query_parameters {
2033 $c->engine->prepare_query_parameters( $c, @_ );
2036 =head2 $c->log_request
2038 Writes information about the request to the debug logs. This includes:
2042 =item * Request method, path, and remote IP address
2044 =item * Query keywords (see L<Catalyst::Request/query_keywords>)
2046 =item * Request parameters
2048 =item * File uploads
2057 return unless $c->debug;
2059 my($dump) = grep {$_->[0] eq 'Request' } $c->dump_these;
2060 my $request = $dump->[1];
2062 my ( $method, $path, $address ) = ( $request->method, $request->path, $request->address );
2064 $path = '/' unless length $path;
2066 $c->log->debug(qq/"$method" request for "$path" from "$address"/);
2068 $c->log_request_headers($request->headers);
2070 if ( my $keywords = $request->query_keywords ) {
2071 $c->log->debug("Query keywords are: $keywords");
2074 $c->log_request_parameters( query => $request->query_parameters, $request->_has_body ? (body => $request->body_parameters) : () );
2076 $c->log_request_uploads($request);
2079 =head2 $c->log_response
2081 Writes information about the response to the debug logs by calling
2082 C<< $c->log_response_status_line >> and C<< $c->log_response_headers >>.
2089 return unless $c->debug;
2091 my($dump) = grep {$_->[0] eq 'Response' } $c->dump_these;
2092 my $response = $dump->[1];
2094 $c->log_response_status_line($response);
2095 $c->log_response_headers($response->headers);
2098 =head2 $c->log_response_status_line($response)
2100 Writes one line of information about the response to the debug logs. This includes:
2104 =item * Response status code
2106 =item * Content-Type header (if present)
2108 =item * Content-Length header (if present)
2114 sub log_response_status_line {
2115 my ($c, $response) = @_;
2119 'Response Code: %s; Content-Type: %s; Content-Length: %s',
2120 $response->status || 'unknown',
2121 $response->headers->header('Content-Type') || 'unknown',
2122 $response->headers->header('Content-Length') || 'unknown'
2127 =head2 $c->log_response_headers($headers);
2129 Hook method which can be wrapped by plugins to log the responseheaders.
2130 No-op in the default implementation.
2134 sub log_response_headers {}
2136 =head2 $c->log_request_parameters( query => {}, body => {} )
2138 Logs request parameters to debug logs
2142 sub log_request_parameters {
2144 my %all_params = @_;
2146 return unless $c->debug;
2148 my $column_width = Catalyst::Utils::term_width() - 44;
2149 foreach my $type (qw(query body)) {
2150 my $params = $all_params{$type};
2151 next if ! keys %$params;
2152 my $t = Text::SimpleTable->new( [ 35, 'Parameter' ], [ $column_width, 'Value' ] );
2153 for my $key ( sort keys %$params ) {
2154 my $param = $params->{$key};
2155 my $value = defined($param) ? $param : '';
2156 $t->row( $key, ref $value eq 'ARRAY' ? ( join ', ', @$value ) : $value );
2158 $c->log->debug( ucfirst($type) . " Parameters are:\n" . $t->draw );
2162 =head2 $c->log_request_uploads
2164 Logs file uploads included in the request to the debug logs.
2165 The parameter name, filename, file type, and file size are all included in
2170 sub log_request_uploads {
2172 my $request = shift;
2173 return unless $c->debug;
2174 my $uploads = $request->uploads;
2175 if ( keys %$uploads ) {
2176 my $t = Text::SimpleTable->new(
2177 [ 12, 'Parameter' ],
2182 for my $key ( sort keys %$uploads ) {
2183 my $upload = $uploads->{$key};
2184 for my $u ( ref $upload eq 'ARRAY' ? @{$upload} : ($upload) ) {
2185 $t->row( $key, $u->filename, $u->type, $u->size );
2188 $c->log->debug( "File Uploads are:\n" . $t->draw );
2192 =head2 $c->log_request_headers($headers);
2194 Hook method which can be wrapped by plugins to log the request headers.
2195 No-op in the default implementation.
2199 sub log_request_headers {}
2201 =head2 $c->log_headers($type => $headers)
2203 Logs L<HTTP::Headers> (either request or response) to the debug logs.
2210 my $headers = shift; # an HTTP::Headers instance
2212 return unless $c->debug;
2214 my $column_width = Catalyst::Utils::term_width() - 28;
2215 my $t = Text::SimpleTable->new( [ 15, 'Header Name' ], [ $column_width, 'Value' ] );
2218 my ( $name, $value ) = @_;
2219 $t->row( $name, $value );
2222 $c->log->debug( ucfirst($type) . " Headers:\n" . $t->draw );
2226 =head2 $c->prepare_read
2228 Prepares the input for reading.
2232 sub prepare_read { my $c = shift; $c->engine->prepare_read( $c, @_ ) }
2234 =head2 $c->prepare_request
2236 Prepares the engine request.
2240 sub prepare_request { my $c = shift; $c->engine->prepare_request( $c, @_ ) }
2242 =head2 $c->prepare_uploads
2248 sub prepare_uploads {
2251 $c->engine->prepare_uploads( $c, @_ );
2254 =head2 $c->prepare_write
2256 Prepares the output for writing.
2260 sub prepare_write { my $c = shift; $c->engine->prepare_write( $c, @_ ) }
2262 =head2 $c->request_class
2264 Returns or sets the request class. Defaults to L<Catalyst::Request>.
2266 =head2 $c->response_class
2268 Returns or sets the response class. Defaults to L<Catalyst::Response>.
2270 =head2 $c->read( [$maxlength] )
2272 Reads a chunk of data from the request body. This method is designed to
2273 be used in a while loop, reading C<$maxlength> bytes on every call.
2274 C<$maxlength> defaults to the size of the request if not specified.
2276 You have to set C<< MyApp->config(parse_on_demand => 1) >> to use this
2279 Warning: If you use read(), Catalyst will not process the body,
2280 so you will not be able to access POST parameters or file uploads via
2281 $c->request. You must handle all body parsing yourself.
2285 sub read { my $c = shift; return $c->engine->read( $c, @_ ) }
2293 sub run { my $c = shift; return $c->engine->run( $c, @_ ) }
2295 =head2 $c->set_action( $action, $code, $namespace, $attrs )
2297 Sets an action in a given namespace.
2301 sub set_action { my $c = shift; $c->dispatcher->set_action( $c, @_ ) }
2303 =head2 $c->setup_actions($component)
2305 Sets up actions for a component.
2309 sub setup_actions { my $c = shift; $c->dispatcher->setup_actions( $c, @_ ) }
2311 =head2 $c->setup_config
2318 my %args = %{ $class->config || {} };
2320 my @container_classes = ( "${class}::Container", 'Catalyst::IOC::Container');
2321 unshift @container_classes, delete $args{container_class} if exists $args{container_class};
2323 my $container_class = Class::MOP::load_first_existing_class(@container_classes);
2325 my $container = $container_class->new( %args, name => "$class" );
2326 $class->container($container);
2328 my $config = $container->resolve(service => 'config');
2329 $class->config($config);
2330 $class->finalize_config; # back-compat
2333 =head2 $c->finalize_config
2337 sub finalize_config { }
2339 =head2 $c->setup_components
2341 This method is called internally to set up the application's components.
2343 It finds modules by calling the L<locate_components> method, expands them to
2344 package names with the L<expand_component_module> method, and then installs
2345 each component into the application.
2347 The C<setup_components> config option is passed to both of the above methods.
2349 Installation of each component is performed by the L<setup_component> method,
2354 sub setup_components {
2357 my $config = $class->config->{ setup_components };
2359 my @comps = $class->locate_components($config);
2360 my %comps = map { $_ => 1 } @comps;
2362 my $deprecatedcatalyst_component_names = grep { /::[CMV]::/ } @comps;
2363 $class->log->warn(qq{Your application is using the deprecated ::[MVC]:: type naming scheme.\n}.
2364 qq{Please switch your class names to ::Model::, ::View:: and ::Controller: as appropriate.\n}
2365 ) if $deprecatedcatalyst_component_names;
2367 for my $component ( @comps ) {
2369 # We pass ignore_loaded here so that overlay files for (e.g.)
2370 # Model::DBI::Schema sub-classes are loaded - if it's in @comps
2371 # we know M::P::O found a file on disk so this is safe
2373 Catalyst::Utils::ensure_class_loaded( $component, { ignore_loaded => 1 } );
2377 $containers->{$_} = $class->container->get_sub_container($_) for qw(model view controller);
2379 for my $component (@comps) {
2380 my $instance = $class->components->{ $component } = $class->setup_component($component);
2381 if ( my ($type, $name) = _get_component_type_name($component) ) {
2382 $containers->{$type}->add_service(Catalyst::IOC::BlockInjection->new( name => $name, block => sub { return $instance } ));
2384 my @expanded_components = $instance->can('expand_modules')
2385 ? $instance->expand_modules( $component, $config )
2386 : $class->expand_component_module( $component, $config );
2387 for my $component (@expanded_components) {
2388 next if $comps{$component};
2390 $deprecatedcatalyst_component_names = grep { /::[CMV]::/ } @expanded_components;
2391 $class->log->warn(qq{Your application is using the deprecated ::[MVC]:: type naming scheme.\n}.
2392 qq{Please switch your class names to ::Model::, ::View:: and ::Controller: as appropriate.\n}
2393 ) if $deprecatedcatalyst_component_names;
2395 if (my ($type, $name) = _get_component_type_name($component)) {
2396 $containers->{$type}->add_service(Catalyst::IOC::BlockInjection->new( name => $name, block => sub { return $class->setup_component($component) } ));
2399 $class->components->{ $component } = $class->setup_component($component);
2403 $containers->{model}->make_single_default;
2404 $containers->{view}->make_single_default;
2407 # FIXME: should this sub exist?
2408 # should it be moved to Catalyst::Utils,
2409 # or replaced by something already existing there?
2410 sub _get_component_type_name {
2411 my $component = shift;
2412 my @parts = split /::/, $component;
2414 if (scalar @parts == 1) {
2415 return (undef, $component);
2418 while (my $type = shift @parts) {
2419 return ('controller', join '::', @parts)
2420 if $type =~ /^(c|controller)$/i;
2422 return ('model', join '::', @parts)
2423 if $type =~ /^(m|model)$/i;
2425 return ('view', join '::', @parts)
2426 if $type =~ /^(v|view)$/i;
2430 =head2 $c->locate_components( $setup_component_config )
2432 This method is meant to provide a list of component modules that should be
2433 setup for the application. By default, it will use L<Module::Pluggable>.
2435 Specify a C<setup_components> config option to pass additional options directly
2436 to L<Module::Pluggable>. To add additional search paths, specify a key named
2437 C<search_extra> as an array reference. Items in the array beginning with C<::>
2438 will have the application class name prepended to them.
2442 sub locate_components {
2446 my @paths = qw( ::Controller ::C ::Model ::M ::View ::V );
2447 my $extra = delete $config->{ search_extra } || [];
2449 push @paths, @$extra;
2451 my $locator = Module::Pluggable::Object->new(
2452 search_path => [ map { s/^(?=::)/$class/; $_; } @paths ],
2456 # XXX think about ditching this sort entirely
2457 my @comps = sort { length $a <=> length $b } $locator->plugins;
2462 =head2 $c->expand_component_module( $component, $setup_component_config )
2464 Components found by C<locate_components> will be passed to this method, which
2465 is expected to return a list of component (package) names to be set up.
2469 sub expand_component_module {
2470 my ($class, $module) = @_;
2471 return Devel::InnerPackage::list_packages( $module );
2474 =head2 $c->setup_component
2478 sub setup_component {
2479 my( $class, $component ) = @_;
2481 unless ( $component->can( 'COMPONENT' ) ) {
2485 my $suffix = Catalyst::Utils::class2classsuffix( $component );
2486 my $config = $class->config->{ $suffix } || {};
2487 # Stash catalyst_component_name in the config here, so that custom COMPONENT
2488 # methods also pass it. local to avoid pointlessly shitting in config
2489 # for the debug screen, as $component is already the key name.
2490 local $config->{catalyst_component_name} = $component;
2492 my $instance = eval { $component->COMPONENT( $class, $config ); };
2494 if ( my $error = $@ ) {
2496 Catalyst::Exception->throw(
2497 message => qq/Couldn't instantiate component "$component", "$error"/
2500 elsif (!blessed $instance) {
2501 my $metaclass = Moose::Util::find_meta($component);
2502 my $method_meta = $metaclass->find_method_by_name('COMPONENT');
2503 my $component_method_from = $method_meta->associated_metaclass->name;
2504 my $value = defined($instance) ? $instance : 'undef';
2505 Catalyst::Exception->throw(
2507 qq/Couldn't instantiate component "$component", COMPONENT() method (from $component_method_from) didn't return an object-like value (value was $value)./
2514 =head2 $c->setup_dispatcher
2520 sub setup_dispatcher {
2521 my ( $class, $dispatcher ) = @_;
2524 $dispatcher = 'Catalyst::Dispatcher::' . $dispatcher;
2527 if ( my $env = Catalyst::Utils::env_value( $class, 'DISPATCHER' ) ) {
2528 $dispatcher = 'Catalyst::Dispatcher::' . $env;
2531 unless ($dispatcher) {
2532 $dispatcher = $class->dispatcher_class;
2535 Class::MOP::load_class($dispatcher);
2537 # dispatcher instance
2538 $class->dispatcher( $dispatcher->new );
2541 =head2 $c->setup_engine
2548 my ( $class, $engine ) = @_;
2551 $engine = 'Catalyst::Engine::' . $engine;
2554 if ( my $env = Catalyst::Utils::env_value( $class, 'ENGINE' ) ) {
2555 $engine = 'Catalyst::Engine::' . $env;
2558 if ( $ENV{MOD_PERL} ) {
2559 my $meta = Class::MOP::get_metaclass_by_name($class);
2561 # create the apache method
2562 $meta->add_method('apache' => sub { shift->engine->apache });
2564 my ( $software, $version ) =
2565 $ENV{MOD_PERL} =~ /^(\S+)\/(\d+(?:[\.\_]\d+)+)/;
2568 $version =~ s/(\.[^.]+)\./$1/g;
2570 if ( $software eq 'mod_perl' ) {
2574 if ( $version >= 1.99922 ) {
2575 $engine = 'Catalyst::Engine::Apache2::MP20';
2578 elsif ( $version >= 1.9901 ) {
2579 $engine = 'Catalyst::Engine::Apache2::MP19';
2582 elsif ( $version >= 1.24 ) {
2583 $engine = 'Catalyst::Engine::Apache::MP13';
2587 Catalyst::Exception->throw( message =>
2588 qq/Unsupported mod_perl version: $ENV{MOD_PERL}/ );
2593 # install the correct mod_perl handler
2594 if ( $version >= 1.9901 ) {
2595 *handler = sub : method {
2596 shift->handle_request(@_);
2600 *handler = sub ($$) { shift->handle_request(@_) };
2605 elsif ( $software eq 'Zeus-Perl' ) {
2606 $engine = 'Catalyst::Engine::Zeus';
2610 Catalyst::Exception->throw(
2611 message => qq/Unsupported mod_perl: $ENV{MOD_PERL}/ );
2616 $engine = $class->engine_class;
2619 Class::MOP::load_class($engine);
2621 # check for old engines that are no longer compatible
2623 if ( $engine->isa('Catalyst::Engine::Apache')
2624 && !Catalyst::Engine::Apache->VERSION )
2629 elsif ( $engine->isa('Catalyst::Engine::Server::Base')
2630 && Catalyst::Engine::Server->VERSION le '0.02' )
2635 elsif ($engine->isa('Catalyst::Engine::HTTP::POE')
2636 && $engine->VERSION eq '0.01' )
2641 elsif ($engine->isa('Catalyst::Engine::Zeus')
2642 && $engine->VERSION eq '0.01' )
2648 Catalyst::Exception->throw( message =>
2649 qq/Engine "$engine" is not supported by this version of Catalyst/
2654 $class->engine( $engine->new );
2657 =head2 $c->setup_home
2659 Sets up the home directory.
2664 my ( $class, $home ) = @_;
2666 if ( my $env = Catalyst::Utils::env_value( $class, 'HOME' ) ) {
2670 $home ||= Catalyst::Utils::home($class);
2673 #I remember recently being scolded for assigning config values like this
2674 $class->config->{home} ||= $home;
2675 $class->config->{root} ||= Path::Class::Dir->new($home)->subdir('root');
2679 =head2 $c->setup_log
2681 Sets up log by instantiating a L<Catalyst::Log|Catalyst::Log> object and
2682 passing it to C<log()>. Pass in a comma-delimited list of levels to set the
2685 This method also installs a C<debug> method that returns a true value into the
2686 catalyst subclass if the "debug" level is passed in the comma-delimited list,
2687 or if the C<$CATALYST_DEBUG> environment variable is set to a true value.
2689 Note that if the log has already been setup, by either a previous call to
2690 C<setup_log> or by a call such as C<< __PACKAGE__->log( MyLogger->new ) >>,
2691 that this method won't actually set up the log object.
2696 my ( $class, $levels ) = @_;
2699 $levels =~ s/^\s+//;
2700 $levels =~ s/\s+$//;
2701 my %levels = map { $_ => 1 } split /\s*,\s*/, $levels;
2703 my $env_debug = Catalyst::Utils::env_value( $class, 'DEBUG' );
2704 if ( defined $env_debug ) {
2705 $levels{debug} = 1 if $env_debug; # Ugly!
2706 delete($levels{debug}) unless $env_debug;
2709 unless ( $class->log ) {
2710 $class->log( Catalyst::Log->new(keys %levels) );
2713 if ( $levels{debug} ) {
2714 Class::MOP::get_metaclass_by_name($class)->add_method('debug' => sub { 1 });
2715 $class->log->debug('Debug messages enabled');
2719 =head2 $c->setup_plugins
2725 =head2 $c->setup_stats
2727 Sets up timing statistics class.
2732 my ( $class, $stats ) = @_;
2734 Catalyst::Utils::ensure_class_loaded($class->stats_class);
2736 my $env = Catalyst::Utils::env_value( $class, 'STATS' );
2737 if ( defined($env) ? $env : ($stats || $class->debug ) ) {
2738 Class::MOP::get_metaclass_by_name($class)->add_method('use_stats' => sub { 1 });
2739 $class->log->debug('Statistics enabled');
2744 =head2 $c->registered_plugins
2746 Returns a sorted list of the plugins which have either been stated in the
2747 import list or which have been added via C<< MyApp->plugin(@args); >>.
2749 If passed a given plugin name, it will report a boolean value indicating
2750 whether or not that plugin is loaded. A fully qualified name is required if
2751 the plugin name does not begin with C<Catalyst::Plugin::>.
2753 if ($c->registered_plugins('Some::Plugin')) {
2761 sub registered_plugins {
2763 return sort keys %{ $proto->_plugins } unless @_;
2765 return 1 if exists $proto->_plugins->{$plugin};
2766 return exists $proto->_plugins->{"Catalyst::Plugin::$plugin"};
2769 sub _register_plugin {
2770 my ( $proto, $plugin, $instant ) = @_;
2771 my $class = ref $proto || $proto;
2773 Class::MOP::load_class( $plugin );
2774 $class->log->warn( "$plugin inherits from 'Catalyst::Component' - this is deprecated and will not work in 5.81" )
2775 if $plugin->isa( 'Catalyst::Component' );
2776 $proto->_plugins->{$plugin} = 1;
2778 my $meta = Class::MOP::get_metaclass_by_name($class);
2779 $meta->superclasses($plugin, $meta->superclasses);
2785 my ( $class, $plugins ) = @_;
2787 $class->_plugins( {} ) unless $class->_plugins;
2788 $plugins = Data::OptList::mkopt($plugins || []);
2791 [ Catalyst::Utils::resolve_namespace(
2792 $class . '::Plugin',
2793 'Catalyst::Plugin', $_->[0]
2799 for my $plugin ( reverse @plugins ) {
2800 Class::MOP::load_class($plugin->[0], $plugin->[1]);
2801 my $meta = find_meta($plugin->[0]);
2802 next if $meta && $meta->isa('Moose::Meta::Role');
2804 $class->_register_plugin($plugin->[0]);
2808 map { $_->[0]->name, $_->[1] }
2809 grep { blessed($_->[0]) && $_->[0]->isa('Moose::Meta::Role') }
2810 map { [find_meta($_->[0]), $_->[1]] }
2813 Moose::Util::apply_all_roles(
2821 Returns an arrayref of the internal execution stack (actions that are
2822 currently executing).
2826 Returns the current timing statistics object. By default Catalyst uses
2827 L<Catalyst::Stats|Catalyst::Stats>, but can be set otherwise with
2828 L<< stats_class|/"$c->stats_class" >>.
2830 Even if L<< -Stats|/"-Stats" >> is not enabled, the stats object is still
2831 available. By enabling it with C< $c->stats->enabled(1) >, it can be used to
2832 profile explicitly, although MyApp.pm still won't profile nor output anything
2835 =head2 $c->stats_class
2837 Returns or sets the stats (timing statistics) class. L<Catalyst::Stats|Catalyst::Stats> is used by default.
2839 =head2 $c->use_stats
2841 Returns 1 when L<< stats collection|/"-Stats" >> is enabled.
2843 Note that this is a static method, not an accessor and should be overridden
2844 by declaring C<sub use_stats { 1 }> in your MyApp.pm, not by calling C<< $c->use_stats(1) >>.
2851 =head2 $c->write( $data )
2853 Writes $data to the output stream. When using this method directly, you
2854 will need to manually set the C<Content-Length> header to the length of
2855 your output data, if known.
2862 # Finalize headers if someone manually writes output
2863 $c->finalize_headers;
2865 return $c->engine->write( $c, @_ );
2870 Returns the Catalyst version number. Mostly useful for "powered by"
2871 messages in template systems.
2875 sub version { return $Catalyst::VERSION }
2877 =head1 CONFIGURATION
2879 There are a number of 'base' config variables which can be set:
2885 C<default_model> - The default model picked if you say C<< $c->model >>. See L<< /$c->model($name) >>.
2889 C<default_view> - The default view to be rendered or returned when C<< $c->view >> is called. See L<< /$c->view($name) >>.
2893 C<home> - The application home directory. In an uninstalled application,
2894 this is the top level application directory. In an installed application,
2895 this will be the directory containing C<< MyApp.pm >>.
2899 C<ignore_frontend_proxy> - See L</PROXY SUPPORT>
2903 C<name> - The name of the application in debug messages and the debug and
2908 C<parse_on_demand> - The request body (for example file uploads) will not be parsed
2909 until it is accessed. This allows you to (for example) check authentication (and reject
2910 the upload) before actually recieving all the data. See L</ON-DEMAND PARSER>
2914 C<root> - The root directory for templates. Usually this is just a
2915 subdirectory of the home directory, but you can set it to change the
2916 templates to a different directory.
2920 C<search_extra> - Array reference passed to Module::Pluggable to for additional
2921 namespaces from which components will be loaded (and constructed and stored in
2922 C<< $c->components >>).
2926 C<show_internal_actions> - If true, causes internal actions such as C<< _DISPATCH >>
2927 to be shown in hit debug tables in the test server.
2931 C<use_request_uri_for_path> - Controlls if the C<REQUEST_URI> or C<PATH_INFO> environment
2932 variable should be used for determining the request path. See L<Catalyst::Engine::CGI/PATH DECODING>
2933 for more information.
2937 C<using_frontend_proxy> - See L</PROXY SUPPORT>.
2941 =head1 INTERNAL ACTIONS
2943 Catalyst uses internal actions like C<_DISPATCH>, C<_BEGIN>, C<_AUTO>,
2944 C<_ACTION>, and C<_END>. These are by default not shown in the private
2945 action table, but you can make them visible with a config parameter.
2947 MyApp->config(show_internal_actions => 1);
2949 =head1 ON-DEMAND PARSER
2951 The request body is usually parsed at the beginning of a request,
2952 but if you want to handle input yourself, you can enable on-demand
2953 parsing with a config parameter.
2955 MyApp->config(parse_on_demand => 1);
2957 =head1 PROXY SUPPORT
2959 Many production servers operate using the common double-server approach,
2960 with a lightweight frontend web server passing requests to a larger
2961 backend server. An application running on the backend server must deal
2962 with two problems: the remote user always appears to be C<127.0.0.1> and
2963 the server's hostname will appear to be C<localhost> regardless of the
2964 virtual host that the user connected through.
2966 Catalyst will automatically detect this situation when you are running
2967 the frontend and backend servers on the same machine. The following
2968 changes are made to the request.
2970 $c->req->address is set to the user's real IP address, as read from
2971 the HTTP X-Forwarded-For header.
2973 The host value for $c->req->base and $c->req->uri is set to the real
2974 host, as read from the HTTP X-Forwarded-Host header.
2976 Additionally, you may be running your backend application on an insecure
2977 connection (port 80) while your frontend proxy is running under SSL. If there
2978 is a discrepancy in the ports, use the HTTP header C<X-Forwarded-Port> to
2979 tell Catalyst what port the frontend listens on. This will allow all URIs to
2980 be created properly.
2982 In the case of passing in:
2984 X-Forwarded-Port: 443
2986 All calls to C<uri_for> will result in an https link, as is expected.
2988 Obviously, your web server must support these headers for this to work.
2990 In a more complex server farm environment where you may have your
2991 frontend proxy server(s) on different machines, you will need to set a
2992 configuration option to tell Catalyst to read the proxied data from the
2995 MyApp->config(using_frontend_proxy => 1);
2997 If you do not wish to use the proxy support at all, you may set:
2999 MyApp->config(ignore_frontend_proxy => 1);
3001 =head1 THREAD SAFETY
3003 Catalyst has been tested under Apache 2's threading C<mpm_worker>,
3004 C<mpm_winnt>, and the standalone forking HTTP server on Windows. We
3005 believe the Catalyst core to be thread-safe.
3007 If you plan to operate in a threaded environment, remember that all other
3008 modules you are using must also be thread-safe. Some modules, most notably
3009 L<DBD::SQLite>, are not thread-safe.
3015 Join #catalyst on irc.perl.org.
3019 http://lists.scsys.co.uk/cgi-bin/mailman/listinfo/catalyst
3020 http://lists.scsys.co.uk/cgi-bin/mailman/listinfo/catalyst-dev
3024 http://catalyst.perl.org
3028 http://dev.catalyst.perl.org
3032 =head2 L<Task::Catalyst> - All you need to start with Catalyst
3034 =head2 L<Catalyst::Manual> - The Catalyst Manual
3036 =head2 L<Catalyst::Component>, L<Catalyst::Controller> - Base classes for components
3038 =head2 L<Catalyst::Engine> - Core engine
3040 =head2 L<Catalyst::Log> - Log class.
3042 =head2 L<Catalyst::Request> - Request object
3044 =head2 L<Catalyst::Response> - Response object
3046 =head2 L<Catalyst::Test> - The test suite.
3048 =head1 PROJECT FOUNDER
3050 sri: Sebastian Riedel <sri@cpan.org>
3056 acme: Leon Brocard <leon@astray.com>
3058 abraxxa: Alexander Hartmaier <abraxxa@cpan.org>
3062 Andrew Ford E<lt>A.Ford@ford-mason.co.ukE<gt>
3068 andyg: Andy Grundman <andy@hybridized.org>
3070 audreyt: Audrey Tang
3072 bricas: Brian Cassidy <bricas@cpan.org>
3074 Caelum: Rafael Kitover <rkitover@io.com>
3076 chansen: Christian Hansen
3078 chicks: Christopher Hicks
3080 Chisel Wright C<pause@herlpacker.co.uk>
3082 Danijel Milicevic C<me@danijel.de>
3084 David Kamholz E<lt>dkamholz@cpan.orgE<gt>
3086 David Naughton, C<naughton@umn.edu>
3090 dhoss: Devin Austin <dhoss@cpan.org>
3092 dkubb: Dan Kubb <dan.kubb-cpan@onautopilot.com>
3096 dwc: Daniel Westermann-Clark <danieltwc@cpan.org>
3098 esskar: Sascha Kiefer
3100 fireartist: Carl Franks <cfranks@cpan.org>
3102 frew: Arthur Axel "fREW" Schmidt <frioux@gmail.com>
3104 gabb: Danijel Milicevic
3108 Gavin Henry C<ghenry@perl.me.uk>
3112 groditi: Guillermo Roditi <groditi@gmail.com>
3114 hobbs: Andrew Rodland <andrew@cleverdomain.org>
3116 ilmari: Dagfinn Ilmari Mannsåker <ilmari@ilmari.org>
3118 jcamacho: Juan Camacho
3120 jester: Jesse Sheidlower C<jester@panix.com>
3122 jhannah: Jay Hannah <jay@jays.net>
3128 jon: Jon Schutz <jjschutz@cpan.org>
3130 Jonathan Rockway C<< <jrockway@cpan.org> >>
3132 Kieren Diment C<kd@totaldatasolution.com>
3134 konobi: Scott McWhirter <konobi@cpan.org>
3136 marcus: Marcus Ramberg <mramberg@cpan.org>
3138 miyagawa: Tatsuhiko Miyagawa <miyagawa@bulknews.net>
3140 mst: Matt S. Trout <mst@shadowcatsystems.co.uk>
3144 naughton: David Naughton
3146 ningu: David Kamholz <dkamholz@cpan.org>
3148 nothingmuch: Yuval Kogman <nothingmuch@woobling.org>
3150 numa: Dan Sully <daniel@cpan.org>
3156 omega: Andreas Marienborg
3158 Oleg Kostyuk <cub.uanic@gmail.com>
3160 phaylon: Robert Sedlacek <phaylon@dunkelheit.at>
3162 rafl: Florian Ragwitz <rafl@debian.org>
3164 random: Roland Lammel <lammel@cpan.org>
3166 Robert Sedlacek C<< <rs@474.at> >>
3168 SpiceMan: Marcel Montes
3172 szbalint: Balint Szilakszi <szbalint@cpan.org>
3174 t0m: Tomas Doran <bobtfish@bobtfish.net>
3178 Viljo Marrandi C<vilts@yahoo.com>
3180 Will Hawes C<info@whawes.co.uk>
3182 willert: Sebastian Willert <willert@cpan.org>
3184 wreis: Wallace Reis <wallace@reis.org.br>
3186 Yuval Kogman, C<nothingmuch@woobling.org>
3188 rainboxx: Matthias Dietrich, C<perl@rainboxx.de>
3190 dd070: Dhaval Dhanani <dhaval070@gmail.com>
3194 Copyright (c) 2005, the above named PROJECT FOUNDER and CONTRIBUTORS.
3198 This library is free software. You can redistribute it and/or modify it under
3199 the same terms as Perl itself.
3205 __PACKAGE__->meta->make_immutable;