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.7000';
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 ] )
296 The same as C<forward>, but doesn't return to the previous action when
297 processing is finished.
301 sub detach { my $c = shift; $c->dispatcher->detach( $c, @_ ) }
307 Returns the current L<Catalyst::Response> object, q.v.
311 Returns a hashref to the stash, which may be used to store data and pass
312 it between components during a request. You can also set hash keys by
313 passing arguments. The stash is automatically sent to the view. The
314 stash is cleared at the end of a request; it cannot be used for
315 persistent storage (for this you must use a session; see
316 L<Catalyst::Plugin::Session> for a complete system integrated with
319 $c->stash->{foo} = $bar;
320 $c->stash( { moose => 'majestic', qux => 0 } );
321 $c->stash( bar => 1, gorch => 2 ); # equivalent to passing a hashref
323 # stash is automatically passed to the view for use in a template
324 $c->forward( 'MyApp::V::TT' );
331 my $stash = @_ > 1 ? {@_} : $_[0];
332 croak('stash takes a hash or hashref') unless ref $stash;
333 foreach my $key ( keys %$stash ) {
334 $c->{stash}->{$key} = $stash->{$key};
342 =head2 $c->error($error, ...)
344 =head2 $c->error($arrayref)
346 Returns an arrayref containing error messages. If Catalyst encounters an
347 error while processing a request, it stores the error in $c->error. This
348 method should not be used to store non-fatal error messages.
350 my @error = @{ $c->error };
354 $c->error('Something bad happened');
361 my $error = ref $_[0] eq 'ARRAY' ? $_[0] : [@_];
362 croak @$error unless ref $c;
363 push @{ $c->{error} }, @$error;
365 elsif ( defined $_[0] ) { $c->{error} = undef }
366 return $c->{error} || [];
372 Contains the return value of the last executed action.
374 =head2 $c->clear_errors
376 Clear errors. You probably don't want to clear the errors unless you are
377 implementing a custom error screen.
379 This is equivalent to running
393 my ( $c, @names ) = @_;
395 foreach my $name (@names) {
396 foreach my $component ( keys %{ $c->components } ) {
397 return $c->components->{$component} if $component =~ /$name/i;
404 # try explicit component names
406 my ( $c, @names ) = @_;
408 foreach my $try (@names) {
409 return $c->components->{$try} if ( exists $c->components->{$try} );
415 # like component, but try just these prefixes before regex searching,
416 # and do not try to return "sort keys %{ $c->components }"
418 my ( $c, $name, @prefixes ) = @_;
420 my $appclass = ref $c || $c;
422 my @names = map { "${appclass}::${_}::${name}" } @prefixes;
424 my $comp = $c->_comp_explicit(@names);
425 return $comp if defined($comp);
426 $comp = $c->_comp_search($name);
430 # Find possible names for a prefix
433 my ( $c, @prefixes ) = @_;
435 my $appclass = ref $c || $c;
437 my @pre = map { "${appclass}::${_}::" } @prefixes;
441 COMPONENT: foreach my $comp ($c->component) {
442 foreach my $p (@pre) {
443 if ($comp =~ s/^$p//) {
453 # Return a component if only one matches.
455 my ( $c, @prefixes ) = @_;
457 my $appclass = ref $c || $c;
459 my ( $comp, $rest ) =
460 map { $c->_comp_search("^${appclass}::${_}::") } @prefixes;
461 return $comp unless $rest;
464 # Filter a component before returning by calling ACCEPT_CONTEXT if available
465 sub _filter_component {
466 my ( $c, $comp, @args ) = @_;
467 if ( eval { $comp->can('ACCEPT_CONTEXT'); } ) {
468 return $comp->ACCEPT_CONTEXT( $c, @args );
470 else { return $comp }
473 =head2 COMPONENT ACCESSORS
475 =head2 $c->controller($name)
477 Gets a L<Catalyst::Controller> instance by name.
479 $c->controller('Foo')->do_stuff;
481 If the name is omitted, will return the controller for the dispatched
487 my ( $c, $name, @args ) = @_;
488 return $c->_filter_component( $c->_comp_prefixes( $name, qw/Controller C/ ),
491 return $c->component( $c->action->class );
494 =head2 $c->model($name)
496 Gets a L<Catalyst::Model> instance by name.
498 $c->model('Foo')->do_stuff;
500 If the name is omitted, it will look for a config setting 'default_model',
501 or check if there is only one view, and return it if that's the case.
506 my ( $c, $name, @args ) = @_;
507 return $c->_filter_component( $c->_comp_prefixes( $name, qw/Model M/ ),
510 return $c->component( $c->config->{default_model} )
511 if $c->config->{default_model};
512 return $c->_filter_component( $c->_comp_singular(qw/Model M/), @args );
516 =head2 $c->controllers
518 Returns the available names which can be passed to $c->controller
524 return $c->_comp_names(qw/Controller C/);
528 =head2 $c->view($name)
530 Gets a L<Catalyst::View> instance by name.
532 $c->view('Foo')->do_stuff;
534 If the name is omitted, it will look for a config setting
535 'default_view', or check if there is only one view, and forward to it if
541 my ( $c, $name, @args ) = @_;
542 return $c->_filter_component( $c->_comp_prefixes( $name, qw/View V/ ),
545 return $c->component( $c->config->{default_view} )
546 if $c->config->{default_view};
547 return $c->_filter_component( $c->_comp_singular(qw/View V/) );
552 Returns the available names which can be passed to $c->model
558 return $c->_comp_names(qw/Model M/);
564 Returns the available names which can be passed to $c->view
570 return $c->_comp_names(qw/View V/);
573 =head2 $c->comp($name)
575 =head2 $c->component($name)
577 Gets a component object by name. This method is no longer recommended,
578 unless you want to get a specific component by full
579 class. C<$c-E<gt>controller>, C<$c-E<gt>model>, and C<$c-E<gt>view>
580 should be used instead.
591 my $appclass = ref $c || $c;
594 $name, "${appclass}::${name}",
595 map { "${appclass}::${_}::${name}" }
596 qw/Model M Controller C View V/
599 my $comp = $c->_comp_explicit(@names);
600 return $c->_filter_component( $comp, @_ ) if defined($comp);
602 $comp = $c->_comp_search($name);
603 return $c->_filter_component( $comp, @_ ) if defined($comp);
606 return sort keys %{ $c->components };
611 =head2 CLASS DATA AND HELPER CLASSES
615 Returns or takes a hashref containing the application's configuration.
617 __PACKAGE__->config( { db => 'dsn:SQLite:foo.db' } );
619 You can also use a L<YAML> config file like myapp.yml in your
620 applications home directory.
623 db: dsn:SQLite:foo.db
631 $c->log->warn("Setting config after setup has been run is not a good idea.")
632 if ( @_ and $c->setup_finished );
634 $c->NEXT::config(@_);
639 Returns the logging object instance. Unless it is already set, Catalyst
640 sets this up with a L<Catalyst::Log> object. To use your own log class,
641 set the logger with the C<< __PACKAGE__->log >> method prior to calling
642 C<< __PACKAGE__->setup >>.
644 __PACKAGE__->log( MyLogger->new );
649 $c->log->info( 'Now logging with my own logger!' );
651 Your log class should implement the methods described in
657 Overload to enable debug messages (same as -Debug option).
659 Note that this is a static method, not an accessor and should be overloaded
660 by declaring "sub debug { 1 }" in your MyApp.pm, not by calling $c->debug(1).
666 =head2 $c->dispatcher
668 Returns the dispatcher instance. Stringifies to class name. See
669 L<Catalyst::Dispatcher>.
673 Returns the engine instance. Stringifies to the class name. See
677 =head2 UTILITY METHODS
679 =head2 $c->path_to(@path)
681 Merges C<@path> with C<$c-E<gt>config-E<gt>{home}> and returns a
682 L<Path::Class> object.
686 $c->path_to( 'db', 'sqlite.db' );
691 my ( $c, @path ) = @_;
692 my $path = Path::Class::Dir->new( $c->config->{home}, @path );
693 if ( -d $path ) { return $path }
694 else { return Path::Class::File->new( $c->config->{home}, @path ) }
697 =head2 $c->plugin( $name, $class, @args )
699 Helper method for plugins. It creates a classdata accessor/mutator and
700 loads and instantiates the given class.
702 MyApp->plugin( 'prototype', 'HTML::Prototype' );
704 $c->prototype->define_javascript_functions;
709 my ( $class, $name, $plugin, @args ) = @_;
710 $class->_register_plugin( $plugin, 1 );
712 eval { $plugin->import };
713 $class->mk_classdata($name);
715 eval { $obj = $plugin->new(@args) };
718 Catalyst::Exception->throw( message =>
719 qq/Couldn't instantiate instant plugin "$plugin", "$@"/ );
723 $class->log->debug(qq/Initialized instant plugin "$plugin" as "$name"/)
729 Initializes the dispatcher and engine, loads any plugins, and loads the
730 model, view, and controller components. You may also specify an array
731 of plugins to load here, if you choose to not load them in the C<use
735 MyApp->setup( qw/-Debug/ );
740 my ( $class, @arguments ) = @_;
742 $class->log->warn("Running setup twice is not a good idea.")
743 if ( $class->setup_finished );
745 unless ( $class->isa('Catalyst') ) {
747 Catalyst::Exception->throw(
748 message => qq/'$class' does not inherit from Catalyst/ );
751 if ( $class->arguments ) {
752 @arguments = ( @arguments, @{ $class->arguments } );
758 foreach (@arguments) {
762 ( $flags->{log} ) ? 'debug,' . $flags->{log} : 'debug';
764 elsif (/^-(\w+)=?(.*)$/) {
765 $flags->{ lc $1 } = $2;
768 push @{ $flags->{plugins} }, $_;
772 $class->setup_home( delete $flags->{home} );
774 $class->setup_log( delete $flags->{log} );
775 $class->setup_plugins( delete $flags->{plugins} );
776 $class->setup_dispatcher( delete $flags->{dispatcher} );
777 $class->setup_engine( delete $flags->{engine} );
779 for my $flag ( sort keys %{$flags} ) {
781 if ( my $code = $class->can( 'setup_' . $flag ) ) {
782 &$code( $class, delete $flags->{$flag} );
785 $class->log->warn(qq/Unknown flag "$flag"/);
789 eval { require Catalyst::Devel; };
790 if( !$@ && $ENV{CATALYST_SCRIPT_GEN} && ( $ENV{CATALYST_SCRIPT_GEN} < $Catalyst::Devel::CATALYST_SCRIPT_GEN ) ) {
791 $class->log->warn(<<"EOF");
792 You are running an old script!
794 Please update by running (this will overwrite existing files):
795 catalyst.pl -force -scripts $class
797 or (this will not overwrite existing files):
798 catalyst.pl -scripts $class
802 if ( $class->debug ) {
803 my @plugins = map { "$_ " . ( $_->VERSION || '' ) } $class->registered_plugins;
806 my $t = Text::SimpleTable->new(74);
807 $t->row($_) for @plugins;
808 $class->log->debug( "Loaded plugins:\n" . $t->draw );
811 my $dispatcher = $class->dispatcher;
812 my $engine = $class->engine;
813 my $home = $class->config->{home};
815 $class->log->debug(qq/Loaded dispatcher "$dispatcher"/);
816 $class->log->debug(qq/Loaded engine "$engine"/);
820 ? $class->log->debug(qq/Found home "$home"/)
821 : $class->log->debug(qq/Home "$home" doesn't exist/)
822 : $class->log->debug(q/Couldn't find home/);
827 no warnings qw/redefine/;
828 local *setup = sub { };
832 # Initialize our data structure
833 $class->components( {} );
835 $class->setup_components;
837 if ( $class->debug ) {
838 my $t = Text::SimpleTable->new( [ 63, 'Class' ], [ 8, 'Type' ] );
839 for my $comp ( sort keys %{ $class->components } ) {
840 my $type = ref $class->components->{$comp} ? 'instance' : 'class';
841 $t->row( $comp, $type );
843 $class->log->debug( "Loaded components:\n" . $t->draw )
844 if ( keys %{ $class->components } );
847 # Add our self to components, since we are also a component
848 $class->components->{$class} = $class;
850 $class->setup_actions;
852 if ( $class->debug ) {
853 my $name = $class->config->{name} || 'Application';
854 $class->log->info("$name powered by Catalyst $Catalyst::VERSION");
856 $class->log->_flush() if $class->log->can('_flush');
858 $class->setup_finished(1);
861 =head2 $c->uri_for( $path, @args?, \%query_values? )
863 Merges path with C<< $c->request->base >> for absolute URIs and with
864 C<< $c->namespace >> for relative URIs, then returns a normalized L<URI>
865 object. If any args are passed, they are added at the end of the path.
866 If the last argument to C<uri_for> is a hash reference, it is assumed to
867 contain GET parameter key/value pairs, which will be appended to the URI
870 Instead of C<$path>, you can also optionally pass a C<$action> object
871 which will be resolved to a path using
872 C<< $c->dispatcher->uri_for_action >>; if the first element of
873 C<@args> is an arrayref it is treated as a list of captures to be passed
874 to C<uri_for_action>.
879 my ( $c, $path, @args ) = @_;
880 my $base = $c->request->base->clone;
881 my $basepath = $base->path;
882 $basepath =~ s/\/$//;
884 my $namespace = $c->namespace || '';
886 if ( Scalar::Util::blessed($path) ) { # action object
887 my $captures = ( scalar @args && ref $args[0] eq 'ARRAY'
890 $path = $c->dispatcher->uri_for_action($path, $captures);
891 return undef unless defined($path);
894 # massage namespace, empty if absolute path
895 $namespace =~ s/^\/// if $namespace;
896 $namespace .= '/' if $namespace;
898 $namespace = '' if $path =~ /^\//;
902 ( scalar @args && ref $args[$#args] eq 'HASH' ? pop @args : {} );
904 for my $value ( values %$params ) {
905 my $isa_ref = ref $value;
906 if( $isa_ref and $isa_ref ne 'ARRAY' ) {
907 croak( "Non-array reference ($isa_ref) passed to uri_for()" );
909 utf8::encode( $_ ) for grep { defined } $isa_ref ? @$value : $value;
912 # join args with '/', or a blank string
913 my $args = ( scalar @args ? '/' . join( '/', @args ) : '' );
914 $args =~ s/^\/// unless $path;
916 URI->new_abs( URI->new_abs( "$path$args", "$basepath$namespace" ), $base )
918 $res->query_form(%$params);
922 =head2 $c->welcome_message
924 Returns the Catalyst welcome HTML page.
928 sub welcome_message {
930 my $name = $c->config->{name};
931 my $logo = $c->uri_for('/static/images/catalyst_logo.png');
932 my $prefix = Catalyst::Utils::appprefix( ref $c );
933 $c->response->content_type('text/html; charset=utf-8');
935 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
936 "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
937 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
939 <meta http-equiv="Content-Language" content="en" />
940 <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
941 <title>$name on Catalyst $VERSION</title>
942 <style type="text/css">
945 background-color: #eee;
954 background-color: #ccc;
955 border: 1px solid #aaa;
960 font-family: verdana, tahoma, sans-serif;
963 font-family: verdana, tahoma, sans-serif;
966 text-decoration: none;
968 border-bottom: 1px dotted #bbb;
970 :link:hover, :visited:hover {
983 background-color: #fff;
984 border: 1px solid #aaa;
1010 <h1><span id="appname">$name</span> on <a href="http://catalyst.perl.org">Catalyst</a>
1015 <img src="$logo" alt="Catalyst Logo" />
1017 <p>Welcome to the wonderful world of Catalyst.
1018 This <a href="http://en.wikipedia.org/wiki/MVC">MVC</a>
1019 framework will make web development something you had
1020 never expected it to be: Fun, rewarding, and quick.</p>
1021 <h2>What to do now?</h2>
1022 <p>That really depends on what <b>you</b> want to do.
1023 We do, however, provide you with a few starting points.</p>
1024 <p>If you want to jump right into web development with Catalyst
1025 you might want to check out the documentation.</p>
1026 <pre><code>perldoc <a href="http://cpansearch.perl.org/dist/Catalyst/lib/Catalyst/Manual/Intro.pod">Catalyst::Manual::Intro</a>
1027 perldoc <a href="http://cpansearch.perl.org/dist/Catalyst/lib/Catalyst/Manual/Tutorial.pod">Catalyst::Manual::Tutorial</a></code>
1028 perldoc <a href="http://cpansearch.perl.org/dist/Catalyst/lib/Catalyst/Manual.pod">Catalyst::Manual</a></code></pre>
1029 <h2>What to do next?</h2>
1030 <p>Next it's time to write an actual application. Use the
1031 helper scripts to generate <a href="http://cpansearch.perl.org/search?query=Catalyst%3A%3AController%3A%3A&mode=all">controllers</a>,
1032 <a href="http://cpansearch.perl.org/search?query=Catalyst%3A%3AModel%3A%3A&mode=all">models</a>, and
1033 <a href="http://cpansearch.perl.org/search?query=Catalyst%3A%3AView%3A%3A&mode=all">views</a>;
1034 they can save you a lot of work.</p>
1035 <pre><code>script/${prefix}_create.pl -help</code></pre>
1036 <p>Also, be sure to check out the vast and growing
1037 collection of <a href="http://cpansearch.perl.org/search?query=Catalyst%3A%3APlugin%3A%3A&mode=all">plugins for Catalyst on CPAN</a>;
1038 you are likely to find what you need there.
1042 <p>Catalyst has a very active community. Here are the main places to
1043 get in touch with us.</p>
1046 <a href="http://dev.catalyst.perl.org">Wiki</a>
1049 <a href="http://lists.rawmode.org/mailman/listinfo/catalyst">Mailing-List</a>
1052 <a href="irc://irc.perl.org/catalyst">IRC channel #catalyst on irc.perl.org</a>
1055 <h2>In conclusion</h2>
1056 <p>The Catalyst team hopes you will enjoy using Catalyst as much
1057 as we enjoyed making it. Please contact us if you have ideas
1058 for improvement or other feedback.</p>
1066 =head1 INTERNAL METHODS
1068 These methods are not meant to be used by end users.
1070 =head2 $c->components
1072 Returns a hash of components.
1074 =head2 $c->context_class
1076 Returns or sets the context class.
1080 Returns a hashref containing coderefs and execution counts (needed for
1081 deep recursion detection).
1085 Returns the number of actions on the current internal execution stack.
1089 Dispatches a request to actions.
1093 sub dispatch { my $c = shift; $c->dispatcher->dispatch( $c, @_ ) }
1095 =head2 $c->dispatcher_class
1097 Returns or sets the dispatcher class.
1099 =head2 $c->dump_these
1101 Returns a list of 2-element array references (name, structure) pairs
1102 that will be dumped on the error page in debug mode.
1108 [ Request => $c->req ],
1109 [ Response => $c->res ],
1110 [ Stash => $c->stash ],
1111 [ Config => $c->config ];
1114 =head2 $c->engine_class
1116 Returns or sets the engine class.
1118 =head2 $c->execute( $class, $coderef )
1120 Execute a coderef in given class and catch exceptions. Errors are available
1126 my ( $c, $class, $code ) = @_;
1127 $class = $c->component($class) || $class;
1130 if ( $c->depth >= $RECURSION ) {
1131 my $action = "$code";
1132 $action = "/$action" unless $action =~ /->/;
1133 my $error = qq/Deep recursion detected calling "$action"/;
1134 $c->log->error($error);
1140 my $stats_info = $c->_stats_start_execute( $code ) if $c->debug;
1142 push( @{ $c->stack }, $code );
1144 eval { $c->state( &$code( $class, $c, @{ $c->req->args } ) || 0 ) };
1146 $c->_stats_finish_execute( $stats_info ) if $c->debug and $stats_info;
1148 my $last = pop( @{ $c->stack } );
1150 if ( my $error = $@ ) {
1151 if ( $error eq $DETACH ) { die $DETACH if $c->depth > 1 }
1153 unless ( ref $error ) {
1154 no warnings 'uninitialized';
1156 my $class = $last->class;
1157 my $name = $last->name;
1158 $error = qq/Caught exception in $class->$name "$error"/;
1167 sub _stats_start_execute {
1168 my ( $c, $code ) = @_;
1170 return if ( ( $code->name =~ /^_.*/ )
1171 && ( !$c->config->{show_internal_actions} ) );
1173 $c->counter->{"$code"}++;
1175 my $action = "$code";
1176 $action = "/$action" unless $action =~ /->/;
1178 # determine if the call was the result of a forward
1179 # this is done by walking up the call stack and looking for a calling
1180 # sub of Catalyst::forward before the eval
1182 for my $index ( 2 .. 11 ) {
1184 if ( ( caller($index) )[0] eq 'Catalyst'
1185 && ( caller($index) )[3] eq '(eval)' );
1187 if ( ( caller($index) )[3] =~ /forward$/ ) {
1188 $callsub = ( caller($index) )[3];
1189 $action = "-> $action";
1194 my $node = Tree::Simple->new(
1197 elapsed => undef, # to be filled in later
1201 $node->setUID( "$code" . $c->counter->{"$code"} );
1203 # is this a root-level call or a forwarded call?
1204 if ( $callsub =~ /forward$/ ) {
1206 # forward, locate the caller
1207 if ( my $parent = $c->stack->[-1] ) {
1208 my $visitor = Tree::Simple::Visitor::FindByUID->new;
1209 $visitor->searchForUID(
1210 "$parent" . $c->counter->{"$parent"} );
1211 $c->stats->accept($visitor);
1212 if ( my $result = $visitor->getResult ) {
1213 $result->addChild($node);
1218 # forward with no caller may come from a plugin
1219 $c->stats->addChild($node);
1225 $c->stats->addChild($node);
1229 start => [gettimeofday],
1234 sub _stats_finish_execute {
1235 my ( $c, $info ) = @_;
1236 my $elapsed = tv_interval $info->{start};
1237 my $value = $info->{node}->getNodeValue;
1238 $value->{elapsed} = sprintf( '%fs', $elapsed );
1241 =head2 $c->_localize_fields( sub { }, \%keys );
1245 sub _localize_fields {
1246 my ( $c, $localized, $code ) = ( @_ );
1248 my $request = delete $localized->{request} || {};
1249 my $response = delete $localized->{response} || {};
1251 local @{ $c }{ keys %$localized } = values %$localized;
1252 local @{ $c->request }{ keys %$request } = values %$request;
1253 local @{ $c->response }{ keys %$response } = values %$response;
1260 Finalizes the request.
1267 for my $error ( @{ $c->error } ) {
1268 $c->log->error($error);
1271 # Allow engine to handle finalize flow (for POE)
1272 if ( $c->engine->can('finalize') ) {
1273 $c->engine->finalize($c);
1277 $c->finalize_uploads;
1280 if ( $#{ $c->error } >= 0 ) {
1284 $c->finalize_headers;
1287 if ( $c->request->method eq 'HEAD' ) {
1288 $c->response->body('');
1294 return $c->response->status;
1297 =head2 $c->finalize_body
1303 sub finalize_body { my $c = shift; $c->engine->finalize_body( $c, @_ ) }
1305 =head2 $c->finalize_cookies
1311 sub finalize_cookies { my $c = shift; $c->engine->finalize_cookies( $c, @_ ) }
1313 =head2 $c->finalize_error
1319 sub finalize_error { my $c = shift; $c->engine->finalize_error( $c, @_ ) }
1321 =head2 $c->finalize_headers
1327 sub finalize_headers {
1330 # Check if we already finalized headers
1331 return if $c->response->{_finalized_headers};
1334 if ( my $location = $c->response->redirect ) {
1335 $c->log->debug(qq/Redirecting to "$location"/) if $c->debug;
1336 $c->response->header( Location => $location );
1340 if ( $c->response->body && !$c->response->content_length ) {
1342 # get the length from a filehandle
1343 if ( blessed( $c->response->body ) && $c->response->body->can('read') )
1345 if ( my $stat = stat $c->response->body ) {
1346 $c->response->content_length( $stat->size );
1349 $c->log->warn('Serving filehandle without a content-length');
1353 $c->response->content_length( bytes::length( $c->response->body ) );
1358 if ( $c->response->status =~ /^(1\d\d|[23]04)$/ ) {
1359 $c->response->headers->remove_header("Content-Length");
1360 $c->response->body('');
1363 $c->finalize_cookies;
1365 $c->engine->finalize_headers( $c, @_ );
1368 $c->response->{_finalized_headers} = 1;
1371 =head2 $c->finalize_output
1373 An alias for finalize_body.
1375 =head2 $c->finalize_read
1377 Finalizes the input after reading is complete.
1381 sub finalize_read { my $c = shift; $c->engine->finalize_read( $c, @_ ) }
1383 =head2 $c->finalize_uploads
1385 Finalizes uploads. Cleans up any temporary files.
1389 sub finalize_uploads { my $c = shift; $c->engine->finalize_uploads( $c, @_ ) }
1391 =head2 $c->get_action( $action, $namespace )
1393 Gets an action in a given namespace.
1397 sub get_action { my $c = shift; $c->dispatcher->get_action(@_) }
1399 =head2 $c->get_actions( $action, $namespace )
1401 Gets all actions of a given name in a namespace and all parent
1406 sub get_actions { my $c = shift; $c->dispatcher->get_actions( $c, @_ ) }
1408 =head2 $c->handle_request( $class, @arguments )
1410 Called to handle each HTTP request.
1414 sub handle_request {
1415 my ( $class, @arguments ) = @_;
1417 # Always expect worst case!
1420 if ($class->debug) {
1421 my $start = [gettimeofday];
1422 my $c = $class->prepare(@arguments);
1423 $c->stats(Tree::Simple->new);
1425 $status = $c->finalize;
1427 my $elapsed = tv_interval $start;
1428 $elapsed = sprintf '%f', $elapsed;
1429 my $av = sprintf '%.3f',
1430 ( $elapsed == 0 ? '??' : ( 1 / $elapsed ) );
1431 my $t = Text::SimpleTable->new( [ 62, 'Action' ], [ 9, 'Time' ] );
1433 $c->stats->traverse(
1436 my $stat = $action->getNodeValue;
1437 $t->row( ( q{ } x $action->getDepth ) . $stat->{action} . $stat->{comment},
1438 $stat->{elapsed} || '??' );
1443 "Request took ${elapsed}s ($av/s)\n" . $t->draw );
1446 my $c = $class->prepare(@arguments);
1448 $status = $c->finalize;
1452 if ( my $error = $@ ) {
1454 $class->log->error(qq/Caught exception in engine "$error"/);
1458 $class->log->_flush() if $class->log->can('_flush');
1462 =head2 $c->prepare( @arguments )
1464 Creates a Catalyst context from an engine-specific request (Apache, CGI,
1470 my ( $class, @arguments ) = @_;
1472 $class->context_class( ref $class || $class ) unless $class->context_class;
1473 my $c = $class->context_class->new(
1477 request => $class->request_class->new(
1480 body_parameters => {},
1482 headers => HTTP::Headers->new,
1484 query_parameters => {},
1490 response => $class->response_class->new(
1494 headers => HTTP::Headers->new(),
1503 # For on-demand data
1504 $c->request->{_context} = $c;
1505 $c->response->{_context} = $c;
1506 weaken( $c->request->{_context} );
1507 weaken( $c->response->{_context} );
1510 my $secs = time - $START || 1;
1511 my $av = sprintf '%.3f', $COUNT / $secs;
1512 my $time = localtime time;
1513 $c->log->info("*** Request $COUNT ($av/s) [$$] [$time] ***");
1514 $c->res->headers->header( 'X-Catalyst' => $Catalyst::VERSION );
1517 # Allow engine to direct the prepare flow (for POE)
1518 if ( $c->engine->can('prepare') ) {
1519 $c->engine->prepare( $c, @arguments );
1522 $c->prepare_request(@arguments);
1523 $c->prepare_connection;
1524 $c->prepare_query_parameters;
1525 $c->prepare_headers;
1526 $c->prepare_cookies;
1530 $c->prepare_body unless $c->config->{parse_on_demand};
1533 my $method = $c->req->method || '';
1534 my $path = $c->req->path || '/';
1535 my $address = $c->req->address || '';
1537 $c->log->debug(qq/"$method" request for "$path" from "$address"/)
1545 =head2 $c->prepare_action
1547 Prepares action. See L<Catalyst::Dispatcher>.
1551 sub prepare_action { my $c = shift; $c->dispatcher->prepare_action( $c, @_ ) }
1553 =head2 $c->prepare_body
1555 Prepares message body.
1562 # Do we run for the first time?
1563 return if defined $c->request->{_body};
1565 # Initialize on-demand data
1566 $c->engine->prepare_body( $c, @_ );
1567 $c->prepare_parameters;
1568 $c->prepare_uploads;
1570 if ( $c->debug && keys %{ $c->req->body_parameters } ) {
1571 my $t = Text::SimpleTable->new( [ 35, 'Parameter' ], [ 36, 'Value' ] );
1572 for my $key ( sort keys %{ $c->req->body_parameters } ) {
1573 my $param = $c->req->body_parameters->{$key};
1574 my $value = defined($param) ? $param : '';
1576 ref $value eq 'ARRAY' ? ( join ', ', @$value ) : $value );
1578 $c->log->debug( "Body Parameters are:\n" . $t->draw );
1582 =head2 $c->prepare_body_chunk( $chunk )
1584 Prepares a chunk of data before sending it to L<HTTP::Body>.
1586 See L<Catalyst::Engine>.
1590 sub prepare_body_chunk {
1592 $c->engine->prepare_body_chunk( $c, @_ );
1595 =head2 $c->prepare_body_parameters
1597 Prepares body parameters.
1601 sub prepare_body_parameters {
1603 $c->engine->prepare_body_parameters( $c, @_ );
1606 =head2 $c->prepare_connection
1608 Prepares connection.
1612 sub prepare_connection {
1614 $c->engine->prepare_connection( $c, @_ );
1617 =head2 $c->prepare_cookies
1623 sub prepare_cookies { my $c = shift; $c->engine->prepare_cookies( $c, @_ ) }
1625 =head2 $c->prepare_headers
1631 sub prepare_headers { my $c = shift; $c->engine->prepare_headers( $c, @_ ) }
1633 =head2 $c->prepare_parameters
1635 Prepares parameters.
1639 sub prepare_parameters {
1641 $c->prepare_body_parameters;
1642 $c->engine->prepare_parameters( $c, @_ );
1645 =head2 $c->prepare_path
1647 Prepares path and base.
1651 sub prepare_path { my $c = shift; $c->engine->prepare_path( $c, @_ ) }
1653 =head2 $c->prepare_query_parameters
1655 Prepares query parameters.
1659 sub prepare_query_parameters {
1662 $c->engine->prepare_query_parameters( $c, @_ );
1664 if ( $c->debug && keys %{ $c->request->query_parameters } ) {
1665 my $t = Text::SimpleTable->new( [ 35, 'Parameter' ], [ 36, 'Value' ] );
1666 for my $key ( sort keys %{ $c->req->query_parameters } ) {
1667 my $param = $c->req->query_parameters->{$key};
1668 my $value = defined($param) ? $param : '';
1670 ref $value eq 'ARRAY' ? ( join ', ', @$value ) : $value );
1672 $c->log->debug( "Query Parameters are:\n" . $t->draw );
1676 =head2 $c->prepare_read
1678 Prepares the input for reading.
1682 sub prepare_read { my $c = shift; $c->engine->prepare_read( $c, @_ ) }
1684 =head2 $c->prepare_request
1686 Prepares the engine request.
1690 sub prepare_request { my $c = shift; $c->engine->prepare_request( $c, @_ ) }
1692 =head2 $c->prepare_uploads
1698 sub prepare_uploads {
1701 $c->engine->prepare_uploads( $c, @_ );
1703 if ( $c->debug && keys %{ $c->request->uploads } ) {
1704 my $t = Text::SimpleTable->new(
1705 [ 12, 'Parameter' ],
1710 for my $key ( sort keys %{ $c->request->uploads } ) {
1711 my $upload = $c->request->uploads->{$key};
1712 for my $u ( ref $upload eq 'ARRAY' ? @{$upload} : ($upload) ) {
1713 $t->row( $key, $u->filename, $u->type, $u->size );
1716 $c->log->debug( "File Uploads are:\n" . $t->draw );
1720 =head2 $c->prepare_write
1722 Prepares the output for writing.
1726 sub prepare_write { my $c = shift; $c->engine->prepare_write( $c, @_ ) }
1728 =head2 $c->request_class
1730 Returns or sets the request class.
1732 =head2 $c->response_class
1734 Returns or sets the response class.
1736 =head2 $c->read( [$maxlength] )
1738 Reads a chunk of data from the request body. This method is designed to
1739 be used in a while loop, reading C<$maxlength> bytes on every call.
1740 C<$maxlength> defaults to the size of the request if not specified.
1742 You have to set C<MyApp-E<gt>config-E<gt>{parse_on_demand}> to use this
1747 sub read { my $c = shift; return $c->engine->read( $c, @_ ) }
1755 sub run { my $c = shift; return $c->engine->run( $c, @_ ) }
1757 =head2 $c->set_action( $action, $code, $namespace, $attrs )
1759 Sets an action in a given namespace.
1763 sub set_action { my $c = shift; $c->dispatcher->set_action( $c, @_ ) }
1765 =head2 $c->setup_actions($component)
1767 Sets up actions for a component.
1771 sub setup_actions { my $c = shift; $c->dispatcher->setup_actions( $c, @_ ) }
1773 =head2 $c->setup_components
1775 Sets up components. Specify a C<setup_components> config option to pass
1776 additional options directly to L<Module::Pluggable>. To add additional
1777 search paths, specify a key named C<search_extra> as an array
1778 reference. Items in the array beginning with C<::> will have the
1779 application class name prepended to them.
1783 sub setup_components {
1786 my @paths = qw( ::Controller ::C ::Model ::M ::View ::V );
1787 my $config = $class->config->{ setup_components };
1788 my $extra = delete $config->{ search_extra } || [];
1790 push @paths, @$extra;
1792 my $locator = Module::Pluggable::Object->new(
1793 search_path => [ map { s/^(?=::)/$class/; $_; } @paths ],
1797 for my $component ( sort { length $a <=> length $b } $locator->plugins ) {
1798 Catalyst::Utils::ensure_class_loaded( $component );
1800 my $module = $class->setup_component( $component );
1802 $component => $module,
1804 $_ => $class->setup_component( $_ )
1805 } Devel::InnerPackage::list_packages( $component )
1808 for my $key ( keys %modules ) {
1809 $class->components->{ $key } = $modules{ $key };
1814 =head2 $c->setup_component
1818 sub setup_component {
1819 my( $class, $component ) = @_;
1821 unless ( $component->can( 'COMPONENT' ) ) {
1825 my $suffix = Catalyst::Utils::class2classsuffix( $component );
1826 my $config = $class->config->{ $suffix } || {};
1828 my $instance = eval { $component->COMPONENT( $class, $config ); };
1830 if ( my $error = $@ ) {
1832 Catalyst::Exception->throw(
1833 message => qq/Couldn't instantiate component "$component", "$error"/
1837 Catalyst::Exception->throw(
1839 qq/Couldn't instantiate component "$component", "COMPONENT() didn't return an object-like value"/
1840 ) unless eval { $instance->can( 'can' ) };
1845 =head2 $c->setup_dispatcher
1851 sub setup_dispatcher {
1852 my ( $class, $dispatcher ) = @_;
1855 $dispatcher = 'Catalyst::Dispatcher::' . $dispatcher;
1858 if ( $ENV{CATALYST_DISPATCHER} ) {
1859 $dispatcher = 'Catalyst::Dispatcher::' . $ENV{CATALYST_DISPATCHER};
1862 if ( $ENV{ uc($class) . '_DISPATCHER' } ) {
1864 'Catalyst::Dispatcher::' . $ENV{ uc($class) . '_DISPATCHER' };
1867 unless ($dispatcher) {
1868 $dispatcher = $class->dispatcher_class;
1871 unless (Class::Inspector->loaded($dispatcher)) {
1872 require Class::Inspector->filename($dispatcher);
1875 # dispatcher instance
1876 $class->dispatcher( $dispatcher->new );
1879 =head2 $c->setup_engine
1886 my ( $class, $engine ) = @_;
1889 $engine = 'Catalyst::Engine::' . $engine;
1892 if ( $ENV{CATALYST_ENGINE} ) {
1893 $engine = 'Catalyst::Engine::' . $ENV{CATALYST_ENGINE};
1896 if ( $ENV{ uc($class) . '_ENGINE' } ) {
1897 $engine = 'Catalyst::Engine::' . $ENV{ uc($class) . '_ENGINE' };
1900 if ( $ENV{MOD_PERL} ) {
1902 # create the apache method
1905 *{"$class\::apache"} = sub { shift->engine->apache };
1908 my ( $software, $version ) =
1909 $ENV{MOD_PERL} =~ /^(\S+)\/(\d+(?:[\.\_]\d+)+)/;
1912 $version =~ s/(\.[^.]+)\./$1/g;
1914 if ( $software eq 'mod_perl' ) {
1918 if ( $version >= 1.99922 ) {
1919 $engine = 'Catalyst::Engine::Apache2::MP20';
1922 elsif ( $version >= 1.9901 ) {
1923 $engine = 'Catalyst::Engine::Apache2::MP19';
1926 elsif ( $version >= 1.24 ) {
1927 $engine = 'Catalyst::Engine::Apache::MP13';
1931 Catalyst::Exception->throw( message =>
1932 qq/Unsupported mod_perl version: $ENV{MOD_PERL}/ );
1937 # install the correct mod_perl handler
1938 if ( $version >= 1.9901 ) {
1939 *handler = sub : method {
1940 shift->handle_request(@_);
1944 *handler = sub ($$) { shift->handle_request(@_) };
1949 elsif ( $software eq 'Zeus-Perl' ) {
1950 $engine = 'Catalyst::Engine::Zeus';
1954 Catalyst::Exception->throw(
1955 message => qq/Unsupported mod_perl: $ENV{MOD_PERL}/ );
1960 $engine = $class->engine_class;
1963 unless (Class::Inspector->loaded($engine)) {
1964 require Class::Inspector->filename($engine);
1967 # check for old engines that are no longer compatible
1969 if ( $engine->isa('Catalyst::Engine::Apache')
1970 && !Catalyst::Engine::Apache->VERSION )
1975 elsif ( $engine->isa('Catalyst::Engine::Server::Base')
1976 && Catalyst::Engine::Server->VERSION le '0.02' )
1981 elsif ($engine->isa('Catalyst::Engine::HTTP::POE')
1982 && $engine->VERSION eq '0.01' )
1987 elsif ($engine->isa('Catalyst::Engine::Zeus')
1988 && $engine->VERSION eq '0.01' )
1994 Catalyst::Exception->throw( message =>
1995 qq/Engine "$engine" is not supported by this version of Catalyst/
2000 $class->engine( $engine->new );
2003 =head2 $c->setup_home
2005 Sets up the home directory.
2010 my ( $class, $home ) = @_;
2012 if ( $ENV{CATALYST_HOME} ) {
2013 $home = $ENV{CATALYST_HOME};
2016 if ( $ENV{ uc($class) . '_HOME' } ) {
2017 $home = $ENV{ uc($class) . '_HOME' };
2021 $home = Catalyst::Utils::home($class);
2025 $class->config->{home} ||= $home;
2026 $class->config->{root} ||= Path::Class::Dir->new($home)->subdir('root');
2030 =head2 $c->setup_log
2037 my ( $class, $debug ) = @_;
2039 unless ( $class->log ) {
2040 $class->log( Catalyst::Log->new );
2043 my $app_flag = Catalyst::Utils::class2env($class) . '_DEBUG';
2046 ( defined( $ENV{CATALYST_DEBUG} ) || defined( $ENV{$app_flag} ) )
2047 ? ( $ENV{CATALYST_DEBUG} || $ENV{$app_flag} )
2052 *{"$class\::debug"} = sub { 1 };
2053 $class->log->debug('Debug messages enabled');
2057 =head2 $c->setup_plugins
2063 =head2 $c->registered_plugins
2065 Returns a sorted list of the plugins which have either been stated in the
2066 import list or which have been added via C<< MyApp->plugin(@args); >>.
2068 If passed a given plugin name, it will report a boolean value indicating
2069 whether or not that plugin is loaded. A fully qualified name is required if
2070 the plugin name does not begin with C<Catalyst::Plugin::>.
2072 if ($c->registered_plugins('Some::Plugin')) {
2080 sub registered_plugins {
2082 return sort keys %{ $proto->_plugins } unless @_;
2084 return 1 if exists $proto->_plugins->{$plugin};
2085 return exists $proto->_plugins->{"Catalyst::Plugin::$plugin"};
2088 sub _register_plugin {
2089 my ( $proto, $plugin, $instant ) = @_;
2090 my $class = ref $proto || $proto;
2092 unless (Class::Inspector->loaded($plugin)) {
2093 require Class::Inspector->filename($plugin);
2096 $proto->_plugins->{$plugin} = 1;
2099 unshift @{"$class\::ISA"}, $plugin;
2105 my ( $class, $plugins ) = @_;
2107 $class->_plugins( {} ) unless $class->_plugins;
2109 for my $plugin ( reverse @$plugins ) {
2111 unless ( $plugin =~ s/\A\+// ) {
2112 $plugin = "Catalyst::Plugin::$plugin";
2115 $class->_register_plugin($plugin);
2122 Returns an arrayref of the internal execution stack (actions that are
2123 currently executing).
2125 =head2 $c->write( $data )
2127 Writes $data to the output stream. When using this method directly, you
2128 will need to manually set the C<Content-Length> header to the length of
2129 your output data, if known.
2136 # Finalize headers if someone manually writes output
2137 $c->finalize_headers;
2139 return $c->engine->write( $c, @_ );
2144 Returns the Catalyst version number. Mostly useful for "powered by"
2145 messages in template systems.
2149 sub version { return $Catalyst::VERSION }
2151 =head1 INTERNAL ACTIONS
2153 Catalyst uses internal actions like C<_DISPATCH>, C<_BEGIN>, C<_AUTO>,
2154 C<_ACTION>, and C<_END>. These are by default not shown in the private
2155 action table, but you can make them visible with a config parameter.
2157 MyApp->config->{show_internal_actions} = 1;
2159 =head1 CASE SENSITIVITY
2161 By default Catalyst is not case sensitive, so C<MyApp::C::FOO::Bar> is
2162 mapped to C</foo/bar>. You can activate case sensitivity with a config
2165 MyApp->config->{case_sensitive} = 1;
2167 This causes C<MyApp::C::Foo::Bar> to map to C</Foo/Bar>.
2169 =head1 ON-DEMAND PARSER
2171 The request body is usually parsed at the beginning of a request,
2172 but if you want to handle input yourself or speed things up a bit,
2173 you can enable on-demand parsing with a config parameter.
2175 MyApp->config->{parse_on_demand} = 1;
2177 =head1 PROXY SUPPORT
2179 Many production servers operate using the common double-server approach,
2180 with a lightweight frontend web server passing requests to a larger
2181 backend server. An application running on the backend server must deal
2182 with two problems: the remote user always appears to be C<127.0.0.1> and
2183 the server's hostname will appear to be C<localhost> regardless of the
2184 virtual host that the user connected through.
2186 Catalyst will automatically detect this situation when you are running
2187 the frontend and backend servers on the same machine. The following
2188 changes are made to the request.
2190 $c->req->address is set to the user's real IP address, as read from
2191 the HTTP X-Forwarded-For header.
2193 The host value for $c->req->base and $c->req->uri is set to the real
2194 host, as read from the HTTP X-Forwarded-Host header.
2196 Obviously, your web server must support these headers for this to work.
2198 In a more complex server farm environment where you may have your
2199 frontend proxy server(s) on different machines, you will need to set a
2200 configuration option to tell Catalyst to read the proxied data from the
2203 MyApp->config->{using_frontend_proxy} = 1;
2205 If you do not wish to use the proxy support at all, you may set:
2207 MyApp->config->{ignore_frontend_proxy} = 1;
2209 =head1 THREAD SAFETY
2211 Catalyst has been tested under Apache 2's threading C<mpm_worker>,
2212 C<mpm_winnt>, and the standalone forking HTTP server on Windows. We
2213 believe the Catalyst core to be thread-safe.
2215 If you plan to operate in a threaded environment, remember that all other
2216 modules you are using must also be thread-safe. Some modules, most notably
2217 L<DBD::SQLite>, are not thread-safe.
2223 Join #catalyst on irc.perl.org.
2227 http://lists.rawmode.org/mailman/listinfo/catalyst
2228 http://lists.rawmode.org/mailman/listinfo/catalyst-dev
2232 http://catalyst.perl.org
2236 http://dev.catalyst.perl.org
2240 =head2 L<Task::Catalyst> - All you need to start with Catalyst
2242 =head2 L<Catalyst::Manual> - The Catalyst Manual
2244 =head2 L<Catalyst::Component>, L<Catalyst::Base> - Base classes for components
2246 =head2 L<Catalyst::Engine> - Core engine
2248 =head2 L<Catalyst::Log> - Log class.
2250 =head2 L<Catalyst::Request> - Request object
2252 =head2 L<Catalyst::Response> - Response object
2254 =head2 L<Catalyst::Test> - The test suite.
2326 Sebastian Riedel, C<sri@oook.de>
2330 This library is free software, you can redistribute it and/or modify it under
2331 the same terms as Perl itself.