4 use base 'Catalyst::Base';
6 use UNIVERSAL::require;
7 use Catalyst::Exception;
10 use Catalyst::Request::Upload;
11 use Catalyst::Response;
15 use Text::SimpleTable;
17 use Time::HiRes qw/gettimeofday tv_interval/;
19 use Scalar::Util qw/weaken/;
20 use Tree::Simple qw/use_weak_refs/;
21 use Tree::Simple::Visitor::FindByUID;
24 __PACKAGE__->mk_accessors(
25 qw/counter request response state action stack namespace/
28 attributes->import( __PACKAGE__, \&namespace, 'lvalue' );
30 sub depth { scalar @{ shift->stack || [] }; }
37 # For backwards compatibility
38 *finalize_output = \&finalize_body;
43 our $RECURSION = 1000;
44 our $DETACH = "catalyst_detach\n";
46 require Module::Pluggable::Fast;
48 # Helper script generation
49 our $CATALYST_SCRIPT_GEN = 25;
51 __PACKAGE__->mk_classdata($_)
52 for qw/components arguments dispatcher engine log dispatcher_class
53 engine_class context_class request_class response_class/;
55 __PACKAGE__->dispatcher_class('Catalyst::Dispatcher');
56 __PACKAGE__->engine_class('Catalyst::Engine::CGI');
57 __PACKAGE__->request_class('Catalyst::Request');
58 __PACKAGE__->response_class('Catalyst::Response');
60 our $VERSION = '5.62';
63 my ( $class, @arguments ) = @_;
65 # We have to limit $class to Catalyst to avoid pushing Catalyst upon every
67 return unless $class eq 'Catalyst';
69 my $caller = caller(0);
71 unless ( $caller->isa('Catalyst') ) {
73 push @{"$caller\::ISA"}, $class;
76 $caller->arguments( [@arguments] );
82 Catalyst - The Elegant MVC Web Application Framework
86 # use the helper to start a new application
89 # add models, views, controllers
90 script/myapp_create.pl model Database DBIC dbi:SQLite:/path/to/db
91 script/myapp_create.pl view TT TT
92 script/myapp_create.pl controller Search
94 # built in testserver -- use -r to restart automatically on changes
95 script/myapp_server.pl
97 # command line testing interface
98 script/myapp_test.pl /yada
101 use Catalyst qw/-Debug/; # include plugins here as well
103 sub foo : Global { # called for /foo, /foo/1, /foo/1/2, etc.
104 my ( $self, $c, @args ) = @_; # args are qw/1 2/ for /foo/1/2
105 $c->stash->{template} = 'foo.tt'; # set the template
106 # lookup something from db -- stash vars are passed to TT
108 MyApp::Model::Database::Foo->search( { country => $args[0] } );
109 if ( $c->req->params->{bar} ) { # access GET or POST parameters
110 $c->forward( 'bar' ); # process another action
111 # do something else after forward returns
115 # The foo.tt TT template can use the stash data from the database
116 [% WHILE (item = data.next) %]
120 # called for /bar/of/soap, /bar/of/soap/10, etc.
121 sub bar : Path('/bar/of/soap') { ... }
123 # called for all actions, from the top-most controller downwards
125 my ( $self, $c ) = @_;
127 $c->res->redirect( '/login' ); # require login
128 return 0; # abort request and go immediately to end()
130 return 1; # success; carry on to next action
133 # called after all actions are finished
135 my ( $self, $c ) = @_;
136 if ( scalar @{ $c->error } ) { ... } # handle errors
137 return if $c->res->body; # already have a response
138 $c->forward( 'MyApp::View::TT' ); # render template
141 ### in MyApp/Controller/Foo.pm
142 # called for /foo/bar
143 sub bar : Local { ... }
145 # called for /blargle
146 sub blargle : Global { ... }
148 # an index action matches /foo, but not /foo/1, etc.
149 sub index : Private { ... }
151 ### in MyApp/Controller/Foo/Bar.pm
152 # called for /foo/bar/baz
153 sub baz : Local { ... }
155 # first MyApp auto is called, then Foo auto, then this
156 sub auto : Private { ... }
158 # powerful regular expression paths are also possible
159 sub details : Regex('^product/(\w+)/details$') {
160 my ( $self, $c ) = @_;
161 # extract the (\w+) from the URI
162 my $product = $c->req->snippets->[0];
165 See L<Catalyst::Manual::Intro> for additional information.
169 The key concept of Catalyst is DRY (Don't Repeat Yourself).
171 See L<Catalyst::Manual> for more documentation.
173 Catalyst plugins can be loaded by naming them as arguments to the "use
174 Catalyst" statement. Omit the C<Catalyst::Plugin::> prefix from the
175 plugin name, i.e., C<Catalyst::Plugin::My::Module> becomes
178 use Catalyst qw/My::Module/;
180 Special flags like C<-Debug> and C<-Engine> can also be specified as
181 arguments when Catalyst is loaded:
183 use Catalyst qw/-Debug My::Module/;
185 The position of plugins and flags in the chain is important, because
186 they are loaded in exactly the order in which they appear.
188 The following flags are supported:
192 Enables debug output.
196 Forces Catalyst to use a specific engine. Omit the
197 C<Catalyst::Engine::> prefix of the engine name, i.e.:
199 use Catalyst qw/-Engine=CGI/;
203 Forces Catalyst to use a specific home directory, e.g.:
205 use Catalyst qw[-Home=/usr/sri];
213 =head2 Information about the current request
217 Returns a L<Catalyst::Action> object for the current action, which
218 stringifies to the action name. See L<Catalyst::Action>.
222 Returns the namespace of the current action, i.e., the uri prefix
223 corresponding to the controller of the current action. For example:
225 # in Controller::Foo::Bar
226 $c->namespace; # returns 'foo/bar';
232 Returns the current L<Catalyst::Request> object. See
233 L<Catalyst::Request>.
235 =head2 Processing and response to the current request
237 =head2 $c->forward( $action [, \@arguments ] )
239 =head2 $c->forward( $class, $method, [, \@arguments ] )
241 Forwards processing to a private action. If you give a class name but no
242 method, C<process()> is called. You may also optionally pass arguments
243 in an arrayref. The action will receive the arguments in C<@_> and
244 C<$c-E<gt>req-E<gt>args>. Upon returning from the function,
245 C<$c-E<gt>req-E<gt>args> will be restored to the previous values.
248 $c->forward('index');
249 $c->forward(qw/MyApp::Model::CDBI::Foo do_stuff/);
250 $c->forward('MyApp::View::TT');
254 sub forward { my $c = shift; $c->dispatcher->forward( $c, @_ ) }
256 =head2 $c->detach( $action [, \@arguments ] )
258 =head2 $c->detach( $class, $method, [, \@arguments ] )
260 The same as C<forward>, but doesn't return.
264 sub detach { my $c = shift; $c->dispatcher->detach( $c, @_ ) }
268 =head2 $c->error($error, ...)
270 =head2 $c->error($arrayref)
272 Returns an arrayref containing error messages. If Catalyst encounters an
273 error while processing a request, it stores the error in $c->error. This
274 method should not be used to store non-fatal error messages.
276 my @error = @{ $c->error };
280 $c->error('Something bad happened');
282 Clear errors. You probably don't want to clear the errors unless you are
283 implementing a custom error screen.
292 my $error = ref $_[0] eq 'ARRAY' ? $_[0] : [@_];
293 push @{ $c->{error} }, @$error;
295 elsif ( defined $_[0] ) { $c->{error} = undef }
296 return $c->{error} || [];
303 Returns the current L<Catalyst::Response> object.
307 Returns a hashref to the stash, which may be used to store data and pass
308 it between components during a request. You can also set hash keys by
309 passing arguments. The stash is automatically sent to the view. The
310 stash is cleared at the end of a request; it cannot be used for
313 $c->stash->{foo} = $bar;
314 $c->stash( { moose => 'majestic', qux => 0 } );
315 $c->stash( bar => 1, gorch => 2 ); # equivalent to passing a hashref
317 # stash is automatically passed to the view for use in a template
318 $c->forward( 'MyApp::V::TT' );
325 my $stash = @_ > 1 ? {@_} : $_[0];
326 while ( my ( $key, $val ) = each %$stash ) {
327 $c->{stash}->{$key} = $val;
335 Contains the return value of the last executed action.
337 =head2 Component Accessors
339 =head2 $c->comp($name)
341 =head2 $c->component($name)
343 Gets a component object by name. This method is no longer recommended,
344 unless you want to get a specific component by full
345 class. C<$c-E<gt>controller>, C<$c-E<gt>model>, and C<$c-E<gt>view>
346 should be used instead.
357 my $appclass = ref $c || $c;
360 $name, "${appclass}::${name}",
361 map { "${appclass}::${_}::${name}" }
362 qw/Model M Controller C View V/
365 foreach my $try (@names) {
367 if ( exists $c->components->{$try} ) {
369 return $c->components->{$try};
373 foreach my $component ( keys %{ $c->components } ) {
375 return $c->components->{$component} if $component =~ /$name/i;
380 return sort keys %{ $c->components };
383 =head2 $c->controller($name)
385 Gets a L<Catalyst::Controller> instance by name.
387 $c->controller('Foo')->do_stuff;
392 my ( $c, $name ) = @_;
393 my $controller = $c->comp("Controller::$name");
394 return $controller if defined $controller;
395 return $c->comp("C::$name");
398 =head2 $c->model($name)
400 Gets a L<Catalyst::Model> instance by name.
402 $c->model('Foo')->do_stuff;
407 my ( $c, $name ) = @_;
408 my $model = $c->comp("Model::$name");
409 return $model if defined $model;
410 return $c->comp("M::$name");
413 =head2 $c->view($name)
415 Gets a L<Catalyst::View> instance by name.
417 $c->view('Foo')->do_stuff;
422 my ( $c, $name ) = @_;
423 my $view = $c->comp("View::$name");
424 return $view if defined $view;
425 return $c->comp("V::$name");
428 =head2 Class data and helper classes
432 Returns or takes a hashref containing the application's configuration.
434 __PACKAGE__->config({ db => 'dsn:SQLite:foo.db' });
438 Overload to enable debug messages (same as -Debug option).
444 =head2 $c->dispatcher
446 Returns the dispatcher instance. Stringifies to class name. See
447 L<Catalyst::Dispatcher>.
451 Returns the engine instance. Stringifies to the class name. See
456 Returns the logging object instance. Unless it is already set, Catalyst
457 sets this up with a L<Catalyst::Log> object. To use your own log class:
459 $c->log( MyLogger->new );
460 $c->log->info( 'Now logging with my own logger!' );
462 Your log class should implement the methods described in the
463 L<Catalyst::Log> man page.
467 =head2 Utility methods
469 =head2 $c->path_to(@path)
471 Merges C<@path> with C<$c-E<gt>config-E<gt>{home}> and returns a
472 L<Path::Class> object.
476 $c->path_to( 'db', 'sqlite.db' );
481 my ( $c, @path ) = @_;
482 my $path = dir( $c->config->{home}, @path );
483 if ( -d $path ) { return $path }
484 else { return file( $c->config->{home}, @path ) }
487 =head2 $c->plugin( $name, $class, @args )
489 Helper method for plugins. It creates a classdata accessor/mutator and
490 loads and instantiates the given class.
492 MyApp->plugin( 'prototype', 'HTML::Prototype' );
494 $c->prototype->define_javascript_functions;
499 my ( $class, $name, $plugin, @args ) = @_;
502 if ( my $error = $UNIVERSAL::require::ERROR ) {
503 Catalyst::Exception->throw(
504 message => qq/Couldn't load instant plugin "$plugin", "$error"/ );
507 eval { $plugin->import };
508 $class->mk_classdata($name);
510 eval { $obj = $plugin->new(@args) };
513 Catalyst::Exception->throw( message =>
514 qq/Couldn't instantiate instant plugin "$plugin", "$@"/ );
518 $class->log->debug(qq/Initialized instant plugin "$plugin" as "$name"/)
524 Initializes the dispatcher and engine, loads any plugins, and loads the
525 model, view, and controller components. You may also specify an array
526 of plugins to load here, if you choose to not load them in the C<use
530 MyApp->setup( qw/-Debug/ );
535 my ( $class, @arguments ) = @_;
537 unless ( $class->isa('Catalyst') ) {
539 Catalyst::Exception->throw(
540 message => qq/'$class' does not inherit from Catalyst/ );
543 if ( $class->arguments ) {
544 @arguments = ( @arguments, @{ $class->arguments } );
550 foreach (@arguments) {
554 ( $flags->{log} ) ? 'debug,' . $flags->{log} : 'debug';
556 elsif (/^-(\w+)=?(.*)$/) {
557 $flags->{ lc $1 } = $2;
560 push @{ $flags->{plugins} }, $_;
564 $class->setup_log( delete $flags->{log} );
565 $class->setup_plugins( delete $flags->{plugins} );
566 $class->setup_dispatcher( delete $flags->{dispatcher} );
567 $class->setup_engine( delete $flags->{engine} );
568 $class->setup_home( delete $flags->{home} );
570 for my $flag ( sort keys %{$flags} ) {
572 if ( my $code = $class->can( 'setup_' . $flag ) ) {
573 &$code( $class, delete $flags->{$flag} );
576 $class->log->warn(qq/Unknown flag "$flag"/);
581 <<"EOF") if ( $ENV{CATALYST_SCRIPT_GEN} && ( $ENV{CATALYST_SCRIPT_GEN} < $Catalyst::CATALYST_SCRIPT_GEN ) );
582 You are running an old script!
584 Please update by running (this will overwrite existing files):
585 catalyst.pl -force -scripts $class
587 or (this will not overwrite existing files):
588 catalyst.pl -scripts $class
591 if ( $class->debug ) {
598 map { $_ . ' ' . ( $_->VERSION || '' ) }
599 grep { /^Catalyst::Plugin/ } @{"$class\::ISA"};
603 my $t = Text::SimpleTable->new(76);
604 $t->row($_) for @plugins;
605 $class->log->debug( "Loaded plugins:\n" . $t->draw );
608 my $dispatcher = $class->dispatcher;
609 my $engine = $class->engine;
610 my $home = $class->config->{home};
612 $class->log->debug(qq/Loaded dispatcher "$dispatcher"/);
613 $class->log->debug(qq/Loaded engine "$engine"/);
617 ? $class->log->debug(qq/Found home "$home"/)
618 : $class->log->debug(qq/Home "$home" doesn't exist/)
619 : $class->log->debug(q/Couldn't find home/);
624 no warnings qw/redefine/;
625 local *setup = sub { };
629 # Initialize our data structure
630 $class->components( {} );
632 $class->setup_components;
634 if ( $class->debug ) {
635 my $t = Text::SimpleTable->new( [ 65, 'Class' ], [ 8, 'Type' ] );
636 for my $comp ( sort keys %{ $class->components } ) {
637 my $type = ref $class->components->{$comp} ? 'instance' : 'class';
638 $t->row( $comp, $type );
640 $class->log->debug( "Loaded components:\n" . $t->draw )
641 if ( keys %{ $class->components } );
644 # Add our self to components, since we are also a component
645 $class->components->{$class} = $class;
647 $class->setup_actions;
649 if ( $class->debug ) {
650 my $name = $class->config->{name} || 'Application';
651 $class->log->info("$name powered by Catalyst $Catalyst::VERSION");
653 $class->log->_flush() if $class->log->can('_flush');
656 =head2 $c->uri_for( $path, [ @args ] )
658 Merges path with C<$c-E<gt>request-E<gt>base> for absolute uri's and
659 with C<$c-E<gt>namespace> for relative uri's, then returns a
660 normalized L<URI> object. If any args are passed, they are added at the
666 my ( $c, $path, @args ) = @_;
667 my $base = $c->request->base->clone;
668 my $basepath = $base->path;
669 $basepath =~ s/\/$//;
671 my $namespace = $c->namespace;
673 # massage namespace, empty if absolute path
674 $namespace =~ s/^\///;
675 $namespace .= '/' if $namespace;
677 $namespace = '' if $path =~ /^\//;
680 # join args with '/', or a blank string
681 my $args = ( scalar @args ? '/' . join( '/', @args ) : '' );
682 $args =~ s/^\/// unless $path;
684 URI->new_abs( URI->new_abs( "$path$args", "$basepath$namespace" ), $base )
689 =head2 $c->welcome_message
691 Returns the Catalyst welcome HTML page.
695 sub welcome_message {
697 my $name = $c->config->{name};
698 my $logo = $c->uri_for('/static/images/catalyst_logo.png');
699 my $prefix = Catalyst::Utils::appprefix( ref $c );
700 $c->response->content_type('text/html; charset=utf-8');
702 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
703 "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
704 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
706 <meta http-equiv="Content-Language" content="en" />
707 <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
708 <title>$name on Catalyst $VERSION</title>
709 <style type="text/css">
712 background-color: #eee;
721 background-color: #ccc;
722 border: 1px solid #aaa;
723 -moz-border-radius: 10px;
728 font-family: verdana, tahoma, sans-serif;
731 font-family: verdana, tahoma, sans-serif;
734 text-decoration: none;
736 border-bottom: 1px dotted #bbb;
738 :link:hover, :visited:hover {
751 background-color: #fff;
752 border: 1px solid #aaa;
753 -moz-border-radius: 10px;
779 <h1><span id="appname">$name</span> on <a href="http://catalyst.perl.org">Catalyst</a>
784 <img src="$logo" alt="Catalyst Logo" />
786 <p>Welcome to the wonderful world of Catalyst.
787 This <a href="http://en.wikipedia.org/wiki/MVC">MVC</a>
788 framework will make web development something you had
789 never expected it to be: Fun, rewarding, and quick.</p>
790 <h2>What to do now?</h2>
791 <p>That really depends on what <b>you</b> want to do.
792 We do, however, provide you with a few starting points.</p>
793 <p>If you want to jump right into web development with Catalyst
794 you might want to check out the documentation.</p>
795 <pre><code>perldoc <a href="http://cpansearch.perl.org/dist/Catalyst/lib/Catalyst/Manual/Intro.pod">Catalyst::Manual::Intro</a>
796 perldoc <a href="http://cpansearch.perl.org/dist/Catalyst/lib/Catalyst/Manual.pod">Catalyst::Manual</a></code></pre>
797 <h2>What to do next?</h2>
798 <p>Next it's time to write an actual application. Use the
799 helper scripts to generate <a href="http://cpansearch.perl.org/search?query=Catalyst%3A%3AController%3A%3A&mode=all">controllers</a>,
800 <a href="http://cpansearch.perl.org/search?query=Catalyst%3A%3AModel%3A%3A&mode=all">models</a>, and
801 <a href="http://cpansearch.perl.org/search?query=Catalyst%3A%3AView%3A%3A&mode=all">views</a>;
802 they can save you a lot of work.</p>
803 <pre><code>script/${prefix}_create.pl -help</code></pre>
804 <p>Also, be sure to check out the vast and growing
805 collection of <a href="http://cpansearch.perl.org/search?query=Catalyst%3A%3APlugin%3A%3A&mode=all">plugins for Catalyst on CPAN</a>;
806 you are likely to find what you need there.
810 <p>Catalyst has a very active community. Here are the main places to
811 get in touch with us.</p>
814 <a href="http://dev.catalyst.perl.org">Wiki</a>
817 <a href="http://lists.rawmode.org/mailman/listinfo/catalyst">Mailing-List</a>
820 <a href="irc://irc.perl.org/catalyst">IRC channel #catalyst on irc.perl.org</a>
823 <h2>In conclusion</h2>
824 <p>The Catalyst team hopes you will enjoy using Catalyst as much
825 as we enjoyed making it. Please contact us if you have ideas
826 for improvement or other feedback.</p>
834 =head1 INTERNAL METHODS
836 These methods are not meant to be used by end users.
838 =head2 $c->components
840 Returns a hash of components.
842 =head2 $c->context_class
844 Returns or sets the context class.
848 Returns a hashref containing coderefs and execution counts (needed for
849 deep recursion detection).
853 Returns the number of actions on the current internal execution stack.
857 Dispatches a request to actions.
861 sub dispatch { my $c = shift; $c->dispatcher->dispatch( $c, @_ ) }
863 =head2 $c->dispatcher_class
865 Returns or sets the dispatcher class.
867 =head2 $c->dump_these
869 Returns a list of 2-element array references (name, structure) pairs
870 that will be dumped on the error page in debug mode.
876 [ Request => $c->req ], [ Response => $c->res ], [ Stash => $c->stash ],;
879 =head2 $c->engine_class
881 Returns or sets the engine class.
883 =head2 $c->execute( $class, $coderef )
885 Execute a coderef in given class and catch exceptions. Errors are available
891 my ( $c, $class, $code ) = @_;
892 $class = $c->components->{$class} || $class;
896 my $action = "$code";
897 $action = "/$action" unless $action =~ /\-\>/;
898 $c->counter->{"$code"}++;
900 if ( $c->counter->{"$code"} > $RECURSION ) {
901 my $error = qq/Deep recursion detected in "$action"/;
902 $c->log->error($error);
908 # determine if the call was the result of a forward
909 my $callsub_index = ( caller(0) )[0]->isa('Catalyst::Action') ? 2 : 1;
910 if ( ( caller($callsub_index) )[3] =~ /^NEXT/ ) {
911 # work around NEXT if execute was extended by a plugin
914 my $callsub = ( caller($callsub_index) )[3];
916 $action = "-> $action" if $callsub =~ /forward$/;
918 my $node = Tree::Simple->new( {
920 elapsed => undef, # to be filled in later
922 $node->setUID( "$code" . $c->counter->{"$code"} );
924 unless ( ( $code->name =~ /^_.*/ )
925 && ( !$c->config->{show_internal_actions} ) )
927 # is this a root-level call or a forwarded call?
928 if ( $callsub =~ /forward$/ ) {
930 # forward, locate the caller
931 if ( my $parent = $c->stack->[-1] ) {
932 my $visitor = Tree::Simple::Visitor::FindByUID->new;
933 $visitor->searchForUID(
934 "$parent" . $c->counter->{"$parent"} );
935 $c->{stats}->accept( $visitor );
936 if ( my $result = $visitor->getResult ) {
937 $result->addChild( $node );
941 # forward with no caller may come from a plugin
942 $c->{stats}->addChild( $node );
947 $c->{stats}->addChild( $node );
952 push( @{ $c->stack }, $code );
955 $start = [gettimeofday] if $c->debug;
956 eval { $c->state( &$code( $class, $c, @{ $c->req->args } ) || 0 ) };
957 $elapsed = tv_interval($start) if $c->debug;
960 unless ( ( $code->name =~ /^_.*/ )
961 && ( !$c->config->{show_internal_actions} ) )
963 # FindByUID uses an internal die, so we save the existing error
966 # locate the node in the tree and update the elapsed time
967 my $visitor = Tree::Simple::Visitor::FindByUID->new;
968 $visitor->searchForUID( "$code" . $c->counter->{"$code"} );
969 $c->{stats}->accept( $visitor );
970 if ( my $result = $visitor->getResult ) {
971 my $value = $result->getNodeValue;
972 $value->{elapsed} = sprintf( '%fs', $elapsed );
973 $result->setNodeValue( $value );
977 $@ = $error || undef;
980 my $last = ${ $c->stack }[-1];
981 pop( @{ $c->stack } );
983 if ( my $error = $@ ) {
984 if ( $error eq $DETACH ) { die $DETACH if $c->depth > 1 }
986 unless ( ref $error ) {
988 my $class = $last->class;
989 my $name = $last->name;
990 $error = qq/Caught exception in $class->$name "$error"/;
1001 Finalizes the request.
1008 for my $error ( @{ $c->error } ) {
1009 $c->log->error($error);
1012 $c->finalize_uploads;
1015 if ( $#{ $c->error } >= 0 ) {
1019 $c->finalize_headers;
1022 if ( $c->request->method eq 'HEAD' ) {
1023 $c->response->body('');
1028 return $c->response->status;
1031 =head2 $c->finalize_body
1037 sub finalize_body { my $c = shift; $c->engine->finalize_body( $c, @_ ) }
1039 =head2 $c->finalize_cookies
1045 sub finalize_cookies { my $c = shift; $c->engine->finalize_cookies( $c, @_ ) }
1047 =head2 $c->finalize_error
1053 sub finalize_error { my $c = shift; $c->engine->finalize_error( $c, @_ ) }
1055 =head2 $c->finalize_headers
1061 sub finalize_headers {
1064 # Check if we already finalized headers
1065 return if $c->response->{_finalized_headers};
1068 if ( my $location = $c->response->redirect ) {
1069 $c->log->debug(qq/Redirecting to "$location"/) if $c->debug;
1070 $c->response->header( Location => $location );
1074 if ( $c->response->body && !$c->response->content_length ) {
1076 # get the length from a filehandle
1077 if ( ref $c->response->body && $c->response->body->can('read') ) {
1078 if ( my $stat = stat $c->response->body ) {
1079 $c->response->content_length( $stat->size );
1082 $c->log->warn('Serving filehandle without a content-length');
1086 $c->response->content_length( bytes::length( $c->response->body ) );
1091 if ( $c->response->status =~ /^(1\d\d|[23]04)$/ ) {
1092 $c->response->headers->remove_header("Content-Length");
1093 $c->response->body('');
1096 $c->finalize_cookies;
1098 $c->engine->finalize_headers( $c, @_ );
1101 $c->response->{_finalized_headers} = 1;
1104 =head2 $c->finalize_output
1106 An alias for finalize_body.
1108 =head2 $c->finalize_read
1110 Finalizes the input after reading is complete.
1114 sub finalize_read { my $c = shift; $c->engine->finalize_read( $c, @_ ) }
1116 =head2 $c->finalize_uploads
1118 Finalizes uploads. Cleans up any temporary files.
1122 sub finalize_uploads { my $c = shift; $c->engine->finalize_uploads( $c, @_ ) }
1124 =head2 $c->get_action( $action, $namespace )
1126 Gets an action in a given namespace.
1130 sub get_action { my $c = shift; $c->dispatcher->get_action(@_) }
1132 =head2 $c->get_actions( $action, $namespace )
1134 Gets all actions of a given name in a namespace and all parent
1139 sub get_actions { my $c = shift; $c->dispatcher->get_actions( $c, @_ ) }
1141 =head2 handle_request( $class, @arguments )
1143 Called to handle each HTTP request.
1147 sub handle_request {
1148 my ( $class, @arguments ) = @_;
1150 # Always expect worst case!
1153 my $stats = ( $class->debug ) ? Tree::Simple->new : q{};
1156 my $c = $class->prepare(@arguments);
1157 $c->{stats} = $stats;
1159 return $c->finalize;
1162 if ( $class->debug ) {
1163 my $start = [gettimeofday];
1164 $status = &$handler;
1165 my $elapsed = tv_interval $start;
1166 $elapsed = sprintf '%f', $elapsed;
1167 my $av = sprintf '%.3f',
1168 ( $elapsed == 0 ? '??' : ( 1 / $elapsed ) );
1169 my $t = Text::SimpleTable->new( [ 64, 'Action' ], [ 9, 'Time' ] );
1171 $stats->traverse( sub {
1173 my $stat = $action->getNodeValue;
1175 ( q{ } x $action->getDepth ) . $stat->{action},
1176 $stat->{elapsed} || '??'
1181 "Request took ${elapsed}s ($av/s)\n" . $t->draw );
1183 else { $status = &$handler }
1187 if ( my $error = $@ ) {
1189 $class->log->error(qq/Caught exception in engine "$error"/);
1193 $class->log->_flush() if $class->log->can('_flush');
1197 =head2 $c->prepare( @arguments )
1199 Creates a Catalyst context from an engine-specific request (Apache, CGI,
1205 my ( $class, @arguments ) = @_;
1207 $class->context_class( ref $class || $class ) unless $class->context_class;
1208 my $c = $class->context_class->new(
1212 request => $class->request_class->new(
1215 body_parameters => {},
1217 headers => HTTP::Headers->new,
1219 query_parameters => {},
1225 response => $class->response_class->new(
1229 headers => HTTP::Headers->new(),
1238 # For on-demand data
1239 $c->request->{_context} = $c;
1240 $c->response->{_context} = $c;
1241 weaken( $c->request->{_context} );
1242 weaken( $c->response->{_context} );
1245 my $secs = time - $START || 1;
1246 my $av = sprintf '%.3f', $COUNT / $secs;
1247 $c->log->debug('**********************************');
1248 $c->log->debug("* Request $COUNT ($av/s) [$$]");
1249 $c->log->debug('**********************************');
1250 $c->res->headers->header( 'X-Catalyst' => $Catalyst::VERSION );
1253 $c->prepare_request(@arguments);
1254 $c->prepare_connection;
1255 $c->prepare_query_parameters;
1256 $c->prepare_headers;
1257 $c->prepare_cookies;
1261 $c->prepare_body unless $c->config->{parse_on_demand};
1263 my $method = $c->req->method || '';
1264 my $path = $c->req->path || '';
1265 my $address = $c->req->address || '';
1267 $c->log->debug(qq/"$method" request for "$path" from "$address"/)
1275 =head2 $c->prepare_action
1281 sub prepare_action { my $c = shift; $c->dispatcher->prepare_action( $c, @_ ) }
1283 =head2 $c->prepare_body
1285 Prepares message body.
1292 # Do we run for the first time?
1293 return if defined $c->request->{_body};
1295 # Initialize on-demand data
1296 $c->engine->prepare_body( $c, @_ );
1297 $c->prepare_parameters;
1298 $c->prepare_uploads;
1300 if ( $c->debug && keys %{ $c->req->body_parameters } ) {
1301 my $t = Text::SimpleTable->new( [ 37, 'Key' ], [ 36, 'Value' ] );
1302 for my $key ( sort keys %{ $c->req->body_parameters } ) {
1303 my $param = $c->req->body_parameters->{$key};
1304 my $value = defined($param) ? $param : '';
1306 ref $value eq 'ARRAY' ? ( join ', ', @$value ) : $value );
1308 $c->log->debug( "Body Parameters are:\n" . $t->draw );
1312 =head2 $c->prepare_body_chunk( $chunk )
1314 Prepares a chunk of data before sending it to L<HTTP::Body>.
1318 sub prepare_body_chunk {
1320 $c->engine->prepare_body_chunk( $c, @_ );
1323 =head2 $c->prepare_body_parameters
1325 Prepares body parameters.
1329 sub prepare_body_parameters {
1331 $c->engine->prepare_body_parameters( $c, @_ );
1334 =head2 $c->prepare_connection
1336 Prepares connection.
1340 sub prepare_connection {
1342 $c->engine->prepare_connection( $c, @_ );
1345 =head2 $c->prepare_cookies
1351 sub prepare_cookies { my $c = shift; $c->engine->prepare_cookies( $c, @_ ) }
1353 =head2 $c->prepare_headers
1359 sub prepare_headers { my $c = shift; $c->engine->prepare_headers( $c, @_ ) }
1361 =head2 $c->prepare_parameters
1363 Prepares parameters.
1367 sub prepare_parameters {
1369 $c->prepare_body_parameters;
1370 $c->engine->prepare_parameters( $c, @_ );
1373 =head2 $c->prepare_path
1375 Prepares path and base.
1379 sub prepare_path { my $c = shift; $c->engine->prepare_path( $c, @_ ) }
1381 =head2 $c->prepare_query_parameters
1383 Prepares query parameters.
1387 sub prepare_query_parameters {
1390 $c->engine->prepare_query_parameters( $c, @_ );
1392 if ( $c->debug && keys %{ $c->request->query_parameters } ) {
1393 my $t = Text::SimpleTable->new( [ 37, 'Key' ], [ 36, 'Value' ] );
1394 for my $key ( sort keys %{ $c->req->query_parameters } ) {
1395 my $param = $c->req->query_parameters->{$key};
1396 my $value = defined($param) ? $param : '';
1398 ref $value eq 'ARRAY' ? ( join ', ', @$value ) : $value );
1400 $c->log->debug( "Query Parameters are:\n" . $t->draw );
1404 =head2 $c->prepare_read
1406 Prepares the input for reading.
1410 sub prepare_read { my $c = shift; $c->engine->prepare_read( $c, @_ ) }
1412 =head2 $c->prepare_request
1414 Prepares the engine request.
1418 sub prepare_request { my $c = shift; $c->engine->prepare_request( $c, @_ ) }
1420 =head2 $c->prepare_uploads
1426 sub prepare_uploads {
1429 $c->engine->prepare_uploads( $c, @_ );
1431 if ( $c->debug && keys %{ $c->request->uploads } ) {
1432 my $t = Text::SimpleTable->new(
1438 for my $key ( sort keys %{ $c->request->uploads } ) {
1439 my $upload = $c->request->uploads->{$key};
1440 for my $u ( ref $upload eq 'ARRAY' ? @{$upload} : ($upload) ) {
1441 $t->row( $key, $u->filename, $u->type, $u->size );
1444 $c->log->debug( "File Uploads are:\n" . $t->draw );
1448 =head2 $c->prepare_write
1450 Prepares the output for writing.
1454 sub prepare_write { my $c = shift; $c->engine->prepare_write( $c, @_ ) }
1456 =head2 $c->request_class
1458 Returns or sets the request class.
1460 =head2 $c->response_class
1462 Returns or sets the response class.
1464 =head2 $c->read( [$maxlength] )
1466 Reads a chunk of data from the request body. This method is designed to
1467 be used in a while loop, reading C<$maxlength> bytes on every call.
1468 C<$maxlength> defaults to the size of the request if not specified.
1470 You have to set C<MyApp-E<gt>config-E<gt>{parse_on_demand}> to use this
1475 sub read { my $c = shift; return $c->engine->read( $c, @_ ) }
1483 sub run { my $c = shift; return $c->engine->run( $c, @_ ) }
1485 =head2 $c->set_action( $action, $code, $namespace, $attrs )
1487 Sets an action in a given namespace.
1491 sub set_action { my $c = shift; $c->dispatcher->set_action( $c, @_ ) }
1493 =head2 $c->setup_actions($component)
1495 Sets up actions for a component.
1499 sub setup_actions { my $c = shift; $c->dispatcher->setup_actions( $c, @_ ) }
1501 =head2 $c->setup_components
1507 sub setup_components {
1510 my $callback = sub {
1511 my ( $component, $context ) = @_;
1513 unless ( $component->isa('Catalyst::Component') ) {
1517 my $suffix = Catalyst::Utils::class2classsuffix($component);
1518 my $config = $class->config->{$suffix} || {};
1522 eval { $instance = $component->new( $context, $config ); };
1524 if ( my $error = $@ ) {
1528 Catalyst::Exception->throw( message =>
1529 qq/Couldn't instantiate component "$component", "$error"/ );
1532 Catalyst::Exception->throw( message =>
1533 qq/Couldn't instantiate component "$component", "new() didn't return a object"/
1535 unless ref $instance;
1539 eval "package $class;\n" . q!Module::Pluggable::Fast->import(
1540 name => '_catalyst_components',
1542 "$class\::Controller", "$class\::C",
1543 "$class\::Model", "$class\::M",
1544 "$class\::View", "$class\::V"
1546 callback => $callback
1550 if ( my $error = $@ ) {
1554 Catalyst::Exception->throw(
1555 message => qq/Couldn't load components "$error"/ );
1558 for my $component ( $class->_catalyst_components($class) ) {
1559 $class->components->{ ref $component || $component } = $component;
1563 =head2 $c->setup_dispatcher
1569 sub setup_dispatcher {
1570 my ( $class, $dispatcher ) = @_;
1573 $dispatcher = 'Catalyst::Dispatcher::' . $dispatcher;
1576 if ( $ENV{CATALYST_DISPATCHER} ) {
1577 $dispatcher = 'Catalyst::Dispatcher::' . $ENV{CATALYST_DISPATCHER};
1580 if ( $ENV{ uc($class) . '_DISPATCHER' } ) {
1582 'Catalyst::Dispatcher::' . $ENV{ uc($class) . '_DISPATCHER' };
1585 unless ($dispatcher) {
1586 $dispatcher = $class->dispatcher_class;
1589 $dispatcher->require;
1592 Catalyst::Exception->throw(
1593 message => qq/Couldn't load dispatcher "$dispatcher", "$@"/ );
1596 # dispatcher instance
1597 $class->dispatcher( $dispatcher->new );
1600 =head2 $c->setup_engine
1607 my ( $class, $engine ) = @_;
1610 $engine = 'Catalyst::Engine::' . $engine;
1613 if ( $ENV{CATALYST_ENGINE} ) {
1614 $engine = 'Catalyst::Engine::' . $ENV{CATALYST_ENGINE};
1617 if ( $ENV{ uc($class) . '_ENGINE' } ) {
1618 $engine = 'Catalyst::Engine::' . $ENV{ uc($class) . '_ENGINE' };
1621 if ( $ENV{MOD_PERL} ) {
1623 # create the apache method
1626 *{"$class\::apache"} = sub { shift->engine->apache };
1629 my ( $software, $version ) =
1630 $ENV{MOD_PERL} =~ /^(\S+)\/(\d+(?:[\.\_]\d+)+)/;
1633 $version =~ s/(\.[^.]+)\./$1/g;
1635 if ( $software eq 'mod_perl' ) {
1639 if ( $version >= 1.99922 ) {
1640 $engine = 'Catalyst::Engine::Apache2::MP20';
1643 elsif ( $version >= 1.9901 ) {
1644 $engine = 'Catalyst::Engine::Apache2::MP19';
1647 elsif ( $version >= 1.24 ) {
1648 $engine = 'Catalyst::Engine::Apache::MP13';
1652 Catalyst::Exception->throw( message =>
1653 qq/Unsupported mod_perl version: $ENV{MOD_PERL}/ );
1658 # install the correct mod_perl handler
1659 if ( $version >= 1.9901 ) {
1660 *handler = sub : method {
1661 shift->handle_request(@_);
1665 *handler = sub ($$) { shift->handle_request(@_) };
1670 elsif ( $software eq 'Zeus-Perl' ) {
1671 $engine = 'Catalyst::Engine::Zeus';
1675 Catalyst::Exception->throw(
1676 message => qq/Unsupported mod_perl: $ENV{MOD_PERL}/ );
1681 $engine = $class->engine_class;
1687 Catalyst::Exception->throw( message =>
1688 qq/Couldn't load engine "$engine" (maybe you forgot to install it?), "$@"/
1692 # check for old engines that are no longer compatible
1694 if ( $engine->isa('Catalyst::Engine::Apache')
1695 && !Catalyst::Engine::Apache->VERSION )
1700 elsif ( $engine->isa('Catalyst::Engine::Server::Base')
1701 && Catalyst::Engine::Server->VERSION le '0.02' )
1706 elsif ($engine->isa('Catalyst::Engine::HTTP::POE')
1707 && $engine->VERSION eq '0.01' )
1712 elsif ($engine->isa('Catalyst::Engine::Zeus')
1713 && $engine->VERSION eq '0.01' )
1719 Catalyst::Exception->throw( message =>
1720 qq/Engine "$engine" is not supported by this version of Catalyst/
1725 $class->engine( $engine->new );
1728 =head2 $c->setup_home
1730 Sets up the home directory.
1735 my ( $class, $home ) = @_;
1737 if ( $ENV{CATALYST_HOME} ) {
1738 $home = $ENV{CATALYST_HOME};
1741 if ( $ENV{ uc($class) . '_HOME' } ) {
1742 $home = $ENV{ uc($class) . '_HOME' };
1746 $home = Catalyst::Utils::home($class);
1750 $class->config->{home} ||= $home;
1751 $class->config->{root} ||= dir($home)->subdir('root');
1755 =head2 $c->setup_log
1762 my ( $class, $debug ) = @_;
1764 unless ( $class->log ) {
1765 $class->log( Catalyst::Log->new );
1768 my $app_flag = Catalyst::Utils::class2env($class) . '_DEBUG';
1771 ( defined( $ENV{CATALYST_DEBUG} ) || defined( $ENV{$app_flag} ) )
1772 ? ( $ENV{CATALYST_DEBUG} || $ENV{$app_flag} )
1777 *{"$class\::debug"} = sub { 1 };
1778 $class->log->debug('Debug messages enabled');
1782 =head2 $c->setup_plugins
1789 my ( $class, $plugins ) = @_;
1792 for my $plugin ( reverse @$plugins ) {
1794 $plugin = "Catalyst::Plugin::$plugin";
1799 Catalyst::Exception->throw(
1800 message => qq/Couldn't load plugin "$plugin", "$@"/ );
1805 unshift @{"$class\::ISA"}, $plugin;
1814 =head2 $c->write( $data )
1816 Writes $data to the output stream. When using this method directly, you
1817 will need to manually set the C<Content-Length> header to the length of
1818 your output data, if known.
1825 # Finalize headers if someone manually writes output
1826 $c->finalize_headers;
1828 return $c->engine->write( $c, @_ );
1833 Returns the Catalyst version number. Mostly useful for "powered by"
1834 messages in template systems.
1838 sub version { return $Catalyst::VERSION }
1840 =head1 INTERNAL ACTIONS
1842 Catalyst uses internal actions like C<_DISPATCH>, C<_BEGIN>, C<_AUTO>,
1843 C<_ACTION>, and C<_END>. These are by default not shown in the private
1844 action table, but you can make them visible with a config parameter.
1846 MyApp->config->{show_internal_actions} = 1;
1848 =head1 CASE SENSITIVITY
1850 By default Catalyst is not case sensitive, so C<MyApp::C::FOO::Bar> is
1851 mapped to C</foo/bar>. You can activate case sensitivity with a config
1854 MyApp->config->{case_sensitive} = 1;
1856 This causes C<MyApp::C::Foo::Bar> to map to C</Foo/Bar>.
1858 =head1 ON-DEMAND PARSER
1860 The request body is usually parsed at the beginning of a request,
1861 but if you want to handle input yourself or speed things up a bit,
1862 you can enable on-demand parsing with a config parameter.
1864 MyApp->config->{parse_on_demand} = 1;
1866 =head1 PROXY SUPPORT
1868 Many production servers operate using the common double-server approach,
1869 with a lightweight frontend web server passing requests to a larger
1870 backend server. An application running on the backend server must deal
1871 with two problems: the remote user always appears to be C<127.0.0.1> and
1872 the server's hostname will appear to be C<localhost> regardless of the
1873 virtual host that the user connected through.
1875 Catalyst will automatically detect this situation when you are running
1876 the frontend and backend servers on the same machine. The following
1877 changes are made to the request.
1879 $c->req->address is set to the user's real IP address, as read from
1880 the HTTP X-Forwarded-For header.
1882 The host value for $c->req->base and $c->req->uri is set to the real
1883 host, as read from the HTTP X-Forwarded-Host header.
1885 Obviously, your web server must support these headers for this to work.
1887 In a more complex server farm environment where you may have your
1888 frontend proxy server(s) on different machines, you will need to set a
1889 configuration option to tell Catalyst to read the proxied data from the
1892 MyApp->config->{using_frontend_proxy} = 1;
1894 If you do not wish to use the proxy support at all, you may set:
1896 MyApp->config->{ignore_frontend_proxy} = 1;
1898 =head1 THREAD SAFETY
1900 Catalyst has been tested under Apache 2's threading mpm_worker, mpm_winnt,
1901 and the standalone forking HTTP server on Windows. We believe the Catalyst
1902 core to be thread-safe.
1904 If you plan to operate in a threaded environment, remember that all other
1905 modules you are using must also be thread-safe. Some modules, most notably
1906 L<DBD::SQLite>, are not thread-safe.
1912 Join #catalyst on irc.perl.org.
1916 http://lists.rawmode.org/mailman/listinfo/catalyst
1917 http://lists.rawmode.org/mailman/listinfo/catalyst-dev
1921 http://catalyst.perl.org
1925 http://dev.catalyst.perl.org
1929 =head2 L<Task::Catalyst> - All you need to start with Catalyst
1931 =head2 L<Catalyst::Manual> - The Catalyst Manual
1933 =head2 L<Catalyst::Component>, L<Catalyst::Base> - Base classes for components
1935 =head2 L<Catalyst::Engine> - Core engine
1937 =head2 L<Catalyst::Log> - Log class.
1939 =head2 L<Catalyst::Request> - Request object
1941 =head2 L<Catalyst::Response> - Response object
1943 =head2 L<Catalyst::Test> - The test suite.
2013 Sebastian Riedel, C<sri@oook.de>
2017 This library is free software, you can redistribute it and/or modify it under
2018 the same terms as Perl itself.