4 use base 'Catalyst::Component';
6 use UNIVERSAL::require;
7 use Catalyst::Exception;
10 use Catalyst::Request::Upload;
11 use Catalyst::Response;
13 use Catalyst::Controller;
16 use Text::SimpleTable;
18 use Path::Class::File;
19 use Time::HiRes qw/gettimeofday tv_interval/;
21 use Scalar::Util qw/weaken blessed/;
22 use Tree::Simple qw/use_weak_refs/;
23 use Tree::Simple::Visitor::FindByUID;
28 __PACKAGE__->mk_accessors(
29 qw/counter request response state action stack namespace stats/
32 attributes->import( __PACKAGE__, \&namespace, 'lvalue' );
34 sub depth { scalar @{ shift->stack || [] }; }
41 # For backwards compatibility
42 *finalize_output = \&finalize_body;
47 our $RECURSION = 1000;
48 our $DETACH = "catalyst_detach\n";
50 require Module::Pluggable::Fast;
52 # Helper script generation
53 our $CATALYST_SCRIPT_GEN = 27;
55 __PACKAGE__->mk_classdata($_)
56 for qw/components arguments dispatcher engine log dispatcher_class
57 engine_class context_class request_class response_class setup_finished/;
59 __PACKAGE__->dispatcher_class('Catalyst::Dispatcher');
60 __PACKAGE__->engine_class('Catalyst::Engine::CGI');
61 __PACKAGE__->request_class('Catalyst::Request');
62 __PACKAGE__->response_class('Catalyst::Response');
64 our $VERSION = '5.66';
67 my ( $class, @arguments ) = @_;
69 # We have to limit $class to Catalyst to avoid pushing Catalyst upon every
71 return unless $class eq 'Catalyst';
73 my $caller = caller(0);
75 unless ( $caller->isa('Catalyst') ) {
77 push @{"$caller\::ISA"}, $class, 'Catalyst::Controller';
80 $caller->arguments( [@arguments] );
86 Catalyst - The Elegant MVC Web Application Framework
90 # use the helper to start a new application
93 # add models, views, controllers
94 script/myapp_create.pl model Database DBIC dbi:SQLite:/path/to/db
95 script/myapp_create.pl view TT TT
96 script/myapp_create.pl controller Search
98 # built in testserver -- use -r to restart automatically on changes
99 script/myapp_server.pl
101 # command line testing interface
102 script/myapp_test.pl /yada
105 use Catalyst qw/-Debug/; # include plugins here as well
107 sub foo : Global { # called for /foo, /foo/1, /foo/1/2, etc.
108 my ( $self, $c, @args ) = @_; # args are qw/1 2/ for /foo/1/2
109 $c->stash->{template} = 'foo.tt'; # set the template
110 # lookup something from db -- stash vars are passed to TT
112 MyApp::Model::Database::Foo->search( { country => $args[0] } );
113 if ( $c->req->params->{bar} ) { # access GET or POST parameters
114 $c->forward( 'bar' ); # process another action
115 # do something else after forward returns
119 # The foo.tt TT template can use the stash data from the database
120 [% WHILE (item = data.next) %]
124 # called for /bar/of/soap, /bar/of/soap/10, etc.
125 sub bar : Path('/bar/of/soap') { ... }
127 # called for all actions, from the top-most controller downwards
129 my ( $self, $c ) = @_;
131 $c->res->redirect( '/login' ); # require login
132 return 0; # abort request and go immediately to end()
134 return 1; # success; carry on to next action
137 # called after all actions are finished
139 my ( $self, $c ) = @_;
140 if ( scalar @{ $c->error } ) { ... } # handle errors
141 return if $c->res->body; # already have a response
142 $c->forward( 'MyApp::View::TT' ); # render template
145 ### in MyApp/Controller/Foo.pm
146 # called for /foo/bar
147 sub bar : Local { ... }
149 # called for /blargle
150 sub blargle : Global { ... }
152 # an index action matches /foo, but not /foo/1, etc.
153 sub index : Private { ... }
155 ### in MyApp/Controller/Foo/Bar.pm
156 # called for /foo/bar/baz
157 sub baz : Local { ... }
159 # first MyApp auto is called, then Foo auto, then this
160 sub auto : Private { ... }
162 # powerful regular expression paths are also possible
163 sub details : Regex('^product/(\w+)/details$') {
164 my ( $self, $c ) = @_;
165 # extract the (\w+) from the URI
166 my $product = $c->req->snippets->[0];
169 See L<Catalyst::Manual::Intro> for additional information.
173 The key concept of Catalyst is DRY (Don't Repeat Yourself).
175 See L<Catalyst::Manual> for more documentation.
177 Catalyst plugins can be loaded by naming them as arguments to the "use
178 Catalyst" statement. Omit the C<Catalyst::Plugin::> prefix from the
179 plugin name, i.e., C<Catalyst::Plugin::My::Module> becomes
182 use Catalyst qw/My::Module/;
184 If your plugin starts with a name other than C<Catalyst::Plugin::>, you can
185 fully qualify the name by using a unary plus:
189 +Fully::Qualified::Plugin::Name
192 Special flags like C<-Debug> and C<-Engine> can also be specified as
193 arguments when Catalyst is loaded:
195 use Catalyst qw/-Debug My::Module/;
197 The position of plugins and flags in the chain is important, because
198 they are loaded in exactly the order in which they appear.
200 The following flags are supported:
204 Enables debug output.
208 Forces Catalyst to use a specific engine. Omit the
209 C<Catalyst::Engine::> prefix of the engine name, i.e.:
211 use Catalyst qw/-Engine=CGI/;
215 Forces Catalyst to use a specific home directory, e.g.:
217 use Catalyst qw[-Home=/usr/sri];
225 =head2 INFORMATION ABOUT THE CURRENT REQUEST
229 Returns a L<Catalyst::Action> object for the current action, which
230 stringifies to the action name. See L<Catalyst::Action>.
234 Returns the namespace of the current action, i.e., the uri prefix
235 corresponding to the controller of the current action. For example:
237 # in Controller::Foo::Bar
238 $c->namespace; # returns 'foo/bar';
244 Returns the current L<Catalyst::Request> object. See
245 L<Catalyst::Request>.
247 =head2 PROCESSING AND RESPONSE TO THE CURRENT REQUEST
249 =head2 $c->forward( $action [, \@arguments ] )
251 =head2 $c->forward( $class, $method, [, \@arguments ] )
253 Forwards processing to a private action. If you give a class name but no
254 method, C<process()> is called. You may also optionally pass arguments
255 in an arrayref. The action will receive the arguments in C<@_> and
256 C<$c-E<gt>req-E<gt>args>. Upon returning from the function,
257 C<$c-E<gt>req-E<gt>args> will be restored to the previous values.
259 Any data C<return>ed from the action forwarded to, will be returned by the
262 my $foodata = $c->forward('/foo');
263 $c->forward('index');
264 $c->forward(qw/MyApp::Model::DBIC::Foo do_stuff/);
265 $c->forward('MyApp::View::TT');
269 sub forward { my $c = shift; $c->dispatcher->forward( $c, @_ ) }
271 =head2 $c->detach( $action [, \@arguments ] )
273 =head2 $c->detach( $class, $method, [, \@arguments ] )
275 The same as C<forward>, but doesn't return.
279 sub detach { my $c = shift; $c->dispatcher->detach( $c, @_ ) }
283 =head2 $c->error($error, ...)
285 =head2 $c->error($arrayref)
287 Returns an arrayref containing error messages. If Catalyst encounters an
288 error while processing a request, it stores the error in $c->error. This
289 method should not be used to store non-fatal error messages.
291 my @error = @{ $c->error };
295 $c->error('Something bad happened');
302 my $error = ref $_[0] eq 'ARRAY' ? $_[0] : [@_];
303 croak @$error unless ref $c;
304 push @{ $c->{error} }, @$error;
306 elsif ( defined $_[0] ) { $c->{error} = undef }
307 return $c->{error} || [];
310 =head2 $c->clear_errors
312 Clear errors. You probably don't want to clear the errors unless you are
313 implementing a custom error screen.
315 This is equivalent to running
330 Returns the current L<Catalyst::Response> object.
334 Returns a hashref to the stash, which may be used to store data and pass
335 it between components during a request. You can also set hash keys by
336 passing arguments. The stash is automatically sent to the view. The
337 stash is cleared at the end of a request; it cannot be used for
340 $c->stash->{foo} = $bar;
341 $c->stash( { moose => 'majestic', qux => 0 } );
342 $c->stash( bar => 1, gorch => 2 ); # equivalent to passing a hashref
344 # stash is automatically passed to the view for use in a template
345 $c->forward( 'MyApp::V::TT' );
352 my $stash = @_ > 1 ? {@_} : $_[0];
353 while ( my ( $key, $val ) = each %$stash ) {
354 $c->{stash}->{$key} = $val;
362 Contains the return value of the last executed action.
368 my ( $c, @names ) = @_;
370 foreach my $name (@names) {
371 foreach my $component ( keys %{ $c->components } ) {
372 return $c->components->{$component} if $component =~ /$name/i;
379 # try explicit component names
381 my ( $c, @names ) = @_;
383 foreach my $try (@names) {
384 return $c->components->{$try} if ( exists $c->components->{$try} );
390 # like component, but try just these prefixes before regex searching,
391 # and do not try to return "sort keys %{ $c->components }"
393 my ( $c, $name, @prefixes ) = @_;
395 my $appclass = ref $c || $c;
397 my @names = map { "${appclass}::${_}::${name}" } @prefixes;
399 my $comp = $c->_comp_explicit(@names);
400 return $comp if defined($comp);
401 $comp = $c->_comp_search($name);
405 # Find possible names for a prefix
408 my ( $c, @prefixes ) = @_;
410 my $appclass = ref $c || $c;
412 my @pre = map { "${appclass}::${_}::" } @prefixes;
416 COMPONENT: foreach my $comp ($c->component) {
417 foreach my $p (@pre) {
418 if ($comp =~ s/^$p//) {
428 # Return a component if only one matches.
430 my ( $c, @prefixes ) = @_;
432 my $appclass = ref $c || $c;
434 my ( $comp, $rest ) =
435 map { $c->_comp_search("^${appclass}::${_}::") } @prefixes;
436 return $comp unless $rest;
439 # Filter a component before returning by calling ACCEPT_CONTEXT if available
440 sub _filter_component {
441 my ( $c, $comp, @args ) = @_;
442 if ( eval { $comp->can('ACCEPT_CONTEXT'); } ) {
443 return $comp->ACCEPT_CONTEXT( $c, @args );
445 else { return $comp }
448 =head2 COMPONENT ACCESSORS
450 =head2 $c->comp($name)
452 =head2 $c->component($name)
454 Gets a component object by name. This method is no longer recommended,
455 unless you want to get a specific component by full
456 class. C<$c-E<gt>controller>, C<$c-E<gt>model>, and C<$c-E<gt>view>
457 should be used instead.
468 my $appclass = ref $c || $c;
471 $name, "${appclass}::${name}",
472 map { "${appclass}::${_}::${name}" }
473 qw/Model M Controller C View V/
476 my $comp = $c->_comp_explicit(@names);
477 return $c->_filter_component( $comp, @_ ) if defined($comp);
479 $comp = $c->_comp_search($name);
480 return $c->_filter_component( $comp, @_ ) if defined($comp);
483 return sort keys %{ $c->components };
486 =head2 $c->controller($name)
488 Gets a L<Catalyst::Controller> instance by name.
490 $c->controller('Foo')->do_stuff;
492 If name is omitted, will return the controller for the dispatched action.
497 my ( $c, $name, @args ) = @_;
498 return $c->_filter_component( $c->_comp_prefixes( $name, qw/Controller C/ ),
501 return $c->component( $c->action->class );
504 =head2 $c->controllers
506 Returns the available names which can be passed to $c->controller
512 return $c->_comp_names(qw/Controller C/);
515 =head2 $c->model($name)
517 Gets a L<Catalyst::Model> instance by name.
519 $c->model('Foo')->do_stuff;
521 If the name is omitted, it will look for a config setting 'default_model',
522 or check if there is only one model, and forward to it if that's the case.
527 my ( $c, $name, @args ) = @_;
528 return $c->_filter_component( $c->_comp_prefixes( $name, qw/Model M/ ),
531 return $c->component( $c->config->{default_model} )
532 if $c->config->{default_model};
533 return $c->_filter_component( $c->_comp_singular(qw/Model M/), @args );
539 Returns the available names which can be passed to $c->model
545 return $c->_comp_names(qw/Model M/);
548 =head2 $c->view($name)
550 Gets a L<Catalyst::View> instance by name.
552 $c->view('Foo')->do_stuff;
554 If the name is omitted, it will look for a config setting 'default_view',
555 or check if there is only one view, and forward to it if that's the case.
560 my ( $c, $name, @args ) = @_;
561 return $c->_filter_component( $c->_comp_prefixes( $name, qw/View V/ ),
564 return $c->component( $c->config->{default_view} )
565 if $c->config->{default_view};
566 return $c->_filter_component( $c->_comp_singular(qw/View V/) );
571 Returns the available names which can be passed to $c->view
577 return $c->_comp_names(qw/View V/);
580 =head2 Class data and helper classes
584 Returns or takes a hashref containing the application's configuration.
586 __PACKAGE__->config( { db => 'dsn:SQLite:foo.db' } );
588 You can also use a L<YAML> config file like myapp.yml in your
589 applications home directory.
592 db: dsn:SQLite:foo.db
599 $c->log->warn("Setting config after setup has been run is not a good idea.")
600 if ( @_ and $c->setup_finished );
602 $c->NEXT::config(@_);
607 Overload to enable debug messages (same as -Debug option).
613 =head2 $c->dispatcher
615 Returns the dispatcher instance. Stringifies to class name. See
616 L<Catalyst::Dispatcher>.
620 Returns the engine instance. Stringifies to the class name. See
625 Returns the logging object instance. Unless it is already set, Catalyst sets
626 this up with a L<Catalyst::Log> object. To use your own log class, set the
627 logger with the C<< __PACKAGE__->log >> method prior to calling
628 C<< __PACKAGE__->setup >>.
630 __PACKAGE__->log( MyLogger->new );
635 $c->log->info( 'Now logging with my own logger!' );
637 Your log class should implement the methods described in the
638 L<Catalyst::Log> man page.
642 =head2 UTILITY METHODS
644 =head2 $c->path_to(@path)
646 Merges C<@path> with C<$c-E<gt>config-E<gt>{home}> and returns a
647 L<Path::Class> object.
651 $c->path_to( 'db', 'sqlite.db' );
656 my ( $c, @path ) = @_;
657 my $path = Path::Class::Dir->new( $c->config->{home}, @path );
658 if ( -d $path ) { return $path }
659 else { return Path::Class::File->new( $c->config->{home}, @path ) }
662 =head2 $c->plugin( $name, $class, @args )
664 Helper method for plugins. It creates a classdata accessor/mutator and
665 loads and instantiates the given class.
667 MyApp->plugin( 'prototype', 'HTML::Prototype' );
669 $c->prototype->define_javascript_functions;
674 my ( $class, $name, $plugin, @args ) = @_;
675 $class->_register_plugin( $plugin, 1 );
677 eval { $plugin->import };
678 $class->mk_classdata($name);
680 eval { $obj = $plugin->new(@args) };
683 Catalyst::Exception->throw( message =>
684 qq/Couldn't instantiate instant plugin "$plugin", "$@"/ );
688 $class->log->debug(qq/Initialized instant plugin "$plugin" as "$name"/)
694 Initializes the dispatcher and engine, loads any plugins, and loads the
695 model, view, and controller components. You may also specify an array
696 of plugins to load here, if you choose to not load them in the C<use
700 MyApp->setup( qw/-Debug/ );
705 my ( $class, @arguments ) = @_;
707 unless ( $class->isa('Catalyst') ) {
709 Catalyst::Exception->throw(
710 message => qq/'$class' does not inherit from Catalyst/ );
713 if ( $class->arguments ) {
714 @arguments = ( @arguments, @{ $class->arguments } );
720 foreach (@arguments) {
724 ( $flags->{log} ) ? 'debug,' . $flags->{log} : 'debug';
726 elsif (/^-(\w+)=?(.*)$/) {
727 $flags->{ lc $1 } = $2;
730 push @{ $flags->{plugins} }, $_;
734 $class->setup_home( delete $flags->{home} );
736 $class->setup_log( delete $flags->{log} );
737 $class->setup_plugins( delete $flags->{plugins} );
738 $class->setup_dispatcher( delete $flags->{dispatcher} );
739 $class->setup_engine( delete $flags->{engine} );
741 for my $flag ( sort keys %{$flags} ) {
743 if ( my $code = $class->can( 'setup_' . $flag ) ) {
744 &$code( $class, delete $flags->{$flag} );
747 $class->log->warn(qq/Unknown flag "$flag"/);
752 <<"EOF") if ( $ENV{CATALYST_SCRIPT_GEN} && ( $ENV{CATALYST_SCRIPT_GEN} < $Catalyst::CATALYST_SCRIPT_GEN ) );
753 You are running an old script!
755 Please update by running (this will overwrite existing files):
756 catalyst.pl -force -scripts $class
758 or (this will not overwrite existing files):
759 catalyst.pl -scripts $class
762 if ( $class->debug ) {
769 map { $_ . ' ' . ( $_->VERSION || '' ) }
770 grep { /^Catalyst::Plugin/ } @{"$class\::ISA"};
774 my $t = Text::SimpleTable->new(76);
775 $t->row($_) for @plugins;
776 $class->log->debug( "Loaded plugins:\n" . $t->draw );
779 my $dispatcher = $class->dispatcher;
780 my $engine = $class->engine;
781 my $home = $class->config->{home};
783 $class->log->debug(qq/Loaded dispatcher "$dispatcher"/);
784 $class->log->debug(qq/Loaded engine "$engine"/);
788 ? $class->log->debug(qq/Found home "$home"/)
789 : $class->log->debug(qq/Home "$home" doesn't exist/)
790 : $class->log->debug(q/Couldn't find home/);
795 no warnings qw/redefine/;
796 local *setup = sub { };
800 # Initialize our data structure
801 $class->components( {} );
803 $class->setup_components;
805 if ( $class->debug ) {
806 my $t = Text::SimpleTable->new( [ 65, 'Class' ], [ 8, 'Type' ] );
807 for my $comp ( sort keys %{ $class->components } ) {
808 my $type = ref $class->components->{$comp} ? 'instance' : 'class';
809 $t->row( $comp, $type );
811 $class->log->debug( "Loaded components:\n" . $t->draw )
812 if ( keys %{ $class->components } );
815 # Add our self to components, since we are also a component
816 $class->components->{$class} = $class;
818 $class->setup_actions;
820 if ( $class->debug ) {
821 my $name = $class->config->{name} || 'Application';
822 $class->log->info("$name powered by Catalyst $Catalyst::VERSION");
824 $class->log->_flush() if $class->log->can('_flush');
826 $class->setup_finished(1);
829 =head2 $c->uri_for( $path, @args?, \%query_values? )
831 Merges path with C<$c-E<gt>request-E<gt>base> for absolute uri's and
832 with C<$c-E<gt>namespace> for relative uri's, then returns a
833 normalized L<URI> object. If any args are passed, they are added at the
834 end of the path. If the last argument to uri_for is a hash reference,
835 it is assumed to contain GET parameter key/value pairs, which will be
836 appended to the URI in standard fashion.
841 my ( $c, $path, @args ) = @_;
842 my $base = $c->request->base->clone;
843 my $basepath = $base->path;
844 $basepath =~ s/\/$//;
846 my $namespace = $c->namespace;
848 # massage namespace, empty if absolute path
849 $namespace =~ s/^\///;
850 $namespace .= '/' if $namespace;
852 $namespace = '' if $path =~ /^\//;
856 ( scalar @args && ref $args[$#args] eq 'HASH' ? pop @args : {} );
858 for my $value ( values %$params ) {
\r
859 my $isa_ref = ref $value;
\r
860 if( $isa_ref and $isa_ref ne 'ARRAY' ) {
\r
861 croak( "Non-array reference ($isa_ref) passed to uri_for()" );
\r
863 utf8::encode( $_ ) for $isa_ref ? @$value : $value;
\r
866 # join args with '/', or a blank string
867 my $args = ( scalar @args ? '/' . join( '/', @args ) : '' );
868 $args =~ s/^\/// unless $path;
870 URI->new_abs( URI->new_abs( "$path$args", "$basepath$namespace" ), $base )
872 $res->query_form(%$params);
876 =head2 $c->welcome_message
878 Returns the Catalyst welcome HTML page.
882 sub welcome_message {
884 my $name = $c->config->{name};
885 my $logo = $c->uri_for('/static/images/catalyst_logo.png');
886 my $prefix = Catalyst::Utils::appprefix( ref $c );
887 $c->response->content_type('text/html; charset=utf-8');
889 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
890 "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
891 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
893 <meta http-equiv="Content-Language" content="en" />
894 <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
895 <title>$name on Catalyst $VERSION</title>
896 <style type="text/css">
899 background-color: #eee;
908 background-color: #ccc;
909 border: 1px solid #aaa;
910 -moz-border-radius: 10px;
915 font-family: verdana, tahoma, sans-serif;
918 font-family: verdana, tahoma, sans-serif;
921 text-decoration: none;
923 border-bottom: 1px dotted #bbb;
925 :link:hover, :visited:hover {
938 background-color: #fff;
939 border: 1px solid #aaa;
940 -moz-border-radius: 10px;
966 <h1><span id="appname">$name</span> on <a href="http://catalyst.perl.org">Catalyst</a>
971 <img src="$logo" alt="Catalyst Logo" />
973 <p>Welcome to the wonderful world of Catalyst.
974 This <a href="http://en.wikipedia.org/wiki/MVC">MVC</a>
975 framework will make web development something you had
976 never expected it to be: Fun, rewarding, and quick.</p>
977 <h2>What to do now?</h2>
978 <p>That really depends on what <b>you</b> want to do.
979 We do, however, provide you with a few starting points.</p>
980 <p>If you want to jump right into web development with Catalyst
981 you might want to check out the documentation.</p>
982 <pre><code>perldoc <a href="http://cpansearch.perl.org/dist/Catalyst/lib/Catalyst/Manual/Intro.pod">Catalyst::Manual::Intro</a>
983 perldoc <a href="http://cpansearch.perl.org/dist/Catalyst/lib/Catalyst/Manual/Tutorial.pod">Catalyst::Manual::Tutorial</a></code>
984 perldoc <a href="http://cpansearch.perl.org/dist/Catalyst/lib/Catalyst/Manual.pod">Catalyst::Manual</a></code></pre>
985 <h2>What to do next?</h2>
986 <p>Next it's time to write an actual application. Use the
987 helper scripts to generate <a href="http://cpansearch.perl.org/search?query=Catalyst%3A%3AController%3A%3A&mode=all">controllers</a>,
988 <a href="http://cpansearch.perl.org/search?query=Catalyst%3A%3AModel%3A%3A&mode=all">models</a>, and
989 <a href="http://cpansearch.perl.org/search?query=Catalyst%3A%3AView%3A%3A&mode=all">views</a>;
990 they can save you a lot of work.</p>
991 <pre><code>script/${prefix}_create.pl -help</code></pre>
992 <p>Also, be sure to check out the vast and growing
993 collection of <a href="http://cpansearch.perl.org/search?query=Catalyst%3A%3APlugin%3A%3A&mode=all">plugins for Catalyst on CPAN</a>;
994 you are likely to find what you need there.
998 <p>Catalyst has a very active community. Here are the main places to
999 get in touch with us.</p>
1002 <a href="http://dev.catalyst.perl.org">Wiki</a>
1005 <a href="http://lists.rawmode.org/mailman/listinfo/catalyst">Mailing-List</a>
1008 <a href="irc://irc.perl.org/catalyst">IRC channel #catalyst on irc.perl.org</a>
1011 <h2>In conclusion</h2>
1012 <p>The Catalyst team hopes you will enjoy using Catalyst as much
1013 as we enjoyed making it. Please contact us if you have ideas
1014 for improvement or other feedback.</p>
1022 =head1 INTERNAL METHODS
1024 These methods are not meant to be used by end users.
1026 =head2 $c->components
1028 Returns a hash of components.
1030 =head2 $c->context_class
1032 Returns or sets the context class.
1036 Returns a hashref containing coderefs and execution counts (needed for
1037 deep recursion detection).
1041 Returns the number of actions on the current internal execution stack.
1045 Dispatches a request to actions.
1049 sub dispatch { my $c = shift; $c->dispatcher->dispatch( $c, @_ ) }
1051 =head2 $c->dispatcher_class
1053 Returns or sets the dispatcher class.
1055 =head2 $c->dump_these
1057 Returns a list of 2-element array references (name, structure) pairs
1058 that will be dumped on the error page in debug mode.
1064 [ Request => $c->req ], [ Response => $c->res ], [ Stash => $c->stash ],;
1067 =head2 $c->engine_class
1069 Returns or sets the engine class.
1071 =head2 $c->execute( $class, $coderef )
1073 Execute a coderef in given class and catch exceptions. Errors are available
1079 my ( $c, $class, $code ) = @_;
1080 $class = $c->component($class) || $class;
1083 if ( $c->depth >= $RECURSION ) {
1084 my $action = "$code";
1085 $action = "/$action" unless $action =~ /\-\>/;
1086 my $error = qq/Deep recursion detected calling "$action"/;
1087 $c->log->error($error);
1093 my $stats_info = $c->_stats_start_execute( $code );
1095 push( @{ $c->stack }, $code );
1097 eval { $c->state( &$code( $class, $c, @{ $c->req->args } ) || 0 ) };
1099 $c->_stats_finish_execute( $stats_info );
1101 my $last = ${ $c->stack }[-1];
1102 pop( @{ $c->stack } );
1104 if ( my $error = $@ ) {
1105 if ( $error eq $DETACH ) { die $DETACH if $c->depth > 1 }
1107 unless ( ref $error ) {
1109 my $class = $last->class;
1110 my $name = $last->name;
1111 $error = qq/Caught exception in $class->$name "$error"/;
1120 sub _stats_start_execute {
1121 my ( $c, $code ) = @_;
1123 return unless $c->debug;
1125 my $action = "$code";
1127 $action = "/$action" unless $action =~ /\-\>/;
1128 $c->counter->{"$code"}++;
1130 # determine if the call was the result of a forward
1131 # this is done by walking up the call stack and looking for a calling
1132 # sub of Catalyst::forward before the eval
1134 for my $index ( 2 .. 11 ) {
1136 if ( ( caller($index) )[0] eq 'Catalyst'
1137 && ( caller($index) )[3] eq '(eval)' );
1139 if ( ( caller($index) )[3] =~ /forward$/ ) {
1140 $callsub = ( caller($index) )[3];
1141 $action = "-> $action";
1146 my $node = Tree::Simple->new(
1149 elapsed => undef, # to be filled in later
1153 $node->setUID( "$code" . $c->counter->{"$code"} );
1155 unless ( ( $code->name =~ /^_.*/ )
1156 && ( !$c->config->{show_internal_actions} ) )
1158 # is this a root-level call or a forwarded call?
1159 if ( $callsub =~ /forward$/ ) {
1161 # forward, locate the caller
1162 if ( my $parent = $c->stack->[-1] ) {
1163 my $visitor = Tree::Simple::Visitor::FindByUID->new;
1164 $visitor->searchForUID(
1165 "$parent" . $c->counter->{"$parent"} );
1166 $c->stats->accept($visitor);
1167 if ( my $result = $visitor->getResult ) {
1168 $result->addChild($node);
1173 # forward with no caller may come from a plugin
1174 $c->stats->addChild($node);
1180 $c->stats->addChild($node);
1184 my $start = [gettimeofday];
1185 my $elapsed = tv_interval($start);
1189 elapsed => $elapsed,
1195 sub _stats_finish_execute {
1196 my ( $c, $info ) = @_;
1198 return unless $c->debug;
1200 my ( $code, $start, $elapsed ) = @{ $info }{qw/code start elapsed/};
1202 unless ( ( $code->name =~ /^_.*/ )
1203 && ( !$c->config->{show_internal_actions} ) )
1206 # FindByUID uses an internal die, so we save the existing error
1209 # locate the node in the tree and update the elapsed time
1210 my $visitor = Tree::Simple::Visitor::FindByUID->new;
1211 $visitor->searchForUID( "$code" . $c->counter->{"$code"} );
1212 $c->stats->accept($visitor);
1213 if ( my $result = $visitor->getResult ) {
1214 my $value = $result->getNodeValue;
1215 $value->{elapsed} = sprintf( '%fs', $elapsed );
1216 $result->setNodeValue($value);
1220 $@ = $error || undef;
1224 =head2 $c->_localize_fields( sub { }, \%keys );
1228 sub _localize_fields {
1229 my ( $c, $localized, $code ) = ( @_ );
1231 my $request = delete $localized->{request} || {};
1232 my $response = delete $localized->{response} || {};
1234 local @{ $c }{ keys %$localized } = values %$localized;
1235 local @{ $c->request }{ keys %$request } = values %$request;
1236 local @{ $c->response }{ keys %$response } = values %$response;
1243 Finalizes the request.
1250 for my $error ( @{ $c->error } ) {
1251 $c->log->error($error);
1254 # Allow engine to handle finalize flow (for POE)
1255 if ( $c->engine->can('finalize') ) {
1256 $c->engine->finalize( $c );
1260 $c->finalize_uploads;
1263 if ( $#{ $c->error } >= 0 ) {
1267 $c->finalize_headers;
1270 if ( $c->request->method eq 'HEAD' ) {
1271 $c->response->body('');
1277 return $c->response->status;
1280 =head2 $c->finalize_body
1286 sub finalize_body { my $c = shift; $c->engine->finalize_body( $c, @_ ) }
1288 =head2 $c->finalize_cookies
1294 sub finalize_cookies { my $c = shift; $c->engine->finalize_cookies( $c, @_ ) }
1296 =head2 $c->finalize_error
1302 sub finalize_error { my $c = shift; $c->engine->finalize_error( $c, @_ ) }
1304 =head2 $c->finalize_headers
1310 sub finalize_headers {
1313 # Check if we already finalized headers
1314 return if $c->response->{_finalized_headers};
1317 if ( my $location = $c->response->redirect ) {
1318 $c->log->debug(qq/Redirecting to "$location"/) if $c->debug;
1319 $c->response->header( Location => $location );
1323 if ( $c->response->body && !$c->response->content_length ) {
1325 # get the length from a filehandle
1326 if ( blessed( $c->response->body ) && $c->response->body->can('read') )
1328 if ( my $stat = stat $c->response->body ) {
1329 $c->response->content_length( $stat->size );
1332 $c->log->warn('Serving filehandle without a content-length');
1336 $c->response->content_length( bytes::length( $c->response->body ) );
1341 if ( $c->response->status =~ /^(1\d\d|[23]04)$/ ) {
1342 $c->response->headers->remove_header("Content-Length");
1343 $c->response->body('');
1346 $c->finalize_cookies;
1348 $c->engine->finalize_headers( $c, @_ );
1351 $c->response->{_finalized_headers} = 1;
1354 =head2 $c->finalize_output
1356 An alias for finalize_body.
1358 =head2 $c->finalize_read
1360 Finalizes the input after reading is complete.
1364 sub finalize_read { my $c = shift; $c->engine->finalize_read( $c, @_ ) }
1366 =head2 $c->finalize_uploads
1368 Finalizes uploads. Cleans up any temporary files.
1372 sub finalize_uploads { my $c = shift; $c->engine->finalize_uploads( $c, @_ ) }
1374 =head2 $c->get_action( $action, $namespace )
1376 Gets an action in a given namespace.
1380 sub get_action { my $c = shift; $c->dispatcher->get_action(@_) }
1382 =head2 $c->get_actions( $action, $namespace )
1384 Gets all actions of a given name in a namespace and all parent
1389 sub get_actions { my $c = shift; $c->dispatcher->get_actions( $c, @_ ) }
1391 =head2 $c->handle_request( $class, @arguments )
1393 Called to handle each HTTP request.
1397 sub handle_request {
1398 my ( $class, @arguments ) = @_;
1400 # Always expect worst case!
1403 my $stats = ( $class->debug ) ? Tree::Simple->new: q{};
1406 my $c = $class->prepare(@arguments);
1409 return $c->finalize;
1412 if ( $class->debug ) {
1413 my $start = [gettimeofday];
1414 $status = &$handler;
1415 my $elapsed = tv_interval $start;
1416 $elapsed = sprintf '%f', $elapsed;
1417 my $av = sprintf '%.3f',
1418 ( $elapsed == 0 ? '??' : ( 1 / $elapsed ) );
1419 my $t = Text::SimpleTable->new( [ 64, 'Action' ], [ 9, 'Time' ] );
1424 my $stat = $action->getNodeValue;
1425 $t->row( ( q{ } x $action->getDepth ) . $stat->{action} . $stat->{comment},
1426 $stat->{elapsed} || '??' );
1431 "Request took ${elapsed}s ($av/s)\n" . $t->draw );
1433 else { $status = &$handler }
1437 if ( my $error = $@ ) {
1439 $class->log->error(qq/Caught exception in engine "$error"/);
1443 $class->log->_flush() if $class->log->can('_flush');
1447 =head2 $c->prepare( @arguments )
1449 Creates a Catalyst context from an engine-specific request (Apache, CGI,
1455 my ( $class, @arguments ) = @_;
1457 $class->context_class( ref $class || $class ) unless $class->context_class;
1458 my $c = $class->context_class->new(
1462 request => $class->request_class->new(
1465 body_parameters => {},
1467 headers => HTTP::Headers->new,
1469 query_parameters => {},
1475 response => $class->response_class->new(
1479 headers => HTTP::Headers->new(),
1488 # For on-demand data
1489 $c->request->{_context} = $c;
1490 $c->response->{_context} = $c;
1491 weaken( $c->request->{_context} );
1492 weaken( $c->response->{_context} );
1495 my $secs = time - $START || 1;
1496 my $av = sprintf '%.3f', $COUNT / $secs;
1497 $c->log->debug('**********************************');
1498 $c->log->debug("* Request $COUNT ($av/s) [$$]");
1499 $c->log->debug('**********************************');
1500 $c->res->headers->header( 'X-Catalyst' => $Catalyst::VERSION );
1503 # Allow engine to direct the prepare flow (for POE)
1504 if ( $c->engine->can('prepare') ) {
1505 $c->engine->prepare( $c, @arguments );
1508 $c->prepare_request(@arguments);
1509 $c->prepare_connection;
1510 $c->prepare_query_parameters;
1511 $c->prepare_headers;
1512 $c->prepare_cookies;
1516 $c->prepare_body unless $c->config->{parse_on_demand};
1519 my $method = $c->req->method || '';
1520 my $path = $c->req->path || '';
1521 my $address = $c->req->address || '';
1523 $c->log->debug(qq/"$method" request for "$path" from "$address"/)
1531 =head2 $c->prepare_action
1537 sub prepare_action { my $c = shift; $c->dispatcher->prepare_action( $c, @_ ) }
1539 =head2 $c->prepare_body
1541 Prepares message body.
1548 # Do we run for the first time?
1549 return if defined $c->request->{_body};
1551 # Initialize on-demand data
1552 $c->engine->prepare_body( $c, @_ );
1553 $c->prepare_parameters;
1554 $c->prepare_uploads;
1556 if ( $c->debug && keys %{ $c->req->body_parameters } ) {
1557 my $t = Text::SimpleTable->new( [ 37, 'Key' ], [ 36, 'Value' ] );
1558 for my $key ( sort keys %{ $c->req->body_parameters } ) {
1559 my $param = $c->req->body_parameters->{$key};
1560 my $value = defined($param) ? $param : '';
1562 ref $value eq 'ARRAY' ? ( join ', ', @$value ) : $value );
1564 $c->log->debug( "Body Parameters are:\n" . $t->draw );
1568 =head2 $c->prepare_body_chunk( $chunk )
1570 Prepares a chunk of data before sending it to L<HTTP::Body>.
1574 sub prepare_body_chunk {
1576 $c->engine->prepare_body_chunk( $c, @_ );
1579 =head2 $c->prepare_body_parameters
1581 Prepares body parameters.
1585 sub prepare_body_parameters {
1587 $c->engine->prepare_body_parameters( $c, @_ );
1590 =head2 $c->prepare_connection
1592 Prepares connection.
1596 sub prepare_connection {
1598 $c->engine->prepare_connection( $c, @_ );
1601 =head2 $c->prepare_cookies
1607 sub prepare_cookies { my $c = shift; $c->engine->prepare_cookies( $c, @_ ) }
1609 =head2 $c->prepare_headers
1615 sub prepare_headers { my $c = shift; $c->engine->prepare_headers( $c, @_ ) }
1617 =head2 $c->prepare_parameters
1619 Prepares parameters.
1623 sub prepare_parameters {
1625 $c->prepare_body_parameters;
1626 $c->engine->prepare_parameters( $c, @_ );
1629 =head2 $c->prepare_path
1631 Prepares path and base.
1635 sub prepare_path { my $c = shift; $c->engine->prepare_path( $c, @_ ) }
1637 =head2 $c->prepare_query_parameters
1639 Prepares query parameters.
1643 sub prepare_query_parameters {
1646 $c->engine->prepare_query_parameters( $c, @_ );
1648 if ( $c->debug && keys %{ $c->request->query_parameters } ) {
1649 my $t = Text::SimpleTable->new( [ 37, 'Key' ], [ 36, 'Value' ] );
1650 for my $key ( sort keys %{ $c->req->query_parameters } ) {
1651 my $param = $c->req->query_parameters->{$key};
1652 my $value = defined($param) ? $param : '';
1654 ref $value eq 'ARRAY' ? ( join ', ', @$value ) : $value );
1656 $c->log->debug( "Query Parameters are:\n" . $t->draw );
1660 =head2 $c->prepare_read
1662 Prepares the input for reading.
1666 sub prepare_read { my $c = shift; $c->engine->prepare_read( $c, @_ ) }
1668 =head2 $c->prepare_request
1670 Prepares the engine request.
1674 sub prepare_request { my $c = shift; $c->engine->prepare_request( $c, @_ ) }
1676 =head2 $c->prepare_uploads
1682 sub prepare_uploads {
1685 $c->engine->prepare_uploads( $c, @_ );
1687 if ( $c->debug && keys %{ $c->request->uploads } ) {
1688 my $t = Text::SimpleTable->new(
1694 for my $key ( sort keys %{ $c->request->uploads } ) {
1695 my $upload = $c->request->uploads->{$key};
1696 for my $u ( ref $upload eq 'ARRAY' ? @{$upload} : ($upload) ) {
1697 $t->row( $key, $u->filename, $u->type, $u->size );
1700 $c->log->debug( "File Uploads are:\n" . $t->draw );
1704 =head2 $c->prepare_write
1706 Prepares the output for writing.
1710 sub prepare_write { my $c = shift; $c->engine->prepare_write( $c, @_ ) }
1712 =head2 $c->request_class
1714 Returns or sets the request class.
1716 =head2 $c->response_class
1718 Returns or sets the response class.
1720 =head2 $c->read( [$maxlength] )
1722 Reads a chunk of data from the request body. This method is designed to
1723 be used in a while loop, reading C<$maxlength> bytes on every call.
1724 C<$maxlength> defaults to the size of the request if not specified.
1726 You have to set C<MyApp-E<gt>config-E<gt>{parse_on_demand}> to use this
1731 sub read { my $c = shift; return $c->engine->read( $c, @_ ) }
1739 sub run { my $c = shift; return $c->engine->run( $c, @_ ) }
1741 =head2 $c->set_action( $action, $code, $namespace, $attrs )
1743 Sets an action in a given namespace.
1747 sub set_action { my $c = shift; $c->dispatcher->set_action( $c, @_ ) }
1749 =head2 $c->setup_actions($component)
1751 Sets up actions for a component.
1755 sub setup_actions { my $c = shift; $c->dispatcher->setup_actions( $c, @_ ) }
1757 =head2 $c->setup_components
1763 sub setup_components {
1766 my $callback = sub {
1767 my ( $component, $context ) = @_;
1769 unless ( $component->can('COMPONENT') ) {
1773 my $suffix = Catalyst::Utils::class2classsuffix($component);
1774 my $config = $class->config->{$suffix} || {};
1778 eval { $instance = $component->COMPONENT( $context, $config ); };
1780 if ( my $error = $@ ) {
1784 Catalyst::Exception->throw( message =>
1785 qq/Couldn't instantiate component "$component", "$error"/ );
1788 Catalyst::Exception->throw( message =>
1789 qq/Couldn't instantiate component "$component", "COMPONENT() didn't return a object"/
1791 unless ref $instance;
1795 eval "package $class;\n" . q!Module::Pluggable::Fast->import(
1796 name => '_catalyst_components',
1798 "$class\::Controller", "$class\::C",
1799 "$class\::Model", "$class\::M",
1800 "$class\::View", "$class\::V"
1802 callback => $callback
1806 if ( my $error = $@ ) {
1810 Catalyst::Exception->throw(
1811 message => qq/Couldn't load components "$error"/ );
1814 for my $component ( $class->_catalyst_components($class) ) {
1815 $class->components->{ ref $component || $component } = $component;
1819 =head2 $c->setup_dispatcher
1825 sub setup_dispatcher {
1826 my ( $class, $dispatcher ) = @_;
1829 $dispatcher = 'Catalyst::Dispatcher::' . $dispatcher;
1832 if ( $ENV{CATALYST_DISPATCHER} ) {
1833 $dispatcher = 'Catalyst::Dispatcher::' . $ENV{CATALYST_DISPATCHER};
1836 if ( $ENV{ uc($class) . '_DISPATCHER' } ) {
1838 'Catalyst::Dispatcher::' . $ENV{ uc($class) . '_DISPATCHER' };
1841 unless ($dispatcher) {
1842 $dispatcher = $class->dispatcher_class;
1845 $dispatcher->require;
1848 Catalyst::Exception->throw(
1849 message => qq/Couldn't load dispatcher "$dispatcher", "$@"/ );
1852 # dispatcher instance
1853 $class->dispatcher( $dispatcher->new );
1856 =head2 $c->setup_engine
1863 my ( $class, $engine ) = @_;
1866 $engine = 'Catalyst::Engine::' . $engine;
1869 if ( $ENV{CATALYST_ENGINE} ) {
1870 $engine = 'Catalyst::Engine::' . $ENV{CATALYST_ENGINE};
1873 if ( $ENV{ uc($class) . '_ENGINE' } ) {
1874 $engine = 'Catalyst::Engine::' . $ENV{ uc($class) . '_ENGINE' };
1877 if ( $ENV{MOD_PERL} ) {
1879 # create the apache method
1882 *{"$class\::apache"} = sub { shift->engine->apache };
1885 my ( $software, $version ) =
1886 $ENV{MOD_PERL} =~ /^(\S+)\/(\d+(?:[\.\_]\d+)+)/;
1889 $version =~ s/(\.[^.]+)\./$1/g;
1891 if ( $software eq 'mod_perl' ) {
1895 if ( $version >= 1.99922 ) {
1896 $engine = 'Catalyst::Engine::Apache2::MP20';
1899 elsif ( $version >= 1.9901 ) {
1900 $engine = 'Catalyst::Engine::Apache2::MP19';
1903 elsif ( $version >= 1.24 ) {
1904 $engine = 'Catalyst::Engine::Apache::MP13';
1908 Catalyst::Exception->throw( message =>
1909 qq/Unsupported mod_perl version: $ENV{MOD_PERL}/ );
1914 # install the correct mod_perl handler
1915 if ( $version >= 1.9901 ) {
1916 *handler = sub : method {
1917 shift->handle_request(@_);
1921 *handler = sub ($$) { shift->handle_request(@_) };
1926 elsif ( $software eq 'Zeus-Perl' ) {
1927 $engine = 'Catalyst::Engine::Zeus';
1931 Catalyst::Exception->throw(
1932 message => qq/Unsupported mod_perl: $ENV{MOD_PERL}/ );
1937 $engine = $class->engine_class;
1943 Catalyst::Exception->throw( message =>
1944 qq/Couldn't load engine "$engine" (maybe you forgot to install it?), "$@"/
1948 # check for old engines that are no longer compatible
1950 if ( $engine->isa('Catalyst::Engine::Apache')
1951 && !Catalyst::Engine::Apache->VERSION )
1956 elsif ( $engine->isa('Catalyst::Engine::Server::Base')
1957 && Catalyst::Engine::Server->VERSION le '0.02' )
1962 elsif ($engine->isa('Catalyst::Engine::HTTP::POE')
1963 && $engine->VERSION eq '0.01' )
1968 elsif ($engine->isa('Catalyst::Engine::Zeus')
1969 && $engine->VERSION eq '0.01' )
1975 Catalyst::Exception->throw( message =>
1976 qq/Engine "$engine" is not supported by this version of Catalyst/
1981 $class->engine( $engine->new );
1984 =head2 $c->setup_home
1986 Sets up the home directory.
1991 my ( $class, $home ) = @_;
1993 if ( $ENV{CATALYST_HOME} ) {
1994 $home = $ENV{CATALYST_HOME};
1997 if ( $ENV{ uc($class) . '_HOME' } ) {
1998 $home = $ENV{ uc($class) . '_HOME' };
2002 $home = Catalyst::Utils::home($class);
2006 $class->config->{home} ||= $home;
2007 $class->config->{root} ||= Path::Class::Dir->new($home)->subdir('root');
2011 =head2 $c->setup_log
2018 my ( $class, $debug ) = @_;
2020 unless ( $class->log ) {
2021 $class->log( Catalyst::Log->new );
2024 my $app_flag = Catalyst::Utils::class2env($class) . '_DEBUG';
2027 ( defined( $ENV{CATALYST_DEBUG} ) || defined( $ENV{$app_flag} ) )
2028 ? ( $ENV{CATALYST_DEBUG} || $ENV{$app_flag} )
2033 *{"$class\::debug"} = sub { 1 };
2034 $class->log->debug('Debug messages enabled');
2038 =head2 $c->setup_plugins
2044 =head2 $c->registered_plugins
2046 Returns a sorted list of the plugins which have either been stated in the
2047 import list or which have been added via C<< MyApp->plugin(@args); >>.
2049 If passed a given plugin name, it will report a boolean value indicating
2050 whether or not that plugin is loaded. A fully qualified name is required if
2051 the plugin name does not begin with C<Catalyst::Plugin::>.
2053 if ($c->registered_plugins('Some::Plugin')) {
2061 sub registered_plugins {
2063 return sort keys %{ $proto->_plugins } unless @_;
2065 return 1 if exists $proto->_plugins->{$plugin};
2066 return exists $proto->_plugins->{"Catalyst::Plugin::$plugin"};
2069 sub _register_plugin {
2070 my ( $proto, $plugin, $instant ) = @_;
2071 my $class = ref $proto || $proto;
2075 if ( my $error = $@ ) {
2076 my $type = $instant ? "instant " : '';
2077 Catalyst::Exception->throw(
2078 message => qq/Couldn't load ${type}plugin "$plugin", $error/ );
2081 $proto->_plugins->{$plugin} = 1;
2084 unshift @{"$class\::ISA"}, $plugin;
2090 my ( $class, $plugins ) = @_;
2092 $class->_plugins( {} ) unless $class->_plugins;
2094 for my $plugin ( reverse @$plugins ) {
2096 unless ( $plugin =~ s/\A\+// ) {
2097 $plugin = "Catalyst::Plugin::$plugin";
2100 $class->_register_plugin($plugin);
2107 Returns an arrayref of the internal execution stack (actions that are currently
2110 =head2 $c->write( $data )
2112 Writes $data to the output stream. When using this method directly, you
2113 will need to manually set the C<Content-Length> header to the length of
2114 your output data, if known.
2121 # Finalize headers if someone manually writes output
2122 $c->finalize_headers;
2124 return $c->engine->write( $c, @_ );
2129 Returns the Catalyst version number. Mostly useful for "powered by"
2130 messages in template systems.
2134 sub version { return $Catalyst::VERSION }
2136 =head1 INTERNAL ACTIONS
2138 Catalyst uses internal actions like C<_DISPATCH>, C<_BEGIN>, C<_AUTO>,
2139 C<_ACTION>, and C<_END>. These are by default not shown in the private
2140 action table, but you can make them visible with a config parameter.
2142 MyApp->config->{show_internal_actions} = 1;
2144 =head1 CASE SENSITIVITY
2146 By default Catalyst is not case sensitive, so C<MyApp::C::FOO::Bar> is
2147 mapped to C</foo/bar>. You can activate case sensitivity with a config
2150 MyApp->config->{case_sensitive} = 1;
2152 This causes C<MyApp::C::Foo::Bar> to map to C</Foo/Bar>.
2154 =head1 ON-DEMAND PARSER
2156 The request body is usually parsed at the beginning of a request,
2157 but if you want to handle input yourself or speed things up a bit,
2158 you can enable on-demand parsing with a config parameter.
2160 MyApp->config->{parse_on_demand} = 1;
2162 =head1 PROXY SUPPORT
2164 Many production servers operate using the common double-server approach,
2165 with a lightweight frontend web server passing requests to a larger
2166 backend server. An application running on the backend server must deal
2167 with two problems: the remote user always appears to be C<127.0.0.1> and
2168 the server's hostname will appear to be C<localhost> regardless of the
2169 virtual host that the user connected through.
2171 Catalyst will automatically detect this situation when you are running
2172 the frontend and backend servers on the same machine. The following
2173 changes are made to the request.
2175 $c->req->address is set to the user's real IP address, as read from
2176 the HTTP X-Forwarded-For header.
2178 The host value for $c->req->base and $c->req->uri is set to the real
2179 host, as read from the HTTP X-Forwarded-Host header.
2181 Obviously, your web server must support these headers for this to work.
2183 In a more complex server farm environment where you may have your
2184 frontend proxy server(s) on different machines, you will need to set a
2185 configuration option to tell Catalyst to read the proxied data from the
2188 MyApp->config->{using_frontend_proxy} = 1;
2190 If you do not wish to use the proxy support at all, you may set:
2192 MyApp->config->{ignore_frontend_proxy} = 1;
2194 =head1 THREAD SAFETY
2196 Catalyst has been tested under Apache 2's threading mpm_worker, mpm_winnt,
2197 and the standalone forking HTTP server on Windows. We believe the Catalyst
2198 core to be thread-safe.
2200 If you plan to operate in a threaded environment, remember that all other
2201 modules you are using must also be thread-safe. Some modules, most notably
2202 L<DBD::SQLite>, are not thread-safe.
2208 Join #catalyst on irc.perl.org.
2212 http://lists.rawmode.org/mailman/listinfo/catalyst
2213 http://lists.rawmode.org/mailman/listinfo/catalyst-dev
2217 http://catalyst.perl.org
2221 http://dev.catalyst.perl.org
2225 =head2 L<Task::Catalyst> - All you need to start with Catalyst
2227 =head2 L<Catalyst::Manual> - The Catalyst Manual
2229 =head2 L<Catalyst::Component>, L<Catalyst::Base> - Base classes for components
2231 =head2 L<Catalyst::Engine> - Core engine
2233 =head2 L<Catalyst::Log> - Log class.
2235 =head2 L<Catalyst::Request> - Request object
2237 =head2 L<Catalyst::Response> - Response object
2239 =head2 L<Catalyst::Test> - The test suite.
2311 Sebastian Riedel, C<sri@oook.de>
2315 This library is free software, you can redistribute it and/or modify it under
2316 the same terms as Perl itself.