4 use base 'Catalyst::Component';
6 use UNIVERSAL::require;
7 use Catalyst::Exception;
10 use Catalyst::Request::Upload;
11 use Catalyst::Response;
13 use Catalyst::Controller;
16 use Text::SimpleTable;
18 use Time::HiRes qw/gettimeofday tv_interval/;
20 use Scalar::Util qw/weaken/;
21 use Tree::Simple qw/use_weak_refs/;
22 use Tree::Simple::Visitor::FindByUID;
26 __PACKAGE__->mk_accessors(
27 qw/counter request response state action stack namespace/
30 attributes->import( __PACKAGE__, \&namespace, 'lvalue' );
32 sub depth { scalar @{ shift->stack || [] }; }
39 # For backwards compatibility
40 *finalize_output = \&finalize_body;
45 our $RECURSION = 1000;
46 our $DETACH = "catalyst_detach\n";
48 require Module::Pluggable::Fast;
50 # Helper script generation
51 our $CATALYST_SCRIPT_GEN = 25;
53 __PACKAGE__->mk_classdata($_)
54 for qw/components arguments dispatcher engine log dispatcher_class
55 engine_class context_class request_class response_class/;
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.62';
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 start a new application
91 # add models, views, controllers
92 script/myapp_create.pl model Database DBIC 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 sub foo : Global { # called for /foo, /foo/1, /foo/1/2, etc.
106 my ( $self, $c, @args ) = @_; # args are qw/1 2/ for /foo/1/2
107 $c->stash->{template} = 'foo.tt'; # set the template
108 # lookup something from db -- stash vars are passed to TT
110 MyApp::Model::Database::Foo->search( { country => $args[0] } );
111 if ( $c->req->params->{bar} ) { # access GET or POST parameters
112 $c->forward( 'bar' ); # process another action
113 # do something else after forward returns
117 # The foo.tt TT template can use the stash data from the database
118 [% WHILE (item = data.next) %]
122 # called for /bar/of/soap, /bar/of/soap/10, etc.
123 sub bar : Path('/bar/of/soap') { ... }
125 # called for all actions, from the top-most controller downwards
127 my ( $self, $c ) = @_;
129 $c->res->redirect( '/login' ); # require login
130 return 0; # abort request and go immediately to end()
132 return 1; # success; carry on to next action
135 # called after all actions are finished
137 my ( $self, $c ) = @_;
138 if ( scalar @{ $c->error } ) { ... } # handle errors
139 return if $c->res->body; # already have a response
140 $c->forward( 'MyApp::View::TT' ); # render template
143 ### in MyApp/Controller/Foo.pm
144 # called for /foo/bar
145 sub bar : Local { ... }
147 # called for /blargle
148 sub blargle : Global { ... }
150 # an index action matches /foo, but not /foo/1, etc.
151 sub index : Private { ... }
153 ### in MyApp/Controller/Foo/Bar.pm
154 # called for /foo/bar/baz
155 sub baz : Local { ... }
157 # first MyApp auto is called, then Foo auto, then this
158 sub auto : Private { ... }
160 # powerful regular expression paths are also possible
161 sub details : Regex('^product/(\w+)/details$') {
162 my ( $self, $c ) = @_;
163 # extract the (\w+) from the URI
164 my $product = $c->req->snippets->[0];
167 See L<Catalyst::Manual::Intro> for additional information.
171 The key concept of Catalyst is DRY (Don't Repeat Yourself).
173 See L<Catalyst::Manual> for more documentation.
175 Catalyst plugins can be loaded by naming them as arguments to the "use
176 Catalyst" statement. Omit the C<Catalyst::Plugin::> prefix from the
177 plugin name, i.e., C<Catalyst::Plugin::My::Module> becomes
180 use Catalyst qw/My::Module/;
182 Special flags like C<-Debug> and C<-Engine> can also be specified as
183 arguments when Catalyst is loaded:
185 use Catalyst qw/-Debug My::Module/;
187 The position of plugins and flags in the chain is important, because
188 they are loaded in exactly the order in which they appear.
190 The following flags are supported:
194 Enables debug output.
198 Forces Catalyst to use a specific engine. Omit the
199 C<Catalyst::Engine::> prefix of the engine name, i.e.:
201 use Catalyst qw/-Engine=CGI/;
205 Forces Catalyst to use a specific home directory, e.g.:
207 use Catalyst qw[-Home=/usr/sri];
215 =head2 Information about the current request
219 Returns a L<Catalyst::Action> object for the current action, which
220 stringifies to the action name. See L<Catalyst::Action>.
224 Returns the namespace of the current action, i.e., the uri prefix
225 corresponding to the controller of the current action. For example:
227 # in Controller::Foo::Bar
228 $c->namespace; # returns 'foo/bar';
234 Returns the current L<Catalyst::Request> object. See
235 L<Catalyst::Request>.
237 =head2 Processing and response to the current request
239 =head2 $c->forward( $action [, \@arguments ] )
241 =head2 $c->forward( $class, $method, [, \@arguments ] )
243 Forwards processing to a private action. If you give a class name but no
244 method, C<process()> is called. You may also optionally pass arguments
245 in an arrayref. The action will receive the arguments in C<@_> and
246 C<$c-E<gt>req-E<gt>args>. Upon returning from the function,
247 C<$c-E<gt>req-E<gt>args> will be restored to the previous values.
250 $c->forward('index');
251 $c->forward(qw/MyApp::Model::CDBI::Foo do_stuff/);
252 $c->forward('MyApp::View::TT');
256 sub forward { my $c = shift; $c->dispatcher->forward( $c, @_ ) }
258 =head2 $c->detach( $action [, \@arguments ] )
260 =head2 $c->detach( $class, $method, [, \@arguments ] )
262 The same as C<forward>, but doesn't return.
266 sub detach { my $c = shift; $c->dispatcher->detach( $c, @_ ) }
270 =head2 $c->error($error, ...)
272 =head2 $c->error($arrayref)
274 Returns an arrayref containing error messages. If Catalyst encounters an
275 error while processing a request, it stores the error in $c->error. This
276 method should not be used to store non-fatal error messages.
278 my @error = @{ $c->error };
282 $c->error('Something bad happened');
284 Clear errors. You probably don't want to clear the errors unless you are
285 implementing a custom error screen.
294 my $error = ref $_[0] eq 'ARRAY' ? $_[0] : [@_];
295 push @{ $c->{error} }, @$error;
297 elsif ( defined $_[0] ) { $c->{error} = undef }
298 return $c->{error} || [];
305 Returns the current L<Catalyst::Response> object.
309 Returns a hashref to the stash, which may be used to store data and pass
310 it between components during a request. You can also set hash keys by
311 passing arguments. The stash is automatically sent to the view. The
312 stash is cleared at the end of a request; it cannot be used for
315 $c->stash->{foo} = $bar;
316 $c->stash( { moose => 'majestic', qux => 0 } );
317 $c->stash( bar => 1, gorch => 2 ); # equivalent to passing a hashref
319 # stash is automatically passed to the view for use in a template
320 $c->forward( 'MyApp::V::TT' );
327 my $stash = @_ > 1 ? {@_} : $_[0];
328 while ( my ( $key, $val ) = each %$stash ) {
329 $c->{stash}->{$key} = $val;
337 Contains the return value of the last executed action.
339 =head2 Component Accessors
341 =head2 $c->comp($name)
343 =head2 $c->component($name)
345 Gets a component object by name. This method is no longer recommended,
346 unless you want to get a specific component by full
347 class. C<$c-E<gt>controller>, C<$c-E<gt>model>, and C<$c-E<gt>view>
348 should be used instead.
359 my $appclass = ref $c || $c;
362 $name, "${appclass}::${name}",
363 map { "${appclass}::${_}::${name}" }
364 qw/Model M Controller C View V/
367 foreach my $try (@names) {
369 if ( exists $c->components->{$try} ) {
371 my $comp = $c->components->{$try};
372 if ( ref $comp && $comp->can('ACCEPT_CONTEXT') ) {
373 return $comp->ACCEPT_CONTEXT($c);
375 else { return $comp }
379 foreach my $component ( keys %{ $c->components } ) {
381 $comp = $c->components->{$component} if $component =~ /$name/i;
383 if ( ref $comp && $comp->can('ACCEPT_CONTEXT') ) {
384 return $comp->ACCEPT_CONTEXT($c);
386 else { return $comp }
392 return sort keys %{ $c->components };
395 =head2 $c->controller($name)
397 Gets a L<Catalyst::Controller> instance by name.
399 $c->controller('Foo')->do_stuff;
404 my ( $c, $name ) = @_;
405 my $controller = $c->comp("Controller::$name");
406 return $controller if defined $controller;
407 return $c->comp("C::$name");
410 =head2 $c->model($name)
412 Gets a L<Catalyst::Model> instance by name.
414 $c->model('Foo')->do_stuff;
419 my ( $c, $name ) = @_;
420 my $model = $c->comp("Model::$name");
421 return $model if defined $model;
422 return $c->comp("M::$name");
425 =head2 $c->view($name)
427 Gets a L<Catalyst::View> instance by name.
429 $c->view('Foo')->do_stuff;
434 my ( $c, $name ) = @_;
435 my $view = $c->comp("View::$name");
436 return $view if defined $view;
437 return $c->comp("V::$name");
440 =head2 Class data and helper classes
444 Returns or takes a hashref containing the application's configuration.
446 __PACKAGE__->config({ db => 'dsn:SQLite:foo.db' });
448 You can also use a L<YAML> config file like myapp.yml in your
449 applications home directory.
452 db: dsn:SQLite:foo.db
456 Overload to enable debug messages (same as -Debug option).
462 =head2 $c->dispatcher
464 Returns the dispatcher instance. Stringifies to class name. See
465 L<Catalyst::Dispatcher>.
469 Returns the engine instance. Stringifies to the class name. See
474 Returns the logging object instance. Unless it is already set, Catalyst
475 sets this up with a L<Catalyst::Log> object. To use your own log class:
477 $c->log( MyLogger->new );
478 $c->log->info( 'Now logging with my own logger!' );
480 Your log class should implement the methods described in the
481 L<Catalyst::Log> man page.
485 =head2 Utility methods
487 =head2 $c->path_to(@path)
489 Merges C<@path> with C<$c-E<gt>config-E<gt>{home}> and returns a
490 L<Path::Class> object.
494 $c->path_to( 'db', 'sqlite.db' );
499 my ( $c, @path ) = @_;
500 my $path = dir( $c->config->{home}, @path );
501 if ( -d $path ) { return $path }
502 else { return file( $c->config->{home}, @path ) }
505 =head2 $c->plugin( $name, $class, @args )
507 Helper method for plugins. It creates a classdata accessor/mutator and
508 loads and instantiates the given class.
510 MyApp->plugin( 'prototype', 'HTML::Prototype' );
512 $c->prototype->define_javascript_functions;
517 my ( $class, $name, $plugin, @args ) = @_;
520 if ( my $error = $UNIVERSAL::require::ERROR ) {
521 Catalyst::Exception->throw(
522 message => qq/Couldn't load instant plugin "$plugin", "$error"/ );
525 eval { $plugin->import };
526 $class->mk_classdata($name);
528 eval { $obj = $plugin->new(@args) };
531 Catalyst::Exception->throw( message =>
532 qq/Couldn't instantiate instant plugin "$plugin", "$@"/ );
536 $class->log->debug(qq/Initialized instant plugin "$plugin" as "$name"/)
542 Initializes the dispatcher and engine, loads any plugins, and loads the
543 model, view, and controller components. You may also specify an array
544 of plugins to load here, if you choose to not load them in the C<use
548 MyApp->setup( qw/-Debug/ );
553 my ( $class, @arguments ) = @_;
555 unless ( $class->isa('Catalyst') ) {
557 Catalyst::Exception->throw(
558 message => qq/'$class' does not inherit from Catalyst/ );
561 if ( $class->arguments ) {
562 @arguments = ( @arguments, @{ $class->arguments } );
568 foreach (@arguments) {
572 ( $flags->{log} ) ? 'debug,' . $flags->{log} : 'debug';
574 elsif (/^-(\w+)=?(.*)$/) {
575 $flags->{ lc $1 } = $2;
578 push @{ $flags->{plugins} }, $_;
582 $class->setup_home( delete $flags->{home} );
584 # YAML config support
585 my $confpath = $class->config->{file}
587 ( Catalyst::Utils::appprefix( ref $class || $class ) . '.yml' ) );
589 $conf = YAML::LoadFile($confpath) if -f $confpath;
590 my $oldconf = $class->config;
591 $class->config( { %$oldconf, %$conf } );
593 $class->setup_log( delete $flags->{log} );
594 $class->setup_plugins( delete $flags->{plugins} );
595 $class->setup_dispatcher( delete $flags->{dispatcher} );
596 $class->setup_engine( delete $flags->{engine} );
598 for my $flag ( sort keys %{$flags} ) {
600 if ( my $code = $class->can( 'setup_' . $flag ) ) {
601 &$code( $class, delete $flags->{$flag} );
604 $class->log->warn(qq/Unknown flag "$flag"/);
609 <<"EOF") if ( $ENV{CATALYST_SCRIPT_GEN} && ( $ENV{CATALYST_SCRIPT_GEN} < $Catalyst::CATALYST_SCRIPT_GEN ) );
610 You are running an old script!
612 Please update by running (this will overwrite existing files):
613 catalyst.pl -force -scripts $class
615 or (this will not overwrite existing files):
616 catalyst.pl -scripts $class
619 if ( $class->debug ) {
626 map { $_ . ' ' . ( $_->VERSION || '' ) }
627 grep { /^Catalyst::Plugin/ } @{"$class\::ISA"};
631 my $t = Text::SimpleTable->new(76);
632 $t->row($_) for @plugins;
633 $class->log->debug( "Loaded plugins:\n" . $t->draw );
636 my $dispatcher = $class->dispatcher;
637 my $engine = $class->engine;
638 my $home = $class->config->{home};
640 $class->log->debug(qq/Loaded dispatcher "$dispatcher"/);
641 $class->log->debug(qq/Loaded engine "$engine"/);
645 ? $class->log->debug(qq/Found home "$home"/)
646 : $class->log->debug(qq/Home "$home" doesn't exist/)
647 : $class->log->debug(q/Couldn't find home/);
652 no warnings qw/redefine/;
653 local *setup = sub { };
657 # Initialize our data structure
658 $class->components( {} );
660 $class->setup_components;
662 if ( $class->debug ) {
663 my $t = Text::SimpleTable->new( [ 65, 'Class' ], [ 8, 'Type' ] );
664 for my $comp ( sort keys %{ $class->components } ) {
665 my $type = ref $class->components->{$comp} ? 'instance' : 'class';
666 $t->row( $comp, $type );
668 $class->log->debug( "Loaded components:\n" . $t->draw )
669 if ( keys %{ $class->components } );
672 # Add our self to components, since we are also a component
673 $class->components->{$class} = $class;
675 $class->setup_actions;
677 if ( $class->debug ) {
678 my $name = $class->config->{name} || 'Application';
679 $class->log->info("$name powered by Catalyst $Catalyst::VERSION");
681 $class->log->_flush() if $class->log->can('_flush');
684 =head2 $c->uri_for( $path, [ @args ] )
686 Merges path with C<$c-E<gt>request-E<gt>base> for absolute uri's and
687 with C<$c-E<gt>namespace> for relative uri's, then returns a
688 normalized L<URI> object. If any args are passed, they are added at the
694 my ( $c, $path, @args ) = @_;
695 my $base = $c->request->base->clone;
696 my $basepath = $base->path;
697 $basepath =~ s/\/$//;
699 my $namespace = $c->namespace;
701 # massage namespace, empty if absolute path
702 $namespace =~ s/^\///;
703 $namespace .= '/' if $namespace;
705 $namespace = '' if $path =~ /^\//;
708 # join args with '/', or a blank string
709 my $args = ( scalar @args ? '/' . join( '/', @args ) : '' );
710 $args =~ s/^\/// unless $path;
712 URI->new_abs( URI->new_abs( "$path$args", "$basepath$namespace" ), $base )
717 =head2 $c->welcome_message
719 Returns the Catalyst welcome HTML page.
723 sub welcome_message {
725 my $name = $c->config->{name};
726 my $logo = $c->uri_for('/static/images/catalyst_logo.png');
727 my $prefix = Catalyst::Utils::appprefix( ref $c );
728 $c->response->content_type('text/html; charset=utf-8');
730 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
731 "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
732 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
734 <meta http-equiv="Content-Language" content="en" />
735 <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
736 <title>$name on Catalyst $VERSION</title>
737 <style type="text/css">
740 background-color: #eee;
749 background-color: #ccc;
750 border: 1px solid #aaa;
751 -moz-border-radius: 10px;
756 font-family: verdana, tahoma, sans-serif;
759 font-family: verdana, tahoma, sans-serif;
762 text-decoration: none;
764 border-bottom: 1px dotted #bbb;
766 :link:hover, :visited:hover {
779 background-color: #fff;
780 border: 1px solid #aaa;
781 -moz-border-radius: 10px;
807 <h1><span id="appname">$name</span> on <a href="http://catalyst.perl.org">Catalyst</a>
812 <img src="$logo" alt="Catalyst Logo" />
814 <p>Welcome to the wonderful world of Catalyst.
815 This <a href="http://en.wikipedia.org/wiki/MVC">MVC</a>
816 framework will make web development something you had
817 never expected it to be: Fun, rewarding, and quick.</p>
818 <h2>What to do now?</h2>
819 <p>That really depends on what <b>you</b> want to do.
820 We do, however, provide you with a few starting points.</p>
821 <p>If you want to jump right into web development with Catalyst
822 you might want to check out the documentation.</p>
823 <pre><code>perldoc <a href="http://cpansearch.perl.org/dist/Catalyst/lib/Catalyst/Manual/Intro.pod">Catalyst::Manual::Intro</a>
824 perldoc <a href="http://cpansearch.perl.org/dist/Catalyst/lib/Catalyst/Manual.pod">Catalyst::Manual</a></code></pre>
825 <h2>What to do next?</h2>
826 <p>Next it's time to write an actual application. Use the
827 helper scripts to generate <a href="http://cpansearch.perl.org/search?query=Catalyst%3A%3AController%3A%3A&mode=all">controllers</a>,
828 <a href="http://cpansearch.perl.org/search?query=Catalyst%3A%3AModel%3A%3A&mode=all">models</a>, and
829 <a href="http://cpansearch.perl.org/search?query=Catalyst%3A%3AView%3A%3A&mode=all">views</a>;
830 they can save you a lot of work.</p>
831 <pre><code>script/${prefix}_create.pl -help</code></pre>
832 <p>Also, be sure to check out the vast and growing
833 collection of <a href="http://cpansearch.perl.org/search?query=Catalyst%3A%3APlugin%3A%3A&mode=all">plugins for Catalyst on CPAN</a>;
834 you are likely to find what you need there.
838 <p>Catalyst has a very active community. Here are the main places to
839 get in touch with us.</p>
842 <a href="http://dev.catalyst.perl.org">Wiki</a>
845 <a href="http://lists.rawmode.org/mailman/listinfo/catalyst">Mailing-List</a>
848 <a href="irc://irc.perl.org/catalyst">IRC channel #catalyst on irc.perl.org</a>
851 <h2>In conclusion</h2>
852 <p>The Catalyst team hopes you will enjoy using Catalyst as much
853 as we enjoyed making it. Please contact us if you have ideas
854 for improvement or other feedback.</p>
862 =head1 INTERNAL METHODS
864 These methods are not meant to be used by end users.
866 =head2 $c->components
868 Returns a hash of components.
870 =head2 $c->context_class
872 Returns or sets the context class.
876 Returns a hashref containing coderefs and execution counts (needed for
877 deep recursion detection).
881 Returns the number of actions on the current internal execution stack.
885 Dispatches a request to actions.
889 sub dispatch { my $c = shift; $c->dispatcher->dispatch( $c, @_ ) }
891 =head2 $c->dispatcher_class
893 Returns or sets the dispatcher class.
895 =head2 $c->dump_these
897 Returns a list of 2-element array references (name, structure) pairs
898 that will be dumped on the error page in debug mode.
904 [ Request => $c->req ], [ Response => $c->res ], [ Stash => $c->stash ],;
907 =head2 $c->engine_class
909 Returns or sets the engine class.
911 =head2 $c->execute( $class, $coderef )
913 Execute a coderef in given class and catch exceptions. Errors are available
919 my ( $c, $class, $code ) = @_;
920 $class = $c->components->{$class} || $class;
924 my $action = "$code";
925 $action = "/$action" unless $action =~ /\-\>/;
926 $c->counter->{"$code"}++;
928 if ( $c->counter->{"$code"} > $RECURSION ) {
929 my $error = qq/Deep recursion detected in "$action"/;
930 $c->log->error($error);
936 # determine if the call was the result of a forward
937 # this is done by walking up the call stack and looking for a calling
938 # sub of Catalyst::forward before the eval
940 for my $index (1..10) {
942 if ( ( caller($index) )[0] eq 'Catalyst'
943 && ( caller($index) )[3] eq '(eval)' );
945 if ( (caller($index))[3] =~ /forward$/ ) {
946 $callsub = (caller($index))[3];
947 $action = "-> $action";
952 my $node = Tree::Simple->new(
955 elapsed => undef, # to be filled in later
958 $node->setUID( "$code" . $c->counter->{"$code"} );
960 unless ( ( $code->name =~ /^_.*/ )
961 && ( !$c->config->{show_internal_actions} ) )
964 # is this a root-level call or a forwarded call?
965 if ( $callsub =~ /forward$/ ) {
967 # forward, locate the caller
968 if ( my $parent = $c->stack->[-1] ) {
969 my $visitor = Tree::Simple::Visitor::FindByUID->new;
970 $visitor->searchForUID(
971 "$parent" . $c->counter->{"$parent"} );
972 $c->{stats}->accept($visitor);
973 if ( my $result = $visitor->getResult ) {
974 $result->addChild($node);
979 # forward with no caller may come from a plugin
980 $c->{stats}->addChild($node);
986 $c->{stats}->addChild($node);
991 push( @{ $c->stack }, $code );
994 $start = [gettimeofday] if $c->debug;
995 eval { $c->state( &$code( $class, $c, @{ $c->req->args } ) || 0 ) };
996 $elapsed = tv_interval($start) if $c->debug;
999 unless ( ( $code->name =~ /^_.*/ )
1000 && ( !$c->config->{show_internal_actions} ) )
1003 # FindByUID uses an internal die, so we save the existing error
1006 # locate the node in the tree and update the elapsed time
1007 my $visitor = Tree::Simple::Visitor::FindByUID->new;
1008 $visitor->searchForUID( "$code" . $c->counter->{"$code"} );
1009 $c->{stats}->accept($visitor);
1010 if ( my $result = $visitor->getResult ) {
1011 my $value = $result->getNodeValue;
1012 $value->{elapsed} = sprintf( '%fs', $elapsed );
1013 $result->setNodeValue($value);
1017 $@ = $error || undef;
1020 my $last = ${ $c->stack }[-1];
1021 pop( @{ $c->stack } );
1023 if ( my $error = $@ ) {
1024 if ( $error eq $DETACH ) { die $DETACH if $c->depth > 1 }
1026 unless ( ref $error ) {
1028 my $class = $last->class;
1029 my $name = $last->name;
1030 $error = qq/Caught exception in $class->$name "$error"/;
1041 Finalizes the request.
1048 for my $error ( @{ $c->error } ) {
1049 $c->log->error($error);
1052 $c->finalize_uploads;
1055 if ( $#{ $c->error } >= 0 ) {
1059 $c->finalize_headers;
1062 if ( $c->request->method eq 'HEAD' ) {
1063 $c->response->body('');
1068 return $c->response->status;
1071 =head2 $c->finalize_body
1077 sub finalize_body { my $c = shift; $c->engine->finalize_body( $c, @_ ) }
1079 =head2 $c->finalize_cookies
1085 sub finalize_cookies { my $c = shift; $c->engine->finalize_cookies( $c, @_ ) }
1087 =head2 $c->finalize_error
1093 sub finalize_error { my $c = shift; $c->engine->finalize_error( $c, @_ ) }
1095 =head2 $c->finalize_headers
1101 sub finalize_headers {
1104 # Check if we already finalized headers
1105 return if $c->response->{_finalized_headers};
1108 if ( my $location = $c->response->redirect ) {
1109 $c->log->debug(qq/Redirecting to "$location"/) if $c->debug;
1110 $c->response->header( Location => $location );
1114 if ( $c->response->body && !$c->response->content_length ) {
1116 # get the length from a filehandle
1117 if ( ref $c->response->body && $c->response->body->can('read') ) {
1118 if ( my $stat = stat $c->response->body ) {
1119 $c->response->content_length( $stat->size );
1122 $c->log->warn('Serving filehandle without a content-length');
1126 $c->response->content_length( bytes::length( $c->response->body ) );
1131 if ( $c->response->status =~ /^(1\d\d|[23]04)$/ ) {
1132 $c->response->headers->remove_header("Content-Length");
1133 $c->response->body('');
1136 $c->finalize_cookies;
1138 $c->engine->finalize_headers( $c, @_ );
1141 $c->response->{_finalized_headers} = 1;
1144 =head2 $c->finalize_output
1146 An alias for finalize_body.
1148 =head2 $c->finalize_read
1150 Finalizes the input after reading is complete.
1154 sub finalize_read { my $c = shift; $c->engine->finalize_read( $c, @_ ) }
1156 =head2 $c->finalize_uploads
1158 Finalizes uploads. Cleans up any temporary files.
1162 sub finalize_uploads { my $c = shift; $c->engine->finalize_uploads( $c, @_ ) }
1164 =head2 $c->get_action( $action, $namespace )
1166 Gets an action in a given namespace.
1170 sub get_action { my $c = shift; $c->dispatcher->get_action(@_) }
1172 =head2 $c->get_actions( $action, $namespace )
1174 Gets all actions of a given name in a namespace and all parent
1179 sub get_actions { my $c = shift; $c->dispatcher->get_actions( $c, @_ ) }
1181 =head2 handle_request( $class, @arguments )
1183 Called to handle each HTTP request.
1187 sub handle_request {
1188 my ( $class, @arguments ) = @_;
1190 # Always expect worst case!
1193 my $stats = ( $class->debug ) ? Tree::Simple->new: q{};
1196 my $c = $class->prepare(@arguments);
1197 $c->{stats} = $stats;
1199 return $c->finalize;
1202 if ( $class->debug ) {
1203 my $start = [gettimeofday];
1204 $status = &$handler;
1205 my $elapsed = tv_interval $start;
1206 $elapsed = sprintf '%f', $elapsed;
1207 my $av = sprintf '%.3f',
1208 ( $elapsed == 0 ? '??' : ( 1 / $elapsed ) );
1209 my $t = Text::SimpleTable->new( [ 64, 'Action' ], [ 9, 'Time' ] );
1214 my $stat = $action->getNodeValue;
1215 $t->row( ( q{ } x $action->getDepth ) . $stat->{action},
1216 $stat->{elapsed} || '??' );
1221 "Request took ${elapsed}s ($av/s)\n" . $t->draw );
1223 else { $status = &$handler }
1227 if ( my $error = $@ ) {
1229 $class->log->error(qq/Caught exception in engine "$error"/);
1233 $class->log->_flush() if $class->log->can('_flush');
1237 =head2 $c->prepare( @arguments )
1239 Creates a Catalyst context from an engine-specific request (Apache, CGI,
1245 my ( $class, @arguments ) = @_;
1247 $class->context_class( ref $class || $class ) unless $class->context_class;
1248 my $c = $class->context_class->new(
1252 request => $class->request_class->new(
1255 body_parameters => {},
1257 headers => HTTP::Headers->new,
1259 query_parameters => {},
1265 response => $class->response_class->new(
1269 headers => HTTP::Headers->new(),
1278 # For on-demand data
1279 $c->request->{_context} = $c;
1280 $c->response->{_context} = $c;
1281 weaken( $c->request->{_context} );
1282 weaken( $c->response->{_context} );
1285 my $secs = time - $START || 1;
1286 my $av = sprintf '%.3f', $COUNT / $secs;
1287 $c->log->debug('**********************************');
1288 $c->log->debug("* Request $COUNT ($av/s) [$$]");
1289 $c->log->debug('**********************************');
1290 $c->res->headers->header( 'X-Catalyst' => $Catalyst::VERSION );
1293 $c->prepare_request(@arguments);
1294 $c->prepare_connection;
1295 $c->prepare_query_parameters;
1296 $c->prepare_headers;
1297 $c->prepare_cookies;
1301 $c->prepare_body unless $c->config->{parse_on_demand};
1303 my $method = $c->req->method || '';
1304 my $path = $c->req->path || '';
1305 my $address = $c->req->address || '';
1307 $c->log->debug(qq/"$method" request for "$path" from "$address"/)
1315 =head2 $c->prepare_action
1321 sub prepare_action { my $c = shift; $c->dispatcher->prepare_action( $c, @_ ) }
1323 =head2 $c->prepare_body
1325 Prepares message body.
1332 # Do we run for the first time?
1333 return if defined $c->request->{_body};
1335 # Initialize on-demand data
1336 $c->engine->prepare_body( $c, @_ );
1337 $c->prepare_parameters;
1338 $c->prepare_uploads;
1340 if ( $c->debug && keys %{ $c->req->body_parameters } ) {
1341 my $t = Text::SimpleTable->new( [ 37, 'Key' ], [ 36, 'Value' ] );
1342 for my $key ( sort keys %{ $c->req->body_parameters } ) {
1343 my $param = $c->req->body_parameters->{$key};
1344 my $value = defined($param) ? $param : '';
1346 ref $value eq 'ARRAY' ? ( join ', ', @$value ) : $value );
1348 $c->log->debug( "Body Parameters are:\n" . $t->draw );
1352 =head2 $c->prepare_body_chunk( $chunk )
1354 Prepares a chunk of data before sending it to L<HTTP::Body>.
1358 sub prepare_body_chunk {
1360 $c->engine->prepare_body_chunk( $c, @_ );
1363 =head2 $c->prepare_body_parameters
1365 Prepares body parameters.
1369 sub prepare_body_parameters {
1371 $c->engine->prepare_body_parameters( $c, @_ );
1374 =head2 $c->prepare_connection
1376 Prepares connection.
1380 sub prepare_connection {
1382 $c->engine->prepare_connection( $c, @_ );
1385 =head2 $c->prepare_cookies
1391 sub prepare_cookies { my $c = shift; $c->engine->prepare_cookies( $c, @_ ) }
1393 =head2 $c->prepare_headers
1399 sub prepare_headers { my $c = shift; $c->engine->prepare_headers( $c, @_ ) }
1401 =head2 $c->prepare_parameters
1403 Prepares parameters.
1407 sub prepare_parameters {
1409 $c->prepare_body_parameters;
1410 $c->engine->prepare_parameters( $c, @_ );
1413 =head2 $c->prepare_path
1415 Prepares path and base.
1419 sub prepare_path { my $c = shift; $c->engine->prepare_path( $c, @_ ) }
1421 =head2 $c->prepare_query_parameters
1423 Prepares query parameters.
1427 sub prepare_query_parameters {
1430 $c->engine->prepare_query_parameters( $c, @_ );
1432 if ( $c->debug && keys %{ $c->request->query_parameters } ) {
1433 my $t = Text::SimpleTable->new( [ 37, 'Key' ], [ 36, 'Value' ] );
1434 for my $key ( sort keys %{ $c->req->query_parameters } ) {
1435 my $param = $c->req->query_parameters->{$key};
1436 my $value = defined($param) ? $param : '';
1438 ref $value eq 'ARRAY' ? ( join ', ', @$value ) : $value );
1440 $c->log->debug( "Query Parameters are:\n" . $t->draw );
1444 =head2 $c->prepare_read
1446 Prepares the input for reading.
1450 sub prepare_read { my $c = shift; $c->engine->prepare_read( $c, @_ ) }
1452 =head2 $c->prepare_request
1454 Prepares the engine request.
1458 sub prepare_request { my $c = shift; $c->engine->prepare_request( $c, @_ ) }
1460 =head2 $c->prepare_uploads
1466 sub prepare_uploads {
1469 $c->engine->prepare_uploads( $c, @_ );
1471 if ( $c->debug && keys %{ $c->request->uploads } ) {
1472 my $t = Text::SimpleTable->new(
1478 for my $key ( sort keys %{ $c->request->uploads } ) {
1479 my $upload = $c->request->uploads->{$key};
1480 for my $u ( ref $upload eq 'ARRAY' ? @{$upload} : ($upload) ) {
1481 $t->row( $key, $u->filename, $u->type, $u->size );
1484 $c->log->debug( "File Uploads are:\n" . $t->draw );
1488 =head2 $c->prepare_write
1490 Prepares the output for writing.
1494 sub prepare_write { my $c = shift; $c->engine->prepare_write( $c, @_ ) }
1496 =head2 $c->request_class
1498 Returns or sets the request class.
1500 =head2 $c->response_class
1502 Returns or sets the response class.
1504 =head2 $c->read( [$maxlength] )
1506 Reads a chunk of data from the request body. This method is designed to
1507 be used in a while loop, reading C<$maxlength> bytes on every call.
1508 C<$maxlength> defaults to the size of the request if not specified.
1510 You have to set C<MyApp-E<gt>config-E<gt>{parse_on_demand}> to use this
1515 sub read { my $c = shift; return $c->engine->read( $c, @_ ) }
1523 sub run { my $c = shift; return $c->engine->run( $c, @_ ) }
1525 =head2 $c->set_action( $action, $code, $namespace, $attrs )
1527 Sets an action in a given namespace.
1531 sub set_action { my $c = shift; $c->dispatcher->set_action( $c, @_ ) }
1533 =head2 $c->setup_actions($component)
1535 Sets up actions for a component.
1539 sub setup_actions { my $c = shift; $c->dispatcher->setup_actions( $c, @_ ) }
1541 =head2 $c->setup_components
1547 sub setup_components {
1550 my $callback = sub {
1551 my ( $component, $context ) = @_;
1553 unless ( $component->can('COMPONENT') ) {
1557 my $suffix = Catalyst::Utils::class2classsuffix($component);
1558 my $config = $class->config->{$suffix} || {};
1562 eval { $instance = $component->COMPONENT( $context, $config ); };
1564 if ( my $error = $@ ) {
1568 Catalyst::Exception->throw( message =>
1569 qq/Couldn't instantiate component "$component", "$error"/ );
1572 Catalyst::Exception->throw( message =>
1573 qq/Couldn't instantiate component "$component", "new() didn't return a object"/
1575 unless ref $instance;
1579 eval "package $class;\n" . q!Module::Pluggable::Fast->import(
1580 name => '_catalyst_components',
1582 "$class\::Controller", "$class\::C",
1583 "$class\::Model", "$class\::M",
1584 "$class\::View", "$class\::V"
1586 callback => $callback
1590 if ( my $error = $@ ) {
1594 Catalyst::Exception->throw(
1595 message => qq/Couldn't load components "$error"/ );
1598 for my $component ( $class->_catalyst_components($class) ) {
1599 $class->components->{ ref $component || $component } = $component;
1603 =head2 $c->setup_dispatcher
1609 sub setup_dispatcher {
1610 my ( $class, $dispatcher ) = @_;
1613 $dispatcher = 'Catalyst::Dispatcher::' . $dispatcher;
1616 if ( $ENV{CATALYST_DISPATCHER} ) {
1617 $dispatcher = 'Catalyst::Dispatcher::' . $ENV{CATALYST_DISPATCHER};
1620 if ( $ENV{ uc($class) . '_DISPATCHER' } ) {
1622 'Catalyst::Dispatcher::' . $ENV{ uc($class) . '_DISPATCHER' };
1625 unless ($dispatcher) {
1626 $dispatcher = $class->dispatcher_class;
1629 $dispatcher->require;
1632 Catalyst::Exception->throw(
1633 message => qq/Couldn't load dispatcher "$dispatcher", "$@"/ );
1636 # dispatcher instance
1637 $class->dispatcher( $dispatcher->new );
1640 =head2 $c->setup_engine
1647 my ( $class, $engine ) = @_;
1650 $engine = 'Catalyst::Engine::' . $engine;
1653 if ( $ENV{CATALYST_ENGINE} ) {
1654 $engine = 'Catalyst::Engine::' . $ENV{CATALYST_ENGINE};
1657 if ( $ENV{ uc($class) . '_ENGINE' } ) {
1658 $engine = 'Catalyst::Engine::' . $ENV{ uc($class) . '_ENGINE' };
1661 if ( $ENV{MOD_PERL} ) {
1663 # create the apache method
1666 *{"$class\::apache"} = sub { shift->engine->apache };
1669 my ( $software, $version ) =
1670 $ENV{MOD_PERL} =~ /^(\S+)\/(\d+(?:[\.\_]\d+)+)/;
1673 $version =~ s/(\.[^.]+)\./$1/g;
1675 if ( $software eq 'mod_perl' ) {
1679 if ( $version >= 1.99922 ) {
1680 $engine = 'Catalyst::Engine::Apache2::MP20';
1683 elsif ( $version >= 1.9901 ) {
1684 $engine = 'Catalyst::Engine::Apache2::MP19';
1687 elsif ( $version >= 1.24 ) {
1688 $engine = 'Catalyst::Engine::Apache::MP13';
1692 Catalyst::Exception->throw( message =>
1693 qq/Unsupported mod_perl version: $ENV{MOD_PERL}/ );
1698 # install the correct mod_perl handler
1699 if ( $version >= 1.9901 ) {
1700 *handler = sub : method {
1701 shift->handle_request(@_);
1705 *handler = sub ($$) { shift->handle_request(@_) };
1710 elsif ( $software eq 'Zeus-Perl' ) {
1711 $engine = 'Catalyst::Engine::Zeus';
1715 Catalyst::Exception->throw(
1716 message => qq/Unsupported mod_perl: $ENV{MOD_PERL}/ );
1721 $engine = $class->engine_class;
1727 Catalyst::Exception->throw( message =>
1728 qq/Couldn't load engine "$engine" (maybe you forgot to install it?), "$@"/
1732 # check for old engines that are no longer compatible
1734 if ( $engine->isa('Catalyst::Engine::Apache')
1735 && !Catalyst::Engine::Apache->VERSION )
1740 elsif ( $engine->isa('Catalyst::Engine::Server::Base')
1741 && Catalyst::Engine::Server->VERSION le '0.02' )
1746 elsif ($engine->isa('Catalyst::Engine::HTTP::POE')
1747 && $engine->VERSION eq '0.01' )
1752 elsif ($engine->isa('Catalyst::Engine::Zeus')
1753 && $engine->VERSION eq '0.01' )
1759 Catalyst::Exception->throw( message =>
1760 qq/Engine "$engine" is not supported by this version of Catalyst/
1765 $class->engine( $engine->new );
1768 =head2 $c->setup_home
1770 Sets up the home directory.
1775 my ( $class, $home ) = @_;
1777 if ( $ENV{CATALYST_HOME} ) {
1778 $home = $ENV{CATALYST_HOME};
1781 if ( $ENV{ uc($class) . '_HOME' } ) {
1782 $home = $ENV{ uc($class) . '_HOME' };
1786 $home = Catalyst::Utils::home($class);
1790 $class->config->{home} ||= $home;
1791 $class->config->{root} ||= dir($home)->subdir('root');
1795 =head2 $c->setup_log
1802 my ( $class, $debug ) = @_;
1804 unless ( $class->log ) {
1805 $class->log( Catalyst::Log->new );
1808 my $app_flag = Catalyst::Utils::class2env($class) . '_DEBUG';
1811 ( defined( $ENV{CATALYST_DEBUG} ) || defined( $ENV{$app_flag} ) )
1812 ? ( $ENV{CATALYST_DEBUG} || $ENV{$app_flag} )
1817 *{"$class\::debug"} = sub { 1 };
1818 $class->log->debug('Debug messages enabled');
1822 =head2 $c->setup_plugins
1829 my ( $class, $plugins ) = @_;
1832 for my $plugin ( reverse @$plugins ) {
1834 $plugin = "Catalyst::Plugin::$plugin";
1839 Catalyst::Exception->throw(
1840 message => qq/Couldn't load plugin "$plugin", "$@"/ );
1845 unshift @{"$class\::ISA"}, $plugin;
1854 =head2 $c->write( $data )
1856 Writes $data to the output stream. When using this method directly, you
1857 will need to manually set the C<Content-Length> header to the length of
1858 your output data, if known.
1865 # Finalize headers if someone manually writes output
1866 $c->finalize_headers;
1868 return $c->engine->write( $c, @_ );
1873 Returns the Catalyst version number. Mostly useful for "powered by"
1874 messages in template systems.
1878 sub version { return $Catalyst::VERSION }
1880 =head1 INTERNAL ACTIONS
1882 Catalyst uses internal actions like C<_DISPATCH>, C<_BEGIN>, C<_AUTO>,
1883 C<_ACTION>, and C<_END>. These are by default not shown in the private
1884 action table, but you can make them visible with a config parameter.
1886 MyApp->config->{show_internal_actions} = 1;
1888 =head1 CASE SENSITIVITY
1890 By default Catalyst is not case sensitive, so C<MyApp::C::FOO::Bar> is
1891 mapped to C</foo/bar>. You can activate case sensitivity with a config
1894 MyApp->config->{case_sensitive} = 1;
1896 This causes C<MyApp::C::Foo::Bar> to map to C</Foo/Bar>.
1898 =head1 ON-DEMAND PARSER
1900 The request body is usually parsed at the beginning of a request,
1901 but if you want to handle input yourself or speed things up a bit,
1902 you can enable on-demand parsing with a config parameter.
1904 MyApp->config->{parse_on_demand} = 1;
1906 =head1 PROXY SUPPORT
1908 Many production servers operate using the common double-server approach,
1909 with a lightweight frontend web server passing requests to a larger
1910 backend server. An application running on the backend server must deal
1911 with two problems: the remote user always appears to be C<127.0.0.1> and
1912 the server's hostname will appear to be C<localhost> regardless of the
1913 virtual host that the user connected through.
1915 Catalyst will automatically detect this situation when you are running
1916 the frontend and backend servers on the same machine. The following
1917 changes are made to the request.
1919 $c->req->address is set to the user's real IP address, as read from
1920 the HTTP X-Forwarded-For header.
1922 The host value for $c->req->base and $c->req->uri is set to the real
1923 host, as read from the HTTP X-Forwarded-Host header.
1925 Obviously, your web server must support these headers for this to work.
1927 In a more complex server farm environment where you may have your
1928 frontend proxy server(s) on different machines, you will need to set a
1929 configuration option to tell Catalyst to read the proxied data from the
1932 MyApp->config->{using_frontend_proxy} = 1;
1934 If you do not wish to use the proxy support at all, you may set:
1936 MyApp->config->{ignore_frontend_proxy} = 1;
1938 =head1 THREAD SAFETY
1940 Catalyst has been tested under Apache 2's threading mpm_worker, mpm_winnt,
1941 and the standalone forking HTTP server on Windows. We believe the Catalyst
1942 core to be thread-safe.
1944 If you plan to operate in a threaded environment, remember that all other
1945 modules you are using must also be thread-safe. Some modules, most notably
1946 L<DBD::SQLite>, are not thread-safe.
1952 Join #catalyst on irc.perl.org.
1956 http://lists.rawmode.org/mailman/listinfo/catalyst
1957 http://lists.rawmode.org/mailman/listinfo/catalyst-dev
1961 http://catalyst.perl.org
1965 http://dev.catalyst.perl.org
1969 =head2 L<Task::Catalyst> - All you need to start with Catalyst
1971 =head2 L<Catalyst::Manual> - The Catalyst Manual
1973 =head2 L<Catalyst::Component>, L<Catalyst::Base> - Base classes for components
1975 =head2 L<Catalyst::Engine> - Core engine
1977 =head2 L<Catalyst::Log> - Log class.
1979 =head2 L<Catalyst::Request> - Request object
1981 =head2 L<Catalyst::Response> - Response object
1983 =head2 L<Catalyst::Test> - The test suite.
2053 Sebastian Riedel, C<sri@oook.de>
2057 This library is free software, you can redistribute it and/or modify it under
2058 the same terms as Perl itself.