4 use base 'Catalyst::Component';
6 use Catalyst::Exception;
9 use Catalyst::Request::Upload;
10 use Catalyst::Response;
12 use Catalyst::Controller;
15 use Text::SimpleTable;
17 use Path::Class::File;
18 use Time::HiRes qw/gettimeofday tv_interval/;
20 use Scalar::Util qw/weaken blessed/;
21 use Tree::Simple qw/use_weak_refs/;
22 use Tree::Simple::Visitor::FindByUID;
27 BEGIN { require 5.008001; }
29 __PACKAGE__->mk_accessors(
30 qw/counter request response state action stack namespace stats/
33 attributes->import( __PACKAGE__, \&namespace, 'lvalue' );
35 sub depth { scalar @{ shift->stack || [] }; }
42 # For backwards compatibility
43 *finalize_output = \&finalize_body;
48 our $RECURSION = 1000;
49 our $DETACH = "catalyst_detach\n";
51 require Module::Pluggable::Fast;
53 __PACKAGE__->mk_classdata($_)
54 for qw/components arguments dispatcher engine log dispatcher_class
55 engine_class context_class request_class response_class setup_finished/;
57 __PACKAGE__->dispatcher_class('Catalyst::Dispatcher');
58 __PACKAGE__->engine_class('Catalyst::Engine::CGI');
59 __PACKAGE__->request_class('Catalyst::Request');
60 __PACKAGE__->response_class('Catalyst::Response');
62 our $VERSION = '5.6902';
65 my ( $class, @arguments ) = @_;
67 # We have to limit $class to Catalyst to avoid pushing Catalyst upon every
69 return unless $class eq 'Catalyst';
71 my $caller = caller(0);
73 unless ( $caller->isa('Catalyst') ) {
75 push @{"$caller\::ISA"}, $class, 'Catalyst::Controller';
78 $caller->arguments( [@arguments] );
84 Catalyst - The Elegant MVC Web Application Framework
88 # use the helper to create a new application
91 # add models, views, controllers
92 script/myapp_create.pl model Database DBIC::SchemaLoader dbi:SQLite:/path/to/db
93 script/myapp_create.pl view TT TT
94 script/myapp_create.pl controller Search
96 # built in testserver -- use -r to restart automatically on changes
97 script/myapp_server.pl
99 # command line testing interface
100 script/myapp_test.pl /yada
103 use Catalyst qw/-Debug/; # include plugins here as well
105 ### In lib/MyApp/Controller/Root.pm (autocreated)
106 sub foo : Global { # called for /foo, /foo/1, /foo/1/2, etc.
107 my ( $self, $c, @args ) = @_; # args are qw/1 2/ for /foo/1/2
108 $c->stash->{template} = 'foo.tt'; # set the template
109 # lookup something from db -- stash vars are passed to TT
111 $c->model('Database::Foo')->search( { country => $args[0] } );
112 if ( $c->req->params->{bar} ) { # access GET or POST parameters
113 $c->forward( 'bar' ); # process another action
114 # do something else after forward returns
118 # The foo.tt TT template can use the stash data from the database
119 [% WHILE (item = data.next) %]
123 # called for /bar/of/soap, /bar/of/soap/10, etc.
124 sub bar : Path('/bar/of/soap') { ... }
126 # called for all actions, from the top-most controller downwards
128 my ( $self, $c ) = @_;
129 if ( !$c->user_exists ) { # Catalyst::Plugin::Authentication
130 $c->res->redirect( '/login' ); # require login
131 return 0; # abort request and go immediately to end()
133 return 1; # success; carry on to next action
136 # called after all actions are finished
138 my ( $self, $c ) = @_;
139 if ( scalar @{ $c->error } ) { ... } # handle errors
140 return if $c->res->body; # already have a response
141 $c->forward( 'MyApp::View::TT' ); # render template
144 ### in MyApp/Controller/Foo.pm
145 # called for /foo/bar
146 sub bar : Local { ... }
148 # called for /blargle
149 sub blargle : Global { ... }
151 # an index action matches /foo, but not /foo/1, etc.
152 sub index : Private { ... }
154 ### in MyApp/Controller/Foo/Bar.pm
155 # called for /foo/bar/baz
156 sub baz : Local { ... }
158 # first Root auto is called, then Foo auto, then this
159 sub auto : Private { ... }
161 # powerful regular expression paths are also possible
162 sub details : Regex('^product/(\w+)/details$') {
163 my ( $self, $c ) = @_;
164 # extract the (\w+) from the URI
165 my $product = $c->req->captures->[0];
168 See L<Catalyst::Manual::Intro> for additional information.
172 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>
174 See L<Catalyst::Manual> for more documentation.
176 Catalyst plugins can be loaded by naming them as arguments to the "use
177 Catalyst" statement. Omit the C<Catalyst::Plugin::> prefix from the
178 plugin name, i.e., C<Catalyst::Plugin::My::Module> becomes
181 use Catalyst qw/My::Module/;
183 If your plugin starts with a name other than C<Catalyst::Plugin::>, you can
184 fully qualify the name by using a unary plus:
188 +Fully::Qualified::Plugin::Name
191 Special flags like C<-Debug> and C<-Engine> can also be specified as
192 arguments when Catalyst is loaded:
194 use Catalyst qw/-Debug My::Module/;
196 The position of plugins and flags in the chain is important, because
197 they are loaded in exactly the order in which they appear.
199 The following flags are supported:
203 Enables debug output. You can also force this setting from the system
204 environment with CATALYST_DEBUG or <MYAPP>_DEBUG. The environment settings
205 override the app, with <MYAPP>_DEBUG having highest priority.
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 croak('stash takes a hash or hashref') unless ref $stash;
323 foreach my $key ( keys %$stash ) {
324 $c->{stash}->{$key} = $stash->{$key};
332 =head2 $c->error($error, ...)
334 =head2 $c->error($arrayref)
336 Returns an arrayref containing error messages. If Catalyst encounters an
337 error while processing a request, it stores the error in $c->error. This
338 method should not be used to store non-fatal error messages.
340 my @error = @{ $c->error };
344 $c->error('Something bad happened');
351 my $error = ref $_[0] eq 'ARRAY' ? $_[0] : [@_];
352 croak @$error unless ref $c;
353 push @{ $c->{error} }, @$error;
355 elsif ( defined $_[0] ) { $c->{error} = undef }
356 return $c->{error} || [];
362 Contains the return value of the last executed action.
364 =head2 $c->clear_errors
366 Clear errors. You probably don't want to clear the errors unless you are
367 implementing a custom error screen.
369 This is equivalent to running
385 my ( $c, @names ) = @_;
387 foreach my $name (@names) {
388 foreach my $component ( keys %{ $c->components } ) {
389 return $c->components->{$component} if $component =~ /$name/i;
396 # try explicit component names
398 my ( $c, @names ) = @_;
400 foreach my $try (@names) {
401 return $c->components->{$try} if ( exists $c->components->{$try} );
407 # like component, but try just these prefixes before regex searching,
408 # and do not try to return "sort keys %{ $c->components }"
410 my ( $c, $name, @prefixes ) = @_;
412 my $appclass = ref $c || $c;
414 my @names = map { "${appclass}::${_}::${name}" } @prefixes;
416 my $comp = $c->_comp_explicit(@names);
417 return $comp if defined($comp);
418 $comp = $c->_comp_search($name);
422 # Find possible names for a prefix
425 my ( $c, @prefixes ) = @_;
427 my $appclass = ref $c || $c;
429 my @pre = map { "${appclass}::${_}::" } @prefixes;
433 COMPONENT: foreach my $comp ($c->component) {
434 foreach my $p (@pre) {
435 if ($comp =~ s/^$p//) {
445 # Return a component if only one matches.
447 my ( $c, @prefixes ) = @_;
449 my $appclass = ref $c || $c;
451 my ( $comp, $rest ) =
452 map { $c->_comp_search("^${appclass}::${_}::") } @prefixes;
453 return $comp unless $rest;
456 # Filter a component before returning by calling ACCEPT_CONTEXT if available
457 sub _filter_component {
458 my ( $c, $comp, @args ) = @_;
459 if ( eval { $comp->can('ACCEPT_CONTEXT'); } ) {
460 return $comp->ACCEPT_CONTEXT( $c, @args );
462 else { return $comp }
465 =head2 COMPONENT ACCESSORS
467 =head2 $c->controller($name)
469 Gets a L<Catalyst::Controller> instance by name.
471 $c->controller('Foo')->do_stuff;
473 If name is omitted, will return the controller for the dispatched action.
478 my ( $c, $name, @args ) = @_;
479 return $c->_filter_component( $c->_comp_prefixes( $name, qw/Controller C/ ),
482 return $c->component( $c->action->class );
485 =head2 $c->model($name)
487 Gets a L<Catalyst::Model> instance by name.
489 $c->model('Foo')->do_stuff;
491 If the name is omitted, it will look for a config setting 'default_model',
492 or check if there is only one view, and return it if that's the case.
497 my ( $c, $name, @args ) = @_;
498 return $c->_filter_component( $c->_comp_prefixes( $name, qw/Model M/ ),
501 return $c->component( $c->config->{default_model} )
502 if $c->config->{default_model};
503 return $c->_filter_component( $c->_comp_singular(qw/Model M/), @args );
507 =head2 $c->controllers
509 Returns the available names which can be passed to $c->controller
515 return $c->_comp_names(qw/Controller C/);
519 =head2 $c->view($name)
521 Gets a L<Catalyst::View> instance by name.
523 $c->view('Foo')->do_stuff;
525 If the name is omitted, it will look for a config setting 'default_view',
526 or check if there is only one view, and forward to it if that's the case.
531 my ( $c, $name, @args ) = @_;
532 return $c->_filter_component( $c->_comp_prefixes( $name, qw/View V/ ),
535 return $c->component( $c->config->{default_view} )
536 if $c->config->{default_view};
537 return $c->_filter_component( $c->_comp_singular(qw/View V/) );
542 Returns the available names which can be passed to $c->model
548 return $c->_comp_names(qw/Model M/);
554 Returns the available names which can be passed to $c->view
560 return $c->_comp_names(qw/View V/);
563 =head2 $c->comp($name)
565 =head2 $c->component($name)
567 Gets a component object by name. This method is no longer recommended,
568 unless you want to get a specific component by full
569 class. C<$c-E<gt>controller>, C<$c-E<gt>model>, and C<$c-E<gt>view>
570 should be used instead.
581 my $appclass = ref $c || $c;
584 $name, "${appclass}::${name}",
585 map { "${appclass}::${_}::${name}" }
586 qw/Model M Controller C View V/
589 my $comp = $c->_comp_explicit(@names);
590 return $c->_filter_component( $comp, @_ ) if defined($comp);
592 $comp = $c->_comp_search($name);
593 return $c->_filter_component( $comp, @_ ) if defined($comp);
596 return sort keys %{ $c->components };
601 =head2 CLASS DATA AND HELPER CLASSES
605 Returns or takes a hashref containing the application's configuration.
607 __PACKAGE__->config( { db => 'dsn:SQLite:foo.db' } );
609 You can also use a L<YAML> config file like myapp.yml in your
610 applications home directory.
613 db: dsn:SQLite:foo.db
621 $c->log->warn("Setting config after setup has been run is not a good idea.")
622 if ( @_ and $c->setup_finished );
624 $c->NEXT::config(@_);
629 Returns the logging object instance. Unless it is already set, Catalyst sets
630 this up with a L<Catalyst::Log> object. To use your own log class, set the
631 logger with the C<< __PACKAGE__->log >> method prior to calling
632 C<< __PACKAGE__->setup >>.
634 __PACKAGE__->log( MyLogger->new );
639 $c->log->info( 'Now logging with my own logger!' );
641 Your log class should implement the methods described in the
642 L<Catalyst::Log> man page.
647 Overload to enable debug messages (same as -Debug option).
649 Note that this is a static method, not an accessor and should be overloaded
650 by declaring "sub debug { 1 }" in your MyApp.pm, not by calling $c->debug(1).
656 =head2 $c->dispatcher
658 Returns the dispatcher instance. Stringifies to class name. See
659 L<Catalyst::Dispatcher>.
663 Returns the engine instance. Stringifies to the class name. See
667 =head2 UTILITY METHODS
669 =head2 $c->path_to(@path)
671 Merges C<@path> with C<$c-E<gt>config-E<gt>{home}> and returns a
672 L<Path::Class> object.
676 $c->path_to( 'db', 'sqlite.db' );
681 my ( $c, @path ) = @_;
682 my $path = Path::Class::Dir->new( $c->config->{home}, @path );
683 if ( -d $path ) { return $path }
684 else { return Path::Class::File->new( $c->config->{home}, @path ) }
687 =head2 $c->plugin( $name, $class, @args )
689 Helper method for plugins. It creates a classdata accessor/mutator and
690 loads and instantiates the given class.
692 MyApp->plugin( 'prototype', 'HTML::Prototype' );
694 $c->prototype->define_javascript_functions;
699 my ( $class, $name, $plugin, @args ) = @_;
700 $class->_register_plugin( $plugin, 1 );
702 eval { $plugin->import };
703 $class->mk_classdata($name);
705 eval { $obj = $plugin->new(@args) };
708 Catalyst::Exception->throw( message =>
709 qq/Couldn't instantiate instant plugin "$plugin", "$@"/ );
713 $class->log->debug(qq/Initialized instant plugin "$plugin" as "$name"/)
719 Initializes the dispatcher and engine, loads any plugins, and loads the
720 model, view, and controller components. You may also specify an array
721 of plugins to load here, if you choose to not load them in the C<use
725 MyApp->setup( qw/-Debug/ );
730 my ( $class, @arguments ) = @_;
732 $class->log->warn("Running setup twice is not a good idea.")
733 if ( $class->setup_finished );
735 unless ( $class->isa('Catalyst') ) {
737 Catalyst::Exception->throw(
738 message => qq/'$class' does not inherit from Catalyst/ );
741 if ( $class->arguments ) {
742 @arguments = ( @arguments, @{ $class->arguments } );
748 foreach (@arguments) {
752 ( $flags->{log} ) ? 'debug,' . $flags->{log} : 'debug';
754 elsif (/^-(\w+)=?(.*)$/) {
755 $flags->{ lc $1 } = $2;
758 push @{ $flags->{plugins} }, $_;
762 $class->setup_home( delete $flags->{home} );
764 $class->setup_log( delete $flags->{log} );
765 $class->setup_plugins( delete $flags->{plugins} );
766 $class->setup_dispatcher( delete $flags->{dispatcher} );
767 $class->setup_engine( delete $flags->{engine} );
769 for my $flag ( sort keys %{$flags} ) {
771 if ( my $code = $class->can( 'setup_' . $flag ) ) {
772 &$code( $class, delete $flags->{$flag} );
775 $class->log->warn(qq/Unknown flag "$flag"/);
779 eval { require Catalyst::Devel; };
780 if( !$@ && $ENV{CATALYST_SCRIPT_GEN} && ( $ENV{CATALYST_SCRIPT_GEN} < $Catalyst::Devel::CATALYST_SCRIPT_GEN ) ) {
781 $class->log->warn(<<"EOF");
782 You are running an old script!
784 Please update by running (this will overwrite existing files):
785 catalyst.pl -force -scripts $class
787 or (this will not overwrite existing files):
788 catalyst.pl -scripts $class
792 if ( $class->debug ) {
799 map { $_ . ' ' . ( $_->VERSION || '' ) }
800 grep { /^Catalyst::Plugin/ } @{"$class\::ISA"};
804 my $t = Text::SimpleTable->new(74);
805 $t->row($_) for @plugins;
806 $class->log->debug( "Loaded plugins:\n" . $t->draw );
809 my $dispatcher = $class->dispatcher;
810 my $engine = $class->engine;
811 my $home = $class->config->{home};
813 $class->log->debug(qq/Loaded dispatcher "$dispatcher"/);
814 $class->log->debug(qq/Loaded engine "$engine"/);
818 ? $class->log->debug(qq/Found home "$home"/)
819 : $class->log->debug(qq/Home "$home" doesn't exist/)
820 : $class->log->debug(q/Couldn't find home/);
825 no warnings qw/redefine/;
826 local *setup = sub { };
830 # Initialize our data structure
831 $class->components( {} );
833 $class->setup_components;
835 if ( $class->debug ) {
836 my $t = Text::SimpleTable->new( [ 63, 'Class' ], [ 8, 'Type' ] );
837 for my $comp ( sort keys %{ $class->components } ) {
838 my $type = ref $class->components->{$comp} ? 'instance' : 'class';
839 $t->row( $comp, $type );
841 $class->log->debug( "Loaded components:\n" . $t->draw )
842 if ( keys %{ $class->components } );
845 # Add our self to components, since we are also a component
846 $class->components->{$class} = $class;
848 $class->setup_actions;
850 if ( $class->debug ) {
851 my $name = $class->config->{name} || 'Application';
852 $class->log->info("$name powered by Catalyst $Catalyst::VERSION");
854 $class->log->_flush() if $class->log->can('_flush');
856 $class->setup_finished(1);
859 =head2 $c->uri_for( $path, @args?, \%query_values? )
861 Merges path with C<$c-E<gt>request-E<gt>base> for absolute uri's and
862 with C<$c-E<gt>namespace> for relative uri's, then returns a
863 normalized L<URI> object. If any args are passed, they are added at the
864 end of the path. If the last argument to uri_for is a hash reference,
865 it is assumed to contain GET parameter key/value pairs, which will be
866 appended to the URI in standard fashion.
871 my ( $c, $path, @args ) = @_;
872 my $base = $c->request->base->clone;
873 my $basepath = $base->path;
874 $basepath =~ s/\/$//;
876 my $namespace = $c->namespace || '';
878 # massage namespace, empty if absolute path
879 $namespace =~ s/^\/// if $namespace;
880 $namespace .= '/' if $namespace;
882 $namespace = '' if $path =~ /^\//;
886 ( scalar @args && ref $args[$#args] eq 'HASH' ? pop @args : {} );
888 for my $value ( values %$params ) {
\r
889 my $isa_ref = ref $value;
\r
890 if( $isa_ref and $isa_ref ne 'ARRAY' ) {
\r
891 croak( "Non-array reference ($isa_ref) passed to uri_for()" );
\r
893 utf8::encode( $_ ) for grep { defined } $isa_ref ? @$value : $value;
\r
896 # join args with '/', or a blank string
897 my $args = ( scalar @args ? '/' . join( '/', @args ) : '' );
898 $args =~ s/^\/// unless $path;
900 URI->new_abs( URI->new_abs( "$path$args", "$basepath$namespace" ), $base )
902 $res->query_form(%$params);
906 =head2 $c->welcome_message
908 Returns the Catalyst welcome HTML page.
912 sub welcome_message {
914 my $name = $c->config->{name};
915 my $logo = $c->uri_for('/static/images/catalyst_logo.png');
916 my $prefix = Catalyst::Utils::appprefix( ref $c );
917 $c->response->content_type('text/html; charset=utf-8');
919 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
920 "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
921 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
923 <meta http-equiv="Content-Language" content="en" />
924 <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
925 <title>$name on Catalyst $VERSION</title>
926 <style type="text/css">
929 background-color: #eee;
938 background-color: #ccc;
939 border: 1px solid #aaa;
944 font-family: verdana, tahoma, sans-serif;
947 font-family: verdana, tahoma, sans-serif;
950 text-decoration: none;
952 border-bottom: 1px dotted #bbb;
954 :link:hover, :visited:hover {
967 background-color: #fff;
968 border: 1px solid #aaa;
994 <h1><span id="appname">$name</span> on <a href="http://catalyst.perl.org">Catalyst</a>
999 <img src="$logo" alt="Catalyst Logo" />
1001 <p>Welcome to the wonderful world of Catalyst.
1002 This <a href="http://en.wikipedia.org/wiki/MVC">MVC</a>
1003 framework will make web development something you had
1004 never expected it to be: Fun, rewarding, and quick.</p>
1005 <h2>What to do now?</h2>
1006 <p>That really depends on what <b>you</b> want to do.
1007 We do, however, provide you with a few starting points.</p>
1008 <p>If you want to jump right into web development with Catalyst
1009 you might want to check out the documentation.</p>
1010 <pre><code>perldoc <a href="http://cpansearch.perl.org/dist/Catalyst/lib/Catalyst/Manual/Intro.pod">Catalyst::Manual::Intro</a>
1011 perldoc <a href="http://cpansearch.perl.org/dist/Catalyst/lib/Catalyst/Manual/Tutorial.pod">Catalyst::Manual::Tutorial</a></code>
1012 perldoc <a href="http://cpansearch.perl.org/dist/Catalyst/lib/Catalyst/Manual.pod">Catalyst::Manual</a></code></pre>
1013 <h2>What to do next?</h2>
1014 <p>Next it's time to write an actual application. Use the
1015 helper scripts to generate <a href="http://cpansearch.perl.org/search?query=Catalyst%3A%3AController%3A%3A&mode=all">controllers</a>,
1016 <a href="http://cpansearch.perl.org/search?query=Catalyst%3A%3AModel%3A%3A&mode=all">models</a>, and
1017 <a href="http://cpansearch.perl.org/search?query=Catalyst%3A%3AView%3A%3A&mode=all">views</a>;
1018 they can save you a lot of work.</p>
1019 <pre><code>script/${prefix}_create.pl -help</code></pre>
1020 <p>Also, be sure to check out the vast and growing
1021 collection of <a href="http://cpansearch.perl.org/search?query=Catalyst%3A%3APlugin%3A%3A&mode=all">plugins for Catalyst on CPAN</a>;
1022 you are likely to find what you need there.
1026 <p>Catalyst has a very active community. Here are the main places to
1027 get in touch with us.</p>
1030 <a href="http://dev.catalyst.perl.org">Wiki</a>
1033 <a href="http://lists.rawmode.org/mailman/listinfo/catalyst">Mailing-List</a>
1036 <a href="irc://irc.perl.org/catalyst">IRC channel #catalyst on irc.perl.org</a>
1039 <h2>In conclusion</h2>
1040 <p>The Catalyst team hopes you will enjoy using Catalyst as much
1041 as we enjoyed making it. Please contact us if you have ideas
1042 for improvement or other feedback.</p>
1050 =head1 INTERNAL METHODS
1052 These methods are not meant to be used by end users.
1054 =head2 $c->components
1056 Returns a hash of components.
1058 =head2 $c->context_class
1060 Returns or sets the context class.
1064 Returns a hashref containing coderefs and execution counts (needed for
1065 deep recursion detection).
1069 Returns the number of actions on the current internal execution stack.
1073 Dispatches a request to actions.
1077 sub dispatch { my $c = shift; $c->dispatcher->dispatch( $c, @_ ) }
1079 =head2 $c->dispatcher_class
1081 Returns or sets the dispatcher class.
1083 =head2 $c->dump_these
1085 Returns a list of 2-element array references (name, structure) pairs
1086 that will be dumped on the error page in debug mode.
1092 [ Request => $c->req ],
1093 [ Response => $c->res ],
1094 [ Stash => $c->stash ],
1095 [ Config => $c->config ];
1098 =head2 $c->engine_class
1100 Returns or sets the engine class.
1102 =head2 $c->execute( $class, $coderef )
1104 Execute a coderef in given class and catch exceptions. Errors are available
1110 my ( $c, $class, $code ) = @_;
1111 $class = $c->component($class) || $class;
1114 if ( $c->depth >= $RECURSION ) {
1115 my $action = "$code";
1116 $action = "/$action" unless $action =~ /\-\>/;
1117 my $error = qq/Deep recursion detected calling "$action"/;
1118 $c->log->error($error);
1124 my $stats_info = $c->_stats_start_execute( $code );
1126 push( @{ $c->stack }, $code );
1128 eval { $c->state( &$code( $class, $c, @{ $c->req->args } ) || 0 ) };
1130 $c->_stats_finish_execute( $stats_info );
1132 my $last = ${ $c->stack }[-1];
1133 pop( @{ $c->stack } );
1135 if ( my $error = $@ ) {
1136 if ( $error eq $DETACH ) { die $DETACH if $c->depth > 1 }
1138 unless ( ref $error ) {
1140 my $class = $last->class;
1141 my $name = $last->name;
1142 $error = qq/Caught exception in $class->$name "$error"/;
1151 sub _stats_start_execute {
1152 my ( $c, $code ) = @_;
1154 return unless $c->debug;
1156 my $action = "$code";
1158 $action = "/$action" unless $action =~ /\-\>/;
1159 $c->counter->{"$code"}++;
1161 # determine if the call was the result of a forward
1162 # this is done by walking up the call stack and looking for a calling
1163 # sub of Catalyst::forward before the eval
1165 for my $index ( 2 .. 11 ) {
1167 if ( ( caller($index) )[0] eq 'Catalyst'
1168 && ( caller($index) )[3] eq '(eval)' );
1170 if ( ( caller($index) )[3] =~ /forward$/ ) {
1171 $callsub = ( caller($index) )[3];
1172 $action = "-> $action";
1177 my $node = Tree::Simple->new(
1180 elapsed => undef, # to be filled in later
1184 $node->setUID( "$code" . $c->counter->{"$code"} );
1186 unless ( ( $code->name =~ /^_.*/ )
1187 && ( !$c->config->{show_internal_actions} ) )
1189 # is this a root-level call or a forwarded call?
1190 if ( $callsub =~ /forward$/ ) {
1192 # forward, locate the caller
1193 if ( my $parent = $c->stack->[-1] ) {
1194 my $visitor = Tree::Simple::Visitor::FindByUID->new;
1195 $visitor->searchForUID(
1196 "$parent" . $c->counter->{"$parent"} );
1197 $c->stats->accept($visitor);
1198 if ( my $result = $visitor->getResult ) {
1199 $result->addChild($node);
1204 # forward with no caller may come from a plugin
1205 $c->stats->addChild($node);
1211 $c->stats->addChild($node);
1215 my $start = [gettimeofday];
1216 my $elapsed = tv_interval($start);
1220 elapsed => $elapsed,
1226 sub _stats_finish_execute {
1227 my ( $c, $info ) = @_;
1229 return unless $c->debug;
1231 my ( $code, $start, $elapsed ) = @{ $info }{qw/code start elapsed/};
1233 unless ( ( $code->name =~ /^_.*/ )
1234 && ( !$c->config->{show_internal_actions} ) )
1237 # FindByUID uses an internal die, so we save the existing error
1240 # locate the node in the tree and update the elapsed time
1241 my $visitor = Tree::Simple::Visitor::FindByUID->new;
1242 $visitor->searchForUID( "$code" . $c->counter->{"$code"} );
1243 $c->stats->accept($visitor);
1244 if ( my $result = $visitor->getResult ) {
1245 my $value = $result->getNodeValue;
1246 $value->{elapsed} = sprintf( '%fs', $elapsed );
1247 $result->setNodeValue($value);
1251 $@ = $error || undef;
1255 =head2 $c->_localize_fields( sub { }, \%keys );
1259 sub _localize_fields {
1260 my ( $c, $localized, $code ) = ( @_ );
1262 my $request = delete $localized->{request} || {};
1263 my $response = delete $localized->{response} || {};
1265 local @{ $c }{ keys %$localized } = values %$localized;
1266 local @{ $c->request }{ keys %$request } = values %$request;
1267 local @{ $c->response }{ keys %$response } = values %$response;
1274 Finalizes the request.
1281 for my $error ( @{ $c->error } ) {
1282 $c->log->error($error);
1285 # Allow engine to handle finalize flow (for POE)
1286 if ( $c->engine->can('finalize') ) {
1287 $c->engine->finalize($c);
1291 $c->finalize_uploads;
1294 if ( $#{ $c->error } >= 0 ) {
1298 $c->finalize_headers;
1301 if ( $c->request->method eq 'HEAD' ) {
1302 $c->response->body('');
1308 return $c->response->status;
1311 =head2 $c->finalize_body
1317 sub finalize_body { my $c = shift; $c->engine->finalize_body( $c, @_ ) }
1319 =head2 $c->finalize_cookies
1325 sub finalize_cookies { my $c = shift; $c->engine->finalize_cookies( $c, @_ ) }
1327 =head2 $c->finalize_error
1333 sub finalize_error { my $c = shift; $c->engine->finalize_error( $c, @_ ) }
1335 =head2 $c->finalize_headers
1341 sub finalize_headers {
1344 # Check if we already finalized headers
1345 return if $c->response->{_finalized_headers};
1348 if ( my $location = $c->response->redirect ) {
1349 $c->log->debug(qq/Redirecting to "$location"/) if $c->debug;
1350 $c->response->header( Location => $location );
1354 if ( $c->response->body && !$c->response->content_length ) {
1356 # get the length from a filehandle
1357 if ( blessed( $c->response->body ) && $c->response->body->can('read') )
1359 if ( my $stat = stat $c->response->body ) {
1360 $c->response->content_length( $stat->size );
1363 $c->log->warn('Serving filehandle without a content-length');
1367 $c->response->content_length( bytes::length( $c->response->body ) );
1372 if ( $c->response->status =~ /^(1\d\d|[23]04)$/ ) {
1373 $c->response->headers->remove_header("Content-Length");
1374 $c->response->body('');
1377 $c->finalize_cookies;
1379 $c->engine->finalize_headers( $c, @_ );
1382 $c->response->{_finalized_headers} = 1;
1385 =head2 $c->finalize_output
1387 An alias for finalize_body.
1389 =head2 $c->finalize_read
1391 Finalizes the input after reading is complete.
1395 sub finalize_read { my $c = shift; $c->engine->finalize_read( $c, @_ ) }
1397 =head2 $c->finalize_uploads
1399 Finalizes uploads. Cleans up any temporary files.
1403 sub finalize_uploads { my $c = shift; $c->engine->finalize_uploads( $c, @_ ) }
1405 =head2 $c->get_action( $action, $namespace )
1407 Gets an action in a given namespace.
1411 sub get_action { my $c = shift; $c->dispatcher->get_action(@_) }
1413 =head2 $c->get_actions( $action, $namespace )
1415 Gets all actions of a given name in a namespace and all parent
1420 sub get_actions { my $c = shift; $c->dispatcher->get_actions( $c, @_ ) }
1422 =head2 $c->handle_request( $class, @arguments )
1424 Called to handle each HTTP request.
1428 sub handle_request {
1429 my ( $class, @arguments ) = @_;
1431 # Always expect worst case!
1434 my $stats = ( $class->debug ) ? Tree::Simple->new: q{};
1437 my $c = $class->prepare(@arguments);
1440 return $c->finalize;
1443 if ( $class->debug ) {
1444 my $start = [gettimeofday];
1445 $status = &$handler;
1446 my $elapsed = tv_interval $start;
1447 $elapsed = sprintf '%f', $elapsed;
1448 my $av = sprintf '%.3f',
1449 ( $elapsed == 0 ? '??' : ( 1 / $elapsed ) );
1450 my $t = Text::SimpleTable->new( [ 62, 'Action' ], [ 9, 'Time' ] );
1455 my $stat = $action->getNodeValue;
1456 $t->row( ( q{ } x $action->getDepth ) . $stat->{action} . $stat->{comment},
1457 $stat->{elapsed} || '??' );
1462 "Request took ${elapsed}s ($av/s)\n" . $t->draw );
1464 else { $status = &$handler }
1468 if ( my $error = $@ ) {
1470 $class->log->error(qq/Caught exception in engine "$error"/);
1474 $class->log->_flush() if $class->log->can('_flush');
1478 =head2 $c->prepare( @arguments )
1480 Creates a Catalyst context from an engine-specific request (Apache, CGI,
1486 my ( $class, @arguments ) = @_;
1488 $class->context_class( ref $class || $class ) unless $class->context_class;
1489 my $c = $class->context_class->new(
1493 request => $class->request_class->new(
1496 body_parameters => {},
1498 headers => HTTP::Headers->new,
1500 query_parameters => {},
1506 response => $class->response_class->new(
1510 headers => HTTP::Headers->new(),
1519 # For on-demand data
1520 $c->request->{_context} = $c;
1521 $c->response->{_context} = $c;
1522 weaken( $c->request->{_context} );
1523 weaken( $c->response->{_context} );
1526 my $secs = time - $START || 1;
1527 my $av = sprintf '%.3f', $COUNT / $secs;
1528 my $time = localtime time;
1529 $c->log->info("*** Request $COUNT ($av/s) [$$] [$time] ***");
1530 $c->res->headers->header( 'X-Catalyst' => $Catalyst::VERSION );
1533 # Allow engine to direct the prepare flow (for POE)
1534 if ( $c->engine->can('prepare') ) {
1535 $c->engine->prepare( $c, @arguments );
1538 $c->prepare_request(@arguments);
1539 $c->prepare_connection;
1540 $c->prepare_query_parameters;
1541 $c->prepare_headers;
1542 $c->prepare_cookies;
1546 $c->prepare_body unless $c->config->{parse_on_demand};
1549 my $method = $c->req->method || '';
1550 my $path = $c->req->path || '/';
1551 my $address = $c->req->address || '';
1553 $c->log->debug(qq/"$method" request for "$path" from "$address"/)
1561 =head2 $c->prepare_action
1563 Prepares action. See L<Catalyst::Dispatcher>.
1567 sub prepare_action { my $c = shift; $c->dispatcher->prepare_action( $c, @_ ) }
1569 =head2 $c->prepare_body
1571 Prepares message body.
1578 # Do we run for the first time?
1579 return if defined $c->request->{_body};
1581 # Initialize on-demand data
1582 $c->engine->prepare_body( $c, @_ );
1583 $c->prepare_parameters;
1584 $c->prepare_uploads;
1586 if ( $c->debug && keys %{ $c->req->body_parameters } ) {
1587 my $t = Text::SimpleTable->new( [ 35, 'Parameter' ], [ 36, 'Value' ] );
1588 for my $key ( sort keys %{ $c->req->body_parameters } ) {
1589 my $param = $c->req->body_parameters->{$key};
1590 my $value = defined($param) ? $param : '';
1592 ref $value eq 'ARRAY' ? ( join ', ', @$value ) : $value );
1594 $c->log->debug( "Body Parameters are:\n" . $t->draw );
1598 =head2 $c->prepare_body_chunk( $chunk )
1600 Prepares a chunk of data before sending it to L<HTTP::Body>.
1602 See L<Catalyst::Engine>.
1606 sub prepare_body_chunk {
1608 $c->engine->prepare_body_chunk( $c, @_ );
1611 =head2 $c->prepare_body_parameters
1613 Prepares body parameters.
1617 sub prepare_body_parameters {
1619 $c->engine->prepare_body_parameters( $c, @_ );
1622 =head2 $c->prepare_connection
1624 Prepares connection.
1628 sub prepare_connection {
1630 $c->engine->prepare_connection( $c, @_ );
1633 =head2 $c->prepare_cookies
1639 sub prepare_cookies { my $c = shift; $c->engine->prepare_cookies( $c, @_ ) }
1641 =head2 $c->prepare_headers
1647 sub prepare_headers { my $c = shift; $c->engine->prepare_headers( $c, @_ ) }
1649 =head2 $c->prepare_parameters
1651 Prepares parameters.
1655 sub prepare_parameters {
1657 $c->prepare_body_parameters;
1658 $c->engine->prepare_parameters( $c, @_ );
1661 =head2 $c->prepare_path
1663 Prepares path and base.
1667 sub prepare_path { my $c = shift; $c->engine->prepare_path( $c, @_ ) }
1669 =head2 $c->prepare_query_parameters
1671 Prepares query parameters.
1675 sub prepare_query_parameters {
1678 $c->engine->prepare_query_parameters( $c, @_ );
1680 if ( $c->debug && keys %{ $c->request->query_parameters } ) {
1681 my $t = Text::SimpleTable->new( [ 35, 'Parameter' ], [ 36, 'Value' ] );
1682 for my $key ( sort keys %{ $c->req->query_parameters } ) {
1683 my $param = $c->req->query_parameters->{$key};
1684 my $value = defined($param) ? $param : '';
1686 ref $value eq 'ARRAY' ? ( join ', ', @$value ) : $value );
1688 $c->log->debug( "Query Parameters are:\n" . $t->draw );
1692 =head2 $c->prepare_read
1694 Prepares the input for reading.
1698 sub prepare_read { my $c = shift; $c->engine->prepare_read( $c, @_ ) }
1700 =head2 $c->prepare_request
1702 Prepares the engine request.
1706 sub prepare_request { my $c = shift; $c->engine->prepare_request( $c, @_ ) }
1708 =head2 $c->prepare_uploads
1714 sub prepare_uploads {
1717 $c->engine->prepare_uploads( $c, @_ );
1719 if ( $c->debug && keys %{ $c->request->uploads } ) {
1720 my $t = Text::SimpleTable->new(
1721 [ 12, 'Parameter' ],
1726 for my $key ( sort keys %{ $c->request->uploads } ) {
1727 my $upload = $c->request->uploads->{$key};
1728 for my $u ( ref $upload eq 'ARRAY' ? @{$upload} : ($upload) ) {
1729 $t->row( $key, $u->filename, $u->type, $u->size );
1732 $c->log->debug( "File Uploads are:\n" . $t->draw );
1736 =head2 $c->prepare_write
1738 Prepares the output for writing.
1742 sub prepare_write { my $c = shift; $c->engine->prepare_write( $c, @_ ) }
1744 =head2 $c->request_class
1746 Returns or sets the request class.
1748 =head2 $c->response_class
1750 Returns or sets the response class.
1752 =head2 $c->read( [$maxlength] )
1754 Reads a chunk of data from the request body. This method is designed to
1755 be used in a while loop, reading C<$maxlength> bytes on every call.
1756 C<$maxlength> defaults to the size of the request if not specified.
1758 You have to set C<MyApp-E<gt>config-E<gt>{parse_on_demand}> to use this
1763 sub read { my $c = shift; return $c->engine->read( $c, @_ ) }
1771 sub run { my $c = shift; return $c->engine->run( $c, @_ ) }
1773 =head2 $c->set_action( $action, $code, $namespace, $attrs )
1775 Sets an action in a given namespace.
1779 sub set_action { my $c = shift; $c->dispatcher->set_action( $c, @_ ) }
1781 =head2 $c->setup_actions($component)
1783 Sets up actions for a component.
1787 sub setup_actions { my $c = shift; $c->dispatcher->setup_actions( $c, @_ ) }
1789 =head2 $c->setup_components
1795 sub setup_components {
1798 my $callback = sub {
1799 my ( $component, $context ) = @_;
1801 unless ( $component->can('COMPONENT') ) {
1805 my $suffix = Catalyst::Utils::class2classsuffix($component);
1806 my $config = $class->config->{$suffix} || {};
1810 eval { $instance = $component->COMPONENT( $context, $config ); };
1812 if ( my $error = $@ ) {
1816 Catalyst::Exception->throw( message =>
1817 qq/Couldn't instantiate component "$component", "$error"/ );
1820 Catalyst::Exception->throw( message =>
1821 qq/Couldn't instantiate component "$component", "COMPONENT() didn't return a object"/
1823 unless ref $instance;
1827 eval "package $class;\n" . q!Module::Pluggable::Fast->import(
1828 name => '_catalyst_components',
1830 "$class\::Controller", "$class\::C",
1831 "$class\::Model", "$class\::M",
1832 "$class\::View", "$class\::V"
1834 callback => $callback
1838 if ( my $error = $@ ) {
1842 Catalyst::Exception->throw(
1843 message => qq/Couldn't load components "$error"/ );
1846 for my $component ( $class->_catalyst_components($class) ) {
1847 $class->components->{ ref $component || $component } = $component;
1851 =head2 $c->setup_dispatcher
1857 sub setup_dispatcher {
1858 my ( $class, $dispatcher ) = @_;
1861 $dispatcher = 'Catalyst::Dispatcher::' . $dispatcher;
1864 if ( $ENV{CATALYST_DISPATCHER} ) {
1865 $dispatcher = 'Catalyst::Dispatcher::' . $ENV{CATALYST_DISPATCHER};
1868 if ( $ENV{ uc($class) . '_DISPATCHER' } ) {
1870 'Catalyst::Dispatcher::' . $ENV{ uc($class) . '_DISPATCHER' };
1873 unless ($dispatcher) {
1874 $dispatcher = $class->dispatcher_class;
1877 unless (Class::Inspector->loaded($dispatcher)) {
1878 require Class::Inspector->filename($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;
1969 unless (Class::Inspector->loaded($engine)) {
1970 require Class::Inspector->filename($engine);
1973 # check for old engines that are no longer compatible
1975 if ( $engine->isa('Catalyst::Engine::Apache')
1976 && !Catalyst::Engine::Apache->VERSION )
1981 elsif ( $engine->isa('Catalyst::Engine::Server::Base')
1982 && Catalyst::Engine::Server->VERSION le '0.02' )
1987 elsif ($engine->isa('Catalyst::Engine::HTTP::POE')
1988 && $engine->VERSION eq '0.01' )
1993 elsif ($engine->isa('Catalyst::Engine::Zeus')
1994 && $engine->VERSION eq '0.01' )
2000 Catalyst::Exception->throw( message =>
2001 qq/Engine "$engine" is not supported by this version of Catalyst/
2006 $class->engine( $engine->new );
2009 =head2 $c->setup_home
2011 Sets up the home directory.
2016 my ( $class, $home ) = @_;
2018 if ( $ENV{CATALYST_HOME} ) {
2019 $home = $ENV{CATALYST_HOME};
2022 if ( $ENV{ uc($class) . '_HOME' } ) {
2023 $home = $ENV{ uc($class) . '_HOME' };
2027 $home = Catalyst::Utils::home($class);
2031 $class->config->{home} ||= $home;
2032 $class->config->{root} ||= Path::Class::Dir->new($home)->subdir('root');
2036 =head2 $c->setup_log
2043 my ( $class, $debug ) = @_;
2045 unless ( $class->log ) {
2046 $class->log( Catalyst::Log->new );
2049 my $app_flag = Catalyst::Utils::class2env($class) . '_DEBUG';
2052 ( defined( $ENV{CATALYST_DEBUG} ) || defined( $ENV{$app_flag} ) )
2053 ? ( $ENV{CATALYST_DEBUG} || $ENV{$app_flag} )
2058 *{"$class\::debug"} = sub { 1 };
2059 $class->log->debug('Debug messages enabled');
2063 =head2 $c->setup_plugins
2069 =head2 $c->registered_plugins
2071 Returns a sorted list of the plugins which have either been stated in the
2072 import list or which have been added via C<< MyApp->plugin(@args); >>.
2074 If passed a given plugin name, it will report a boolean value indicating
2075 whether or not that plugin is loaded. A fully qualified name is required if
2076 the plugin name does not begin with C<Catalyst::Plugin::>.
2078 if ($c->registered_plugins('Some::Plugin')) {
2086 sub registered_plugins {
2088 return sort keys %{ $proto->_plugins } unless @_;
2090 return 1 if exists $proto->_plugins->{$plugin};
2091 return exists $proto->_plugins->{"Catalyst::Plugin::$plugin"};
2094 sub _register_plugin {
2095 my ( $proto, $plugin, $instant ) = @_;
2096 my $class = ref $proto || $proto;
2098 unless (Class::Inspector->loaded($plugin)) {
2099 require Class::Inspector->filename($plugin);
2102 $proto->_plugins->{$plugin} = 1;
2105 unshift @{"$class\::ISA"}, $plugin;
2111 my ( $class, $plugins ) = @_;
2113 $class->_plugins( {} ) unless $class->_plugins;
2115 for my $plugin ( reverse @$plugins ) {
2117 unless ( $plugin =~ s/\A\+// ) {
2118 $plugin = "Catalyst::Plugin::$plugin";
2121 $class->_register_plugin($plugin);
2128 Returns an arrayref of the internal execution stack (actions that are currently
2131 =head2 $c->write( $data )
2133 Writes $data to the output stream. When using this method directly, you
2134 will need to manually set the C<Content-Length> header to the length of
2135 your output data, if known.
2142 # Finalize headers if someone manually writes output
2143 $c->finalize_headers;
2145 return $c->engine->write( $c, @_ );
2150 Returns the Catalyst version number. Mostly useful for "powered by"
2151 messages in template systems.
2155 sub version { return $Catalyst::VERSION }
2157 =head1 INTERNAL ACTIONS
2159 Catalyst uses internal actions like C<_DISPATCH>, C<_BEGIN>, C<_AUTO>,
2160 C<_ACTION>, and C<_END>. These are by default not shown in the private
2161 action table, but you can make them visible with a config parameter.
2163 MyApp->config->{show_internal_actions} = 1;
2165 =head1 CASE SENSITIVITY
2167 By default Catalyst is not case sensitive, so C<MyApp::C::FOO::Bar> is
2168 mapped to C</foo/bar>. You can activate case sensitivity with a config
2171 MyApp->config->{case_sensitive} = 1;
2173 This causes C<MyApp::C::Foo::Bar> to map to C</Foo/Bar>.
2175 =head1 ON-DEMAND PARSER
2177 The request body is usually parsed at the beginning of a request,
2178 but if you want to handle input yourself or speed things up a bit,
2179 you can enable on-demand parsing with a config parameter.
2181 MyApp->config->{parse_on_demand} = 1;
2183 =head1 PROXY SUPPORT
2185 Many production servers operate using the common double-server approach,
2186 with a lightweight frontend web server passing requests to a larger
2187 backend server. An application running on the backend server must deal
2188 with two problems: the remote user always appears to be C<127.0.0.1> and
2189 the server's hostname will appear to be C<localhost> regardless of the
2190 virtual host that the user connected through.
2192 Catalyst will automatically detect this situation when you are running
2193 the frontend and backend servers on the same machine. The following
2194 changes are made to the request.
2196 $c->req->address is set to the user's real IP address, as read from
2197 the HTTP X-Forwarded-For header.
2199 The host value for $c->req->base and $c->req->uri is set to the real
2200 host, as read from the HTTP X-Forwarded-Host header.
2202 Obviously, your web server must support these headers for this to work.
2204 In a more complex server farm environment where you may have your
2205 frontend proxy server(s) on different machines, you will need to set a
2206 configuration option to tell Catalyst to read the proxied data from the
2209 MyApp->config->{using_frontend_proxy} = 1;
2211 If you do not wish to use the proxy support at all, you may set:
2213 MyApp->config->{ignore_frontend_proxy} = 1;
2215 =head1 THREAD SAFETY
2217 Catalyst has been tested under Apache 2's threading mpm_worker, mpm_winnt,
2218 and the standalone forking HTTP server on Windows. We believe the Catalyst
2219 core to be thread-safe.
2221 If you plan to operate in a threaded environment, remember that all other
2222 modules you are using must also be thread-safe. Some modules, most notably
2223 L<DBD::SQLite>, are not thread-safe.
2229 Join #catalyst on irc.perl.org.
2233 http://lists.rawmode.org/mailman/listinfo/catalyst
2234 http://lists.rawmode.org/mailman/listinfo/catalyst-dev
2238 http://catalyst.perl.org
2242 http://dev.catalyst.perl.org
2246 =head2 L<Task::Catalyst> - All you need to start with Catalyst
2248 =head2 L<Catalyst::Manual> - The Catalyst Manual
2250 =head2 L<Catalyst::Component>, L<Catalyst::Base> - Base classes for components
2252 =head2 L<Catalyst::Engine> - Core engine
2254 =head2 L<Catalyst::Log> - Log class.
2256 =head2 L<Catalyst::Request> - Request object
2258 =head2 L<Catalyst::Response> - Response object
2260 =head2 L<Catalyst::Test> - The test suite.
2332 Sebastian Riedel, C<sri@oook.de>
2336 This library is free software, you can redistribute it and/or modify it under
2337 the same terms as Perl itself.