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;
27 __PACKAGE__->mk_accessors(
28 qw/counter request response state action stack namespace/
31 attributes->import( __PACKAGE__, \&namespace, 'lvalue' );
33 sub depth { scalar @{ shift->stack || [] }; }
40 # For backwards compatibility
41 *finalize_output = \&finalize_body;
46 our $RECURSION = 1000;
47 our $DETACH = "catalyst_detach\n";
49 require Module::Pluggable::Fast;
51 # Helper script generation
52 our $CATALYST_SCRIPT_GEN = 26;
54 __PACKAGE__->mk_classdata($_)
55 for qw/components arguments dispatcher engine log dispatcher_class
56 engine_class context_class request_class response_class/;
58 __PACKAGE__->dispatcher_class('Catalyst::Dispatcher');
59 __PACKAGE__->engine_class('Catalyst::Engine::CGI');
60 __PACKAGE__->request_class('Catalyst::Request');
61 __PACKAGE__->response_class('Catalyst::Response');
63 our $VERSION = '5.64';
66 my ( $class, @arguments ) = @_;
68 # We have to limit $class to Catalyst to avoid pushing Catalyst upon every
70 return unless $class eq 'Catalyst';
72 my $caller = caller(0);
74 unless ( $caller->isa('Catalyst') ) {
76 push @{"$caller\::ISA"}, $class, 'Catalyst::Controller';
79 $caller->arguments( [@arguments] );
85 Catalyst - The Elegant MVC Web Application Framework
89 # use the helper to start a new application
92 # add models, views, controllers
93 script/myapp_create.pl model Database DBIC dbi:SQLite:/path/to/db
94 script/myapp_create.pl view TT TT
95 script/myapp_create.pl controller Search
97 # built in testserver -- use -r to restart automatically on changes
98 script/myapp_server.pl
100 # command line testing interface
101 script/myapp_test.pl /yada
104 use Catalyst qw/-Debug/; # include plugins here as well
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 MyApp::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 ) = @_;
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 MyApp 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->snippets->[0];
168 See L<Catalyst::Manual::Intro> for additional information.
172 The key concept of Catalyst is DRY (Don't Repeat Yourself).
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 Special flags like C<-Debug> and C<-Engine> can also be specified as
184 arguments when Catalyst is loaded:
186 use Catalyst qw/-Debug My::Module/;
188 The position of plugins and flags in the chain is important, because
189 they are loaded in exactly the order in which they appear.
191 The following flags are supported:
195 Enables debug output.
199 Forces Catalyst to use a specific engine. Omit the
200 C<Catalyst::Engine::> prefix of the engine name, i.e.:
202 use Catalyst qw/-Engine=CGI/;
206 Forces Catalyst to use a specific home directory, e.g.:
208 use Catalyst qw[-Home=/usr/sri];
216 =head2 Information about the current request
220 Returns a L<Catalyst::Action> object for the current action, which
221 stringifies to the action name. See L<Catalyst::Action>.
225 Returns the namespace of the current action, i.e., the uri prefix
226 corresponding to the controller of the current action. For example:
228 # in Controller::Foo::Bar
229 $c->namespace; # returns 'foo/bar';
235 Returns the current L<Catalyst::Request> object. See
236 L<Catalyst::Request>.
238 =head2 Processing and response to the current request
240 =head2 $c->forward( $action [, \@arguments ] )
242 =head2 $c->forward( $class, $method, [, \@arguments ] )
244 Forwards processing to a private action. If you give a class name but no
245 method, C<process()> is called. You may also optionally pass arguments
246 in an arrayref. The action will receive the arguments in C<@_> and
247 C<$c-E<gt>req-E<gt>args>. Upon returning from the function,
248 C<$c-E<gt>req-E<gt>args> will be restored to the previous values.
250 Any data C<return>ed from the action forwarded to, will be returned by the
253 my $foodata = $c->forward('/foo');
254 $c->forward('index');
255 $c->forward(qw/MyApp::Model::CDBI::Foo do_stuff/);
256 $c->forward('MyApp::View::TT');
260 sub forward { my $c = shift; $c->dispatcher->forward( $c, @_ ) }
262 =head2 $c->detach( $action [, \@arguments ] )
264 =head2 $c->detach( $class, $method, [, \@arguments ] )
266 The same as C<forward>, but doesn't return.
270 sub detach { my $c = shift; $c->dispatcher->detach( $c, @_ ) }
274 =head2 $c->error($error, ...)
276 =head2 $c->error($arrayref)
278 Returns an arrayref containing error messages. If Catalyst encounters an
279 error while processing a request, it stores the error in $c->error. This
280 method should not be used to store non-fatal error messages.
282 my @error = @{ $c->error };
286 $c->error('Something bad happened');
288 Clear errors. You probably don't want to clear the errors unless you are
289 implementing a custom error screen.
298 my $error = ref $_[0] eq 'ARRAY' ? $_[0] : [@_];
299 push @{ $c->{error} }, @$error;
301 elsif ( defined $_[0] ) { $c->{error} = undef }
302 return $c->{error} || [];
309 Returns the current L<Catalyst::Response> object.
313 Returns a hashref to the stash, which may be used to store data and pass
314 it between components during a request. You can also set hash keys by
315 passing arguments. The stash is automatically sent to the view. The
316 stash is cleared at the end of a request; it cannot be used for
319 $c->stash->{foo} = $bar;
320 $c->stash( { moose => 'majestic', qux => 0 } );
321 $c->stash( bar => 1, gorch => 2 ); # equivalent to passing a hashref
323 # stash is automatically passed to the view for use in a template
324 $c->forward( 'MyApp::V::TT' );
331 my $stash = @_ > 1 ? {@_} : $_[0];
332 while ( my ( $key, $val ) = each %$stash ) {
333 $c->{stash}->{$key} = $val;
341 Contains the return value of the last executed action.
343 =head2 Component Accessors
345 =head2 $c->comp($name)
347 =head2 $c->component($name)
349 Gets a component object by name. This method is no longer recommended,
350 unless you want to get a specific component by full
351 class. C<$c-E<gt>controller>, C<$c-E<gt>model>, and C<$c-E<gt>view>
352 should be used instead.
363 my $appclass = ref $c || $c;
366 $name, "${appclass}::${name}",
367 map { "${appclass}::${_}::${name}" }
368 qw/Model M Controller C View V/
371 foreach my $try (@names) {
373 if ( exists $c->components->{$try} ) {
375 my $comp = $c->components->{$try};
376 if ( ref $comp && $comp->can('ACCEPT_CONTEXT') ) {
377 return $comp->ACCEPT_CONTEXT($c);
379 else { return $comp }
383 foreach my $component ( keys %{ $c->components } ) {
385 $comp = $c->components->{$component} if $component =~ /$name/i;
387 if ( ref $comp && $comp->can('ACCEPT_CONTEXT') ) {
388 return $comp->ACCEPT_CONTEXT($c);
390 else { return $comp }
396 return sort keys %{ $c->components };
399 =head2 $c->controller($name)
401 Gets a L<Catalyst::Controller> instance by name.
403 $c->controller('Foo')->do_stuff;
408 my ( $c, $name ) = @_;
409 my $controller = $c->comp("Controller::$name");
410 return $controller if defined $controller;
411 return $c->comp("C::$name");
414 =head2 $c->model($name)
416 Gets a L<Catalyst::Model> instance by name.
418 $c->model('Foo')->do_stuff;
423 my ( $c, $name ) = @_;
424 my $model = $c->comp("Model::$name");
425 return $model if defined $model;
426 return $c->comp("M::$name");
429 =head2 $c->view($name)
431 Gets a L<Catalyst::View> instance by name.
433 $c->view('Foo')->do_stuff;
438 my ( $c, $name ) = @_;
439 my $view = $c->comp("View::$name");
440 return $view if defined $view;
441 return $c->comp("V::$name");
444 =head2 Class data and helper classes
448 Returns or takes a hashref containing the application's configuration.
450 __PACKAGE__->config({ db => 'dsn:SQLite:foo.db' });
452 You can also use a L<YAML> config file like myapp.json in your
453 applications home directory.
456 db: dsn:SQLite:foo.db
460 Overload to enable debug messages (same as -Debug option).
466 =head2 $c->dispatcher
468 Returns the dispatcher instance. Stringifies to class name. See
469 L<Catalyst::Dispatcher>.
473 Returns the engine instance. Stringifies to the class name. See
478 Returns the logging object instance. Unless it is already set, Catalyst sets
479 this up with a L<Catalyst::Log> object. To use your own log class, set the
480 logger with the C<< __PACKAGE__->log >> method prior to calling
481 C<< __PACKAGE__->setup >>.
483 __PACKAGE__->log( MyLogger->new );
488 $c->log->info( 'Now logging with my own logger!' );
490 Your log class should implement the methods described in the
491 L<Catalyst::Log> man page.
495 =head2 Utility methods
497 =head2 $c->path_to(@path)
499 Merges C<@path> with C<$c-E<gt>config-E<gt>{home}> and returns a
500 L<Path::Class> object.
504 $c->path_to( 'db', 'sqlite.db' );
509 my ( $c, @path ) = @_;
510 my $path = dir( $c->config->{home}, @path );
511 if ( -d $path ) { return $path }
512 else { return file( $c->config->{home}, @path ) }
515 =head2 $c->plugin( $name, $class, @args )
517 Helper method for plugins. It creates a classdata accessor/mutator and
518 loads and instantiates the given class.
520 MyApp->plugin( 'prototype', 'HTML::Prototype' );
522 $c->prototype->define_javascript_functions;
527 my ( $class, $name, $plugin, @args ) = @_;
530 if ( my $error = $UNIVERSAL::require::ERROR ) {
531 Catalyst::Exception->throw(
532 message => qq/Couldn't load instant plugin "$plugin", "$error"/ );
535 eval { $plugin->import };
536 $class->mk_classdata($name);
538 eval { $obj = $plugin->new(@args) };
541 Catalyst::Exception->throw( message =>
542 qq/Couldn't instantiate instant plugin "$plugin", "$@"/ );
546 $class->log->debug(qq/Initialized instant plugin "$plugin" as "$name"/)
552 Initializes the dispatcher and engine, loads any plugins, and loads the
553 model, view, and controller components. You may also specify an array
554 of plugins to load here, if you choose to not load them in the C<use
558 MyApp->setup( qw/-Debug/ );
563 my ( $class, @arguments ) = @_;
565 unless ( $class->isa('Catalyst') ) {
567 Catalyst::Exception->throw(
568 message => qq/'$class' does not inherit from Catalyst/ );
571 if ( $class->arguments ) {
572 @arguments = ( @arguments, @{ $class->arguments } );
578 foreach (@arguments) {
582 ( $flags->{log} ) ? 'debug,' . $flags->{log} : 'debug';
584 elsif (/^-(\w+)=?(.*)$/) {
585 $flags->{ lc $1 } = $2;
588 push @{ $flags->{plugins} }, $_;
592 $class->setup_home( delete $flags->{home} );
594 # YAML config support
595 my $confpath = $class->config->{file}
597 ( Catalyst::Utils::appprefix( ref $class || $class ) . '.yml' ) );
599 if ( -f $confpath ) {
600 my $content = read_file("$confpath");
601 $conf = YAML::Syck::Load($content);
603 my $oldconf = $class->config;
604 $class->config( { %$oldconf, %$conf } );
606 $class->setup_log( delete $flags->{log} );
607 $class->setup_plugins( delete $flags->{plugins} );
608 $class->setup_dispatcher( delete $flags->{dispatcher} );
609 $class->setup_engine( delete $flags->{engine} );
611 for my $flag ( sort keys %{$flags} ) {
613 if ( my $code = $class->can( 'setup_' . $flag ) ) {
614 &$code( $class, delete $flags->{$flag} );
617 $class->log->warn(qq/Unknown flag "$flag"/);
622 <<"EOF") if ( $ENV{CATALYST_SCRIPT_GEN} && ( $ENV{CATALYST_SCRIPT_GEN} < $Catalyst::CATALYST_SCRIPT_GEN ) );
623 You are running an old script!
625 Please update by running (this will overwrite existing files):
626 catalyst.pl -force -scripts $class
628 or (this will not overwrite existing files):
629 catalyst.pl -scripts $class
632 if ( $class->debug ) {
639 map { $_ . ' ' . ( $_->VERSION || '' ) }
640 grep { /^Catalyst::Plugin/ } @{"$class\::ISA"};
644 my $t = Text::SimpleTable->new(76);
645 $t->row($_) for @plugins;
646 $class->log->debug( "Loaded plugins:\n" . $t->draw );
649 my $dispatcher = $class->dispatcher;
650 my $engine = $class->engine;
651 my $home = $class->config->{home};
653 $class->log->debug(qq/Loaded dispatcher "$dispatcher"/);
654 $class->log->debug(qq/Loaded engine "$engine"/);
658 ? $class->log->debug(qq/Found home "$home"/)
659 : $class->log->debug(qq/Home "$home" doesn't exist/)
660 : $class->log->debug(q/Couldn't find home/);
665 no warnings qw/redefine/;
666 local *setup = sub { };
670 # Initialize our data structure
671 $class->components( {} );
673 $class->setup_components;
675 if ( $class->debug ) {
676 my $t = Text::SimpleTable->new( [ 65, 'Class' ], [ 8, 'Type' ] );
677 for my $comp ( sort keys %{ $class->components } ) {
678 my $type = ref $class->components->{$comp} ? 'instance' : 'class';
679 $t->row( $comp, $type );
681 $class->log->debug( "Loaded components:\n" . $t->draw )
682 if ( keys %{ $class->components } );
685 # Add our self to components, since we are also a component
686 $class->components->{$class} = $class;
688 $class->setup_actions;
690 if ( $class->debug ) {
691 my $name = $class->config->{name} || 'Application';
692 $class->log->info("$name powered by Catalyst $Catalyst::VERSION");
694 $class->log->_flush() if $class->log->can('_flush');
697 =head2 $c->uri_for( $path, [ @args ] )
699 Merges path with C<$c-E<gt>request-E<gt>base> for absolute uri's and
700 with C<$c-E<gt>namespace> for relative uri's, then returns a
701 normalized L<URI> object. If any args are passed, they are added at the
707 my ( $c, $path, @args ) = @_;
708 my $base = $c->request->base->clone;
709 my $basepath = $base->path;
710 $basepath =~ s/\/$//;
712 my $namespace = $c->namespace;
714 # massage namespace, empty if absolute path
715 $namespace =~ s/^\///;
716 $namespace .= '/' if $namespace;
718 $namespace = '' if $path =~ /^\//;
721 # join args with '/', or a blank string
722 my $args = ( scalar @args ? '/' . join( '/', @args ) : '' );
723 $args =~ s/^\/// unless $path;
725 URI->new_abs( URI->new_abs( "$path$args", "$basepath$namespace" ), $base )
730 =head2 $c->welcome_message
732 Returns the Catalyst welcome HTML page.
736 sub welcome_message {
738 my $name = $c->config->{name};
739 my $logo = $c->uri_for('/static/images/catalyst_logo.png');
740 my $prefix = Catalyst::Utils::appprefix( ref $c );
741 $c->response->content_type('text/html; charset=utf-8');
743 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
744 "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
745 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
747 <meta http-equiv="Content-Language" content="en" />
748 <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
749 <title>$name on Catalyst $VERSION</title>
750 <style type="text/css">
753 background-color: #eee;
762 background-color: #ccc;
763 border: 1px solid #aaa;
764 -moz-border-radius: 10px;
769 font-family: verdana, tahoma, sans-serif;
772 font-family: verdana, tahoma, sans-serif;
775 text-decoration: none;
777 border-bottom: 1px dotted #bbb;
779 :link:hover, :visited:hover {
792 background-color: #fff;
793 border: 1px solid #aaa;
794 -moz-border-radius: 10px;
820 <h1><span id="appname">$name</span> on <a href="http://catalyst.perl.org">Catalyst</a>
825 <img src="$logo" alt="Catalyst Logo" />
827 <p>Welcome to the wonderful world of Catalyst.
828 This <a href="http://en.wikipedia.org/wiki/MVC">MVC</a>
829 framework will make web development something you had
830 never expected it to be: Fun, rewarding, and quick.</p>
831 <h2>What to do now?</h2>
832 <p>That really depends on what <b>you</b> want to do.
833 We do, however, provide you with a few starting points.</p>
834 <p>If you want to jump right into web development with Catalyst
835 you might want to check out the documentation.</p>
836 <pre><code>perldoc <a href="http://cpansearch.perl.org/dist/Catalyst/lib/Catalyst/Manual/Intro.pod">Catalyst::Manual::Intro</a>
837 perldoc <a href="http://cpansearch.perl.org/dist/Catalyst/lib/Catalyst/Manual/Tutorial.pod">Catalyst::Manual::Tutorial</a></code>
838 perldoc <a href="http://cpansearch.perl.org/dist/Catalyst/lib/Catalyst/Manual.pod">Catalyst::Manual</a></code></pre>
839 <h2>What to do next?</h2>
840 <p>Next it's time to write an actual application. Use the
841 helper scripts to generate <a href="http://cpansearch.perl.org/search?query=Catalyst%3A%3AController%3A%3A&mode=all">controllers</a>,
842 <a href="http://cpansearch.perl.org/search?query=Catalyst%3A%3AModel%3A%3A&mode=all">models</a>, and
843 <a href="http://cpansearch.perl.org/search?query=Catalyst%3A%3AView%3A%3A&mode=all">views</a>;
844 they can save you a lot of work.</p>
845 <pre><code>script/${prefix}_create.pl -help</code></pre>
846 <p>Also, be sure to check out the vast and growing
847 collection of <a href="http://cpansearch.perl.org/search?query=Catalyst%3A%3APlugin%3A%3A&mode=all">plugins for Catalyst on CPAN</a>;
848 you are likely to find what you need there.
852 <p>Catalyst has a very active community. Here are the main places to
853 get in touch with us.</p>
856 <a href="http://dev.catalyst.perl.org">Wiki</a>
859 <a href="http://lists.rawmode.org/mailman/listinfo/catalyst">Mailing-List</a>
862 <a href="irc://irc.perl.org/catalyst">IRC channel #catalyst on irc.perl.org</a>
865 <h2>In conclusion</h2>
866 <p>The Catalyst team hopes you will enjoy using Catalyst as much
867 as we enjoyed making it. Please contact us if you have ideas
868 for improvement or other feedback.</p>
876 =head1 INTERNAL METHODS
878 These methods are not meant to be used by end users.
880 =head2 $c->components
882 Returns a hash of components.
884 =head2 $c->context_class
886 Returns or sets the context class.
890 Returns a hashref containing coderefs and execution counts (needed for
891 deep recursion detection).
895 Returns the number of actions on the current internal execution stack.
899 Dispatches a request to actions.
903 sub dispatch { my $c = shift; $c->dispatcher->dispatch( $c, @_ ) }
905 =head2 $c->dispatcher_class
907 Returns or sets the dispatcher class.
909 =head2 $c->dump_these
911 Returns a list of 2-element array references (name, structure) pairs
912 that will be dumped on the error page in debug mode.
918 [ Request => $c->req ], [ Response => $c->res ], [ Stash => $c->stash ],;
921 =head2 $c->engine_class
923 Returns or sets the engine class.
925 =head2 $c->execute( $class, $coderef )
927 Execute a coderef in given class and catch exceptions. Errors are available
933 my ( $c, $class, $code ) = @_;
934 $class = $c->component($class) || $class;
938 my $action = "$code";
939 $action = "/$action" unless $action =~ /\-\>/;
940 $c->counter->{"$code"}++;
942 if ( $c->counter->{"$code"} > $RECURSION ) {
943 my $error = qq/Deep recursion detected in "$action"/;
944 $c->log->error($error);
950 # determine if the call was the result of a forward
951 # this is done by walking up the call stack and looking for a calling
952 # sub of Catalyst::forward before the eval
954 for my $index ( 1 .. 10 ) {
956 if ( ( caller($index) )[0] eq 'Catalyst'
957 && ( caller($index) )[3] eq '(eval)' );
959 if ( ( caller($index) )[3] =~ /forward$/ ) {
960 $callsub = ( caller($index) )[3];
961 $action = "-> $action";
966 my $node = Tree::Simple->new(
969 elapsed => undef, # to be filled in later
972 $node->setUID( "$code" . $c->counter->{"$code"} );
974 unless ( ( $code->name =~ /^_.*/ )
975 && ( !$c->config->{show_internal_actions} ) )
978 # is this a root-level call or a forwarded call?
979 if ( $callsub =~ /forward$/ ) {
981 # forward, locate the caller
982 if ( my $parent = $c->stack->[-1] ) {
983 my $visitor = Tree::Simple::Visitor::FindByUID->new;
984 $visitor->searchForUID(
985 "$parent" . $c->counter->{"$parent"} );
986 $c->{stats}->accept($visitor);
987 if ( my $result = $visitor->getResult ) {
988 $result->addChild($node);
993 # forward with no caller may come from a plugin
994 $c->{stats}->addChild($node);
1000 $c->{stats}->addChild($node);
1005 push( @{ $c->stack }, $code );
1008 $start = [gettimeofday] if $c->debug;
1009 eval { $c->state( &$code( $class, $c, @{ $c->req->args } ) || 0 ) };
1010 $elapsed = tv_interval($start) if $c->debug;
1013 unless ( ( $code->name =~ /^_.*/ )
1014 && ( !$c->config->{show_internal_actions} ) )
1017 # FindByUID uses an internal die, so we save the existing error
1020 # locate the node in the tree and update the elapsed time
1021 my $visitor = Tree::Simple::Visitor::FindByUID->new;
1022 $visitor->searchForUID( "$code" . $c->counter->{"$code"} );
1023 $c->{stats}->accept($visitor);
1024 if ( my $result = $visitor->getResult ) {
1025 my $value = $result->getNodeValue;
1026 $value->{elapsed} = sprintf( '%fs', $elapsed );
1027 $result->setNodeValue($value);
1031 $@ = $error || undef;
1034 my $last = ${ $c->stack }[-1];
1035 pop( @{ $c->stack } );
1037 if ( my $error = $@ ) {
1038 if ( $error eq $DETACH ) { die $DETACH if $c->depth > 1 }
1040 unless ( ref $error ) {
1042 my $class = $last->class;
1043 my $name = $last->name;
1044 $error = qq/Caught exception in $class->$name "$error"/;
1055 Finalizes the request.
1062 for my $error ( @{ $c->error } ) {
1063 $c->log->error($error);
1066 $c->finalize_uploads;
1069 if ( $#{ $c->error } >= 0 ) {
1073 $c->finalize_headers;
1076 if ( $c->request->method eq 'HEAD' ) {
1077 $c->response->body('');
1082 return $c->response->status;
1085 =head2 $c->finalize_body
1091 sub finalize_body { my $c = shift; $c->engine->finalize_body( $c, @_ ) }
1093 =head2 $c->finalize_cookies
1099 sub finalize_cookies { my $c = shift; $c->engine->finalize_cookies( $c, @_ ) }
1101 =head2 $c->finalize_error
1107 sub finalize_error { my $c = shift; $c->engine->finalize_error( $c, @_ ) }
1109 =head2 $c->finalize_headers
1115 sub finalize_headers {
1118 # Check if we already finalized headers
1119 return if $c->response->{_finalized_headers};
1122 if ( my $location = $c->response->redirect ) {
1123 $c->log->debug(qq/Redirecting to "$location"/) if $c->debug;
1124 $c->response->header( Location => $location );
1128 if ( $c->response->body && !$c->response->content_length ) {
1130 # get the length from a filehandle
1131 if ( ref $c->response->body && $c->response->body->can('read') ) {
1132 if ( my $stat = stat $c->response->body ) {
1133 $c->response->content_length( $stat->size );
1136 $c->log->warn('Serving filehandle without a content-length');
1140 $c->response->content_length( bytes::length( $c->response->body ) );
1145 if ( $c->response->status =~ /^(1\d\d|[23]04)$/ ) {
1146 $c->response->headers->remove_header("Content-Length");
1147 $c->response->body('');
1150 $c->finalize_cookies;
1152 $c->engine->finalize_headers( $c, @_ );
1155 $c->response->{_finalized_headers} = 1;
1158 =head2 $c->finalize_output
1160 An alias for finalize_body.
1162 =head2 $c->finalize_read
1164 Finalizes the input after reading is complete.
1168 sub finalize_read { my $c = shift; $c->engine->finalize_read( $c, @_ ) }
1170 =head2 $c->finalize_uploads
1172 Finalizes uploads. Cleans up any temporary files.
1176 sub finalize_uploads { my $c = shift; $c->engine->finalize_uploads( $c, @_ ) }
1178 =head2 $c->get_action( $action, $namespace )
1180 Gets an action in a given namespace.
1184 sub get_action { my $c = shift; $c->dispatcher->get_action(@_) }
1186 =head2 $c->get_actions( $action, $namespace )
1188 Gets all actions of a given name in a namespace and all parent
1193 sub get_actions { my $c = shift; $c->dispatcher->get_actions( $c, @_ ) }
1195 =head2 handle_request( $class, @arguments )
1197 Called to handle each HTTP request.
1201 sub handle_request {
1202 my ( $class, @arguments ) = @_;
1204 # Always expect worst case!
1207 my $stats = ( $class->debug ) ? Tree::Simple->new: q{};
1210 my $c = $class->prepare(@arguments);
1211 $c->{stats} = $stats;
1213 return $c->finalize;
1216 if ( $class->debug ) {
1217 my $start = [gettimeofday];
1218 $status = &$handler;
1219 my $elapsed = tv_interval $start;
1220 $elapsed = sprintf '%f', $elapsed;
1221 my $av = sprintf '%.3f',
1222 ( $elapsed == 0 ? '??' : ( 1 / $elapsed ) );
1223 my $t = Text::SimpleTable->new( [ 64, 'Action' ], [ 9, 'Time' ] );
1228 my $stat = $action->getNodeValue;
1229 $t->row( ( q{ } x $action->getDepth ) . $stat->{action},
1230 $stat->{elapsed} || '??' );
1235 "Request took ${elapsed}s ($av/s)\n" . $t->draw );
1237 else { $status = &$handler }
1241 if ( my $error = $@ ) {
1243 $class->log->error(qq/Caught exception in engine "$error"/);
1247 $class->log->_flush() if $class->log->can('_flush');
1251 =head2 $c->prepare( @arguments )
1253 Creates a Catalyst context from an engine-specific request (Apache, CGI,
1259 my ( $class, @arguments ) = @_;
1261 $class->context_class( ref $class || $class ) unless $class->context_class;
1262 my $c = $class->context_class->new(
1266 request => $class->request_class->new(
1269 body_parameters => {},
1271 headers => HTTP::Headers->new,
1273 query_parameters => {},
1279 response => $class->response_class->new(
1283 headers => HTTP::Headers->new(),
1292 # For on-demand data
1293 $c->request->{_context} = $c;
1294 $c->response->{_context} = $c;
1295 weaken( $c->request->{_context} );
1296 weaken( $c->response->{_context} );
1299 my $secs = time - $START || 1;
1300 my $av = sprintf '%.3f', $COUNT / $secs;
1301 $c->log->debug('**********************************');
1302 $c->log->debug("* Request $COUNT ($av/s) [$$]");
1303 $c->log->debug('**********************************');
1304 $c->res->headers->header( 'X-Catalyst' => $Catalyst::VERSION );
1307 $c->prepare_request(@arguments);
1308 $c->prepare_connection;
1309 $c->prepare_query_parameters;
1310 $c->prepare_headers;
1311 $c->prepare_cookies;
1315 $c->prepare_body unless $c->config->{parse_on_demand};
1317 my $method = $c->req->method || '';
1318 my $path = $c->req->path || '';
1319 my $address = $c->req->address || '';
1321 $c->log->debug(qq/"$method" request for "$path" from "$address"/)
1329 =head2 $c->prepare_action
1335 sub prepare_action { my $c = shift; $c->dispatcher->prepare_action( $c, @_ ) }
1337 =head2 $c->prepare_body
1339 Prepares message body.
1346 # Do we run for the first time?
1347 return if defined $c->request->{_body};
1349 # Initialize on-demand data
1350 $c->engine->prepare_body( $c, @_ );
1351 $c->prepare_parameters;
1352 $c->prepare_uploads;
1354 if ( $c->debug && keys %{ $c->req->body_parameters } ) {
1355 my $t = Text::SimpleTable->new( [ 37, 'Key' ], [ 36, 'Value' ] );
1356 for my $key ( sort keys %{ $c->req->body_parameters } ) {
1357 my $param = $c->req->body_parameters->{$key};
1358 my $value = defined($param) ? $param : '';
1360 ref $value eq 'ARRAY' ? ( join ', ', @$value ) : $value );
1362 $c->log->debug( "Body Parameters are:\n" . $t->draw );
1366 =head2 $c->prepare_body_chunk( $chunk )
1368 Prepares a chunk of data before sending it to L<HTTP::Body>.
1372 sub prepare_body_chunk {
1374 $c->engine->prepare_body_chunk( $c, @_ );
1377 =head2 $c->prepare_body_parameters
1379 Prepares body parameters.
1383 sub prepare_body_parameters {
1385 $c->engine->prepare_body_parameters( $c, @_ );
1388 =head2 $c->prepare_connection
1390 Prepares connection.
1394 sub prepare_connection {
1396 $c->engine->prepare_connection( $c, @_ );
1399 =head2 $c->prepare_cookies
1405 sub prepare_cookies { my $c = shift; $c->engine->prepare_cookies( $c, @_ ) }
1407 =head2 $c->prepare_headers
1413 sub prepare_headers { my $c = shift; $c->engine->prepare_headers( $c, @_ ) }
1415 =head2 $c->prepare_parameters
1417 Prepares parameters.
1421 sub prepare_parameters {
1423 $c->prepare_body_parameters;
1424 $c->engine->prepare_parameters( $c, @_ );
1427 =head2 $c->prepare_path
1429 Prepares path and base.
1433 sub prepare_path { my $c = shift; $c->engine->prepare_path( $c, @_ ) }
1435 =head2 $c->prepare_query_parameters
1437 Prepares query parameters.
1441 sub prepare_query_parameters {
1444 $c->engine->prepare_query_parameters( $c, @_ );
1446 if ( $c->debug && keys %{ $c->request->query_parameters } ) {
1447 my $t = Text::SimpleTable->new( [ 37, 'Key' ], [ 36, 'Value' ] );
1448 for my $key ( sort keys %{ $c->req->query_parameters } ) {
1449 my $param = $c->req->query_parameters->{$key};
1450 my $value = defined($param) ? $param : '';
1452 ref $value eq 'ARRAY' ? ( join ', ', @$value ) : $value );
1454 $c->log->debug( "Query Parameters are:\n" . $t->draw );
1458 =head2 $c->prepare_read
1460 Prepares the input for reading.
1464 sub prepare_read { my $c = shift; $c->engine->prepare_read( $c, @_ ) }
1466 =head2 $c->prepare_request
1468 Prepares the engine request.
1472 sub prepare_request { my $c = shift; $c->engine->prepare_request( $c, @_ ) }
1474 =head2 $c->prepare_uploads
1480 sub prepare_uploads {
1483 $c->engine->prepare_uploads( $c, @_ );
1485 if ( $c->debug && keys %{ $c->request->uploads } ) {
1486 my $t = Text::SimpleTable->new(
1492 for my $key ( sort keys %{ $c->request->uploads } ) {
1493 my $upload = $c->request->uploads->{$key};
1494 for my $u ( ref $upload eq 'ARRAY' ? @{$upload} : ($upload) ) {
1495 $t->row( $key, $u->filename, $u->type, $u->size );
1498 $c->log->debug( "File Uploads are:\n" . $t->draw );
1502 =head2 $c->prepare_write
1504 Prepares the output for writing.
1508 sub prepare_write { my $c = shift; $c->engine->prepare_write( $c, @_ ) }
1510 =head2 $c->request_class
1512 Returns or sets the request class.
1514 =head2 $c->response_class
1516 Returns or sets the response class.
1518 =head2 $c->read( [$maxlength] )
1520 Reads a chunk of data from the request body. This method is designed to
1521 be used in a while loop, reading C<$maxlength> bytes on every call.
1522 C<$maxlength> defaults to the size of the request if not specified.
1524 You have to set C<MyApp-E<gt>config-E<gt>{parse_on_demand}> to use this
1529 sub read { my $c = shift; return $c->engine->read( $c, @_ ) }
1537 sub run { my $c = shift; return $c->engine->run( $c, @_ ) }
1539 =head2 $c->set_action( $action, $code, $namespace, $attrs )
1541 Sets an action in a given namespace.
1545 sub set_action { my $c = shift; $c->dispatcher->set_action( $c, @_ ) }
1547 =head2 $c->setup_actions($component)
1549 Sets up actions for a component.
1553 sub setup_actions { my $c = shift; $c->dispatcher->setup_actions( $c, @_ ) }
1555 =head2 $c->setup_components
1561 sub setup_components {
1564 my $callback = sub {
1565 my ( $component, $context ) = @_;
1567 unless ( $component->can('COMPONENT') ) {
1571 my $suffix = Catalyst::Utils::class2classsuffix($component);
1572 my $config = $class->config->{$suffix} || {};
1576 eval { $instance = $component->COMPONENT( $context, $config ); };
1578 if ( my $error = $@ ) {
1582 Catalyst::Exception->throw( message =>
1583 qq/Couldn't instantiate component "$component", "$error"/ );
1586 Catalyst::Exception->throw( message =>
1587 qq/Couldn't instantiate component "$component", "new() didn't return a object"/
1589 unless ref $instance;
1593 eval "package $class;\n" . q!Module::Pluggable::Fast->import(
1594 name => '_catalyst_components',
1596 "$class\::Controller", "$class\::C",
1597 "$class\::Model", "$class\::M",
1598 "$class\::View", "$class\::V"
1600 callback => $callback
1604 if ( my $error = $@ ) {
1608 Catalyst::Exception->throw(
1609 message => qq/Couldn't load components "$error"/ );
1612 for my $component ( $class->_catalyst_components($class) ) {
1613 $class->components->{ ref $component || $component } = $component;
1617 =head2 $c->setup_dispatcher
1623 sub setup_dispatcher {
1624 my ( $class, $dispatcher ) = @_;
1627 $dispatcher = 'Catalyst::Dispatcher::' . $dispatcher;
1630 if ( $ENV{CATALYST_DISPATCHER} ) {
1631 $dispatcher = 'Catalyst::Dispatcher::' . $ENV{CATALYST_DISPATCHER};
1634 if ( $ENV{ uc($class) . '_DISPATCHER' } ) {
1636 'Catalyst::Dispatcher::' . $ENV{ uc($class) . '_DISPATCHER' };
1639 unless ($dispatcher) {
1640 $dispatcher = $class->dispatcher_class;
1643 $dispatcher->require;
1646 Catalyst::Exception->throw(
1647 message => qq/Couldn't load dispatcher "$dispatcher", "$@"/ );
1650 # dispatcher instance
1651 $class->dispatcher( $dispatcher->new );
1654 =head2 $c->setup_engine
1661 my ( $class, $engine ) = @_;
1664 $engine = 'Catalyst::Engine::' . $engine;
1667 if ( $ENV{CATALYST_ENGINE} ) {
1668 $engine = 'Catalyst::Engine::' . $ENV{CATALYST_ENGINE};
1671 if ( $ENV{ uc($class) . '_ENGINE' } ) {
1672 $engine = 'Catalyst::Engine::' . $ENV{ uc($class) . '_ENGINE' };
1675 if ( $ENV{MOD_PERL} ) {
1677 # create the apache method
1680 *{"$class\::apache"} = sub { shift->engine->apache };
1683 my ( $software, $version ) =
1684 $ENV{MOD_PERL} =~ /^(\S+)\/(\d+(?:[\.\_]\d+)+)/;
1687 $version =~ s/(\.[^.]+)\./$1/g;
1689 if ( $software eq 'mod_perl' ) {
1693 if ( $version >= 1.99922 ) {
1694 $engine = 'Catalyst::Engine::Apache2::MP20';
1697 elsif ( $version >= 1.9901 ) {
1698 $engine = 'Catalyst::Engine::Apache2::MP19';
1701 elsif ( $version >= 1.24 ) {
1702 $engine = 'Catalyst::Engine::Apache::MP13';
1706 Catalyst::Exception->throw( message =>
1707 qq/Unsupported mod_perl version: $ENV{MOD_PERL}/ );
1712 # install the correct mod_perl handler
1713 if ( $version >= 1.9901 ) {
1714 *handler = sub : method {
1715 shift->handle_request(@_);
1719 *handler = sub ($$) { shift->handle_request(@_) };
1724 elsif ( $software eq 'Zeus-Perl' ) {
1725 $engine = 'Catalyst::Engine::Zeus';
1729 Catalyst::Exception->throw(
1730 message => qq/Unsupported mod_perl: $ENV{MOD_PERL}/ );
1735 $engine = $class->engine_class;
1741 Catalyst::Exception->throw( message =>
1742 qq/Couldn't load engine "$engine" (maybe you forgot to install it?), "$@"/
1746 # check for old engines that are no longer compatible
1748 if ( $engine->isa('Catalyst::Engine::Apache')
1749 && !Catalyst::Engine::Apache->VERSION )
1754 elsif ( $engine->isa('Catalyst::Engine::Server::Base')
1755 && Catalyst::Engine::Server->VERSION le '0.02' )
1760 elsif ($engine->isa('Catalyst::Engine::HTTP::POE')
1761 && $engine->VERSION eq '0.01' )
1766 elsif ($engine->isa('Catalyst::Engine::Zeus')
1767 && $engine->VERSION eq '0.01' )
1773 Catalyst::Exception->throw( message =>
1774 qq/Engine "$engine" is not supported by this version of Catalyst/
1779 $class->engine( $engine->new );
1782 =head2 $c->setup_home
1784 Sets up the home directory.
1789 my ( $class, $home ) = @_;
1791 if ( $ENV{CATALYST_HOME} ) {
1792 $home = $ENV{CATALYST_HOME};
1795 if ( $ENV{ uc($class) . '_HOME' } ) {
1796 $home = $ENV{ uc($class) . '_HOME' };
1800 $home = Catalyst::Utils::home($class);
1804 $class->config->{home} ||= $home;
1805 $class->config->{root} ||= dir($home)->subdir('root');
1809 =head2 $c->setup_log
1816 my ( $class, $debug ) = @_;
1818 unless ( $class->log ) {
1819 $class->log( Catalyst::Log->new );
1822 my $app_flag = Catalyst::Utils::class2env($class) . '_DEBUG';
1825 ( defined( $ENV{CATALYST_DEBUG} ) || defined( $ENV{$app_flag} ) )
1826 ? ( $ENV{CATALYST_DEBUG} || $ENV{$app_flag} )
1831 *{"$class\::debug"} = sub { 1 };
1832 $class->log->debug('Debug messages enabled');
1836 =head2 $c->setup_plugins
1843 my ( $class, $plugins ) = @_;
1846 for my $plugin ( reverse @$plugins ) {
1848 $plugin = "Catalyst::Plugin::$plugin";
1853 Catalyst::Exception->throw(
1854 message => qq/Couldn't load plugin "$plugin", "$@"/ );
1859 unshift @{"$class\::ISA"}, $plugin;
1868 =head2 $c->write( $data )
1870 Writes $data to the output stream. When using this method directly, you
1871 will need to manually set the C<Content-Length> header to the length of
1872 your output data, if known.
1879 # Finalize headers if someone manually writes output
1880 $c->finalize_headers;
1882 return $c->engine->write( $c, @_ );
1887 Returns the Catalyst version number. Mostly useful for "powered by"
1888 messages in template systems.
1892 sub version { return $Catalyst::VERSION }
1894 =head1 INTERNAL ACTIONS
1896 Catalyst uses internal actions like C<_DISPATCH>, C<_BEGIN>, C<_AUTO>,
1897 C<_ACTION>, and C<_END>. These are by default not shown in the private
1898 action table, but you can make them visible with a config parameter.
1900 MyApp->config->{show_internal_actions} = 1;
1902 =head1 CASE SENSITIVITY
1904 By default Catalyst is not case sensitive, so C<MyApp::C::FOO::Bar> is
1905 mapped to C</foo/bar>. You can activate case sensitivity with a config
1908 MyApp->config->{case_sensitive} = 1;
1910 This causes C<MyApp::C::Foo::Bar> to map to C</Foo/Bar>.
1912 =head1 ON-DEMAND PARSER
1914 The request body is usually parsed at the beginning of a request,
1915 but if you want to handle input yourself or speed things up a bit,
1916 you can enable on-demand parsing with a config parameter.
1918 MyApp->config->{parse_on_demand} = 1;
1920 =head1 PROXY SUPPORT
1922 Many production servers operate using the common double-server approach,
1923 with a lightweight frontend web server passing requests to a larger
1924 backend server. An application running on the backend server must deal
1925 with two problems: the remote user always appears to be C<127.0.0.1> and
1926 the server's hostname will appear to be C<localhost> regardless of the
1927 virtual host that the user connected through.
1929 Catalyst will automatically detect this situation when you are running
1930 the frontend and backend servers on the same machine. The following
1931 changes are made to the request.
1933 $c->req->address is set to the user's real IP address, as read from
1934 the HTTP X-Forwarded-For header.
1936 The host value for $c->req->base and $c->req->uri is set to the real
1937 host, as read from the HTTP X-Forwarded-Host header.
1939 Obviously, your web server must support these headers for this to work.
1941 In a more complex server farm environment where you may have your
1942 frontend proxy server(s) on different machines, you will need to set a
1943 configuration option to tell Catalyst to read the proxied data from the
1946 MyApp->config->{using_frontend_proxy} = 1;
1948 If you do not wish to use the proxy support at all, you may set:
1950 MyApp->config->{ignore_frontend_proxy} = 1;
1952 =head1 THREAD SAFETY
1954 Catalyst has been tested under Apache 2's threading mpm_worker, mpm_winnt,
1955 and the standalone forking HTTP server on Windows. We believe the Catalyst
1956 core to be thread-safe.
1958 If you plan to operate in a threaded environment, remember that all other
1959 modules you are using must also be thread-safe. Some modules, most notably
1960 L<DBD::SQLite>, are not thread-safe.
1966 Join #catalyst on irc.perl.org.
1970 http://lists.rawmode.org/mailman/listinfo/catalyst
1971 http://lists.rawmode.org/mailman/listinfo/catalyst-dev
1975 http://catalyst.perl.org
1979 http://dev.catalyst.perl.org
1983 =head2 L<Task::Catalyst> - All you need to start with Catalyst
1985 =head2 L<Catalyst::Manual> - The Catalyst Manual
1987 =head2 L<Catalyst::Component>, L<Catalyst::Base> - Base classes for components
1989 =head2 L<Catalyst::Engine> - Core engine
1991 =head2 L<Catalyst::Log> - Log class.
1993 =head2 L<Catalyst::Request> - Request object
1995 =head2 L<Catalyst::Response> - Response object
1997 =head2 L<Catalyst::Test> - The test suite.
2067 Sebastian Riedel, C<sri@oook.de>
2071 This library is free software, you can redistribute it and/or modify it under
2072 the same terms as Perl itself.