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 # list context for regexp searches
716 return @result if ref $component;
718 # only one component (if it's found) for string searches
719 return shift @result if @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
729 $c->log->warn('Component not found, returning the list of existing');
730 $c->log->warn('components. This behavior is deprecated and will be');
731 $c->log->warn('removed in a future release. Use $c->component_list');
732 $c->log->warn('instead.');
734 return $c->component_list;
737 =head2 $c->component_list
739 Returns the sorted list of the component names of the application.
743 sub component_list { sort keys %{ shift->components } }
745 =head2 CLASS DATA AND HELPER CLASSES
749 Returns or takes a hashref containing the application's configuration.
751 __PACKAGE__->config( { db => 'dsn:SQLite:foo.db' } );
753 You can also use a C<YAML>, C<XML> or L<Config::General> config file
754 like C<myapp.conf> in your applications home directory. See
755 L<Catalyst::Plugin::ConfigLoader>.
757 =head3 Cascading configuration
759 The config method is present on all Catalyst components, and configuration
760 will be merged when an application is started. Configuration loaded with
761 L<Catalyst::Plugin::ConfigLoader> takes precedence over other configuration,
762 followed by configuration in your top level C<MyApp> class. These two
763 configurations are merged, and then configuration data whose hash key matches a
764 component name is merged with configuration for that component.
766 The configuration for a component is then passed to the C<new> method when a
767 component is constructed.
771 MyApp->config({ 'Model::Foo' => { bar => 'baz', overrides => 'me' } });
772 MyApp::Model::Foo->config({ quux => 'frob', overrides => 'this' });
774 will mean that C<MyApp::Model::Foo> receives the following data when
777 MyApp::Model::Foo->new({
783 It's common practice to use a Moose attribute
784 on the receiving component to access the config value.
786 package MyApp::Model::Foo;
790 # this attr will receive 'baz' at construction time
796 You can then get the value 'baz' by calling $c->model('Foo')->bar
797 (or $self->bar inside code in the model).
799 B<NOTE:> you MUST NOT call C<< $self->config >> or C<< __PACKAGE__->config >>
800 as a way of reading config within your code, as this B<will not> give you the
801 correctly merged config back. You B<MUST> take the config values supplied to
802 the constructor and use those instead.
806 around config => sub {
810 croak('Setting config after setup has been run is not allowed.')
811 if ( @_ and $c->setup_finished );
818 Returns the logging object instance. Unless it is already set, Catalyst
819 sets this up with a L<Catalyst::Log> object. To use your own log class,
820 set the logger with the C<< __PACKAGE__->log >> method prior to calling
821 C<< __PACKAGE__->setup >>.
823 __PACKAGE__->log( MyLogger->new );
828 $c->log->info( 'Now logging with my own logger!' );
830 Your log class should implement the methods described in
836 Returns 1 if debug mode is enabled, 0 otherwise.
838 You can enable debug mode in several ways:
842 =item By calling myapp_server.pl with the -d flag
844 =item With the environment variables MYAPP_DEBUG, or CATALYST_DEBUG
846 =item The -Debug option in your MyApp.pm
848 =item By declaring C<sub debug { 1 }> in your MyApp.pm.
852 The first three also set the log level to 'debug'.
854 Calling C<< $c->debug(1) >> has no effect.
860 =head2 $c->dispatcher
862 Returns the dispatcher instance. See L<Catalyst::Dispatcher>.
866 Returns the engine instance. See L<Catalyst::Engine>.
869 =head2 UTILITY METHODS
871 =head2 $c->path_to(@path)
873 Merges C<@path> with C<< $c->config->{home} >> and returns a
874 L<Path::Class::Dir> object. Note you can usually use this object as
875 a filename, but sometimes you will have to explicitly stringify it
876 yourself by calling the C<< ->stringify >> method.
880 $c->path_to( 'db', 'sqlite.db' );
885 my ( $c, @path ) = @_;
886 my $path = Path::Class::Dir->new( $c->config->{home}, @path );
887 if ( -d $path ) { return $path }
888 else { return Path::Class::File->new( $c->config->{home}, @path ) }
891 =head2 $c->plugin( $name, $class, @args )
893 Helper method for plugins. It creates a class data accessor/mutator and
894 loads and instantiates the given class.
896 MyApp->plugin( 'prototype', 'HTML::Prototype' );
898 $c->prototype->define_javascript_functions;
900 B<Note:> This method of adding plugins is deprecated. The ability
901 to add plugins like this B<will be removed> in a Catalyst 5.81.
902 Please do not use this functionality in new code.
907 my ( $class, $name, $plugin, @args ) = @_;
909 # See block comment in t/aggregate/unit_core_plugin.t
910 $class->log->warn(qq/Adding plugin using the ->plugin method is deprecated, and will be removed in Catalyst 5.81/);
912 $class->_register_plugin( $plugin, 1 );
914 eval { $plugin->import };
915 $class->mk_classdata($name);
917 eval { $obj = $plugin->new(@args) };
920 Catalyst::Exception->throw( message =>
921 qq/Couldn't instantiate instant plugin "$plugin", "$@"/ );
925 $class->log->debug(qq/Initialized instant plugin "$plugin" as "$name"/)
931 Initializes the dispatcher and engine, loads any plugins, and loads the
932 model, view, and controller components. You may also specify an array
933 of plugins to load here, if you choose to not load them in the C<use
937 MyApp->setup( qw/-Debug/ );
942 my ( $class, @arguments ) = @_;
943 croak('Running setup more than once')
944 if ( $class->setup_finished );
946 unless ( $class->isa('Catalyst') ) {
948 Catalyst::Exception->throw(
949 message => qq/'$class' does not inherit from Catalyst/ );
952 if ( $class->arguments ) {
953 @arguments = ( @arguments, @{ $class->arguments } );
959 foreach (@arguments) {
963 ( $flags->{log} ) ? 'debug,' . $flags->{log} : 'debug';
965 elsif (/^-(\w+)=?(.*)$/) {
966 $flags->{ lc $1 } = $2;
969 push @{ $flags->{plugins} }, $_;
973 $class->setup_config();
974 $class->setup_home( delete $flags->{home} );
976 $class->setup_log( delete $flags->{log} );
977 $class->setup_plugins( delete $flags->{plugins} );
978 $class->setup_dispatcher( delete $flags->{dispatcher} );
979 $class->setup_engine( delete $flags->{engine} );
980 $class->setup_stats( delete $flags->{stats} );
982 for my $flag ( sort keys %{$flags} ) {
984 if ( my $code = $class->can( 'setup_' . $flag ) ) {
985 &$code( $class, delete $flags->{$flag} );
988 $class->log->warn(qq/Unknown flag "$flag"/);
992 eval { require Catalyst::Devel; };
993 if( !$@ && $ENV{CATALYST_SCRIPT_GEN} && ( $ENV{CATALYST_SCRIPT_GEN} < $Catalyst::Devel::CATALYST_SCRIPT_GEN ) ) {
994 $class->log->warn(<<"EOF");
995 You are running an old script!
997 Please update by running (this will overwrite existing files):
998 catalyst.pl -force -scripts $class
1000 or (this will not overwrite existing files):
1001 catalyst.pl -scripts $class
1006 if ( $class->debug ) {
1007 my @plugins = map { "$_ " . ( $_->VERSION || '' ) } $class->registered_plugins;
1010 my $column_width = Catalyst::Utils::term_width() - 6;
1011 my $t = Text::SimpleTable->new($column_width);
1012 $t->row($_) for @plugins;
1013 $class->log->debug( "Loaded plugins:\n" . $t->draw . "\n" );
1016 my $dispatcher = $class->dispatcher;
1017 my $engine = $class->engine;
1018 my $home = $class->config->{home};
1020 $class->log->debug(sprintf(q/Loaded dispatcher "%s"/, blessed($dispatcher)));
1021 $class->log->debug(sprintf(q/Loaded engine "%s"/, blessed($engine)));
1025 ? $class->log->debug(qq/Found home "$home"/)
1026 : $class->log->debug(qq/Home "$home" doesn't exist/)
1027 : $class->log->debug(q/Couldn't find home/);
1030 # Call plugins setup, this is stupid and evil.
1031 # Also screws C3 badly on 5.10, hack to avoid.
1033 no warnings qw/redefine/;
1034 local *setup = sub { };
1035 $class->setup unless $Catalyst::__AM_RESTARTING;
1038 $class->setup_components;
1040 if ( $class->debug ) { # XXX - Fixme to be a method on the container? (Or at least get a) data structure back from the container!!
1041 my $column_width = Catalyst::Utils::term_width() - 8 - 9;
1042 my $t = Text::SimpleTable->new( [ $column_width, 'Class' ], [ 8, 'Type' ] );
1043 for my $comp ( sort keys %{ $class->components } ) {
1044 my $type = ref $class->components->{$comp} ? 'instance' : 'class';
1045 $t->row( $comp, $type );
1047 $class->log->debug( "Loaded components:\n" . $t->draw . "\n" )
1048 if ( keys %{ $class->components } );
1051 $class->setup_actions;
1053 if ( $class->debug ) {
1054 my $name = $class->config->{name} || 'Application';
1055 $class->log->info("$name powered by Catalyst $Catalyst::VERSION");
1058 # Make sure that the application class becomes immutable at this point,
1059 B::Hooks::EndOfScope::on_scope_end {
1061 my $meta = Class::MOP::get_metaclass_by_name($class);
1064 && ! { $meta->immutable_options }->{replace_constructor}
1066 $class->isa('Class::Accessor::Fast')
1067 || $class->isa('Class::Accessor')
1070 warn "You made your application class ($class) immutable, "
1071 . "but did not inline the\nconstructor. "
1072 . "This will break catalyst, as your app \@ISA "
1073 . "Class::Accessor(::Fast)?\nPlease pass "
1074 . "(replace_constructor => 1)\nwhen making your class immutable.\n";
1076 $meta->make_immutable(
1077 replace_constructor => 1,
1078 ) unless $meta->is_immutable;
1081 if ($class->config->{case_sensitive}) {
1082 $class->log->warn($class . "->config->{case_sensitive} is set.");
1083 $class->log->warn("This setting is deprecated and planned to be removed in Catalyst 5.81.");
1086 $class->setup_finalize;
1087 # Should be the last thing we do so that user things hooking
1088 # setup_finalize can log..
1089 $class->log->_flush() if $class->log->can('_flush');
1090 return 1; # Explicit return true as people have __PACKAGE__->setup as the last thing in their class. HATE.
1093 =head2 $app->setup_finalize
1095 A hook to attach modifiers to. This method does not do anything except set the
1096 C<setup_finished> accessor.
1098 Applying method modifiers to the C<setup> method doesn't work, because of quirky things done for plugin setup.
1102 after setup_finalize => sub {
1110 sub setup_finalize {
1112 $class->setup_finished(1);
1115 =head2 $c->uri_for( $path?, @args?, \%query_values? )
1117 =head2 $c->uri_for( $action, \@captures?, @args?, \%query_values? )
1119 Constructs an absolute L<URI> object based on the application root, the
1120 provided path, and the additional arguments and query parameters provided.
1121 When used as a string, provides a textual URI. If you need more flexibility
1122 than this (i.e. the option to provide relative URIs etc.) see
1123 L<Catalyst::Plugin::SmartURI>.
1125 If no arguments are provided, the URI for the current action is returned.
1126 To return the current action and also provide @args, use
1127 C<< $c->uri_for( $c->action, @args ) >>.
1129 If the first argument is a string, it is taken as a public URI path relative
1130 to C<< $c->namespace >> (if it doesn't begin with a forward slash) or
1131 relative to the application root (if it does). It is then merged with
1132 C<< $c->request->base >>; any C<@args> are appended as additional path
1133 components; and any C<%query_values> are appended as C<?foo=bar> parameters.
1135 If the first argument is a L<Catalyst::Action> it represents an action which
1136 will have its path resolved using C<< $c->dispatcher->uri_for_action >>. The
1137 optional C<\@captures> argument (an arrayref) allows passing the captured
1138 variables that are needed to fill in the paths of Chained and Regex actions;
1139 once the path is resolved, C<uri_for> continues as though a path was
1140 provided, appending any arguments or parameters and creating an absolute
1143 The captures for the current request can be found in
1144 C<< $c->request->captures >>, and actions can be resolved using
1145 C<< Catalyst::Controller->action_for($name) >>. If you have a private action
1146 path, use C<< $c->uri_for_action >> instead.
1148 # Equivalent to $c->req->uri
1149 $c->uri_for($c->action, $c->req->captures,
1150 @{ $c->req->args }, $c->req->params);
1152 # For the Foo action in the Bar controller
1153 $c->uri_for($c->controller('Bar')->action_for('Foo'));
1155 # Path to a static resource
1156 $c->uri_for('/static/images/logo.png');
1161 my ( $c, $path, @args ) = @_;
1163 if (blessed($path) && $path->isa('Catalyst::Controller')) {
1164 $path = $path->path_prefix;
1169 undef($path) if (defined $path && $path eq '');
1172 ( scalar @args && ref $args[$#args] eq 'HASH' ? pop @args : {} );
1174 carp "uri_for called with undef argument" if grep { ! defined $_ } @args;
1175 foreach my $arg (@args) {
1176 utf8::encode($arg) if utf8::is_utf8($arg);
1177 $arg =~ s/([^$URI::uric])/$URI::Escape::escapes{$1}/go;
1180 if ( blessed($path) ) { # action object
1181 s|/|%2F|g for @args;
1182 my $captures = [ map { s|/|%2F|g; $_; }
1183 ( scalar @args && ref $args[0] eq 'ARRAY'
1187 foreach my $capture (@$captures) {
1188 utf8::encode($capture) if utf8::is_utf8($capture);
1189 $capture =~ s/([^$URI::uric])/$URI::Escape::escapes{$1}/go;
1193 $path = $c->dispatcher->uri_for_action($action, $captures);
1194 if (not defined $path) {
1195 $c->log->debug(qq/Can't find uri_for action '$action' @$captures/)
1199 $path = '/' if $path eq '';
1202 unshift(@args, $path);
1204 unless (defined $path && $path =~ s!^/!!) { # in-place strip
1205 my $namespace = $c->namespace;
1206 if (defined $path) { # cheesy hack to handle path '../foo'
1207 $namespace =~ s{(?:^|/)[^/]+$}{} while $args[0] =~ s{^\.\./}{};
1209 unshift(@args, $namespace || '');
1212 # join args with '/', or a blank string
1213 my $args = join('/', grep { defined($_) } @args);
1214 $args =~ s/\?/%3F/g; # STUPID STUPID SPECIAL CASE
1216 my $base = $c->req->base;
1217 my $class = ref($base);
1218 $base =~ s{(?<!/)$}{/};
1222 if (my @keys = keys %$params) {
1223 # somewhat lifted from URI::_query's query_form
1224 $query = '?'.join('&', map {
1225 my $val = $params->{$_};
1226 s/([;\/?:@&=+,\$\[\]%])/$URI::Escape::escapes{$1}/go;
1229 $val = '' unless defined $val;
1232 utf8::encode( $param ) if utf8::is_utf8($param);
1233 # using the URI::Escape pattern here so utf8 chars survive
1234 $param =~ s/([^A-Za-z0-9\-_.!~*'() ])/$URI::Escape::escapes{$1}/go;
1236 "${key}=$param"; } ( ref $val eq 'ARRAY' ? @$val : $val ));
1240 my $res = bless(\"${base}${args}${query}", $class);
1244 =head2 $c->uri_for_action( $path, \@captures?, @args?, \%query_values? )
1246 =head2 $c->uri_for_action( $action, \@captures?, @args?, \%query_values? )
1252 A private path to the Catalyst action you want to create a URI for.
1254 This is a shortcut for calling C<< $c->dispatcher->get_action_by_path($path)
1255 >> and passing the resulting C<$action> and the remaining arguments to C<<
1258 You can also pass in a Catalyst::Action object, in which case it is passed to
1261 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.
1263 For example, if the action looks like:
1265 package MyApp::Controller::Users;
1267 sub lst : Path('the-list') {}
1271 $c->uri_for_action('/users/lst')
1273 and it will create the URI /users/the-list.
1279 sub uri_for_action {
1280 my ( $c, $path, @args ) = @_;
1281 my $action = blessed($path)
1283 : $c->dispatcher->get_action_by_path($path);
1284 unless (defined $action) {
1285 croak "Can't find action for path '$path'";
1287 return $c->uri_for( $action, @args );
1290 =head2 $c->welcome_message
1292 Returns the Catalyst welcome HTML page.
1296 sub welcome_message {
1298 my $name = $c->config->{name};
1299 my $logo = $c->uri_for('/static/images/catalyst_logo.png');
1300 my $prefix = Catalyst::Utils::appprefix( ref $c );
1301 $c->response->content_type('text/html; charset=utf-8');
1303 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
1304 "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
1305 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
1307 <meta http-equiv="Content-Language" content="en" />
1308 <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
1309 <title>$name on Catalyst $VERSION</title>
1310 <style type="text/css">
1313 background-color: #eee;
1320 margin-bottom: 10px;
1322 background-color: #ccc;
1323 border: 1px solid #aaa;
1328 font-family: verdana, tahoma, sans-serif;
1331 font-family: verdana, tahoma, sans-serif;
1334 text-decoration: none;
1336 border-bottom: 1px dotted #bbb;
1338 :link:hover, :visited:hover {
1351 background-color: #fff;
1352 border: 1px solid #aaa;
1356 font-weight: normal;
1378 <h1><span id="appname">$name</span> on <a href="http://catalyst.perl.org">Catalyst</a>
1383 <img src="$logo" alt="Catalyst Logo" />
1385 <p>Welcome to the world of Catalyst.
1386 This <a href="http://en.wikipedia.org/wiki/MVC">MVC</a>
1387 framework will make web development something you had
1388 never expected it to be: Fun, rewarding, and quick.</p>
1389 <h2>What to do now?</h2>
1390 <p>That really depends on what <b>you</b> want to do.
1391 We do, however, provide you with a few starting points.</p>
1392 <p>If you want to jump right into web development with Catalyst
1393 you might want to start with a tutorial.</p>
1394 <pre>perldoc <a href="http://cpansearch.perl.org/dist/Catalyst-Manual/lib/Catalyst/Manual/Tutorial.pod">Catalyst::Manual::Tutorial</a></code>
1396 <p>Afterwards you can go on to check out a more complete look at our features.</p>
1398 <code>perldoc <a href="http://cpansearch.perl.org/dist/Catalyst-Manual/lib/Catalyst/Manual/Intro.pod">Catalyst::Manual::Intro</a>
1399 <!-- Something else should go here, but the Catalyst::Manual link seems unhelpful -->
1401 <h2>What to do next?</h2>
1402 <p>Next it's time to write an actual application. Use the
1403 helper scripts to generate <a href="http://cpansearch.perl.org/search?query=Catalyst%3A%3AController%3A%3A&mode=all">controllers</a>,
1404 <a href="http://cpansearch.perl.org/search?query=Catalyst%3A%3AModel%3A%3A&mode=all">models</a>, and
1405 <a href="http://cpansearch.perl.org/search?query=Catalyst%3A%3AView%3A%3A&mode=all">views</a>;
1406 they can save you a lot of work.</p>
1407 <pre><code>script/${prefix}_create.pl --help</code></pre>
1408 <p>Also, be sure to check out the vast and growing
1409 collection of <a href="http://search.cpan.org/search?query=Catalyst">plugins for Catalyst on CPAN</a>;
1410 you are likely to find what you need there.
1414 <p>Catalyst has a very active community. Here are the main places to
1415 get in touch with us.</p>
1418 <a href="http://dev.catalyst.perl.org">Wiki</a>
1421 <a href="http://lists.scsys.co.uk/cgi-bin/mailman/listinfo/catalyst">Mailing-List</a>
1424 <a href="irc://irc.perl.org/catalyst">IRC channel #catalyst on irc.perl.org</a>
1427 <h2>In conclusion</h2>
1428 <p>The Catalyst team hopes you will enjoy using Catalyst as much
1429 as we enjoyed making it. Please contact us if you have ideas
1430 for improvement or other feedback.</p>
1438 =head1 INTERNAL METHODS
1440 These methods are not meant to be used by end users.
1442 =head2 $c->components
1444 Returns a hash of components.
1449 my ( $class, $comps ) = @_;
1451 # FIXME: should this ugly kludge exist?
1452 $class->setup_config unless defined $class->container;
1455 $containers->{$_} = $class->container->get_sub_container($_) for qw(model view controller);
1458 for my $component ( keys %$comps ) {
1459 my ($type, $name) = _get_component_type_name($component);
1461 $containers->{$type}->add_service(Catalyst::IOC::BlockInjection->new( name => $name, block => sub { return $class->setup_component($component) } ));
1466 for my $container (keys %$containers) {
1467 my @service_list = $containers->{$container}->get_service_list;
1468 for my $component (@service_list) {
1469 $components{$component} =
1470 $containers->{$container}->resolve(service => $component);
1474 return lock_hash %components;
1477 =head2 $c->context_class
1479 Returns or sets the context class.
1483 Returns a hashref containing coderefs and execution counts (needed for
1484 deep recursion detection).
1488 Returns the number of actions on the current internal execution stack.
1492 Dispatches a request to actions.
1496 sub dispatch { my $c = shift; $c->dispatcher->dispatch( $c, @_ ) }
1498 =head2 $c->dispatcher_class
1500 Returns or sets the dispatcher class.
1502 =head2 $c->dump_these
1504 Returns a list of 2-element array references (name, structure) pairs
1505 that will be dumped on the error page in debug mode.
1511 [ Request => $c->req ],
1512 [ Response => $c->res ],
1513 [ Stash => $c->stash ],
1514 [ Config => $c->config ];
1517 =head2 $c->engine_class
1519 Returns or sets the engine class.
1521 =head2 $c->execute( $class, $coderef )
1523 Execute a coderef in given class and catch exceptions. Errors are available
1529 my ( $c, $class, $code ) = @_;
1530 $class = $c->component($class) || $class;
1533 if ( $c->depth >= $RECURSION ) {
1534 my $action = $code->reverse();
1535 $action = "/$action" unless $action =~ /->/;
1536 my $error = qq/Deep recursion detected calling "${action}"/;
1537 $c->log->error($error);
1543 my $stats_info = $c->_stats_start_execute( $code ) if $c->use_stats;
1545 push( @{ $c->stack }, $code );
1547 no warnings 'recursion';
1548 # N.B. This used to be combined, but I have seen $c get clobbered if so, and
1549 # I have no idea how, ergo $ret (which appears to fix the issue)
1550 eval { my $ret = $code->execute( $class, $c, @{ $c->req->args } ) || 0; $c->state( $ret ) };
1552 $c->_stats_finish_execute( $stats_info ) if $c->use_stats and $stats_info;
1554 my $last = pop( @{ $c->stack } );
1556 if ( my $error = $@ ) {
1557 if ( blessed($error) and $error->isa('Catalyst::Exception::Detach') ) {
1558 $error->rethrow if $c->depth > 1;
1560 elsif ( blessed($error) and $error->isa('Catalyst::Exception::Go') ) {
1561 $error->rethrow if $c->depth > 0;
1564 unless ( ref $error ) {
1565 no warnings 'uninitialized';
1567 my $class = $last->class;
1568 my $name = $last->name;
1569 $error = qq/Caught exception in $class->$name "$error"/;
1578 sub _stats_start_execute {
1579 my ( $c, $code ) = @_;
1580 my $appclass = ref($c) || $c;
1581 return if ( ( $code->name =~ /^_.*/ )
1582 && ( !$appclass->config->{show_internal_actions} ) );
1584 my $action_name = $code->reverse();
1585 $c->counter->{$action_name}++;
1587 my $action = $action_name;
1588 $action = "/$action" unless $action =~ /->/;
1590 # determine if the call was the result of a forward
1591 # this is done by walking up the call stack and looking for a calling
1592 # sub of Catalyst::forward before the eval
1594 for my $index ( 2 .. 11 ) {
1596 if ( ( caller($index) )[0] eq 'Catalyst'
1597 && ( caller($index) )[3] eq '(eval)' );
1599 if ( ( caller($index) )[3] =~ /forward$/ ) {
1600 $callsub = ( caller($index) )[3];
1601 $action = "-> $action";
1606 my $uid = $action_name . $c->counter->{$action_name};
1608 # is this a root-level call or a forwarded call?
1609 if ( $callsub =~ /forward$/ ) {
1610 my $parent = $c->stack->[-1];
1612 # forward, locate the caller
1613 if ( defined $parent && exists $c->counter->{"$parent"} ) {
1616 parent => "$parent" . $c->counter->{"$parent"},
1622 # forward with no caller may come from a plugin
1641 sub _stats_finish_execute {
1642 my ( $c, $info ) = @_;
1643 $c->stats->profile( end => $info );
1648 Finalizes the request.
1655 for my $error ( @{ $c->error } ) {
1656 $c->log->error($error);
1659 # Allow engine to handle finalize flow (for POE)
1660 my $engine = $c->engine;
1661 if ( my $code = $engine->can('finalize') ) {
1666 $c->finalize_uploads;
1669 if ( $#{ $c->error } >= 0 ) {
1673 $c->finalize_headers;
1676 if ( $c->request->method eq 'HEAD' ) {
1677 $c->response->body('');
1685 if ($c->use_stats) {
1686 my $elapsed = sprintf '%f', $c->stats->elapsed;
1687 my $av = $elapsed == 0 ? '??' : sprintf '%.3f', 1 / $elapsed;
1689 "Request took ${elapsed}s ($av/s)\n" . $c->stats->report . "\n" );
1692 return $c->response->status;
1695 =head2 $c->finalize_body
1701 sub finalize_body { my $c = shift; $c->engine->finalize_body( $c, @_ ) }
1703 =head2 $c->finalize_cookies
1709 sub finalize_cookies { my $c = shift; $c->engine->finalize_cookies( $c, @_ ) }
1711 =head2 $c->finalize_error
1717 sub finalize_error { my $c = shift; $c->engine->finalize_error( $c, @_ ) }
1719 =head2 $c->finalize_headers
1725 sub finalize_headers {
1728 my $response = $c->response; #accessor calls can add up?
1730 # Check if we already finalized headers
1731 return if $response->finalized_headers;
1734 if ( my $location = $response->redirect ) {
1735 $c->log->debug(qq/Redirecting to "$location"/) if $c->debug;
1736 $response->header( Location => $location );
1738 if ( !$response->has_body ) {
1739 # Add a default body if none is already present
1741 qq{<html><body><p>This item has moved <a href="$location">here</a>.</p></body></html>}
1747 if ( defined $response->body && length $response->body && !$response->content_length ) {
1749 # get the length from a filehandle
1750 if ( blessed( $response->body ) && $response->body->can('read') || ref( $response->body ) eq 'GLOB' )
1752 my $stat = stat $response->body;
1753 if ( $stat && $stat->size > 0 ) {
1754 $response->content_length( $stat->size );
1757 $c->log->warn('Serving filehandle without a content-length');
1761 # everything should be bytes at this point, but just in case
1762 $response->content_length( length( $response->body ) );
1767 if ( $response->status =~ /^(1\d\d|[23]04)$/ ) {
1768 $response->headers->remove_header("Content-Length");
1769 $response->body('');
1772 $c->finalize_cookies;
1774 $c->engine->finalize_headers( $c, @_ );
1777 $response->finalized_headers(1);
1780 =head2 $c->finalize_output
1782 An alias for finalize_body.
1784 =head2 $c->finalize_read
1786 Finalizes the input after reading is complete.
1790 sub finalize_read { my $c = shift; $c->engine->finalize_read( $c, @_ ) }
1792 =head2 $c->finalize_uploads
1794 Finalizes uploads. Cleans up any temporary files.
1798 sub finalize_uploads { my $c = shift; $c->engine->finalize_uploads( $c, @_ ) }
1800 =head2 $c->get_action( $action, $namespace )
1802 Gets an action in a given namespace.
1806 sub get_action { my $c = shift; $c->dispatcher->get_action(@_) }
1808 =head2 $c->get_actions( $action, $namespace )
1810 Gets all actions of a given name in a namespace and all parent
1815 sub get_actions { my $c = shift; $c->dispatcher->get_actions( $c, @_ ) }
1817 =head2 $app->handle_request( @arguments )
1819 Called to handle each HTTP request.
1823 sub handle_request {
1824 my ( $class, @arguments ) = @_;
1826 # Always expect worst case!
1829 if ($class->debug) {
1830 my $secs = time - $START || 1;
1831 my $av = sprintf '%.3f', $COUNT / $secs;
1832 my $time = localtime time;
1833 $class->log->info("*** Request $COUNT ($av/s) [$$] [$time] ***");
1836 my $c = $class->prepare(@arguments);
1838 $status = $c->finalize;
1841 if ( my $error = $@ ) {
1843 $class->log->error(qq/Caught exception in engine "$error"/);
1848 if(my $coderef = $class->log->can('_flush')){
1849 $class->log->$coderef();
1854 =head2 $c->prepare( @arguments )
1856 Creates a Catalyst context from an engine-specific request (Apache, CGI,
1862 my ( $class, @arguments ) = @_;
1865 # After the app/ctxt split, this should become an attribute based on something passed
1866 # into the application.
1867 $class->context_class( ref $class || $class ) unless $class->context_class;
1869 my $c = $class->context_class->new({});
1871 # For on-demand data
1872 $c->request->_context($c);
1873 $c->response->_context($c);
1875 #surely this is not the most efficient way to do things...
1876 $c->stats($class->stats_class->new)->enable($c->use_stats);
1877 if ( $c->debug || $c->config->{enable_catalyst_header} ) {
1878 $c->res->headers->header( 'X-Catalyst' => $Catalyst::VERSION );
1881 #XXX reuse coderef from can
1882 # Allow engine to direct the prepare flow (for POE)
1883 if ( $c->engine->can('prepare') ) {
1884 $c->engine->prepare( $c, @arguments );
1887 $c->prepare_request(@arguments);
1888 $c->prepare_connection;
1889 $c->prepare_query_parameters;
1890 $c->prepare_headers;
1891 $c->prepare_cookies;
1894 # Prepare the body for reading, either by prepare_body
1895 # or the user, if they are using $c->read
1898 # Parse the body unless the user wants it on-demand
1899 unless ( ref($c)->config->{parse_on_demand} ) {
1904 my $method = $c->req->method || '';
1905 my $path = $c->req->path;
1906 $path = '/' unless length $path;
1907 my $address = $c->req->address || '';
1916 =head2 $c->prepare_action
1918 Prepares action. See L<Catalyst::Dispatcher>.
1922 sub prepare_action { my $c = shift; $c->dispatcher->prepare_action( $c, @_ ) }
1924 =head2 $c->prepare_body
1926 Prepares message body.
1933 return if $c->request->_has_body;
1935 # Initialize on-demand data
1936 $c->engine->prepare_body( $c, @_ );
1937 $c->prepare_parameters;
1938 $c->prepare_uploads;
1941 =head2 $c->prepare_body_chunk( $chunk )
1943 Prepares a chunk of data before sending it to L<HTTP::Body>.
1945 See L<Catalyst::Engine>.
1949 sub prepare_body_chunk {
1951 $c->engine->prepare_body_chunk( $c, @_ );
1954 =head2 $c->prepare_body_parameters
1956 Prepares body parameters.
1960 sub prepare_body_parameters {
1962 $c->engine->prepare_body_parameters( $c, @_ );
1965 =head2 $c->prepare_connection
1967 Prepares connection.
1971 sub prepare_connection {
1973 $c->engine->prepare_connection( $c, @_ );
1976 =head2 $c->prepare_cookies
1982 sub prepare_cookies { my $c = shift; $c->engine->prepare_cookies( $c, @_ ) }
1984 =head2 $c->prepare_headers
1990 sub prepare_headers { my $c = shift; $c->engine->prepare_headers( $c, @_ ) }
1992 =head2 $c->prepare_parameters
1994 Prepares parameters.
1998 sub prepare_parameters {
2000 $c->prepare_body_parameters;
2001 $c->engine->prepare_parameters( $c, @_ );
2004 =head2 $c->prepare_path
2006 Prepares path and base.
2010 sub prepare_path { my $c = shift; $c->engine->prepare_path( $c, @_ ) }
2012 =head2 $c->prepare_query_parameters
2014 Prepares query parameters.
2018 sub prepare_query_parameters {
2021 $c->engine->prepare_query_parameters( $c, @_ );
2024 =head2 $c->log_request
2026 Writes information about the request to the debug logs. This includes:
2030 =item * Request method, path, and remote IP address
2032 =item * Query keywords (see L<Catalyst::Request/query_keywords>)
2034 =item * Request parameters
2036 =item * File uploads
2045 return unless $c->debug;
2047 my($dump) = grep {$_->[0] eq 'Request' } $c->dump_these;
2048 my $request = $dump->[1];
2050 my ( $method, $path, $address ) = ( $request->method, $request->path, $request->address );
2052 $path = '/' unless length $path;
2054 $c->log->debug(qq/"$method" request for "$path" from "$address"/);
2056 $c->log_request_headers($request->headers);
2058 if ( my $keywords = $request->query_keywords ) {
2059 $c->log->debug("Query keywords are: $keywords");
2062 $c->log_request_parameters( query => $request->query_parameters, $request->_has_body ? (body => $request->body_parameters) : () );
2064 $c->log_request_uploads($request);
2067 =head2 $c->log_response
2069 Writes information about the response to the debug logs by calling
2070 C<< $c->log_response_status_line >> and C<< $c->log_response_headers >>.
2077 return unless $c->debug;
2079 my($dump) = grep {$_->[0] eq 'Response' } $c->dump_these;
2080 my $response = $dump->[1];
2082 $c->log_response_status_line($response);
2083 $c->log_response_headers($response->headers);
2086 =head2 $c->log_response_status_line($response)
2088 Writes one line of information about the response to the debug logs. This includes:
2092 =item * Response status code
2094 =item * Content-Type header (if present)
2096 =item * Content-Length header (if present)
2102 sub log_response_status_line {
2103 my ($c, $response) = @_;
2107 'Response Code: %s; Content-Type: %s; Content-Length: %s',
2108 $response->status || 'unknown',
2109 $response->headers->header('Content-Type') || 'unknown',
2110 $response->headers->header('Content-Length') || 'unknown'
2115 =head2 $c->log_response_headers($headers);
2117 Hook method which can be wrapped by plugins to log the responseheaders.
2118 No-op in the default implementation.
2122 sub log_response_headers {}
2124 =head2 $c->log_request_parameters( query => {}, body => {} )
2126 Logs request parameters to debug logs
2130 sub log_request_parameters {
2132 my %all_params = @_;
2134 return unless $c->debug;
2136 my $column_width = Catalyst::Utils::term_width() - 44;
2137 foreach my $type (qw(query body)) {
2138 my $params = $all_params{$type};
2139 next if ! keys %$params;
2140 my $t = Text::SimpleTable->new( [ 35, 'Parameter' ], [ $column_width, 'Value' ] );
2141 for my $key ( sort keys %$params ) {
2142 my $param = $params->{$key};
2143 my $value = defined($param) ? $param : '';
2144 $t->row( $key, ref $value eq 'ARRAY' ? ( join ', ', @$value ) : $value );
2146 $c->log->debug( ucfirst($type) . " Parameters are:\n" . $t->draw );
2150 =head2 $c->log_request_uploads
2152 Logs file uploads included in the request to the debug logs.
2153 The parameter name, filename, file type, and file size are all included in
2158 sub log_request_uploads {
2160 my $request = shift;
2161 return unless $c->debug;
2162 my $uploads = $request->uploads;
2163 if ( keys %$uploads ) {
2164 my $t = Text::SimpleTable->new(
2165 [ 12, 'Parameter' ],
2170 for my $key ( sort keys %$uploads ) {
2171 my $upload = $uploads->{$key};
2172 for my $u ( ref $upload eq 'ARRAY' ? @{$upload} : ($upload) ) {
2173 $t->row( $key, $u->filename, $u->type, $u->size );
2176 $c->log->debug( "File Uploads are:\n" . $t->draw );
2180 =head2 $c->log_request_headers($headers);
2182 Hook method which can be wrapped by plugins to log the request headers.
2183 No-op in the default implementation.
2187 sub log_request_headers {}
2189 =head2 $c->log_headers($type => $headers)
2191 Logs L<HTTP::Headers> (either request or response) to the debug logs.
2198 my $headers = shift; # an HTTP::Headers instance
2200 return unless $c->debug;
2202 my $column_width = Catalyst::Utils::term_width() - 28;
2203 my $t = Text::SimpleTable->new( [ 15, 'Header Name' ], [ $column_width, 'Value' ] );
2206 my ( $name, $value ) = @_;
2207 $t->row( $name, $value );
2210 $c->log->debug( ucfirst($type) . " Headers:\n" . $t->draw );
2214 =head2 $c->prepare_read
2216 Prepares the input for reading.
2220 sub prepare_read { my $c = shift; $c->engine->prepare_read( $c, @_ ) }
2222 =head2 $c->prepare_request
2224 Prepares the engine request.
2228 sub prepare_request { my $c = shift; $c->engine->prepare_request( $c, @_ ) }
2230 =head2 $c->prepare_uploads
2236 sub prepare_uploads {
2239 $c->engine->prepare_uploads( $c, @_ );
2242 =head2 $c->prepare_write
2244 Prepares the output for writing.
2248 sub prepare_write { my $c = shift; $c->engine->prepare_write( $c, @_ ) }
2250 =head2 $c->request_class
2252 Returns or sets the request class. Defaults to L<Catalyst::Request>.
2254 =head2 $c->response_class
2256 Returns or sets the response class. Defaults to L<Catalyst::Response>.
2258 =head2 $c->read( [$maxlength] )
2260 Reads a chunk of data from the request body. This method is designed to
2261 be used in a while loop, reading C<$maxlength> bytes on every call.
2262 C<$maxlength> defaults to the size of the request if not specified.
2264 You have to set C<< MyApp->config(parse_on_demand => 1) >> to use this
2267 Warning: If you use read(), Catalyst will not process the body,
2268 so you will not be able to access POST parameters or file uploads via
2269 $c->request. You must handle all body parsing yourself.
2273 sub read { my $c = shift; return $c->engine->read( $c, @_ ) }
2281 sub run { my $c = shift; return $c->engine->run( $c, @_ ) }
2283 =head2 $c->set_action( $action, $code, $namespace, $attrs )
2285 Sets an action in a given namespace.
2289 sub set_action { my $c = shift; $c->dispatcher->set_action( $c, @_ ) }
2291 =head2 $c->setup_actions($component)
2293 Sets up actions for a component.
2297 sub setup_actions { my $c = shift; $c->dispatcher->setup_actions( $c, @_ ) }
2299 =head2 $c->setup_config
2306 my %args = %{ $class->config || {} };
2308 my @container_classes = ( "${class}::Container", 'Catalyst::IOC::Container');
2309 unshift @container_classes, delete $args{container_class} if exists $args{container_class};
2311 my $container_class = Class::MOP::load_first_existing_class(@container_classes);
2313 my $container = $container_class->new( %args, name => "$class" );
2314 $class->container($container);
2316 my $config = $container->resolve(service => 'config');
2317 $class->config($config);
2318 $class->finalize_config; # back-compat
2321 =head2 $c->finalize_config
2325 sub finalize_config { }
2327 =head2 $c->setup_components
2329 This method is called internally to set up the application's components.
2331 It finds modules by calling the L<locate_components> method, expands them to
2332 package names with the L<expand_component_module> method, and then installs
2333 each component into the application.
2335 The C<setup_components> config option is passed to both of the above methods.
2337 Installation of each component is performed by the L<setup_component> method,
2342 sub setup_components {
2345 my $config = $class->config->{ setup_components };
2346 my $search_extra = $config->{ search_extra };
2348 my @comps = $class->locate_components($config);
2349 my %comps = map { $_ => 1 } @comps;
2351 my $deprecatedcatalyst_component_names = grep { /::[CMV]::/ } @comps;
2352 $class->log->warn(qq{Your application is using the deprecated ::[MVC]:: type naming scheme.\n}.
2353 qq{Please switch your class names to ::Model::, ::View:: and ::Controller: as appropriate.\n}
2354 ) if $deprecatedcatalyst_component_names;
2356 for my $component ( @comps ) {
2358 # We pass ignore_loaded here so that overlay files for (e.g.)
2359 # Model::DBI::Schema sub-classes are loaded - if it's in @comps
2360 # we know M::P::O found a file on disk so this is safe
2362 Catalyst::Utils::ensure_class_loaded( $component, { ignore_loaded => 1 } );
2366 $containers->{$_} = $class->container->get_sub_container($_) for qw(model view controller);
2368 for my $component (@comps) {
2369 my $instance = $class->setup_component($component);
2370 if ( my ($type, $name) = _get_component_type_name($component, $search_extra) ) {
2371 $containers->{$type}->add_service(Catalyst::IOC::BlockInjection->new( name => $name, block => sub { return $instance } ));
2373 my @expanded_components = $instance->can('expand_modules')
2374 ? $instance->expand_modules( $component, $config )
2375 : $class->expand_component_module( $component, $config );
2376 for my $component (@expanded_components) {
2377 next if $comps{$component};
2379 $deprecatedcatalyst_component_names = grep { /::[CMV]::/ } @expanded_components;
2380 $class->log->warn(qq{Your application is using the deprecated ::[MVC]:: type naming scheme.\n}.
2381 qq{Please switch your class names to ::Model::, ::View:: and ::Controller: as appropriate.\n}
2382 ) if $deprecatedcatalyst_component_names;
2384 if (my ($type, $name) = _get_component_type_name($component, $search_extra)) {
2385 $containers->{$type}->add_service(Catalyst::IOC::BlockInjection->new( name => $name, block => sub { return $class->setup_component($component) } ));
2390 $containers->{model}->make_single_default;
2391 $containers->{view}->make_single_default;
2394 # FIXME: should this sub exist?
2395 # should it be moved to Catalyst::Utils,
2396 # or replaced by something already existing there?
2397 sub _get_component_type_name {
2398 my ( $component, $search_extra) = @_;
2399 $search_extra ||= [];
2400 my @search_extra = map { s/^:://; lc $_ } @$search_extra;
2402 my @parts = split /::/, $component;
2404 if (scalar @parts == 1) {
2405 return (undef, $component);
2408 while (my $type = shift @parts) {
2409 return ('controller', join '::', @parts)
2410 if $type =~ /^(c|controller)$/i;
2412 return ('model', join '::', @parts)
2413 if $type =~ /^(m|model)$/i;
2415 return ('view', join '::', @parts)
2416 if $type =~ /^(v|view)$/i;
2418 return (_get_component_type($component), join '::', @parts)
2419 if @search_extra and ( grep { lc $type eq $_ } @search_extra );
2423 sub _get_component_type {
2424 my ( $instance ) = @_;
2426 return 'controller' if $instance->isa('Catalyst::Controller');
2427 return 'model' if $instance->isa('Catalyst::Model');
2428 return 'view' if $instance->isa('Catalyst::View');
2431 =head2 $c->locate_components( $setup_component_config )
2433 This method is meant to provide a list of component modules that should be
2434 setup for the application. By default, it will use L<Module::Pluggable>.
2436 Specify a C<setup_components> config option to pass additional options directly
2437 to L<Module::Pluggable>. To add additional search paths, specify a key named
2438 C<search_extra> as an array reference. Items in the array beginning with C<::>
2439 will have the application class name prepended to them.
2443 sub locate_components {
2447 my @paths = qw( ::Controller ::C ::Model ::M ::View ::V );
2448 my $extra = delete $config->{ search_extra } || [];
2450 push @paths, @$extra;
2452 my $locator = Module::Pluggable::Object->new(
2453 search_path => [ map { s/^(?=::)/$class/; $_; } @paths ],
2457 # XXX think about ditching this sort entirely
2458 my @comps = sort { length $a <=> length $b } $locator->plugins;
2463 =head2 $c->expand_component_module( $component, $setup_component_config )
2465 Components found by C<locate_components> will be passed to this method, which
2466 is expected to return a list of component (package) names to be set up.
2470 sub expand_component_module {
2471 my ($class, $module) = @_;
2472 return Devel::InnerPackage::list_packages( $module );
2475 =head2 $c->setup_component
2479 ## FIXME - Why the hell do we try calling the ->COMPONENT method twice, this is madness!?!
2480 sub setup_component {
2481 my( $class, $component ) = @_;
2483 unless ( $component->can( 'COMPONENT' ) ) {
2487 my $suffix = Catalyst::Utils::class2classsuffix( $component );
2488 my $config = $class->config->{ $suffix } || {};
2489 # Stash catalyst_component_name in the config here, so that custom COMPONENT
2490 # methods also pass it. local to avoid pointlessly shitting in config
2491 # for the debug screen, as $component is already the key name.
2492 local $config->{catalyst_component_name} = $component;
2494 my $instance = eval { $component->COMPONENT( $class, $config ); };
2496 if ( my $error = $@ ) {
2498 Catalyst::Exception->throw(
2499 message => qq/Couldn't instantiate component "$component", "$error"/
2502 elsif (!blessed $instance) {
2503 my $metaclass = Moose::Util::find_meta($component);
2504 my $method_meta = $metaclass->find_method_by_name('COMPONENT');
2505 my $component_method_from = $method_meta->associated_metaclass->name;
2506 my $value = defined($instance) ? $instance : 'undef';
2507 Catalyst::Exception->throw(
2509 qq/Couldn't instantiate component "$component", COMPONENT() method (from $component_method_from) didn't return an object-like value (value was $value)./
2516 =head2 $c->setup_dispatcher
2522 sub setup_dispatcher {
2523 my ( $class, $dispatcher ) = @_;
2526 $dispatcher = 'Catalyst::Dispatcher::' . $dispatcher;
2529 if ( my $env = Catalyst::Utils::env_value( $class, 'DISPATCHER' ) ) {
2530 $dispatcher = 'Catalyst::Dispatcher::' . $env;
2533 unless ($dispatcher) {
2534 $dispatcher = $class->dispatcher_class;
2537 Class::MOP::load_class($dispatcher);
2539 # dispatcher instance
2540 $class->dispatcher( $dispatcher->new );
2543 =head2 $c->setup_engine
2550 my ( $class, $engine ) = @_;
2553 $engine = 'Catalyst::Engine::' . $engine;
2556 if ( my $env = Catalyst::Utils::env_value( $class, 'ENGINE' ) ) {
2557 $engine = 'Catalyst::Engine::' . $env;
2560 if ( $ENV{MOD_PERL} ) {
2561 my $meta = Class::MOP::get_metaclass_by_name($class);
2563 # create the apache method
2564 $meta->add_method('apache' => sub { shift->engine->apache });
2566 my ( $software, $version ) =
2567 $ENV{MOD_PERL} =~ /^(\S+)\/(\d+(?:[\.\_]\d+)+)/;
2570 $version =~ s/(\.[^.]+)\./$1/g;
2572 if ( $software eq 'mod_perl' ) {
2576 if ( $version >= 1.99922 ) {
2577 $engine = 'Catalyst::Engine::Apache2::MP20';
2580 elsif ( $version >= 1.9901 ) {
2581 $engine = 'Catalyst::Engine::Apache2::MP19';
2584 elsif ( $version >= 1.24 ) {
2585 $engine = 'Catalyst::Engine::Apache::MP13';
2589 Catalyst::Exception->throw( message =>
2590 qq/Unsupported mod_perl version: $ENV{MOD_PERL}/ );
2595 # install the correct mod_perl handler
2596 if ( $version >= 1.9901 ) {
2597 *handler = sub : method {
2598 shift->handle_request(@_);
2602 *handler = sub ($$) { shift->handle_request(@_) };
2607 elsif ( $software eq 'Zeus-Perl' ) {
2608 $engine = 'Catalyst::Engine::Zeus';
2612 Catalyst::Exception->throw(
2613 message => qq/Unsupported mod_perl: $ENV{MOD_PERL}/ );
2618 $engine = $class->engine_class;
2621 Class::MOP::load_class($engine);
2623 # check for old engines that are no longer compatible
2625 if ( $engine->isa('Catalyst::Engine::Apache')
2626 && !Catalyst::Engine::Apache->VERSION )
2631 elsif ( $engine->isa('Catalyst::Engine::Server::Base')
2632 && Catalyst::Engine::Server->VERSION le '0.02' )
2637 elsif ($engine->isa('Catalyst::Engine::HTTP::POE')
2638 && $engine->VERSION eq '0.01' )
2643 elsif ($engine->isa('Catalyst::Engine::Zeus')
2644 && $engine->VERSION eq '0.01' )
2650 Catalyst::Exception->throw( message =>
2651 qq/Engine "$engine" is not supported by this version of Catalyst/
2656 $class->engine( $engine->new );
2659 =head2 $c->setup_home
2661 Sets up the home directory.
2666 my ( $class, $home ) = @_;
2668 if ( my $env = Catalyst::Utils::env_value( $class, 'HOME' ) ) {
2672 $home ||= Catalyst::Utils::home($class);
2675 #I remember recently being scolded for assigning config values like this
2676 $class->config->{home} ||= $home;
2677 $class->config->{root} ||= Path::Class::Dir->new($home)->subdir('root');
2681 =head2 $c->setup_log
2683 Sets up log by instantiating a L<Catalyst::Log|Catalyst::Log> object and
2684 passing it to C<log()>. Pass in a comma-delimited list of levels to set the
2687 This method also installs a C<debug> method that returns a true value into the
2688 catalyst subclass if the "debug" level is passed in the comma-delimited list,
2689 or if the C<$CATALYST_DEBUG> environment variable is set to a true value.
2691 Note that if the log has already been setup, by either a previous call to
2692 C<setup_log> or by a call such as C<< __PACKAGE__->log( MyLogger->new ) >>,
2693 that this method won't actually set up the log object.
2698 my ( $class, $levels ) = @_;
2701 $levels =~ s/^\s+//;
2702 $levels =~ s/\s+$//;
2703 my %levels = map { $_ => 1 } split /\s*,\s*/, $levels;
2705 my $env_debug = Catalyst::Utils::env_value( $class, 'DEBUG' );
2706 if ( defined $env_debug ) {
2707 $levels{debug} = 1 if $env_debug; # Ugly!
2708 delete($levels{debug}) unless $env_debug;
2711 unless ( $class->log ) {
2712 $class->log( Catalyst::Log->new(keys %levels) );
2715 if ( $levels{debug} ) {
2716 Class::MOP::get_metaclass_by_name($class)->add_method('debug' => sub { 1 });
2717 $class->log->debug('Debug messages enabled');
2721 =head2 $c->setup_plugins
2727 =head2 $c->setup_stats
2729 Sets up timing statistics class.
2734 my ( $class, $stats ) = @_;
2736 Catalyst::Utils::ensure_class_loaded($class->stats_class);
2738 my $env = Catalyst::Utils::env_value( $class, 'STATS' );
2739 if ( defined($env) ? $env : ($stats || $class->debug ) ) {
2740 Class::MOP::get_metaclass_by_name($class)->add_method('use_stats' => sub { 1 });
2741 $class->log->debug('Statistics enabled');
2746 =head2 $c->registered_plugins
2748 Returns a sorted list of the plugins which have either been stated in the
2749 import list or which have been added via C<< MyApp->plugin(@args); >>.
2751 If passed a given plugin name, it will report a boolean value indicating
2752 whether or not that plugin is loaded. A fully qualified name is required if
2753 the plugin name does not begin with C<Catalyst::Plugin::>.
2755 if ($c->registered_plugins('Some::Plugin')) {
2763 sub registered_plugins {
2765 return sort keys %{ $proto->_plugins } unless @_;
2767 return 1 if exists $proto->_plugins->{$plugin};
2768 return exists $proto->_plugins->{"Catalyst::Plugin::$plugin"};
2771 sub _register_plugin {
2772 my ( $proto, $plugin, $instant ) = @_;
2773 my $class = ref $proto || $proto;
2775 Class::MOP::load_class( $plugin );
2776 $class->log->warn( "$plugin inherits from 'Catalyst::Component' - this is deprecated and will not work in 5.81" )
2777 if $plugin->isa( 'Catalyst::Component' );
2778 $proto->_plugins->{$plugin} = 1;
2780 my $meta = Class::MOP::get_metaclass_by_name($class);
2781 $meta->superclasses($plugin, $meta->superclasses);
2787 my ( $class, $plugins ) = @_;
2789 $class->_plugins( {} ) unless $class->_plugins;
2790 $plugins = Data::OptList::mkopt($plugins || []);
2793 [ Catalyst::Utils::resolve_namespace(
2794 $class . '::Plugin',
2795 'Catalyst::Plugin', $_->[0]
2801 for my $plugin ( reverse @plugins ) {
2802 Class::MOP::load_class($plugin->[0], $plugin->[1]);
2803 my $meta = find_meta($plugin->[0]);
2804 next if $meta && $meta->isa('Moose::Meta::Role');
2806 $class->_register_plugin($plugin->[0]);
2810 map { $_->[0]->name, $_->[1] }
2811 grep { blessed($_->[0]) && $_->[0]->isa('Moose::Meta::Role') }
2812 map { [find_meta($_->[0]), $_->[1]] }
2815 Moose::Util::apply_all_roles(
2823 Returns an arrayref of the internal execution stack (actions that are
2824 currently executing).
2828 Returns the current timing statistics object. By default Catalyst uses
2829 L<Catalyst::Stats|Catalyst::Stats>, but can be set otherwise with
2830 L<< stats_class|/"$c->stats_class" >>.
2832 Even if L<< -Stats|/"-Stats" >> is not enabled, the stats object is still
2833 available. By enabling it with C< $c->stats->enabled(1) >, it can be used to
2834 profile explicitly, although MyApp.pm still won't profile nor output anything
2837 =head2 $c->stats_class
2839 Returns or sets the stats (timing statistics) class. L<Catalyst::Stats|Catalyst::Stats> is used by default.
2841 =head2 $c->use_stats
2843 Returns 1 when L<< stats collection|/"-Stats" >> is enabled.
2845 Note that this is a static method, not an accessor and should be overridden
2846 by declaring C<sub use_stats { 1 }> in your MyApp.pm, not by calling C<< $c->use_stats(1) >>.
2853 =head2 $c->write( $data )
2855 Writes $data to the output stream. When using this method directly, you
2856 will need to manually set the C<Content-Length> header to the length of
2857 your output data, if known.
2864 # Finalize headers if someone manually writes output
2865 $c->finalize_headers;
2867 return $c->engine->write( $c, @_ );
2872 Returns the Catalyst version number. Mostly useful for "powered by"
2873 messages in template systems.
2877 sub version { return $Catalyst::VERSION }
2879 =head1 CONFIGURATION
2881 There are a number of 'base' config variables which can be set:
2887 C<default_model> - The default model picked if you say C<< $c->model >>. See L<< /$c->model($name) >>.
2891 C<default_view> - The default view to be rendered or returned when C<< $c->view >> is called. See L<< /$c->view($name) >>.
2895 C<home> - The application home directory. In an uninstalled application,
2896 this is the top level application directory. In an installed application,
2897 this will be the directory containing C<< MyApp.pm >>.
2901 C<ignore_frontend_proxy> - See L</PROXY SUPPORT>
2905 C<name> - The name of the application in debug messages and the debug and
2910 C<parse_on_demand> - The request body (for example file uploads) will not be parsed
2911 until it is accessed. This allows you to (for example) check authentication (and reject
2912 the upload) before actually recieving all the data. See L</ON-DEMAND PARSER>
2916 C<root> - The root directory for templates. Usually this is just a
2917 subdirectory of the home directory, but you can set it to change the
2918 templates to a different directory.
2922 C<search_extra> - Array reference passed to Module::Pluggable to for additional
2923 namespaces from which components will be loaded (and constructed and stored in
2924 C<< $c->components >>).
2928 C<show_internal_actions> - If true, causes internal actions such as C<< _DISPATCH >>
2929 to be shown in hit debug tables in the test server.
2933 C<use_request_uri_for_path> - Controlls if the C<REQUEST_URI> or C<PATH_INFO> environment
2934 variable should be used for determining the request path. See L<Catalyst::Engine::CGI/PATH DECODING>
2935 for more information.
2939 C<using_frontend_proxy> - See L</PROXY SUPPORT>.
2943 =head1 INTERNAL ACTIONS
2945 Catalyst uses internal actions like C<_DISPATCH>, C<_BEGIN>, C<_AUTO>,
2946 C<_ACTION>, and C<_END>. These are by default not shown in the private
2947 action table, but you can make them visible with a config parameter.
2949 MyApp->config(show_internal_actions => 1);
2951 =head1 ON-DEMAND PARSER
2953 The request body is usually parsed at the beginning of a request,
2954 but if you want to handle input yourself, you can enable on-demand
2955 parsing with a config parameter.
2957 MyApp->config(parse_on_demand => 1);
2959 =head1 PROXY SUPPORT
2961 Many production servers operate using the common double-server approach,
2962 with a lightweight frontend web server passing requests to a larger
2963 backend server. An application running on the backend server must deal
2964 with two problems: the remote user always appears to be C<127.0.0.1> and
2965 the server's hostname will appear to be C<localhost> regardless of the
2966 virtual host that the user connected through.
2968 Catalyst will automatically detect this situation when you are running
2969 the frontend and backend servers on the same machine. The following
2970 changes are made to the request.
2972 $c->req->address is set to the user's real IP address, as read from
2973 the HTTP X-Forwarded-For header.
2975 The host value for $c->req->base and $c->req->uri is set to the real
2976 host, as read from the HTTP X-Forwarded-Host header.
2978 Additionally, you may be running your backend application on an insecure
2979 connection (port 80) while your frontend proxy is running under SSL. If there
2980 is a discrepancy in the ports, use the HTTP header C<X-Forwarded-Port> to
2981 tell Catalyst what port the frontend listens on. This will allow all URIs to
2982 be created properly.
2984 In the case of passing in:
2986 X-Forwarded-Port: 443
2988 All calls to C<uri_for> will result in an https link, as is expected.
2990 Obviously, your web server must support these headers for this to work.
2992 In a more complex server farm environment where you may have your
2993 frontend proxy server(s) on different machines, you will need to set a
2994 configuration option to tell Catalyst to read the proxied data from the
2997 MyApp->config(using_frontend_proxy => 1);
2999 If you do not wish to use the proxy support at all, you may set:
3001 MyApp->config(ignore_frontend_proxy => 1);
3003 =head1 THREAD SAFETY
3005 Catalyst has been tested under Apache 2's threading C<mpm_worker>,
3006 C<mpm_winnt>, and the standalone forking HTTP server on Windows. We
3007 believe the Catalyst core to be thread-safe.
3009 If you plan to operate in a threaded environment, remember that all other
3010 modules you are using must also be thread-safe. Some modules, most notably
3011 L<DBD::SQLite>, are not thread-safe.
3017 Join #catalyst on irc.perl.org.
3021 http://lists.scsys.co.uk/cgi-bin/mailman/listinfo/catalyst
3022 http://lists.scsys.co.uk/cgi-bin/mailman/listinfo/catalyst-dev
3026 http://catalyst.perl.org
3030 http://dev.catalyst.perl.org
3034 =head2 L<Task::Catalyst> - All you need to start with Catalyst
3036 =head2 L<Catalyst::Manual> - The Catalyst Manual
3038 =head2 L<Catalyst::Component>, L<Catalyst::Controller> - Base classes for components
3040 =head2 L<Catalyst::Engine> - Core engine
3042 =head2 L<Catalyst::Log> - Log class.
3044 =head2 L<Catalyst::Request> - Request object
3046 =head2 L<Catalyst::Response> - Response object
3048 =head2 L<Catalyst::Test> - The test suite.
3050 =head1 PROJECT FOUNDER
3052 sri: Sebastian Riedel <sri@cpan.org>
3058 acme: Leon Brocard <leon@astray.com>
3060 abraxxa: Alexander Hartmaier <abraxxa@cpan.org>
3064 Andrew Ford E<lt>A.Ford@ford-mason.co.ukE<gt>
3070 andyg: Andy Grundman <andy@hybridized.org>
3072 audreyt: Audrey Tang
3074 bricas: Brian Cassidy <bricas@cpan.org>
3076 Caelum: Rafael Kitover <rkitover@io.com>
3078 chansen: Christian Hansen
3080 chicks: Christopher Hicks
3082 Chisel Wright C<pause@herlpacker.co.uk>
3084 Danijel Milicevic C<me@danijel.de>
3086 David Kamholz E<lt>dkamholz@cpan.orgE<gt>
3088 David Naughton, C<naughton@umn.edu>
3092 dhoss: Devin Austin <dhoss@cpan.org>
3094 dkubb: Dan Kubb <dan.kubb-cpan@onautopilot.com>
3098 dwc: Daniel Westermann-Clark <danieltwc@cpan.org>
3100 esskar: Sascha Kiefer
3102 fireartist: Carl Franks <cfranks@cpan.org>
3104 frew: Arthur Axel "fREW" Schmidt <frioux@gmail.com>
3106 gabb: Danijel Milicevic
3110 Gavin Henry C<ghenry@perl.me.uk>
3114 groditi: Guillermo Roditi <groditi@gmail.com>
3116 hobbs: Andrew Rodland <andrew@cleverdomain.org>
3118 ilmari: Dagfinn Ilmari Mannsåker <ilmari@ilmari.org>
3120 jcamacho: Juan Camacho
3122 jester: Jesse Sheidlower C<jester@panix.com>
3124 jhannah: Jay Hannah <jay@jays.net>
3130 jon: Jon Schutz <jjschutz@cpan.org>
3132 Jonathan Rockway C<< <jrockway@cpan.org> >>
3134 Kieren Diment C<kd@totaldatasolution.com>
3136 konobi: Scott McWhirter <konobi@cpan.org>
3138 marcus: Marcus Ramberg <mramberg@cpan.org>
3140 miyagawa: Tatsuhiko Miyagawa <miyagawa@bulknews.net>
3142 mst: Matt S. Trout <mst@shadowcatsystems.co.uk>
3146 naughton: David Naughton
3148 ningu: David Kamholz <dkamholz@cpan.org>
3150 nothingmuch: Yuval Kogman <nothingmuch@woobling.org>
3152 numa: Dan Sully <daniel@cpan.org>
3158 omega: Andreas Marienborg
3160 Oleg Kostyuk <cub.uanic@gmail.com>
3162 phaylon: Robert Sedlacek <phaylon@dunkelheit.at>
3164 rafl: Florian Ragwitz <rafl@debian.org>
3166 random: Roland Lammel <lammel@cpan.org>
3168 Robert Sedlacek C<< <rs@474.at> >>
3170 SpiceMan: Marcel Montes
3174 szbalint: Balint Szilakszi <szbalint@cpan.org>
3176 t0m: Tomas Doran <bobtfish@bobtfish.net>
3180 Viljo Marrandi C<vilts@yahoo.com>
3182 Will Hawes C<info@whawes.co.uk>
3184 willert: Sebastian Willert <willert@cpan.org>
3186 wreis: Wallace Reis <wallace@reis.org.br>
3188 Yuval Kogman, C<nothingmuch@woobling.org>
3190 rainboxx: Matthias Dietrich, C<perl@rainboxx.de>
3192 dd070: Dhaval Dhanani <dhaval070@gmail.com>
3196 Copyright (c) 2005, the above named PROJECT FOUNDER and CONTRIBUTORS.
3200 This library is free software. You can redistribute it and/or modify it under
3201 the same terms as Perl itself.
3207 __PACKAGE__->meta->make_immutable;