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 ) = @_;
655 my $appclass = ref($c) || $c;
657 unless ( ref($name) ) { # Direct component hash lookup to avoid costly regexps
658 my $check = $appclass."::Controller::".$name;
659 my $container = $c->container->get_sub_container('controller');
660 return $c->_filter_component( $container->resolve(service => "$check"), @args )
661 if $container->has_service($check);
663 my @result = $c->_comp_search_prefixes( $name, qw/Controller C/ );
664 return map { $c->_filter_component( $_, @args ) } @result if ref $name;
665 return $c->_filter_component( $result[ 0 ], @args );
668 return $c->component( $c->action->class );
671 =head2 $c->model($name)
673 Gets a L<Catalyst::Model> instance by name.
675 $c->model('Foo')->do_stuff;
677 Any extra arguments are directly passed to ACCEPT_CONTEXT.
679 If the name is omitted, it will look for
680 - a model object in $c->stash->{current_model_instance}, then
681 - a model name in $c->stash->{current_model}, then
682 - a config setting 'default_model', or
683 - check if there is only one model, and return it if that's the case.
685 If you want to search for models, pass in a regexp as the argument.
687 # find all models that start with Foo
688 my @foo_models = $c->model(qr{^Foo});
693 my ( $c, $name, @args ) = @_;
694 my $appclass = ref($c) || $c;
696 unless ( ref($name) ) { # Direct component hash lookup to avoid costly regexps
697 my $check = $appclass."::Model::".$name;
698 my $container = $c->container->get_sub_container('model');
699 return $c->_filter_component( $container->resolve(service => "$check"), @args )
700 if $container->has_service($check);
702 my @result = $c->_comp_search_prefixes( $name, qw/Model M/ );
703 return map { $c->_filter_component( $_, @args ) } @result if ref $name;
704 return $c->_filter_component( $result[ 0 ], @args );
708 return $c->stash->{current_model_instance}
709 if $c->stash->{current_model_instance};
710 return $c->model( $c->stash->{current_model} )
711 if $c->stash->{current_model};
713 return $c->model( $appclass->config->{default_model} )
714 if $appclass->config->{default_model};
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 $c->_filter_component( $comp );
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 ) = @_;
754 my $appclass = ref($c) || $c;
756 unless ( ref($name) ) { # Direct component hash lookup to avoid costly regexps
757 my $check = $appclass."::View::".$name;
758 my $container = $c->container->get_sub_container('view');
759 if ($container->has_service($check)) {
761 return $c->_filter_component( $container->resolve(service => $check), @args );
764 $c->log->warn( "Attempted to use view '$check', but does not exist" );
767 my @result = $c->_comp_search_prefixes( $name, qw/View V/ );
768 return map { $c->_filter_component( $_, @args ) } @result if ref $name;
769 return $c->_filter_component( $result[ 0 ], @args );
773 return $c->stash->{current_view_instance}
774 if $c->stash->{current_view_instance};
775 return $c->view( $c->stash->{current_view} )
776 if $c->stash->{current_view};
778 return $c->view( $appclass->config->{default_view} )
779 if $appclass->config->{default_view};
781 my( $comp, $rest ) = $c->_comp_search_prefixes( undef, qw/View V/);
784 $c->log->warn( 'Calling $c->view() will return a random view unless you specify one of:' );
785 $c->log->warn( '* $c->config(default_view => "the name of the default view to use")' );
786 $c->log->warn( '* $c->stash->{current_view} # the name of the view to use for this request' );
787 $c->log->warn( '* $c->stash->{current_view_instance} # the instance of the view to use for this request' );
788 $c->log->warn( 'NB: in version 5.81, the "random" behavior will not work at all.' );
791 return $c->_filter_component( $comp );
794 =head2 $c->controllers
796 Returns the available names which can be passed to $c->controller
802 return $c->container->get_sub_container('controller')->get_service_list;
807 Returns the available names which can be passed to $c->model
813 return $c->container->get_sub_container('model')->get_service_list;
819 Returns the available names which can be passed to $c->view
825 return $c->container->get_sub_container('view')->get_service_list;
828 =head2 $c->comp($name)
830 =head2 $c->component($name)
832 Gets a component object by name. This method is not recommended,
833 unless you want to get a specific component by full
834 class. C<< $c->controller >>, C<< $c->model >>, and C<< $c->view >>
835 should be used instead.
837 If C<$name> is a regexp, a list of components matched against the full
838 component name will be returned.
840 If Catalyst can't find a component by name, it will fallback to regex
841 matching by default. To disable this behaviour set
842 disable_component_resolution_regex_fallback to a true value.
844 __PACKAGE__->config( disable_component_resolution_regex_fallback => 1 );
849 my ( $c, $name, @args ) = @_;
852 my $comps = $c->components;
855 # is it the exact name?
856 return $c->_filter_component( $comps->{ $name }, @args )
857 if exists $comps->{ $name };
859 # perhaps we just omitted "MyApp"?
860 my $composed = ( ref $c || $c ) . "::${name}";
861 return $c->_filter_component( $comps->{ $composed }, @args )
862 if exists $comps->{ $composed };
864 # search all of the models, views and controllers
865 my( $comp ) = $c->_comp_search_prefixes( $name, qw/Model M Controller C View V/ );
866 return $c->_filter_component( $comp, @args ) if $comp;
870 if $c->config->{disable_component_resolution_regex_fallback};
872 # This is here so $c->comp( '::M::' ) works
873 my $query = ref $name ? $name : qr{$name}i;
875 my @result = grep { m{$query} } keys %{ $c->components };
876 return map { $c->_filter_component( $_, @args ) } @result if ref $name;
879 $c->log->warn( Carp::shortmess(qq(Found results for "${name}" using regexp fallback)) );
880 $c->log->warn( 'Relying on the regexp fallback behavior for component resolution' );
881 $c->log->warn( 'is unreliable and unsafe. You have been warned' );
882 return $c->_filter_component( $result[ 0 ], @args );
885 # I would expect to return an empty list here, but that breaks back-compat
889 return sort keys %{ $c->components };
892 =head2 CLASS DATA AND HELPER CLASSES
896 Returns or takes a hashref containing the application's configuration.
898 __PACKAGE__->config( { db => 'dsn:SQLite:foo.db' } );
900 You can also use a C<YAML>, C<XML> or L<Config::General> config file
901 like C<myapp.conf> in your applications home directory. See
902 L<Catalyst::Plugin::ConfigLoader>.
904 =head3 Cascading configuration
906 The config method is present on all Catalyst components, and configuration
907 will be merged when an application is started. Configuration loaded with
908 L<Catalyst::Plugin::ConfigLoader> takes precedence over other configuration,
909 followed by configuration in your top level C<MyApp> class. These two
910 configurations are merged, and then configuration data whose hash key matches a
911 component name is merged with configuration for that component.
913 The configuration for a component is then passed to the C<new> method when a
914 component is constructed.
918 MyApp->config({ 'Model::Foo' => { bar => 'baz', overrides => 'me' } });
919 MyApp::Model::Foo->config({ quux => 'frob', overrides => 'this' });
921 will mean that C<MyApp::Model::Foo> receives the following data when
924 MyApp::Model::Foo->new({
930 It's common practice to use a Moose attribute
931 on the receiving component to access the config value.
933 package MyApp::Model::Foo;
937 # this attr will receive 'baz' at construction time
943 You can then get the value 'baz' by calling $c->model('Foo')->bar
944 (or $self->bar inside code in the model).
946 B<NOTE:> you MUST NOT call C<< $self->config >> or C<< __PACKAGE__->config >>
947 as a way of reading config within your code, as this B<will not> give you the
948 correctly merged config back. You B<MUST> take the config values supplied to
949 the constructor and use those instead.
953 around config => sub {
957 croak('Setting config after setup has been run is not allowed.')
958 if ( @_ and $c->setup_finished );
965 Returns the logging object instance. Unless it is already set, Catalyst
966 sets this up with a L<Catalyst::Log> object. To use your own log class,
967 set the logger with the C<< __PACKAGE__->log >> method prior to calling
968 C<< __PACKAGE__->setup >>.
970 __PACKAGE__->log( MyLogger->new );
975 $c->log->info( 'Now logging with my own logger!' );
977 Your log class should implement the methods described in
983 Returns 1 if debug mode is enabled, 0 otherwise.
985 You can enable debug mode in several ways:
989 =item By calling myapp_server.pl with the -d flag
991 =item With the environment variables MYAPP_DEBUG, or CATALYST_DEBUG
993 =item The -Debug option in your MyApp.pm
995 =item By declaring C<sub debug { 1 }> in your MyApp.pm.
999 The first three also set the log level to 'debug'.
1001 Calling C<< $c->debug(1) >> has no effect.
1007 =head2 $c->dispatcher
1009 Returns the dispatcher instance. See L<Catalyst::Dispatcher>.
1013 Returns the engine instance. See L<Catalyst::Engine>.
1016 =head2 UTILITY METHODS
1018 =head2 $c->path_to(@path)
1020 Merges C<@path> with C<< $c->config->{home} >> and returns a
1021 L<Path::Class::Dir> object. Note you can usually use this object as
1022 a filename, but sometimes you will have to explicitly stringify it
1023 yourself by calling the C<< ->stringify >> method.
1027 $c->path_to( 'db', 'sqlite.db' );
1032 my ( $c, @path ) = @_;
1033 my $path = Path::Class::Dir->new( $c->config->{home}, @path );
1034 if ( -d $path ) { return $path }
1035 else { return Path::Class::File->new( $c->config->{home}, @path ) }
1038 =head2 $c->plugin( $name, $class, @args )
1040 Helper method for plugins. It creates a class data accessor/mutator and
1041 loads and instantiates the given class.
1043 MyApp->plugin( 'prototype', 'HTML::Prototype' );
1045 $c->prototype->define_javascript_functions;
1047 B<Note:> This method of adding plugins is deprecated. The ability
1048 to add plugins like this B<will be removed> in a Catalyst 5.81.
1049 Please do not use this functionality in new code.
1054 my ( $class, $name, $plugin, @args ) = @_;
1056 # See block comment in t/unit_core_plugin.t
1057 $class->log->warn(qq/Adding plugin using the ->plugin method is deprecated, and will be removed in Catalyst 5.81/);
1059 $class->_register_plugin( $plugin, 1 );
1061 eval { $plugin->import };
1062 $class->mk_classdata($name);
1064 eval { $obj = $plugin->new(@args) };
1067 Catalyst::Exception->throw( message =>
1068 qq/Couldn't instantiate instant plugin "$plugin", "$@"/ );
1071 $class->$name($obj);
1072 $class->log->debug(qq/Initialized instant plugin "$plugin" as "$name"/)
1078 Initializes the dispatcher and engine, loads any plugins, and loads the
1079 model, view, and controller components. You may also specify an array
1080 of plugins to load here, if you choose to not load them in the C<use
1084 MyApp->setup( qw/-Debug/ );
1089 my ( $class, @arguments ) = @_;
1090 croak('Running setup more than once')
1091 if ( $class->setup_finished );
1093 unless ( $class->isa('Catalyst') ) {
1095 Catalyst::Exception->throw(
1096 message => qq/'$class' does not inherit from Catalyst/ );
1099 if ( $class->arguments ) {
1100 @arguments = ( @arguments, @{ $class->arguments } );
1106 foreach (@arguments) {
1110 ( $flags->{log} ) ? 'debug,' . $flags->{log} : 'debug';
1112 elsif (/^-(\w+)=?(.*)$/) {
1113 $flags->{ lc $1 } = $2;
1116 push @{ $flags->{plugins} }, $_;
1120 $class->setup_config();
1121 $class->setup_home( delete $flags->{home} );
1123 $class->setup_log( delete $flags->{log} );
1124 $class->setup_plugins( delete $flags->{plugins} );
1125 $class->setup_dispatcher( delete $flags->{dispatcher} );
1126 $class->setup_engine( delete $flags->{engine} );
1127 $class->setup_stats( delete $flags->{stats} );
1129 for my $flag ( sort keys %{$flags} ) {
1131 if ( my $code = $class->can( 'setup_' . $flag ) ) {
1132 &$code( $class, delete $flags->{$flag} );
1135 $class->log->warn(qq/Unknown flag "$flag"/);
1139 eval { require Catalyst::Devel; };
1140 if( !$@ && $ENV{CATALYST_SCRIPT_GEN} && ( $ENV{CATALYST_SCRIPT_GEN} < $Catalyst::Devel::CATALYST_SCRIPT_GEN ) ) {
1141 $class->log->warn(<<"EOF");
1142 You are running an old script!
1144 Please update by running (this will overwrite existing files):
1145 catalyst.pl -force -scripts $class
1147 or (this will not overwrite existing files):
1148 catalyst.pl -scripts $class
1153 if ( $class->debug ) {
1154 my @plugins = map { "$_ " . ( $_->VERSION || '' ) } $class->registered_plugins;
1157 my $column_width = Catalyst::Utils::term_width() - 6;
1158 my $t = Text::SimpleTable->new($column_width);
1159 $t->row($_) for @plugins;
1160 $class->log->debug( "Loaded plugins:\n" . $t->draw . "\n" );
1163 my $dispatcher = $class->dispatcher;
1164 my $engine = $class->engine;
1165 my $home = $class->config->{home};
1167 $class->log->debug(sprintf(q/Loaded dispatcher "%s"/, blessed($dispatcher)));
1168 $class->log->debug(sprintf(q/Loaded engine "%s"/, blessed($engine)));
1172 ? $class->log->debug(qq/Found home "$home"/)
1173 : $class->log->debug(qq/Home "$home" doesn't exist/)
1174 : $class->log->debug(q/Couldn't find home/);
1177 # Call plugins setup, this is stupid and evil.
1178 # Also screws C3 badly on 5.10, hack to avoid.
1180 no warnings qw/redefine/;
1181 local *setup = sub { };
1182 $class->setup unless $Catalyst::__AM_RESTARTING;
1185 # Initialize our data structure
1186 $class->components( {} );
1188 $class->setup_components;
1190 if ( $class->debug ) {
1191 my $column_width = Catalyst::Utils::term_width() - 8 - 9;
1192 my $t = Text::SimpleTable->new( [ $column_width, 'Class' ], [ 8, 'Type' ] );
1193 for my $comp ( sort keys %{ $class->components } ) {
1194 my $type = ref $class->components->{$comp} ? 'instance' : 'class';
1195 $t->row( $comp, $type );
1197 $class->log->debug( "Loaded components:\n" . $t->draw . "\n" )
1198 if ( keys %{ $class->components } );
1201 # Add our self to components, since we are also a component
1202 if( $class->isa('Catalyst::Controller') ){
1203 $class->components->{$class} = $class;
1206 $class->setup_actions;
1208 if ( $class->debug ) {
1209 my $name = $class->config->{name} || 'Application';
1210 $class->log->info("$name powered by Catalyst $Catalyst::VERSION");
1213 # Make sure that the application class becomes immutable at this point,
1214 B::Hooks::EndOfScope::on_scope_end {
1216 my $meta = Class::MOP::get_metaclass_by_name($class);
1219 && ! { $meta->immutable_options }->{replace_constructor}
1221 $class->isa('Class::Accessor::Fast')
1222 || $class->isa('Class::Accessor')
1225 warn "You made your application class ($class) immutable, "
1226 . "but did not inline the\nconstructor. "
1227 . "This will break catalyst, as your app \@ISA "
1228 . "Class::Accessor(::Fast)?\nPlease pass "
1229 . "(replace_constructor => 1)\nwhen making your class immutable.\n";
1231 $meta->make_immutable(
1232 replace_constructor => 1,
1233 ) unless $meta->is_immutable;
1236 if ($class->config->{case_sensitive}) {
1237 $class->log->warn($class . "->config->{case_sensitive} is set.");
1238 $class->log->warn("This setting is deprecated and planned to be removed in Catalyst 5.81.");
1241 $class->setup_finalize;
1242 # Should be the last thing we do so that user things hooking
1243 # setup_finalize can log..
1244 $class->log->_flush() if $class->log->can('_flush');
1245 return 1; # Explicit return true as people have __PACKAGE__->setup as the last thing in their class. HATE.
1248 =head2 $app->setup_finalize
1250 A hook to attach modifiers to. This method does not do anything except set the
1251 C<setup_finished> accessor.
1253 Applying method modifiers to the C<setup> method doesn't work, because of quirky things done for plugin setup.
1257 after setup_finalize => sub {
1265 sub setup_finalize {
1267 $class->setup_finished(1);
1270 =head2 $c->uri_for( $path?, @args?, \%query_values? )
1272 =head2 $c->uri_for( $action, \@captures?, @args?, \%query_values? )
1274 Constructs an absolute L<URI> object based on the application root, the
1275 provided path, and the additional arguments and query parameters provided.
1276 When used as a string, provides a textual URI. If you need more flexibility
1277 than this (i.e. the option to provide relative URIs etc.) see
1278 L<Catalyst::Plugin::SmartURI>.
1280 If no arguments are provided, the URI for the current action is returned.
1281 To return the current action and also provide @args, use
1282 C<< $c->uri_for( $c->action, @args ) >>.
1284 If the first argument is a string, it is taken as a public URI path relative
1285 to C<< $c->namespace >> (if it doesn't begin with a forward slash) or
1286 relative to the application root (if it does). It is then merged with
1287 C<< $c->request->base >>; any C<@args> are appended as additional path
1288 components; and any C<%query_values> are appended as C<?foo=bar> parameters.
1290 If the first argument is a L<Catalyst::Action> it represents an action which
1291 will have its path resolved using C<< $c->dispatcher->uri_for_action >>. The
1292 optional C<\@captures> argument (an arrayref) allows passing the captured
1293 variables that are needed to fill in the paths of Chained and Regex actions;
1294 once the path is resolved, C<uri_for> continues as though a path was
1295 provided, appending any arguments or parameters and creating an absolute
1298 The captures for the current request can be found in
1299 C<< $c->request->captures >>, and actions can be resolved using
1300 C<< Catalyst::Controller->action_for($name) >>. If you have a private action
1301 path, use C<< $c->uri_for_action >> instead.
1303 # Equivalent to $c->req->uri
1304 $c->uri_for($c->action, $c->req->captures,
1305 @{ $c->req->args }, $c->req->params);
1307 # For the Foo action in the Bar controller
1308 $c->uri_for($c->controller('Bar')->action_for('Foo'));
1310 # Path to a static resource
1311 $c->uri_for('/static/images/logo.png');
1316 my ( $c, $path, @args ) = @_;
1318 if (blessed($path) && $path->isa('Catalyst::Controller')) {
1319 $path = $path->path_prefix;
1324 undef($path) if (defined $path && $path eq '');
1327 ( scalar @args && ref $args[$#args] eq 'HASH' ? pop @args : {} );
1329 carp "uri_for called with undef argument" if grep { ! defined $_ } @args;
1330 foreach my $arg (@args) {
1331 utf8::encode($arg) if utf8::is_utf8($arg);
1332 $arg =~ s/([^$URI::uric])/$URI::Escape::escapes{$1}/go;
1335 if ( blessed($path) ) { # action object
1336 s|/|%2F|g for @args;
1337 my $captures = [ map { s|/|%2F|g; $_; }
1338 ( scalar @args && ref $args[0] eq 'ARRAY'
1342 foreach my $capture (@$captures) {
1343 utf8::encode($capture) if utf8::is_utf8($capture);
1344 $capture =~ s/([^$URI::uric])/$URI::Escape::escapes{$1}/go;
1348 $path = $c->dispatcher->uri_for_action($action, $captures);
1349 if (not defined $path) {
1350 $c->log->debug(qq/Can't find uri_for action '$action' @$captures/)
1354 $path = '/' if $path eq '';
1357 unshift(@args, $path);
1359 unless (defined $path && $path =~ s!^/!!) { # in-place strip
1360 my $namespace = $c->namespace;
1361 if (defined $path) { # cheesy hack to handle path '../foo'
1362 $namespace =~ s{(?:^|/)[^/]+$}{} while $args[0] =~ s{^\.\./}{};
1364 unshift(@args, $namespace || '');
1367 # join args with '/', or a blank string
1368 my $args = join('/', grep { defined($_) } @args);
1369 $args =~ s/\?/%3F/g; # STUPID STUPID SPECIAL CASE
1371 my $base = $c->req->base;
1372 my $class = ref($base);
1373 $base =~ s{(?<!/)$}{/};
1377 if (my @keys = keys %$params) {
1378 # somewhat lifted from URI::_query's query_form
1379 $query = '?'.join('&', map {
1380 my $val = $params->{$_};
1381 s/([;\/?:@&=+,\$\[\]%])/$URI::Escape::escapes{$1}/go;
1384 $val = '' unless defined $val;
1387 utf8::encode( $param ) if utf8::is_utf8($param);
1388 # using the URI::Escape pattern here so utf8 chars survive
1389 $param =~ s/([^A-Za-z0-9\-_.!~*'() ])/$URI::Escape::escapes{$1}/go;
1391 "${key}=$param"; } ( ref $val eq 'ARRAY' ? @$val : $val ));
1395 my $res = bless(\"${base}${args}${query}", $class);
1399 =head2 $c->uri_for_action( $path, \@captures?, @args?, \%query_values? )
1401 =head2 $c->uri_for_action( $action, \@captures?, @args?, \%query_values? )
1407 A private path to the Catalyst action you want to create a URI for.
1409 This is a shortcut for calling C<< $c->dispatcher->get_action_by_path($path)
1410 >> and passing the resulting C<$action> and the remaining arguments to C<<
1413 You can also pass in a Catalyst::Action object, in which case it is passed to
1416 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.
1418 For example, if the action looks like:
1420 package MyApp::Controller::Users;
1422 sub lst : Path('the-list') {}
1426 $c->uri_for_action('/users/lst')
1428 and it will create the URI /users/the-list.
1434 sub uri_for_action {
1435 my ( $c, $path, @args ) = @_;
1436 my $action = blessed($path)
1438 : $c->dispatcher->get_action_by_path($path);
1439 unless (defined $action) {
1440 croak "Can't find action for path '$path'";
1442 return $c->uri_for( $action, @args );
1445 =head2 $c->welcome_message
1447 Returns the Catalyst welcome HTML page.
1451 sub welcome_message {
1453 my $name = $c->config->{name};
1454 my $logo = $c->uri_for('/static/images/catalyst_logo.png');
1455 my $prefix = Catalyst::Utils::appprefix( ref $c );
1456 $c->response->content_type('text/html; charset=utf-8');
1458 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
1459 "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
1460 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
1462 <meta http-equiv="Content-Language" content="en" />
1463 <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
1464 <title>$name on Catalyst $VERSION</title>
1465 <style type="text/css">
1468 background-color: #eee;
1475 margin-bottom: 10px;
1477 background-color: #ccc;
1478 border: 1px solid #aaa;
1483 font-family: verdana, tahoma, sans-serif;
1486 font-family: verdana, tahoma, sans-serif;
1489 text-decoration: none;
1491 border-bottom: 1px dotted #bbb;
1493 :link:hover, :visited:hover {
1506 background-color: #fff;
1507 border: 1px solid #aaa;
1511 font-weight: normal;
1533 <h1><span id="appname">$name</span> on <a href="http://catalyst.perl.org">Catalyst</a>
1538 <img src="$logo" alt="Catalyst Logo" />
1540 <p>Welcome to the world of Catalyst.
1541 This <a href="http://en.wikipedia.org/wiki/MVC">MVC</a>
1542 framework will make web development something you had
1543 never expected it to be: Fun, rewarding, and quick.</p>
1544 <h2>What to do now?</h2>
1545 <p>That really depends on what <b>you</b> want to do.
1546 We do, however, provide you with a few starting points.</p>
1547 <p>If you want to jump right into web development with Catalyst
1548 you might want to start with a tutorial.</p>
1549 <pre>perldoc <a href="http://cpansearch.perl.org/dist/Catalyst-Manual/lib/Catalyst/Manual/Tutorial.pod">Catalyst::Manual::Tutorial</a></code>
1551 <p>Afterwards you can go on to check out a more complete look at our features.</p>
1553 <code>perldoc <a href="http://cpansearch.perl.org/dist/Catalyst-Manual/lib/Catalyst/Manual/Intro.pod">Catalyst::Manual::Intro</a>
1554 <!-- Something else should go here, but the Catalyst::Manual link seems unhelpful -->
1556 <h2>What to do next?</h2>
1557 <p>Next it's time to write an actual application. Use the
1558 helper scripts to generate <a href="http://cpansearch.perl.org/search?query=Catalyst%3A%3AController%3A%3A&mode=all">controllers</a>,
1559 <a href="http://cpansearch.perl.org/search?query=Catalyst%3A%3AModel%3A%3A&mode=all">models</a>, and
1560 <a href="http://cpansearch.perl.org/search?query=Catalyst%3A%3AView%3A%3A&mode=all">views</a>;
1561 they can save you a lot of work.</p>
1562 <pre><code>script/${prefix}_create.pl --help</code></pre>
1563 <p>Also, be sure to check out the vast and growing
1564 collection of <a href="http://search.cpan.org/search?query=Catalyst">plugins for Catalyst on CPAN</a>;
1565 you are likely to find what you need there.
1569 <p>Catalyst has a very active community. Here are the main places to
1570 get in touch with us.</p>
1573 <a href="http://dev.catalyst.perl.org">Wiki</a>
1576 <a href="http://lists.scsys.co.uk/cgi-bin/mailman/listinfo/catalyst">Mailing-List</a>
1579 <a href="irc://irc.perl.org/catalyst">IRC channel #catalyst on irc.perl.org</a>
1582 <h2>In conclusion</h2>
1583 <p>The Catalyst team hopes you will enjoy using Catalyst as much
1584 as we enjoyed making it. Please contact us if you have ideas
1585 for improvement or other feedback.</p>
1593 =head1 INTERNAL METHODS
1595 These methods are not meant to be used by end users.
1597 =head2 $c->components
1599 Returns a hash of components.
1603 around components => sub {
1608 return $class->$orig if ( !$comps );
1610 # FIXME: should this ugly kludge exist?
1611 $class->setup_config unless defined $class->container;
1613 # FIXME: should there be a warning here, not to use this accessor to create the components?
1614 my $components = {};
1617 $containers->{$_} = $class->container->get_sub_container($_) for qw(model view controller);
1619 for my $component ( keys %$comps ) {
1620 $components->{ $component } = $comps->{$component};
1622 my ($type, $name) = _get_component_type_name($component);
1624 # FIXME: shouldn't the service name be $name?
1625 $containers->{$type}->add_service(Bread::Board::BlockInjection->new( name => $component, block => sub { return $class->setup_component($component) } ));
1628 return $class->$orig($components);
1631 =head2 $c->context_class
1633 Returns or sets the context class.
1637 Returns a hashref containing coderefs and execution counts (needed for
1638 deep recursion detection).
1642 Returns the number of actions on the current internal execution stack.
1646 Dispatches a request to actions.
1650 sub dispatch { my $c = shift; $c->dispatcher->dispatch( $c, @_ ) }
1652 =head2 $c->dispatcher_class
1654 Returns or sets the dispatcher class.
1656 =head2 $c->dump_these
1658 Returns a list of 2-element array references (name, structure) pairs
1659 that will be dumped on the error page in debug mode.
1665 [ Request => $c->req ],
1666 [ Response => $c->res ],
1667 [ Stash => $c->stash ],
1668 [ Config => $c->config ];
1671 =head2 $c->engine_class
1673 Returns or sets the engine class.
1675 =head2 $c->execute( $class, $coderef )
1677 Execute a coderef in given class and catch exceptions. Errors are available
1683 my ( $c, $class, $code ) = @_;
1684 $class = $c->component($class) || $class;
1687 if ( $c->depth >= $RECURSION ) {
1688 my $action = $code->reverse();
1689 $action = "/$action" unless $action =~ /->/;
1690 my $error = qq/Deep recursion detected calling "${action}"/;
1691 $c->log->error($error);
1697 my $stats_info = $c->_stats_start_execute( $code ) if $c->use_stats;
1699 push( @{ $c->stack }, $code );
1701 no warnings 'recursion';
1702 # N.B. This used to be combined, but I have seen $c get clobbered if so, and
1703 # I have no idea how, ergo $ret (which appears to fix the issue)
1704 eval { my $ret = $code->execute( $class, $c, @{ $c->req->args } ) || 0; $c->state( $ret ) };
1706 $c->_stats_finish_execute( $stats_info ) if $c->use_stats and $stats_info;
1708 my $last = pop( @{ $c->stack } );
1710 if ( my $error = $@ ) {
1711 if ( blessed($error) and $error->isa('Catalyst::Exception::Detach') ) {
1712 $error->rethrow if $c->depth > 1;
1714 elsif ( blessed($error) and $error->isa('Catalyst::Exception::Go') ) {
1715 $error->rethrow if $c->depth > 0;
1718 unless ( ref $error ) {
1719 no warnings 'uninitialized';
1721 my $class = $last->class;
1722 my $name = $last->name;
1723 $error = qq/Caught exception in $class->$name "$error"/;
1732 sub _stats_start_execute {
1733 my ( $c, $code ) = @_;
1734 my $appclass = ref($c) || $c;
1735 return if ( ( $code->name =~ /^_.*/ )
1736 && ( !$appclass->config->{show_internal_actions} ) );
1738 my $action_name = $code->reverse();
1739 $c->counter->{$action_name}++;
1741 my $action = $action_name;
1742 $action = "/$action" unless $action =~ /->/;
1744 # determine if the call was the result of a forward
1745 # this is done by walking up the call stack and looking for a calling
1746 # sub of Catalyst::forward before the eval
1748 for my $index ( 2 .. 11 ) {
1750 if ( ( caller($index) )[0] eq 'Catalyst'
1751 && ( caller($index) )[3] eq '(eval)' );
1753 if ( ( caller($index) )[3] =~ /forward$/ ) {
1754 $callsub = ( caller($index) )[3];
1755 $action = "-> $action";
1760 my $uid = $action_name . $c->counter->{$action_name};
1762 # is this a root-level call or a forwarded call?
1763 if ( $callsub =~ /forward$/ ) {
1764 my $parent = $c->stack->[-1];
1766 # forward, locate the caller
1767 if ( defined $parent && exists $c->counter->{"$parent"} ) {
1770 parent => "$parent" . $c->counter->{"$parent"},
1776 # forward with no caller may come from a plugin
1795 sub _stats_finish_execute {
1796 my ( $c, $info ) = @_;
1797 $c->stats->profile( end => $info );
1802 Finalizes the request.
1809 for my $error ( @{ $c->error } ) {
1810 $c->log->error($error);
1813 # Allow engine to handle finalize flow (for POE)
1814 my $engine = $c->engine;
1815 if ( my $code = $engine->can('finalize') ) {
1820 $c->finalize_uploads;
1823 if ( $#{ $c->error } >= 0 ) {
1827 $c->finalize_headers;
1830 if ( $c->request->method eq 'HEAD' ) {
1831 $c->response->body('');
1839 if ($c->use_stats) {
1840 my $elapsed = sprintf '%f', $c->stats->elapsed;
1841 my $av = $elapsed == 0 ? '??' : sprintf '%.3f', 1 / $elapsed;
1843 "Request took ${elapsed}s ($av/s)\n" . $c->stats->report . "\n" );
1846 return $c->response->status;
1849 =head2 $c->finalize_body
1855 sub finalize_body { my $c = shift; $c->engine->finalize_body( $c, @_ ) }
1857 =head2 $c->finalize_cookies
1863 sub finalize_cookies { my $c = shift; $c->engine->finalize_cookies( $c, @_ ) }
1865 =head2 $c->finalize_error
1871 sub finalize_error { my $c = shift; $c->engine->finalize_error( $c, @_ ) }
1873 =head2 $c->finalize_headers
1879 sub finalize_headers {
1882 my $response = $c->response; #accessor calls can add up?
1884 # Check if we already finalized headers
1885 return if $response->finalized_headers;
1888 if ( my $location = $response->redirect ) {
1889 $c->log->debug(qq/Redirecting to "$location"/) if $c->debug;
1890 $response->header( Location => $location );
1892 if ( !$response->has_body ) {
1893 # Add a default body if none is already present
1895 qq{<html><body><p>This item has moved <a href="$location">here</a>.</p></body></html>}
1901 if ( defined $response->body && length $response->body && !$response->content_length ) {
1903 # get the length from a filehandle
1904 if ( blessed( $response->body ) && $response->body->can('read') || ref( $response->body ) eq 'GLOB' )
1906 my $stat = stat $response->body;
1907 if ( $stat && $stat->size > 0 ) {
1908 $response->content_length( $stat->size );
1911 $c->log->warn('Serving filehandle without a content-length');
1915 # everything should be bytes at this point, but just in case
1916 $response->content_length( length( $response->body ) );
1921 if ( $response->status =~ /^(1\d\d|[23]04)$/ ) {
1922 $response->headers->remove_header("Content-Length");
1923 $response->body('');
1926 $c->finalize_cookies;
1928 $c->engine->finalize_headers( $c, @_ );
1931 $response->finalized_headers(1);
1934 =head2 $c->finalize_output
1936 An alias for finalize_body.
1938 =head2 $c->finalize_read
1940 Finalizes the input after reading is complete.
1944 sub finalize_read { my $c = shift; $c->engine->finalize_read( $c, @_ ) }
1946 =head2 $c->finalize_uploads
1948 Finalizes uploads. Cleans up any temporary files.
1952 sub finalize_uploads { my $c = shift; $c->engine->finalize_uploads( $c, @_ ) }
1954 =head2 $c->get_action( $action, $namespace )
1956 Gets an action in a given namespace.
1960 sub get_action { my $c = shift; $c->dispatcher->get_action(@_) }
1962 =head2 $c->get_actions( $action, $namespace )
1964 Gets all actions of a given name in a namespace and all parent
1969 sub get_actions { my $c = shift; $c->dispatcher->get_actions( $c, @_ ) }
1971 =head2 $app->handle_request( @arguments )
1973 Called to handle each HTTP request.
1977 sub handle_request {
1978 my ( $class, @arguments ) = @_;
1980 # Always expect worst case!
1983 if ($class->debug) {
1984 my $secs = time - $START || 1;
1985 my $av = sprintf '%.3f', $COUNT / $secs;
1986 my $time = localtime time;
1987 $class->log->info("*** Request $COUNT ($av/s) [$$] [$time] ***");
1990 my $c = $class->prepare(@arguments);
1992 $status = $c->finalize;
1995 if ( my $error = $@ ) {
1997 $class->log->error(qq/Caught exception in engine "$error"/);
2002 if(my $coderef = $class->log->can('_flush')){
2003 $class->log->$coderef();
2008 =head2 $c->prepare( @arguments )
2010 Creates a Catalyst context from an engine-specific request (Apache, CGI,
2016 my ( $class, @arguments ) = @_;
2019 # After the app/ctxt split, this should become an attribute based on something passed
2020 # into the application.
2021 $class->context_class( ref $class || $class ) unless $class->context_class;
2023 my $c = $class->context_class->new({});
2025 # For on-demand data
2026 $c->request->_context($c);
2027 $c->response->_context($c);
2029 #surely this is not the most efficient way to do things...
2030 $c->stats($class->stats_class->new)->enable($c->use_stats);
2031 if ( $c->debug || $c->config->{enable_catalyst_header} ) {
2032 $c->res->headers->header( 'X-Catalyst' => $Catalyst::VERSION );
2035 #XXX reuse coderef from can
2036 # Allow engine to direct the prepare flow (for POE)
2037 if ( $c->engine->can('prepare') ) {
2038 $c->engine->prepare( $c, @arguments );
2041 $c->prepare_request(@arguments);
2042 $c->prepare_connection;
2043 $c->prepare_query_parameters;
2044 $c->prepare_headers;
2045 $c->prepare_cookies;
2048 # Prepare the body for reading, either by prepare_body
2049 # or the user, if they are using $c->read
2052 # Parse the body unless the user wants it on-demand
2053 unless ( ref($c)->config->{parse_on_demand} ) {
2058 my $method = $c->req->method || '';
2059 my $path = $c->req->path;
2060 $path = '/' unless length $path;
2061 my $address = $c->req->address || '';
2070 =head2 $c->prepare_action
2072 Prepares action. See L<Catalyst::Dispatcher>.
2076 sub prepare_action { my $c = shift; $c->dispatcher->prepare_action( $c, @_ ) }
2078 =head2 $c->prepare_body
2080 Prepares message body.
2087 return if $c->request->_has_body;
2089 # Initialize on-demand data
2090 $c->engine->prepare_body( $c, @_ );
2091 $c->prepare_parameters;
2092 $c->prepare_uploads;
2095 =head2 $c->prepare_body_chunk( $chunk )
2097 Prepares a chunk of data before sending it to L<HTTP::Body>.
2099 See L<Catalyst::Engine>.
2103 sub prepare_body_chunk {
2105 $c->engine->prepare_body_chunk( $c, @_ );
2108 =head2 $c->prepare_body_parameters
2110 Prepares body parameters.
2114 sub prepare_body_parameters {
2116 $c->engine->prepare_body_parameters( $c, @_ );
2119 =head2 $c->prepare_connection
2121 Prepares connection.
2125 sub prepare_connection {
2127 $c->engine->prepare_connection( $c, @_ );
2130 =head2 $c->prepare_cookies
2136 sub prepare_cookies { my $c = shift; $c->engine->prepare_cookies( $c, @_ ) }
2138 =head2 $c->prepare_headers
2144 sub prepare_headers { my $c = shift; $c->engine->prepare_headers( $c, @_ ) }
2146 =head2 $c->prepare_parameters
2148 Prepares parameters.
2152 sub prepare_parameters {
2154 $c->prepare_body_parameters;
2155 $c->engine->prepare_parameters( $c, @_ );
2158 =head2 $c->prepare_path
2160 Prepares path and base.
2164 sub prepare_path { my $c = shift; $c->engine->prepare_path( $c, @_ ) }
2166 =head2 $c->prepare_query_parameters
2168 Prepares query parameters.
2172 sub prepare_query_parameters {
2175 $c->engine->prepare_query_parameters( $c, @_ );
2178 =head2 $c->log_request
2180 Writes information about the request to the debug logs. This includes:
2184 =item * Request method, path, and remote IP address
2186 =item * Query keywords (see L<Catalyst::Request/query_keywords>)
2188 =item * Request parameters
2190 =item * File uploads
2199 return unless $c->debug;
2201 my($dump) = grep {$_->[0] eq 'Request' } $c->dump_these;
2202 my $request = $dump->[1];
2204 my ( $method, $path, $address ) = ( $request->method, $request->path, $request->address );
2206 $path = '/' unless length $path;
2208 $c->log->debug(qq/"$method" request for "$path" from "$address"/);
2210 $c->log_request_headers($request->headers);
2212 if ( my $keywords = $request->query_keywords ) {
2213 $c->log->debug("Query keywords are: $keywords");
2216 $c->log_request_parameters( query => $request->query_parameters, $request->_has_body ? (body => $request->body_parameters) : () );
2218 $c->log_request_uploads($request);
2221 =head2 $c->log_response
2223 Writes information about the response to the debug logs by calling
2224 C<< $c->log_response_status_line >> and C<< $c->log_response_headers >>.
2231 return unless $c->debug;
2233 my($dump) = grep {$_->[0] eq 'Response' } $c->dump_these;
2234 my $response = $dump->[1];
2236 $c->log_response_status_line($response);
2237 $c->log_response_headers($response->headers);
2240 =head2 $c->log_response_status_line($response)
2242 Writes one line of information about the response to the debug logs. This includes:
2246 =item * Response status code
2248 =item * Content-Type header (if present)
2250 =item * Content-Length header (if present)
2256 sub log_response_status_line {
2257 my ($c, $response) = @_;
2261 'Response Code: %s; Content-Type: %s; Content-Length: %s',
2262 $response->status || 'unknown',
2263 $response->headers->header('Content-Type') || 'unknown',
2264 $response->headers->header('Content-Length') || 'unknown'
2269 =head2 $c->log_response_headers($headers);
2271 Hook method which can be wrapped by plugins to log the responseheaders.
2272 No-op in the default implementation.
2276 sub log_response_headers {}
2278 =head2 $c->log_request_parameters( query => {}, body => {} )
2280 Logs request parameters to debug logs
2284 sub log_request_parameters {
2286 my %all_params = @_;
2288 return unless $c->debug;
2290 my $column_width = Catalyst::Utils::term_width() - 44;
2291 foreach my $type (qw(query body)) {
2292 my $params = $all_params{$type};
2293 next if ! keys %$params;
2294 my $t = Text::SimpleTable->new( [ 35, 'Parameter' ], [ $column_width, 'Value' ] );
2295 for my $key ( sort keys %$params ) {
2296 my $param = $params->{$key};
2297 my $value = defined($param) ? $param : '';
2298 $t->row( $key, ref $value eq 'ARRAY' ? ( join ', ', @$value ) : $value );
2300 $c->log->debug( ucfirst($type) . " Parameters are:\n" . $t->draw );
2304 =head2 $c->log_request_uploads
2306 Logs file uploads included in the request to the debug logs.
2307 The parameter name, filename, file type, and file size are all included in
2312 sub log_request_uploads {
2314 my $request = shift;
2315 return unless $c->debug;
2316 my $uploads = $request->uploads;
2317 if ( keys %$uploads ) {
2318 my $t = Text::SimpleTable->new(
2319 [ 12, 'Parameter' ],
2324 for my $key ( sort keys %$uploads ) {
2325 my $upload = $uploads->{$key};
2326 for my $u ( ref $upload eq 'ARRAY' ? @{$upload} : ($upload) ) {
2327 $t->row( $key, $u->filename, $u->type, $u->size );
2330 $c->log->debug( "File Uploads are:\n" . $t->draw );
2334 =head2 $c->log_request_headers($headers);
2336 Hook method which can be wrapped by plugins to log the request headers.
2337 No-op in the default implementation.
2341 sub log_request_headers {}
2343 =head2 $c->log_headers($type => $headers)
2345 Logs L<HTTP::Headers> (either request or response) to the debug logs.
2352 my $headers = shift; # an HTTP::Headers instance
2354 return unless $c->debug;
2356 my $column_width = Catalyst::Utils::term_width() - 28;
2357 my $t = Text::SimpleTable->new( [ 15, 'Header Name' ], [ $column_width, 'Value' ] );
2360 my ( $name, $value ) = @_;
2361 $t->row( $name, $value );
2364 $c->log->debug( ucfirst($type) . " Headers:\n" . $t->draw );
2368 =head2 $c->prepare_read
2370 Prepares the input for reading.
2374 sub prepare_read { my $c = shift; $c->engine->prepare_read( $c, @_ ) }
2376 =head2 $c->prepare_request
2378 Prepares the engine request.
2382 sub prepare_request { my $c = shift; $c->engine->prepare_request( $c, @_ ) }
2384 =head2 $c->prepare_uploads
2390 sub prepare_uploads {
2393 $c->engine->prepare_uploads( $c, @_ );
2396 =head2 $c->prepare_write
2398 Prepares the output for writing.
2402 sub prepare_write { my $c = shift; $c->engine->prepare_write( $c, @_ ) }
2404 =head2 $c->request_class
2406 Returns or sets the request class. Defaults to L<Catalyst::Request>.
2408 =head2 $c->response_class
2410 Returns or sets the response class. Defaults to L<Catalyst::Response>.
2412 =head2 $c->read( [$maxlength] )
2414 Reads a chunk of data from the request body. This method is designed to
2415 be used in a while loop, reading C<$maxlength> bytes on every call.
2416 C<$maxlength> defaults to the size of the request if not specified.
2418 You have to set C<< MyApp->config(parse_on_demand => 1) >> to use this
2421 Warning: If you use read(), Catalyst will not process the body,
2422 so you will not be able to access POST parameters or file uploads via
2423 $c->request. You must handle all body parsing yourself.
2427 sub read { my $c = shift; return $c->engine->read( $c, @_ ) }
2435 sub run { my $c = shift; return $c->engine->run( $c, @_ ) }
2437 =head2 $c->set_action( $action, $code, $namespace, $attrs )
2439 Sets an action in a given namespace.
2443 sub set_action { my $c = shift; $c->dispatcher->set_action( $c, @_ ) }
2445 =head2 $c->setup_actions($component)
2447 Sets up actions for a component.
2451 sub setup_actions { my $c = shift; $c->dispatcher->setup_actions( $c, @_ ) }
2453 =head2 $c->setup_config
2460 my %args = %{ $class->config || {} };
2462 my @container_classes = ( "${class}::Container", 'Catalyst::Container');
2463 unshift @container_classes, delete $args{container_class} if exists $args{container_class};
2465 my $container_class = Class::MOP::load_first_existing_class(@container_classes);
2467 my $container = $container_class->new( %args, name => "$class" );
2468 $class->container($container);
2470 my $config = $container->resolve(service => 'config');
2471 $class->config($config);
2472 $class->finalize_config; # back-compat
2475 =head $c->finalize_config
2479 sub finalize_config { }
2481 =head2 $c->setup_components
2483 This method is called internally to set up the application's components.
2485 It finds modules by calling the L<locate_components> method, expands them to
2486 package names with the L<expand_component_module> method, and then installs
2487 each component into the application.
2489 The C<setup_components> config option is passed to both of the above methods.
2491 Installation of each component is performed by the L<setup_component> method,
2496 sub setup_components {
2499 my $config = $class->config->{ setup_components };
2501 my @comps = $class->locate_components($config);
2502 my %comps = map { $_ => 1 } @comps;
2504 my $deprecatedcatalyst_component_names = grep { /::[CMV]::/ } @comps;
2505 $class->log->warn(qq{Your application is using the deprecated ::[MVC]:: type naming scheme.\n}.
2506 qq{Please switch your class names to ::Model::, ::View:: and ::Controller: as appropriate.\n}
2507 ) if $deprecatedcatalyst_component_names;
2509 for my $component ( @comps ) {
2511 # We pass ignore_loaded here so that overlay files for (e.g.)
2512 # Model::DBI::Schema sub-classes are loaded - if it's in @comps
2513 # we know M::P::O found a file on disk so this is safe
2515 Catalyst::Utils::ensure_class_loaded( $component, { ignore_loaded => 1 } );
2519 $containers->{$_} = $class->container->get_sub_container($_) for qw(model view controller);
2521 for my $component (@comps) {
2522 my $instance = $class->components->{ $component } = $class->setup_component($component);
2523 if ( my ($type, $name) = _get_component_type_name($component) ) {
2524 # FIXME: shouldn't the service name be $name?
2525 $containers->{$type}->add_service(Bread::Board::BlockInjection->new( name => $component, block => sub { return $instance } ));
2527 my @expanded_components = $instance->can('expand_modules')
2528 ? $instance->expand_modules( $component, $config )
2529 : $class->expand_component_module( $component, $config );
2530 for my $component (@expanded_components) {
2531 next if $comps{$component};
2533 $deprecatedcatalyst_component_names = grep { /::[CMV]::/ } @expanded_components;
2534 $class->log->warn(qq{Your application is using the deprecated ::[MVC]:: type naming scheme.\n}.
2535 qq{Please switch your class names to ::Model::, ::View:: and ::Controller: as appropriate.\n}
2536 ) if $deprecatedcatalyst_component_names;
2538 if (my ($type, $name) = _get_component_type_name($component)) {
2539 $containers->{$type}->add_service(Bread::Board::BlockInjection->new( name => $component, block => sub { return $class->setup_component($component) } ));
2542 $class->components->{ $component } = $class->setup_component($component);
2547 sub _get_component_type_name {
2548 my $component = shift;
2549 my @parts = split /::/, $component;
2551 while (my $type = shift @parts) {
2552 return ('controller', join '::', @parts)
2553 if $type =~ /^(c|controller)$/i;
2555 return ('model', join '::', @parts)
2556 if $type =~ /^(m|model)$/i;
2558 return ('view', join '::', @parts)
2559 if $type =~ /^(v|view)$/i;
2563 =head2 $c->locate_components( $setup_component_config )
2565 This method is meant to provide a list of component modules that should be
2566 setup for the application. By default, it will use L<Module::Pluggable>.
2568 Specify a C<setup_components> config option to pass additional options directly
2569 to L<Module::Pluggable>. To add additional search paths, specify a key named
2570 C<search_extra> as an array reference. Items in the array beginning with C<::>
2571 will have the application class name prepended to them.
2575 sub locate_components {
2579 my @paths = qw( ::Controller ::C ::Model ::M ::View ::V );
2580 my $extra = delete $config->{ search_extra } || [];
2582 push @paths, @$extra;
2584 my $locator = Module::Pluggable::Object->new(
2585 search_path => [ map { s/^(?=::)/$class/; $_; } @paths ],
2589 # XXX think about ditching this sort entirely
2590 my @comps = sort { length $a <=> length $b } $locator->plugins;
2595 =head2 $c->expand_component_module( $component, $setup_component_config )
2597 Components found by C<locate_components> will be passed to this method, which
2598 is expected to return a list of component (package) names to be set up.
2602 sub expand_component_module {
2603 my ($class, $module) = @_;
2604 return Devel::InnerPackage::list_packages( $module );
2607 =head2 $c->setup_component
2611 sub setup_component {
2612 my( $class, $component ) = @_;
2614 unless ( $component->can( 'COMPONENT' ) ) {
2618 my $suffix = Catalyst::Utils::class2classsuffix( $component );
2619 my $config = $class->config->{ $suffix } || {};
2620 # Stash catalyst_component_name in the config here, so that custom COMPONENT
2621 # methods also pass it. local to avoid pointlessly shitting in config
2622 # for the debug screen, as $component is already the key name.
2623 local $config->{catalyst_component_name} = $component;
2625 my $instance = eval { $component->COMPONENT( $class, $config ); };
2627 if ( my $error = $@ ) {
2629 Catalyst::Exception->throw(
2630 message => qq/Couldn't instantiate component "$component", "$error"/
2633 elsif (!blessed $instance) {
2634 my $metaclass = Moose::Util::find_meta($component);
2635 my $method_meta = $metaclass->find_method_by_name('COMPONENT');
2636 my $component_method_from = $method_meta->associated_metaclass->name;
2637 my $value = defined($instance) ? $instance : 'undef';
2638 Catalyst::Exception->throw(
2640 qq/Couldn't instantiate component "$component", COMPONENT() method (from $component_method_from) didn't return an object-like value (value was $value)./
2647 =head2 $c->setup_dispatcher
2653 sub setup_dispatcher {
2654 my ( $class, $dispatcher ) = @_;
2657 $dispatcher = 'Catalyst::Dispatcher::' . $dispatcher;
2660 if ( my $env = Catalyst::Utils::env_value( $class, 'DISPATCHER' ) ) {
2661 $dispatcher = 'Catalyst::Dispatcher::' . $env;
2664 unless ($dispatcher) {
2665 $dispatcher = $class->dispatcher_class;
2668 Class::MOP::load_class($dispatcher);
2670 # dispatcher instance
2671 $class->dispatcher( $dispatcher->new );
2674 =head2 $c->setup_engine
2681 my ( $class, $engine ) = @_;
2684 $engine = 'Catalyst::Engine::' . $engine;
2687 if ( my $env = Catalyst::Utils::env_value( $class, 'ENGINE' ) ) {
2688 $engine = 'Catalyst::Engine::' . $env;
2691 if ( $ENV{MOD_PERL} ) {
2692 my $meta = Class::MOP::get_metaclass_by_name($class);
2694 # create the apache method
2695 $meta->add_method('apache' => sub { shift->engine->apache });
2697 my ( $software, $version ) =
2698 $ENV{MOD_PERL} =~ /^(\S+)\/(\d+(?:[\.\_]\d+)+)/;
2701 $version =~ s/(\.[^.]+)\./$1/g;
2703 if ( $software eq 'mod_perl' ) {
2707 if ( $version >= 1.99922 ) {
2708 $engine = 'Catalyst::Engine::Apache2::MP20';
2711 elsif ( $version >= 1.9901 ) {
2712 $engine = 'Catalyst::Engine::Apache2::MP19';
2715 elsif ( $version >= 1.24 ) {
2716 $engine = 'Catalyst::Engine::Apache::MP13';
2720 Catalyst::Exception->throw( message =>
2721 qq/Unsupported mod_perl version: $ENV{MOD_PERL}/ );
2726 # install the correct mod_perl handler
2727 if ( $version >= 1.9901 ) {
2728 *handler = sub : method {
2729 shift->handle_request(@_);
2733 *handler = sub ($$) { shift->handle_request(@_) };
2738 elsif ( $software eq 'Zeus-Perl' ) {
2739 $engine = 'Catalyst::Engine::Zeus';
2743 Catalyst::Exception->throw(
2744 message => qq/Unsupported mod_perl: $ENV{MOD_PERL}/ );
2749 $engine = $class->engine_class;
2752 Class::MOP::load_class($engine);
2754 # check for old engines that are no longer compatible
2756 if ( $engine->isa('Catalyst::Engine::Apache')
2757 && !Catalyst::Engine::Apache->VERSION )
2762 elsif ( $engine->isa('Catalyst::Engine::Server::Base')
2763 && Catalyst::Engine::Server->VERSION le '0.02' )
2768 elsif ($engine->isa('Catalyst::Engine::HTTP::POE')
2769 && $engine->VERSION eq '0.01' )
2774 elsif ($engine->isa('Catalyst::Engine::Zeus')
2775 && $engine->VERSION eq '0.01' )
2781 Catalyst::Exception->throw( message =>
2782 qq/Engine "$engine" is not supported by this version of Catalyst/
2787 $class->engine( $engine->new );
2790 =head2 $c->setup_home
2792 Sets up the home directory.
2797 my ( $class, $home ) = @_;
2799 if ( my $env = Catalyst::Utils::env_value( $class, 'HOME' ) ) {
2803 $home ||= Catalyst::Utils::home($class);
2806 #I remember recently being scolded for assigning config values like this
2807 $class->config->{home} ||= $home;
2808 $class->config->{root} ||= Path::Class::Dir->new($home)->subdir('root');
2812 =head2 $c->setup_log
2814 Sets up log by instantiating a L<Catalyst::Log|Catalyst::Log> object and
2815 passing it to C<log()>. Pass in a comma-delimited list of levels to set the
2818 This method also installs a C<debug> method that returns a true value into the
2819 catalyst subclass if the "debug" level is passed in the comma-delimited list,
2820 or if the C<$CATALYST_DEBUG> environment variable is set to a true value.
2822 Note that if the log has already been setup, by either a previous call to
2823 C<setup_log> or by a call such as C<< __PACKAGE__->log( MyLogger->new ) >>,
2824 that this method won't actually set up the log object.
2829 my ( $class, $levels ) = @_;
2832 $levels =~ s/^\s+//;
2833 $levels =~ s/\s+$//;
2834 my %levels = map { $_ => 1 } split /\s*,\s*/, $levels;
2836 my $env_debug = Catalyst::Utils::env_value( $class, 'DEBUG' );
2837 if ( defined $env_debug ) {
2838 $levels{debug} = 1 if $env_debug; # Ugly!
2839 delete($levels{debug}) unless $env_debug;
2842 unless ( $class->log ) {
2843 $class->log( Catalyst::Log->new(keys %levels) );
2846 if ( $levels{debug} ) {
2847 Class::MOP::get_metaclass_by_name($class)->add_method('debug' => sub { 1 });
2848 $class->log->debug('Debug messages enabled');
2852 =head2 $c->setup_plugins
2858 =head2 $c->setup_stats
2860 Sets up timing statistics class.
2865 my ( $class, $stats ) = @_;
2867 Catalyst::Utils::ensure_class_loaded($class->stats_class);
2869 my $env = Catalyst::Utils::env_value( $class, 'STATS' );
2870 if ( defined($env) ? $env : ($stats || $class->debug ) ) {
2871 Class::MOP::get_metaclass_by_name($class)->add_method('use_stats' => sub { 1 });
2872 $class->log->debug('Statistics enabled');
2877 =head2 $c->registered_plugins
2879 Returns a sorted list of the plugins which have either been stated in the
2880 import list or which have been added via C<< MyApp->plugin(@args); >>.
2882 If passed a given plugin name, it will report a boolean value indicating
2883 whether or not that plugin is loaded. A fully qualified name is required if
2884 the plugin name does not begin with C<Catalyst::Plugin::>.
2886 if ($c->registered_plugins('Some::Plugin')) {
2894 sub registered_plugins {
2896 return sort keys %{ $proto->_plugins } unless @_;
2898 return 1 if exists $proto->_plugins->{$plugin};
2899 return exists $proto->_plugins->{"Catalyst::Plugin::$plugin"};
2902 sub _register_plugin {
2903 my ( $proto, $plugin, $instant ) = @_;
2904 my $class = ref $proto || $proto;
2906 Class::MOP::load_class( $plugin );
2907 $class->log->warn( "$plugin inherits from 'Catalyst::Component' - this is deprecated and will not work in 5.81" )
2908 if $plugin->isa( 'Catalyst::Component' );
2909 $proto->_plugins->{$plugin} = 1;
2911 my $meta = Class::MOP::get_metaclass_by_name($class);
2912 $meta->superclasses($plugin, $meta->superclasses);
2918 my ( $class, $plugins ) = @_;
2920 $class->_plugins( {} ) unless $class->_plugins;
2921 $plugins = Data::OptList::mkopt($plugins || []);
2924 [ Catalyst::Utils::resolve_namespace(
2925 $class . '::Plugin',
2926 'Catalyst::Plugin', $_->[0]
2932 for my $plugin ( reverse @plugins ) {
2933 Class::MOP::load_class($plugin->[0], $plugin->[1]);
2934 my $meta = find_meta($plugin->[0]);
2935 next if $meta && $meta->isa('Moose::Meta::Role');
2937 $class->_register_plugin($plugin->[0]);
2941 map { $_->[0]->name, $_->[1] }
2942 grep { blessed($_->[0]) && $_->[0]->isa('Moose::Meta::Role') }
2943 map { [find_meta($_->[0]), $_->[1]] }
2946 Moose::Util::apply_all_roles(
2954 Returns an arrayref of the internal execution stack (actions that are
2955 currently executing).
2959 Returns the current timing statistics object. By default Catalyst uses
2960 L<Catalyst::Stats|Catalyst::Stats>, but can be set otherwise with
2961 L<< stats_class|/"$c->stats_class" >>.
2963 Even if L<< -Stats|/"-Stats" >> is not enabled, the stats object is still
2964 available. By enabling it with C< $c->stats->enabled(1) >, it can be used to
2965 profile explicitly, although MyApp.pm still won't profile nor output anything
2968 =head2 $c->stats_class
2970 Returns or sets the stats (timing statistics) class. L<Catalyst::Stats|Catalyst::Stats> is used by default.
2972 =head2 $c->use_stats
2974 Returns 1 when L<< stats collection|/"-Stats" >> is enabled.
2976 Note that this is a static method, not an accessor and should be overridden
2977 by declaring C<sub use_stats { 1 }> in your MyApp.pm, not by calling C<< $c->use_stats(1) >>.
2984 =head2 $c->write( $data )
2986 Writes $data to the output stream. When using this method directly, you
2987 will need to manually set the C<Content-Length> header to the length of
2988 your output data, if known.
2995 # Finalize headers if someone manually writes output
2996 $c->finalize_headers;
2998 return $c->engine->write( $c, @_ );
3003 Returns the Catalyst version number. Mostly useful for "powered by"
3004 messages in template systems.
3008 sub version { return $Catalyst::VERSION }
3010 =head1 CONFIGURATION
3012 There are a number of 'base' config variables which can be set:
3018 C<default_model> - The default model picked if you say C<< $c->model >>. See L<< /$c->model($name) >>.
3022 C<default_view> - The default view to be rendered or returned when C<< $c->view >> is called. See L<< /$c->view($name) >>.
3026 C<disable_component_resolution_regex_fallback> - Turns
3027 off the deprecated component resolution functionality so
3028 that if any of the component methods (e.g. C<< $c->controller('Foo') >>)
3029 are called then regex search will not be attempted on string values and
3030 instead C<undef> will be returned.
3034 C<home> - The application home directory. In an uninstalled application,
3035 this is the top level application directory. In an installed application,
3036 this will be the directory containing C<< MyApp.pm >>.
3040 C<ignore_frontend_proxy> - See L</PROXY SUPPORT>
3044 C<name> - The name of the application in debug messages and the debug and
3049 C<parse_on_demand> - The request body (for example file uploads) will not be parsed
3050 until it is accessed. This allows you to (for example) check authentication (and reject
3051 the upload) before actually recieving all the data. See L</ON-DEMAND PARSER>
3055 C<root> - The root directory for templates. Usually this is just a
3056 subdirectory of the home directory, but you can set it to change the
3057 templates to a different directory.
3061 C<search_extra> - Array reference passed to Module::Pluggable to for additional
3062 namespaces from which components will be loaded (and constructed and stored in
3063 C<< $c->components >>).
3067 C<show_internal_actions> - If true, causes internal actions such as C<< _DISPATCH >>
3068 to be shown in hit debug tables in the test server.
3072 C<use_request_uri_for_path> - Controlls if the C<REQUEST_URI> or C<PATH_INFO> environment
3073 variable should be used for determining the request path. See L<Catalyst::Engine::CGI/PATH DECODING>
3074 for more information.
3078 C<using_frontend_proxy> - See L</PROXY SUPPORT>.
3082 =head1 INTERNAL ACTIONS
3084 Catalyst uses internal actions like C<_DISPATCH>, C<_BEGIN>, C<_AUTO>,
3085 C<_ACTION>, and C<_END>. These are by default not shown in the private
3086 action table, but you can make them visible with a config parameter.
3088 MyApp->config(show_internal_actions => 1);
3090 =head1 ON-DEMAND PARSER
3092 The request body is usually parsed at the beginning of a request,
3093 but if you want to handle input yourself, you can enable on-demand
3094 parsing with a config parameter.
3096 MyApp->config(parse_on_demand => 1);
3098 =head1 PROXY SUPPORT
3100 Many production servers operate using the common double-server approach,
3101 with a lightweight frontend web server passing requests to a larger
3102 backend server. An application running on the backend server must deal
3103 with two problems: the remote user always appears to be C<127.0.0.1> and
3104 the server's hostname will appear to be C<localhost> regardless of the
3105 virtual host that the user connected through.
3107 Catalyst will automatically detect this situation when you are running
3108 the frontend and backend servers on the same machine. The following
3109 changes are made to the request.
3111 $c->req->address is set to the user's real IP address, as read from
3112 the HTTP X-Forwarded-For header.
3114 The host value for $c->req->base and $c->req->uri is set to the real
3115 host, as read from the HTTP X-Forwarded-Host header.
3117 Additionally, you may be running your backend application on an insecure
3118 connection (port 80) while your frontend proxy is running under SSL. If there
3119 is a discrepancy in the ports, use the HTTP header C<X-Forwarded-Port> to
3120 tell Catalyst what port the frontend listens on. This will allow all URIs to
3121 be created properly.
3123 In the case of passing in:
3125 X-Forwarded-Port: 443
3127 All calls to C<uri_for> will result in an https link, as is expected.
3129 Obviously, your web server must support these headers for this to work.
3131 In a more complex server farm environment where you may have your
3132 frontend proxy server(s) on different machines, you will need to set a
3133 configuration option to tell Catalyst to read the proxied data from the
3136 MyApp->config(using_frontend_proxy => 1);
3138 If you do not wish to use the proxy support at all, you may set:
3140 MyApp->config(ignore_frontend_proxy => 1);
3142 =head1 THREAD SAFETY
3144 Catalyst has been tested under Apache 2's threading C<mpm_worker>,
3145 C<mpm_winnt>, and the standalone forking HTTP server on Windows. We
3146 believe the Catalyst core to be thread-safe.
3148 If you plan to operate in a threaded environment, remember that all other
3149 modules you are using must also be thread-safe. Some modules, most notably
3150 L<DBD::SQLite>, are not thread-safe.
3156 Join #catalyst on irc.perl.org.
3160 http://lists.scsys.co.uk/cgi-bin/mailman/listinfo/catalyst
3161 http://lists.scsys.co.uk/cgi-bin/mailman/listinfo/catalyst-dev
3165 http://catalyst.perl.org
3169 http://dev.catalyst.perl.org
3173 =head2 L<Task::Catalyst> - All you need to start with Catalyst
3175 =head2 L<Catalyst::Manual> - The Catalyst Manual
3177 =head2 L<Catalyst::Component>, L<Catalyst::Controller> - Base classes for components
3179 =head2 L<Catalyst::Engine> - Core engine
3181 =head2 L<Catalyst::Log> - Log class.
3183 =head2 L<Catalyst::Request> - Request object
3185 =head2 L<Catalyst::Response> - Response object
3187 =head2 L<Catalyst::Test> - The test suite.
3189 =head1 PROJECT FOUNDER
3191 sri: Sebastian Riedel <sri@cpan.org>
3197 acme: Leon Brocard <leon@astray.com>
3199 abraxxa: Alexander Hartmaier <abraxxa@cpan.org>
3203 Andrew Ford E<lt>A.Ford@ford-mason.co.ukE<gt>
3207 andyg: Andy Grundman <andy@hybridized.org>
3209 audreyt: Audrey Tang
3211 bricas: Brian Cassidy <bricas@cpan.org>
3213 Caelum: Rafael Kitover <rkitover@io.com>
3215 chansen: Christian Hansen
3217 chicks: Christopher Hicks
3219 Chisel Wright C<pause@herlpacker.co.uk>
3221 Danijel Milicevic C<me@danijel.de>
3223 David Kamholz E<lt>dkamholz@cpan.orgE<gt>
3225 David Naughton, C<naughton@umn.edu>
3229 dhoss: Devin Austin <dhoss@cpan.org>
3231 dkubb: Dan Kubb <dan.kubb-cpan@onautopilot.com>
3235 dwc: Daniel Westermann-Clark <danieltwc@cpan.org>
3237 esskar: Sascha Kiefer
3239 fireartist: Carl Franks <cfranks@cpan.org>
3241 frew: Arthur Axel "fREW" Schmidt <frioux@gmail.com>
3243 gabb: Danijel Milicevic
3247 Gavin Henry C<ghenry@perl.me.uk>
3251 groditi: Guillermo Roditi <groditi@gmail.com>
3253 hobbs: Andrew Rodland <andrew@cleverdomain.org>
3255 ilmari: Dagfinn Ilmari Mannsåker <ilmari@ilmari.org>
3257 jcamacho: Juan Camacho
3259 jester: Jesse Sheidlower C<jester@panix.com>
3261 jhannah: Jay Hannah <jay@jays.net>
3267 jon: Jon Schutz <jjschutz@cpan.org>
3269 Jonathan Rockway C<< <jrockway@cpan.org> >>
3271 Kieren Diment C<kd@totaldatasolution.com>
3273 konobi: Scott McWhirter <konobi@cpan.org>
3275 marcus: Marcus Ramberg <mramberg@cpan.org>
3277 miyagawa: Tatsuhiko Miyagawa <miyagawa@bulknews.net>
3279 mst: Matt S. Trout <mst@shadowcatsystems.co.uk>
3283 naughton: David Naughton
3285 ningu: David Kamholz <dkamholz@cpan.org>
3287 nothingmuch: Yuval Kogman <nothingmuch@woobling.org>
3289 numa: Dan Sully <daniel@cpan.org>
3295 omega: Andreas Marienborg
3297 Oleg Kostyuk <cub.uanic@gmail.com>
3299 phaylon: Robert Sedlacek <phaylon@dunkelheit.at>
3301 rafl: Florian Ragwitz <rafl@debian.org>
3303 random: Roland Lammel <lammel@cpan.org>
3305 Robert Sedlacek C<< <rs@474.at> >>
3307 SpiceMan: Marcel Montes
3311 szbalint: Balint Szilakszi <szbalint@cpan.org>
3313 t0m: Tomas Doran <bobtfish@bobtfish.net>
3317 Viljo Marrandi C<vilts@yahoo.com>
3319 Will Hawes C<info@whawes.co.uk>
3321 willert: Sebastian Willert <willert@cpan.org>
3323 wreis: Wallace Reis <wallace@reis.org.br>
3325 Yuval Kogman, C<nothingmuch@woobling.org>
3327 rainboxx: Matthias Dietrich, C<perl@rainboxx.de>
3329 dd070: Dhaval Dhanani <dhaval070@gmail.com>
3333 Copyright (c) 2005, the above named PROJECT FOUNDER and CONTRIBUTORS.
3337 This library is free software. You can redistribute it and/or modify it under
3338 the same terms as Perl itself.
3344 __PACKAGE__->meta->make_immutable;