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 sub _comp_search_prefixes {
541 return map $c->components->{ $_ }, $c->_comp_names_search_prefixes(@_);
544 # search components given a name and some prefixes
545 sub _comp_names_search_prefixes {
546 my ( $c, $name, @prefixes ) = @_;
547 my $appclass = ref $c || $c;
548 my $filter = "^${appclass}::(" . join( '|', @prefixes ) . ')::';
549 $filter = qr/$filter/; # Compile regex now rather than once per loop
551 my @components = map { $c->container->get_sub_container($_)->get_service_list } qw(controller view model);
553 # map the original component name to the sub part that we will search against
554 my %eligible = map { my $n = $_; $n =~ s{^$appclass\::[^:]+::}{}; $_ => $n; }
555 grep { /$filter/ } @components;
557 # undef for a name will return all
558 return keys %eligible if !defined $name;
560 my $query = ref $name ? $name : qr/^$name$/i;
561 my @result = grep { $eligible{$_} =~ m{$query} } keys %eligible;
563 return @result if @result;
565 # if we were given a regexp to search against, we're done.
568 # skip regexp fallback if configured
570 if $appclass->config->{disable_component_resolution_regex_fallback};
574 @result = grep { $eligible{ $_ } =~ m{$query} } keys %eligible;
576 # no results? try against full names
578 @result = grep { m{$query} } keys %eligible;
581 # don't warn if we didn't find any results, it just might not exist
583 # Disgusting hack to work out correct method name
584 my $warn_for = lc $prefixes[0];
585 my $msg = "Used regexp fallback for \$c->${warn_for}('${name}'), which found '" .
586 (join '", "', @result) . "'. Relying on regexp fallback behavior for " .
587 "component resolution is unreliable and unsafe.";
588 my $short = $result[0];
589 # remove the component namespace prefix
590 $short =~ s/.*?(Model|Controller|View):://;
591 my $shortmess = Carp::shortmess('');
592 if ($shortmess =~ m#Catalyst/Plugin#) {
593 $msg .= " You probably need to set '$short' instead of '${name}' in this " .
595 } elsif ($shortmess =~ m#Catalyst/lib/(View|Controller)#) {
596 $msg .= " You probably need to set '$short' instead of '${name}' in this " .
597 "component's config";
599 $msg .= " You probably meant \$c->${warn_for}('$short') instead of \$c->${warn_for}('${name}'), " .
600 "but if you really wanted to search, pass in a regexp as the argument " .
601 "like so: \$c->${warn_for}(qr/${name}/)";
603 $c->log->warn( "${msg}$shortmess" );
609 # Find possible names for a prefix
611 my ( $c, @prefixes ) = @_;
612 my $appclass = ref $c || $c;
614 my $filter = "^${appclass}::(" . join( '|', @prefixes ) . ')::';
616 my @names = map { s{$filter}{}; $_; }
617 $c->_comp_names_search_prefixes( undef, @prefixes );
622 # Filter a component before returning by calling ACCEPT_CONTEXT if available
623 sub _filter_component {
624 my ( $c, $comp, @args ) = @_;
626 if ( eval { $comp->can('ACCEPT_CONTEXT'); } ) {
627 return $comp->ACCEPT_CONTEXT( $c, @args );
633 =head2 COMPONENT ACCESSORS
635 =head2 $c->controller($name)
637 Gets a L<Catalyst::Controller> instance by name.
639 $c->controller('Foo')->do_stuff;
641 If the name is omitted, will return the controller for the dispatched
644 If you want to search for controllers, pass in a regexp as the argument.
646 # find all controllers that start with Foo
647 my @foo_controllers = $c->controller(qr{^Foo});
653 my ( $c, $name, @args ) = @_;
654 my $container = $c->container->get_sub_container('controller');
656 my $appclass = ref($c) || $c;
658 unless ( ref($name) ) { # Direct component hash lookup to avoid costly regexps
659 my $check = $appclass."::Controller::".$name;
660 return $container->resolve(service => "$check", parameters => { context => \@args } )
661 if $container->has_service($check);
663 my @result = $c->_comp_search_prefixes( $name, qw/Controller C/ );
664 return map { $container->resolve(service => "$_", parameters => { context => \@args } ) } @result if ref $name;
667 return $c->component( $c->action->class );
670 =head2 $c->model($name)
672 Gets a L<Catalyst::Model> instance by name.
674 $c->model('Foo')->do_stuff;
676 Any extra arguments are directly passed to ACCEPT_CONTEXT.
678 If the name is omitted, it will look for
679 - a model object in $c->stash->{current_model_instance}, then
680 - a model name in $c->stash->{current_model}, then
681 - a config setting 'default_model', or
682 - check if there is only one model, and return it if that's the case.
684 If you want to search for models, pass in a regexp as the argument.
686 # find all models that start with Foo
687 my @foo_models = $c->model(qr{^Foo});
692 my ( $c, $name, @args ) = @_;
693 my $appclass = ref($c) || $c;
694 my $container = $c->container->get_sub_container('model');
697 unless ( ref($name) ) { # Direct component hash lookup to avoid costly regexps
698 my $check = $appclass."::Model::".$name;
699 return $container->resolve( service => "$check", parameters => { context => \@args } )
700 if $container->has_service($check);
702 my @result = $c->_comp_search_prefixes( $name, qw/Model M/ );
703 return map { $container->resolve( service => "$_", parameters => { context => \@args } ) } @result if ref $name;
707 return $c->stash->{current_model_instance}
708 if $c->stash->{current_model_instance};
709 return $c->model( $c->stash->{current_model} )
710 if $c->stash->{current_model};
712 return $c->model( $appclass->config->{default_model} )
713 if $appclass->config->{default_model};
715 # FIXME: will this still be mantained?
716 my( $comp, $rest ) = $c->_comp_search_prefixes( undef, qw/Model M/);
719 $c->log->warn( Carp::shortmess('Calling $c->model() will return a random model unless you specify one of:') );
720 $c->log->warn( '* $c->config(default_model => "the name of the default model to use")' );
721 $c->log->warn( '* $c->stash->{current_model} # the name of the model to use for this request' );
722 $c->log->warn( '* $c->stash->{current_model_instance} # the instance of the model to use for this request' );
723 $c->log->warn( 'NB: in version 5.81, the "random" behavior will not work at all.' );
726 return $container->resolve( service => ref $comp, parameters => { context => \@args } );
730 =head2 $c->view($name)
732 Gets a L<Catalyst::View> instance by name.
734 $c->view('Foo')->do_stuff;
736 Any extra arguments are directly passed to ACCEPT_CONTEXT.
738 If the name is omitted, it will look for
739 - a view object in $c->stash->{current_view_instance}, then
740 - a view name in $c->stash->{current_view}, then
741 - a config setting 'default_view', or
742 - check if there is only one view, and return it if that's the case.
744 If you want to search for views, pass in a regexp as the argument.
746 # find all views that start with Foo
747 my @foo_views = $c->view(qr{^Foo});
752 my ( $c, $name, @args ) = @_;
753 my $appclass = ref($c) || $c;
754 my $container = $c->container->get_sub_container('view');
757 unless ( ref($name) ) { # Direct component hash lookup to avoid costly regexps
758 my $check = $appclass."::View::".$name;
759 if ($container->has_service($check)) {
760 return $container->resolve(service => $check, parameters => { context => \@args } );
763 $c->log->warn( "Attempted to use view '$check', but does not exist" );
766 my @result = $c->_comp_search_prefixes( $name, qw/View V/ );
767 return map { $container->resolve(service => "$_", parameters => { context => \@args } ) } @result if ref $name;
771 return $c->stash->{current_view_instance}
772 if $c->stash->{current_view_instance};
773 return $c->view( $c->stash->{current_view} )
774 if $c->stash->{current_view};
776 return $c->view( $appclass->config->{default_view} )
777 if $appclass->config->{default_view};
779 my( $comp, $rest ) = $c->_comp_search_prefixes( undef, qw/View V/);
782 $c->log->warn( 'Calling $c->view() will return a random view unless you specify one of:' );
783 $c->log->warn( '* $c->config(default_view => "the name of the default view to use")' );
784 $c->log->warn( '* $c->stash->{current_view} # the name of the view to use for this request' );
785 $c->log->warn( '* $c->stash->{current_view_instance} # the instance of the view to use for this request' );
786 $c->log->warn( 'NB: in version 5.81, the "random" behavior will not work at all.' );
789 return $container->resolve( service => ref $comp, parameters => { context => \@args } );
792 =head2 $c->controllers
794 Returns the available names which can be passed to $c->controller
800 return $c->container->get_sub_container('controller')->get_service_list;
805 Returns the available names which can be passed to $c->model
811 return $c->container->get_sub_container('model')->get_service_list;
817 Returns the available names which can be passed to $c->view
823 return $c->container->get_sub_container('view')->get_service_list;
826 =head2 $c->comp($name)
828 =head2 $c->component($name)
830 Gets a component object by name. This method is not recommended,
831 unless you want to get a specific component by full
832 class. C<< $c->controller >>, C<< $c->model >>, and C<< $c->view >>
833 should be used instead.
835 If C<$name> is a regexp, a list of components matched against the full
836 component name will be returned.
838 If Catalyst can't find a component by name, it will fallback to regex
839 matching by default. To disable this behaviour set
840 disable_component_resolution_regex_fallback to a true value.
842 __PACKAGE__->config( disable_component_resolution_regex_fallback => 1 );
847 my ( $c, $name, @args ) = @_;
850 my $comps = $c->components;
853 # is it the exact name?
854 return $c->_filter_component( $comps->{ $name }, @args )
855 if exists $comps->{ $name };
857 # perhaps we just omitted "MyApp"?
858 my $composed = ( ref $c || $c ) . "::${name}";
859 return $c->_filter_component( $comps->{ $composed }, @args )
860 if exists $comps->{ $composed };
862 # search all of the models, views and controllers
863 my( $comp ) = $c->_comp_search_prefixes( $name, qw/Model M Controller C View V/ );
864 return $c->_filter_component( $comp, @args ) if $comp;
868 if $c->config->{disable_component_resolution_regex_fallback};
870 # This is here so $c->comp( '::M::' ) works
871 my $query = ref $name ? $name : qr{$name}i;
873 my @result = grep { m{$query} } keys %{ $c->components };
874 return map { $c->_filter_component( $_, @args ) } @result if ref $name;
877 $c->log->warn( Carp::shortmess(qq(Found results for "${name}" using regexp fallback)) );
878 $c->log->warn( 'Relying on the regexp fallback behavior for component resolution' );
879 $c->log->warn( 'is unreliable and unsafe. You have been warned' );
880 return $c->_filter_component( $result[ 0 ], @args );
883 # I would expect to return an empty list here, but that breaks back-compat
887 return sort keys %{ $c->components };
890 =head2 CLASS DATA AND HELPER CLASSES
894 Returns or takes a hashref containing the application's configuration.
896 __PACKAGE__->config( { db => 'dsn:SQLite:foo.db' } );
898 You can also use a C<YAML>, C<XML> or L<Config::General> config file
899 like C<myapp.conf> in your applications home directory. See
900 L<Catalyst::Plugin::ConfigLoader>.
902 =head3 Cascading configuration
904 The config method is present on all Catalyst components, and configuration
905 will be merged when an application is started. Configuration loaded with
906 L<Catalyst::Plugin::ConfigLoader> takes precedence over other configuration,
907 followed by configuration in your top level C<MyApp> class. These two
908 configurations are merged, and then configuration data whose hash key matches a
909 component name is merged with configuration for that component.
911 The configuration for a component is then passed to the C<new> method when a
912 component is constructed.
916 MyApp->config({ 'Model::Foo' => { bar => 'baz', overrides => 'me' } });
917 MyApp::Model::Foo->config({ quux => 'frob', overrides => 'this' });
919 will mean that C<MyApp::Model::Foo> receives the following data when
922 MyApp::Model::Foo->new({
928 It's common practice to use a Moose attribute
929 on the receiving component to access the config value.
931 package MyApp::Model::Foo;
935 # this attr will receive 'baz' at construction time
941 You can then get the value 'baz' by calling $c->model('Foo')->bar
942 (or $self->bar inside code in the model).
944 B<NOTE:> you MUST NOT call C<< $self->config >> or C<< __PACKAGE__->config >>
945 as a way of reading config within your code, as this B<will not> give you the
946 correctly merged config back. You B<MUST> take the config values supplied to
947 the constructor and use those instead.
951 around config => sub {
955 croak('Setting config after setup has been run is not allowed.')
956 if ( @_ and $c->setup_finished );
963 Returns the logging object instance. Unless it is already set, Catalyst
964 sets this up with a L<Catalyst::Log> object. To use your own log class,
965 set the logger with the C<< __PACKAGE__->log >> method prior to calling
966 C<< __PACKAGE__->setup >>.
968 __PACKAGE__->log( MyLogger->new );
973 $c->log->info( 'Now logging with my own logger!' );
975 Your log class should implement the methods described in
981 Returns 1 if debug mode is enabled, 0 otherwise.
983 You can enable debug mode in several ways:
987 =item By calling myapp_server.pl with the -d flag
989 =item With the environment variables MYAPP_DEBUG, or CATALYST_DEBUG
991 =item The -Debug option in your MyApp.pm
993 =item By declaring C<sub debug { 1 }> in your MyApp.pm.
997 The first three also set the log level to 'debug'.
999 Calling C<< $c->debug(1) >> has no effect.
1005 =head2 $c->dispatcher
1007 Returns the dispatcher instance. See L<Catalyst::Dispatcher>.
1011 Returns the engine instance. See L<Catalyst::Engine>.
1014 =head2 UTILITY METHODS
1016 =head2 $c->path_to(@path)
1018 Merges C<@path> with C<< $c->config->{home} >> and returns a
1019 L<Path::Class::Dir> object. Note you can usually use this object as
1020 a filename, but sometimes you will have to explicitly stringify it
1021 yourself by calling the C<< ->stringify >> method.
1025 $c->path_to( 'db', 'sqlite.db' );
1030 my ( $c, @path ) = @_;
1031 my $path = Path::Class::Dir->new( $c->config->{home}, @path );
1032 if ( -d $path ) { return $path }
1033 else { return Path::Class::File->new( $c->config->{home}, @path ) }
1036 =head2 $c->plugin( $name, $class, @args )
1038 Helper method for plugins. It creates a class data accessor/mutator and
1039 loads and instantiates the given class.
1041 MyApp->plugin( 'prototype', 'HTML::Prototype' );
1043 $c->prototype->define_javascript_functions;
1045 B<Note:> This method of adding plugins is deprecated. The ability
1046 to add plugins like this B<will be removed> in a Catalyst 5.81.
1047 Please do not use this functionality in new code.
1052 my ( $class, $name, $plugin, @args ) = @_;
1054 # See block comment in t/unit_core_plugin.t
1055 $class->log->warn(qq/Adding plugin using the ->plugin method is deprecated, and will be removed in Catalyst 5.81/);
1057 $class->_register_plugin( $plugin, 1 );
1059 eval { $plugin->import };
1060 $class->mk_classdata($name);
1062 eval { $obj = $plugin->new(@args) };
1065 Catalyst::Exception->throw( message =>
1066 qq/Couldn't instantiate instant plugin "$plugin", "$@"/ );
1069 $class->$name($obj);
1070 $class->log->debug(qq/Initialized instant plugin "$plugin" as "$name"/)
1076 Initializes the dispatcher and engine, loads any plugins, and loads the
1077 model, view, and controller components. You may also specify an array
1078 of plugins to load here, if you choose to not load them in the C<use
1082 MyApp->setup( qw/-Debug/ );
1087 my ( $class, @arguments ) = @_;
1088 croak('Running setup more than once')
1089 if ( $class->setup_finished );
1091 unless ( $class->isa('Catalyst') ) {
1093 Catalyst::Exception->throw(
1094 message => qq/'$class' does not inherit from Catalyst/ );
1097 if ( $class->arguments ) {
1098 @arguments = ( @arguments, @{ $class->arguments } );
1104 foreach (@arguments) {
1108 ( $flags->{log} ) ? 'debug,' . $flags->{log} : 'debug';
1110 elsif (/^-(\w+)=?(.*)$/) {
1111 $flags->{ lc $1 } = $2;
1114 push @{ $flags->{plugins} }, $_;
1118 $class->setup_config();
1119 $class->setup_home( delete $flags->{home} );
1121 $class->setup_log( delete $flags->{log} );
1122 $class->setup_plugins( delete $flags->{plugins} );
1123 $class->setup_dispatcher( delete $flags->{dispatcher} );
1124 $class->setup_engine( delete $flags->{engine} );
1125 $class->setup_stats( delete $flags->{stats} );
1127 for my $flag ( sort keys %{$flags} ) {
1129 if ( my $code = $class->can( 'setup_' . $flag ) ) {
1130 &$code( $class, delete $flags->{$flag} );
1133 $class->log->warn(qq/Unknown flag "$flag"/);
1137 eval { require Catalyst::Devel; };
1138 if( !$@ && $ENV{CATALYST_SCRIPT_GEN} && ( $ENV{CATALYST_SCRIPT_GEN} < $Catalyst::Devel::CATALYST_SCRIPT_GEN ) ) {
1139 $class->log->warn(<<"EOF");
1140 You are running an old script!
1142 Please update by running (this will overwrite existing files):
1143 catalyst.pl -force -scripts $class
1145 or (this will not overwrite existing files):
1146 catalyst.pl -scripts $class
1151 if ( $class->debug ) {
1152 my @plugins = map { "$_ " . ( $_->VERSION || '' ) } $class->registered_plugins;
1155 my $column_width = Catalyst::Utils::term_width() - 6;
1156 my $t = Text::SimpleTable->new($column_width);
1157 $t->row($_) for @plugins;
1158 $class->log->debug( "Loaded plugins:\n" . $t->draw . "\n" );
1161 my $dispatcher = $class->dispatcher;
1162 my $engine = $class->engine;
1163 my $home = $class->config->{home};
1165 $class->log->debug(sprintf(q/Loaded dispatcher "%s"/, blessed($dispatcher)));
1166 $class->log->debug(sprintf(q/Loaded engine "%s"/, blessed($engine)));
1170 ? $class->log->debug(qq/Found home "$home"/)
1171 : $class->log->debug(qq/Home "$home" doesn't exist/)
1172 : $class->log->debug(q/Couldn't find home/);
1175 # Call plugins setup, this is stupid and evil.
1176 # Also screws C3 badly on 5.10, hack to avoid.
1178 no warnings qw/redefine/;
1179 local *setup = sub { };
1180 $class->setup unless $Catalyst::__AM_RESTARTING;
1183 # Initialize our data structure
1184 $class->components( {} );
1186 $class->setup_components;
1188 if ( $class->debug ) {
1189 my $column_width = Catalyst::Utils::term_width() - 8 - 9;
1190 my $t = Text::SimpleTable->new( [ $column_width, 'Class' ], [ 8, 'Type' ] );
1191 for my $comp ( sort keys %{ $class->components } ) {
1192 my $type = ref $class->components->{$comp} ? 'instance' : 'class';
1193 $t->row( $comp, $type );
1195 $class->log->debug( "Loaded components:\n" . $t->draw . "\n" )
1196 if ( keys %{ $class->components } );
1199 # Add our self to components, since we are also a component
1200 if( $class->isa('Catalyst::Controller') ){
1201 $class->components->{$class} = $class;
1204 $class->setup_actions;
1206 if ( $class->debug ) {
1207 my $name = $class->config->{name} || 'Application';
1208 $class->log->info("$name powered by Catalyst $Catalyst::VERSION");
1211 # Make sure that the application class becomes immutable at this point,
1212 B::Hooks::EndOfScope::on_scope_end {
1214 my $meta = Class::MOP::get_metaclass_by_name($class);
1217 && ! { $meta->immutable_options }->{replace_constructor}
1219 $class->isa('Class::Accessor::Fast')
1220 || $class->isa('Class::Accessor')
1223 warn "You made your application class ($class) immutable, "
1224 . "but did not inline the\nconstructor. "
1225 . "This will break catalyst, as your app \@ISA "
1226 . "Class::Accessor(::Fast)?\nPlease pass "
1227 . "(replace_constructor => 1)\nwhen making your class immutable.\n";
1229 $meta->make_immutable(
1230 replace_constructor => 1,
1231 ) unless $meta->is_immutable;
1234 if ($class->config->{case_sensitive}) {
1235 $class->log->warn($class . "->config->{case_sensitive} is set.");
1236 $class->log->warn("This setting is deprecated and planned to be removed in Catalyst 5.81.");
1239 $class->setup_finalize;
1240 # Should be the last thing we do so that user things hooking
1241 # setup_finalize can log..
1242 $class->log->_flush() if $class->log->can('_flush');
1243 return 1; # Explicit return true as people have __PACKAGE__->setup as the last thing in their class. HATE.
1246 =head2 $app->setup_finalize
1248 A hook to attach modifiers to. This method does not do anything except set the
1249 C<setup_finished> accessor.
1251 Applying method modifiers to the C<setup> method doesn't work, because of quirky things done for plugin setup.
1255 after setup_finalize => sub {
1263 sub setup_finalize {
1265 $class->setup_finished(1);
1268 =head2 $c->uri_for( $path?, @args?, \%query_values? )
1270 =head2 $c->uri_for( $action, \@captures?, @args?, \%query_values? )
1272 Constructs an absolute L<URI> object based on the application root, the
1273 provided path, and the additional arguments and query parameters provided.
1274 When used as a string, provides a textual URI. If you need more flexibility
1275 than this (i.e. the option to provide relative URIs etc.) see
1276 L<Catalyst::Plugin::SmartURI>.
1278 If no arguments are provided, the URI for the current action is returned.
1279 To return the current action and also provide @args, use
1280 C<< $c->uri_for( $c->action, @args ) >>.
1282 If the first argument is a string, it is taken as a public URI path relative
1283 to C<< $c->namespace >> (if it doesn't begin with a forward slash) or
1284 relative to the application root (if it does). It is then merged with
1285 C<< $c->request->base >>; any C<@args> are appended as additional path
1286 components; and any C<%query_values> are appended as C<?foo=bar> parameters.
1288 If the first argument is a L<Catalyst::Action> it represents an action which
1289 will have its path resolved using C<< $c->dispatcher->uri_for_action >>. The
1290 optional C<\@captures> argument (an arrayref) allows passing the captured
1291 variables that are needed to fill in the paths of Chained and Regex actions;
1292 once the path is resolved, C<uri_for> continues as though a path was
1293 provided, appending any arguments or parameters and creating an absolute
1296 The captures for the current request can be found in
1297 C<< $c->request->captures >>, and actions can be resolved using
1298 C<< Catalyst::Controller->action_for($name) >>. If you have a private action
1299 path, use C<< $c->uri_for_action >> instead.
1301 # Equivalent to $c->req->uri
1302 $c->uri_for($c->action, $c->req->captures,
1303 @{ $c->req->args }, $c->req->params);
1305 # For the Foo action in the Bar controller
1306 $c->uri_for($c->controller('Bar')->action_for('Foo'));
1308 # Path to a static resource
1309 $c->uri_for('/static/images/logo.png');
1314 my ( $c, $path, @args ) = @_;
1316 if (blessed($path) && $path->isa('Catalyst::Controller')) {
1317 $path = $path->path_prefix;
1322 undef($path) if (defined $path && $path eq '');
1325 ( scalar @args && ref $args[$#args] eq 'HASH' ? pop @args : {} );
1327 carp "uri_for called with undef argument" if grep { ! defined $_ } @args;
1328 foreach my $arg (@args) {
1329 utf8::encode($arg) if utf8::is_utf8($arg);
1330 $arg =~ s/([^$URI::uric])/$URI::Escape::escapes{$1}/go;
1333 if ( blessed($path) ) { # action object
1334 s|/|%2F|g for @args;
1335 my $captures = [ map { s|/|%2F|g; $_; }
1336 ( scalar @args && ref $args[0] eq 'ARRAY'
1340 foreach my $capture (@$captures) {
1341 utf8::encode($capture) if utf8::is_utf8($capture);
1342 $capture =~ s/([^$URI::uric])/$URI::Escape::escapes{$1}/go;
1346 $path = $c->dispatcher->uri_for_action($action, $captures);
1347 if (not defined $path) {
1348 $c->log->debug(qq/Can't find uri_for action '$action' @$captures/)
1352 $path = '/' if $path eq '';
1355 unshift(@args, $path);
1357 unless (defined $path && $path =~ s!^/!!) { # in-place strip
1358 my $namespace = $c->namespace;
1359 if (defined $path) { # cheesy hack to handle path '../foo'
1360 $namespace =~ s{(?:^|/)[^/]+$}{} while $args[0] =~ s{^\.\./}{};
1362 unshift(@args, $namespace || '');
1365 # join args with '/', or a blank string
1366 my $args = join('/', grep { defined($_) } @args);
1367 $args =~ s/\?/%3F/g; # STUPID STUPID SPECIAL CASE
1369 my $base = $c->req->base;
1370 my $class = ref($base);
1371 $base =~ s{(?<!/)$}{/};
1375 if (my @keys = keys %$params) {
1376 # somewhat lifted from URI::_query's query_form
1377 $query = '?'.join('&', map {
1378 my $val = $params->{$_};
1379 s/([;\/?:@&=+,\$\[\]%])/$URI::Escape::escapes{$1}/go;
1382 $val = '' unless defined $val;
1385 utf8::encode( $param ) if utf8::is_utf8($param);
1386 # using the URI::Escape pattern here so utf8 chars survive
1387 $param =~ s/([^A-Za-z0-9\-_.!~*'() ])/$URI::Escape::escapes{$1}/go;
1389 "${key}=$param"; } ( ref $val eq 'ARRAY' ? @$val : $val ));
1393 my $res = bless(\"${base}${args}${query}", $class);
1397 =head2 $c->uri_for_action( $path, \@captures?, @args?, \%query_values? )
1399 =head2 $c->uri_for_action( $action, \@captures?, @args?, \%query_values? )
1405 A private path to the Catalyst action you want to create a URI for.
1407 This is a shortcut for calling C<< $c->dispatcher->get_action_by_path($path)
1408 >> and passing the resulting C<$action> and the remaining arguments to C<<
1411 You can also pass in a Catalyst::Action object, in which case it is passed to
1414 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.
1416 For example, if the action looks like:
1418 package MyApp::Controller::Users;
1420 sub lst : Path('the-list') {}
1424 $c->uri_for_action('/users/lst')
1426 and it will create the URI /users/the-list.
1432 sub uri_for_action {
1433 my ( $c, $path, @args ) = @_;
1434 my $action = blessed($path)
1436 : $c->dispatcher->get_action_by_path($path);
1437 unless (defined $action) {
1438 croak "Can't find action for path '$path'";
1440 return $c->uri_for( $action, @args );
1443 =head2 $c->welcome_message
1445 Returns the Catalyst welcome HTML page.
1449 sub welcome_message {
1451 my $name = $c->config->{name};
1452 my $logo = $c->uri_for('/static/images/catalyst_logo.png');
1453 my $prefix = Catalyst::Utils::appprefix( ref $c );
1454 $c->response->content_type('text/html; charset=utf-8');
1456 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
1457 "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
1458 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
1460 <meta http-equiv="Content-Language" content="en" />
1461 <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
1462 <title>$name on Catalyst $VERSION</title>
1463 <style type="text/css">
1466 background-color: #eee;
1473 margin-bottom: 10px;
1475 background-color: #ccc;
1476 border: 1px solid #aaa;
1481 font-family: verdana, tahoma, sans-serif;
1484 font-family: verdana, tahoma, sans-serif;
1487 text-decoration: none;
1489 border-bottom: 1px dotted #bbb;
1491 :link:hover, :visited:hover {
1504 background-color: #fff;
1505 border: 1px solid #aaa;
1509 font-weight: normal;
1531 <h1><span id="appname">$name</span> on <a href="http://catalyst.perl.org">Catalyst</a>
1536 <img src="$logo" alt="Catalyst Logo" />
1538 <p>Welcome to the world of Catalyst.
1539 This <a href="http://en.wikipedia.org/wiki/MVC">MVC</a>
1540 framework will make web development something you had
1541 never expected it to be: Fun, rewarding, and quick.</p>
1542 <h2>What to do now?</h2>
1543 <p>That really depends on what <b>you</b> want to do.
1544 We do, however, provide you with a few starting points.</p>
1545 <p>If you want to jump right into web development with Catalyst
1546 you might want to start with a tutorial.</p>
1547 <pre>perldoc <a href="http://cpansearch.perl.org/dist/Catalyst-Manual/lib/Catalyst/Manual/Tutorial.pod">Catalyst::Manual::Tutorial</a></code>
1549 <p>Afterwards you can go on to check out a more complete look at our features.</p>
1551 <code>perldoc <a href="http://cpansearch.perl.org/dist/Catalyst-Manual/lib/Catalyst/Manual/Intro.pod">Catalyst::Manual::Intro</a>
1552 <!-- Something else should go here, but the Catalyst::Manual link seems unhelpful -->
1554 <h2>What to do next?</h2>
1555 <p>Next it's time to write an actual application. Use the
1556 helper scripts to generate <a href="http://cpansearch.perl.org/search?query=Catalyst%3A%3AController%3A%3A&mode=all">controllers</a>,
1557 <a href="http://cpansearch.perl.org/search?query=Catalyst%3A%3AModel%3A%3A&mode=all">models</a>, and
1558 <a href="http://cpansearch.perl.org/search?query=Catalyst%3A%3AView%3A%3A&mode=all">views</a>;
1559 they can save you a lot of work.</p>
1560 <pre><code>script/${prefix}_create.pl --help</code></pre>
1561 <p>Also, be sure to check out the vast and growing
1562 collection of <a href="http://search.cpan.org/search?query=Catalyst">plugins for Catalyst on CPAN</a>;
1563 you are likely to find what you need there.
1567 <p>Catalyst has a very active community. Here are the main places to
1568 get in touch with us.</p>
1571 <a href="http://dev.catalyst.perl.org">Wiki</a>
1574 <a href="http://lists.scsys.co.uk/cgi-bin/mailman/listinfo/catalyst">Mailing-List</a>
1577 <a href="irc://irc.perl.org/catalyst">IRC channel #catalyst on irc.perl.org</a>
1580 <h2>In conclusion</h2>
1581 <p>The Catalyst team hopes you will enjoy using Catalyst as much
1582 as we enjoyed making it. Please contact us if you have ideas
1583 for improvement or other feedback.</p>
1591 =head1 INTERNAL METHODS
1593 These methods are not meant to be used by end users.
1595 =head2 $c->components
1597 Returns a hash of components.
1601 around components => sub {
1606 return $class->$orig if ( !$comps );
1608 # FIXME: should this ugly kludge exist?
1609 $class->setup_config unless defined $class->container;
1611 # FIXME: should there be a warning here, not to use this accessor to create the components?
1612 my $components = {};
1615 $containers->{$_} = $class->container->get_sub_container($_) for qw(model view controller);
1617 for my $component ( keys %$comps ) {
1618 $components->{ $component } = $comps->{$component};
1620 my ($type, $name) = _get_component_type_name($component);
1622 # FIXME: shouldn't the service name be $name?
1623 $containers->{$type}->add_service(Catalyst::BlockInjection->new( name => $component, block => sub { return $class->setup_component($component) } ));
1626 return $class->$orig($components);
1629 =head2 $c->context_class
1631 Returns or sets the context class.
1635 Returns a hashref containing coderefs and execution counts (needed for
1636 deep recursion detection).
1640 Returns the number of actions on the current internal execution stack.
1644 Dispatches a request to actions.
1648 sub dispatch { my $c = shift; $c->dispatcher->dispatch( $c, @_ ) }
1650 =head2 $c->dispatcher_class
1652 Returns or sets the dispatcher class.
1654 =head2 $c->dump_these
1656 Returns a list of 2-element array references (name, structure) pairs
1657 that will be dumped on the error page in debug mode.
1663 [ Request => $c->req ],
1664 [ Response => $c->res ],
1665 [ Stash => $c->stash ],
1666 [ Config => $c->config ];
1669 =head2 $c->engine_class
1671 Returns or sets the engine class.
1673 =head2 $c->execute( $class, $coderef )
1675 Execute a coderef in given class and catch exceptions. Errors are available
1681 my ( $c, $class, $code ) = @_;
1682 $class = $c->component($class) || $class;
1685 if ( $c->depth >= $RECURSION ) {
1686 my $action = $code->reverse();
1687 $action = "/$action" unless $action =~ /->/;
1688 my $error = qq/Deep recursion detected calling "${action}"/;
1689 $c->log->error($error);
1695 my $stats_info = $c->_stats_start_execute( $code ) if $c->use_stats;
1697 push( @{ $c->stack }, $code );
1699 no warnings 'recursion';
1700 # N.B. This used to be combined, but I have seen $c get clobbered if so, and
1701 # I have no idea how, ergo $ret (which appears to fix the issue)
1702 eval { my $ret = $code->execute( $class, $c, @{ $c->req->args } ) || 0; $c->state( $ret ) };
1704 $c->_stats_finish_execute( $stats_info ) if $c->use_stats and $stats_info;
1706 my $last = pop( @{ $c->stack } );
1708 if ( my $error = $@ ) {
1709 if ( blessed($error) and $error->isa('Catalyst::Exception::Detach') ) {
1710 $error->rethrow if $c->depth > 1;
1712 elsif ( blessed($error) and $error->isa('Catalyst::Exception::Go') ) {
1713 $error->rethrow if $c->depth > 0;
1716 unless ( ref $error ) {
1717 no warnings 'uninitialized';
1719 my $class = $last->class;
1720 my $name = $last->name;
1721 $error = qq/Caught exception in $class->$name "$error"/;
1730 sub _stats_start_execute {
1731 my ( $c, $code ) = @_;
1732 my $appclass = ref($c) || $c;
1733 return if ( ( $code->name =~ /^_.*/ )
1734 && ( !$appclass->config->{show_internal_actions} ) );
1736 my $action_name = $code->reverse();
1737 $c->counter->{$action_name}++;
1739 my $action = $action_name;
1740 $action = "/$action" unless $action =~ /->/;
1742 # determine if the call was the result of a forward
1743 # this is done by walking up the call stack and looking for a calling
1744 # sub of Catalyst::forward before the eval
1746 for my $index ( 2 .. 11 ) {
1748 if ( ( caller($index) )[0] eq 'Catalyst'
1749 && ( caller($index) )[3] eq '(eval)' );
1751 if ( ( caller($index) )[3] =~ /forward$/ ) {
1752 $callsub = ( caller($index) )[3];
1753 $action = "-> $action";
1758 my $uid = $action_name . $c->counter->{$action_name};
1760 # is this a root-level call or a forwarded call?
1761 if ( $callsub =~ /forward$/ ) {
1762 my $parent = $c->stack->[-1];
1764 # forward, locate the caller
1765 if ( defined $parent && exists $c->counter->{"$parent"} ) {
1768 parent => "$parent" . $c->counter->{"$parent"},
1774 # forward with no caller may come from a plugin
1793 sub _stats_finish_execute {
1794 my ( $c, $info ) = @_;
1795 $c->stats->profile( end => $info );
1800 Finalizes the request.
1807 for my $error ( @{ $c->error } ) {
1808 $c->log->error($error);
1811 # Allow engine to handle finalize flow (for POE)
1812 my $engine = $c->engine;
1813 if ( my $code = $engine->can('finalize') ) {
1818 $c->finalize_uploads;
1821 if ( $#{ $c->error } >= 0 ) {
1825 $c->finalize_headers;
1828 if ( $c->request->method eq 'HEAD' ) {
1829 $c->response->body('');
1837 if ($c->use_stats) {
1838 my $elapsed = sprintf '%f', $c->stats->elapsed;
1839 my $av = $elapsed == 0 ? '??' : sprintf '%.3f', 1 / $elapsed;
1841 "Request took ${elapsed}s ($av/s)\n" . $c->stats->report . "\n" );
1844 return $c->response->status;
1847 =head2 $c->finalize_body
1853 sub finalize_body { my $c = shift; $c->engine->finalize_body( $c, @_ ) }
1855 =head2 $c->finalize_cookies
1861 sub finalize_cookies { my $c = shift; $c->engine->finalize_cookies( $c, @_ ) }
1863 =head2 $c->finalize_error
1869 sub finalize_error { my $c = shift; $c->engine->finalize_error( $c, @_ ) }
1871 =head2 $c->finalize_headers
1877 sub finalize_headers {
1880 my $response = $c->response; #accessor calls can add up?
1882 # Check if we already finalized headers
1883 return if $response->finalized_headers;
1886 if ( my $location = $response->redirect ) {
1887 $c->log->debug(qq/Redirecting to "$location"/) if $c->debug;
1888 $response->header( Location => $location );
1890 if ( !$response->has_body ) {
1891 # Add a default body if none is already present
1893 qq{<html><body><p>This item has moved <a href="$location">here</a>.</p></body></html>}
1899 if ( defined $response->body && length $response->body && !$response->content_length ) {
1901 # get the length from a filehandle
1902 if ( blessed( $response->body ) && $response->body->can('read') || ref( $response->body ) eq 'GLOB' )
1904 my $stat = stat $response->body;
1905 if ( $stat && $stat->size > 0 ) {
1906 $response->content_length( $stat->size );
1909 $c->log->warn('Serving filehandle without a content-length');
1913 # everything should be bytes at this point, but just in case
1914 $response->content_length( length( $response->body ) );
1919 if ( $response->status =~ /^(1\d\d|[23]04)$/ ) {
1920 $response->headers->remove_header("Content-Length");
1921 $response->body('');
1924 $c->finalize_cookies;
1926 $c->engine->finalize_headers( $c, @_ );
1929 $response->finalized_headers(1);
1932 =head2 $c->finalize_output
1934 An alias for finalize_body.
1936 =head2 $c->finalize_read
1938 Finalizes the input after reading is complete.
1942 sub finalize_read { my $c = shift; $c->engine->finalize_read( $c, @_ ) }
1944 =head2 $c->finalize_uploads
1946 Finalizes uploads. Cleans up any temporary files.
1950 sub finalize_uploads { my $c = shift; $c->engine->finalize_uploads( $c, @_ ) }
1952 =head2 $c->get_action( $action, $namespace )
1954 Gets an action in a given namespace.
1958 sub get_action { my $c = shift; $c->dispatcher->get_action(@_) }
1960 =head2 $c->get_actions( $action, $namespace )
1962 Gets all actions of a given name in a namespace and all parent
1967 sub get_actions { my $c = shift; $c->dispatcher->get_actions( $c, @_ ) }
1969 =head2 $app->handle_request( @arguments )
1971 Called to handle each HTTP request.
1975 sub handle_request {
1976 my ( $class, @arguments ) = @_;
1978 # Always expect worst case!
1981 if ($class->debug) {
1982 my $secs = time - $START || 1;
1983 my $av = sprintf '%.3f', $COUNT / $secs;
1984 my $time = localtime time;
1985 $class->log->info("*** Request $COUNT ($av/s) [$$] [$time] ***");
1988 my $c = $class->prepare(@arguments);
1990 $status = $c->finalize;
1993 if ( my $error = $@ ) {
1995 $class->log->error(qq/Caught exception in engine "$error"/);
2000 if(my $coderef = $class->log->can('_flush')){
2001 $class->log->$coderef();
2006 =head2 $c->prepare( @arguments )
2008 Creates a Catalyst context from an engine-specific request (Apache, CGI,
2014 my ( $class, @arguments ) = @_;
2017 # After the app/ctxt split, this should become an attribute based on something passed
2018 # into the application.
2019 $class->context_class( ref $class || $class ) unless $class->context_class;
2021 my $c = $class->context_class->new({});
2023 # For on-demand data
2024 $c->request->_context($c);
2025 $c->response->_context($c);
2027 #surely this is not the most efficient way to do things...
2028 $c->stats($class->stats_class->new)->enable($c->use_stats);
2029 if ( $c->debug || $c->config->{enable_catalyst_header} ) {
2030 $c->res->headers->header( 'X-Catalyst' => $Catalyst::VERSION );
2033 #XXX reuse coderef from can
2034 # Allow engine to direct the prepare flow (for POE)
2035 if ( $c->engine->can('prepare') ) {
2036 $c->engine->prepare( $c, @arguments );
2039 $c->prepare_request(@arguments);
2040 $c->prepare_connection;
2041 $c->prepare_query_parameters;
2042 $c->prepare_headers;
2043 $c->prepare_cookies;
2046 # Prepare the body for reading, either by prepare_body
2047 # or the user, if they are using $c->read
2050 # Parse the body unless the user wants it on-demand
2051 unless ( ref($c)->config->{parse_on_demand} ) {
2056 my $method = $c->req->method || '';
2057 my $path = $c->req->path;
2058 $path = '/' unless length $path;
2059 my $address = $c->req->address || '';
2068 =head2 $c->prepare_action
2070 Prepares action. See L<Catalyst::Dispatcher>.
2074 sub prepare_action { my $c = shift; $c->dispatcher->prepare_action( $c, @_ ) }
2076 =head2 $c->prepare_body
2078 Prepares message body.
2085 return if $c->request->_has_body;
2087 # Initialize on-demand data
2088 $c->engine->prepare_body( $c, @_ );
2089 $c->prepare_parameters;
2090 $c->prepare_uploads;
2093 =head2 $c->prepare_body_chunk( $chunk )
2095 Prepares a chunk of data before sending it to L<HTTP::Body>.
2097 See L<Catalyst::Engine>.
2101 sub prepare_body_chunk {
2103 $c->engine->prepare_body_chunk( $c, @_ );
2106 =head2 $c->prepare_body_parameters
2108 Prepares body parameters.
2112 sub prepare_body_parameters {
2114 $c->engine->prepare_body_parameters( $c, @_ );
2117 =head2 $c->prepare_connection
2119 Prepares connection.
2123 sub prepare_connection {
2125 $c->engine->prepare_connection( $c, @_ );
2128 =head2 $c->prepare_cookies
2134 sub prepare_cookies { my $c = shift; $c->engine->prepare_cookies( $c, @_ ) }
2136 =head2 $c->prepare_headers
2142 sub prepare_headers { my $c = shift; $c->engine->prepare_headers( $c, @_ ) }
2144 =head2 $c->prepare_parameters
2146 Prepares parameters.
2150 sub prepare_parameters {
2152 $c->prepare_body_parameters;
2153 $c->engine->prepare_parameters( $c, @_ );
2156 =head2 $c->prepare_path
2158 Prepares path and base.
2162 sub prepare_path { my $c = shift; $c->engine->prepare_path( $c, @_ ) }
2164 =head2 $c->prepare_query_parameters
2166 Prepares query parameters.
2170 sub prepare_query_parameters {
2173 $c->engine->prepare_query_parameters( $c, @_ );
2176 =head2 $c->log_request
2178 Writes information about the request to the debug logs. This includes:
2182 =item * Request method, path, and remote IP address
2184 =item * Query keywords (see L<Catalyst::Request/query_keywords>)
2186 =item * Request parameters
2188 =item * File uploads
2197 return unless $c->debug;
2199 my($dump) = grep {$_->[0] eq 'Request' } $c->dump_these;
2200 my $request = $dump->[1];
2202 my ( $method, $path, $address ) = ( $request->method, $request->path, $request->address );
2204 $path = '/' unless length $path;
2206 $c->log->debug(qq/"$method" request for "$path" from "$address"/);
2208 $c->log_request_headers($request->headers);
2210 if ( my $keywords = $request->query_keywords ) {
2211 $c->log->debug("Query keywords are: $keywords");
2214 $c->log_request_parameters( query => $request->query_parameters, $request->_has_body ? (body => $request->body_parameters) : () );
2216 $c->log_request_uploads($request);
2219 =head2 $c->log_response
2221 Writes information about the response to the debug logs by calling
2222 C<< $c->log_response_status_line >> and C<< $c->log_response_headers >>.
2229 return unless $c->debug;
2231 my($dump) = grep {$_->[0] eq 'Response' } $c->dump_these;
2232 my $response = $dump->[1];
2234 $c->log_response_status_line($response);
2235 $c->log_response_headers($response->headers);
2238 =head2 $c->log_response_status_line($response)
2240 Writes one line of information about the response to the debug logs. This includes:
2244 =item * Response status code
2246 =item * Content-Type header (if present)
2248 =item * Content-Length header (if present)
2254 sub log_response_status_line {
2255 my ($c, $response) = @_;
2259 'Response Code: %s; Content-Type: %s; Content-Length: %s',
2260 $response->status || 'unknown',
2261 $response->headers->header('Content-Type') || 'unknown',
2262 $response->headers->header('Content-Length') || 'unknown'
2267 =head2 $c->log_response_headers($headers);
2269 Hook method which can be wrapped by plugins to log the responseheaders.
2270 No-op in the default implementation.
2274 sub log_response_headers {}
2276 =head2 $c->log_request_parameters( query => {}, body => {} )
2278 Logs request parameters to debug logs
2282 sub log_request_parameters {
2284 my %all_params = @_;
2286 return unless $c->debug;
2288 my $column_width = Catalyst::Utils::term_width() - 44;
2289 foreach my $type (qw(query body)) {
2290 my $params = $all_params{$type};
2291 next if ! keys %$params;
2292 my $t = Text::SimpleTable->new( [ 35, 'Parameter' ], [ $column_width, 'Value' ] );
2293 for my $key ( sort keys %$params ) {
2294 my $param = $params->{$key};
2295 my $value = defined($param) ? $param : '';
2296 $t->row( $key, ref $value eq 'ARRAY' ? ( join ', ', @$value ) : $value );
2298 $c->log->debug( ucfirst($type) . " Parameters are:\n" . $t->draw );
2302 =head2 $c->log_request_uploads
2304 Logs file uploads included in the request to the debug logs.
2305 The parameter name, filename, file type, and file size are all included in
2310 sub log_request_uploads {
2312 my $request = shift;
2313 return unless $c->debug;
2314 my $uploads = $request->uploads;
2315 if ( keys %$uploads ) {
2316 my $t = Text::SimpleTable->new(
2317 [ 12, 'Parameter' ],
2322 for my $key ( sort keys %$uploads ) {
2323 my $upload = $uploads->{$key};
2324 for my $u ( ref $upload eq 'ARRAY' ? @{$upload} : ($upload) ) {
2325 $t->row( $key, $u->filename, $u->type, $u->size );
2328 $c->log->debug( "File Uploads are:\n" . $t->draw );
2332 =head2 $c->log_request_headers($headers);
2334 Hook method which can be wrapped by plugins to log the request headers.
2335 No-op in the default implementation.
2339 sub log_request_headers {}
2341 =head2 $c->log_headers($type => $headers)
2343 Logs L<HTTP::Headers> (either request or response) to the debug logs.
2350 my $headers = shift; # an HTTP::Headers instance
2352 return unless $c->debug;
2354 my $column_width = Catalyst::Utils::term_width() - 28;
2355 my $t = Text::SimpleTable->new( [ 15, 'Header Name' ], [ $column_width, 'Value' ] );
2358 my ( $name, $value ) = @_;
2359 $t->row( $name, $value );
2362 $c->log->debug( ucfirst($type) . " Headers:\n" . $t->draw );
2366 =head2 $c->prepare_read
2368 Prepares the input for reading.
2372 sub prepare_read { my $c = shift; $c->engine->prepare_read( $c, @_ ) }
2374 =head2 $c->prepare_request
2376 Prepares the engine request.
2380 sub prepare_request { my $c = shift; $c->engine->prepare_request( $c, @_ ) }
2382 =head2 $c->prepare_uploads
2388 sub prepare_uploads {
2391 $c->engine->prepare_uploads( $c, @_ );
2394 =head2 $c->prepare_write
2396 Prepares the output for writing.
2400 sub prepare_write { my $c = shift; $c->engine->prepare_write( $c, @_ ) }
2402 =head2 $c->request_class
2404 Returns or sets the request class. Defaults to L<Catalyst::Request>.
2406 =head2 $c->response_class
2408 Returns or sets the response class. Defaults to L<Catalyst::Response>.
2410 =head2 $c->read( [$maxlength] )
2412 Reads a chunk of data from the request body. This method is designed to
2413 be used in a while loop, reading C<$maxlength> bytes on every call.
2414 C<$maxlength> defaults to the size of the request if not specified.
2416 You have to set C<< MyApp->config(parse_on_demand => 1) >> to use this
2419 Warning: If you use read(), Catalyst will not process the body,
2420 so you will not be able to access POST parameters or file uploads via
2421 $c->request. You must handle all body parsing yourself.
2425 sub read { my $c = shift; return $c->engine->read( $c, @_ ) }
2433 sub run { my $c = shift; return $c->engine->run( $c, @_ ) }
2435 =head2 $c->set_action( $action, $code, $namespace, $attrs )
2437 Sets an action in a given namespace.
2441 sub set_action { my $c = shift; $c->dispatcher->set_action( $c, @_ ) }
2443 =head2 $c->setup_actions($component)
2445 Sets up actions for a component.
2449 sub setup_actions { my $c = shift; $c->dispatcher->setup_actions( $c, @_ ) }
2451 =head2 $c->setup_config
2458 my %args = %{ $class->config || {} };
2460 my @container_classes = ( "${class}::Container", 'Catalyst::Container');
2461 unshift @container_classes, delete $args{container_class} if exists $args{container_class};
2463 my $container_class = Class::MOP::load_first_existing_class(@container_classes);
2465 my $container = $container_class->new( %args, name => "$class" );
2466 $class->container($container);
2468 my $config = $container->resolve(service => 'config');
2469 $class->config($config);
2470 $class->finalize_config; # back-compat
2473 =head $c->finalize_config
2477 sub finalize_config { }
2479 =head2 $c->setup_components
2481 This method is called internally to set up the application's components.
2483 It finds modules by calling the L<locate_components> method, expands them to
2484 package names with the L<expand_component_module> method, and then installs
2485 each component into the application.
2487 The C<setup_components> config option is passed to both of the above methods.
2489 Installation of each component is performed by the L<setup_component> method,
2494 sub setup_components {
2497 my $config = $class->config->{ setup_components };
2499 my @comps = $class->locate_components($config);
2500 my %comps = map { $_ => 1 } @comps;
2502 my $deprecatedcatalyst_component_names = grep { /::[CMV]::/ } @comps;
2503 $class->log->warn(qq{Your application is using the deprecated ::[MVC]:: type naming scheme.\n}.
2504 qq{Please switch your class names to ::Model::, ::View:: and ::Controller: as appropriate.\n}
2505 ) if $deprecatedcatalyst_component_names;
2507 for my $component ( @comps ) {
2509 # We pass ignore_loaded here so that overlay files for (e.g.)
2510 # Model::DBI::Schema sub-classes are loaded - if it's in @comps
2511 # we know M::P::O found a file on disk so this is safe
2513 Catalyst::Utils::ensure_class_loaded( $component, { ignore_loaded => 1 } );
2517 $containers->{$_} = $class->container->get_sub_container($_) for qw(model view controller);
2519 for my $component (@comps) {
2520 my $instance = $class->components->{ $component } = $class->setup_component($component);
2521 if ( my ($type, $name) = _get_component_type_name($component) ) {
2522 # FIXME: shouldn't the service name be $name?
2523 $containers->{$type}->add_service(Catalyst::BlockInjection->new( name => $component, block => sub { return $instance } ));
2525 my @expanded_components = $instance->can('expand_modules')
2526 ? $instance->expand_modules( $component, $config )
2527 : $class->expand_component_module( $component, $config );
2528 for my $component (@expanded_components) {
2529 next if $comps{$component};
2531 $deprecatedcatalyst_component_names = grep { /::[CMV]::/ } @expanded_components;
2532 $class->log->warn(qq{Your application is using the deprecated ::[MVC]:: type naming scheme.\n}.
2533 qq{Please switch your class names to ::Model::, ::View:: and ::Controller: as appropriate.\n}
2534 ) if $deprecatedcatalyst_component_names;
2536 if (my ($type, $name) = _get_component_type_name($component)) {
2537 $containers->{$type}->add_service(Catalyst::BlockInjection->new( name => $component, block => sub { return $class->setup_component($component) } ));
2540 $class->components->{ $component } = $class->setup_component($component);
2545 sub _get_component_type_name {
2546 my $component = shift;
2547 my @parts = split /::/, $component;
2549 while (my $type = shift @parts) {
2550 return ('controller', join '::', @parts)
2551 if $type =~ /^(c|controller)$/i;
2553 return ('model', join '::', @parts)
2554 if $type =~ /^(m|model)$/i;
2556 return ('view', join '::', @parts)
2557 if $type =~ /^(v|view)$/i;
2561 =head2 $c->locate_components( $setup_component_config )
2563 This method is meant to provide a list of component modules that should be
2564 setup for the application. By default, it will use L<Module::Pluggable>.
2566 Specify a C<setup_components> config option to pass additional options directly
2567 to L<Module::Pluggable>. To add additional search paths, specify a key named
2568 C<search_extra> as an array reference. Items in the array beginning with C<::>
2569 will have the application class name prepended to them.
2573 sub locate_components {
2577 my @paths = qw( ::Controller ::C ::Model ::M ::View ::V );
2578 my $extra = delete $config->{ search_extra } || [];
2580 push @paths, @$extra;
2582 my $locator = Module::Pluggable::Object->new(
2583 search_path => [ map { s/^(?=::)/$class/; $_; } @paths ],
2587 # XXX think about ditching this sort entirely
2588 my @comps = sort { length $a <=> length $b } $locator->plugins;
2593 =head2 $c->expand_component_module( $component, $setup_component_config )
2595 Components found by C<locate_components> will be passed to this method, which
2596 is expected to return a list of component (package) names to be set up.
2600 sub expand_component_module {
2601 my ($class, $module) = @_;
2602 return Devel::InnerPackage::list_packages( $module );
2605 =head2 $c->setup_component
2609 sub setup_component {
2610 my( $class, $component ) = @_;
2612 unless ( $component->can( 'COMPONENT' ) ) {
2616 my $suffix = Catalyst::Utils::class2classsuffix( $component );
2617 my $config = $class->config->{ $suffix } || {};
2618 # Stash catalyst_component_name in the config here, so that custom COMPONENT
2619 # methods also pass it. local to avoid pointlessly shitting in config
2620 # for the debug screen, as $component is already the key name.
2621 local $config->{catalyst_component_name} = $component;
2623 my $instance = eval { $component->COMPONENT( $class, $config ); };
2625 if ( my $error = $@ ) {
2627 Catalyst::Exception->throw(
2628 message => qq/Couldn't instantiate component "$component", "$error"/
2631 elsif (!blessed $instance) {
2632 my $metaclass = Moose::Util::find_meta($component);
2633 my $method_meta = $metaclass->find_method_by_name('COMPONENT');
2634 my $component_method_from = $method_meta->associated_metaclass->name;
2635 my $value = defined($instance) ? $instance : 'undef';
2636 Catalyst::Exception->throw(
2638 qq/Couldn't instantiate component "$component", COMPONENT() method (from $component_method_from) didn't return an object-like value (value was $value)./
2645 =head2 $c->setup_dispatcher
2651 sub setup_dispatcher {
2652 my ( $class, $dispatcher ) = @_;
2655 $dispatcher = 'Catalyst::Dispatcher::' . $dispatcher;
2658 if ( my $env = Catalyst::Utils::env_value( $class, 'DISPATCHER' ) ) {
2659 $dispatcher = 'Catalyst::Dispatcher::' . $env;
2662 unless ($dispatcher) {
2663 $dispatcher = $class->dispatcher_class;
2666 Class::MOP::load_class($dispatcher);
2668 # dispatcher instance
2669 $class->dispatcher( $dispatcher->new );
2672 =head2 $c->setup_engine
2679 my ( $class, $engine ) = @_;
2682 $engine = 'Catalyst::Engine::' . $engine;
2685 if ( my $env = Catalyst::Utils::env_value( $class, 'ENGINE' ) ) {
2686 $engine = 'Catalyst::Engine::' . $env;
2689 if ( $ENV{MOD_PERL} ) {
2690 my $meta = Class::MOP::get_metaclass_by_name($class);
2692 # create the apache method
2693 $meta->add_method('apache' => sub { shift->engine->apache });
2695 my ( $software, $version ) =
2696 $ENV{MOD_PERL} =~ /^(\S+)\/(\d+(?:[\.\_]\d+)+)/;
2699 $version =~ s/(\.[^.]+)\./$1/g;
2701 if ( $software eq 'mod_perl' ) {
2705 if ( $version >= 1.99922 ) {
2706 $engine = 'Catalyst::Engine::Apache2::MP20';
2709 elsif ( $version >= 1.9901 ) {
2710 $engine = 'Catalyst::Engine::Apache2::MP19';
2713 elsif ( $version >= 1.24 ) {
2714 $engine = 'Catalyst::Engine::Apache::MP13';
2718 Catalyst::Exception->throw( message =>
2719 qq/Unsupported mod_perl version: $ENV{MOD_PERL}/ );
2724 # install the correct mod_perl handler
2725 if ( $version >= 1.9901 ) {
2726 *handler = sub : method {
2727 shift->handle_request(@_);
2731 *handler = sub ($$) { shift->handle_request(@_) };
2736 elsif ( $software eq 'Zeus-Perl' ) {
2737 $engine = 'Catalyst::Engine::Zeus';
2741 Catalyst::Exception->throw(
2742 message => qq/Unsupported mod_perl: $ENV{MOD_PERL}/ );
2747 $engine = $class->engine_class;
2750 Class::MOP::load_class($engine);
2752 # check for old engines that are no longer compatible
2754 if ( $engine->isa('Catalyst::Engine::Apache')
2755 && !Catalyst::Engine::Apache->VERSION )
2760 elsif ( $engine->isa('Catalyst::Engine::Server::Base')
2761 && Catalyst::Engine::Server->VERSION le '0.02' )
2766 elsif ($engine->isa('Catalyst::Engine::HTTP::POE')
2767 && $engine->VERSION eq '0.01' )
2772 elsif ($engine->isa('Catalyst::Engine::Zeus')
2773 && $engine->VERSION eq '0.01' )
2779 Catalyst::Exception->throw( message =>
2780 qq/Engine "$engine" is not supported by this version of Catalyst/
2785 $class->engine( $engine->new );
2788 =head2 $c->setup_home
2790 Sets up the home directory.
2795 my ( $class, $home ) = @_;
2797 if ( my $env = Catalyst::Utils::env_value( $class, 'HOME' ) ) {
2801 $home ||= Catalyst::Utils::home($class);
2804 #I remember recently being scolded for assigning config values like this
2805 $class->config->{home} ||= $home;
2806 $class->config->{root} ||= Path::Class::Dir->new($home)->subdir('root');
2810 =head2 $c->setup_log
2812 Sets up log by instantiating a L<Catalyst::Log|Catalyst::Log> object and
2813 passing it to C<log()>. Pass in a comma-delimited list of levels to set the
2816 This method also installs a C<debug> method that returns a true value into the
2817 catalyst subclass if the "debug" level is passed in the comma-delimited list,
2818 or if the C<$CATALYST_DEBUG> environment variable is set to a true value.
2820 Note that if the log has already been setup, by either a previous call to
2821 C<setup_log> or by a call such as C<< __PACKAGE__->log( MyLogger->new ) >>,
2822 that this method won't actually set up the log object.
2827 my ( $class, $levels ) = @_;
2830 $levels =~ s/^\s+//;
2831 $levels =~ s/\s+$//;
2832 my %levels = map { $_ => 1 } split /\s*,\s*/, $levels;
2834 my $env_debug = Catalyst::Utils::env_value( $class, 'DEBUG' );
2835 if ( defined $env_debug ) {
2836 $levels{debug} = 1 if $env_debug; # Ugly!
2837 delete($levels{debug}) unless $env_debug;
2840 unless ( $class->log ) {
2841 $class->log( Catalyst::Log->new(keys %levels) );
2844 if ( $levels{debug} ) {
2845 Class::MOP::get_metaclass_by_name($class)->add_method('debug' => sub { 1 });
2846 $class->log->debug('Debug messages enabled');
2850 =head2 $c->setup_plugins
2856 =head2 $c->setup_stats
2858 Sets up timing statistics class.
2863 my ( $class, $stats ) = @_;
2865 Catalyst::Utils::ensure_class_loaded($class->stats_class);
2867 my $env = Catalyst::Utils::env_value( $class, 'STATS' );
2868 if ( defined($env) ? $env : ($stats || $class->debug ) ) {
2869 Class::MOP::get_metaclass_by_name($class)->add_method('use_stats' => sub { 1 });
2870 $class->log->debug('Statistics enabled');
2875 =head2 $c->registered_plugins
2877 Returns a sorted list of the plugins which have either been stated in the
2878 import list or which have been added via C<< MyApp->plugin(@args); >>.
2880 If passed a given plugin name, it will report a boolean value indicating
2881 whether or not that plugin is loaded. A fully qualified name is required if
2882 the plugin name does not begin with C<Catalyst::Plugin::>.
2884 if ($c->registered_plugins('Some::Plugin')) {
2892 sub registered_plugins {
2894 return sort keys %{ $proto->_plugins } unless @_;
2896 return 1 if exists $proto->_plugins->{$plugin};
2897 return exists $proto->_plugins->{"Catalyst::Plugin::$plugin"};
2900 sub _register_plugin {
2901 my ( $proto, $plugin, $instant ) = @_;
2902 my $class = ref $proto || $proto;
2904 Class::MOP::load_class( $plugin );
2905 $class->log->warn( "$plugin inherits from 'Catalyst::Component' - this is deprecated and will not work in 5.81" )
2906 if $plugin->isa( 'Catalyst::Component' );
2907 $proto->_plugins->{$plugin} = 1;
2909 my $meta = Class::MOP::get_metaclass_by_name($class);
2910 $meta->superclasses($plugin, $meta->superclasses);
2916 my ( $class, $plugins ) = @_;
2918 $class->_plugins( {} ) unless $class->_plugins;
2919 $plugins = Data::OptList::mkopt($plugins || []);
2922 [ Catalyst::Utils::resolve_namespace(
2923 $class . '::Plugin',
2924 'Catalyst::Plugin', $_->[0]
2930 for my $plugin ( reverse @plugins ) {
2931 Class::MOP::load_class($plugin->[0], $plugin->[1]);
2932 my $meta = find_meta($plugin->[0]);
2933 next if $meta && $meta->isa('Moose::Meta::Role');
2935 $class->_register_plugin($plugin->[0]);
2939 map { $_->[0]->name, $_->[1] }
2940 grep { blessed($_->[0]) && $_->[0]->isa('Moose::Meta::Role') }
2941 map { [find_meta($_->[0]), $_->[1]] }
2944 Moose::Util::apply_all_roles(
2952 Returns an arrayref of the internal execution stack (actions that are
2953 currently executing).
2957 Returns the current timing statistics object. By default Catalyst uses
2958 L<Catalyst::Stats|Catalyst::Stats>, but can be set otherwise with
2959 L<< stats_class|/"$c->stats_class" >>.
2961 Even if L<< -Stats|/"-Stats" >> is not enabled, the stats object is still
2962 available. By enabling it with C< $c->stats->enabled(1) >, it can be used to
2963 profile explicitly, although MyApp.pm still won't profile nor output anything
2966 =head2 $c->stats_class
2968 Returns or sets the stats (timing statistics) class. L<Catalyst::Stats|Catalyst::Stats> is used by default.
2970 =head2 $c->use_stats
2972 Returns 1 when L<< stats collection|/"-Stats" >> is enabled.
2974 Note that this is a static method, not an accessor and should be overridden
2975 by declaring C<sub use_stats { 1 }> in your MyApp.pm, not by calling C<< $c->use_stats(1) >>.
2982 =head2 $c->write( $data )
2984 Writes $data to the output stream. When using this method directly, you
2985 will need to manually set the C<Content-Length> header to the length of
2986 your output data, if known.
2993 # Finalize headers if someone manually writes output
2994 $c->finalize_headers;
2996 return $c->engine->write( $c, @_ );
3001 Returns the Catalyst version number. Mostly useful for "powered by"
3002 messages in template systems.
3006 sub version { return $Catalyst::VERSION }
3008 =head1 CONFIGURATION
3010 There are a number of 'base' config variables which can be set:
3016 C<default_model> - The default model picked if you say C<< $c->model >>. See L<< /$c->model($name) >>.
3020 C<default_view> - The default view to be rendered or returned when C<< $c->view >> is called. See L<< /$c->view($name) >>.
3024 C<disable_component_resolution_regex_fallback> - Turns
3025 off the deprecated component resolution functionality so
3026 that if any of the component methods (e.g. C<< $c->controller('Foo') >>)
3027 are called then regex search will not be attempted on string values and
3028 instead C<undef> will be returned.
3032 C<home> - The application home directory. In an uninstalled application,
3033 this is the top level application directory. In an installed application,
3034 this will be the directory containing C<< MyApp.pm >>.
3038 C<ignore_frontend_proxy> - See L</PROXY SUPPORT>
3042 C<name> - The name of the application in debug messages and the debug and
3047 C<parse_on_demand> - The request body (for example file uploads) will not be parsed
3048 until it is accessed. This allows you to (for example) check authentication (and reject
3049 the upload) before actually recieving all the data. See L</ON-DEMAND PARSER>
3053 C<root> - The root directory for templates. Usually this is just a
3054 subdirectory of the home directory, but you can set it to change the
3055 templates to a different directory.
3059 C<search_extra> - Array reference passed to Module::Pluggable to for additional
3060 namespaces from which components will be loaded (and constructed and stored in
3061 C<< $c->components >>).
3065 C<show_internal_actions> - If true, causes internal actions such as C<< _DISPATCH >>
3066 to be shown in hit debug tables in the test server.
3070 C<use_request_uri_for_path> - Controlls if the C<REQUEST_URI> or C<PATH_INFO> environment
3071 variable should be used for determining the request path. See L<Catalyst::Engine::CGI/PATH DECODING>
3072 for more information.
3076 C<using_frontend_proxy> - See L</PROXY SUPPORT>.
3080 =head1 INTERNAL ACTIONS
3082 Catalyst uses internal actions like C<_DISPATCH>, C<_BEGIN>, C<_AUTO>,
3083 C<_ACTION>, and C<_END>. These are by default not shown in the private
3084 action table, but you can make them visible with a config parameter.
3086 MyApp->config(show_internal_actions => 1);
3088 =head1 ON-DEMAND PARSER
3090 The request body is usually parsed at the beginning of a request,
3091 but if you want to handle input yourself, you can enable on-demand
3092 parsing with a config parameter.
3094 MyApp->config(parse_on_demand => 1);
3096 =head1 PROXY SUPPORT
3098 Many production servers operate using the common double-server approach,
3099 with a lightweight frontend web server passing requests to a larger
3100 backend server. An application running on the backend server must deal
3101 with two problems: the remote user always appears to be C<127.0.0.1> and
3102 the server's hostname will appear to be C<localhost> regardless of the
3103 virtual host that the user connected through.
3105 Catalyst will automatically detect this situation when you are running
3106 the frontend and backend servers on the same machine. The following
3107 changes are made to the request.
3109 $c->req->address is set to the user's real IP address, as read from
3110 the HTTP X-Forwarded-For header.
3112 The host value for $c->req->base and $c->req->uri is set to the real
3113 host, as read from the HTTP X-Forwarded-Host header.
3115 Additionally, you may be running your backend application on an insecure
3116 connection (port 80) while your frontend proxy is running under SSL. If there
3117 is a discrepancy in the ports, use the HTTP header C<X-Forwarded-Port> to
3118 tell Catalyst what port the frontend listens on. This will allow all URIs to
3119 be created properly.
3121 In the case of passing in:
3123 X-Forwarded-Port: 443
3125 All calls to C<uri_for> will result in an https link, as is expected.
3127 Obviously, your web server must support these headers for this to work.
3129 In a more complex server farm environment where you may have your
3130 frontend proxy server(s) on different machines, you will need to set a
3131 configuration option to tell Catalyst to read the proxied data from the
3134 MyApp->config(using_frontend_proxy => 1);
3136 If you do not wish to use the proxy support at all, you may set:
3138 MyApp->config(ignore_frontend_proxy => 1);
3140 =head1 THREAD SAFETY
3142 Catalyst has been tested under Apache 2's threading C<mpm_worker>,
3143 C<mpm_winnt>, and the standalone forking HTTP server on Windows. We
3144 believe the Catalyst core to be thread-safe.
3146 If you plan to operate in a threaded environment, remember that all other
3147 modules you are using must also be thread-safe. Some modules, most notably
3148 L<DBD::SQLite>, are not thread-safe.
3154 Join #catalyst on irc.perl.org.
3158 http://lists.scsys.co.uk/cgi-bin/mailman/listinfo/catalyst
3159 http://lists.scsys.co.uk/cgi-bin/mailman/listinfo/catalyst-dev
3163 http://catalyst.perl.org
3167 http://dev.catalyst.perl.org
3171 =head2 L<Task::Catalyst> - All you need to start with Catalyst
3173 =head2 L<Catalyst::Manual> - The Catalyst Manual
3175 =head2 L<Catalyst::Component>, L<Catalyst::Controller> - Base classes for components
3177 =head2 L<Catalyst::Engine> - Core engine
3179 =head2 L<Catalyst::Log> - Log class.
3181 =head2 L<Catalyst::Request> - Request object
3183 =head2 L<Catalyst::Response> - Response object
3185 =head2 L<Catalyst::Test> - The test suite.
3187 =head1 PROJECT FOUNDER
3189 sri: Sebastian Riedel <sri@cpan.org>
3195 acme: Leon Brocard <leon@astray.com>
3197 abraxxa: Alexander Hartmaier <abraxxa@cpan.org>
3201 Andrew Ford E<lt>A.Ford@ford-mason.co.ukE<gt>
3205 andyg: Andy Grundman <andy@hybridized.org>
3207 audreyt: Audrey Tang
3209 bricas: Brian Cassidy <bricas@cpan.org>
3211 Caelum: Rafael Kitover <rkitover@io.com>
3213 chansen: Christian Hansen
3215 chicks: Christopher Hicks
3217 Chisel Wright C<pause@herlpacker.co.uk>
3219 Danijel Milicevic C<me@danijel.de>
3221 David Kamholz E<lt>dkamholz@cpan.orgE<gt>
3223 David Naughton, C<naughton@umn.edu>
3227 dhoss: Devin Austin <dhoss@cpan.org>
3229 dkubb: Dan Kubb <dan.kubb-cpan@onautopilot.com>
3233 dwc: Daniel Westermann-Clark <danieltwc@cpan.org>
3235 esskar: Sascha Kiefer
3237 fireartist: Carl Franks <cfranks@cpan.org>
3239 frew: Arthur Axel "fREW" Schmidt <frioux@gmail.com>
3241 gabb: Danijel Milicevic
3245 Gavin Henry C<ghenry@perl.me.uk>
3249 groditi: Guillermo Roditi <groditi@gmail.com>
3251 hobbs: Andrew Rodland <andrew@cleverdomain.org>
3253 ilmari: Dagfinn Ilmari Mannsåker <ilmari@ilmari.org>
3255 jcamacho: Juan Camacho
3257 jester: Jesse Sheidlower C<jester@panix.com>
3259 jhannah: Jay Hannah <jay@jays.net>
3265 jon: Jon Schutz <jjschutz@cpan.org>
3267 Jonathan Rockway C<< <jrockway@cpan.org> >>
3269 Kieren Diment C<kd@totaldatasolution.com>
3271 konobi: Scott McWhirter <konobi@cpan.org>
3273 marcus: Marcus Ramberg <mramberg@cpan.org>
3275 miyagawa: Tatsuhiko Miyagawa <miyagawa@bulknews.net>
3277 mst: Matt S. Trout <mst@shadowcatsystems.co.uk>
3281 naughton: David Naughton
3283 ningu: David Kamholz <dkamholz@cpan.org>
3285 nothingmuch: Yuval Kogman <nothingmuch@woobling.org>
3287 numa: Dan Sully <daniel@cpan.org>
3293 omega: Andreas Marienborg
3295 Oleg Kostyuk <cub.uanic@gmail.com>
3297 phaylon: Robert Sedlacek <phaylon@dunkelheit.at>
3299 rafl: Florian Ragwitz <rafl@debian.org>
3301 random: Roland Lammel <lammel@cpan.org>
3303 Robert Sedlacek C<< <rs@474.at> >>
3305 SpiceMan: Marcel Montes
3309 szbalint: Balint Szilakszi <szbalint@cpan.org>
3311 t0m: Tomas Doran <bobtfish@bobtfish.net>
3315 Viljo Marrandi C<vilts@yahoo.com>
3317 Will Hawes C<info@whawes.co.uk>
3319 willert: Sebastian Willert <willert@cpan.org>
3321 wreis: Wallace Reis <wallace@reis.org.br>
3323 Yuval Kogman, C<nothingmuch@woobling.org>
3325 rainboxx: Matthias Dietrich, C<perl@rainboxx.de>
3327 dd070: Dhaval Dhanani <dhaval070@gmail.com>
3331 Copyright (c) 2005, the above named PROJECT FOUNDER and CONTRIBUTORS.
3335 This library is free software. You can redistribute it and/or modify it under
3336 the same terms as Perl itself.
3342 __PACKAGE__->meta->make_immutable;