4 use Moose::Meta::Class ();
5 extends 'Catalyst::Component';
6 use Moose::Util qw/find_meta/;
7 use B::Hooks::EndOfScope ();
8 use Catalyst::Exception;
9 use Catalyst::Exception::Detach;
10 use Catalyst::Exception::Go;
12 use Catalyst::Request;
13 use Catalyst::Request::Upload;
14 use Catalyst::Response;
16 use Catalyst::Controller;
18 use Devel::InnerPackage ();
20 use Module::Pluggable::Object ();
21 use Text::SimpleTable ();
22 use Path::Class::Dir ();
23 use Path::Class::File ();
27 use Tree::Simple qw/use_weak_refs/;
28 use Tree::Simple::Visitor::FindByUID;
29 use Class::C3::Adopt::NEXT;
30 use List::MoreUtils qw/uniq/;
33 use Carp qw/croak carp shortmess/;
35 BEGIN { require 5.008004; }
37 has stack => (is => 'ro', default => sub { [] });
38 has stash => (is => 'rw', default => sub { {} });
39 has state => (is => 'rw', default => 0);
40 has stats => (is => 'rw');
41 has action => (is => 'rw');
42 has counter => (is => 'rw', default => sub { {} });
43 has request => (is => 'rw', default => sub { $_[0]->request_class->new({}) }, required => 1, lazy => 1);
44 has response => (is => 'rw', default => sub { $_[0]->response_class->new({}) }, required => 1, lazy => 1);
45 has namespace => (is => 'rw');
47 sub depth { scalar @{ shift->stack || [] }; }
48 sub comp { shift->component(@_) }
51 my $self = shift; return $self->request(@_);
54 my $self = shift; return $self->response(@_);
57 # For backwards compatibility
58 sub finalize_output { shift->finalize_body(@_) };
63 our $RECURSION = 1000;
64 our $DETACH = Catalyst::Exception::Detach->new;
65 our $GO = Catalyst::Exception::Go->new;
67 #I imagine that very few of these really need to be class variables. if any.
68 #maybe we should just make them attributes with a default?
69 __PACKAGE__->mk_classdata($_)
70 for qw/container components arguments dispatcher engine log dispatcher_class
71 engine_class context_class request_class response_class stats_class
74 __PACKAGE__->dispatcher_class('Catalyst::Dispatcher');
75 __PACKAGE__->engine_class('Catalyst::Engine::CGI');
76 __PACKAGE__->request_class('Catalyst::Request');
77 __PACKAGE__->response_class('Catalyst::Response');
78 __PACKAGE__->stats_class('Catalyst::Stats');
80 # Remember to update this in Catalyst::Runtime as well!
82 our $VERSION = '5.80032';
85 my ( $class, @arguments ) = @_;
87 # We have to limit $class to Catalyst to avoid pushing Catalyst upon every
89 return unless $class eq 'Catalyst';
91 my $caller = caller();
92 return if $caller eq 'main';
94 my $meta = Moose::Meta::Class->initialize($caller);
95 unless ( $caller->isa('Catalyst') ) {
96 my @superclasses = ($meta->superclasses, $class, 'Catalyst::Controller');
97 $meta->superclasses(@superclasses);
99 # Avoid possible C3 issues if 'Moose::Object' is already on RHS of MyApp
100 $meta->superclasses(grep { $_ ne 'Moose::Object' } $meta->superclasses);
102 unless( $meta->has_method('meta') ){
103 if ($Moose::VERSION >= 1.15) {
104 $meta->_add_meta_method('meta');
107 $meta->add_method(meta => sub { Moose::Meta::Class->initialize("${caller}") } );
111 $caller->arguments( [@arguments] );
115 sub _application { $_[0] }
119 Catalyst - The Elegant MVC Web Application Framework
123 See the L<Catalyst::Manual> distribution for comprehensive
124 documentation and tutorials.
126 # Install Catalyst::Devel for helpers and other development tools
127 # use the helper to create a new application
130 # add models, views, controllers
131 script/myapp_create.pl model MyDatabase DBIC::Schema create=static dbi:SQLite:/path/to/db
132 script/myapp_create.pl view MyTemplate TT
133 script/myapp_create.pl controller Search
135 # built in testserver -- use -r to restart automatically on changes
136 # --help to see all available options
137 script/myapp_server.pl
139 # command line testing interface
140 script/myapp_test.pl /yada
143 use Catalyst qw/-Debug/; # include plugins here as well
145 ### In lib/MyApp/Controller/Root.pm (autocreated)
146 sub foo : Global { # called for /foo, /foo/1, /foo/1/2, etc.
147 my ( $self, $c, @args ) = @_; # args are qw/1 2/ for /foo/1/2
148 $c->stash->{template} = 'foo.tt'; # set the template
149 # lookup something from db -- stash vars are passed to TT
151 $c->model('Database::Foo')->search( { country => $args[0] } );
152 if ( $c->req->params->{bar} ) { # access GET or POST parameters
153 $c->forward( 'bar' ); # process another action
154 # do something else after forward returns
158 # The foo.tt TT template can use the stash data from the database
159 [% WHILE (item = data.next) %]
163 # called for /bar/of/soap, /bar/of/soap/10, etc.
164 sub bar : Path('/bar/of/soap') { ... }
166 # called for all actions, from the top-most controller downwards
168 my ( $self, $c ) = @_;
169 if ( !$c->user_exists ) { # Catalyst::Plugin::Authentication
170 $c->res->redirect( '/login' ); # require login
171 return 0; # abort request and go immediately to end()
173 return 1; # success; carry on to next action
176 # called after all actions are finished
178 my ( $self, $c ) = @_;
179 if ( scalar @{ $c->error } ) { ... } # handle errors
180 return if $c->res->body; # already have a response
181 $c->forward( 'MyApp::View::TT' ); # render template
184 ### in MyApp/Controller/Foo.pm
185 # called for /foo/bar
186 sub bar : Local { ... }
188 # called for /blargle
189 sub blargle : Global { ... }
191 # an index action matches /foo, but not /foo/1, etc.
192 sub index : Private { ... }
194 ### in MyApp/Controller/Foo/Bar.pm
195 # called for /foo/bar/baz
196 sub baz : Local { ... }
198 # first Root auto is called, then Foo auto, then this
199 sub auto : Private { ... }
201 # powerful regular expression paths are also possible
202 sub details : Regex('^product/(\w+)/details$') {
203 my ( $self, $c ) = @_;
204 # extract the (\w+) from the URI
205 my $product = $c->req->captures->[0];
208 See L<Catalyst::Manual::Intro> for additional information.
212 Catalyst is a modern framework for making web applications without the
213 pain usually associated with this process. This document is a reference
214 to the main Catalyst application. If you are a new user, we suggest you
215 start with L<Catalyst::Manual::Tutorial> or L<Catalyst::Manual::Intro>.
217 See L<Catalyst::Manual> for more documentation.
219 Catalyst plugins can be loaded by naming them as arguments to the "use
220 Catalyst" statement. Omit the C<Catalyst::Plugin::> prefix from the
221 plugin name, i.e., C<Catalyst::Plugin::My::Module> becomes
224 use Catalyst qw/My::Module/;
226 If your plugin starts with a name other than C<Catalyst::Plugin::>, you can
227 fully qualify the name by using a unary plus:
231 +Fully::Qualified::Plugin::Name
234 Special flags like C<-Debug> and C<-Engine> can also be specified as
235 arguments when Catalyst is loaded:
237 use Catalyst qw/-Debug My::Module/;
239 The position of plugins and flags in the chain is important, because
240 they are loaded in the order in which they appear.
242 The following flags are supported:
246 Enables debug output. You can also force this setting from the system
247 environment with CATALYST_DEBUG or <MYAPP>_DEBUG. The environment
248 settings override the application, with <MYAPP>_DEBUG having the highest
251 This sets the log level to 'debug' and enables full debug output on the
252 error screen. If you only want the latter, see L<< $c->debug >>.
256 Forces Catalyst to use a specific engine. Omit the
257 C<Catalyst::Engine::> prefix of the engine name, i.e.:
259 use Catalyst qw/-Engine=CGI/;
263 Forces Catalyst to use a specific home directory, e.g.:
265 use Catalyst qw[-Home=/usr/mst];
267 This can also be done in the shell environment by setting either the
268 C<CATALYST_HOME> environment variable or C<MYAPP_HOME>; where C<MYAPP>
269 is replaced with the uppercased name of your application, any "::" in
270 the name will be replaced with underscores, e.g. MyApp::Web should use
271 MYAPP_WEB_HOME. If both variables are set, the MYAPP_HOME one will be used.
273 If none of these are set, Catalyst will attempt to automatically detect the
274 home directory. If you are working in a development envirnoment, Catalyst
275 will try and find the directory containing either Makefile.PL, Build.PL or
276 dist.ini. If the application has been installed into the system (i.e.
277 you have done C<make install>), then Catalyst will use the path to your
278 application module, without the .pm extension (ie, /foo/MyApp if your
279 application was installed at /foo/MyApp.pm)
283 use Catalyst '-Log=warn,fatal,error';
285 Specifies a comma-delimited list of log levels.
289 Enables statistics collection and reporting.
291 use Catalyst qw/-Stats=1/;
293 You can also force this setting from the system environment with CATALYST_STATS
294 or <MYAPP>_STATS. The environment settings override the application, with
295 <MYAPP>_STATS having the highest priority.
297 Stats are also enabled if L<< debugging |/"-Debug" >> is enabled.
301 =head2 INFORMATION ABOUT THE CURRENT REQUEST
305 Returns a L<Catalyst::Action> object for the current action, which
306 stringifies to the action name. See L<Catalyst::Action>.
310 Returns the namespace of the current action, i.e., the URI prefix
311 corresponding to the controller of the current action. For example:
313 # in Controller::Foo::Bar
314 $c->namespace; # returns 'foo/bar';
320 Returns the current L<Catalyst::Request> object, giving access to
321 information about the current client request (including parameters,
322 cookies, HTTP headers, etc.). See L<Catalyst::Request>.
324 =head2 REQUEST FLOW HANDLING
326 =head2 $c->forward( $action [, \@arguments ] )
328 =head2 $c->forward( $class, $method, [, \@arguments ] )
330 Forwards processing to another action, by its private name. If you give a
331 class name but no method, C<process()> is called. You may also optionally
332 pass arguments in an arrayref. The action will receive the arguments in
333 C<@_> and C<< $c->req->args >>. Upon returning from the function,
334 C<< $c->req->args >> will be restored to the previous values.
336 Any data C<return>ed from the action forwarded to, will be returned by the
339 my $foodata = $c->forward('/foo');
340 $c->forward('index');
341 $c->forward(qw/Model::DBIC::Foo do_stuff/);
342 $c->forward('View::TT');
344 Note that L<< forward|/"$c->forward( $action [, \@arguments ] )" >> implies
345 an C<< eval { } >> around the call (actually
346 L<< execute|/"$c->execute( $class, $coderef )" >> does), thus de-fatalizing
347 all 'dies' within the called action. If you want C<die> to propagate you
348 need to do something like:
351 die join "\n", @{ $c->error } if @{ $c->error };
353 Or make sure to always return true values from your actions and write
356 $c->forward('foo') || return;
358 Another note is that C<< $c->forward >> always returns a scalar because it
359 actually returns $c->state which operates in a scalar context.
360 Thus, something like:
364 in an action that is forwarded to is going to return a scalar,
365 i.e. how many items are in that array, which is probably not what you want.
366 If you need to return an array then return a reference to it,
369 $c->stash->{array} = \@array;
371 and access it from the stash.
373 Keep in mind that the C<end> method used is that of the caller action. So a C<$c-E<gt>detach> inside a forwarded action would run the C<end> method from the original action requested.
377 sub forward { my $c = shift; no warnings 'recursion'; $c->dispatcher->forward( $c, @_ ) }
379 =head2 $c->detach( $action [, \@arguments ] )
381 =head2 $c->detach( $class, $method, [, \@arguments ] )
385 The same as L<< forward|/"$c->forward( $action [, \@arguments ] )" >>, but
386 doesn't return to the previous action when processing is finished.
388 When called with no arguments it escapes the processing chain entirely.
392 sub detach { my $c = shift; $c->dispatcher->detach( $c, @_ ) }
394 =head2 $c->visit( $action [, \@captures, \@arguments ] )
396 =head2 $c->visit( $class, $method, [, \@captures, \@arguments ] )
398 Almost the same as L<< forward|/"$c->forward( $action [, \@arguments ] )" >>,
399 but does a full dispatch, instead of just calling the new C<$action> /
400 C<< $class->$method >>. This means that C<begin>, C<auto> and the method
401 you go to are called, just like a new request.
403 In addition both C<< $c->action >> and C<< $c->namespace >> are localized.
404 This means, for example, that C<< $c->action >> methods such as
405 L<name|Catalyst::Action/name>, L<class|Catalyst::Action/class> and
406 L<reverse|Catalyst::Action/reverse> return information for the visited action
407 when they are invoked within the visited action. This is different from the
408 behavior of L<< forward|/"$c->forward( $action [, \@arguments ] )" >>, which
409 continues to use the $c->action object from the caller action even when
410 invoked from the callee.
412 C<< $c->stash >> is kept unchanged.
414 In effect, L<< visit|/"$c->visit( $action [, \@captures, \@arguments ] )" >>
415 allows you to "wrap" another action, just as it would have been called by
416 dispatching from a URL, while the analogous
417 L<< go|/"$c->go( $action [, \@captures, \@arguments ] )" >> allows you to
418 transfer control to another action as if it had been reached directly from a URL.
422 sub visit { my $c = shift; $c->dispatcher->visit( $c, @_ ) }
424 =head2 $c->go( $action [, \@captures, \@arguments ] )
426 =head2 $c->go( $class, $method, [, \@captures, \@arguments ] )
428 The relationship between C<go> and
429 L<< visit|/"$c->visit( $action [, \@captures, \@arguments ] )" >> is the same as
430 the relationship between
431 L<< forward|/"$c->forward( $class, $method, [, \@arguments ] )" >> and
432 L<< detach|/"$c->detach( $action [, \@arguments ] )" >>. Like C<< $c->visit >>,
433 C<< $c->go >> will perform a full dispatch on the specified action or method,
434 with localized C<< $c->action >> and C<< $c->namespace >>. Like C<detach>,
435 C<go> escapes the processing of the current request chain on completion, and
436 does not return to its caller.
438 @arguments are arguments to the final destination of $action. @captures are
439 arguments to the intermediate steps, if any, on the way to the final sub of
444 sub go { my $c = shift; $c->dispatcher->go( $c, @_ ) }
450 Returns the current L<Catalyst::Response> object, see there for details.
454 Returns a hashref to the stash, which may be used to store data and pass
455 it between components during a request. You can also set hash keys by
456 passing arguments. The stash is automatically sent to the view. The
457 stash is cleared at the end of a request; it cannot be used for
458 persistent storage (for this you must use a session; see
459 L<Catalyst::Plugin::Session> for a complete system integrated with
462 $c->stash->{foo} = $bar;
463 $c->stash( { moose => 'majestic', qux => 0 } );
464 $c->stash( bar => 1, gorch => 2 ); # equivalent to passing a hashref
466 # stash is automatically passed to the view for use in a template
467 $c->forward( 'MyApp::View::TT' );
471 around stash => sub {
474 my $stash = $orig->($c);
476 my $new_stash = @_ > 1 ? {@_} : $_[0];
477 croak('stash takes a hash or hashref') unless ref $new_stash;
478 foreach my $key ( keys %$new_stash ) {
479 $stash->{$key} = $new_stash->{$key};
489 =head2 $c->error($error, ...)
491 =head2 $c->error($arrayref)
493 Returns an arrayref containing error messages. If Catalyst encounters an
494 error while processing a request, it stores the error in $c->error. This
495 method should only be used to store fatal error messages.
497 my @error = @{ $c->error };
501 $c->error('Something bad happened');
508 my $error = ref $_[0] eq 'ARRAY' ? $_[0] : [@_];
509 croak @$error unless ref $c;
510 push @{ $c->{error} }, @$error;
512 elsif ( defined $_[0] ) { $c->{error} = undef }
513 return $c->{error} || [];
519 Contains the return value of the last executed action.
520 Note that << $c->state >> operates in a scalar context which means that all
521 values it returns are scalar.
523 =head2 $c->clear_errors
525 Clear errors. You probably don't want to clear the errors unless you are
526 implementing a custom error screen.
528 This is equivalent to running
539 =head2 COMPONENT ACCESSORS
541 =head2 $c->controller($name)
543 Gets a L<Catalyst::Controller> instance by name.
545 $c->controller('Foo')->do_stuff;
547 If the name is omitted, will return the controller for the dispatched
550 If you want to search for controllers, pass in a regexp as the argument.
552 # find all controllers that start with Foo
553 my @foo_controllers = $c->controller(qr{^Foo});
559 my ( $c, $name, @args ) = @_;
561 # FIXME: should this be a Catalyst::Utils method?
563 my $class = $c->action->class;
565 my $prefix = length Catalyst::Utils::class2classprefix($class);
567 # MyApp::Controller::Foo becomes Foo
568 # the + 2 is because of the ::
569 $name = substr $class, $prefix + 2;
572 return $c->container->get_component_from_sub_container( 'controller', $name, $c, @args);
575 =head2 $c->model($name)
577 Gets a L<Catalyst::Model> instance by name.
579 $c->model('Foo')->do_stuff;
581 Any extra arguments are directly passed to ACCEPT_CONTEXT.
583 If the name is omitted, it will look for
584 - a model object in $c->stash->{current_model_instance}, then
585 - a model name in $c->stash->{current_model}, then
586 - a config setting 'default_model', or
587 - check if there is only one model, and return it if that's the case.
589 If you want to search for models, pass in a regexp as the argument.
591 # find all models that start with Foo
592 my @foo_models = $c->model(qr{^Foo});
597 my ( $c, $name, @args ) = @_;
598 my $appclass = ref($c) || $c;
599 my $container = $c->container->get_sub_container('model');
601 return $c->container->get_component_from_sub_container( 'model', $name, $c, @args)
605 return $c->stash->{current_model_instance}
606 if $c->stash->{current_model_instance};
607 return $c->model( $c->stash->{current_model} )
608 if $c->stash->{current_model};
610 return $c->model( $appclass->config->{default_model} )
611 if $appclass->config->{default_model};
613 # FIXME: will this still be mantained?
614 my( $comp, $rest ) = $container->get_service_list;
617 $c->log->warn( Carp::shortmess('Calling $c->model() will return a random model unless you specify one of:') );
618 $c->log->warn( '* $c->config(default_model => "the name of the default model to use")' );
619 $c->log->warn( '* $c->stash->{current_model} # the name of the model to use for this request' );
620 $c->log->warn( '* $c->stash->{current_model_instance} # the instance of the model to use for this request' );
621 $c->log->warn( 'NB: in version 5.81, the "random" behavior will not work at all.' );
624 return $container->get_component( $comp, $c, @args );
628 =head2 $c->view($name)
630 Gets a L<Catalyst::View> instance by name.
632 $c->view('Foo')->do_stuff;
634 Any extra arguments are directly passed to ACCEPT_CONTEXT.
636 If the name is omitted, it will look for
637 - a view object in $c->stash->{current_view_instance}, then
638 - a view name in $c->stash->{current_view}, then
639 - a config setting 'default_view', or
640 - check if there is only one view, and return it if that's the case.
642 If you want to search for views, pass in a regexp as the argument.
644 # find all views that start with Foo
645 my @foo_views = $c->view(qr{^Foo});
650 my ( $c, $name, @args ) = @_;
651 my $appclass = ref($c) || $c;
652 my $container = $c->container->get_sub_container('view');
654 return $c->container->get_component_from_sub_container( 'view', $name, $c, @args)
658 return $c->stash->{current_view_instance}
659 if $c->stash->{current_view_instance};
660 return $c->view( $c->stash->{current_view} )
661 if $c->stash->{current_view};
663 return $c->view( $appclass->config->{default_view} )
664 if $appclass->config->{default_view};
666 my( $comp, $rest ) = $container->get_service_list;
669 $c->log->warn( 'Calling $c->view() will return a random view unless you specify one of:' );
670 $c->log->warn( '* $c->config(default_view => "the name of the default view to use")' );
671 $c->log->warn( '* $c->stash->{current_view} # the name of the view to use for this request' );
672 $c->log->warn( '* $c->stash->{current_view_instance} # the instance of the view to use for this request' );
673 $c->log->warn( 'NB: in version 5.81, the "random" behavior will not work at all.' );
676 return $container->get_component( $comp, $c, @args );
679 =head2 $c->controllers
681 Returns the available names which can be passed to $c->controller
687 return $c->container->get_sub_container('controller')->get_service_list;
692 Returns the available names which can be passed to $c->model
698 return $c->container->get_sub_container('model')->get_service_list;
704 Returns the available names which can be passed to $c->view
710 return $c->container->get_sub_container('view')->get_service_list;
713 =head2 $c->comp($name)
715 =head2 $c->component($name)
717 Gets a component object by name. This method is not recommended,
718 unless you want to get a specific component by full
719 class. C<< $c->controller >>, C<< $c->model >>, and C<< $c->view >>
720 should be used instead.
722 If C<$name> is a regexp, a list of components matched against the full
723 component name will be returned.
728 my ( $c, $component, @args ) = @_;
731 # FIXME: I probably shouldn't be doing this
732 return $c->components->{$component}
733 if exists $c->components->{$component};
735 my ($type, $name) = _get_component_type_name($component);
737 if ($type && $c->container->has_sub_container($type)) {
738 my $container = $c->container->get_sub_container($type);
740 if( !ref $component && $container->has_service($name) ) {
741 return $container->get_component( $name, $c, @args );
744 return $container->get_component_regexp( $name, $c, @args );
747 if (ref $component) {
748 for my $subcontainer_name (qw/model view controller/) {
749 my $subcontainer = $c->container->get_sub_container($subcontainer_name);
750 my @components = $subcontainer->get_service_list;
751 my @result = grep { m{$component} } @components;
753 return map { $subcontainer->get_component( $_, $c, @args ) } @result;
757 $c->log->warn("Looking for '$component', but nothing was found.");
759 # I would expect to return an empty list here, but that breaks back-compat
763 return sort keys %{ $c->components };
766 =head2 CLASS DATA AND HELPER CLASSES
770 Returns or takes a hashref containing the application's configuration.
772 __PACKAGE__->config( { db => 'dsn:SQLite:foo.db' } );
774 You can also use a C<YAML>, C<XML> or L<Config::General> config file
775 like C<myapp.conf> in your applications home directory. See
776 L<Catalyst::Plugin::ConfigLoader>.
778 =head3 Cascading configuration
780 The config method is present on all Catalyst components, and configuration
781 will be merged when an application is started. Configuration loaded with
782 L<Catalyst::Plugin::ConfigLoader> takes precedence over other configuration,
783 followed by configuration in your top level C<MyApp> class. These two
784 configurations are merged, and then configuration data whose hash key matches a
785 component name is merged with configuration for that component.
787 The configuration for a component is then passed to the C<new> method when a
788 component is constructed.
792 MyApp->config({ 'Model::Foo' => { bar => 'baz', overrides => 'me' } });
793 MyApp::Model::Foo->config({ quux => 'frob', overrides => 'this' });
795 will mean that C<MyApp::Model::Foo> receives the following data when
798 MyApp::Model::Foo->new({
804 It's common practice to use a Moose attribute
805 on the receiving component to access the config value.
807 package MyApp::Model::Foo;
811 # this attr will receive 'baz' at construction time
817 You can then get the value 'baz' by calling $c->model('Foo')->bar
818 (or $self->bar inside code in the model).
820 B<NOTE:> you MUST NOT call C<< $self->config >> or C<< __PACKAGE__->config >>
821 as a way of reading config within your code, as this B<will not> give you the
822 correctly merged config back. You B<MUST> take the config values supplied to
823 the constructor and use those instead.
827 around config => sub {
831 croak('Setting config after setup has been run is not allowed.')
832 if ( @_ and $c->setup_finished );
839 Returns the logging object instance. Unless it is already set, Catalyst
840 sets this up with a L<Catalyst::Log> object. To use your own log class,
841 set the logger with the C<< __PACKAGE__->log >> method prior to calling
842 C<< __PACKAGE__->setup >>.
844 __PACKAGE__->log( MyLogger->new );
849 $c->log->info( 'Now logging with my own logger!' );
851 Your log class should implement the methods described in
857 Returns 1 if debug mode is enabled, 0 otherwise.
859 You can enable debug mode in several ways:
863 =item By calling myapp_server.pl with the -d flag
865 =item With the environment variables MYAPP_DEBUG, or CATALYST_DEBUG
867 =item The -Debug option in your MyApp.pm
869 =item By declaring C<sub debug { 1 }> in your MyApp.pm.
873 The first three also set the log level to 'debug'.
875 Calling C<< $c->debug(1) >> has no effect.
881 =head2 $c->dispatcher
883 Returns the dispatcher instance. See L<Catalyst::Dispatcher>.
887 Returns the engine instance. See L<Catalyst::Engine>.
890 =head2 UTILITY METHODS
892 =head2 $c->path_to(@path)
894 Merges C<@path> with C<< $c->config->{home} >> and returns a
895 L<Path::Class::Dir> object. Note you can usually use this object as
896 a filename, but sometimes you will have to explicitly stringify it
897 yourself by calling the C<< ->stringify >> method.
901 $c->path_to( 'db', 'sqlite.db' );
906 my ( $c, @path ) = @_;
907 my $path = Path::Class::Dir->new( $c->config->{home}, @path );
908 if ( -d $path ) { return $path }
909 else { return Path::Class::File->new( $c->config->{home}, @path ) }
912 =head2 $c->plugin( $name, $class, @args )
914 Helper method for plugins. It creates a class data accessor/mutator and
915 loads and instantiates the given class.
917 MyApp->plugin( 'prototype', 'HTML::Prototype' );
919 $c->prototype->define_javascript_functions;
921 B<Note:> This method of adding plugins is deprecated. The ability
922 to add plugins like this B<will be removed> in a Catalyst 5.81.
923 Please do not use this functionality in new code.
928 my ( $class, $name, $plugin, @args ) = @_;
930 # See block comment in t/unit_core_plugin.t
931 $class->log->warn(qq/Adding plugin using the ->plugin method is deprecated, and will be removed in Catalyst 5.81/);
933 $class->_register_plugin( $plugin, 1 );
935 eval { $plugin->import };
936 $class->mk_classdata($name);
938 eval { $obj = $plugin->new(@args) };
941 Catalyst::Exception->throw( message =>
942 qq/Couldn't instantiate instant plugin "$plugin", "$@"/ );
946 $class->log->debug(qq/Initialized instant plugin "$plugin" as "$name"/)
952 Initializes the dispatcher and engine, loads any plugins, and loads the
953 model, view, and controller components. You may also specify an array
954 of plugins to load here, if you choose to not load them in the C<use
958 MyApp->setup( qw/-Debug/ );
963 my ( $class, @arguments ) = @_;
964 croak('Running setup more than once')
965 if ( $class->setup_finished );
967 unless ( $class->isa('Catalyst') ) {
969 Catalyst::Exception->throw(
970 message => qq/'$class' does not inherit from Catalyst/ );
973 if ( $class->arguments ) {
974 @arguments = ( @arguments, @{ $class->arguments } );
980 foreach (@arguments) {
984 ( $flags->{log} ) ? 'debug,' . $flags->{log} : 'debug';
986 elsif (/^-(\w+)=?(.*)$/) {
987 $flags->{ lc $1 } = $2;
990 push @{ $flags->{plugins} }, $_;
994 $class->setup_config();
995 $class->setup_home( delete $flags->{home} );
997 $class->setup_log( delete $flags->{log} );
998 $class->setup_plugins( delete $flags->{plugins} );
999 $class->setup_dispatcher( delete $flags->{dispatcher} );
1000 $class->setup_engine( delete $flags->{engine} );
1001 $class->setup_stats( delete $flags->{stats} );
1003 for my $flag ( sort keys %{$flags} ) {
1005 if ( my $code = $class->can( 'setup_' . $flag ) ) {
1006 &$code( $class, delete $flags->{$flag} );
1009 $class->log->warn(qq/Unknown flag "$flag"/);
1013 eval { require Catalyst::Devel; };
1014 if( !$@ && $ENV{CATALYST_SCRIPT_GEN} && ( $ENV{CATALYST_SCRIPT_GEN} < $Catalyst::Devel::CATALYST_SCRIPT_GEN ) ) {
1015 $class->log->warn(<<"EOF");
1016 You are running an old script!
1018 Please update by running (this will overwrite existing files):
1019 catalyst.pl -force -scripts $class
1021 or (this will not overwrite existing files):
1022 catalyst.pl -scripts $class
1027 if ( $class->debug ) {
1028 my @plugins = map { "$_ " . ( $_->VERSION || '' ) } $class->registered_plugins;
1031 my $column_width = Catalyst::Utils::term_width() - 6;
1032 my $t = Text::SimpleTable->new($column_width);
1033 $t->row($_) for @plugins;
1034 $class->log->debug( "Loaded plugins:\n" . $t->draw . "\n" );
1037 my $dispatcher = $class->dispatcher;
1038 my $engine = $class->engine;
1039 my $home = $class->config->{home};
1041 $class->log->debug(sprintf(q/Loaded dispatcher "%s"/, blessed($dispatcher)));
1042 $class->log->debug(sprintf(q/Loaded engine "%s"/, blessed($engine)));
1046 ? $class->log->debug(qq/Found home "$home"/)
1047 : $class->log->debug(qq/Home "$home" doesn't exist/)
1048 : $class->log->debug(q/Couldn't find home/);
1051 # Call plugins setup, this is stupid and evil.
1052 # Also screws C3 badly on 5.10, hack to avoid.
1054 no warnings qw/redefine/;
1055 local *setup = sub { };
1056 $class->setup unless $Catalyst::__AM_RESTARTING;
1059 # Initialize our data structure
1060 $class->components( {} );
1062 $class->setup_components;
1064 if ( $class->debug ) {
1065 my $column_width = Catalyst::Utils::term_width() - 8 - 9;
1066 my $t = Text::SimpleTable->new( [ $column_width, 'Class' ], [ 8, 'Type' ] );
1067 for my $comp ( sort keys %{ $class->components } ) {
1068 my $type = ref $class->components->{$comp} ? 'instance' : 'class';
1069 $t->row( $comp, $type );
1071 $class->log->debug( "Loaded components:\n" . $t->draw . "\n" )
1072 if ( keys %{ $class->components } );
1075 # Add our self to components, since we are also a component
1076 if( $class->isa('Catalyst::Controller') ){
1077 $class->components->{$class} = $class;
1080 $class->setup_actions;
1082 if ( $class->debug ) {
1083 my $name = $class->config->{name} || 'Application';
1084 $class->log->info("$name powered by Catalyst $Catalyst::VERSION");
1087 # Make sure that the application class becomes immutable at this point,
1088 B::Hooks::EndOfScope::on_scope_end {
1090 my $meta = Class::MOP::get_metaclass_by_name($class);
1093 && ! { $meta->immutable_options }->{replace_constructor}
1095 $class->isa('Class::Accessor::Fast')
1096 || $class->isa('Class::Accessor')
1099 warn "You made your application class ($class) immutable, "
1100 . "but did not inline the\nconstructor. "
1101 . "This will break catalyst, as your app \@ISA "
1102 . "Class::Accessor(::Fast)?\nPlease pass "
1103 . "(replace_constructor => 1)\nwhen making your class immutable.\n";
1105 $meta->make_immutable(
1106 replace_constructor => 1,
1107 ) unless $meta->is_immutable;
1110 if ($class->config->{case_sensitive}) {
1111 $class->log->warn($class . "->config->{case_sensitive} is set.");
1112 $class->log->warn("This setting is deprecated and planned to be removed in Catalyst 5.81.");
1115 $class->setup_finalize;
1116 # Should be the last thing we do so that user things hooking
1117 # setup_finalize can log..
1118 $class->log->_flush() if $class->log->can('_flush');
1119 return 1; # Explicit return true as people have __PACKAGE__->setup as the last thing in their class. HATE.
1122 =head2 $app->setup_finalize
1124 A hook to attach modifiers to. This method does not do anything except set the
1125 C<setup_finished> accessor.
1127 Applying method modifiers to the C<setup> method doesn't work, because of quirky things done for plugin setup.
1131 after setup_finalize => sub {
1139 sub setup_finalize {
1141 $class->setup_finished(1);
1144 =head2 $c->uri_for( $path?, @args?, \%query_values? )
1146 =head2 $c->uri_for( $action, \@captures?, @args?, \%query_values? )
1148 Constructs an absolute L<URI> object based on the application root, the
1149 provided path, and the additional arguments and query parameters provided.
1150 When used as a string, provides a textual URI. If you need more flexibility
1151 than this (i.e. the option to provide relative URIs etc.) see
1152 L<Catalyst::Plugin::SmartURI>.
1154 If no arguments are provided, the URI for the current action is returned.
1155 To return the current action and also provide @args, use
1156 C<< $c->uri_for( $c->action, @args ) >>.
1158 If the first argument is a string, it is taken as a public URI path relative
1159 to C<< $c->namespace >> (if it doesn't begin with a forward slash) or
1160 relative to the application root (if it does). It is then merged with
1161 C<< $c->request->base >>; any C<@args> are appended as additional path
1162 components; and any C<%query_values> are appended as C<?foo=bar> parameters.
1164 If the first argument is a L<Catalyst::Action> it represents an action which
1165 will have its path resolved using C<< $c->dispatcher->uri_for_action >>. The
1166 optional C<\@captures> argument (an arrayref) allows passing the captured
1167 variables that are needed to fill in the paths of Chained and Regex actions;
1168 once the path is resolved, C<uri_for> continues as though a path was
1169 provided, appending any arguments or parameters and creating an absolute
1172 The captures for the current request can be found in
1173 C<< $c->request->captures >>, and actions can be resolved using
1174 C<< Catalyst::Controller->action_for($name) >>. If you have a private action
1175 path, use C<< $c->uri_for_action >> instead.
1177 # Equivalent to $c->req->uri
1178 $c->uri_for($c->action, $c->req->captures,
1179 @{ $c->req->args }, $c->req->params);
1181 # For the Foo action in the Bar controller
1182 $c->uri_for($c->controller('Bar')->action_for('Foo'));
1184 # Path to a static resource
1185 $c->uri_for('/static/images/logo.png');
1190 my ( $c, $path, @args ) = @_;
1192 if (blessed($path) && $path->isa('Catalyst::Controller')) {
1193 $path = $path->path_prefix;
1198 undef($path) if (defined $path && $path eq '');
1201 ( scalar @args && ref $args[$#args] eq 'HASH' ? pop @args : {} );
1203 carp "uri_for called with undef argument" if grep { ! defined $_ } @args;
1204 foreach my $arg (@args) {
1205 utf8::encode($arg) if utf8::is_utf8($arg);
1206 $arg =~ s/([^$URI::uric])/$URI::Escape::escapes{$1}/go;
1209 if ( blessed($path) ) { # action object
1210 s|/|%2F|g for @args;
1211 my $captures = [ map { s|/|%2F|g; $_; }
1212 ( scalar @args && ref $args[0] eq 'ARRAY'
1216 foreach my $capture (@$captures) {
1217 utf8::encode($capture) if utf8::is_utf8($capture);
1218 $capture =~ s/([^$URI::uric])/$URI::Escape::escapes{$1}/go;
1222 $path = $c->dispatcher->uri_for_action($action, $captures);
1223 if (not defined $path) {
1224 $c->log->debug(qq/Can't find uri_for action '$action' @$captures/)
1228 $path = '/' if $path eq '';
1231 unshift(@args, $path);
1233 unless (defined $path && $path =~ s!^/!!) { # in-place strip
1234 my $namespace = $c->namespace;
1235 if (defined $path) { # cheesy hack to handle path '../foo'
1236 $namespace =~ s{(?:^|/)[^/]+$}{} while $args[0] =~ s{^\.\./}{};
1238 unshift(@args, $namespace || '');
1241 # join args with '/', or a blank string
1242 my $args = join('/', grep { defined($_) } @args);
1243 $args =~ s/\?/%3F/g; # STUPID STUPID SPECIAL CASE
1245 my $base = $c->req->base;
1246 my $class = ref($base);
1247 $base =~ s{(?<!/)$}{/};
1251 if (my @keys = keys %$params) {
1252 # somewhat lifted from URI::_query's query_form
1253 $query = '?'.join('&', map {
1254 my $val = $params->{$_};
1255 s/([;\/?:@&=+,\$\[\]%])/$URI::Escape::escapes{$1}/go;
1258 $val = '' unless defined $val;
1261 utf8::encode( $param ) if utf8::is_utf8($param);
1262 # using the URI::Escape pattern here so utf8 chars survive
1263 $param =~ s/([^A-Za-z0-9\-_.!~*'() ])/$URI::Escape::escapes{$1}/go;
1265 "${key}=$param"; } ( ref $val eq 'ARRAY' ? @$val : $val ));
1269 my $res = bless(\"${base}${args}${query}", $class);
1273 =head2 $c->uri_for_action( $path, \@captures?, @args?, \%query_values? )
1275 =head2 $c->uri_for_action( $action, \@captures?, @args?, \%query_values? )
1281 A private path to the Catalyst action you want to create a URI for.
1283 This is a shortcut for calling C<< $c->dispatcher->get_action_by_path($path)
1284 >> and passing the resulting C<$action> and the remaining arguments to C<<
1287 You can also pass in a Catalyst::Action object, in which case it is passed to
1290 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.
1292 For example, if the action looks like:
1294 package MyApp::Controller::Users;
1296 sub lst : Path('the-list') {}
1300 $c->uri_for_action('/users/lst')
1302 and it will create the URI /users/the-list.
1308 sub uri_for_action {
1309 my ( $c, $path, @args ) = @_;
1310 my $action = blessed($path)
1312 : $c->dispatcher->get_action_by_path($path);
1313 unless (defined $action) {
1314 croak "Can't find action for path '$path'";
1316 return $c->uri_for( $action, @args );
1319 =head2 $c->welcome_message
1321 Returns the Catalyst welcome HTML page.
1325 sub welcome_message {
1327 my $name = $c->config->{name};
1328 my $logo = $c->uri_for('/static/images/catalyst_logo.png');
1329 my $prefix = Catalyst::Utils::appprefix( ref $c );
1330 $c->response->content_type('text/html; charset=utf-8');
1332 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
1333 "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
1334 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
1336 <meta http-equiv="Content-Language" content="en" />
1337 <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
1338 <title>$name on Catalyst $VERSION</title>
1339 <style type="text/css">
1342 background-color: #eee;
1349 margin-bottom: 10px;
1351 background-color: #ccc;
1352 border: 1px solid #aaa;
1357 font-family: verdana, tahoma, sans-serif;
1360 font-family: verdana, tahoma, sans-serif;
1363 text-decoration: none;
1365 border-bottom: 1px dotted #bbb;
1367 :link:hover, :visited:hover {
1380 background-color: #fff;
1381 border: 1px solid #aaa;
1385 font-weight: normal;
1407 <h1><span id="appname">$name</span> on <a href="http://catalyst.perl.org">Catalyst</a>
1412 <img src="$logo" alt="Catalyst Logo" />
1414 <p>Welcome to the world of Catalyst.
1415 This <a href="http://en.wikipedia.org/wiki/MVC">MVC</a>
1416 framework will make web development something you had
1417 never expected it to be: Fun, rewarding, and quick.</p>
1418 <h2>What to do now?</h2>
1419 <p>That really depends on what <b>you</b> want to do.
1420 We do, however, provide you with a few starting points.</p>
1421 <p>If you want to jump right into web development with Catalyst
1422 you might want to start with a tutorial.</p>
1423 <pre>perldoc <a href="http://cpansearch.perl.org/dist/Catalyst-Manual/lib/Catalyst/Manual/Tutorial.pod">Catalyst::Manual::Tutorial</a></code>
1425 <p>Afterwards you can go on to check out a more complete look at our features.</p>
1427 <code>perldoc <a href="http://cpansearch.perl.org/dist/Catalyst-Manual/lib/Catalyst/Manual/Intro.pod">Catalyst::Manual::Intro</a>
1428 <!-- Something else should go here, but the Catalyst::Manual link seems unhelpful -->
1430 <h2>What to do next?</h2>
1431 <p>Next it's time to write an actual application. Use the
1432 helper scripts to generate <a href="http://cpansearch.perl.org/search?query=Catalyst%3A%3AController%3A%3A&mode=all">controllers</a>,
1433 <a href="http://cpansearch.perl.org/search?query=Catalyst%3A%3AModel%3A%3A&mode=all">models</a>, and
1434 <a href="http://cpansearch.perl.org/search?query=Catalyst%3A%3AView%3A%3A&mode=all">views</a>;
1435 they can save you a lot of work.</p>
1436 <pre><code>script/${prefix}_create.pl --help</code></pre>
1437 <p>Also, be sure to check out the vast and growing
1438 collection of <a href="http://search.cpan.org/search?query=Catalyst">plugins for Catalyst on CPAN</a>;
1439 you are likely to find what you need there.
1443 <p>Catalyst has a very active community. Here are the main places to
1444 get in touch with us.</p>
1447 <a href="http://dev.catalyst.perl.org">Wiki</a>
1450 <a href="http://lists.scsys.co.uk/cgi-bin/mailman/listinfo/catalyst">Mailing-List</a>
1453 <a href="irc://irc.perl.org/catalyst">IRC channel #catalyst on irc.perl.org</a>
1456 <h2>In conclusion</h2>
1457 <p>The Catalyst team hopes you will enjoy using Catalyst as much
1458 as we enjoyed making it. Please contact us if you have ideas
1459 for improvement or other feedback.</p>
1467 =head1 INTERNAL METHODS
1469 These methods are not meant to be used by end users.
1471 =head2 $c->components
1473 Returns a hash of components.
1477 around components => sub {
1482 return $class->$orig if ( !$comps );
1484 # FIXME: should this ugly kludge exist?
1485 $class->setup_config unless defined $class->container;
1487 # FIXME: should there be a warning here, not to use this accessor to create the components?
1488 my $components = {};
1491 $containers->{$_} = $class->container->get_sub_container($_) for qw(model view controller);
1493 for my $component ( keys %$comps ) {
1494 $components->{ $component } = $comps->{$component};
1496 my ($type, $name) = _get_component_type_name($component);
1498 # FIXME: shouldn't the service name be $name?
1499 $containers->{$type}->add_service(Catalyst::IOC::BlockInjection->new( name => $name, block => sub { return $class->setup_component($component) } ));
1502 return $class->$orig($components);
1505 =head2 $c->context_class
1507 Returns or sets the context class.
1511 Returns a hashref containing coderefs and execution counts (needed for
1512 deep recursion detection).
1516 Returns the number of actions on the current internal execution stack.
1520 Dispatches a request to actions.
1524 sub dispatch { my $c = shift; $c->dispatcher->dispatch( $c, @_ ) }
1526 =head2 $c->dispatcher_class
1528 Returns or sets the dispatcher class.
1530 =head2 $c->dump_these
1532 Returns a list of 2-element array references (name, structure) pairs
1533 that will be dumped on the error page in debug mode.
1539 [ Request => $c->req ],
1540 [ Response => $c->res ],
1541 [ Stash => $c->stash ],
1542 [ Config => $c->config ];
1545 =head2 $c->engine_class
1547 Returns or sets the engine class.
1549 =head2 $c->execute( $class, $coderef )
1551 Execute a coderef in given class and catch exceptions. Errors are available
1557 my ( $c, $class, $code ) = @_;
1558 $class = $c->component($class) || $class;
1561 if ( $c->depth >= $RECURSION ) {
1562 my $action = $code->reverse();
1563 $action = "/$action" unless $action =~ /->/;
1564 my $error = qq/Deep recursion detected calling "${action}"/;
1565 $c->log->error($error);
1571 my $stats_info = $c->_stats_start_execute( $code ) if $c->use_stats;
1573 push( @{ $c->stack }, $code );
1575 no warnings 'recursion';
1576 # N.B. This used to be combined, but I have seen $c get clobbered if so, and
1577 # I have no idea how, ergo $ret (which appears to fix the issue)
1578 eval { my $ret = $code->execute( $class, $c, @{ $c->req->args } ) || 0; $c->state( $ret ) };
1580 $c->_stats_finish_execute( $stats_info ) if $c->use_stats and $stats_info;
1582 my $last = pop( @{ $c->stack } );
1584 if ( my $error = $@ ) {
1585 if ( blessed($error) and $error->isa('Catalyst::Exception::Detach') ) {
1586 $error->rethrow if $c->depth > 1;
1588 elsif ( blessed($error) and $error->isa('Catalyst::Exception::Go') ) {
1589 $error->rethrow if $c->depth > 0;
1592 unless ( ref $error ) {
1593 no warnings 'uninitialized';
1595 my $class = $last->class;
1596 my $name = $last->name;
1597 $error = qq/Caught exception in $class->$name "$error"/;
1606 sub _stats_start_execute {
1607 my ( $c, $code ) = @_;
1608 my $appclass = ref($c) || $c;
1609 return if ( ( $code->name =~ /^_.*/ )
1610 && ( !$appclass->config->{show_internal_actions} ) );
1612 my $action_name = $code->reverse();
1613 $c->counter->{$action_name}++;
1615 my $action = $action_name;
1616 $action = "/$action" unless $action =~ /->/;
1618 # determine if the call was the result of a forward
1619 # this is done by walking up the call stack and looking for a calling
1620 # sub of Catalyst::forward before the eval
1622 for my $index ( 2 .. 11 ) {
1624 if ( ( caller($index) )[0] eq 'Catalyst'
1625 && ( caller($index) )[3] eq '(eval)' );
1627 if ( ( caller($index) )[3] =~ /forward$/ ) {
1628 $callsub = ( caller($index) )[3];
1629 $action = "-> $action";
1634 my $uid = $action_name . $c->counter->{$action_name};
1636 # is this a root-level call or a forwarded call?
1637 if ( $callsub =~ /forward$/ ) {
1638 my $parent = $c->stack->[-1];
1640 # forward, locate the caller
1641 if ( defined $parent && exists $c->counter->{"$parent"} ) {
1644 parent => "$parent" . $c->counter->{"$parent"},
1650 # forward with no caller may come from a plugin
1669 sub _stats_finish_execute {
1670 my ( $c, $info ) = @_;
1671 $c->stats->profile( end => $info );
1676 Finalizes the request.
1683 for my $error ( @{ $c->error } ) {
1684 $c->log->error($error);
1687 # Allow engine to handle finalize flow (for POE)
1688 my $engine = $c->engine;
1689 if ( my $code = $engine->can('finalize') ) {
1694 $c->finalize_uploads;
1697 if ( $#{ $c->error } >= 0 ) {
1701 $c->finalize_headers;
1704 if ( $c->request->method eq 'HEAD' ) {
1705 $c->response->body('');
1713 if ($c->use_stats) {
1714 my $elapsed = sprintf '%f', $c->stats->elapsed;
1715 my $av = $elapsed == 0 ? '??' : sprintf '%.3f', 1 / $elapsed;
1717 "Request took ${elapsed}s ($av/s)\n" . $c->stats->report . "\n" );
1720 return $c->response->status;
1723 =head2 $c->finalize_body
1729 sub finalize_body { my $c = shift; $c->engine->finalize_body( $c, @_ ) }
1731 =head2 $c->finalize_cookies
1737 sub finalize_cookies { my $c = shift; $c->engine->finalize_cookies( $c, @_ ) }
1739 =head2 $c->finalize_error
1745 sub finalize_error { my $c = shift; $c->engine->finalize_error( $c, @_ ) }
1747 =head2 $c->finalize_headers
1753 sub finalize_headers {
1756 my $response = $c->response; #accessor calls can add up?
1758 # Check if we already finalized headers
1759 return if $response->finalized_headers;
1762 if ( my $location = $response->redirect ) {
1763 $c->log->debug(qq/Redirecting to "$location"/) if $c->debug;
1764 $response->header( Location => $location );
1766 if ( !$response->has_body ) {
1767 # Add a default body if none is already present
1769 qq{<html><body><p>This item has moved <a href="$location">here</a>.</p></body></html>}
1775 if ( defined $response->body && length $response->body && !$response->content_length ) {
1777 # get the length from a filehandle
1778 if ( blessed( $response->body ) && $response->body->can('read') || ref( $response->body ) eq 'GLOB' )
1780 my $stat = stat $response->body;
1781 if ( $stat && $stat->size > 0 ) {
1782 $response->content_length( $stat->size );
1785 $c->log->warn('Serving filehandle without a content-length');
1789 # everything should be bytes at this point, but just in case
1790 $response->content_length( length( $response->body ) );
1795 if ( $response->status =~ /^(1\d\d|[23]04)$/ ) {
1796 $response->headers->remove_header("Content-Length");
1797 $response->body('');
1800 $c->finalize_cookies;
1802 $c->engine->finalize_headers( $c, @_ );
1805 $response->finalized_headers(1);
1808 =head2 $c->finalize_output
1810 An alias for finalize_body.
1812 =head2 $c->finalize_read
1814 Finalizes the input after reading is complete.
1818 sub finalize_read { my $c = shift; $c->engine->finalize_read( $c, @_ ) }
1820 =head2 $c->finalize_uploads
1822 Finalizes uploads. Cleans up any temporary files.
1826 sub finalize_uploads { my $c = shift; $c->engine->finalize_uploads( $c, @_ ) }
1828 =head2 $c->get_action( $action, $namespace )
1830 Gets an action in a given namespace.
1834 sub get_action { my $c = shift; $c->dispatcher->get_action(@_) }
1836 =head2 $c->get_actions( $action, $namespace )
1838 Gets all actions of a given name in a namespace and all parent
1843 sub get_actions { my $c = shift; $c->dispatcher->get_actions( $c, @_ ) }
1845 =head2 $app->handle_request( @arguments )
1847 Called to handle each HTTP request.
1851 sub handle_request {
1852 my ( $class, @arguments ) = @_;
1854 # Always expect worst case!
1857 if ($class->debug) {
1858 my $secs = time - $START || 1;
1859 my $av = sprintf '%.3f', $COUNT / $secs;
1860 my $time = localtime time;
1861 $class->log->info("*** Request $COUNT ($av/s) [$$] [$time] ***");
1864 my $c = $class->prepare(@arguments);
1866 $status = $c->finalize;
1869 if ( my $error = $@ ) {
1871 $class->log->error(qq/Caught exception in engine "$error"/);
1876 if(my $coderef = $class->log->can('_flush')){
1877 $class->log->$coderef();
1882 =head2 $c->prepare( @arguments )
1884 Creates a Catalyst context from an engine-specific request (Apache, CGI,
1890 my ( $class, @arguments ) = @_;
1893 # After the app/ctxt split, this should become an attribute based on something passed
1894 # into the application.
1895 $class->context_class( ref $class || $class ) unless $class->context_class;
1897 my $c = $class->context_class->new({});
1899 # For on-demand data
1900 $c->request->_context($c);
1901 $c->response->_context($c);
1903 #surely this is not the most efficient way to do things...
1904 $c->stats($class->stats_class->new)->enable($c->use_stats);
1905 if ( $c->debug || $c->config->{enable_catalyst_header} ) {
1906 $c->res->headers->header( 'X-Catalyst' => $Catalyst::VERSION );
1909 #XXX reuse coderef from can
1910 # Allow engine to direct the prepare flow (for POE)
1911 if ( $c->engine->can('prepare') ) {
1912 $c->engine->prepare( $c, @arguments );
1915 $c->prepare_request(@arguments);
1916 $c->prepare_connection;
1917 $c->prepare_query_parameters;
1918 $c->prepare_headers;
1919 $c->prepare_cookies;
1922 # Prepare the body for reading, either by prepare_body
1923 # or the user, if they are using $c->read
1926 # Parse the body unless the user wants it on-demand
1927 unless ( ref($c)->config->{parse_on_demand} ) {
1932 my $method = $c->req->method || '';
1933 my $path = $c->req->path;
1934 $path = '/' unless length $path;
1935 my $address = $c->req->address || '';
1944 =head2 $c->prepare_action
1946 Prepares action. See L<Catalyst::Dispatcher>.
1950 sub prepare_action { my $c = shift; $c->dispatcher->prepare_action( $c, @_ ) }
1952 =head2 $c->prepare_body
1954 Prepares message body.
1961 return if $c->request->_has_body;
1963 # Initialize on-demand data
1964 $c->engine->prepare_body( $c, @_ );
1965 $c->prepare_parameters;
1966 $c->prepare_uploads;
1969 =head2 $c->prepare_body_chunk( $chunk )
1971 Prepares a chunk of data before sending it to L<HTTP::Body>.
1973 See L<Catalyst::Engine>.
1977 sub prepare_body_chunk {
1979 $c->engine->prepare_body_chunk( $c, @_ );
1982 =head2 $c->prepare_body_parameters
1984 Prepares body parameters.
1988 sub prepare_body_parameters {
1990 $c->engine->prepare_body_parameters( $c, @_ );
1993 =head2 $c->prepare_connection
1995 Prepares connection.
1999 sub prepare_connection {
2001 $c->engine->prepare_connection( $c, @_ );
2004 =head2 $c->prepare_cookies
2010 sub prepare_cookies { my $c = shift; $c->engine->prepare_cookies( $c, @_ ) }
2012 =head2 $c->prepare_headers
2018 sub prepare_headers { my $c = shift; $c->engine->prepare_headers( $c, @_ ) }
2020 =head2 $c->prepare_parameters
2022 Prepares parameters.
2026 sub prepare_parameters {
2028 $c->prepare_body_parameters;
2029 $c->engine->prepare_parameters( $c, @_ );
2032 =head2 $c->prepare_path
2034 Prepares path and base.
2038 sub prepare_path { my $c = shift; $c->engine->prepare_path( $c, @_ ) }
2040 =head2 $c->prepare_query_parameters
2042 Prepares query parameters.
2046 sub prepare_query_parameters {
2049 $c->engine->prepare_query_parameters( $c, @_ );
2052 =head2 $c->log_request
2054 Writes information about the request to the debug logs. This includes:
2058 =item * Request method, path, and remote IP address
2060 =item * Query keywords (see L<Catalyst::Request/query_keywords>)
2062 =item * Request parameters
2064 =item * File uploads
2073 return unless $c->debug;
2075 my($dump) = grep {$_->[0] eq 'Request' } $c->dump_these;
2076 my $request = $dump->[1];
2078 my ( $method, $path, $address ) = ( $request->method, $request->path, $request->address );
2080 $path = '/' unless length $path;
2082 $c->log->debug(qq/"$method" request for "$path" from "$address"/);
2084 $c->log_request_headers($request->headers);
2086 if ( my $keywords = $request->query_keywords ) {
2087 $c->log->debug("Query keywords are: $keywords");
2090 $c->log_request_parameters( query => $request->query_parameters, $request->_has_body ? (body => $request->body_parameters) : () );
2092 $c->log_request_uploads($request);
2095 =head2 $c->log_response
2097 Writes information about the response to the debug logs by calling
2098 C<< $c->log_response_status_line >> and C<< $c->log_response_headers >>.
2105 return unless $c->debug;
2107 my($dump) = grep {$_->[0] eq 'Response' } $c->dump_these;
2108 my $response = $dump->[1];
2110 $c->log_response_status_line($response);
2111 $c->log_response_headers($response->headers);
2114 =head2 $c->log_response_status_line($response)
2116 Writes one line of information about the response to the debug logs. This includes:
2120 =item * Response status code
2122 =item * Content-Type header (if present)
2124 =item * Content-Length header (if present)
2130 sub log_response_status_line {
2131 my ($c, $response) = @_;
2135 'Response Code: %s; Content-Type: %s; Content-Length: %s',
2136 $response->status || 'unknown',
2137 $response->headers->header('Content-Type') || 'unknown',
2138 $response->headers->header('Content-Length') || 'unknown'
2143 =head2 $c->log_response_headers($headers);
2145 Hook method which can be wrapped by plugins to log the responseheaders.
2146 No-op in the default implementation.
2150 sub log_response_headers {}
2152 =head2 $c->log_request_parameters( query => {}, body => {} )
2154 Logs request parameters to debug logs
2158 sub log_request_parameters {
2160 my %all_params = @_;
2162 return unless $c->debug;
2164 my $column_width = Catalyst::Utils::term_width() - 44;
2165 foreach my $type (qw(query body)) {
2166 my $params = $all_params{$type};
2167 next if ! keys %$params;
2168 my $t = Text::SimpleTable->new( [ 35, 'Parameter' ], [ $column_width, 'Value' ] );
2169 for my $key ( sort keys %$params ) {
2170 my $param = $params->{$key};
2171 my $value = defined($param) ? $param : '';
2172 $t->row( $key, ref $value eq 'ARRAY' ? ( join ', ', @$value ) : $value );
2174 $c->log->debug( ucfirst($type) . " Parameters are:\n" . $t->draw );
2178 =head2 $c->log_request_uploads
2180 Logs file uploads included in the request to the debug logs.
2181 The parameter name, filename, file type, and file size are all included in
2186 sub log_request_uploads {
2188 my $request = shift;
2189 return unless $c->debug;
2190 my $uploads = $request->uploads;
2191 if ( keys %$uploads ) {
2192 my $t = Text::SimpleTable->new(
2193 [ 12, 'Parameter' ],
2198 for my $key ( sort keys %$uploads ) {
2199 my $upload = $uploads->{$key};
2200 for my $u ( ref $upload eq 'ARRAY' ? @{$upload} : ($upload) ) {
2201 $t->row( $key, $u->filename, $u->type, $u->size );
2204 $c->log->debug( "File Uploads are:\n" . $t->draw );
2208 =head2 $c->log_request_headers($headers);
2210 Hook method which can be wrapped by plugins to log the request headers.
2211 No-op in the default implementation.
2215 sub log_request_headers {}
2217 =head2 $c->log_headers($type => $headers)
2219 Logs L<HTTP::Headers> (either request or response) to the debug logs.
2226 my $headers = shift; # an HTTP::Headers instance
2228 return unless $c->debug;
2230 my $column_width = Catalyst::Utils::term_width() - 28;
2231 my $t = Text::SimpleTable->new( [ 15, 'Header Name' ], [ $column_width, 'Value' ] );
2234 my ( $name, $value ) = @_;
2235 $t->row( $name, $value );
2238 $c->log->debug( ucfirst($type) . " Headers:\n" . $t->draw );
2242 =head2 $c->prepare_read
2244 Prepares the input for reading.
2248 sub prepare_read { my $c = shift; $c->engine->prepare_read( $c, @_ ) }
2250 =head2 $c->prepare_request
2252 Prepares the engine request.
2256 sub prepare_request { my $c = shift; $c->engine->prepare_request( $c, @_ ) }
2258 =head2 $c->prepare_uploads
2264 sub prepare_uploads {
2267 $c->engine->prepare_uploads( $c, @_ );
2270 =head2 $c->prepare_write
2272 Prepares the output for writing.
2276 sub prepare_write { my $c = shift; $c->engine->prepare_write( $c, @_ ) }
2278 =head2 $c->request_class
2280 Returns or sets the request class. Defaults to L<Catalyst::Request>.
2282 =head2 $c->response_class
2284 Returns or sets the response class. Defaults to L<Catalyst::Response>.
2286 =head2 $c->read( [$maxlength] )
2288 Reads a chunk of data from the request body. This method is designed to
2289 be used in a while loop, reading C<$maxlength> bytes on every call.
2290 C<$maxlength> defaults to the size of the request if not specified.
2292 You have to set C<< MyApp->config(parse_on_demand => 1) >> to use this
2295 Warning: If you use read(), Catalyst will not process the body,
2296 so you will not be able to access POST parameters or file uploads via
2297 $c->request. You must handle all body parsing yourself.
2301 sub read { my $c = shift; return $c->engine->read( $c, @_ ) }
2309 sub run { my $c = shift; return $c->engine->run( $c, @_ ) }
2311 =head2 $c->set_action( $action, $code, $namespace, $attrs )
2313 Sets an action in a given namespace.
2317 sub set_action { my $c = shift; $c->dispatcher->set_action( $c, @_ ) }
2319 =head2 $c->setup_actions($component)
2321 Sets up actions for a component.
2325 sub setup_actions { my $c = shift; $c->dispatcher->setup_actions( $c, @_ ) }
2327 =head2 $c->setup_config
2334 my %args = %{ $class->config || {} };
2336 my @container_classes = ( "${class}::Container", 'Catalyst::IOC::Container');
2337 unshift @container_classes, delete $args{container_class} if exists $args{container_class};
2339 my $container_class = Class::MOP::load_first_existing_class(@container_classes);
2341 my $container = $container_class->new( %args, name => "$class" );
2342 $class->container($container);
2344 my $config = $container->resolve(service => 'config');
2345 $class->config($config);
2346 $class->finalize_config; # back-compat
2349 =head2 $c->finalize_config
2353 sub finalize_config { }
2355 =head2 $c->setup_components
2357 This method is called internally to set up the application's components.
2359 It finds modules by calling the L<locate_components> method, expands them to
2360 package names with the L<expand_component_module> method, and then installs
2361 each component into the application.
2363 The C<setup_components> config option is passed to both of the above methods.
2365 Installation of each component is performed by the L<setup_component> method,
2370 sub setup_components {
2373 my $config = $class->config->{ setup_components };
2375 my @comps = $class->locate_components($config);
2376 my %comps = map { $_ => 1 } @comps;
2378 my $deprecatedcatalyst_component_names = grep { /::[CMV]::/ } @comps;
2379 $class->log->warn(qq{Your application is using the deprecated ::[MVC]:: type naming scheme.\n}.
2380 qq{Please switch your class names to ::Model::, ::View:: and ::Controller: as appropriate.\n}
2381 ) if $deprecatedcatalyst_component_names;
2383 for my $component ( @comps ) {
2385 # We pass ignore_loaded here so that overlay files for (e.g.)
2386 # Model::DBI::Schema sub-classes are loaded - if it's in @comps
2387 # we know M::P::O found a file on disk so this is safe
2389 Catalyst::Utils::ensure_class_loaded( $component, { ignore_loaded => 1 } );
2393 $containers->{$_} = $class->container->get_sub_container($_) for qw(model view controller);
2395 for my $component (@comps) {
2396 my $instance = $class->components->{ $component } = $class->setup_component($component);
2397 if ( my ($type, $name) = _get_component_type_name($component) ) {
2398 $containers->{$type}->add_service(Catalyst::IOC::BlockInjection->new( name => $name, block => sub { return $instance } ));
2400 my @expanded_components = $instance->can('expand_modules')
2401 ? $instance->expand_modules( $component, $config )
2402 : $class->expand_component_module( $component, $config );
2403 for my $component (@expanded_components) {
2404 next if $comps{$component};
2406 $deprecatedcatalyst_component_names = grep { /::[CMV]::/ } @expanded_components;
2407 $class->log->warn(qq{Your application is using the deprecated ::[MVC]:: type naming scheme.\n}.
2408 qq{Please switch your class names to ::Model::, ::View:: and ::Controller: as appropriate.\n}
2409 ) if $deprecatedcatalyst_component_names;
2411 if (my ($type, $name) = _get_component_type_name($component)) {
2412 $containers->{$type}->add_service(Catalyst::IOC::BlockInjection->new( name => $name, block => sub { return $class->setup_component($component) } ));
2415 $class->components->{ $component } = $class->setup_component($component);
2420 sub _get_component_type_name {
2421 my $component = shift;
2422 my @parts = split /::/, $component;
2424 while (my $type = shift @parts) {
2425 return ('controller', join '::', @parts)
2426 if $type =~ /^(c|controller)$/i;
2428 return ('model', join '::', @parts)
2429 if $type =~ /^(m|model)$/i;
2431 return ('view', join '::', @parts)
2432 if $type =~ /^(v|view)$/i;
2436 =head2 $c->locate_components( $setup_component_config )
2438 This method is meant to provide a list of component modules that should be
2439 setup for the application. By default, it will use L<Module::Pluggable>.
2441 Specify a C<setup_components> config option to pass additional options directly
2442 to L<Module::Pluggable>. To add additional search paths, specify a key named
2443 C<search_extra> as an array reference. Items in the array beginning with C<::>
2444 will have the application class name prepended to them.
2448 sub locate_components {
2452 my @paths = qw( ::Controller ::C ::Model ::M ::View ::V );
2453 my $extra = delete $config->{ search_extra } || [];
2455 push @paths, @$extra;
2457 my $locator = Module::Pluggable::Object->new(
2458 search_path => [ map { s/^(?=::)/$class/; $_; } @paths ],
2462 # XXX think about ditching this sort entirely
2463 my @comps = sort { length $a <=> length $b } $locator->plugins;
2468 =head2 $c->expand_component_module( $component, $setup_component_config )
2470 Components found by C<locate_components> will be passed to this method, which
2471 is expected to return a list of component (package) names to be set up.
2475 sub expand_component_module {
2476 my ($class, $module) = @_;
2477 return Devel::InnerPackage::list_packages( $module );
2480 =head2 $c->setup_component
2484 sub setup_component {
2485 my( $class, $component ) = @_;
2487 unless ( $component->can( 'COMPONENT' ) ) {
2491 my $suffix = Catalyst::Utils::class2classsuffix( $component );
2492 my $config = $class->config->{ $suffix } || {};
2493 # Stash catalyst_component_name in the config here, so that custom COMPONENT
2494 # methods also pass it. local to avoid pointlessly shitting in config
2495 # for the debug screen, as $component is already the key name.
2496 local $config->{catalyst_component_name} = $component;
2498 my $instance = eval { $component->COMPONENT( $class, $config ); };
2500 if ( my $error = $@ ) {
2502 Catalyst::Exception->throw(
2503 message => qq/Couldn't instantiate component "$component", "$error"/
2506 elsif (!blessed $instance) {
2507 my $metaclass = Moose::Util::find_meta($component);
2508 my $method_meta = $metaclass->find_method_by_name('COMPONENT');
2509 my $component_method_from = $method_meta->associated_metaclass->name;
2510 my $value = defined($instance) ? $instance : 'undef';
2511 Catalyst::Exception->throw(
2513 qq/Couldn't instantiate component "$component", COMPONENT() method (from $component_method_from) didn't return an object-like value (value was $value)./
2520 =head2 $c->setup_dispatcher
2526 sub setup_dispatcher {
2527 my ( $class, $dispatcher ) = @_;
2530 $dispatcher = 'Catalyst::Dispatcher::' . $dispatcher;
2533 if ( my $env = Catalyst::Utils::env_value( $class, 'DISPATCHER' ) ) {
2534 $dispatcher = 'Catalyst::Dispatcher::' . $env;
2537 unless ($dispatcher) {
2538 $dispatcher = $class->dispatcher_class;
2541 Class::MOP::load_class($dispatcher);
2543 # dispatcher instance
2544 $class->dispatcher( $dispatcher->new );
2547 =head2 $c->setup_engine
2554 my ( $class, $engine ) = @_;
2557 $engine = 'Catalyst::Engine::' . $engine;
2560 if ( my $env = Catalyst::Utils::env_value( $class, 'ENGINE' ) ) {
2561 $engine = 'Catalyst::Engine::' . $env;
2564 if ( $ENV{MOD_PERL} ) {
2565 my $meta = Class::MOP::get_metaclass_by_name($class);
2567 # create the apache method
2568 $meta->add_method('apache' => sub { shift->engine->apache });
2570 my ( $software, $version ) =
2571 $ENV{MOD_PERL} =~ /^(\S+)\/(\d+(?:[\.\_]\d+)+)/;
2574 $version =~ s/(\.[^.]+)\./$1/g;
2576 if ( $software eq 'mod_perl' ) {
2580 if ( $version >= 1.99922 ) {
2581 $engine = 'Catalyst::Engine::Apache2::MP20';
2584 elsif ( $version >= 1.9901 ) {
2585 $engine = 'Catalyst::Engine::Apache2::MP19';
2588 elsif ( $version >= 1.24 ) {
2589 $engine = 'Catalyst::Engine::Apache::MP13';
2593 Catalyst::Exception->throw( message =>
2594 qq/Unsupported mod_perl version: $ENV{MOD_PERL}/ );
2599 # install the correct mod_perl handler
2600 if ( $version >= 1.9901 ) {
2601 *handler = sub : method {
2602 shift->handle_request(@_);
2606 *handler = sub ($$) { shift->handle_request(@_) };
2611 elsif ( $software eq 'Zeus-Perl' ) {
2612 $engine = 'Catalyst::Engine::Zeus';
2616 Catalyst::Exception->throw(
2617 message => qq/Unsupported mod_perl: $ENV{MOD_PERL}/ );
2622 $engine = $class->engine_class;
2625 Class::MOP::load_class($engine);
2627 # check for old engines that are no longer compatible
2629 if ( $engine->isa('Catalyst::Engine::Apache')
2630 && !Catalyst::Engine::Apache->VERSION )
2635 elsif ( $engine->isa('Catalyst::Engine::Server::Base')
2636 && Catalyst::Engine::Server->VERSION le '0.02' )
2641 elsif ($engine->isa('Catalyst::Engine::HTTP::POE')
2642 && $engine->VERSION eq '0.01' )
2647 elsif ($engine->isa('Catalyst::Engine::Zeus')
2648 && $engine->VERSION eq '0.01' )
2654 Catalyst::Exception->throw( message =>
2655 qq/Engine "$engine" is not supported by this version of Catalyst/
2660 $class->engine( $engine->new );
2663 =head2 $c->setup_home
2665 Sets up the home directory.
2670 my ( $class, $home ) = @_;
2672 if ( my $env = Catalyst::Utils::env_value( $class, 'HOME' ) ) {
2676 $home ||= Catalyst::Utils::home($class);
2679 #I remember recently being scolded for assigning config values like this
2680 $class->config->{home} ||= $home;
2681 $class->config->{root} ||= Path::Class::Dir->new($home)->subdir('root');
2685 =head2 $c->setup_log
2687 Sets up log by instantiating a L<Catalyst::Log|Catalyst::Log> object and
2688 passing it to C<log()>. Pass in a comma-delimited list of levels to set the
2691 This method also installs a C<debug> method that returns a true value into the
2692 catalyst subclass if the "debug" level is passed in the comma-delimited list,
2693 or if the C<$CATALYST_DEBUG> environment variable is set to a true value.
2695 Note that if the log has already been setup, by either a previous call to
2696 C<setup_log> or by a call such as C<< __PACKAGE__->log( MyLogger->new ) >>,
2697 that this method won't actually set up the log object.
2702 my ( $class, $levels ) = @_;
2705 $levels =~ s/^\s+//;
2706 $levels =~ s/\s+$//;
2707 my %levels = map { $_ => 1 } split /\s*,\s*/, $levels;
2709 my $env_debug = Catalyst::Utils::env_value( $class, 'DEBUG' );
2710 if ( defined $env_debug ) {
2711 $levels{debug} = 1 if $env_debug; # Ugly!
2712 delete($levels{debug}) unless $env_debug;
2715 unless ( $class->log ) {
2716 $class->log( Catalyst::Log->new(keys %levels) );
2719 if ( $levels{debug} ) {
2720 Class::MOP::get_metaclass_by_name($class)->add_method('debug' => sub { 1 });
2721 $class->log->debug('Debug messages enabled');
2725 =head2 $c->setup_plugins
2731 =head2 $c->setup_stats
2733 Sets up timing statistics class.
2738 my ( $class, $stats ) = @_;
2740 Catalyst::Utils::ensure_class_loaded($class->stats_class);
2742 my $env = Catalyst::Utils::env_value( $class, 'STATS' );
2743 if ( defined($env) ? $env : ($stats || $class->debug ) ) {
2744 Class::MOP::get_metaclass_by_name($class)->add_method('use_stats' => sub { 1 });
2745 $class->log->debug('Statistics enabled');
2750 =head2 $c->registered_plugins
2752 Returns a sorted list of the plugins which have either been stated in the
2753 import list or which have been added via C<< MyApp->plugin(@args); >>.
2755 If passed a given plugin name, it will report a boolean value indicating
2756 whether or not that plugin is loaded. A fully qualified name is required if
2757 the plugin name does not begin with C<Catalyst::Plugin::>.
2759 if ($c->registered_plugins('Some::Plugin')) {
2767 sub registered_plugins {
2769 return sort keys %{ $proto->_plugins } unless @_;
2771 return 1 if exists $proto->_plugins->{$plugin};
2772 return exists $proto->_plugins->{"Catalyst::Plugin::$plugin"};
2775 sub _register_plugin {
2776 my ( $proto, $plugin, $instant ) = @_;
2777 my $class = ref $proto || $proto;
2779 Class::MOP::load_class( $plugin );
2780 $class->log->warn( "$plugin inherits from 'Catalyst::Component' - this is deprecated and will not work in 5.81" )
2781 if $plugin->isa( 'Catalyst::Component' );
2782 $proto->_plugins->{$plugin} = 1;
2784 my $meta = Class::MOP::get_metaclass_by_name($class);
2785 $meta->superclasses($plugin, $meta->superclasses);
2791 my ( $class, $plugins ) = @_;
2793 $class->_plugins( {} ) unless $class->_plugins;
2794 $plugins = Data::OptList::mkopt($plugins || []);
2797 [ Catalyst::Utils::resolve_namespace(
2798 $class . '::Plugin',
2799 'Catalyst::Plugin', $_->[0]
2805 for my $plugin ( reverse @plugins ) {
2806 Class::MOP::load_class($plugin->[0], $plugin->[1]);
2807 my $meta = find_meta($plugin->[0]);
2808 next if $meta && $meta->isa('Moose::Meta::Role');
2810 $class->_register_plugin($plugin->[0]);
2814 map { $_->[0]->name, $_->[1] }
2815 grep { blessed($_->[0]) && $_->[0]->isa('Moose::Meta::Role') }
2816 map { [find_meta($_->[0]), $_->[1]] }
2819 Moose::Util::apply_all_roles(
2827 Returns an arrayref of the internal execution stack (actions that are
2828 currently executing).
2832 Returns the current timing statistics object. By default Catalyst uses
2833 L<Catalyst::Stats|Catalyst::Stats>, but can be set otherwise with
2834 L<< stats_class|/"$c->stats_class" >>.
2836 Even if L<< -Stats|/"-Stats" >> is not enabled, the stats object is still
2837 available. By enabling it with C< $c->stats->enabled(1) >, it can be used to
2838 profile explicitly, although MyApp.pm still won't profile nor output anything
2841 =head2 $c->stats_class
2843 Returns or sets the stats (timing statistics) class. L<Catalyst::Stats|Catalyst::Stats> is used by default.
2845 =head2 $c->use_stats
2847 Returns 1 when L<< stats collection|/"-Stats" >> is enabled.
2849 Note that this is a static method, not an accessor and should be overridden
2850 by declaring C<sub use_stats { 1 }> in your MyApp.pm, not by calling C<< $c->use_stats(1) >>.
2857 =head2 $c->write( $data )
2859 Writes $data to the output stream. When using this method directly, you
2860 will need to manually set the C<Content-Length> header to the length of
2861 your output data, if known.
2868 # Finalize headers if someone manually writes output
2869 $c->finalize_headers;
2871 return $c->engine->write( $c, @_ );
2876 Returns the Catalyst version number. Mostly useful for "powered by"
2877 messages in template systems.
2881 sub version { return $Catalyst::VERSION }
2883 =head1 CONFIGURATION
2885 There are a number of 'base' config variables which can be set:
2891 C<default_model> - The default model picked if you say C<< $c->model >>. See L<< /$c->model($name) >>.
2895 C<default_view> - The default view to be rendered or returned when C<< $c->view >> is called. See L<< /$c->view($name) >>.
2899 C<home> - The application home directory. In an uninstalled application,
2900 this is the top level application directory. In an installed application,
2901 this will be the directory containing C<< MyApp.pm >>.
2905 C<ignore_frontend_proxy> - See L</PROXY SUPPORT>
2909 C<name> - The name of the application in debug messages and the debug and
2914 C<parse_on_demand> - The request body (for example file uploads) will not be parsed
2915 until it is accessed. This allows you to (for example) check authentication (and reject
2916 the upload) before actually recieving all the data. See L</ON-DEMAND PARSER>
2920 C<root> - The root directory for templates. Usually this is just a
2921 subdirectory of the home directory, but you can set it to change the
2922 templates to a different directory.
2926 C<search_extra> - Array reference passed to Module::Pluggable to for additional
2927 namespaces from which components will be loaded (and constructed and stored in
2928 C<< $c->components >>).
2932 C<show_internal_actions> - If true, causes internal actions such as C<< _DISPATCH >>
2933 to be shown in hit debug tables in the test server.
2937 C<use_request_uri_for_path> - Controlls if the C<REQUEST_URI> or C<PATH_INFO> environment
2938 variable should be used for determining the request path. See L<Catalyst::Engine::CGI/PATH DECODING>
2939 for more information.
2943 C<using_frontend_proxy> - See L</PROXY SUPPORT>.
2947 =head1 INTERNAL ACTIONS
2949 Catalyst uses internal actions like C<_DISPATCH>, C<_BEGIN>, C<_AUTO>,
2950 C<_ACTION>, and C<_END>. These are by default not shown in the private
2951 action table, but you can make them visible with a config parameter.
2953 MyApp->config(show_internal_actions => 1);
2955 =head1 ON-DEMAND PARSER
2957 The request body is usually parsed at the beginning of a request,
2958 but if you want to handle input yourself, you can enable on-demand
2959 parsing with a config parameter.
2961 MyApp->config(parse_on_demand => 1);
2963 =head1 PROXY SUPPORT
2965 Many production servers operate using the common double-server approach,
2966 with a lightweight frontend web server passing requests to a larger
2967 backend server. An application running on the backend server must deal
2968 with two problems: the remote user always appears to be C<127.0.0.1> and
2969 the server's hostname will appear to be C<localhost> regardless of the
2970 virtual host that the user connected through.
2972 Catalyst will automatically detect this situation when you are running
2973 the frontend and backend servers on the same machine. The following
2974 changes are made to the request.
2976 $c->req->address is set to the user's real IP address, as read from
2977 the HTTP X-Forwarded-For header.
2979 The host value for $c->req->base and $c->req->uri is set to the real
2980 host, as read from the HTTP X-Forwarded-Host header.
2982 Additionally, you may be running your backend application on an insecure
2983 connection (port 80) while your frontend proxy is running under SSL. If there
2984 is a discrepancy in the ports, use the HTTP header C<X-Forwarded-Port> to
2985 tell Catalyst what port the frontend listens on. This will allow all URIs to
2986 be created properly.
2988 In the case of passing in:
2990 X-Forwarded-Port: 443
2992 All calls to C<uri_for> will result in an https link, as is expected.
2994 Obviously, your web server must support these headers for this to work.
2996 In a more complex server farm environment where you may have your
2997 frontend proxy server(s) on different machines, you will need to set a
2998 configuration option to tell Catalyst to read the proxied data from the
3001 MyApp->config(using_frontend_proxy => 1);
3003 If you do not wish to use the proxy support at all, you may set:
3005 MyApp->config(ignore_frontend_proxy => 1);
3007 =head1 THREAD SAFETY
3009 Catalyst has been tested under Apache 2's threading C<mpm_worker>,
3010 C<mpm_winnt>, and the standalone forking HTTP server on Windows. We
3011 believe the Catalyst core to be thread-safe.
3013 If you plan to operate in a threaded environment, remember that all other
3014 modules you are using must also be thread-safe. Some modules, most notably
3015 L<DBD::SQLite>, are not thread-safe.
3021 Join #catalyst on irc.perl.org.
3025 http://lists.scsys.co.uk/cgi-bin/mailman/listinfo/catalyst
3026 http://lists.scsys.co.uk/cgi-bin/mailman/listinfo/catalyst-dev
3030 http://catalyst.perl.org
3034 http://dev.catalyst.perl.org
3038 =head2 L<Task::Catalyst> - All you need to start with Catalyst
3040 =head2 L<Catalyst::Manual> - The Catalyst Manual
3042 =head2 L<Catalyst::Component>, L<Catalyst::Controller> - Base classes for components
3044 =head2 L<Catalyst::Engine> - Core engine
3046 =head2 L<Catalyst::Log> - Log class.
3048 =head2 L<Catalyst::Request> - Request object
3050 =head2 L<Catalyst::Response> - Response object
3052 =head2 L<Catalyst::Test> - The test suite.
3054 =head1 PROJECT FOUNDER
3056 sri: Sebastian Riedel <sri@cpan.org>
3062 acme: Leon Brocard <leon@astray.com>
3064 abraxxa: Alexander Hartmaier <abraxxa@cpan.org>
3068 Andrew Ford E<lt>A.Ford@ford-mason.co.ukE<gt>
3074 andyg: Andy Grundman <andy@hybridized.org>
3076 audreyt: Audrey Tang
3078 bricas: Brian Cassidy <bricas@cpan.org>
3080 Caelum: Rafael Kitover <rkitover@io.com>
3082 chansen: Christian Hansen
3084 chicks: Christopher Hicks
3086 Chisel Wright C<pause@herlpacker.co.uk>
3088 Danijel Milicevic C<me@danijel.de>
3090 David Kamholz E<lt>dkamholz@cpan.orgE<gt>
3092 David Naughton, C<naughton@umn.edu>
3096 dhoss: Devin Austin <dhoss@cpan.org>
3098 dkubb: Dan Kubb <dan.kubb-cpan@onautopilot.com>
3102 dwc: Daniel Westermann-Clark <danieltwc@cpan.org>
3104 esskar: Sascha Kiefer
3106 fireartist: Carl Franks <cfranks@cpan.org>
3108 frew: Arthur Axel "fREW" Schmidt <frioux@gmail.com>
3110 gabb: Danijel Milicevic
3114 Gavin Henry C<ghenry@perl.me.uk>
3118 groditi: Guillermo Roditi <groditi@gmail.com>
3120 hobbs: Andrew Rodland <andrew@cleverdomain.org>
3122 ilmari: Dagfinn Ilmari Mannsåker <ilmari@ilmari.org>
3124 jcamacho: Juan Camacho
3126 jester: Jesse Sheidlower C<jester@panix.com>
3128 jhannah: Jay Hannah <jay@jays.net>
3134 jon: Jon Schutz <jjschutz@cpan.org>
3136 Jonathan Rockway C<< <jrockway@cpan.org> >>
3138 Kieren Diment C<kd@totaldatasolution.com>
3140 konobi: Scott McWhirter <konobi@cpan.org>
3142 marcus: Marcus Ramberg <mramberg@cpan.org>
3144 miyagawa: Tatsuhiko Miyagawa <miyagawa@bulknews.net>
3146 mst: Matt S. Trout <mst@shadowcatsystems.co.uk>
3150 naughton: David Naughton
3152 ningu: David Kamholz <dkamholz@cpan.org>
3154 nothingmuch: Yuval Kogman <nothingmuch@woobling.org>
3156 numa: Dan Sully <daniel@cpan.org>
3162 omega: Andreas Marienborg
3164 Oleg Kostyuk <cub.uanic@gmail.com>
3166 phaylon: Robert Sedlacek <phaylon@dunkelheit.at>
3168 rafl: Florian Ragwitz <rafl@debian.org>
3170 random: Roland Lammel <lammel@cpan.org>
3172 Robert Sedlacek C<< <rs@474.at> >>
3174 SpiceMan: Marcel Montes
3178 szbalint: Balint Szilakszi <szbalint@cpan.org>
3180 t0m: Tomas Doran <bobtfish@bobtfish.net>
3184 Viljo Marrandi C<vilts@yahoo.com>
3186 Will Hawes C<info@whawes.co.uk>
3188 willert: Sebastian Willert <willert@cpan.org>
3190 wreis: Wallace Reis <wallace@reis.org.br>
3192 Yuval Kogman, C<nothingmuch@woobling.org>
3194 rainboxx: Matthias Dietrich, C<perl@rainboxx.de>
3196 dd070: Dhaval Dhanani <dhaval070@gmail.com>
3200 Copyright (c) 2005, the above named PROJECT FOUNDER and CONTRIBUTORS.
3204 This library is free software. You can redistribute it and/or modify it under
3205 the same terms as Perl itself.
3211 __PACKAGE__->meta->make_immutable;