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 sub _find_component {
682 my ($c, $component, @args) = @_;
685 my $query = ref $component
690 for my $subcontainer_name (qw/model view controller/) {
691 my $subcontainer = $c->container->get_sub_container($subcontainer_name);
692 my @components = $subcontainer->get_service_list;
693 @result = grep { m{$component} } @components;
695 return map { $subcontainer->get_component( $_, $c, @args ) } @result
699 # it expects an empty list on failed searches
703 =head2 $c->comp($name)
705 =head2 $c->component($name)
707 Gets a component object by name. This method is not recommended,
708 unless you want to get a specific component by full
709 class. C<< $c->controller >>, C<< $c->model >>, and C<< $c->view >>
710 should be used instead.
712 If C<$name> is a regexp, a list of components matched against the full
713 component name will be returned.
718 my ( $c, $component, @args ) = @_;
720 return sort keys %{ $c->components }
723 my ($type, $name) = _get_component_type_name($component);
725 return $c->container->get_component_from_sub_container(
726 $type, $name, $c, @args
729 my @result = $c->_find_component( $component, @args );
731 # list context for regexp searches
732 return @result if ref $component;
734 # only one component (if it's found) for string searches
735 return shift @result if @result;
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
745 $c->log->warn("Component not found, returning the list of existing");
746 $c->log->warn("components. This behavior is going to be deprecated");
747 $c->log->warn("in future releases.");
749 return sort keys %{ $c->components };
752 =head2 CLASS DATA AND HELPER CLASSES
756 Returns or takes a hashref containing the application's configuration.
758 __PACKAGE__->config( { db => 'dsn:SQLite:foo.db' } );
760 You can also use a C<YAML>, C<XML> or L<Config::General> config file
761 like C<myapp.conf> in your applications home directory. See
762 L<Catalyst::Plugin::ConfigLoader>.
764 =head3 Cascading configuration
766 The config method is present on all Catalyst components, and configuration
767 will be merged when an application is started. Configuration loaded with
768 L<Catalyst::Plugin::ConfigLoader> takes precedence over other configuration,
769 followed by configuration in your top level C<MyApp> class. These two
770 configurations are merged, and then configuration data whose hash key matches a
771 component name is merged with configuration for that component.
773 The configuration for a component is then passed to the C<new> method when a
774 component is constructed.
778 MyApp->config({ 'Model::Foo' => { bar => 'baz', overrides => 'me' } });
779 MyApp::Model::Foo->config({ quux => 'frob', overrides => 'this' });
781 will mean that C<MyApp::Model::Foo> receives the following data when
784 MyApp::Model::Foo->new({
790 It's common practice to use a Moose attribute
791 on the receiving component to access the config value.
793 package MyApp::Model::Foo;
797 # this attr will receive 'baz' at construction time
803 You can then get the value 'baz' by calling $c->model('Foo')->bar
804 (or $self->bar inside code in the model).
806 B<NOTE:> you MUST NOT call C<< $self->config >> or C<< __PACKAGE__->config >>
807 as a way of reading config within your code, as this B<will not> give you the
808 correctly merged config back. You B<MUST> take the config values supplied to
809 the constructor and use those instead.
813 around config => sub {
817 croak('Setting config after setup has been run is not allowed.')
818 if ( @_ and $c->setup_finished );
825 Returns the logging object instance. Unless it is already set, Catalyst
826 sets this up with a L<Catalyst::Log> object. To use your own log class,
827 set the logger with the C<< __PACKAGE__->log >> method prior to calling
828 C<< __PACKAGE__->setup >>.
830 __PACKAGE__->log( MyLogger->new );
835 $c->log->info( 'Now logging with my own logger!' );
837 Your log class should implement the methods described in
843 Returns 1 if debug mode is enabled, 0 otherwise.
845 You can enable debug mode in several ways:
849 =item By calling myapp_server.pl with the -d flag
851 =item With the environment variables MYAPP_DEBUG, or CATALYST_DEBUG
853 =item The -Debug option in your MyApp.pm
855 =item By declaring C<sub debug { 1 }> in your MyApp.pm.
859 The first three also set the log level to 'debug'.
861 Calling C<< $c->debug(1) >> has no effect.
867 =head2 $c->dispatcher
869 Returns the dispatcher instance. See L<Catalyst::Dispatcher>.
873 Returns the engine instance. See L<Catalyst::Engine>.
876 =head2 UTILITY METHODS
878 =head2 $c->path_to(@path)
880 Merges C<@path> with C<< $c->config->{home} >> and returns a
881 L<Path::Class::Dir> object. Note you can usually use this object as
882 a filename, but sometimes you will have to explicitly stringify it
883 yourself by calling the C<< ->stringify >> method.
887 $c->path_to( 'db', 'sqlite.db' );
892 my ( $c, @path ) = @_;
893 my $path = Path::Class::Dir->new( $c->config->{home}, @path );
894 if ( -d $path ) { return $path }
895 else { return Path::Class::File->new( $c->config->{home}, @path ) }
898 =head2 $c->plugin( $name, $class, @args )
900 Helper method for plugins. It creates a class data accessor/mutator and
901 loads and instantiates the given class.
903 MyApp->plugin( 'prototype', 'HTML::Prototype' );
905 $c->prototype->define_javascript_functions;
907 B<Note:> This method of adding plugins is deprecated. The ability
908 to add plugins like this B<will be removed> in a Catalyst 5.81.
909 Please do not use this functionality in new code.
914 my ( $class, $name, $plugin, @args ) = @_;
916 # See block comment in t/unit_core_plugin.t
917 $class->log->warn(qq/Adding plugin using the ->plugin method is deprecated, and will be removed in Catalyst 5.81/);
919 $class->_register_plugin( $plugin, 1 );
921 eval { $plugin->import };
922 $class->mk_classdata($name);
924 eval { $obj = $plugin->new(@args) };
927 Catalyst::Exception->throw( message =>
928 qq/Couldn't instantiate instant plugin "$plugin", "$@"/ );
932 $class->log->debug(qq/Initialized instant plugin "$plugin" as "$name"/)
938 Initializes the dispatcher and engine, loads any plugins, and loads the
939 model, view, and controller components. You may also specify an array
940 of plugins to load here, if you choose to not load them in the C<use
944 MyApp->setup( qw/-Debug/ );
949 my ( $class, @arguments ) = @_;
950 croak('Running setup more than once')
951 if ( $class->setup_finished );
953 unless ( $class->isa('Catalyst') ) {
955 Catalyst::Exception->throw(
956 message => qq/'$class' does not inherit from Catalyst/ );
959 if ( $class->arguments ) {
960 @arguments = ( @arguments, @{ $class->arguments } );
966 foreach (@arguments) {
970 ( $flags->{log} ) ? 'debug,' . $flags->{log} : 'debug';
972 elsif (/^-(\w+)=?(.*)$/) {
973 $flags->{ lc $1 } = $2;
976 push @{ $flags->{plugins} }, $_;
980 $class->setup_config();
981 $class->setup_home( delete $flags->{home} );
983 $class->setup_log( delete $flags->{log} );
984 $class->setup_plugins( delete $flags->{plugins} );
985 $class->setup_dispatcher( delete $flags->{dispatcher} );
986 $class->setup_engine( delete $flags->{engine} );
987 $class->setup_stats( delete $flags->{stats} );
989 for my $flag ( sort keys %{$flags} ) {
991 if ( my $code = $class->can( 'setup_' . $flag ) ) {
992 &$code( $class, delete $flags->{$flag} );
995 $class->log->warn(qq/Unknown flag "$flag"/);
999 eval { require Catalyst::Devel; };
1000 if( !$@ && $ENV{CATALYST_SCRIPT_GEN} && ( $ENV{CATALYST_SCRIPT_GEN} < $Catalyst::Devel::CATALYST_SCRIPT_GEN ) ) {
1001 $class->log->warn(<<"EOF");
1002 You are running an old script!
1004 Please update by running (this will overwrite existing files):
1005 catalyst.pl -force -scripts $class
1007 or (this will not overwrite existing files):
1008 catalyst.pl -scripts $class
1013 if ( $class->debug ) {
1014 my @plugins = map { "$_ " . ( $_->VERSION || '' ) } $class->registered_plugins;
1017 my $column_width = Catalyst::Utils::term_width() - 6;
1018 my $t = Text::SimpleTable->new($column_width);
1019 $t->row($_) for @plugins;
1020 $class->log->debug( "Loaded plugins:\n" . $t->draw . "\n" );
1023 my $dispatcher = $class->dispatcher;
1024 my $engine = $class->engine;
1025 my $home = $class->config->{home};
1027 $class->log->debug(sprintf(q/Loaded dispatcher "%s"/, blessed($dispatcher)));
1028 $class->log->debug(sprintf(q/Loaded engine "%s"/, blessed($engine)));
1032 ? $class->log->debug(qq/Found home "$home"/)
1033 : $class->log->debug(qq/Home "$home" doesn't exist/)
1034 : $class->log->debug(q/Couldn't find home/);
1037 # Call plugins setup, this is stupid and evil.
1038 # Also screws C3 badly on 5.10, hack to avoid.
1040 no warnings qw/redefine/;
1041 local *setup = sub { };
1042 $class->setup unless $Catalyst::__AM_RESTARTING;
1045 # Initialize our data structure
1046 $class->components( {} );
1048 $class->setup_components;
1050 if ( $class->debug ) {
1051 my $column_width = Catalyst::Utils::term_width() - 8 - 9;
1052 my $t = Text::SimpleTable->new( [ $column_width, 'Class' ], [ 8, 'Type' ] );
1053 for my $comp ( sort keys %{ $class->components } ) {
1054 my $type = ref $class->components->{$comp} ? 'instance' : 'class';
1055 $t->row( $comp, $type );
1057 $class->log->debug( "Loaded components:\n" . $t->draw . "\n" )
1058 if ( keys %{ $class->components } );
1061 # Add our self to components, since we are also a component
1062 if( $class->isa('Catalyst::Controller') ){
1063 $class->components->{$class} = $class;
1066 $class->setup_actions;
1068 if ( $class->debug ) {
1069 my $name = $class->config->{name} || 'Application';
1070 $class->log->info("$name powered by Catalyst $Catalyst::VERSION");
1073 # Make sure that the application class becomes immutable at this point,
1074 B::Hooks::EndOfScope::on_scope_end {
1076 my $meta = Class::MOP::get_metaclass_by_name($class);
1079 && ! { $meta->immutable_options }->{replace_constructor}
1081 $class->isa('Class::Accessor::Fast')
1082 || $class->isa('Class::Accessor')
1085 warn "You made your application class ($class) immutable, "
1086 . "but did not inline the\nconstructor. "
1087 . "This will break catalyst, as your app \@ISA "
1088 . "Class::Accessor(::Fast)?\nPlease pass "
1089 . "(replace_constructor => 1)\nwhen making your class immutable.\n";
1091 $meta->make_immutable(
1092 replace_constructor => 1,
1093 ) unless $meta->is_immutable;
1096 if ($class->config->{case_sensitive}) {
1097 $class->log->warn($class . "->config->{case_sensitive} is set.");
1098 $class->log->warn("This setting is deprecated and planned to be removed in Catalyst 5.81.");
1101 $class->setup_finalize;
1102 # Should be the last thing we do so that user things hooking
1103 # setup_finalize can log..
1104 $class->log->_flush() if $class->log->can('_flush');
1105 return 1; # Explicit return true as people have __PACKAGE__->setup as the last thing in their class. HATE.
1108 =head2 $app->setup_finalize
1110 A hook to attach modifiers to. This method does not do anything except set the
1111 C<setup_finished> accessor.
1113 Applying method modifiers to the C<setup> method doesn't work, because of quirky things done for plugin setup.
1117 after setup_finalize => sub {
1125 sub setup_finalize {
1127 $class->setup_finished(1);
1130 =head2 $c->uri_for( $path?, @args?, \%query_values? )
1132 =head2 $c->uri_for( $action, \@captures?, @args?, \%query_values? )
1134 Constructs an absolute L<URI> object based on the application root, the
1135 provided path, and the additional arguments and query parameters provided.
1136 When used as a string, provides a textual URI. If you need more flexibility
1137 than this (i.e. the option to provide relative URIs etc.) see
1138 L<Catalyst::Plugin::SmartURI>.
1140 If no arguments are provided, the URI for the current action is returned.
1141 To return the current action and also provide @args, use
1142 C<< $c->uri_for( $c->action, @args ) >>.
1144 If the first argument is a string, it is taken as a public URI path relative
1145 to C<< $c->namespace >> (if it doesn't begin with a forward slash) or
1146 relative to the application root (if it does). It is then merged with
1147 C<< $c->request->base >>; any C<@args> are appended as additional path
1148 components; and any C<%query_values> are appended as C<?foo=bar> parameters.
1150 If the first argument is a L<Catalyst::Action> it represents an action which
1151 will have its path resolved using C<< $c->dispatcher->uri_for_action >>. The
1152 optional C<\@captures> argument (an arrayref) allows passing the captured
1153 variables that are needed to fill in the paths of Chained and Regex actions;
1154 once the path is resolved, C<uri_for> continues as though a path was
1155 provided, appending any arguments or parameters and creating an absolute
1158 The captures for the current request can be found in
1159 C<< $c->request->captures >>, and actions can be resolved using
1160 C<< Catalyst::Controller->action_for($name) >>. If you have a private action
1161 path, use C<< $c->uri_for_action >> instead.
1163 # Equivalent to $c->req->uri
1164 $c->uri_for($c->action, $c->req->captures,
1165 @{ $c->req->args }, $c->req->params);
1167 # For the Foo action in the Bar controller
1168 $c->uri_for($c->controller('Bar')->action_for('Foo'));
1170 # Path to a static resource
1171 $c->uri_for('/static/images/logo.png');
1176 my ( $c, $path, @args ) = @_;
1178 if (blessed($path) && $path->isa('Catalyst::Controller')) {
1179 $path = $path->path_prefix;
1184 undef($path) if (defined $path && $path eq '');
1187 ( scalar @args && ref $args[$#args] eq 'HASH' ? pop @args : {} );
1189 carp "uri_for called with undef argument" if grep { ! defined $_ } @args;
1190 foreach my $arg (@args) {
1191 utf8::encode($arg) if utf8::is_utf8($arg);
1192 $arg =~ s/([^$URI::uric])/$URI::Escape::escapes{$1}/go;
1195 if ( blessed($path) ) { # action object
1196 s|/|%2F|g for @args;
1197 my $captures = [ map { s|/|%2F|g; $_; }
1198 ( scalar @args && ref $args[0] eq 'ARRAY'
1202 foreach my $capture (@$captures) {
1203 utf8::encode($capture) if utf8::is_utf8($capture);
1204 $capture =~ s/([^$URI::uric])/$URI::Escape::escapes{$1}/go;
1208 $path = $c->dispatcher->uri_for_action($action, $captures);
1209 if (not defined $path) {
1210 $c->log->debug(qq/Can't find uri_for action '$action' @$captures/)
1214 $path = '/' if $path eq '';
1217 unshift(@args, $path);
1219 unless (defined $path && $path =~ s!^/!!) { # in-place strip
1220 my $namespace = $c->namespace;
1221 if (defined $path) { # cheesy hack to handle path '../foo'
1222 $namespace =~ s{(?:^|/)[^/]+$}{} while $args[0] =~ s{^\.\./}{};
1224 unshift(@args, $namespace || '');
1227 # join args with '/', or a blank string
1228 my $args = join('/', grep { defined($_) } @args);
1229 $args =~ s/\?/%3F/g; # STUPID STUPID SPECIAL CASE
1231 my $base = $c->req->base;
1232 my $class = ref($base);
1233 $base =~ s{(?<!/)$}{/};
1237 if (my @keys = keys %$params) {
1238 # somewhat lifted from URI::_query's query_form
1239 $query = '?'.join('&', map {
1240 my $val = $params->{$_};
1241 s/([;\/?:@&=+,\$\[\]%])/$URI::Escape::escapes{$1}/go;
1244 $val = '' unless defined $val;
1247 utf8::encode( $param ) if utf8::is_utf8($param);
1248 # using the URI::Escape pattern here so utf8 chars survive
1249 $param =~ s/([^A-Za-z0-9\-_.!~*'() ])/$URI::Escape::escapes{$1}/go;
1251 "${key}=$param"; } ( ref $val eq 'ARRAY' ? @$val : $val ));
1255 my $res = bless(\"${base}${args}${query}", $class);
1259 =head2 $c->uri_for_action( $path, \@captures?, @args?, \%query_values? )
1261 =head2 $c->uri_for_action( $action, \@captures?, @args?, \%query_values? )
1267 A private path to the Catalyst action you want to create a URI for.
1269 This is a shortcut for calling C<< $c->dispatcher->get_action_by_path($path)
1270 >> and passing the resulting C<$action> and the remaining arguments to C<<
1273 You can also pass in a Catalyst::Action object, in which case it is passed to
1276 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.
1278 For example, if the action looks like:
1280 package MyApp::Controller::Users;
1282 sub lst : Path('the-list') {}
1286 $c->uri_for_action('/users/lst')
1288 and it will create the URI /users/the-list.
1294 sub uri_for_action {
1295 my ( $c, $path, @args ) = @_;
1296 my $action = blessed($path)
1298 : $c->dispatcher->get_action_by_path($path);
1299 unless (defined $action) {
1300 croak "Can't find action for path '$path'";
1302 return $c->uri_for( $action, @args );
1305 =head2 $c->welcome_message
1307 Returns the Catalyst welcome HTML page.
1311 sub welcome_message {
1313 my $name = $c->config->{name};
1314 my $logo = $c->uri_for('/static/images/catalyst_logo.png');
1315 my $prefix = Catalyst::Utils::appprefix( ref $c );
1316 $c->response->content_type('text/html; charset=utf-8');
1318 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
1319 "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
1320 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
1322 <meta http-equiv="Content-Language" content="en" />
1323 <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
1324 <title>$name on Catalyst $VERSION</title>
1325 <style type="text/css">
1328 background-color: #eee;
1335 margin-bottom: 10px;
1337 background-color: #ccc;
1338 border: 1px solid #aaa;
1343 font-family: verdana, tahoma, sans-serif;
1346 font-family: verdana, tahoma, sans-serif;
1349 text-decoration: none;
1351 border-bottom: 1px dotted #bbb;
1353 :link:hover, :visited:hover {
1366 background-color: #fff;
1367 border: 1px solid #aaa;
1371 font-weight: normal;
1393 <h1><span id="appname">$name</span> on <a href="http://catalyst.perl.org">Catalyst</a>
1398 <img src="$logo" alt="Catalyst Logo" />
1400 <p>Welcome to the world of Catalyst.
1401 This <a href="http://en.wikipedia.org/wiki/MVC">MVC</a>
1402 framework will make web development something you had
1403 never expected it to be: Fun, rewarding, and quick.</p>
1404 <h2>What to do now?</h2>
1405 <p>That really depends on what <b>you</b> want to do.
1406 We do, however, provide you with a few starting points.</p>
1407 <p>If you want to jump right into web development with Catalyst
1408 you might want to start with a tutorial.</p>
1409 <pre>perldoc <a href="http://cpansearch.perl.org/dist/Catalyst-Manual/lib/Catalyst/Manual/Tutorial.pod">Catalyst::Manual::Tutorial</a></code>
1411 <p>Afterwards you can go on to check out a more complete look at our features.</p>
1413 <code>perldoc <a href="http://cpansearch.perl.org/dist/Catalyst-Manual/lib/Catalyst/Manual/Intro.pod">Catalyst::Manual::Intro</a>
1414 <!-- Something else should go here, but the Catalyst::Manual link seems unhelpful -->
1416 <h2>What to do next?</h2>
1417 <p>Next it's time to write an actual application. Use the
1418 helper scripts to generate <a href="http://cpansearch.perl.org/search?query=Catalyst%3A%3AController%3A%3A&mode=all">controllers</a>,
1419 <a href="http://cpansearch.perl.org/search?query=Catalyst%3A%3AModel%3A%3A&mode=all">models</a>, and
1420 <a href="http://cpansearch.perl.org/search?query=Catalyst%3A%3AView%3A%3A&mode=all">views</a>;
1421 they can save you a lot of work.</p>
1422 <pre><code>script/${prefix}_create.pl --help</code></pre>
1423 <p>Also, be sure to check out the vast and growing
1424 collection of <a href="http://search.cpan.org/search?query=Catalyst">plugins for Catalyst on CPAN</a>;
1425 you are likely to find what you need there.
1429 <p>Catalyst has a very active community. Here are the main places to
1430 get in touch with us.</p>
1433 <a href="http://dev.catalyst.perl.org">Wiki</a>
1436 <a href="http://lists.scsys.co.uk/cgi-bin/mailman/listinfo/catalyst">Mailing-List</a>
1439 <a href="irc://irc.perl.org/catalyst">IRC channel #catalyst on irc.perl.org</a>
1442 <h2>In conclusion</h2>
1443 <p>The Catalyst team hopes you will enjoy using Catalyst as much
1444 as we enjoyed making it. Please contact us if you have ideas
1445 for improvement or other feedback.</p>
1453 =head1 INTERNAL METHODS
1455 These methods are not meant to be used by end users.
1457 =head2 $c->components
1459 Returns a hash of components.
1463 around components => sub {
1468 return $class->$orig if ( !$comps );
1470 # FIXME: should this ugly kludge exist?
1471 $class->setup_config unless defined $class->container;
1473 # FIXME: should there be a warning here, not to use this accessor to create the components?
1474 my $components = {};
1477 $containers->{$_} = $class->container->get_sub_container($_) for qw(model view controller);
1479 for my $component ( keys %$comps ) {
1480 $components->{ $component } = $comps->{$component};
1482 my ($type, $name) = _get_component_type_name($component);
1484 $containers->{$type}->add_service(Catalyst::IOC::BlockInjection->new( name => $name, block => sub { return $class->setup_component($component) } ));
1487 return $class->$orig($components);
1490 =head2 $c->context_class
1492 Returns or sets the context class.
1496 Returns a hashref containing coderefs and execution counts (needed for
1497 deep recursion detection).
1501 Returns the number of actions on the current internal execution stack.
1505 Dispatches a request to actions.
1509 sub dispatch { my $c = shift; $c->dispatcher->dispatch( $c, @_ ) }
1511 =head2 $c->dispatcher_class
1513 Returns or sets the dispatcher class.
1515 =head2 $c->dump_these
1517 Returns a list of 2-element array references (name, structure) pairs
1518 that will be dumped on the error page in debug mode.
1524 [ Request => $c->req ],
1525 [ Response => $c->res ],
1526 [ Stash => $c->stash ],
1527 [ Config => $c->config ];
1530 =head2 $c->engine_class
1532 Returns or sets the engine class.
1534 =head2 $c->execute( $class, $coderef )
1536 Execute a coderef in given class and catch exceptions. Errors are available
1542 my ( $c, $class, $code ) = @_;
1543 $class = $c->component($class) || $class;
1546 if ( $c->depth >= $RECURSION ) {
1547 my $action = $code->reverse();
1548 $action = "/$action" unless $action =~ /->/;
1549 my $error = qq/Deep recursion detected calling "${action}"/;
1550 $c->log->error($error);
1556 my $stats_info = $c->_stats_start_execute( $code ) if $c->use_stats;
1558 push( @{ $c->stack }, $code );
1560 no warnings 'recursion';
1561 # N.B. This used to be combined, but I have seen $c get clobbered if so, and
1562 # I have no idea how, ergo $ret (which appears to fix the issue)
1563 eval { my $ret = $code->execute( $class, $c, @{ $c->req->args } ) || 0; $c->state( $ret ) };
1565 $c->_stats_finish_execute( $stats_info ) if $c->use_stats and $stats_info;
1567 my $last = pop( @{ $c->stack } );
1569 if ( my $error = $@ ) {
1570 if ( blessed($error) and $error->isa('Catalyst::Exception::Detach') ) {
1571 $error->rethrow if $c->depth > 1;
1573 elsif ( blessed($error) and $error->isa('Catalyst::Exception::Go') ) {
1574 $error->rethrow if $c->depth > 0;
1577 unless ( ref $error ) {
1578 no warnings 'uninitialized';
1580 my $class = $last->class;
1581 my $name = $last->name;
1582 $error = qq/Caught exception in $class->$name "$error"/;
1591 sub _stats_start_execute {
1592 my ( $c, $code ) = @_;
1593 my $appclass = ref($c) || $c;
1594 return if ( ( $code->name =~ /^_.*/ )
1595 && ( !$appclass->config->{show_internal_actions} ) );
1597 my $action_name = $code->reverse();
1598 $c->counter->{$action_name}++;
1600 my $action = $action_name;
1601 $action = "/$action" unless $action =~ /->/;
1603 # determine if the call was the result of a forward
1604 # this is done by walking up the call stack and looking for a calling
1605 # sub of Catalyst::forward before the eval
1607 for my $index ( 2 .. 11 ) {
1609 if ( ( caller($index) )[0] eq 'Catalyst'
1610 && ( caller($index) )[3] eq '(eval)' );
1612 if ( ( caller($index) )[3] =~ /forward$/ ) {
1613 $callsub = ( caller($index) )[3];
1614 $action = "-> $action";
1619 my $uid = $action_name . $c->counter->{$action_name};
1621 # is this a root-level call or a forwarded call?
1622 if ( $callsub =~ /forward$/ ) {
1623 my $parent = $c->stack->[-1];
1625 # forward, locate the caller
1626 if ( defined $parent && exists $c->counter->{"$parent"} ) {
1629 parent => "$parent" . $c->counter->{"$parent"},
1635 # forward with no caller may come from a plugin
1654 sub _stats_finish_execute {
1655 my ( $c, $info ) = @_;
1656 $c->stats->profile( end => $info );
1661 Finalizes the request.
1668 for my $error ( @{ $c->error } ) {
1669 $c->log->error($error);
1672 # Allow engine to handle finalize flow (for POE)
1673 my $engine = $c->engine;
1674 if ( my $code = $engine->can('finalize') ) {
1679 $c->finalize_uploads;
1682 if ( $#{ $c->error } >= 0 ) {
1686 $c->finalize_headers;
1689 if ( $c->request->method eq 'HEAD' ) {
1690 $c->response->body('');
1698 if ($c->use_stats) {
1699 my $elapsed = sprintf '%f', $c->stats->elapsed;
1700 my $av = $elapsed == 0 ? '??' : sprintf '%.3f', 1 / $elapsed;
1702 "Request took ${elapsed}s ($av/s)\n" . $c->stats->report . "\n" );
1705 return $c->response->status;
1708 =head2 $c->finalize_body
1714 sub finalize_body { my $c = shift; $c->engine->finalize_body( $c, @_ ) }
1716 =head2 $c->finalize_cookies
1722 sub finalize_cookies { my $c = shift; $c->engine->finalize_cookies( $c, @_ ) }
1724 =head2 $c->finalize_error
1730 sub finalize_error { my $c = shift; $c->engine->finalize_error( $c, @_ ) }
1732 =head2 $c->finalize_headers
1738 sub finalize_headers {
1741 my $response = $c->response; #accessor calls can add up?
1743 # Check if we already finalized headers
1744 return if $response->finalized_headers;
1747 if ( my $location = $response->redirect ) {
1748 $c->log->debug(qq/Redirecting to "$location"/) if $c->debug;
1749 $response->header( Location => $location );
1751 if ( !$response->has_body ) {
1752 # Add a default body if none is already present
1754 qq{<html><body><p>This item has moved <a href="$location">here</a>.</p></body></html>}
1760 if ( defined $response->body && length $response->body && !$response->content_length ) {
1762 # get the length from a filehandle
1763 if ( blessed( $response->body ) && $response->body->can('read') || ref( $response->body ) eq 'GLOB' )
1765 my $stat = stat $response->body;
1766 if ( $stat && $stat->size > 0 ) {
1767 $response->content_length( $stat->size );
1770 $c->log->warn('Serving filehandle without a content-length');
1774 # everything should be bytes at this point, but just in case
1775 $response->content_length( length( $response->body ) );
1780 if ( $response->status =~ /^(1\d\d|[23]04)$/ ) {
1781 $response->headers->remove_header("Content-Length");
1782 $response->body('');
1785 $c->finalize_cookies;
1787 $c->engine->finalize_headers( $c, @_ );
1790 $response->finalized_headers(1);
1793 =head2 $c->finalize_output
1795 An alias for finalize_body.
1797 =head2 $c->finalize_read
1799 Finalizes the input after reading is complete.
1803 sub finalize_read { my $c = shift; $c->engine->finalize_read( $c, @_ ) }
1805 =head2 $c->finalize_uploads
1807 Finalizes uploads. Cleans up any temporary files.
1811 sub finalize_uploads { my $c = shift; $c->engine->finalize_uploads( $c, @_ ) }
1813 =head2 $c->get_action( $action, $namespace )
1815 Gets an action in a given namespace.
1819 sub get_action { my $c = shift; $c->dispatcher->get_action(@_) }
1821 =head2 $c->get_actions( $action, $namespace )
1823 Gets all actions of a given name in a namespace and all parent
1828 sub get_actions { my $c = shift; $c->dispatcher->get_actions( $c, @_ ) }
1830 =head2 $app->handle_request( @arguments )
1832 Called to handle each HTTP request.
1836 sub handle_request {
1837 my ( $class, @arguments ) = @_;
1839 # Always expect worst case!
1842 if ($class->debug) {
1843 my $secs = time - $START || 1;
1844 my $av = sprintf '%.3f', $COUNT / $secs;
1845 my $time = localtime time;
1846 $class->log->info("*** Request $COUNT ($av/s) [$$] [$time] ***");
1849 my $c = $class->prepare(@arguments);
1851 $status = $c->finalize;
1854 if ( my $error = $@ ) {
1856 $class->log->error(qq/Caught exception in engine "$error"/);
1861 if(my $coderef = $class->log->can('_flush')){
1862 $class->log->$coderef();
1867 =head2 $c->prepare( @arguments )
1869 Creates a Catalyst context from an engine-specific request (Apache, CGI,
1875 my ( $class, @arguments ) = @_;
1878 # After the app/ctxt split, this should become an attribute based on something passed
1879 # into the application.
1880 $class->context_class( ref $class || $class ) unless $class->context_class;
1882 my $c = $class->context_class->new({});
1884 # For on-demand data
1885 $c->request->_context($c);
1886 $c->response->_context($c);
1888 #surely this is not the most efficient way to do things...
1889 $c->stats($class->stats_class->new)->enable($c->use_stats);
1890 if ( $c->debug || $c->config->{enable_catalyst_header} ) {
1891 $c->res->headers->header( 'X-Catalyst' => $Catalyst::VERSION );
1894 #XXX reuse coderef from can
1895 # Allow engine to direct the prepare flow (for POE)
1896 if ( $c->engine->can('prepare') ) {
1897 $c->engine->prepare( $c, @arguments );
1900 $c->prepare_request(@arguments);
1901 $c->prepare_connection;
1902 $c->prepare_query_parameters;
1903 $c->prepare_headers;
1904 $c->prepare_cookies;
1907 # Prepare the body for reading, either by prepare_body
1908 # or the user, if they are using $c->read
1911 # Parse the body unless the user wants it on-demand
1912 unless ( ref($c)->config->{parse_on_demand} ) {
1917 my $method = $c->req->method || '';
1918 my $path = $c->req->path;
1919 $path = '/' unless length $path;
1920 my $address = $c->req->address || '';
1929 =head2 $c->prepare_action
1931 Prepares action. See L<Catalyst::Dispatcher>.
1935 sub prepare_action { my $c = shift; $c->dispatcher->prepare_action( $c, @_ ) }
1937 =head2 $c->prepare_body
1939 Prepares message body.
1946 return if $c->request->_has_body;
1948 # Initialize on-demand data
1949 $c->engine->prepare_body( $c, @_ );
1950 $c->prepare_parameters;
1951 $c->prepare_uploads;
1954 =head2 $c->prepare_body_chunk( $chunk )
1956 Prepares a chunk of data before sending it to L<HTTP::Body>.
1958 See L<Catalyst::Engine>.
1962 sub prepare_body_chunk {
1964 $c->engine->prepare_body_chunk( $c, @_ );
1967 =head2 $c->prepare_body_parameters
1969 Prepares body parameters.
1973 sub prepare_body_parameters {
1975 $c->engine->prepare_body_parameters( $c, @_ );
1978 =head2 $c->prepare_connection
1980 Prepares connection.
1984 sub prepare_connection {
1986 $c->engine->prepare_connection( $c, @_ );
1989 =head2 $c->prepare_cookies
1995 sub prepare_cookies { my $c = shift; $c->engine->prepare_cookies( $c, @_ ) }
1997 =head2 $c->prepare_headers
2003 sub prepare_headers { my $c = shift; $c->engine->prepare_headers( $c, @_ ) }
2005 =head2 $c->prepare_parameters
2007 Prepares parameters.
2011 sub prepare_parameters {
2013 $c->prepare_body_parameters;
2014 $c->engine->prepare_parameters( $c, @_ );
2017 =head2 $c->prepare_path
2019 Prepares path and base.
2023 sub prepare_path { my $c = shift; $c->engine->prepare_path( $c, @_ ) }
2025 =head2 $c->prepare_query_parameters
2027 Prepares query parameters.
2031 sub prepare_query_parameters {
2034 $c->engine->prepare_query_parameters( $c, @_ );
2037 =head2 $c->log_request
2039 Writes information about the request to the debug logs. This includes:
2043 =item * Request method, path, and remote IP address
2045 =item * Query keywords (see L<Catalyst::Request/query_keywords>)
2047 =item * Request parameters
2049 =item * File uploads
2058 return unless $c->debug;
2060 my($dump) = grep {$_->[0] eq 'Request' } $c->dump_these;
2061 my $request = $dump->[1];
2063 my ( $method, $path, $address ) = ( $request->method, $request->path, $request->address );
2065 $path = '/' unless length $path;
2067 $c->log->debug(qq/"$method" request for "$path" from "$address"/);
2069 $c->log_request_headers($request->headers);
2071 if ( my $keywords = $request->query_keywords ) {
2072 $c->log->debug("Query keywords are: $keywords");
2075 $c->log_request_parameters( query => $request->query_parameters, $request->_has_body ? (body => $request->body_parameters) : () );
2077 $c->log_request_uploads($request);
2080 =head2 $c->log_response
2082 Writes information about the response to the debug logs by calling
2083 C<< $c->log_response_status_line >> and C<< $c->log_response_headers >>.
2090 return unless $c->debug;
2092 my($dump) = grep {$_->[0] eq 'Response' } $c->dump_these;
2093 my $response = $dump->[1];
2095 $c->log_response_status_line($response);
2096 $c->log_response_headers($response->headers);
2099 =head2 $c->log_response_status_line($response)
2101 Writes one line of information about the response to the debug logs. This includes:
2105 =item * Response status code
2107 =item * Content-Type header (if present)
2109 =item * Content-Length header (if present)
2115 sub log_response_status_line {
2116 my ($c, $response) = @_;
2120 'Response Code: %s; Content-Type: %s; Content-Length: %s',
2121 $response->status || 'unknown',
2122 $response->headers->header('Content-Type') || 'unknown',
2123 $response->headers->header('Content-Length') || 'unknown'
2128 =head2 $c->log_response_headers($headers);
2130 Hook method which can be wrapped by plugins to log the responseheaders.
2131 No-op in the default implementation.
2135 sub log_response_headers {}
2137 =head2 $c->log_request_parameters( query => {}, body => {} )
2139 Logs request parameters to debug logs
2143 sub log_request_parameters {
2145 my %all_params = @_;
2147 return unless $c->debug;
2149 my $column_width = Catalyst::Utils::term_width() - 44;
2150 foreach my $type (qw(query body)) {
2151 my $params = $all_params{$type};
2152 next if ! keys %$params;
2153 my $t = Text::SimpleTable->new( [ 35, 'Parameter' ], [ $column_width, 'Value' ] );
2154 for my $key ( sort keys %$params ) {
2155 my $param = $params->{$key};
2156 my $value = defined($param) ? $param : '';
2157 $t->row( $key, ref $value eq 'ARRAY' ? ( join ', ', @$value ) : $value );
2159 $c->log->debug( ucfirst($type) . " Parameters are:\n" . $t->draw );
2163 =head2 $c->log_request_uploads
2165 Logs file uploads included in the request to the debug logs.
2166 The parameter name, filename, file type, and file size are all included in
2171 sub log_request_uploads {
2173 my $request = shift;
2174 return unless $c->debug;
2175 my $uploads = $request->uploads;
2176 if ( keys %$uploads ) {
2177 my $t = Text::SimpleTable->new(
2178 [ 12, 'Parameter' ],
2183 for my $key ( sort keys %$uploads ) {
2184 my $upload = $uploads->{$key};
2185 for my $u ( ref $upload eq 'ARRAY' ? @{$upload} : ($upload) ) {
2186 $t->row( $key, $u->filename, $u->type, $u->size );
2189 $c->log->debug( "File Uploads are:\n" . $t->draw );
2193 =head2 $c->log_request_headers($headers);
2195 Hook method which can be wrapped by plugins to log the request headers.
2196 No-op in the default implementation.
2200 sub log_request_headers {}
2202 =head2 $c->log_headers($type => $headers)
2204 Logs L<HTTP::Headers> (either request or response) to the debug logs.
2211 my $headers = shift; # an HTTP::Headers instance
2213 return unless $c->debug;
2215 my $column_width = Catalyst::Utils::term_width() - 28;
2216 my $t = Text::SimpleTable->new( [ 15, 'Header Name' ], [ $column_width, 'Value' ] );
2219 my ( $name, $value ) = @_;
2220 $t->row( $name, $value );
2223 $c->log->debug( ucfirst($type) . " Headers:\n" . $t->draw );
2227 =head2 $c->prepare_read
2229 Prepares the input for reading.
2233 sub prepare_read { my $c = shift; $c->engine->prepare_read( $c, @_ ) }
2235 =head2 $c->prepare_request
2237 Prepares the engine request.
2241 sub prepare_request { my $c = shift; $c->engine->prepare_request( $c, @_ ) }
2243 =head2 $c->prepare_uploads
2249 sub prepare_uploads {
2252 $c->engine->prepare_uploads( $c, @_ );
2255 =head2 $c->prepare_write
2257 Prepares the output for writing.
2261 sub prepare_write { my $c = shift; $c->engine->prepare_write( $c, @_ ) }
2263 =head2 $c->request_class
2265 Returns or sets the request class. Defaults to L<Catalyst::Request>.
2267 =head2 $c->response_class
2269 Returns or sets the response class. Defaults to L<Catalyst::Response>.
2271 =head2 $c->read( [$maxlength] )
2273 Reads a chunk of data from the request body. This method is designed to
2274 be used in a while loop, reading C<$maxlength> bytes on every call.
2275 C<$maxlength> defaults to the size of the request if not specified.
2277 You have to set C<< MyApp->config(parse_on_demand => 1) >> to use this
2280 Warning: If you use read(), Catalyst will not process the body,
2281 so you will not be able to access POST parameters or file uploads via
2282 $c->request. You must handle all body parsing yourself.
2286 sub read { my $c = shift; return $c->engine->read( $c, @_ ) }
2294 sub run { my $c = shift; return $c->engine->run( $c, @_ ) }
2296 =head2 $c->set_action( $action, $code, $namespace, $attrs )
2298 Sets an action in a given namespace.
2302 sub set_action { my $c = shift; $c->dispatcher->set_action( $c, @_ ) }
2304 =head2 $c->setup_actions($component)
2306 Sets up actions for a component.
2310 sub setup_actions { my $c = shift; $c->dispatcher->setup_actions( $c, @_ ) }
2312 =head2 $c->setup_config
2319 my %args = %{ $class->config || {} };
2321 my @container_classes = ( "${class}::Container", 'Catalyst::IOC::Container');
2322 unshift @container_classes, delete $args{container_class} if exists $args{container_class};
2324 my $container_class = Class::MOP::load_first_existing_class(@container_classes);
2326 my $container = $container_class->new( %args, name => "$class" );
2327 $class->container($container);
2329 my $config = $container->resolve(service => 'config');
2330 $class->config($config);
2331 $class->finalize_config; # back-compat
2334 =head2 $c->finalize_config
2338 sub finalize_config { }
2340 =head2 $c->setup_components
2342 This method is called internally to set up the application's components.
2344 It finds modules by calling the L<locate_components> method, expands them to
2345 package names with the L<expand_component_module> method, and then installs
2346 each component into the application.
2348 The C<setup_components> config option is passed to both of the above methods.
2350 Installation of each component is performed by the L<setup_component> method,
2355 sub setup_components {
2358 my $config = $class->config->{ setup_components };
2359 my $search_extra = $config->{ search_extra };
2361 my @comps = $class->locate_components($config);
2362 my %comps = map { $_ => 1 } @comps;
2364 my $deprecatedcatalyst_component_names = grep { /::[CMV]::/ } @comps;
2365 $class->log->warn(qq{Your application is using the deprecated ::[MVC]:: type naming scheme.\n}.
2366 qq{Please switch your class names to ::Model::, ::View:: and ::Controller: as appropriate.\n}
2367 ) if $deprecatedcatalyst_component_names;
2369 for my $component ( @comps ) {
2371 # We pass ignore_loaded here so that overlay files for (e.g.)
2372 # Model::DBI::Schema sub-classes are loaded - if it's in @comps
2373 # we know M::P::O found a file on disk so this is safe
2375 Catalyst::Utils::ensure_class_loaded( $component, { ignore_loaded => 1 } );
2379 $containers->{$_} = $class->container->get_sub_container($_) for qw(model view controller);
2381 for my $component (@comps) {
2382 my $instance = $class->components->{ $component } = $class->setup_component($component);
2383 if ( my ($type, $name) = _get_component_type_name($component, $search_extra) ) {
2384 $containers->{$type}->add_service(Catalyst::IOC::BlockInjection->new( name => $name, block => sub { return $instance } ));
2386 my @expanded_components = $instance->can('expand_modules')
2387 ? $instance->expand_modules( $component, $config )
2388 : $class->expand_component_module( $component, $config );
2389 for my $component (@expanded_components) {
2390 next if $comps{$component};
2392 $deprecatedcatalyst_component_names = grep { /::[CMV]::/ } @expanded_components;
2393 $class->log->warn(qq{Your application is using the deprecated ::[MVC]:: type naming scheme.\n}.
2394 qq{Please switch your class names to ::Model::, ::View:: and ::Controller: as appropriate.\n}
2395 ) if $deprecatedcatalyst_component_names;
2397 if (my ($type, $name) = _get_component_type_name($component, $search_extra)) {
2398 $containers->{$type}->add_service(Catalyst::IOC::BlockInjection->new( name => $name, block => sub { return $class->setup_component($component) } ));
2401 $class->components->{ $component } = $class->setup_component($component);
2405 $containers->{model}->make_single_default;
2406 $containers->{view}->make_single_default;
2409 # FIXME: should this sub exist?
2410 # should it be moved to Catalyst::Utils,
2411 # or replaced by something already existing there?
2412 sub _get_component_type_name {
2413 my ( $component, $search_extra) = @_;
2414 $search_extra ||= [];
2415 my @search_extra = map { s/^:://; lc $_ } @$search_extra;
2417 my @parts = split /::/, $component;
2419 if (scalar @parts == 1) {
2420 return (undef, $component);
2423 while (my $type = shift @parts) {
2424 return ('controller', join '::', @parts)
2425 if $type =~ /^(c|controller)$/i;
2427 return ('model', join '::', @parts)
2428 if $type =~ /^(m|model)$/i;
2430 return ('view', join '::', @parts)
2431 if $type =~ /^(v|view)$/i;
2433 return (_get_component_type($component), join '::', @parts)
2434 if @search_extra and ( grep { lc $type eq $_ } @search_extra );
2438 sub _get_component_type {
2439 my ( $instance ) = @_;
2441 return 'controller' if $instance->isa('Catalyst::Controller');
2442 return 'model' if $instance->isa('Catalyst::Model');
2443 return 'view' if $instance->isa('Catalyst::View');
2446 =head2 $c->locate_components( $setup_component_config )
2448 This method is meant to provide a list of component modules that should be
2449 setup for the application. By default, it will use L<Module::Pluggable>.
2451 Specify a C<setup_components> config option to pass additional options directly
2452 to L<Module::Pluggable>. To add additional search paths, specify a key named
2453 C<search_extra> as an array reference. Items in the array beginning with C<::>
2454 will have the application class name prepended to them.
2458 sub locate_components {
2462 my @paths = qw( ::Controller ::C ::Model ::M ::View ::V );
2463 my $extra = delete $config->{ search_extra } || [];
2465 push @paths, @$extra;
2467 my $locator = Module::Pluggable::Object->new(
2468 search_path => [ map { s/^(?=::)/$class/; $_; } @paths ],
2472 # XXX think about ditching this sort entirely
2473 my @comps = sort { length $a <=> length $b } $locator->plugins;
2478 =head2 $c->expand_component_module( $component, $setup_component_config )
2480 Components found by C<locate_components> will be passed to this method, which
2481 is expected to return a list of component (package) names to be set up.
2485 sub expand_component_module {
2486 my ($class, $module) = @_;
2487 return Devel::InnerPackage::list_packages( $module );
2490 =head2 $c->setup_component
2494 sub setup_component {
2495 my( $class, $component ) = @_;
2497 unless ( $component->can( 'COMPONENT' ) ) {
2501 my $suffix = Catalyst::Utils::class2classsuffix( $component );
2502 my $config = $class->config->{ $suffix } || {};
2503 # Stash catalyst_component_name in the config here, so that custom COMPONENT
2504 # methods also pass it. local to avoid pointlessly shitting in config
2505 # for the debug screen, as $component is already the key name.
2506 local $config->{catalyst_component_name} = $component;
2508 my $instance = eval { $component->COMPONENT( $class, $config ); };
2510 if ( my $error = $@ ) {
2512 Catalyst::Exception->throw(
2513 message => qq/Couldn't instantiate component "$component", "$error"/
2516 elsif (!blessed $instance) {
2517 my $metaclass = Moose::Util::find_meta($component);
2518 my $method_meta = $metaclass->find_method_by_name('COMPONENT');
2519 my $component_method_from = $method_meta->associated_metaclass->name;
2520 my $value = defined($instance) ? $instance : 'undef';
2521 Catalyst::Exception->throw(
2523 qq/Couldn't instantiate component "$component", COMPONENT() method (from $component_method_from) didn't return an object-like value (value was $value)./
2530 =head2 $c->setup_dispatcher
2536 sub setup_dispatcher {
2537 my ( $class, $dispatcher ) = @_;
2540 $dispatcher = 'Catalyst::Dispatcher::' . $dispatcher;
2543 if ( my $env = Catalyst::Utils::env_value( $class, 'DISPATCHER' ) ) {
2544 $dispatcher = 'Catalyst::Dispatcher::' . $env;
2547 unless ($dispatcher) {
2548 $dispatcher = $class->dispatcher_class;
2551 Class::MOP::load_class($dispatcher);
2553 # dispatcher instance
2554 $class->dispatcher( $dispatcher->new );
2557 =head2 $c->setup_engine
2564 my ( $class, $engine ) = @_;
2567 $engine = 'Catalyst::Engine::' . $engine;
2570 if ( my $env = Catalyst::Utils::env_value( $class, 'ENGINE' ) ) {
2571 $engine = 'Catalyst::Engine::' . $env;
2574 if ( $ENV{MOD_PERL} ) {
2575 my $meta = Class::MOP::get_metaclass_by_name($class);
2577 # create the apache method
2578 $meta->add_method('apache' => sub { shift->engine->apache });
2580 my ( $software, $version ) =
2581 $ENV{MOD_PERL} =~ /^(\S+)\/(\d+(?:[\.\_]\d+)+)/;
2584 $version =~ s/(\.[^.]+)\./$1/g;
2586 if ( $software eq 'mod_perl' ) {
2590 if ( $version >= 1.99922 ) {
2591 $engine = 'Catalyst::Engine::Apache2::MP20';
2594 elsif ( $version >= 1.9901 ) {
2595 $engine = 'Catalyst::Engine::Apache2::MP19';
2598 elsif ( $version >= 1.24 ) {
2599 $engine = 'Catalyst::Engine::Apache::MP13';
2603 Catalyst::Exception->throw( message =>
2604 qq/Unsupported mod_perl version: $ENV{MOD_PERL}/ );
2609 # install the correct mod_perl handler
2610 if ( $version >= 1.9901 ) {
2611 *handler = sub : method {
2612 shift->handle_request(@_);
2616 *handler = sub ($$) { shift->handle_request(@_) };
2621 elsif ( $software eq 'Zeus-Perl' ) {
2622 $engine = 'Catalyst::Engine::Zeus';
2626 Catalyst::Exception->throw(
2627 message => qq/Unsupported mod_perl: $ENV{MOD_PERL}/ );
2632 $engine = $class->engine_class;
2635 Class::MOP::load_class($engine);
2637 # check for old engines that are no longer compatible
2639 if ( $engine->isa('Catalyst::Engine::Apache')
2640 && !Catalyst::Engine::Apache->VERSION )
2645 elsif ( $engine->isa('Catalyst::Engine::Server::Base')
2646 && Catalyst::Engine::Server->VERSION le '0.02' )
2651 elsif ($engine->isa('Catalyst::Engine::HTTP::POE')
2652 && $engine->VERSION eq '0.01' )
2657 elsif ($engine->isa('Catalyst::Engine::Zeus')
2658 && $engine->VERSION eq '0.01' )
2664 Catalyst::Exception->throw( message =>
2665 qq/Engine "$engine" is not supported by this version of Catalyst/
2670 $class->engine( $engine->new );
2673 =head2 $c->setup_home
2675 Sets up the home directory.
2680 my ( $class, $home ) = @_;
2682 if ( my $env = Catalyst::Utils::env_value( $class, 'HOME' ) ) {
2686 $home ||= Catalyst::Utils::home($class);
2689 #I remember recently being scolded for assigning config values like this
2690 $class->config->{home} ||= $home;
2691 $class->config->{root} ||= Path::Class::Dir->new($home)->subdir('root');
2695 =head2 $c->setup_log
2697 Sets up log by instantiating a L<Catalyst::Log|Catalyst::Log> object and
2698 passing it to C<log()>. Pass in a comma-delimited list of levels to set the
2701 This method also installs a C<debug> method that returns a true value into the
2702 catalyst subclass if the "debug" level is passed in the comma-delimited list,
2703 or if the C<$CATALYST_DEBUG> environment variable is set to a true value.
2705 Note that if the log has already been setup, by either a previous call to
2706 C<setup_log> or by a call such as C<< __PACKAGE__->log( MyLogger->new ) >>,
2707 that this method won't actually set up the log object.
2712 my ( $class, $levels ) = @_;
2715 $levels =~ s/^\s+//;
2716 $levels =~ s/\s+$//;
2717 my %levels = map { $_ => 1 } split /\s*,\s*/, $levels;
2719 my $env_debug = Catalyst::Utils::env_value( $class, 'DEBUG' );
2720 if ( defined $env_debug ) {
2721 $levels{debug} = 1 if $env_debug; # Ugly!
2722 delete($levels{debug}) unless $env_debug;
2725 unless ( $class->log ) {
2726 $class->log( Catalyst::Log->new(keys %levels) );
2729 if ( $levels{debug} ) {
2730 Class::MOP::get_metaclass_by_name($class)->add_method('debug' => sub { 1 });
2731 $class->log->debug('Debug messages enabled');
2735 =head2 $c->setup_plugins
2741 =head2 $c->setup_stats
2743 Sets up timing statistics class.
2748 my ( $class, $stats ) = @_;
2750 Catalyst::Utils::ensure_class_loaded($class->stats_class);
2752 my $env = Catalyst::Utils::env_value( $class, 'STATS' );
2753 if ( defined($env) ? $env : ($stats || $class->debug ) ) {
2754 Class::MOP::get_metaclass_by_name($class)->add_method('use_stats' => sub { 1 });
2755 $class->log->debug('Statistics enabled');
2760 =head2 $c->registered_plugins
2762 Returns a sorted list of the plugins which have either been stated in the
2763 import list or which have been added via C<< MyApp->plugin(@args); >>.
2765 If passed a given plugin name, it will report a boolean value indicating
2766 whether or not that plugin is loaded. A fully qualified name is required if
2767 the plugin name does not begin with C<Catalyst::Plugin::>.
2769 if ($c->registered_plugins('Some::Plugin')) {
2777 sub registered_plugins {
2779 return sort keys %{ $proto->_plugins } unless @_;
2781 return 1 if exists $proto->_plugins->{$plugin};
2782 return exists $proto->_plugins->{"Catalyst::Plugin::$plugin"};
2785 sub _register_plugin {
2786 my ( $proto, $plugin, $instant ) = @_;
2787 my $class = ref $proto || $proto;
2789 Class::MOP::load_class( $plugin );
2790 $class->log->warn( "$plugin inherits from 'Catalyst::Component' - this is deprecated and will not work in 5.81" )
2791 if $plugin->isa( 'Catalyst::Component' );
2792 $proto->_plugins->{$plugin} = 1;
2794 my $meta = Class::MOP::get_metaclass_by_name($class);
2795 $meta->superclasses($plugin, $meta->superclasses);
2801 my ( $class, $plugins ) = @_;
2803 $class->_plugins( {} ) unless $class->_plugins;
2804 $plugins = Data::OptList::mkopt($plugins || []);
2807 [ Catalyst::Utils::resolve_namespace(
2808 $class . '::Plugin',
2809 'Catalyst::Plugin', $_->[0]
2815 for my $plugin ( reverse @plugins ) {
2816 Class::MOP::load_class($plugin->[0], $plugin->[1]);
2817 my $meta = find_meta($plugin->[0]);
2818 next if $meta && $meta->isa('Moose::Meta::Role');
2820 $class->_register_plugin($plugin->[0]);
2824 map { $_->[0]->name, $_->[1] }
2825 grep { blessed($_->[0]) && $_->[0]->isa('Moose::Meta::Role') }
2826 map { [find_meta($_->[0]), $_->[1]] }
2829 Moose::Util::apply_all_roles(
2837 Returns an arrayref of the internal execution stack (actions that are
2838 currently executing).
2842 Returns the current timing statistics object. By default Catalyst uses
2843 L<Catalyst::Stats|Catalyst::Stats>, but can be set otherwise with
2844 L<< stats_class|/"$c->stats_class" >>.
2846 Even if L<< -Stats|/"-Stats" >> is not enabled, the stats object is still
2847 available. By enabling it with C< $c->stats->enabled(1) >, it can be used to
2848 profile explicitly, although MyApp.pm still won't profile nor output anything
2851 =head2 $c->stats_class
2853 Returns or sets the stats (timing statistics) class. L<Catalyst::Stats|Catalyst::Stats> is used by default.
2855 =head2 $c->use_stats
2857 Returns 1 when L<< stats collection|/"-Stats" >> is enabled.
2859 Note that this is a static method, not an accessor and should be overridden
2860 by declaring C<sub use_stats { 1 }> in your MyApp.pm, not by calling C<< $c->use_stats(1) >>.
2867 =head2 $c->write( $data )
2869 Writes $data to the output stream. When using this method directly, you
2870 will need to manually set the C<Content-Length> header to the length of
2871 your output data, if known.
2878 # Finalize headers if someone manually writes output
2879 $c->finalize_headers;
2881 return $c->engine->write( $c, @_ );
2886 Returns the Catalyst version number. Mostly useful for "powered by"
2887 messages in template systems.
2891 sub version { return $Catalyst::VERSION }
2893 =head1 CONFIGURATION
2895 There are a number of 'base' config variables which can be set:
2901 C<default_model> - The default model picked if you say C<< $c->model >>. See L<< /$c->model($name) >>.
2905 C<default_view> - The default view to be rendered or returned when C<< $c->view >> is called. See L<< /$c->view($name) >>.
2909 C<home> - The application home directory. In an uninstalled application,
2910 this is the top level application directory. In an installed application,
2911 this will be the directory containing C<< MyApp.pm >>.
2915 C<ignore_frontend_proxy> - See L</PROXY SUPPORT>
2919 C<name> - The name of the application in debug messages and the debug and
2924 C<parse_on_demand> - The request body (for example file uploads) will not be parsed
2925 until it is accessed. This allows you to (for example) check authentication (and reject
2926 the upload) before actually recieving all the data. See L</ON-DEMAND PARSER>
2930 C<root> - The root directory for templates. Usually this is just a
2931 subdirectory of the home directory, but you can set it to change the
2932 templates to a different directory.
2936 C<search_extra> - Array reference passed to Module::Pluggable to for additional
2937 namespaces from which components will be loaded (and constructed and stored in
2938 C<< $c->components >>).
2942 C<show_internal_actions> - If true, causes internal actions such as C<< _DISPATCH >>
2943 to be shown in hit debug tables in the test server.
2947 C<use_request_uri_for_path> - Controlls if the C<REQUEST_URI> or C<PATH_INFO> environment
2948 variable should be used for determining the request path. See L<Catalyst::Engine::CGI/PATH DECODING>
2949 for more information.
2953 C<using_frontend_proxy> - See L</PROXY SUPPORT>.
2957 =head1 INTERNAL ACTIONS
2959 Catalyst uses internal actions like C<_DISPATCH>, C<_BEGIN>, C<_AUTO>,
2960 C<_ACTION>, and C<_END>. These are by default not shown in the private
2961 action table, but you can make them visible with a config parameter.
2963 MyApp->config(show_internal_actions => 1);
2965 =head1 ON-DEMAND PARSER
2967 The request body is usually parsed at the beginning of a request,
2968 but if you want to handle input yourself, you can enable on-demand
2969 parsing with a config parameter.
2971 MyApp->config(parse_on_demand => 1);
2973 =head1 PROXY SUPPORT
2975 Many production servers operate using the common double-server approach,
2976 with a lightweight frontend web server passing requests to a larger
2977 backend server. An application running on the backend server must deal
2978 with two problems: the remote user always appears to be C<127.0.0.1> and
2979 the server's hostname will appear to be C<localhost> regardless of the
2980 virtual host that the user connected through.
2982 Catalyst will automatically detect this situation when you are running
2983 the frontend and backend servers on the same machine. The following
2984 changes are made to the request.
2986 $c->req->address is set to the user's real IP address, as read from
2987 the HTTP X-Forwarded-For header.
2989 The host value for $c->req->base and $c->req->uri is set to the real
2990 host, as read from the HTTP X-Forwarded-Host header.
2992 Additionally, you may be running your backend application on an insecure
2993 connection (port 80) while your frontend proxy is running under SSL. If there
2994 is a discrepancy in the ports, use the HTTP header C<X-Forwarded-Port> to
2995 tell Catalyst what port the frontend listens on. This will allow all URIs to
2996 be created properly.
2998 In the case of passing in:
3000 X-Forwarded-Port: 443
3002 All calls to C<uri_for> will result in an https link, as is expected.
3004 Obviously, your web server must support these headers for this to work.
3006 In a more complex server farm environment where you may have your
3007 frontend proxy server(s) on different machines, you will need to set a
3008 configuration option to tell Catalyst to read the proxied data from the
3011 MyApp->config(using_frontend_proxy => 1);
3013 If you do not wish to use the proxy support at all, you may set:
3015 MyApp->config(ignore_frontend_proxy => 1);
3017 =head1 THREAD SAFETY
3019 Catalyst has been tested under Apache 2's threading C<mpm_worker>,
3020 C<mpm_winnt>, and the standalone forking HTTP server on Windows. We
3021 believe the Catalyst core to be thread-safe.
3023 If you plan to operate in a threaded environment, remember that all other
3024 modules you are using must also be thread-safe. Some modules, most notably
3025 L<DBD::SQLite>, are not thread-safe.
3031 Join #catalyst on irc.perl.org.
3035 http://lists.scsys.co.uk/cgi-bin/mailman/listinfo/catalyst
3036 http://lists.scsys.co.uk/cgi-bin/mailman/listinfo/catalyst-dev
3040 http://catalyst.perl.org
3044 http://dev.catalyst.perl.org
3048 =head2 L<Task::Catalyst> - All you need to start with Catalyst
3050 =head2 L<Catalyst::Manual> - The Catalyst Manual
3052 =head2 L<Catalyst::Component>, L<Catalyst::Controller> - Base classes for components
3054 =head2 L<Catalyst::Engine> - Core engine
3056 =head2 L<Catalyst::Log> - Log class.
3058 =head2 L<Catalyst::Request> - Request object
3060 =head2 L<Catalyst::Response> - Response object
3062 =head2 L<Catalyst::Test> - The test suite.
3064 =head1 PROJECT FOUNDER
3066 sri: Sebastian Riedel <sri@cpan.org>
3072 acme: Leon Brocard <leon@astray.com>
3074 abraxxa: Alexander Hartmaier <abraxxa@cpan.org>
3078 Andrew Ford E<lt>A.Ford@ford-mason.co.ukE<gt>
3084 andyg: Andy Grundman <andy@hybridized.org>
3086 audreyt: Audrey Tang
3088 bricas: Brian Cassidy <bricas@cpan.org>
3090 Caelum: Rafael Kitover <rkitover@io.com>
3092 chansen: Christian Hansen
3094 chicks: Christopher Hicks
3096 Chisel Wright C<pause@herlpacker.co.uk>
3098 Danijel Milicevic C<me@danijel.de>
3100 David Kamholz E<lt>dkamholz@cpan.orgE<gt>
3102 David Naughton, C<naughton@umn.edu>
3106 dhoss: Devin Austin <dhoss@cpan.org>
3108 dkubb: Dan Kubb <dan.kubb-cpan@onautopilot.com>
3112 dwc: Daniel Westermann-Clark <danieltwc@cpan.org>
3114 esskar: Sascha Kiefer
3116 fireartist: Carl Franks <cfranks@cpan.org>
3118 frew: Arthur Axel "fREW" Schmidt <frioux@gmail.com>
3120 gabb: Danijel Milicevic
3124 Gavin Henry C<ghenry@perl.me.uk>
3128 groditi: Guillermo Roditi <groditi@gmail.com>
3130 hobbs: Andrew Rodland <andrew@cleverdomain.org>
3132 ilmari: Dagfinn Ilmari Mannsåker <ilmari@ilmari.org>
3134 jcamacho: Juan Camacho
3136 jester: Jesse Sheidlower C<jester@panix.com>
3138 jhannah: Jay Hannah <jay@jays.net>
3144 jon: Jon Schutz <jjschutz@cpan.org>
3146 Jonathan Rockway C<< <jrockway@cpan.org> >>
3148 Kieren Diment C<kd@totaldatasolution.com>
3150 konobi: Scott McWhirter <konobi@cpan.org>
3152 marcus: Marcus Ramberg <mramberg@cpan.org>
3154 miyagawa: Tatsuhiko Miyagawa <miyagawa@bulknews.net>
3156 mst: Matt S. Trout <mst@shadowcatsystems.co.uk>
3160 naughton: David Naughton
3162 ningu: David Kamholz <dkamholz@cpan.org>
3164 nothingmuch: Yuval Kogman <nothingmuch@woobling.org>
3166 numa: Dan Sully <daniel@cpan.org>
3172 omega: Andreas Marienborg
3174 Oleg Kostyuk <cub.uanic@gmail.com>
3176 phaylon: Robert Sedlacek <phaylon@dunkelheit.at>
3178 rafl: Florian Ragwitz <rafl@debian.org>
3180 random: Roland Lammel <lammel@cpan.org>
3182 Robert Sedlacek C<< <rs@474.at> >>
3184 SpiceMan: Marcel Montes
3188 szbalint: Balint Szilakszi <szbalint@cpan.org>
3190 t0m: Tomas Doran <bobtfish@bobtfish.net>
3194 Viljo Marrandi C<vilts@yahoo.com>
3196 Will Hawes C<info@whawes.co.uk>
3198 willert: Sebastian Willert <willert@cpan.org>
3200 wreis: Wallace Reis <wallace@reis.org.br>
3202 Yuval Kogman, C<nothingmuch@woobling.org>
3204 rainboxx: Matthias Dietrich, C<perl@rainboxx.de>
3206 dd070: Dhaval Dhanani <dhaval070@gmail.com>
3210 Copyright (c) 2005, the above named PROJECT FOUNDER and CONTRIBUTORS.
3214 This library is free software. You can redistribute it and/or modify it under
3215 the same terms as Perl itself.
3221 __PACKAGE__->meta->make_immutable;