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 Hash::Util qw/lock_hash/;
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 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);
97 unless ( $caller->isa('Catalyst') ) { # XXX - Remove!
98 my @superclasses = ($meta->superclasses, $class, 'Catalyst::Component'); # XXX - Remove!
99 $meta->superclasses(@superclasses); # XXX - Remove!
102 # Avoid possible C3 issues if 'Moose::Object' is already on RHS of MyApp
103 $meta->superclasses(grep { $_ ne 'Moose::Object' } $meta->superclasses);
105 unless( $meta->has_method('meta') ){
106 if ($Moose::VERSION >= 1.15) {
107 $meta->_add_meta_method('meta');
110 $meta->add_method(meta => sub { Moose::Meta::Class->initialize("${caller}") } );
114 $caller->arguments( [@arguments] );
118 sub MODIFY_CODE_ATTRIBUTES {
119 Catalyst::Exception->throw(
120 "Catalyst applications (aka MyApp) cannot be controllers anymore. " .
121 "That has been deprecated and removed. You should create a " .
122 "controller class called Root.pm, and move relevant code to that class."
127 sub _application { $_[0] }
131 Catalyst - The Elegant MVC Web Application Framework
135 See the L<Catalyst::Manual> distribution for comprehensive
136 documentation and tutorials.
138 # Install Catalyst::Devel for helpers and other development tools
139 # use the helper to create a new application
142 # add models, views, controllers
143 script/myapp_create.pl model MyDatabase DBIC::Schema create=static dbi:SQLite:/path/to/db
144 script/myapp_create.pl view MyTemplate TT
145 script/myapp_create.pl controller Search
147 # built in testserver -- use -r to restart automatically on changes
148 # --help to see all available options
149 script/myapp_server.pl
151 # command line testing interface
152 script/myapp_test.pl /yada
155 use Catalyst qw/-Debug/; # include plugins here as well
157 ### In lib/MyApp/Controller/Root.pm (autocreated)
158 sub foo : Global { # called for /foo, /foo/1, /foo/1/2, etc.
159 my ( $self, $c, @args ) = @_; # args are qw/1 2/ for /foo/1/2
160 $c->stash->{template} = 'foo.tt'; # set the template
161 # lookup something from db -- stash vars are passed to TT
163 $c->model('Database::Foo')->search( { country => $args[0] } );
164 if ( $c->req->params->{bar} ) { # access GET or POST parameters
165 $c->forward( 'bar' ); # process another action
166 # do something else after forward returns
170 # The foo.tt TT template can use the stash data from the database
171 [% WHILE (item = data.next) %]
175 # called for /bar/of/soap, /bar/of/soap/10, etc.
176 sub bar : Path('/bar/of/soap') { ... }
178 # called for all actions, from the top-most controller downwards
180 my ( $self, $c ) = @_;
181 if ( !$c->user_exists ) { # Catalyst::Plugin::Authentication
182 $c->res->redirect( '/login' ); # require login
183 return 0; # abort request and go immediately to end()
185 return 1; # success; carry on to next action
188 # called after all actions are finished
190 my ( $self, $c ) = @_;
191 if ( scalar @{ $c->error } ) { ... } # handle errors
192 return if $c->res->body; # already have a response
193 $c->forward( 'MyApp::View::TT' ); # render template
196 ### in MyApp/Controller/Foo.pm
197 # called for /foo/bar
198 sub bar : Local { ... }
200 # called for /blargle
201 sub blargle : Global { ... }
203 # an index action matches /foo, but not /foo/1, etc.
204 sub index : Private { ... }
206 ### in MyApp/Controller/Foo/Bar.pm
207 # called for /foo/bar/baz
208 sub baz : Local { ... }
210 # first Root auto is called, then Foo auto, then this
211 sub auto : Private { ... }
213 # powerful regular expression paths are also possible
214 sub details : Regex('^product/(\w+)/details$') {
215 my ( $self, $c ) = @_;
216 # extract the (\w+) from the URI
217 my $product = $c->req->captures->[0];
220 See L<Catalyst::Manual::Intro> for additional information.
224 Catalyst is a modern framework for making web applications without the
225 pain usually associated with this process. This document is a reference
226 to the main Catalyst application. If you are a new user, we suggest you
227 start with L<Catalyst::Manual::Tutorial> or L<Catalyst::Manual::Intro>.
229 See L<Catalyst::Manual> for more documentation.
231 Catalyst plugins can be loaded by naming them as arguments to the "use
232 Catalyst" statement. Omit the C<Catalyst::Plugin::> prefix from the
233 plugin name, i.e., C<Catalyst::Plugin::My::Module> becomes
236 use Catalyst qw/My::Module/;
238 If your plugin starts with a name other than C<Catalyst::Plugin::>, you can
239 fully qualify the name by using a unary plus:
243 +Fully::Qualified::Plugin::Name
246 Special flags like C<-Debug> and C<-Engine> can also be specified as
247 arguments when Catalyst is loaded:
249 use Catalyst qw/-Debug My::Module/;
251 The position of plugins and flags in the chain is important, because
252 they are loaded in the order in which they appear.
254 The following flags are supported:
258 Enables debug output. You can also force this setting from the system
259 environment with CATALYST_DEBUG or <MYAPP>_DEBUG. The environment
260 settings override the application, with <MYAPP>_DEBUG having the highest
263 This sets the log level to 'debug' and enables full debug output on the
264 error screen. If you only want the latter, see L<< $c->debug >>.
268 Forces Catalyst to use a specific engine. Omit the
269 C<Catalyst::Engine::> prefix of the engine name, i.e.:
271 use Catalyst qw/-Engine=CGI/;
275 Forces Catalyst to use a specific home directory, e.g.:
277 use Catalyst qw[-Home=/usr/mst];
279 This can also be done in the shell environment by setting either the
280 C<CATALYST_HOME> environment variable or C<MYAPP_HOME>; where C<MYAPP>
281 is replaced with the uppercased name of your application, any "::" in
282 the name will be replaced with underscores, e.g. MyApp::Web should use
283 MYAPP_WEB_HOME. If both variables are set, the MYAPP_HOME one will be used.
285 If none of these are set, Catalyst will attempt to automatically detect the
286 home directory. If you are working in a development envirnoment, Catalyst
287 will try and find the directory containing either Makefile.PL, Build.PL or
288 dist.ini. If the application has been installed into the system (i.e.
289 you have done C<make install>), then Catalyst will use the path to your
290 application module, without the .pm extension (ie, /foo/MyApp if your
291 application was installed at /foo/MyApp.pm)
295 use Catalyst '-Log=warn,fatal,error';
297 Specifies a comma-delimited list of log levels.
301 Enables statistics collection and reporting.
303 use Catalyst qw/-Stats=1/;
305 You can also force this setting from the system environment with CATALYST_STATS
306 or <MYAPP>_STATS. The environment settings override the application, with
307 <MYAPP>_STATS having the highest priority.
309 Stats are also enabled if L<< debugging |/"-Debug" >> is enabled.
313 =head2 INFORMATION ABOUT THE CURRENT REQUEST
317 Returns a L<Catalyst::Action> object for the current action, which
318 stringifies to the action name. See L<Catalyst::Action>.
322 Returns the namespace of the current action, i.e., the URI prefix
323 corresponding to the controller of the current action. For example:
325 # in Controller::Foo::Bar
326 $c->namespace; # returns 'foo/bar';
332 Returns the current L<Catalyst::Request> object, giving access to
333 information about the current client request (including parameters,
334 cookies, HTTP headers, etc.). See L<Catalyst::Request>.
336 =head2 REQUEST FLOW HANDLING
338 =head2 $c->forward( $action [, \@arguments ] )
340 =head2 $c->forward( $class, $method, [, \@arguments ] )
342 Forwards processing to another action, by its private name. If you give a
343 class name but no method, C<process()> is called. You may also optionally
344 pass arguments in an arrayref. The action will receive the arguments in
345 C<@_> and C<< $c->req->args >>. Upon returning from the function,
346 C<< $c->req->args >> will be restored to the previous values.
348 Any data C<return>ed from the action forwarded to, will be returned by the
351 my $foodata = $c->forward('/foo');
352 $c->forward('index');
353 $c->forward(qw/Model::DBIC::Foo do_stuff/);
354 $c->forward('View::TT');
356 Note that L<< forward|/"$c->forward( $action [, \@arguments ] )" >> implies
357 an C<< eval { } >> around the call (actually
358 L<< execute|/"$c->execute( $class, $coderef )" >> does), thus de-fatalizing
359 all 'dies' within the called action. If you want C<die> to propagate you
360 need to do something like:
363 die join "\n", @{ $c->error } if @{ $c->error };
365 Or make sure to always return true values from your actions and write
368 $c->forward('foo') || return;
370 Another note is that C<< $c->forward >> always returns a scalar because it
371 actually returns $c->state which operates in a scalar context.
372 Thus, something like:
376 in an action that is forwarded to is going to return a scalar,
377 i.e. how many items are in that array, which is probably not what you want.
378 If you need to return an array then return a reference to it,
381 $c->stash->{array} = \@array;
383 and access it from the stash.
385 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.
389 sub forward { my $c = shift; no warnings 'recursion'; $c->dispatcher->forward( $c, @_ ) }
391 =head2 $c->detach( $action [, \@arguments ] )
393 =head2 $c->detach( $class, $method, [, \@arguments ] )
397 The same as L<< forward|/"$c->forward( $action [, \@arguments ] )" >>, but
398 doesn't return to the previous action when processing is finished.
400 When called with no arguments it escapes the processing chain entirely.
404 sub detach { my $c = shift; $c->dispatcher->detach( $c, @_ ) }
406 =head2 $c->visit( $action [, \@captures, \@arguments ] )
408 =head2 $c->visit( $class, $method, [, \@captures, \@arguments ] )
410 Almost the same as L<< forward|/"$c->forward( $action [, \@arguments ] )" >>,
411 but does a full dispatch, instead of just calling the new C<$action> /
412 C<< $class->$method >>. This means that C<begin>, C<auto> and the method
413 you go to are called, just like a new request.
415 In addition both C<< $c->action >> and C<< $c->namespace >> are localized.
416 This means, for example, that C<< $c->action >> methods such as
417 L<name|Catalyst::Action/name>, L<class|Catalyst::Action/class> and
418 L<reverse|Catalyst::Action/reverse> return information for the visited action
419 when they are invoked within the visited action. This is different from the
420 behavior of L<< forward|/"$c->forward( $action [, \@arguments ] )" >>, which
421 continues to use the $c->action object from the caller action even when
422 invoked from the callee.
424 C<< $c->stash >> is kept unchanged.
426 In effect, L<< visit|/"$c->visit( $action [, \@captures, \@arguments ] )" >>
427 allows you to "wrap" another action, just as it would have been called by
428 dispatching from a URL, while the analogous
429 L<< go|/"$c->go( $action [, \@captures, \@arguments ] )" >> allows you to
430 transfer control to another action as if it had been reached directly from a URL.
434 sub visit { my $c = shift; $c->dispatcher->visit( $c, @_ ) }
436 =head2 $c->go( $action [, \@captures, \@arguments ] )
438 =head2 $c->go( $class, $method, [, \@captures, \@arguments ] )
440 The relationship between C<go> and
441 L<< visit|/"$c->visit( $action [, \@captures, \@arguments ] )" >> is the same as
442 the relationship between
443 L<< forward|/"$c->forward( $class, $method, [, \@arguments ] )" >> and
444 L<< detach|/"$c->detach( $action [, \@arguments ] )" >>. Like C<< $c->visit >>,
445 C<< $c->go >> will perform a full dispatch on the specified action or method,
446 with localized C<< $c->action >> and C<< $c->namespace >>. Like C<detach>,
447 C<go> escapes the processing of the current request chain on completion, and
448 does not return to its caller.
450 @arguments are arguments to the final destination of $action. @captures are
451 arguments to the intermediate steps, if any, on the way to the final sub of
456 sub go { my $c = shift; $c->dispatcher->go( $c, @_ ) }
462 Returns the current L<Catalyst::Response> object, see there for details.
466 Returns a hashref to the stash, which may be used to store data and pass
467 it between components during a request. You can also set hash keys by
468 passing arguments. The stash is automatically sent to the view. The
469 stash is cleared at the end of a request; it cannot be used for
470 persistent storage (for this you must use a session; see
471 L<Catalyst::Plugin::Session> for a complete system integrated with
474 $c->stash->{foo} = $bar;
475 $c->stash( { moose => 'majestic', qux => 0 } );
476 $c->stash( bar => 1, gorch => 2 ); # equivalent to passing a hashref
478 # stash is automatically passed to the view for use in a template
479 $c->forward( 'MyApp::View::TT' );
483 around stash => sub {
486 my $stash = $orig->($c);
488 my $new_stash = @_ > 1 ? {@_} : $_[0];
489 croak('stash takes a hash or hashref') unless ref $new_stash;
490 foreach my $key ( keys %$new_stash ) {
491 $stash->{$key} = $new_stash->{$key};
501 =head2 $c->error($error, ...)
503 =head2 $c->error($arrayref)
505 Returns an arrayref containing error messages. If Catalyst encounters an
506 error while processing a request, it stores the error in $c->error. This
507 method should only be used to store fatal error messages.
509 my @error = @{ $c->error };
513 $c->error('Something bad happened');
520 my $error = ref $_[0] eq 'ARRAY' ? $_[0] : [@_];
521 croak @$error unless ref $c;
522 push @{ $c->{error} }, @$error;
524 elsif ( defined $_[0] ) { $c->{error} = undef }
525 return $c->{error} || [];
531 Contains the return value of the last executed action.
532 Note that << $c->state >> operates in a scalar context which means that all
533 values it returns are scalar.
535 =head2 $c->clear_errors
537 Clear errors. You probably don't want to clear the errors unless you are
538 implementing a custom error screen.
540 This is equivalent to running
551 =head2 COMPONENT ACCESSORS
553 =head2 $c->controller($name)
555 Gets a L<Catalyst::Controller> instance by name.
557 $c->controller('Foo')->do_stuff;
559 If the name is omitted, will return the controller for the dispatched
562 If you want to search for controllers, pass in a regexp as the argument.
564 # find all controllers that start with Foo
565 my @foo_controllers = $c->controller(qr{^Foo});
571 my ( $c, $name, @args ) = @_;
573 $name ||= Catalyst::Utils::class2classshortsuffix( $c->action->class );
575 return $c->container->get_component_from_sub_container( 'controller', $name, $c, @args);
578 =head2 $c->model($name)
580 Gets a L<Catalyst::Model> instance by name.
582 $c->model('Foo')->do_stuff;
584 Any extra arguments are directly passed to ACCEPT_CONTEXT.
586 If the name is omitted, it will look for
587 - a model object in $c->stash->{current_model_instance}, then
588 - a model name in $c->stash->{current_model}, then
589 - a config setting 'default_model', or
590 - check if there is only one model, and return it if that's the case.
592 If you want to search for models, pass in a regexp as the argument.
594 # find all models that start with Foo
595 my @foo_models = $c->model(qr{^Foo});
600 my ( $c, $name, @args ) = @_;
602 if (ref $c && !$name) {
603 return $c->stash->{current_model_instance}
604 if $c->stash->{current_model_instance};
606 $name = $c->stash->{current_model}
607 if $c->stash->{current_model};
610 return $c->container->get_component_from_sub_container( 'model', $name, $c, @args);
614 =head2 $c->view($name)
616 Gets a L<Catalyst::View> instance by name.
618 $c->view('Foo')->do_stuff;
620 Any extra arguments are directly passed to ACCEPT_CONTEXT.
622 If the name is omitted, it will look for
623 - a view object in $c->stash->{current_view_instance}, then
624 - a view name in $c->stash->{current_view}, then
625 - a config setting 'default_view', or
626 - check if there is only one view, and return it if that's the case.
628 If you want to search for views, pass in a regexp as the argument.
630 # find all views that start with Foo
631 my @foo_views = $c->view(qr{^Foo});
636 my ( $c, $name, @args ) = @_;
638 if (ref $c && !$name) {
639 return $c->stash->{current_view_instance}
640 if $c->stash->{current_view_instance};
642 $name = $c->stash->{current_view}
643 if $c->stash->{current_view};
646 return $c->container->get_component_from_sub_container( 'view', $name, $c, @args);
649 =head2 $c->controllers
651 Returns the available names which can be passed to $c->controller
657 return $c->container->get_sub_container('controller')->get_service_list;
662 Returns the available names which can be passed to $c->model
668 return $c->container->get_sub_container('model')->get_service_list;
674 Returns the available names which can be passed to $c->view
680 return $c->container->get_sub_container('view')->get_service_list;
683 =head2 $c->comp($name)
685 =head2 $c->component($name)
687 Gets a component object by name. This method is not recommended,
688 unless you want to get a specific component by full
689 class. C<< $c->controller >>, C<< $c->model >>, and C<< $c->view >>
690 should be used instead.
692 If C<$name> is a regexp, a list of components matched against the full
693 component name will be returned.
698 my ( $c, $component, @args ) = @_;
700 unless ($component) {
701 $c->log->warn('Calling $c->component with no args is deprecated and ');
702 $c->log->warn('will be removed in a future release.');
703 $c->log->warn('Use $c->component_list instead.');
704 return $c->component_list;
707 my ($type, $name) = _get_component_type_name($component);
709 return $c->container->get_component_from_sub_container(
710 $type, $name, $c, @args
713 my @result = $c->container->find_component( $component, $c, @args );
715 # one last search for things like $c->comp(qr/::M::/)
716 @result = $c->container->find_component_regexp(
717 $c->components, $component, $c, @args
718 ) if !@result and ref $component;
720 # list context for regexp searches
721 return @result if ref $component;
723 # only one component (if it's found) for string searches
724 return shift @result if @result;
726 if (ref $c eq $component) {
727 $c->log->warn('You are calling $c->comp("MyApp"). This behaviour is');
728 $c->log->warn('deprecated, and will be removed in a future release.');
732 $c->log->warn("Looking for '$component', but nothing was found.");
734 # I would expect to return an empty list here, but that breaks back-compat
735 $c->log->warn('Component not found, returning the list of existing');
736 $c->log->warn('components. This behavior is deprecated and will be');
737 $c->log->warn('removed in a future release. Use $c->component_list');
738 $c->log->warn('instead.');
740 return $c->component_list;
743 =head2 $c->component_list
745 Returns the sorted list of the component names of the application.
749 sub component_list { sort keys %{ shift->components } }
751 =head2 CLASS DATA AND HELPER CLASSES
755 Returns or takes a hashref containing the application's configuration.
757 __PACKAGE__->config( { db => 'dsn:SQLite:foo.db' } );
759 You can also use a C<YAML>, C<XML> or L<Config::General> config file
760 like C<myapp.conf> in your applications home directory. See
761 L<Catalyst::Plugin::ConfigLoader>.
763 =head3 Cascading configuration
765 The config method is present on all Catalyst components, and configuration
766 will be merged when an application is started. Configuration loaded with
767 L<Catalyst::Plugin::ConfigLoader> takes precedence over other configuration,
768 followed by configuration in your top level C<MyApp> class. These two
769 configurations are merged, and then configuration data whose hash key matches a
770 component name is merged with configuration for that component.
772 The configuration for a component is then passed to the C<new> method when a
773 component is constructed.
777 MyApp->config({ 'Model::Foo' => { bar => 'baz', overrides => 'me' } });
778 MyApp::Model::Foo->config({ quux => 'frob', overrides => 'this' });
780 will mean that C<MyApp::Model::Foo> receives the following data when
783 MyApp::Model::Foo->new({
789 It's common practice to use a Moose attribute
790 on the receiving component to access the config value.
792 package MyApp::Model::Foo;
796 # this attr will receive 'baz' at construction time
802 You can then get the value 'baz' by calling $c->model('Foo')->bar
803 (or $self->bar inside code in the model).
805 B<NOTE:> you MUST NOT call C<< $self->config >> or C<< __PACKAGE__->config >>
806 as a way of reading config within your code, as this B<will not> give you the
807 correctly merged config back. You B<MUST> take the config values supplied to
808 the constructor and use those instead.
812 around config => sub {
816 croak('Setting config after setup has been run is not allowed.')
817 if ( @_ and $c->setup_finished );
824 Returns the logging object instance. Unless it is already set, Catalyst
825 sets this up with a L<Catalyst::Log> object. To use your own log class,
826 set the logger with the C<< __PACKAGE__->log >> method prior to calling
827 C<< __PACKAGE__->setup >>.
829 __PACKAGE__->log( MyLogger->new );
834 $c->log->info( 'Now logging with my own logger!' );
836 Your log class should implement the methods described in
842 Returns 1 if debug mode is enabled, 0 otherwise.
844 You can enable debug mode in several ways:
848 =item By calling myapp_server.pl with the -d flag
850 =item With the environment variables MYAPP_DEBUG, or CATALYST_DEBUG
852 =item The -Debug option in your MyApp.pm
854 =item By declaring C<sub debug { 1 }> in your MyApp.pm.
858 The first three also set the log level to 'debug'.
860 Calling C<< $c->debug(1) >> has no effect.
866 =head2 $c->dispatcher
868 Returns the dispatcher instance. See L<Catalyst::Dispatcher>.
872 Returns the engine instance. See L<Catalyst::Engine>.
875 =head2 UTILITY METHODS
877 =head2 $c->path_to(@path)
879 Merges C<@path> with C<< $c->config->{home} >> and returns a
880 L<Path::Class::Dir> object. Note you can usually use this object as
881 a filename, but sometimes you will have to explicitly stringify it
882 yourself by calling the C<< ->stringify >> method.
886 $c->path_to( 'db', 'sqlite.db' );
891 my ( $c, @path ) = @_;
892 my $path = Path::Class::Dir->new( $c->config->{home}, @path );
893 if ( -d $path ) { return $path }
894 else { return Path::Class::File->new( $c->config->{home}, @path ) }
897 =head2 $c->plugin( $name, $class, @args )
899 Helper method for plugins. It creates a class data accessor/mutator and
900 loads and instantiates the given class.
902 MyApp->plugin( 'prototype', 'HTML::Prototype' );
904 $c->prototype->define_javascript_functions;
906 B<Note:> This method of adding plugins is deprecated. The ability
907 to add plugins like this B<will be removed> in a Catalyst 5.81.
908 Please do not use this functionality in new code.
913 my ( $class, $name, $plugin, @args ) = @_;
915 # See block comment in t/aggregate/unit_core_plugin.t
916 $class->log->warn(qq/Adding plugin using the ->plugin method is deprecated, and will be removed in Catalyst 5.81/);
918 $class->_register_plugin( $plugin, 1 );
920 eval { $plugin->import };
921 $class->mk_classdata($name);
923 eval { $obj = $plugin->new(@args) };
926 Catalyst::Exception->throw( message =>
927 qq/Couldn't instantiate instant plugin "$plugin", "$@"/ );
931 $class->log->debug(qq/Initialized instant plugin "$plugin" as "$name"/)
937 Initializes the dispatcher and engine, loads any plugins, and loads the
938 model, view, and controller components. You may also specify an array
939 of plugins to load here, if you choose to not load them in the C<use
943 MyApp->setup( qw/-Debug/ );
948 my ( $class, @arguments ) = @_;
949 croak('Running setup more than once')
950 if ( $class->setup_finished );
952 unless ( $class->isa('Catalyst') ) {
954 Catalyst::Exception->throw(
955 message => qq/'$class' does not inherit from Catalyst/ );
958 if ( $class->arguments ) {
959 @arguments = ( @arguments, @{ $class->arguments } );
965 foreach (@arguments) {
969 ( $flags->{log} ) ? 'debug,' . $flags->{log} : 'debug';
971 elsif (/^-(\w+)=?(.*)$/) {
972 $flags->{ lc $1 } = $2;
975 push @{ $flags->{plugins} }, $_;
979 $class->setup_config();
980 $class->setup_home( delete $flags->{home} );
982 $class->setup_log( delete $flags->{log} );
983 $class->setup_plugins( delete $flags->{plugins} );
984 $class->setup_dispatcher( delete $flags->{dispatcher} );
985 $class->setup_engine( delete $flags->{engine} );
986 $class->setup_stats( delete $flags->{stats} );
988 for my $flag ( sort keys %{$flags} ) {
990 if ( my $code = $class->can( 'setup_' . $flag ) ) {
991 &$code( $class, delete $flags->{$flag} );
994 $class->log->warn(qq/Unknown flag "$flag"/);
998 eval { require Catalyst::Devel; };
999 if( !$@ && $ENV{CATALYST_SCRIPT_GEN} && ( $ENV{CATALYST_SCRIPT_GEN} < $Catalyst::Devel::CATALYST_SCRIPT_GEN ) ) {
1000 $class->log->warn(<<"EOF");
1001 You are running an old script!
1003 Please update by running (this will overwrite existing files):
1004 catalyst.pl -force -scripts $class
1006 or (this will not overwrite existing files):
1007 catalyst.pl -scripts $class
1012 if ( $class->debug ) {
1013 my @plugins = map { "$_ " . ( $_->VERSION || '' ) } $class->registered_plugins;
1016 my $column_width = Catalyst::Utils::term_width() - 6;
1017 my $t = Text::SimpleTable->new($column_width);
1018 $t->row($_) for @plugins;
1019 $class->log->debug( "Loaded plugins:\n" . $t->draw . "\n" );
1022 my $dispatcher = $class->dispatcher;
1023 my $engine = $class->engine;
1024 my $home = $class->config->{home};
1026 $class->log->debug(sprintf(q/Loaded dispatcher "%s"/, blessed($dispatcher)));
1027 $class->log->debug(sprintf(q/Loaded engine "%s"/, blessed($engine)));
1031 ? $class->log->debug(qq/Found home "$home"/)
1032 : $class->log->debug(qq/Home "$home" doesn't exist/)
1033 : $class->log->debug(q/Couldn't find home/);
1036 # Call plugins setup, this is stupid and evil.
1037 # Also screws C3 badly on 5.10, hack to avoid.
1039 no warnings qw/redefine/;
1040 local *setup = sub { };
1041 $class->setup unless $Catalyst::__AM_RESTARTING;
1044 $class->setup_components;
1048 my @comps_types = $class->container->get_components_types
1050 my $column_width = Catalyst::Utils::term_width() - 8 - 9;
1051 my $t = Text::SimpleTable->new( [ $column_width, 'Class' ], [ 8, 'Type' ] );
1052 $t->row( @$_ ) for @comps_types;
1054 $class->log->debug( "Loaded components:\n" . $t->draw . "\n" );
1057 $class->setup_actions;
1059 if ( $class->debug ) {
1060 my $name = $class->config->{name} || 'Application';
1061 $class->log->info("$name powered by Catalyst $Catalyst::VERSION");
1064 # Make sure that the application class becomes immutable at this point,
1065 B::Hooks::EndOfScope::on_scope_end {
1067 my $meta = Class::MOP::get_metaclass_by_name($class);
1070 && ! { $meta->immutable_options }->{replace_constructor}
1072 $class->isa('Class::Accessor::Fast')
1073 || $class->isa('Class::Accessor')
1076 warn "You made your application class ($class) immutable, "
1077 . "but did not inline the\nconstructor. "
1078 . "This will break catalyst, as your app \@ISA "
1079 . "Class::Accessor(::Fast)?\nPlease pass "
1080 . "(replace_constructor => 1)\nwhen making your class immutable.\n";
1082 $meta->make_immutable(
1083 replace_constructor => 1,
1084 ) unless $meta->is_immutable;
1087 if ($class->config->{case_sensitive}) {
1088 $class->log->warn($class . "->config->{case_sensitive} is set.");
1089 $class->log->warn("This setting is deprecated and planned to be removed in Catalyst 5.81.");
1092 $class->setup_finalize;
1093 # Should be the last thing we do so that user things hooking
1094 # setup_finalize can log..
1095 $class->log->_flush() if $class->log->can('_flush');
1096 return 1; # Explicit return true as people have __PACKAGE__->setup as the last thing in their class. HATE.
1099 =head2 $app->setup_finalize
1101 A hook to attach modifiers to. This method does not do anything except set the
1102 C<setup_finished> accessor.
1104 Applying method modifiers to the C<setup> method doesn't work, because of quirky things done for plugin setup.
1108 after setup_finalize => sub {
1116 sub setup_finalize {
1118 $class->setup_finished(1);
1121 =head2 $c->uri_for( $path?, @args?, \%query_values? )
1123 =head2 $c->uri_for( $action, \@captures?, @args?, \%query_values? )
1125 Constructs an absolute L<URI> object based on the application root, the
1126 provided path, and the additional arguments and query parameters provided.
1127 When used as a string, provides a textual URI. If you need more flexibility
1128 than this (i.e. the option to provide relative URIs etc.) see
1129 L<Catalyst::Plugin::SmartURI>.
1131 If no arguments are provided, the URI for the current action is returned.
1132 To return the current action and also provide @args, use
1133 C<< $c->uri_for( $c->action, @args ) >>.
1135 If the first argument is a string, it is taken as a public URI path relative
1136 to C<< $c->namespace >> (if it doesn't begin with a forward slash) or
1137 relative to the application root (if it does). It is then merged with
1138 C<< $c->request->base >>; any C<@args> are appended as additional path
1139 components; and any C<%query_values> are appended as C<?foo=bar> parameters.
1141 If the first argument is a L<Catalyst::Action> it represents an action which
1142 will have its path resolved using C<< $c->dispatcher->uri_for_action >>. The
1143 optional C<\@captures> argument (an arrayref) allows passing the captured
1144 variables that are needed to fill in the paths of Chained and Regex actions;
1145 once the path is resolved, C<uri_for> continues as though a path was
1146 provided, appending any arguments or parameters and creating an absolute
1149 The captures for the current request can be found in
1150 C<< $c->request->captures >>, and actions can be resolved using
1151 C<< Catalyst::Controller->action_for($name) >>. If you have a private action
1152 path, use C<< $c->uri_for_action >> instead.
1154 # Equivalent to $c->req->uri
1155 $c->uri_for($c->action, $c->req->captures,
1156 @{ $c->req->args }, $c->req->params);
1158 # For the Foo action in the Bar controller
1159 $c->uri_for($c->controller('Bar')->action_for('Foo'));
1161 # Path to a static resource
1162 $c->uri_for('/static/images/logo.png');
1167 my ( $c, $path, @args ) = @_;
1169 if (blessed($path) && $path->isa('Catalyst::Controller')) {
1170 $path = $path->path_prefix;
1175 undef($path) if (defined $path && $path eq '');
1178 ( scalar @args && ref $args[$#args] eq 'HASH' ? pop @args : {} );
1180 carp "uri_for called with undef argument" if grep { ! defined $_ } @args;
1181 foreach my $arg (@args) {
1182 utf8::encode($arg) if utf8::is_utf8($arg);
1183 $arg =~ s/([^$URI::uric])/$URI::Escape::escapes{$1}/go;
1186 if ( blessed($path) ) { # action object
1187 s|/|%2F|g for @args;
1188 my $captures = [ map { s|/|%2F|g; $_; }
1189 ( scalar @args && ref $args[0] eq 'ARRAY'
1193 foreach my $capture (@$captures) {
1194 utf8::encode($capture) if utf8::is_utf8($capture);
1195 $capture =~ s/([^$URI::uric])/$URI::Escape::escapes{$1}/go;
1199 $path = $c->dispatcher->uri_for_action($action, $captures);
1200 if (not defined $path) {
1201 $c->log->debug(qq/Can't find uri_for action '$action' @$captures/)
1205 $path = '/' if $path eq '';
1208 unshift(@args, $path);
1210 unless (defined $path && $path =~ s!^/!!) { # in-place strip
1211 my $namespace = $c->namespace;
1212 if (defined $path) { # cheesy hack to handle path '../foo'
1213 $namespace =~ s{(?:^|/)[^/]+$}{} while $args[0] =~ s{^\.\./}{};
1215 unshift(@args, $namespace || '');
1218 # join args with '/', or a blank string
1219 my $args = join('/', grep { defined($_) } @args);
1220 $args =~ s/\?/%3F/g; # STUPID STUPID SPECIAL CASE
1222 my $base = $c->req->base;
1223 my $class = ref($base);
1224 $base =~ s{(?<!/)$}{/};
1228 if (my @keys = keys %$params) {
1229 # somewhat lifted from URI::_query's query_form
1230 $query = '?'.join('&', map {
1231 my $val = $params->{$_};
1232 s/([;\/?:@&=+,\$\[\]%])/$URI::Escape::escapes{$1}/go;
1235 $val = '' unless defined $val;
1238 utf8::encode( $param ) if utf8::is_utf8($param);
1239 # using the URI::Escape pattern here so utf8 chars survive
1240 $param =~ s/([^A-Za-z0-9\-_.!~*'() ])/$URI::Escape::escapes{$1}/go;
1242 "${key}=$param"; } ( ref $val eq 'ARRAY' ? @$val : $val ));
1246 my $res = bless(\"${base}${args}${query}", $class);
1250 =head2 $c->uri_for_action( $path, \@captures?, @args?, \%query_values? )
1252 =head2 $c->uri_for_action( $action, \@captures?, @args?, \%query_values? )
1258 A private path to the Catalyst action you want to create a URI for.
1260 This is a shortcut for calling C<< $c->dispatcher->get_action_by_path($path)
1261 >> and passing the resulting C<$action> and the remaining arguments to C<<
1264 You can also pass in a Catalyst::Action object, in which case it is passed to
1267 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.
1269 For example, if the action looks like:
1271 package MyApp::Controller::Users;
1273 sub lst : Path('the-list') {}
1277 $c->uri_for_action('/users/lst')
1279 and it will create the URI /users/the-list.
1285 sub uri_for_action {
1286 my ( $c, $path, @args ) = @_;
1287 my $action = blessed($path)
1289 : $c->dispatcher->get_action_by_path($path);
1290 unless (defined $action) {
1291 croak "Can't find action for path '$path'";
1293 return $c->uri_for( $action, @args );
1296 =head2 $c->welcome_message
1298 Returns the Catalyst welcome HTML page.
1302 sub welcome_message {
1304 my $name = $c->config->{name};
1305 my $logo = $c->uri_for('/static/images/catalyst_logo.png');
1306 my $prefix = Catalyst::Utils::appprefix( ref $c );
1307 $c->response->content_type('text/html; charset=utf-8');
1309 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
1310 "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
1311 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
1313 <meta http-equiv="Content-Language" content="en" />
1314 <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
1315 <title>$name on Catalyst $VERSION</title>
1316 <style type="text/css">
1319 background-color: #eee;
1326 margin-bottom: 10px;
1328 background-color: #ccc;
1329 border: 1px solid #aaa;
1334 font-family: verdana, tahoma, sans-serif;
1337 font-family: verdana, tahoma, sans-serif;
1340 text-decoration: none;
1342 border-bottom: 1px dotted #bbb;
1344 :link:hover, :visited:hover {
1357 background-color: #fff;
1358 border: 1px solid #aaa;
1362 font-weight: normal;
1384 <h1><span id="appname">$name</span> on <a href="http://catalyst.perl.org">Catalyst</a>
1389 <img src="$logo" alt="Catalyst Logo" />
1391 <p>Welcome to the world of Catalyst.
1392 This <a href="http://en.wikipedia.org/wiki/MVC">MVC</a>
1393 framework will make web development something you had
1394 never expected it to be: Fun, rewarding, and quick.</p>
1395 <h2>What to do now?</h2>
1396 <p>That really depends on what <b>you</b> want to do.
1397 We do, however, provide you with a few starting points.</p>
1398 <p>If you want to jump right into web development with Catalyst
1399 you might want to start with a tutorial.</p>
1400 <pre>perldoc <a href="http://cpansearch.perl.org/dist/Catalyst-Manual/lib/Catalyst/Manual/Tutorial.pod">Catalyst::Manual::Tutorial</a></code>
1402 <p>Afterwards you can go on to check out a more complete look at our features.</p>
1404 <code>perldoc <a href="http://cpansearch.perl.org/dist/Catalyst-Manual/lib/Catalyst/Manual/Intro.pod">Catalyst::Manual::Intro</a>
1405 <!-- Something else should go here, but the Catalyst::Manual link seems unhelpful -->
1407 <h2>What to do next?</h2>
1408 <p>Next it's time to write an actual application. Use the
1409 helper scripts to generate <a href="http://cpansearch.perl.org/search?query=Catalyst%3A%3AController%3A%3A&mode=all">controllers</a>,
1410 <a href="http://cpansearch.perl.org/search?query=Catalyst%3A%3AModel%3A%3A&mode=all">models</a>, and
1411 <a href="http://cpansearch.perl.org/search?query=Catalyst%3A%3AView%3A%3A&mode=all">views</a>;
1412 they can save you a lot of work.</p>
1413 <pre><code>script/${prefix}_create.pl --help</code></pre>
1414 <p>Also, be sure to check out the vast and growing
1415 collection of <a href="http://search.cpan.org/search?query=Catalyst">plugins for Catalyst on CPAN</a>;
1416 you are likely to find what you need there.
1420 <p>Catalyst has a very active community. Here are the main places to
1421 get in touch with us.</p>
1424 <a href="http://dev.catalyst.perl.org">Wiki</a>
1427 <a href="http://lists.scsys.co.uk/cgi-bin/mailman/listinfo/catalyst">Mailing-List</a>
1430 <a href="irc://irc.perl.org/catalyst">IRC channel #catalyst on irc.perl.org</a>
1433 <h2>In conclusion</h2>
1434 <p>The Catalyst team hopes you will enjoy using Catalyst as much
1435 as we enjoyed making it. Please contact us if you have ideas
1436 for improvement or other feedback.</p>
1444 =head1 INTERNAL METHODS
1446 These methods are not meant to be used by end users.
1448 =head2 $c->components
1450 Returns a hash of components.
1455 my ( $class, $comps ) = @_;
1457 # FIXME: should this ugly kludge exist?
1458 $class->setup_config unless defined $class->container;
1461 $containers->{$_} = $class->container->get_sub_container($_)
1462 for qw(model view controller);
1465 for my $component ( keys %$comps ) {
1466 my ($type, $name) = _get_component_type_name($component);
1468 $containers->{$type}->add_service(
1469 Catalyst::IOC::BlockInjection->new(
1471 block => sub { $class->setup_component($component) },
1478 for my $container (keys %$containers) {
1479 my @service_list = $containers->{$container}->get_service_list;
1480 for my $component (@service_list) {
1481 my $comp = $containers->{$container}->resolve(
1482 service => $component
1484 my $comp_name = ref $comp || $comp;
1485 $components{$comp_name} = $comp;
1489 return lock_hash %components;
1492 =head2 $c->context_class
1494 Returns or sets the context class.
1498 Returns a hashref containing coderefs and execution counts (needed for
1499 deep recursion detection).
1503 Returns the number of actions on the current internal execution stack.
1507 Dispatches a request to actions.
1511 sub dispatch { my $c = shift; $c->dispatcher->dispatch( $c, @_ ) }
1513 =head2 $c->dispatcher_class
1515 Returns or sets the dispatcher class.
1517 =head2 $c->dump_these
1519 Returns a list of 2-element array references (name, structure) pairs
1520 that will be dumped on the error page in debug mode.
1526 [ Request => $c->req ],
1527 [ Response => $c->res ],
1528 [ Stash => $c->stash ],
1529 [ Config => $c->config ];
1532 =head2 $c->engine_class
1534 Returns or sets the engine class.
1536 =head2 $c->execute( $class, $coderef )
1538 Execute a coderef in given class and catch exceptions. Errors are available
1544 my ( $c, $class, $code ) = @_;
1545 $class = $c->component($class) || $class;
1548 if ( $c->depth >= $RECURSION ) {
1549 my $action = $code->reverse();
1550 $action = "/$action" unless $action =~ /->/;
1551 my $error = qq/Deep recursion detected calling "${action}"/;
1552 $c->log->error($error);
1558 my $stats_info = $c->_stats_start_execute( $code ) if $c->use_stats;
1560 push( @{ $c->stack }, $code );
1562 no warnings 'recursion';
1563 # N.B. This used to be combined, but I have seen $c get clobbered if so, and
1564 # I have no idea how, ergo $ret (which appears to fix the issue)
1565 eval { my $ret = $code->execute( $class, $c, @{ $c->req->args } ) || 0; $c->state( $ret ) };
1567 $c->_stats_finish_execute( $stats_info ) if $c->use_stats and $stats_info;
1569 my $last = pop( @{ $c->stack } );
1571 if ( my $error = $@ ) {
1572 if ( blessed($error) and $error->isa('Catalyst::Exception::Detach') ) {
1573 $error->rethrow if $c->depth > 1;
1575 elsif ( blessed($error) and $error->isa('Catalyst::Exception::Go') ) {
1576 $error->rethrow if $c->depth > 0;
1579 unless ( ref $error ) {
1580 no warnings 'uninitialized';
1582 my $class = $last->class;
1583 my $name = $last->name;
1584 $error = qq/Caught exception in $class->$name "$error"/;
1593 sub _stats_start_execute {
1594 my ( $c, $code ) = @_;
1595 my $appclass = ref($c) || $c;
1596 return if ( ( $code->name =~ /^_.*/ )
1597 && ( !$appclass->config->{show_internal_actions} ) );
1599 my $action_name = $code->reverse();
1600 $c->counter->{$action_name}++;
1602 my $action = $action_name;
1603 $action = "/$action" unless $action =~ /->/;
1605 # determine if the call was the result of a forward
1606 # this is done by walking up the call stack and looking for a calling
1607 # sub of Catalyst::forward before the eval
1609 for my $index ( 2 .. 11 ) {
1611 if ( ( caller($index) )[0] eq 'Catalyst'
1612 && ( caller($index) )[3] eq '(eval)' );
1614 if ( ( caller($index) )[3] =~ /forward$/ ) {
1615 $callsub = ( caller($index) )[3];
1616 $action = "-> $action";
1621 my $uid = $action_name . $c->counter->{$action_name};
1623 # is this a root-level call or a forwarded call?
1624 if ( $callsub =~ /forward$/ ) {
1625 my $parent = $c->stack->[-1];
1627 # forward, locate the caller
1628 if ( defined $parent && exists $c->counter->{"$parent"} ) {
1631 parent => "$parent" . $c->counter->{"$parent"},
1637 # forward with no caller may come from a plugin
1656 sub _stats_finish_execute {
1657 my ( $c, $info ) = @_;
1658 $c->stats->profile( end => $info );
1663 Finalizes the request.
1670 for my $error ( @{ $c->error } ) {
1671 $c->log->error($error);
1674 # Allow engine to handle finalize flow (for POE)
1675 my $engine = $c->engine;
1676 if ( my $code = $engine->can('finalize') ) {
1681 $c->finalize_uploads;
1684 if ( $#{ $c->error } >= 0 ) {
1688 $c->finalize_headers;
1691 if ( $c->request->method eq 'HEAD' ) {
1692 $c->response->body('');
1700 if ($c->use_stats) {
1701 my $elapsed = sprintf '%f', $c->stats->elapsed;
1702 my $av = $elapsed == 0 ? '??' : sprintf '%.3f', 1 / $elapsed;
1704 "Request took ${elapsed}s ($av/s)\n" . $c->stats->report . "\n" );
1707 return $c->response->status;
1710 =head2 $c->finalize_body
1716 sub finalize_body { my $c = shift; $c->engine->finalize_body( $c, @_ ) }
1718 =head2 $c->finalize_cookies
1724 sub finalize_cookies { my $c = shift; $c->engine->finalize_cookies( $c, @_ ) }
1726 =head2 $c->finalize_error
1732 sub finalize_error { my $c = shift; $c->engine->finalize_error( $c, @_ ) }
1734 =head2 $c->finalize_headers
1740 sub finalize_headers {
1743 my $response = $c->response; #accessor calls can add up?
1745 # Check if we already finalized headers
1746 return if $response->finalized_headers;
1749 if ( my $location = $response->redirect ) {
1750 $c->log->debug(qq/Redirecting to "$location"/) if $c->debug;
1751 $response->header( Location => $location );
1753 if ( !$response->has_body ) {
1754 # Add a default body if none is already present
1756 qq{<html><body><p>This item has moved <a href="$location">here</a>.</p></body></html>}
1762 if ( defined $response->body && length $response->body && !$response->content_length ) {
1764 # get the length from a filehandle
1765 if ( blessed( $response->body ) && $response->body->can('read') || ref( $response->body ) eq 'GLOB' )
1767 my $stat = stat $response->body;
1768 if ( $stat && $stat->size > 0 ) {
1769 $response->content_length( $stat->size );
1772 $c->log->warn('Serving filehandle without a content-length');
1776 # everything should be bytes at this point, but just in case
1777 $response->content_length( length( $response->body ) );
1782 if ( $response->status =~ /^(1\d\d|[23]04)$/ ) {
1783 $response->headers->remove_header("Content-Length");
1784 $response->body('');
1787 $c->finalize_cookies;
1789 $c->engine->finalize_headers( $c, @_ );
1792 $response->finalized_headers(1);
1795 =head2 $c->finalize_output
1797 An alias for finalize_body.
1799 =head2 $c->finalize_read
1801 Finalizes the input after reading is complete.
1805 sub finalize_read { my $c = shift; $c->engine->finalize_read( $c, @_ ) }
1807 =head2 $c->finalize_uploads
1809 Finalizes uploads. Cleans up any temporary files.
1813 sub finalize_uploads { my $c = shift; $c->engine->finalize_uploads( $c, @_ ) }
1815 =head2 $c->get_action( $action, $namespace )
1817 Gets an action in a given namespace.
1821 sub get_action { my $c = shift; $c->dispatcher->get_action(@_) }
1823 =head2 $c->get_actions( $action, $namespace )
1825 Gets all actions of a given name in a namespace and all parent
1830 sub get_actions { my $c = shift; $c->dispatcher->get_actions( $c, @_ ) }
1832 =head2 $app->handle_request( @arguments )
1834 Called to handle each HTTP request.
1838 sub handle_request {
1839 my ( $class, @arguments ) = @_;
1841 # Always expect worst case!
1844 if ($class->debug) {
1845 my $secs = time - $START || 1;
1846 my $av = sprintf '%.3f', $COUNT / $secs;
1847 my $time = localtime time;
1848 $class->log->info("*** Request $COUNT ($av/s) [$$] [$time] ***");
1851 my $c = $class->prepare(@arguments);
1853 $status = $c->finalize;
1856 if ( my $error = $@ ) {
1858 $class->log->error(qq/Caught exception in engine "$error"/);
1863 if(my $coderef = $class->log->can('_flush')){
1864 $class->log->$coderef();
1869 =head2 $c->prepare( @arguments )
1871 Creates a Catalyst context from an engine-specific request (Apache, CGI,
1877 my ( $class, @arguments ) = @_;
1880 # After the app/ctxt split, this should become an attribute based on something passed
1881 # into the application.
1882 $class->context_class( ref $class || $class ) unless $class->context_class;
1884 my $c = $class->context_class->new({});
1886 # For on-demand data
1887 $c->request->_context($c);
1888 $c->response->_context($c);
1890 #surely this is not the most efficient way to do things...
1891 $c->stats($class->stats_class->new)->enable($c->use_stats);
1892 if ( $c->debug || $c->config->{enable_catalyst_header} ) {
1893 $c->res->headers->header( 'X-Catalyst' => $Catalyst::VERSION );
1896 #XXX reuse coderef from can
1897 # Allow engine to direct the prepare flow (for POE)
1898 if ( $c->engine->can('prepare') ) {
1899 $c->engine->prepare( $c, @arguments );
1902 $c->prepare_request(@arguments);
1903 $c->prepare_connection;
1904 $c->prepare_query_parameters;
1905 $c->prepare_headers;
1906 $c->prepare_cookies;
1909 # Prepare the body for reading, either by prepare_body
1910 # or the user, if they are using $c->read
1913 # Parse the body unless the user wants it on-demand
1914 unless ( ref($c)->config->{parse_on_demand} ) {
1919 my $method = $c->req->method || '';
1920 my $path = $c->req->path;
1921 $path = '/' unless length $path;
1922 my $address = $c->req->address || '';
1931 =head2 $c->prepare_action
1933 Prepares action. See L<Catalyst::Dispatcher>.
1937 sub prepare_action { my $c = shift; $c->dispatcher->prepare_action( $c, @_ ) }
1939 =head2 $c->prepare_body
1941 Prepares message body.
1948 return if $c->request->_has_body;
1950 # Initialize on-demand data
1951 $c->engine->prepare_body( $c, @_ );
1952 $c->prepare_parameters;
1953 $c->prepare_uploads;
1956 =head2 $c->prepare_body_chunk( $chunk )
1958 Prepares a chunk of data before sending it to L<HTTP::Body>.
1960 See L<Catalyst::Engine>.
1964 sub prepare_body_chunk {
1966 $c->engine->prepare_body_chunk( $c, @_ );
1969 =head2 $c->prepare_body_parameters
1971 Prepares body parameters.
1975 sub prepare_body_parameters {
1977 $c->engine->prepare_body_parameters( $c, @_ );
1980 =head2 $c->prepare_connection
1982 Prepares connection.
1986 sub prepare_connection {
1988 $c->engine->prepare_connection( $c, @_ );
1991 =head2 $c->prepare_cookies
1997 sub prepare_cookies { my $c = shift; $c->engine->prepare_cookies( $c, @_ ) }
1999 =head2 $c->prepare_headers
2005 sub prepare_headers { my $c = shift; $c->engine->prepare_headers( $c, @_ ) }
2007 =head2 $c->prepare_parameters
2009 Prepares parameters.
2013 sub prepare_parameters {
2015 $c->prepare_body_parameters;
2016 $c->engine->prepare_parameters( $c, @_ );
2019 =head2 $c->prepare_path
2021 Prepares path and base.
2025 sub prepare_path { my $c = shift; $c->engine->prepare_path( $c, @_ ) }
2027 =head2 $c->prepare_query_parameters
2029 Prepares query parameters.
2033 sub prepare_query_parameters {
2036 $c->engine->prepare_query_parameters( $c, @_ );
2039 =head2 $c->log_request
2041 Writes information about the request to the debug logs. This includes:
2045 =item * Request method, path, and remote IP address
2047 =item * Query keywords (see L<Catalyst::Request/query_keywords>)
2049 =item * Request parameters
2051 =item * File uploads
2060 return unless $c->debug;
2062 my($dump) = grep {$_->[0] eq 'Request' } $c->dump_these;
2063 my $request = $dump->[1];
2065 my ( $method, $path, $address ) = ( $request->method, $request->path, $request->address );
2067 $path = '/' unless length $path;
2069 $c->log->debug(qq/"$method" request for "$path" from "$address"/);
2071 $c->log_request_headers($request->headers);
2073 if ( my $keywords = $request->query_keywords ) {
2074 $c->log->debug("Query keywords are: $keywords");
2077 $c->log_request_parameters( query => $request->query_parameters, $request->_has_body ? (body => $request->body_parameters) : () );
2079 $c->log_request_uploads($request);
2082 =head2 $c->log_response
2084 Writes information about the response to the debug logs by calling
2085 C<< $c->log_response_status_line >> and C<< $c->log_response_headers >>.
2092 return unless $c->debug;
2094 my($dump) = grep {$_->[0] eq 'Response' } $c->dump_these;
2095 my $response = $dump->[1];
2097 $c->log_response_status_line($response);
2098 $c->log_response_headers($response->headers);
2101 =head2 $c->log_response_status_line($response)
2103 Writes one line of information about the response to the debug logs. This includes:
2107 =item * Response status code
2109 =item * Content-Type header (if present)
2111 =item * Content-Length header (if present)
2117 sub log_response_status_line {
2118 my ($c, $response) = @_;
2122 'Response Code: %s; Content-Type: %s; Content-Length: %s',
2123 $response->status || 'unknown',
2124 $response->headers->header('Content-Type') || 'unknown',
2125 $response->headers->header('Content-Length') || 'unknown'
2130 =head2 $c->log_response_headers($headers);
2132 Hook method which can be wrapped by plugins to log the responseheaders.
2133 No-op in the default implementation.
2137 sub log_response_headers {}
2139 =head2 $c->log_request_parameters( query => {}, body => {} )
2141 Logs request parameters to debug logs
2145 sub log_request_parameters {
2147 my %all_params = @_;
2149 return unless $c->debug;
2151 my $column_width = Catalyst::Utils::term_width() - 44;
2152 foreach my $type (qw(query body)) {
2153 my $params = $all_params{$type};
2154 next if ! keys %$params;
2155 my $t = Text::SimpleTable->new( [ 35, 'Parameter' ], [ $column_width, 'Value' ] );
2156 for my $key ( sort keys %$params ) {
2157 my $param = $params->{$key};
2158 my $value = defined($param) ? $param : '';
2159 $t->row( $key, ref $value eq 'ARRAY' ? ( join ', ', @$value ) : $value );
2161 $c->log->debug( ucfirst($type) . " Parameters are:\n" . $t->draw );
2165 =head2 $c->log_request_uploads
2167 Logs file uploads included in the request to the debug logs.
2168 The parameter name, filename, file type, and file size are all included in
2173 sub log_request_uploads {
2175 my $request = shift;
2176 return unless $c->debug;
2177 my $uploads = $request->uploads;
2178 if ( keys %$uploads ) {
2179 my $t = Text::SimpleTable->new(
2180 [ 12, 'Parameter' ],
2185 for my $key ( sort keys %$uploads ) {
2186 my $upload = $uploads->{$key};
2187 for my $u ( ref $upload eq 'ARRAY' ? @{$upload} : ($upload) ) {
2188 $t->row( $key, $u->filename, $u->type, $u->size );
2191 $c->log->debug( "File Uploads are:\n" . $t->draw );
2195 =head2 $c->log_request_headers($headers);
2197 Hook method which can be wrapped by plugins to log the request headers.
2198 No-op in the default implementation.
2202 sub log_request_headers {}
2204 =head2 $c->log_headers($type => $headers)
2206 Logs L<HTTP::Headers> (either request or response) to the debug logs.
2213 my $headers = shift; # an HTTP::Headers instance
2215 return unless $c->debug;
2217 my $column_width = Catalyst::Utils::term_width() - 28;
2218 my $t = Text::SimpleTable->new( [ 15, 'Header Name' ], [ $column_width, 'Value' ] );
2221 my ( $name, $value ) = @_;
2222 $t->row( $name, $value );
2225 $c->log->debug( ucfirst($type) . " Headers:\n" . $t->draw );
2229 =head2 $c->prepare_read
2231 Prepares the input for reading.
2235 sub prepare_read { my $c = shift; $c->engine->prepare_read( $c, @_ ) }
2237 =head2 $c->prepare_request
2239 Prepares the engine request.
2243 sub prepare_request { my $c = shift; $c->engine->prepare_request( $c, @_ ) }
2245 =head2 $c->prepare_uploads
2251 sub prepare_uploads {
2254 $c->engine->prepare_uploads( $c, @_ );
2257 =head2 $c->prepare_write
2259 Prepares the output for writing.
2263 sub prepare_write { my $c = shift; $c->engine->prepare_write( $c, @_ ) }
2265 =head2 $c->request_class
2267 Returns or sets the request class. Defaults to L<Catalyst::Request>.
2269 =head2 $c->response_class
2271 Returns or sets the response class. Defaults to L<Catalyst::Response>.
2273 =head2 $c->read( [$maxlength] )
2275 Reads a chunk of data from the request body. This method is designed to
2276 be used in a while loop, reading C<$maxlength> bytes on every call.
2277 C<$maxlength> defaults to the size of the request if not specified.
2279 You have to set C<< MyApp->config(parse_on_demand => 1) >> to use this
2282 Warning: If you use read(), Catalyst will not process the body,
2283 so you will not be able to access POST parameters or file uploads via
2284 $c->request. You must handle all body parsing yourself.
2288 sub read { my $c = shift; return $c->engine->read( $c, @_ ) }
2296 sub run { my $c = shift; return $c->engine->run( $c, @_ ) }
2298 =head2 $c->set_action( $action, $code, $namespace, $attrs )
2300 Sets an action in a given namespace.
2304 sub set_action { my $c = shift; $c->dispatcher->set_action( $c, @_ ) }
2306 =head2 $c->setup_actions($component)
2308 Sets up actions for a component.
2312 sub setup_actions { my $c = shift; $c->dispatcher->setup_actions( $c, @_ ) }
2314 =head2 $c->setup_config
2321 my %args = %{ $class->config || {} };
2323 my @container_classes = ( "${class}::Container", 'Catalyst::IOC::Container');
2324 unshift @container_classes, delete $args{container_class} if exists $args{container_class};
2326 my $container_class = Class::MOP::load_first_existing_class(@container_classes);
2328 my $container = $container_class->new( %args, name => "$class" );
2329 $class->container($container);
2331 my $config = $container->resolve(service => 'config');
2332 $class->config($config);
2333 $class->finalize_config; # back-compat
2336 =head2 $c->finalize_config
2340 sub finalize_config { }
2342 =head2 $c->setup_components
2344 This method is called internally to set up the application's components.
2346 It finds modules by calling the L<locate_components> method, expands them to
2347 package names with the L<expand_component_module> method, and then installs
2348 each component into the application.
2350 The C<setup_components> config option is passed to both of the above methods.
2352 Installation of each component is performed by the L<setup_component> method,
2357 sub setup_components {
2360 my $config = $class->config->{ setup_components };
2362 Catalyst::Exception->throw(
2363 qq{You are using search_extra config option. That option is\n} .
2364 qq{deprecated, please refer to the documentation for\n} .
2365 qq{other ways of achieving the same results.\n}
2366 ) if delete $config->{ search_extra };
2368 my @comps = $class->locate_components($config);
2369 my %comps = map { $_ => 1 } @comps;
2371 my $deprecatedcatalyst_component_names = grep { /::[CMV]::/ } @comps;
2372 $class->log->warn(qq{Your application is using the deprecated ::[MVC]:: type naming scheme.\n}.
2373 qq{Please switch your class names to ::Model::, ::View:: and ::Controller: as appropriate.\n}
2374 ) if $deprecatedcatalyst_component_names;
2376 for my $component ( @comps ) {
2378 # We pass ignore_loaded here so that overlay files for (e.g.)
2379 # Model::DBI::Schema sub-classes are loaded - if it's in @comps
2380 # we know M::P::O found a file on disk so this is safe
2382 Catalyst::Utils::ensure_class_loaded( $component, { ignore_loaded => 1 } );
2386 $containers->{$_} = $class->container->get_sub_container($_) for qw(model view controller);
2388 for my $component (@comps) {
2389 my $instance = $class->setup_component($component);
2390 if ( my ($type, $name) = _get_component_type_name($component) ) {
2391 $containers->{$type}->add_service(Catalyst::IOC::BlockInjection->new( name => $name, block => sub { return $instance } ));
2393 my @expanded_components = $instance->can('expand_modules')
2394 ? $instance->expand_modules( $component, $config )
2395 : $class->expand_component_module( $component, $config );
2396 for my $component (@expanded_components) {
2397 next if $comps{$component};
2399 $deprecatedcatalyst_component_names = grep { /::[CMV]::/ } @expanded_components;
2400 $class->log->warn(qq{Your application is using the deprecated ::[MVC]:: type naming scheme.\n}.
2401 qq{Please switch your class names to ::Model::, ::View:: and ::Controller: as appropriate.\n}
2402 ) if $deprecatedcatalyst_component_names;
2404 if (my ($type, $name) = _get_component_type_name($component)) {
2405 $containers->{$type}->add_service(Catalyst::IOC::BlockInjection->new( name => $name, block => sub { return $class->setup_component($component) } ));
2410 $containers->{model}->make_single_default;
2411 $containers->{view}->make_single_default;
2414 # FIXME: should this sub exist?
2415 # should it be moved to Catalyst::Utils,
2416 # or replaced by something already existing there?
2417 sub _get_component_type_name {
2418 my ( $component ) = @_;
2420 my @parts = split /::/, $component;
2422 while (my $type = shift @parts) {
2423 return ('controller', join '::', @parts)
2424 if $type =~ /^(c|controller)$/i;
2426 return ('model', join '::', @parts)
2427 if $type =~ /^(m|model)$/i;
2429 return ('view', join '::', @parts)
2430 if $type =~ /^(v|view)$/i;
2433 return (undef, $component);
2436 sub _get_component_type {
2437 my ( $instance ) = @_;
2439 return 'controller' if $instance->isa('Catalyst::Controller');
2440 return 'model' if $instance->isa('Catalyst::Model');
2441 return 'view' if $instance->isa('Catalyst::View');
2444 =head2 $c->locate_components( $setup_component_config )
2446 This method is meant to provide a list of component modules that should be
2447 setup for the application. By default, it will use L<Module::Pluggable>.
2449 Specify a C<setup_components> config option to pass additional options directly
2450 to L<Module::Pluggable>.
2454 sub locate_components {
2458 my @paths = qw( ::Controller ::C ::Model ::M ::View ::V );
2460 my $locator = Module::Pluggable::Object->new(
2461 search_path => [ map { s/^(?=::)/$class/; $_; } @paths ],
2465 # XXX think about ditching this sort entirely
2466 my @comps = sort { length $a <=> length $b } $locator->plugins;
2471 =head2 $c->expand_component_module( $component, $setup_component_config )
2473 Components found by C<locate_components> will be passed to this method, which
2474 is expected to return a list of component (package) names to be set up.
2478 sub expand_component_module {
2479 my ($class, $module) = @_;
2480 return Devel::InnerPackage::list_packages( $module );
2483 =head2 $c->setup_component
2487 ## FIXME - Why the hell do we try calling the ->COMPONENT method twice, this is madness!?!
2488 sub setup_component {
2489 my( $class, $component ) = @_;
2491 unless ( $component->can( 'COMPONENT' ) ) {
2495 my $suffix = Catalyst::Utils::class2classsuffix( $component );
2496 my $config = $class->config->{ $suffix } || {};
2497 # Stash catalyst_component_name in the config here, so that custom COMPONENT
2498 # methods also pass it. local to avoid pointlessly shitting in config
2499 # for the debug screen, as $component is already the key name.
2500 local $config->{catalyst_component_name} = $component;
2502 my $instance = eval { $component->COMPONENT( $class, $config ); };
2504 if ( my $error = $@ ) {
2506 Catalyst::Exception->throw(
2507 message => qq/Couldn't instantiate component "$component", "$error"/
2510 elsif (!blessed $instance) {
2511 my $metaclass = Moose::Util::find_meta($component);
2512 my $method_meta = $metaclass->find_method_by_name('COMPONENT');
2513 my $component_method_from = $method_meta->associated_metaclass->name;
2514 my $value = defined($instance) ? $instance : 'undef';
2515 Catalyst::Exception->throw(
2517 qq/Couldn't instantiate component "$component", COMPONENT() method (from $component_method_from) didn't return an object-like value (value was $value)./
2524 =head2 $c->setup_dispatcher
2530 sub setup_dispatcher {
2531 my ( $class, $dispatcher ) = @_;
2534 $dispatcher = 'Catalyst::Dispatcher::' . $dispatcher;
2537 if ( my $env = Catalyst::Utils::env_value( $class, 'DISPATCHER' ) ) {
2538 $dispatcher = 'Catalyst::Dispatcher::' . $env;
2541 unless ($dispatcher) {
2542 $dispatcher = $class->dispatcher_class;
2545 Class::MOP::load_class($dispatcher);
2547 # dispatcher instance
2548 $class->dispatcher( $dispatcher->new );
2551 =head2 $c->setup_engine
2558 my ( $class, $engine ) = @_;
2561 $engine = 'Catalyst::Engine::' . $engine;
2564 if ( my $env = Catalyst::Utils::env_value( $class, 'ENGINE' ) ) {
2565 $engine = 'Catalyst::Engine::' . $env;
2568 if ( $ENV{MOD_PERL} ) {
2569 my $meta = Class::MOP::get_metaclass_by_name($class);
2571 # create the apache method
2572 $meta->add_method('apache' => sub { shift->engine->apache });
2574 my ( $software, $version ) =
2575 $ENV{MOD_PERL} =~ /^(\S+)\/(\d+(?:[\.\_]\d+)+)/;
2578 $version =~ s/(\.[^.]+)\./$1/g;
2580 if ( $software eq 'mod_perl' ) {
2584 if ( $version >= 1.99922 ) {
2585 $engine = 'Catalyst::Engine::Apache2::MP20';
2588 elsif ( $version >= 1.9901 ) {
2589 $engine = 'Catalyst::Engine::Apache2::MP19';
2592 elsif ( $version >= 1.24 ) {
2593 $engine = 'Catalyst::Engine::Apache::MP13';
2597 Catalyst::Exception->throw( message =>
2598 qq/Unsupported mod_perl version: $ENV{MOD_PERL}/ );
2603 # install the correct mod_perl handler
2604 if ( $version >= 1.9901 ) {
2605 *handler = sub : method {
2606 shift->handle_request(@_);
2610 *handler = sub ($$) { shift->handle_request(@_) };
2615 elsif ( $software eq 'Zeus-Perl' ) {
2616 $engine = 'Catalyst::Engine::Zeus';
2620 Catalyst::Exception->throw(
2621 message => qq/Unsupported mod_perl: $ENV{MOD_PERL}/ );
2626 $engine = $class->engine_class;
2629 Class::MOP::load_class($engine);
2631 # check for old engines that are no longer compatible
2633 if ( $engine->isa('Catalyst::Engine::Apache')
2634 && !Catalyst::Engine::Apache->VERSION )
2639 elsif ( $engine->isa('Catalyst::Engine::Server::Base')
2640 && Catalyst::Engine::Server->VERSION le '0.02' )
2645 elsif ($engine->isa('Catalyst::Engine::HTTP::POE')
2646 && $engine->VERSION eq '0.01' )
2651 elsif ($engine->isa('Catalyst::Engine::Zeus')
2652 && $engine->VERSION eq '0.01' )
2658 Catalyst::Exception->throw( message =>
2659 qq/Engine "$engine" is not supported by this version of Catalyst/
2664 $class->engine( $engine->new );
2667 =head2 $c->setup_home
2669 Sets up the home directory.
2674 my ( $class, $home ) = @_;
2676 if ( my $env = Catalyst::Utils::env_value( $class, 'HOME' ) ) {
2680 $home ||= Catalyst::Utils::home($class);
2683 #I remember recently being scolded for assigning config values like this
2684 $class->config->{home} ||= $home;
2685 $class->config->{root} ||= Path::Class::Dir->new($home)->subdir('root');
2689 =head2 $c->setup_log
2691 Sets up log by instantiating a L<Catalyst::Log|Catalyst::Log> object and
2692 passing it to C<log()>. Pass in a comma-delimited list of levels to set the
2695 This method also installs a C<debug> method that returns a true value into the
2696 catalyst subclass if the "debug" level is passed in the comma-delimited list,
2697 or if the C<$CATALYST_DEBUG> environment variable is set to a true value.
2699 Note that if the log has already been setup, by either a previous call to
2700 C<setup_log> or by a call such as C<< __PACKAGE__->log( MyLogger->new ) >>,
2701 that this method won't actually set up the log object.
2706 my ( $class, $levels ) = @_;
2709 $levels =~ s/^\s+//;
2710 $levels =~ s/\s+$//;
2711 my %levels = map { $_ => 1 } split /\s*,\s*/, $levels;
2713 my $env_debug = Catalyst::Utils::env_value( $class, 'DEBUG' );
2714 if ( defined $env_debug ) {
2715 $levels{debug} = 1 if $env_debug; # Ugly!
2716 delete($levels{debug}) unless $env_debug;
2719 unless ( $class->log ) {
2720 $class->log( Catalyst::Log->new(keys %levels) );
2723 if ( $levels{debug} ) {
2724 Class::MOP::get_metaclass_by_name($class)->add_method('debug' => sub { 1 });
2725 $class->log->debug('Debug messages enabled');
2729 =head2 $c->setup_plugins
2735 =head2 $c->setup_stats
2737 Sets up timing statistics class.
2742 my ( $class, $stats ) = @_;
2744 Catalyst::Utils::ensure_class_loaded($class->stats_class);
2746 my $env = Catalyst::Utils::env_value( $class, 'STATS' );
2747 if ( defined($env) ? $env : ($stats || $class->debug ) ) {
2748 Class::MOP::get_metaclass_by_name($class)->add_method('use_stats' => sub { 1 });
2749 $class->log->debug('Statistics enabled');
2754 =head2 $c->registered_plugins
2756 Returns a sorted list of the plugins which have either been stated in the
2757 import list or which have been added via C<< MyApp->plugin(@args); >>.
2759 If passed a given plugin name, it will report a boolean value indicating
2760 whether or not that plugin is loaded. A fully qualified name is required if
2761 the plugin name does not begin with C<Catalyst::Plugin::>.
2763 if ($c->registered_plugins('Some::Plugin')) {
2771 sub registered_plugins {
2773 return sort keys %{ $proto->_plugins } unless @_;
2775 return 1 if exists $proto->_plugins->{$plugin};
2776 return exists $proto->_plugins->{"Catalyst::Plugin::$plugin"};
2779 sub _register_plugin {
2780 my ( $proto, $plugin, $instant ) = @_;
2781 my $class = ref $proto || $proto;
2783 Class::MOP::load_class( $plugin );
2784 $class->log->warn( "$plugin inherits from 'Catalyst::Component' - this is deprecated and will not work in 5.81" )
2785 if $plugin->isa( 'Catalyst::Component' );
2786 $proto->_plugins->{$plugin} = 1;
2788 my $meta = Class::MOP::get_metaclass_by_name($class);
2789 $meta->superclasses($plugin, $meta->superclasses);
2795 my ( $class, $plugins ) = @_;
2797 $class->_plugins( {} ) unless $class->_plugins;
2798 $plugins = Data::OptList::mkopt($plugins || []);
2801 [ Catalyst::Utils::resolve_namespace(
2802 $class . '::Plugin',
2803 'Catalyst::Plugin', $_->[0]
2809 for my $plugin ( reverse @plugins ) {
2810 Class::MOP::load_class($plugin->[0], $plugin->[1]);
2811 my $meta = find_meta($plugin->[0]);
2812 next if $meta && $meta->isa('Moose::Meta::Role');
2814 $class->_register_plugin($plugin->[0]);
2818 map { $_->[0]->name, $_->[1] }
2819 grep { blessed($_->[0]) && $_->[0]->isa('Moose::Meta::Role') }
2820 map { [find_meta($_->[0]), $_->[1]] }
2823 Moose::Util::apply_all_roles(
2831 Returns an arrayref of the internal execution stack (actions that are
2832 currently executing).
2836 Returns the current timing statistics object. By default Catalyst uses
2837 L<Catalyst::Stats|Catalyst::Stats>, but can be set otherwise with
2838 L<< stats_class|/"$c->stats_class" >>.
2840 Even if L<< -Stats|/"-Stats" >> is not enabled, the stats object is still
2841 available. By enabling it with C< $c->stats->enabled(1) >, it can be used to
2842 profile explicitly, although MyApp.pm still won't profile nor output anything
2845 =head2 $c->stats_class
2847 Returns or sets the stats (timing statistics) class. L<Catalyst::Stats|Catalyst::Stats> is used by default.
2849 =head2 $c->use_stats
2851 Returns 1 when L<< stats collection|/"-Stats" >> is enabled.
2853 Note that this is a static method, not an accessor and should be overridden
2854 by declaring C<sub use_stats { 1 }> in your MyApp.pm, not by calling C<< $c->use_stats(1) >>.
2861 =head2 $c->write( $data )
2863 Writes $data to the output stream. When using this method directly, you
2864 will need to manually set the C<Content-Length> header to the length of
2865 your output data, if known.
2872 # Finalize headers if someone manually writes output
2873 $c->finalize_headers;
2875 return $c->engine->write( $c, @_ );
2880 Returns the Catalyst version number. Mostly useful for "powered by"
2881 messages in template systems.
2885 sub version { return $Catalyst::VERSION }
2887 =head1 CONFIGURATION
2889 There are a number of 'base' config variables which can be set:
2895 C<default_model> - The default model picked if you say C<< $c->model >>. See L<< /$c->model($name) >>.
2899 C<default_view> - The default view to be rendered or returned when C<< $c->view >> is called. See L<< /$c->view($name) >>.
2903 C<home> - The application home directory. In an uninstalled application,
2904 this is the top level application directory. In an installed application,
2905 this will be the directory containing C<< MyApp.pm >>.
2909 C<ignore_frontend_proxy> - See L</PROXY SUPPORT>
2913 C<name> - The name of the application in debug messages and the debug and
2918 C<parse_on_demand> - The request body (for example file uploads) will not be parsed
2919 until it is accessed. This allows you to (for example) check authentication (and reject
2920 the upload) before actually recieving all the data. See L</ON-DEMAND PARSER>
2924 C<root> - The root directory for templates. Usually this is just a
2925 subdirectory of the home directory, but you can set it to change the
2926 templates to a different directory.
2930 C<show_internal_actions> - If true, causes internal actions such as C<< _DISPATCH >>
2931 to be shown in hit debug tables in the test server.
2935 C<use_request_uri_for_path> - Controlls if the C<REQUEST_URI> or C<PATH_INFO> environment
2936 variable should be used for determining the request path. See L<Catalyst::Engine::CGI/PATH DECODING>
2937 for more information.
2941 C<using_frontend_proxy> - See L</PROXY SUPPORT>.
2945 =head1 INTERNAL ACTIONS
2947 Catalyst uses internal actions like C<_DISPATCH>, C<_BEGIN>, C<_AUTO>,
2948 C<_ACTION>, and C<_END>. These are by default not shown in the private
2949 action table, but you can make them visible with a config parameter.
2951 MyApp->config(show_internal_actions => 1);
2953 =head1 ON-DEMAND PARSER
2955 The request body is usually parsed at the beginning of a request,
2956 but if you want to handle input yourself, you can enable on-demand
2957 parsing with a config parameter.
2959 MyApp->config(parse_on_demand => 1);
2961 =head1 PROXY SUPPORT
2963 Many production servers operate using the common double-server approach,
2964 with a lightweight frontend web server passing requests to a larger
2965 backend server. An application running on the backend server must deal
2966 with two problems: the remote user always appears to be C<127.0.0.1> and
2967 the server's hostname will appear to be C<localhost> regardless of the
2968 virtual host that the user connected through.
2970 Catalyst will automatically detect this situation when you are running
2971 the frontend and backend servers on the same machine. The following
2972 changes are made to the request.
2974 $c->req->address is set to the user's real IP address, as read from
2975 the HTTP X-Forwarded-For header.
2977 The host value for $c->req->base and $c->req->uri is set to the real
2978 host, as read from the HTTP X-Forwarded-Host header.
2980 Additionally, you may be running your backend application on an insecure
2981 connection (port 80) while your frontend proxy is running under SSL. If there
2982 is a discrepancy in the ports, use the HTTP header C<X-Forwarded-Port> to
2983 tell Catalyst what port the frontend listens on. This will allow all URIs to
2984 be created properly.
2986 In the case of passing in:
2988 X-Forwarded-Port: 443
2990 All calls to C<uri_for> will result in an https link, as is expected.
2992 Obviously, your web server must support these headers for this to work.
2994 In a more complex server farm environment where you may have your
2995 frontend proxy server(s) on different machines, you will need to set a
2996 configuration option to tell Catalyst to read the proxied data from the
2999 MyApp->config(using_frontend_proxy => 1);
3001 If you do not wish to use the proxy support at all, you may set:
3003 MyApp->config(ignore_frontend_proxy => 1);
3005 =head1 THREAD SAFETY
3007 Catalyst has been tested under Apache 2's threading C<mpm_worker>,
3008 C<mpm_winnt>, and the standalone forking HTTP server on Windows. We
3009 believe the Catalyst core to be thread-safe.
3011 If you plan to operate in a threaded environment, remember that all other
3012 modules you are using must also be thread-safe. Some modules, most notably
3013 L<DBD::SQLite>, are not thread-safe.
3019 Join #catalyst on irc.perl.org.
3023 http://lists.scsys.co.uk/cgi-bin/mailman/listinfo/catalyst
3024 http://lists.scsys.co.uk/cgi-bin/mailman/listinfo/catalyst-dev
3028 http://catalyst.perl.org
3032 http://dev.catalyst.perl.org
3036 =head2 L<Task::Catalyst> - All you need to start with Catalyst
3038 =head2 L<Catalyst::Manual> - The Catalyst Manual
3040 =head2 L<Catalyst::Component>, L<Catalyst::Controller> - Base classes for components
3042 =head2 L<Catalyst::Engine> - Core engine
3044 =head2 L<Catalyst::Log> - Log class.
3046 =head2 L<Catalyst::Request> - Request object
3048 =head2 L<Catalyst::Response> - Response object
3050 =head2 L<Catalyst::Test> - The test suite.
3052 =head1 PROJECT FOUNDER
3054 sri: Sebastian Riedel <sri@cpan.org>
3060 acme: Leon Brocard <leon@astray.com>
3062 abraxxa: Alexander Hartmaier <abraxxa@cpan.org>
3066 Andrew Ford E<lt>A.Ford@ford-mason.co.ukE<gt>
3072 andyg: Andy Grundman <andy@hybridized.org>
3074 audreyt: Audrey Tang
3076 bricas: Brian Cassidy <bricas@cpan.org>
3078 Caelum: Rafael Kitover <rkitover@io.com>
3080 chansen: Christian Hansen
3082 chicks: Christopher Hicks
3084 Chisel Wright C<pause@herlpacker.co.uk>
3086 Danijel Milicevic C<me@danijel.de>
3088 David Kamholz E<lt>dkamholz@cpan.orgE<gt>
3090 David Naughton, C<naughton@umn.edu>
3094 dhoss: Devin Austin <dhoss@cpan.org>
3096 dkubb: Dan Kubb <dan.kubb-cpan@onautopilot.com>
3100 dwc: Daniel Westermann-Clark <danieltwc@cpan.org>
3102 esskar: Sascha Kiefer
3104 fireartist: Carl Franks <cfranks@cpan.org>
3106 frew: Arthur Axel "fREW" Schmidt <frioux@gmail.com>
3108 gabb: Danijel Milicevic
3112 Gavin Henry C<ghenry@perl.me.uk>
3116 groditi: Guillermo Roditi <groditi@gmail.com>
3118 hobbs: Andrew Rodland <andrew@cleverdomain.org>
3120 ilmari: Dagfinn Ilmari Mannsåker <ilmari@ilmari.org>
3122 jcamacho: Juan Camacho
3124 jester: Jesse Sheidlower C<jester@panix.com>
3126 jhannah: Jay Hannah <jay@jays.net>
3132 jon: Jon Schutz <jjschutz@cpan.org>
3134 Jonathan Rockway C<< <jrockway@cpan.org> >>
3136 Kieren Diment C<kd@totaldatasolution.com>
3138 konobi: Scott McWhirter <konobi@cpan.org>
3140 marcus: Marcus Ramberg <mramberg@cpan.org>
3142 miyagawa: Tatsuhiko Miyagawa <miyagawa@bulknews.net>
3144 mst: Matt S. Trout <mst@shadowcatsystems.co.uk>
3148 naughton: David Naughton
3150 ningu: David Kamholz <dkamholz@cpan.org>
3152 nothingmuch: Yuval Kogman <nothingmuch@woobling.org>
3154 numa: Dan Sully <daniel@cpan.org>
3160 omega: Andreas Marienborg
3162 Oleg Kostyuk <cub.uanic@gmail.com>
3164 phaylon: Robert Sedlacek <phaylon@dunkelheit.at>
3166 rafl: Florian Ragwitz <rafl@debian.org>
3168 random: Roland Lammel <lammel@cpan.org>
3170 Robert Sedlacek C<< <rs@474.at> >>
3172 SpiceMan: Marcel Montes
3176 szbalint: Balint Szilakszi <szbalint@cpan.org>
3178 t0m: Tomas Doran <bobtfish@bobtfish.net>
3182 Viljo Marrandi C<vilts@yahoo.com>
3184 Will Hawes C<info@whawes.co.uk>
3186 willert: Sebastian Willert <willert@cpan.org>
3188 wreis: Wallace Reis <wallace@reis.org.br>
3190 Yuval Kogman, C<nothingmuch@woobling.org>
3192 rainboxx: Matthias Dietrich, C<perl@rainboxx.de>
3194 dd070: Dhaval Dhanani <dhaval070@gmail.com>
3198 Copyright (c) 2005, the above named PROJECT FOUNDER and CONTRIBUTORS.
3202 This library is free software. You can redistribute it and/or modify it under
3203 the same terms as Perl itself.
3209 __PACKAGE__->meta->make_immutable;