4 use Moose::Meta::Class ();
5 extends 'Catalyst::Component';
6 use Moose::Util qw/find_meta/;
7 use B::Hooks::EndOfScope ();
8 use Catalyst::Exception;
9 use Catalyst::Exception::Detach;
10 use Catalyst::Exception::Go;
12 use Catalyst::Request;
13 use Catalyst::Request::Upload;
14 use Catalyst::Response;
16 use Catalyst::Controller;
18 use Devel::InnerPackage ();
20 use Module::Pluggable::Object ();
21 use Text::SimpleTable ();
22 use Path::Class::Dir ();
23 use Path::Class::File ();
27 use Tree::Simple qw/use_weak_refs/;
28 use Tree::Simple::Visitor::FindByUID;
29 use Class::C3::Adopt::NEXT;
30 use List::MoreUtils qw/uniq/;
33 use Carp qw/croak carp shortmess/;
35 BEGIN { require 5.008004; }
37 has stack => (is => 'ro', default => sub { [] });
38 has stash => (is => 'rw', default => sub { {} });
39 has state => (is => 'rw', default => 0);
40 has stats => (is => 'rw');
41 has action => (is => 'rw');
42 has counter => (is => 'rw', default => sub { {} });
43 has request => (is => 'rw', default => sub { $_[0]->request_class->new({}) }, required => 1, lazy => 1);
44 has response => (is => 'rw', default => sub { $_[0]->response_class->new({}) }, required => 1, lazy => 1);
45 has namespace => (is => 'rw');
47 sub depth { scalar @{ shift->stack || [] }; }
48 sub comp { shift->component(@_) }
51 my $self = shift; return $self->request(@_);
54 my $self = shift; return $self->response(@_);
57 # For backwards compatibility
58 sub finalize_output { shift->finalize_body(@_) };
63 our $RECURSION = 1000;
64 our $DETACH = Catalyst::Exception::Detach->new;
65 our $GO = Catalyst::Exception::Go->new;
67 #I imagine that very few of these really need to be class variables. if any.
68 #maybe we should just make them attributes with a default?
69 __PACKAGE__->mk_classdata($_)
70 for qw/container components arguments dispatcher engine log dispatcher_class
71 engine_class context_class request_class response_class stats_class
74 __PACKAGE__->dispatcher_class('Catalyst::Dispatcher');
75 __PACKAGE__->engine_class('Catalyst::Engine::CGI');
76 __PACKAGE__->request_class('Catalyst::Request');
77 __PACKAGE__->response_class('Catalyst::Response');
78 __PACKAGE__->stats_class('Catalyst::Stats');
80 # Remember to update this in Catalyst::Runtime as well!
82 our $VERSION = '5.80032';
85 my ( $class, @arguments ) = @_;
87 # We have to limit $class to Catalyst to avoid pushing Catalyst upon every
89 return unless $class eq 'Catalyst';
91 my $caller = caller();
92 return if $caller eq 'main';
94 my $meta = Moose::Meta::Class->initialize($caller);
95 unless ( $caller->isa('Catalyst') ) {
96 my @superclasses = ($meta->superclasses, $class, 'Catalyst::Controller');
97 $meta->superclasses(@superclasses);
99 # Avoid possible C3 issues if 'Moose::Object' is already on RHS of MyApp
100 $meta->superclasses(grep { $_ ne 'Moose::Object' } $meta->superclasses);
102 unless( $meta->has_method('meta') ){
103 if ($Moose::VERSION >= 1.15) {
104 $meta->_add_meta_method('meta');
107 $meta->add_method(meta => sub { Moose::Meta::Class->initialize("${caller}") } );
111 $caller->arguments( [@arguments] );
115 sub _application { $_[0] }
119 Catalyst - The Elegant MVC Web Application Framework
123 See the L<Catalyst::Manual> distribution for comprehensive
124 documentation and tutorials.
126 # Install Catalyst::Devel for helpers and other development tools
127 # use the helper to create a new application
130 # add models, views, controllers
131 script/myapp_create.pl model MyDatabase DBIC::Schema create=static dbi:SQLite:/path/to/db
132 script/myapp_create.pl view MyTemplate TT
133 script/myapp_create.pl controller Search
135 # built in testserver -- use -r to restart automatically on changes
136 # --help to see all available options
137 script/myapp_server.pl
139 # command line testing interface
140 script/myapp_test.pl /yada
143 use Catalyst qw/-Debug/; # include plugins here as well
145 ### In lib/MyApp/Controller/Root.pm (autocreated)
146 sub foo : Global { # called for /foo, /foo/1, /foo/1/2, etc.
147 my ( $self, $c, @args ) = @_; # args are qw/1 2/ for /foo/1/2
148 $c->stash->{template} = 'foo.tt'; # set the template
149 # lookup something from db -- stash vars are passed to TT
151 $c->model('Database::Foo')->search( { country => $args[0] } );
152 if ( $c->req->params->{bar} ) { # access GET or POST parameters
153 $c->forward( 'bar' ); # process another action
154 # do something else after forward returns
158 # The foo.tt TT template can use the stash data from the database
159 [% WHILE (item = data.next) %]
163 # called for /bar/of/soap, /bar/of/soap/10, etc.
164 sub bar : Path('/bar/of/soap') { ... }
166 # called for all actions, from the top-most controller downwards
168 my ( $self, $c ) = @_;
169 if ( !$c->user_exists ) { # Catalyst::Plugin::Authentication
170 $c->res->redirect( '/login' ); # require login
171 return 0; # abort request and go immediately to end()
173 return 1; # success; carry on to next action
176 # called after all actions are finished
178 my ( $self, $c ) = @_;
179 if ( scalar @{ $c->error } ) { ... } # handle errors
180 return if $c->res->body; # already have a response
181 $c->forward( 'MyApp::View::TT' ); # render template
184 ### in MyApp/Controller/Foo.pm
185 # called for /foo/bar
186 sub bar : Local { ... }
188 # called for /blargle
189 sub blargle : Global { ... }
191 # an index action matches /foo, but not /foo/1, etc.
192 sub index : Private { ... }
194 ### in MyApp/Controller/Foo/Bar.pm
195 # called for /foo/bar/baz
196 sub baz : Local { ... }
198 # first Root auto is called, then Foo auto, then this
199 sub auto : Private { ... }
201 # powerful regular expression paths are also possible
202 sub details : Regex('^product/(\w+)/details$') {
203 my ( $self, $c ) = @_;
204 # extract the (\w+) from the URI
205 my $product = $c->req->captures->[0];
208 See L<Catalyst::Manual::Intro> for additional information.
212 Catalyst is a modern framework for making web applications without the
213 pain usually associated with this process. This document is a reference
214 to the main Catalyst application. If you are a new user, we suggest you
215 start with L<Catalyst::Manual::Tutorial> or L<Catalyst::Manual::Intro>.
217 See L<Catalyst::Manual> for more documentation.
219 Catalyst plugins can be loaded by naming them as arguments to the "use
220 Catalyst" statement. Omit the C<Catalyst::Plugin::> prefix from the
221 plugin name, i.e., C<Catalyst::Plugin::My::Module> becomes
224 use Catalyst qw/My::Module/;
226 If your plugin starts with a name other than C<Catalyst::Plugin::>, you can
227 fully qualify the name by using a unary plus:
231 +Fully::Qualified::Plugin::Name
234 Special flags like C<-Debug> and C<-Engine> can also be specified as
235 arguments when Catalyst is loaded:
237 use Catalyst qw/-Debug My::Module/;
239 The position of plugins and flags in the chain is important, because
240 they are loaded in the order in which they appear.
242 The following flags are supported:
246 Enables debug output. You can also force this setting from the system
247 environment with CATALYST_DEBUG or <MYAPP>_DEBUG. The environment
248 settings override the application, with <MYAPP>_DEBUG having the highest
251 This sets the log level to 'debug' and enables full debug output on the
252 error screen. If you only want the latter, see L<< $c->debug >>.
256 Forces Catalyst to use a specific engine. Omit the
257 C<Catalyst::Engine::> prefix of the engine name, i.e.:
259 use Catalyst qw/-Engine=CGI/;
263 Forces Catalyst to use a specific home directory, e.g.:
265 use Catalyst qw[-Home=/usr/mst];
267 This can also be done in the shell environment by setting either the
268 C<CATALYST_HOME> environment variable or C<MYAPP_HOME>; where C<MYAPP>
269 is replaced with the uppercased name of your application, any "::" in
270 the name will be replaced with underscores, e.g. MyApp::Web should use
271 MYAPP_WEB_HOME. If both variables are set, the MYAPP_HOME one will be used.
273 If none of these are set, Catalyst will attempt to automatically detect the
274 home directory. If you are working in a development envirnoment, Catalyst
275 will try and find the directory containing either Makefile.PL, Build.PL or
276 dist.ini. If the application has been installed into the system (i.e.
277 you have done C<make install>), then Catalyst will use the path to your
278 application module, without the .pm extension (ie, /foo/MyApp if your
279 application was installed at /foo/MyApp.pm)
283 use Catalyst '-Log=warn,fatal,error';
285 Specifies a comma-delimited list of log levels.
289 Enables statistics collection and reporting.
291 use Catalyst qw/-Stats=1/;
293 You can also force this setting from the system environment with CATALYST_STATS
294 or <MYAPP>_STATS. The environment settings override the application, with
295 <MYAPP>_STATS having the highest priority.
297 Stats are also enabled if L<< debugging |/"-Debug" >> is enabled.
301 =head2 INFORMATION ABOUT THE CURRENT REQUEST
305 Returns a L<Catalyst::Action> object for the current action, which
306 stringifies to the action name. See L<Catalyst::Action>.
310 Returns the namespace of the current action, i.e., the URI prefix
311 corresponding to the controller of the current action. For example:
313 # in Controller::Foo::Bar
314 $c->namespace; # returns 'foo/bar';
320 Returns the current L<Catalyst::Request> object, giving access to
321 information about the current client request (including parameters,
322 cookies, HTTP headers, etc.). See L<Catalyst::Request>.
324 =head2 REQUEST FLOW HANDLING
326 =head2 $c->forward( $action [, \@arguments ] )
328 =head2 $c->forward( $class, $method, [, \@arguments ] )
330 Forwards processing to another action, by its private name. If you give a
331 class name but no method, C<process()> is called. You may also optionally
332 pass arguments in an arrayref. The action will receive the arguments in
333 C<@_> and C<< $c->req->args >>. Upon returning from the function,
334 C<< $c->req->args >> will be restored to the previous values.
336 Any data C<return>ed from the action forwarded to, will be returned by the
339 my $foodata = $c->forward('/foo');
340 $c->forward('index');
341 $c->forward(qw/Model::DBIC::Foo do_stuff/);
342 $c->forward('View::TT');
344 Note that L<< forward|/"$c->forward( $action [, \@arguments ] )" >> implies
345 an C<< eval { } >> around the call (actually
346 L<< execute|/"$c->execute( $class, $coderef )" >> does), thus de-fatalizing
347 all 'dies' within the called action. If you want C<die> to propagate you
348 need to do something like:
351 die join "\n", @{ $c->error } if @{ $c->error };
353 Or make sure to always return true values from your actions and write
356 $c->forward('foo') || return;
358 Another note is that C<< $c->forward >> always returns a scalar because it
359 actually returns $c->state which operates in a scalar context.
360 Thus, something like:
364 in an action that is forwarded to is going to return a scalar,
365 i.e. how many items are in that array, which is probably not what you want.
366 If you need to return an array then return a reference to it,
369 $c->stash->{array} = \@array;
371 and access it from the stash.
373 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.
377 sub forward { my $c = shift; no warnings 'recursion'; $c->dispatcher->forward( $c, @_ ) }
379 =head2 $c->detach( $action [, \@arguments ] )
381 =head2 $c->detach( $class, $method, [, \@arguments ] )
385 The same as L<< forward|/"$c->forward( $action [, \@arguments ] )" >>, but
386 doesn't return to the previous action when processing is finished.
388 When called with no arguments it escapes the processing chain entirely.
392 sub detach { my $c = shift; $c->dispatcher->detach( $c, @_ ) }
394 =head2 $c->visit( $action [, \@captures, \@arguments ] )
396 =head2 $c->visit( $class, $method, [, \@captures, \@arguments ] )
398 Almost the same as L<< forward|/"$c->forward( $action [, \@arguments ] )" >>,
399 but does a full dispatch, instead of just calling the new C<$action> /
400 C<< $class->$method >>. This means that C<begin>, C<auto> and the method
401 you go to are called, just like a new request.
403 In addition both C<< $c->action >> and C<< $c->namespace >> are localized.
404 This means, for example, that C<< $c->action >> methods such as
405 L<name|Catalyst::Action/name>, L<class|Catalyst::Action/class> and
406 L<reverse|Catalyst::Action/reverse> return information for the visited action
407 when they are invoked within the visited action. This is different from the
408 behavior of L<< forward|/"$c->forward( $action [, \@arguments ] )" >>, which
409 continues to use the $c->action object from the caller action even when
410 invoked from the callee.
412 C<< $c->stash >> is kept unchanged.
414 In effect, L<< visit|/"$c->visit( $action [, \@captures, \@arguments ] )" >>
415 allows you to "wrap" another action, just as it would have been called by
416 dispatching from a URL, while the analogous
417 L<< go|/"$c->go( $action [, \@captures, \@arguments ] )" >> allows you to
418 transfer control to another action as if it had been reached directly from a URL.
422 sub visit { my $c = shift; $c->dispatcher->visit( $c, @_ ) }
424 =head2 $c->go( $action [, \@captures, \@arguments ] )
426 =head2 $c->go( $class, $method, [, \@captures, \@arguments ] )
428 The relationship between C<go> and
429 L<< visit|/"$c->visit( $action [, \@captures, \@arguments ] )" >> is the same as
430 the relationship between
431 L<< forward|/"$c->forward( $class, $method, [, \@arguments ] )" >> and
432 L<< detach|/"$c->detach( $action [, \@arguments ] )" >>. Like C<< $c->visit >>,
433 C<< $c->go >> will perform a full dispatch on the specified action or method,
434 with localized C<< $c->action >> and C<< $c->namespace >>. Like C<detach>,
435 C<go> escapes the processing of the current request chain on completion, and
436 does not return to its caller.
438 @arguments are arguments to the final destination of $action. @captures are
439 arguments to the intermediate steps, if any, on the way to the final sub of
444 sub go { my $c = shift; $c->dispatcher->go( $c, @_ ) }
450 Returns the current L<Catalyst::Response> object, see there for details.
454 Returns a hashref to the stash, which may be used to store data and pass
455 it between components during a request. You can also set hash keys by
456 passing arguments. The stash is automatically sent to the view. The
457 stash is cleared at the end of a request; it cannot be used for
458 persistent storage (for this you must use a session; see
459 L<Catalyst::Plugin::Session> for a complete system integrated with
462 $c->stash->{foo} = $bar;
463 $c->stash( { moose => 'majestic', qux => 0 } );
464 $c->stash( bar => 1, gorch => 2 ); # equivalent to passing a hashref
466 # stash is automatically passed to the view for use in a template
467 $c->forward( 'MyApp::View::TT' );
471 around stash => sub {
474 my $stash = $orig->($c);
476 my $new_stash = @_ > 1 ? {@_} : $_[0];
477 croak('stash takes a hash or hashref') unless ref $new_stash;
478 foreach my $key ( keys %$new_stash ) {
479 $stash->{$key} = $new_stash->{$key};
489 =head2 $c->error($error, ...)
491 =head2 $c->error($arrayref)
493 Returns an arrayref containing error messages. If Catalyst encounters an
494 error while processing a request, it stores the error in $c->error. This
495 method should only be used to store fatal error messages.
497 my @error = @{ $c->error };
501 $c->error('Something bad happened');
508 my $error = ref $_[0] eq 'ARRAY' ? $_[0] : [@_];
509 croak @$error unless ref $c;
510 push @{ $c->{error} }, @$error;
512 elsif ( defined $_[0] ) { $c->{error} = undef }
513 return $c->{error} || [];
519 Contains the return value of the last executed action.
520 Note that << $c->state >> operates in a scalar context which means that all
521 values it returns are scalar.
523 =head2 $c->clear_errors
525 Clear errors. You probably don't want to clear the errors unless you are
526 implementing a custom error screen.
528 This is equivalent to running
539 =head2 COMPONENT ACCESSORS
541 =head2 $c->controller($name)
543 Gets a L<Catalyst::Controller> instance by name.
545 $c->controller('Foo')->do_stuff;
547 If the name is omitted, will return the controller for the dispatched
550 If you want to search for controllers, pass in a regexp as the argument.
552 # find all controllers that start with Foo
553 my @foo_controllers = $c->controller(qr{^Foo});
559 my ( $c, $name, @args ) = @_;
561 # FIXME: should this be a Catalyst::Utils method?
563 my $class = $c->action->class;
565 my $prefix = length Catalyst::Utils::class2classprefix($class);
567 # MyApp::Controller::Foo becomes Foo
568 # the + 2 is because of the ::
569 $name = substr $class, $prefix + 2;
572 return $c->container->get_component_from_sub_container( 'controller', $name, $c, @args);
575 =head2 $c->model($name)
577 Gets a L<Catalyst::Model> instance by name.
579 $c->model('Foo')->do_stuff;
581 Any extra arguments are directly passed to ACCEPT_CONTEXT.
583 If the name is omitted, it will look for
584 - a model object in $c->stash->{current_model_instance}, then
585 - a model name in $c->stash->{current_model}, then
586 - a config setting 'default_model', or
587 - check if there is only one model, and return it if that's the case.
589 If you want to search for models, pass in a regexp as the argument.
591 # find all models that start with Foo
592 my @foo_models = $c->model(qr{^Foo});
597 my ( $c, $name, @args ) = @_;
599 if (ref $c && !$name) {
600 return $c->stash->{current_model_instance}
601 if $c->stash->{current_model_instance};
603 $name = $c->stash->{current_model}
604 if $c->stash->{current_model};
607 return $c->container->get_component_from_sub_container( 'model', $name, $c, @args);
611 =head2 $c->view($name)
613 Gets a L<Catalyst::View> instance by name.
615 $c->view('Foo')->do_stuff;
617 Any extra arguments are directly passed to ACCEPT_CONTEXT.
619 If the name is omitted, it will look for
620 - a view object in $c->stash->{current_view_instance}, then
621 - a view name in $c->stash->{current_view}, then
622 - a config setting 'default_view', or
623 - check if there is only one view, and return it if that's the case.
625 If you want to search for views, pass in a regexp as the argument.
627 # find all views that start with Foo
628 my @foo_views = $c->view(qr{^Foo});
633 my ( $c, $name, @args ) = @_;
635 if (ref $c && !$name) {
636 return $c->stash->{current_view_instance}
637 if $c->stash->{current_view_instance};
639 $name = $c->stash->{current_view}
640 if $c->stash->{current_view};
643 return $c->container->get_component_from_sub_container( 'view', $name, $c, @args);
646 =head2 $c->controllers
648 Returns the available names which can be passed to $c->controller
654 return $c->container->get_sub_container('controller')->get_service_list;
659 Returns the available names which can be passed to $c->model
665 return $c->container->get_sub_container('model')->get_service_list;
671 Returns the available names which can be passed to $c->view
677 return $c->container->get_sub_container('view')->get_service_list;
680 =head2 $c->comp($name)
682 =head2 $c->component($name)
684 Gets a component object by name. This method is not recommended,
685 unless you want to get a specific component by full
686 class. C<< $c->controller >>, C<< $c->model >>, and C<< $c->view >>
687 should be used instead.
689 If C<$name> is a regexp, a list of components matched against the full
690 component name will be returned.
695 my ( $c, $component, @args ) = @_;
698 my ($type, $name) = _get_component_type_name($component);
700 if ($type && $c->container->has_sub_container($type)) {
701 my $container = $c->container->get_sub_container($type);
703 if( !ref $component && $container->has_service($name) ) {
704 return $container->get_component( $name, $c, @args );
707 return $container->get_component_regexp( $name, $c, @args );
710 if (ref $component) {
711 for my $subcontainer_name (qw/model view controller/) {
712 my $subcontainer = $c->container->get_sub_container($subcontainer_name);
713 my @components = $subcontainer->get_service_list;
714 my @result = grep { m{$component} } @components;
716 return map { $subcontainer->get_component( $_, $c, @args ) } @result
721 # FIXME: I probably shouldn't be doing this
722 # I'm keeping it temporarily for things like $c->comp('MyApp')
723 return $c->components->{$component}
724 if exists $c->components->{$component} and !@args;
726 $c->log->warn("Looking for '$component', but nothing was found.");
728 # I would expect to return an empty list here, but that breaks back-compat
732 return sort keys %{ $c->components };
735 =head2 CLASS DATA AND HELPER CLASSES
739 Returns or takes a hashref containing the application's configuration.
741 __PACKAGE__->config( { db => 'dsn:SQLite:foo.db' } );
743 You can also use a C<YAML>, C<XML> or L<Config::General> config file
744 like C<myapp.conf> in your applications home directory. See
745 L<Catalyst::Plugin::ConfigLoader>.
747 =head3 Cascading configuration
749 The config method is present on all Catalyst components, and configuration
750 will be merged when an application is started. Configuration loaded with
751 L<Catalyst::Plugin::ConfigLoader> takes precedence over other configuration,
752 followed by configuration in your top level C<MyApp> class. These two
753 configurations are merged, and then configuration data whose hash key matches a
754 component name is merged with configuration for that component.
756 The configuration for a component is then passed to the C<new> method when a
757 component is constructed.
761 MyApp->config({ 'Model::Foo' => { bar => 'baz', overrides => 'me' } });
762 MyApp::Model::Foo->config({ quux => 'frob', overrides => 'this' });
764 will mean that C<MyApp::Model::Foo> receives the following data when
767 MyApp::Model::Foo->new({
773 It's common practice to use a Moose attribute
774 on the receiving component to access the config value.
776 package MyApp::Model::Foo;
780 # this attr will receive 'baz' at construction time
786 You can then get the value 'baz' by calling $c->model('Foo')->bar
787 (or $self->bar inside code in the model).
789 B<NOTE:> you MUST NOT call C<< $self->config >> or C<< __PACKAGE__->config >>
790 as a way of reading config within your code, as this B<will not> give you the
791 correctly merged config back. You B<MUST> take the config values supplied to
792 the constructor and use those instead.
796 around config => sub {
800 croak('Setting config after setup has been run is not allowed.')
801 if ( @_ and $c->setup_finished );
808 Returns the logging object instance. Unless it is already set, Catalyst
809 sets this up with a L<Catalyst::Log> object. To use your own log class,
810 set the logger with the C<< __PACKAGE__->log >> method prior to calling
811 C<< __PACKAGE__->setup >>.
813 __PACKAGE__->log( MyLogger->new );
818 $c->log->info( 'Now logging with my own logger!' );
820 Your log class should implement the methods described in
826 Returns 1 if debug mode is enabled, 0 otherwise.
828 You can enable debug mode in several ways:
832 =item By calling myapp_server.pl with the -d flag
834 =item With the environment variables MYAPP_DEBUG, or CATALYST_DEBUG
836 =item The -Debug option in your MyApp.pm
838 =item By declaring C<sub debug { 1 }> in your MyApp.pm.
842 The first three also set the log level to 'debug'.
844 Calling C<< $c->debug(1) >> has no effect.
850 =head2 $c->dispatcher
852 Returns the dispatcher instance. See L<Catalyst::Dispatcher>.
856 Returns the engine instance. See L<Catalyst::Engine>.
859 =head2 UTILITY METHODS
861 =head2 $c->path_to(@path)
863 Merges C<@path> with C<< $c->config->{home} >> and returns a
864 L<Path::Class::Dir> object. Note you can usually use this object as
865 a filename, but sometimes you will have to explicitly stringify it
866 yourself by calling the C<< ->stringify >> method.
870 $c->path_to( 'db', 'sqlite.db' );
875 my ( $c, @path ) = @_;
876 my $path = Path::Class::Dir->new( $c->config->{home}, @path );
877 if ( -d $path ) { return $path }
878 else { return Path::Class::File->new( $c->config->{home}, @path ) }
881 =head2 $c->plugin( $name, $class, @args )
883 Helper method for plugins. It creates a class data accessor/mutator and
884 loads and instantiates the given class.
886 MyApp->plugin( 'prototype', 'HTML::Prototype' );
888 $c->prototype->define_javascript_functions;
890 B<Note:> This method of adding plugins is deprecated. The ability
891 to add plugins like this B<will be removed> in a Catalyst 5.81.
892 Please do not use this functionality in new code.
897 my ( $class, $name, $plugin, @args ) = @_;
899 # See block comment in t/unit_core_plugin.t
900 $class->log->warn(qq/Adding plugin using the ->plugin method is deprecated, and will be removed in Catalyst 5.81/);
902 $class->_register_plugin( $plugin, 1 );
904 eval { $plugin->import };
905 $class->mk_classdata($name);
907 eval { $obj = $plugin->new(@args) };
910 Catalyst::Exception->throw( message =>
911 qq/Couldn't instantiate instant plugin "$plugin", "$@"/ );
915 $class->log->debug(qq/Initialized instant plugin "$plugin" as "$name"/)
921 Initializes the dispatcher and engine, loads any plugins, and loads the
922 model, view, and controller components. You may also specify an array
923 of plugins to load here, if you choose to not load them in the C<use
927 MyApp->setup( qw/-Debug/ );
932 my ( $class, @arguments ) = @_;
933 croak('Running setup more than once')
934 if ( $class->setup_finished );
936 unless ( $class->isa('Catalyst') ) {
938 Catalyst::Exception->throw(
939 message => qq/'$class' does not inherit from Catalyst/ );
942 if ( $class->arguments ) {
943 @arguments = ( @arguments, @{ $class->arguments } );
949 foreach (@arguments) {
953 ( $flags->{log} ) ? 'debug,' . $flags->{log} : 'debug';
955 elsif (/^-(\w+)=?(.*)$/) {
956 $flags->{ lc $1 } = $2;
959 push @{ $flags->{plugins} }, $_;
963 $class->setup_config();
964 $class->setup_home( delete $flags->{home} );
966 $class->setup_log( delete $flags->{log} );
967 $class->setup_plugins( delete $flags->{plugins} );
968 $class->setup_dispatcher( delete $flags->{dispatcher} );
969 $class->setup_engine( delete $flags->{engine} );
970 $class->setup_stats( delete $flags->{stats} );
972 for my $flag ( sort keys %{$flags} ) {
974 if ( my $code = $class->can( 'setup_' . $flag ) ) {
975 &$code( $class, delete $flags->{$flag} );
978 $class->log->warn(qq/Unknown flag "$flag"/);
982 eval { require Catalyst::Devel; };
983 if( !$@ && $ENV{CATALYST_SCRIPT_GEN} && ( $ENV{CATALYST_SCRIPT_GEN} < $Catalyst::Devel::CATALYST_SCRIPT_GEN ) ) {
984 $class->log->warn(<<"EOF");
985 You are running an old script!
987 Please update by running (this will overwrite existing files):
988 catalyst.pl -force -scripts $class
990 or (this will not overwrite existing files):
991 catalyst.pl -scripts $class
996 if ( $class->debug ) {
997 my @plugins = map { "$_ " . ( $_->VERSION || '' ) } $class->registered_plugins;
1000 my $column_width = Catalyst::Utils::term_width() - 6;
1001 my $t = Text::SimpleTable->new($column_width);
1002 $t->row($_) for @plugins;
1003 $class->log->debug( "Loaded plugins:\n" . $t->draw . "\n" );
1006 my $dispatcher = $class->dispatcher;
1007 my $engine = $class->engine;
1008 my $home = $class->config->{home};
1010 $class->log->debug(sprintf(q/Loaded dispatcher "%s"/, blessed($dispatcher)));
1011 $class->log->debug(sprintf(q/Loaded engine "%s"/, blessed($engine)));
1015 ? $class->log->debug(qq/Found home "$home"/)
1016 : $class->log->debug(qq/Home "$home" doesn't exist/)
1017 : $class->log->debug(q/Couldn't find home/);
1020 # Call plugins setup, this is stupid and evil.
1021 # Also screws C3 badly on 5.10, hack to avoid.
1023 no warnings qw/redefine/;
1024 local *setup = sub { };
1025 $class->setup unless $Catalyst::__AM_RESTARTING;
1028 # Initialize our data structure
1029 $class->components( {} );
1031 $class->setup_components;
1033 if ( $class->debug ) {
1034 my $column_width = Catalyst::Utils::term_width() - 8 - 9;
1035 my $t = Text::SimpleTable->new( [ $column_width, 'Class' ], [ 8, 'Type' ] );
1036 for my $comp ( sort keys %{ $class->components } ) {
1037 my $type = ref $class->components->{$comp} ? 'instance' : 'class';
1038 $t->row( $comp, $type );
1040 $class->log->debug( "Loaded components:\n" . $t->draw . "\n" )
1041 if ( keys %{ $class->components } );
1044 # Add our self to components, since we are also a component
1045 if( $class->isa('Catalyst::Controller') ){
1046 $class->components->{$class} = $class;
1049 $class->setup_actions;
1051 if ( $class->debug ) {
1052 my $name = $class->config->{name} || 'Application';
1053 $class->log->info("$name powered by Catalyst $Catalyst::VERSION");
1056 # Make sure that the application class becomes immutable at this point,
1057 B::Hooks::EndOfScope::on_scope_end {
1059 my $meta = Class::MOP::get_metaclass_by_name($class);
1062 && ! { $meta->immutable_options }->{replace_constructor}
1064 $class->isa('Class::Accessor::Fast')
1065 || $class->isa('Class::Accessor')
1068 warn "You made your application class ($class) immutable, "
1069 . "but did not inline the\nconstructor. "
1070 . "This will break catalyst, as your app \@ISA "
1071 . "Class::Accessor(::Fast)?\nPlease pass "
1072 . "(replace_constructor => 1)\nwhen making your class immutable.\n";
1074 $meta->make_immutable(
1075 replace_constructor => 1,
1076 ) unless $meta->is_immutable;
1079 if ($class->config->{case_sensitive}) {
1080 $class->log->warn($class . "->config->{case_sensitive} is set.");
1081 $class->log->warn("This setting is deprecated and planned to be removed in Catalyst 5.81.");
1084 $class->setup_finalize;
1085 # Should be the last thing we do so that user things hooking
1086 # setup_finalize can log..
1087 $class->log->_flush() if $class->log->can('_flush');
1088 return 1; # Explicit return true as people have __PACKAGE__->setup as the last thing in their class. HATE.
1091 =head2 $app->setup_finalize
1093 A hook to attach modifiers to. This method does not do anything except set the
1094 C<setup_finished> accessor.
1096 Applying method modifiers to the C<setup> method doesn't work, because of quirky things done for plugin setup.
1100 after setup_finalize => sub {
1108 sub setup_finalize {
1110 $class->setup_finished(1);
1113 =head2 $c->uri_for( $path?, @args?, \%query_values? )
1115 =head2 $c->uri_for( $action, \@captures?, @args?, \%query_values? )
1117 Constructs an absolute L<URI> object based on the application root, the
1118 provided path, and the additional arguments and query parameters provided.
1119 When used as a string, provides a textual URI. If you need more flexibility
1120 than this (i.e. the option to provide relative URIs etc.) see
1121 L<Catalyst::Plugin::SmartURI>.
1123 If no arguments are provided, the URI for the current action is returned.
1124 To return the current action and also provide @args, use
1125 C<< $c->uri_for( $c->action, @args ) >>.
1127 If the first argument is a string, it is taken as a public URI path relative
1128 to C<< $c->namespace >> (if it doesn't begin with a forward slash) or
1129 relative to the application root (if it does). It is then merged with
1130 C<< $c->request->base >>; any C<@args> are appended as additional path
1131 components; and any C<%query_values> are appended as C<?foo=bar> parameters.
1133 If the first argument is a L<Catalyst::Action> it represents an action which
1134 will have its path resolved using C<< $c->dispatcher->uri_for_action >>. The
1135 optional C<\@captures> argument (an arrayref) allows passing the captured
1136 variables that are needed to fill in the paths of Chained and Regex actions;
1137 once the path is resolved, C<uri_for> continues as though a path was
1138 provided, appending any arguments or parameters and creating an absolute
1141 The captures for the current request can be found in
1142 C<< $c->request->captures >>, and actions can be resolved using
1143 C<< Catalyst::Controller->action_for($name) >>. If you have a private action
1144 path, use C<< $c->uri_for_action >> instead.
1146 # Equivalent to $c->req->uri
1147 $c->uri_for($c->action, $c->req->captures,
1148 @{ $c->req->args }, $c->req->params);
1150 # For the Foo action in the Bar controller
1151 $c->uri_for($c->controller('Bar')->action_for('Foo'));
1153 # Path to a static resource
1154 $c->uri_for('/static/images/logo.png');
1159 my ( $c, $path, @args ) = @_;
1161 if (blessed($path) && $path->isa('Catalyst::Controller')) {
1162 $path = $path->path_prefix;
1167 undef($path) if (defined $path && $path eq '');
1170 ( scalar @args && ref $args[$#args] eq 'HASH' ? pop @args : {} );
1172 carp "uri_for called with undef argument" if grep { ! defined $_ } @args;
1173 foreach my $arg (@args) {
1174 utf8::encode($arg) if utf8::is_utf8($arg);
1175 $arg =~ s/([^$URI::uric])/$URI::Escape::escapes{$1}/go;
1178 if ( blessed($path) ) { # action object
1179 s|/|%2F|g for @args;
1180 my $captures = [ map { s|/|%2F|g; $_; }
1181 ( scalar @args && ref $args[0] eq 'ARRAY'
1185 foreach my $capture (@$captures) {
1186 utf8::encode($capture) if utf8::is_utf8($capture);
1187 $capture =~ s/([^$URI::uric])/$URI::Escape::escapes{$1}/go;
1191 $path = $c->dispatcher->uri_for_action($action, $captures);
1192 if (not defined $path) {
1193 $c->log->debug(qq/Can't find uri_for action '$action' @$captures/)
1197 $path = '/' if $path eq '';
1200 unshift(@args, $path);
1202 unless (defined $path && $path =~ s!^/!!) { # in-place strip
1203 my $namespace = $c->namespace;
1204 if (defined $path) { # cheesy hack to handle path '../foo'
1205 $namespace =~ s{(?:^|/)[^/]+$}{} while $args[0] =~ s{^\.\./}{};
1207 unshift(@args, $namespace || '');
1210 # join args with '/', or a blank string
1211 my $args = join('/', grep { defined($_) } @args);
1212 $args =~ s/\?/%3F/g; # STUPID STUPID SPECIAL CASE
1214 my $base = $c->req->base;
1215 my $class = ref($base);
1216 $base =~ s{(?<!/)$}{/};
1220 if (my @keys = keys %$params) {
1221 # somewhat lifted from URI::_query's query_form
1222 $query = '?'.join('&', map {
1223 my $val = $params->{$_};
1224 s/([;\/?:@&=+,\$\[\]%])/$URI::Escape::escapes{$1}/go;
1227 $val = '' unless defined $val;
1230 utf8::encode( $param ) if utf8::is_utf8($param);
1231 # using the URI::Escape pattern here so utf8 chars survive
1232 $param =~ s/([^A-Za-z0-9\-_.!~*'() ])/$URI::Escape::escapes{$1}/go;
1234 "${key}=$param"; } ( ref $val eq 'ARRAY' ? @$val : $val ));
1238 my $res = bless(\"${base}${args}${query}", $class);
1242 =head2 $c->uri_for_action( $path, \@captures?, @args?, \%query_values? )
1244 =head2 $c->uri_for_action( $action, \@captures?, @args?, \%query_values? )
1250 A private path to the Catalyst action you want to create a URI for.
1252 This is a shortcut for calling C<< $c->dispatcher->get_action_by_path($path)
1253 >> and passing the resulting C<$action> and the remaining arguments to C<<
1256 You can also pass in a Catalyst::Action object, in which case it is passed to
1259 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.
1261 For example, if the action looks like:
1263 package MyApp::Controller::Users;
1265 sub lst : Path('the-list') {}
1269 $c->uri_for_action('/users/lst')
1271 and it will create the URI /users/the-list.
1277 sub uri_for_action {
1278 my ( $c, $path, @args ) = @_;
1279 my $action = blessed($path)
1281 : $c->dispatcher->get_action_by_path($path);
1282 unless (defined $action) {
1283 croak "Can't find action for path '$path'";
1285 return $c->uri_for( $action, @args );
1288 =head2 $c->welcome_message
1290 Returns the Catalyst welcome HTML page.
1294 sub welcome_message {
1296 my $name = $c->config->{name};
1297 my $logo = $c->uri_for('/static/images/catalyst_logo.png');
1298 my $prefix = Catalyst::Utils::appprefix( ref $c );
1299 $c->response->content_type('text/html; charset=utf-8');
1301 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
1302 "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
1303 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
1305 <meta http-equiv="Content-Language" content="en" />
1306 <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
1307 <title>$name on Catalyst $VERSION</title>
1308 <style type="text/css">
1311 background-color: #eee;
1318 margin-bottom: 10px;
1320 background-color: #ccc;
1321 border: 1px solid #aaa;
1326 font-family: verdana, tahoma, sans-serif;
1329 font-family: verdana, tahoma, sans-serif;
1332 text-decoration: none;
1334 border-bottom: 1px dotted #bbb;
1336 :link:hover, :visited:hover {
1349 background-color: #fff;
1350 border: 1px solid #aaa;
1354 font-weight: normal;
1376 <h1><span id="appname">$name</span> on <a href="http://catalyst.perl.org">Catalyst</a>
1381 <img src="$logo" alt="Catalyst Logo" />
1383 <p>Welcome to the world of Catalyst.
1384 This <a href="http://en.wikipedia.org/wiki/MVC">MVC</a>
1385 framework will make web development something you had
1386 never expected it to be: Fun, rewarding, and quick.</p>
1387 <h2>What to do now?</h2>
1388 <p>That really depends on what <b>you</b> want to do.
1389 We do, however, provide you with a few starting points.</p>
1390 <p>If you want to jump right into web development with Catalyst
1391 you might want to start with a tutorial.</p>
1392 <pre>perldoc <a href="http://cpansearch.perl.org/dist/Catalyst-Manual/lib/Catalyst/Manual/Tutorial.pod">Catalyst::Manual::Tutorial</a></code>
1394 <p>Afterwards you can go on to check out a more complete look at our features.</p>
1396 <code>perldoc <a href="http://cpansearch.perl.org/dist/Catalyst-Manual/lib/Catalyst/Manual/Intro.pod">Catalyst::Manual::Intro</a>
1397 <!-- Something else should go here, but the Catalyst::Manual link seems unhelpful -->
1399 <h2>What to do next?</h2>
1400 <p>Next it's time to write an actual application. Use the
1401 helper scripts to generate <a href="http://cpansearch.perl.org/search?query=Catalyst%3A%3AController%3A%3A&mode=all">controllers</a>,
1402 <a href="http://cpansearch.perl.org/search?query=Catalyst%3A%3AModel%3A%3A&mode=all">models</a>, and
1403 <a href="http://cpansearch.perl.org/search?query=Catalyst%3A%3AView%3A%3A&mode=all">views</a>;
1404 they can save you a lot of work.</p>
1405 <pre><code>script/${prefix}_create.pl --help</code></pre>
1406 <p>Also, be sure to check out the vast and growing
1407 collection of <a href="http://search.cpan.org/search?query=Catalyst">plugins for Catalyst on CPAN</a>;
1408 you are likely to find what you need there.
1412 <p>Catalyst has a very active community. Here are the main places to
1413 get in touch with us.</p>
1416 <a href="http://dev.catalyst.perl.org">Wiki</a>
1419 <a href="http://lists.scsys.co.uk/cgi-bin/mailman/listinfo/catalyst">Mailing-List</a>
1422 <a href="irc://irc.perl.org/catalyst">IRC channel #catalyst on irc.perl.org</a>
1425 <h2>In conclusion</h2>
1426 <p>The Catalyst team hopes you will enjoy using Catalyst as much
1427 as we enjoyed making it. Please contact us if you have ideas
1428 for improvement or other feedback.</p>
1436 =head1 INTERNAL METHODS
1438 These methods are not meant to be used by end users.
1440 =head2 $c->components
1442 Returns a hash of components.
1446 around components => sub {
1451 return $class->$orig if ( !$comps );
1453 # FIXME: should this ugly kludge exist?
1454 $class->setup_config unless defined $class->container;
1456 # FIXME: should there be a warning here, not to use this accessor to create the components?
1457 my $components = {};
1460 $containers->{$_} = $class->container->get_sub_container($_) for qw(model view controller);
1462 for my $component ( keys %$comps ) {
1463 $components->{ $component } = $comps->{$component};
1465 my ($type, $name) = _get_component_type_name($component);
1467 $containers->{$type}->add_service(Catalyst::IOC::BlockInjection->new( name => $name, block => sub { return $class->setup_component($component) } ));
1470 return $class->$orig($components);
1473 =head2 $c->context_class
1475 Returns or sets the context class.
1479 Returns a hashref containing coderefs and execution counts (needed for
1480 deep recursion detection).
1484 Returns the number of actions on the current internal execution stack.
1488 Dispatches a request to actions.
1492 sub dispatch { my $c = shift; $c->dispatcher->dispatch( $c, @_ ) }
1494 =head2 $c->dispatcher_class
1496 Returns or sets the dispatcher class.
1498 =head2 $c->dump_these
1500 Returns a list of 2-element array references (name, structure) pairs
1501 that will be dumped on the error page in debug mode.
1507 [ Request => $c->req ],
1508 [ Response => $c->res ],
1509 [ Stash => $c->stash ],
1510 [ Config => $c->config ];
1513 =head2 $c->engine_class
1515 Returns or sets the engine class.
1517 =head2 $c->execute( $class, $coderef )
1519 Execute a coderef in given class and catch exceptions. Errors are available
1525 my ( $c, $class, $code ) = @_;
1526 $class = $c->component($class) || $class;
1529 if ( $c->depth >= $RECURSION ) {
1530 my $action = $code->reverse();
1531 $action = "/$action" unless $action =~ /->/;
1532 my $error = qq/Deep recursion detected calling "${action}"/;
1533 $c->log->error($error);
1539 my $stats_info = $c->_stats_start_execute( $code ) if $c->use_stats;
1541 push( @{ $c->stack }, $code );
1543 no warnings 'recursion';
1544 # N.B. This used to be combined, but I have seen $c get clobbered if so, and
1545 # I have no idea how, ergo $ret (which appears to fix the issue)
1546 eval { my $ret = $code->execute( $class, $c, @{ $c->req->args } ) || 0; $c->state( $ret ) };
1548 $c->_stats_finish_execute( $stats_info ) if $c->use_stats and $stats_info;
1550 my $last = pop( @{ $c->stack } );
1552 if ( my $error = $@ ) {
1553 if ( blessed($error) and $error->isa('Catalyst::Exception::Detach') ) {
1554 $error->rethrow if $c->depth > 1;
1556 elsif ( blessed($error) and $error->isa('Catalyst::Exception::Go') ) {
1557 $error->rethrow if $c->depth > 0;
1560 unless ( ref $error ) {
1561 no warnings 'uninitialized';
1563 my $class = $last->class;
1564 my $name = $last->name;
1565 $error = qq/Caught exception in $class->$name "$error"/;
1574 sub _stats_start_execute {
1575 my ( $c, $code ) = @_;
1576 my $appclass = ref($c) || $c;
1577 return if ( ( $code->name =~ /^_.*/ )
1578 && ( !$appclass->config->{show_internal_actions} ) );
1580 my $action_name = $code->reverse();
1581 $c->counter->{$action_name}++;
1583 my $action = $action_name;
1584 $action = "/$action" unless $action =~ /->/;
1586 # determine if the call was the result of a forward
1587 # this is done by walking up the call stack and looking for a calling
1588 # sub of Catalyst::forward before the eval
1590 for my $index ( 2 .. 11 ) {
1592 if ( ( caller($index) )[0] eq 'Catalyst'
1593 && ( caller($index) )[3] eq '(eval)' );
1595 if ( ( caller($index) )[3] =~ /forward$/ ) {
1596 $callsub = ( caller($index) )[3];
1597 $action = "-> $action";
1602 my $uid = $action_name . $c->counter->{$action_name};
1604 # is this a root-level call or a forwarded call?
1605 if ( $callsub =~ /forward$/ ) {
1606 my $parent = $c->stack->[-1];
1608 # forward, locate the caller
1609 if ( defined $parent && exists $c->counter->{"$parent"} ) {
1612 parent => "$parent" . $c->counter->{"$parent"},
1618 # forward with no caller may come from a plugin
1637 sub _stats_finish_execute {
1638 my ( $c, $info ) = @_;
1639 $c->stats->profile( end => $info );
1644 Finalizes the request.
1651 for my $error ( @{ $c->error } ) {
1652 $c->log->error($error);
1655 # Allow engine to handle finalize flow (for POE)
1656 my $engine = $c->engine;
1657 if ( my $code = $engine->can('finalize') ) {
1662 $c->finalize_uploads;
1665 if ( $#{ $c->error } >= 0 ) {
1669 $c->finalize_headers;
1672 if ( $c->request->method eq 'HEAD' ) {
1673 $c->response->body('');
1681 if ($c->use_stats) {
1682 my $elapsed = sprintf '%f', $c->stats->elapsed;
1683 my $av = $elapsed == 0 ? '??' : sprintf '%.3f', 1 / $elapsed;
1685 "Request took ${elapsed}s ($av/s)\n" . $c->stats->report . "\n" );
1688 return $c->response->status;
1691 =head2 $c->finalize_body
1697 sub finalize_body { my $c = shift; $c->engine->finalize_body( $c, @_ ) }
1699 =head2 $c->finalize_cookies
1705 sub finalize_cookies { my $c = shift; $c->engine->finalize_cookies( $c, @_ ) }
1707 =head2 $c->finalize_error
1713 sub finalize_error { my $c = shift; $c->engine->finalize_error( $c, @_ ) }
1715 =head2 $c->finalize_headers
1721 sub finalize_headers {
1724 my $response = $c->response; #accessor calls can add up?
1726 # Check if we already finalized headers
1727 return if $response->finalized_headers;
1730 if ( my $location = $response->redirect ) {
1731 $c->log->debug(qq/Redirecting to "$location"/) if $c->debug;
1732 $response->header( Location => $location );
1734 if ( !$response->has_body ) {
1735 # Add a default body if none is already present
1737 qq{<html><body><p>This item has moved <a href="$location">here</a>.</p></body></html>}
1743 if ( defined $response->body && length $response->body && !$response->content_length ) {
1745 # get the length from a filehandle
1746 if ( blessed( $response->body ) && $response->body->can('read') || ref( $response->body ) eq 'GLOB' )
1748 my $stat = stat $response->body;
1749 if ( $stat && $stat->size > 0 ) {
1750 $response->content_length( $stat->size );
1753 $c->log->warn('Serving filehandle without a content-length');
1757 # everything should be bytes at this point, but just in case
1758 $response->content_length( length( $response->body ) );
1763 if ( $response->status =~ /^(1\d\d|[23]04)$/ ) {
1764 $response->headers->remove_header("Content-Length");
1765 $response->body('');
1768 $c->finalize_cookies;
1770 $c->engine->finalize_headers( $c, @_ );
1773 $response->finalized_headers(1);
1776 =head2 $c->finalize_output
1778 An alias for finalize_body.
1780 =head2 $c->finalize_read
1782 Finalizes the input after reading is complete.
1786 sub finalize_read { my $c = shift; $c->engine->finalize_read( $c, @_ ) }
1788 =head2 $c->finalize_uploads
1790 Finalizes uploads. Cleans up any temporary files.
1794 sub finalize_uploads { my $c = shift; $c->engine->finalize_uploads( $c, @_ ) }
1796 =head2 $c->get_action( $action, $namespace )
1798 Gets an action in a given namespace.
1802 sub get_action { my $c = shift; $c->dispatcher->get_action(@_) }
1804 =head2 $c->get_actions( $action, $namespace )
1806 Gets all actions of a given name in a namespace and all parent
1811 sub get_actions { my $c = shift; $c->dispatcher->get_actions( $c, @_ ) }
1813 =head2 $app->handle_request( @arguments )
1815 Called to handle each HTTP request.
1819 sub handle_request {
1820 my ( $class, @arguments ) = @_;
1822 # Always expect worst case!
1825 if ($class->debug) {
1826 my $secs = time - $START || 1;
1827 my $av = sprintf '%.3f', $COUNT / $secs;
1828 my $time = localtime time;
1829 $class->log->info("*** Request $COUNT ($av/s) [$$] [$time] ***");
1832 my $c = $class->prepare(@arguments);
1834 $status = $c->finalize;
1837 if ( my $error = $@ ) {
1839 $class->log->error(qq/Caught exception in engine "$error"/);
1844 if(my $coderef = $class->log->can('_flush')){
1845 $class->log->$coderef();
1850 =head2 $c->prepare( @arguments )
1852 Creates a Catalyst context from an engine-specific request (Apache, CGI,
1858 my ( $class, @arguments ) = @_;
1861 # After the app/ctxt split, this should become an attribute based on something passed
1862 # into the application.
1863 $class->context_class( ref $class || $class ) unless $class->context_class;
1865 my $c = $class->context_class->new({});
1867 # For on-demand data
1868 $c->request->_context($c);
1869 $c->response->_context($c);
1871 #surely this is not the most efficient way to do things...
1872 $c->stats($class->stats_class->new)->enable($c->use_stats);
1873 if ( $c->debug || $c->config->{enable_catalyst_header} ) {
1874 $c->res->headers->header( 'X-Catalyst' => $Catalyst::VERSION );
1877 #XXX reuse coderef from can
1878 # Allow engine to direct the prepare flow (for POE)
1879 if ( $c->engine->can('prepare') ) {
1880 $c->engine->prepare( $c, @arguments );
1883 $c->prepare_request(@arguments);
1884 $c->prepare_connection;
1885 $c->prepare_query_parameters;
1886 $c->prepare_headers;
1887 $c->prepare_cookies;
1890 # Prepare the body for reading, either by prepare_body
1891 # or the user, if they are using $c->read
1894 # Parse the body unless the user wants it on-demand
1895 unless ( ref($c)->config->{parse_on_demand} ) {
1900 my $method = $c->req->method || '';
1901 my $path = $c->req->path;
1902 $path = '/' unless length $path;
1903 my $address = $c->req->address || '';
1912 =head2 $c->prepare_action
1914 Prepares action. See L<Catalyst::Dispatcher>.
1918 sub prepare_action { my $c = shift; $c->dispatcher->prepare_action( $c, @_ ) }
1920 =head2 $c->prepare_body
1922 Prepares message body.
1929 return if $c->request->_has_body;
1931 # Initialize on-demand data
1932 $c->engine->prepare_body( $c, @_ );
1933 $c->prepare_parameters;
1934 $c->prepare_uploads;
1937 =head2 $c->prepare_body_chunk( $chunk )
1939 Prepares a chunk of data before sending it to L<HTTP::Body>.
1941 See L<Catalyst::Engine>.
1945 sub prepare_body_chunk {
1947 $c->engine->prepare_body_chunk( $c, @_ );
1950 =head2 $c->prepare_body_parameters
1952 Prepares body parameters.
1956 sub prepare_body_parameters {
1958 $c->engine->prepare_body_parameters( $c, @_ );
1961 =head2 $c->prepare_connection
1963 Prepares connection.
1967 sub prepare_connection {
1969 $c->engine->prepare_connection( $c, @_ );
1972 =head2 $c->prepare_cookies
1978 sub prepare_cookies { my $c = shift; $c->engine->prepare_cookies( $c, @_ ) }
1980 =head2 $c->prepare_headers
1986 sub prepare_headers { my $c = shift; $c->engine->prepare_headers( $c, @_ ) }
1988 =head2 $c->prepare_parameters
1990 Prepares parameters.
1994 sub prepare_parameters {
1996 $c->prepare_body_parameters;
1997 $c->engine->prepare_parameters( $c, @_ );
2000 =head2 $c->prepare_path
2002 Prepares path and base.
2006 sub prepare_path { my $c = shift; $c->engine->prepare_path( $c, @_ ) }
2008 =head2 $c->prepare_query_parameters
2010 Prepares query parameters.
2014 sub prepare_query_parameters {
2017 $c->engine->prepare_query_parameters( $c, @_ );
2020 =head2 $c->log_request
2022 Writes information about the request to the debug logs. This includes:
2026 =item * Request method, path, and remote IP address
2028 =item * Query keywords (see L<Catalyst::Request/query_keywords>)
2030 =item * Request parameters
2032 =item * File uploads
2041 return unless $c->debug;
2043 my($dump) = grep {$_->[0] eq 'Request' } $c->dump_these;
2044 my $request = $dump->[1];
2046 my ( $method, $path, $address ) = ( $request->method, $request->path, $request->address );
2048 $path = '/' unless length $path;
2050 $c->log->debug(qq/"$method" request for "$path" from "$address"/);
2052 $c->log_request_headers($request->headers);
2054 if ( my $keywords = $request->query_keywords ) {
2055 $c->log->debug("Query keywords are: $keywords");
2058 $c->log_request_parameters( query => $request->query_parameters, $request->_has_body ? (body => $request->body_parameters) : () );
2060 $c->log_request_uploads($request);
2063 =head2 $c->log_response
2065 Writes information about the response to the debug logs by calling
2066 C<< $c->log_response_status_line >> and C<< $c->log_response_headers >>.
2073 return unless $c->debug;
2075 my($dump) = grep {$_->[0] eq 'Response' } $c->dump_these;
2076 my $response = $dump->[1];
2078 $c->log_response_status_line($response);
2079 $c->log_response_headers($response->headers);
2082 =head2 $c->log_response_status_line($response)
2084 Writes one line of information about the response to the debug logs. This includes:
2088 =item * Response status code
2090 =item * Content-Type header (if present)
2092 =item * Content-Length header (if present)
2098 sub log_response_status_line {
2099 my ($c, $response) = @_;
2103 'Response Code: %s; Content-Type: %s; Content-Length: %s',
2104 $response->status || 'unknown',
2105 $response->headers->header('Content-Type') || 'unknown',
2106 $response->headers->header('Content-Length') || 'unknown'
2111 =head2 $c->log_response_headers($headers);
2113 Hook method which can be wrapped by plugins to log the responseheaders.
2114 No-op in the default implementation.
2118 sub log_response_headers {}
2120 =head2 $c->log_request_parameters( query => {}, body => {} )
2122 Logs request parameters to debug logs
2126 sub log_request_parameters {
2128 my %all_params = @_;
2130 return unless $c->debug;
2132 my $column_width = Catalyst::Utils::term_width() - 44;
2133 foreach my $type (qw(query body)) {
2134 my $params = $all_params{$type};
2135 next if ! keys %$params;
2136 my $t = Text::SimpleTable->new( [ 35, 'Parameter' ], [ $column_width, 'Value' ] );
2137 for my $key ( sort keys %$params ) {
2138 my $param = $params->{$key};
2139 my $value = defined($param) ? $param : '';
2140 $t->row( $key, ref $value eq 'ARRAY' ? ( join ', ', @$value ) : $value );
2142 $c->log->debug( ucfirst($type) . " Parameters are:\n" . $t->draw );
2146 =head2 $c->log_request_uploads
2148 Logs file uploads included in the request to the debug logs.
2149 The parameter name, filename, file type, and file size are all included in
2154 sub log_request_uploads {
2156 my $request = shift;
2157 return unless $c->debug;
2158 my $uploads = $request->uploads;
2159 if ( keys %$uploads ) {
2160 my $t = Text::SimpleTable->new(
2161 [ 12, 'Parameter' ],
2166 for my $key ( sort keys %$uploads ) {
2167 my $upload = $uploads->{$key};
2168 for my $u ( ref $upload eq 'ARRAY' ? @{$upload} : ($upload) ) {
2169 $t->row( $key, $u->filename, $u->type, $u->size );
2172 $c->log->debug( "File Uploads are:\n" . $t->draw );
2176 =head2 $c->log_request_headers($headers);
2178 Hook method which can be wrapped by plugins to log the request headers.
2179 No-op in the default implementation.
2183 sub log_request_headers {}
2185 =head2 $c->log_headers($type => $headers)
2187 Logs L<HTTP::Headers> (either request or response) to the debug logs.
2194 my $headers = shift; # an HTTP::Headers instance
2196 return unless $c->debug;
2198 my $column_width = Catalyst::Utils::term_width() - 28;
2199 my $t = Text::SimpleTable->new( [ 15, 'Header Name' ], [ $column_width, 'Value' ] );
2202 my ( $name, $value ) = @_;
2203 $t->row( $name, $value );
2206 $c->log->debug( ucfirst($type) . " Headers:\n" . $t->draw );
2210 =head2 $c->prepare_read
2212 Prepares the input for reading.
2216 sub prepare_read { my $c = shift; $c->engine->prepare_read( $c, @_ ) }
2218 =head2 $c->prepare_request
2220 Prepares the engine request.
2224 sub prepare_request { my $c = shift; $c->engine->prepare_request( $c, @_ ) }
2226 =head2 $c->prepare_uploads
2232 sub prepare_uploads {
2235 $c->engine->prepare_uploads( $c, @_ );
2238 =head2 $c->prepare_write
2240 Prepares the output for writing.
2244 sub prepare_write { my $c = shift; $c->engine->prepare_write( $c, @_ ) }
2246 =head2 $c->request_class
2248 Returns or sets the request class. Defaults to L<Catalyst::Request>.
2250 =head2 $c->response_class
2252 Returns or sets the response class. Defaults to L<Catalyst::Response>.
2254 =head2 $c->read( [$maxlength] )
2256 Reads a chunk of data from the request body. This method is designed to
2257 be used in a while loop, reading C<$maxlength> bytes on every call.
2258 C<$maxlength> defaults to the size of the request if not specified.
2260 You have to set C<< MyApp->config(parse_on_demand => 1) >> to use this
2263 Warning: If you use read(), Catalyst will not process the body,
2264 so you will not be able to access POST parameters or file uploads via
2265 $c->request. You must handle all body parsing yourself.
2269 sub read { my $c = shift; return $c->engine->read( $c, @_ ) }
2277 sub run { my $c = shift; return $c->engine->run( $c, @_ ) }
2279 =head2 $c->set_action( $action, $code, $namespace, $attrs )
2281 Sets an action in a given namespace.
2285 sub set_action { my $c = shift; $c->dispatcher->set_action( $c, @_ ) }
2287 =head2 $c->setup_actions($component)
2289 Sets up actions for a component.
2293 sub setup_actions { my $c = shift; $c->dispatcher->setup_actions( $c, @_ ) }
2295 =head2 $c->setup_config
2302 my %args = %{ $class->config || {} };
2304 my @container_classes = ( "${class}::Container", 'Catalyst::IOC::Container');
2305 unshift @container_classes, delete $args{container_class} if exists $args{container_class};
2307 my $container_class = Class::MOP::load_first_existing_class(@container_classes);
2309 my $container = $container_class->new( %args, name => "$class" );
2310 $class->container($container);
2312 my $config = $container->resolve(service => 'config');
2313 $class->config($config);
2314 $class->finalize_config; # back-compat
2317 =head2 $c->finalize_config
2321 sub finalize_config { }
2323 =head2 $c->setup_components
2325 This method is called internally to set up the application's components.
2327 It finds modules by calling the L<locate_components> method, expands them to
2328 package names with the L<expand_component_module> method, and then installs
2329 each component into the application.
2331 The C<setup_components> config option is passed to both of the above methods.
2333 Installation of each component is performed by the L<setup_component> method,
2338 sub setup_components {
2341 my $config = $class->config->{ setup_components };
2343 my @comps = $class->locate_components($config);
2344 my %comps = map { $_ => 1 } @comps;
2346 my $deprecatedcatalyst_component_names = grep { /::[CMV]::/ } @comps;
2347 $class->log->warn(qq{Your application is using the deprecated ::[MVC]:: type naming scheme.\n}.
2348 qq{Please switch your class names to ::Model::, ::View:: and ::Controller: as appropriate.\n}
2349 ) if $deprecatedcatalyst_component_names;
2351 for my $component ( @comps ) {
2353 # We pass ignore_loaded here so that overlay files for (e.g.)
2354 # Model::DBI::Schema sub-classes are loaded - if it's in @comps
2355 # we know M::P::O found a file on disk so this is safe
2357 Catalyst::Utils::ensure_class_loaded( $component, { ignore_loaded => 1 } );
2361 $containers->{$_} = $class->container->get_sub_container($_) for qw(model view controller);
2363 for my $component (@comps) {
2364 my $instance = $class->components->{ $component } = $class->setup_component($component);
2365 if ( my ($type, $name) = _get_component_type_name($component) ) {
2366 $containers->{$type}->add_service(Catalyst::IOC::BlockInjection->new( name => $name, block => sub { return $instance } ));
2368 my @expanded_components = $instance->can('expand_modules')
2369 ? $instance->expand_modules( $component, $config )
2370 : $class->expand_component_module( $component, $config );
2371 for my $component (@expanded_components) {
2372 next if $comps{$component};
2374 $deprecatedcatalyst_component_names = grep { /::[CMV]::/ } @expanded_components;
2375 $class->log->warn(qq{Your application is using the deprecated ::[MVC]:: type naming scheme.\n}.
2376 qq{Please switch your class names to ::Model::, ::View:: and ::Controller: as appropriate.\n}
2377 ) if $deprecatedcatalyst_component_names;
2379 if (my ($type, $name) = _get_component_type_name($component)) {
2380 $containers->{$type}->add_service(Catalyst::IOC::BlockInjection->new( name => $name, block => sub { return $class->setup_component($component) } ));
2383 $class->components->{ $component } = $class->setup_component($component);
2387 $containers->{model}->make_single_default;
2388 $containers->{view}->make_single_default;
2391 sub _get_component_type_name {
2392 my $component = shift;
2393 my @parts = split /::/, $component;
2395 while (my $type = shift @parts) {
2396 return ('controller', join '::', @parts)
2397 if $type =~ /^(c|controller)$/i;
2399 return ('model', join '::', @parts)
2400 if $type =~ /^(m|model)$/i;
2402 return ('view', join '::', @parts)
2403 if $type =~ /^(v|view)$/i;
2407 =head2 $c->locate_components( $setup_component_config )
2409 This method is meant to provide a list of component modules that should be
2410 setup for the application. By default, it will use L<Module::Pluggable>.
2412 Specify a C<setup_components> config option to pass additional options directly
2413 to L<Module::Pluggable>. To add additional search paths, specify a key named
2414 C<search_extra> as an array reference. Items in the array beginning with C<::>
2415 will have the application class name prepended to them.
2419 sub locate_components {
2423 my @paths = qw( ::Controller ::C ::Model ::M ::View ::V );
2424 my $extra = delete $config->{ search_extra } || [];
2426 push @paths, @$extra;
2428 my $locator = Module::Pluggable::Object->new(
2429 search_path => [ map { s/^(?=::)/$class/; $_; } @paths ],
2433 # XXX think about ditching this sort entirely
2434 my @comps = sort { length $a <=> length $b } $locator->plugins;
2439 =head2 $c->expand_component_module( $component, $setup_component_config )
2441 Components found by C<locate_components> will be passed to this method, which
2442 is expected to return a list of component (package) names to be set up.
2446 sub expand_component_module {
2447 my ($class, $module) = @_;
2448 return Devel::InnerPackage::list_packages( $module );
2451 =head2 $c->setup_component
2455 sub setup_component {
2456 my( $class, $component ) = @_;
2458 unless ( $component->can( 'COMPONENT' ) ) {
2462 my $suffix = Catalyst::Utils::class2classsuffix( $component );
2463 my $config = $class->config->{ $suffix } || {};
2464 # Stash catalyst_component_name in the config here, so that custom COMPONENT
2465 # methods also pass it. local to avoid pointlessly shitting in config
2466 # for the debug screen, as $component is already the key name.
2467 local $config->{catalyst_component_name} = $component;
2469 my $instance = eval { $component->COMPONENT( $class, $config ); };
2471 if ( my $error = $@ ) {
2473 Catalyst::Exception->throw(
2474 message => qq/Couldn't instantiate component "$component", "$error"/
2477 elsif (!blessed $instance) {
2478 my $metaclass = Moose::Util::find_meta($component);
2479 my $method_meta = $metaclass->find_method_by_name('COMPONENT');
2480 my $component_method_from = $method_meta->associated_metaclass->name;
2481 my $value = defined($instance) ? $instance : 'undef';
2482 Catalyst::Exception->throw(
2484 qq/Couldn't instantiate component "$component", COMPONENT() method (from $component_method_from) didn't return an object-like value (value was $value)./
2491 =head2 $c->setup_dispatcher
2497 sub setup_dispatcher {
2498 my ( $class, $dispatcher ) = @_;
2501 $dispatcher = 'Catalyst::Dispatcher::' . $dispatcher;
2504 if ( my $env = Catalyst::Utils::env_value( $class, 'DISPATCHER' ) ) {
2505 $dispatcher = 'Catalyst::Dispatcher::' . $env;
2508 unless ($dispatcher) {
2509 $dispatcher = $class->dispatcher_class;
2512 Class::MOP::load_class($dispatcher);
2514 # dispatcher instance
2515 $class->dispatcher( $dispatcher->new );
2518 =head2 $c->setup_engine
2525 my ( $class, $engine ) = @_;
2528 $engine = 'Catalyst::Engine::' . $engine;
2531 if ( my $env = Catalyst::Utils::env_value( $class, 'ENGINE' ) ) {
2532 $engine = 'Catalyst::Engine::' . $env;
2535 if ( $ENV{MOD_PERL} ) {
2536 my $meta = Class::MOP::get_metaclass_by_name($class);
2538 # create the apache method
2539 $meta->add_method('apache' => sub { shift->engine->apache });
2541 my ( $software, $version ) =
2542 $ENV{MOD_PERL} =~ /^(\S+)\/(\d+(?:[\.\_]\d+)+)/;
2545 $version =~ s/(\.[^.]+)\./$1/g;
2547 if ( $software eq 'mod_perl' ) {
2551 if ( $version >= 1.99922 ) {
2552 $engine = 'Catalyst::Engine::Apache2::MP20';
2555 elsif ( $version >= 1.9901 ) {
2556 $engine = 'Catalyst::Engine::Apache2::MP19';
2559 elsif ( $version >= 1.24 ) {
2560 $engine = 'Catalyst::Engine::Apache::MP13';
2564 Catalyst::Exception->throw( message =>
2565 qq/Unsupported mod_perl version: $ENV{MOD_PERL}/ );
2570 # install the correct mod_perl handler
2571 if ( $version >= 1.9901 ) {
2572 *handler = sub : method {
2573 shift->handle_request(@_);
2577 *handler = sub ($$) { shift->handle_request(@_) };
2582 elsif ( $software eq 'Zeus-Perl' ) {
2583 $engine = 'Catalyst::Engine::Zeus';
2587 Catalyst::Exception->throw(
2588 message => qq/Unsupported mod_perl: $ENV{MOD_PERL}/ );
2593 $engine = $class->engine_class;
2596 Class::MOP::load_class($engine);
2598 # check for old engines that are no longer compatible
2600 if ( $engine->isa('Catalyst::Engine::Apache')
2601 && !Catalyst::Engine::Apache->VERSION )
2606 elsif ( $engine->isa('Catalyst::Engine::Server::Base')
2607 && Catalyst::Engine::Server->VERSION le '0.02' )
2612 elsif ($engine->isa('Catalyst::Engine::HTTP::POE')
2613 && $engine->VERSION eq '0.01' )
2618 elsif ($engine->isa('Catalyst::Engine::Zeus')
2619 && $engine->VERSION eq '0.01' )
2625 Catalyst::Exception->throw( message =>
2626 qq/Engine "$engine" is not supported by this version of Catalyst/
2631 $class->engine( $engine->new );
2634 =head2 $c->setup_home
2636 Sets up the home directory.
2641 my ( $class, $home ) = @_;
2643 if ( my $env = Catalyst::Utils::env_value( $class, 'HOME' ) ) {
2647 $home ||= Catalyst::Utils::home($class);
2650 #I remember recently being scolded for assigning config values like this
2651 $class->config->{home} ||= $home;
2652 $class->config->{root} ||= Path::Class::Dir->new($home)->subdir('root');
2656 =head2 $c->setup_log
2658 Sets up log by instantiating a L<Catalyst::Log|Catalyst::Log> object and
2659 passing it to C<log()>. Pass in a comma-delimited list of levels to set the
2662 This method also installs a C<debug> method that returns a true value into the
2663 catalyst subclass if the "debug" level is passed in the comma-delimited list,
2664 or if the C<$CATALYST_DEBUG> environment variable is set to a true value.
2666 Note that if the log has already been setup, by either a previous call to
2667 C<setup_log> or by a call such as C<< __PACKAGE__->log( MyLogger->new ) >>,
2668 that this method won't actually set up the log object.
2673 my ( $class, $levels ) = @_;
2676 $levels =~ s/^\s+//;
2677 $levels =~ s/\s+$//;
2678 my %levels = map { $_ => 1 } split /\s*,\s*/, $levels;
2680 my $env_debug = Catalyst::Utils::env_value( $class, 'DEBUG' );
2681 if ( defined $env_debug ) {
2682 $levels{debug} = 1 if $env_debug; # Ugly!
2683 delete($levels{debug}) unless $env_debug;
2686 unless ( $class->log ) {
2687 $class->log( Catalyst::Log->new(keys %levels) );
2690 if ( $levels{debug} ) {
2691 Class::MOP::get_metaclass_by_name($class)->add_method('debug' => sub { 1 });
2692 $class->log->debug('Debug messages enabled');
2696 =head2 $c->setup_plugins
2702 =head2 $c->setup_stats
2704 Sets up timing statistics class.
2709 my ( $class, $stats ) = @_;
2711 Catalyst::Utils::ensure_class_loaded($class->stats_class);
2713 my $env = Catalyst::Utils::env_value( $class, 'STATS' );
2714 if ( defined($env) ? $env : ($stats || $class->debug ) ) {
2715 Class::MOP::get_metaclass_by_name($class)->add_method('use_stats' => sub { 1 });
2716 $class->log->debug('Statistics enabled');
2721 =head2 $c->registered_plugins
2723 Returns a sorted list of the plugins which have either been stated in the
2724 import list or which have been added via C<< MyApp->plugin(@args); >>.
2726 If passed a given plugin name, it will report a boolean value indicating
2727 whether or not that plugin is loaded. A fully qualified name is required if
2728 the plugin name does not begin with C<Catalyst::Plugin::>.
2730 if ($c->registered_plugins('Some::Plugin')) {
2738 sub registered_plugins {
2740 return sort keys %{ $proto->_plugins } unless @_;
2742 return 1 if exists $proto->_plugins->{$plugin};
2743 return exists $proto->_plugins->{"Catalyst::Plugin::$plugin"};
2746 sub _register_plugin {
2747 my ( $proto, $plugin, $instant ) = @_;
2748 my $class = ref $proto || $proto;
2750 Class::MOP::load_class( $plugin );
2751 $class->log->warn( "$plugin inherits from 'Catalyst::Component' - this is deprecated and will not work in 5.81" )
2752 if $plugin->isa( 'Catalyst::Component' );
2753 $proto->_plugins->{$plugin} = 1;
2755 my $meta = Class::MOP::get_metaclass_by_name($class);
2756 $meta->superclasses($plugin, $meta->superclasses);
2762 my ( $class, $plugins ) = @_;
2764 $class->_plugins( {} ) unless $class->_plugins;
2765 $plugins = Data::OptList::mkopt($plugins || []);
2768 [ Catalyst::Utils::resolve_namespace(
2769 $class . '::Plugin',
2770 'Catalyst::Plugin', $_->[0]
2776 for my $plugin ( reverse @plugins ) {
2777 Class::MOP::load_class($plugin->[0], $plugin->[1]);
2778 my $meta = find_meta($plugin->[0]);
2779 next if $meta && $meta->isa('Moose::Meta::Role');
2781 $class->_register_plugin($plugin->[0]);
2785 map { $_->[0]->name, $_->[1] }
2786 grep { blessed($_->[0]) && $_->[0]->isa('Moose::Meta::Role') }
2787 map { [find_meta($_->[0]), $_->[1]] }
2790 Moose::Util::apply_all_roles(
2798 Returns an arrayref of the internal execution stack (actions that are
2799 currently executing).
2803 Returns the current timing statistics object. By default Catalyst uses
2804 L<Catalyst::Stats|Catalyst::Stats>, but can be set otherwise with
2805 L<< stats_class|/"$c->stats_class" >>.
2807 Even if L<< -Stats|/"-Stats" >> is not enabled, the stats object is still
2808 available. By enabling it with C< $c->stats->enabled(1) >, it can be used to
2809 profile explicitly, although MyApp.pm still won't profile nor output anything
2812 =head2 $c->stats_class
2814 Returns or sets the stats (timing statistics) class. L<Catalyst::Stats|Catalyst::Stats> is used by default.
2816 =head2 $c->use_stats
2818 Returns 1 when L<< stats collection|/"-Stats" >> is enabled.
2820 Note that this is a static method, not an accessor and should be overridden
2821 by declaring C<sub use_stats { 1 }> in your MyApp.pm, not by calling C<< $c->use_stats(1) >>.
2828 =head2 $c->write( $data )
2830 Writes $data to the output stream. When using this method directly, you
2831 will need to manually set the C<Content-Length> header to the length of
2832 your output data, if known.
2839 # Finalize headers if someone manually writes output
2840 $c->finalize_headers;
2842 return $c->engine->write( $c, @_ );
2847 Returns the Catalyst version number. Mostly useful for "powered by"
2848 messages in template systems.
2852 sub version { return $Catalyst::VERSION }
2854 =head1 CONFIGURATION
2856 There are a number of 'base' config variables which can be set:
2862 C<default_model> - The default model picked if you say C<< $c->model >>. See L<< /$c->model($name) >>.
2866 C<default_view> - The default view to be rendered or returned when C<< $c->view >> is called. See L<< /$c->view($name) >>.
2870 C<home> - The application home directory. In an uninstalled application,
2871 this is the top level application directory. In an installed application,
2872 this will be the directory containing C<< MyApp.pm >>.
2876 C<ignore_frontend_proxy> - See L</PROXY SUPPORT>
2880 C<name> - The name of the application in debug messages and the debug and
2885 C<parse_on_demand> - The request body (for example file uploads) will not be parsed
2886 until it is accessed. This allows you to (for example) check authentication (and reject
2887 the upload) before actually recieving all the data. See L</ON-DEMAND PARSER>
2891 C<root> - The root directory for templates. Usually this is just a
2892 subdirectory of the home directory, but you can set it to change the
2893 templates to a different directory.
2897 C<search_extra> - Array reference passed to Module::Pluggable to for additional
2898 namespaces from which components will be loaded (and constructed and stored in
2899 C<< $c->components >>).
2903 C<show_internal_actions> - If true, causes internal actions such as C<< _DISPATCH >>
2904 to be shown in hit debug tables in the test server.
2908 C<use_request_uri_for_path> - Controlls if the C<REQUEST_URI> or C<PATH_INFO> environment
2909 variable should be used for determining the request path. See L<Catalyst::Engine::CGI/PATH DECODING>
2910 for more information.
2914 C<using_frontend_proxy> - See L</PROXY SUPPORT>.
2918 =head1 INTERNAL ACTIONS
2920 Catalyst uses internal actions like C<_DISPATCH>, C<_BEGIN>, C<_AUTO>,
2921 C<_ACTION>, and C<_END>. These are by default not shown in the private
2922 action table, but you can make them visible with a config parameter.
2924 MyApp->config(show_internal_actions => 1);
2926 =head1 ON-DEMAND PARSER
2928 The request body is usually parsed at the beginning of a request,
2929 but if you want to handle input yourself, you can enable on-demand
2930 parsing with a config parameter.
2932 MyApp->config(parse_on_demand => 1);
2934 =head1 PROXY SUPPORT
2936 Many production servers operate using the common double-server approach,
2937 with a lightweight frontend web server passing requests to a larger
2938 backend server. An application running on the backend server must deal
2939 with two problems: the remote user always appears to be C<127.0.0.1> and
2940 the server's hostname will appear to be C<localhost> regardless of the
2941 virtual host that the user connected through.
2943 Catalyst will automatically detect this situation when you are running
2944 the frontend and backend servers on the same machine. The following
2945 changes are made to the request.
2947 $c->req->address is set to the user's real IP address, as read from
2948 the HTTP X-Forwarded-For header.
2950 The host value for $c->req->base and $c->req->uri is set to the real
2951 host, as read from the HTTP X-Forwarded-Host header.
2953 Additionally, you may be running your backend application on an insecure
2954 connection (port 80) while your frontend proxy is running under SSL. If there
2955 is a discrepancy in the ports, use the HTTP header C<X-Forwarded-Port> to
2956 tell Catalyst what port the frontend listens on. This will allow all URIs to
2957 be created properly.
2959 In the case of passing in:
2961 X-Forwarded-Port: 443
2963 All calls to C<uri_for> will result in an https link, as is expected.
2965 Obviously, your web server must support these headers for this to work.
2967 In a more complex server farm environment where you may have your
2968 frontend proxy server(s) on different machines, you will need to set a
2969 configuration option to tell Catalyst to read the proxied data from the
2972 MyApp->config(using_frontend_proxy => 1);
2974 If you do not wish to use the proxy support at all, you may set:
2976 MyApp->config(ignore_frontend_proxy => 1);
2978 =head1 THREAD SAFETY
2980 Catalyst has been tested under Apache 2's threading C<mpm_worker>,
2981 C<mpm_winnt>, and the standalone forking HTTP server on Windows. We
2982 believe the Catalyst core to be thread-safe.
2984 If you plan to operate in a threaded environment, remember that all other
2985 modules you are using must also be thread-safe. Some modules, most notably
2986 L<DBD::SQLite>, are not thread-safe.
2992 Join #catalyst on irc.perl.org.
2996 http://lists.scsys.co.uk/cgi-bin/mailman/listinfo/catalyst
2997 http://lists.scsys.co.uk/cgi-bin/mailman/listinfo/catalyst-dev
3001 http://catalyst.perl.org
3005 http://dev.catalyst.perl.org
3009 =head2 L<Task::Catalyst> - All you need to start with Catalyst
3011 =head2 L<Catalyst::Manual> - The Catalyst Manual
3013 =head2 L<Catalyst::Component>, L<Catalyst::Controller> - Base classes for components
3015 =head2 L<Catalyst::Engine> - Core engine
3017 =head2 L<Catalyst::Log> - Log class.
3019 =head2 L<Catalyst::Request> - Request object
3021 =head2 L<Catalyst::Response> - Response object
3023 =head2 L<Catalyst::Test> - The test suite.
3025 =head1 PROJECT FOUNDER
3027 sri: Sebastian Riedel <sri@cpan.org>
3033 acme: Leon Brocard <leon@astray.com>
3035 abraxxa: Alexander Hartmaier <abraxxa@cpan.org>
3039 Andrew Ford E<lt>A.Ford@ford-mason.co.ukE<gt>
3045 andyg: Andy Grundman <andy@hybridized.org>
3047 audreyt: Audrey Tang
3049 bricas: Brian Cassidy <bricas@cpan.org>
3051 Caelum: Rafael Kitover <rkitover@io.com>
3053 chansen: Christian Hansen
3055 chicks: Christopher Hicks
3057 Chisel Wright C<pause@herlpacker.co.uk>
3059 Danijel Milicevic C<me@danijel.de>
3061 David Kamholz E<lt>dkamholz@cpan.orgE<gt>
3063 David Naughton, C<naughton@umn.edu>
3067 dhoss: Devin Austin <dhoss@cpan.org>
3069 dkubb: Dan Kubb <dan.kubb-cpan@onautopilot.com>
3073 dwc: Daniel Westermann-Clark <danieltwc@cpan.org>
3075 esskar: Sascha Kiefer
3077 fireartist: Carl Franks <cfranks@cpan.org>
3079 frew: Arthur Axel "fREW" Schmidt <frioux@gmail.com>
3081 gabb: Danijel Milicevic
3085 Gavin Henry C<ghenry@perl.me.uk>
3089 groditi: Guillermo Roditi <groditi@gmail.com>
3091 hobbs: Andrew Rodland <andrew@cleverdomain.org>
3093 ilmari: Dagfinn Ilmari Mannsåker <ilmari@ilmari.org>
3095 jcamacho: Juan Camacho
3097 jester: Jesse Sheidlower C<jester@panix.com>
3099 jhannah: Jay Hannah <jay@jays.net>
3105 jon: Jon Schutz <jjschutz@cpan.org>
3107 Jonathan Rockway C<< <jrockway@cpan.org> >>
3109 Kieren Diment C<kd@totaldatasolution.com>
3111 konobi: Scott McWhirter <konobi@cpan.org>
3113 marcus: Marcus Ramberg <mramberg@cpan.org>
3115 miyagawa: Tatsuhiko Miyagawa <miyagawa@bulknews.net>
3117 mst: Matt S. Trout <mst@shadowcatsystems.co.uk>
3121 naughton: David Naughton
3123 ningu: David Kamholz <dkamholz@cpan.org>
3125 nothingmuch: Yuval Kogman <nothingmuch@woobling.org>
3127 numa: Dan Sully <daniel@cpan.org>
3133 omega: Andreas Marienborg
3135 Oleg Kostyuk <cub.uanic@gmail.com>
3137 phaylon: Robert Sedlacek <phaylon@dunkelheit.at>
3139 rafl: Florian Ragwitz <rafl@debian.org>
3141 random: Roland Lammel <lammel@cpan.org>
3143 Robert Sedlacek C<< <rs@474.at> >>
3145 SpiceMan: Marcel Montes
3149 szbalint: Balint Szilakszi <szbalint@cpan.org>
3151 t0m: Tomas Doran <bobtfish@bobtfish.net>
3155 Viljo Marrandi C<vilts@yahoo.com>
3157 Will Hawes C<info@whawes.co.uk>
3159 willert: Sebastian Willert <willert@cpan.org>
3161 wreis: Wallace Reis <wallace@reis.org.br>
3163 Yuval Kogman, C<nothingmuch@woobling.org>
3165 rainboxx: Matthias Dietrich, C<perl@rainboxx.de>
3167 dd070: Dhaval Dhanani <dhaval070@gmail.com>
3171 Copyright (c) 2005, the above named PROJECT FOUNDER and CONTRIBUTORS.
3175 This library is free software. You can redistribute it and/or modify it under
3176 the same terms as Perl itself.
3182 __PACKAGE__->meta->make_immutable;