4 use base 'Catalyst::Component';
6 use Catalyst::Exception;
9 use Catalyst::Request::Upload;
10 use Catalyst::Response;
12 use Catalyst::Controller;
15 use Text::SimpleTable;
17 use Path::Class::File;
18 use Time::HiRes qw/gettimeofday tv_interval/;
20 use Scalar::Util qw/weaken blessed/;
21 use Tree::Simple qw/use_weak_refs/;
22 use Tree::Simple::Visitor::FindByUID;
27 BEGIN { require 5.008001; }
29 __PACKAGE__->mk_accessors(
30 qw/counter request response state action stack namespace stats/
33 attributes->import( __PACKAGE__, \&namespace, 'lvalue' );
35 sub depth { scalar @{ shift->stack || [] }; }
42 # For backwards compatibility
43 *finalize_output = \&finalize_body;
48 our $RECURSION = 1000;
49 our $DETACH = "catalyst_detach\n";
51 require Module::Pluggable::Fast;
53 __PACKAGE__->mk_classdata($_)
54 for qw/components arguments dispatcher engine log dispatcher_class
55 engine_class context_class request_class response_class setup_finished/;
57 __PACKAGE__->dispatcher_class('Catalyst::Dispatcher');
58 __PACKAGE__->engine_class('Catalyst::Engine::CGI');
59 __PACKAGE__->request_class('Catalyst::Request');
60 __PACKAGE__->response_class('Catalyst::Response');
62 our $VERSION = '5.6902';
65 my ( $class, @arguments ) = @_;
67 # We have to limit $class to Catalyst to avoid pushing Catalyst upon every
69 return unless $class eq 'Catalyst';
71 my $caller = caller(0);
73 unless ( $caller->isa('Catalyst') ) {
75 push @{"$caller\::ISA"}, $class, 'Catalyst::Controller';
78 $caller->arguments( [@arguments] );
84 Catalyst - The Elegant MVC Web Application Framework
88 # use the helper to create a new application
91 # add models, views, controllers
92 script/myapp_create.pl model Database DBIC::SchemaLoader dbi:SQLite:/path/to/db
93 script/myapp_create.pl view TT TT
94 script/myapp_create.pl controller Search
96 # built in testserver -- use -r to restart automatically on changes
97 script/myapp_server.pl
99 # command line testing interface
100 script/myapp_test.pl /yada
103 use Catalyst qw/-Debug/; # include plugins here as well
105 ### In lib/MyApp/Controller/Root.pm (autocreated)
106 sub foo : Global { # called for /foo, /foo/1, /foo/1/2, etc.
107 my ( $self, $c, @args ) = @_; # args are qw/1 2/ for /foo/1/2
108 $c->stash->{template} = 'foo.tt'; # set the template
109 # lookup something from db -- stash vars are passed to TT
111 $c->model('Database::Foo')->search( { country => $args[0] } );
112 if ( $c->req->params->{bar} ) { # access GET or POST parameters
113 $c->forward( 'bar' ); # process another action
114 # do something else after forward returns
118 # The foo.tt TT template can use the stash data from the database
119 [% WHILE (item = data.next) %]
123 # called for /bar/of/soap, /bar/of/soap/10, etc.
124 sub bar : Path('/bar/of/soap') { ... }
126 # called for all actions, from the top-most controller downwards
128 my ( $self, $c ) = @_;
129 if ( !$c->user_exists ) { # Catalyst::Plugin::Authentication
130 $c->res->redirect( '/login' ); # require login
131 return 0; # abort request and go immediately to end()
133 return 1; # success; carry on to next action
136 # called after all actions are finished
138 my ( $self, $c ) = @_;
139 if ( scalar @{ $c->error } ) { ... } # handle errors
140 return if $c->res->body; # already have a response
141 $c->forward( 'MyApp::View::TT' ); # render template
144 ### in MyApp/Controller/Foo.pm
145 # called for /foo/bar
146 sub bar : Local { ... }
148 # called for /blargle
149 sub blargle : Global { ... }
151 # an index action matches /foo, but not /foo/1, etc.
152 sub index : Private { ... }
154 ### in MyApp/Controller/Foo/Bar.pm
155 # called for /foo/bar/baz
156 sub baz : Local { ... }
158 # first Root auto is called, then Foo auto, then this
159 sub auto : Private { ... }
161 # powerful regular expression paths are also possible
162 sub details : Regex('^product/(\w+)/details$') {
163 my ( $self, $c ) = @_;
164 # extract the (\w+) from the URI
165 my $product = $c->req->captures->[0];
168 See L<Catalyst::Manual::Intro> for additional information.
172 Catalyst is a modern framework for making web applications without the pain usually associated with this process. This document is a reference to the main Catalyst application. If you are a new user, we suggest you start with L<Catalyst::Manual::Tutorial> or L<Catalyst::Manual::Intro>
174 See L<Catalyst::Manual> for more documentation.
176 Catalyst plugins can be loaded by naming them as arguments to the "use
177 Catalyst" statement. Omit the C<Catalyst::Plugin::> prefix from the
178 plugin name, i.e., C<Catalyst::Plugin::My::Module> becomes
181 use Catalyst qw/My::Module/;
183 If your plugin starts with a name other than C<Catalyst::Plugin::>, you can
184 fully qualify the name by using a unary plus:
188 +Fully::Qualified::Plugin::Name
191 Special flags like C<-Debug> and C<-Engine> can also be specified as
192 arguments when Catalyst is loaded:
194 use Catalyst qw/-Debug My::Module/;
196 The position of plugins and flags in the chain is important, because
197 they are loaded in exactly the order in which they appear.
199 The following flags are supported:
203 Enables debug output. You can also force this setting from the system
204 environment with CATALYST_DEBUG or <MYAPP>_DEBUG. The environment settings
205 override the app, with <MYAPP>_DEBUG having highest priority.
209 Forces Catalyst to use a specific engine. Omit the
210 C<Catalyst::Engine::> prefix of the engine name, i.e.:
212 use Catalyst qw/-Engine=CGI/;
216 Forces Catalyst to use a specific home directory, e.g.:
218 use Catalyst qw[-Home=/usr/sri];
226 =head2 INFORMATION ABOUT THE CURRENT REQUEST
230 Returns a L<Catalyst::Action> object for the current action, which
231 stringifies to the action name. See L<Catalyst::Action>.
235 Returns the namespace of the current action, i.e., the uri prefix
236 corresponding to the controller of the current action. For example:
238 # in Controller::Foo::Bar
239 $c->namespace; # returns 'foo/bar';
245 Returns the current L<Catalyst::Request> object. See
246 L<Catalyst::Request>.
248 =head2 REQUEST FLOW HANDLING
250 =head2 $c->forward( $action [, \@arguments ] )
252 =head2 $c->forward( $class, $method, [, \@arguments ] )
254 Forwards processing to another action, by it's private name. If you give a
255 class name but no method, C<process()> is called. You may also optionally
256 pass arguments in an arrayref. The action will receive the arguments in
257 C<@_> and C<$c-E<gt>req-E<gt>args>. Upon returning from the function,
258 C<$c-E<gt>req-E<gt>args> will be restored to the previous values.
260 Any data C<return>ed from the action forwarded to, will be returned by the
263 my $foodata = $c->forward('/foo');
264 $c->forward('index');
265 $c->forward(qw/MyApp::Model::DBIC::Foo do_stuff/);
266 $c->forward('MyApp::View::TT');
268 Note that forward implies an C<<eval { }>> around the call (well, actually
269 C<execute> does), thus de-fatalizing all 'dies' within the called action. If
270 you want C<die> to propagate you need to do something like:
273 die $c->error if $c->error;
275 Or make sure to always return true values from your actions and write your code
278 $c->forward('foo') || return;
282 sub forward { my $c = shift; $c->dispatcher->forward( $c, @_ ) }
284 =head2 $c->detach( $action [, \@arguments ] )
286 =head2 $c->detach( $class, $method, [, \@arguments ] )
288 The same as C<forward>, but doesn't return to the previous action when
289 processing is finished.
293 sub detach { my $c = shift; $c->dispatcher->detach( $c, @_ ) }
299 Returns the current L<Catalyst::Response> object.
303 Returns a hashref to the stash, which may be used to store data and pass
304 it between components during a request. You can also set hash keys by
305 passing arguments. The stash is automatically sent to the view. The
306 stash is cleared at the end of a request; it cannot be used for
309 $c->stash->{foo} = $bar;
310 $c->stash( { moose => 'majestic', qux => 0 } );
311 $c->stash( bar => 1, gorch => 2 ); # equivalent to passing a hashref
313 # stash is automatically passed to the view for use in a template
314 $c->forward( 'MyApp::V::TT' );
321 my $stash = @_ > 1 ? {@_} : $_[0];
322 croak('stash takes a hash or hashref') unless ref $stash;
323 foreach my $key ( keys %$stash ) {
324 $c->{stash}->{$key} = $stash->{$key};
332 =head2 $c->error($error, ...)
334 =head2 $c->error($arrayref)
336 Returns an arrayref containing error messages. If Catalyst encounters an
337 error while processing a request, it stores the error in $c->error. This
338 method should not be used to store non-fatal error messages.
340 my @error = @{ $c->error };
344 $c->error('Something bad happened');
351 my $error = ref $_[0] eq 'ARRAY' ? $_[0] : [@_];
352 croak @$error unless ref $c;
353 push @{ $c->{error} }, @$error;
355 elsif ( defined $_[0] ) { $c->{error} = undef }
356 return $c->{error} || [];
362 Contains the return value of the last executed action.
364 =head2 $c->clear_errors
366 Clear errors. You probably don't want to clear the errors unless you are
367 implementing a custom error screen.
369 This is equivalent to running
385 my ( $c, @names ) = @_;
387 foreach my $name (@names) {
388 foreach my $component ( keys %{ $c->components } ) {
389 return $c->components->{$component} if $component =~ /$name/i;
396 # try explicit component names
398 my ( $c, @names ) = @_;
400 foreach my $try (@names) {
401 return $c->components->{$try} if ( exists $c->components->{$try} );
407 # like component, but try just these prefixes before regex searching,
408 # and do not try to return "sort keys %{ $c->components }"
410 my ( $c, $name, @prefixes ) = @_;
412 my $appclass = ref $c || $c;
414 my @names = map { "${appclass}::${_}::${name}" } @prefixes;
416 my $comp = $c->_comp_explicit(@names);
417 return $comp if defined($comp);
418 $comp = $c->_comp_search($name);
422 # Find possible names for a prefix
425 my ( $c, @prefixes ) = @_;
427 my $appclass = ref $c || $c;
429 my @pre = map { "${appclass}::${_}::" } @prefixes;
433 COMPONENT: foreach my $comp ($c->component) {
434 foreach my $p (@pre) {
435 if ($comp =~ s/^$p//) {
445 # Return a component if only one matches.
447 my ( $c, @prefixes ) = @_;
449 my $appclass = ref $c || $c;
451 my ( $comp, $rest ) =
452 map { $c->_comp_search("^${appclass}::${_}::") } @prefixes;
453 return $comp unless $rest;
456 # Filter a component before returning by calling ACCEPT_CONTEXT if available
457 sub _filter_component {
458 my ( $c, $comp, @args ) = @_;
459 if ( eval { $comp->can('ACCEPT_CONTEXT'); } ) {
460 return $comp->ACCEPT_CONTEXT( $c, @args );
462 else { return $comp }
465 =head2 COMPONENT ACCESSORS
467 =head2 $c->controller($name)
469 Gets a L<Catalyst::Controller> instance by name.
471 $c->controller('Foo')->do_stuff;
473 If name is omitted, will return the controller for the dispatched action.
478 my ( $c, $name, @args ) = @_;
479 return $c->_filter_component( $c->_comp_prefixes( $name, qw/Controller C/ ),
482 return $c->component( $c->action->class );
485 =head2 $c->model($name)
487 Gets a L<Catalyst::Model> instance by name.
489 $c->model('Foo')->do_stuff;
491 If the name is omitted, it will look for a config setting 'default_model',
492 or check if there is only one view, and return it if that's the case.
497 my ( $c, $name, @args ) = @_;
498 return $c->_filter_component( $c->_comp_prefixes( $name, qw/Model M/ ),
501 return $c->component( $c->config->{default_model} )
502 if $c->config->{default_model};
503 return $c->_filter_component( $c->_comp_singular(qw/Model M/), @args );
507 =head2 $c->controllers
509 Returns the available names which can be passed to $c->controller
515 return $c->_comp_names(qw/Controller C/);
519 =head2 $c->view($name)
521 Gets a L<Catalyst::View> instance by name.
523 $c->view('Foo')->do_stuff;
525 If the name is omitted, it will look for a config setting 'default_view',
526 or check if there is only one view, and forward to it if that's the case.
531 my ( $c, $name, @args ) = @_;
532 return $c->_filter_component( $c->_comp_prefixes( $name, qw/View V/ ),
535 return $c->component( $c->config->{default_view} )
536 if $c->config->{default_view};
537 return $c->_filter_component( $c->_comp_singular(qw/View V/) );
542 Returns the available names which can be passed to $c->model
548 return $c->_comp_names(qw/Model M/);
554 Returns the available names which can be passed to $c->view
560 return $c->_comp_names(qw/View V/);
563 =head2 $c->comp($name)
565 =head2 $c->component($name)
567 Gets a component object by name. This method is no longer recommended,
568 unless you want to get a specific component by full
569 class. C<$c-E<gt>controller>, C<$c-E<gt>model>, and C<$c-E<gt>view>
570 should be used instead.
581 my $appclass = ref $c || $c;
584 $name, "${appclass}::${name}",
585 map { "${appclass}::${_}::${name}" }
586 qw/Model M Controller C View V/
589 my $comp = $c->_comp_explicit(@names);
590 return $c->_filter_component( $comp, @_ ) if defined($comp);
592 $comp = $c->_comp_search($name);
593 return $c->_filter_component( $comp, @_ ) if defined($comp);
596 return sort keys %{ $c->components };
601 =head2 CLASS DATA AND HELPER CLASSES
605 Returns or takes a hashref containing the application's configuration.
607 __PACKAGE__->config( { db => 'dsn:SQLite:foo.db' } );
609 You can also use a L<YAML> config file like myapp.yml in your
610 applications home directory.
613 db: dsn:SQLite:foo.db
621 $c->log->warn("Setting config after setup has been run is not a good idea.")
622 if ( @_ and $c->setup_finished );
624 $c->NEXT::config(@_);
629 Returns the logging object instance. Unless it is already set, Catalyst sets
630 this up with a L<Catalyst::Log> object. To use your own log class, set the
631 logger with the C<< __PACKAGE__->log >> method prior to calling
632 C<< __PACKAGE__->setup >>.
634 __PACKAGE__->log( MyLogger->new );
639 $c->log->info( 'Now logging with my own logger!' );
641 Your log class should implement the methods described in the
642 L<Catalyst::Log> man page.
647 Overload to enable debug messages (same as -Debug option).
649 Note that this is a static method, not an accessor and should be overloaded
650 by declaring "sub debug { 1 }" in your MyApp.pm, not by calling $c->debug(1).
656 =head2 $c->dispatcher
658 Returns the dispatcher instance. Stringifies to class name. See
659 L<Catalyst::Dispatcher>.
663 Returns the engine instance. Stringifies to the class name. See
667 =head2 UTILITY METHODS
669 =head2 $c->path_to(@path)
671 Merges C<@path> with C<$c-E<gt>config-E<gt>{home}> and returns a
672 L<Path::Class> object.
676 $c->path_to( 'db', 'sqlite.db' );
681 my ( $c, @path ) = @_;
682 my $path = Path::Class::Dir->new( $c->config->{home}, @path );
683 if ( -d $path ) { return $path }
684 else { return Path::Class::File->new( $c->config->{home}, @path ) }
687 =head2 $c->plugin( $name, $class, @args )
689 Helper method for plugins. It creates a classdata accessor/mutator and
690 loads and instantiates the given class.
692 MyApp->plugin( 'prototype', 'HTML::Prototype' );
694 $c->prototype->define_javascript_functions;
699 my ( $class, $name, $plugin, @args ) = @_;
700 $class->_register_plugin( $plugin, 1 );
702 eval { $plugin->import };
703 $class->mk_classdata($name);
705 eval { $obj = $plugin->new(@args) };
708 Catalyst::Exception->throw( message =>
709 qq/Couldn't instantiate instant plugin "$plugin", "$@"/ );
713 $class->log->debug(qq/Initialized instant plugin "$plugin" as "$name"/)
719 Initializes the dispatcher and engine, loads any plugins, and loads the
720 model, view, and controller components. You may also specify an array
721 of plugins to load here, if you choose to not load them in the C<use
725 MyApp->setup( qw/-Debug/ );
730 my ( $class, @arguments ) = @_;
732 $class->log->warn("Running setup twice is not a good idea.")
733 if ( $class->setup_finished );
735 unless ( $class->isa('Catalyst') ) {
737 Catalyst::Exception->throw(
738 message => qq/'$class' does not inherit from Catalyst/ );
741 if ( $class->arguments ) {
742 @arguments = ( @arguments, @{ $class->arguments } );
748 foreach (@arguments) {
752 ( $flags->{log} ) ? 'debug,' . $flags->{log} : 'debug';
754 elsif (/^-(\w+)=?(.*)$/) {
755 $flags->{ lc $1 } = $2;
758 push @{ $flags->{plugins} }, $_;
762 $class->setup_home( delete $flags->{home} );
764 $class->setup_log( delete $flags->{log} );
765 $class->setup_plugins( delete $flags->{plugins} );
766 $class->setup_dispatcher( delete $flags->{dispatcher} );
767 $class->setup_engine( delete $flags->{engine} );
769 for my $flag ( sort keys %{$flags} ) {
771 if ( my $code = $class->can( 'setup_' . $flag ) ) {
772 &$code( $class, delete $flags->{$flag} );
775 $class->log->warn(qq/Unknown flag "$flag"/);
779 eval { require Catalyst::Devel; };
780 if( !$@ && $ENV{CATALYST_SCRIPT_GEN} && ( $ENV{CATALYST_SCRIPT_GEN} < $Catalyst::Devel::CATALYST_SCRIPT_GEN ) ) {
781 $class->log->warn(<<"EOF");
782 You are running an old script!
784 Please update by running (this will overwrite existing files):
785 catalyst.pl -force -scripts $class
787 or (this will not overwrite existing files):
788 catalyst.pl -scripts $class
792 if ( $class->debug ) {
799 map { $_ . ' ' . ( $_->VERSION || '' ) }
800 grep { /^Catalyst::Plugin/ } @{"$class\::ISA"};
804 my $t = Text::SimpleTable->new(74);
805 $t->row($_) for @plugins;
806 $class->log->debug( "Loaded plugins:\n" . $t->draw );
809 my $dispatcher = $class->dispatcher;
810 my $engine = $class->engine;
811 my $home = $class->config->{home};
813 $class->log->debug(qq/Loaded dispatcher "$dispatcher"/);
814 $class->log->debug(qq/Loaded engine "$engine"/);
818 ? $class->log->debug(qq/Found home "$home"/)
819 : $class->log->debug(qq/Home "$home" doesn't exist/)
820 : $class->log->debug(q/Couldn't find home/);
825 no warnings qw/redefine/;
826 local *setup = sub { };
830 # Initialize our data structure
831 $class->components( {} );
833 $class->setup_components;
835 if ( $class->debug ) {
836 my $t = Text::SimpleTable->new( [ 63, 'Class' ], [ 8, 'Type' ] );
837 for my $comp ( sort keys %{ $class->components } ) {
838 my $type = ref $class->components->{$comp} ? 'instance' : 'class';
839 $t->row( $comp, $type );
841 $class->log->debug( "Loaded components:\n" . $t->draw )
842 if ( keys %{ $class->components } );
845 # Add our self to components, since we are also a component
846 $class->components->{$class} = $class;
848 $class->setup_actions;
850 if ( $class->debug ) {
851 my $name = $class->config->{name} || 'Application';
852 $class->log->info("$name powered by Catalyst $Catalyst::VERSION");
854 $class->log->_flush() if $class->log->can('_flush');
856 $class->setup_finished(1);
859 =head2 $c->uri_for( $path, @args?, \%query_values? )
861 Merges path with C<$c-E<gt>request-E<gt>base> for absolute uri's and
862 with C<$c-E<gt>namespace> for relative uri's, then returns a
863 normalized L<URI> object. If any args are passed, they are added at the
864 end of the path. If the last argument to uri_for is a hash reference,
865 it is assumed to contain GET parameter key/value pairs, which will be
866 appended to the URI in standard fashion.
868 Instead of $path, you can also optionally pass a $action object which will
869 be resolved to a path using $c->dispatcher->uri_for_action; if the first
870 element of @args is an arrayref it is treated as a list of captures to be
871 passed to uri_for_action.
876 my ( $c, $path, @args ) = @_;
877 my $base = $c->request->base->clone;
878 my $basepath = $base->path;
879 $basepath =~ s/\/$//;
881 my $namespace = $c->namespace || '';
883 if ( Scalar::Util::blessed($path) ) { # action object
884 my $captures = ( scalar @args && ref $args[0] eq 'ARRAY'
887 $path = $c->dispatcher->uri_for_action($path, $captures);
888 return undef unless defined($path);
891 # massage namespace, empty if absolute path
892 $namespace =~ s/^\/// if $namespace;
893 $namespace .= '/' if $namespace;
895 $namespace = '' if $path =~ /^\//;
899 ( scalar @args && ref $args[$#args] eq 'HASH' ? pop @args : {} );
901 for my $value ( values %$params ) {
\r
902 my $isa_ref = ref $value;
\r
903 if( $isa_ref and $isa_ref ne 'ARRAY' ) {
\r
904 croak( "Non-array reference ($isa_ref) passed to uri_for()" );
\r
906 utf8::encode( $_ ) for grep { defined } $isa_ref ? @$value : $value;
\r
909 # join args with '/', or a blank string
910 my $args = ( scalar @args ? '/' . join( '/', @args ) : '' );
911 $args =~ s/^\/// unless $path;
913 URI->new_abs( URI->new_abs( "$path$args", "$basepath$namespace" ), $base )
915 $res->query_form(%$params);
919 =head2 $c->welcome_message
921 Returns the Catalyst welcome HTML page.
925 sub welcome_message {
927 my $name = $c->config->{name};
928 my $logo = $c->uri_for('/static/images/catalyst_logo.png');
929 my $prefix = Catalyst::Utils::appprefix( ref $c );
930 $c->response->content_type('text/html; charset=utf-8');
932 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
933 "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
934 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
936 <meta http-equiv="Content-Language" content="en" />
937 <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
938 <title>$name on Catalyst $VERSION</title>
939 <style type="text/css">
942 background-color: #eee;
951 background-color: #ccc;
952 border: 1px solid #aaa;
957 font-family: verdana, tahoma, sans-serif;
960 font-family: verdana, tahoma, sans-serif;
963 text-decoration: none;
965 border-bottom: 1px dotted #bbb;
967 :link:hover, :visited:hover {
980 background-color: #fff;
981 border: 1px solid #aaa;
1007 <h1><span id="appname">$name</span> on <a href="http://catalyst.perl.org">Catalyst</a>
1012 <img src="$logo" alt="Catalyst Logo" />
1014 <p>Welcome to the wonderful world of Catalyst.
1015 This <a href="http://en.wikipedia.org/wiki/MVC">MVC</a>
1016 framework will make web development something you had
1017 never expected it to be: Fun, rewarding, and quick.</p>
1018 <h2>What to do now?</h2>
1019 <p>That really depends on what <b>you</b> want to do.
1020 We do, however, provide you with a few starting points.</p>
1021 <p>If you want to jump right into web development with Catalyst
1022 you might want to check out the documentation.</p>
1023 <pre><code>perldoc <a href="http://cpansearch.perl.org/dist/Catalyst/lib/Catalyst/Manual/Intro.pod">Catalyst::Manual::Intro</a>
1024 perldoc <a href="http://cpansearch.perl.org/dist/Catalyst/lib/Catalyst/Manual/Tutorial.pod">Catalyst::Manual::Tutorial</a></code>
1025 perldoc <a href="http://cpansearch.perl.org/dist/Catalyst/lib/Catalyst/Manual.pod">Catalyst::Manual</a></code></pre>
1026 <h2>What to do next?</h2>
1027 <p>Next it's time to write an actual application. Use the
1028 helper scripts to generate <a href="http://cpansearch.perl.org/search?query=Catalyst%3A%3AController%3A%3A&mode=all">controllers</a>,
1029 <a href="http://cpansearch.perl.org/search?query=Catalyst%3A%3AModel%3A%3A&mode=all">models</a>, and
1030 <a href="http://cpansearch.perl.org/search?query=Catalyst%3A%3AView%3A%3A&mode=all">views</a>;
1031 they can save you a lot of work.</p>
1032 <pre><code>script/${prefix}_create.pl -help</code></pre>
1033 <p>Also, be sure to check out the vast and growing
1034 collection of <a href="http://cpansearch.perl.org/search?query=Catalyst%3A%3APlugin%3A%3A&mode=all">plugins for Catalyst on CPAN</a>;
1035 you are likely to find what you need there.
1039 <p>Catalyst has a very active community. Here are the main places to
1040 get in touch with us.</p>
1043 <a href="http://dev.catalyst.perl.org">Wiki</a>
1046 <a href="http://lists.rawmode.org/mailman/listinfo/catalyst">Mailing-List</a>
1049 <a href="irc://irc.perl.org/catalyst">IRC channel #catalyst on irc.perl.org</a>
1052 <h2>In conclusion</h2>
1053 <p>The Catalyst team hopes you will enjoy using Catalyst as much
1054 as we enjoyed making it. Please contact us if you have ideas
1055 for improvement or other feedback.</p>
1063 =head1 INTERNAL METHODS
1065 These methods are not meant to be used by end users.
1067 =head2 $c->components
1069 Returns a hash of components.
1071 =head2 $c->context_class
1073 Returns or sets the context class.
1077 Returns a hashref containing coderefs and execution counts (needed for
1078 deep recursion detection).
1082 Returns the number of actions on the current internal execution stack.
1086 Dispatches a request to actions.
1090 sub dispatch { my $c = shift; $c->dispatcher->dispatch( $c, @_ ) }
1092 =head2 $c->dispatcher_class
1094 Returns or sets the dispatcher class.
1096 =head2 $c->dump_these
1098 Returns a list of 2-element array references (name, structure) pairs
1099 that will be dumped on the error page in debug mode.
1105 [ Request => $c->req ],
1106 [ Response => $c->res ],
1107 [ Stash => $c->stash ],
1108 [ Config => $c->config ];
1111 =head2 $c->engine_class
1113 Returns or sets the engine class.
1115 =head2 $c->execute( $class, $coderef )
1117 Execute a coderef in given class and catch exceptions. Errors are available
1123 my ( $c, $class, $code ) = @_;
1124 $class = $c->component($class) || $class;
1127 if ( $c->depth >= $RECURSION ) {
1128 my $action = "$code";
1129 $action = "/$action" unless $action =~ /\-\>/;
1130 my $error = qq/Deep recursion detected calling "$action"/;
1131 $c->log->error($error);
1137 my $stats_info = $c->_stats_start_execute( $code );
1139 push( @{ $c->stack }, $code );
1141 eval { $c->state( &$code( $class, $c, @{ $c->req->args } ) || 0 ) };
1143 $c->_stats_finish_execute( $stats_info );
1145 my $last = ${ $c->stack }[-1];
1146 pop( @{ $c->stack } );
1148 if ( my $error = $@ ) {
1149 if ( $error eq $DETACH ) { die $DETACH if $c->depth > 1 }
1151 unless ( ref $error ) {
1153 my $class = $last->class;
1154 my $name = $last->name;
1155 $error = qq/Caught exception in $class->$name "$error"/;
1164 sub _stats_start_execute {
1165 my ( $c, $code ) = @_;
1167 return unless $c->debug;
1169 my $action = "$code";
1171 $action = "/$action" unless $action =~ /\-\>/;
1172 $c->counter->{"$code"}++;
1174 # determine if the call was the result of a forward
1175 # this is done by walking up the call stack and looking for a calling
1176 # sub of Catalyst::forward before the eval
1178 for my $index ( 2 .. 11 ) {
1180 if ( ( caller($index) )[0] eq 'Catalyst'
1181 && ( caller($index) )[3] eq '(eval)' );
1183 if ( ( caller($index) )[3] =~ /forward$/ ) {
1184 $callsub = ( caller($index) )[3];
1185 $action = "-> $action";
1190 my $node = Tree::Simple->new(
1193 elapsed => undef, # to be filled in later
1197 $node->setUID( "$code" . $c->counter->{"$code"} );
1199 unless ( ( $code->name =~ /^_.*/ )
1200 && ( !$c->config->{show_internal_actions} ) )
1202 # is this a root-level call or a forwarded call?
1203 if ( $callsub =~ /forward$/ ) {
1205 # forward, locate the caller
1206 if ( my $parent = $c->stack->[-1] ) {
1207 my $visitor = Tree::Simple::Visitor::FindByUID->new;
1208 $visitor->searchForUID(
1209 "$parent" . $c->counter->{"$parent"} );
1210 $c->stats->accept($visitor);
1211 if ( my $result = $visitor->getResult ) {
1212 $result->addChild($node);
1217 # forward with no caller may come from a plugin
1218 $c->stats->addChild($node);
1224 $c->stats->addChild($node);
1228 my $start = [gettimeofday];
1229 my $elapsed = tv_interval($start);
1233 elapsed => $elapsed,
1239 sub _stats_finish_execute {
1240 my ( $c, $info ) = @_;
1242 return unless $c->debug;
1244 my ( $code, $start, $elapsed ) = @{ $info }{qw/code start elapsed/};
1246 unless ( ( $code->name =~ /^_.*/ )
1247 && ( !$c->config->{show_internal_actions} ) )
1250 # FindByUID uses an internal die, so we save the existing error
1253 # locate the node in the tree and update the elapsed time
1254 my $visitor = Tree::Simple::Visitor::FindByUID->new;
1255 $visitor->searchForUID( "$code" . $c->counter->{"$code"} );
1256 $c->stats->accept($visitor);
1257 if ( my $result = $visitor->getResult ) {
1258 my $value = $result->getNodeValue;
1259 $value->{elapsed} = sprintf( '%fs', $elapsed );
1260 $result->setNodeValue($value);
1264 $@ = $error || undef;
1268 =head2 $c->_localize_fields( sub { }, \%keys );
1272 sub _localize_fields {
1273 my ( $c, $localized, $code ) = ( @_ );
1275 my $request = delete $localized->{request} || {};
1276 my $response = delete $localized->{response} || {};
1278 local @{ $c }{ keys %$localized } = values %$localized;
1279 local @{ $c->request }{ keys %$request } = values %$request;
1280 local @{ $c->response }{ keys %$response } = values %$response;
1287 Finalizes the request.
1294 for my $error ( @{ $c->error } ) {
1295 $c->log->error($error);
1298 # Allow engine to handle finalize flow (for POE)
1299 if ( $c->engine->can('finalize') ) {
1300 $c->engine->finalize($c);
1304 $c->finalize_uploads;
1307 if ( $#{ $c->error } >= 0 ) {
1311 $c->finalize_headers;
1314 if ( $c->request->method eq 'HEAD' ) {
1315 $c->response->body('');
1321 return $c->response->status;
1324 =head2 $c->finalize_body
1330 sub finalize_body { my $c = shift; $c->engine->finalize_body( $c, @_ ) }
1332 =head2 $c->finalize_cookies
1338 sub finalize_cookies { my $c = shift; $c->engine->finalize_cookies( $c, @_ ) }
1340 =head2 $c->finalize_error
1346 sub finalize_error { my $c = shift; $c->engine->finalize_error( $c, @_ ) }
1348 =head2 $c->finalize_headers
1354 sub finalize_headers {
1357 # Check if we already finalized headers
1358 return if $c->response->{_finalized_headers};
1361 if ( my $location = $c->response->redirect ) {
1362 $c->log->debug(qq/Redirecting to "$location"/) if $c->debug;
1363 $c->response->header( Location => $location );
1367 if ( $c->response->body && !$c->response->content_length ) {
1369 # get the length from a filehandle
1370 if ( blessed( $c->response->body ) && $c->response->body->can('read') )
1372 if ( my $stat = stat $c->response->body ) {
1373 $c->response->content_length( $stat->size );
1376 $c->log->warn('Serving filehandle without a content-length');
1380 $c->response->content_length( bytes::length( $c->response->body ) );
1385 if ( $c->response->status =~ /^(1\d\d|[23]04)$/ ) {
1386 $c->response->headers->remove_header("Content-Length");
1387 $c->response->body('');
1390 $c->finalize_cookies;
1392 $c->engine->finalize_headers( $c, @_ );
1395 $c->response->{_finalized_headers} = 1;
1398 =head2 $c->finalize_output
1400 An alias for finalize_body.
1402 =head2 $c->finalize_read
1404 Finalizes the input after reading is complete.
1408 sub finalize_read { my $c = shift; $c->engine->finalize_read( $c, @_ ) }
1410 =head2 $c->finalize_uploads
1412 Finalizes uploads. Cleans up any temporary files.
1416 sub finalize_uploads { my $c = shift; $c->engine->finalize_uploads( $c, @_ ) }
1418 =head2 $c->get_action( $action, $namespace )
1420 Gets an action in a given namespace.
1424 sub get_action { my $c = shift; $c->dispatcher->get_action(@_) }
1426 =head2 $c->get_actions( $action, $namespace )
1428 Gets all actions of a given name in a namespace and all parent
1433 sub get_actions { my $c = shift; $c->dispatcher->get_actions( $c, @_ ) }
1435 =head2 $c->handle_request( $class, @arguments )
1437 Called to handle each HTTP request.
1441 sub handle_request {
1442 my ( $class, @arguments ) = @_;
1444 # Always expect worst case!
1447 my $stats = ( $class->debug ) ? Tree::Simple->new: q{};
1450 my $c = $class->prepare(@arguments);
1453 return $c->finalize;
1456 if ( $class->debug ) {
1457 my $start = [gettimeofday];
1458 $status = &$handler;
1459 my $elapsed = tv_interval $start;
1460 $elapsed = sprintf '%f', $elapsed;
1461 my $av = sprintf '%.3f',
1462 ( $elapsed == 0 ? '??' : ( 1 / $elapsed ) );
1463 my $t = Text::SimpleTable->new( [ 62, 'Action' ], [ 9, 'Time' ] );
1468 my $stat = $action->getNodeValue;
1469 $t->row( ( q{ } x $action->getDepth ) . $stat->{action} . $stat->{comment},
1470 $stat->{elapsed} || '??' );
1475 "Request took ${elapsed}s ($av/s)\n" . $t->draw );
1477 else { $status = &$handler }
1481 if ( my $error = $@ ) {
1483 $class->log->error(qq/Caught exception in engine "$error"/);
1487 $class->log->_flush() if $class->log->can('_flush');
1491 =head2 $c->prepare( @arguments )
1493 Creates a Catalyst context from an engine-specific request (Apache, CGI,
1499 my ( $class, @arguments ) = @_;
1501 $class->context_class( ref $class || $class ) unless $class->context_class;
1502 my $c = $class->context_class->new(
1506 request => $class->request_class->new(
1509 body_parameters => {},
1511 headers => HTTP::Headers->new,
1513 query_parameters => {},
1519 response => $class->response_class->new(
1523 headers => HTTP::Headers->new(),
1532 # For on-demand data
1533 $c->request->{_context} = $c;
1534 $c->response->{_context} = $c;
1535 weaken( $c->request->{_context} );
1536 weaken( $c->response->{_context} );
1539 my $secs = time - $START || 1;
1540 my $av = sprintf '%.3f', $COUNT / $secs;
1541 my $time = localtime time;
1542 $c->log->info("*** Request $COUNT ($av/s) [$$] [$time] ***");
1543 $c->res->headers->header( 'X-Catalyst' => $Catalyst::VERSION );
1546 # Allow engine to direct the prepare flow (for POE)
1547 if ( $c->engine->can('prepare') ) {
1548 $c->engine->prepare( $c, @arguments );
1551 $c->prepare_request(@arguments);
1552 $c->prepare_connection;
1553 $c->prepare_query_parameters;
1554 $c->prepare_headers;
1555 $c->prepare_cookies;
1559 $c->prepare_body unless $c->config->{parse_on_demand};
1562 my $method = $c->req->method || '';
1563 my $path = $c->req->path || '/';
1564 my $address = $c->req->address || '';
1566 $c->log->debug(qq/"$method" request for "$path" from "$address"/)
1574 =head2 $c->prepare_action
1576 Prepares action. See L<Catalyst::Dispatcher>.
1580 sub prepare_action { my $c = shift; $c->dispatcher->prepare_action( $c, @_ ) }
1582 =head2 $c->prepare_body
1584 Prepares message body.
1591 # Do we run for the first time?
1592 return if defined $c->request->{_body};
1594 # Initialize on-demand data
1595 $c->engine->prepare_body( $c, @_ );
1596 $c->prepare_parameters;
1597 $c->prepare_uploads;
1599 if ( $c->debug && keys %{ $c->req->body_parameters } ) {
1600 my $t = Text::SimpleTable->new( [ 35, 'Parameter' ], [ 36, 'Value' ] );
1601 for my $key ( sort keys %{ $c->req->body_parameters } ) {
1602 my $param = $c->req->body_parameters->{$key};
1603 my $value = defined($param) ? $param : '';
1605 ref $value eq 'ARRAY' ? ( join ', ', @$value ) : $value );
1607 $c->log->debug( "Body Parameters are:\n" . $t->draw );
1611 =head2 $c->prepare_body_chunk( $chunk )
1613 Prepares a chunk of data before sending it to L<HTTP::Body>.
1615 See L<Catalyst::Engine>.
1619 sub prepare_body_chunk {
1621 $c->engine->prepare_body_chunk( $c, @_ );
1624 =head2 $c->prepare_body_parameters
1626 Prepares body parameters.
1630 sub prepare_body_parameters {
1632 $c->engine->prepare_body_parameters( $c, @_ );
1635 =head2 $c->prepare_connection
1637 Prepares connection.
1641 sub prepare_connection {
1643 $c->engine->prepare_connection( $c, @_ );
1646 =head2 $c->prepare_cookies
1652 sub prepare_cookies { my $c = shift; $c->engine->prepare_cookies( $c, @_ ) }
1654 =head2 $c->prepare_headers
1660 sub prepare_headers { my $c = shift; $c->engine->prepare_headers( $c, @_ ) }
1662 =head2 $c->prepare_parameters
1664 Prepares parameters.
1668 sub prepare_parameters {
1670 $c->prepare_body_parameters;
1671 $c->engine->prepare_parameters( $c, @_ );
1674 =head2 $c->prepare_path
1676 Prepares path and base.
1680 sub prepare_path { my $c = shift; $c->engine->prepare_path( $c, @_ ) }
1682 =head2 $c->prepare_query_parameters
1684 Prepares query parameters.
1688 sub prepare_query_parameters {
1691 $c->engine->prepare_query_parameters( $c, @_ );
1693 if ( $c->debug && keys %{ $c->request->query_parameters } ) {
1694 my $t = Text::SimpleTable->new( [ 35, 'Parameter' ], [ 36, 'Value' ] );
1695 for my $key ( sort keys %{ $c->req->query_parameters } ) {
1696 my $param = $c->req->query_parameters->{$key};
1697 my $value = defined($param) ? $param : '';
1699 ref $value eq 'ARRAY' ? ( join ', ', @$value ) : $value );
1701 $c->log->debug( "Query Parameters are:\n" . $t->draw );
1705 =head2 $c->prepare_read
1707 Prepares the input for reading.
1711 sub prepare_read { my $c = shift; $c->engine->prepare_read( $c, @_ ) }
1713 =head2 $c->prepare_request
1715 Prepares the engine request.
1719 sub prepare_request { my $c = shift; $c->engine->prepare_request( $c, @_ ) }
1721 =head2 $c->prepare_uploads
1727 sub prepare_uploads {
1730 $c->engine->prepare_uploads( $c, @_ );
1732 if ( $c->debug && keys %{ $c->request->uploads } ) {
1733 my $t = Text::SimpleTable->new(
1734 [ 12, 'Parameter' ],
1739 for my $key ( sort keys %{ $c->request->uploads } ) {
1740 my $upload = $c->request->uploads->{$key};
1741 for my $u ( ref $upload eq 'ARRAY' ? @{$upload} : ($upload) ) {
1742 $t->row( $key, $u->filename, $u->type, $u->size );
1745 $c->log->debug( "File Uploads are:\n" . $t->draw );
1749 =head2 $c->prepare_write
1751 Prepares the output for writing.
1755 sub prepare_write { my $c = shift; $c->engine->prepare_write( $c, @_ ) }
1757 =head2 $c->request_class
1759 Returns or sets the request class.
1761 =head2 $c->response_class
1763 Returns or sets the response class.
1765 =head2 $c->read( [$maxlength] )
1767 Reads a chunk of data from the request body. This method is designed to
1768 be used in a while loop, reading C<$maxlength> bytes on every call.
1769 C<$maxlength> defaults to the size of the request if not specified.
1771 You have to set C<MyApp-E<gt>config-E<gt>{parse_on_demand}> to use this
1776 sub read { my $c = shift; return $c->engine->read( $c, @_ ) }
1784 sub run { my $c = shift; return $c->engine->run( $c, @_ ) }
1786 =head2 $c->set_action( $action, $code, $namespace, $attrs )
1788 Sets an action in a given namespace.
1792 sub set_action { my $c = shift; $c->dispatcher->set_action( $c, @_ ) }
1794 =head2 $c->setup_actions($component)
1796 Sets up actions for a component.
1800 sub setup_actions { my $c = shift; $c->dispatcher->setup_actions( $c, @_ ) }
1802 =head2 $c->setup_components
1808 sub setup_components {
1811 my $callback = sub {
1812 my ( $component, $context ) = @_;
1814 unless ( $component->can('COMPONENT') ) {
1818 my $suffix = Catalyst::Utils::class2classsuffix($component);
1819 my $config = $class->config->{$suffix} || {};
1823 eval { $instance = $component->COMPONENT( $context, $config ); };
1825 if ( my $error = $@ ) {
1829 Catalyst::Exception->throw( message =>
1830 qq/Couldn't instantiate component "$component", "$error"/ );
1833 Catalyst::Exception->throw( message =>
1834 qq/Couldn't instantiate component "$component", "COMPONENT() didn't return a object"/
1836 unless ref $instance;
1840 eval "package $class;\n" . q!Module::Pluggable::Fast->import(
1841 name => '_catalyst_components',
1843 "$class\::Controller", "$class\::C",
1844 "$class\::Model", "$class\::M",
1845 "$class\::View", "$class\::V"
1847 callback => $callback
1851 if ( my $error = $@ ) {
1855 Catalyst::Exception->throw(
1856 message => qq/Couldn't load components "$error"/ );
1859 for my $component ( $class->_catalyst_components($class) ) {
1860 $class->components->{ ref $component || $component } = $component;
1864 =head2 $c->setup_dispatcher
1870 sub setup_dispatcher {
1871 my ( $class, $dispatcher ) = @_;
1874 $dispatcher = 'Catalyst::Dispatcher::' . $dispatcher;
1877 if ( $ENV{CATALYST_DISPATCHER} ) {
1878 $dispatcher = 'Catalyst::Dispatcher::' . $ENV{CATALYST_DISPATCHER};
1881 if ( $ENV{ uc($class) . '_DISPATCHER' } ) {
1883 'Catalyst::Dispatcher::' . $ENV{ uc($class) . '_DISPATCHER' };
1886 unless ($dispatcher) {
1887 $dispatcher = $class->dispatcher_class;
1890 unless (Class::Inspector->loaded($dispatcher)) {
1891 require Class::Inspector->filename($dispatcher);
1894 # dispatcher instance
1895 $class->dispatcher( $dispatcher->new );
1898 =head2 $c->setup_engine
1905 my ( $class, $engine ) = @_;
1908 $engine = 'Catalyst::Engine::' . $engine;
1911 if ( $ENV{CATALYST_ENGINE} ) {
1912 $engine = 'Catalyst::Engine::' . $ENV{CATALYST_ENGINE};
1915 if ( $ENV{ uc($class) . '_ENGINE' } ) {
1916 $engine = 'Catalyst::Engine::' . $ENV{ uc($class) . '_ENGINE' };
1919 if ( $ENV{MOD_PERL} ) {
1921 # create the apache method
1924 *{"$class\::apache"} = sub { shift->engine->apache };
1927 my ( $software, $version ) =
1928 $ENV{MOD_PERL} =~ /^(\S+)\/(\d+(?:[\.\_]\d+)+)/;
1931 $version =~ s/(\.[^.]+)\./$1/g;
1933 if ( $software eq 'mod_perl' ) {
1937 if ( $version >= 1.99922 ) {
1938 $engine = 'Catalyst::Engine::Apache2::MP20';
1941 elsif ( $version >= 1.9901 ) {
1942 $engine = 'Catalyst::Engine::Apache2::MP19';
1945 elsif ( $version >= 1.24 ) {
1946 $engine = 'Catalyst::Engine::Apache::MP13';
1950 Catalyst::Exception->throw( message =>
1951 qq/Unsupported mod_perl version: $ENV{MOD_PERL}/ );
1956 # install the correct mod_perl handler
1957 if ( $version >= 1.9901 ) {
1958 *handler = sub : method {
1959 shift->handle_request(@_);
1963 *handler = sub ($$) { shift->handle_request(@_) };
1968 elsif ( $software eq 'Zeus-Perl' ) {
1969 $engine = 'Catalyst::Engine::Zeus';
1973 Catalyst::Exception->throw(
1974 message => qq/Unsupported mod_perl: $ENV{MOD_PERL}/ );
1979 $engine = $class->engine_class;
1982 unless (Class::Inspector->loaded($engine)) {
1983 require Class::Inspector->filename($engine);
1986 # check for old engines that are no longer compatible
1988 if ( $engine->isa('Catalyst::Engine::Apache')
1989 && !Catalyst::Engine::Apache->VERSION )
1994 elsif ( $engine->isa('Catalyst::Engine::Server::Base')
1995 && Catalyst::Engine::Server->VERSION le '0.02' )
2000 elsif ($engine->isa('Catalyst::Engine::HTTP::POE')
2001 && $engine->VERSION eq '0.01' )
2006 elsif ($engine->isa('Catalyst::Engine::Zeus')
2007 && $engine->VERSION eq '0.01' )
2013 Catalyst::Exception->throw( message =>
2014 qq/Engine "$engine" is not supported by this version of Catalyst/
2019 $class->engine( $engine->new );
2022 =head2 $c->setup_home
2024 Sets up the home directory.
2029 my ( $class, $home ) = @_;
2031 if ( $ENV{CATALYST_HOME} ) {
2032 $home = $ENV{CATALYST_HOME};
2035 if ( $ENV{ uc($class) . '_HOME' } ) {
2036 $home = $ENV{ uc($class) . '_HOME' };
2040 $home = Catalyst::Utils::home($class);
2044 $class->config->{home} ||= $home;
2045 $class->config->{root} ||= Path::Class::Dir->new($home)->subdir('root');
2049 =head2 $c->setup_log
2056 my ( $class, $debug ) = @_;
2058 unless ( $class->log ) {
2059 $class->log( Catalyst::Log->new );
2062 my $app_flag = Catalyst::Utils::class2env($class) . '_DEBUG';
2065 ( defined( $ENV{CATALYST_DEBUG} ) || defined( $ENV{$app_flag} ) )
2066 ? ( $ENV{CATALYST_DEBUG} || $ENV{$app_flag} )
2071 *{"$class\::debug"} = sub { 1 };
2072 $class->log->debug('Debug messages enabled');
2076 =head2 $c->setup_plugins
2082 =head2 $c->registered_plugins
2084 Returns a sorted list of the plugins which have either been stated in the
2085 import list or which have been added via C<< MyApp->plugin(@args); >>.
2087 If passed a given plugin name, it will report a boolean value indicating
2088 whether or not that plugin is loaded. A fully qualified name is required if
2089 the plugin name does not begin with C<Catalyst::Plugin::>.
2091 if ($c->registered_plugins('Some::Plugin')) {
2099 sub registered_plugins {
2101 return sort keys %{ $proto->_plugins } unless @_;
2103 return 1 if exists $proto->_plugins->{$plugin};
2104 return exists $proto->_plugins->{"Catalyst::Plugin::$plugin"};
2107 sub _register_plugin {
2108 my ( $proto, $plugin, $instant ) = @_;
2109 my $class = ref $proto || $proto;
2111 unless (Class::Inspector->loaded($plugin)) {
2112 require Class::Inspector->filename($plugin);
2115 $proto->_plugins->{$plugin} = 1;
2118 unshift @{"$class\::ISA"}, $plugin;
2124 my ( $class, $plugins ) = @_;
2126 $class->_plugins( {} ) unless $class->_plugins;
2128 for my $plugin ( reverse @$plugins ) {
2130 unless ( $plugin =~ s/\A\+// ) {
2131 $plugin = "Catalyst::Plugin::$plugin";
2134 $class->_register_plugin($plugin);
2141 Returns an arrayref of the internal execution stack (actions that are currently
2144 =head2 $c->write( $data )
2146 Writes $data to the output stream. When using this method directly, you
2147 will need to manually set the C<Content-Length> header to the length of
2148 your output data, if known.
2155 # Finalize headers if someone manually writes output
2156 $c->finalize_headers;
2158 return $c->engine->write( $c, @_ );
2163 Returns the Catalyst version number. Mostly useful for "powered by"
2164 messages in template systems.
2168 sub version { return $Catalyst::VERSION }
2170 =head1 INTERNAL ACTIONS
2172 Catalyst uses internal actions like C<_DISPATCH>, C<_BEGIN>, C<_AUTO>,
2173 C<_ACTION>, and C<_END>. These are by default not shown in the private
2174 action table, but you can make them visible with a config parameter.
2176 MyApp->config->{show_internal_actions} = 1;
2178 =head1 CASE SENSITIVITY
2180 By default Catalyst is not case sensitive, so C<MyApp::C::FOO::Bar> is
2181 mapped to C</foo/bar>. You can activate case sensitivity with a config
2184 MyApp->config->{case_sensitive} = 1;
2186 This causes C<MyApp::C::Foo::Bar> to map to C</Foo/Bar>.
2188 =head1 ON-DEMAND PARSER
2190 The request body is usually parsed at the beginning of a request,
2191 but if you want to handle input yourself or speed things up a bit,
2192 you can enable on-demand parsing with a config parameter.
2194 MyApp->config->{parse_on_demand} = 1;
2196 =head1 PROXY SUPPORT
2198 Many production servers operate using the common double-server approach,
2199 with a lightweight frontend web server passing requests to a larger
2200 backend server. An application running on the backend server must deal
2201 with two problems: the remote user always appears to be C<127.0.0.1> and
2202 the server's hostname will appear to be C<localhost> regardless of the
2203 virtual host that the user connected through.
2205 Catalyst will automatically detect this situation when you are running
2206 the frontend and backend servers on the same machine. The following
2207 changes are made to the request.
2209 $c->req->address is set to the user's real IP address, as read from
2210 the HTTP X-Forwarded-For header.
2212 The host value for $c->req->base and $c->req->uri is set to the real
2213 host, as read from the HTTP X-Forwarded-Host header.
2215 Obviously, your web server must support these headers for this to work.
2217 In a more complex server farm environment where you may have your
2218 frontend proxy server(s) on different machines, you will need to set a
2219 configuration option to tell Catalyst to read the proxied data from the
2222 MyApp->config->{using_frontend_proxy} = 1;
2224 If you do not wish to use the proxy support at all, you may set:
2226 MyApp->config->{ignore_frontend_proxy} = 1;
2228 =head1 THREAD SAFETY
2230 Catalyst has been tested under Apache 2's threading mpm_worker, mpm_winnt,
2231 and the standalone forking HTTP server on Windows. We believe the Catalyst
2232 core to be thread-safe.
2234 If you plan to operate in a threaded environment, remember that all other
2235 modules you are using must also be thread-safe. Some modules, most notably
2236 L<DBD::SQLite>, are not thread-safe.
2242 Join #catalyst on irc.perl.org.
2246 http://lists.rawmode.org/mailman/listinfo/catalyst
2247 http://lists.rawmode.org/mailman/listinfo/catalyst-dev
2251 http://catalyst.perl.org
2255 http://dev.catalyst.perl.org
2259 =head2 L<Task::Catalyst> - All you need to start with Catalyst
2261 =head2 L<Catalyst::Manual> - The Catalyst Manual
2263 =head2 L<Catalyst::Component>, L<Catalyst::Base> - Base classes for components
2265 =head2 L<Catalyst::Engine> - Core engine
2267 =head2 L<Catalyst::Log> - Log class.
2269 =head2 L<Catalyst::Request> - Request object
2271 =head2 L<Catalyst::Response> - Response object
2273 =head2 L<Catalyst::Test> - The test suite.
2345 Sebastian Riedel, C<sri@oook.de>
2349 This library is free software, you can redistribute it and/or modify it under
2350 the same terms as Perl itself.