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/;
32 use String::RewritePrefix;
33 use Catalyst::EngineLoader;
35 use Carp qw/croak carp shortmess/;
37 use Plack::Middleware::Conditional;
38 use Plack::Middleware::ReverseProxy;
40 BEGIN { require 5.008004; }
42 has stack => (is => 'ro', default => sub { [] });
43 has stash => (is => 'rw', default => sub { {} });
44 has state => (is => 'rw', default => 0);
45 has stats => (is => 'rw');
46 has action => (is => 'rw');
47 has counter => (is => 'rw', default => sub { {} });
48 has request => (is => 'rw', default => sub { $_[0]->request_class->new({}) }, required => 1, lazy => 1);
49 has response => (is => 'rw', default => sub { $_[0]->response_class->new({}) }, required => 1, lazy => 1);
50 has namespace => (is => 'rw');
52 sub depth { scalar @{ shift->stack || [] }; }
53 sub comp { shift->component(@_) }
56 my $self = shift; return $self->request(@_);
59 my $self = shift; return $self->response(@_);
62 # For backwards compatibility
63 sub finalize_output { shift->finalize_body(@_) };
68 our $RECURSION = 1000;
69 our $DETACH = Catalyst::Exception::Detach->new;
70 our $GO = Catalyst::Exception::Go->new;
72 #I imagine that very few of these really need to be class variables. if any.
73 #maybe we should just make them attributes with a default?
74 __PACKAGE__->mk_classdata($_)
75 for qw/components arguments dispatcher engine log dispatcher_class
76 engine_loader context_class request_class response_class stats_class
77 setup_finished _psgi_app/;
79 __PACKAGE__->dispatcher_class('Catalyst::Dispatcher');
80 __PACKAGE__->request_class('Catalyst::Request');
81 __PACKAGE__->response_class('Catalyst::Response');
82 __PACKAGE__->stats_class('Catalyst::Stats');
84 # Remember to update this in Catalyst::Runtime as well!
86 our $VERSION = '5.89002';
89 my ( $class, @arguments ) = @_;
91 # We have to limit $class to Catalyst to avoid pushing Catalyst upon every
93 return unless $class eq 'Catalyst';
95 my $caller = caller();
96 return if $caller eq 'main';
98 my $meta = Moose::Meta::Class->initialize($caller);
99 unless ( $caller->isa('Catalyst') ) {
100 my @superclasses = ($meta->superclasses, $class, 'Catalyst::Controller');
101 $meta->superclasses(@superclasses);
103 # Avoid possible C3 issues if 'Moose::Object' is already on RHS of MyApp
104 $meta->superclasses(grep { $_ ne 'Moose::Object' } $meta->superclasses);
106 unless( $meta->has_method('meta') ){
107 if ($Moose::VERSION >= 1.15) {
108 $meta->_add_meta_method('meta');
111 $meta->add_method(meta => sub { Moose::Meta::Class->initialize("${caller}") } );
115 $caller->arguments( [@arguments] );
119 sub _application { $_[0] }
123 Catalyst - The Elegant MVC Web Application Framework
127 See the L<Catalyst::Manual> distribution for comprehensive
128 documentation and tutorials.
130 # Install Catalyst::Devel for helpers and other development tools
131 # use the helper to create a new application
134 # add models, views, controllers
135 script/myapp_create.pl model MyDatabase DBIC::Schema create=static dbi:SQLite:/path/to/db
136 script/myapp_create.pl view MyTemplate TT
137 script/myapp_create.pl controller Search
139 # built in testserver -- use -r to restart automatically on changes
140 # --help to see all available options
141 script/myapp_server.pl
143 # command line testing interface
144 script/myapp_test.pl /yada
147 use Catalyst qw/-Debug/; # include plugins here as well
149 ### In lib/MyApp/Controller/Root.pm (autocreated)
150 sub foo : Global { # called for /foo, /foo/1, /foo/1/2, etc.
151 my ( $self, $c, @args ) = @_; # args are qw/1 2/ for /foo/1/2
152 $c->stash->{template} = 'foo.tt'; # set the template
153 # lookup something from db -- stash vars are passed to TT
155 $c->model('Database::Foo')->search( { country => $args[0] } );
156 if ( $c->req->params->{bar} ) { # access GET or POST parameters
157 $c->forward( 'bar' ); # process another action
158 # do something else after forward returns
162 # The foo.tt TT template can use the stash data from the database
163 [% WHILE (item = data.next) %]
167 # called for /bar/of/soap, /bar/of/soap/10, etc.
168 sub bar : Path('/bar/of/soap') { ... }
170 # called for all actions, from the top-most controller downwards
172 my ( $self, $c ) = @_;
173 if ( !$c->user_exists ) { # Catalyst::Plugin::Authentication
174 $c->res->redirect( '/login' ); # require login
175 return 0; # abort request and go immediately to end()
177 return 1; # success; carry on to next action
180 # called after all actions are finished
182 my ( $self, $c ) = @_;
183 if ( scalar @{ $c->error } ) { ... } # handle errors
184 return if $c->res->body; # already have a response
185 $c->forward( 'MyApp::View::TT' ); # render template
188 ### in MyApp/Controller/Foo.pm
189 # called for /foo/bar
190 sub bar : Local { ... }
192 # called for /blargle
193 sub blargle : Global { ... }
195 # an index action matches /foo, but not /foo/1, etc.
196 sub index : Private { ... }
198 ### in MyApp/Controller/Foo/Bar.pm
199 # called for /foo/bar/baz
200 sub baz : Local { ... }
202 # first Root auto is called, then Foo auto, then this
203 sub auto : Private { ... }
205 # powerful regular expression paths are also possible
206 sub details : Regex('^product/(\w+)/details$') {
207 my ( $self, $c ) = @_;
208 # extract the (\w+) from the URI
209 my $product = $c->req->captures->[0];
212 See L<Catalyst::Manual::Intro> for additional information.
216 Catalyst is a modern framework for making web applications without the
217 pain usually associated with this process. This document is a reference
218 to the main Catalyst application. If you are a new user, we suggest you
219 start with L<Catalyst::Manual::Tutorial> or L<Catalyst::Manual::Intro>.
221 See L<Catalyst::Manual> for more documentation.
223 Catalyst plugins can be loaded by naming them as arguments to the "use
224 Catalyst" statement. Omit the C<Catalyst::Plugin::> prefix from the
225 plugin name, i.e., C<Catalyst::Plugin::My::Module> becomes
228 use Catalyst qw/My::Module/;
230 If your plugin starts with a name other than C<Catalyst::Plugin::>, you can
231 fully qualify the name by using a unary plus:
235 +Fully::Qualified::Plugin::Name
238 Special flags like C<-Debug> and C<-Engine> can also be specified as
239 arguments when Catalyst is loaded:
241 use Catalyst qw/-Debug My::Module/;
243 The position of plugins and flags in the chain is important, because
244 they are loaded in the order in which they appear.
246 The following flags are supported:
250 Enables debug output. You can also force this setting from the system
251 environment with CATALYST_DEBUG or <MYAPP>_DEBUG. The environment
252 settings override the application, with <MYAPP>_DEBUG having the highest
255 This sets the log level to 'debug' and enables full debug output on the
256 error screen. If you only want the latter, see L<< $c->debug >>.
260 Forces Catalyst to use a specific engine. Omit the
261 C<Catalyst::Engine::> prefix of the engine name, i.e.:
263 use Catalyst qw/-Engine=CGI/;
267 Forces Catalyst to use a specific home directory, e.g.:
269 use Catalyst qw[-Home=/usr/mst];
271 This can also be done in the shell environment by setting either the
272 C<CATALYST_HOME> environment variable or C<MYAPP_HOME>; where C<MYAPP>
273 is replaced with the uppercased name of your application, any "::" in
274 the name will be replaced with underscores, e.g. MyApp::Web should use
275 MYAPP_WEB_HOME. If both variables are set, the MYAPP_HOME one will be used.
277 If none of these are set, Catalyst will attempt to automatically detect the
278 home directory. If you are working in a development envirnoment, Catalyst
279 will try and find the directory containing either Makefile.PL, Build.PL or
280 dist.ini. If the application has been installed into the system (i.e.
281 you have done C<make install>), then Catalyst will use the path to your
282 application module, without the .pm extension (ie, /foo/MyApp if your
283 application was installed at /foo/MyApp.pm)
287 use Catalyst '-Log=warn,fatal,error';
289 Specifies a comma-delimited list of log levels.
293 Enables statistics collection and reporting.
295 use Catalyst qw/-Stats=1/;
297 You can also force this setting from the system environment with CATALYST_STATS
298 or <MYAPP>_STATS. The environment settings override the application, with
299 <MYAPP>_STATS having the highest priority.
301 Stats are also enabled if L<< debugging |/"-Debug" >> is enabled.
305 =head2 INFORMATION ABOUT THE CURRENT REQUEST
309 Returns a L<Catalyst::Action> object for the current action, which
310 stringifies to the action name. See L<Catalyst::Action>.
314 Returns the namespace of the current action, i.e., the URI prefix
315 corresponding to the controller of the current action. For example:
317 # in Controller::Foo::Bar
318 $c->namespace; # returns 'foo/bar';
324 Returns the current L<Catalyst::Request> object, giving access to
325 information about the current client request (including parameters,
326 cookies, HTTP headers, etc.). See L<Catalyst::Request>.
328 =head2 REQUEST FLOW HANDLING
330 =head2 $c->forward( $action [, \@arguments ] )
332 =head2 $c->forward( $class, $method, [, \@arguments ] )
334 Forwards processing to another action, by its private name. If you give a
335 class name but no method, C<process()> is called. You may also optionally
336 pass arguments in an arrayref. The action will receive the arguments in
337 C<@_> and C<< $c->req->args >>. Upon returning from the function,
338 C<< $c->req->args >> will be restored to the previous values.
340 Any data C<return>ed from the action forwarded to, will be returned by the
343 my $foodata = $c->forward('/foo');
344 $c->forward('index');
345 $c->forward(qw/Model::DBIC::Foo do_stuff/);
346 $c->forward('View::TT');
348 Note that L<< forward|/"$c->forward( $action [, \@arguments ] )" >> implies
349 an C<< eval { } >> around the call (actually
350 L<< execute|/"$c->execute( $class, $coderef )" >> does), thus de-fatalizing
351 all 'dies' within the called action. If you want C<die> to propagate you
352 need to do something like:
355 die join "\n", @{ $c->error } if @{ $c->error };
357 Or make sure to always return true values from your actions and write
360 $c->forward('foo') || return;
362 Another note is that C<< $c->forward >> always returns a scalar because it
363 actually returns $c->state which operates in a scalar context.
364 Thus, something like:
368 in an action that is forwarded to is going to return a scalar,
369 i.e. how many items are in that array, which is probably not what you want.
370 If you need to return an array then return a reference to it,
373 $c->stash->{array} = \@array;
375 and access it from the stash.
377 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.
381 sub forward { my $c = shift; no warnings 'recursion'; $c->dispatcher->forward( $c, @_ ) }
383 =head2 $c->detach( $action [, \@arguments ] )
385 =head2 $c->detach( $class, $method, [, \@arguments ] )
389 The same as L<< forward|/"$c->forward( $action [, \@arguments ] )" >>, but
390 doesn't return to the previous action when processing is finished.
392 When called with no arguments it escapes the processing chain entirely.
396 sub detach { my $c = shift; $c->dispatcher->detach( $c, @_ ) }
398 =head2 $c->visit( $action [, \@captures, \@arguments ] )
400 =head2 $c->visit( $class, $method, [, \@captures, \@arguments ] )
402 Almost the same as L<< forward|/"$c->forward( $action [, \@arguments ] )" >>,
403 but does a full dispatch, instead of just calling the new C<$action> /
404 C<< $class->$method >>. This means that C<begin>, C<auto> and the method
405 you go to are called, just like a new request.
407 In addition both C<< $c->action >> and C<< $c->namespace >> are localized.
408 This means, for example, that C<< $c->action >> methods such as
409 L<name|Catalyst::Action/name>, L<class|Catalyst::Action/class> and
410 L<reverse|Catalyst::Action/reverse> return information for the visited action
411 when they are invoked within the visited action. This is different from the
412 behavior of L<< forward|/"$c->forward( $action [, \@arguments ] )" >>, which
413 continues to use the $c->action object from the caller action even when
414 invoked from the callee.
416 C<< $c->stash >> is kept unchanged.
418 In effect, L<< visit|/"$c->visit( $action [, \@captures, \@arguments ] )" >>
419 allows you to "wrap" another action, just as it would have been called by
420 dispatching from a URL, while the analogous
421 L<< go|/"$c->go( $action [, \@captures, \@arguments ] )" >> allows you to
422 transfer control to another action as if it had been reached directly from a URL.
426 sub visit { my $c = shift; $c->dispatcher->visit( $c, @_ ) }
428 =head2 $c->go( $action [, \@captures, \@arguments ] )
430 =head2 $c->go( $class, $method, [, \@captures, \@arguments ] )
432 The relationship between C<go> and
433 L<< visit|/"$c->visit( $action [, \@captures, \@arguments ] )" >> is the same as
434 the relationship between
435 L<< forward|/"$c->forward( $class, $method, [, \@arguments ] )" >> and
436 L<< detach|/"$c->detach( $action [, \@arguments ] )" >>. Like C<< $c->visit >>,
437 C<< $c->go >> will perform a full dispatch on the specified action or method,
438 with localized C<< $c->action >> and C<< $c->namespace >>. Like C<detach>,
439 C<go> escapes the processing of the current request chain on completion, and
440 does not return to its caller.
442 @arguments are arguments to the final destination of $action. @captures are
443 arguments to the intermediate steps, if any, on the way to the final sub of
448 sub go { my $c = shift; $c->dispatcher->go( $c, @_ ) }
454 Returns the current L<Catalyst::Response> object, see there for details.
458 Returns a hashref to the stash, which may be used to store data and pass
459 it between components during a request. You can also set hash keys by
460 passing arguments. The stash is automatically sent to the view. The
461 stash is cleared at the end of a request; it cannot be used for
462 persistent storage (for this you must use a session; see
463 L<Catalyst::Plugin::Session> for a complete system integrated with
466 $c->stash->{foo} = $bar;
467 $c->stash( { moose => 'majestic', qux => 0 } );
468 $c->stash( bar => 1, gorch => 2 ); # equivalent to passing a hashref
470 # stash is automatically passed to the view for use in a template
471 $c->forward( 'MyApp::View::TT' );
475 around stash => sub {
478 my $stash = $orig->($c);
480 my $new_stash = @_ > 1 ? {@_} : $_[0];
481 croak('stash takes a hash or hashref') unless ref $new_stash;
482 foreach my $key ( keys %$new_stash ) {
483 $stash->{$key} = $new_stash->{$key};
493 =head2 $c->error($error, ...)
495 =head2 $c->error($arrayref)
497 Returns an arrayref containing error messages. If Catalyst encounters an
498 error while processing a request, it stores the error in $c->error. This
499 method should only be used to store fatal error messages.
501 my @error = @{ $c->error };
505 $c->error('Something bad happened');
512 my $error = ref $_[0] eq 'ARRAY' ? $_[0] : [@_];
513 croak @$error unless ref $c;
514 push @{ $c->{error} }, @$error;
516 elsif ( defined $_[0] ) { $c->{error} = undef }
517 return $c->{error} || [];
523 Contains the return value of the last executed action.
524 Note that << $c->state >> operates in a scalar context which means that all
525 values it returns are scalar.
527 =head2 $c->clear_errors
529 Clear errors. You probably don't want to clear the errors unless you are
530 implementing a custom error screen.
532 This is equivalent to running
543 sub _comp_search_prefixes {
545 return map $c->components->{ $_ }, $c->_comp_names_search_prefixes(@_);
548 # search components given a name and some prefixes
549 sub _comp_names_search_prefixes {
550 my ( $c, $name, @prefixes ) = @_;
551 my $appclass = ref $c || $c;
552 my $filter = "^${appclass}::(" . join( '|', @prefixes ) . ')::';
553 $filter = qr/$filter/; # Compile regex now rather than once per loop
555 # map the original component name to the sub part that we will search against
556 my %eligible = map { my $n = $_; $n =~ s{^$appclass\::[^:]+::}{}; $_ => $n; }
557 grep { /$filter/ } keys %{ $c->components };
559 # undef for a name will return all
560 return keys %eligible if !defined $name;
562 my $query = ref $name ? $name : qr/^$name$/i;
563 my @result = grep { $eligible{$_} =~ m{$query} } keys %eligible;
565 return @result if @result;
567 # if we were given a regexp to search against, we're done.
570 # skip regexp fallback if configured
572 if $appclass->config->{disable_component_resolution_regex_fallback};
576 @result = grep { $eligible{ $_ } =~ m{$query} } keys %eligible;
578 # no results? try against full names
580 @result = grep { m{$query} } keys %eligible;
583 # don't warn if we didn't find any results, it just might not exist
585 # Disgusting hack to work out correct method name
586 my $warn_for = lc $prefixes[0];
587 my $msg = "Used regexp fallback for \$c->${warn_for}('${name}'), which found '" .
588 (join '", "', @result) . "'. Relying on regexp fallback behavior for " .
589 "component resolution is unreliable and unsafe.";
590 my $short = $result[0];
591 # remove the component namespace prefix
592 $short =~ s/.*?(Model|Controller|View):://;
593 my $shortmess = Carp::shortmess('');
594 if ($shortmess =~ m#Catalyst/Plugin#) {
595 $msg .= " You probably need to set '$short' instead of '${name}' in this " .
597 } elsif ($shortmess =~ m#Catalyst/lib/(View|Controller)#) {
598 $msg .= " You probably need to set '$short' instead of '${name}' in this " .
599 "component's config";
601 $msg .= " You probably meant \$c->${warn_for}('$short') instead of \$c->${warn_for}('${name}'), " .
602 "but if you really wanted to search, pass in a regexp as the argument " .
603 "like so: \$c->${warn_for}(qr/${name}/)";
605 $c->log->warn( "${msg}$shortmess" );
611 # Find possible names for a prefix
613 my ( $c, @prefixes ) = @_;
614 my $appclass = ref $c || $c;
616 my $filter = "^${appclass}::(" . join( '|', @prefixes ) . ')::';
618 my @names = map { s{$filter}{}; $_; }
619 $c->_comp_names_search_prefixes( undef, @prefixes );
624 # Filter a component before returning by calling ACCEPT_CONTEXT if available
625 sub _filter_component {
626 my ( $c, $comp, @args ) = @_;
628 if ( eval { $comp->can('ACCEPT_CONTEXT'); } ) {
629 return $comp->ACCEPT_CONTEXT( $c, @args );
635 =head2 COMPONENT ACCESSORS
637 =head2 $c->controller($name)
639 Gets a L<Catalyst::Controller> instance by name.
641 $c->controller('Foo')->do_stuff;
643 If the name is omitted, will return the controller for the dispatched
646 If you want to search for controllers, pass in a regexp as the argument.
648 # find all controllers that start with Foo
649 my @foo_controllers = $c->controller(qr{^Foo});
655 my ( $c, $name, @args ) = @_;
657 my $appclass = ref($c) || $c;
659 unless ( ref($name) ) { # Direct component hash lookup to avoid costly regexps
660 my $comps = $c->components;
661 my $check = $appclass."::Controller::".$name;
662 return $c->_filter_component( $comps->{$check}, @args ) if exists $comps->{$check};
664 my @result = $c->_comp_search_prefixes( $name, qw/Controller C/ );
665 return map { $c->_filter_component( $_, @args ) } @result if ref $name;
666 return $c->_filter_component( $result[ 0 ], @args );
669 return $c->component( $c->action->class );
672 =head2 $c->model($name)
674 Gets a L<Catalyst::Model> instance by name.
676 $c->model('Foo')->do_stuff;
678 Any extra arguments are directly passed to ACCEPT_CONTEXT.
680 If the name is omitted, it will look for
681 - a model object in $c->stash->{current_model_instance}, then
682 - a model name in $c->stash->{current_model}, then
683 - a config setting 'default_model', or
684 - check if there is only one model, and return it if that's the case.
686 If you want to search for models, pass in a regexp as the argument.
688 # find all models that start with Foo
689 my @foo_models = $c->model(qr{^Foo});
694 my ( $c, $name, @args ) = @_;
695 my $appclass = ref($c) || $c;
697 unless ( ref($name) ) { # Direct component hash lookup to avoid costly regexps
698 my $comps = $c->components;
699 my $check = $appclass."::Model::".$name;
700 return $c->_filter_component( $comps->{$check}, @args ) if exists $comps->{$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 $comps = $c->components;
758 my $check = $appclass."::View::".$name;
759 if( exists $comps->{$check} ) {
760 return $c->_filter_component( $comps->{$check}, @args );
763 $c->log->warn( "Attempted to use view '$check', but does not exist" );
766 my @result = $c->_comp_search_prefixes( $name, qw/View V/ );
767 return map { $c->_filter_component( $_, @args ) } @result if ref $name;
768 return $c->_filter_component( $result[ 0 ], @args );
772 return $c->stash->{current_view_instance}
773 if $c->stash->{current_view_instance};
774 return $c->view( $c->stash->{current_view} )
775 if $c->stash->{current_view};
777 return $c->view( $appclass->config->{default_view} )
778 if $appclass->config->{default_view};
780 my( $comp, $rest ) = $c->_comp_search_prefixes( undef, qw/View V/);
783 $c->log->warn( 'Calling $c->view() will return a random view unless you specify one of:' );
784 $c->log->warn( '* $c->config(default_view => "the name of the default view to use")' );
785 $c->log->warn( '* $c->stash->{current_view} # the name of the view to use for this request' );
786 $c->log->warn( '* $c->stash->{current_view_instance} # the instance of the view to use for this request' );
787 $c->log->warn( 'NB: in version 5.81, the "random" behavior will not work at all.' );
790 return $c->_filter_component( $comp );
793 =head2 $c->controllers
795 Returns the available names which can be passed to $c->controller
801 return $c->_comp_names(qw/Controller C/);
806 Returns the available names which can be passed to $c->model
812 return $c->_comp_names(qw/Model M/);
818 Returns the available names which can be passed to $c->view
824 return $c->_comp_names(qw/View V/);
827 =head2 $c->comp($name)
829 =head2 $c->component($name)
831 Gets a component object by name. This method is not recommended,
832 unless you want to get a specific component by full
833 class. C<< $c->controller >>, C<< $c->model >>, and C<< $c->view >>
834 should be used instead.
836 If C<$name> is a regexp, a list of components matched against the full
837 component name will be returned.
839 If Catalyst can't find a component by name, it will fallback to regex
840 matching by default. To disable this behaviour set
841 disable_component_resolution_regex_fallback to a true value.
843 __PACKAGE__->config( disable_component_resolution_regex_fallback => 1 );
848 my ( $c, $name, @args ) = @_;
851 my $comps = $c->components;
854 # is it the exact name?
855 return $c->_filter_component( $comps->{ $name }, @args )
856 if exists $comps->{ $name };
858 # perhaps we just omitted "MyApp"?
859 my $composed = ( ref $c || $c ) . "::${name}";
860 return $c->_filter_component( $comps->{ $composed }, @args )
861 if exists $comps->{ $composed };
863 # search all of the models, views and controllers
864 my( $comp ) = $c->_comp_search_prefixes( $name, qw/Model M Controller C View V/ );
865 return $c->_filter_component( $comp, @args ) if $comp;
868 # This is here so $c->comp( '::M::' ) works
869 my $query = ref $name ? $name : qr{$name}i;
871 my @result = grep { m{$query} } keys %{ $c->components };
872 return map { $c->_filter_component( $_, @args ) } @result if ref $name;
875 $c->log->warn( Carp::shortmess(qq(Found results for "${name}" using regexp fallback)) );
876 $c->log->warn( 'Relying on the regexp fallback behavior for component resolution' );
877 $c->log->warn( 'is unreliable and unsafe. You have been warned' );
878 return $c->_filter_component( $result[ 0 ], @args );
881 # I would expect to return an empty list here, but that breaks back-compat
885 return sort keys %{ $c->components };
888 =head2 CLASS DATA AND HELPER CLASSES
892 Returns or takes a hashref containing the application's configuration.
894 __PACKAGE__->config( { db => 'dsn:SQLite:foo.db' } );
896 You can also use a C<YAML>, C<XML> or L<Config::General> config file
897 like C<myapp.conf> in your applications home directory. See
898 L<Catalyst::Plugin::ConfigLoader>.
900 =head3 Cascading configuration
902 The config method is present on all Catalyst components, and configuration
903 will be merged when an application is started. Configuration loaded with
904 L<Catalyst::Plugin::ConfigLoader> takes precedence over other configuration,
905 followed by configuration in your top level C<MyApp> class. These two
906 configurations are merged, and then configuration data whose hash key matches a
907 component name is merged with configuration for that component.
909 The configuration for a component is then passed to the C<new> method when a
910 component is constructed.
914 MyApp->config({ 'Model::Foo' => { bar => 'baz', overrides => 'me' } });
915 MyApp::Model::Foo->config({ quux => 'frob', overrides => 'this' });
917 will mean that C<MyApp::Model::Foo> receives the following data when
920 MyApp::Model::Foo->new({
926 It's common practice to use a Moose attribute
927 on the receiving component to access the config value.
929 package MyApp::Model::Foo;
933 # this attr will receive 'baz' at construction time
939 You can then get the value 'baz' by calling $c->model('Foo')->bar
940 (or $self->bar inside code in the model).
942 B<NOTE:> you MUST NOT call C<< $self->config >> or C<< __PACKAGE__->config >>
943 as a way of reading config within your code, as this B<will not> give you the
944 correctly merged config back. You B<MUST> take the config values supplied to
945 the constructor and use those instead.
949 around config => sub {
953 croak('Setting config after setup has been run is not allowed.')
954 if ( @_ and $c->setup_finished );
961 Returns the logging object instance. Unless it is already set, Catalyst
962 sets this up with a L<Catalyst::Log> object. To use your own log class,
963 set the logger with the C<< __PACKAGE__->log >> method prior to calling
964 C<< __PACKAGE__->setup >>.
966 __PACKAGE__->log( MyLogger->new );
971 $c->log->info( 'Now logging with my own logger!' );
973 Your log class should implement the methods described in
979 Returns 1 if debug mode is enabled, 0 otherwise.
981 You can enable debug mode in several ways:
985 =item By calling myapp_server.pl with the -d flag
987 =item With the environment variables MYAPP_DEBUG, or CATALYST_DEBUG
989 =item The -Debug option in your MyApp.pm
991 =item By declaring C<sub debug { 1 }> in your MyApp.pm.
995 The first three also set the log level to 'debug'.
997 Calling C<< $c->debug(1) >> has no effect.
1003 =head2 $c->dispatcher
1005 Returns the dispatcher instance. See L<Catalyst::Dispatcher>.
1009 Returns the engine instance. See L<Catalyst::Engine>.
1012 =head2 UTILITY METHODS
1014 =head2 $c->path_to(@path)
1016 Merges C<@path> with C<< $c->config->{home} >> and returns a
1017 L<Path::Class::Dir> object. Note you can usually use this object as
1018 a filename, but sometimes you will have to explicitly stringify it
1019 yourself by calling the C<< ->stringify >> method.
1023 $c->path_to( 'db', 'sqlite.db' );
1028 my ( $c, @path ) = @_;
1029 my $path = Path::Class::Dir->new( $c->config->{home}, @path );
1030 if ( -d $path ) { return $path }
1031 else { return Path::Class::File->new( $c->config->{home}, @path ) }
1034 =head2 $c->plugin( $name, $class, @args )
1036 Helper method for plugins. It creates a class data accessor/mutator and
1037 loads and instantiates the given class.
1039 MyApp->plugin( 'prototype', 'HTML::Prototype' );
1041 $c->prototype->define_javascript_functions;
1043 B<Note:> This method of adding plugins is deprecated. The ability
1044 to add plugins like this B<will be removed> in a Catalyst 5.81.
1045 Please do not use this functionality in new code.
1050 my ( $class, $name, $plugin, @args ) = @_;
1052 # See block comment in t/unit_core_plugin.t
1053 $class->log->warn(qq/Adding plugin using the ->plugin method is deprecated, and will be removed in Catalyst 5.81/);
1055 $class->_register_plugin( $plugin, 1 );
1057 eval { $plugin->import };
1058 $class->mk_classdata($name);
1060 eval { $obj = $plugin->new(@args) };
1063 Catalyst::Exception->throw( message =>
1064 qq/Couldn't instantiate instant plugin "$plugin", "$@"/ );
1067 $class->$name($obj);
1068 $class->log->debug(qq/Initialized instant plugin "$plugin" as "$name"/)
1074 Initializes the dispatcher and engine, loads any plugins, and loads the
1075 model, view, and controller components. You may also specify an array
1076 of plugins to load here, if you choose to not load them in the C<use
1080 MyApp->setup( qw/-Debug/ );
1085 my ( $class, @arguments ) = @_;
1086 croak('Running setup more than once')
1087 if ( $class->setup_finished );
1089 unless ( $class->isa('Catalyst') ) {
1091 Catalyst::Exception->throw(
1092 message => qq/'$class' does not inherit from Catalyst/ );
1095 if ( $class->arguments ) {
1096 @arguments = ( @arguments, @{ $class->arguments } );
1102 foreach (@arguments) {
1106 ( $flags->{log} ) ? 'debug,' . $flags->{log} : 'debug';
1108 elsif (/^-(\w+)=?(.*)$/) {
1109 $flags->{ lc $1 } = $2;
1112 push @{ $flags->{plugins} }, $_;
1116 $class->setup_home( delete $flags->{home} );
1118 $class->setup_log( delete $flags->{log} );
1119 $class->setup_plugins( delete $flags->{plugins} );
1120 $class->setup_dispatcher( delete $flags->{dispatcher} );
1121 if (my $engine = delete $flags->{engine}) {
1122 $class->log->warn("Specifying the engine in ->setup is no longer supported, XXX FIXME");
1124 $class->setup_engine();
1125 $class->setup_stats( delete $flags->{stats} );
1127 for my $flag ( sort keys %{$flags} ) {
1129 if ( my $code = $class->can( 'setup_' . $flag ) ) {
1130 &$code( $class, delete $flags->{$flag} );
1133 $class->log->warn(qq/Unknown flag "$flag"/);
1137 eval { require Catalyst::Devel; };
1138 if( !$@ && $ENV{CATALYST_SCRIPT_GEN} && ( $ENV{CATALYST_SCRIPT_GEN} < $Catalyst::Devel::CATALYST_SCRIPT_GEN ) ) {
1139 $class->log->warn(<<"EOF");
1140 You are running an old script!
1142 Please update by running (this will overwrite existing files):
1143 catalyst.pl -force -scripts $class
1145 or (this will not overwrite existing files):
1146 catalyst.pl -scripts $class
1151 if ( $class->debug ) {
1152 my @plugins = map { "$_ " . ( $_->VERSION || '' ) } $class->registered_plugins;
1155 my $column_width = Catalyst::Utils::term_width() - 6;
1156 my $t = Text::SimpleTable->new($column_width);
1157 $t->row($_) for @plugins;
1158 $class->log->debug( "Loaded plugins:\n" . $t->draw . "\n" );
1161 my $dispatcher = $class->dispatcher;
1162 my $engine = $class->engine;
1163 my $home = $class->config->{home};
1165 $class->log->debug(sprintf(q/Loaded dispatcher "%s"/, blessed($dispatcher)));
1166 $class->log->debug(sprintf(q/Loaded engine "%s"/, blessed($engine)));
1170 ? $class->log->debug(qq/Found home "$home"/)
1171 : $class->log->debug(qq/Home "$home" doesn't exist/)
1172 : $class->log->debug(q/Couldn't find home/);
1175 # Call plugins setup, this is stupid and evil.
1176 # Also screws C3 badly on 5.10, hack to avoid.
1178 no warnings qw/redefine/;
1179 local *setup = sub { };
1180 $class->setup unless $Catalyst::__AM_RESTARTING;
1183 # Initialize our data structure
1184 $class->components( {} );
1186 $class->setup_components;
1188 if ( $class->debug ) {
1189 my $column_width = Catalyst::Utils::term_width() - 8 - 9;
1190 my $t = Text::SimpleTable->new( [ $column_width, 'Class' ], [ 8, 'Type' ] );
1191 for my $comp ( sort keys %{ $class->components } ) {
1192 my $type = ref $class->components->{$comp} ? 'instance' : 'class';
1193 $t->row( $comp, $type );
1195 $class->log->debug( "Loaded components:\n" . $t->draw . "\n" )
1196 if ( keys %{ $class->components } );
1199 # Add our self to components, since we are also a component
1200 if( $class->isa('Catalyst::Controller') ){
1201 $class->components->{$class} = $class;
1204 $class->setup_actions;
1206 if ( $class->debug ) {
1207 my $name = $class->config->{name} || 'Application';
1208 $class->log->info("$name powered by Catalyst $Catalyst::VERSION");
1211 # Make sure that the application class becomes immutable at this point,
1212 B::Hooks::EndOfScope::on_scope_end {
1214 my $meta = Class::MOP::get_metaclass_by_name($class);
1217 && ! { $meta->immutable_options }->{replace_constructor}
1219 $class->isa('Class::Accessor::Fast')
1220 || $class->isa('Class::Accessor')
1223 warn "You made your application class ($class) immutable, "
1224 . "but did not inline the\nconstructor. "
1225 . "This will break catalyst, as your app \@ISA "
1226 . "Class::Accessor(::Fast)?\nPlease pass "
1227 . "(replace_constructor => 1)\nwhen making your class immutable.\n";
1229 $meta->make_immutable(
1230 replace_constructor => 1,
1231 ) unless $meta->is_immutable;
1234 if ($class->config->{case_sensitive}) {
1235 $class->log->warn($class . "->config->{case_sensitive} is set.");
1236 $class->log->warn("This setting is deprecated and planned to be removed in Catalyst 5.81.");
1239 $class->setup_finalize;
1240 # Should be the last thing we do so that user things hooking
1241 # setup_finalize can log..
1242 $class->log->_flush() if $class->log->can('_flush');
1243 return 1; # Explicit return true as people have __PACKAGE__->setup as the last thing in their class. HATE.
1246 =head2 $app->setup_finalize
1248 A hook to attach modifiers to. This method does not do anything except set the
1249 C<setup_finished> accessor.
1251 Applying method modifiers to the C<setup> method doesn't work, because of quirky thingsdone for plugin setup.
1255 after setup_finalize => sub {
1263 sub setup_finalize {
1265 $class->setup_finished(1);
1268 =head2 $c->uri_for( $path?, @args?, \%query_values? )
1270 =head2 $c->uri_for( $action, \@captures?, @args?, \%query_values? )
1272 Constructs an absolute L<URI> object based on the application root, the
1273 provided path, and the additional arguments and query parameters provided.
1274 When used as a string, provides a textual URI. If you need more flexibility
1275 than this (i.e. the option to provide relative URIs etc.) see
1276 L<Catalyst::Plugin::SmartURI>.
1278 If no arguments are provided, the URI for the current action is returned.
1279 To return the current action and also provide @args, use
1280 C<< $c->uri_for( $c->action, @args ) >>.
1282 If the first argument is a string, it is taken as a public URI path relative
1283 to C<< $c->namespace >> (if it doesn't begin with a forward slash) or
1284 relative to the application root (if it does). It is then merged with
1285 C<< $c->request->base >>; any C<@args> are appended as additional path
1286 components; and any C<%query_values> are appended as C<?foo=bar> parameters.
1288 If the first argument is a L<Catalyst::Action> it represents an action which
1289 will have its path resolved using C<< $c->dispatcher->uri_for_action >>. The
1290 optional C<\@captures> argument (an arrayref) allows passing the captured
1291 variables that are needed to fill in the paths of Chained and Regex actions;
1292 once the path is resolved, C<uri_for> continues as though a path was
1293 provided, appending any arguments or parameters and creating an absolute
1296 The captures for the current request can be found in
1297 C<< $c->request->captures >>, and actions can be resolved using
1298 C<< Catalyst::Controller->action_for($name) >>. If you have a private action
1299 path, use C<< $c->uri_for_action >> instead.
1301 # Equivalent to $c->req->uri
1302 $c->uri_for($c->action, $c->req->captures,
1303 @{ $c->req->args }, $c->req->params);
1305 # For the Foo action in the Bar controller
1306 $c->uri_for($c->controller('Bar')->action_for('Foo'));
1308 # Path to a static resource
1309 $c->uri_for('/static/images/logo.png');
1314 my ( $c, $path, @args ) = @_;
1316 if (blessed($path) && $path->isa('Catalyst::Controller')) {
1317 $path = $path->path_prefix;
1322 undef($path) if (defined $path && $path eq '');
1325 ( scalar @args && ref $args[$#args] eq 'HASH' ? pop @args : {} );
1327 carp "uri_for called with undef argument" if grep { ! defined $_ } @args;
1328 foreach my $arg (@args) {
1329 utf8::encode($arg) if utf8::is_utf8($arg);
1330 $arg =~ s/([^$URI::uric])/$URI::Escape::escapes{$1}/go;
1333 if ( blessed($path) ) { # action object
1334 s|/|%2F|g for @args;
1335 my $captures = [ map { s|/|%2F|g; $_; }
1336 ( scalar @args && ref $args[0] eq 'ARRAY'
1340 foreach my $capture (@$captures) {
1341 utf8::encode($capture) if utf8::is_utf8($capture);
1342 $capture =~ s/([^$URI::uric])/$URI::Escape::escapes{$1}/go;
1346 $path = $c->dispatcher->uri_for_action($action, $captures);
1347 if (not defined $path) {
1348 $c->log->debug(qq/Can't find uri_for action '$action' @$captures/)
1352 $path = '/' if $path eq '';
1355 unshift(@args, $path);
1357 unless (defined $path && $path =~ s!^/!!) { # in-place strip
1358 my $namespace = $c->namespace;
1359 if (defined $path) { # cheesy hack to handle path '../foo'
1360 $namespace =~ s{(?:^|/)[^/]+$}{} while $args[0] =~ s{^\.\./}{};
1362 unshift(@args, $namespace || '');
1365 # join args with '/', or a blank string
1366 my $args = join('/', grep { defined($_) } @args);
1367 $args =~ s/\?/%3F/g; # STUPID STUPID SPECIAL CASE
1369 my $base = $c->req->base;
1370 my $class = ref($base);
1371 $base =~ s{(?<!/)$}{/};
1375 if (my @keys = keys %$params) {
1376 # somewhat lifted from URI::_query's query_form
1377 $query = '?'.join('&', map {
1378 my $val = $params->{$_};
1379 s/([;\/?:@&=+,\$\[\]%])/$URI::Escape::escapes{$1}/go;
1382 $val = '' unless defined $val;
1385 utf8::encode( $param ) if utf8::is_utf8($param);
1386 # using the URI::Escape pattern here so utf8 chars survive
1387 $param =~ s/([^A-Za-z0-9\-_.!~*'() ])/$URI::Escape::escapes{$1}/go;
1389 "${key}=$param"; } ( ref $val eq 'ARRAY' ? @$val : $val ));
1393 my $res = bless(\"${base}${args}${query}", $class);
1397 =head2 $c->uri_for_action( $path, \@captures?, @args?, \%query_values? )
1399 =head2 $c->uri_for_action( $action, \@captures?, @args?, \%query_values? )
1405 A private path to the Catalyst action you want to create a URI for.
1407 This is a shortcut for calling C<< $c->dispatcher->get_action_by_path($path)
1408 >> and passing the resulting C<$action> and the remaining arguments to C<<
1411 You can also pass in a Catalyst::Action object, in which case it is passed to
1414 Note that although the path looks like a URI that dispatches to the wanted action, it is not a URI, but an internal path to that action.
1416 For example, if the action looks like:
1418 package MyApp::Controller::Users;
1420 sub lst : Path('the-list') {}
1424 $c->uri_for_action('/users/lst')
1426 and it will create the URI /users/the-list.
1432 sub uri_for_action {
1433 my ( $c, $path, @args ) = @_;
1434 my $action = blessed($path)
1436 : $c->dispatcher->get_action_by_path($path);
1437 unless (defined $action) {
1438 croak "Can't find action for path '$path'";
1440 return $c->uri_for( $action, @args );
1443 =head2 $c->welcome_message
1445 Returns the Catalyst welcome HTML page.
1449 sub welcome_message {
1451 my $name = $c->config->{name};
1452 my $logo = $c->uri_for('/static/images/catalyst_logo.png');
1453 my $prefix = Catalyst::Utils::appprefix( ref $c );
1454 $c->response->content_type('text/html; charset=utf-8');
1456 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
1457 "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
1458 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
1460 <meta http-equiv="Content-Language" content="en" />
1461 <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
1462 <title>$name on Catalyst $VERSION</title>
1463 <style type="text/css">
1466 background-color: #eee;
1473 margin-bottom: 10px;
1475 background-color: #ccc;
1476 border: 1px solid #aaa;
1481 font-family: verdana, tahoma, sans-serif;
1484 font-family: verdana, tahoma, sans-serif;
1487 text-decoration: none;
1489 border-bottom: 1px dotted #bbb;
1491 :link:hover, :visited:hover {
1504 background-color: #fff;
1505 border: 1px solid #aaa;
1509 font-weight: normal;
1531 <h1><span id="appname">$name</span> on <a href="http://catalyst.perl.org">Catalyst</a>
1536 <img src="$logo" alt="Catalyst Logo" />
1538 <p>Welcome to the world of Catalyst.
1539 This <a href="http://en.wikipedia.org/wiki/MVC">MVC</a>
1540 framework will make web development something you had
1541 never expected it to be: Fun, rewarding, and quick.</p>
1542 <h2>What to do now?</h2>
1543 <p>That really depends on what <b>you</b> want to do.
1544 We do, however, provide you with a few starting points.</p>
1545 <p>If you want to jump right into web development with Catalyst
1546 you might want to start with a tutorial.</p>
1547 <pre>perldoc <a href="http://cpansearch.perl.org/dist/Catalyst-Manual/lib/Catalyst/Manual/Tutorial.pod">Catalyst::Manual::Tutorial</a></code>
1549 <p>Afterwards you can go on to check out a more complete look at our features.</p>
1551 <code>perldoc <a href="http://cpansearch.perl.org/dist/Catalyst-Manual/lib/Catalyst/Manual/Intro.pod">Catalyst::Manual::Intro</a>
1552 <!-- Something else should go here, but the Catalyst::Manual link seems unhelpful -->
1554 <h2>What to do next?</h2>
1555 <p>Next it's time to write an actual application. Use the
1556 helper scripts to generate <a href="http://cpansearch.perl.org/search?query=Catalyst%3A%3AController%3A%3A&mode=all">controllers</a>,
1557 <a href="http://cpansearch.perl.org/search?query=Catalyst%3A%3AModel%3A%3A&mode=all">models</a>, and
1558 <a href="http://cpansearch.perl.org/search?query=Catalyst%3A%3AView%3A%3A&mode=all">views</a>;
1559 they can save you a lot of work.</p>
1560 <pre><code>script/${prefix}_create.pl --help</code></pre>
1561 <p>Also, be sure to check out the vast and growing
1562 collection of <a href="http://search.cpan.org/search?query=Catalyst">plugins for Catalyst on CPAN</a>;
1563 you are likely to find what you need there.
1567 <p>Catalyst has a very active community. Here are the main places to
1568 get in touch with us.</p>
1571 <a href="http://dev.catalyst.perl.org">Wiki</a>
1574 <a href="http://lists.scsys.co.uk/cgi-bin/mailman/listinfo/catalyst">Mailing-List</a>
1577 <a href="irc://irc.perl.org/catalyst">IRC channel #catalyst on irc.perl.org</a>
1580 <h2>In conclusion</h2>
1581 <p>The Catalyst team hopes you will enjoy using Catalyst as much
1582 as we enjoyed making it. Please contact us if you have ideas
1583 for improvement or other feedback.</p>
1591 =head1 INTERNAL METHODS
1593 These methods are not meant to be used by end users.
1595 =head2 $c->components
1597 Returns a hash of components.
1599 =head2 $c->context_class
1601 Returns or sets the context class.
1605 Returns a hashref containing coderefs and execution counts (needed for
1606 deep recursion detection).
1610 Returns the number of actions on the current internal execution stack.
1614 Dispatches a request to actions.
1618 sub dispatch { my $c = shift; $c->dispatcher->dispatch( $c, @_ ) }
1620 =head2 $c->dispatcher_class
1622 Returns or sets the dispatcher class.
1624 =head2 $c->dump_these
1626 Returns a list of 2-element array references (name, structure) pairs
1627 that will be dumped on the error page in debug mode.
1633 [ Request => $c->req ],
1634 [ Response => $c->res ],
1635 [ Stash => $c->stash ],
1636 [ Config => $c->config ];
1639 =head2 $c->engine_class
1641 Returns or sets the engine class.
1643 =head2 $c->execute( $class, $coderef )
1645 Execute a coderef in given class and catch exceptions. Errors are available
1651 my ( $c, $class, $code ) = @_;
1652 $class = $c->component($class) || $class;
1655 if ( $c->depth >= $RECURSION ) {
1656 my $action = $code->reverse();
1657 $action = "/$action" unless $action =~ /->/;
1658 my $error = qq/Deep recursion detected calling "${action}"/;
1659 $c->log->error($error);
1665 my $stats_info = $c->_stats_start_execute( $code ) if $c->use_stats;
1667 push( @{ $c->stack }, $code );
1669 no warnings 'recursion';
1670 # N.B. This used to be combined, but I have seen $c get clobbered if so, and
1671 # I have no idea how, ergo $ret (which appears to fix the issue)
1672 eval { my $ret = $code->execute( $class, $c, @{ $c->req->args } ) || 0; $c->state( $ret ) };
1674 $c->_stats_finish_execute( $stats_info ) if $c->use_stats and $stats_info;
1676 my $last = pop( @{ $c->stack } );
1678 if ( my $error = $@ ) {
1679 if ( blessed($error) and $error->isa('Catalyst::Exception::Detach') ) {
1680 $error->rethrow if $c->depth > 1;
1682 elsif ( blessed($error) and $error->isa('Catalyst::Exception::Go') ) {
1683 $error->rethrow if $c->depth > 0;
1686 unless ( ref $error ) {
1687 no warnings 'uninitialized';
1689 my $class = $last->class;
1690 my $name = $last->name;
1691 $error = qq/Caught exception in $class->$name "$error"/;
1700 sub _stats_start_execute {
1701 my ( $c, $code ) = @_;
1702 my $appclass = ref($c) || $c;
1703 return if ( ( $code->name =~ /^_.*/ )
1704 && ( !$appclass->config->{show_internal_actions} ) );
1706 my $action_name = $code->reverse();
1707 $c->counter->{$action_name}++;
1709 my $action = $action_name;
1710 $action = "/$action" unless $action =~ /->/;
1712 # determine if the call was the result of a forward
1713 # this is done by walking up the call stack and looking for a calling
1714 # sub of Catalyst::forward before the eval
1716 for my $index ( 2 .. 11 ) {
1718 if ( ( caller($index) )[0] eq 'Catalyst'
1719 && ( caller($index) )[3] eq '(eval)' );
1721 if ( ( caller($index) )[3] =~ /forward$/ ) {
1722 $callsub = ( caller($index) )[3];
1723 $action = "-> $action";
1728 my $uid = $action_name . $c->counter->{$action_name};
1730 # is this a root-level call or a forwarded call?
1731 if ( $callsub =~ /forward$/ ) {
1732 my $parent = $c->stack->[-1];
1734 # forward, locate the caller
1735 if ( defined $parent && exists $c->counter->{"$parent"} ) {
1738 parent => "$parent" . $c->counter->{"$parent"},
1744 # forward with no caller may come from a plugin
1763 sub _stats_finish_execute {
1764 my ( $c, $info ) = @_;
1765 $c->stats->profile( end => $info );
1770 Finalizes the request.
1777 for my $error ( @{ $c->error } ) {
1778 $c->log->error($error);
1781 # Allow engine to handle finalize flow (for POE)
1782 my $engine = $c->engine;
1783 if ( my $code = $engine->can('finalize') ) {
1788 $c->finalize_uploads;
1791 if ( $#{ $c->error } >= 0 ) {
1795 $c->finalize_headers;
1798 if ( $c->request->method eq 'HEAD' ) {
1799 $c->response->body('');
1807 if ($c->use_stats) {
1808 my $elapsed = sprintf '%f', $c->stats->elapsed;
1809 my $av = $elapsed == 0 ? '??' : sprintf '%.3f', 1 / $elapsed;
1811 "Request took ${elapsed}s ($av/s)\n" . $c->stats->report . "\n" );
1814 return $c->response->status;
1817 =head2 $c->finalize_body
1823 sub finalize_body { my $c = shift; $c->engine->finalize_body( $c, @_ ) }
1825 =head2 $c->finalize_cookies
1831 sub finalize_cookies { my $c = shift; $c->engine->finalize_cookies( $c, @_ ) }
1833 =head2 $c->finalize_error
1839 sub finalize_error { my $c = shift; $c->engine->finalize_error( $c, @_ ) }
1841 =head2 $c->finalize_headers
1847 sub finalize_headers {
1850 my $response = $c->response; #accessor calls can add up?
1852 # Check if we already finalized headers
1853 return if $response->finalized_headers;
1856 if ( my $location = $response->redirect ) {
1857 $c->log->debug(qq/Redirecting to "$location"/) if $c->debug;
1858 $response->header( Location => $location );
1860 if ( !$response->has_body ) {
1861 # Add a default body if none is already present
1863 qq{<html><body><p>This item has moved <a href="$location">here</a>.</p></body></html>}
1869 if ( defined $response->body && length $response->body && !$response->content_length ) {
1871 # get the length from a filehandle
1872 if ( blessed( $response->body ) && $response->body->can('read') || ref( $response->body ) eq 'GLOB' )
1874 my $stat = stat $response->body;
1875 if ( $stat && $stat->size > 0 ) {
1876 $response->content_length( $stat->size );
1879 $c->log->warn('Serving filehandle without a content-length');
1883 # everything should be bytes at this point, but just in case
1884 $response->content_length( length( $response->body ) );
1889 if ( $response->status =~ /^(1\d\d|[23]04)$/ ) {
1890 $response->headers->remove_header("Content-Length");
1891 $response->body('');
1894 $c->finalize_cookies;
1896 $c->engine->finalize_headers( $c, @_ );
1899 $response->finalized_headers(1);
1902 =head2 $c->finalize_output
1904 An alias for finalize_body.
1906 =head2 $c->finalize_read
1908 Finalizes the input after reading is complete.
1912 sub finalize_read { my $c = shift; $c->engine->finalize_read( $c, @_ ) }
1914 =head2 $c->finalize_uploads
1916 Finalizes uploads. Cleans up any temporary files.
1920 sub finalize_uploads { my $c = shift; $c->engine->finalize_uploads( $c, @_ ) }
1922 =head2 $c->get_action( $action, $namespace )
1924 Gets an action in a given namespace.
1928 sub get_action { my $c = shift; $c->dispatcher->get_action(@_) }
1930 =head2 $c->get_actions( $action, $namespace )
1932 Gets all actions of a given name in a namespace and all parent
1937 sub get_actions { my $c = shift; $c->dispatcher->get_actions( $c, @_ ) }
1939 =head2 $app->handle_request( @arguments )
1941 Called to handle each HTTP request.
1945 sub handle_request {
1946 my ( $class, @arguments ) = @_;
1948 # Always expect worst case!
1951 if ($class->debug) {
1952 my $secs = time - $START || 1;
1953 my $av = sprintf '%.3f', $COUNT / $secs;
1954 my $time = localtime time;
1955 $class->log->info("*** Request $COUNT ($av/s) [$$] [$time] ***");
1958 my $c = $class->prepare(@arguments);
1960 $status = $c->finalize;
1963 chomp(my $error = $_);
1964 $class->log->error(qq/Caught exception in engine "$error"/);
1969 if(my $coderef = $class->log->can('_flush')){
1970 $class->log->$coderef();
1975 =head2 $c->prepare( @arguments )
1977 Creates a Catalyst context from an engine-specific request (Apache, CGI,
1983 my ( $class, @arguments ) = @_;
1986 # After the app/ctxt split, this should become an attribute based on something passed
1987 # into the application.
1988 $class->context_class( ref $class || $class ) unless $class->context_class;
1990 my $c = $class->context_class->new({});
1992 # For on-demand data
1993 $c->request->_context($c);
1994 $c->response->_context($c);
1996 #surely this is not the most efficient way to do things...
1997 $c->stats($class->stats_class->new)->enable($c->use_stats);
1998 if ( $c->debug || $c->config->{enable_catalyst_header} ) {
1999 $c->res->headers->header( 'X-Catalyst' => $Catalyst::VERSION );
2003 # Allow engine to direct the prepare flow (for POE)
2004 if ( my $prepare = $c->engine->can('prepare') ) {
2005 $c->engine->$prepare( $c, @arguments );
2008 $c->prepare_request(@arguments);
2009 $c->prepare_connection;
2010 $c->prepare_query_parameters;
2011 $c->prepare_headers;
2012 $c->prepare_cookies;
2015 # Prepare the body for reading, either by prepare_body
2016 # or the user, if they are using $c->read
2019 # Parse the body unless the user wants it on-demand
2020 unless ( ref($c)->config->{parse_on_demand} ) {
2025 # VERY ugly and probably shouldn't rely on ->finalize actually working
2027 # failed prepare is always due to an invalid request, right?
2028 $c->response->status(400);
2029 $c->response->content_type('text/plain');
2030 $c->response->body('Bad Request');
2035 my $method = $c->req->method || '';
2036 my $path = $c->req->path;
2037 $path = '/' unless length $path;
2038 my $address = $c->req->address || '';
2047 =head2 $c->prepare_action
2049 Prepares action. See L<Catalyst::Dispatcher>.
2053 sub prepare_action { my $c = shift; $c->dispatcher->prepare_action( $c, @_ ) }
2055 =head2 $c->prepare_body
2057 Prepares message body.
2064 return if $c->request->_has_body;
2066 # Initialize on-demand data
2067 $c->engine->prepare_body( $c, @_ );
2068 $c->prepare_parameters;
2069 $c->prepare_uploads;
2072 =head2 $c->prepare_body_chunk( $chunk )
2074 Prepares a chunk of data before sending it to L<HTTP::Body>.
2076 See L<Catalyst::Engine>.
2080 sub prepare_body_chunk {
2082 $c->engine->prepare_body_chunk( $c, @_ );
2085 =head2 $c->prepare_body_parameters
2087 Prepares body parameters.
2091 sub prepare_body_parameters {
2093 $c->engine->prepare_body_parameters( $c, @_ );
2096 =head2 $c->prepare_connection
2098 Prepares connection.
2102 sub prepare_connection {
2104 $c->engine->prepare_connection( $c, @_ );
2107 =head2 $c->prepare_cookies
2113 sub prepare_cookies { my $c = shift; $c->engine->prepare_cookies( $c, @_ ) }
2115 =head2 $c->prepare_headers
2121 sub prepare_headers { my $c = shift; $c->engine->prepare_headers( $c, @_ ) }
2123 =head2 $c->prepare_parameters
2125 Prepares parameters.
2129 sub prepare_parameters {
2131 $c->prepare_body_parameters;
2132 $c->engine->prepare_parameters( $c, @_ );
2135 =head2 $c->prepare_path
2137 Prepares path and base.
2141 sub prepare_path { my $c = shift; $c->engine->prepare_path( $c, @_ ) }
2143 =head2 $c->prepare_query_parameters
2145 Prepares query parameters.
2149 sub prepare_query_parameters {
2152 $c->engine->prepare_query_parameters( $c, @_ );
2155 =head2 $c->log_request
2157 Writes information about the request to the debug logs. This includes:
2161 =item * Request method, path, and remote IP address
2163 =item * Query keywords (see L<Catalyst::Request/query_keywords>)
2165 =item * Request parameters
2167 =item * File uploads
2176 return unless $c->debug;
2178 my($dump) = grep {$_->[0] eq 'Request' } $c->dump_these;
2179 my $request = $dump->[1];
2181 my ( $method, $path, $address ) = ( $request->method, $request->path, $request->address );
2183 $path = '/' unless length $path;
2185 $c->log->debug(qq/"$method" request for "$path" from "$address"/);
2187 $c->log_request_headers($request->headers);
2189 if ( my $keywords = $request->query_keywords ) {
2190 $c->log->debug("Query keywords are: $keywords");
2193 $c->log_request_parameters( query => $request->query_parameters, $request->_has_body ? (body => $request->body_parameters) : () );
2195 $c->log_request_uploads($request);
2198 =head2 $c->log_response
2200 Writes information about the response to the debug logs by calling
2201 C<< $c->log_response_status_line >> and C<< $c->log_response_headers >>.
2208 return unless $c->debug;
2210 my($dump) = grep {$_->[0] eq 'Response' } $c->dump_these;
2211 my $response = $dump->[1];
2213 $c->log_response_status_line($response);
2214 $c->log_response_headers($response->headers);
2217 =head2 $c->log_response_status_line($response)
2219 Writes one line of information about the response to the debug logs. This includes:
2223 =item * Response status code
2225 =item * Content-Type header (if present)
2227 =item * Content-Length header (if present)
2233 sub log_response_status_line {
2234 my ($c, $response) = @_;
2238 'Response Code: %s; Content-Type: %s; Content-Length: %s',
2239 $response->status || 'unknown',
2240 $response->headers->header('Content-Type') || 'unknown',
2241 $response->headers->header('Content-Length') || 'unknown'
2246 =head2 $c->log_response_headers($headers);
2248 Hook method which can be wrapped by plugins to log the responseheaders.
2249 No-op in the default implementation.
2253 sub log_response_headers {}
2255 =head2 $c->log_request_parameters( query => {}, body => {} )
2257 Logs request parameters to debug logs
2261 sub log_request_parameters {
2263 my %all_params = @_;
2265 return unless $c->debug;
2267 my $column_width = Catalyst::Utils::term_width() - 44;
2268 foreach my $type (qw(query body)) {
2269 my $params = $all_params{$type};
2270 next if ! keys %$params;
2271 my $t = Text::SimpleTable->new( [ 35, 'Parameter' ], [ $column_width, 'Value' ] );
2272 for my $key ( sort keys %$params ) {
2273 my $param = $params->{$key};
2274 my $value = defined($param) ? $param : '';
2275 $t->row( $key, ref $value eq 'ARRAY' ? ( join ', ', @$value ) : $value );
2277 $c->log->debug( ucfirst($type) . " Parameters are:\n" . $t->draw );
2281 =head2 $c->log_request_uploads
2283 Logs file uploads included in the request to the debug logs.
2284 The parameter name, filename, file type, and file size are all included in
2289 sub log_request_uploads {
2291 my $request = shift;
2292 return unless $c->debug;
2293 my $uploads = $request->uploads;
2294 if ( keys %$uploads ) {
2295 my $t = Text::SimpleTable->new(
2296 [ 12, 'Parameter' ],
2301 for my $key ( sort keys %$uploads ) {
2302 my $upload = $uploads->{$key};
2303 for my $u ( ref $upload eq 'ARRAY' ? @{$upload} : ($upload) ) {
2304 $t->row( $key, $u->filename, $u->type, $u->size );
2307 $c->log->debug( "File Uploads are:\n" . $t->draw );
2311 =head2 $c->log_request_headers($headers);
2313 Hook method which can be wrapped by plugins to log the request headers.
2314 No-op in the default implementation.
2318 sub log_request_headers {}
2320 =head2 $c->log_headers($type => $headers)
2322 Logs L<HTTP::Headers> (either request or response) to the debug logs.
2329 my $headers = shift; # an HTTP::Headers instance
2331 return unless $c->debug;
2333 my $column_width = Catalyst::Utils::term_width() - 28;
2334 my $t = Text::SimpleTable->new( [ 15, 'Header Name' ], [ $column_width, 'Value' ] );
2337 my ( $name, $value ) = @_;
2338 $t->row( $name, $value );
2341 $c->log->debug( ucfirst($type) . " Headers:\n" . $t->draw );
2345 =head2 $c->prepare_read
2347 Prepares the input for reading.
2351 sub prepare_read { my $c = shift; $c->engine->prepare_read( $c, @_ ) }
2353 =head2 $c->prepare_request
2355 Prepares the engine request.
2359 sub prepare_request { my $c = shift; $c->engine->prepare_request( $c, @_ ) }
2361 =head2 $c->prepare_uploads
2367 sub prepare_uploads {
2370 $c->engine->prepare_uploads( $c, @_ );
2373 =head2 $c->prepare_write
2375 Prepares the output for writing.
2379 sub prepare_write { my $c = shift; $c->engine->prepare_write( $c, @_ ) }
2381 =head2 $c->request_class
2383 Returns or sets the request class. Defaults to L<Catalyst::Request>.
2385 =head2 $c->response_class
2387 Returns or sets the response class. Defaults to L<Catalyst::Response>.
2389 =head2 $c->read( [$maxlength] )
2391 Reads a chunk of data from the request body. This method is designed to
2392 be used in a while loop, reading C<$maxlength> bytes on every call.
2393 C<$maxlength> defaults to the size of the request if not specified.
2395 You have to set C<< MyApp->config(parse_on_demand => 1) >> to use this
2398 Warning: If you use read(), Catalyst will not process the body,
2399 so you will not be able to access POST parameters or file uploads via
2400 $c->request. You must handle all body parsing yourself.
2404 sub read { my $c = shift; return $c->engine->read( $c, @_ ) }
2412 sub run { my $c = shift; return $c->engine->run( $c, $c->_finalized_psgi_app, @_ ) }
2414 =head2 $c->set_action( $action, $code, $namespace, $attrs )
2416 Sets an action in a given namespace.
2420 sub set_action { my $c = shift; $c->dispatcher->set_action( $c, @_ ) }
2422 =head2 $c->setup_actions($component)
2424 Sets up actions for a component.
2428 sub setup_actions { my $c = shift; $c->dispatcher->setup_actions( $c, @_ ) }
2430 =head2 $c->setup_components
2432 This method is called internally to set up the application's components.
2434 It finds modules by calling the L<locate_components> method, expands them to
2435 package names with the L<expand_component_module> method, and then installs
2436 each component into the application.
2438 The C<setup_components> config option is passed to both of the above methods.
2440 Installation of each component is performed by the L<setup_component> method,
2445 sub setup_components {
2448 my $config = $class->config->{ setup_components };
2450 my @comps = $class->locate_components($config);
2451 my %comps = map { $_ => 1 } @comps;
2453 my $deprecatedcatalyst_component_names = grep { /::[CMV]::/ } @comps;
2454 $class->log->warn(qq{Your application is using the deprecated ::[MVC]:: type naming scheme.\n}.
2455 qq{Please switch your class names to ::Model::, ::View:: and ::Controller: as appropriate.\n}
2456 ) if $deprecatedcatalyst_component_names;
2458 for my $component ( @comps ) {
2460 # We pass ignore_loaded here so that overlay files for (e.g.)
2461 # Model::DBI::Schema sub-classes are loaded - if it's in @comps
2462 # we know M::P::O found a file on disk so this is safe
2464 Catalyst::Utils::ensure_class_loaded( $component, { ignore_loaded => 1 } );
2467 for my $component (@comps) {
2468 my $instance = $class->components->{ $component } = $class->setup_component($component);
2469 my @expanded_components = $instance->can('expand_modules')
2470 ? $instance->expand_modules( $component, $config )
2471 : $class->expand_component_module( $component, $config );
2472 for my $component (@expanded_components) {
2473 next if $comps{$component};
2474 $class->components->{ $component } = $class->setup_component($component);
2479 =head2 $c->locate_components( $setup_component_config )
2481 This method is meant to provide a list of component modules that should be
2482 setup for the application. By default, it will use L<Module::Pluggable>.
2484 Specify a C<setup_components> config option to pass additional options directly
2485 to L<Module::Pluggable>. To add additional search paths, specify a key named
2486 C<search_extra> as an array reference. Items in the array beginning with C<::>
2487 will have the application class name prepended to them.
2491 sub locate_components {
2495 my @paths = qw( ::Controller ::C ::Model ::M ::View ::V );
2496 my $extra = delete $config->{ search_extra } || [];
2498 push @paths, @$extra;
2500 my $locator = Module::Pluggable::Object->new(
2501 search_path => [ map { s/^(?=::)/$class/; $_; } @paths ],
2505 # XXX think about ditching this sort entirely
2506 my @comps = sort { length $a <=> length $b } $locator->plugins;
2511 =head2 $c->expand_component_module( $component, $setup_component_config )
2513 Components found by C<locate_components> will be passed to this method, which
2514 is expected to return a list of component (package) names to be set up.
2518 sub expand_component_module {
2519 my ($class, $module) = @_;
2520 return Devel::InnerPackage::list_packages( $module );
2523 =head2 $c->setup_component
2527 sub setup_component {
2528 my( $class, $component ) = @_;
2530 unless ( $component->can( 'COMPONENT' ) ) {
2534 my $suffix = Catalyst::Utils::class2classsuffix( $component );
2535 my $config = $class->config->{ $suffix } || {};
2536 # Stash catalyst_component_name in the config here, so that custom COMPONENT
2537 # methods also pass it. local to avoid pointlessly shitting in config
2538 # for the debug screen, as $component is already the key name.
2539 local $config->{catalyst_component_name} = $component;
2541 my $instance = eval { $component->COMPONENT( $class, $config ); };
2543 if ( my $error = $@ ) {
2545 Catalyst::Exception->throw(
2546 message => qq/Couldn't instantiate component "$component", "$error"/
2550 unless (blessed $instance) {
2551 my $metaclass = Moose::Util::find_meta($component);
2552 my $method_meta = $metaclass->find_method_by_name('COMPONENT');
2553 my $component_method_from = $method_meta->associated_metaclass->name;
2554 my $value = defined($instance) ? $instance : 'undef';
2555 Catalyst::Exception->throw(
2557 qq/Couldn't instantiate component "$component", COMPONENT() method (from $component_method_from) didn't return an object-like value (value was $value)./
2563 =head2 $c->setup_dispatcher
2569 sub setup_dispatcher {
2570 my ( $class, $dispatcher ) = @_;
2573 $dispatcher = 'Catalyst::Dispatcher::' . $dispatcher;
2576 if ( my $env = Catalyst::Utils::env_value( $class, 'DISPATCHER' ) ) {
2577 $dispatcher = 'Catalyst::Dispatcher::' . $env;
2580 unless ($dispatcher) {
2581 $dispatcher = $class->dispatcher_class;
2584 Class::MOP::load_class($dispatcher);
2586 # dispatcher instance
2587 $class->dispatcher( $dispatcher->new );
2590 =head2 $c->setup_engine
2598 $class->engine_loader->catalyst_engine_class(@_);
2604 $class->engine_loader(Catalyst::EngineLoader->new(application_name => $class));
2606 my $engine = $class->engine_class;
2607 Class::MOP::load_class($engine);
2609 if ($ENV{MOD_PERL}) {
2610 my $apache = $class->engine_loader->auto;
2612 $class->meta->add_method(handler => sub {
2614 my $psgi_app = $class->psgi_app;
2615 $apache->call_app($r, $psgi_app);
2619 $class->engine( $engine->new );
2624 sub _finalized_psgi_app {
2627 unless ($app->_psgi_app) {
2628 my $psgi_app = $app->_setup_psgi_app;
2629 $app->_psgi_app($psgi_app);
2632 return $app->_psgi_app;
2635 sub _setup_psgi_app {
2638 if (my $home = Path::Class::Dir->new($app->config->{home})) {
2639 my $psgi_file = $home->file(
2640 Catalyst::Utils::appprefix($app) . '.psgi',
2643 return Plack::Util::load_psgi($psgi_file)
2647 return $app->_wrapped_legacy_psgi_app($app->psgi_app);
2650 # Note - this is for back compatibility. Catalyst should not know or care about
2651 # how it's deployed. The recommended way of configuring this is now to
2652 # use the ReverseProxy middleware yourself if you want it in a .psgi
2654 sub _wrapped_legacy_psgi_app {
2655 my ($app, $psgi_app) = @_;
2657 $psgi_app = Plack::Middleware::Conditional->wrap(
2659 builder => sub { Plack::Middleware::ReverseProxy->wrap($_[0]) },
2662 return if $app->config->{ignore_frontend_proxy};
2663 return $env->{REMOTE_ADDR} eq '127.0.0.1'
2664 || $app->config->{using_frontend_proxy};
2668 # If we're running under Lighttpd, swap PATH_INFO and SCRIPT_NAME
2669 # http://lists.scsys.co.uk/pipermail/catalyst/2006-June/008361.html
2670 # Thanks to Mark Blythe for this fix
2672 # Note that this has probably the same effect as
2673 # Plack::Middleware::LighttpdScriptNameFix and we should switch to that if
2675 $psgi_app = Plack::Middleware::Conditional->wrap(
2681 $env->{PATH_INFO} ||= delete $env->{SCRIPT_NAME};
2682 return $to_wrap->($env);
2687 my $server = $env->{SERVER_SOFTWARE};
2688 return unless $server;
2689 return $server =~ /lighttpd/ ? 1 : 0;
2698 Returns a PSGI application code reference for the catalyst application
2699 C<$c>. This is the bare application without any middlewares
2700 applied. C<${myapp}.psgi> is not taken into account.
2702 This is what you want to be using to retrieve the PSGI application code
2703 reference of your Catalyst application for use in F<.psgi> files.
2709 return $app->engine->build_psgi_app($app);
2712 =head2 $c->setup_home
2714 Sets up the home directory.
2719 my ( $class, $home ) = @_;
2721 if ( my $env = Catalyst::Utils::env_value( $class, 'HOME' ) ) {
2725 $home ||= Catalyst::Utils::home($class);
2728 #I remember recently being scolded for assigning config values like this
2729 $class->config->{home} ||= $home;
2730 $class->config->{root} ||= Path::Class::Dir->new($home)->subdir('root');
2734 =head2 $c->setup_log
2736 Sets up log by instantiating a L<Catalyst::Log|Catalyst::Log> object and
2737 passing it to C<log()>. Pass in a comma-delimited list of levels to set the
2740 This method also installs a C<debug> method that returns a true value into the
2741 catalyst subclass if the "debug" level is passed in the comma-delimited list,
2742 or if the C<$CATALYST_DEBUG> environment variable is set to a true value.
2744 Note that if the log has already been setup, by either a previous call to
2745 C<setup_log> or by a call such as C<< __PACKAGE__->log( MyLogger->new ) >>,
2746 that this method won't actually set up the log object.
2751 my ( $class, $levels ) = @_;
2754 $levels =~ s/^\s+//;
2755 $levels =~ s/\s+$//;
2756 my %levels = map { $_ => 1 } split /\s*,\s*/, $levels;
2758 my $env_debug = Catalyst::Utils::env_value( $class, 'DEBUG' );
2759 if ( defined $env_debug ) {
2760 $levels{debug} = 1 if $env_debug; # Ugly!
2761 delete($levels{debug}) unless $env_debug;
2764 unless ( $class->log ) {
2765 $class->log( Catalyst::Log->new(keys %levels) );
2768 if ( $levels{debug} ) {
2769 Class::MOP::get_metaclass_by_name($class)->add_method('debug' => sub { 1 });
2770 $class->log->debug('Debug messages enabled');
2774 =head2 $c->setup_plugins
2780 =head2 $c->setup_stats
2782 Sets up timing statistics class.
2787 my ( $class, $stats ) = @_;
2789 Catalyst::Utils::ensure_class_loaded($class->stats_class);
2791 my $env = Catalyst::Utils::env_value( $class, 'STATS' );
2792 if ( defined($env) ? $env : ($stats || $class->debug ) ) {
2793 Class::MOP::get_metaclass_by_name($class)->add_method('use_stats' => sub { 1 });
2794 $class->log->debug('Statistics enabled');
2799 =head2 $c->registered_plugins
2801 Returns a sorted list of the plugins which have either been stated in the
2802 import list or which have been added via C<< MyApp->plugin(@args); >>.
2804 If passed a given plugin name, it will report a boolean value indicating
2805 whether or not that plugin is loaded. A fully qualified name is required if
2806 the plugin name does not begin with C<Catalyst::Plugin::>.
2808 if ($c->registered_plugins('Some::Plugin')) {
2816 sub registered_plugins {
2818 return sort keys %{ $proto->_plugins } unless @_;
2820 return 1 if exists $proto->_plugins->{$plugin};
2821 return exists $proto->_plugins->{"Catalyst::Plugin::$plugin"};
2824 sub _register_plugin {
2825 my ( $proto, $plugin, $instant ) = @_;
2826 my $class = ref $proto || $proto;
2828 Class::MOP::load_class( $plugin );
2829 $class->log->warn( "$plugin inherits from 'Catalyst::Component' - this is decated and will not work in 5.81" )
2830 if $plugin->isa( 'Catalyst::Component' );
2831 $proto->_plugins->{$plugin} = 1;
2833 my $meta = Class::MOP::get_metaclass_by_name($class);
2834 $meta->superclasses($plugin, $meta->superclasses);
2840 my ( $class, $plugins ) = @_;
2842 $class->_plugins( {} ) unless $class->_plugins;
2843 $plugins = Data::OptList::mkopt($plugins || []);
2846 [ Catalyst::Utils::resolve_namespace(
2847 $class . '::Plugin',
2848 'Catalyst::Plugin', $_->[0]
2854 for my $plugin ( reverse @plugins ) {
2855 Class::MOP::load_class($plugin->[0], $plugin->[1]);
2856 my $meta = find_meta($plugin->[0]);
2857 next if $meta && $meta->isa('Moose::Meta::Role');
2859 $class->_register_plugin($plugin->[0]);
2863 map { $_->[0]->name, $_->[1] }
2864 grep { blessed($_->[0]) && $_->[0]->isa('Moose::Meta::Role') }
2865 map { [find_meta($_->[0]), $_->[1]] }
2868 Moose::Util::apply_all_roles(
2876 Returns an arrayref of the internal execution stack (actions that are
2877 currently executing).
2881 Returns the current timing statistics object. By default Catalyst uses
2882 L<Catalyst::Stats|Catalyst::Stats>, but can be set otherwise with
2883 L<< stats_class|/"$c->stats_class" >>.
2885 Even if L<< -Stats|/"-Stats" >> is not enabled, the stats object is still
2886 available. By enabling it with C< $c->stats->enabled(1) >, it can be used to
2887 profile explicitly, although MyApp.pm still won't profile nor output anything
2890 =head2 $c->stats_class
2892 Returns or sets the stats (timing statistics) class. L<Catalyst::Stats|Catalyst::Stats> is used by default.
2894 =head2 $c->use_stats
2896 Returns 1 when L<< stats collection|/"-Stats" >> is enabled.
2898 Note that this is a static method, not an accessor and should be overridden
2899 by declaring C<sub use_stats { 1 }> in your MyApp.pm, not by calling C<< $c->use_stats(1) >>.
2906 =head2 $c->write( $data )
2908 Writes $data to the output stream. When using this method directly, you
2909 will need to manually set the C<Content-Length> header to the length of
2910 your output data, if known.
2917 # Finalize headers if someone manually writes output
2918 $c->finalize_headers;
2920 return $c->engine->write( $c, @_ );
2925 Returns the Catalyst version number. Mostly useful for "powered by"
2926 messages in template systems.
2930 sub version { return $Catalyst::VERSION }
2932 =head1 CONFIGURATION
2934 There are a number of 'base' config variables which can be set:
2940 C<default_model> - The default model picked if you say C<< $c->model >>. See L<< /$c->model($name) >>.
2944 C<default_view> - The default view to be rendered or returned when C<< $c->view >> is called. See L<< /$c->view($name) >>.
2948 C<disable_component_resolution_regex_fallback> - Turns
2949 off the deprecated component resolution functionality so
2950 that if any of the component methods (e.g. C<< $c->controller('Foo') >>)
2951 are called then regex search will not be attempted on string values and
2952 instead C<undef> will be returned.
2956 C<home> - The application home directory. In an uninstalled application,
2957 this is the top level application directory. In an installed application,
2958 this will be the directory containing C<< MyApp.pm >>.
2962 C<ignore_frontend_proxy> - See L</PROXY SUPPORT>
2966 C<name> - The name of the application in debug messages and the debug and
2971 C<parse_on_demand> - The request body (for example file uploads) will not be parsed
2972 until it is accessed. This allows you to (for example) check authentication (and reject
2973 the upload) before actually recieving all the data. See L</ON-DEMAND PARSER>
2977 C<root> - The root directory for templates. Usually this is just a
2978 subdirectory of the home directory, but you can set it to change the
2979 templates to a different directory.
2983 C<search_extra> - Array reference passed to Module::Pluggable to for additional
2984 namespaces from which components will be loaded (and constructed and stored in
2985 C<< $c->components >>).
2989 C<show_internal_actions> - If true, causes internal actions such as C<< _DISPATCH >>
2990 to be shown in hit debug tables in the test server.
2994 C<use_request_uri_for_path> - Controlls if the C<REQUEST_URI> or C<PATH_INFO> environment
2995 variable should be used for determining the request path. See L<Catalyst::Engine::CGI/PATH DECODING>
2996 for more information.
3000 C<using_frontend_proxy> - See L</PROXY SUPPORT>.
3004 =head1 INTERNAL ACTIONS
3006 Catalyst uses internal actions like C<_DISPATCH>, C<_BEGIN>, C<_AUTO>,
3007 C<_ACTION>, and C<_END>. These are by default not shown in the private
3008 action table, but you can make them visible with a config parameter.
3010 MyApp->config(show_internal_actions => 1);
3012 =head1 ON-DEMAND PARSER
3014 The request body is usually parsed at the beginning of a request,
3015 but if you want to handle input yourself, you can enable on-demand
3016 parsing with a config parameter.
3018 MyApp->config(parse_on_demand => 1);
3020 =head1 PROXY SUPPORT
3022 Many production servers operate using the common double-server approach,
3023 with a lightweight frontend web server passing requests to a larger
3024 backend server. An application running on the backend server must deal
3025 with two problems: the remote user always appears to be C<127.0.0.1> and
3026 the server's hostname will appear to be C<localhost> regardless of the
3027 virtual host that the user connected through.
3029 Catalyst will automatically detect this situation when you are running
3030 the frontend and backend servers on the same machine. The following
3031 changes are made to the request.
3033 $c->req->address is set to the user's real IP address, as read from
3034 the HTTP X-Forwarded-For header.
3036 The host value for $c->req->base and $c->req->uri is set to the real
3037 host, as read from the HTTP X-Forwarded-Host header.
3039 Additionally, you may be running your backend application on an insecure
3040 connection (port 80) while your frontend proxy is running under SSL. If there
3041 is a discrepancy in the ports, use the HTTP header C<X-Forwarded-Port> to
3042 tell Catalyst what port the frontend listens on. This will allow all URIs to
3043 be created properly.
3045 In the case of passing in:
3047 X-Forwarded-Port: 443
3049 All calls to C<uri_for> will result in an https link, as is expected.
3051 Obviously, your web server must support these headers for this to work.
3053 In a more complex server farm environment where you may have your
3054 frontend proxy server(s) on different machines, you will need to set a
3055 configuration option to tell Catalyst to read the proxied data from the
3058 MyApp->config(using_frontend_proxy => 1);
3060 If you do not wish to use the proxy support at all, you may set:
3062 MyApp->config(ignore_frontend_proxy => 1);
3064 =head1 THREAD SAFETY
3066 Catalyst has been tested under Apache 2's threading C<mpm_worker>,
3067 C<mpm_winnt>, and the standalone forking HTTP server on Windows. We
3068 believe the Catalyst core to be thread-safe.
3070 If you plan to operate in a threaded environment, remember that all other
3071 modules you are using must also be thread-safe. Some modules, most notably
3072 L<DBD::SQLite>, are not thread-safe.
3078 Join #catalyst on irc.perl.org.
3082 http://lists.scsys.co.uk/cgi-bin/mailman/listinfo/catalyst
3083 http://lists.scsys.co.uk/cgi-bin/mailman/listinfo/catalyst-dev
3087 http://catalyst.perl.org
3091 http://dev.catalyst.perl.org
3095 =head2 L<Task::Catalyst> - All you need to start with Catalyst
3097 =head2 L<Catalyst::Manual> - The Catalyst Manual
3099 =head2 L<Catalyst::Component>, L<Catalyst::Controller> - Base classes for components
3101 =head2 L<Catalyst::Engine> - Core engine
3103 =head2 L<Catalyst::Log> - Log class.
3105 =head2 L<Catalyst::Request> - Request object
3107 =head2 L<Catalyst::Response> - Response object
3109 =head2 L<Catalyst::Test> - The test suite.
3111 =head1 PROJECT FOUNDER
3113 sri: Sebastian Riedel <sri@cpan.org>
3119 acme: Leon Brocard <leon@astray.com>
3121 abraxxa: Alexander Hartmaier <abraxxa@cpan.org>
3125 Andrew Ford E<lt>A.Ford@ford-mason.co.ukE<gt>
3129 andyg: Andy Grundman <andy@hybridized.org>
3131 audreyt: Audrey Tang
3133 bricas: Brian Cassidy <bricas@cpan.org>
3135 Caelum: Rafael Kitover <rkitover@io.com>
3137 chansen: Christian Hansen
3139 chicks: Christopher Hicks
3141 Chisel Wright C<pause@herlpacker.co.uk>
3143 Danijel Milicevic C<me@danijel.de>
3145 David Kamholz E<lt>dkamholz@cpan.orgE<gt>
3147 David Naughton, C<naughton@umn.edu>
3151 dhoss: Devin Austin <dhoss@cpan.org>
3153 dkubb: Dan Kubb <dan.kubb-cpan@onautopilot.com>
3157 dwc: Daniel Westermann-Clark <danieltwc@cpan.org>
3159 esskar: Sascha Kiefer
3161 fireartist: Carl Franks <cfranks@cpan.org>
3163 frew: Arthur Axel "fREW" Schmidt <frioux@gmail.com>
3165 gabb: Danijel Milicevic
3169 Gavin Henry C<ghenry@perl.me.uk>
3173 groditi: Guillermo Roditi <groditi@gmail.com>
3175 hobbs: Andrew Rodland <andrew@cleverdomain.org>
3177 ilmari: Dagfinn Ilmari Mannsåker <ilmari@ilmari.org>
3179 jcamacho: Juan Camacho
3181 jester: Jesse Sheidlower C<jester@panix.com>
3183 jhannah: Jay Hannah <jay@jays.net>
3189 jon: Jon Schutz <jjschutz@cpan.org>
3191 Jonathan Rockway C<< <jrockway@cpan.org> >>
3193 Kieren Diment C<kd@totaldatasolution.com>
3195 konobi: Scott McWhirter <konobi@cpan.org>
3197 marcus: Marcus Ramberg <mramberg@cpan.org>
3199 miyagawa: Tatsuhiko Miyagawa <miyagawa@bulknews.net>
3201 mst: Matt S. Trout <mst@shadowcatsystems.co.uk>
3205 naughton: David Naughton
3207 ningu: David Kamholz <dkamholz@cpan.org>
3209 nothingmuch: Yuval Kogman <nothingmuch@woobling.org>
3211 numa: Dan Sully <daniel@cpan.org>
3217 omega: Andreas Marienborg
3219 Oleg Kostyuk <cub.uanic@gmail.com>
3221 phaylon: Robert Sedlacek <phaylon@dunkelheit.at>
3223 rafl: Florian Ragwitz <rafl@debian.org>
3225 random: Roland Lammel <lammel@cpan.org>
3227 Robert Sedlacek C<< <rs@474.at> >>
3229 SpiceMan: Marcel Montes
3233 szbalint: Balint Szilakszi <szbalint@cpan.org>
3235 t0m: Tomas Doran <bobtfish@bobtfish.net>
3239 Viljo Marrandi C<vilts@yahoo.com>
3241 Will Hawes C<info@whawes.co.uk>
3243 willert: Sebastian Willert <willert@cpan.org>
3245 wreis: Wallace Reis <wallace@reis.org.br>
3247 Yuval Kogman, C<nothingmuch@woobling.org>
3249 rainboxx: Matthias Dietrich, C<perl@rainboxx.de>
3251 dd070: Dhaval Dhanani <dhaval070@gmail.com>
3255 This library is free software. You can redistribute it and/or modify it under
3256 the same terms as Perl itself.
3262 __PACKAGE__->meta->make_immutable;