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;
17 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/;
32 use Carp qw/croak carp shortmess/;
34 BEGIN { require 5.008004; }
36 has stack => (is => 'ro', default => sub { [] });
37 has stash => (is => 'rw', default => sub { {} });
38 has state => (is => 'rw', default => 0);
39 has stats => (is => 'rw');
40 has action => (is => 'rw');
41 has counter => (is => 'rw', default => sub { {} });
42 has request => (is => 'rw', default => sub { $_[0]->request_class->new({}) }, required => 1, lazy => 1);
43 has response => (is => 'rw', default => sub { $_[0]->response_class->new({}) }, required => 1, lazy => 1);
44 has namespace => (is => 'rw');
46 sub depth { scalar @{ shift->stack || [] }; }
47 sub comp { shift->component(@_) }
50 my $self = shift; return $self->request(@_);
53 my $self = shift; return $self->response(@_);
56 # For backwards compatibility
57 sub finalize_output { shift->finalize_body(@_) };
62 our $RECURSION = 1000;
63 our $DETACH = Catalyst::Exception::Detach->new;
64 our $GO = Catalyst::Exception::Go->new;
66 #I imagine that very few of these really need to be class variables. if any.
67 #maybe we should just make them attributes with a default?
68 __PACKAGE__->mk_classdata($_)
69 for qw/components arguments dispatcher engine log dispatcher_class
70 engine_class context_class request_class response_class stats_class
73 __PACKAGE__->dispatcher_class('Catalyst::Dispatcher');
74 __PACKAGE__->engine_class('Catalyst::Engine::CGI');
75 __PACKAGE__->request_class('Catalyst::Request');
76 __PACKAGE__->response_class('Catalyst::Response');
77 __PACKAGE__->stats_class('Catalyst::Stats');
79 # Remember to update this in Catalyst::Runtime as well!
81 our $VERSION = '5.80020';
82 $VERSION = eval $VERSION;
85 my ( $class, @arguments ) = @_;
87 # We have to limit $class to Catalyst to avoid pushing Catalyst upon every
89 return unless $class eq 'Catalyst';
91 my $caller = caller();
92 return if $caller eq 'main';
94 my $meta = Moose::Meta::Class->initialize($caller);
95 unless ( $caller->isa('Catalyst') ) {
96 my @superclasses = ($meta->superclasses, $class, 'Catalyst::Controller');
97 $meta->superclasses(@superclasses);
99 # Avoid possible C3 issues if 'Moose::Object' is already on RHS of MyApp
100 $meta->superclasses(grep { $_ ne 'Moose::Object' } $meta->superclasses);
102 unless( $meta->has_method('meta') ){
103 $meta->add_method(meta => sub { Moose::Meta::Class->initialize("${caller}") } );
106 $caller->arguments( [@arguments] );
110 sub _application { $_[0] }
114 Catalyst - The Elegant MVC Web Application Framework
118 See the L<Catalyst::Manual> distribution for comprehensive
119 documentation and tutorials.
121 # Install Catalyst::Devel for helpers and other development tools
122 # use the helper to create a new application
125 # add models, views, controllers
126 script/myapp_create.pl model MyDatabase DBIC::Schema create=static dbi:SQLite:/path/to/db
127 script/myapp_create.pl view MyTemplate TT
128 script/myapp_create.pl controller Search
130 # built in testserver -- use -r to restart automatically on changes
131 # --help to see all available options
132 script/myapp_server.pl
134 # command line testing interface
135 script/myapp_test.pl /yada
138 use Catalyst qw/-Debug/; # include plugins here as well
140 ### In lib/MyApp/Controller/Root.pm (autocreated)
141 sub foo : Global { # called for /foo, /foo/1, /foo/1/2, etc.
142 my ( $self, $c, @args ) = @_; # args are qw/1 2/ for /foo/1/2
143 $c->stash->{template} = 'foo.tt'; # set the template
144 # lookup something from db -- stash vars are passed to TT
146 $c->model('Database::Foo')->search( { country => $args[0] } );
147 if ( $c->req->params->{bar} ) { # access GET or POST parameters
148 $c->forward( 'bar' ); # process another action
149 # do something else after forward returns
153 # The foo.tt TT template can use the stash data from the database
154 [% WHILE (item = data.next) %]
158 # called for /bar/of/soap, /bar/of/soap/10, etc.
159 sub bar : Path('/bar/of/soap') { ... }
161 # called for all actions, from the top-most controller downwards
163 my ( $self, $c ) = @_;
164 if ( !$c->user_exists ) { # Catalyst::Plugin::Authentication
165 $c->res->redirect( '/login' ); # require login
166 return 0; # abort request and go immediately to end()
168 return 1; # success; carry on to next action
171 # called after all actions are finished
173 my ( $self, $c ) = @_;
174 if ( scalar @{ $c->error } ) { ... } # handle errors
175 return if $c->res->body; # already have a response
176 $c->forward( 'MyApp::View::TT' ); # render template
179 ### in MyApp/Controller/Foo.pm
180 # called for /foo/bar
181 sub bar : Local { ... }
183 # called for /blargle
184 sub blargle : Global { ... }
186 # an index action matches /foo, but not /foo/1, etc.
187 sub index : Private { ... }
189 ### in MyApp/Controller/Foo/Bar.pm
190 # called for /foo/bar/baz
191 sub baz : Local { ... }
193 # first Root auto is called, then Foo auto, then this
194 sub auto : Private { ... }
196 # powerful regular expression paths are also possible
197 sub details : Regex('^product/(\w+)/details$') {
198 my ( $self, $c ) = @_;
199 # extract the (\w+) from the URI
200 my $product = $c->req->captures->[0];
203 See L<Catalyst::Manual::Intro> for additional information.
207 Catalyst is a modern framework for making web applications without the
208 pain usually associated with this process. This document is a reference
209 to the main Catalyst application. If you are a new user, we suggest you
210 start with L<Catalyst::Manual::Tutorial> or L<Catalyst::Manual::Intro>.
212 See L<Catalyst::Manual> for more documentation.
214 Catalyst plugins can be loaded by naming them as arguments to the "use
215 Catalyst" statement. Omit the C<Catalyst::Plugin::> prefix from the
216 plugin name, i.e., C<Catalyst::Plugin::My::Module> becomes
219 use Catalyst qw/My::Module/;
221 If your plugin starts with a name other than C<Catalyst::Plugin::>, you can
222 fully qualify the name by using a unary plus:
226 +Fully::Qualified::Plugin::Name
229 Special flags like C<-Debug> and C<-Engine> can also be specified as
230 arguments when Catalyst is loaded:
232 use Catalyst qw/-Debug My::Module/;
234 The position of plugins and flags in the chain is important, because
235 they are loaded in the order in which they appear.
237 The following flags are supported:
241 Enables debug output. You can also force this setting from the system
242 environment with CATALYST_DEBUG or <MYAPP>_DEBUG. The environment
243 settings override the application, with <MYAPP>_DEBUG having the highest
246 This sets the log level to 'debug' and enables full debug output on the
247 error screen. If you only want the latter, see L<< $c->debug >>.
251 Forces Catalyst to use a specific engine. Omit the
252 C<Catalyst::Engine::> prefix of the engine name, i.e.:
254 use Catalyst qw/-Engine=CGI/;
258 Forces Catalyst to use a specific home directory, e.g.:
260 use Catalyst qw[-Home=/usr/mst];
262 This can also be done in the shell environment by setting either the
263 C<CATALYST_HOME> environment variable or C<MYAPP_HOME>; where C<MYAPP>
264 is replaced with the uppercased name of your application, any "::" in
265 the name will be replaced with underscores, e.g. MyApp::Web should use
266 MYAPP_WEB_HOME. If both variables are set, the MYAPP_HOME one will be used.
268 If none of these are set, Catalyst will attempt to automatically detect the
269 home directory. If you are working in a development envirnoment, Catalyst
270 will try and find the directory containing either Makefile.PL, Build.PL or
271 dist.ini. If the application has been installed into the system (i.e.
272 you have done C<make install>), then Catalyst will use the path to your
273 application module, without the .pm extension (ie, /foo/MyApp if your
274 application was installed at /foo/MyApp.pm)
278 use Catalyst '-Log=warn,fatal,error';
280 Specifies a comma-delimited list of log levels.
284 Enables statistics collection and reporting. You can also force this setting
285 from the system environment with CATALYST_STATS or <MYAPP>_STATS. The
286 environment settings override the application, with <MYAPP>_STATS having the
291 use Catalyst qw/-Stats=1/
295 =head2 INFORMATION ABOUT THE CURRENT REQUEST
299 Returns a L<Catalyst::Action> object for the current action, which
300 stringifies to the action name. See L<Catalyst::Action>.
304 Returns the namespace of the current action, i.e., the URI prefix
305 corresponding to the controller of the current action. For example:
307 # in Controller::Foo::Bar
308 $c->namespace; # returns 'foo/bar';
314 Returns the current L<Catalyst::Request> object, giving access to
315 information about the current client request (including parameters,
316 cookies, HTTP headers, etc.). See L<Catalyst::Request>.
318 =head2 REQUEST FLOW HANDLING
320 =head2 $c->forward( $action [, \@arguments ] )
322 =head2 $c->forward( $class, $method, [, \@arguments ] )
324 Forwards processing to another action, by its private name. If you give a
325 class name but no method, C<process()> is called. You may also optionally
326 pass arguments in an arrayref. The action will receive the arguments in
327 C<@_> and C<< $c->req->args >>. Upon returning from the function,
328 C<< $c->req->args >> will be restored to the previous values.
330 Any data C<return>ed from the action forwarded to, will be returned by the
333 my $foodata = $c->forward('/foo');
334 $c->forward('index');
335 $c->forward(qw/Model::DBIC::Foo do_stuff/);
336 $c->forward('View::TT');
338 Note that L<< forward|/"$c->forward( $action [, \@arguments ] )" >> implies
339 an C<< eval { } >> around the call (actually
340 L<< execute|/"$c->execute( $class, $coderef )" >> does), thus de-fatalizing
341 all 'dies' within the called action. If you want C<die> to propagate you
342 need to do something like:
345 die join "\n", @{ $c->error } if @{ $c->error };
347 Or make sure to always return true values from your actions and write
350 $c->forward('foo') || return;
352 Another note is that C<< $c->forward >> always returns a scalar because it
353 actually returns $c->state which operates in a scalar context.
354 Thus, something like:
358 in an action that is forwarded to is going to return a scalar,
359 i.e. how many items are in that array, which is probably not what you want.
360 If you need to return an array then return a reference to it,
363 $c->stash->{array} = \@array;
365 and access it from the stash.
369 sub forward { my $c = shift; no warnings 'recursion'; $c->dispatcher->forward( $c, @_ ) }
371 =head2 $c->detach( $action [, \@arguments ] )
373 =head2 $c->detach( $class, $method, [, \@arguments ] )
377 The same as L<< forward|/"$c->forward( $action [, \@arguments ] )" >>, but
378 doesn't return to the previous action when processing is finished.
380 When called with no arguments it escapes the processing chain entirely.
384 sub detach { my $c = shift; $c->dispatcher->detach( $c, @_ ) }
386 =head2 $c->visit( $action [, \@captures, \@arguments ] )
388 =head2 $c->visit( $class, $method, [, \@captures, \@arguments ] )
390 Almost the same as L<< forward|/"$c->forward( $action [, \@arguments ] )" >>,
391 but does a full dispatch, instead of just calling the new C<$action> /
392 C<< $class->$method >>. This means that C<begin>, C<auto> and the method
393 you go to are called, just like a new request.
395 In addition both C<< $c->action >> and C<< $c->namespace >> are localized.
396 This means, for example, that C<< $c->action >> methods such as
397 L<name|Catalyst::Action/name>, L<class|Catalyst::Action/class> and
398 L<reverse|Catalyst::Action/reverse> return information for the visited action
399 when they are invoked within the visited action. This is different from the
400 behavior of L<< forward|/"$c->forward( $action [, \@arguments ] )" >>, which
401 continues to use the $c->action object from the caller action even when
402 invoked from the callee.
404 C<< $c->stash >> is kept unchanged.
406 In effect, L<< visit|/"$c->visit( $action [, \@captures, \@arguments ] )" >>
407 allows you to "wrap" another action, just as it would have been called by
408 dispatching from a URL, while the analogous
409 L<< go|/"$c->go( $action [, \@captures, \@arguments ] )" >> allows you to
410 transfer control to another action as if it had been reached directly from a URL.
414 sub visit { my $c = shift; $c->dispatcher->visit( $c, @_ ) }
416 =head2 $c->go( $action [, \@captures, \@arguments ] )
418 =head2 $c->go( $class, $method, [, \@captures, \@arguments ] )
420 The relationship between C<go> and
421 L<< visit|/"$c->visit( $action [, \@captures, \@arguments ] )" >> is the same as
422 the relationship between
423 L<< forward|/"$c->forward( $class, $method, [, \@arguments ] )" >> and
424 L<< detach|/"$c->detach( $action [, \@arguments ] )" >>. Like C<< $c->visit >>,
425 C<< $c->go >> will perform a full dispatch on the specified action or method,
426 with localized C<< $c->action >> and C<< $c->namespace >>. Like C<detach>,
427 C<go> escapes the processing of the current request chain on completion, and
428 does not return to its caller.
432 sub go { my $c = shift; $c->dispatcher->go( $c, @_ ) }
438 Returns the current L<Catalyst::Response> object, see there for details.
442 Returns a hashref to the stash, which may be used to store data and pass
443 it between components during a request. You can also set hash keys by
444 passing arguments. The stash is automatically sent to the view. The
445 stash is cleared at the end of a request; it cannot be used for
446 persistent storage (for this you must use a session; see
447 L<Catalyst::Plugin::Session> for a complete system integrated with
450 $c->stash->{foo} = $bar;
451 $c->stash( { moose => 'majestic', qux => 0 } );
452 $c->stash( bar => 1, gorch => 2 ); # equivalent to passing a hashref
454 # stash is automatically passed to the view for use in a template
455 $c->forward( 'MyApp::View::TT' );
459 around stash => sub {
462 my $stash = $orig->($c);
464 my $new_stash = @_ > 1 ? {@_} : $_[0];
465 croak('stash takes a hash or hashref') unless ref $new_stash;
466 foreach my $key ( keys %$new_stash ) {
467 $stash->{$key} = $new_stash->{$key};
477 =head2 $c->error($error, ...)
479 =head2 $c->error($arrayref)
481 Returns an arrayref containing error messages. If Catalyst encounters an
482 error while processing a request, it stores the error in $c->error. This
483 method should only be used to store fatal error messages.
485 my @error = @{ $c->error };
489 $c->error('Something bad happened');
496 my $error = ref $_[0] eq 'ARRAY' ? $_[0] : [@_];
497 croak @$error unless ref $c;
498 push @{ $c->{error} }, @$error;
500 elsif ( defined $_[0] ) { $c->{error} = undef }
501 return $c->{error} || [];
507 Contains the return value of the last executed action.
508 Note that << $c->state >> operates in a scalar context which means that all
509 values it returns are scalar.
511 =head2 $c->clear_errors
513 Clear errors. You probably don't want to clear the errors unless you are
514 implementing a custom error screen.
516 This is equivalent to running
527 sub _comp_search_prefixes {
529 return map $c->components->{ $_ }, $c->_comp_names_search_prefixes(@_);
532 # search components given a name and some prefixes
533 sub _comp_names_search_prefixes {
534 my ( $c, $name, @prefixes ) = @_;
535 my $appclass = ref $c || $c;
536 my $filter = "^${appclass}::(" . join( '|', @prefixes ) . ')::';
537 $filter = qr/$filter/; # Compile regex now rather than once per loop
539 # map the original component name to the sub part that we will search against
540 my %eligible = map { my $n = $_; $n =~ s{^$appclass\::[^:]+::}{}; $_ => $n; }
541 grep { /$filter/ } keys %{ $c->components };
543 # undef for a name will return all
544 return keys %eligible if !defined $name;
546 my $query = ref $name ? $name : qr/^$name$/i;
547 my @result = grep { $eligible{$_} =~ m{$query} } keys %eligible;
549 return @result if @result;
551 # if we were given a regexp to search against, we're done.
554 # skip regexp fallback if configured
556 if $appclass->config->{disable_component_resolution_regex_fallback};
560 @result = grep { $eligible{ $_ } =~ m{$query} } keys %eligible;
562 # no results? try against full names
564 @result = grep { m{$query} } keys %eligible;
567 # don't warn if we didn't find any results, it just might not exist
569 # Disgusting hack to work out correct method name
570 my $warn_for = lc $prefixes[0];
571 my $msg = "Used regexp fallback for \$c->${warn_for}('${name}'), which found '" .
572 (join '", "', @result) . "'. Relying on regexp fallback behavior for " .
573 "component resolution is unreliable and unsafe.";
574 my $short = $result[0];
575 # remove the component namespace prefix
576 $short =~ s/.*?(Model|Controller|View):://;
577 my $shortmess = Carp::shortmess('');
578 if ($shortmess =~ m#Catalyst/Plugin#) {
579 $msg .= " You probably need to set '$short' instead of '${name}' in this " .
581 } elsif ($shortmess =~ m#Catalyst/lib/(View|Controller)#) {
582 $msg .= " You probably need to set '$short' instead of '${name}' in this " .
583 "component's config";
585 $msg .= " You probably meant \$c->${warn_for}('$short') instead of \$c->${warn_for}('${name}'), " .
586 "but if you really wanted to search, pass in a regexp as the argument " .
587 "like so: \$c->${warn_for}(qr/${name}/)";
589 $c->log->warn( "${msg}$shortmess" );
595 # Find possible names for a prefix
597 my ( $c, @prefixes ) = @_;
598 my $appclass = ref $c || $c;
600 my $filter = "^${appclass}::(" . join( '|', @prefixes ) . ')::';
602 my @names = map { s{$filter}{}; $_; }
603 $c->_comp_names_search_prefixes( undef, @prefixes );
608 # Filter a component before returning by calling ACCEPT_CONTEXT if available
609 sub _filter_component {
610 my ( $c, $comp, @args ) = @_;
612 if ( eval { $comp->can('ACCEPT_CONTEXT'); } ) {
613 return $comp->ACCEPT_CONTEXT( $c, @args );
619 =head2 COMPONENT ACCESSORS
621 =head2 $c->controller($name)
623 Gets a L<Catalyst::Controller> instance by name.
625 $c->controller('Foo')->do_stuff;
627 If the name is omitted, will return the controller for the dispatched
630 If you want to search for controllers, pass in a regexp as the argument.
632 # find all controllers that start with Foo
633 my @foo_controllers = $c->controller(qr{^Foo});
639 my ( $c, $name, @args ) = @_;
642 my @result = $c->_comp_search_prefixes( $name, qw/Controller C/ );
643 return map { $c->_filter_component( $_, @args ) } @result if ref $name;
644 return $c->_filter_component( $result[ 0 ], @args );
647 return $c->component( $c->action->class );
650 =head2 $c->model($name)
652 Gets a L<Catalyst::Model> instance by name.
654 $c->model('Foo')->do_stuff;
656 Any extra arguments are directly passed to ACCEPT_CONTEXT.
658 If the name is omitted, it will look for
659 - a model object in $c->stash->{current_model_instance}, then
660 - a model name in $c->stash->{current_model}, then
661 - a config setting 'default_model', or
662 - check if there is only one model, and return it if that's the case.
664 If you want to search for models, pass in a regexp as the argument.
666 # find all models that start with Foo
667 my @foo_models = $c->model(qr{^Foo});
672 my ( $c, $name, @args ) = @_;
673 my $appclass = ref($c) || $c;
675 my @result = $c->_comp_search_prefixes( $name, qw/Model M/ );
676 return map { $c->_filter_component( $_, @args ) } @result if ref $name;
677 return $c->_filter_component( $result[ 0 ], @args );
681 return $c->stash->{current_model_instance}
682 if $c->stash->{current_model_instance};
683 return $c->model( $c->stash->{current_model} )
684 if $c->stash->{current_model};
686 return $c->model( $appclass->config->{default_model} )
687 if $appclass->config->{default_model};
689 my( $comp, $rest ) = $c->_comp_search_prefixes( undef, qw/Model M/);
692 $c->log->warn( Carp::shortmess('Calling $c->model() will return a random model unless you specify one of:') );
693 $c->log->warn( '* $c->config(default_model => "the name of the default model to use")' );
694 $c->log->warn( '* $c->stash->{current_model} # the name of the model to use for this request' );
695 $c->log->warn( '* $c->stash->{current_model_instance} # the instance of the model to use for this request' );
696 $c->log->warn( 'NB: in version 5.81, the "random" behavior will not work at all.' );
699 return $c->_filter_component( $comp );
703 =head2 $c->view($name)
705 Gets a L<Catalyst::View> instance by name.
707 $c->view('Foo')->do_stuff;
709 Any extra arguments are directly passed to ACCEPT_CONTEXT.
711 If the name is omitted, it will look for
712 - a view object in $c->stash->{current_view_instance}, then
713 - a view name in $c->stash->{current_view}, then
714 - a config setting 'default_view', or
715 - check if there is only one view, and return it if that's the case.
717 If you want to search for views, pass in a regexp as the argument.
719 # find all views that start with Foo
720 my @foo_views = $c->view(qr{^Foo});
725 my ( $c, $name, @args ) = @_;
727 my $appclass = ref($c) || $c;
729 my @result = $c->_comp_search_prefixes( $name, qw/View V/ );
730 return map { $c->_filter_component( $_, @args ) } @result if ref $name;
731 return $c->_filter_component( $result[ 0 ], @args );
735 return $c->stash->{current_view_instance}
736 if $c->stash->{current_view_instance};
737 return $c->view( $c->stash->{current_view} )
738 if $c->stash->{current_view};
740 return $c->view( $appclass->config->{default_view} )
741 if $appclass->config->{default_view};
743 my( $comp, $rest ) = $c->_comp_search_prefixes( undef, qw/View V/);
746 $c->log->warn( 'Calling $c->view() will return a random view unless you specify one of:' );
747 $c->log->warn( '* $c->config(default_view => "the name of the default view to use")' );
748 $c->log->warn( '* $c->stash->{current_view} # the name of the view to use for this request' );
749 $c->log->warn( '* $c->stash->{current_view_instance} # the instance of the view to use for this request' );
750 $c->log->warn( 'NB: in version 5.81, the "random" behavior will not work at all.' );
753 return $c->_filter_component( $comp );
756 =head2 $c->controllers
758 Returns the available names which can be passed to $c->controller
764 return $c->_comp_names(qw/Controller C/);
769 Returns the available names which can be passed to $c->model
775 return $c->_comp_names(qw/Model M/);
781 Returns the available names which can be passed to $c->view
787 return $c->_comp_names(qw/View V/);
790 =head2 $c->comp($name)
792 =head2 $c->component($name)
794 Gets a component object by name. This method is not recommended,
795 unless you want to get a specific component by full
796 class. C<< $c->controller >>, C<< $c->model >>, and C<< $c->view >>
797 should be used instead.
799 If C<$name> is a regexp, a list of components matched against the full
800 component name will be returned.
802 If Catalyst can't find a component by name, it will fallback to regex
803 matching by default. To disable this behaviour set
804 disable_component_resolution_regex_fallback to a true value.
806 __PACKAGE__->config( disable_component_resolution_regex_fallback => 1 );
811 my ( $c, $name, @args ) = @_;
814 my $comps = $c->components;
817 # is it the exact name?
818 return $c->_filter_component( $comps->{ $name }, @args )
819 if exists $comps->{ $name };
821 # perhaps we just omitted "MyApp"?
822 my $composed = ( ref $c || $c ) . "::${name}";
823 return $c->_filter_component( $comps->{ $composed }, @args )
824 if exists $comps->{ $composed };
826 # search all of the models, views and controllers
827 my( $comp ) = $c->_comp_search_prefixes( $name, qw/Model M Controller C View V/ );
828 return $c->_filter_component( $comp, @args ) if $comp;
831 # This is here so $c->comp( '::M::' ) works
832 my $query = ref $name ? $name : qr{$name}i;
834 my @result = grep { m{$query} } keys %{ $c->components };
835 return map { $c->_filter_component( $_, @args ) } @result if ref $name;
838 $c->log->warn( Carp::shortmess(qq(Found results for "${name}" using regexp fallback)) );
839 $c->log->warn( 'Relying on the regexp fallback behavior for component resolution' );
840 $c->log->warn( 'is unreliable and unsafe. You have been warned' );
841 return $c->_filter_component( $result[ 0 ], @args );
844 # I would expect to return an empty list here, but that breaks back-compat
848 return sort keys %{ $c->components };
851 =head2 CLASS DATA AND HELPER CLASSES
855 Returns or takes a hashref containing the application's configuration.
857 __PACKAGE__->config( { db => 'dsn:SQLite:foo.db' } );
859 You can also use a C<YAML>, C<XML> or L<Config::General> config file
860 like C<myapp.conf> in your applications home directory. See
861 L<Catalyst::Plugin::ConfigLoader>.
863 =head3 Cascading configuration
865 The config method is present on all Catalyst components, and configuration
866 will be merged when an application is started. Configuration loaded with
867 L<Catalyst::Plugin::ConfigLoader> takes precedence over other configuration,
868 followed by configuration in your top level C<MyApp> class. These two
869 configurations are merged, and then configuration data whose hash key matches a
870 component name is merged with configuration for that component.
872 The configuration for a component is then passed to the C<new> method when a
873 component is constructed.
877 MyApp->config({ 'Model::Foo' => { bar => 'baz', overrides => 'me' } });
878 MyApp::Model::Foo->config({ quux => 'frob', 'overrides => 'this' });
880 will mean that C<MyApp::Model::Foo> receives the following data when
883 MyApp::Model::Foo->new({
891 around config => sub {
895 croak('Setting config after setup has been run is not allowed.')
896 if ( @_ and $c->setup_finished );
903 Returns the logging object instance. Unless it is already set, Catalyst
904 sets this up with a L<Catalyst::Log> object. To use your own log class,
905 set the logger with the C<< __PACKAGE__->log >> method prior to calling
906 C<< __PACKAGE__->setup >>.
908 __PACKAGE__->log( MyLogger->new );
913 $c->log->info( 'Now logging with my own logger!' );
915 Your log class should implement the methods described in
921 Returns 1 if debug mode is enabled, 0 otherwise.
923 You can enable debug mode in several ways:
927 =item By calling myapp_server.pl with the -d flag
929 =item With the environment variables MYAPP_DEBUG, or CATALYST_DEBUG
931 =item The -Debug option in your MyApp.pm
933 =item By declaring C<sub debug { 1 }> in your MyApp.pm.
937 The first three also set the log level to 'debug'.
939 Calling C<< $c->debug(1) >> has no effect.
945 =head2 $c->dispatcher
947 Returns the dispatcher instance. See L<Catalyst::Dispatcher>.
951 Returns the engine instance. See L<Catalyst::Engine>.
954 =head2 UTILITY METHODS
956 =head2 $c->path_to(@path)
958 Merges C<@path> with C<< $c->config->{home} >> and returns a
959 L<Path::Class::Dir> object. Note you can usually use this object as
960 a filename, but sometimes you will have to explicitly stringify it
961 yourself by calling the C<< ->stringify >> method.
965 $c->path_to( 'db', 'sqlite.db' );
970 my ( $c, @path ) = @_;
971 my $path = Path::Class::Dir->new( $c->config->{home}, @path );
972 if ( -d $path ) { return $path }
973 else { return Path::Class::File->new( $c->config->{home}, @path ) }
976 =head2 $c->plugin( $name, $class, @args )
978 Helper method for plugins. It creates a class data accessor/mutator and
979 loads and instantiates the given class.
981 MyApp->plugin( 'prototype', 'HTML::Prototype' );
983 $c->prototype->define_javascript_functions;
985 B<Note:> This method of adding plugins is deprecated. The ability
986 to add plugins like this B<will be removed> in a Catalyst 5.81.
987 Please do not use this functionality in new code.
992 my ( $class, $name, $plugin, @args ) = @_;
994 # See block comment in t/unit_core_plugin.t
995 $class->log->warn(qq/Adding plugin using the ->plugin method is deprecated, and will be removed in Catalyst 5.81/);
997 $class->_register_plugin( $plugin, 1 );
999 eval { $plugin->import };
1000 $class->mk_classdata($name);
1002 eval { $obj = $plugin->new(@args) };
1005 Catalyst::Exception->throw( message =>
1006 qq/Couldn't instantiate instant plugin "$plugin", "$@"/ );
1009 $class->$name($obj);
1010 $class->log->debug(qq/Initialized instant plugin "$plugin" as "$name"/)
1016 Initializes the dispatcher and engine, loads any plugins, and loads the
1017 model, view, and controller components. You may also specify an array
1018 of plugins to load here, if you choose to not load them in the C<use
1022 MyApp->setup( qw/-Debug/ );
1027 my ( $class, @arguments ) = @_;
1028 croak('Running setup more than once')
1029 if ( $class->setup_finished );
1031 unless ( $class->isa('Catalyst') ) {
1033 Catalyst::Exception->throw(
1034 message => qq/'$class' does not inherit from Catalyst/ );
1037 if ( $class->arguments ) {
1038 @arguments = ( @arguments, @{ $class->arguments } );
1044 foreach (@arguments) {
1048 ( $flags->{log} ) ? 'debug,' . $flags->{log} : 'debug';
1050 elsif (/^-(\w+)=?(.*)$/) {
1051 $flags->{ lc $1 } = $2;
1054 push @{ $flags->{plugins} }, $_;
1058 $class->setup_home( delete $flags->{home} );
1060 $class->setup_log( delete $flags->{log} );
1061 $class->setup_plugins( delete $flags->{plugins} );
1062 $class->setup_dispatcher( delete $flags->{dispatcher} );
1063 $class->setup_engine( delete $flags->{engine} );
1064 $class->setup_stats( delete $flags->{stats} );
1066 for my $flag ( sort keys %{$flags} ) {
1068 if ( my $code = $class->can( 'setup_' . $flag ) ) {
1069 &$code( $class, delete $flags->{$flag} );
1072 $class->log->warn(qq/Unknown flag "$flag"/);
1076 eval { require Catalyst::Devel; };
1077 if( !$@ && $ENV{CATALYST_SCRIPT_GEN} && ( $ENV{CATALYST_SCRIPT_GEN} < $Catalyst::Devel::CATALYST_SCRIPT_GEN ) ) {
1078 $class->log->warn(<<"EOF");
1079 You are running an old script!
1081 Please update by running (this will overwrite existing files):
1082 catalyst.pl -force -scripts $class
1084 or (this will not overwrite existing files):
1085 catalyst.pl -scripts $class
1090 if ( $class->debug ) {
1091 my @plugins = map { "$_ " . ( $_->VERSION || '' ) } $class->registered_plugins;
1094 my $column_width = Catalyst::Utils::term_width() - 6;
1095 my $t = Text::SimpleTable->new($column_width);
1096 $t->row($_) for @plugins;
1097 $class->log->debug( "Loaded plugins:\n" . $t->draw . "\n" );
1100 my $dispatcher = $class->dispatcher;
1101 my $engine = $class->engine;
1102 my $home = $class->config->{home};
1104 $class->log->debug(sprintf(q/Loaded dispatcher "%s"/, blessed($dispatcher)));
1105 $class->log->debug(sprintf(q/Loaded engine "%s"/, blessed($engine)));
1109 ? $class->log->debug(qq/Found home "$home"/)
1110 : $class->log->debug(qq/Home "$home" doesn't exist/)
1111 : $class->log->debug(q/Couldn't find home/);
1114 # Call plugins setup, this is stupid and evil.
1115 # Also screws C3 badly on 5.10, hack to avoid.
1117 no warnings qw/redefine/;
1118 local *setup = sub { };
1119 $class->setup unless $Catalyst::__AM_RESTARTING;
1122 # Initialize our data structure
1123 $class->components( {} );
1125 $class->setup_components;
1127 if ( $class->debug ) {
1128 my $column_width = Catalyst::Utils::term_width() - 8 - 9;
1129 my $t = Text::SimpleTable->new( [ $column_width, 'Class' ], [ 8, 'Type' ] );
1130 for my $comp ( sort keys %{ $class->components } ) {
1131 my $type = ref $class->components->{$comp} ? 'instance' : 'class';
1132 $t->row( $comp, $type );
1134 $class->log->debug( "Loaded components:\n" . $t->draw . "\n" )
1135 if ( keys %{ $class->components } );
1138 # Add our self to components, since we are also a component
1139 if( $class->isa('Catalyst::Controller') ){
1140 $class->components->{$class} = $class;
1143 $class->setup_actions;
1145 if ( $class->debug ) {
1146 my $name = $class->config->{name} || 'Application';
1147 $class->log->info("$name powered by Catalyst $Catalyst::VERSION");
1150 # Make sure that the application class becomes immutable at this point,
1151 B::Hooks::EndOfScope::on_scope_end {
1153 my $meta = Class::MOP::get_metaclass_by_name($class);
1156 && ! { $meta->immutable_options }->{replace_constructor}
1158 $class->isa('Class::Accessor::Fast')
1159 || $class->isa('Class::Accessor')
1162 warn "You made your application class ($class) immutable, "
1163 . "but did not inline the\nconstructor. "
1164 . "This will break catalyst, as your app \@ISA "
1165 . "Class::Accessor(::Fast)?\nPlease pass "
1166 . "(replace_constructor => 1)\nwhen making your class immutable.\n";
1168 $meta->make_immutable(
1169 replace_constructor => 1,
1170 ) unless $meta->is_immutable;
1173 if ($class->config->{case_sensitive}) {
1174 $class->log->warn($class . "->config->{case_sensitive} is set.");
1175 $class->log->warn("This setting is deprecated and planned to be removed in Catalyst 5.81.");
1178 $class->setup_finalize;
1179 # Should be the last thing we do so that user things hooking
1180 # setup_finalize can log..
1181 $class->log->_flush() if $class->log->can('_flush');
1182 return 1; # Explicit return true as people have __PACKAGE__->setup as the last thing in their class. HATE.
1186 =head2 $app->setup_finalize
1188 A hook to attach modifiers to.
1189 Using C<< after setup => sub{}; >> doesn't work, because of quirky things done for plugin setup.
1190 Also better than C< setup_finished(); >, as that is a getter method.
1192 sub setup_finalize {
1196 ## do stuff, i.e., determine a primary key column for sessions stored in a DB
1198 $app->next::method(@_);
1205 sub setup_finalize {
1207 $class->setup_finished(1);
1210 =head2 $c->uri_for( $path?, @args?, \%query_values? )
1212 =head2 $c->uri_for( $action, \@captures?, @args?, \%query_values? )
1214 Constructs an absolute L<URI> object based on the application root, the
1215 provided path, and the additional arguments and query parameters provided.
1216 When used as a string, provides a textual URI.
1218 If no arguments are provided, the URI for the current action is returned.
1219 To return the current action and also provide @args, use
1220 C<< $c->uri_for( $c->action, @args ) >>.
1222 If the first argument is a string, it is taken as a public URI path relative
1223 to C<< $c->namespace >> (if it doesn't begin with a forward slash) or
1224 relative to the application root (if it does). It is then merged with
1225 C<< $c->request->base >>; any C<@args> are appended as additional path
1226 components; and any C<%query_values> are appended as C<?foo=bar> parameters.
1228 If the first argument is a L<Catalyst::Action> it represents an action which
1229 will have its path resolved using C<< $c->dispatcher->uri_for_action >>. The
1230 optional C<\@captures> argument (an arrayref) allows passing the captured
1231 variables that are needed to fill in the paths of Chained and Regex actions;
1232 once the path is resolved, C<uri_for> continues as though a path was
1233 provided, appending any arguments or parameters and creating an absolute
1236 The captures for the current request can be found in
1237 C<< $c->request->captures >>, and actions can be resolved using
1238 C<< Catalyst::Controller->action_for($name) >>. If you have a private action
1239 path, use C<< $c->uri_for_action >> instead.
1241 # Equivalent to $c->req->uri
1242 $c->uri_for($c->action, $c->req->captures,
1243 @{ $c->req->args }, $c->req->params);
1245 # For the Foo action in the Bar controller
1246 $c->uri_for($c->controller('Bar')->action_for('Foo'));
1248 # Path to a static resource
1249 $c->uri_for('/static/images/logo.png');
1254 my ( $c, $path, @args ) = @_;
1256 if (blessed($path) && $path->isa('Catalyst::Controller')) {
1257 $path = $path->path_prefix;
1262 undef($path) if (defined $path && $path eq '');
1265 ( scalar @args && ref $args[$#args] eq 'HASH' ? pop @args : {} );
1267 carp "uri_for called with undef argument" if grep { ! defined $_ } @args;
1268 s/([^$URI::uric])/$URI::Escape::escapes{$1}/go for @args;
1269 if (blessed $path) { # Action object only.
1270 s|/|%2F|g for @args;
1273 if ( blessed($path) ) { # action object
1274 my $captures = [ map { s|/|%2F|g; $_; }
1275 ( scalar @args && ref $args[0] eq 'ARRAY'
1279 foreach my $capture (@$captures) {
1280 utf8::encode($capture) if utf8::is_utf8($capture);
1281 $capture =~ s/([^$URI::uric])/$URI::Escape::escapes{$1}/go;
1285 $path = $c->dispatcher->uri_for_action($action, $captures);
1286 if (not defined $path) {
1287 $c->log->debug(qq/Can't find uri_for action '$action' @$captures/)
1291 $path = '/' if $path eq '';
1294 undef($path) if (defined $path && $path eq '');
1297 ( scalar @args && ref $args[$#args] eq 'HASH' ? pop @args : {} );
1299 carp "uri_for called with undef argument" if grep { ! defined $_ } @args;
1301 foreach my $arg (@args) {
1302 utf8::encode($arg) if utf8::is_utf8($arg);
1304 s/([^$URI::uric])/$URI::Escape::escapes{$1}/go for @args;
1307 unshift(@args, $path);
1309 unless (defined $path && $path =~ s!^/!!) { # in-place strip
1310 my $namespace = $c->namespace;
1311 if (defined $path) { # cheesy hack to handle path '../foo'
1312 $namespace =~ s{(?:^|/)[^/]+$}{} while $args[0] =~ s{^\.\./}{};
1314 unshift(@args, $namespace || '');
1317 # join args with '/', or a blank string
1318 my $args = join('/', grep { defined($_) } @args);
1319 $args =~ s/\?/%3F/g; # STUPID STUPID SPECIAL CASE
1321 my $base = $c->req->base;
1322 my $class = ref($base);
1323 $base =~ s{(?<!/)$}{/};
1327 if (my @keys = keys %$params) {
1328 # somewhat lifted from URI::_query's query_form
1329 $query = '?'.join('&', map {
1330 my $val = $params->{$_};
1331 s/([;\/?:@&=+,\$\[\]%])/$URI::Escape::escapes{$1}/go;
1334 $val = '' unless defined $val;
1337 utf8::encode( $param ) if utf8::is_utf8($param);
1338 $param =~ s/([^A-Za-z0-9\-_.!~*'() ])/$URI::Escape::escapes{$1}/go;
1340 "${key}=$param"; } ( ref $val eq 'ARRAY' ? @$val : $val ));
1344 my $res = bless(\"${base}${args}${query}", $class);
1348 =head2 $c->uri_for_action( $path, \@captures?, @args?, \%query_values? )
1350 =head2 $c->uri_for_action( $action, \@captures?, @args?, \%query_values? )
1356 A private path to the Catalyst action you want to create a URI for.
1358 This is a shortcut for calling C<< $c->dispatcher->get_action_by_path($path)
1359 >> and passing the resulting C<$action> and the remaining arguments to C<<
1362 You can also pass in a Catalyst::Action object, in which case it is passed to
1365 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.
1367 For example, if the action looks like:
1369 package MyApp::Controller::Users;
1371 sub lst : Path('the-list') {}
1375 $c->uri_for_action('/users/lst')
1377 and it will create the URI /users/the-list.
1383 sub uri_for_action {
1384 my ( $c, $path, @args ) = @_;
1385 my $action = blessed($path)
1387 : $c->dispatcher->get_action_by_path($path);
1388 unless (defined $action) {
1389 croak "Can't find action for path '$path'";
1391 return $c->uri_for( $action, @args );
1394 =head2 $c->welcome_message
1396 Returns the Catalyst welcome HTML page.
1400 sub welcome_message {
1402 my $name = $c->config->{name};
1403 my $logo = $c->uri_for('/static/images/catalyst_logo.png');
1404 my $prefix = Catalyst::Utils::appprefix( ref $c );
1405 $c->response->content_type('text/html; charset=utf-8');
1407 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
1408 "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
1409 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
1411 <meta http-equiv="Content-Language" content="en" />
1412 <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
1413 <title>$name on Catalyst $VERSION</title>
1414 <style type="text/css">
1417 background-color: #eee;
1424 margin-bottom: 10px;
1426 background-color: #ccc;
1427 border: 1px solid #aaa;
1432 font-family: verdana, tahoma, sans-serif;
1435 font-family: verdana, tahoma, sans-serif;
1438 text-decoration: none;
1440 border-bottom: 1px dotted #bbb;
1442 :link:hover, :visited:hover {
1455 background-color: #fff;
1456 border: 1px solid #aaa;
1460 font-weight: normal;
1482 <h1><span id="appname">$name</span> on <a href="http://catalyst.perl.org">Catalyst</a>
1487 <img src="$logo" alt="Catalyst Logo" />
1489 <p>Welcome to the world of Catalyst.
1490 This <a href="http://en.wikipedia.org/wiki/MVC">MVC</a>
1491 framework will make web development something you had
1492 never expected it to be: Fun, rewarding, and quick.</p>
1493 <h2>What to do now?</h2>
1494 <p>That really depends on what <b>you</b> want to do.
1495 We do, however, provide you with a few starting points.</p>
1496 <p>If you want to jump right into web development with Catalyst
1497 you might want to start with a tutorial.</p>
1498 <pre>perldoc <a href="http://cpansearch.perl.org/dist/Catalyst-Manual/lib/Catalyst/Manual/Tutorial.pod">Catalyst::Manual::Tutorial</a></code>
1500 <p>Afterwards you can go on to check out a more complete look at our features.</p>
1502 <code>perldoc <a href="http://cpansearch.perl.org/dist/Catalyst-Manual/lib/Catalyst/Manual/Intro.pod">Catalyst::Manual::Intro</a>
1503 <!-- Something else should go here, but the Catalyst::Manual link seems unhelpful -->
1505 <h2>What to do next?</h2>
1506 <p>Next it's time to write an actual application. Use the
1507 helper scripts to generate <a href="http://cpansearch.perl.org/search?query=Catalyst%3A%3AController%3A%3A&mode=all">controllers</a>,
1508 <a href="http://cpansearch.perl.org/search?query=Catalyst%3A%3AModel%3A%3A&mode=all">models</a>, and
1509 <a href="http://cpansearch.perl.org/search?query=Catalyst%3A%3AView%3A%3A&mode=all">views</a>;
1510 they can save you a lot of work.</p>
1511 <pre><code>script/${prefix}_create.pl -help</code></pre>
1512 <p>Also, be sure to check out the vast and growing
1513 collection of <a href="http://search.cpan.org/search?query=Catalyst">plugins for Catalyst on CPAN</a>;
1514 you are likely to find what you need there.
1518 <p>Catalyst has a very active community. Here are the main places to
1519 get in touch with us.</p>
1522 <a href="http://dev.catalyst.perl.org">Wiki</a>
1525 <a href="http://lists.scsys.co.uk/cgi-bin/mailman/listinfo/catalyst">Mailing-List</a>
1528 <a href="irc://irc.perl.org/catalyst">IRC channel #catalyst on irc.perl.org</a>
1531 <h2>In conclusion</h2>
1532 <p>The Catalyst team hopes you will enjoy using Catalyst as much
1533 as we enjoyed making it. Please contact us if you have ideas
1534 for improvement or other feedback.</p>
1542 =head1 INTERNAL METHODS
1544 These methods are not meant to be used by end users.
1546 =head2 $c->components
1548 Returns a hash of components.
1550 =head2 $c->context_class
1552 Returns or sets the context class.
1556 Returns a hashref containing coderefs and execution counts (needed for
1557 deep recursion detection).
1561 Returns the number of actions on the current internal execution stack.
1565 Dispatches a request to actions.
1569 sub dispatch { my $c = shift; $c->dispatcher->dispatch( $c, @_ ) }
1571 =head2 $c->dispatcher_class
1573 Returns or sets the dispatcher class.
1575 =head2 $c->dump_these
1577 Returns a list of 2-element array references (name, structure) pairs
1578 that will be dumped on the error page in debug mode.
1584 [ Request => $c->req ],
1585 [ Response => $c->res ],
1586 [ Stash => $c->stash ],
1587 [ Config => $c->config ];
1590 =head2 $c->engine_class
1592 Returns or sets the engine class.
1594 =head2 $c->execute( $class, $coderef )
1596 Execute a coderef in given class and catch exceptions. Errors are available
1602 my ( $c, $class, $code ) = @_;
1603 $class = $c->component($class) || $class;
1606 if ( $c->depth >= $RECURSION ) {
1607 my $action = $code->reverse();
1608 $action = "/$action" unless $action =~ /->/;
1609 my $error = qq/Deep recursion detected calling "${action}"/;
1610 $c->log->error($error);
1616 my $stats_info = $c->_stats_start_execute( $code ) if $c->use_stats;
1618 push( @{ $c->stack }, $code );
1620 no warnings 'recursion';
1621 eval { $c->state( $code->execute( $class, $c, @{ $c->req->args } ) || 0 ) };
1623 $c->_stats_finish_execute( $stats_info ) if $c->use_stats and $stats_info;
1625 my $last = pop( @{ $c->stack } );
1627 if ( my $error = $@ ) {
1628 if ( blessed($error) and $error->isa('Catalyst::Exception::Detach') ) {
1629 $error->rethrow if $c->depth > 1;
1631 elsif ( blessed($error) and $error->isa('Catalyst::Exception::Go') ) {
1632 $error->rethrow if $c->depth > 0;
1635 unless ( ref $error ) {
1636 no warnings 'uninitialized';
1638 my $class = $last->class;
1639 my $name = $last->name;
1640 $error = qq/Caught exception in $class->$name "$error"/;
1649 sub _stats_start_execute {
1650 my ( $c, $code ) = @_;
1651 my $appclass = ref($c) || $c;
1652 return if ( ( $code->name =~ /^_.*/ )
1653 && ( !$appclass->config->{show_internal_actions} ) );
1655 my $action_name = $code->reverse();
1656 $c->counter->{$action_name}++;
1658 my $action = $action_name;
1659 $action = "/$action" unless $action =~ /->/;
1661 # determine if the call was the result of a forward
1662 # this is done by walking up the call stack and looking for a calling
1663 # sub of Catalyst::forward before the eval
1665 for my $index ( 2 .. 11 ) {
1667 if ( ( caller($index) )[0] eq 'Catalyst'
1668 && ( caller($index) )[3] eq '(eval)' );
1670 if ( ( caller($index) )[3] =~ /forward$/ ) {
1671 $callsub = ( caller($index) )[3];
1672 $action = "-> $action";
1677 my $uid = $action_name . $c->counter->{$action_name};
1679 # is this a root-level call or a forwarded call?
1680 if ( $callsub =~ /forward$/ ) {
1681 my $parent = $c->stack->[-1];
1683 # forward, locate the caller
1684 if ( exists $c->counter->{"$parent"} ) {
1687 parent => "$parent" . $c->counter->{"$parent"},
1693 # forward with no caller may come from a plugin
1712 sub _stats_finish_execute {
1713 my ( $c, $info ) = @_;
1714 $c->stats->profile( end => $info );
1719 Finalizes the request.
1726 for my $error ( @{ $c->error } ) {
1727 $c->log->error($error);
1730 # Allow engine to handle finalize flow (for POE)
1731 my $engine = $c->engine;
1732 if ( my $code = $engine->can('finalize') ) {
1737 $c->finalize_uploads;
1740 if ( $#{ $c->error } >= 0 ) {
1744 $c->finalize_headers;
1747 if ( $c->request->method eq 'HEAD' ) {
1748 $c->response->body('');
1754 if ($c->use_stats) {
1755 my $elapsed = sprintf '%f', $c->stats->elapsed;
1756 my $av = $elapsed == 0 ? '??' : sprintf '%.3f', 1 / $elapsed;
1758 "Request took ${elapsed}s ($av/s)\n" . $c->stats->report . "\n" );
1761 return $c->response->status;
1764 =head2 $c->finalize_body
1770 sub finalize_body { my $c = shift; $c->engine->finalize_body( $c, @_ ) }
1772 =head2 $c->finalize_cookies
1778 sub finalize_cookies { my $c = shift; $c->engine->finalize_cookies( $c, @_ ) }
1780 =head2 $c->finalize_error
1786 sub finalize_error { my $c = shift; $c->engine->finalize_error( $c, @_ ) }
1788 =head2 $c->finalize_headers
1794 sub finalize_headers {
1797 my $response = $c->response; #accessor calls can add up?
1799 # Check if we already finalized headers
1800 return if $response->finalized_headers;
1803 if ( my $location = $response->redirect ) {
1804 $c->log->debug(qq/Redirecting to "$location"/) if $c->debug;
1805 $response->header( Location => $location );
1807 if ( !$response->has_body ) {
1808 # Add a default body if none is already present
1810 qq{<html><body><p>This item has moved <a href="$location">here</a>.</p></body></html>}
1816 if ( $response->body && !$response->content_length ) {
1818 # get the length from a filehandle
1819 if ( blessed( $response->body ) && $response->body->can('read') )
1821 my $stat = stat $response->body;
1822 if ( $stat && $stat->size > 0 ) {
1823 $response->content_length( $stat->size );
1826 $c->log->warn('Serving filehandle without a content-length');
1830 # everything should be bytes at this point, but just in case
1831 $response->content_length( length( $response->body ) );
1836 if ( $response->status =~ /^(1\d\d|[23]04)$/ ) {
1837 $response->headers->remove_header("Content-Length");
1838 $response->body('');
1841 $c->finalize_cookies;
1843 $c->engine->finalize_headers( $c, @_ );
1846 $response->finalized_headers(1);
1849 =head2 $c->finalize_output
1851 An alias for finalize_body.
1853 =head2 $c->finalize_read
1855 Finalizes the input after reading is complete.
1859 sub finalize_read { my $c = shift; $c->engine->finalize_read( $c, @_ ) }
1861 =head2 $c->finalize_uploads
1863 Finalizes uploads. Cleans up any temporary files.
1867 sub finalize_uploads { my $c = shift; $c->engine->finalize_uploads( $c, @_ ) }
1869 =head2 $c->get_action( $action, $namespace )
1871 Gets an action in a given namespace.
1875 sub get_action { my $c = shift; $c->dispatcher->get_action(@_) }
1877 =head2 $c->get_actions( $action, $namespace )
1879 Gets all actions of a given name in a namespace and all parent
1884 sub get_actions { my $c = shift; $c->dispatcher->get_actions( $c, @_ ) }
1886 =head2 $c->handle_request( $class, @arguments )
1888 Called to handle each HTTP request.
1892 sub handle_request {
1893 my ( $class, @arguments ) = @_;
1895 # Always expect worst case!
1898 if ($class->debug) {
1899 my $secs = time - $START || 1;
1900 my $av = sprintf '%.3f', $COUNT / $secs;
1901 my $time = localtime time;
1902 $class->log->info("*** Request $COUNT ($av/s) [$$] [$time] ***");
1905 my $c = $class->prepare(@arguments);
1907 $status = $c->finalize;
1910 if ( my $error = $@ ) {
1912 $class->log->error(qq/Caught exception in engine "$error"/);
1917 if(my $coderef = $class->log->can('_flush')){
1918 $class->log->$coderef();
1923 =head2 $c->prepare( @arguments )
1925 Creates a Catalyst context from an engine-specific request (Apache, CGI,
1931 my ( $class, @arguments ) = @_;
1934 # After the app/ctxt split, this should become an attribute based on something passed
1935 # into the application.
1936 $class->context_class( ref $class || $class ) unless $class->context_class;
1938 my $c = $class->context_class->new({});
1940 # For on-demand data
1941 $c->request->_context($c);
1942 $c->response->_context($c);
1944 #surely this is not the most efficient way to do things...
1945 $c->stats($class->stats_class->new)->enable($c->use_stats);
1947 $c->res->headers->header( 'X-Catalyst' => $Catalyst::VERSION );
1950 #XXX reuse coderef from can
1951 # Allow engine to direct the prepare flow (for POE)
1952 if ( $c->engine->can('prepare') ) {
1953 $c->engine->prepare( $c, @arguments );
1956 $c->prepare_request(@arguments);
1957 $c->prepare_connection;
1958 $c->prepare_query_parameters;
1959 $c->prepare_headers;
1960 $c->prepare_cookies;
1963 # Prepare the body for reading, either by prepare_body
1964 # or the user, if they are using $c->read
1967 # Parse the body unless the user wants it on-demand
1968 unless ( ref($c)->config->{parse_on_demand} ) {
1973 my $method = $c->req->method || '';
1974 my $path = $c->req->path;
1975 $path = '/' unless length $path;
1976 my $address = $c->req->address || '';
1978 $c->log->debug(qq/"$method" request for "$path" from "$address"/)
1986 =head2 $c->prepare_action
1988 Prepares action. See L<Catalyst::Dispatcher>.
1992 sub prepare_action { my $c = shift; $c->dispatcher->prepare_action( $c, @_ ) }
1994 =head2 $c->prepare_body
1996 Prepares message body.
2003 return if $c->request->_has_body;
2005 # Initialize on-demand data
2006 $c->engine->prepare_body( $c, @_ );
2007 $c->prepare_parameters;
2008 $c->prepare_uploads;
2010 if ( $c->debug && keys %{ $c->req->body_parameters } ) {
2011 my $t = Text::SimpleTable->new( [ 35, 'Parameter' ], [ 36, 'Value' ] );
2012 for my $key ( sort keys %{ $c->req->body_parameters } ) {
2013 my $param = $c->req->body_parameters->{$key};
2014 my $value = defined($param) ? $param : '';
2016 ref $value eq 'ARRAY' ? ( join ', ', @$value ) : $value );
2018 $c->log->debug( "Body Parameters are:\n" . $t->draw );
2022 =head2 $c->prepare_body_chunk( $chunk )
2024 Prepares a chunk of data before sending it to L<HTTP::Body>.
2026 See L<Catalyst::Engine>.
2030 sub prepare_body_chunk {
2032 $c->engine->prepare_body_chunk( $c, @_ );
2035 =head2 $c->prepare_body_parameters
2037 Prepares body parameters.
2041 sub prepare_body_parameters {
2043 $c->engine->prepare_body_parameters( $c, @_ );
2046 =head2 $c->prepare_connection
2048 Prepares connection.
2052 sub prepare_connection {
2054 $c->engine->prepare_connection( $c, @_ );
2057 =head2 $c->prepare_cookies
2063 sub prepare_cookies { my $c = shift; $c->engine->prepare_cookies( $c, @_ ) }
2065 =head2 $c->prepare_headers
2071 sub prepare_headers { my $c = shift; $c->engine->prepare_headers( $c, @_ ) }
2073 =head2 $c->prepare_parameters
2075 Prepares parameters.
2079 sub prepare_parameters {
2081 $c->prepare_body_parameters;
2082 $c->engine->prepare_parameters( $c, @_ );
2085 =head2 $c->prepare_path
2087 Prepares path and base.
2091 sub prepare_path { my $c = shift; $c->engine->prepare_path( $c, @_ ) }
2093 =head2 $c->prepare_query_parameters
2095 Prepares query parameters.
2099 sub prepare_query_parameters {
2102 $c->engine->prepare_query_parameters( $c, @_ );
2104 if ( $c->debug && keys %{ $c->request->query_parameters } ) {
2105 my $t = Text::SimpleTable->new( [ 35, 'Parameter' ], [ 36, 'Value' ] );
2106 for my $key ( sort keys %{ $c->req->query_parameters } ) {
2107 my $param = $c->req->query_parameters->{$key};
2108 my $value = defined($param) ? $param : '';
2110 ref $value eq 'ARRAY' ? ( join ', ', @$value ) : $value );
2112 $c->log->debug( "Query Parameters are:\n" . $t->draw );
2116 =head2 $c->prepare_read
2118 Prepares the input for reading.
2122 sub prepare_read { my $c = shift; $c->engine->prepare_read( $c, @_ ) }
2124 =head2 $c->prepare_request
2126 Prepares the engine request.
2130 sub prepare_request { my $c = shift; $c->engine->prepare_request( $c, @_ ) }
2132 =head2 $c->prepare_uploads
2138 sub prepare_uploads {
2141 $c->engine->prepare_uploads( $c, @_ );
2143 if ( $c->debug && keys %{ $c->request->uploads } ) {
2144 my $t = Text::SimpleTable->new(
2145 [ 12, 'Parameter' ],
2150 for my $key ( sort keys %{ $c->request->uploads } ) {
2151 my $upload = $c->request->uploads->{$key};
2152 for my $u ( ref $upload eq 'ARRAY' ? @{$upload} : ($upload) ) {
2153 $t->row( $key, $u->filename, $u->type, $u->size );
2156 $c->log->debug( "File Uploads are:\n" . $t->draw );
2160 =head2 $c->prepare_write
2162 Prepares the output for writing.
2166 sub prepare_write { my $c = shift; $c->engine->prepare_write( $c, @_ ) }
2168 =head2 $c->request_class
2170 Returns or sets the request class.
2172 =head2 $c->response_class
2174 Returns or sets the response class.
2176 =head2 $c->read( [$maxlength] )
2178 Reads a chunk of data from the request body. This method is designed to
2179 be used in a while loop, reading C<$maxlength> bytes on every call.
2180 C<$maxlength> defaults to the size of the request if not specified.
2182 You have to set C<< MyApp->config(parse_on_demand => 1) >> to use this
2185 Warning: If you use read(), Catalyst will not process the body,
2186 so you will not be able to access POST parameters or file uploads via
2187 $c->request. You must handle all body parsing yourself.
2191 sub read { my $c = shift; return $c->engine->read( $c, @_ ) }
2199 sub run { my $c = shift; return $c->engine->run( $c, @_ ) }
2201 =head2 $c->set_action( $action, $code, $namespace, $attrs )
2203 Sets an action in a given namespace.
2207 sub set_action { my $c = shift; $c->dispatcher->set_action( $c, @_ ) }
2209 =head2 $c->setup_actions($component)
2211 Sets up actions for a component.
2215 sub setup_actions { my $c = shift; $c->dispatcher->setup_actions( $c, @_ ) }
2217 =head2 $c->setup_components
2219 This method is called internally to set up the application's components.
2221 It finds modules by calling the L<locate_components> method, expands them to
2222 package names with the L<expand_component_module> method, and then installs
2223 each component into the application.
2225 The C<setup_components> config option is passed to both of the above methods.
2227 Installation of each component is performed by the L<setup_component> method,
2232 sub setup_components {
2235 my $config = $class->config->{ setup_components };
2237 my @comps = sort { length $a <=> length $b }
2238 $class->locate_components($config);
2239 my %comps = map { $_ => 1 } @comps;
2241 my $deprecatedcatalyst_component_names = grep { /::[CMV]::/ } @comps;
2242 $class->log->warn(qq{Your application is using the deprecated ::[MVC]:: type naming scheme.\n}.
2243 qq{Please switch your class names to ::Model::, ::View:: and ::Controller: as appropriate.\n}
2244 ) if $deprecatedcatalyst_component_names;
2246 for my $component ( @comps ) {
2248 # We pass ignore_loaded here so that overlay files for (e.g.)
2249 # Model::DBI::Schema sub-classes are loaded - if it's in @comps
2250 # we know M::P::O found a file on disk so this is safe
2252 Catalyst::Utils::ensure_class_loaded( $component, { ignore_loaded => 1 } );
2254 # Needs to be done as soon as the component is loaded, as loading a sub-component
2255 # (next time round the loop) can cause us to get the wrong metaclass..
2256 $class->_controller_init_base_classes($component);
2259 for my $component (@comps) {
2260 my $instance = $class->components->{ $component } = $class->setup_component($component);
2261 my @expanded_components = $instance->can('expand_modules')
2262 ? $instance->expand_modules( $component, $config )
2263 : $class->expand_component_module( $component, $config );
2264 for my $component (@expanded_components) {
2265 next if $comps{$component};
2266 $class->_controller_init_base_classes($component); # Also cover inner packages
2267 $class->components->{ $component } = $class->setup_component($component);
2272 =head2 $c->locate_components( $setup_component_config )
2274 This method is meant to provide a list of component modules that should be
2275 setup for the application. By default, it will use L<Module::Pluggable>.
2277 Specify a C<setup_components> config option to pass additional options directly
2278 to L<Module::Pluggable>. To add additional search paths, specify a key named
2279 C<search_extra> as an array reference. Items in the array beginning with C<::>
2280 will have the application class name prepended to them.
2284 sub locate_components {
2288 my @paths = qw( ::Controller ::C ::Model ::M ::View ::V );
2289 my $extra = delete $config->{ search_extra } || [];
2291 push @paths, @$extra;
2293 my $locator = Module::Pluggable::Object->new(
2294 search_path => [ map { s/^(?=::)/$class/; $_; } @paths ],
2298 my @comps = $locator->plugins;
2303 =head2 $c->expand_component_module( $component, $setup_component_config )
2305 Components found by C<locate_components> will be passed to this method, which
2306 is expected to return a list of component (package) names to be set up.
2310 sub expand_component_module {
2311 my ($class, $module) = @_;
2312 return Devel::InnerPackage::list_packages( $module );
2315 =head2 $c->setup_component
2319 # FIXME - Ugly, ugly hack to ensure the we force initialize non-moose base classes
2320 # nearest to Catalyst::Controller first, no matter what order stuff happens
2321 # to be loaded. There are TODO tests in Moose for this, see
2322 # f2391d17574eff81d911b97be15ea51080500003
2323 sub _controller_init_base_classes {
2324 my ($app_class, $component) = @_;
2325 return unless $component->isa('Catalyst::Controller');
2326 foreach my $class ( reverse @{ mro::get_linear_isa($component) } ) {
2327 Moose::Meta::Class->initialize( $class )
2328 unless find_meta($class);
2332 sub setup_component {
2333 my( $class, $component ) = @_;
2335 unless ( $component->can( 'COMPONENT' ) ) {
2339 my $suffix = Catalyst::Utils::class2classsuffix( $component );
2340 my $config = $class->config->{ $suffix } || {};
2341 # Stash catalyst_component_name in the config here, so that custom COMPONENT
2342 # methods also pass it. local to avoid pointlessly shitting in config
2343 # for the debug screen, as $component is already the key name.
2344 local $config->{catalyst_component_name} = $component;
2346 my $instance = eval { $component->COMPONENT( $class, $config ); };
2348 if ( my $error = $@ ) {
2350 Catalyst::Exception->throw(
2351 message => qq/Couldn't instantiate component "$component", "$error"/
2355 unless (blessed $instance) {
2356 my $metaclass = Moose::Util::find_meta($component);
2357 my $method_meta = $metaclass->find_method_by_name('COMPONENT');
2358 my $component_method_from = $method_meta->associated_metaclass->name;
2359 my $value = defined($instance) ? $instance : 'undef';
2360 Catalyst::Exception->throw(
2362 qq/Couldn't instantiate component "$component", COMPONENT() method (from $component_method_from) didn't return an object-like value (value was $value)./
2368 =head2 $c->setup_dispatcher
2374 sub setup_dispatcher {
2375 my ( $class, $dispatcher ) = @_;
2378 $dispatcher = 'Catalyst::Dispatcher::' . $dispatcher;
2381 if ( my $env = Catalyst::Utils::env_value( $class, 'DISPATCHER' ) ) {
2382 $dispatcher = 'Catalyst::Dispatcher::' . $env;
2385 unless ($dispatcher) {
2386 $dispatcher = $class->dispatcher_class;
2389 Class::MOP::load_class($dispatcher);
2391 # dispatcher instance
2392 $class->dispatcher( $dispatcher->new );
2395 =head2 $c->setup_engine
2402 my ( $class, $engine ) = @_;
2405 $engine = 'Catalyst::Engine::' . $engine;
2408 if ( my $env = Catalyst::Utils::env_value( $class, 'ENGINE' ) ) {
2409 $engine = 'Catalyst::Engine::' . $env;
2412 if ( $ENV{MOD_PERL} ) {
2413 my $meta = Class::MOP::get_metaclass_by_name($class);
2415 # create the apache method
2416 $meta->add_method('apache' => sub { shift->engine->apache });
2418 my ( $software, $version ) =
2419 $ENV{MOD_PERL} =~ /^(\S+)\/(\d+(?:[\.\_]\d+)+)/;
2422 $version =~ s/(\.[^.]+)\./$1/g;
2424 if ( $software eq 'mod_perl' ) {
2428 if ( $version >= 1.99922 ) {
2429 $engine = 'Catalyst::Engine::Apache2::MP20';
2432 elsif ( $version >= 1.9901 ) {
2433 $engine = 'Catalyst::Engine::Apache2::MP19';
2436 elsif ( $version >= 1.24 ) {
2437 $engine = 'Catalyst::Engine::Apache::MP13';
2441 Catalyst::Exception->throw( message =>
2442 qq/Unsupported mod_perl version: $ENV{MOD_PERL}/ );
2447 # install the correct mod_perl handler
2448 if ( $version >= 1.9901 ) {
2449 *handler = sub : method {
2450 shift->handle_request(@_);
2454 *handler = sub ($$) { shift->handle_request(@_) };
2459 elsif ( $software eq 'Zeus-Perl' ) {
2460 $engine = 'Catalyst::Engine::Zeus';
2464 Catalyst::Exception->throw(
2465 message => qq/Unsupported mod_perl: $ENV{MOD_PERL}/ );
2470 $engine = $class->engine_class;
2473 Class::MOP::load_class($engine);
2475 # check for old engines that are no longer compatible
2477 if ( $engine->isa('Catalyst::Engine::Apache')
2478 && !Catalyst::Engine::Apache->VERSION )
2483 elsif ( $engine->isa('Catalyst::Engine::Server::Base')
2484 && Catalyst::Engine::Server->VERSION le '0.02' )
2489 elsif ($engine->isa('Catalyst::Engine::HTTP::POE')
2490 && $engine->VERSION eq '0.01' )
2495 elsif ($engine->isa('Catalyst::Engine::Zeus')
2496 && $engine->VERSION eq '0.01' )
2502 Catalyst::Exception->throw( message =>
2503 qq/Engine "$engine" is not supported by this version of Catalyst/
2508 $class->engine( $engine->new );
2511 =head2 $c->setup_home
2513 Sets up the home directory.
2518 my ( $class, $home ) = @_;
2520 if ( my $env = Catalyst::Utils::env_value( $class, 'HOME' ) ) {
2524 $home ||= Catalyst::Utils::home($class);
2527 #I remember recently being scolded for assigning config values like this
2528 $class->config->{home} ||= $home;
2529 $class->config->{root} ||= Path::Class::Dir->new($home)->subdir('root');
2533 =head2 $c->setup_log
2535 Sets up log by instantiating a L<Catalyst::Log|Catalyst::Log> object and
2536 passing it to C<log()>. Pass in a comma-delimited list of levels to set the
2539 This method also installs a C<debug> method that returns a true value into the
2540 catalyst subclass if the "debug" level is passed in the comma-delimited list,
2541 or if the C<$CATALYST_DEBUG> environment variable is set to a true value.
2543 Note that if the log has already been setup, by either a previous call to
2544 C<setup_log> or by a call such as C<< __PACKAGE__->log( MyLogger->new ) >>,
2545 that this method won't actually set up the log object.
2550 my ( $class, $levels ) = @_;
2553 $levels =~ s/^\s+//;
2554 $levels =~ s/\s+$//;
2555 my %levels = map { $_ => 1 } split /\s*,\s*/, $levels;
2557 my $env_debug = Catalyst::Utils::env_value( $class, 'DEBUG' );
2558 if ( defined $env_debug ) {
2559 $levels{debug} = 1 if $env_debug; # Ugly!
2560 delete($levels{debug}) unless $env_debug;
2563 unless ( $class->log ) {
2564 $class->log( Catalyst::Log->new(keys %levels) );
2567 if ( $levels{debug} ) {
2568 Class::MOP::get_metaclass_by_name($class)->add_method('debug' => sub { 1 });
2569 $class->log->debug('Debug messages enabled');
2573 =head2 $c->setup_plugins
2579 =head2 $c->setup_stats
2581 Sets up timing statistics class.
2586 my ( $class, $stats ) = @_;
2588 Catalyst::Utils::ensure_class_loaded($class->stats_class);
2590 my $env = Catalyst::Utils::env_value( $class, 'STATS' );
2591 if ( defined($env) ? $env : ($stats || $class->debug ) ) {
2592 Class::MOP::get_metaclass_by_name($class)->add_method('use_stats' => sub { 1 });
2593 $class->log->debug('Statistics enabled');
2598 =head2 $c->registered_plugins
2600 Returns a sorted list of the plugins which have either been stated in the
2601 import list or which have been added via C<< MyApp->plugin(@args); >>.
2603 If passed a given plugin name, it will report a boolean value indicating
2604 whether or not that plugin is loaded. A fully qualified name is required if
2605 the plugin name does not begin with C<Catalyst::Plugin::>.
2607 if ($c->registered_plugins('Some::Plugin')) {
2615 sub registered_plugins {
2617 return sort keys %{ $proto->_plugins } unless @_;
2619 return 1 if exists $proto->_plugins->{$plugin};
2620 return exists $proto->_plugins->{"Catalyst::Plugin::$plugin"};
2623 sub _register_plugin {
2624 my ( $proto, $plugin, $instant ) = @_;
2625 my $class = ref $proto || $proto;
2627 Class::MOP::load_class( $plugin );
2628 $class->log->warn( "$plugin inherits from 'Catalyst::Component' - this is decated and will not work in 5.81" )
2629 if $plugin->isa( 'Catalyst::Component' );
2630 $proto->_plugins->{$plugin} = 1;
2633 if ( my $meta = Class::MOP::get_metaclass_by_name($class) ) {
2634 my @superclasses = ($plugin, $meta->superclasses );
2635 $meta->superclasses(@superclasses);
2637 unshift @{"$class\::ISA"}, $plugin;
2644 my ( $class, $plugins ) = @_;
2646 $class->_plugins( {} ) unless $class->_plugins;
2649 my @plugins = Catalyst::Utils::resolve_namespace($class . '::Plugin', 'Catalyst::Plugin', @$plugins);
2651 for my $plugin ( reverse @plugins ) {
2652 Class::MOP::load_class($plugin);
2653 my $meta = find_meta($plugin);
2654 next if $meta && $meta->isa('Moose::Meta::Role');
2656 $class->_register_plugin($plugin);
2661 grep { $_ && blessed($_) && $_->isa('Moose::Meta::Role') }
2662 map { find_meta($_) }
2665 Moose::Util::apply_all_roles(
2673 Returns an arrayref of the internal execution stack (actions that are
2674 currently executing).
2676 =head2 $c->stats_class
2678 Returns or sets the stats (timing statistics) class.
2680 =head2 $c->use_stats
2682 Returns 1 when stats collection is enabled. Stats collection is enabled
2683 when the -Stats options is set, debug is on or when the <MYAPP>_STATS
2684 environment variable is set.
2686 Note that this is a static method, not an accessor and should be overridden
2687 by declaring C<sub use_stats { 1 }> in your MyApp.pm, not by calling C<< $c->use_stats(1) >>.
2694 =head2 $c->write( $data )
2696 Writes $data to the output stream. When using this method directly, you
2697 will need to manually set the C<Content-Length> header to the length of
2698 your output data, if known.
2705 # Finalize headers if someone manually writes output
2706 $c->finalize_headers;
2708 return $c->engine->write( $c, @_ );
2713 Returns the Catalyst version number. Mostly useful for "powered by"
2714 messages in template systems.
2718 sub version { return $Catalyst::VERSION }
2720 =head1 CONFIGURATION
2722 There are a number of 'base' config variables which can be set:
2728 C<default_model> - The default model picked if you say C<< $c->model >>. See L<< /$c->model($name) >>.
2732 C<default_view> - The default view to be rendered or returned when C<< $c->view >> is called. See L<< /$c->view($name) >>.
2736 C<disable_component_resolution_regex_fallback> - Turns
2737 off the deprecated component resolution functionality so
2738 that if any of the component methods (e.g. C<< $c->controller('Foo') >>)
2739 are called then regex search will not be attempted on string values and
2740 instead C<undef> will be returned.
2744 C<home> - The application home directory. In an uninstalled application,
2745 this is the top level application directory. In an installed application,
2746 this will be the directory containing C<< MyApp.pm >>.
2750 C<ignore_frontend_proxy> - See L</PROXY SUPPORT>
2754 C<name> - The name of the application in debug messages and the debug and
2759 C<parse_on_demand> - The request body (for example file uploads) will not be parsed
2760 until it is accessed. This allows you to (for example) check authentication (and reject
2761 the upload) before actually recieving all the data. See L</ON-DEMAND PARSER>
2765 C<root> - The root directory for templates. Usually this is just a
2766 subdirectory of the home directory, but you can set it to change the
2767 templates to a different directory.
2771 C<search_extra> - Array reference passed to Module::Pluggable to for additional
2772 namespaces from which components will be loaded (and constructed and stored in
2773 C<< $c->components >>).
2777 C<show_internal_actions> - If true, causes internal actions such as C<< _DISPATCH >>
2778 to be shown in hit debug tables in the test server.
2782 C<using_frontend_proxy> - See L</PROXY SUPPORT>.
2786 =head1 INTERNAL ACTIONS
2788 Catalyst uses internal actions like C<_DISPATCH>, C<_BEGIN>, C<_AUTO>,
2789 C<_ACTION>, and C<_END>. These are by default not shown in the private
2790 action table, but you can make them visible with a config parameter.
2792 MyApp->config(show_internal_actions => 1);
2794 =head1 ON-DEMAND PARSER
2796 The request body is usually parsed at the beginning of a request,
2797 but if you want to handle input yourself, you can enable on-demand
2798 parsing with a config parameter.
2800 MyApp->config(parse_on_demand => 1);
2802 =head1 PROXY SUPPORT
2804 Many production servers operate using the common double-server approach,
2805 with a lightweight frontend web server passing requests to a larger
2806 backend server. An application running on the backend server must deal
2807 with two problems: the remote user always appears to be C<127.0.0.1> and
2808 the server's hostname will appear to be C<localhost> regardless of the
2809 virtual host that the user connected through.
2811 Catalyst will automatically detect this situation when you are running
2812 the frontend and backend servers on the same machine. The following
2813 changes are made to the request.
2815 $c->req->address is set to the user's real IP address, as read from
2816 the HTTP X-Forwarded-For header.
2818 The host value for $c->req->base and $c->req->uri is set to the real
2819 host, as read from the HTTP X-Forwarded-Host header.
2821 Additionally, you may be running your backend application on an insecure
2822 connection (port 80) while your frontend proxy is running under SSL. If there
2823 is a discrepancy in the ports, use the HTTP header C<X-Forwarded-Port> to
2824 tell Catalyst what port the frontend listens on. This will allow all URIs to
2825 be created properly.
2827 In the case of passing in:
2829 X-Forwarded-Port: 443
2831 All calls to C<uri_for> will result in an https link, as is expected.
2833 Obviously, your web server must support these headers for this to work.
2835 In a more complex server farm environment where you may have your
2836 frontend proxy server(s) on different machines, you will need to set a
2837 configuration option to tell Catalyst to read the proxied data from the
2840 MyApp->config(using_frontend_proxy => 1);
2842 If you do not wish to use the proxy support at all, you may set:
2844 MyApp->config(ignore_frontend_proxy => 1);
2846 =head1 THREAD SAFETY
2848 Catalyst has been tested under Apache 2's threading C<mpm_worker>,
2849 C<mpm_winnt>, and the standalone forking HTTP server on Windows. We
2850 believe the Catalyst core to be thread-safe.
2852 If you plan to operate in a threaded environment, remember that all other
2853 modules you are using must also be thread-safe. Some modules, most notably
2854 L<DBD::SQLite>, are not thread-safe.
2860 Join #catalyst on irc.perl.org.
2864 http://lists.scsys.co.uk/cgi-bin/mailman/listinfo/catalyst
2865 http://lists.scsys.co.uk/cgi-bin/mailman/listinfo/catalyst-dev
2869 http://catalyst.perl.org
2873 http://dev.catalyst.perl.org
2877 =head2 L<Task::Catalyst> - All you need to start with Catalyst
2879 =head2 L<Catalyst::Manual> - The Catalyst Manual
2881 =head2 L<Catalyst::Component>, L<Catalyst::Controller> - Base classes for components
2883 =head2 L<Catalyst::Engine> - Core engine
2885 =head2 L<Catalyst::Log> - Log class.
2887 =head2 L<Catalyst::Request> - Request object
2889 =head2 L<Catalyst::Response> - Response object
2891 =head2 L<Catalyst::Test> - The test suite.
2893 =head1 PROJECT FOUNDER
2895 sri: Sebastian Riedel <sri@cpan.org>
2901 acme: Leon Brocard <leon@astray.com>
2903 abraxxa: Alexander Hartmaier <abraxxa@cpan.org>
2907 Andrew Ford E<lt>A.Ford@ford-mason.co.ukE<gt>
2911 andyg: Andy Grundman <andy@hybridized.org>
2913 audreyt: Audrey Tang
2915 bricas: Brian Cassidy <bricas@cpan.org>
2917 Caelum: Rafael Kitover <rkitover@io.com>
2919 chansen: Christian Hansen
2921 chicks: Christopher Hicks
2923 Chisel Wright C<pause@herlpacker.co.uk>
2925 Danijel Milicevic C<me@danijel.de>
2927 David Kamholz E<lt>dkamholz@cpan.orgE<gt>
2929 David Naughton, C<naughton@umn.edu>
2933 dhoss: Devin Austin <dhoss@cpan.org>
2935 dkubb: Dan Kubb <dan.kubb-cpan@onautopilot.com>
2939 dwc: Daniel Westermann-Clark <danieltwc@cpan.org>
2941 esskar: Sascha Kiefer
2943 fireartist: Carl Franks <cfranks@cpan.org>
2945 frew: Arthur Axel "fREW" Schmidt <frioux@gmail.com>
2947 gabb: Danijel Milicevic
2951 Gavin Henry C<ghenry@perl.me.uk>
2955 groditi: Guillermo Roditi <groditi@gmail.com>
2957 hobbs: Andrew Rodland <andrew@cleverdomain.org>
2959 ilmari: Dagfinn Ilmari Mannsåker <ilmari@ilmari.org>
2961 jcamacho: Juan Camacho
2963 jester: Jesse Sheidlower C<jester@panix.com>
2965 jhannah: Jay Hannah <jay@jays.net>
2971 jon: Jon Schutz <jjschutz@cpan.org>
2973 Jonathan Rockway C<< <jrockway@cpan.org> >>
2975 Kieren Diment C<kd@totaldatasolution.com>
2977 konobi: Scott McWhirter <konobi@cpan.org>
2979 marcus: Marcus Ramberg <mramberg@cpan.org>
2981 miyagawa: Tatsuhiko Miyagawa <miyagawa@bulknews.net>
2983 mst: Matt S. Trout <mst@shadowcatsystems.co.uk>
2987 naughton: David Naughton
2989 ningu: David Kamholz <dkamholz@cpan.org>
2991 nothingmuch: Yuval Kogman <nothingmuch@woobling.org>
2993 numa: Dan Sully <daniel@cpan.org>
2999 omega: Andreas Marienborg
3001 Oleg Kostyuk <cub.uanic@gmail.com>
3003 phaylon: Robert Sedlacek <phaylon@dunkelheit.at>
3005 rafl: Florian Ragwitz <rafl@debian.org>
3007 random: Roland Lammel <lammel@cpan.org>
3009 Robert Sedlacek C<< <rs@474.at> >>
3013 t0m: Tomas Doran <bobtfish@bobtfish.net>
3017 Viljo Marrandi C<vilts@yahoo.com>
3019 Will Hawes C<info@whawes.co.uk>
3021 willert: Sebastian Willert <willert@cpan.org>
3023 Yuval Kogman, C<nothingmuch@woobling.org>
3027 This library is free software. You can redistribute it and/or modify it under
3028 the same terms as Perl itself.
3034 __PACKAGE__->meta->make_immutable;