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.6901';
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 create 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 ### In libMyApp/Controller/Root.pm (autocreated)
108 sub foo : Global { # called for /foo, /foo/1, /foo/1/2, etc.
109 my ( $self, $c, @args ) = @_; # args are qw/1 2/ for /foo/1/2
110 $c->stash->{template} = 'foo.tt'; # set the template
111 # lookup something from db -- stash vars are passed to TT
113 $c->model('Database::Foo')->search( { country => $args[0] } );
114 if ( $c->req->params->{bar} ) { # access GET or POST parameters
115 $c->forward( 'bar' ); # process another action
116 # do something else after forward returns
120 # The foo.tt TT template can use the stash data from the database
121 [% WHILE (item = data.next) %]
125 # called for /bar/of/soap, /bar/of/soap/10, etc.
126 sub bar : Path('/bar/of/soap') { ... }
128 # called for all actions, from the top-most controller downwards
130 my ( $self, $c ) = @_;
131 if ( !$c->user_exists ) { # Catalyst::Plugin::Authentication
132 $c->res->redirect( '/login' ); # require login
133 return 0; # abort request and go immediately to end()
135 return 1; # success; carry on to next action
138 # called after all actions are finished
140 my ( $self, $c ) = @_;
141 if ( scalar @{ $c->error } ) { ... } # handle errors
142 return if $c->res->body; # already have a response
143 $c->forward( 'MyApp::View::TT' ); # render template
146 ### in MyApp/Controller/Foo.pm
147 # called for /foo/bar
148 sub bar : Local { ... }
150 # called for /blargle
151 sub blargle : Global { ... }
153 # an index action matches /foo, but not /foo/1, etc.
154 sub index : Private { ... }
156 ### in MyApp/Controller/Foo/Bar.pm
157 # called for /foo/bar/baz
158 sub baz : Local { ... }
160 # first Root auto is called, then Foo auto, then this
161 sub auto : Private { ... }
163 # powerful regular expression paths are also possible
164 sub details : Regex('^product/(\w+)/details$') {
165 my ( $self, $c ) = @_;
166 # extract the (\w+) from the URI
167 my $product = $c->req->snippets->[0];
170 See L<Catalyst::Manual::Intro> for additional information.
174 Catalyst is a modern framework for making web applications without the pain usually associated with this process. This document is a reference to the main Catalyst application. If you are a new user, we suggest you start with L<Catalyst::Manual::Tutorial> or L<Catalyst::Manual::Intro>
176 See L<Catalyst::Manual> for more documentation.
178 Catalyst plugins can be loaded by naming them as arguments to the "use
179 Catalyst" statement. Omit the C<Catalyst::Plugin::> prefix from the
180 plugin name, i.e., C<Catalyst::Plugin::My::Module> becomes
183 use Catalyst qw/My::Module/;
185 If your plugin starts with a name other than C<Catalyst::Plugin::>, you can
186 fully qualify the name by using a unary plus:
190 +Fully::Qualified::Plugin::Name
193 Special flags like C<-Debug> and C<-Engine> can also be specified as
194 arguments when Catalyst is loaded:
196 use Catalyst qw/-Debug My::Module/;
198 The position of plugins and flags in the chain is important, because
199 they are loaded in exactly the order in which they appear.
201 The following flags are supported:
205 Enables debug output.
209 Forces Catalyst to use a specific engine. Omit the
210 C<Catalyst::Engine::> prefix of the engine name, i.e.:
212 use Catalyst qw/-Engine=CGI/;
216 Forces Catalyst to use a specific home directory, e.g.:
218 use Catalyst qw[-Home=/usr/sri];
226 =head2 INFORMATION ABOUT THE CURRENT REQUEST
230 Returns a L<Catalyst::Action> object for the current action, which
231 stringifies to the action name. See L<Catalyst::Action>.
235 Returns the namespace of the current action, i.e., the uri prefix
236 corresponding to the controller of the current action. For example:
238 # in Controller::Foo::Bar
239 $c->namespace; # returns 'foo/bar';
245 Returns the current L<Catalyst::Request> object. See
246 L<Catalyst::Request>.
248 =head2 REQUEST FLOW HANDLING
250 =head2 $c->forward( $action [, \@arguments ] )
252 =head2 $c->forward( $class, $method, [, \@arguments ] )
254 Forwards processing to another action, by it's private name. If you give a
255 class name but no method, C<process()> is called. You may also optionally
256 pass arguments in an arrayref. The action will receive the arguments in
257 C<@_> and C<$c-E<gt>req-E<gt>args>. Upon returning from the function,
258 C<$c-E<gt>req-E<gt>args> will be restored to the previous values.
260 Any data C<return>ed from the action forwarded to, will be returned by the
263 my $foodata = $c->forward('/foo');
264 $c->forward('index');
265 $c->forward(qw/MyApp::Model::DBIC::Foo do_stuff/);
266 $c->forward('MyApp::View::TT');
268 Note that forward implies an C<<eval { }>> around the call (well, actually
269 C<execute> does), thus de-fatalizing all 'dies' within the called action. If
270 you want C<die> to propagate you need to do something like:
273 die $c->error if $c->error;
275 Or make sure to always return true values from your actions and write your code
278 $c->forward('foo') || return;
282 sub forward { my $c = shift; $c->dispatcher->forward( $c, @_ ) }
284 =head2 $c->detach( $action [, \@arguments ] )
286 =head2 $c->detach( $class, $method, [, \@arguments ] )
288 The same as C<forward>, but doesn't return to the previous action when
289 processing is finished.
293 sub detach { my $c = shift; $c->dispatcher->detach( $c, @_ ) }
299 Returns the current L<Catalyst::Response> object.
303 Returns a hashref to the stash, which may be used to store data and pass
304 it between components during a request. You can also set hash keys by
305 passing arguments. The stash is automatically sent to the view. The
306 stash is cleared at the end of a request; it cannot be used for
309 $c->stash->{foo} = $bar;
310 $c->stash( { moose => 'majestic', qux => 0 } );
311 $c->stash( bar => 1, gorch => 2 ); # equivalent to passing a hashref
313 # stash is automatically passed to the view for use in a template
314 $c->forward( 'MyApp::V::TT' );
321 my $stash = @_ > 1 ? {@_} : $_[0];
322 while ( my ( $key, $val ) = each %$stash ) {
323 $c->{stash}->{$key} = $val;
331 =head2 $c->error($error, ...)
333 =head2 $c->error($arrayref)
335 Returns an arrayref containing error messages. If Catalyst encounters an
336 error while processing a request, it stores the error in $c->error. This
337 method should not be used to store non-fatal error messages.
339 my @error = @{ $c->error };
343 $c->error('Something bad happened');
350 my $error = ref $_[0] eq 'ARRAY' ? $_[0] : [@_];
351 croak @$error unless ref $c;
352 push @{ $c->{error} }, @$error;
354 elsif ( defined $_[0] ) { $c->{error} = undef }
355 return $c->{error} || [];
361 Contains the return value of the last executed action.
363 =head2 $c->clear_errors
365 Clear errors. You probably don't want to clear the errors unless you are
366 implementing a custom error screen.
368 This is equivalent to running
384 my ( $c, @names ) = @_;
386 foreach my $name (@names) {
387 foreach my $component ( keys %{ $c->components } ) {
388 return $c->components->{$component} if $component =~ /$name/i;
395 # try explicit component names
397 my ( $c, @names ) = @_;
399 foreach my $try (@names) {
400 return $c->components->{$try} if ( exists $c->components->{$try} );
406 # like component, but try just these prefixes before regex searching,
407 # and do not try to return "sort keys %{ $c->components }"
409 my ( $c, $name, @prefixes ) = @_;
411 my $appclass = ref $c || $c;
413 my @names = map { "${appclass}::${_}::${name}" } @prefixes;
415 my $comp = $c->_comp_explicit(@names);
416 return $comp if defined($comp);
417 $comp = $c->_comp_search($name);
421 # Find possible names for a prefix
424 my ( $c, @prefixes ) = @_;
426 my $appclass = ref $c || $c;
428 my @pre = map { "${appclass}::${_}::" } @prefixes;
432 COMPONENT: foreach my $comp ($c->component) {
433 foreach my $p (@pre) {
434 if ($comp =~ s/^$p//) {
444 # Return a component if only one matches.
446 my ( $c, @prefixes ) = @_;
448 my $appclass = ref $c || $c;
450 my ( $comp, $rest ) =
451 map { $c->_comp_search("^${appclass}::${_}::") } @prefixes;
452 return $comp unless $rest;
455 # Filter a component before returning by calling ACCEPT_CONTEXT if available
456 sub _filter_component {
457 my ( $c, $comp, @args ) = @_;
458 if ( eval { $comp->can('ACCEPT_CONTEXT'); } ) {
459 return $comp->ACCEPT_CONTEXT( $c, @args );
461 else { return $comp }
464 =head2 COMPONENT ACCESSORS
466 =head2 $c->controller($name)
468 Gets a L<Catalyst::Controller> instance by name.
470 $c->controller('Foo')->do_stuff;
472 If name is omitted, will return the controller for the dispatched action.
477 my ( $c, $name, @args ) = @_;
478 return $c->_filter_component( $c->_comp_prefixes( $name, qw/Controller C/ ),
481 return $c->component( $c->action->class );
484 =head2 $c->model($name)
486 Gets a L<Catalyst::Model> instance by name.
488 $c->model('Foo')->do_stuff;
490 If the name is omitted, it will look for a config setting 'default_model',
491 or check if there is only one model, and forward to it if that's the case.
496 my ( $c, $name, @args ) = @_;
497 return $c->_filter_component( $c->_comp_prefixes( $name, qw/Model M/ ),
500 return $c->component( $c->config->{default_model} )
501 if $c->config->{default_model};
502 return $c->_filter_component( $c->_comp_singular(qw/Model M/), @args );
506 =head2 $c->controllers
508 Returns the available names which can be passed to $c->controller
514 return $c->_comp_names(qw/Controller C/);
518 =head2 $c->view($name)
520 Gets a L<Catalyst::View> instance by name.
522 $c->view('Foo')->do_stuff;
524 If the name is omitted, it will look for a config setting 'default_view',
525 or check if there is only one view, and forward to it if that's the case.
530 my ( $c, $name, @args ) = @_;
531 return $c->_filter_component( $c->_comp_prefixes( $name, qw/View V/ ),
534 return $c->component( $c->config->{default_view} )
535 if $c->config->{default_view};
536 return $c->_filter_component( $c->_comp_singular(qw/View V/) );
541 Returns the available names which can be passed to $c->model
547 return $c->_comp_names(qw/Model M/);
553 Returns the available names which can be passed to $c->view
559 return $c->_comp_names(qw/View V/);
562 =head2 $c->comp($name)
564 =head2 $c->component($name)
566 Gets a component object by name. This method is no longer recommended,
567 unless you want to get a specific component by full
568 class. C<$c-E<gt>controller>, C<$c-E<gt>model>, and C<$c-E<gt>view>
569 should be used instead.
580 my $appclass = ref $c || $c;
583 $name, "${appclass}::${name}",
584 map { "${appclass}::${_}::${name}" }
585 qw/Model M Controller C View V/
588 my $comp = $c->_comp_explicit(@names);
589 return $c->_filter_component( $comp, @_ ) if defined($comp);
591 $comp = $c->_comp_search($name);
592 return $c->_filter_component( $comp, @_ ) if defined($comp);
595 return sort keys %{ $c->components };
600 =head2 CLASS DATA AND HELPER CLASSES
604 Returns or takes a hashref containing the application's configuration.
606 __PACKAGE__->config( { db => 'dsn:SQLite:foo.db' } );
608 You can also use a L<YAML> config file like myapp.yml in your
609 applications home directory.
612 db: dsn:SQLite:foo.db
620 $c->log->warn("Setting config after setup has been run is not a good idea.")
621 if ( @_ and $c->setup_finished );
623 $c->NEXT::config(@_);
628 Returns the logging object instance. Unless it is already set, Catalyst sets
629 this up with a L<Catalyst::Log> object. To use your own log class, set the
630 logger with the C<< __PACKAGE__->log >> method prior to calling
631 C<< __PACKAGE__->setup >>.
633 __PACKAGE__->log( MyLogger->new );
638 $c->log->info( 'Now logging with my own logger!' );
640 Your log class should implement the methods described in the
641 L<Catalyst::Log> man page.
646 Overload to enable debug messages (same as -Debug option).
652 =head2 $c->dispatcher
654 Returns the dispatcher instance. Stringifies to class name. See
655 L<Catalyst::Dispatcher>.
659 Returns the engine instance. Stringifies to the class name. See
663 =head2 UTILITY METHODS
665 =head2 $c->path_to(@path)
667 Merges C<@path> with C<$c-E<gt>config-E<gt>{home}> and returns a
668 L<Path::Class> object.
672 $c->path_to( 'db', 'sqlite.db' );
677 my ( $c, @path ) = @_;
678 my $path = Path::Class::Dir->new( $c->config->{home}, @path );
679 if ( -d $path ) { return $path }
680 else { return Path::Class::File->new( $c->config->{home}, @path ) }
683 =head2 $c->plugin( $name, $class, @args )
685 Helper method for plugins. It creates a classdata accessor/mutator and
686 loads and instantiates the given class.
688 MyApp->plugin( 'prototype', 'HTML::Prototype' );
690 $c->prototype->define_javascript_functions;
695 my ( $class, $name, $plugin, @args ) = @_;
696 $class->_register_plugin( $plugin, 1 );
698 eval { $plugin->import };
699 $class->mk_classdata($name);
701 eval { $obj = $plugin->new(@args) };
704 Catalyst::Exception->throw( message =>
705 qq/Couldn't instantiate instant plugin "$plugin", "$@"/ );
709 $class->log->debug(qq/Initialized instant plugin "$plugin" as "$name"/)
715 Initializes the dispatcher and engine, loads any plugins, and loads the
716 model, view, and controller components. You may also specify an array
717 of plugins to load here, if you choose to not load them in the C<use
721 MyApp->setup( qw/-Debug/ );
726 my ( $class, @arguments ) = @_;
728 unless ( $class->isa('Catalyst') ) {
730 Catalyst::Exception->throw(
731 message => qq/'$class' does not inherit from Catalyst/ );
734 if ( $class->arguments ) {
735 @arguments = ( @arguments, @{ $class->arguments } );
741 foreach (@arguments) {
745 ( $flags->{log} ) ? 'debug,' . $flags->{log} : 'debug';
747 elsif (/^-(\w+)=?(.*)$/) {
748 $flags->{ lc $1 } = $2;
751 push @{ $flags->{plugins} }, $_;
755 $class->setup_home( delete $flags->{home} );
757 $class->setup_log( delete $flags->{log} );
758 $class->setup_plugins( delete $flags->{plugins} );
759 $class->setup_dispatcher( delete $flags->{dispatcher} );
760 $class->setup_engine( delete $flags->{engine} );
762 for my $flag ( sort keys %{$flags} ) {
764 if ( my $code = $class->can( 'setup_' . $flag ) ) {
765 &$code( $class, delete $flags->{$flag} );
768 $class->log->warn(qq/Unknown flag "$flag"/);
773 <<"EOF") if ( $ENV{CATALYST_SCRIPT_GEN} && ( $ENV{CATALYST_SCRIPT_GEN} < $Catalyst::CATALYST_SCRIPT_GEN ) );
774 You are running an old script!
776 Please update by running (this will overwrite existing files):
777 catalyst.pl -force -scripts $class
779 or (this will not overwrite existing files):
780 catalyst.pl -scripts $class
783 if ( $class->debug ) {
790 map { $_ . ' ' . ( $_->VERSION || '' ) }
791 grep { /^Catalyst::Plugin/ } @{"$class\::ISA"};
795 my $t = Text::SimpleTable->new(76);
796 $t->row($_) for @plugins;
797 $class->log->debug( "Loaded plugins:\n" . $t->draw );
800 my $dispatcher = $class->dispatcher;
801 my $engine = $class->engine;
802 my $home = $class->config->{home};
804 $class->log->debug(qq/Loaded dispatcher "$dispatcher"/);
805 $class->log->debug(qq/Loaded engine "$engine"/);
809 ? $class->log->debug(qq/Found home "$home"/)
810 : $class->log->debug(qq/Home "$home" doesn't exist/)
811 : $class->log->debug(q/Couldn't find home/);
816 no warnings qw/redefine/;
817 local *setup = sub { };
821 # Initialize our data structure
822 $class->components( {} );
824 $class->setup_components;
826 if ( $class->debug ) {
827 my $t = Text::SimpleTable->new( [ 65, 'Class' ], [ 8, 'Type' ] );
828 for my $comp ( sort keys %{ $class->components } ) {
829 my $type = ref $class->components->{$comp} ? 'instance' : 'class';
830 $t->row( $comp, $type );
832 $class->log->debug( "Loaded components:\n" . $t->draw )
833 if ( keys %{ $class->components } );
836 # Add our self to components, since we are also a component
837 $class->components->{$class} = $class;
839 $class->setup_actions;
841 if ( $class->debug ) {
842 my $name = $class->config->{name} || 'Application';
843 $class->log->info("$name powered by Catalyst $Catalyst::VERSION");
845 $class->log->_flush() if $class->log->can('_flush');
847 $class->setup_finished(1);
850 =head2 $c->uri_for( $path, @args?, \%query_values? )
852 Merges path with C<$c-E<gt>request-E<gt>base> for absolute uri's and
853 with C<$c-E<gt>namespace> for relative uri's, then returns a
854 normalized L<URI> object. If any args are passed, they are added at the
855 end of the path. If the last argument to uri_for is a hash reference,
856 it is assumed to contain GET parameter key/value pairs, which will be
857 appended to the URI in standard fashion.
862 my ( $c, $path, @args ) = @_;
863 my $base = $c->request->base->clone;
864 my $basepath = $base->path;
865 $basepath =~ s/\/$//;
867 my $namespace = $c->namespace;
869 # massage namespace, empty if absolute path
870 $namespace =~ s/^\///;
871 $namespace .= '/' if $namespace;
873 $namespace = '' if $path =~ /^\//;
877 ( scalar @args && ref $args[$#args] eq 'HASH' ? pop @args : {} );
879 for my $value ( values %$params ) {
\r
880 my $isa_ref = ref $value;
\r
881 if( $isa_ref and $isa_ref ne 'ARRAY' ) {
\r
882 croak( "Non-array reference ($isa_ref) passed to uri_for()" );
\r
884 utf8::encode( $_ ) for grep { defined } $isa_ref ? @$value : $value;
\r
887 # join args with '/', or a blank string
888 my $args = ( scalar @args ? '/' . join( '/', @args ) : '' );
889 $args =~ s/^\/// unless $path;
891 URI->new_abs( URI->new_abs( "$path$args", "$basepath$namespace" ), $base )
893 $res->query_form(%$params);
897 =head2 $c->welcome_message
899 Returns the Catalyst welcome HTML page.
903 sub welcome_message {
905 my $name = $c->config->{name};
906 my $logo = $c->uri_for('/static/images/catalyst_logo.png');
907 my $prefix = Catalyst::Utils::appprefix( ref $c );
908 $c->response->content_type('text/html; charset=utf-8');
910 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
911 "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
912 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
914 <meta http-equiv="Content-Language" content="en" />
915 <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
916 <title>$name on Catalyst $VERSION</title>
917 <style type="text/css">
920 background-color: #eee;
929 background-color: #ccc;
930 border: 1px solid #aaa;
931 -moz-border-radius: 10px;
936 font-family: verdana, tahoma, sans-serif;
939 font-family: verdana, tahoma, sans-serif;
942 text-decoration: none;
944 border-bottom: 1px dotted #bbb;
946 :link:hover, :visited:hover {
959 background-color: #fff;
960 border: 1px solid #aaa;
961 -moz-border-radius: 10px;
987 <h1><span id="appname">$name</span> on <a href="http://catalyst.perl.org">Catalyst</a>
992 <img src="$logo" alt="Catalyst Logo" />
994 <p>Welcome to the wonderful world of Catalyst.
995 This <a href="http://en.wikipedia.org/wiki/MVC">MVC</a>
996 framework will make web development something you had
997 never expected it to be: Fun, rewarding, and quick.</p>
998 <h2>What to do now?</h2>
999 <p>That really depends on what <b>you</b> want to do.
1000 We do, however, provide you with a few starting points.</p>
1001 <p>If you want to jump right into web development with Catalyst
1002 you might want to check out the documentation.</p>
1003 <pre><code>perldoc <a href="http://cpansearch.perl.org/dist/Catalyst/lib/Catalyst/Manual/Intro.pod">Catalyst::Manual::Intro</a>
1004 perldoc <a href="http://cpansearch.perl.org/dist/Catalyst/lib/Catalyst/Manual/Tutorial.pod">Catalyst::Manual::Tutorial</a></code>
1005 perldoc <a href="http://cpansearch.perl.org/dist/Catalyst/lib/Catalyst/Manual.pod">Catalyst::Manual</a></code></pre>
1006 <h2>What to do next?</h2>
1007 <p>Next it's time to write an actual application. Use the
1008 helper scripts to generate <a href="http://cpansearch.perl.org/search?query=Catalyst%3A%3AController%3A%3A&mode=all">controllers</a>,
1009 <a href="http://cpansearch.perl.org/search?query=Catalyst%3A%3AModel%3A%3A&mode=all">models</a>, and
1010 <a href="http://cpansearch.perl.org/search?query=Catalyst%3A%3AView%3A%3A&mode=all">views</a>;
1011 they can save you a lot of work.</p>
1012 <pre><code>script/${prefix}_create.pl -help</code></pre>
1013 <p>Also, be sure to check out the vast and growing
1014 collection of <a href="http://cpansearch.perl.org/search?query=Catalyst%3A%3APlugin%3A%3A&mode=all">plugins for Catalyst on CPAN</a>;
1015 you are likely to find what you need there.
1019 <p>Catalyst has a very active community. Here are the main places to
1020 get in touch with us.</p>
1023 <a href="http://dev.catalyst.perl.org">Wiki</a>
1026 <a href="http://lists.rawmode.org/mailman/listinfo/catalyst">Mailing-List</a>
1029 <a href="irc://irc.perl.org/catalyst">IRC channel #catalyst on irc.perl.org</a>
1032 <h2>In conclusion</h2>
1033 <p>The Catalyst team hopes you will enjoy using Catalyst as much
1034 as we enjoyed making it. Please contact us if you have ideas
1035 for improvement or other feedback.</p>
1043 =head1 INTERNAL METHODS
1045 These methods are not meant to be used by end users.
1047 =head2 $c->components
1049 Returns a hash of components.
1051 =head2 $c->context_class
1053 Returns or sets the context class.
1057 Returns a hashref containing coderefs and execution counts (needed for
1058 deep recursion detection).
1062 Returns the number of actions on the current internal execution stack.
1066 Dispatches a request to actions.
1070 sub dispatch { my $c = shift; $c->dispatcher->dispatch( $c, @_ ) }
1072 =head2 $c->dispatcher_class
1074 Returns or sets the dispatcher class.
1076 =head2 $c->dump_these
1078 Returns a list of 2-element array references (name, structure) pairs
1079 that will be dumped on the error page in debug mode.
1085 [ Request => $c->req ],
1086 [ Response => $c->res ],
1087 [ Stash => $c->stash ],
1088 [ Config => $c->config ];
1091 =head2 $c->engine_class
1093 Returns or sets the engine class.
1095 =head2 $c->execute( $class, $coderef )
1097 Execute a coderef in given class and catch exceptions. Errors are available
1103 my ( $c, $class, $code ) = @_;
1104 $class = $c->component($class) || $class;
1107 if ( $c->depth >= $RECURSION ) {
1108 my $action = "$code";
1109 $action = "/$action" unless $action =~ /\-\>/;
1110 my $error = qq/Deep recursion detected calling "$action"/;
1111 $c->log->error($error);
1117 my $stats_info = $c->_stats_start_execute( $code );
1119 push( @{ $c->stack }, $code );
1121 eval { $c->state( &$code( $class, $c, @{ $c->req->args } ) || 0 ) };
1123 $c->_stats_finish_execute( $stats_info );
1125 my $last = ${ $c->stack }[-1];
1126 pop( @{ $c->stack } );
1128 if ( my $error = $@ ) {
1129 if ( $error eq $DETACH ) { die $DETACH if $c->depth > 1 }
1131 unless ( ref $error ) {
1133 my $class = $last->class;
1134 my $name = $last->name;
1135 $error = qq/Caught exception in $class->$name "$error"/;
1144 sub _stats_start_execute {
1145 my ( $c, $code ) = @_;
1147 return unless $c->debug;
1149 my $action = "$code";
1151 $action = "/$action" unless $action =~ /\-\>/;
1152 $c->counter->{"$code"}++;
1154 # determine if the call was the result of a forward
1155 # this is done by walking up the call stack and looking for a calling
1156 # sub of Catalyst::forward before the eval
1158 for my $index ( 2 .. 11 ) {
1160 if ( ( caller($index) )[0] eq 'Catalyst'
1161 && ( caller($index) )[3] eq '(eval)' );
1163 if ( ( caller($index) )[3] =~ /forward$/ ) {
1164 $callsub = ( caller($index) )[3];
1165 $action = "-> $action";
1170 my $node = Tree::Simple->new(
1173 elapsed => undef, # to be filled in later
1177 $node->setUID( "$code" . $c->counter->{"$code"} );
1179 unless ( ( $code->name =~ /^_.*/ )
1180 && ( !$c->config->{show_internal_actions} ) )
1182 # is this a root-level call or a forwarded call?
1183 if ( $callsub =~ /forward$/ ) {
1185 # forward, locate the caller
1186 if ( my $parent = $c->stack->[-1] ) {
1187 my $visitor = Tree::Simple::Visitor::FindByUID->new;
1188 $visitor->searchForUID(
1189 "$parent" . $c->counter->{"$parent"} );
1190 $c->stats->accept($visitor);
1191 if ( my $result = $visitor->getResult ) {
1192 $result->addChild($node);
1197 # forward with no caller may come from a plugin
1198 $c->stats->addChild($node);
1204 $c->stats->addChild($node);
1208 my $start = [gettimeofday];
1209 my $elapsed = tv_interval($start);
1213 elapsed => $elapsed,
1219 sub _stats_finish_execute {
1220 my ( $c, $info ) = @_;
1222 return unless $c->debug;
1224 my ( $code, $start, $elapsed ) = @{ $info }{qw/code start elapsed/};
1226 unless ( ( $code->name =~ /^_.*/ )
1227 && ( !$c->config->{show_internal_actions} ) )
1230 # FindByUID uses an internal die, so we save the existing error
1233 # locate the node in the tree and update the elapsed time
1234 my $visitor = Tree::Simple::Visitor::FindByUID->new;
1235 $visitor->searchForUID( "$code" . $c->counter->{"$code"} );
1236 $c->stats->accept($visitor);
1237 if ( my $result = $visitor->getResult ) {
1238 my $value = $result->getNodeValue;
1239 $value->{elapsed} = sprintf( '%fs', $elapsed );
1240 $result->setNodeValue($value);
1244 $@ = $error || undef;
1248 =head2 $c->_localize_fields( sub { }, \%keys );
1252 sub _localize_fields {
1253 my ( $c, $localized, $code ) = ( @_ );
1255 my $request = delete $localized->{request} || {};
1256 my $response = delete $localized->{response} || {};
1258 local @{ $c }{ keys %$localized } = values %$localized;
1259 local @{ $c->request }{ keys %$request } = values %$request;
1260 local @{ $c->response }{ keys %$response } = values %$response;
1267 Finalizes the request.
1274 for my $error ( @{ $c->error } ) {
1275 $c->log->error($error);
1278 # Allow engine to handle finalize flow (for POE)
1279 if ( $c->engine->can('finalize') ) {
1280 $c->engine->finalize( $c );
1284 $c->finalize_uploads;
1287 if ( $#{ $c->error } >= 0 ) {
1291 $c->finalize_headers;
1294 if ( $c->request->method eq 'HEAD' ) {
1295 $c->response->body('');
1301 return $c->response->status;
1304 =head2 $c->finalize_body
1310 sub finalize_body { my $c = shift; $c->engine->finalize_body( $c, @_ ) }
1312 =head2 $c->finalize_cookies
1318 sub finalize_cookies { my $c = shift; $c->engine->finalize_cookies( $c, @_ ) }
1320 =head2 $c->finalize_error
1326 sub finalize_error { my $c = shift; $c->engine->finalize_error( $c, @_ ) }
1328 =head2 $c->finalize_headers
1334 sub finalize_headers {
1337 # Check if we already finalized headers
1338 return if $c->response->{_finalized_headers};
1341 if ( my $location = $c->response->redirect ) {
1342 $c->log->debug(qq/Redirecting to "$location"/) if $c->debug;
1343 $c->response->header( Location => $location );
1347 if ( $c->response->body && !$c->response->content_length ) {
1349 # get the length from a filehandle
1350 if ( blessed( $c->response->body ) && $c->response->body->can('read') )
1352 if ( my $stat = stat $c->response->body ) {
1353 $c->response->content_length( $stat->size );
1356 $c->log->warn('Serving filehandle without a content-length');
1360 $c->response->content_length( bytes::length( $c->response->body ) );
1365 if ( $c->response->status =~ /^(1\d\d|[23]04)$/ ) {
1366 $c->response->headers->remove_header("Content-Length");
1367 $c->response->body('');
1370 $c->finalize_cookies;
1372 $c->engine->finalize_headers( $c, @_ );
1375 $c->response->{_finalized_headers} = 1;
1378 =head2 $c->finalize_output
1380 An alias for finalize_body.
1382 =head2 $c->finalize_read
1384 Finalizes the input after reading is complete.
1388 sub finalize_read { my $c = shift; $c->engine->finalize_read( $c, @_ ) }
1390 =head2 $c->finalize_uploads
1392 Finalizes uploads. Cleans up any temporary files.
1396 sub finalize_uploads { my $c = shift; $c->engine->finalize_uploads( $c, @_ ) }
1398 =head2 $c->get_action( $action, $namespace )
1400 Gets an action in a given namespace.
1404 sub get_action { my $c = shift; $c->dispatcher->get_action(@_) }
1406 =head2 $c->get_actions( $action, $namespace )
1408 Gets all actions of a given name in a namespace and all parent
1413 sub get_actions { my $c = shift; $c->dispatcher->get_actions( $c, @_ ) }
1415 =head2 $c->handle_request( $class, @arguments )
1417 Called to handle each HTTP request.
1421 sub handle_request {
1422 my ( $class, @arguments ) = @_;
1424 # Always expect worst case!
1427 my $stats = ( $class->debug ) ? Tree::Simple->new: q{};
1430 my $c = $class->prepare(@arguments);
1433 return $c->finalize;
1436 if ( $class->debug ) {
1437 my $start = [gettimeofday];
1438 $status = &$handler;
1439 my $elapsed = tv_interval $start;
1440 $elapsed = sprintf '%f', $elapsed;
1441 my $av = sprintf '%.3f',
1442 ( $elapsed == 0 ? '??' : ( 1 / $elapsed ) );
1443 my $t = Text::SimpleTable->new( [ 64, 'Action' ], [ 9, 'Time' ] );
1448 my $stat = $action->getNodeValue;
1449 $t->row( ( q{ } x $action->getDepth ) . $stat->{action} . $stat->{comment},
1450 $stat->{elapsed} || '??' );
1455 "Request took ${elapsed}s ($av/s)\n" . $t->draw );
1457 else { $status = &$handler }
1461 if ( my $error = $@ ) {
1463 $class->log->error(qq/Caught exception in engine "$error"/);
1467 $class->log->_flush() if $class->log->can('_flush');
1471 =head2 $c->prepare( @arguments )
1473 Creates a Catalyst context from an engine-specific request (Apache, CGI,
1479 my ( $class, @arguments ) = @_;
1481 $class->context_class( ref $class || $class ) unless $class->context_class;
1482 my $c = $class->context_class->new(
1486 request => $class->request_class->new(
1489 body_parameters => {},
1491 headers => HTTP::Headers->new,
1493 query_parameters => {},
1499 response => $class->response_class->new(
1503 headers => HTTP::Headers->new(),
1512 # For on-demand data
1513 $c->request->{_context} = $c;
1514 $c->response->{_context} = $c;
1515 weaken( $c->request->{_context} );
1516 weaken( $c->response->{_context} );
1519 my $secs = time - $START || 1;
1520 my $av = sprintf '%.3f', $COUNT / $secs;
1521 $c->log->debug('**********************************');
1522 $c->log->debug("* Request $COUNT ($av/s) [$$]");
1523 $c->log->debug('**********************************');
1524 $c->res->headers->header( 'X-Catalyst' => $Catalyst::VERSION );
1527 # Allow engine to direct the prepare flow (for POE)
1528 if ( $c->engine->can('prepare') ) {
1529 $c->engine->prepare( $c, @arguments );
1532 $c->prepare_request(@arguments);
1533 $c->prepare_connection;
1534 $c->prepare_query_parameters;
1535 $c->prepare_headers;
1536 $c->prepare_cookies;
1540 $c->prepare_body unless $c->config->{parse_on_demand};
1543 my $method = $c->req->method || '';
1544 my $path = $c->req->path || '';
1545 my $address = $c->req->address || '';
1547 $c->log->debug(qq/"$method" request for "$path" from "$address"/)
1555 =head2 $c->prepare_action
1557 Prepares action. See L<Catalyst::Dispatcher>.
1561 sub prepare_action { my $c = shift; $c->dispatcher->prepare_action( $c, @_ ) }
1563 =head2 $c->prepare_body
1565 Prepares message body.
1572 # Do we run for the first time?
1573 return if defined $c->request->{_body};
1575 # Initialize on-demand data
1576 $c->engine->prepare_body( $c, @_ );
1577 $c->prepare_parameters;
1578 $c->prepare_uploads;
1580 if ( $c->debug && keys %{ $c->req->body_parameters } ) {
1581 my $t = Text::SimpleTable->new( [ 37, 'Key' ], [ 36, 'Value' ] );
1582 for my $key ( sort keys %{ $c->req->body_parameters } ) {
1583 my $param = $c->req->body_parameters->{$key};
1584 my $value = defined($param) ? $param : '';
1586 ref $value eq 'ARRAY' ? ( join ', ', @$value ) : $value );
1588 $c->log->debug( "Body Parameters are:\n" . $t->draw );
1592 =head2 $c->prepare_body_chunk( $chunk )
1594 Prepares a chunk of data before sending it to L<HTTP::Body>.
1596 See L<Catalyst::Engine>.
1600 sub prepare_body_chunk {
1602 $c->engine->prepare_body_chunk( $c, @_ );
1605 =head2 $c->prepare_body_parameters
1607 Prepares body parameters.
1611 sub prepare_body_parameters {
1613 $c->engine->prepare_body_parameters( $c, @_ );
1616 =head2 $c->prepare_connection
1618 Prepares connection.
1622 sub prepare_connection {
1624 $c->engine->prepare_connection( $c, @_ );
1627 =head2 $c->prepare_cookies
1633 sub prepare_cookies { my $c = shift; $c->engine->prepare_cookies( $c, @_ ) }
1635 =head2 $c->prepare_headers
1641 sub prepare_headers { my $c = shift; $c->engine->prepare_headers( $c, @_ ) }
1643 =head2 $c->prepare_parameters
1645 Prepares parameters.
1649 sub prepare_parameters {
1651 $c->prepare_body_parameters;
1652 $c->engine->prepare_parameters( $c, @_ );
1655 =head2 $c->prepare_path
1657 Prepares path and base.
1661 sub prepare_path { my $c = shift; $c->engine->prepare_path( $c, @_ ) }
1663 =head2 $c->prepare_query_parameters
1665 Prepares query parameters.
1669 sub prepare_query_parameters {
1672 $c->engine->prepare_query_parameters( $c, @_ );
1674 if ( $c->debug && keys %{ $c->request->query_parameters } ) {
1675 my $t = Text::SimpleTable->new( [ 37, 'Key' ], [ 36, 'Value' ] );
1676 for my $key ( sort keys %{ $c->req->query_parameters } ) {
1677 my $param = $c->req->query_parameters->{$key};
1678 my $value = defined($param) ? $param : '';
1680 ref $value eq 'ARRAY' ? ( join ', ', @$value ) : $value );
1682 $c->log->debug( "Query Parameters are:\n" . $t->draw );
1686 =head2 $c->prepare_read
1688 Prepares the input for reading.
1692 sub prepare_read { my $c = shift; $c->engine->prepare_read( $c, @_ ) }
1694 =head2 $c->prepare_request
1696 Prepares the engine request.
1700 sub prepare_request { my $c = shift; $c->engine->prepare_request( $c, @_ ) }
1702 =head2 $c->prepare_uploads
1708 sub prepare_uploads {
1711 $c->engine->prepare_uploads( $c, @_ );
1713 if ( $c->debug && keys %{ $c->request->uploads } ) {
1714 my $t = Text::SimpleTable->new(
1720 for my $key ( sort keys %{ $c->request->uploads } ) {
1721 my $upload = $c->request->uploads->{$key};
1722 for my $u ( ref $upload eq 'ARRAY' ? @{$upload} : ($upload) ) {
1723 $t->row( $key, $u->filename, $u->type, $u->size );
1726 $c->log->debug( "File Uploads are:\n" . $t->draw );
1730 =head2 $c->prepare_write
1732 Prepares the output for writing.
1736 sub prepare_write { my $c = shift; $c->engine->prepare_write( $c, @_ ) }
1738 =head2 $c->request_class
1740 Returns or sets the request class.
1742 =head2 $c->response_class
1744 Returns or sets the response class.
1746 =head2 $c->read( [$maxlength] )
1748 Reads a chunk of data from the request body. This method is designed to
1749 be used in a while loop, reading C<$maxlength> bytes on every call.
1750 C<$maxlength> defaults to the size of the request if not specified.
1752 You have to set C<MyApp-E<gt>config-E<gt>{parse_on_demand}> to use this
1757 sub read { my $c = shift; return $c->engine->read( $c, @_ ) }
1765 sub run { my $c = shift; return $c->engine->run( $c, @_ ) }
1767 =head2 $c->set_action( $action, $code, $namespace, $attrs )
1769 Sets an action in a given namespace.
1773 sub set_action { my $c = shift; $c->dispatcher->set_action( $c, @_ ) }
1775 =head2 $c->setup_actions($component)
1777 Sets up actions for a component.
1781 sub setup_actions { my $c = shift; $c->dispatcher->setup_actions( $c, @_ ) }
1783 =head2 $c->setup_components
1789 sub setup_components {
1792 my $callback = sub {
1793 my ( $component, $context ) = @_;
1795 unless ( $component->can('COMPONENT') ) {
1799 my $suffix = Catalyst::Utils::class2classsuffix($component);
1800 my $config = $class->config->{$suffix} || {};
1804 eval { $instance = $component->COMPONENT( $context, $config ); };
1806 if ( my $error = $@ ) {
1810 Catalyst::Exception->throw( message =>
1811 qq/Couldn't instantiate component "$component", "$error"/ );
1814 Catalyst::Exception->throw( message =>
1815 qq/Couldn't instantiate component "$component", "COMPONENT() didn't return a object"/
1817 unless ref $instance;
1821 eval "package $class;\n" . q!Module::Pluggable::Fast->import(
1822 name => '_catalyst_components',
1824 "$class\::Controller", "$class\::C",
1825 "$class\::Model", "$class\::M",
1826 "$class\::View", "$class\::V"
1828 callback => $callback
1832 if ( my $error = $@ ) {
1836 Catalyst::Exception->throw(
1837 message => qq/Couldn't load components "$error"/ );
1840 for my $component ( $class->_catalyst_components($class) ) {
1841 $class->components->{ ref $component || $component } = $component;
1845 =head2 $c->setup_dispatcher
1851 sub setup_dispatcher {
1852 my ( $class, $dispatcher ) = @_;
1855 $dispatcher = 'Catalyst::Dispatcher::' . $dispatcher;
1858 if ( $ENV{CATALYST_DISPATCHER} ) {
1859 $dispatcher = 'Catalyst::Dispatcher::' . $ENV{CATALYST_DISPATCHER};
1862 if ( $ENV{ uc($class) . '_DISPATCHER' } ) {
1864 'Catalyst::Dispatcher::' . $ENV{ uc($class) . '_DISPATCHER' };
1867 unless ($dispatcher) {
1868 $dispatcher = $class->dispatcher_class;
1871 $dispatcher->require;
1874 Catalyst::Exception->throw(
1875 message => qq/Couldn't load dispatcher "$dispatcher", "$@"/ );
1878 # dispatcher instance
1879 $class->dispatcher( $dispatcher->new );
1882 =head2 $c->setup_engine
1889 my ( $class, $engine ) = @_;
1892 $engine = 'Catalyst::Engine::' . $engine;
1895 if ( $ENV{CATALYST_ENGINE} ) {
1896 $engine = 'Catalyst::Engine::' . $ENV{CATALYST_ENGINE};
1899 if ( $ENV{ uc($class) . '_ENGINE' } ) {
1900 $engine = 'Catalyst::Engine::' . $ENV{ uc($class) . '_ENGINE' };
1903 if ( $ENV{MOD_PERL} ) {
1905 # create the apache method
1908 *{"$class\::apache"} = sub { shift->engine->apache };
1911 my ( $software, $version ) =
1912 $ENV{MOD_PERL} =~ /^(\S+)\/(\d+(?:[\.\_]\d+)+)/;
1915 $version =~ s/(\.[^.]+)\./$1/g;
1917 if ( $software eq 'mod_perl' ) {
1921 if ( $version >= 1.99922 ) {
1922 $engine = 'Catalyst::Engine::Apache2::MP20';
1925 elsif ( $version >= 1.9901 ) {
1926 $engine = 'Catalyst::Engine::Apache2::MP19';
1929 elsif ( $version >= 1.24 ) {
1930 $engine = 'Catalyst::Engine::Apache::MP13';
1934 Catalyst::Exception->throw( message =>
1935 qq/Unsupported mod_perl version: $ENV{MOD_PERL}/ );
1940 # install the correct mod_perl handler
1941 if ( $version >= 1.9901 ) {
1942 *handler = sub : method {
1943 shift->handle_request(@_);
1947 *handler = sub ($$) { shift->handle_request(@_) };
1952 elsif ( $software eq 'Zeus-Perl' ) {
1953 $engine = 'Catalyst::Engine::Zeus';
1957 Catalyst::Exception->throw(
1958 message => qq/Unsupported mod_perl: $ENV{MOD_PERL}/ );
1963 $engine = $class->engine_class;
1969 Catalyst::Exception->throw( message =>
1970 qq/Couldn't load engine "$engine" (maybe you forgot to install it?), "$@"/
1974 # check for old engines that are no longer compatible
1976 if ( $engine->isa('Catalyst::Engine::Apache')
1977 && !Catalyst::Engine::Apache->VERSION )
1982 elsif ( $engine->isa('Catalyst::Engine::Server::Base')
1983 && Catalyst::Engine::Server->VERSION le '0.02' )
1988 elsif ($engine->isa('Catalyst::Engine::HTTP::POE')
1989 && $engine->VERSION eq '0.01' )
1994 elsif ($engine->isa('Catalyst::Engine::Zeus')
1995 && $engine->VERSION eq '0.01' )
2001 Catalyst::Exception->throw( message =>
2002 qq/Engine "$engine" is not supported by this version of Catalyst/
2007 $class->engine( $engine->new );
2010 =head2 $c->setup_home
2012 Sets up the home directory.
2017 my ( $class, $home ) = @_;
2019 if ( $ENV{CATALYST_HOME} ) {
2020 $home = $ENV{CATALYST_HOME};
2023 if ( $ENV{ uc($class) . '_HOME' } ) {
2024 $home = $ENV{ uc($class) . '_HOME' };
2028 $home = Catalyst::Utils::home($class);
2032 $class->config->{home} ||= $home;
2033 $class->config->{root} ||= Path::Class::Dir->new($home)->subdir('root');
2037 =head2 $c->setup_log
2044 my ( $class, $debug ) = @_;
2046 unless ( $class->log ) {
2047 $class->log( Catalyst::Log->new );
2050 my $app_flag = Catalyst::Utils::class2env($class) . '_DEBUG';
2053 ( defined( $ENV{CATALYST_DEBUG} ) || defined( $ENV{$app_flag} ) )
2054 ? ( $ENV{CATALYST_DEBUG} || $ENV{$app_flag} )
2059 *{"$class\::debug"} = sub { 1 };
2060 $class->log->debug('Debug messages enabled');
2064 =head2 $c->setup_plugins
2070 =head2 $c->registered_plugins
2072 Returns a sorted list of the plugins which have either been stated in the
2073 import list or which have been added via C<< MyApp->plugin(@args); >>.
2075 If passed a given plugin name, it will report a boolean value indicating
2076 whether or not that plugin is loaded. A fully qualified name is required if
2077 the plugin name does not begin with C<Catalyst::Plugin::>.
2079 if ($c->registered_plugins('Some::Plugin')) {
2087 sub registered_plugins {
2089 return sort keys %{ $proto->_plugins } unless @_;
2091 return 1 if exists $proto->_plugins->{$plugin};
2092 return exists $proto->_plugins->{"Catalyst::Plugin::$plugin"};
2095 sub _register_plugin {
2096 my ( $proto, $plugin, $instant ) = @_;
2097 my $class = ref $proto || $proto;
2101 if ( my $error = $@ ) {
2102 my $type = $instant ? "instant " : '';
2103 Catalyst::Exception->throw(
2104 message => qq/Couldn't load ${type}plugin "$plugin", $error/ );
2107 $proto->_plugins->{$plugin} = 1;
2110 unshift @{"$class\::ISA"}, $plugin;
2116 my ( $class, $plugins ) = @_;
2118 $class->_plugins( {} ) unless $class->_plugins;
2120 for my $plugin ( reverse @$plugins ) {
2122 unless ( $plugin =~ s/\A\+// ) {
2123 $plugin = "Catalyst::Plugin::$plugin";
2126 $class->_register_plugin($plugin);
2133 Returns an arrayref of the internal execution stack (actions that are currently
2136 =head2 $c->write( $data )
2138 Writes $data to the output stream. When using this method directly, you
2139 will need to manually set the C<Content-Length> header to the length of
2140 your output data, if known.
2147 # Finalize headers if someone manually writes output
2148 $c->finalize_headers;
2150 return $c->engine->write( $c, @_ );
2155 Returns the Catalyst version number. Mostly useful for "powered by"
2156 messages in template systems.
2160 sub version { return $Catalyst::VERSION }
2162 =head1 INTERNAL ACTIONS
2164 Catalyst uses internal actions like C<_DISPATCH>, C<_BEGIN>, C<_AUTO>,
2165 C<_ACTION>, and C<_END>. These are by default not shown in the private
2166 action table, but you can make them visible with a config parameter.
2168 MyApp->config->{show_internal_actions} = 1;
2170 =head1 CASE SENSITIVITY
2172 By default Catalyst is not case sensitive, so C<MyApp::C::FOO::Bar> is
2173 mapped to C</foo/bar>. You can activate case sensitivity with a config
2176 MyApp->config->{case_sensitive} = 1;
2178 This causes C<MyApp::C::Foo::Bar> to map to C</Foo/Bar>.
2180 =head1 ON-DEMAND PARSER
2182 The request body is usually parsed at the beginning of a request,
2183 but if you want to handle input yourself or speed things up a bit,
2184 you can enable on-demand parsing with a config parameter.
2186 MyApp->config->{parse_on_demand} = 1;
2188 =head1 PROXY SUPPORT
2190 Many production servers operate using the common double-server approach,
2191 with a lightweight frontend web server passing requests to a larger
2192 backend server. An application running on the backend server must deal
2193 with two problems: the remote user always appears to be C<127.0.0.1> and
2194 the server's hostname will appear to be C<localhost> regardless of the
2195 virtual host that the user connected through.
2197 Catalyst will automatically detect this situation when you are running
2198 the frontend and backend servers on the same machine. The following
2199 changes are made to the request.
2201 $c->req->address is set to the user's real IP address, as read from
2202 the HTTP X-Forwarded-For header.
2204 The host value for $c->req->base and $c->req->uri is set to the real
2205 host, as read from the HTTP X-Forwarded-Host header.
2207 Obviously, your web server must support these headers for this to work.
2209 In a more complex server farm environment where you may have your
2210 frontend proxy server(s) on different machines, you will need to set a
2211 configuration option to tell Catalyst to read the proxied data from the
2214 MyApp->config->{using_frontend_proxy} = 1;
2216 If you do not wish to use the proxy support at all, you may set:
2218 MyApp->config->{ignore_frontend_proxy} = 1;
2220 =head1 THREAD SAFETY
2222 Catalyst has been tested under Apache 2's threading mpm_worker, mpm_winnt,
2223 and the standalone forking HTTP server on Windows. We believe the Catalyst
2224 core to be thread-safe.
2226 If you plan to operate in a threaded environment, remember that all other
2227 modules you are using must also be thread-safe. Some modules, most notably
2228 L<DBD::SQLite>, are not thread-safe.
2234 Join #catalyst on irc.perl.org.
2238 http://lists.rawmode.org/mailman/listinfo/catalyst
2239 http://lists.rawmode.org/mailman/listinfo/catalyst-dev
2243 http://catalyst.perl.org
2247 http://dev.catalyst.perl.org
2251 =head2 L<Task::Catalyst> - All you need to start with Catalyst
2253 =head2 L<Catalyst::Manual> - The Catalyst Manual
2255 =head2 L<Catalyst::Component>, L<Catalyst::Base> - Base classes for components
2257 =head2 L<Catalyst::Engine> - Core engine
2259 =head2 L<Catalyst::Log> - Log class.
2261 =head2 L<Catalyst::Request> - Request object
2263 =head2 L<Catalyst::Response> - Response object
2265 =head2 L<Catalyst::Test> - The test suite.
2337 Sebastian Riedel, C<sri@oook.de>
2341 This library is free software, you can redistribute it and/or modify it under
2342 the same terms as Perl itself.