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 ();
19 use Module::Pluggable::Object ();
20 use Text::SimpleTable ();
21 use Path::Class::Dir ();
22 use Path::Class::File ();
26 use Tree::Simple qw/use_weak_refs/;
27 use Tree::Simple::Visitor::FindByUID;
28 use Class::C3::Adopt::NEXT;
29 use List::MoreUtils qw/uniq/;
31 use String::RewritePrefix;
32 use Catalyst::EngineLoader;
34 use Carp qw/croak carp shortmess/;
36 use Plack::Middleware::Conditional;
37 use Plack::Middleware::ReverseProxy;
38 use Plack::Middleware::IIS6ScriptNameFix;
39 use Plack::Middleware::LighttpdScriptNameFix;
41 BEGIN { require 5.008004; }
43 has stack => (is => 'ro', default => sub { [] });
44 has stash => (is => 'rw', default => sub { {} });
45 has state => (is => 'rw', default => 0);
46 has stats => (is => 'rw');
47 has action => (is => 'rw');
48 has counter => (is => 'rw', default => sub { {} });
49 has request => (is => 'rw', default => sub { $_[0]->request_class->new({}) }, required => 1, lazy => 1);
50 has response => (is => 'rw', default => sub { $_[0]->response_class->new({}) }, required => 1, lazy => 1);
51 has namespace => (is => 'rw');
53 sub depth { scalar @{ shift->stack || [] }; }
54 sub comp { shift->component(@_) }
57 my $self = shift; return $self->request(@_);
60 my $self = shift; return $self->response(@_);
63 # For backwards compatibility
64 sub finalize_output { shift->finalize_body(@_) };
69 our $RECURSION = 1000;
70 our $DETACH = Catalyst::Exception::Detach->new;
71 our $GO = Catalyst::Exception::Go->new;
73 #I imagine that very few of these really need to be class variables. if any.
74 #maybe we should just make them attributes with a default?
75 __PACKAGE__->mk_classdata($_)
76 for qw/components arguments dispatcher engine log dispatcher_class
77 engine_loader context_class request_class response_class stats_class
78 setup_finished _psgi_app/;
80 __PACKAGE__->dispatcher_class('Catalyst::Dispatcher');
81 __PACKAGE__->request_class('Catalyst::Request');
82 __PACKAGE__->response_class('Catalyst::Response');
83 __PACKAGE__->stats_class('Catalyst::Stats');
85 # Remember to update this in Catalyst::Runtime as well!
87 our $VERSION = '5.89002';
90 my ( $class, @arguments ) = @_;
92 # We have to limit $class to Catalyst to avoid pushing Catalyst upon every
94 return unless $class eq 'Catalyst';
96 my $caller = caller();
97 return if $caller eq 'main';
99 my $meta = Moose::Meta::Class->initialize($caller);
100 unless ( $caller->isa('Catalyst') ) {
101 my @superclasses = ($meta->superclasses, $class, 'Catalyst::Controller');
102 $meta->superclasses(@superclasses);
104 # Avoid possible C3 issues if 'Moose::Object' is already on RHS of MyApp
105 $meta->superclasses(grep { $_ ne 'Moose::Object' } $meta->superclasses);
107 unless( $meta->has_method('meta') ){
108 if ($Moose::VERSION >= 1.15) {
109 $meta->_add_meta_method('meta');
112 $meta->add_method(meta => sub { Moose::Meta::Class->initialize("${caller}") } );
116 $caller->arguments( [@arguments] );
120 sub _application { $_[0] }
124 Catalyst - The Elegant MVC Web Application Framework
128 See the L<Catalyst::Manual> distribution for comprehensive
129 documentation and tutorials.
131 # Install Catalyst::Devel for helpers and other development tools
132 # use the helper to create a new application
135 # add models, views, controllers
136 script/myapp_create.pl model MyDatabase DBIC::Schema create=static dbi:SQLite:/path/to/db
137 script/myapp_create.pl view MyTemplate TT
138 script/myapp_create.pl controller Search
140 # built in testserver -- use -r to restart automatically on changes
141 # --help to see all available options
142 script/myapp_server.pl
144 # command line testing interface
145 script/myapp_test.pl /yada
148 use Catalyst qw/-Debug/; # include plugins here as well
150 ### In lib/MyApp/Controller/Root.pm (autocreated)
151 sub foo : Global { # called for /foo, /foo/1, /foo/1/2, etc.
152 my ( $self, $c, @args ) = @_; # args are qw/1 2/ for /foo/1/2
153 $c->stash->{template} = 'foo.tt'; # set the template
154 # lookup something from db -- stash vars are passed to TT
156 $c->model('Database::Foo')->search( { country => $args[0] } );
157 if ( $c->req->params->{bar} ) { # access GET or POST parameters
158 $c->forward( 'bar' ); # process another action
159 # do something else after forward returns
163 # The foo.tt TT template can use the stash data from the database
164 [% WHILE (item = data.next) %]
168 # called for /bar/of/soap, /bar/of/soap/10, etc.
169 sub bar : Path('/bar/of/soap') { ... }
171 # called for all actions, from the top-most controller downwards
173 my ( $self, $c ) = @_;
174 if ( !$c->user_exists ) { # Catalyst::Plugin::Authentication
175 $c->res->redirect( '/login' ); # require login
176 return 0; # abort request and go immediately to end()
178 return 1; # success; carry on to next action
181 # called after all actions are finished
183 my ( $self, $c ) = @_;
184 if ( scalar @{ $c->error } ) { ... } # handle errors
185 return if $c->res->body; # already have a response
186 $c->forward( 'MyApp::View::TT' ); # render template
189 ### in MyApp/Controller/Foo.pm
190 # called for /foo/bar
191 sub bar : Local { ... }
193 # called for /blargle
194 sub blargle : Global { ... }
196 # an index action matches /foo, but not /foo/1, etc.
197 sub index : Private { ... }
199 ### in MyApp/Controller/Foo/Bar.pm
200 # called for /foo/bar/baz
201 sub baz : Local { ... }
203 # first Root auto is called, then Foo auto, then this
204 sub auto : Private { ... }
206 # powerful regular expression paths are also possible
207 sub details : Regex('^product/(\w+)/details$') {
208 my ( $self, $c ) = @_;
209 # extract the (\w+) from the URI
210 my $product = $c->req->captures->[0];
213 See L<Catalyst::Manual::Intro> for additional information.
217 Catalyst is a modern framework for making web applications without the
218 pain usually associated with this process. This document is a reference
219 to the main Catalyst application. If you are a new user, we suggest you
220 start with L<Catalyst::Manual::Tutorial> or L<Catalyst::Manual::Intro>.
222 See L<Catalyst::Manual> for more documentation.
224 Catalyst plugins can be loaded by naming them as arguments to the "use
225 Catalyst" statement. Omit the C<Catalyst::Plugin::> prefix from the
226 plugin name, i.e., C<Catalyst::Plugin::My::Module> becomes
229 use Catalyst qw/My::Module/;
231 If your plugin starts with a name other than C<Catalyst::Plugin::>, you can
232 fully qualify the name by using a unary plus:
236 +Fully::Qualified::Plugin::Name
239 Special flags like C<-Debug> and C<-Engine> can also be specified as
240 arguments when Catalyst is loaded:
242 use Catalyst qw/-Debug My::Module/;
244 The position of plugins and flags in the chain is important, because
245 they are loaded in the order in which they appear.
247 The following flags are supported:
251 Enables debug output. You can also force this setting from the system
252 environment with CATALYST_DEBUG or <MYAPP>_DEBUG. The environment
253 settings override the application, with <MYAPP>_DEBUG having the highest
256 This sets the log level to 'debug' and enables full debug output on the
257 error screen. If you only want the latter, see L<< $c->debug >>.
261 Forces Catalyst to use a specific engine. Omit the
262 C<Catalyst::Engine::> prefix of the engine name, i.e.:
264 use Catalyst qw/-Engine=CGI/;
268 Forces Catalyst to use a specific home directory, e.g.:
270 use Catalyst qw[-Home=/usr/mst];
272 This can also be done in the shell environment by setting either the
273 C<CATALYST_HOME> environment variable or C<MYAPP_HOME>; where C<MYAPP>
274 is replaced with the uppercased name of your application, any "::" in
275 the name will be replaced with underscores, e.g. MyApp::Web should use
276 MYAPP_WEB_HOME. If both variables are set, the MYAPP_HOME one will be used.
278 If none of these are set, Catalyst will attempt to automatically detect the
279 home directory. If you are working in a development envirnoment, Catalyst
280 will try and find the directory containing either Makefile.PL, Build.PL or
281 dist.ini. If the application has been installed into the system (i.e.
282 you have done C<make install>), then Catalyst will use the path to your
283 application module, without the .pm extension (ie, /foo/MyApp if your
284 application was installed at /foo/MyApp.pm)
288 use Catalyst '-Log=warn,fatal,error';
290 Specifies a comma-delimited list of log levels.
294 Enables statistics collection and reporting.
296 use Catalyst qw/-Stats=1/;
298 You can also force this setting from the system environment with CATALYST_STATS
299 or <MYAPP>_STATS. The environment settings override the application, with
300 <MYAPP>_STATS having the highest priority.
302 Stats are also enabled if L<< debugging |/"-Debug" >> is enabled.
306 =head2 INFORMATION ABOUT THE CURRENT REQUEST
310 Returns a L<Catalyst::Action> object for the current action, which
311 stringifies to the action name. See L<Catalyst::Action>.
315 Returns the namespace of the current action, i.e., the URI prefix
316 corresponding to the controller of the current action. For example:
318 # in Controller::Foo::Bar
319 $c->namespace; # returns 'foo/bar';
325 Returns the current L<Catalyst::Request> object, giving access to
326 information about the current client request (including parameters,
327 cookies, HTTP headers, etc.). See L<Catalyst::Request>.
329 =head2 REQUEST FLOW HANDLING
331 =head2 $c->forward( $action [, \@arguments ] )
333 =head2 $c->forward( $class, $method, [, \@arguments ] )
335 Forwards processing to another action, by its private name. If you give a
336 class name but no method, C<process()> is called. You may also optionally
337 pass arguments in an arrayref. The action will receive the arguments in
338 C<@_> and C<< $c->req->args >>. Upon returning from the function,
339 C<< $c->req->args >> will be restored to the previous values.
341 Any data C<return>ed from the action forwarded to, will be returned by the
344 my $foodata = $c->forward('/foo');
345 $c->forward('index');
346 $c->forward(qw/Model::DBIC::Foo do_stuff/);
347 $c->forward('View::TT');
349 Note that L<< forward|/"$c->forward( $action [, \@arguments ] )" >> implies
350 an C<< eval { } >> around the call (actually
351 L<< execute|/"$c->execute( $class, $coderef )" >> does), thus de-fatalizing
352 all 'dies' within the called action. If you want C<die> to propagate you
353 need to do something like:
356 die join "\n", @{ $c->error } if @{ $c->error };
358 Or make sure to always return true values from your actions and write
361 $c->forward('foo') || return;
363 Another note is that C<< $c->forward >> always returns a scalar because it
364 actually returns $c->state which operates in a scalar context.
365 Thus, something like:
369 in an action that is forwarded to is going to return a scalar,
370 i.e. how many items are in that array, which is probably not what you want.
371 If you need to return an array then return a reference to it,
374 $c->stash->{array} = \@array;
376 and access it from the stash.
378 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.
382 sub forward { my $c = shift; no warnings 'recursion'; $c->dispatcher->forward( $c, @_ ) }
384 =head2 $c->detach( $action [, \@arguments ] )
386 =head2 $c->detach( $class, $method, [, \@arguments ] )
390 The same as L<< forward|/"$c->forward( $action [, \@arguments ] )" >>, but
391 doesn't return to the previous action when processing is finished.
393 When called with no arguments it escapes the processing chain entirely.
397 sub detach { my $c = shift; $c->dispatcher->detach( $c, @_ ) }
399 =head2 $c->visit( $action [, \@captures, \@arguments ] )
401 =head2 $c->visit( $class, $method, [, \@captures, \@arguments ] )
403 Almost the same as L<< forward|/"$c->forward( $action [, \@arguments ] )" >>,
404 but does a full dispatch, instead of just calling the new C<$action> /
405 C<< $class->$method >>. This means that C<begin>, C<auto> and the method
406 you go to are called, just like a new request.
408 In addition both C<< $c->action >> and C<< $c->namespace >> are localized.
409 This means, for example, that C<< $c->action >> methods such as
410 L<name|Catalyst::Action/name>, L<class|Catalyst::Action/class> and
411 L<reverse|Catalyst::Action/reverse> return information for the visited action
412 when they are invoked within the visited action. This is different from the
413 behavior of L<< forward|/"$c->forward( $action [, \@arguments ] )" >>, which
414 continues to use the $c->action object from the caller action even when
415 invoked from the callee.
417 C<< $c->stash >> is kept unchanged.
419 In effect, L<< visit|/"$c->visit( $action [, \@captures, \@arguments ] )" >>
420 allows you to "wrap" another action, just as it would have been called by
421 dispatching from a URL, while the analogous
422 L<< go|/"$c->go( $action [, \@captures, \@arguments ] )" >> allows you to
423 transfer control to another action as if it had been reached directly from a URL.
427 sub visit { my $c = shift; $c->dispatcher->visit( $c, @_ ) }
429 =head2 $c->go( $action [, \@captures, \@arguments ] )
431 =head2 $c->go( $class, $method, [, \@captures, \@arguments ] )
433 The relationship between C<go> and
434 L<< visit|/"$c->visit( $action [, \@captures, \@arguments ] )" >> is the same as
435 the relationship between
436 L<< forward|/"$c->forward( $class, $method, [, \@arguments ] )" >> and
437 L<< detach|/"$c->detach( $action [, \@arguments ] )" >>. Like C<< $c->visit >>,
438 C<< $c->go >> will perform a full dispatch on the specified action or method,
439 with localized C<< $c->action >> and C<< $c->namespace >>. Like C<detach>,
440 C<go> escapes the processing of the current request chain on completion, and
441 does not return to its caller.
443 @arguments are arguments to the final destination of $action. @captures are
444 arguments to the intermediate steps, if any, on the way to the final sub of
449 sub go { my $c = shift; $c->dispatcher->go( $c, @_ ) }
455 Returns the current L<Catalyst::Response> object, see there for details.
459 Returns a hashref to the stash, which may be used to store data and pass
460 it between components during a request. You can also set hash keys by
461 passing arguments. The stash is automatically sent to the view. The
462 stash is cleared at the end of a request; it cannot be used for
463 persistent storage (for this you must use a session; see
464 L<Catalyst::Plugin::Session> for a complete system integrated with
467 $c->stash->{foo} = $bar;
468 $c->stash( { moose => 'majestic', qux => 0 } );
469 $c->stash( bar => 1, gorch => 2 ); # equivalent to passing a hashref
471 # stash is automatically passed to the view for use in a template
472 $c->forward( 'MyApp::View::TT' );
476 around stash => sub {
479 my $stash = $orig->($c);
481 my $new_stash = @_ > 1 ? {@_} : $_[0];
482 croak('stash takes a hash or hashref') unless ref $new_stash;
483 foreach my $key ( keys %$new_stash ) {
484 $stash->{$key} = $new_stash->{$key};
494 =head2 $c->error($error, ...)
496 =head2 $c->error($arrayref)
498 Returns an arrayref containing error messages. If Catalyst encounters an
499 error while processing a request, it stores the error in $c->error. This
500 method should only be used to store fatal error messages.
502 my @error = @{ $c->error };
506 $c->error('Something bad happened');
513 my $error = ref $_[0] eq 'ARRAY' ? $_[0] : [@_];
514 croak @$error unless ref $c;
515 push @{ $c->{error} }, @$error;
517 elsif ( defined $_[0] ) { $c->{error} = undef }
518 return $c->{error} || [];
524 Contains the return value of the last executed action.
525 Note that << $c->state >> operates in a scalar context which means that all
526 values it returns are scalar.
528 =head2 $c->clear_errors
530 Clear errors. You probably don't want to clear the errors unless you are
531 implementing a custom error screen.
533 This is equivalent to running
544 sub _comp_search_prefixes {
546 return map $c->components->{ $_ }, $c->_comp_names_search_prefixes(@_);
549 # search components given a name and some prefixes
550 sub _comp_names_search_prefixes {
551 my ( $c, $name, @prefixes ) = @_;
552 my $appclass = ref $c || $c;
553 my $filter = "^${appclass}::(" . join( '|', @prefixes ) . ')::';
554 $filter = qr/$filter/; # Compile regex now rather than once per loop
556 # map the original component name to the sub part that we will search against
557 my %eligible = map { my $n = $_; $n =~ s{^$appclass\::[^:]+::}{}; $_ => $n; }
558 grep { /$filter/ } keys %{ $c->components };
560 # undef for a name will return all
561 return keys %eligible if !defined $name;
563 my $query = ref $name ? $name : qr/^$name$/i;
564 my @result = grep { $eligible{$_} =~ m{$query} } keys %eligible;
566 return @result if @result;
568 # if we were given a regexp to search against, we're done.
571 # skip regexp fallback if configured
573 if $appclass->config->{disable_component_resolution_regex_fallback};
577 @result = grep { $eligible{ $_ } =~ m{$query} } keys %eligible;
579 # no results? try against full names
581 @result = grep { m{$query} } keys %eligible;
584 # don't warn if we didn't find any results, it just might not exist
586 # Disgusting hack to work out correct method name
587 my $warn_for = lc $prefixes[0];
588 my $msg = "Used regexp fallback for \$c->${warn_for}('${name}'), which found '" .
589 (join '", "', @result) . "'. Relying on regexp fallback behavior for " .
590 "component resolution is unreliable and unsafe.";
591 my $short = $result[0];
592 # remove the component namespace prefix
593 $short =~ s/.*?(Model|Controller|View):://;
594 my $shortmess = Carp::shortmess('');
595 if ($shortmess =~ m#Catalyst/Plugin#) {
596 $msg .= " You probably need to set '$short' instead of '${name}' in this " .
598 } elsif ($shortmess =~ m#Catalyst/lib/(View|Controller)#) {
599 $msg .= " You probably need to set '$short' instead of '${name}' in this " .
600 "component's config";
602 $msg .= " You probably meant \$c->${warn_for}('$short') instead of \$c->${warn_for}('${name}'), " .
603 "but if you really wanted to search, pass in a regexp as the argument " .
604 "like so: \$c->${warn_for}(qr/${name}/)";
606 $c->log->warn( "${msg}$shortmess" );
612 # Find possible names for a prefix
614 my ( $c, @prefixes ) = @_;
615 my $appclass = ref $c || $c;
617 my $filter = "^${appclass}::(" . join( '|', @prefixes ) . ')::';
619 my @names = map { s{$filter}{}; $_; }
620 $c->_comp_names_search_prefixes( undef, @prefixes );
625 # Filter a component before returning by calling ACCEPT_CONTEXT if available
626 sub _filter_component {
627 my ( $c, $comp, @args ) = @_;
629 if ( eval { $comp->can('ACCEPT_CONTEXT'); } ) {
630 return $comp->ACCEPT_CONTEXT( $c, @args );
636 =head2 COMPONENT ACCESSORS
638 =head2 $c->controller($name)
640 Gets a L<Catalyst::Controller> instance by name.
642 $c->controller('Foo')->do_stuff;
644 If the name is omitted, will return the controller for the dispatched
647 If you want to search for controllers, pass in a regexp as the argument.
649 # find all controllers that start with Foo
650 my @foo_controllers = $c->controller(qr{^Foo});
656 my ( $c, $name, @args ) = @_;
658 my $appclass = ref($c) || $c;
660 unless ( ref($name) ) { # Direct component hash lookup to avoid costly regexps
661 my $comps = $c->components;
662 my $check = $appclass."::Controller::".$name;
663 return $c->_filter_component( $comps->{$check}, @args ) if exists $comps->{$check};
665 my @result = $c->_comp_search_prefixes( $name, qw/Controller C/ );
666 return map { $c->_filter_component( $_, @args ) } @result if ref $name;
667 return $c->_filter_component( $result[ 0 ], @args );
670 return $c->component( $c->action->class );
673 =head2 $c->model($name)
675 Gets a L<Catalyst::Model> instance by name.
677 $c->model('Foo')->do_stuff;
679 Any extra arguments are directly passed to ACCEPT_CONTEXT.
681 If the name is omitted, it will look for
682 - a model object in $c->stash->{current_model_instance}, then
683 - a model name in $c->stash->{current_model}, then
684 - a config setting 'default_model', or
685 - check if there is only one model, and return it if that's the case.
687 If you want to search for models, pass in a regexp as the argument.
689 # find all models that start with Foo
690 my @foo_models = $c->model(qr{^Foo});
695 my ( $c, $name, @args ) = @_;
696 my $appclass = ref($c) || $c;
698 unless ( ref($name) ) { # Direct component hash lookup to avoid costly regexps
699 my $comps = $c->components;
700 my $check = $appclass."::Model::".$name;
701 return $c->_filter_component( $comps->{$check}, @args ) if exists $comps->{$check};
703 my @result = $c->_comp_search_prefixes( $name, qw/Model M/ );
704 return map { $c->_filter_component( $_, @args ) } @result if ref $name;
705 return $c->_filter_component( $result[ 0 ], @args );
709 return $c->stash->{current_model_instance}
710 if $c->stash->{current_model_instance};
711 return $c->model( $c->stash->{current_model} )
712 if $c->stash->{current_model};
714 return $c->model( $appclass->config->{default_model} )
715 if $appclass->config->{default_model};
717 my( $comp, $rest ) = $c->_comp_search_prefixes( undef, qw/Model M/);
720 $c->log->warn( Carp::shortmess('Calling $c->model() will return a random model unless you specify one of:') );
721 $c->log->warn( '* $c->config(default_model => "the name of the default model to use")' );
722 $c->log->warn( '* $c->stash->{current_model} # the name of the model to use for this request' );
723 $c->log->warn( '* $c->stash->{current_model_instance} # the instance of the model to use for this request' );
724 $c->log->warn( 'NB: in version 5.81, the "random" behavior will not work at all.' );
727 return $c->_filter_component( $comp );
731 =head2 $c->view($name)
733 Gets a L<Catalyst::View> instance by name.
735 $c->view('Foo')->do_stuff;
737 Any extra arguments are directly passed to ACCEPT_CONTEXT.
739 If the name is omitted, it will look for
740 - a view object in $c->stash->{current_view_instance}, then
741 - a view name in $c->stash->{current_view}, then
742 - a config setting 'default_view', or
743 - check if there is only one view, and return it if that's the case.
745 If you want to search for views, pass in a regexp as the argument.
747 # find all views that start with Foo
748 my @foo_views = $c->view(qr{^Foo});
753 my ( $c, $name, @args ) = @_;
755 my $appclass = ref($c) || $c;
757 unless ( ref($name) ) { # Direct component hash lookup to avoid costly regexps
758 my $comps = $c->components;
759 my $check = $appclass."::View::".$name;
760 if( exists $comps->{$check} ) {
761 return $c->_filter_component( $comps->{$check}, @args );
764 $c->log->warn( "Attempted to use view '$check', but does not exist" );
767 my @result = $c->_comp_search_prefixes( $name, qw/View V/ );
768 return map { $c->_filter_component( $_, @args ) } @result if ref $name;
769 return $c->_filter_component( $result[ 0 ], @args );
773 return $c->stash->{current_view_instance}
774 if $c->stash->{current_view_instance};
775 return $c->view( $c->stash->{current_view} )
776 if $c->stash->{current_view};
778 return $c->view( $appclass->config->{default_view} )
779 if $appclass->config->{default_view};
781 my( $comp, $rest ) = $c->_comp_search_prefixes( undef, qw/View V/);
784 $c->log->warn( 'Calling $c->view() will return a random view unless you specify one of:' );
785 $c->log->warn( '* $c->config(default_view => "the name of the default view to use")' );
786 $c->log->warn( '* $c->stash->{current_view} # the name of the view to use for this request' );
787 $c->log->warn( '* $c->stash->{current_view_instance} # the instance of the view to use for this request' );
788 $c->log->warn( 'NB: in version 5.81, the "random" behavior will not work at all.' );
791 return $c->_filter_component( $comp );
794 =head2 $c->controllers
796 Returns the available names which can be passed to $c->controller
802 return $c->_comp_names(qw/Controller C/);
807 Returns the available names which can be passed to $c->model
813 return $c->_comp_names(qw/Model M/);
819 Returns the available names which can be passed to $c->view
825 return $c->_comp_names(qw/View V/);
828 =head2 $c->comp($name)
830 =head2 $c->component($name)
832 Gets a component object by name. This method is not recommended,
833 unless you want to get a specific component by full
834 class. C<< $c->controller >>, C<< $c->model >>, and C<< $c->view >>
835 should be used instead.
837 If C<$name> is a regexp, a list of components matched against the full
838 component name will be returned.
840 If Catalyst can't find a component by name, it will fallback to regex
841 matching by default. To disable this behaviour set
842 disable_component_resolution_regex_fallback to a true value.
844 __PACKAGE__->config( disable_component_resolution_regex_fallback => 1 );
849 my ( $c, $name, @args ) = @_;
852 my $comps = $c->components;
855 # is it the exact name?
856 return $c->_filter_component( $comps->{ $name }, @args )
857 if exists $comps->{ $name };
859 # perhaps we just omitted "MyApp"?
860 my $composed = ( ref $c || $c ) . "::${name}";
861 return $c->_filter_component( $comps->{ $composed }, @args )
862 if exists $comps->{ $composed };
864 # search all of the models, views and controllers
865 my( $comp ) = $c->_comp_search_prefixes( $name, qw/Model M Controller C View V/ );
866 return $c->_filter_component( $comp, @args ) if $comp;
869 # This is here so $c->comp( '::M::' ) works
870 my $query = ref $name ? $name : qr{$name}i;
872 my @result = grep { m{$query} } keys %{ $c->components };
873 return map { $c->_filter_component( $_, @args ) } @result if ref $name;
876 $c->log->warn( Carp::shortmess(qq(Found results for "${name}" using regexp fallback)) );
877 $c->log->warn( 'Relying on the regexp fallback behavior for component resolution' );
878 $c->log->warn( 'is unreliable and unsafe. You have been warned' );
879 return $c->_filter_component( $result[ 0 ], @args );
882 # I would expect to return an empty list here, but that breaks back-compat
886 return sort keys %{ $c->components };
889 =head2 CLASS DATA AND HELPER CLASSES
893 Returns or takes a hashref containing the application's configuration.
895 __PACKAGE__->config( { db => 'dsn:SQLite:foo.db' } );
897 You can also use a C<YAML>, C<XML> or L<Config::General> config file
898 like C<myapp.conf> in your applications home directory. See
899 L<Catalyst::Plugin::ConfigLoader>.
901 =head3 Cascading configuration
903 The config method is present on all Catalyst components, and configuration
904 will be merged when an application is started. Configuration loaded with
905 L<Catalyst::Plugin::ConfigLoader> takes precedence over other configuration,
906 followed by configuration in your top level C<MyApp> class. These two
907 configurations are merged, and then configuration data whose hash key matches a
908 component name is merged with configuration for that component.
910 The configuration for a component is then passed to the C<new> method when a
911 component is constructed.
915 MyApp->config({ 'Model::Foo' => { bar => 'baz', overrides => 'me' } });
916 MyApp::Model::Foo->config({ quux => 'frob', overrides => 'this' });
918 will mean that C<MyApp::Model::Foo> receives the following data when
921 MyApp::Model::Foo->new({
927 It's common practice to use a Moose attribute
928 on the receiving component to access the config value.
930 package MyApp::Model::Foo;
934 # this attr will receive 'baz' at construction time
940 You can then get the value 'baz' by calling $c->model('Foo')->bar
941 (or $self->bar inside code in the model).
943 B<NOTE:> you MUST NOT call C<< $self->config >> or C<< __PACKAGE__->config >>
944 as a way of reading config within your code, as this B<will not> give you the
945 correctly merged config back. You B<MUST> take the config values supplied to
946 the constructor and use those instead.
950 around config => sub {
954 croak('Setting config after setup has been run is not allowed.')
955 if ( @_ and $c->setup_finished );
962 Returns the logging object instance. Unless it is already set, Catalyst
963 sets this up with a L<Catalyst::Log> object. To use your own log class,
964 set the logger with the C<< __PACKAGE__->log >> method prior to calling
965 C<< __PACKAGE__->setup >>.
967 __PACKAGE__->log( MyLogger->new );
972 $c->log->info( 'Now logging with my own logger!' );
974 Your log class should implement the methods described in
980 Returns 1 if debug mode is enabled, 0 otherwise.
982 You can enable debug mode in several ways:
986 =item By calling myapp_server.pl with the -d flag
988 =item With the environment variables MYAPP_DEBUG, or CATALYST_DEBUG
990 =item The -Debug option in your MyApp.pm
992 =item By declaring C<sub debug { 1 }> in your MyApp.pm.
996 The first three also set the log level to 'debug'.
998 Calling C<< $c->debug(1) >> has no effect.
1004 =head2 $c->dispatcher
1006 Returns the dispatcher instance. See L<Catalyst::Dispatcher>.
1010 Returns the engine instance. See L<Catalyst::Engine>.
1013 =head2 UTILITY METHODS
1015 =head2 $c->path_to(@path)
1017 Merges C<@path> with C<< $c->config->{home} >> and returns a
1018 L<Path::Class::Dir> object. Note you can usually use this object as
1019 a filename, but sometimes you will have to explicitly stringify it
1020 yourself by calling the C<< ->stringify >> method.
1024 $c->path_to( 'db', 'sqlite.db' );
1029 my ( $c, @path ) = @_;
1030 my $path = Path::Class::Dir->new( $c->config->{home}, @path );
1031 if ( -d $path ) { return $path }
1032 else { return Path::Class::File->new( $c->config->{home}, @path ) }
1035 =head2 $c->plugin( $name, $class, @args )
1037 Helper method for plugins. It creates a class data accessor/mutator and
1038 loads and instantiates the given class.
1040 MyApp->plugin( 'prototype', 'HTML::Prototype' );
1042 $c->prototype->define_javascript_functions;
1044 B<Note:> This method of adding plugins is deprecated. The ability
1045 to add plugins like this B<will be removed> in a Catalyst 5.81.
1046 Please do not use this functionality in new code.
1051 my ( $class, $name, $plugin, @args ) = @_;
1053 # See block comment in t/unit_core_plugin.t
1054 $class->log->warn(qq/Adding plugin using the ->plugin method is deprecated, and will be removed in Catalyst 5.81/);
1056 $class->_register_plugin( $plugin, 1 );
1058 eval { $plugin->import };
1059 $class->mk_classdata($name);
1061 eval { $obj = $plugin->new(@args) };
1064 Catalyst::Exception->throw( message =>
1065 qq/Couldn't instantiate instant plugin "$plugin", "$@"/ );
1068 $class->$name($obj);
1069 $class->log->debug(qq/Initialized instant plugin "$plugin" as "$name"/)
1075 Initializes the dispatcher and engine, loads any plugins, and loads the
1076 model, view, and controller components. You may also specify an array
1077 of plugins to load here, if you choose to not load them in the C<use
1081 MyApp->setup( qw/-Debug/ );
1086 my ( $class, @arguments ) = @_;
1087 croak('Running setup more than once')
1088 if ( $class->setup_finished );
1090 unless ( $class->isa('Catalyst') ) {
1092 Catalyst::Exception->throw(
1093 message => qq/'$class' does not inherit from Catalyst/ );
1096 if ( $class->arguments ) {
1097 @arguments = ( @arguments, @{ $class->arguments } );
1103 foreach (@arguments) {
1107 ( $flags->{log} ) ? 'debug,' . $flags->{log} : 'debug';
1109 elsif (/^-(\w+)=?(.*)$/) {
1110 $flags->{ lc $1 } = $2;
1113 push @{ $flags->{plugins} }, $_;
1117 $class->setup_home( delete $flags->{home} );
1119 $class->setup_log( delete $flags->{log} );
1120 $class->setup_plugins( delete $flags->{plugins} );
1121 $class->setup_dispatcher( delete $flags->{dispatcher} );
1122 if (my $engine = delete $flags->{engine}) {
1123 $class->log->warn("Specifying the engine in ->setup is no longer supported, XXX FIXME");
1125 $class->setup_engine();
1126 $class->setup_stats( delete $flags->{stats} );
1128 for my $flag ( sort keys %{$flags} ) {
1130 if ( my $code = $class->can( 'setup_' . $flag ) ) {
1131 &$code( $class, delete $flags->{$flag} );
1134 $class->log->warn(qq/Unknown flag "$flag"/);
1138 eval { require Catalyst::Devel; };
1139 if( !$@ && $ENV{CATALYST_SCRIPT_GEN} && ( $ENV{CATALYST_SCRIPT_GEN} < $Catalyst::Devel::CATALYST_SCRIPT_GEN ) ) {
1140 $class->log->warn(<<"EOF");
1141 You are running an old script!
1143 Please update by running (this will overwrite existing files):
1144 catalyst.pl -force -scripts $class
1146 or (this will not overwrite existing files):
1147 catalyst.pl -scripts $class
1152 if ( $class->debug ) {
1153 my @plugins = map { "$_ " . ( $_->VERSION || '' ) } $class->registered_plugins;
1156 my $column_width = Catalyst::Utils::term_width() - 6;
1157 my $t = Text::SimpleTable->new($column_width);
1158 $t->row($_) for @plugins;
1159 $class->log->debug( "Loaded plugins:\n" . $t->draw . "\n" );
1162 my $dispatcher = $class->dispatcher;
1163 my $engine = $class->engine;
1164 my $home = $class->config->{home};
1166 $class->log->debug(sprintf(q/Loaded dispatcher "%s"/, blessed($dispatcher)));
1167 $class->log->debug(sprintf(q/Loaded engine "%s"/, blessed($engine)));
1171 ? $class->log->debug(qq/Found home "$home"/)
1172 : $class->log->debug(qq/Home "$home" doesn't exist/)
1173 : $class->log->debug(q/Couldn't find home/);
1176 # Call plugins setup, this is stupid and evil.
1177 # Also screws C3 badly on 5.10, hack to avoid.
1179 no warnings qw/redefine/;
1180 local *setup = sub { };
1181 $class->setup unless $Catalyst::__AM_RESTARTING;
1184 # Initialize our data structure
1185 $class->components( {} );
1187 $class->setup_components;
1189 if ( $class->debug ) {
1190 my $column_width = Catalyst::Utils::term_width() - 8 - 9;
1191 my $t = Text::SimpleTable->new( [ $column_width, 'Class' ], [ 8, 'Type' ] );
1192 for my $comp ( sort keys %{ $class->components } ) {
1193 my $type = ref $class->components->{$comp} ? 'instance' : 'class';
1194 $t->row( $comp, $type );
1196 $class->log->debug( "Loaded components:\n" . $t->draw . "\n" )
1197 if ( keys %{ $class->components } );
1200 # Add our self to components, since we are also a component
1201 if( $class->isa('Catalyst::Controller') ){
1202 $class->components->{$class} = $class;
1205 $class->setup_actions;
1207 if ( $class->debug ) {
1208 my $name = $class->config->{name} || 'Application';
1209 $class->log->info("$name powered by Catalyst $Catalyst::VERSION");
1212 # Make sure that the application class becomes immutable at this point,
1213 B::Hooks::EndOfScope::on_scope_end {
1215 my $meta = Class::MOP::get_metaclass_by_name($class);
1218 && ! { $meta->immutable_options }->{replace_constructor}
1220 $class->isa('Class::Accessor::Fast')
1221 || $class->isa('Class::Accessor')
1224 warn "You made your application class ($class) immutable, "
1225 . "but did not inline the\nconstructor. "
1226 . "This will break catalyst, as your app \@ISA "
1227 . "Class::Accessor(::Fast)?\nPlease pass "
1228 . "(replace_constructor => 1)\nwhen making your class immutable.\n";
1230 $meta->make_immutable(
1231 replace_constructor => 1,
1232 ) unless $meta->is_immutable;
1235 if ($class->config->{case_sensitive}) {
1236 $class->log->warn($class . "->config->{case_sensitive} is set.");
1237 $class->log->warn("This setting is deprecated and planned to be removed in Catalyst 5.81.");
1240 $class->setup_finalize;
1241 # Should be the last thing we do so that user things hooking
1242 # setup_finalize can log..
1243 $class->log->_flush() if $class->log->can('_flush');
1244 return 1; # Explicit return true as people have __PACKAGE__->setup as the last thing in their class. HATE.
1247 =head2 $app->setup_finalize
1249 A hook to attach modifiers to. This method does not do anything except set the
1250 C<setup_finished> accessor.
1252 Applying method modifiers to the C<setup> method doesn't work, because of quirky thingsdone for plugin setup.
1256 after setup_finalize => sub {
1264 sub setup_finalize {
1266 $class->setup_finished(1);
1269 =head2 $c->uri_for( $path?, @args?, \%query_values? )
1271 =head2 $c->uri_for( $action, \@captures?, @args?, \%query_values? )
1273 Constructs an absolute L<URI> object based on the application root, the
1274 provided path, and the additional arguments and query parameters provided.
1275 When used as a string, provides a textual URI. If you need more flexibility
1276 than this (i.e. the option to provide relative URIs etc.) see
1277 L<Catalyst::Plugin::SmartURI>.
1279 If no arguments are provided, the URI for the current action is returned.
1280 To return the current action and also provide @args, use
1281 C<< $c->uri_for( $c->action, @args ) >>.
1283 If the first argument is a string, it is taken as a public URI path relative
1284 to C<< $c->namespace >> (if it doesn't begin with a forward slash) or
1285 relative to the application root (if it does). It is then merged with
1286 C<< $c->request->base >>; any C<@args> are appended as additional path
1287 components; and any C<%query_values> are appended as C<?foo=bar> parameters.
1289 If the first argument is a L<Catalyst::Action> it represents an action which
1290 will have its path resolved using C<< $c->dispatcher->uri_for_action >>. The
1291 optional C<\@captures> argument (an arrayref) allows passing the captured
1292 variables that are needed to fill in the paths of Chained and Regex actions;
1293 once the path is resolved, C<uri_for> continues as though a path was
1294 provided, appending any arguments or parameters and creating an absolute
1297 The captures for the current request can be found in
1298 C<< $c->request->captures >>, and actions can be resolved using
1299 C<< Catalyst::Controller->action_for($name) >>. If you have a private action
1300 path, use C<< $c->uri_for_action >> instead.
1302 # Equivalent to $c->req->uri
1303 $c->uri_for($c->action, $c->req->captures,
1304 @{ $c->req->args }, $c->req->params);
1306 # For the Foo action in the Bar controller
1307 $c->uri_for($c->controller('Bar')->action_for('Foo'));
1309 # Path to a static resource
1310 $c->uri_for('/static/images/logo.png');
1315 my ( $c, $path, @args ) = @_;
1317 if (blessed($path) && $path->isa('Catalyst::Controller')) {
1318 $path = $path->path_prefix;
1323 undef($path) if (defined $path && $path eq '');
1326 ( scalar @args && ref $args[$#args] eq 'HASH' ? pop @args : {} );
1328 carp "uri_for called with undef argument" if grep { ! defined $_ } @args;
1329 foreach my $arg (@args) {
1330 utf8::encode($arg) if utf8::is_utf8($arg);
1331 $arg =~ s/([^$URI::uric])/$URI::Escape::escapes{$1}/go;
1334 if ( blessed($path) ) { # action object
1335 s|/|%2F|g for @args;
1336 my $captures = [ map { s|/|%2F|g; $_; }
1337 ( scalar @args && ref $args[0] eq 'ARRAY'
1341 foreach my $capture (@$captures) {
1342 utf8::encode($capture) if utf8::is_utf8($capture);
1343 $capture =~ s/([^$URI::uric])/$URI::Escape::escapes{$1}/go;
1347 $path = $c->dispatcher->uri_for_action($action, $captures);
1348 if (not defined $path) {
1349 $c->log->debug(qq/Can't find uri_for action '$action' @$captures/)
1353 $path = '/' if $path eq '';
1356 unshift(@args, $path);
1358 unless (defined $path && $path =~ s!^/!!) { # in-place strip
1359 my $namespace = $c->namespace;
1360 if (defined $path) { # cheesy hack to handle path '../foo'
1361 $namespace =~ s{(?:^|/)[^/]+$}{} while $args[0] =~ s{^\.\./}{};
1363 unshift(@args, $namespace || '');
1366 # join args with '/', or a blank string
1367 my $args = join('/', grep { defined($_) } @args);
1368 $args =~ s/\?/%3F/g; # STUPID STUPID SPECIAL CASE
1370 my $base = $c->req->base;
1371 my $class = ref($base);
1372 $base =~ s{(?<!/)$}{/};
1376 if (my @keys = keys %$params) {
1377 # somewhat lifted from URI::_query's query_form
1378 $query = '?'.join('&', map {
1379 my $val = $params->{$_};
1380 s/([;\/?:@&=+,\$\[\]%])/$URI::Escape::escapes{$1}/go;
1383 $val = '' unless defined $val;
1386 utf8::encode( $param ) if utf8::is_utf8($param);
1387 # using the URI::Escape pattern here so utf8 chars survive
1388 $param =~ s/([^A-Za-z0-9\-_.!~*'() ])/$URI::Escape::escapes{$1}/go;
1390 "${key}=$param"; } ( ref $val eq 'ARRAY' ? @$val : $val ));
1394 my $res = bless(\"${base}${args}${query}", $class);
1398 =head2 $c->uri_for_action( $path, \@captures?, @args?, \%query_values? )
1400 =head2 $c->uri_for_action( $action, \@captures?, @args?, \%query_values? )
1406 A private path to the Catalyst action you want to create a URI for.
1408 This is a shortcut for calling C<< $c->dispatcher->get_action_by_path($path)
1409 >> and passing the resulting C<$action> and the remaining arguments to C<<
1412 You can also pass in a Catalyst::Action object, in which case it is passed to
1415 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.
1417 For example, if the action looks like:
1419 package MyApp::Controller::Users;
1421 sub lst : Path('the-list') {}
1425 $c->uri_for_action('/users/lst')
1427 and it will create the URI /users/the-list.
1433 sub uri_for_action {
1434 my ( $c, $path, @args ) = @_;
1435 my $action = blessed($path)
1437 : $c->dispatcher->get_action_by_path($path);
1438 unless (defined $action) {
1439 croak "Can't find action for path '$path'";
1441 return $c->uri_for( $action, @args );
1444 =head2 $c->welcome_message
1446 Returns the Catalyst welcome HTML page.
1450 sub welcome_message {
1452 my $name = $c->config->{name};
1453 my $logo = $c->uri_for('/static/images/catalyst_logo.png');
1454 my $prefix = Catalyst::Utils::appprefix( ref $c );
1455 $c->response->content_type('text/html; charset=utf-8');
1457 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
1458 "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
1459 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
1461 <meta http-equiv="Content-Language" content="en" />
1462 <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
1463 <title>$name on Catalyst $VERSION</title>
1464 <style type="text/css">
1467 background-color: #eee;
1474 margin-bottom: 10px;
1476 background-color: #ccc;
1477 border: 1px solid #aaa;
1482 font-family: verdana, tahoma, sans-serif;
1485 font-family: verdana, tahoma, sans-serif;
1488 text-decoration: none;
1490 border-bottom: 1px dotted #bbb;
1492 :link:hover, :visited:hover {
1505 background-color: #fff;
1506 border: 1px solid #aaa;
1510 font-weight: normal;
1532 <h1><span id="appname">$name</span> on <a href="http://catalyst.perl.org">Catalyst</a>
1537 <img src="$logo" alt="Catalyst Logo" />
1539 <p>Welcome to the world of Catalyst.
1540 This <a href="http://en.wikipedia.org/wiki/MVC">MVC</a>
1541 framework will make web development something you had
1542 never expected it to be: Fun, rewarding, and quick.</p>
1543 <h2>What to do now?</h2>
1544 <p>That really depends on what <b>you</b> want to do.
1545 We do, however, provide you with a few starting points.</p>
1546 <p>If you want to jump right into web development with Catalyst
1547 you might want to start with a tutorial.</p>
1548 <pre>perldoc <a href="http://cpansearch.perl.org/dist/Catalyst-Manual/lib/Catalyst/Manual/Tutorial.pod">Catalyst::Manual::Tutorial</a></code>
1550 <p>Afterwards you can go on to check out a more complete look at our features.</p>
1552 <code>perldoc <a href="http://cpansearch.perl.org/dist/Catalyst-Manual/lib/Catalyst/Manual/Intro.pod">Catalyst::Manual::Intro</a>
1553 <!-- Something else should go here, but the Catalyst::Manual link seems unhelpful -->
1555 <h2>What to do next?</h2>
1556 <p>Next it's time to write an actual application. Use the
1557 helper scripts to generate <a href="http://cpansearch.perl.org/search?query=Catalyst%3A%3AController%3A%3A&mode=all">controllers</a>,
1558 <a href="http://cpansearch.perl.org/search?query=Catalyst%3A%3AModel%3A%3A&mode=all">models</a>, and
1559 <a href="http://cpansearch.perl.org/search?query=Catalyst%3A%3AView%3A%3A&mode=all">views</a>;
1560 they can save you a lot of work.</p>
1561 <pre><code>script/${prefix}_create.pl --help</code></pre>
1562 <p>Also, be sure to check out the vast and growing
1563 collection of <a href="http://search.cpan.org/search?query=Catalyst">plugins for Catalyst on CPAN</a>;
1564 you are likely to find what you need there.
1568 <p>Catalyst has a very active community. Here are the main places to
1569 get in touch with us.</p>
1572 <a href="http://dev.catalyst.perl.org">Wiki</a>
1575 <a href="http://lists.scsys.co.uk/cgi-bin/mailman/listinfo/catalyst">Mailing-List</a>
1578 <a href="irc://irc.perl.org/catalyst">IRC channel #catalyst on irc.perl.org</a>
1581 <h2>In conclusion</h2>
1582 <p>The Catalyst team hopes you will enjoy using Catalyst as much
1583 as we enjoyed making it. Please contact us if you have ideas
1584 for improvement or other feedback.</p>
1592 =head1 INTERNAL METHODS
1594 These methods are not meant to be used by end users.
1596 =head2 $c->components
1598 Returns a hash of components.
1600 =head2 $c->context_class
1602 Returns or sets the context class.
1606 Returns a hashref containing coderefs and execution counts (needed for
1607 deep recursion detection).
1611 Returns the number of actions on the current internal execution stack.
1615 Dispatches a request to actions.
1619 sub dispatch { my $c = shift; $c->dispatcher->dispatch( $c, @_ ) }
1621 =head2 $c->dispatcher_class
1623 Returns or sets the dispatcher class.
1625 =head2 $c->dump_these
1627 Returns a list of 2-element array references (name, structure) pairs
1628 that will be dumped on the error page in debug mode.
1634 [ Request => $c->req ],
1635 [ Response => $c->res ],
1636 [ Stash => $c->stash ],
1637 [ Config => $c->config ];
1640 =head2 $c->engine_class
1642 Returns or sets the engine class.
1644 =head2 $c->execute( $class, $coderef )
1646 Execute a coderef in given class and catch exceptions. Errors are available
1652 my ( $c, $class, $code ) = @_;
1653 $class = $c->component($class) || $class;
1656 if ( $c->depth >= $RECURSION ) {
1657 my $action = $code->reverse();
1658 $action = "/$action" unless $action =~ /->/;
1659 my $error = qq/Deep recursion detected calling "${action}"/;
1660 $c->log->error($error);
1666 my $stats_info = $c->_stats_start_execute( $code ) if $c->use_stats;
1668 push( @{ $c->stack }, $code );
1670 no warnings 'recursion';
1671 # N.B. This used to be combined, but I have seen $c get clobbered if so, and
1672 # I have no idea how, ergo $ret (which appears to fix the issue)
1673 eval { my $ret = $code->execute( $class, $c, @{ $c->req->args } ) || 0; $c->state( $ret ) };
1675 $c->_stats_finish_execute( $stats_info ) if $c->use_stats and $stats_info;
1677 my $last = pop( @{ $c->stack } );
1679 if ( my $error = $@ ) {
1680 if ( blessed($error) and $error->isa('Catalyst::Exception::Detach') ) {
1681 $error->rethrow if $c->depth > 1;
1683 elsif ( blessed($error) and $error->isa('Catalyst::Exception::Go') ) {
1684 $error->rethrow if $c->depth > 0;
1687 unless ( ref $error ) {
1688 no warnings 'uninitialized';
1690 my $class = $last->class;
1691 my $name = $last->name;
1692 $error = qq/Caught exception in $class->$name "$error"/;
1701 sub _stats_start_execute {
1702 my ( $c, $code ) = @_;
1703 my $appclass = ref($c) || $c;
1704 return if ( ( $code->name =~ /^_.*/ )
1705 && ( !$appclass->config->{show_internal_actions} ) );
1707 my $action_name = $code->reverse();
1708 $c->counter->{$action_name}++;
1710 my $action = $action_name;
1711 $action = "/$action" unless $action =~ /->/;
1713 # determine if the call was the result of a forward
1714 # this is done by walking up the call stack and looking for a calling
1715 # sub of Catalyst::forward before the eval
1717 for my $index ( 2 .. 11 ) {
1719 if ( ( caller($index) )[0] eq 'Catalyst'
1720 && ( caller($index) )[3] eq '(eval)' );
1722 if ( ( caller($index) )[3] =~ /forward$/ ) {
1723 $callsub = ( caller($index) )[3];
1724 $action = "-> $action";
1729 my $uid = $action_name . $c->counter->{$action_name};
1731 # is this a root-level call or a forwarded call?
1732 if ( $callsub =~ /forward$/ ) {
1733 my $parent = $c->stack->[-1];
1735 # forward, locate the caller
1736 if ( defined $parent && exists $c->counter->{"$parent"} ) {
1739 parent => "$parent" . $c->counter->{"$parent"},
1745 # forward with no caller may come from a plugin
1764 sub _stats_finish_execute {
1765 my ( $c, $info ) = @_;
1766 $c->stats->profile( end => $info );
1771 Finalizes the request.
1778 for my $error ( @{ $c->error } ) {
1779 $c->log->error($error);
1782 # Allow engine to handle finalize flow (for POE)
1783 my $engine = $c->engine;
1784 if ( my $code = $engine->can('finalize') ) {
1789 $c->finalize_uploads;
1792 if ( $#{ $c->error } >= 0 ) {
1796 $c->finalize_headers;
1799 if ( $c->request->method eq 'HEAD' ) {
1800 $c->response->body('');
1808 if ($c->use_stats) {
1809 my $elapsed = sprintf '%f', $c->stats->elapsed;
1810 my $av = $elapsed == 0 ? '??' : sprintf '%.3f', 1 / $elapsed;
1812 "Request took ${elapsed}s ($av/s)\n" . $c->stats->report . "\n" );
1815 return $c->response->status;
1818 =head2 $c->finalize_body
1824 sub finalize_body { my $c = shift; $c->engine->finalize_body( $c, @_ ) }
1826 =head2 $c->finalize_cookies
1832 sub finalize_cookies { my $c = shift; $c->engine->finalize_cookies( $c, @_ ) }
1834 =head2 $c->finalize_error
1840 sub finalize_error { my $c = shift; $c->engine->finalize_error( $c, @_ ) }
1842 =head2 $c->finalize_headers
1848 sub finalize_headers {
1851 my $response = $c->response; #accessor calls can add up?
1853 # Check if we already finalized headers
1854 return if $response->finalized_headers;
1857 if ( my $location = $response->redirect ) {
1858 $c->log->debug(qq/Redirecting to "$location"/) if $c->debug;
1859 $response->header( Location => $location );
1861 if ( !$response->has_body ) {
1862 # Add a default body if none is already present
1864 qq{<html><body><p>This item has moved <a href="$location">here</a>.</p></body></html>}
1870 if ( defined $response->body && length $response->body && !$response->content_length ) {
1872 # get the length from a filehandle
1873 if ( blessed( $response->body ) && $response->body->can('read') || ref( $response->body ) eq 'GLOB' )
1875 my $size = -s $response->body;
1877 $response->content_length( $size );
1880 $c->log->warn('Serving filehandle without a content-length');
1884 # everything should be bytes at this point, but just in case
1885 $response->content_length( length( $response->body ) );
1890 if ( $response->status =~ /^(1\d\d|[23]04)$/ ) {
1891 $response->headers->remove_header("Content-Length");
1892 $response->body('');
1895 $c->finalize_cookies;
1897 $c->engine->finalize_headers( $c, @_ );
1900 $response->finalized_headers(1);
1903 =head2 $c->finalize_output
1905 An alias for finalize_body.
1907 =head2 $c->finalize_read
1909 Finalizes the input after reading is complete.
1913 sub finalize_read { my $c = shift; $c->engine->finalize_read( $c, @_ ) }
1915 =head2 $c->finalize_uploads
1917 Finalizes uploads. Cleans up any temporary files.
1921 sub finalize_uploads { my $c = shift; $c->engine->finalize_uploads( $c, @_ ) }
1923 =head2 $c->get_action( $action, $namespace )
1925 Gets an action in a given namespace.
1929 sub get_action { my $c = shift; $c->dispatcher->get_action(@_) }
1931 =head2 $c->get_actions( $action, $namespace )
1933 Gets all actions of a given name in a namespace and all parent
1938 sub get_actions { my $c = shift; $c->dispatcher->get_actions( $c, @_ ) }
1940 =head2 $app->handle_request( @arguments )
1942 Called to handle each HTTP request.
1946 sub handle_request {
1947 my ( $class, @arguments ) = @_;
1949 # Always expect worst case!
1952 if ($class->debug) {
1953 my $secs = time - $START || 1;
1954 my $av = sprintf '%.3f', $COUNT / $secs;
1955 my $time = localtime time;
1956 $class->log->info("*** Request $COUNT ($av/s) [$$] [$time] ***");
1959 my $c = $class->prepare(@arguments);
1961 $status = $c->finalize;
1964 chomp(my $error = $_);
1965 $class->log->error(qq/Caught exception in engine "$error"/);
1970 if(my $coderef = $class->log->can('_flush')){
1971 $class->log->$coderef();
1976 =head2 $c->prepare( @arguments )
1978 Creates a Catalyst context from an engine-specific request (Apache, CGI,
1984 my ( $class, @arguments ) = @_;
1987 # After the app/ctxt split, this should become an attribute based on something passed
1988 # into the application.
1989 $class->context_class( ref $class || $class ) unless $class->context_class;
1991 my $c = $class->context_class->new({});
1993 # For on-demand data
1994 $c->request->_context($c);
1995 $c->response->_context($c);
1997 #surely this is not the most efficient way to do things...
1998 $c->stats($class->stats_class->new)->enable($c->use_stats);
1999 if ( $c->debug || $c->config->{enable_catalyst_header} ) {
2000 $c->res->headers->header( 'X-Catalyst' => $Catalyst::VERSION );
2004 # Allow engine to direct the prepare flow (for POE)
2005 if ( my $prepare = $c->engine->can('prepare') ) {
2006 $c->engine->$prepare( $c, @arguments );
2009 $c->prepare_request(@arguments);
2010 $c->prepare_connection;
2011 $c->prepare_query_parameters;
2012 $c->prepare_headers;
2013 $c->prepare_cookies;
2016 # Prepare the body for reading, either by prepare_body
2017 # or the user, if they are using $c->read
2020 # Parse the body unless the user wants it on-demand
2021 unless ( ref($c)->config->{parse_on_demand} ) {
2026 # VERY ugly and probably shouldn't rely on ->finalize actually working
2028 # failed prepare is always due to an invalid request, right?
2029 $c->response->status(400);
2030 $c->response->content_type('text/plain');
2031 $c->response->body('Bad Request');
2036 my $method = $c->req->method || '';
2037 my $path = $c->req->path;
2038 $path = '/' unless length $path;
2039 my $address = $c->req->address || '';
2048 =head2 $c->prepare_action
2050 Prepares action. See L<Catalyst::Dispatcher>.
2054 sub prepare_action { my $c = shift; $c->dispatcher->prepare_action( $c, @_ ) }
2056 =head2 $c->prepare_body
2058 Prepares message body.
2065 return if $c->request->_has_body;
2067 # Initialize on-demand data
2068 $c->engine->prepare_body( $c, @_ );
2069 $c->prepare_parameters;
2070 $c->prepare_uploads;
2073 =head2 $c->prepare_body_chunk( $chunk )
2075 Prepares a chunk of data before sending it to L<HTTP::Body>.
2077 See L<Catalyst::Engine>.
2081 sub prepare_body_chunk {
2083 $c->engine->prepare_body_chunk( $c, @_ );
2086 =head2 $c->prepare_body_parameters
2088 Prepares body parameters.
2092 sub prepare_body_parameters {
2094 $c->engine->prepare_body_parameters( $c, @_ );
2097 =head2 $c->prepare_connection
2099 Prepares connection.
2103 sub prepare_connection {
2105 $c->engine->prepare_connection( $c, @_ );
2108 =head2 $c->prepare_cookies
2114 sub prepare_cookies { my $c = shift; $c->engine->prepare_cookies( $c, @_ ) }
2116 =head2 $c->prepare_headers
2122 sub prepare_headers { my $c = shift; $c->engine->prepare_headers( $c, @_ ) }
2124 =head2 $c->prepare_parameters
2126 Prepares parameters.
2130 sub prepare_parameters {
2132 $c->prepare_body_parameters;
2133 $c->engine->prepare_parameters( $c, @_ );
2136 =head2 $c->prepare_path
2138 Prepares path and base.
2142 sub prepare_path { my $c = shift; $c->engine->prepare_path( $c, @_ ) }
2144 =head2 $c->prepare_query_parameters
2146 Prepares query parameters.
2150 sub prepare_query_parameters {
2153 $c->engine->prepare_query_parameters( $c, @_ );
2156 =head2 $c->log_request
2158 Writes information about the request to the debug logs. This includes:
2162 =item * Request method, path, and remote IP address
2164 =item * Query keywords (see L<Catalyst::Request/query_keywords>)
2166 =item * Request parameters
2168 =item * File uploads
2177 return unless $c->debug;
2179 my($dump) = grep {$_->[0] eq 'Request' } $c->dump_these;
2180 my $request = $dump->[1];
2182 my ( $method, $path, $address ) = ( $request->method, $request->path, $request->address );
2184 $path = '/' unless length $path;
2186 $c->log->debug(qq/"$method" request for "$path" from "$address"/);
2188 $c->log_request_headers($request->headers);
2190 if ( my $keywords = $request->query_keywords ) {
2191 $c->log->debug("Query keywords are: $keywords");
2194 $c->log_request_parameters( query => $request->query_parameters, $request->_has_body ? (body => $request->body_parameters) : () );
2196 $c->log_request_uploads($request);
2199 =head2 $c->log_response
2201 Writes information about the response to the debug logs by calling
2202 C<< $c->log_response_status_line >> and C<< $c->log_response_headers >>.
2209 return unless $c->debug;
2211 my($dump) = grep {$_->[0] eq 'Response' } $c->dump_these;
2212 my $response = $dump->[1];
2214 $c->log_response_status_line($response);
2215 $c->log_response_headers($response->headers);
2218 =head2 $c->log_response_status_line($response)
2220 Writes one line of information about the response to the debug logs. This includes:
2224 =item * Response status code
2226 =item * Content-Type header (if present)
2228 =item * Content-Length header (if present)
2234 sub log_response_status_line {
2235 my ($c, $response) = @_;
2239 'Response Code: %s; Content-Type: %s; Content-Length: %s',
2240 $response->status || 'unknown',
2241 $response->headers->header('Content-Type') || 'unknown',
2242 $response->headers->header('Content-Length') || 'unknown'
2247 =head2 $c->log_response_headers($headers);
2249 Hook method which can be wrapped by plugins to log the responseheaders.
2250 No-op in the default implementation.
2254 sub log_response_headers {}
2256 =head2 $c->log_request_parameters( query => {}, body => {} )
2258 Logs request parameters to debug logs
2262 sub log_request_parameters {
2264 my %all_params = @_;
2266 return unless $c->debug;
2268 my $column_width = Catalyst::Utils::term_width() - 44;
2269 foreach my $type (qw(query body)) {
2270 my $params = $all_params{$type};
2271 next if ! keys %$params;
2272 my $t = Text::SimpleTable->new( [ 35, 'Parameter' ], [ $column_width, 'Value' ] );
2273 for my $key ( sort keys %$params ) {
2274 my $param = $params->{$key};
2275 my $value = defined($param) ? $param : '';
2276 $t->row( $key, ref $value eq 'ARRAY' ? ( join ', ', @$value ) : $value );
2278 $c->log->debug( ucfirst($type) . " Parameters are:\n" . $t->draw );
2282 =head2 $c->log_request_uploads
2284 Logs file uploads included in the request to the debug logs.
2285 The parameter name, filename, file type, and file size are all included in
2290 sub log_request_uploads {
2292 my $request = shift;
2293 return unless $c->debug;
2294 my $uploads = $request->uploads;
2295 if ( keys %$uploads ) {
2296 my $t = Text::SimpleTable->new(
2297 [ 12, 'Parameter' ],
2302 for my $key ( sort keys %$uploads ) {
2303 my $upload = $uploads->{$key};
2304 for my $u ( ref $upload eq 'ARRAY' ? @{$upload} : ($upload) ) {
2305 $t->row( $key, $u->filename, $u->type, $u->size );
2308 $c->log->debug( "File Uploads are:\n" . $t->draw );
2312 =head2 $c->log_request_headers($headers);
2314 Hook method which can be wrapped by plugins to log the request headers.
2315 No-op in the default implementation.
2319 sub log_request_headers {}
2321 =head2 $c->log_headers($type => $headers)
2323 Logs L<HTTP::Headers> (either request or response) to the debug logs.
2330 my $headers = shift; # an HTTP::Headers instance
2332 return unless $c->debug;
2334 my $column_width = Catalyst::Utils::term_width() - 28;
2335 my $t = Text::SimpleTable->new( [ 15, 'Header Name' ], [ $column_width, 'Value' ] );
2338 my ( $name, $value ) = @_;
2339 $t->row( $name, $value );
2342 $c->log->debug( ucfirst($type) . " Headers:\n" . $t->draw );
2346 =head2 $c->prepare_read
2348 Prepares the input for reading.
2352 sub prepare_read { my $c = shift; $c->engine->prepare_read( $c, @_ ) }
2354 =head2 $c->prepare_request
2356 Prepares the engine request.
2360 sub prepare_request { my $c = shift; $c->engine->prepare_request( $c, @_ ) }
2362 =head2 $c->prepare_uploads
2368 sub prepare_uploads {
2371 $c->engine->prepare_uploads( $c, @_ );
2374 =head2 $c->prepare_write
2376 Prepares the output for writing.
2380 sub prepare_write { my $c = shift; $c->engine->prepare_write( $c, @_ ) }
2382 =head2 $c->request_class
2384 Returns or sets the request class. Defaults to L<Catalyst::Request>.
2386 =head2 $c->response_class
2388 Returns or sets the response class. Defaults to L<Catalyst::Response>.
2390 =head2 $c->read( [$maxlength] )
2392 Reads a chunk of data from the request body. This method is designed to
2393 be used in a while loop, reading C<$maxlength> bytes on every call.
2394 C<$maxlength> defaults to the size of the request if not specified.
2396 You have to set C<< MyApp->config(parse_on_demand => 1) >> to use this
2399 Warning: If you use read(), Catalyst will not process the body,
2400 so you will not be able to access POST parameters or file uploads via
2401 $c->request. You must handle all body parsing yourself.
2405 sub read { my $c = shift; return $c->engine->read( $c, @_ ) }
2413 sub run { my $c = shift; return $c->engine->run( $c, $c->_finalized_psgi_app, @_ ) }
2415 =head2 $c->set_action( $action, $code, $namespace, $attrs )
2417 Sets an action in a given namespace.
2421 sub set_action { my $c = shift; $c->dispatcher->set_action( $c, @_ ) }
2423 =head2 $c->setup_actions($component)
2425 Sets up actions for a component.
2429 sub setup_actions { my $c = shift; $c->dispatcher->setup_actions( $c, @_ ) }
2431 =head2 $c->setup_components
2433 This method is called internally to set up the application's components.
2435 It finds modules by calling the L<locate_components> method, expands them to
2436 package names with the L<expand_component_module> method, and then installs
2437 each component into the application.
2439 The C<setup_components> config option is passed to both of the above methods.
2441 Installation of each component is performed by the L<setup_component> method,
2446 sub setup_components {
2449 my $config = $class->config->{ setup_components };
2451 my @comps = $class->locate_components($config);
2452 my %comps = map { $_ => 1 } @comps;
2454 my $deprecatedcatalyst_component_names = grep { /::[CMV]::/ } @comps;
2455 $class->log->warn(qq{Your application is using the deprecated ::[MVC]:: type naming scheme.\n}.
2456 qq{Please switch your class names to ::Model::, ::View:: and ::Controller: as appropriate.\n}
2457 ) if $deprecatedcatalyst_component_names;
2459 for my $component ( @comps ) {
2461 # We pass ignore_loaded here so that overlay files for (e.g.)
2462 # Model::DBI::Schema sub-classes are loaded - if it's in @comps
2463 # we know M::P::O found a file on disk so this is safe
2465 Catalyst::Utils::ensure_class_loaded( $component, { ignore_loaded => 1 } );
2468 for my $component (@comps) {
2469 my $instance = $class->components->{ $component } = $class->setup_component($component);
2470 my @expanded_components = $instance->can('expand_modules')
2471 ? $instance->expand_modules( $component, $config )
2472 : $class->expand_component_module( $component, $config );
2473 for my $component (@expanded_components) {
2474 next if $comps{$component};
2475 $class->components->{ $component } = $class->setup_component($component);
2480 =head2 $c->locate_components( $setup_component_config )
2482 This method is meant to provide a list of component modules that should be
2483 setup for the application. By default, it will use L<Module::Pluggable>.
2485 Specify a C<setup_components> config option to pass additional options directly
2486 to L<Module::Pluggable>. To add additional search paths, specify a key named
2487 C<search_extra> as an array reference. Items in the array beginning with C<::>
2488 will have the application class name prepended to them.
2492 sub locate_components {
2496 my @paths = qw( ::Controller ::C ::Model ::M ::View ::V );
2497 my $extra = delete $config->{ search_extra } || [];
2499 push @paths, @$extra;
2501 my $locator = Module::Pluggable::Object->new(
2502 search_path => [ map { s/^(?=::)/$class/; $_; } @paths ],
2506 # XXX think about ditching this sort entirely
2507 my @comps = sort { length $a <=> length $b } $locator->plugins;
2512 =head2 $c->expand_component_module( $component, $setup_component_config )
2514 Components found by C<locate_components> will be passed to this method, which
2515 is expected to return a list of component (package) names to be set up.
2519 sub expand_component_module {
2520 my ($class, $module) = @_;
2521 return Devel::InnerPackage::list_packages( $module );
2524 =head2 $c->setup_component
2528 sub setup_component {
2529 my( $class, $component ) = @_;
2531 unless ( $component->can( 'COMPONENT' ) ) {
2535 my $suffix = Catalyst::Utils::class2classsuffix( $component );
2536 my $config = $class->config->{ $suffix } || {};
2537 # Stash catalyst_component_name in the config here, so that custom COMPONENT
2538 # methods also pass it. local to avoid pointlessly shitting in config
2539 # for the debug screen, as $component is already the key name.
2540 local $config->{catalyst_component_name} = $component;
2542 my $instance = eval { $component->COMPONENT( $class, $config ); };
2544 if ( my $error = $@ ) {
2546 Catalyst::Exception->throw(
2547 message => qq/Couldn't instantiate component "$component", "$error"/
2551 unless (blessed $instance) {
2552 my $metaclass = Moose::Util::find_meta($component);
2553 my $method_meta = $metaclass->find_method_by_name('COMPONENT');
2554 my $component_method_from = $method_meta->associated_metaclass->name;
2555 my $value = defined($instance) ? $instance : 'undef';
2556 Catalyst::Exception->throw(
2558 qq/Couldn't instantiate component "$component", COMPONENT() method (from $component_method_from) didn't return an object-like value (value was $value)./
2564 =head2 $c->setup_dispatcher
2570 sub setup_dispatcher {
2571 my ( $class, $dispatcher ) = @_;
2574 $dispatcher = 'Catalyst::Dispatcher::' . $dispatcher;
2577 if ( my $env = Catalyst::Utils::env_value( $class, 'DISPATCHER' ) ) {
2578 $dispatcher = 'Catalyst::Dispatcher::' . $env;
2581 unless ($dispatcher) {
2582 $dispatcher = $class->dispatcher_class;
2585 Class::MOP::load_class($dispatcher);
2587 # dispatcher instance
2588 $class->dispatcher( $dispatcher->new );
2591 =head2 $c->setup_engine
2599 $class->engine_loader->catalyst_engine_class(@_);
2603 my ($class, $requested_engine) = @_;
2605 $class->engine_loader(
2606 Catalyst::EngineLoader->new({
2607 application_name => $class,
2608 (defined $requested_engine
2609 ? (requested_engine => $requested_engine) : ()),
2613 my $engine = $class->engine_class;
2614 Class::MOP::load_class($engine);
2616 if ($ENV{MOD_PERL}) {
2617 my $apache = $class->engine_loader->auto;
2619 $class->meta->add_method(handler => sub {
2621 my $psgi_app = $class->psgi_app;
2622 $apache->call_app($r, $psgi_app);
2626 $class->engine( $engine->new );
2631 sub _finalized_psgi_app {
2634 unless ($app->_psgi_app) {
2635 my $psgi_app = $app->_setup_psgi_app;
2636 $app->_psgi_app($psgi_app);
2639 return $app->_psgi_app;
2642 sub _setup_psgi_app {
2645 for my $home (Path::Class::Dir->new($app->config->{home})) {
2646 my $psgi_file = $home->file(
2647 Catalyst::Utils::appprefix($app) . '.psgi',
2650 next unless -e $psgi_file;
2651 my $psgi_app = Plack::Util::load_psgi($psgi_file);
2654 unless $app->engine_loader->needs_psgi_engine_compat_hack;
2656 # load_psgi ran a .psgi file doing ->setup_engine('PSGI'). That's what
2657 # .psgi files generated by the old Engine::PSGI do. Those return an app
2658 # coderef calling into MyApp->run, which doesn't work anymore, so we're
2659 # just ignoring it and use the wrapped legacy psgi app
2661 Found a legacy Catalyst::Engine::PSGI .psgi file at ${psgi_file}.
2663 Its content has been ignored. Please consult the Catalyst::Upgrading
2664 documentation on how to upgrade from Catalyst::Engine::PSGI.
2668 return $app->apply_default_middlewares($app->psgi_app);
2671 # FIXME - document me
2673 sub apply_default_middlewares {
2674 my ($app, $psgi_app) = @_;
2676 $psgi_app = Plack::Middleware::Conditional->wrap(
2678 builder => sub { Plack::Middleware::ReverseProxy->wrap($_[0]) },
2681 return if $app->config->{ignore_frontend_proxy};
2682 return $env->{REMOTE_ADDR} eq '127.0.0.1'
2683 || $app->config->{using_frontend_proxy};
2687 my $server_matches = sub {
2691 my $server = $env->{SERVER_SOFTWARE};
2692 return unless $server;
2693 return $server =~ $re ? 1 : 0;
2697 # If we're running under Lighttpd, swap PATH_INFO and SCRIPT_NAME
2698 # http://lists.scsys.co.uk/pipermail/catalyst/2006-June/008361.html
2699 $psgi_app = Plack::Middleware::LighttpdScriptNameFix->wrap($psgi_app);
2701 $psgi_app = Plack::Middleware::Conditional->wrap(
2703 condition => $server_matches->(qr/^nginx/),
2708 my $script_name = $env->{SCRIPT_NAME};
2709 $env->{PATH_INFO} =~ s/^$script_name//g;
2710 return $to_wrap->($env);
2715 # we're applying this unconditionally as the middleware itself already makes
2716 # sure it doesn't fuck things up if it's not running under one of the right
2718 $psgi_app = Plack::Middleware::IIS6ScriptNameFix->wrap($psgi_app);
2725 Returns a PSGI application code reference for the catalyst application
2726 C<$c>. This is the bare application without any middlewares
2727 applied. C<${myapp}.psgi> is not taken into account.
2729 This is what you want to be using to retrieve the PSGI application code
2730 reference of your Catalyst application for use in F<.psgi> files.
2736 return $app->engine->build_psgi_app($app);
2739 =head2 $c->setup_home
2741 Sets up the home directory.
2746 my ( $class, $home ) = @_;
2748 if ( my $env = Catalyst::Utils::env_value( $class, 'HOME' ) ) {
2752 $home ||= Catalyst::Utils::home($class);
2755 #I remember recently being scolded for assigning config values like this
2756 $class->config->{home} ||= $home;
2757 $class->config->{root} ||= Path::Class::Dir->new($home)->subdir('root');
2761 =head2 $c->setup_log
2763 Sets up log by instantiating a L<Catalyst::Log|Catalyst::Log> object and
2764 passing it to C<log()>. Pass in a comma-delimited list of levels to set the
2767 This method also installs a C<debug> method that returns a true value into the
2768 catalyst subclass if the "debug" level is passed in the comma-delimited list,
2769 or if the C<$CATALYST_DEBUG> environment variable is set to a true value.
2771 Note that if the log has already been setup, by either a previous call to
2772 C<setup_log> or by a call such as C<< __PACKAGE__->log( MyLogger->new ) >>,
2773 that this method won't actually set up the log object.
2778 my ( $class, $levels ) = @_;
2781 $levels =~ s/^\s+//;
2782 $levels =~ s/\s+$//;
2783 my %levels = map { $_ => 1 } split /\s*,\s*/, $levels;
2785 my $env_debug = Catalyst::Utils::env_value( $class, 'DEBUG' );
2786 if ( defined $env_debug ) {
2787 $levels{debug} = 1 if $env_debug; # Ugly!
2788 delete($levels{debug}) unless $env_debug;
2791 unless ( $class->log ) {
2792 $class->log( Catalyst::Log->new(keys %levels) );
2795 if ( $levels{debug} ) {
2796 Class::MOP::get_metaclass_by_name($class)->add_method('debug' => sub { 1 });
2797 $class->log->debug('Debug messages enabled');
2801 =head2 $c->setup_plugins
2807 =head2 $c->setup_stats
2809 Sets up timing statistics class.
2814 my ( $class, $stats ) = @_;
2816 Catalyst::Utils::ensure_class_loaded($class->stats_class);
2818 my $env = Catalyst::Utils::env_value( $class, 'STATS' );
2819 if ( defined($env) ? $env : ($stats || $class->debug ) ) {
2820 Class::MOP::get_metaclass_by_name($class)->add_method('use_stats' => sub { 1 });
2821 $class->log->debug('Statistics enabled');
2826 =head2 $c->registered_plugins
2828 Returns a sorted list of the plugins which have either been stated in the
2829 import list or which have been added via C<< MyApp->plugin(@args); >>.
2831 If passed a given plugin name, it will report a boolean value indicating
2832 whether or not that plugin is loaded. A fully qualified name is required if
2833 the plugin name does not begin with C<Catalyst::Plugin::>.
2835 if ($c->registered_plugins('Some::Plugin')) {
2843 sub registered_plugins {
2845 return sort keys %{ $proto->_plugins } unless @_;
2847 return 1 if exists $proto->_plugins->{$plugin};
2848 return exists $proto->_plugins->{"Catalyst::Plugin::$plugin"};
2851 sub _register_plugin {
2852 my ( $proto, $plugin, $instant ) = @_;
2853 my $class = ref $proto || $proto;
2855 Class::MOP::load_class( $plugin );
2856 $class->log->warn( "$plugin inherits from 'Catalyst::Component' - this is decated and will not work in 5.81" )
2857 if $plugin->isa( 'Catalyst::Component' );
2858 $proto->_plugins->{$plugin} = 1;
2860 my $meta = Class::MOP::get_metaclass_by_name($class);
2861 $meta->superclasses($plugin, $meta->superclasses);
2867 my ( $class, $plugins ) = @_;
2869 $class->_plugins( {} ) unless $class->_plugins;
2870 $plugins = Data::OptList::mkopt($plugins || []);
2873 [ Catalyst::Utils::resolve_namespace(
2874 $class . '::Plugin',
2875 'Catalyst::Plugin', $_->[0]
2881 for my $plugin ( reverse @plugins ) {
2882 Class::MOP::load_class($plugin->[0], $plugin->[1]);
2883 my $meta = find_meta($plugin->[0]);
2884 next if $meta && $meta->isa('Moose::Meta::Role');
2886 $class->_register_plugin($plugin->[0]);
2890 map { $_->[0]->name, $_->[1] }
2891 grep { blessed($_->[0]) && $_->[0]->isa('Moose::Meta::Role') }
2892 map { [find_meta($_->[0]), $_->[1]] }
2895 Moose::Util::apply_all_roles(
2903 Returns an arrayref of the internal execution stack (actions that are
2904 currently executing).
2908 Returns the current timing statistics object. By default Catalyst uses
2909 L<Catalyst::Stats|Catalyst::Stats>, but can be set otherwise with
2910 L<< stats_class|/"$c->stats_class" >>.
2912 Even if L<< -Stats|/"-Stats" >> is not enabled, the stats object is still
2913 available. By enabling it with C< $c->stats->enabled(1) >, it can be used to
2914 profile explicitly, although MyApp.pm still won't profile nor output anything
2917 =head2 $c->stats_class
2919 Returns or sets the stats (timing statistics) class. L<Catalyst::Stats|Catalyst::Stats> is used by default.
2921 =head2 $c->use_stats
2923 Returns 1 when L<< stats collection|/"-Stats" >> is enabled.
2925 Note that this is a static method, not an accessor and should be overridden
2926 by declaring C<sub use_stats { 1 }> in your MyApp.pm, not by calling C<< $c->use_stats(1) >>.
2933 =head2 $c->write( $data )
2935 Writes $data to the output stream. When using this method directly, you
2936 will need to manually set the C<Content-Length> header to the length of
2937 your output data, if known.
2944 # Finalize headers if someone manually writes output
2945 $c->finalize_headers;
2947 return $c->engine->write( $c, @_ );
2952 Returns the Catalyst version number. Mostly useful for "powered by"
2953 messages in template systems.
2957 sub version { return $Catalyst::VERSION }
2959 =head1 CONFIGURATION
2961 There are a number of 'base' config variables which can be set:
2967 C<default_model> - The default model picked if you say C<< $c->model >>. See L<< /$c->model($name) >>.
2971 C<default_view> - The default view to be rendered or returned when C<< $c->view >> is called. See L<< /$c->view($name) >>.
2975 C<disable_component_resolution_regex_fallback> - Turns
2976 off the deprecated component resolution functionality so
2977 that if any of the component methods (e.g. C<< $c->controller('Foo') >>)
2978 are called then regex search will not be attempted on string values and
2979 instead C<undef> will be returned.
2983 C<home> - The application home directory. In an uninstalled application,
2984 this is the top level application directory. In an installed application,
2985 this will be the directory containing C<< MyApp.pm >>.
2989 C<ignore_frontend_proxy> - See L</PROXY SUPPORT>
2993 C<name> - The name of the application in debug messages and the debug and
2998 C<parse_on_demand> - The request body (for example file uploads) will not be parsed
2999 until it is accessed. This allows you to (for example) check authentication (and reject
3000 the upload) before actually recieving all the data. See L</ON-DEMAND PARSER>
3004 C<root> - The root directory for templates. Usually this is just a
3005 subdirectory of the home directory, but you can set it to change the
3006 templates to a different directory.
3010 C<search_extra> - Array reference passed to Module::Pluggable to for additional
3011 namespaces from which components will be loaded (and constructed and stored in
3012 C<< $c->components >>).
3016 C<show_internal_actions> - If true, causes internal actions such as C<< _DISPATCH >>
3017 to be shown in hit debug tables in the test server.
3021 C<use_request_uri_for_path> - Controlls if the C<REQUEST_URI> or C<PATH_INFO> environment
3022 variable should be used for determining the request path. See L<Catalyst::Engine::CGI/PATH DECODING>
3023 for more information.
3027 C<using_frontend_proxy> - See L</PROXY SUPPORT>.
3031 =head1 INTERNAL ACTIONS
3033 Catalyst uses internal actions like C<_DISPATCH>, C<_BEGIN>, C<_AUTO>,
3034 C<_ACTION>, and C<_END>. These are by default not shown in the private
3035 action table, but you can make them visible with a config parameter.
3037 MyApp->config(show_internal_actions => 1);
3039 =head1 ON-DEMAND PARSER
3041 The request body is usually parsed at the beginning of a request,
3042 but if you want to handle input yourself, you can enable on-demand
3043 parsing with a config parameter.
3045 MyApp->config(parse_on_demand => 1);
3047 =head1 PROXY SUPPORT
3049 Many production servers operate using the common double-server approach,
3050 with a lightweight frontend web server passing requests to a larger
3051 backend server. An application running on the backend server must deal
3052 with two problems: the remote user always appears to be C<127.0.0.1> and
3053 the server's hostname will appear to be C<localhost> regardless of the
3054 virtual host that the user connected through.
3056 Catalyst will automatically detect this situation when you are running
3057 the frontend and backend servers on the same machine. The following
3058 changes are made to the request.
3060 $c->req->address is set to the user's real IP address, as read from
3061 the HTTP X-Forwarded-For header.
3063 The host value for $c->req->base and $c->req->uri is set to the real
3064 host, as read from the HTTP X-Forwarded-Host header.
3066 Additionally, you may be running your backend application on an insecure
3067 connection (port 80) while your frontend proxy is running under SSL. If there
3068 is a discrepancy in the ports, use the HTTP header C<X-Forwarded-Port> to
3069 tell Catalyst what port the frontend listens on. This will allow all URIs to
3070 be created properly.
3072 In the case of passing in:
3074 X-Forwarded-Port: 443
3076 All calls to C<uri_for> will result in an https link, as is expected.
3078 Obviously, your web server must support these headers for this to work.
3080 In a more complex server farm environment where you may have your
3081 frontend proxy server(s) on different machines, you will need to set a
3082 configuration option to tell Catalyst to read the proxied data from the
3085 MyApp->config(using_frontend_proxy => 1);
3087 If you do not wish to use the proxy support at all, you may set:
3089 MyApp->config(ignore_frontend_proxy => 1);
3091 =head1 THREAD SAFETY
3093 Catalyst has been tested under Apache 2's threading C<mpm_worker>,
3094 C<mpm_winnt>, and the standalone forking HTTP server on Windows. We
3095 believe the Catalyst core to be thread-safe.
3097 If you plan to operate in a threaded environment, remember that all other
3098 modules you are using must also be thread-safe. Some modules, most notably
3099 L<DBD::SQLite>, are not thread-safe.
3105 Join #catalyst on irc.perl.org.
3109 http://lists.scsys.co.uk/cgi-bin/mailman/listinfo/catalyst
3110 http://lists.scsys.co.uk/cgi-bin/mailman/listinfo/catalyst-dev
3114 http://catalyst.perl.org
3118 http://dev.catalyst.perl.org
3122 =head2 L<Task::Catalyst> - All you need to start with Catalyst
3124 =head2 L<Catalyst::Manual> - The Catalyst Manual
3126 =head2 L<Catalyst::Component>, L<Catalyst::Controller> - Base classes for components
3128 =head2 L<Catalyst::Engine> - Core engine
3130 =head2 L<Catalyst::Log> - Log class.
3132 =head2 L<Catalyst::Request> - Request object
3134 =head2 L<Catalyst::Response> - Response object
3136 =head2 L<Catalyst::Test> - The test suite.
3138 =head1 PROJECT FOUNDER
3140 sri: Sebastian Riedel <sri@cpan.org>
3146 acme: Leon Brocard <leon@astray.com>
3148 abraxxa: Alexander Hartmaier <abraxxa@cpan.org>
3152 Andrew Ford E<lt>A.Ford@ford-mason.co.ukE<gt>
3156 andyg: Andy Grundman <andy@hybridized.org>
3158 audreyt: Audrey Tang
3160 bricas: Brian Cassidy <bricas@cpan.org>
3162 Caelum: Rafael Kitover <rkitover@io.com>
3164 chansen: Christian Hansen
3166 chicks: Christopher Hicks
3168 Chisel Wright C<pause@herlpacker.co.uk>
3170 Danijel Milicevic C<me@danijel.de>
3172 David Kamholz E<lt>dkamholz@cpan.orgE<gt>
3174 David Naughton, C<naughton@umn.edu>
3178 dhoss: Devin Austin <dhoss@cpan.org>
3180 dkubb: Dan Kubb <dan.kubb-cpan@onautopilot.com>
3184 dwc: Daniel Westermann-Clark <danieltwc@cpan.org>
3186 esskar: Sascha Kiefer
3188 fireartist: Carl Franks <cfranks@cpan.org>
3190 frew: Arthur Axel "fREW" Schmidt <frioux@gmail.com>
3192 gabb: Danijel Milicevic
3196 Gavin Henry C<ghenry@perl.me.uk>
3200 groditi: Guillermo Roditi <groditi@gmail.com>
3202 hobbs: Andrew Rodland <andrew@cleverdomain.org>
3204 ilmari: Dagfinn Ilmari Mannsåker <ilmari@ilmari.org>
3206 jcamacho: Juan Camacho
3208 jester: Jesse Sheidlower C<jester@panix.com>
3210 jhannah: Jay Hannah <jay@jays.net>
3216 jon: Jon Schutz <jjschutz@cpan.org>
3218 Jonathan Rockway C<< <jrockway@cpan.org> >>
3220 Kieren Diment C<kd@totaldatasolution.com>
3222 konobi: Scott McWhirter <konobi@cpan.org>
3224 marcus: Marcus Ramberg <mramberg@cpan.org>
3226 miyagawa: Tatsuhiko Miyagawa <miyagawa@bulknews.net>
3228 mst: Matt S. Trout <mst@shadowcatsystems.co.uk>
3232 naughton: David Naughton
3234 ningu: David Kamholz <dkamholz@cpan.org>
3236 nothingmuch: Yuval Kogman <nothingmuch@woobling.org>
3238 numa: Dan Sully <daniel@cpan.org>
3244 omega: Andreas Marienborg
3246 Oleg Kostyuk <cub.uanic@gmail.com>
3248 phaylon: Robert Sedlacek <phaylon@dunkelheit.at>
3250 rafl: Florian Ragwitz <rafl@debian.org>
3252 random: Roland Lammel <lammel@cpan.org>
3254 Robert Sedlacek C<< <rs@474.at> >>
3256 SpiceMan: Marcel Montes
3260 szbalint: Balint Szilakszi <szbalint@cpan.org>
3262 t0m: Tomas Doran <bobtfish@bobtfish.net>
3266 Viljo Marrandi C<vilts@yahoo.com>
3268 Will Hawes C<info@whawes.co.uk>
3270 willert: Sebastian Willert <willert@cpan.org>
3272 wreis: Wallace Reis <wallace@reis.org.br>
3274 Yuval Kogman, C<nothingmuch@woobling.org>
3276 rainboxx: Matthias Dietrich, C<perl@rainboxx.de>
3278 dd070: Dhaval Dhanani <dhaval070@gmail.com>
3282 Copyright (c) 2005, the above named PROJECT FOUNDER and CONTRIBUTORS.
3286 This library is free software. You can redistribute it and/or modify it under
3287 the same terms as Perl itself.
3293 __PACKAGE__->meta->make_immutable;