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.6902';
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::SchemaLoader 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->captures->[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 $class->log->warn("Running setup twice is not a good idea.")
729 if ( $class->setup_finished );
731 unless ( $class->isa('Catalyst') ) {
733 Catalyst::Exception->throw(
734 message => qq/'$class' does not inherit from Catalyst/ );
737 if ( $class->arguments ) {
738 @arguments = ( @arguments, @{ $class->arguments } );
744 foreach (@arguments) {
748 ( $flags->{log} ) ? 'debug,' . $flags->{log} : 'debug';
750 elsif (/^-(\w+)=?(.*)$/) {
751 $flags->{ lc $1 } = $2;
754 push @{ $flags->{plugins} }, $_;
758 $class->setup_home( delete $flags->{home} );
760 $class->setup_log( delete $flags->{log} );
761 $class->setup_plugins( delete $flags->{plugins} );
762 $class->setup_dispatcher( delete $flags->{dispatcher} );
763 $class->setup_engine( delete $flags->{engine} );
765 for my $flag ( sort keys %{$flags} ) {
767 if ( my $code = $class->can( 'setup_' . $flag ) ) {
768 &$code( $class, delete $flags->{$flag} );
771 $class->log->warn(qq/Unknown flag "$flag"/);
776 <<"EOF") if ( $ENV{CATALYST_SCRIPT_GEN} && ( $ENV{CATALYST_SCRIPT_GEN} < $Catalyst::CATALYST_SCRIPT_GEN ) );
777 You are running an old script!
779 Please update by running (this will overwrite existing files):
780 catalyst.pl -force -scripts $class
782 or (this will not overwrite existing files):
783 catalyst.pl -scripts $class
786 if ( $class->debug ) {
793 map { $_ . ' ' . ( $_->VERSION || '' ) }
794 grep { /^Catalyst::Plugin/ } @{"$class\::ISA"};
798 my $t = Text::SimpleTable->new(76);
799 $t->row($_) for @plugins;
800 $class->log->debug( "Loaded plugins:\n" . $t->draw );
803 my $dispatcher = $class->dispatcher;
804 my $engine = $class->engine;
805 my $home = $class->config->{home};
807 $class->log->debug(qq/Loaded dispatcher "$dispatcher"/);
808 $class->log->debug(qq/Loaded engine "$engine"/);
812 ? $class->log->debug(qq/Found home "$home"/)
813 : $class->log->debug(qq/Home "$home" doesn't exist/)
814 : $class->log->debug(q/Couldn't find home/);
819 no warnings qw/redefine/;
820 local *setup = sub { };
824 # Initialize our data structure
825 $class->components( {} );
827 $class->setup_components;
829 if ( $class->debug ) {
830 my $t = Text::SimpleTable->new( [ 65, 'Class' ], [ 8, 'Type' ] );
831 for my $comp ( sort keys %{ $class->components } ) {
832 my $type = ref $class->components->{$comp} ? 'instance' : 'class';
833 $t->row( $comp, $type );
835 $class->log->debug( "Loaded components:\n" . $t->draw )
836 if ( keys %{ $class->components } );
839 # Add our self to components, since we are also a component
840 $class->components->{$class} = $class;
842 $class->setup_actions;
844 if ( $class->debug ) {
845 my $name = $class->config->{name} || 'Application';
846 $class->log->info("$name powered by Catalyst $Catalyst::VERSION");
848 $class->log->_flush() if $class->log->can('_flush');
850 $class->setup_finished(1);
853 =head2 $c->uri_for( $path, @args?, \%query_values? )
855 Merges path with C<$c-E<gt>request-E<gt>base> for absolute uri's and
856 with C<$c-E<gt>namespace> for relative uri's, then returns a
857 normalized L<URI> object. If any args are passed, they are added at the
858 end of the path. If the last argument to uri_for is a hash reference,
859 it is assumed to contain GET parameter key/value pairs, which will be
860 appended to the URI in standard fashion.
865 my ( $c, $path, @args ) = @_;
866 my $base = $c->request->base->clone;
867 my $basepath = $base->path;
868 $basepath =~ s/\/$//;
870 my $namespace = $c->namespace || '';
872 # massage namespace, empty if absolute path
873 $namespace =~ s/^\///;
874 $namespace .= '/' if $namespace;
876 $namespace = '' if $path =~ /^\//;
880 ( scalar @args && ref $args[$#args] eq 'HASH' ? pop @args : {} );
882 for my $value ( values %$params ) {
\r
883 my $isa_ref = ref $value;
\r
884 if( $isa_ref and $isa_ref ne 'ARRAY' ) {
\r
885 croak( "Non-array reference ($isa_ref) passed to uri_for()" );
\r
887 utf8::encode( $_ ) for grep { defined } $isa_ref ? @$value : $value;
\r
890 # join args with '/', or a blank string
891 my $args = ( scalar @args ? '/' . join( '/', @args ) : '' );
892 $args =~ s/^\/// unless $path;
894 URI->new_abs( URI->new_abs( "$path$args", "$basepath$namespace" ), $base )
896 $res->query_form(%$params);
900 =head2 $c->welcome_message
902 Returns the Catalyst welcome HTML page.
906 sub welcome_message {
908 my $name = $c->config->{name};
909 my $logo = $c->uri_for('/static/images/catalyst_logo.png');
910 my $prefix = Catalyst::Utils::appprefix( ref $c );
911 $c->response->content_type('text/html; charset=utf-8');
913 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
914 "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
915 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
917 <meta http-equiv="Content-Language" content="en" />
918 <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
919 <title>$name on Catalyst $VERSION</title>
920 <style type="text/css">
923 background-color: #eee;
932 background-color: #ccc;
933 border: 1px solid #aaa;
934 -moz-border-radius: 10px;
939 font-family: verdana, tahoma, sans-serif;
942 font-family: verdana, tahoma, sans-serif;
945 text-decoration: none;
947 border-bottom: 1px dotted #bbb;
949 :link:hover, :visited:hover {
962 background-color: #fff;
963 border: 1px solid #aaa;
964 -moz-border-radius: 10px;
990 <h1><span id="appname">$name</span> on <a href="http://catalyst.perl.org">Catalyst</a>
995 <img src="$logo" alt="Catalyst Logo" />
997 <p>Welcome to the wonderful world of Catalyst.
998 This <a href="http://en.wikipedia.org/wiki/MVC">MVC</a>
999 framework will make web development something you had
1000 never expected it to be: Fun, rewarding, and quick.</p>
1001 <h2>What to do now?</h2>
1002 <p>That really depends on what <b>you</b> want to do.
1003 We do, however, provide you with a few starting points.</p>
1004 <p>If you want to jump right into web development with Catalyst
1005 you might want to check out the documentation.</p>
1006 <pre><code>perldoc <a href="http://cpansearch.perl.org/dist/Catalyst/lib/Catalyst/Manual/Intro.pod">Catalyst::Manual::Intro</a>
1007 perldoc <a href="http://cpansearch.perl.org/dist/Catalyst/lib/Catalyst/Manual/Tutorial.pod">Catalyst::Manual::Tutorial</a></code>
1008 perldoc <a href="http://cpansearch.perl.org/dist/Catalyst/lib/Catalyst/Manual.pod">Catalyst::Manual</a></code></pre>
1009 <h2>What to do next?</h2>
1010 <p>Next it's time to write an actual application. Use the
1011 helper scripts to generate <a href="http://cpansearch.perl.org/search?query=Catalyst%3A%3AController%3A%3A&mode=all">controllers</a>,
1012 <a href="http://cpansearch.perl.org/search?query=Catalyst%3A%3AModel%3A%3A&mode=all">models</a>, and
1013 <a href="http://cpansearch.perl.org/search?query=Catalyst%3A%3AView%3A%3A&mode=all">views</a>;
1014 they can save you a lot of work.</p>
1015 <pre><code>script/${prefix}_create.pl -help</code></pre>
1016 <p>Also, be sure to check out the vast and growing
1017 collection of <a href="http://cpansearch.perl.org/search?query=Catalyst%3A%3APlugin%3A%3A&mode=all">plugins for Catalyst on CPAN</a>;
1018 you are likely to find what you need there.
1022 <p>Catalyst has a very active community. Here are the main places to
1023 get in touch with us.</p>
1026 <a href="http://dev.catalyst.perl.org">Wiki</a>
1029 <a href="http://lists.rawmode.org/mailman/listinfo/catalyst">Mailing-List</a>
1032 <a href="irc://irc.perl.org/catalyst">IRC channel #catalyst on irc.perl.org</a>
1035 <h2>In conclusion</h2>
1036 <p>The Catalyst team hopes you will enjoy using Catalyst as much
1037 as we enjoyed making it. Please contact us if you have ideas
1038 for improvement or other feedback.</p>
1046 =head1 INTERNAL METHODS
1048 These methods are not meant to be used by end users.
1050 =head2 $c->components
1052 Returns a hash of components.
1054 =head2 $c->context_class
1056 Returns or sets the context class.
1060 Returns a hashref containing coderefs and execution counts (needed for
1061 deep recursion detection).
1065 Returns the number of actions on the current internal execution stack.
1069 Dispatches a request to actions.
1073 sub dispatch { my $c = shift; $c->dispatcher->dispatch( $c, @_ ) }
1075 =head2 $c->dispatcher_class
1077 Returns or sets the dispatcher class.
1079 =head2 $c->dump_these
1081 Returns a list of 2-element array references (name, structure) pairs
1082 that will be dumped on the error page in debug mode.
1088 [ Request => $c->req ],
1089 [ Response => $c->res ],
1090 [ Stash => $c->stash ],
1091 [ Config => $c->config ];
1094 =head2 $c->engine_class
1096 Returns or sets the engine class.
1098 =head2 $c->execute( $class, $coderef )
1100 Execute a coderef in given class and catch exceptions. Errors are available
1106 my ( $c, $class, $code ) = @_;
1107 $class = $c->component($class) || $class;
1110 if ( $c->depth >= $RECURSION ) {
1111 my $action = "$code";
1112 $action = "/$action" unless $action =~ /\-\>/;
1113 my $error = qq/Deep recursion detected calling "$action"/;
1114 $c->log->error($error);
1120 my $stats_info = $c->_stats_start_execute( $code );
1122 push( @{ $c->stack }, $code );
1124 eval { $c->state( &$code( $class, $c, @{ $c->req->args } ) || 0 ) };
1126 $c->_stats_finish_execute( $stats_info );
1128 my $last = ${ $c->stack }[-1];
1129 pop( @{ $c->stack } );
1131 if ( my $error = $@ ) {
1132 if ( $error eq $DETACH ) { die $DETACH if $c->depth > 1 }
1134 unless ( ref $error ) {
1136 my $class = $last->class;
1137 my $name = $last->name;
1138 $error = qq/Caught exception in $class->$name "$error"/;
1147 sub _stats_start_execute {
1148 my ( $c, $code ) = @_;
1150 return unless $c->debug;
1152 my $action = "$code";
1154 $action = "/$action" unless $action =~ /\-\>/;
1155 $c->counter->{"$code"}++;
1157 # determine if the call was the result of a forward
1158 # this is done by walking up the call stack and looking for a calling
1159 # sub of Catalyst::forward before the eval
1161 for my $index ( 2 .. 11 ) {
1163 if ( ( caller($index) )[0] eq 'Catalyst'
1164 && ( caller($index) )[3] eq '(eval)' );
1166 if ( ( caller($index) )[3] =~ /forward$/ ) {
1167 $callsub = ( caller($index) )[3];
1168 $action = "-> $action";
1173 my $node = Tree::Simple->new(
1176 elapsed => undef, # to be filled in later
1180 $node->setUID( "$code" . $c->counter->{"$code"} );
1182 unless ( ( $code->name =~ /^_.*/ )
1183 && ( !$c->config->{show_internal_actions} ) )
1185 # is this a root-level call or a forwarded call?
1186 if ( $callsub =~ /forward$/ ) {
1188 # forward, locate the caller
1189 if ( my $parent = $c->stack->[-1] ) {
1190 my $visitor = Tree::Simple::Visitor::FindByUID->new;
1191 $visitor->searchForUID(
1192 "$parent" . $c->counter->{"$parent"} );
1193 $c->stats->accept($visitor);
1194 if ( my $result = $visitor->getResult ) {
1195 $result->addChild($node);
1200 # forward with no caller may come from a plugin
1201 $c->stats->addChild($node);
1207 $c->stats->addChild($node);
1211 my $start = [gettimeofday];
1212 my $elapsed = tv_interval($start);
1216 elapsed => $elapsed,
1222 sub _stats_finish_execute {
1223 my ( $c, $info ) = @_;
1225 return unless $c->debug;
1227 my ( $code, $start, $elapsed ) = @{ $info }{qw/code start elapsed/};
1229 unless ( ( $code->name =~ /^_.*/ )
1230 && ( !$c->config->{show_internal_actions} ) )
1233 # FindByUID uses an internal die, so we save the existing error
1236 # locate the node in the tree and update the elapsed time
1237 my $visitor = Tree::Simple::Visitor::FindByUID->new;
1238 $visitor->searchForUID( "$code" . $c->counter->{"$code"} );
1239 $c->stats->accept($visitor);
1240 if ( my $result = $visitor->getResult ) {
1241 my $value = $result->getNodeValue;
1242 $value->{elapsed} = sprintf( '%fs', $elapsed );
1243 $result->setNodeValue($value);
1247 $@ = $error || undef;
1251 =head2 $c->_localize_fields( sub { }, \%keys );
1255 sub _localize_fields {
1256 my ( $c, $localized, $code ) = ( @_ );
1258 my $request = delete $localized->{request} || {};
1259 my $response = delete $localized->{response} || {};
1261 local @{ $c }{ keys %$localized } = values %$localized;
1262 local @{ $c->request }{ keys %$request } = values %$request;
1263 local @{ $c->response }{ keys %$response } = values %$response;
1270 Finalizes the request.
1277 for my $error ( @{ $c->error } ) {
1278 $c->log->error($error);
1281 # Allow engine to handle finalize flow (for POE)
1282 if ( $c->engine->can('finalize') ) {
1283 $c->engine->finalize( $c );
1287 $c->finalize_uploads;
1290 if ( $#{ $c->error } >= 0 ) {
1294 $c->finalize_headers;
1297 if ( $c->request->method eq 'HEAD' ) {
1298 $c->response->body('');
1304 return $c->response->status;
1307 =head2 $c->finalize_body
1313 sub finalize_body { my $c = shift; $c->engine->finalize_body( $c, @_ ) }
1315 =head2 $c->finalize_cookies
1321 sub finalize_cookies { my $c = shift; $c->engine->finalize_cookies( $c, @_ ) }
1323 =head2 $c->finalize_error
1329 sub finalize_error { my $c = shift; $c->engine->finalize_error( $c, @_ ) }
1331 =head2 $c->finalize_headers
1337 sub finalize_headers {
1340 # Check if we already finalized headers
1341 return if $c->response->{_finalized_headers};
1344 if ( my $location = $c->response->redirect ) {
1345 $c->log->debug(qq/Redirecting to "$location"/) if $c->debug;
1346 $c->response->header( Location => $location );
1350 if ( $c->response->body && !$c->response->content_length ) {
1352 # get the length from a filehandle
1353 if ( blessed( $c->response->body ) && $c->response->body->can('read') )
1355 if ( my $stat = stat $c->response->body ) {
1356 $c->response->content_length( $stat->size );
1359 $c->log->warn('Serving filehandle without a content-length');
1363 $c->response->content_length( bytes::length( $c->response->body ) );
1368 if ( $c->response->status =~ /^(1\d\d|[23]04)$/ ) {
1369 $c->response->headers->remove_header("Content-Length");
1370 $c->response->body('');
1373 $c->finalize_cookies;
1375 $c->engine->finalize_headers( $c, @_ );
1378 $c->response->{_finalized_headers} = 1;
1381 =head2 $c->finalize_output
1383 An alias for finalize_body.
1385 =head2 $c->finalize_read
1387 Finalizes the input after reading is complete.
1391 sub finalize_read { my $c = shift; $c->engine->finalize_read( $c, @_ ) }
1393 =head2 $c->finalize_uploads
1395 Finalizes uploads. Cleans up any temporary files.
1399 sub finalize_uploads { my $c = shift; $c->engine->finalize_uploads( $c, @_ ) }
1401 =head2 $c->get_action( $action, $namespace )
1403 Gets an action in a given namespace.
1407 sub get_action { my $c = shift; $c->dispatcher->get_action(@_) }
1409 =head2 $c->get_actions( $action, $namespace )
1411 Gets all actions of a given name in a namespace and all parent
1416 sub get_actions { my $c = shift; $c->dispatcher->get_actions( $c, @_ ) }
1418 =head2 $c->handle_request( $class, @arguments )
1420 Called to handle each HTTP request.
1424 sub handle_request {
1425 my ( $class, @arguments ) = @_;
1427 # Always expect worst case!
1430 my $stats = ( $class->debug ) ? Tree::Simple->new: q{};
1433 my $c = $class->prepare(@arguments);
1436 return $c->finalize;
1439 if ( $class->debug ) {
1440 my $start = [gettimeofday];
1441 $status = &$handler;
1442 my $elapsed = tv_interval $start;
1443 $elapsed = sprintf '%f', $elapsed;
1444 my $av = sprintf '%.3f',
1445 ( $elapsed == 0 ? '??' : ( 1 / $elapsed ) );
1446 my $t = Text::SimpleTable->new( [ 64, 'Action' ], [ 9, 'Time' ] );
1451 my $stat = $action->getNodeValue;
1452 $t->row( ( q{ } x $action->getDepth ) . $stat->{action} . $stat->{comment},
1453 $stat->{elapsed} || '??' );
1458 "Request took ${elapsed}s ($av/s)\n" . $t->draw );
1460 else { $status = &$handler }
1464 if ( my $error = $@ ) {
1466 $class->log->error(qq/Caught exception in engine "$error"/);
1470 $class->log->_flush() if $class->log->can('_flush');
1474 =head2 $c->prepare( @arguments )
1476 Creates a Catalyst context from an engine-specific request (Apache, CGI,
1482 my ( $class, @arguments ) = @_;
1484 $class->context_class( ref $class || $class ) unless $class->context_class;
1485 my $c = $class->context_class->new(
1489 request => $class->request_class->new(
1492 body_parameters => {},
1494 headers => HTTP::Headers->new,
1496 query_parameters => {},
1502 response => $class->response_class->new(
1506 headers => HTTP::Headers->new(),
1515 # For on-demand data
1516 $c->request->{_context} = $c;
1517 $c->response->{_context} = $c;
1518 weaken( $c->request->{_context} );
1519 weaken( $c->response->{_context} );
1522 my $secs = time - $START || 1;
1523 my $av = sprintf '%.3f', $COUNT / $secs;
1524 $c->log->debug('**********************************');
1525 $c->log->debug("* Request $COUNT ($av/s) [$$]");
1526 $c->log->debug('**********************************');
1527 $c->res->headers->header( 'X-Catalyst' => $Catalyst::VERSION );
1530 # Allow engine to direct the prepare flow (for POE)
1531 if ( $c->engine->can('prepare') ) {
1532 $c->engine->prepare( $c, @arguments );
1535 $c->prepare_request(@arguments);
1536 $c->prepare_connection;
1537 $c->prepare_query_parameters;
1538 $c->prepare_headers;
1539 $c->prepare_cookies;
1543 $c->prepare_body unless $c->config->{parse_on_demand};
1546 my $method = $c->req->method || '';
1547 my $path = $c->req->path || '';
1548 my $address = $c->req->address || '';
1550 $c->log->debug(qq/"$method" request for "$path" from "$address"/)
1558 =head2 $c->prepare_action
1560 Prepares action. See L<Catalyst::Dispatcher>.
1564 sub prepare_action { my $c = shift; $c->dispatcher->prepare_action( $c, @_ ) }
1566 =head2 $c->prepare_body
1568 Prepares message body.
1575 # Do we run for the first time?
1576 return if defined $c->request->{_body};
1578 # Initialize on-demand data
1579 $c->engine->prepare_body( $c, @_ );
1580 $c->prepare_parameters;
1581 $c->prepare_uploads;
1583 if ( $c->debug && keys %{ $c->req->body_parameters } ) {
1584 my $t = Text::SimpleTable->new( [ 37, 'Key' ], [ 36, 'Value' ] );
1585 for my $key ( sort keys %{ $c->req->body_parameters } ) {
1586 my $param = $c->req->body_parameters->{$key};
1587 my $value = defined($param) ? $param : '';
1589 ref $value eq 'ARRAY' ? ( join ', ', @$value ) : $value );
1591 $c->log->debug( "Body Parameters are:\n" . $t->draw );
1595 =head2 $c->prepare_body_chunk( $chunk )
1597 Prepares a chunk of data before sending it to L<HTTP::Body>.
1599 See L<Catalyst::Engine>.
1603 sub prepare_body_chunk {
1605 $c->engine->prepare_body_chunk( $c, @_ );
1608 =head2 $c->prepare_body_parameters
1610 Prepares body parameters.
1614 sub prepare_body_parameters {
1616 $c->engine->prepare_body_parameters( $c, @_ );
1619 =head2 $c->prepare_connection
1621 Prepares connection.
1625 sub prepare_connection {
1627 $c->engine->prepare_connection( $c, @_ );
1630 =head2 $c->prepare_cookies
1636 sub prepare_cookies { my $c = shift; $c->engine->prepare_cookies( $c, @_ ) }
1638 =head2 $c->prepare_headers
1644 sub prepare_headers { my $c = shift; $c->engine->prepare_headers( $c, @_ ) }
1646 =head2 $c->prepare_parameters
1648 Prepares parameters.
1652 sub prepare_parameters {
1654 $c->prepare_body_parameters;
1655 $c->engine->prepare_parameters( $c, @_ );
1658 =head2 $c->prepare_path
1660 Prepares path and base.
1664 sub prepare_path { my $c = shift; $c->engine->prepare_path( $c, @_ ) }
1666 =head2 $c->prepare_query_parameters
1668 Prepares query parameters.
1672 sub prepare_query_parameters {
1675 $c->engine->prepare_query_parameters( $c, @_ );
1677 if ( $c->debug && keys %{ $c->request->query_parameters } ) {
1678 my $t = Text::SimpleTable->new( [ 37, 'Key' ], [ 36, 'Value' ] );
1679 for my $key ( sort keys %{ $c->req->query_parameters } ) {
1680 my $param = $c->req->query_parameters->{$key};
1681 my $value = defined($param) ? $param : '';
1683 ref $value eq 'ARRAY' ? ( join ', ', @$value ) : $value );
1685 $c->log->debug( "Query Parameters are:\n" . $t->draw );
1689 =head2 $c->prepare_read
1691 Prepares the input for reading.
1695 sub prepare_read { my $c = shift; $c->engine->prepare_read( $c, @_ ) }
1697 =head2 $c->prepare_request
1699 Prepares the engine request.
1703 sub prepare_request { my $c = shift; $c->engine->prepare_request( $c, @_ ) }
1705 =head2 $c->prepare_uploads
1711 sub prepare_uploads {
1714 $c->engine->prepare_uploads( $c, @_ );
1716 if ( $c->debug && keys %{ $c->request->uploads } ) {
1717 my $t = Text::SimpleTable->new(
1723 for my $key ( sort keys %{ $c->request->uploads } ) {
1724 my $upload = $c->request->uploads->{$key};
1725 for my $u ( ref $upload eq 'ARRAY' ? @{$upload} : ($upload) ) {
1726 $t->row( $key, $u->filename, $u->type, $u->size );
1729 $c->log->debug( "File Uploads are:\n" . $t->draw );
1733 =head2 $c->prepare_write
1735 Prepares the output for writing.
1739 sub prepare_write { my $c = shift; $c->engine->prepare_write( $c, @_ ) }
1741 =head2 $c->request_class
1743 Returns or sets the request class.
1745 =head2 $c->response_class
1747 Returns or sets the response class.
1749 =head2 $c->read( [$maxlength] )
1751 Reads a chunk of data from the request body. This method is designed to
1752 be used in a while loop, reading C<$maxlength> bytes on every call.
1753 C<$maxlength> defaults to the size of the request if not specified.
1755 You have to set C<MyApp-E<gt>config-E<gt>{parse_on_demand}> to use this
1760 sub read { my $c = shift; return $c->engine->read( $c, @_ ) }
1768 sub run { my $c = shift; return $c->engine->run( $c, @_ ) }
1770 =head2 $c->set_action( $action, $code, $namespace, $attrs )
1772 Sets an action in a given namespace.
1776 sub set_action { my $c = shift; $c->dispatcher->set_action( $c, @_ ) }
1778 =head2 $c->setup_actions($component)
1780 Sets up actions for a component.
1784 sub setup_actions { my $c = shift; $c->dispatcher->setup_actions( $c, @_ ) }
1786 =head2 $c->setup_components
1792 sub setup_components {
1795 my $callback = sub {
1796 my ( $component, $context ) = @_;
1798 unless ( $component->can('COMPONENT') ) {
1802 my $suffix = Catalyst::Utils::class2classsuffix($component);
1803 my $config = $class->config->{$suffix} || {};
1807 eval { $instance = $component->COMPONENT( $context, $config ); };
1809 if ( my $error = $@ ) {
1813 Catalyst::Exception->throw( message =>
1814 qq/Couldn't instantiate component "$component", "$error"/ );
1817 Catalyst::Exception->throw( message =>
1818 qq/Couldn't instantiate component "$component", "COMPONENT() didn't return a object"/
1820 unless ref $instance;
1824 eval "package $class;\n" . q!Module::Pluggable::Fast->import(
1825 name => '_catalyst_components',
1827 "$class\::Controller", "$class\::C",
1828 "$class\::Model", "$class\::M",
1829 "$class\::View", "$class\::V"
1831 callback => $callback
1835 if ( my $error = $@ ) {
1839 Catalyst::Exception->throw(
1840 message => qq/Couldn't load components "$error"/ );
1843 for my $component ( $class->_catalyst_components($class) ) {
1844 $class->components->{ ref $component || $component } = $component;
1848 =head2 $c->setup_dispatcher
1854 sub setup_dispatcher {
1855 my ( $class, $dispatcher ) = @_;
1858 $dispatcher = 'Catalyst::Dispatcher::' . $dispatcher;
1861 if ( $ENV{CATALYST_DISPATCHER} ) {
1862 $dispatcher = 'Catalyst::Dispatcher::' . $ENV{CATALYST_DISPATCHER};
1865 if ( $ENV{ uc($class) . '_DISPATCHER' } ) {
1867 'Catalyst::Dispatcher::' . $ENV{ uc($class) . '_DISPATCHER' };
1870 unless ($dispatcher) {
1871 $dispatcher = $class->dispatcher_class;
1874 $dispatcher->require;
1877 Catalyst::Exception->throw(
1878 message => qq/Couldn't load dispatcher "$dispatcher", "$@"/ );
1881 # dispatcher instance
1882 $class->dispatcher( $dispatcher->new );
1885 =head2 $c->setup_engine
1892 my ( $class, $engine ) = @_;
1895 $engine = 'Catalyst::Engine::' . $engine;
1898 if ( $ENV{CATALYST_ENGINE} ) {
1899 $engine = 'Catalyst::Engine::' . $ENV{CATALYST_ENGINE};
1902 if ( $ENV{ uc($class) . '_ENGINE' } ) {
1903 $engine = 'Catalyst::Engine::' . $ENV{ uc($class) . '_ENGINE' };
1906 if ( $ENV{MOD_PERL} ) {
1908 # create the apache method
1911 *{"$class\::apache"} = sub { shift->engine->apache };
1914 my ( $software, $version ) =
1915 $ENV{MOD_PERL} =~ /^(\S+)\/(\d+(?:[\.\_]\d+)+)/;
1918 $version =~ s/(\.[^.]+)\./$1/g;
1920 if ( $software eq 'mod_perl' ) {
1924 if ( $version >= 1.99922 ) {
1925 $engine = 'Catalyst::Engine::Apache2::MP20';
1928 elsif ( $version >= 1.9901 ) {
1929 $engine = 'Catalyst::Engine::Apache2::MP19';
1932 elsif ( $version >= 1.24 ) {
1933 $engine = 'Catalyst::Engine::Apache::MP13';
1937 Catalyst::Exception->throw( message =>
1938 qq/Unsupported mod_perl version: $ENV{MOD_PERL}/ );
1943 # install the correct mod_perl handler
1944 if ( $version >= 1.9901 ) {
1945 *handler = sub : method {
1946 shift->handle_request(@_);
1950 *handler = sub ($$) { shift->handle_request(@_) };
1955 elsif ( $software eq 'Zeus-Perl' ) {
1956 $engine = 'Catalyst::Engine::Zeus';
1960 Catalyst::Exception->throw(
1961 message => qq/Unsupported mod_perl: $ENV{MOD_PERL}/ );
1966 $engine = $class->engine_class;
1972 Catalyst::Exception->throw( message =>
1973 qq/Couldn't load engine "$engine" (maybe you forgot to install it?), "$@"/
1977 # check for old engines that are no longer compatible
1979 if ( $engine->isa('Catalyst::Engine::Apache')
1980 && !Catalyst::Engine::Apache->VERSION )
1985 elsif ( $engine->isa('Catalyst::Engine::Server::Base')
1986 && Catalyst::Engine::Server->VERSION le '0.02' )
1991 elsif ($engine->isa('Catalyst::Engine::HTTP::POE')
1992 && $engine->VERSION eq '0.01' )
1997 elsif ($engine->isa('Catalyst::Engine::Zeus')
1998 && $engine->VERSION eq '0.01' )
2004 Catalyst::Exception->throw( message =>
2005 qq/Engine "$engine" is not supported by this version of Catalyst/
2010 $class->engine( $engine->new );
2013 =head2 $c->setup_home
2015 Sets up the home directory.
2020 my ( $class, $home ) = @_;
2022 if ( $ENV{CATALYST_HOME} ) {
2023 $home = $ENV{CATALYST_HOME};
2026 if ( $ENV{ uc($class) . '_HOME' } ) {
2027 $home = $ENV{ uc($class) . '_HOME' };
2031 $home = Catalyst::Utils::home($class);
2035 $class->config->{home} ||= $home;
2036 $class->config->{root} ||= Path::Class::Dir->new($home)->subdir('root');
2040 =head2 $c->setup_log
2047 my ( $class, $debug ) = @_;
2049 unless ( $class->log ) {
2050 $class->log( Catalyst::Log->new );
2053 my $app_flag = Catalyst::Utils::class2env($class) . '_DEBUG';
2056 ( defined( $ENV{CATALYST_DEBUG} ) || defined( $ENV{$app_flag} ) )
2057 ? ( $ENV{CATALYST_DEBUG} || $ENV{$app_flag} )
2062 *{"$class\::debug"} = sub { 1 };
2063 $class->log->debug('Debug messages enabled');
2067 =head2 $c->setup_plugins
2073 =head2 $c->registered_plugins
2075 Returns a sorted list of the plugins which have either been stated in the
2076 import list or which have been added via C<< MyApp->plugin(@args); >>.
2078 If passed a given plugin name, it will report a boolean value indicating
2079 whether or not that plugin is loaded. A fully qualified name is required if
2080 the plugin name does not begin with C<Catalyst::Plugin::>.
2082 if ($c->registered_plugins('Some::Plugin')) {
2090 sub registered_plugins {
2092 return sort keys %{ $proto->_plugins } unless @_;
2094 return 1 if exists $proto->_plugins->{$plugin};
2095 return exists $proto->_plugins->{"Catalyst::Plugin::$plugin"};
2098 sub _register_plugin {
2099 my ( $proto, $plugin, $instant ) = @_;
2100 my $class = ref $proto || $proto;
2104 if ( my $error = $@ ) {
2105 my $type = $instant ? "instant " : '';
2106 Catalyst::Exception->throw(
2107 message => qq/Couldn't load ${type}plugin "$plugin", $error/ );
2110 $proto->_plugins->{$plugin} = 1;
2113 unshift @{"$class\::ISA"}, $plugin;
2119 my ( $class, $plugins ) = @_;
2121 $class->_plugins( {} ) unless $class->_plugins;
2123 for my $plugin ( reverse @$plugins ) {
2125 unless ( $plugin =~ s/\A\+// ) {
2126 $plugin = "Catalyst::Plugin::$plugin";
2129 $class->_register_plugin($plugin);
2136 Returns an arrayref of the internal execution stack (actions that are currently
2139 =head2 $c->write( $data )
2141 Writes $data to the output stream. When using this method directly, you
2142 will need to manually set the C<Content-Length> header to the length of
2143 your output data, if known.
2150 # Finalize headers if someone manually writes output
2151 $c->finalize_headers;
2153 return $c->engine->write( $c, @_ );
2158 Returns the Catalyst version number. Mostly useful for "powered by"
2159 messages in template systems.
2163 sub version { return $Catalyst::VERSION }
2165 =head1 INTERNAL ACTIONS
2167 Catalyst uses internal actions like C<_DISPATCH>, C<_BEGIN>, C<_AUTO>,
2168 C<_ACTION>, and C<_END>. These are by default not shown in the private
2169 action table, but you can make them visible with a config parameter.
2171 MyApp->config->{show_internal_actions} = 1;
2173 =head1 CASE SENSITIVITY
2175 By default Catalyst is not case sensitive, so C<MyApp::C::FOO::Bar> is
2176 mapped to C</foo/bar>. You can activate case sensitivity with a config
2179 MyApp->config->{case_sensitive} = 1;
2181 This causes C<MyApp::C::Foo::Bar> to map to C</Foo/Bar>.
2183 =head1 ON-DEMAND PARSER
2185 The request body is usually parsed at the beginning of a request,
2186 but if you want to handle input yourself or speed things up a bit,
2187 you can enable on-demand parsing with a config parameter.
2189 MyApp->config->{parse_on_demand} = 1;
2191 =head1 PROXY SUPPORT
2193 Many production servers operate using the common double-server approach,
2194 with a lightweight frontend web server passing requests to a larger
2195 backend server. An application running on the backend server must deal
2196 with two problems: the remote user always appears to be C<127.0.0.1> and
2197 the server's hostname will appear to be C<localhost> regardless of the
2198 virtual host that the user connected through.
2200 Catalyst will automatically detect this situation when you are running
2201 the frontend and backend servers on the same machine. The following
2202 changes are made to the request.
2204 $c->req->address is set to the user's real IP address, as read from
2205 the HTTP X-Forwarded-For header.
2207 The host value for $c->req->base and $c->req->uri is set to the real
2208 host, as read from the HTTP X-Forwarded-Host header.
2210 Obviously, your web server must support these headers for this to work.
2212 In a more complex server farm environment where you may have your
2213 frontend proxy server(s) on different machines, you will need to set a
2214 configuration option to tell Catalyst to read the proxied data from the
2217 MyApp->config->{using_frontend_proxy} = 1;
2219 If you do not wish to use the proxy support at all, you may set:
2221 MyApp->config->{ignore_frontend_proxy} = 1;
2223 =head1 THREAD SAFETY
2225 Catalyst has been tested under Apache 2's threading mpm_worker, mpm_winnt,
2226 and the standalone forking HTTP server on Windows. We believe the Catalyst
2227 core to be thread-safe.
2229 If you plan to operate in a threaded environment, remember that all other
2230 modules you are using must also be thread-safe. Some modules, most notably
2231 L<DBD::SQLite>, are not thread-safe.
2237 Join #catalyst on irc.perl.org.
2241 http://lists.rawmode.org/mailman/listinfo/catalyst
2242 http://lists.rawmode.org/mailman/listinfo/catalyst-dev
2246 http://catalyst.perl.org
2250 http://dev.catalyst.perl.org
2254 =head2 L<Task::Catalyst> - All you need to start with Catalyst
2256 =head2 L<Catalyst::Manual> - The Catalyst Manual
2258 =head2 L<Catalyst::Component>, L<Catalyst::Base> - Base classes for components
2260 =head2 L<Catalyst::Engine> - Core engine
2262 =head2 L<Catalyst::Log> - Log class.
2264 =head2 L<Catalyst::Request> - Request object
2266 =head2 L<Catalyst::Response> - Response object
2268 =head2 L<Catalyst::Test> - The test suite.
2340 Sebastian Riedel, C<sri@oook.de>
2344 This library is free software, you can redistribute it and/or modify it under
2345 the same terms as Perl itself.