4 use base 'Catalyst::Component';
6 use Catalyst::Exception;
9 use Catalyst::Request::Upload;
10 use Catalyst::Response;
12 use Catalyst::Controller;
13 use Devel::InnerPackage ();
15 use Module::Pluggable::Object ();
17 use Text::SimpleTable ();
18 use Path::Class::Dir ();
19 use Path::Class::File ();
20 use Time::HiRes qw/gettimeofday tv_interval/;
22 use Scalar::Util qw/weaken blessed/;
23 use Tree::Simple qw/use_weak_refs/;
24 use Tree::Simple::Visitor::FindByUID;
29 BEGIN { require 5.008001; }
31 __PACKAGE__->mk_accessors(
32 qw/counter request response state action stack namespace stats/
35 attributes->import( __PACKAGE__, \&namespace, 'lvalue' );
37 sub depth { scalar @{ shift->stack || [] }; }
44 # For backwards compatibility
45 *finalize_output = \&finalize_body;
50 our $RECURSION = 1000;
51 our $DETACH = "catalyst_detach\n";
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 # Remember to update this in Catalyst::Runtime as well!
64 our $VERSION = '5.7002';
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 # Install Catalyst::Devel for helpers and other development tools
91 # use the helper to create a new application
94 # add models, views, controllers
95 script/myapp_create.pl model Database DBIC::SchemaLoader dbi:SQLite:/path/to/db
96 script/myapp_create.pl view TT TT
97 script/myapp_create.pl controller Search
99 # built in testserver -- use -r to restart automatically on changes
100 script/myapp_server.pl
102 # command line testing interface
103 script/myapp_test.pl /yada
106 use Catalyst qw/-Debug/; # include plugins here as well
108 ### In lib/MyApp/Controller/Root.pm (autocreated)
109 sub foo : Global { # called for /foo, /foo/1, /foo/1/2, etc.
110 my ( $self, $c, @args ) = @_; # args are qw/1 2/ for /foo/1/2
111 $c->stash->{template} = 'foo.tt'; # set the template
112 # lookup something from db -- stash vars are passed to TT
114 $c->model('Database::Foo')->search( { country => $args[0] } );
115 if ( $c->req->params->{bar} ) { # access GET or POST parameters
116 $c->forward( 'bar' ); # process another action
117 # do something else after forward returns
121 # The foo.tt TT template can use the stash data from the database
122 [% WHILE (item = data.next) %]
126 # called for /bar/of/soap, /bar/of/soap/10, etc.
127 sub bar : Path('/bar/of/soap') { ... }
129 # called for all actions, from the top-most controller downwards
131 my ( $self, $c ) = @_;
132 if ( !$c->user_exists ) { # Catalyst::Plugin::Authentication
133 $c->res->redirect( '/login' ); # require login
134 return 0; # abort request and go immediately to end()
136 return 1; # success; carry on to next action
139 # called after all actions are finished
141 my ( $self, $c ) = @_;
142 if ( scalar @{ $c->error } ) { ... } # handle errors
143 return if $c->res->body; # already have a response
144 $c->forward( 'MyApp::View::TT' ); # render template
147 ### in MyApp/Controller/Foo.pm
148 # called for /foo/bar
149 sub bar : Local { ... }
151 # called for /blargle
152 sub blargle : Global { ... }
154 # an index action matches /foo, but not /foo/1, etc.
155 sub index : Private { ... }
157 ### in MyApp/Controller/Foo/Bar.pm
158 # called for /foo/bar/baz
159 sub baz : Local { ... }
161 # first Root auto is called, then Foo auto, then this
162 sub auto : Private { ... }
164 # powerful regular expression paths are also possible
165 sub details : Regex('^product/(\w+)/details$') {
166 my ( $self, $c ) = @_;
167 # extract the (\w+) from the URI
168 my $product = $c->req->captures->[0];
171 See L<Catalyst::Manual::Intro> for additional information.
175 Catalyst is a modern framework for making web applications without the
176 pain usually associated with this process. This document is a reference
177 to the main Catalyst application. If you are a new user, we suggest you
178 start with L<Catalyst::Manual::Tutorial> or L<Catalyst::Manual::Intro>.
180 See L<Catalyst::Manual> for more documentation.
182 Catalyst plugins can be loaded by naming them as arguments to the "use
183 Catalyst" statement. Omit the C<Catalyst::Plugin::> prefix from the
184 plugin name, i.e., C<Catalyst::Plugin::My::Module> becomes
187 use Catalyst qw/My::Module/;
189 If your plugin starts with a name other than C<Catalyst::Plugin::>, you can
190 fully qualify the name by using a unary plus:
194 +Fully::Qualified::Plugin::Name
197 Special flags like C<-Debug> and C<-Engine> can also be specified as
198 arguments when Catalyst is loaded:
200 use Catalyst qw/-Debug My::Module/;
202 The position of plugins and flags in the chain is important, because
203 they are loaded in the order in which they appear.
205 The following flags are supported:
209 Enables debug output. You can also force this setting from the system
210 environment with CATALYST_DEBUG or <MYAPP>_DEBUG. The environment
211 settings override the application, with <MYAPP>_DEBUG having the highest
216 Forces Catalyst to use a specific engine. Omit the
217 C<Catalyst::Engine::> prefix of the engine name, i.e.:
219 use Catalyst qw/-Engine=CGI/;
223 Forces Catalyst to use a specific home directory, e.g.:
225 use Catalyst qw[-Home=/usr/mst];
233 =head2 INFORMATION ABOUT THE CURRENT REQUEST
237 Returns a L<Catalyst::Action> object for the current action, which
238 stringifies to the action name. See L<Catalyst::Action>.
242 Returns the namespace of the current action, i.e., the URI prefix
243 corresponding to the controller of the current action. For example:
245 # in Controller::Foo::Bar
246 $c->namespace; # returns 'foo/bar';
252 Returns the current L<Catalyst::Request> object, giving access to
253 information about the current client request (including parameters,
254 cookies, HTTP headers, etc.). See L<Catalyst::Request>.
256 =head2 REQUEST FLOW HANDLING
258 =head2 $c->forward( $action [, \@arguments ] )
260 =head2 $c->forward( $class, $method, [, \@arguments ] )
262 Forwards processing to another action, by its private name. If you give a
263 class name but no method, C<process()> is called. You may also optionally
264 pass arguments in an arrayref. The action will receive the arguments in
265 C<@_> and C<$c-E<gt>req-E<gt>args>. Upon returning from the function,
266 C<$c-E<gt>req-E<gt>args> will be restored to the previous values.
268 Any data C<return>ed from the action forwarded to, will be returned by the
271 my $foodata = $c->forward('/foo');
272 $c->forward('index');
273 $c->forward(qw/MyApp::Model::DBIC::Foo do_stuff/);
274 $c->forward('MyApp::View::TT');
276 Note that forward implies an C<<eval { }>> around the call (actually
277 C<execute> does), thus de-fatalizing all 'dies' within the called
278 action. If you want C<die> to propagate you need to do something like:
281 die $c->error if $c->error;
283 Or make sure to always return true values from your actions and write
286 $c->forward('foo') || return;
290 sub forward { my $c = shift; $c->dispatcher->forward( $c, @_ ) }
292 =head2 $c->detach( $action [, \@arguments ] )
294 =head2 $c->detach( $class, $method, [, \@arguments ] )
298 The same as C<forward>, but doesn't return to the previous action when
299 processing is finished.
301 When called with no arguments it escapes the processing chain entirely.
305 sub detach { my $c = shift; $c->dispatcher->detach( $c, @_ ) }
311 Returns the current L<Catalyst::Response> object, q.v.
315 Returns a hashref to the stash, which may be used to store data and pass
316 it between components during a request. You can also set hash keys by
317 passing arguments. The stash is automatically sent to the view. The
318 stash is cleared at the end of a request; it cannot be used for
319 persistent storage (for this you must use a session; see
320 L<Catalyst::Plugin::Session> for a complete system integrated with
323 $c->stash->{foo} = $bar;
324 $c->stash( { moose => 'majestic', qux => 0 } );
325 $c->stash( bar => 1, gorch => 2 ); # equivalent to passing a hashref
327 # stash is automatically passed to the view for use in a template
328 $c->forward( 'MyApp::V::TT' );
335 my $stash = @_ > 1 ? {@_} : $_[0];
336 croak('stash takes a hash or hashref') unless ref $stash;
337 foreach my $key ( keys %$stash ) {
338 $c->{stash}->{$key} = $stash->{$key};
346 =head2 $c->error($error, ...)
348 =head2 $c->error($arrayref)
350 Returns an arrayref containing error messages. If Catalyst encounters an
351 error while processing a request, it stores the error in $c->error. This
352 method should not be used to store non-fatal error messages.
354 my @error = @{ $c->error };
358 $c->error('Something bad happened');
365 my $error = ref $_[0] eq 'ARRAY' ? $_[0] : [@_];
366 croak @$error unless ref $c;
367 push @{ $c->{error} }, @$error;
369 elsif ( defined $_[0] ) { $c->{error} = undef }
370 return $c->{error} || [];
376 Contains the return value of the last executed action.
378 =head2 $c->clear_errors
380 Clear errors. You probably don't want to clear the errors unless you are
381 implementing a custom error screen.
383 This is equivalent to running
397 my ( $c, @names ) = @_;
399 foreach my $name (@names) {
400 foreach my $component ( keys %{ $c->components } ) {
401 return $c->components->{$component} if $component =~ /$name/i;
408 # try explicit component names
410 my ( $c, @names ) = @_;
412 foreach my $try (@names) {
413 return $c->components->{$try} if ( exists $c->components->{$try} );
419 # like component, but try just these prefixes before regex searching,
420 # and do not try to return "sort keys %{ $c->components }"
422 my ( $c, $name, @prefixes ) = @_;
424 my $appclass = ref $c || $c;
426 my @names = map { "${appclass}::${_}::${name}" } @prefixes;
428 my $comp = $c->_comp_explicit(@names);
429 return $comp if defined($comp);
430 $comp = $c->_comp_search($name);
434 # Find possible names for a prefix
437 my ( $c, @prefixes ) = @_;
439 my $appclass = ref $c || $c;
441 my @pre = map { "${appclass}::${_}::" } @prefixes;
445 COMPONENT: foreach my $comp ($c->component) {
446 foreach my $p (@pre) {
447 if ($comp =~ s/^$p//) {
457 # Return a component if only one matches.
459 my ( $c, @prefixes ) = @_;
461 my $appclass = ref $c || $c;
463 my ( $comp, $rest ) =
464 map { $c->_comp_search("^${appclass}::${_}::") } @prefixes;
465 return $comp unless $rest;
468 # Filter a component before returning by calling ACCEPT_CONTEXT if available
469 sub _filter_component {
470 my ( $c, $comp, @args ) = @_;
471 if ( eval { $comp->can('ACCEPT_CONTEXT'); } ) {
472 return $comp->ACCEPT_CONTEXT( $c, @args );
474 else { return $comp }
477 =head2 COMPONENT ACCESSORS
479 =head2 $c->controller($name)
481 Gets a L<Catalyst::Controller> instance by name.
483 $c->controller('Foo')->do_stuff;
485 If the name is omitted, will return the controller for the dispatched
491 my ( $c, $name, @args ) = @_;
492 return $c->_filter_component( $c->_comp_prefixes( $name, qw/Controller C/ ),
495 return $c->component( $c->action->class );
498 =head2 $c->model($name)
500 Gets a L<Catalyst::Model> instance by name.
502 $c->model('Foo')->do_stuff;
504 If the name is omitted, it will look for a config setting 'default_model',
505 or check if there is only one view, and return it if that's the case.
510 my ( $c, $name, @args ) = @_;
511 return $c->_filter_component( $c->_comp_prefixes( $name, qw/Model M/ ),
514 return $c->component( $c->config->{default_model} )
515 if $c->config->{default_model};
516 return $c->_filter_component( $c->_comp_singular(qw/Model M/), @args );
520 =head2 $c->controllers
522 Returns the available names which can be passed to $c->controller
528 return $c->_comp_names(qw/Controller C/);
532 =head2 $c->view($name)
534 Gets a L<Catalyst::View> instance by name.
536 $c->view('Foo')->do_stuff;
538 If the name is omitted, it will look for a config setting
539 'default_view', or check if there is only one view, and forward to it if
545 my ( $c, $name, @args ) = @_;
546 return $c->_filter_component( $c->_comp_prefixes( $name, qw/View V/ ),
549 return $c->component( $c->config->{default_view} )
550 if $c->config->{default_view};
551 return $c->_filter_component( $c->_comp_singular(qw/View V/) );
556 Returns the available names which can be passed to $c->model
562 return $c->_comp_names(qw/Model M/);
568 Returns the available names which can be passed to $c->view
574 return $c->_comp_names(qw/View V/);
577 =head2 $c->comp($name)
579 =head2 $c->component($name)
581 Gets a component object by name. This method is no longer recommended,
582 unless you want to get a specific component by full
583 class. C<$c-E<gt>controller>, C<$c-E<gt>model>, and C<$c-E<gt>view>
584 should be used instead.
595 my $appclass = ref $c || $c;
598 $name, "${appclass}::${name}",
599 map { "${appclass}::${_}::${name}" }
600 qw/Model M Controller C View V/
603 my $comp = $c->_comp_explicit(@names);
604 return $c->_filter_component( $comp, @_ ) if defined($comp);
606 $comp = $c->_comp_search($name);
607 return $c->_filter_component( $comp, @_ ) if defined($comp);
610 return sort keys %{ $c->components };
615 =head2 CLASS DATA AND HELPER CLASSES
619 Returns or takes a hashref containing the application's configuration.
621 __PACKAGE__->config( { db => 'dsn:SQLite:foo.db' } );
623 You can also use a L<YAML> config file like myapp.yml in your
624 applications home directory.
627 db: dsn:SQLite:foo.db
635 $c->log->warn("Setting config after setup has been run is not a good idea.")
636 if ( @_ and $c->setup_finished );
638 $c->NEXT::config(@_);
643 Returns the logging object instance. Unless it is already set, Catalyst
644 sets this up with a L<Catalyst::Log> object. To use your own log class,
645 set the logger with the C<< __PACKAGE__->log >> method prior to calling
646 C<< __PACKAGE__->setup >>.
648 __PACKAGE__->log( MyLogger->new );
653 $c->log->info( 'Now logging with my own logger!' );
655 Your log class should implement the methods described in
661 Overload to enable debug messages (same as -Debug option).
663 Note that this is a static method, not an accessor and should be overloaded
664 by declaring "sub debug { 1 }" in your MyApp.pm, not by calling $c->debug(1).
670 =head2 $c->dispatcher
672 Returns the dispatcher instance. Stringifies to class name. See
673 L<Catalyst::Dispatcher>.
677 Returns the engine instance. Stringifies to the class name. See
681 =head2 UTILITY METHODS
683 =head2 $c->path_to(@path)
685 Merges C<@path> with C<$c-E<gt>config-E<gt>{home}> and returns a
686 L<Path::Class> object.
690 $c->path_to( 'db', 'sqlite.db' );
695 my ( $c, @path ) = @_;
696 my $path = Path::Class::Dir->new( $c->config->{home}, @path );
697 if ( -d $path ) { return $path }
698 else { return Path::Class::File->new( $c->config->{home}, @path ) }
701 =head2 $c->plugin( $name, $class, @args )
703 Helper method for plugins. It creates a classdata accessor/mutator and
704 loads and instantiates the given class.
706 MyApp->plugin( 'prototype', 'HTML::Prototype' );
708 $c->prototype->define_javascript_functions;
713 my ( $class, $name, $plugin, @args ) = @_;
714 $class->_register_plugin( $plugin, 1 );
716 eval { $plugin->import };
717 $class->mk_classdata($name);
719 eval { $obj = $plugin->new(@args) };
722 Catalyst::Exception->throw( message =>
723 qq/Couldn't instantiate instant plugin "$plugin", "$@"/ );
727 $class->log->debug(qq/Initialized instant plugin "$plugin" as "$name"/)
733 Initializes the dispatcher and engine, loads any plugins, and loads the
734 model, view, and controller components. You may also specify an array
735 of plugins to load here, if you choose to not load them in the C<use
739 MyApp->setup( qw/-Debug/ );
744 my ( $class, @arguments ) = @_;
746 $class->log->warn("Running setup twice is not a good idea.")
747 if ( $class->setup_finished );
749 unless ( $class->isa('Catalyst') ) {
751 Catalyst::Exception->throw(
752 message => qq/'$class' does not inherit from Catalyst/ );
755 if ( $class->arguments ) {
756 @arguments = ( @arguments, @{ $class->arguments } );
762 foreach (@arguments) {
766 ( $flags->{log} ) ? 'debug,' . $flags->{log} : 'debug';
768 elsif (/^-(\w+)=?(.*)$/) {
769 $flags->{ lc $1 } = $2;
772 push @{ $flags->{plugins} }, $_;
776 $class->setup_home( delete $flags->{home} );
778 $class->setup_log( delete $flags->{log} );
779 $class->setup_plugins( delete $flags->{plugins} );
780 $class->setup_dispatcher( delete $flags->{dispatcher} );
781 $class->setup_engine( delete $flags->{engine} );
783 for my $flag ( sort keys %{$flags} ) {
785 if ( my $code = $class->can( 'setup_' . $flag ) ) {
786 &$code( $class, delete $flags->{$flag} );
789 $class->log->warn(qq/Unknown flag "$flag"/);
793 eval { require Catalyst::Devel; };
794 if( !$@ && $ENV{CATALYST_SCRIPT_GEN} && ( $ENV{CATALYST_SCRIPT_GEN} < $Catalyst::Devel::CATALYST_SCRIPT_GEN ) ) {
795 $class->log->warn(<<"EOF");
796 You are running an old script!
798 Please update by running (this will overwrite existing files):
799 catalyst.pl -force -scripts $class
801 or (this will not overwrite existing files):
802 catalyst.pl -scripts $class
806 if ( $class->debug ) {
807 my @plugins = map { "$_ " . ( $_->VERSION || '' ) } $class->registered_plugins;
810 my $t = Text::SimpleTable->new(74);
811 $t->row($_) for @plugins;
812 $class->log->debug( "Loaded plugins:\n" . $t->draw );
815 my $dispatcher = $class->dispatcher;
816 my $engine = $class->engine;
817 my $home = $class->config->{home};
819 $class->log->debug(qq/Loaded dispatcher "$dispatcher"/);
820 $class->log->debug(qq/Loaded engine "$engine"/);
824 ? $class->log->debug(qq/Found home "$home"/)
825 : $class->log->debug(qq/Home "$home" doesn't exist/)
826 : $class->log->debug(q/Couldn't find home/);
831 no warnings qw/redefine/;
832 local *setup = sub { };
836 # Initialize our data structure
837 $class->components( {} );
839 $class->setup_components;
841 if ( $class->debug ) {
842 my $t = Text::SimpleTable->new( [ 63, 'Class' ], [ 8, 'Type' ] );
843 for my $comp ( sort keys %{ $class->components } ) {
844 my $type = ref $class->components->{$comp} ? 'instance' : 'class';
845 $t->row( $comp, $type );
847 $class->log->debug( "Loaded components:\n" . $t->draw )
848 if ( keys %{ $class->components } );
851 # Add our self to components, since we are also a component
852 $class->components->{$class} = $class;
854 $class->setup_actions;
856 if ( $class->debug ) {
857 my $name = $class->config->{name} || 'Application';
858 $class->log->info("$name powered by Catalyst $Catalyst::VERSION");
860 $class->log->_flush() if $class->log->can('_flush');
862 $class->setup_finished(1);
865 =head2 $c->uri_for( $path, @args?, \%query_values? )
867 Merges path with C<< $c->request->base >> for absolute URIs and with
868 C<< $c->namespace >> for relative URIs, then returns a normalized L<URI>
869 object. If any args are passed, they are added at the end of the path.
870 If the last argument to C<uri_for> is a hash reference, it is assumed to
871 contain GET parameter key/value pairs, which will be appended to the URI
874 Instead of C<$path>, you can also optionally pass a C<$action> object
875 which will be resolved to a path using
876 C<< $c->dispatcher->uri_for_action >>; if the first element of
877 C<@args> is an arrayref it is treated as a list of captures to be passed
878 to C<uri_for_action>.
883 my ( $c, $path, @args ) = @_;
884 my $base = $c->request->base->clone;
885 my $basepath = $base->path;
886 $basepath =~ s/\/$//;
888 my $namespace = $c->namespace || '';
890 if ( Scalar::Util::blessed($path) ) { # action object
891 my $captures = ( scalar @args && ref $args[0] eq 'ARRAY'
894 $path = $c->dispatcher->uri_for_action($path, $captures);
895 return undef unless defined($path);
896 $path = '/' if $path eq '';
899 # massage namespace, empty if absolute path
900 $namespace =~ s/^\/// if $namespace;
901 $namespace .= '/' if $namespace;
903 $namespace = '' if $path =~ /^\//;
907 ( scalar @args && ref $args[$#args] eq 'HASH' ? pop @args : {} );
909 for my $value ( values %$params ) {
910 for ( ref $value eq 'ARRAY' ? @$value : $value ) {
916 # join args with '/', or a blank string
917 my $args = ( scalar @args ? '/' . join( '/', @args ) : '' );
918 $args =~ s/^\/// unless $path;
920 URI->new_abs( URI->new_abs( "$path$args", "$basepath$namespace" ), $base )
922 $res->query_form(%$params);
926 =head2 $c->welcome_message
928 Returns the Catalyst welcome HTML page.
932 sub welcome_message {
934 my $name = $c->config->{name};
935 my $logo = $c->uri_for('/static/images/catalyst_logo.png');
936 my $prefix = Catalyst::Utils::appprefix( ref $c );
937 $c->response->content_type('text/html; charset=utf-8');
939 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
940 "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
941 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
943 <meta http-equiv="Content-Language" content="en" />
944 <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
945 <title>$name on Catalyst $VERSION</title>
946 <style type="text/css">
949 background-color: #eee;
958 background-color: #ccc;
959 border: 1px solid #aaa;
964 font-family: verdana, tahoma, sans-serif;
967 font-family: verdana, tahoma, sans-serif;
970 text-decoration: none;
972 border-bottom: 1px dotted #bbb;
974 :link:hover, :visited:hover {
987 background-color: #fff;
988 border: 1px solid #aaa;
1014 <h1><span id="appname">$name</span> on <a href="http://catalyst.perl.org">Catalyst</a>
1019 <img src="$logo" alt="Catalyst Logo" />
1021 <p>Welcome to the wonderful world of Catalyst.
1022 This <a href="http://en.wikipedia.org/wiki/MVC">MVC</a>
1023 framework will make web development something you had
1024 never expected it to be: Fun, rewarding, and quick.</p>
1025 <h2>What to do now?</h2>
1026 <p>That really depends on what <b>you</b> want to do.
1027 We do, however, provide you with a few starting points.</p>
1028 <p>If you want to jump right into web development with Catalyst
1029 you might want to check out the documentation.</p>
1030 <pre><code>perldoc <a href="http://cpansearch.perl.org/dist/Catalyst/lib/Catalyst/Manual/Intro.pod">Catalyst::Manual::Intro</a>
1031 perldoc <a href="http://cpansearch.perl.org/dist/Catalyst/lib/Catalyst/Manual/Tutorial.pod">Catalyst::Manual::Tutorial</a></code>
1032 perldoc <a href="http://cpansearch.perl.org/dist/Catalyst/lib/Catalyst/Manual.pod">Catalyst::Manual</a></code></pre>
1033 <h2>What to do next?</h2>
1034 <p>Next it's time to write an actual application. Use the
1035 helper scripts to generate <a href="http://cpansearch.perl.org/search?query=Catalyst%3A%3AController%3A%3A&mode=all">controllers</a>,
1036 <a href="http://cpansearch.perl.org/search?query=Catalyst%3A%3AModel%3A%3A&mode=all">models</a>, and
1037 <a href="http://cpansearch.perl.org/search?query=Catalyst%3A%3AView%3A%3A&mode=all">views</a>;
1038 they can save you a lot of work.</p>
1039 <pre><code>script/${prefix}_create.pl -help</code></pre>
1040 <p>Also, be sure to check out the vast and growing
1041 collection of <a href="http://cpansearch.perl.org/search?query=Catalyst%3A%3APlugin%3A%3A&mode=all">plugins for Catalyst on CPAN</a>;
1042 you are likely to find what you need there.
1046 <p>Catalyst has a very active community. Here are the main places to
1047 get in touch with us.</p>
1050 <a href="http://dev.catalyst.perl.org">Wiki</a>
1053 <a href="http://lists.rawmode.org/mailman/listinfo/catalyst">Mailing-List</a>
1056 <a href="irc://irc.perl.org/catalyst">IRC channel #catalyst on irc.perl.org</a>
1059 <h2>In conclusion</h2>
1060 <p>The Catalyst team hopes you will enjoy using Catalyst as much
1061 as we enjoyed making it. Please contact us if you have ideas
1062 for improvement or other feedback.</p>
1070 =head1 INTERNAL METHODS
1072 These methods are not meant to be used by end users.
1074 =head2 $c->components
1076 Returns a hash of components.
1078 =head2 $c->context_class
1080 Returns or sets the context class.
1084 Returns a hashref containing coderefs and execution counts (needed for
1085 deep recursion detection).
1089 Returns the number of actions on the current internal execution stack.
1093 Dispatches a request to actions.
1097 sub dispatch { my $c = shift; $c->dispatcher->dispatch( $c, @_ ) }
1099 =head2 $c->dispatcher_class
1101 Returns or sets the dispatcher class.
1103 =head2 $c->dump_these
1105 Returns a list of 2-element array references (name, structure) pairs
1106 that will be dumped on the error page in debug mode.
1112 [ Request => $c->req ],
1113 [ Response => $c->res ],
1114 [ Stash => $c->stash ],
1115 [ Config => $c->config ];
1118 =head2 $c->engine_class
1120 Returns or sets the engine class.
1122 =head2 $c->execute( $class, $coderef )
1124 Execute a coderef in given class and catch exceptions. Errors are available
1130 my ( $c, $class, $code ) = @_;
1131 $class = $c->component($class) || $class;
1134 if ( $c->depth >= $RECURSION ) {
1135 my $action = "$code";
1136 $action = "/$action" unless $action =~ /->/;
1137 my $error = qq/Deep recursion detected calling "$action"/;
1138 $c->log->error($error);
1144 my $stats_info = $c->_stats_start_execute( $code ) if $c->debug;
1146 push( @{ $c->stack }, $code );
1148 eval { $c->state( &$code( $class, $c, @{ $c->req->args } ) || 0 ) };
1150 $c->_stats_finish_execute( $stats_info ) if $c->debug and $stats_info;
1152 my $last = pop( @{ $c->stack } );
1154 if ( my $error = $@ ) {
1155 if ( !ref($error) and $error eq $DETACH ) { die $DETACH if $c->depth > 1 }
1157 unless ( ref $error ) {
1158 no warnings 'uninitialized';
1160 my $class = $last->class;
1161 my $name = $last->name;
1162 $error = qq/Caught exception in $class->$name "$error"/;
1171 sub _stats_start_execute {
1172 my ( $c, $code ) = @_;
1174 return if ( ( $code->name =~ /^_.*/ )
1175 && ( !$c->config->{show_internal_actions} ) );
1177 $c->counter->{"$code"}++;
1179 my $action = "$code";
1180 $action = "/$action" unless $action =~ /->/;
1182 # determine if the call was the result of a forward
1183 # this is done by walking up the call stack and looking for a calling
1184 # sub of Catalyst::forward before the eval
1186 for my $index ( 2 .. 11 ) {
1188 if ( ( caller($index) )[0] eq 'Catalyst'
1189 && ( caller($index) )[3] eq '(eval)' );
1191 if ( ( caller($index) )[3] =~ /forward$/ ) {
1192 $callsub = ( caller($index) )[3];
1193 $action = "-> $action";
1198 my $node = Tree::Simple->new(
1201 elapsed => undef, # to be filled in later
1205 $node->setUID( "$code" . $c->counter->{"$code"} );
1207 # is this a root-level call or a forwarded call?
1208 if ( $callsub =~ /forward$/ ) {
1210 # forward, locate the caller
1211 if ( my $parent = $c->stack->[-1] ) {
1212 my $visitor = Tree::Simple::Visitor::FindByUID->new;
1213 $visitor->searchForUID(
1214 "$parent" . $c->counter->{"$parent"} );
1215 $c->stats->accept($visitor);
1216 if ( my $result = $visitor->getResult ) {
1217 $result->addChild($node);
1222 # forward with no caller may come from a plugin
1223 $c->stats->addChild($node);
1229 $c->stats->addChild($node);
1233 start => [gettimeofday],
1238 sub _stats_finish_execute {
1239 my ( $c, $info ) = @_;
1240 my $elapsed = tv_interval $info->{start};
1241 my $value = $info->{node}->getNodeValue;
1242 $value->{elapsed} = sprintf( '%fs', $elapsed );
1245 =head2 $c->_localize_fields( sub { }, \%keys );
1249 sub _localize_fields {
1250 my ( $c, $localized, $code ) = ( @_ );
1252 my $request = delete $localized->{request} || {};
1253 my $response = delete $localized->{response} || {};
1255 local @{ $c }{ keys %$localized } = values %$localized;
1256 local @{ $c->request }{ keys %$request } = values %$request;
1257 local @{ $c->response }{ keys %$response } = values %$response;
1264 Finalizes the request.
1271 for my $error ( @{ $c->error } ) {
1272 $c->log->error($error);
1275 # Allow engine to handle finalize flow (for POE)
1276 if ( $c->engine->can('finalize') ) {
1277 $c->engine->finalize($c);
1281 $c->finalize_uploads;
1284 if ( $#{ $c->error } >= 0 ) {
1288 $c->finalize_headers;
1291 if ( $c->request->method eq 'HEAD' ) {
1292 $c->response->body('');
1298 return $c->response->status;
1301 =head2 $c->finalize_body
1307 sub finalize_body { my $c = shift; $c->engine->finalize_body( $c, @_ ) }
1309 =head2 $c->finalize_cookies
1315 sub finalize_cookies { my $c = shift; $c->engine->finalize_cookies( $c, @_ ) }
1317 =head2 $c->finalize_error
1323 sub finalize_error { my $c = shift; $c->engine->finalize_error( $c, @_ ) }
1325 =head2 $c->finalize_headers
1331 sub finalize_headers {
1334 # Check if we already finalized headers
1335 return if $c->response->{_finalized_headers};
1338 if ( my $location = $c->response->redirect ) {
1339 $c->log->debug(qq/Redirecting to "$location"/) if $c->debug;
1340 $c->response->header( Location => $location );
1344 if ( $c->response->body && !$c->response->content_length ) {
1346 # get the length from a filehandle
1347 if ( blessed( $c->response->body ) && $c->response->body->can('read') )
1349 if ( my $stat = stat $c->response->body ) {
1350 $c->response->content_length( $stat->size );
1353 $c->log->warn('Serving filehandle without a content-length');
1357 $c->response->content_length( bytes::length( $c->response->body ) );
1362 if ( $c->response->status =~ /^(1\d\d|[23]04)$/ ) {
1363 $c->response->headers->remove_header("Content-Length");
1364 $c->response->body('');
1367 $c->finalize_cookies;
1369 $c->engine->finalize_headers( $c, @_ );
1372 $c->response->{_finalized_headers} = 1;
1375 =head2 $c->finalize_output
1377 An alias for finalize_body.
1379 =head2 $c->finalize_read
1381 Finalizes the input after reading is complete.
1385 sub finalize_read { my $c = shift; $c->engine->finalize_read( $c, @_ ) }
1387 =head2 $c->finalize_uploads
1389 Finalizes uploads. Cleans up any temporary files.
1393 sub finalize_uploads { my $c = shift; $c->engine->finalize_uploads( $c, @_ ) }
1395 =head2 $c->get_action( $action, $namespace )
1397 Gets an action in a given namespace.
1401 sub get_action { my $c = shift; $c->dispatcher->get_action(@_) }
1403 =head2 $c->get_actions( $action, $namespace )
1405 Gets all actions of a given name in a namespace and all parent
1410 sub get_actions { my $c = shift; $c->dispatcher->get_actions( $c, @_ ) }
1412 =head2 $c->handle_request( $class, @arguments )
1414 Called to handle each HTTP request.
1418 sub handle_request {
1419 my ( $class, @arguments ) = @_;
1421 # Always expect worst case!
1424 if ($class->debug) {
1425 my $start = [gettimeofday];
1426 my $c = $class->prepare(@arguments);
1427 $c->stats(Tree::Simple->new);
1429 $status = $c->finalize;
1431 my $elapsed = tv_interval $start;
1432 $elapsed = sprintf '%f', $elapsed;
1433 my $av = sprintf '%.3f',
1434 ( $elapsed == 0 ? '??' : ( 1 / $elapsed ) );
1435 my $t = Text::SimpleTable->new( [ 62, 'Action' ], [ 9, 'Time' ] );
1437 $c->stats->traverse(
1440 my $stat = $action->getNodeValue;
1441 $t->row( ( q{ } x $action->getDepth ) . $stat->{action} . $stat->{comment},
1442 $stat->{elapsed} || '??' );
1447 "Request took ${elapsed}s ($av/s)\n" . $t->draw );
1450 my $c = $class->prepare(@arguments);
1452 $status = $c->finalize;
1456 if ( my $error = $@ ) {
1458 $class->log->error(qq/Caught exception in engine "$error"/);
1462 $class->log->_flush() if $class->log->can('_flush');
1466 =head2 $c->prepare( @arguments )
1468 Creates a Catalyst context from an engine-specific request (Apache, CGI,
1474 my ( $class, @arguments ) = @_;
1476 $class->context_class( ref $class || $class ) unless $class->context_class;
1477 my $c = $class->context_class->new(
1481 request => $class->request_class->new(
1484 body_parameters => {},
1486 headers => HTTP::Headers->new,
1488 query_parameters => {},
1494 response => $class->response_class->new(
1498 headers => HTTP::Headers->new(),
1507 # For on-demand data
1508 $c->request->{_context} = $c;
1509 $c->response->{_context} = $c;
1510 weaken( $c->request->{_context} );
1511 weaken( $c->response->{_context} );
1514 my $secs = time - $START || 1;
1515 my $av = sprintf '%.3f', $COUNT / $secs;
1516 my $time = localtime time;
1517 $c->log->info("*** Request $COUNT ($av/s) [$$] [$time] ***");
1518 $c->res->headers->header( 'X-Catalyst' => $Catalyst::VERSION );
1521 # Allow engine to direct the prepare flow (for POE)
1522 if ( $c->engine->can('prepare') ) {
1523 $c->engine->prepare( $c, @arguments );
1526 $c->prepare_request(@arguments);
1527 $c->prepare_connection;
1528 $c->prepare_query_parameters;
1529 $c->prepare_headers;
1530 $c->prepare_cookies;
1534 $c->prepare_body unless $c->config->{parse_on_demand};
1537 my $method = $c->req->method || '';
1538 my $path = $c->req->path || '/';
1539 my $address = $c->req->address || '';
1541 $c->log->debug(qq/"$method" request for "$path" from "$address"/)
1549 =head2 $c->prepare_action
1551 Prepares action. See L<Catalyst::Dispatcher>.
1555 sub prepare_action { my $c = shift; $c->dispatcher->prepare_action( $c, @_ ) }
1557 =head2 $c->prepare_body
1559 Prepares message body.
1566 # Do we run for the first time?
1567 return if defined $c->request->{_body};
1569 # Initialize on-demand data
1570 $c->engine->prepare_body( $c, @_ );
1571 $c->prepare_parameters;
1572 $c->prepare_uploads;
1574 if ( $c->debug && keys %{ $c->req->body_parameters } ) {
1575 my $t = Text::SimpleTable->new( [ 35, 'Parameter' ], [ 36, 'Value' ] );
1576 for my $key ( sort keys %{ $c->req->body_parameters } ) {
1577 my $param = $c->req->body_parameters->{$key};
1578 my $value = defined($param) ? $param : '';
1580 ref $value eq 'ARRAY' ? ( join ', ', @$value ) : $value );
1582 $c->log->debug( "Body Parameters are:\n" . $t->draw );
1586 =head2 $c->prepare_body_chunk( $chunk )
1588 Prepares a chunk of data before sending it to L<HTTP::Body>.
1590 See L<Catalyst::Engine>.
1594 sub prepare_body_chunk {
1596 $c->engine->prepare_body_chunk( $c, @_ );
1599 =head2 $c->prepare_body_parameters
1601 Prepares body parameters.
1605 sub prepare_body_parameters {
1607 $c->engine->prepare_body_parameters( $c, @_ );
1610 =head2 $c->prepare_connection
1612 Prepares connection.
1616 sub prepare_connection {
1618 $c->engine->prepare_connection( $c, @_ );
1621 =head2 $c->prepare_cookies
1627 sub prepare_cookies { my $c = shift; $c->engine->prepare_cookies( $c, @_ ) }
1629 =head2 $c->prepare_headers
1635 sub prepare_headers { my $c = shift; $c->engine->prepare_headers( $c, @_ ) }
1637 =head2 $c->prepare_parameters
1639 Prepares parameters.
1643 sub prepare_parameters {
1645 $c->prepare_body_parameters;
1646 $c->engine->prepare_parameters( $c, @_ );
1649 =head2 $c->prepare_path
1651 Prepares path and base.
1655 sub prepare_path { my $c = shift; $c->engine->prepare_path( $c, @_ ) }
1657 =head2 $c->prepare_query_parameters
1659 Prepares query parameters.
1663 sub prepare_query_parameters {
1666 $c->engine->prepare_query_parameters( $c, @_ );
1668 if ( $c->debug && keys %{ $c->request->query_parameters } ) {
1669 my $t = Text::SimpleTable->new( [ 35, 'Parameter' ], [ 36, 'Value' ] );
1670 for my $key ( sort keys %{ $c->req->query_parameters } ) {
1671 my $param = $c->req->query_parameters->{$key};
1672 my $value = defined($param) ? $param : '';
1674 ref $value eq 'ARRAY' ? ( join ', ', @$value ) : $value );
1676 $c->log->debug( "Query Parameters are:\n" . $t->draw );
1680 =head2 $c->prepare_read
1682 Prepares the input for reading.
1686 sub prepare_read { my $c = shift; $c->engine->prepare_read( $c, @_ ) }
1688 =head2 $c->prepare_request
1690 Prepares the engine request.
1694 sub prepare_request { my $c = shift; $c->engine->prepare_request( $c, @_ ) }
1696 =head2 $c->prepare_uploads
1702 sub prepare_uploads {
1705 $c->engine->prepare_uploads( $c, @_ );
1707 if ( $c->debug && keys %{ $c->request->uploads } ) {
1708 my $t = Text::SimpleTable->new(
1709 [ 12, 'Parameter' ],
1714 for my $key ( sort keys %{ $c->request->uploads } ) {
1715 my $upload = $c->request->uploads->{$key};
1716 for my $u ( ref $upload eq 'ARRAY' ? @{$upload} : ($upload) ) {
1717 $t->row( $key, $u->filename, $u->type, $u->size );
1720 $c->log->debug( "File Uploads are:\n" . $t->draw );
1724 =head2 $c->prepare_write
1726 Prepares the output for writing.
1730 sub prepare_write { my $c = shift; $c->engine->prepare_write( $c, @_ ) }
1732 =head2 $c->request_class
1734 Returns or sets the request class.
1736 =head2 $c->response_class
1738 Returns or sets the response class.
1740 =head2 $c->read( [$maxlength] )
1742 Reads a chunk of data from the request body. This method is designed to
1743 be used in a while loop, reading C<$maxlength> bytes on every call.
1744 C<$maxlength> defaults to the size of the request if not specified.
1746 You have to set C<MyApp-E<gt>config-E<gt>{parse_on_demand}> to use this
1751 sub read { my $c = shift; return $c->engine->read( $c, @_ ) }
1759 sub run { my $c = shift; return $c->engine->run( $c, @_ ) }
1761 =head2 $c->set_action( $action, $code, $namespace, $attrs )
1763 Sets an action in a given namespace.
1767 sub set_action { my $c = shift; $c->dispatcher->set_action( $c, @_ ) }
1769 =head2 $c->setup_actions($component)
1771 Sets up actions for a component.
1775 sub setup_actions { my $c = shift; $c->dispatcher->setup_actions( $c, @_ ) }
1777 =head2 $c->setup_components
1779 Sets up components. Specify a C<setup_components> config option to pass
1780 additional options directly to L<Module::Pluggable>. To add additional
1781 search paths, specify a key named C<search_extra> as an array
1782 reference. Items in the array beginning with C<::> will have the
1783 application class name prepended to them.
1787 sub setup_components {
1790 my @paths = qw( ::Controller ::C ::Model ::M ::View ::V );
1791 my $config = $class->config->{ setup_components };
1792 my $extra = delete $config->{ search_extra } || [];
1794 push @paths, @$extra;
1796 my $locator = Module::Pluggable::Object->new(
1797 search_path => [ map { s/^(?=::)/$class/; $_; } @paths ],
1801 for my $component ( sort { length $a <=> length $b } $locator->plugins ) {
1802 Catalyst::Utils::ensure_class_loaded( $component, { ignore_loaded => 1 } );
1804 my $module = $class->setup_component( $component );
1806 $component => $module,
1808 $_ => $class->setup_component( $_ )
1809 } Devel::InnerPackage::list_packages( $component )
1812 for my $key ( keys %modules ) {
1813 $class->components->{ $key } = $modules{ $key };
1818 =head2 $c->setup_component
1822 sub setup_component {
1823 my( $class, $component ) = @_;
1825 unless ( $component->can( 'COMPONENT' ) ) {
1829 my $suffix = Catalyst::Utils::class2classsuffix( $component );
1830 my $config = $class->config->{ $suffix } || {};
1832 my $instance = eval { $component->COMPONENT( $class, $config ); };
1834 if ( my $error = $@ ) {
1836 Catalyst::Exception->throw(
1837 message => qq/Couldn't instantiate component "$component", "$error"/
1841 Catalyst::Exception->throw(
1843 qq/Couldn't instantiate component "$component", "COMPONENT() didn't return an object-like value"/
1844 ) unless eval { $instance->can( 'can' ) };
1849 =head2 $c->setup_dispatcher
1855 sub setup_dispatcher {
1856 my ( $class, $dispatcher ) = @_;
1859 $dispatcher = 'Catalyst::Dispatcher::' . $dispatcher;
1862 if ( $ENV{CATALYST_DISPATCHER} ) {
1863 $dispatcher = 'Catalyst::Dispatcher::' . $ENV{CATALYST_DISPATCHER};
1866 if ( $ENV{ uc($class) . '_DISPATCHER' } ) {
1868 'Catalyst::Dispatcher::' . $ENV{ uc($class) . '_DISPATCHER' };
1871 unless ($dispatcher) {
1872 $dispatcher = $class->dispatcher_class;
1875 unless (Class::Inspector->loaded($dispatcher)) {
1876 require Class::Inspector->filename($dispatcher);
1879 # dispatcher instance
1880 $class->dispatcher( $dispatcher->new );
1883 =head2 $c->setup_engine
1890 my ( $class, $engine ) = @_;
1893 $engine = 'Catalyst::Engine::' . $engine;
1896 if ( $ENV{CATALYST_ENGINE} ) {
1897 $engine = 'Catalyst::Engine::' . $ENV{CATALYST_ENGINE};
1900 if ( $ENV{ uc($class) . '_ENGINE' } ) {
1901 $engine = 'Catalyst::Engine::' . $ENV{ uc($class) . '_ENGINE' };
1904 if ( $ENV{MOD_PERL} ) {
1906 # create the apache method
1909 *{"$class\::apache"} = sub { shift->engine->apache };
1912 my ( $software, $version ) =
1913 $ENV{MOD_PERL} =~ /^(\S+)\/(\d+(?:[\.\_]\d+)+)/;
1916 $version =~ s/(\.[^.]+)\./$1/g;
1918 if ( $software eq 'mod_perl' ) {
1922 if ( $version >= 1.99922 ) {
1923 $engine = 'Catalyst::Engine::Apache2::MP20';
1926 elsif ( $version >= 1.9901 ) {
1927 $engine = 'Catalyst::Engine::Apache2::MP19';
1930 elsif ( $version >= 1.24 ) {
1931 $engine = 'Catalyst::Engine::Apache::MP13';
1935 Catalyst::Exception->throw( message =>
1936 qq/Unsupported mod_perl version: $ENV{MOD_PERL}/ );
1941 # install the correct mod_perl handler
1942 if ( $version >= 1.9901 ) {
1943 *handler = sub : method {
1944 shift->handle_request(@_);
1948 *handler = sub ($$) { shift->handle_request(@_) };
1953 elsif ( $software eq 'Zeus-Perl' ) {
1954 $engine = 'Catalyst::Engine::Zeus';
1958 Catalyst::Exception->throw(
1959 message => qq/Unsupported mod_perl: $ENV{MOD_PERL}/ );
1964 $engine = $class->engine_class;
1967 unless (Class::Inspector->loaded($engine)) {
1968 require Class::Inspector->filename($engine);
1971 # check for old engines that are no longer compatible
1973 if ( $engine->isa('Catalyst::Engine::Apache')
1974 && !Catalyst::Engine::Apache->VERSION )
1979 elsif ( $engine->isa('Catalyst::Engine::Server::Base')
1980 && Catalyst::Engine::Server->VERSION le '0.02' )
1985 elsif ($engine->isa('Catalyst::Engine::HTTP::POE')
1986 && $engine->VERSION eq '0.01' )
1991 elsif ($engine->isa('Catalyst::Engine::Zeus')
1992 && $engine->VERSION eq '0.01' )
1998 Catalyst::Exception->throw( message =>
1999 qq/Engine "$engine" is not supported by this version of Catalyst/
2004 $class->engine( $engine->new );
2007 =head2 $c->setup_home
2009 Sets up the home directory.
2014 my ( $class, $home ) = @_;
2016 if ( $ENV{CATALYST_HOME} ) {
2017 $home = $ENV{CATALYST_HOME};
2020 if ( $ENV{ uc($class) . '_HOME' } ) {
2021 $home = $ENV{ uc($class) . '_HOME' };
2025 $home = Catalyst::Utils::home($class);
2029 $class->config->{home} ||= $home;
2030 $class->config->{root} ||= Path::Class::Dir->new($home)->subdir('root');
2034 =head2 $c->setup_log
2041 my ( $class, $debug ) = @_;
2043 unless ( $class->log ) {
2044 $class->log( Catalyst::Log->new );
2047 my $app_flag = Catalyst::Utils::class2env($class) . '_DEBUG';
2050 ( defined( $ENV{CATALYST_DEBUG} ) || defined( $ENV{$app_flag} ) )
2051 ? ( $ENV{CATALYST_DEBUG} || $ENV{$app_flag} )
2056 *{"$class\::debug"} = sub { 1 };
2057 $class->log->debug('Debug messages enabled');
2061 =head2 $c->setup_plugins
2067 =head2 $c->registered_plugins
2069 Returns a sorted list of the plugins which have either been stated in the
2070 import list or which have been added via C<< MyApp->plugin(@args); >>.
2072 If passed a given plugin name, it will report a boolean value indicating
2073 whether or not that plugin is loaded. A fully qualified name is required if
2074 the plugin name does not begin with C<Catalyst::Plugin::>.
2076 if ($c->registered_plugins('Some::Plugin')) {
2084 sub registered_plugins {
2086 return sort keys %{ $proto->_plugins } unless @_;
2088 return 1 if exists $proto->_plugins->{$plugin};
2089 return exists $proto->_plugins->{"Catalyst::Plugin::$plugin"};
2092 sub _register_plugin {
2093 my ( $proto, $plugin, $instant ) = @_;
2094 my $class = ref $proto || $proto;
2096 unless (Class::Inspector->loaded($plugin)) {
2097 require Class::Inspector->filename($plugin);
2100 $proto->_plugins->{$plugin} = 1;
2103 unshift @{"$class\::ISA"}, $plugin;
2109 my ( $class, $plugins ) = @_;
2111 $class->_plugins( {} ) unless $class->_plugins;
2113 for my $plugin ( reverse @$plugins ) {
2115 unless ( $plugin =~ s/\A\+// ) {
2116 $plugin = "Catalyst::Plugin::$plugin";
2119 $class->_register_plugin($plugin);
2126 Returns an arrayref of the internal execution stack (actions that are
2127 currently executing).
2129 =head2 $c->write( $data )
2131 Writes $data to the output stream. When using this method directly, you
2132 will need to manually set the C<Content-Length> header to the length of
2133 your output data, if known.
2140 # Finalize headers if someone manually writes output
2141 $c->finalize_headers;
2143 return $c->engine->write( $c, @_ );
2148 Returns the Catalyst version number. Mostly useful for "powered by"
2149 messages in template systems.
2153 sub version { return $Catalyst::VERSION }
2155 =head1 INTERNAL ACTIONS
2157 Catalyst uses internal actions like C<_DISPATCH>, C<_BEGIN>, C<_AUTO>,
2158 C<_ACTION>, and C<_END>. These are by default not shown in the private
2159 action table, but you can make them visible with a config parameter.
2161 MyApp->config->{show_internal_actions} = 1;
2163 =head1 CASE SENSITIVITY
2165 By default Catalyst is not case sensitive, so C<MyApp::C::FOO::Bar> is
2166 mapped to C</foo/bar>. You can activate case sensitivity with a config
2169 MyApp->config->{case_sensitive} = 1;
2171 This causes C<MyApp::C::Foo::Bar> to map to C</Foo/Bar>.
2173 =head1 ON-DEMAND PARSER
2175 The request body is usually parsed at the beginning of a request,
2176 but if you want to handle input yourself or speed things up a bit,
2177 you can enable on-demand parsing with a config parameter.
2179 MyApp->config->{parse_on_demand} = 1;
2181 =head1 PROXY SUPPORT
2183 Many production servers operate using the common double-server approach,
2184 with a lightweight frontend web server passing requests to a larger
2185 backend server. An application running on the backend server must deal
2186 with two problems: the remote user always appears to be C<127.0.0.1> and
2187 the server's hostname will appear to be C<localhost> regardless of the
2188 virtual host that the user connected through.
2190 Catalyst will automatically detect this situation when you are running
2191 the frontend and backend servers on the same machine. The following
2192 changes are made to the request.
2194 $c->req->address is set to the user's real IP address, as read from
2195 the HTTP X-Forwarded-For header.
2197 The host value for $c->req->base and $c->req->uri is set to the real
2198 host, as read from the HTTP X-Forwarded-Host header.
2200 Obviously, your web server must support these headers for this to work.
2202 In a more complex server farm environment where you may have your
2203 frontend proxy server(s) on different machines, you will need to set a
2204 configuration option to tell Catalyst to read the proxied data from the
2207 MyApp->config->{using_frontend_proxy} = 1;
2209 If you do not wish to use the proxy support at all, you may set:
2211 MyApp->config->{ignore_frontend_proxy} = 1;
2213 =head1 THREAD SAFETY
2215 Catalyst has been tested under Apache 2's threading C<mpm_worker>,
2216 C<mpm_winnt>, and the standalone forking HTTP server on Windows. We
2217 believe the Catalyst core to be thread-safe.
2219 If you plan to operate in a threaded environment, remember that all other
2220 modules you are using must also be thread-safe. Some modules, most notably
2221 L<DBD::SQLite>, are not thread-safe.
2227 Join #catalyst on irc.perl.org.
2231 http://lists.rawmode.org/mailman/listinfo/catalyst
2232 http://lists.rawmode.org/mailman/listinfo/catalyst-dev
2236 http://catalyst.perl.org
2240 http://dev.catalyst.perl.org
2244 =head2 L<Task::Catalyst> - All you need to start with Catalyst
2246 =head2 L<Catalyst::Manual> - The Catalyst Manual
2248 =head2 L<Catalyst::Component>, L<Catalyst::Base> - Base classes for components
2250 =head2 L<Catalyst::Engine> - Core engine
2252 =head2 L<Catalyst::Log> - Log class.
2254 =head2 L<Catalyst::Request> - Request object
2256 =head2 L<Catalyst::Response> - Response object
2258 =head2 L<Catalyst::Test> - The test suite.
2330 Sebastian Riedel, C<sri@oook.de>
2334 This library is free software, you can redistribute it and/or modify it under
2335 the same terms as Perl itself.