4 use Moose::Meta::Class ();
5 extends 'Catalyst::Component';
6 use Moose::Util qw/find_meta/;
7 use B::Hooks::EndOfScope ();
8 use Catalyst::Exception;
9 use Catalyst::Exception::Detach;
10 use Catalyst::Exception::Go;
12 use Catalyst::Request;
13 use Catalyst::Request::Upload;
14 use Catalyst::Response;
16 use Catalyst::Controller;
18 use Devel::InnerPackage ();
20 use Module::Pluggable::Object ();
21 use Text::SimpleTable ();
22 use Path::Class::Dir ();
23 use Path::Class::File ();
27 use Tree::Simple qw/use_weak_refs/;
28 use Tree::Simple::Visitor::FindByUID;
29 use Class::C3::Adopt::NEXT;
30 use List::Util qw/first/;
31 use List::MoreUtils qw/uniq/;
34 use Carp qw/croak carp shortmess/;
36 BEGIN { require 5.008004; }
38 has stack => (is => 'ro', default => sub { [] });
39 has stash => (is => 'rw', default => sub { {} });
40 has state => (is => 'rw', default => 0);
41 has stats => (is => 'rw');
42 has action => (is => 'rw');
43 has counter => (is => 'rw', default => sub { {} });
44 has request => (is => 'rw', default => sub { $_[0]->request_class->new({}) }, required => 1, lazy => 1);
45 has response => (is => 'rw', default => sub { $_[0]->response_class->new({}) }, required => 1, lazy => 1);
46 has namespace => (is => 'rw');
48 sub depth { scalar @{ shift->stack || [] }; }
49 sub comp { shift->component(@_) }
52 my $self = shift; return $self->request(@_);
55 my $self = shift; return $self->response(@_);
58 # For backwards compatibility
59 sub finalize_output { shift->finalize_body(@_) };
64 our $RECURSION = 1000;
65 our $DETACH = Catalyst::Exception::Detach->new;
66 our $GO = Catalyst::Exception::Go->new;
68 #I imagine that very few of these really need to be class variables. if any.
69 #maybe we should just make them attributes with a default?
70 __PACKAGE__->mk_classdata($_) # XXX FIXME - components remove from here
71 for qw/container components arguments dispatcher engine log dispatcher_class
72 engine_class context_class request_class response_class stats_class
75 __PACKAGE__->dispatcher_class('Catalyst::Dispatcher');
76 __PACKAGE__->engine_class('Catalyst::Engine::CGI');
77 __PACKAGE__->request_class('Catalyst::Request');
78 __PACKAGE__->response_class('Catalyst::Response');
79 __PACKAGE__->stats_class('Catalyst::Stats');
81 # Remember to update this in Catalyst::Runtime as well!
83 our $VERSION = '5.80032';
86 my ( $class, @arguments ) = @_;
88 # We have to limit $class to Catalyst to avoid pushing Catalyst upon every
90 return unless $class eq 'Catalyst';
92 my $caller = caller();
93 return if $caller eq 'main';
95 my $meta = Moose::Meta::Class->initialize($caller);
97 unless ( $caller->isa('Catalyst') ) { # XXX - Remove!
98 my @superclasses = ($meta->superclasses, $class, 'Catalyst::Controller'); # 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 _application { $_[0] }
122 Catalyst - The Elegant MVC Web Application Framework
126 See the L<Catalyst::Manual> distribution for comprehensive
127 documentation and tutorials.
129 # Install Catalyst::Devel for helpers and other development tools
130 # use the helper to create a new application
133 # add models, views, controllers
134 script/myapp_create.pl model MyDatabase DBIC::Schema create=static dbi:SQLite:/path/to/db
135 script/myapp_create.pl view MyTemplate TT
136 script/myapp_create.pl controller Search
138 # built in testserver -- use -r to restart automatically on changes
139 # --help to see all available options
140 script/myapp_server.pl
142 # command line testing interface
143 script/myapp_test.pl /yada
146 use Catalyst qw/-Debug/; # include plugins here as well
148 ### In lib/MyApp/Controller/Root.pm (autocreated)
149 sub foo : Global { # called for /foo, /foo/1, /foo/1/2, etc.
150 my ( $self, $c, @args ) = @_; # args are qw/1 2/ for /foo/1/2
151 $c->stash->{template} = 'foo.tt'; # set the template
152 # lookup something from db -- stash vars are passed to TT
154 $c->model('Database::Foo')->search( { country => $args[0] } );
155 if ( $c->req->params->{bar} ) { # access GET or POST parameters
156 $c->forward( 'bar' ); # process another action
157 # do something else after forward returns
161 # The foo.tt TT template can use the stash data from the database
162 [% WHILE (item = data.next) %]
166 # called for /bar/of/soap, /bar/of/soap/10, etc.
167 sub bar : Path('/bar/of/soap') { ... }
169 # called for all actions, from the top-most controller downwards
171 my ( $self, $c ) = @_;
172 if ( !$c->user_exists ) { # Catalyst::Plugin::Authentication
173 $c->res->redirect( '/login' ); # require login
174 return 0; # abort request and go immediately to end()
176 return 1; # success; carry on to next action
179 # called after all actions are finished
181 my ( $self, $c ) = @_;
182 if ( scalar @{ $c->error } ) { ... } # handle errors
183 return if $c->res->body; # already have a response
184 $c->forward( 'MyApp::View::TT' ); # render template
187 ### in MyApp/Controller/Foo.pm
188 # called for /foo/bar
189 sub bar : Local { ... }
191 # called for /blargle
192 sub blargle : Global { ... }
194 # an index action matches /foo, but not /foo/1, etc.
195 sub index : Private { ... }
197 ### in MyApp/Controller/Foo/Bar.pm
198 # called for /foo/bar/baz
199 sub baz : Local { ... }
201 # first Root auto is called, then Foo auto, then this
202 sub auto : Private { ... }
204 # powerful regular expression paths are also possible
205 sub details : Regex('^product/(\w+)/details$') {
206 my ( $self, $c ) = @_;
207 # extract the (\w+) from the URI
208 my $product = $c->req->captures->[0];
211 See L<Catalyst::Manual::Intro> for additional information.
215 Catalyst is a modern framework for making web applications without the
216 pain usually associated with this process. This document is a reference
217 to the main Catalyst application. If you are a new user, we suggest you
218 start with L<Catalyst::Manual::Tutorial> or L<Catalyst::Manual::Intro>.
220 See L<Catalyst::Manual> for more documentation.
222 Catalyst plugins can be loaded by naming them as arguments to the "use
223 Catalyst" statement. Omit the C<Catalyst::Plugin::> prefix from the
224 plugin name, i.e., C<Catalyst::Plugin::My::Module> becomes
227 use Catalyst qw/My::Module/;
229 If your plugin starts with a name other than C<Catalyst::Plugin::>, you can
230 fully qualify the name by using a unary plus:
234 +Fully::Qualified::Plugin::Name
237 Special flags like C<-Debug> and C<-Engine> can also be specified as
238 arguments when Catalyst is loaded:
240 use Catalyst qw/-Debug My::Module/;
242 The position of plugins and flags in the chain is important, because
243 they are loaded in the order in which they appear.
245 The following flags are supported:
249 Enables debug output. You can also force this setting from the system
250 environment with CATALYST_DEBUG or <MYAPP>_DEBUG. The environment
251 settings override the application, with <MYAPP>_DEBUG having the highest
254 This sets the log level to 'debug' and enables full debug output on the
255 error screen. If you only want the latter, see L<< $c->debug >>.
259 Forces Catalyst to use a specific engine. Omit the
260 C<Catalyst::Engine::> prefix of the engine name, i.e.:
262 use Catalyst qw/-Engine=CGI/;
266 Forces Catalyst to use a specific home directory, e.g.:
268 use Catalyst qw[-Home=/usr/mst];
270 This can also be done in the shell environment by setting either the
271 C<CATALYST_HOME> environment variable or C<MYAPP_HOME>; where C<MYAPP>
272 is replaced with the uppercased name of your application, any "::" in
273 the name will be replaced with underscores, e.g. MyApp::Web should use
274 MYAPP_WEB_HOME. If both variables are set, the MYAPP_HOME one will be used.
276 If none of these are set, Catalyst will attempt to automatically detect the
277 home directory. If you are working in a development envirnoment, Catalyst
278 will try and find the directory containing either Makefile.PL, Build.PL or
279 dist.ini. If the application has been installed into the system (i.e.
280 you have done C<make install>), then Catalyst will use the path to your
281 application module, without the .pm extension (ie, /foo/MyApp if your
282 application was installed at /foo/MyApp.pm)
286 use Catalyst '-Log=warn,fatal,error';
288 Specifies a comma-delimited list of log levels.
292 Enables statistics collection and reporting.
294 use Catalyst qw/-Stats=1/;
296 You can also force this setting from the system environment with CATALYST_STATS
297 or <MYAPP>_STATS. The environment settings override the application, with
298 <MYAPP>_STATS having the highest priority.
300 Stats are also enabled if L<< debugging |/"-Debug" >> is enabled.
304 =head2 INFORMATION ABOUT THE CURRENT REQUEST
308 Returns a L<Catalyst::Action> object for the current action, which
309 stringifies to the action name. See L<Catalyst::Action>.
313 Returns the namespace of the current action, i.e., the URI prefix
314 corresponding to the controller of the current action. For example:
316 # in Controller::Foo::Bar
317 $c->namespace; # returns 'foo/bar';
323 Returns the current L<Catalyst::Request> object, giving access to
324 information about the current client request (including parameters,
325 cookies, HTTP headers, etc.). See L<Catalyst::Request>.
327 =head2 REQUEST FLOW HANDLING
329 =head2 $c->forward( $action [, \@arguments ] )
331 =head2 $c->forward( $class, $method, [, \@arguments ] )
333 Forwards processing to another action, by its private name. If you give a
334 class name but no method, C<process()> is called. You may also optionally
335 pass arguments in an arrayref. The action will receive the arguments in
336 C<@_> and C<< $c->req->args >>. Upon returning from the function,
337 C<< $c->req->args >> will be restored to the previous values.
339 Any data C<return>ed from the action forwarded to, will be returned by the
342 my $foodata = $c->forward('/foo');
343 $c->forward('index');
344 $c->forward(qw/Model::DBIC::Foo do_stuff/);
345 $c->forward('View::TT');
347 Note that L<< forward|/"$c->forward( $action [, \@arguments ] )" >> implies
348 an C<< eval { } >> around the call (actually
349 L<< execute|/"$c->execute( $class, $coderef )" >> does), thus de-fatalizing
350 all 'dies' within the called action. If you want C<die> to propagate you
351 need to do something like:
354 die join "\n", @{ $c->error } if @{ $c->error };
356 Or make sure to always return true values from your actions and write
359 $c->forward('foo') || return;
361 Another note is that C<< $c->forward >> always returns a scalar because it
362 actually returns $c->state which operates in a scalar context.
363 Thus, something like:
367 in an action that is forwarded to is going to return a scalar,
368 i.e. how many items are in that array, which is probably not what you want.
369 If you need to return an array then return a reference to it,
372 $c->stash->{array} = \@array;
374 and access it from the stash.
376 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.
380 sub forward { my $c = shift; no warnings 'recursion'; $c->dispatcher->forward( $c, @_ ) }
382 =head2 $c->detach( $action [, \@arguments ] )
384 =head2 $c->detach( $class, $method, [, \@arguments ] )
388 The same as L<< forward|/"$c->forward( $action [, \@arguments ] )" >>, but
389 doesn't return to the previous action when processing is finished.
391 When called with no arguments it escapes the processing chain entirely.
395 sub detach { my $c = shift; $c->dispatcher->detach( $c, @_ ) }
397 =head2 $c->visit( $action [, \@captures, \@arguments ] )
399 =head2 $c->visit( $class, $method, [, \@captures, \@arguments ] )
401 Almost the same as L<< forward|/"$c->forward( $action [, \@arguments ] )" >>,
402 but does a full dispatch, instead of just calling the new C<$action> /
403 C<< $class->$method >>. This means that C<begin>, C<auto> and the method
404 you go to are called, just like a new request.
406 In addition both C<< $c->action >> and C<< $c->namespace >> are localized.
407 This means, for example, that C<< $c->action >> methods such as
408 L<name|Catalyst::Action/name>, L<class|Catalyst::Action/class> and
409 L<reverse|Catalyst::Action/reverse> return information for the visited action
410 when they are invoked within the visited action. This is different from the
411 behavior of L<< forward|/"$c->forward( $action [, \@arguments ] )" >>, which
412 continues to use the $c->action object from the caller action even when
413 invoked from the callee.
415 C<< $c->stash >> is kept unchanged.
417 In effect, L<< visit|/"$c->visit( $action [, \@captures, \@arguments ] )" >>
418 allows you to "wrap" another action, just as it would have been called by
419 dispatching from a URL, while the analogous
420 L<< go|/"$c->go( $action [, \@captures, \@arguments ] )" >> allows you to
421 transfer control to another action as if it had been reached directly from a URL.
425 sub visit { my $c = shift; $c->dispatcher->visit( $c, @_ ) }
427 =head2 $c->go( $action [, \@captures, \@arguments ] )
429 =head2 $c->go( $class, $method, [, \@captures, \@arguments ] )
431 The relationship between C<go> and
432 L<< visit|/"$c->visit( $action [, \@captures, \@arguments ] )" >> is the same as
433 the relationship between
434 L<< forward|/"$c->forward( $class, $method, [, \@arguments ] )" >> and
435 L<< detach|/"$c->detach( $action [, \@arguments ] )" >>. Like C<< $c->visit >>,
436 C<< $c->go >> will perform a full dispatch on the specified action or method,
437 with localized C<< $c->action >> and C<< $c->namespace >>. Like C<detach>,
438 C<go> escapes the processing of the current request chain on completion, and
439 does not return to its caller.
441 @arguments are arguments to the final destination of $action. @captures are
442 arguments to the intermediate steps, if any, on the way to the final sub of
447 sub go { my $c = shift; $c->dispatcher->go( $c, @_ ) }
453 Returns the current L<Catalyst::Response> object, see there for details.
457 Returns a hashref to the stash, which may be used to store data and pass
458 it between components during a request. You can also set hash keys by
459 passing arguments. The stash is automatically sent to the view. The
460 stash is cleared at the end of a request; it cannot be used for
461 persistent storage (for this you must use a session; see
462 L<Catalyst::Plugin::Session> for a complete system integrated with
465 $c->stash->{foo} = $bar;
466 $c->stash( { moose => 'majestic', qux => 0 } );
467 $c->stash( bar => 1, gorch => 2 ); # equivalent to passing a hashref
469 # stash is automatically passed to the view for use in a template
470 $c->forward( 'MyApp::View::TT' );
474 around stash => sub {
477 my $stash = $orig->($c);
479 my $new_stash = @_ > 1 ? {@_} : $_[0];
480 croak('stash takes a hash or hashref') unless ref $new_stash;
481 foreach my $key ( keys %$new_stash ) {
482 $stash->{$key} = $new_stash->{$key};
492 =head2 $c->error($error, ...)
494 =head2 $c->error($arrayref)
496 Returns an arrayref containing error messages. If Catalyst encounters an
497 error while processing a request, it stores the error in $c->error. This
498 method should only be used to store fatal error messages.
500 my @error = @{ $c->error };
504 $c->error('Something bad happened');
511 my $error = ref $_[0] eq 'ARRAY' ? $_[0] : [@_];
512 croak @$error unless ref $c;
513 push @{ $c->{error} }, @$error;
515 elsif ( defined $_[0] ) { $c->{error} = undef }
516 return $c->{error} || [];
522 Contains the return value of the last executed action.
523 Note that << $c->state >> operates in a scalar context which means that all
524 values it returns are scalar.
526 =head2 $c->clear_errors
528 Clear errors. You probably don't want to clear the errors unless you are
529 implementing a custom error screen.
531 This is equivalent to running
542 =head2 COMPONENT ACCESSORS
544 =head2 $c->controller($name)
546 Gets a L<Catalyst::Controller> instance by name.
548 $c->controller('Foo')->do_stuff;
550 If the name is omitted, will return the controller for the dispatched
553 If you want to search for controllers, pass in a regexp as the argument.
555 # find all controllers that start with Foo
556 my @foo_controllers = $c->controller(qr{^Foo});
562 my ( $c, $name, @args ) = @_;
564 # FIXME: should this be a Catalyst::Utils method?
566 my $class = $c->action->class;
568 my $prefix = length Catalyst::Utils::class2classprefix($class);
570 # MyApp::Controller::Foo becomes Foo
571 # the + 2 is because of the ::
572 $name = substr $class, $prefix + 2;
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 sub _find_component {
684 my ($c, $component, @args) = @_;
687 my $query = ref $component
692 for my $subcontainer_name (qw/model view controller/) {
693 my $subcontainer = $c->container->get_sub_container($subcontainer_name);
694 my @components = $subcontainer->get_service_list;
695 @result = grep { m{$component} } @components;
697 return map { $subcontainer->get_component( $_, $c, @args ) } @result
701 # it expects an empty list on failed searches
705 =head2 $c->comp($name)
707 =head2 $c->component($name)
709 Gets a component object by name. This method is not recommended,
710 unless you want to get a specific component by full
711 class. C<< $c->controller >>, C<< $c->model >>, and C<< $c->view >>
712 should be used instead.
714 If C<$name> is a regexp, a list of components matched against the full
715 component name will be returned.
720 my ( $c, $component, @args ) = @_;
722 return sort keys %{ $c->components }
725 my ($type, $name) = _get_component_type_name($component);
727 return $c->container->get_component_from_sub_container(
728 $type, $name, $c, @args
731 my @result = $c->_find_component( $component, @args );
733 # list context for regexp searches
734 return @result if ref $component;
736 # only one component (if it's found) for string searches
737 return shift @result if @result;
739 # FIXME: I probably shouldn't be doing this
740 # I'm keeping it temporarily for things like $c->comp('MyApp')
741 #return $c->components->{$component}
742 # if exists $c->components->{$component} and !@args;
743 Carp::cluck("MOO") if $component eq "PluginTestApp";
744 $c->log->warn("Looking for '$component', but nothing was found.");
746 # I would expect to return an empty list here, but that breaks back-compat
747 $c->log->warn("Component not found, returning the list of existing");
748 $c->log->warn("components. This behavior is going to be deprecated");
749 $c->log->warn("in future releases.");
751 return sort keys %{ $c->components };
754 =head2 CLASS DATA AND HELPER CLASSES
758 Returns or takes a hashref containing the application's configuration.
760 __PACKAGE__->config( { db => 'dsn:SQLite:foo.db' } );
762 You can also use a C<YAML>, C<XML> or L<Config::General> config file
763 like C<myapp.conf> in your applications home directory. See
764 L<Catalyst::Plugin::ConfigLoader>.
766 =head3 Cascading configuration
768 The config method is present on all Catalyst components, and configuration
769 will be merged when an application is started. Configuration loaded with
770 L<Catalyst::Plugin::ConfigLoader> takes precedence over other configuration,
771 followed by configuration in your top level C<MyApp> class. These two
772 configurations are merged, and then configuration data whose hash key matches a
773 component name is merged with configuration for that component.
775 The configuration for a component is then passed to the C<new> method when a
776 component is constructed.
780 MyApp->config({ 'Model::Foo' => { bar => 'baz', overrides => 'me' } });
781 MyApp::Model::Foo->config({ quux => 'frob', overrides => 'this' });
783 will mean that C<MyApp::Model::Foo> receives the following data when
786 MyApp::Model::Foo->new({
792 It's common practice to use a Moose attribute
793 on the receiving component to access the config value.
795 package MyApp::Model::Foo;
799 # this attr will receive 'baz' at construction time
805 You can then get the value 'baz' by calling $c->model('Foo')->bar
806 (or $self->bar inside code in the model).
808 B<NOTE:> you MUST NOT call C<< $self->config >> or C<< __PACKAGE__->config >>
809 as a way of reading config within your code, as this B<will not> give you the
810 correctly merged config back. You B<MUST> take the config values supplied to
811 the constructor and use those instead.
815 around config => sub {
819 croak('Setting config after setup has been run is not allowed.')
820 if ( @_ and $c->setup_finished );
827 Returns the logging object instance. Unless it is already set, Catalyst
828 sets this up with a L<Catalyst::Log> object. To use your own log class,
829 set the logger with the C<< __PACKAGE__->log >> method prior to calling
830 C<< __PACKAGE__->setup >>.
832 __PACKAGE__->log( MyLogger->new );
837 $c->log->info( 'Now logging with my own logger!' );
839 Your log class should implement the methods described in
845 Returns 1 if debug mode is enabled, 0 otherwise.
847 You can enable debug mode in several ways:
851 =item By calling myapp_server.pl with the -d flag
853 =item With the environment variables MYAPP_DEBUG, or CATALYST_DEBUG
855 =item The -Debug option in your MyApp.pm
857 =item By declaring C<sub debug { 1 }> in your MyApp.pm.
861 The first three also set the log level to 'debug'.
863 Calling C<< $c->debug(1) >> has no effect.
869 =head2 $c->dispatcher
871 Returns the dispatcher instance. See L<Catalyst::Dispatcher>.
875 Returns the engine instance. See L<Catalyst::Engine>.
878 =head2 UTILITY METHODS
880 =head2 $c->path_to(@path)
882 Merges C<@path> with C<< $c->config->{home} >> and returns a
883 L<Path::Class::Dir> object. Note you can usually use this object as
884 a filename, but sometimes you will have to explicitly stringify it
885 yourself by calling the C<< ->stringify >> method.
889 $c->path_to( 'db', 'sqlite.db' );
894 my ( $c, @path ) = @_;
895 my $path = Path::Class::Dir->new( $c->config->{home}, @path );
896 if ( -d $path ) { return $path }
897 else { return Path::Class::File->new( $c->config->{home}, @path ) }
900 =head2 $c->plugin( $name, $class, @args )
902 Helper method for plugins. It creates a class data accessor/mutator and
903 loads and instantiates the given class.
905 MyApp->plugin( 'prototype', 'HTML::Prototype' );
907 $c->prototype->define_javascript_functions;
909 B<Note:> This method of adding plugins is deprecated. The ability
910 to add plugins like this B<will be removed> in a Catalyst 5.81.
911 Please do not use this functionality in new code.
916 my ( $class, $name, $plugin, @args ) = @_;
918 # See block comment in t/aggregate/unit_core_plugin.t
919 $class->log->warn(qq/Adding plugin using the ->plugin method is deprecated, and will be removed in Catalyst 5.81/);
921 $class->_register_plugin( $plugin, 1 );
923 eval { $plugin->import };
924 $class->mk_classdata($name);
926 eval { $obj = $plugin->new(@args) };
929 Catalyst::Exception->throw( message =>
930 qq/Couldn't instantiate instant plugin "$plugin", "$@"/ );
934 $class->log->debug(qq/Initialized instant plugin "$plugin" as "$name"/)
940 Initializes the dispatcher and engine, loads any plugins, and loads the
941 model, view, and controller components. You may also specify an array
942 of plugins to load here, if you choose to not load them in the C<use
946 MyApp->setup( qw/-Debug/ );
951 my ( $class, @arguments ) = @_;
952 croak('Running setup more than once')
953 if ( $class->setup_finished );
955 unless ( $class->isa('Catalyst') ) {
957 Catalyst::Exception->throw(
958 message => qq/'$class' does not inherit from Catalyst/ );
961 if ( $class->arguments ) {
962 @arguments = ( @arguments, @{ $class->arguments } );
968 foreach (@arguments) {
972 ( $flags->{log} ) ? 'debug,' . $flags->{log} : 'debug';
974 elsif (/^-(\w+)=?(.*)$/) {
975 $flags->{ lc $1 } = $2;
978 push @{ $flags->{plugins} }, $_;
982 $class->setup_config();
983 $class->setup_home( delete $flags->{home} );
985 $class->setup_log( delete $flags->{log} );
986 $class->setup_plugins( delete $flags->{plugins} );
987 $class->setup_dispatcher( delete $flags->{dispatcher} );
988 $class->setup_engine( delete $flags->{engine} );
989 $class->setup_stats( delete $flags->{stats} );
991 for my $flag ( sort keys %{$flags} ) {
993 if ( my $code = $class->can( 'setup_' . $flag ) ) {
994 &$code( $class, delete $flags->{$flag} );
997 $class->log->warn(qq/Unknown flag "$flag"/);
1001 eval { require Catalyst::Devel; };
1002 if( !$@ && $ENV{CATALYST_SCRIPT_GEN} && ( $ENV{CATALYST_SCRIPT_GEN} < $Catalyst::Devel::CATALYST_SCRIPT_GEN ) ) {
1003 $class->log->warn(<<"EOF");
1004 You are running an old script!
1006 Please update by running (this will overwrite existing files):
1007 catalyst.pl -force -scripts $class
1009 or (this will not overwrite existing files):
1010 catalyst.pl -scripts $class
1015 if ( $class->debug ) {
1016 my @plugins = map { "$_ " . ( $_->VERSION || '' ) } $class->registered_plugins;
1019 my $column_width = Catalyst::Utils::term_width() - 6;
1020 my $t = Text::SimpleTable->new($column_width);
1021 $t->row($_) for @plugins;
1022 $class->log->debug( "Loaded plugins:\n" . $t->draw . "\n" );
1025 my $dispatcher = $class->dispatcher;
1026 my $engine = $class->engine;
1027 my $home = $class->config->{home};
1029 $class->log->debug(sprintf(q/Loaded dispatcher "%s"/, blessed($dispatcher)));
1030 $class->log->debug(sprintf(q/Loaded engine "%s"/, blessed($engine)));
1034 ? $class->log->debug(qq/Found home "$home"/)
1035 : $class->log->debug(qq/Home "$home" doesn't exist/)
1036 : $class->log->debug(q/Couldn't find home/);
1039 # Call plugins setup, this is stupid and evil.
1040 # Also screws C3 badly on 5.10, hack to avoid.
1042 no warnings qw/redefine/;
1043 local *setup = sub { };
1044 $class->setup unless $Catalyst::__AM_RESTARTING;
1047 # Initialize our data structure
1048 $class->components( {} ); # XXX - Remove!
1050 $class->setup_components;
1052 if ( $class->debug ) { # XXX - Fixme to be a method on the container? (Or at least get a) data structure back from the container!!
1053 my $column_width = Catalyst::Utils::term_width() - 8 - 9;
1054 my $t = Text::SimpleTable->new( [ $column_width, 'Class' ], [ 8, 'Type' ] );
1055 for my $comp ( sort keys %{ $class->components } ) {
1056 my $type = ref $class->components->{$comp} ? 'instance' : 'class';
1057 $t->row( $comp, $type );
1059 $class->log->debug( "Loaded components:\n" . $t->draw . "\n" )
1060 if ( keys %{ $class->components } );
1063 # Add our self to components, since we are also a component
1064 if( $class->isa('Catalyst::Controller') ){
1065 $class->components->{$class} = $class;
1068 $class->setup_actions;
1070 if ( $class->debug ) {
1071 my $name = $class->config->{name} || 'Application';
1072 $class->log->info("$name powered by Catalyst $Catalyst::VERSION");
1075 # Make sure that the application class becomes immutable at this point,
1076 B::Hooks::EndOfScope::on_scope_end {
1078 my $meta = Class::MOP::get_metaclass_by_name($class);
1081 && ! { $meta->immutable_options }->{replace_constructor}
1083 $class->isa('Class::Accessor::Fast')
1084 || $class->isa('Class::Accessor')
1087 warn "You made your application class ($class) immutable, "
1088 . "but did not inline the\nconstructor. "
1089 . "This will break catalyst, as your app \@ISA "
1090 . "Class::Accessor(::Fast)?\nPlease pass "
1091 . "(replace_constructor => 1)\nwhen making your class immutable.\n";
1093 $meta->make_immutable(
1094 replace_constructor => 1,
1095 ) unless $meta->is_immutable;
1098 if ($class->config->{case_sensitive}) {
1099 $class->log->warn($class . "->config->{case_sensitive} is set.");
1100 $class->log->warn("This setting is deprecated and planned to be removed in Catalyst 5.81.");
1103 $class->setup_finalize;
1104 # Should be the last thing we do so that user things hooking
1105 # setup_finalize can log..
1106 $class->log->_flush() if $class->log->can('_flush');
1107 return 1; # Explicit return true as people have __PACKAGE__->setup as the last thing in their class. HATE.
1110 =head2 $app->setup_finalize
1112 A hook to attach modifiers to. This method does not do anything except set the
1113 C<setup_finished> accessor.
1115 Applying method modifiers to the C<setup> method doesn't work, because of quirky things done for plugin setup.
1119 after setup_finalize => sub {
1127 sub setup_finalize {
1129 $class->setup_finished(1);
1132 =head2 $c->uri_for( $path?, @args?, \%query_values? )
1134 =head2 $c->uri_for( $action, \@captures?, @args?, \%query_values? )
1136 Constructs an absolute L<URI> object based on the application root, the
1137 provided path, and the additional arguments and query parameters provided.
1138 When used as a string, provides a textual URI. If you need more flexibility
1139 than this (i.e. the option to provide relative URIs etc.) see
1140 L<Catalyst::Plugin::SmartURI>.
1142 If no arguments are provided, the URI for the current action is returned.
1143 To return the current action and also provide @args, use
1144 C<< $c->uri_for( $c->action, @args ) >>.
1146 If the first argument is a string, it is taken as a public URI path relative
1147 to C<< $c->namespace >> (if it doesn't begin with a forward slash) or
1148 relative to the application root (if it does). It is then merged with
1149 C<< $c->request->base >>; any C<@args> are appended as additional path
1150 components; and any C<%query_values> are appended as C<?foo=bar> parameters.
1152 If the first argument is a L<Catalyst::Action> it represents an action which
1153 will have its path resolved using C<< $c->dispatcher->uri_for_action >>. The
1154 optional C<\@captures> argument (an arrayref) allows passing the captured
1155 variables that are needed to fill in the paths of Chained and Regex actions;
1156 once the path is resolved, C<uri_for> continues as though a path was
1157 provided, appending any arguments or parameters and creating an absolute
1160 The captures for the current request can be found in
1161 C<< $c->request->captures >>, and actions can be resolved using
1162 C<< Catalyst::Controller->action_for($name) >>. If you have a private action
1163 path, use C<< $c->uri_for_action >> instead.
1165 # Equivalent to $c->req->uri
1166 $c->uri_for($c->action, $c->req->captures,
1167 @{ $c->req->args }, $c->req->params);
1169 # For the Foo action in the Bar controller
1170 $c->uri_for($c->controller('Bar')->action_for('Foo'));
1172 # Path to a static resource
1173 $c->uri_for('/static/images/logo.png');
1178 my ( $c, $path, @args ) = @_;
1180 if (blessed($path) && $path->isa('Catalyst::Controller')) {
1181 $path = $path->path_prefix;
1186 undef($path) if (defined $path && $path eq '');
1189 ( scalar @args && ref $args[$#args] eq 'HASH' ? pop @args : {} );
1191 carp "uri_for called with undef argument" if grep { ! defined $_ } @args;
1192 foreach my $arg (@args) {
1193 utf8::encode($arg) if utf8::is_utf8($arg);
1194 $arg =~ s/([^$URI::uric])/$URI::Escape::escapes{$1}/go;
1197 if ( blessed($path) ) { # action object
1198 s|/|%2F|g for @args;
1199 my $captures = [ map { s|/|%2F|g; $_; }
1200 ( scalar @args && ref $args[0] eq 'ARRAY'
1204 foreach my $capture (@$captures) {
1205 utf8::encode($capture) if utf8::is_utf8($capture);
1206 $capture =~ s/([^$URI::uric])/$URI::Escape::escapes{$1}/go;
1210 $path = $c->dispatcher->uri_for_action($action, $captures);
1211 if (not defined $path) {
1212 $c->log->debug(qq/Can't find uri_for action '$action' @$captures/)
1216 $path = '/' if $path eq '';
1219 unshift(@args, $path);
1221 unless (defined $path && $path =~ s!^/!!) { # in-place strip
1222 my $namespace = $c->namespace;
1223 if (defined $path) { # cheesy hack to handle path '../foo'
1224 $namespace =~ s{(?:^|/)[^/]+$}{} while $args[0] =~ s{^\.\./}{};
1226 unshift(@args, $namespace || '');
1229 # join args with '/', or a blank string
1230 my $args = join('/', grep { defined($_) } @args);
1231 $args =~ s/\?/%3F/g; # STUPID STUPID SPECIAL CASE
1233 my $base = $c->req->base;
1234 my $class = ref($base);
1235 $base =~ s{(?<!/)$}{/};
1239 if (my @keys = keys %$params) {
1240 # somewhat lifted from URI::_query's query_form
1241 $query = '?'.join('&', map {
1242 my $val = $params->{$_};
1243 s/([;\/?:@&=+,\$\[\]%])/$URI::Escape::escapes{$1}/go;
1246 $val = '' unless defined $val;
1249 utf8::encode( $param ) if utf8::is_utf8($param);
1250 # using the URI::Escape pattern here so utf8 chars survive
1251 $param =~ s/([^A-Za-z0-9\-_.!~*'() ])/$URI::Escape::escapes{$1}/go;
1253 "${key}=$param"; } ( ref $val eq 'ARRAY' ? @$val : $val ));
1257 my $res = bless(\"${base}${args}${query}", $class);
1261 =head2 $c->uri_for_action( $path, \@captures?, @args?, \%query_values? )
1263 =head2 $c->uri_for_action( $action, \@captures?, @args?, \%query_values? )
1269 A private path to the Catalyst action you want to create a URI for.
1271 This is a shortcut for calling C<< $c->dispatcher->get_action_by_path($path)
1272 >> and passing the resulting C<$action> and the remaining arguments to C<<
1275 You can also pass in a Catalyst::Action object, in which case it is passed to
1278 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.
1280 For example, if the action looks like:
1282 package MyApp::Controller::Users;
1284 sub lst : Path('the-list') {}
1288 $c->uri_for_action('/users/lst')
1290 and it will create the URI /users/the-list.
1296 sub uri_for_action {
1297 my ( $c, $path, @args ) = @_;
1298 my $action = blessed($path)
1300 : $c->dispatcher->get_action_by_path($path);
1301 unless (defined $action) {
1302 croak "Can't find action for path '$path'";
1304 return $c->uri_for( $action, @args );
1307 =head2 $c->welcome_message
1309 Returns the Catalyst welcome HTML page.
1313 sub welcome_message {
1315 my $name = $c->config->{name};
1316 my $logo = $c->uri_for('/static/images/catalyst_logo.png');
1317 my $prefix = Catalyst::Utils::appprefix( ref $c );
1318 $c->response->content_type('text/html; charset=utf-8');
1320 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
1321 "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
1322 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
1324 <meta http-equiv="Content-Language" content="en" />
1325 <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
1326 <title>$name on Catalyst $VERSION</title>
1327 <style type="text/css">
1330 background-color: #eee;
1337 margin-bottom: 10px;
1339 background-color: #ccc;
1340 border: 1px solid #aaa;
1345 font-family: verdana, tahoma, sans-serif;
1348 font-family: verdana, tahoma, sans-serif;
1351 text-decoration: none;
1353 border-bottom: 1px dotted #bbb;
1355 :link:hover, :visited:hover {
1368 background-color: #fff;
1369 border: 1px solid #aaa;
1373 font-weight: normal;
1395 <h1><span id="appname">$name</span> on <a href="http://catalyst.perl.org">Catalyst</a>
1400 <img src="$logo" alt="Catalyst Logo" />
1402 <p>Welcome to the world of Catalyst.
1403 This <a href="http://en.wikipedia.org/wiki/MVC">MVC</a>
1404 framework will make web development something you had
1405 never expected it to be: Fun, rewarding, and quick.</p>
1406 <h2>What to do now?</h2>
1407 <p>That really depends on what <b>you</b> want to do.
1408 We do, however, provide you with a few starting points.</p>
1409 <p>If you want to jump right into web development with Catalyst
1410 you might want to start with a tutorial.</p>
1411 <pre>perldoc <a href="http://cpansearch.perl.org/dist/Catalyst-Manual/lib/Catalyst/Manual/Tutorial.pod">Catalyst::Manual::Tutorial</a></code>
1413 <p>Afterwards you can go on to check out a more complete look at our features.</p>
1415 <code>perldoc <a href="http://cpansearch.perl.org/dist/Catalyst-Manual/lib/Catalyst/Manual/Intro.pod">Catalyst::Manual::Intro</a>
1416 <!-- Something else should go here, but the Catalyst::Manual link seems unhelpful -->
1418 <h2>What to do next?</h2>
1419 <p>Next it's time to write an actual application. Use the
1420 helper scripts to generate <a href="http://cpansearch.perl.org/search?query=Catalyst%3A%3AController%3A%3A&mode=all">controllers</a>,
1421 <a href="http://cpansearch.perl.org/search?query=Catalyst%3A%3AModel%3A%3A&mode=all">models</a>, and
1422 <a href="http://cpansearch.perl.org/search?query=Catalyst%3A%3AView%3A%3A&mode=all">views</a>;
1423 they can save you a lot of work.</p>
1424 <pre><code>script/${prefix}_create.pl --help</code></pre>
1425 <p>Also, be sure to check out the vast and growing
1426 collection of <a href="http://search.cpan.org/search?query=Catalyst">plugins for Catalyst on CPAN</a>;
1427 you are likely to find what you need there.
1431 <p>Catalyst has a very active community. Here are the main places to
1432 get in touch with us.</p>
1435 <a href="http://dev.catalyst.perl.org">Wiki</a>
1438 <a href="http://lists.scsys.co.uk/cgi-bin/mailman/listinfo/catalyst">Mailing-List</a>
1441 <a href="irc://irc.perl.org/catalyst">IRC channel #catalyst on irc.perl.org</a>
1444 <h2>In conclusion</h2>
1445 <p>The Catalyst team hopes you will enjoy using Catalyst as much
1446 as we enjoyed making it. Please contact us if you have ideas
1447 for improvement or other feedback.</p>
1455 =head1 INTERNAL METHODS
1457 These methods are not meant to be used by end users.
1459 =head2 $c->components
1461 Returns a hash of components.
1465 # FIXME - We deal with ->components({'Foo' => 'Bar'})
1466 # however we DO NOT deal with ->components->{Foo} = 'Bar'
1467 # We should return a locked hash back to the user? So that if they try the latter, they
1468 # get breakage, rather than their addition being silently ignored?
1469 around components => sub {
1474 return $class->$orig if ( !$comps );
1476 # FIXME: should this ugly kludge exist?
1477 $class->setup_config unless defined $class->container;
1479 # FIXME: should there be a warning here, not to use this accessor to create the components?
1480 my $components = {};
1483 $containers->{$_} = $class->container->get_sub_container($_) for qw(model view controller);
1485 for my $component ( keys %$comps ) {
1486 $components->{ $component } = $comps->{$component};
1488 my ($type, $name) = _get_component_type_name($component);
1490 $containers->{$type}->add_service(Catalyst::IOC::BlockInjection->new( name => $name, block => sub { return $class->setup_component($component) } ));
1493 return $class->$orig($components);
1496 =head2 $c->context_class
1498 Returns or sets the context class.
1502 Returns a hashref containing coderefs and execution counts (needed for
1503 deep recursion detection).
1507 Returns the number of actions on the current internal execution stack.
1511 Dispatches a request to actions.
1515 sub dispatch { my $c = shift; $c->dispatcher->dispatch( $c, @_ ) }
1517 =head2 $c->dispatcher_class
1519 Returns or sets the dispatcher class.
1521 =head2 $c->dump_these
1523 Returns a list of 2-element array references (name, structure) pairs
1524 that will be dumped on the error page in debug mode.
1530 [ Request => $c->req ],
1531 [ Response => $c->res ],
1532 [ Stash => $c->stash ],
1533 [ Config => $c->config ];
1536 =head2 $c->engine_class
1538 Returns or sets the engine class.
1540 =head2 $c->execute( $class, $coderef )
1542 Execute a coderef in given class and catch exceptions. Errors are available
1548 my ( $c, $class, $code ) = @_;
1549 $class = $c->component($class) || $class;
1552 if ( $c->depth >= $RECURSION ) {
1553 my $action = $code->reverse();
1554 $action = "/$action" unless $action =~ /->/;
1555 my $error = qq/Deep recursion detected calling "${action}"/;
1556 $c->log->error($error);
1562 my $stats_info = $c->_stats_start_execute( $code ) if $c->use_stats;
1564 push( @{ $c->stack }, $code );
1566 no warnings 'recursion';
1567 # N.B. This used to be combined, but I have seen $c get clobbered if so, and
1568 # I have no idea how, ergo $ret (which appears to fix the issue)
1569 eval { my $ret = $code->execute( $class, $c, @{ $c->req->args } ) || 0; $c->state( $ret ) };
1571 $c->_stats_finish_execute( $stats_info ) if $c->use_stats and $stats_info;
1573 my $last = pop( @{ $c->stack } );
1575 if ( my $error = $@ ) {
1576 if ( blessed($error) and $error->isa('Catalyst::Exception::Detach') ) {
1577 $error->rethrow if $c->depth > 1;
1579 elsif ( blessed($error) and $error->isa('Catalyst::Exception::Go') ) {
1580 $error->rethrow if $c->depth > 0;
1583 unless ( ref $error ) {
1584 no warnings 'uninitialized';
1586 my $class = $last->class;
1587 my $name = $last->name;
1588 $error = qq/Caught exception in $class->$name "$error"/;
1597 sub _stats_start_execute {
1598 my ( $c, $code ) = @_;
1599 my $appclass = ref($c) || $c;
1600 return if ( ( $code->name =~ /^_.*/ )
1601 && ( !$appclass->config->{show_internal_actions} ) );
1603 my $action_name = $code->reverse();
1604 $c->counter->{$action_name}++;
1606 my $action = $action_name;
1607 $action = "/$action" unless $action =~ /->/;
1609 # determine if the call was the result of a forward
1610 # this is done by walking up the call stack and looking for a calling
1611 # sub of Catalyst::forward before the eval
1613 for my $index ( 2 .. 11 ) {
1615 if ( ( caller($index) )[0] eq 'Catalyst'
1616 && ( caller($index) )[3] eq '(eval)' );
1618 if ( ( caller($index) )[3] =~ /forward$/ ) {
1619 $callsub = ( caller($index) )[3];
1620 $action = "-> $action";
1625 my $uid = $action_name . $c->counter->{$action_name};
1627 # is this a root-level call or a forwarded call?
1628 if ( $callsub =~ /forward$/ ) {
1629 my $parent = $c->stack->[-1];
1631 # forward, locate the caller
1632 if ( defined $parent && exists $c->counter->{"$parent"} ) {
1635 parent => "$parent" . $c->counter->{"$parent"},
1641 # forward with no caller may come from a plugin
1660 sub _stats_finish_execute {
1661 my ( $c, $info ) = @_;
1662 $c->stats->profile( end => $info );
1667 Finalizes the request.
1674 for my $error ( @{ $c->error } ) {
1675 $c->log->error($error);
1678 # Allow engine to handle finalize flow (for POE)
1679 my $engine = $c->engine;
1680 if ( my $code = $engine->can('finalize') ) {
1685 $c->finalize_uploads;
1688 if ( $#{ $c->error } >= 0 ) {
1692 $c->finalize_headers;
1695 if ( $c->request->method eq 'HEAD' ) {
1696 $c->response->body('');
1704 if ($c->use_stats) {
1705 my $elapsed = sprintf '%f', $c->stats->elapsed;
1706 my $av = $elapsed == 0 ? '??' : sprintf '%.3f', 1 / $elapsed;
1708 "Request took ${elapsed}s ($av/s)\n" . $c->stats->report . "\n" );
1711 return $c->response->status;
1714 =head2 $c->finalize_body
1720 sub finalize_body { my $c = shift; $c->engine->finalize_body( $c, @_ ) }
1722 =head2 $c->finalize_cookies
1728 sub finalize_cookies { my $c = shift; $c->engine->finalize_cookies( $c, @_ ) }
1730 =head2 $c->finalize_error
1736 sub finalize_error { my $c = shift; $c->engine->finalize_error( $c, @_ ) }
1738 =head2 $c->finalize_headers
1744 sub finalize_headers {
1747 my $response = $c->response; #accessor calls can add up?
1749 # Check if we already finalized headers
1750 return if $response->finalized_headers;
1753 if ( my $location = $response->redirect ) {
1754 $c->log->debug(qq/Redirecting to "$location"/) if $c->debug;
1755 $response->header( Location => $location );
1757 if ( !$response->has_body ) {
1758 # Add a default body if none is already present
1760 qq{<html><body><p>This item has moved <a href="$location">here</a>.</p></body></html>}
1766 if ( defined $response->body && length $response->body && !$response->content_length ) {
1768 # get the length from a filehandle
1769 if ( blessed( $response->body ) && $response->body->can('read') || ref( $response->body ) eq 'GLOB' )
1771 my $stat = stat $response->body;
1772 if ( $stat && $stat->size > 0 ) {
1773 $response->content_length( $stat->size );
1776 $c->log->warn('Serving filehandle without a content-length');
1780 # everything should be bytes at this point, but just in case
1781 $response->content_length( length( $response->body ) );
1786 if ( $response->status =~ /^(1\d\d|[23]04)$/ ) {
1787 $response->headers->remove_header("Content-Length");
1788 $response->body('');
1791 $c->finalize_cookies;
1793 $c->engine->finalize_headers( $c, @_ );
1796 $response->finalized_headers(1);
1799 =head2 $c->finalize_output
1801 An alias for finalize_body.
1803 =head2 $c->finalize_read
1805 Finalizes the input after reading is complete.
1809 sub finalize_read { my $c = shift; $c->engine->finalize_read( $c, @_ ) }
1811 =head2 $c->finalize_uploads
1813 Finalizes uploads. Cleans up any temporary files.
1817 sub finalize_uploads { my $c = shift; $c->engine->finalize_uploads( $c, @_ ) }
1819 =head2 $c->get_action( $action, $namespace )
1821 Gets an action in a given namespace.
1825 sub get_action { my $c = shift; $c->dispatcher->get_action(@_) }
1827 =head2 $c->get_actions( $action, $namespace )
1829 Gets all actions of a given name in a namespace and all parent
1834 sub get_actions { my $c = shift; $c->dispatcher->get_actions( $c, @_ ) }
1836 =head2 $app->handle_request( @arguments )
1838 Called to handle each HTTP request.
1842 sub handle_request {
1843 my ( $class, @arguments ) = @_;
1845 # Always expect worst case!
1848 if ($class->debug) {
1849 my $secs = time - $START || 1;
1850 my $av = sprintf '%.3f', $COUNT / $secs;
1851 my $time = localtime time;
1852 $class->log->info("*** Request $COUNT ($av/s) [$$] [$time] ***");
1855 my $c = $class->prepare(@arguments);
1857 $status = $c->finalize;
1860 if ( my $error = $@ ) {
1862 $class->log->error(qq/Caught exception in engine "$error"/);
1867 if(my $coderef = $class->log->can('_flush')){
1868 $class->log->$coderef();
1873 =head2 $c->prepare( @arguments )
1875 Creates a Catalyst context from an engine-specific request (Apache, CGI,
1881 my ( $class, @arguments ) = @_;
1884 # After the app/ctxt split, this should become an attribute based on something passed
1885 # into the application.
1886 $class->context_class( ref $class || $class ) unless $class->context_class;
1888 my $c = $class->context_class->new({});
1890 # For on-demand data
1891 $c->request->_context($c);
1892 $c->response->_context($c);
1894 #surely this is not the most efficient way to do things...
1895 $c->stats($class->stats_class->new)->enable($c->use_stats);
1896 if ( $c->debug || $c->config->{enable_catalyst_header} ) {
1897 $c->res->headers->header( 'X-Catalyst' => $Catalyst::VERSION );
1900 #XXX reuse coderef from can
1901 # Allow engine to direct the prepare flow (for POE)
1902 if ( $c->engine->can('prepare') ) {
1903 $c->engine->prepare( $c, @arguments );
1906 $c->prepare_request(@arguments);
1907 $c->prepare_connection;
1908 $c->prepare_query_parameters;
1909 $c->prepare_headers;
1910 $c->prepare_cookies;
1913 # Prepare the body for reading, either by prepare_body
1914 # or the user, if they are using $c->read
1917 # Parse the body unless the user wants it on-demand
1918 unless ( ref($c)->config->{parse_on_demand} ) {
1923 my $method = $c->req->method || '';
1924 my $path = $c->req->path;
1925 $path = '/' unless length $path;
1926 my $address = $c->req->address || '';
1935 =head2 $c->prepare_action
1937 Prepares action. See L<Catalyst::Dispatcher>.
1941 sub prepare_action { my $c = shift; $c->dispatcher->prepare_action( $c, @_ ) }
1943 =head2 $c->prepare_body
1945 Prepares message body.
1952 return if $c->request->_has_body;
1954 # Initialize on-demand data
1955 $c->engine->prepare_body( $c, @_ );
1956 $c->prepare_parameters;
1957 $c->prepare_uploads;
1960 =head2 $c->prepare_body_chunk( $chunk )
1962 Prepares a chunk of data before sending it to L<HTTP::Body>.
1964 See L<Catalyst::Engine>.
1968 sub prepare_body_chunk {
1970 $c->engine->prepare_body_chunk( $c, @_ );
1973 =head2 $c->prepare_body_parameters
1975 Prepares body parameters.
1979 sub prepare_body_parameters {
1981 $c->engine->prepare_body_parameters( $c, @_ );
1984 =head2 $c->prepare_connection
1986 Prepares connection.
1990 sub prepare_connection {
1992 $c->engine->prepare_connection( $c, @_ );
1995 =head2 $c->prepare_cookies
2001 sub prepare_cookies { my $c = shift; $c->engine->prepare_cookies( $c, @_ ) }
2003 =head2 $c->prepare_headers
2009 sub prepare_headers { my $c = shift; $c->engine->prepare_headers( $c, @_ ) }
2011 =head2 $c->prepare_parameters
2013 Prepares parameters.
2017 sub prepare_parameters {
2019 $c->prepare_body_parameters;
2020 $c->engine->prepare_parameters( $c, @_ );
2023 =head2 $c->prepare_path
2025 Prepares path and base.
2029 sub prepare_path { my $c = shift; $c->engine->prepare_path( $c, @_ ) }
2031 =head2 $c->prepare_query_parameters
2033 Prepares query parameters.
2037 sub prepare_query_parameters {
2040 $c->engine->prepare_query_parameters( $c, @_ );
2043 =head2 $c->log_request
2045 Writes information about the request to the debug logs. This includes:
2049 =item * Request method, path, and remote IP address
2051 =item * Query keywords (see L<Catalyst::Request/query_keywords>)
2053 =item * Request parameters
2055 =item * File uploads
2064 return unless $c->debug;
2066 my($dump) = grep {$_->[0] eq 'Request' } $c->dump_these;
2067 my $request = $dump->[1];
2069 my ( $method, $path, $address ) = ( $request->method, $request->path, $request->address );
2071 $path = '/' unless length $path;
2073 $c->log->debug(qq/"$method" request for "$path" from "$address"/);
2075 $c->log_request_headers($request->headers);
2077 if ( my $keywords = $request->query_keywords ) {
2078 $c->log->debug("Query keywords are: $keywords");
2081 $c->log_request_parameters( query => $request->query_parameters, $request->_has_body ? (body => $request->body_parameters) : () );
2083 $c->log_request_uploads($request);
2086 =head2 $c->log_response
2088 Writes information about the response to the debug logs by calling
2089 C<< $c->log_response_status_line >> and C<< $c->log_response_headers >>.
2096 return unless $c->debug;
2098 my($dump) = grep {$_->[0] eq 'Response' } $c->dump_these;
2099 my $response = $dump->[1];
2101 $c->log_response_status_line($response);
2102 $c->log_response_headers($response->headers);
2105 =head2 $c->log_response_status_line($response)
2107 Writes one line of information about the response to the debug logs. This includes:
2111 =item * Response status code
2113 =item * Content-Type header (if present)
2115 =item * Content-Length header (if present)
2121 sub log_response_status_line {
2122 my ($c, $response) = @_;
2126 'Response Code: %s; Content-Type: %s; Content-Length: %s',
2127 $response->status || 'unknown',
2128 $response->headers->header('Content-Type') || 'unknown',
2129 $response->headers->header('Content-Length') || 'unknown'
2134 =head2 $c->log_response_headers($headers);
2136 Hook method which can be wrapped by plugins to log the responseheaders.
2137 No-op in the default implementation.
2141 sub log_response_headers {}
2143 =head2 $c->log_request_parameters( query => {}, body => {} )
2145 Logs request parameters to debug logs
2149 sub log_request_parameters {
2151 my %all_params = @_;
2153 return unless $c->debug;
2155 my $column_width = Catalyst::Utils::term_width() - 44;
2156 foreach my $type (qw(query body)) {
2157 my $params = $all_params{$type};
2158 next if ! keys %$params;
2159 my $t = Text::SimpleTable->new( [ 35, 'Parameter' ], [ $column_width, 'Value' ] );
2160 for my $key ( sort keys %$params ) {
2161 my $param = $params->{$key};
2162 my $value = defined($param) ? $param : '';
2163 $t->row( $key, ref $value eq 'ARRAY' ? ( join ', ', @$value ) : $value );
2165 $c->log->debug( ucfirst($type) . " Parameters are:\n" . $t->draw );
2169 =head2 $c->log_request_uploads
2171 Logs file uploads included in the request to the debug logs.
2172 The parameter name, filename, file type, and file size are all included in
2177 sub log_request_uploads {
2179 my $request = shift;
2180 return unless $c->debug;
2181 my $uploads = $request->uploads;
2182 if ( keys %$uploads ) {
2183 my $t = Text::SimpleTable->new(
2184 [ 12, 'Parameter' ],
2189 for my $key ( sort keys %$uploads ) {
2190 my $upload = $uploads->{$key};
2191 for my $u ( ref $upload eq 'ARRAY' ? @{$upload} : ($upload) ) {
2192 $t->row( $key, $u->filename, $u->type, $u->size );
2195 $c->log->debug( "File Uploads are:\n" . $t->draw );
2199 =head2 $c->log_request_headers($headers);
2201 Hook method which can be wrapped by plugins to log the request headers.
2202 No-op in the default implementation.
2206 sub log_request_headers {}
2208 =head2 $c->log_headers($type => $headers)
2210 Logs L<HTTP::Headers> (either request or response) to the debug logs.
2217 my $headers = shift; # an HTTP::Headers instance
2219 return unless $c->debug;
2221 my $column_width = Catalyst::Utils::term_width() - 28;
2222 my $t = Text::SimpleTable->new( [ 15, 'Header Name' ], [ $column_width, 'Value' ] );
2225 my ( $name, $value ) = @_;
2226 $t->row( $name, $value );
2229 $c->log->debug( ucfirst($type) . " Headers:\n" . $t->draw );
2233 =head2 $c->prepare_read
2235 Prepares the input for reading.
2239 sub prepare_read { my $c = shift; $c->engine->prepare_read( $c, @_ ) }
2241 =head2 $c->prepare_request
2243 Prepares the engine request.
2247 sub prepare_request { my $c = shift; $c->engine->prepare_request( $c, @_ ) }
2249 =head2 $c->prepare_uploads
2255 sub prepare_uploads {
2258 $c->engine->prepare_uploads( $c, @_ );
2261 =head2 $c->prepare_write
2263 Prepares the output for writing.
2267 sub prepare_write { my $c = shift; $c->engine->prepare_write( $c, @_ ) }
2269 =head2 $c->request_class
2271 Returns or sets the request class. Defaults to L<Catalyst::Request>.
2273 =head2 $c->response_class
2275 Returns or sets the response class. Defaults to L<Catalyst::Response>.
2277 =head2 $c->read( [$maxlength] )
2279 Reads a chunk of data from the request body. This method is designed to
2280 be used in a while loop, reading C<$maxlength> bytes on every call.
2281 C<$maxlength> defaults to the size of the request if not specified.
2283 You have to set C<< MyApp->config(parse_on_demand => 1) >> to use this
2286 Warning: If you use read(), Catalyst will not process the body,
2287 so you will not be able to access POST parameters or file uploads via
2288 $c->request. You must handle all body parsing yourself.
2292 sub read { my $c = shift; return $c->engine->read( $c, @_ ) }
2300 sub run { my $c = shift; return $c->engine->run( $c, @_ ) }
2302 =head2 $c->set_action( $action, $code, $namespace, $attrs )
2304 Sets an action in a given namespace.
2308 sub set_action { my $c = shift; $c->dispatcher->set_action( $c, @_ ) }
2310 =head2 $c->setup_actions($component)
2312 Sets up actions for a component.
2316 sub setup_actions { my $c = shift; $c->dispatcher->setup_actions( $c, @_ ) }
2318 =head2 $c->setup_config
2325 my %args = %{ $class->config || {} };
2327 my @container_classes = ( "${class}::Container", 'Catalyst::IOC::Container');
2328 unshift @container_classes, delete $args{container_class} if exists $args{container_class};
2330 my $container_class = Class::MOP::load_first_existing_class(@container_classes);
2332 my $container = $container_class->new( %args, name => "$class" );
2333 $class->container($container);
2335 my $config = $container->resolve(service => 'config');
2336 $class->config($config);
2337 $class->finalize_config; # back-compat
2340 =head2 $c->finalize_config
2344 sub finalize_config { }
2346 =head2 $c->setup_components
2348 This method is called internally to set up the application's components.
2350 It finds modules by calling the L<locate_components> method, expands them to
2351 package names with the L<expand_component_module> method, and then installs
2352 each component into the application.
2354 The C<setup_components> config option is passed to both of the above methods.
2356 Installation of each component is performed by the L<setup_component> method,
2361 sub setup_components {
2364 my $config = $class->config->{ setup_components };
2365 my $search_extra = $config->{ search_extra };
2367 my @comps = $class->locate_components($config);
2368 my %comps = map { $_ => 1 } @comps;
2370 my $deprecatedcatalyst_component_names = grep { /::[CMV]::/ } @comps;
2371 $class->log->warn(qq{Your application is using the deprecated ::[MVC]:: type naming scheme.\n}.
2372 qq{Please switch your class names to ::Model::, ::View:: and ::Controller: as appropriate.\n}
2373 ) if $deprecatedcatalyst_component_names;
2375 for my $component ( @comps ) {
2377 # We pass ignore_loaded here so that overlay files for (e.g.)
2378 # Model::DBI::Schema sub-classes are loaded - if it's in @comps
2379 # we know M::P::O found a file on disk so this is safe
2381 Catalyst::Utils::ensure_class_loaded( $component, { ignore_loaded => 1 } );
2385 $containers->{$_} = $class->container->get_sub_container($_) for qw(model view controller);
2387 for my $component (@comps) {
2388 my $instance = $class->components->{ $component } = $class->setup_component($component);
2389 if ( my ($type, $name) = _get_component_type_name($component, $search_extra) ) {
2390 $containers->{$type}->add_service(Catalyst::IOC::BlockInjection->new( name => $name, block => sub { return $instance } ));
2392 my @expanded_components = $instance->can('expand_modules')
2393 ? $instance->expand_modules( $component, $config )
2394 : $class->expand_component_module( $component, $config );
2395 for my $component (@expanded_components) {
2396 next if $comps{$component};
2398 $deprecatedcatalyst_component_names = grep { /::[CMV]::/ } @expanded_components;
2399 $class->log->warn(qq{Your application is using the deprecated ::[MVC]:: type naming scheme.\n}.
2400 qq{Please switch your class names to ::Model::, ::View:: and ::Controller: as appropriate.\n}
2401 ) if $deprecatedcatalyst_component_names;
2403 if (my ($type, $name) = _get_component_type_name($component, $search_extra)) {
2404 $containers->{$type}->add_service(Catalyst::IOC::BlockInjection->new( name => $name, block => sub { return $class->setup_component($component) } ));
2407 # FIXME - Remove this!!
2408 $class->components->{ $component } = $class->setup_component($component);
2412 $containers->{model}->make_single_default;
2413 $containers->{view}->make_single_default;
2416 # FIXME: should this sub exist?
2417 # should it be moved to Catalyst::Utils,
2418 # or replaced by something already existing there?
2419 sub _get_component_type_name {
2420 my ( $component, $search_extra) = @_;
2421 $search_extra ||= [];
2422 my @search_extra = map { s/^:://; lc $_ } @$search_extra;
2424 my @parts = split /::/, $component;
2426 if (scalar @parts == 1) {
2427 return (undef, $component);
2430 while (my $type = shift @parts) {
2431 return ('controller', join '::', @parts)
2432 if $type =~ /^(c|controller)$/i;
2434 return ('model', join '::', @parts)
2435 if $type =~ /^(m|model)$/i;
2437 return ('view', join '::', @parts)
2438 if $type =~ /^(v|view)$/i;
2440 return (_get_component_type($component), join '::', @parts)
2441 if @search_extra and ( grep { lc $type eq $_ } @search_extra );
2445 sub _get_component_type {
2446 my ( $instance ) = @_;
2448 return 'controller' if $instance->isa('Catalyst::Controller');
2449 return 'model' if $instance->isa('Catalyst::Model');
2450 return 'view' if $instance->isa('Catalyst::View');
2453 =head2 $c->locate_components( $setup_component_config )
2455 This method is meant to provide a list of component modules that should be
2456 setup for the application. By default, it will use L<Module::Pluggable>.
2458 Specify a C<setup_components> config option to pass additional options directly
2459 to L<Module::Pluggable>. To add additional search paths, specify a key named
2460 C<search_extra> as an array reference. Items in the array beginning with C<::>
2461 will have the application class name prepended to them.
2465 sub locate_components {
2469 my @paths = qw( ::Controller ::C ::Model ::M ::View ::V );
2470 my $extra = delete $config->{ search_extra } || [];
2472 push @paths, @$extra;
2474 my $locator = Module::Pluggable::Object->new(
2475 search_path => [ map { s/^(?=::)/$class/; $_; } @paths ],
2479 # XXX think about ditching this sort entirely
2480 my @comps = sort { length $a <=> length $b } $locator->plugins;
2485 =head2 $c->expand_component_module( $component, $setup_component_config )
2487 Components found by C<locate_components> will be passed to this method, which
2488 is expected to return a list of component (package) names to be set up.
2492 sub expand_component_module {
2493 my ($class, $module) = @_;
2494 return Devel::InnerPackage::list_packages( $module );
2497 =head2 $c->setup_component
2501 ## FIXME - Why the hell do we try calling the ->COMPONENT method twice, this is madness!?!
2502 sub setup_component {
2503 my( $class, $component ) = @_;
2505 unless ( $component->can( 'COMPONENT' ) ) {
2509 my $suffix = Catalyst::Utils::class2classsuffix( $component );
2510 my $config = $class->config->{ $suffix } || {};
2511 # Stash catalyst_component_name in the config here, so that custom COMPONENT
2512 # methods also pass it. local to avoid pointlessly shitting in config
2513 # for the debug screen, as $component is already the key name.
2514 local $config->{catalyst_component_name} = $component;
2516 my $instance = eval { $component->COMPONENT( $class, $config ); };
2518 if ( my $error = $@ ) {
2520 Catalyst::Exception->throw(
2521 message => qq/Couldn't instantiate component "$component", "$error"/
2524 elsif (!blessed $instance) {
2525 my $metaclass = Moose::Util::find_meta($component);
2526 my $method_meta = $metaclass->find_method_by_name('COMPONENT');
2527 my $component_method_from = $method_meta->associated_metaclass->name;
2528 my $value = defined($instance) ? $instance : 'undef';
2529 Catalyst::Exception->throw(
2531 qq/Couldn't instantiate component "$component", COMPONENT() method (from $component_method_from) didn't return an object-like value (value was $value)./
2538 =head2 $c->setup_dispatcher
2544 sub setup_dispatcher {
2545 my ( $class, $dispatcher ) = @_;
2548 $dispatcher = 'Catalyst::Dispatcher::' . $dispatcher;
2551 if ( my $env = Catalyst::Utils::env_value( $class, 'DISPATCHER' ) ) {
2552 $dispatcher = 'Catalyst::Dispatcher::' . $env;
2555 unless ($dispatcher) {
2556 $dispatcher = $class->dispatcher_class;
2559 Class::MOP::load_class($dispatcher);
2561 # dispatcher instance
2562 $class->dispatcher( $dispatcher->new );
2565 =head2 $c->setup_engine
2572 my ( $class, $engine ) = @_;
2575 $engine = 'Catalyst::Engine::' . $engine;
2578 if ( my $env = Catalyst::Utils::env_value( $class, 'ENGINE' ) ) {
2579 $engine = 'Catalyst::Engine::' . $env;
2582 if ( $ENV{MOD_PERL} ) {
2583 my $meta = Class::MOP::get_metaclass_by_name($class);
2585 # create the apache method
2586 $meta->add_method('apache' => sub { shift->engine->apache });
2588 my ( $software, $version ) =
2589 $ENV{MOD_PERL} =~ /^(\S+)\/(\d+(?:[\.\_]\d+)+)/;
2592 $version =~ s/(\.[^.]+)\./$1/g;
2594 if ( $software eq 'mod_perl' ) {
2598 if ( $version >= 1.99922 ) {
2599 $engine = 'Catalyst::Engine::Apache2::MP20';
2602 elsif ( $version >= 1.9901 ) {
2603 $engine = 'Catalyst::Engine::Apache2::MP19';
2606 elsif ( $version >= 1.24 ) {
2607 $engine = 'Catalyst::Engine::Apache::MP13';
2611 Catalyst::Exception->throw( message =>
2612 qq/Unsupported mod_perl version: $ENV{MOD_PERL}/ );
2617 # install the correct mod_perl handler
2618 if ( $version >= 1.9901 ) {
2619 *handler = sub : method {
2620 shift->handle_request(@_);
2624 *handler = sub ($$) { shift->handle_request(@_) };
2629 elsif ( $software eq 'Zeus-Perl' ) {
2630 $engine = 'Catalyst::Engine::Zeus';
2634 Catalyst::Exception->throw(
2635 message => qq/Unsupported mod_perl: $ENV{MOD_PERL}/ );
2640 $engine = $class->engine_class;
2643 Class::MOP::load_class($engine);
2645 # check for old engines that are no longer compatible
2647 if ( $engine->isa('Catalyst::Engine::Apache')
2648 && !Catalyst::Engine::Apache->VERSION )
2653 elsif ( $engine->isa('Catalyst::Engine::Server::Base')
2654 && Catalyst::Engine::Server->VERSION le '0.02' )
2659 elsif ($engine->isa('Catalyst::Engine::HTTP::POE')
2660 && $engine->VERSION eq '0.01' )
2665 elsif ($engine->isa('Catalyst::Engine::Zeus')
2666 && $engine->VERSION eq '0.01' )
2672 Catalyst::Exception->throw( message =>
2673 qq/Engine "$engine" is not supported by this version of Catalyst/
2678 $class->engine( $engine->new );
2681 =head2 $c->setup_home
2683 Sets up the home directory.
2688 my ( $class, $home ) = @_;
2690 if ( my $env = Catalyst::Utils::env_value( $class, 'HOME' ) ) {
2694 $home ||= Catalyst::Utils::home($class);
2697 #I remember recently being scolded for assigning config values like this
2698 $class->config->{home} ||= $home;
2699 $class->config->{root} ||= Path::Class::Dir->new($home)->subdir('root');
2703 =head2 $c->setup_log
2705 Sets up log by instantiating a L<Catalyst::Log|Catalyst::Log> object and
2706 passing it to C<log()>. Pass in a comma-delimited list of levels to set the
2709 This method also installs a C<debug> method that returns a true value into the
2710 catalyst subclass if the "debug" level is passed in the comma-delimited list,
2711 or if the C<$CATALYST_DEBUG> environment variable is set to a true value.
2713 Note that if the log has already been setup, by either a previous call to
2714 C<setup_log> or by a call such as C<< __PACKAGE__->log( MyLogger->new ) >>,
2715 that this method won't actually set up the log object.
2720 my ( $class, $levels ) = @_;
2723 $levels =~ s/^\s+//;
2724 $levels =~ s/\s+$//;
2725 my %levels = map { $_ => 1 } split /\s*,\s*/, $levels;
2727 my $env_debug = Catalyst::Utils::env_value( $class, 'DEBUG' );
2728 if ( defined $env_debug ) {
2729 $levels{debug} = 1 if $env_debug; # Ugly!
2730 delete($levels{debug}) unless $env_debug;
2733 unless ( $class->log ) {
2734 $class->log( Catalyst::Log->new(keys %levels) );
2737 if ( $levels{debug} ) {
2738 Class::MOP::get_metaclass_by_name($class)->add_method('debug' => sub { 1 });
2739 $class->log->debug('Debug messages enabled');
2743 =head2 $c->setup_plugins
2749 =head2 $c->setup_stats
2751 Sets up timing statistics class.
2756 my ( $class, $stats ) = @_;
2758 Catalyst::Utils::ensure_class_loaded($class->stats_class);
2760 my $env = Catalyst::Utils::env_value( $class, 'STATS' );
2761 if ( defined($env) ? $env : ($stats || $class->debug ) ) {
2762 Class::MOP::get_metaclass_by_name($class)->add_method('use_stats' => sub { 1 });
2763 $class->log->debug('Statistics enabled');
2768 =head2 $c->registered_plugins
2770 Returns a sorted list of the plugins which have either been stated in the
2771 import list or which have been added via C<< MyApp->plugin(@args); >>.
2773 If passed a given plugin name, it will report a boolean value indicating
2774 whether or not that plugin is loaded. A fully qualified name is required if
2775 the plugin name does not begin with C<Catalyst::Plugin::>.
2777 if ($c->registered_plugins('Some::Plugin')) {
2785 sub registered_plugins {
2787 return sort keys %{ $proto->_plugins } unless @_;
2789 return 1 if exists $proto->_plugins->{$plugin};
2790 return exists $proto->_plugins->{"Catalyst::Plugin::$plugin"};
2793 sub _register_plugin {
2794 my ( $proto, $plugin, $instant ) = @_;
2795 my $class = ref $proto || $proto;
2797 Class::MOP::load_class( $plugin );
2798 $class->log->warn( "$plugin inherits from 'Catalyst::Component' - this is deprecated and will not work in 5.81" )
2799 if $plugin->isa( 'Catalyst::Component' );
2800 $proto->_plugins->{$plugin} = 1;
2802 my $meta = Class::MOP::get_metaclass_by_name($class);
2803 $meta->superclasses($plugin, $meta->superclasses);
2809 my ( $class, $plugins ) = @_;
2811 $class->_plugins( {} ) unless $class->_plugins;
2812 $plugins = Data::OptList::mkopt($plugins || []);
2815 [ Catalyst::Utils::resolve_namespace(
2816 $class . '::Plugin',
2817 'Catalyst::Plugin', $_->[0]
2823 for my $plugin ( reverse @plugins ) {
2824 Class::MOP::load_class($plugin->[0], $plugin->[1]);
2825 my $meta = find_meta($plugin->[0]);
2826 next if $meta && $meta->isa('Moose::Meta::Role');
2828 $class->_register_plugin($plugin->[0]);
2832 map { $_->[0]->name, $_->[1] }
2833 grep { blessed($_->[0]) && $_->[0]->isa('Moose::Meta::Role') }
2834 map { [find_meta($_->[0]), $_->[1]] }
2837 Moose::Util::apply_all_roles(
2845 Returns an arrayref of the internal execution stack (actions that are
2846 currently executing).
2850 Returns the current timing statistics object. By default Catalyst uses
2851 L<Catalyst::Stats|Catalyst::Stats>, but can be set otherwise with
2852 L<< stats_class|/"$c->stats_class" >>.
2854 Even if L<< -Stats|/"-Stats" >> is not enabled, the stats object is still
2855 available. By enabling it with C< $c->stats->enabled(1) >, it can be used to
2856 profile explicitly, although MyApp.pm still won't profile nor output anything
2859 =head2 $c->stats_class
2861 Returns or sets the stats (timing statistics) class. L<Catalyst::Stats|Catalyst::Stats> is used by default.
2863 =head2 $c->use_stats
2865 Returns 1 when L<< stats collection|/"-Stats" >> is enabled.
2867 Note that this is a static method, not an accessor and should be overridden
2868 by declaring C<sub use_stats { 1 }> in your MyApp.pm, not by calling C<< $c->use_stats(1) >>.
2875 =head2 $c->write( $data )
2877 Writes $data to the output stream. When using this method directly, you
2878 will need to manually set the C<Content-Length> header to the length of
2879 your output data, if known.
2886 # Finalize headers if someone manually writes output
2887 $c->finalize_headers;
2889 return $c->engine->write( $c, @_ );
2894 Returns the Catalyst version number. Mostly useful for "powered by"
2895 messages in template systems.
2899 sub version { return $Catalyst::VERSION }
2901 =head1 CONFIGURATION
2903 There are a number of 'base' config variables which can be set:
2909 C<default_model> - The default model picked if you say C<< $c->model >>. See L<< /$c->model($name) >>.
2913 C<default_view> - The default view to be rendered or returned when C<< $c->view >> is called. See L<< /$c->view($name) >>.
2917 C<home> - The application home directory. In an uninstalled application,
2918 this is the top level application directory. In an installed application,
2919 this will be the directory containing C<< MyApp.pm >>.
2923 C<ignore_frontend_proxy> - See L</PROXY SUPPORT>
2927 C<name> - The name of the application in debug messages and the debug and
2932 C<parse_on_demand> - The request body (for example file uploads) will not be parsed
2933 until it is accessed. This allows you to (for example) check authentication (and reject
2934 the upload) before actually recieving all the data. See L</ON-DEMAND PARSER>
2938 C<root> - The root directory for templates. Usually this is just a
2939 subdirectory of the home directory, but you can set it to change the
2940 templates to a different directory.
2944 C<search_extra> - Array reference passed to Module::Pluggable to for additional
2945 namespaces from which components will be loaded (and constructed and stored in
2946 C<< $c->components >>).
2950 C<show_internal_actions> - If true, causes internal actions such as C<< _DISPATCH >>
2951 to be shown in hit debug tables in the test server.
2955 C<use_request_uri_for_path> - Controlls if the C<REQUEST_URI> or C<PATH_INFO> environment
2956 variable should be used for determining the request path. See L<Catalyst::Engine::CGI/PATH DECODING>
2957 for more information.
2961 C<using_frontend_proxy> - See L</PROXY SUPPORT>.
2965 =head1 INTERNAL ACTIONS
2967 Catalyst uses internal actions like C<_DISPATCH>, C<_BEGIN>, C<_AUTO>,
2968 C<_ACTION>, and C<_END>. These are by default not shown in the private
2969 action table, but you can make them visible with a config parameter.
2971 MyApp->config(show_internal_actions => 1);
2973 =head1 ON-DEMAND PARSER
2975 The request body is usually parsed at the beginning of a request,
2976 but if you want to handle input yourself, you can enable on-demand
2977 parsing with a config parameter.
2979 MyApp->config(parse_on_demand => 1);
2981 =head1 PROXY SUPPORT
2983 Many production servers operate using the common double-server approach,
2984 with a lightweight frontend web server passing requests to a larger
2985 backend server. An application running on the backend server must deal
2986 with two problems: the remote user always appears to be C<127.0.0.1> and
2987 the server's hostname will appear to be C<localhost> regardless of the
2988 virtual host that the user connected through.
2990 Catalyst will automatically detect this situation when you are running
2991 the frontend and backend servers on the same machine. The following
2992 changes are made to the request.
2994 $c->req->address is set to the user's real IP address, as read from
2995 the HTTP X-Forwarded-For header.
2997 The host value for $c->req->base and $c->req->uri is set to the real
2998 host, as read from the HTTP X-Forwarded-Host header.
3000 Additionally, you may be running your backend application on an insecure
3001 connection (port 80) while your frontend proxy is running under SSL. If there
3002 is a discrepancy in the ports, use the HTTP header C<X-Forwarded-Port> to
3003 tell Catalyst what port the frontend listens on. This will allow all URIs to
3004 be created properly.
3006 In the case of passing in:
3008 X-Forwarded-Port: 443
3010 All calls to C<uri_for> will result in an https link, as is expected.
3012 Obviously, your web server must support these headers for this to work.
3014 In a more complex server farm environment where you may have your
3015 frontend proxy server(s) on different machines, you will need to set a
3016 configuration option to tell Catalyst to read the proxied data from the
3019 MyApp->config(using_frontend_proxy => 1);
3021 If you do not wish to use the proxy support at all, you may set:
3023 MyApp->config(ignore_frontend_proxy => 1);
3025 =head1 THREAD SAFETY
3027 Catalyst has been tested under Apache 2's threading C<mpm_worker>,
3028 C<mpm_winnt>, and the standalone forking HTTP server on Windows. We
3029 believe the Catalyst core to be thread-safe.
3031 If you plan to operate in a threaded environment, remember that all other
3032 modules you are using must also be thread-safe. Some modules, most notably
3033 L<DBD::SQLite>, are not thread-safe.
3039 Join #catalyst on irc.perl.org.
3043 http://lists.scsys.co.uk/cgi-bin/mailman/listinfo/catalyst
3044 http://lists.scsys.co.uk/cgi-bin/mailman/listinfo/catalyst-dev
3048 http://catalyst.perl.org
3052 http://dev.catalyst.perl.org
3056 =head2 L<Task::Catalyst> - All you need to start with Catalyst
3058 =head2 L<Catalyst::Manual> - The Catalyst Manual
3060 =head2 L<Catalyst::Component>, L<Catalyst::Controller> - Base classes for components
3062 =head2 L<Catalyst::Engine> - Core engine
3064 =head2 L<Catalyst::Log> - Log class.
3066 =head2 L<Catalyst::Request> - Request object
3068 =head2 L<Catalyst::Response> - Response object
3070 =head2 L<Catalyst::Test> - The test suite.
3072 =head1 PROJECT FOUNDER
3074 sri: Sebastian Riedel <sri@cpan.org>
3080 acme: Leon Brocard <leon@astray.com>
3082 abraxxa: Alexander Hartmaier <abraxxa@cpan.org>
3086 Andrew Ford E<lt>A.Ford@ford-mason.co.ukE<gt>
3092 andyg: Andy Grundman <andy@hybridized.org>
3094 audreyt: Audrey Tang
3096 bricas: Brian Cassidy <bricas@cpan.org>
3098 Caelum: Rafael Kitover <rkitover@io.com>
3100 chansen: Christian Hansen
3102 chicks: Christopher Hicks
3104 Chisel Wright C<pause@herlpacker.co.uk>
3106 Danijel Milicevic C<me@danijel.de>
3108 David Kamholz E<lt>dkamholz@cpan.orgE<gt>
3110 David Naughton, C<naughton@umn.edu>
3114 dhoss: Devin Austin <dhoss@cpan.org>
3116 dkubb: Dan Kubb <dan.kubb-cpan@onautopilot.com>
3120 dwc: Daniel Westermann-Clark <danieltwc@cpan.org>
3122 esskar: Sascha Kiefer
3124 fireartist: Carl Franks <cfranks@cpan.org>
3126 frew: Arthur Axel "fREW" Schmidt <frioux@gmail.com>
3128 gabb: Danijel Milicevic
3132 Gavin Henry C<ghenry@perl.me.uk>
3136 groditi: Guillermo Roditi <groditi@gmail.com>
3138 hobbs: Andrew Rodland <andrew@cleverdomain.org>
3140 ilmari: Dagfinn Ilmari Mannsåker <ilmari@ilmari.org>
3142 jcamacho: Juan Camacho
3144 jester: Jesse Sheidlower C<jester@panix.com>
3146 jhannah: Jay Hannah <jay@jays.net>
3152 jon: Jon Schutz <jjschutz@cpan.org>
3154 Jonathan Rockway C<< <jrockway@cpan.org> >>
3156 Kieren Diment C<kd@totaldatasolution.com>
3158 konobi: Scott McWhirter <konobi@cpan.org>
3160 marcus: Marcus Ramberg <mramberg@cpan.org>
3162 miyagawa: Tatsuhiko Miyagawa <miyagawa@bulknews.net>
3164 mst: Matt S. Trout <mst@shadowcatsystems.co.uk>
3168 naughton: David Naughton
3170 ningu: David Kamholz <dkamholz@cpan.org>
3172 nothingmuch: Yuval Kogman <nothingmuch@woobling.org>
3174 numa: Dan Sully <daniel@cpan.org>
3180 omega: Andreas Marienborg
3182 Oleg Kostyuk <cub.uanic@gmail.com>
3184 phaylon: Robert Sedlacek <phaylon@dunkelheit.at>
3186 rafl: Florian Ragwitz <rafl@debian.org>
3188 random: Roland Lammel <lammel@cpan.org>
3190 Robert Sedlacek C<< <rs@474.at> >>
3192 SpiceMan: Marcel Montes
3196 szbalint: Balint Szilakszi <szbalint@cpan.org>
3198 t0m: Tomas Doran <bobtfish@bobtfish.net>
3202 Viljo Marrandi C<vilts@yahoo.com>
3204 Will Hawes C<info@whawes.co.uk>
3206 willert: Sebastian Willert <willert@cpan.org>
3208 wreis: Wallace Reis <wallace@reis.org.br>
3210 Yuval Kogman, C<nothingmuch@woobling.org>
3212 rainboxx: Matthias Dietrich, C<perl@rainboxx.de>
3214 dd070: Dhaval Dhanani <dhaval070@gmail.com>
3218 Copyright (c) 2005, the above named PROJECT FOUNDER and CONTRIBUTORS.
3222 This library is free software. You can redistribute it and/or modify it under
3223 the same terms as Perl itself.
3229 __PACKAGE__->meta->make_immutable;