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 } $c->container->get_sub_container_list;
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 return $c->_filter_component( $c->container->get_sub_container('controller')->get_service($check)->get, @args ) if $c->container->get_sub_container('controller')->has_service($check);
661 my @result = $c->_comp_search_prefixes( $name, qw/Controller C/ );
662 return map { $c->_filter_component( $_, @args ) } @result if ref $name;
663 return $c->_filter_component( $result[ 0 ], @args );
666 return $c->component( $c->action->class );
669 =head2 $c->model($name)
671 Gets a L<Catalyst::Model> instance by name.
673 $c->model('Foo')->do_stuff;
675 Any extra arguments are directly passed to ACCEPT_CONTEXT.
677 If the name is omitted, it will look for
678 - a model object in $c->stash->{current_model_instance}, then
679 - a model name in $c->stash->{current_model}, then
680 - a config setting 'default_model', or
681 - check if there is only one model, and return it if that's the case.
683 If you want to search for models, pass in a regexp as the argument.
685 # find all models that start with Foo
686 my @foo_models = $c->model(qr{^Foo});
691 my ( $c, $name, @args ) = @_;
692 my $appclass = ref($c) || $c;
694 unless ( ref($name) ) { # Direct component hash lookup to avoid costly regexps
695 my $check = $appclass."::Model::".$name;
696 return $c->_filter_component( $c->container->get_sub_container('model')->get_service($check)->get, @args ) if $c->container->get_sub_container('model')->has_service($check);
698 my @result = $c->_comp_search_prefixes( $name, qw/Model M/ );
699 return map { $c->_filter_component( $_, @args ) } @result if ref $name;
700 return $c->_filter_component( $result[ 0 ], @args );
704 return $c->stash->{current_model_instance}
705 if $c->stash->{current_model_instance};
706 return $c->model( $c->stash->{current_model} )
707 if $c->stash->{current_model};
709 return $c->model( $appclass->config->{default_model} )
710 if $appclass->config->{default_model};
712 my( $comp, $rest ) = $c->_comp_search_prefixes( undef, qw/Model M/);
715 $c->log->warn( Carp::shortmess('Calling $c->model() will return a random model unless you specify one of:') );
716 $c->log->warn( '* $c->config(default_model => "the name of the default model to use")' );
717 $c->log->warn( '* $c->stash->{current_model} # the name of the model to use for this request' );
718 $c->log->warn( '* $c->stash->{current_model_instance} # the instance of the model to use for this request' );
719 $c->log->warn( 'NB: in version 5.81, the "random" behavior will not work at all.' );
722 return $c->_filter_component( $comp );
726 =head2 $c->view($name)
728 Gets a L<Catalyst::View> instance by name.
730 $c->view('Foo')->do_stuff;
732 Any extra arguments are directly passed to ACCEPT_CONTEXT.
734 If the name is omitted, it will look for
735 - a view object in $c->stash->{current_view_instance}, then
736 - a view name in $c->stash->{current_view}, then
737 - a config setting 'default_view', or
738 - check if there is only one view, and return it if that's the case.
740 If you want to search for views, pass in a regexp as the argument.
742 # find all views that start with Foo
743 my @foo_views = $c->view(qr{^Foo});
748 my ( $c, $name, @args ) = @_;
750 my $appclass = ref($c) || $c;
752 unless ( ref($name) ) { # Direct component hash lookup to avoid costly regexps
753 my $check = $appclass."::View::".$name;
754 if ($c->container->get_sub_container('view')->has_service($check)) {
756 return $c->_filter_component( $c->container->get_sub_container('view')->get_service($check)->get, @args );
759 $c->log->warn( "Attempted to use view '$check', but does not exist" );
762 my @result = $c->_comp_search_prefixes( $name, qw/View V/ );
763 return map { $c->_filter_component( $_, @args ) } @result if ref $name;
764 return $c->_filter_component( $result[ 0 ], @args );
768 return $c->stash->{current_view_instance}
769 if $c->stash->{current_view_instance};
770 return $c->view( $c->stash->{current_view} )
771 if $c->stash->{current_view};
773 return $c->view( $appclass->config->{default_view} )
774 if $appclass->config->{default_view};
776 my( $comp, $rest ) = $c->_comp_search_prefixes( undef, qw/View V/);
779 $c->log->warn( 'Calling $c->view() will return a random view unless you specify one of:' );
780 $c->log->warn( '* $c->config(default_view => "the name of the default view to use")' );
781 $c->log->warn( '* $c->stash->{current_view} # the name of the view to use for this request' );
782 $c->log->warn( '* $c->stash->{current_view_instance} # the instance of the view to use for this request' );
783 $c->log->warn( 'NB: in version 5.81, the "random" behavior will not work at all.' );
786 return $c->_filter_component( $comp );
789 =head2 $c->controllers
791 Returns the available names which can be passed to $c->controller
797 return $c->_comp_names(qw/Controller C/);
802 Returns the available names which can be passed to $c->model
808 return $c->_comp_names(qw/Model M/);
814 Returns the available names which can be passed to $c->view
820 return $c->_comp_names(qw/View V/);
823 =head2 $c->comp($name)
825 =head2 $c->component($name)
827 Gets a component object by name. This method is not recommended,
828 unless you want to get a specific component by full
829 class. C<< $c->controller >>, C<< $c->model >>, and C<< $c->view >>
830 should be used instead.
832 If C<$name> is a regexp, a list of components matched against the full
833 component name will be returned.
835 If Catalyst can't find a component by name, it will fallback to regex
836 matching by default. To disable this behaviour set
837 disable_component_resolution_regex_fallback to a true value.
839 __PACKAGE__->config( disable_component_resolution_regex_fallback => 1 );
844 my ( $c, $name, @args ) = @_;
847 my $comps = $c->components;
850 # is it the exact name?
851 return $c->_filter_component( $comps->{ $name }, @args )
852 if exists $comps->{ $name };
854 # perhaps we just omitted "MyApp"?
855 my $composed = ( ref $c || $c ) . "::${name}";
856 return $c->_filter_component( $comps->{ $composed }, @args )
857 if exists $comps->{ $composed };
859 # search all of the models, views and controllers
860 my( $comp ) = $c->_comp_search_prefixes( $name, qw/Model M Controller C View V/ );
861 return $c->_filter_component( $comp, @args ) if $comp;
864 # This is here so $c->comp( '::M::' ) works
865 my $query = ref $name ? $name : qr{$name}i;
867 my @result = grep { m{$query} } keys %{ $c->components };
868 return map { $c->_filter_component( $_, @args ) } @result if ref $name;
871 $c->log->warn( Carp::shortmess(qq(Found results for "${name}" using regexp fallback)) );
872 $c->log->warn( 'Relying on the regexp fallback behavior for component resolution' );
873 $c->log->warn( 'is unreliable and unsafe. You have been warned' );
874 return $c->_filter_component( $result[ 0 ], @args );
877 # I would expect to return an empty list here, but that breaks back-compat
881 return sort keys %{ $c->components };
884 =head2 CLASS DATA AND HELPER CLASSES
888 Returns or takes a hashref containing the application's configuration.
890 __PACKAGE__->config( { db => 'dsn:SQLite:foo.db' } );
892 You can also use a C<YAML>, C<XML> or L<Config::General> config file
893 like C<myapp.conf> in your applications home directory. See
894 L<Catalyst::Plugin::ConfigLoader>.
896 =head3 Cascading configuration
898 The config method is present on all Catalyst components, and configuration
899 will be merged when an application is started. Configuration loaded with
900 L<Catalyst::Plugin::ConfigLoader> takes precedence over other configuration,
901 followed by configuration in your top level C<MyApp> class. These two
902 configurations are merged, and then configuration data whose hash key matches a
903 component name is merged with configuration for that component.
905 The configuration for a component is then passed to the C<new> method when a
906 component is constructed.
910 MyApp->config({ 'Model::Foo' => { bar => 'baz', overrides => 'me' } });
911 MyApp::Model::Foo->config({ quux => 'frob', overrides => 'this' });
913 will mean that C<MyApp::Model::Foo> receives the following data when
916 MyApp::Model::Foo->new({
922 It's common practice to use a Moose attribute
923 on the receiving component to access the config value.
925 package MyApp::Model::Foo;
929 # this attr will receive 'baz' at construction time
935 You can then get the value 'baz' by calling $c->model('Foo')->bar
936 (or $self->bar inside code in the model).
938 B<NOTE:> you MUST NOT call C<< $self->config >> or C<< __PACKAGE__->config >>
939 as a way of reading config within your code, as this B<will not> give you the
940 correctly merged config back. You B<MUST> take the config values supplied to
941 the constructor and use those instead.
945 around config => sub {
949 croak('Setting config after setup has been run is not allowed.')
950 if ( @_ and $c->setup_finished );
957 Returns the logging object instance. Unless it is already set, Catalyst
958 sets this up with a L<Catalyst::Log> object. To use your own log class,
959 set the logger with the C<< __PACKAGE__->log >> method prior to calling
960 C<< __PACKAGE__->setup >>.
962 __PACKAGE__->log( MyLogger->new );
967 $c->log->info( 'Now logging with my own logger!' );
969 Your log class should implement the methods described in
975 Returns 1 if debug mode is enabled, 0 otherwise.
977 You can enable debug mode in several ways:
981 =item By calling myapp_server.pl with the -d flag
983 =item With the environment variables MYAPP_DEBUG, or CATALYST_DEBUG
985 =item The -Debug option in your MyApp.pm
987 =item By declaring C<sub debug { 1 }> in your MyApp.pm.
991 The first three also set the log level to 'debug'.
993 Calling C<< $c->debug(1) >> has no effect.
999 =head2 $c->dispatcher
1001 Returns the dispatcher instance. See L<Catalyst::Dispatcher>.
1005 Returns the engine instance. See L<Catalyst::Engine>.
1008 =head2 UTILITY METHODS
1010 =head2 $c->path_to(@path)
1012 Merges C<@path> with C<< $c->config->{home} >> and returns a
1013 L<Path::Class::Dir> object. Note you can usually use this object as
1014 a filename, but sometimes you will have to explicitly stringify it
1015 yourself by calling the C<< ->stringify >> method.
1019 $c->path_to( 'db', 'sqlite.db' );
1024 my ( $c, @path ) = @_;
1025 my $path = Path::Class::Dir->new( $c->config->{home}, @path );
1026 if ( -d $path ) { return $path }
1027 else { return Path::Class::File->new( $c->config->{home}, @path ) }
1030 =head2 $c->plugin( $name, $class, @args )
1032 Helper method for plugins. It creates a class data accessor/mutator and
1033 loads and instantiates the given class.
1035 MyApp->plugin( 'prototype', 'HTML::Prototype' );
1037 $c->prototype->define_javascript_functions;
1039 B<Note:> This method of adding plugins is deprecated. The ability
1040 to add plugins like this B<will be removed> in a Catalyst 5.81.
1041 Please do not use this functionality in new code.
1046 my ( $class, $name, $plugin, @args ) = @_;
1048 # See block comment in t/unit_core_plugin.t
1049 $class->log->warn(qq/Adding plugin using the ->plugin method is deprecated, and will be removed in Catalyst 5.81/);
1051 $class->_register_plugin( $plugin, 1 );
1053 eval { $plugin->import };
1054 $class->mk_classdata($name);
1056 eval { $obj = $plugin->new(@args) };
1059 Catalyst::Exception->throw( message =>
1060 qq/Couldn't instantiate instant plugin "$plugin", "$@"/ );
1063 $class->$name($obj);
1064 $class->log->debug(qq/Initialized instant plugin "$plugin" as "$name"/)
1070 Initializes the dispatcher and engine, loads any plugins, and loads the
1071 model, view, and controller components. You may also specify an array
1072 of plugins to load here, if you choose to not load them in the C<use
1076 MyApp->setup( qw/-Debug/ );
1081 my ( $class, @arguments ) = @_;
1082 croak('Running setup more than once')
1083 if ( $class->setup_finished );
1085 unless ( $class->isa('Catalyst') ) {
1087 Catalyst::Exception->throw(
1088 message => qq/'$class' does not inherit from Catalyst/ );
1091 if ( $class->arguments ) {
1092 @arguments = ( @arguments, @{ $class->arguments } );
1098 foreach (@arguments) {
1102 ( $flags->{log} ) ? 'debug,' . $flags->{log} : 'debug';
1104 elsif (/^-(\w+)=?(.*)$/) {
1105 $flags->{ lc $1 } = $2;
1108 push @{ $flags->{plugins} }, $_;
1112 $class->setup_config();
1113 $class->setup_home( delete $flags->{home} );
1115 $class->setup_log( delete $flags->{log} );
1116 $class->setup_plugins( delete $flags->{plugins} );
1117 $class->setup_dispatcher( delete $flags->{dispatcher} );
1118 $class->setup_engine( delete $flags->{engine} );
1119 $class->setup_stats( delete $flags->{stats} );
1121 for my $flag ( sort keys %{$flags} ) {
1123 if ( my $code = $class->can( 'setup_' . $flag ) ) {
1124 &$code( $class, delete $flags->{$flag} );
1127 $class->log->warn(qq/Unknown flag "$flag"/);
1131 eval { require Catalyst::Devel; };
1132 if( !$@ && $ENV{CATALYST_SCRIPT_GEN} && ( $ENV{CATALYST_SCRIPT_GEN} < $Catalyst::Devel::CATALYST_SCRIPT_GEN ) ) {
1133 $class->log->warn(<<"EOF");
1134 You are running an old script!
1136 Please update by running (this will overwrite existing files):
1137 catalyst.pl -force -scripts $class
1139 or (this will not overwrite existing files):
1140 catalyst.pl -scripts $class
1145 if ( $class->debug ) {
1146 my @plugins = map { "$_ " . ( $_->VERSION || '' ) } $class->registered_plugins;
1149 my $column_width = Catalyst::Utils::term_width() - 6;
1150 my $t = Text::SimpleTable->new($column_width);
1151 $t->row($_) for @plugins;
1152 $class->log->debug( "Loaded plugins:\n" . $t->draw . "\n" );
1155 my $dispatcher = $class->dispatcher;
1156 my $engine = $class->engine;
1157 my $home = $class->config->{home};
1159 $class->log->debug(sprintf(q/Loaded dispatcher "%s"/, blessed($dispatcher)));
1160 $class->log->debug(sprintf(q/Loaded engine "%s"/, blessed($engine)));
1164 ? $class->log->debug(qq/Found home "$home"/)
1165 : $class->log->debug(qq/Home "$home" doesn't exist/)
1166 : $class->log->debug(q/Couldn't find home/);
1169 # Call plugins setup, this is stupid and evil.
1170 # Also screws C3 badly on 5.10, hack to avoid.
1172 no warnings qw/redefine/;
1173 local *setup = sub { };
1174 $class->setup unless $Catalyst::__AM_RESTARTING;
1177 # Initialize our data structure
1178 $class->components( {} );
1180 $class->setup_components;
1182 if ( $class->debug ) {
1183 my $column_width = Catalyst::Utils::term_width() - 8 - 9;
1184 my $t = Text::SimpleTable->new( [ $column_width, 'Class' ], [ 8, 'Type' ] );
1185 for my $comp ( sort keys %{ $class->components } ) {
1186 my $type = ref $class->components->{$comp} ? 'instance' : 'class';
1187 $t->row( $comp, $type );
1189 $class->log->debug( "Loaded components:\n" . $t->draw . "\n" )
1190 if ( keys %{ $class->components } );
1193 # Add our self to components, since we are also a component
1194 if( $class->isa('Catalyst::Controller') ){
1195 $class->components->{$class} = $class;
1198 $class->setup_actions;
1200 if ( $class->debug ) {
1201 my $name = $class->config->{name} || 'Application';
1202 $class->log->info("$name powered by Catalyst $Catalyst::VERSION");
1205 # Make sure that the application class becomes immutable at this point,
1206 B::Hooks::EndOfScope::on_scope_end {
1208 my $meta = Class::MOP::get_metaclass_by_name($class);
1211 && ! { $meta->immutable_options }->{replace_constructor}
1213 $class->isa('Class::Accessor::Fast')
1214 || $class->isa('Class::Accessor')
1217 warn "You made your application class ($class) immutable, "
1218 . "but did not inline the\nconstructor. "
1219 . "This will break catalyst, as your app \@ISA "
1220 . "Class::Accessor(::Fast)?\nPlease pass "
1221 . "(replace_constructor => 1)\nwhen making your class immutable.\n";
1223 $meta->make_immutable(
1224 replace_constructor => 1,
1225 ) unless $meta->is_immutable;
1228 if ($class->config->{case_sensitive}) {
1229 $class->log->warn($class . "->config->{case_sensitive} is set.");
1230 $class->log->warn("This setting is deprecated and planned to be removed in Catalyst 5.81.");
1233 $class->setup_finalize;
1234 # Should be the last thing we do so that user things hooking
1235 # setup_finalize can log..
1236 $class->log->_flush() if $class->log->can('_flush');
1237 return 1; # Explicit return true as people have __PACKAGE__->setup as the last thing in their class. HATE.
1240 =head2 $app->setup_finalize
1242 A hook to attach modifiers to. This method does not do anything except set the
1243 C<setup_finished> accessor.
1245 Applying method modifiers to the C<setup> method doesn't work, because of quirky things done for plugin setup.
1249 after setup_finalize => sub {
1257 sub setup_finalize {
1259 $class->setup_finished(1);
1262 =head2 $c->uri_for( $path?, @args?, \%query_values? )
1264 =head2 $c->uri_for( $action, \@captures?, @args?, \%query_values? )
1266 Constructs an absolute L<URI> object based on the application root, the
1267 provided path, and the additional arguments and query parameters provided.
1268 When used as a string, provides a textual URI. If you need more flexibility
1269 than this (i.e. the option to provide relative URIs etc.) see
1270 L<Catalyst::Plugin::SmartURI>.
1272 If no arguments are provided, the URI for the current action is returned.
1273 To return the current action and also provide @args, use
1274 C<< $c->uri_for( $c->action, @args ) >>.
1276 If the first argument is a string, it is taken as a public URI path relative
1277 to C<< $c->namespace >> (if it doesn't begin with a forward slash) or
1278 relative to the application root (if it does). It is then merged with
1279 C<< $c->request->base >>; any C<@args> are appended as additional path
1280 components; and any C<%query_values> are appended as C<?foo=bar> parameters.
1282 If the first argument is a L<Catalyst::Action> it represents an action which
1283 will have its path resolved using C<< $c->dispatcher->uri_for_action >>. The
1284 optional C<\@captures> argument (an arrayref) allows passing the captured
1285 variables that are needed to fill in the paths of Chained and Regex actions;
1286 once the path is resolved, C<uri_for> continues as though a path was
1287 provided, appending any arguments or parameters and creating an absolute
1290 The captures for the current request can be found in
1291 C<< $c->request->captures >>, and actions can be resolved using
1292 C<< Catalyst::Controller->action_for($name) >>. If you have a private action
1293 path, use C<< $c->uri_for_action >> instead.
1295 # Equivalent to $c->req->uri
1296 $c->uri_for($c->action, $c->req->captures,
1297 @{ $c->req->args }, $c->req->params);
1299 # For the Foo action in the Bar controller
1300 $c->uri_for($c->controller('Bar')->action_for('Foo'));
1302 # Path to a static resource
1303 $c->uri_for('/static/images/logo.png');
1308 my ( $c, $path, @args ) = @_;
1310 if (blessed($path) && $path->isa('Catalyst::Controller')) {
1311 $path = $path->path_prefix;
1316 undef($path) if (defined $path && $path eq '');
1319 ( scalar @args && ref $args[$#args] eq 'HASH' ? pop @args : {} );
1321 carp "uri_for called with undef argument" if grep { ! defined $_ } @args;
1322 foreach my $arg (@args) {
1323 utf8::encode($arg) if utf8::is_utf8($arg);
1324 $arg =~ s/([^$URI::uric])/$URI::Escape::escapes{$1}/go;
1327 if ( blessed($path) ) { # action object
1328 s|/|%2F|g for @args;
1329 my $captures = [ map { s|/|%2F|g; $_; }
1330 ( scalar @args && ref $args[0] eq 'ARRAY'
1334 foreach my $capture (@$captures) {
1335 utf8::encode($capture) if utf8::is_utf8($capture);
1336 $capture =~ s/([^$URI::uric])/$URI::Escape::escapes{$1}/go;
1340 $path = $c->dispatcher->uri_for_action($action, $captures);
1341 if (not defined $path) {
1342 $c->log->debug(qq/Can't find uri_for action '$action' @$captures/)
1346 $path = '/' if $path eq '';
1349 unshift(@args, $path);
1351 unless (defined $path && $path =~ s!^/!!) { # in-place strip
1352 my $namespace = $c->namespace;
1353 if (defined $path) { # cheesy hack to handle path '../foo'
1354 $namespace =~ s{(?:^|/)[^/]+$}{} while $args[0] =~ s{^\.\./}{};
1356 unshift(@args, $namespace || '');
1359 # join args with '/', or a blank string
1360 my $args = join('/', grep { defined($_) } @args);
1361 $args =~ s/\?/%3F/g; # STUPID STUPID SPECIAL CASE
1363 my $base = $c->req->base;
1364 my $class = ref($base);
1365 $base =~ s{(?<!/)$}{/};
1369 if (my @keys = keys %$params) {
1370 # somewhat lifted from URI::_query's query_form
1371 $query = '?'.join('&', map {
1372 my $val = $params->{$_};
1373 s/([;\/?:@&=+,\$\[\]%])/$URI::Escape::escapes{$1}/go;
1376 $val = '' unless defined $val;
1379 utf8::encode( $param ) if utf8::is_utf8($param);
1380 # using the URI::Escape pattern here so utf8 chars survive
1381 $param =~ s/([^A-Za-z0-9\-_.!~*'() ])/$URI::Escape::escapes{$1}/go;
1383 "${key}=$param"; } ( ref $val eq 'ARRAY' ? @$val : $val ));
1387 my $res = bless(\"${base}${args}${query}", $class);
1391 =head2 $c->uri_for_action( $path, \@captures?, @args?, \%query_values? )
1393 =head2 $c->uri_for_action( $action, \@captures?, @args?, \%query_values? )
1399 A private path to the Catalyst action you want to create a URI for.
1401 This is a shortcut for calling C<< $c->dispatcher->get_action_by_path($path)
1402 >> and passing the resulting C<$action> and the remaining arguments to C<<
1405 You can also pass in a Catalyst::Action object, in which case it is passed to
1408 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.
1410 For example, if the action looks like:
1412 package MyApp::Controller::Users;
1414 sub lst : Path('the-list') {}
1418 $c->uri_for_action('/users/lst')
1420 and it will create the URI /users/the-list.
1426 sub uri_for_action {
1427 my ( $c, $path, @args ) = @_;
1428 my $action = blessed($path)
1430 : $c->dispatcher->get_action_by_path($path);
1431 unless (defined $action) {
1432 croak "Can't find action for path '$path'";
1434 return $c->uri_for( $action, @args );
1437 =head2 $c->welcome_message
1439 Returns the Catalyst welcome HTML page.
1443 sub welcome_message {
1445 my $name = $c->config->{name};
1446 my $logo = $c->uri_for('/static/images/catalyst_logo.png');
1447 my $prefix = Catalyst::Utils::appprefix( ref $c );
1448 $c->response->content_type('text/html; charset=utf-8');
1450 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
1451 "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
1452 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
1454 <meta http-equiv="Content-Language" content="en" />
1455 <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
1456 <title>$name on Catalyst $VERSION</title>
1457 <style type="text/css">
1460 background-color: #eee;
1467 margin-bottom: 10px;
1469 background-color: #ccc;
1470 border: 1px solid #aaa;
1475 font-family: verdana, tahoma, sans-serif;
1478 font-family: verdana, tahoma, sans-serif;
1481 text-decoration: none;
1483 border-bottom: 1px dotted #bbb;
1485 :link:hover, :visited:hover {
1498 background-color: #fff;
1499 border: 1px solid #aaa;
1503 font-weight: normal;
1525 <h1><span id="appname">$name</span> on <a href="http://catalyst.perl.org">Catalyst</a>
1530 <img src="$logo" alt="Catalyst Logo" />
1532 <p>Welcome to the world of Catalyst.
1533 This <a href="http://en.wikipedia.org/wiki/MVC">MVC</a>
1534 framework will make web development something you had
1535 never expected it to be: Fun, rewarding, and quick.</p>
1536 <h2>What to do now?</h2>
1537 <p>That really depends on what <b>you</b> want to do.
1538 We do, however, provide you with a few starting points.</p>
1539 <p>If you want to jump right into web development with Catalyst
1540 you might want to start with a tutorial.</p>
1541 <pre>perldoc <a href="http://cpansearch.perl.org/dist/Catalyst-Manual/lib/Catalyst/Manual/Tutorial.pod">Catalyst::Manual::Tutorial</a></code>
1543 <p>Afterwards you can go on to check out a more complete look at our features.</p>
1545 <code>perldoc <a href="http://cpansearch.perl.org/dist/Catalyst-Manual/lib/Catalyst/Manual/Intro.pod">Catalyst::Manual::Intro</a>
1546 <!-- Something else should go here, but the Catalyst::Manual link seems unhelpful -->
1548 <h2>What to do next?</h2>
1549 <p>Next it's time to write an actual application. Use the
1550 helper scripts to generate <a href="http://cpansearch.perl.org/search?query=Catalyst%3A%3AController%3A%3A&mode=all">controllers</a>,
1551 <a href="http://cpansearch.perl.org/search?query=Catalyst%3A%3AModel%3A%3A&mode=all">models</a>, and
1552 <a href="http://cpansearch.perl.org/search?query=Catalyst%3A%3AView%3A%3A&mode=all">views</a>;
1553 they can save you a lot of work.</p>
1554 <pre><code>script/${prefix}_create.pl --help</code></pre>
1555 <p>Also, be sure to check out the vast and growing
1556 collection of <a href="http://search.cpan.org/search?query=Catalyst">plugins for Catalyst on CPAN</a>;
1557 you are likely to find what you need there.
1561 <p>Catalyst has a very active community. Here are the main places to
1562 get in touch with us.</p>
1565 <a href="http://dev.catalyst.perl.org">Wiki</a>
1568 <a href="http://lists.scsys.co.uk/cgi-bin/mailman/listinfo/catalyst">Mailing-List</a>
1571 <a href="irc://irc.perl.org/catalyst">IRC channel #catalyst on irc.perl.org</a>
1574 <h2>In conclusion</h2>
1575 <p>The Catalyst team hopes you will enjoy using Catalyst as much
1576 as we enjoyed making it. Please contact us if you have ideas
1577 for improvement or other feedback.</p>
1585 =head1 INTERNAL METHODS
1587 These methods are not meant to be used by end users.
1589 =head2 $c->components
1591 Returns a hash of components.
1593 =head2 $c->context_class
1595 Returns or sets the context class.
1599 Returns a hashref containing coderefs and execution counts (needed for
1600 deep recursion detection).
1604 Returns the number of actions on the current internal execution stack.
1608 Dispatches a request to actions.
1612 sub dispatch { my $c = shift; $c->dispatcher->dispatch( $c, @_ ) }
1614 =head2 $c->dispatcher_class
1616 Returns or sets the dispatcher class.
1618 =head2 $c->dump_these
1620 Returns a list of 2-element array references (name, structure) pairs
1621 that will be dumped on the error page in debug mode.
1627 [ Request => $c->req ],
1628 [ Response => $c->res ],
1629 [ Stash => $c->stash ],
1630 [ Config => $c->config ];
1633 =head2 $c->engine_class
1635 Returns or sets the engine class.
1637 =head2 $c->execute( $class, $coderef )
1639 Execute a coderef in given class and catch exceptions. Errors are available
1645 my ( $c, $class, $code ) = @_;
1646 $class = $c->component($class) || $class;
1649 if ( $c->depth >= $RECURSION ) {
1650 my $action = $code->reverse();
1651 $action = "/$action" unless $action =~ /->/;
1652 my $error = qq/Deep recursion detected calling "${action}"/;
1653 $c->log->error($error);
1659 my $stats_info = $c->_stats_start_execute( $code ) if $c->use_stats;
1661 push( @{ $c->stack }, $code );
1663 no warnings 'recursion';
1664 # N.B. This used to be combined, but I have seen $c get clobbered if so, and
1665 # I have no idea how, ergo $ret (which appears to fix the issue)
1666 eval { my $ret = $code->execute( $class, $c, @{ $c->req->args } ) || 0; $c->state( $ret ) };
1668 $c->_stats_finish_execute( $stats_info ) if $c->use_stats and $stats_info;
1670 my $last = pop( @{ $c->stack } );
1672 if ( my $error = $@ ) {
1673 if ( blessed($error) and $error->isa('Catalyst::Exception::Detach') ) {
1674 $error->rethrow if $c->depth > 1;
1676 elsif ( blessed($error) and $error->isa('Catalyst::Exception::Go') ) {
1677 $error->rethrow if $c->depth > 0;
1680 unless ( ref $error ) {
1681 no warnings 'uninitialized';
1683 my $class = $last->class;
1684 my $name = $last->name;
1685 $error = qq/Caught exception in $class->$name "$error"/;
1694 sub _stats_start_execute {
1695 my ( $c, $code ) = @_;
1696 my $appclass = ref($c) || $c;
1697 return if ( ( $code->name =~ /^_.*/ )
1698 && ( !$appclass->config->{show_internal_actions} ) );
1700 my $action_name = $code->reverse();
1701 $c->counter->{$action_name}++;
1703 my $action = $action_name;
1704 $action = "/$action" unless $action =~ /->/;
1706 # determine if the call was the result of a forward
1707 # this is done by walking up the call stack and looking for a calling
1708 # sub of Catalyst::forward before the eval
1710 for my $index ( 2 .. 11 ) {
1712 if ( ( caller($index) )[0] eq 'Catalyst'
1713 && ( caller($index) )[3] eq '(eval)' );
1715 if ( ( caller($index) )[3] =~ /forward$/ ) {
1716 $callsub = ( caller($index) )[3];
1717 $action = "-> $action";
1722 my $uid = $action_name . $c->counter->{$action_name};
1724 # is this a root-level call or a forwarded call?
1725 if ( $callsub =~ /forward$/ ) {
1726 my $parent = $c->stack->[-1];
1728 # forward, locate the caller
1729 if ( defined $parent && exists $c->counter->{"$parent"} ) {
1732 parent => "$parent" . $c->counter->{"$parent"},
1738 # forward with no caller may come from a plugin
1757 sub _stats_finish_execute {
1758 my ( $c, $info ) = @_;
1759 $c->stats->profile( end => $info );
1764 Finalizes the request.
1771 for my $error ( @{ $c->error } ) {
1772 $c->log->error($error);
1775 # Allow engine to handle finalize flow (for POE)
1776 my $engine = $c->engine;
1777 if ( my $code = $engine->can('finalize') ) {
1782 $c->finalize_uploads;
1785 if ( $#{ $c->error } >= 0 ) {
1789 $c->finalize_headers;
1792 if ( $c->request->method eq 'HEAD' ) {
1793 $c->response->body('');
1801 if ($c->use_stats) {
1802 my $elapsed = sprintf '%f', $c->stats->elapsed;
1803 my $av = $elapsed == 0 ? '??' : sprintf '%.3f', 1 / $elapsed;
1805 "Request took ${elapsed}s ($av/s)\n" . $c->stats->report . "\n" );
1808 return $c->response->status;
1811 =head2 $c->finalize_body
1817 sub finalize_body { my $c = shift; $c->engine->finalize_body( $c, @_ ) }
1819 =head2 $c->finalize_cookies
1825 sub finalize_cookies { my $c = shift; $c->engine->finalize_cookies( $c, @_ ) }
1827 =head2 $c->finalize_error
1833 sub finalize_error { my $c = shift; $c->engine->finalize_error( $c, @_ ) }
1835 =head2 $c->finalize_headers
1841 sub finalize_headers {
1844 my $response = $c->response; #accessor calls can add up?
1846 # Check if we already finalized headers
1847 return if $response->finalized_headers;
1850 if ( my $location = $response->redirect ) {
1851 $c->log->debug(qq/Redirecting to "$location"/) if $c->debug;
1852 $response->header( Location => $location );
1854 if ( !$response->has_body ) {
1855 # Add a default body if none is already present
1857 qq{<html><body><p>This item has moved <a href="$location">here</a>.</p></body></html>}
1863 if ( defined $response->body && length $response->body && !$response->content_length ) {
1865 # get the length from a filehandle
1866 if ( blessed( $response->body ) && $response->body->can('read') || ref( $response->body ) eq 'GLOB' )
1868 my $stat = stat $response->body;
1869 if ( $stat && $stat->size > 0 ) {
1870 $response->content_length( $stat->size );
1873 $c->log->warn('Serving filehandle without a content-length');
1877 # everything should be bytes at this point, but just in case
1878 $response->content_length( length( $response->body ) );
1883 if ( $response->status =~ /^(1\d\d|[23]04)$/ ) {
1884 $response->headers->remove_header("Content-Length");
1885 $response->body('');
1888 $c->finalize_cookies;
1890 $c->engine->finalize_headers( $c, @_ );
1893 $response->finalized_headers(1);
1896 =head2 $c->finalize_output
1898 An alias for finalize_body.
1900 =head2 $c->finalize_read
1902 Finalizes the input after reading is complete.
1906 sub finalize_read { my $c = shift; $c->engine->finalize_read( $c, @_ ) }
1908 =head2 $c->finalize_uploads
1910 Finalizes uploads. Cleans up any temporary files.
1914 sub finalize_uploads { my $c = shift; $c->engine->finalize_uploads( $c, @_ ) }
1916 =head2 $c->get_action( $action, $namespace )
1918 Gets an action in a given namespace.
1922 sub get_action { my $c = shift; $c->dispatcher->get_action(@_) }
1924 =head2 $c->get_actions( $action, $namespace )
1926 Gets all actions of a given name in a namespace and all parent
1931 sub get_actions { my $c = shift; $c->dispatcher->get_actions( $c, @_ ) }
1933 =head2 $app->handle_request( @arguments )
1935 Called to handle each HTTP request.
1939 sub handle_request {
1940 my ( $class, @arguments ) = @_;
1942 # Always expect worst case!
1945 if ($class->debug) {
1946 my $secs = time - $START || 1;
1947 my $av = sprintf '%.3f', $COUNT / $secs;
1948 my $time = localtime time;
1949 $class->log->info("*** Request $COUNT ($av/s) [$$] [$time] ***");
1952 my $c = $class->prepare(@arguments);
1954 $status = $c->finalize;
1957 if ( my $error = $@ ) {
1959 $class->log->error(qq/Caught exception in engine "$error"/);
1964 if(my $coderef = $class->log->can('_flush')){
1965 $class->log->$coderef();
1970 =head2 $c->prepare( @arguments )
1972 Creates a Catalyst context from an engine-specific request (Apache, CGI,
1978 my ( $class, @arguments ) = @_;
1981 # After the app/ctxt split, this should become an attribute based on something passed
1982 # into the application.
1983 $class->context_class( ref $class || $class ) unless $class->context_class;
1985 my $c = $class->context_class->new({});
1987 # For on-demand data
1988 $c->request->_context($c);
1989 $c->response->_context($c);
1991 #surely this is not the most efficient way to do things...
1992 $c->stats($class->stats_class->new)->enable($c->use_stats);
1993 if ( $c->debug || $c->config->{enable_catalyst_header} ) {
1994 $c->res->headers->header( 'X-Catalyst' => $Catalyst::VERSION );
1997 #XXX reuse coderef from can
1998 # Allow engine to direct the prepare flow (for POE)
1999 if ( $c->engine->can('prepare') ) {
2000 $c->engine->prepare( $c, @arguments );
2003 $c->prepare_request(@arguments);
2004 $c->prepare_connection;
2005 $c->prepare_query_parameters;
2006 $c->prepare_headers;
2007 $c->prepare_cookies;
2010 # Prepare the body for reading, either by prepare_body
2011 # or the user, if they are using $c->read
2014 # Parse the body unless the user wants it on-demand
2015 unless ( ref($c)->config->{parse_on_demand} ) {
2020 my $method = $c->req->method || '';
2021 my $path = $c->req->path;
2022 $path = '/' unless length $path;
2023 my $address = $c->req->address || '';
2032 =head2 $c->prepare_action
2034 Prepares action. See L<Catalyst::Dispatcher>.
2038 sub prepare_action { my $c = shift; $c->dispatcher->prepare_action( $c, @_ ) }
2040 =head2 $c->prepare_body
2042 Prepares message body.
2049 return if $c->request->_has_body;
2051 # Initialize on-demand data
2052 $c->engine->prepare_body( $c, @_ );
2053 $c->prepare_parameters;
2054 $c->prepare_uploads;
2057 =head2 $c->prepare_body_chunk( $chunk )
2059 Prepares a chunk of data before sending it to L<HTTP::Body>.
2061 See L<Catalyst::Engine>.
2065 sub prepare_body_chunk {
2067 $c->engine->prepare_body_chunk( $c, @_ );
2070 =head2 $c->prepare_body_parameters
2072 Prepares body parameters.
2076 sub prepare_body_parameters {
2078 $c->engine->prepare_body_parameters( $c, @_ );
2081 =head2 $c->prepare_connection
2083 Prepares connection.
2087 sub prepare_connection {
2089 $c->engine->prepare_connection( $c, @_ );
2092 =head2 $c->prepare_cookies
2098 sub prepare_cookies { my $c = shift; $c->engine->prepare_cookies( $c, @_ ) }
2100 =head2 $c->prepare_headers
2106 sub prepare_headers { my $c = shift; $c->engine->prepare_headers( $c, @_ ) }
2108 =head2 $c->prepare_parameters
2110 Prepares parameters.
2114 sub prepare_parameters {
2116 $c->prepare_body_parameters;
2117 $c->engine->prepare_parameters( $c, @_ );
2120 =head2 $c->prepare_path
2122 Prepares path and base.
2126 sub prepare_path { my $c = shift; $c->engine->prepare_path( $c, @_ ) }
2128 =head2 $c->prepare_query_parameters
2130 Prepares query parameters.
2134 sub prepare_query_parameters {
2137 $c->engine->prepare_query_parameters( $c, @_ );
2140 =head2 $c->log_request
2142 Writes information about the request to the debug logs. This includes:
2146 =item * Request method, path, and remote IP address
2148 =item * Query keywords (see L<Catalyst::Request/query_keywords>)
2150 =item * Request parameters
2152 =item * File uploads
2161 return unless $c->debug;
2163 my($dump) = grep {$_->[0] eq 'Request' } $c->dump_these;
2164 my $request = $dump->[1];
2166 my ( $method, $path, $address ) = ( $request->method, $request->path, $request->address );
2168 $path = '/' unless length $path;
2170 $c->log->debug(qq/"$method" request for "$path" from "$address"/);
2172 $c->log_request_headers($request->headers);
2174 if ( my $keywords = $request->query_keywords ) {
2175 $c->log->debug("Query keywords are: $keywords");
2178 $c->log_request_parameters( query => $request->query_parameters, $request->_has_body ? (body => $request->body_parameters) : () );
2180 $c->log_request_uploads($request);
2183 =head2 $c->log_response
2185 Writes information about the response to the debug logs by calling
2186 C<< $c->log_response_status_line >> and C<< $c->log_response_headers >>.
2193 return unless $c->debug;
2195 my($dump) = grep {$_->[0] eq 'Response' } $c->dump_these;
2196 my $response = $dump->[1];
2198 $c->log_response_status_line($response);
2199 $c->log_response_headers($response->headers);
2202 =head2 $c->log_response_status_line($response)
2204 Writes one line of information about the response to the debug logs. This includes:
2208 =item * Response status code
2210 =item * Content-Type header (if present)
2212 =item * Content-Length header (if present)
2218 sub log_response_status_line {
2219 my ($c, $response) = @_;
2223 'Response Code: %s; Content-Type: %s; Content-Length: %s',
2224 $response->status || 'unknown',
2225 $response->headers->header('Content-Type') || 'unknown',
2226 $response->headers->header('Content-Length') || 'unknown'
2231 =head2 $c->log_response_headers($headers);
2233 Hook method which can be wrapped by plugins to log the responseheaders.
2234 No-op in the default implementation.
2238 sub log_response_headers {}
2240 =head2 $c->log_request_parameters( query => {}, body => {} )
2242 Logs request parameters to debug logs
2246 sub log_request_parameters {
2248 my %all_params = @_;
2250 return unless $c->debug;
2252 my $column_width = Catalyst::Utils::term_width() - 44;
2253 foreach my $type (qw(query body)) {
2254 my $params = $all_params{$type};
2255 next if ! keys %$params;
2256 my $t = Text::SimpleTable->new( [ 35, 'Parameter' ], [ $column_width, 'Value' ] );
2257 for my $key ( sort keys %$params ) {
2258 my $param = $params->{$key};
2259 my $value = defined($param) ? $param : '';
2260 $t->row( $key, ref $value eq 'ARRAY' ? ( join ', ', @$value ) : $value );
2262 $c->log->debug( ucfirst($type) . " Parameters are:\n" . $t->draw );
2266 =head2 $c->log_request_uploads
2268 Logs file uploads included in the request to the debug logs.
2269 The parameter name, filename, file type, and file size are all included in
2274 sub log_request_uploads {
2276 my $request = shift;
2277 return unless $c->debug;
2278 my $uploads = $request->uploads;
2279 if ( keys %$uploads ) {
2280 my $t = Text::SimpleTable->new(
2281 [ 12, 'Parameter' ],
2286 for my $key ( sort keys %$uploads ) {
2287 my $upload = $uploads->{$key};
2288 for my $u ( ref $upload eq 'ARRAY' ? @{$upload} : ($upload) ) {
2289 $t->row( $key, $u->filename, $u->type, $u->size );
2292 $c->log->debug( "File Uploads are:\n" . $t->draw );
2296 =head2 $c->log_request_headers($headers);
2298 Hook method which can be wrapped by plugins to log the request headers.
2299 No-op in the default implementation.
2303 sub log_request_headers {}
2305 =head2 $c->log_headers($type => $headers)
2307 Logs L<HTTP::Headers> (either request or response) to the debug logs.
2314 my $headers = shift; # an HTTP::Headers instance
2316 return unless $c->debug;
2318 my $column_width = Catalyst::Utils::term_width() - 28;
2319 my $t = Text::SimpleTable->new( [ 15, 'Header Name' ], [ $column_width, 'Value' ] );
2322 my ( $name, $value ) = @_;
2323 $t->row( $name, $value );
2326 $c->log->debug( ucfirst($type) . " Headers:\n" . $t->draw );
2330 =head2 $c->prepare_read
2332 Prepares the input for reading.
2336 sub prepare_read { my $c = shift; $c->engine->prepare_read( $c, @_ ) }
2338 =head2 $c->prepare_request
2340 Prepares the engine request.
2344 sub prepare_request { my $c = shift; $c->engine->prepare_request( $c, @_ ) }
2346 =head2 $c->prepare_uploads
2352 sub prepare_uploads {
2355 $c->engine->prepare_uploads( $c, @_ );
2358 =head2 $c->prepare_write
2360 Prepares the output for writing.
2364 sub prepare_write { my $c = shift; $c->engine->prepare_write( $c, @_ ) }
2366 =head2 $c->request_class
2368 Returns or sets the request class. Defaults to L<Catalyst::Request>.
2370 =head2 $c->response_class
2372 Returns or sets the response class. Defaults to L<Catalyst::Response>.
2374 =head2 $c->read( [$maxlength] )
2376 Reads a chunk of data from the request body. This method is designed to
2377 be used in a while loop, reading C<$maxlength> bytes on every call.
2378 C<$maxlength> defaults to the size of the request if not specified.
2380 You have to set C<< MyApp->config(parse_on_demand => 1) >> to use this
2383 Warning: If you use read(), Catalyst will not process the body,
2384 so you will not be able to access POST parameters or file uploads via
2385 $c->request. You must handle all body parsing yourself.
2389 sub read { my $c = shift; return $c->engine->read( $c, @_ ) }
2397 sub run { my $c = shift; return $c->engine->run( $c, @_ ) }
2399 =head2 $c->set_action( $action, $code, $namespace, $attrs )
2401 Sets an action in a given namespace.
2405 sub set_action { my $c = shift; $c->dispatcher->set_action( $c, @_ ) }
2407 =head2 $c->setup_actions($component)
2409 Sets up actions for a component.
2413 sub setup_actions { my $c = shift; $c->dispatcher->setup_actions( $c, @_ ) }
2415 =head2 $c->setup_config
2422 my %args = %{$class->config || {} };
2423 my @container_classes = qw/MyApp::Container Catalyst::Container/;
2424 unshift @container_classes, delete $args{container_class} if exists $args{container_class};
2426 my $container_class = Class::MOP::load_first_existing_class(@container_classes);
2428 my $container = $container_class->new( %args, name => "$class" );
2430 $container->add_sub_container(Bread::Board::Container->new( name => $_ )) for qw(model controller view);
2431 $class->container($container);
2433 my $config = $container->fetch('config')->get;
2434 $class->config($config);
2435 $class->finalize_config; # back-compat
2438 =head $c->finalize_config
2442 sub finalize_config { }
2444 =head2 $c->setup_components
2446 This method is called internally to set up the application's components.
2448 It finds modules by calling the L<locate_components> method, expands them to
2449 package names with the L<expand_component_module> method, and then installs
2450 each component into the application.
2452 The C<setup_components> config option is passed to both of the above methods.
2454 Installation of each component is performed by the L<setup_component> method,
2459 sub setup_components {
2462 my $config = $class->config->{ setup_components };
2464 my @comps = $class->locate_components($config);
2465 my %comps = map { $_ => 1 } @comps;
2467 my $deprecatedcatalyst_component_names = grep { /::[CMV]::/ } @comps;
2468 $class->log->warn(qq{Your application is using the deprecated ::[MVC]:: type naming scheme.\n}.
2469 qq{Please switch your class names to ::Model::, ::View:: and ::Controller: as appropriate.\n}
2470 ) if $deprecatedcatalyst_component_names;
2472 for my $component ( @comps ) {
2474 # We pass ignore_loaded here so that overlay files for (e.g.)
2475 # Model::DBI::Schema sub-classes are loaded - if it's in @comps
2476 # we know M::P::O found a file on disk so this is safe
2478 Catalyst::Utils::ensure_class_loaded( $component, { ignore_loaded => 1 } );
2482 $containers->{$_} = $class->container->get_sub_container($_) for qw(model view controller);
2484 for my $component (@comps) {
2485 my $instance = $class->components->{ $component } = $class->setup_component($component);
2486 my $type = lc((split /::/, $component)[1]);
2487 if ($deprecatedcatalyst_component_names) {
2488 $type = 'controller' if $type eq 'c';
2489 $type = 'model' if $type eq 'm';
2490 $type = 'view' if $type eq 'v';
2492 $containers->{$type}->add_service(Bread::Board::BlockInjection->new( name => $component, block => sub { return $instance } ));
2493 my @expanded_components = $instance->can('expand_modules')
2494 ? $instance->expand_modules( $component, $config )
2495 : $class->expand_component_module( $component, $config );
2496 for my $component (@expanded_components) {
2497 next if $comps{$component};
2499 $deprecatedcatalyst_component_names = grep { /::[CMV]::/ } @expanded_components;
2500 $class->log->warn(qq{Your application is using the deprecated ::[MVC]:: type naming scheme.\n}.
2501 qq{Please switch your class names to ::Model::, ::View:: and ::Controller: as appropriate.\n}
2502 ) if $deprecatedcatalyst_component_names;
2504 if ($deprecatedcatalyst_component_names) {
2505 $type = lc((split /::/, $component)[1]);
2506 $type = 'controller' if $type eq 'c';
2507 $type = 'model' if $type eq 'm';
2508 $type = 'view' if $type eq 'v';
2510 $containers->{$type}->add_service(Bread::Board::BlockInjection->new( name => $component, block => sub { return $class->setup_component($component) } ));
2511 $class->components->{ $component } = $class->setup_component($component);
2516 =head2 $c->locate_components( $setup_component_config )
2518 This method is meant to provide a list of component modules that should be
2519 setup for the application. By default, it will use L<Module::Pluggable>.
2521 Specify a C<setup_components> config option to pass additional options directly
2522 to L<Module::Pluggable>. To add additional search paths, specify a key named
2523 C<search_extra> as an array reference. Items in the array beginning with C<::>
2524 will have the application class name prepended to them.
2528 sub locate_components {
2532 my @paths = qw( ::Controller ::C ::Model ::M ::View ::V );
2533 my $extra = delete $config->{ search_extra } || [];
2535 push @paths, @$extra;
2537 my $locator = Module::Pluggable::Object->new(
2538 search_path => [ map { s/^(?=::)/$class/; $_; } @paths ],
2542 # XXX think about ditching this sort entirely
2543 my @comps = sort { length $a <=> length $b } $locator->plugins;
2548 =head2 $c->expand_component_module( $component, $setup_component_config )
2550 Components found by C<locate_components> will be passed to this method, which
2551 is expected to return a list of component (package) names to be set up.
2555 sub expand_component_module {
2556 my ($class, $module) = @_;
2557 return Devel::InnerPackage::list_packages( $module );
2560 =head2 $c->setup_component
2564 sub setup_component {
2565 my( $class, $component ) = @_;
2567 unless ( $component->can( 'COMPONENT' ) ) {
2571 my $suffix = Catalyst::Utils::class2classsuffix( $component );
2572 my $config = $class->config->{ $suffix } || {};
2573 # Stash catalyst_component_name in the config here, so that custom COMPONENT
2574 # methods also pass it. local to avoid pointlessly shitting in config
2575 # for the debug screen, as $component is already the key name.
2576 local $config->{catalyst_component_name} = $component;
2578 my $instance = eval { $component->COMPONENT( $class, $config ); };
2580 if ( my $error = $@ ) {
2582 Catalyst::Exception->throw(
2583 message => qq/Couldn't instantiate component "$component", "$error"/
2587 unless (blessed $instance) {
2588 my $metaclass = Moose::Util::find_meta($component);
2589 my $method_meta = $metaclass->find_method_by_name('COMPONENT');
2590 my $component_method_from = $method_meta->associated_metaclass->name;
2591 my $value = defined($instance) ? $instance : 'undef';
2592 Catalyst::Exception->throw(
2594 qq/Couldn't instantiate component "$component", COMPONENT() method (from $component_method_from) didn't return an object-like value (value was $value)./
2600 =head2 $c->setup_dispatcher
2606 sub setup_dispatcher {
2607 my ( $class, $dispatcher ) = @_;
2610 $dispatcher = 'Catalyst::Dispatcher::' . $dispatcher;
2613 if ( my $env = Catalyst::Utils::env_value( $class, 'DISPATCHER' ) ) {
2614 $dispatcher = 'Catalyst::Dispatcher::' . $env;
2617 unless ($dispatcher) {
2618 $dispatcher = $class->dispatcher_class;
2621 Class::MOP::load_class($dispatcher);
2623 # dispatcher instance
2624 $class->dispatcher( $dispatcher->new );
2627 =head2 $c->setup_engine
2634 my ( $class, $engine ) = @_;
2637 $engine = 'Catalyst::Engine::' . $engine;
2640 if ( my $env = Catalyst::Utils::env_value( $class, 'ENGINE' ) ) {
2641 $engine = 'Catalyst::Engine::' . $env;
2644 if ( $ENV{MOD_PERL} ) {
2645 my $meta = Class::MOP::get_metaclass_by_name($class);
2647 # create the apache method
2648 $meta->add_method('apache' => sub { shift->engine->apache });
2650 my ( $software, $version ) =
2651 $ENV{MOD_PERL} =~ /^(\S+)\/(\d+(?:[\.\_]\d+)+)/;
2654 $version =~ s/(\.[^.]+)\./$1/g;
2656 if ( $software eq 'mod_perl' ) {
2660 if ( $version >= 1.99922 ) {
2661 $engine = 'Catalyst::Engine::Apache2::MP20';
2664 elsif ( $version >= 1.9901 ) {
2665 $engine = 'Catalyst::Engine::Apache2::MP19';
2668 elsif ( $version >= 1.24 ) {
2669 $engine = 'Catalyst::Engine::Apache::MP13';
2673 Catalyst::Exception->throw( message =>
2674 qq/Unsupported mod_perl version: $ENV{MOD_PERL}/ );
2679 # install the correct mod_perl handler
2680 if ( $version >= 1.9901 ) {
2681 *handler = sub : method {
2682 shift->handle_request(@_);
2686 *handler = sub ($$) { shift->handle_request(@_) };
2691 elsif ( $software eq 'Zeus-Perl' ) {
2692 $engine = 'Catalyst::Engine::Zeus';
2696 Catalyst::Exception->throw(
2697 message => qq/Unsupported mod_perl: $ENV{MOD_PERL}/ );
2702 $engine = $class->engine_class;
2705 Class::MOP::load_class($engine);
2707 # check for old engines that are no longer compatible
2709 if ( $engine->isa('Catalyst::Engine::Apache')
2710 && !Catalyst::Engine::Apache->VERSION )
2715 elsif ( $engine->isa('Catalyst::Engine::Server::Base')
2716 && Catalyst::Engine::Server->VERSION le '0.02' )
2721 elsif ($engine->isa('Catalyst::Engine::HTTP::POE')
2722 && $engine->VERSION eq '0.01' )
2727 elsif ($engine->isa('Catalyst::Engine::Zeus')
2728 && $engine->VERSION eq '0.01' )
2734 Catalyst::Exception->throw( message =>
2735 qq/Engine "$engine" is not supported by this version of Catalyst/
2740 $class->engine( $engine->new );
2743 =head2 $c->setup_home
2745 Sets up the home directory.
2750 my ( $class, $home ) = @_;
2752 if ( my $env = Catalyst::Utils::env_value( $class, 'HOME' ) ) {
2756 $home ||= Catalyst::Utils::home($class);
2759 #I remember recently being scolded for assigning config values like this
2760 $class->config->{home} ||= $home;
2761 $class->config->{root} ||= Path::Class::Dir->new($home)->subdir('root');
2765 =head2 $c->setup_log
2767 Sets up log by instantiating a L<Catalyst::Log|Catalyst::Log> object and
2768 passing it to C<log()>. Pass in a comma-delimited list of levels to set the
2771 This method also installs a C<debug> method that returns a true value into the
2772 catalyst subclass if the "debug" level is passed in the comma-delimited list,
2773 or if the C<$CATALYST_DEBUG> environment variable is set to a true value.
2775 Note that if the log has already been setup, by either a previous call to
2776 C<setup_log> or by a call such as C<< __PACKAGE__->log( MyLogger->new ) >>,
2777 that this method won't actually set up the log object.
2782 my ( $class, $levels ) = @_;
2785 $levels =~ s/^\s+//;
2786 $levels =~ s/\s+$//;
2787 my %levels = map { $_ => 1 } split /\s*,\s*/, $levels;
2789 my $env_debug = Catalyst::Utils::env_value( $class, 'DEBUG' );
2790 if ( defined $env_debug ) {
2791 $levels{debug} = 1 if $env_debug; # Ugly!
2792 delete($levels{debug}) unless $env_debug;
2795 unless ( $class->log ) {
2796 $class->log( Catalyst::Log->new(keys %levels) );
2799 if ( $levels{debug} ) {
2800 Class::MOP::get_metaclass_by_name($class)->add_method('debug' => sub { 1 });
2801 $class->log->debug('Debug messages enabled');
2805 =head2 $c->setup_plugins
2811 =head2 $c->setup_stats
2813 Sets up timing statistics class.
2818 my ( $class, $stats ) = @_;
2820 Catalyst::Utils::ensure_class_loaded($class->stats_class);
2822 my $env = Catalyst::Utils::env_value( $class, 'STATS' );
2823 if ( defined($env) ? $env : ($stats || $class->debug ) ) {
2824 Class::MOP::get_metaclass_by_name($class)->add_method('use_stats' => sub { 1 });
2825 $class->log->debug('Statistics enabled');
2830 =head2 $c->registered_plugins
2832 Returns a sorted list of the plugins which have either been stated in the
2833 import list or which have been added via C<< MyApp->plugin(@args); >>.
2835 If passed a given plugin name, it will report a boolean value indicating
2836 whether or not that plugin is loaded. A fully qualified name is required if
2837 the plugin name does not begin with C<Catalyst::Plugin::>.
2839 if ($c->registered_plugins('Some::Plugin')) {
2847 sub registered_plugins {
2849 return sort keys %{ $proto->_plugins } unless @_;
2851 return 1 if exists $proto->_plugins->{$plugin};
2852 return exists $proto->_plugins->{"Catalyst::Plugin::$plugin"};
2855 sub _register_plugin {
2856 my ( $proto, $plugin, $instant ) = @_;
2857 my $class = ref $proto || $proto;
2859 Class::MOP::load_class( $plugin );
2860 $class->log->warn( "$plugin inherits from 'Catalyst::Component' - this is decated and will not work in 5.81" )
2861 if $plugin->isa( 'Catalyst::Component' );
2862 $proto->_plugins->{$plugin} = 1;
2864 my $meta = Class::MOP::get_metaclass_by_name($class);
2865 $meta->superclasses($plugin, $meta->superclasses);
2871 my ( $class, $plugins ) = @_;
2873 $class->_plugins( {} ) unless $class->_plugins;
2874 $plugins = Data::OptList::mkopt($plugins || []);
2877 [ Catalyst::Utils::resolve_namespace(
2878 $class . '::Plugin',
2879 'Catalyst::Plugin', $_->[0]
2885 for my $plugin ( reverse @plugins ) {
2886 Class::MOP::load_class($plugin->[0], $plugin->[1]);
2887 my $meta = find_meta($plugin->[0]);
2888 next if $meta && $meta->isa('Moose::Meta::Role');
2890 $class->_register_plugin($plugin->[0]);
2894 map { $_->[0]->name, $_->[1] }
2895 grep { blessed($_->[0]) && $_->[0]->isa('Moose::Meta::Role') }
2896 map { [find_meta($_->[0]), $_->[1]] }
2899 Moose::Util::apply_all_roles(
2907 Returns an arrayref of the internal execution stack (actions that are
2908 currently executing).
2912 Returns the current timing statistics object. By default Catalyst uses
2913 L<Catalyst::Stats|Catalyst::Stats>, but can be set otherwise with
2914 L<< stats_class|/"$c->stats_class" >>.
2916 Even if L<< -Stats|/"-Stats" >> is not enabled, the stats object is still
2917 available. By enabling it with C< $c->stats->enabled(1) >, it can be used to
2918 profile explicitly, although MyApp.pm still won't profile nor output anything
2921 =head2 $c->stats_class
2923 Returns or sets the stats (timing statistics) class. L<Catalyst::Stats|Catalyst::Stats> is used by default.
2925 =head2 $c->use_stats
2927 Returns 1 when L<< stats collection|/"-Stats" >> is enabled.
2929 Note that this is a static method, not an accessor and should be overridden
2930 by declaring C<sub use_stats { 1 }> in your MyApp.pm, not by calling C<< $c->use_stats(1) >>.
2937 =head2 $c->write( $data )
2939 Writes $data to the output stream. When using this method directly, you
2940 will need to manually set the C<Content-Length> header to the length of
2941 your output data, if known.
2948 # Finalize headers if someone manually writes output
2949 $c->finalize_headers;
2951 return $c->engine->write( $c, @_ );
2956 Returns the Catalyst version number. Mostly useful for "powered by"
2957 messages in template systems.
2961 sub version { return $Catalyst::VERSION }
2963 =head1 CONFIGURATION
2965 There are a number of 'base' config variables which can be set:
2971 C<default_model> - The default model picked if you say C<< $c->model >>. See L<< /$c->model($name) >>.
2975 C<default_view> - The default view to be rendered or returned when C<< $c->view >> is called. See L<< /$c->view($name) >>.
2979 C<disable_component_resolution_regex_fallback> - Turns
2980 off the deprecated component resolution functionality so
2981 that if any of the component methods (e.g. C<< $c->controller('Foo') >>)
2982 are called then regex search will not be attempted on string values and
2983 instead C<undef> will be returned.
2987 C<home> - The application home directory. In an uninstalled application,
2988 this is the top level application directory. In an installed application,
2989 this will be the directory containing C<< MyApp.pm >>.
2993 C<ignore_frontend_proxy> - See L</PROXY SUPPORT>
2997 C<name> - The name of the application in debug messages and the debug and
3002 C<parse_on_demand> - The request body (for example file uploads) will not be parsed
3003 until it is accessed. This allows you to (for example) check authentication (and reject
3004 the upload) before actually recieving all the data. See L</ON-DEMAND PARSER>
3008 C<root> - The root directory for templates. Usually this is just a
3009 subdirectory of the home directory, but you can set it to change the
3010 templates to a different directory.
3014 C<search_extra> - Array reference passed to Module::Pluggable to for additional
3015 namespaces from which components will be loaded (and constructed and stored in
3016 C<< $c->components >>).
3020 C<show_internal_actions> - If true, causes internal actions such as C<< _DISPATCH >>
3021 to be shown in hit debug tables in the test server.
3025 C<use_request_uri_for_path> - Controlls if the C<REQUEST_URI> or C<PATH_INFO> environment
3026 variable should be used for determining the request path. See L<Catalyst::Engine::CGI/PATH DECODING>
3027 for more information.
3031 C<using_frontend_proxy> - See L</PROXY SUPPORT>.
3035 =head1 INTERNAL ACTIONS
3037 Catalyst uses internal actions like C<_DISPATCH>, C<_BEGIN>, C<_AUTO>,
3038 C<_ACTION>, and C<_END>. These are by default not shown in the private
3039 action table, but you can make them visible with a config parameter.
3041 MyApp->config(show_internal_actions => 1);
3043 =head1 ON-DEMAND PARSER
3045 The request body is usually parsed at the beginning of a request,
3046 but if you want to handle input yourself, you can enable on-demand
3047 parsing with a config parameter.
3049 MyApp->config(parse_on_demand => 1);
3051 =head1 PROXY SUPPORT
3053 Many production servers operate using the common double-server approach,
3054 with a lightweight frontend web server passing requests to a larger
3055 backend server. An application running on the backend server must deal
3056 with two problems: the remote user always appears to be C<127.0.0.1> and
3057 the server's hostname will appear to be C<localhost> regardless of the
3058 virtual host that the user connected through.
3060 Catalyst will automatically detect this situation when you are running
3061 the frontend and backend servers on the same machine. The following
3062 changes are made to the request.
3064 $c->req->address is set to the user's real IP address, as read from
3065 the HTTP X-Forwarded-For header.
3067 The host value for $c->req->base and $c->req->uri is set to the real
3068 host, as read from the HTTP X-Forwarded-Host header.
3070 Additionally, you may be running your backend application on an insecure
3071 connection (port 80) while your frontend proxy is running under SSL. If there
3072 is a discrepancy in the ports, use the HTTP header C<X-Forwarded-Port> to
3073 tell Catalyst what port the frontend listens on. This will allow all URIs to
3074 be created properly.
3076 In the case of passing in:
3078 X-Forwarded-Port: 443
3080 All calls to C<uri_for> will result in an https link, as is expected.
3082 Obviously, your web server must support these headers for this to work.
3084 In a more complex server farm environment where you may have your
3085 frontend proxy server(s) on different machines, you will need to set a
3086 configuration option to tell Catalyst to read the proxied data from the
3089 MyApp->config(using_frontend_proxy => 1);
3091 If you do not wish to use the proxy support at all, you may set:
3093 MyApp->config(ignore_frontend_proxy => 1);
3095 =head1 THREAD SAFETY
3097 Catalyst has been tested under Apache 2's threading C<mpm_worker>,
3098 C<mpm_winnt>, and the standalone forking HTTP server on Windows. We
3099 believe the Catalyst core to be thread-safe.
3101 If you plan to operate in a threaded environment, remember that all other
3102 modules you are using must also be thread-safe. Some modules, most notably
3103 L<DBD::SQLite>, are not thread-safe.
3109 Join #catalyst on irc.perl.org.
3113 http://lists.scsys.co.uk/cgi-bin/mailman/listinfo/catalyst
3114 http://lists.scsys.co.uk/cgi-bin/mailman/listinfo/catalyst-dev
3118 http://catalyst.perl.org
3122 http://dev.catalyst.perl.org
3126 =head2 L<Task::Catalyst> - All you need to start with Catalyst
3128 =head2 L<Catalyst::Manual> - The Catalyst Manual
3130 =head2 L<Catalyst::Component>, L<Catalyst::Controller> - Base classes for components
3132 =head2 L<Catalyst::Engine> - Core engine
3134 =head2 L<Catalyst::Log> - Log class.
3136 =head2 L<Catalyst::Request> - Request object
3138 =head2 L<Catalyst::Response> - Response object
3140 =head2 L<Catalyst::Test> - The test suite.
3142 =head1 PROJECT FOUNDER
3144 sri: Sebastian Riedel <sri@cpan.org>
3150 acme: Leon Brocard <leon@astray.com>
3152 abraxxa: Alexander Hartmaier <abraxxa@cpan.org>
3156 Andrew Ford E<lt>A.Ford@ford-mason.co.ukE<gt>
3160 andyg: Andy Grundman <andy@hybridized.org>
3162 audreyt: Audrey Tang
3164 bricas: Brian Cassidy <bricas@cpan.org>
3166 Caelum: Rafael Kitover <rkitover@io.com>
3168 chansen: Christian Hansen
3170 chicks: Christopher Hicks
3172 Chisel Wright C<pause@herlpacker.co.uk>
3174 Danijel Milicevic C<me@danijel.de>
3176 David Kamholz E<lt>dkamholz@cpan.orgE<gt>
3178 David Naughton, C<naughton@umn.edu>
3182 dhoss: Devin Austin <dhoss@cpan.org>
3184 dkubb: Dan Kubb <dan.kubb-cpan@onautopilot.com>
3188 dwc: Daniel Westermann-Clark <danieltwc@cpan.org>
3190 esskar: Sascha Kiefer
3192 fireartist: Carl Franks <cfranks@cpan.org>
3194 frew: Arthur Axel "fREW" Schmidt <frioux@gmail.com>
3196 gabb: Danijel Milicevic
3200 Gavin Henry C<ghenry@perl.me.uk>
3204 groditi: Guillermo Roditi <groditi@gmail.com>
3206 hobbs: Andrew Rodland <andrew@cleverdomain.org>
3208 ilmari: Dagfinn Ilmari Mannsåker <ilmari@ilmari.org>
3210 jcamacho: Juan Camacho
3212 jester: Jesse Sheidlower C<jester@panix.com>
3214 jhannah: Jay Hannah <jay@jays.net>
3220 jon: Jon Schutz <jjschutz@cpan.org>
3222 Jonathan Rockway C<< <jrockway@cpan.org> >>
3224 Kieren Diment C<kd@totaldatasolution.com>
3226 konobi: Scott McWhirter <konobi@cpan.org>
3228 marcus: Marcus Ramberg <mramberg@cpan.org>
3230 miyagawa: Tatsuhiko Miyagawa <miyagawa@bulknews.net>
3232 mst: Matt S. Trout <mst@shadowcatsystems.co.uk>
3236 naughton: David Naughton
3238 ningu: David Kamholz <dkamholz@cpan.org>
3240 nothingmuch: Yuval Kogman <nothingmuch@woobling.org>
3242 numa: Dan Sully <daniel@cpan.org>
3248 omega: Andreas Marienborg
3250 Oleg Kostyuk <cub.uanic@gmail.com>
3252 phaylon: Robert Sedlacek <phaylon@dunkelheit.at>
3254 rafl: Florian Ragwitz <rafl@debian.org>
3256 random: Roland Lammel <lammel@cpan.org>
3258 Robert Sedlacek C<< <rs@474.at> >>
3260 SpiceMan: Marcel Montes
3264 szbalint: Balint Szilakszi <szbalint@cpan.org>
3266 t0m: Tomas Doran <bobtfish@bobtfish.net>
3270 Viljo Marrandi C<vilts@yahoo.com>
3272 Will Hawes C<info@whawes.co.uk>
3274 willert: Sebastian Willert <willert@cpan.org>
3276 wreis: Wallace Reis <wallace@reis.org.br>
3278 Yuval Kogman, C<nothingmuch@woobling.org>
3280 rainboxx: Matthias Dietrich, C<perl@rainboxx.de>
3282 dd070: Dhaval Dhanani <dhaval070@gmail.com>
3286 Copyright (c) 2005, the above named PROJECT FOUNDER and CONTRIBUTORS.
3290 This library is free software. You can redistribute it and/or modify it under
3291 the same terms as Perl itself.
3297 __PACKAGE__->meta->make_immutable;