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 = 25;
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<JSON> config file like myapp.json in your
453 applications home directory.
456 "db": "dsn:SQLite:foo.db"
461 Overload to enable debug messages (same as -Debug option).
467 =head2 $c->dispatcher
469 Returns the dispatcher instance. Stringifies to class name. See
470 L<Catalyst::Dispatcher>.
474 Returns the engine instance. Stringifies to the class name. See
479 Returns the logging object instance. Unless it is already set, Catalyst sets
480 this up with a L<Catalyst::Log> object. To use your own log class, set the
481 logger with the C<< __PACKAGE__->log >> method prior to calling
482 C<< __PACKAGE__->setup >>.
484 __PACKAGE__->log( MyLogger->new );
489 $c->log->info( 'Now logging with my own logger!' );
491 Your log class should implement the methods described in the
492 L<Catalyst::Log> man page.
496 =head2 Utility methods
498 =head2 $c->path_to(@path)
500 Merges C<@path> with C<$c-E<gt>config-E<gt>{home}> and returns a
501 L<Path::Class> object.
505 $c->path_to( 'db', 'sqlite.db' );
510 my ( $c, @path ) = @_;
511 my $path = dir( $c->config->{home}, @path );
512 if ( -d $path ) { return $path }
513 else { return file( $c->config->{home}, @path ) }
516 =head2 $c->plugin( $name, $class, @args )
518 Helper method for plugins. It creates a classdata accessor/mutator and
519 loads and instantiates the given class.
521 MyApp->plugin( 'prototype', 'HTML::Prototype' );
523 $c->prototype->define_javascript_functions;
528 my ( $class, $name, $plugin, @args ) = @_;
531 if ( my $error = $UNIVERSAL::require::ERROR ) {
532 Catalyst::Exception->throw(
533 message => qq/Couldn't load instant plugin "$plugin", "$error"/ );
536 eval { $plugin->import };
537 $class->mk_classdata($name);
539 eval { $obj = $plugin->new(@args) };
542 Catalyst::Exception->throw( message =>
543 qq/Couldn't instantiate instant plugin "$plugin", "$@"/ );
547 $class->log->debug(qq/Initialized instant plugin "$plugin" as "$name"/)
553 Initializes the dispatcher and engine, loads any plugins, and loads the
554 model, view, and controller components. You may also specify an array
555 of plugins to load here, if you choose to not load them in the C<use
559 MyApp->setup( qw/-Debug/ );
564 my ( $class, @arguments ) = @_;
566 unless ( $class->isa('Catalyst') ) {
568 Catalyst::Exception->throw(
569 message => qq/'$class' does not inherit from Catalyst/ );
572 if ( $class->arguments ) {
573 @arguments = ( @arguments, @{ $class->arguments } );
579 foreach (@arguments) {
583 ( $flags->{log} ) ? 'debug,' . $flags->{log} : 'debug';
585 elsif (/^-(\w+)=?(.*)$/) {
586 $flags->{ lc $1 } = $2;
589 push @{ $flags->{plugins} }, $_;
593 $class->setup_home( delete $flags->{home} );
595 # JSON config support
596 my $confpath = $class->config->{file}
598 ( Catalyst::Utils::appprefix( ref $class || $class ) . '.json' ) );
600 if ( -f $confpath ) {
601 my $content = read_file("$confpath");
602 $conf = jsonToObj($content);
604 my $oldconf = $class->config;
605 $class->config( { %$oldconf, %$conf } );
607 $class->setup_log( delete $flags->{log} );
608 $class->setup_plugins( delete $flags->{plugins} );
609 $class->setup_dispatcher( delete $flags->{dispatcher} );
610 $class->setup_engine( delete $flags->{engine} );
612 for my $flag ( sort keys %{$flags} ) {
614 if ( my $code = $class->can( 'setup_' . $flag ) ) {
615 &$code( $class, delete $flags->{$flag} );
618 $class->log->warn(qq/Unknown flag "$flag"/);
623 <<"EOF") if ( $ENV{CATALYST_SCRIPT_GEN} && ( $ENV{CATALYST_SCRIPT_GEN} < $Catalyst::CATALYST_SCRIPT_GEN ) );
624 You are running an old script!
626 Please update by running (this will overwrite existing files):
627 catalyst.pl -force -scripts $class
629 or (this will not overwrite existing files):
630 catalyst.pl -scripts $class
633 if ( $class->debug ) {
640 map { $_ . ' ' . ( $_->VERSION || '' ) }
641 grep { /^Catalyst::Plugin/ } @{"$class\::ISA"};
645 my $t = Text::SimpleTable->new(76);
646 $t->row($_) for @plugins;
647 $class->log->debug( "Loaded plugins:\n" . $t->draw );
650 my $dispatcher = $class->dispatcher;
651 my $engine = $class->engine;
652 my $home = $class->config->{home};
654 $class->log->debug(qq/Loaded dispatcher "$dispatcher"/);
655 $class->log->debug(qq/Loaded engine "$engine"/);
659 ? $class->log->debug(qq/Found home "$home"/)
660 : $class->log->debug(qq/Home "$home" doesn't exist/)
661 : $class->log->debug(q/Couldn't find home/);
666 no warnings qw/redefine/;
667 local *setup = sub { };
671 # Initialize our data structure
672 $class->components( {} );
674 $class->setup_components;
676 if ( $class->debug ) {
677 my $t = Text::SimpleTable->new( [ 65, 'Class' ], [ 8, 'Type' ] );
678 for my $comp ( sort keys %{ $class->components } ) {
679 my $type = ref $class->components->{$comp} ? 'instance' : 'class';
680 $t->row( $comp, $type );
682 $class->log->debug( "Loaded components:\n" . $t->draw )
683 if ( keys %{ $class->components } );
686 # Add our self to components, since we are also a component
687 $class->components->{$class} = $class;
689 $class->setup_actions;
691 if ( $class->debug ) {
692 my $name = $class->config->{name} || 'Application';
693 $class->log->info("$name powered by Catalyst $Catalyst::VERSION");
695 $class->log->_flush() if $class->log->can('_flush');
698 =head2 $c->uri_for( $path, [ @args ] )
700 Merges path with C<$c-E<gt>request-E<gt>base> for absolute uri's and
701 with C<$c-E<gt>namespace> for relative uri's, then returns a
702 normalized L<URI> object. If any args are passed, they are added at the
708 my ( $c, $path, @args ) = @_;
709 my $base = $c->request->base->clone;
710 my $basepath = $base->path;
711 $basepath =~ s/\/$//;
713 my $namespace = $c->namespace;
715 # massage namespace, empty if absolute path
716 $namespace =~ s/^\///;
717 $namespace .= '/' if $namespace;
719 $namespace = '' if $path =~ /^\//;
722 # join args with '/', or a blank string
723 my $args = ( scalar @args ? '/' . join( '/', @args ) : '' );
724 $args =~ s/^\/// unless $path;
726 URI->new_abs( URI->new_abs( "$path$args", "$basepath$namespace" ), $base )
731 =head2 $c->welcome_message
733 Returns the Catalyst welcome HTML page.
737 sub welcome_message {
739 my $name = $c->config->{name};
740 my $logo = $c->uri_for('/static/images/catalyst_logo.png');
741 my $prefix = Catalyst::Utils::appprefix( ref $c );
742 $c->response->content_type('text/html; charset=utf-8');
744 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
745 "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
746 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
748 <meta http-equiv="Content-Language" content="en" />
749 <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
750 <title>$name on Catalyst $VERSION</title>
751 <style type="text/css">
754 background-color: #eee;
763 background-color: #ccc;
764 border: 1px solid #aaa;
765 -moz-border-radius: 10px;
770 font-family: verdana, tahoma, sans-serif;
773 font-family: verdana, tahoma, sans-serif;
776 text-decoration: none;
778 border-bottom: 1px dotted #bbb;
780 :link:hover, :visited:hover {
793 background-color: #fff;
794 border: 1px solid #aaa;
795 -moz-border-radius: 10px;
821 <h1><span id="appname">$name</span> on <a href="http://catalyst.perl.org">Catalyst</a>
826 <img src="$logo" alt="Catalyst Logo" />
828 <p>Welcome to the wonderful world of Catalyst.
829 This <a href="http://en.wikipedia.org/wiki/MVC">MVC</a>
830 framework will make web development something you had
831 never expected it to be: Fun, rewarding, and quick.</p>
832 <h2>What to do now?</h2>
833 <p>That really depends on what <b>you</b> want to do.
834 We do, however, provide you with a few starting points.</p>
835 <p>If you want to jump right into web development with Catalyst
836 you might want to check out the documentation.</p>
837 <pre><code>perldoc <a href="http://cpansearch.perl.org/dist/Catalyst/lib/Catalyst/Manual/Intro.pod">Catalyst::Manual::Intro</a>
838 perldoc <a href="http://cpansearch.perl.org/dist/Catalyst/lib/Catalyst/Manual/Tutorial.pod">Catalyst::Manual::Tutorial</a></code>
839 perldoc <a href="http://cpansearch.perl.org/dist/Catalyst/lib/Catalyst/Manual.pod">Catalyst::Manual</a></code></pre>
840 <h2>What to do next?</h2>
841 <p>Next it's time to write an actual application. Use the
842 helper scripts to generate <a href="http://cpansearch.perl.org/search?query=Catalyst%3A%3AController%3A%3A&mode=all">controllers</a>,
843 <a href="http://cpansearch.perl.org/search?query=Catalyst%3A%3AModel%3A%3A&mode=all">models</a>, and
844 <a href="http://cpansearch.perl.org/search?query=Catalyst%3A%3AView%3A%3A&mode=all">views</a>;
845 they can save you a lot of work.</p>
846 <pre><code>script/${prefix}_create.pl -help</code></pre>
847 <p>Also, be sure to check out the vast and growing
848 collection of <a href="http://cpansearch.perl.org/search?query=Catalyst%3A%3APlugin%3A%3A&mode=all">plugins for Catalyst on CPAN</a>;
849 you are likely to find what you need there.
853 <p>Catalyst has a very active community. Here are the main places to
854 get in touch with us.</p>
857 <a href="http://dev.catalyst.perl.org">Wiki</a>
860 <a href="http://lists.rawmode.org/mailman/listinfo/catalyst">Mailing-List</a>
863 <a href="irc://irc.perl.org/catalyst">IRC channel #catalyst on irc.perl.org</a>
866 <h2>In conclusion</h2>
867 <p>The Catalyst team hopes you will enjoy using Catalyst as much
868 as we enjoyed making it. Please contact us if you have ideas
869 for improvement or other feedback.</p>
877 =head1 INTERNAL METHODS
879 These methods are not meant to be used by end users.
881 =head2 $c->components
883 Returns a hash of components.
885 =head2 $c->context_class
887 Returns or sets the context class.
891 Returns a hashref containing coderefs and execution counts (needed for
892 deep recursion detection).
896 Returns the number of actions on the current internal execution stack.
900 Dispatches a request to actions.
904 sub dispatch { my $c = shift; $c->dispatcher->dispatch( $c, @_ ) }
906 =head2 $c->dispatcher_class
908 Returns or sets the dispatcher class.
910 =head2 $c->dump_these
912 Returns a list of 2-element array references (name, structure) pairs
913 that will be dumped on the error page in debug mode.
919 [ Request => $c->req ], [ Response => $c->res ], [ Stash => $c->stash ],;
922 =head2 $c->engine_class
924 Returns or sets the engine class.
926 =head2 $c->execute( $class, $coderef )
928 Execute a coderef in given class and catch exceptions. Errors are available
934 my ( $c, $class, $code ) = @_;
935 $class = $c->component($class) || $class;
939 my $action = "$code";
940 $action = "/$action" unless $action =~ /\-\>/;
941 $c->counter->{"$code"}++;
943 if ( $c->counter->{"$code"} > $RECURSION ) {
944 my $error = qq/Deep recursion detected in "$action"/;
945 $c->log->error($error);
951 # determine if the call was the result of a forward
952 # this is done by walking up the call stack and looking for a calling
953 # sub of Catalyst::forward before the eval
955 for my $index ( 1 .. 10 ) {
957 if ( ( caller($index) )[0] eq 'Catalyst'
958 && ( caller($index) )[3] eq '(eval)' );
960 if ( ( caller($index) )[3] =~ /forward$/ ) {
961 $callsub = ( caller($index) )[3];
962 $action = "-> $action";
967 my $node = Tree::Simple->new(
970 elapsed => undef, # to be filled in later
973 $node->setUID( "$code" . $c->counter->{"$code"} );
975 unless ( ( $code->name =~ /^_.*/ )
976 && ( !$c->config->{show_internal_actions} ) )
979 # is this a root-level call or a forwarded call?
980 if ( $callsub =~ /forward$/ ) {
982 # forward, locate the caller
983 if ( my $parent = $c->stack->[-1] ) {
984 my $visitor = Tree::Simple::Visitor::FindByUID->new;
985 $visitor->searchForUID(
986 "$parent" . $c->counter->{"$parent"} );
987 $c->{stats}->accept($visitor);
988 if ( my $result = $visitor->getResult ) {
989 $result->addChild($node);
994 # forward with no caller may come from a plugin
995 $c->{stats}->addChild($node);
1001 $c->{stats}->addChild($node);
1006 push( @{ $c->stack }, $code );
1009 $start = [gettimeofday] if $c->debug;
1010 eval { $c->state( &$code( $class, $c, @{ $c->req->args } ) || 0 ) };
1011 $elapsed = tv_interval($start) if $c->debug;
1014 unless ( ( $code->name =~ /^_.*/ )
1015 && ( !$c->config->{show_internal_actions} ) )
1018 # FindByUID uses an internal die, so we save the existing error
1021 # locate the node in the tree and update the elapsed time
1022 my $visitor = Tree::Simple::Visitor::FindByUID->new;
1023 $visitor->searchForUID( "$code" . $c->counter->{"$code"} );
1024 $c->{stats}->accept($visitor);
1025 if ( my $result = $visitor->getResult ) {
1026 my $value = $result->getNodeValue;
1027 $value->{elapsed} = sprintf( '%fs', $elapsed );
1028 $result->setNodeValue($value);
1032 $@ = $error || undef;
1035 my $last = ${ $c->stack }[-1];
1036 pop( @{ $c->stack } );
1038 if ( my $error = $@ ) {
1039 if ( $error eq $DETACH ) { die $DETACH if $c->depth > 1 }
1041 unless ( ref $error ) {
1043 my $class = $last->class;
1044 my $name = $last->name;
1045 $error = qq/Caught exception in $class->$name "$error"/;
1056 Finalizes the request.
1063 for my $error ( @{ $c->error } ) {
1064 $c->log->error($error);
1067 $c->finalize_uploads;
1070 if ( $#{ $c->error } >= 0 ) {
1074 $c->finalize_headers;
1077 if ( $c->request->method eq 'HEAD' ) {
1078 $c->response->body('');
1083 return $c->response->status;
1086 =head2 $c->finalize_body
1092 sub finalize_body { my $c = shift; $c->engine->finalize_body( $c, @_ ) }
1094 =head2 $c->finalize_cookies
1100 sub finalize_cookies { my $c = shift; $c->engine->finalize_cookies( $c, @_ ) }
1102 =head2 $c->finalize_error
1108 sub finalize_error { my $c = shift; $c->engine->finalize_error( $c, @_ ) }
1110 =head2 $c->finalize_headers
1116 sub finalize_headers {
1119 # Check if we already finalized headers
1120 return if $c->response->{_finalized_headers};
1123 if ( my $location = $c->response->redirect ) {
1124 $c->log->debug(qq/Redirecting to "$location"/) if $c->debug;
1125 $c->response->header( Location => $location );
1129 if ( $c->response->body && !$c->response->content_length ) {
1131 # get the length from a filehandle
1132 if ( ref $c->response->body && $c->response->body->can('read') ) {
1133 if ( my $stat = stat $c->response->body ) {
1134 $c->response->content_length( $stat->size );
1137 $c->log->warn('Serving filehandle without a content-length');
1141 $c->response->content_length( bytes::length( $c->response->body ) );
1146 if ( $c->response->status =~ /^(1\d\d|[23]04)$/ ) {
1147 $c->response->headers->remove_header("Content-Length");
1148 $c->response->body('');
1151 $c->finalize_cookies;
1153 $c->engine->finalize_headers( $c, @_ );
1156 $c->response->{_finalized_headers} = 1;
1159 =head2 $c->finalize_output
1161 An alias for finalize_body.
1163 =head2 $c->finalize_read
1165 Finalizes the input after reading is complete.
1169 sub finalize_read { my $c = shift; $c->engine->finalize_read( $c, @_ ) }
1171 =head2 $c->finalize_uploads
1173 Finalizes uploads. Cleans up any temporary files.
1177 sub finalize_uploads { my $c = shift; $c->engine->finalize_uploads( $c, @_ ) }
1179 =head2 $c->get_action( $action, $namespace )
1181 Gets an action in a given namespace.
1185 sub get_action { my $c = shift; $c->dispatcher->get_action(@_) }
1187 =head2 $c->get_actions( $action, $namespace )
1189 Gets all actions of a given name in a namespace and all parent
1194 sub get_actions { my $c = shift; $c->dispatcher->get_actions( $c, @_ ) }
1196 =head2 handle_request( $class, @arguments )
1198 Called to handle each HTTP request.
1202 sub handle_request {
1203 my ( $class, @arguments ) = @_;
1205 # Always expect worst case!
1208 my $stats = ( $class->debug ) ? Tree::Simple->new: q{};
1211 my $c = $class->prepare(@arguments);
1212 $c->{stats} = $stats;
1214 return $c->finalize;
1217 if ( $class->debug ) {
1218 my $start = [gettimeofday];
1219 $status = &$handler;
1220 my $elapsed = tv_interval $start;
1221 $elapsed = sprintf '%f', $elapsed;
1222 my $av = sprintf '%.3f',
1223 ( $elapsed == 0 ? '??' : ( 1 / $elapsed ) );
1224 my $t = Text::SimpleTable->new( [ 64, 'Action' ], [ 9, 'Time' ] );
1229 my $stat = $action->getNodeValue;
1230 $t->row( ( q{ } x $action->getDepth ) . $stat->{action},
1231 $stat->{elapsed} || '??' );
1236 "Request took ${elapsed}s ($av/s)\n" . $t->draw );
1238 else { $status = &$handler }
1242 if ( my $error = $@ ) {
1244 $class->log->error(qq/Caught exception in engine "$error"/);
1248 $class->log->_flush() if $class->log->can('_flush');
1252 =head2 $c->prepare( @arguments )
1254 Creates a Catalyst context from an engine-specific request (Apache, CGI,
1260 my ( $class, @arguments ) = @_;
1262 $class->context_class( ref $class || $class ) unless $class->context_class;
1263 my $c = $class->context_class->new(
1267 request => $class->request_class->new(
1270 body_parameters => {},
1272 headers => HTTP::Headers->new,
1274 query_parameters => {},
1280 response => $class->response_class->new(
1284 headers => HTTP::Headers->new(),
1293 # For on-demand data
1294 $c->request->{_context} = $c;
1295 $c->response->{_context} = $c;
1296 weaken( $c->request->{_context} );
1297 weaken( $c->response->{_context} );
1300 my $secs = time - $START || 1;
1301 my $av = sprintf '%.3f', $COUNT / $secs;
1302 $c->log->debug('**********************************');
1303 $c->log->debug("* Request $COUNT ($av/s) [$$]");
1304 $c->log->debug('**********************************');
1305 $c->res->headers->header( 'X-Catalyst' => $Catalyst::VERSION );
1308 $c->prepare_request(@arguments);
1309 $c->prepare_connection;
1310 $c->prepare_query_parameters;
1311 $c->prepare_headers;
1312 $c->prepare_cookies;
1316 $c->prepare_body unless $c->config->{parse_on_demand};
1318 my $method = $c->req->method || '';
1319 my $path = $c->req->path || '';
1320 my $address = $c->req->address || '';
1322 $c->log->debug(qq/"$method" request for "$path" from "$address"/)
1330 =head2 $c->prepare_action
1336 sub prepare_action { my $c = shift; $c->dispatcher->prepare_action( $c, @_ ) }
1338 =head2 $c->prepare_body
1340 Prepares message body.
1347 # Do we run for the first time?
1348 return if defined $c->request->{_body};
1350 # Initialize on-demand data
1351 $c->engine->prepare_body( $c, @_ );
1352 $c->prepare_parameters;
1353 $c->prepare_uploads;
1355 if ( $c->debug && keys %{ $c->req->body_parameters } ) {
1356 my $t = Text::SimpleTable->new( [ 37, 'Key' ], [ 36, 'Value' ] );
1357 for my $key ( sort keys %{ $c->req->body_parameters } ) {
1358 my $param = $c->req->body_parameters->{$key};
1359 my $value = defined($param) ? $param : '';
1361 ref $value eq 'ARRAY' ? ( join ', ', @$value ) : $value );
1363 $c->log->debug( "Body Parameters are:\n" . $t->draw );
1367 =head2 $c->prepare_body_chunk( $chunk )
1369 Prepares a chunk of data before sending it to L<HTTP::Body>.
1373 sub prepare_body_chunk {
1375 $c->engine->prepare_body_chunk( $c, @_ );
1378 =head2 $c->prepare_body_parameters
1380 Prepares body parameters.
1384 sub prepare_body_parameters {
1386 $c->engine->prepare_body_parameters( $c, @_ );
1389 =head2 $c->prepare_connection
1391 Prepares connection.
1395 sub prepare_connection {
1397 $c->engine->prepare_connection( $c, @_ );
1400 =head2 $c->prepare_cookies
1406 sub prepare_cookies { my $c = shift; $c->engine->prepare_cookies( $c, @_ ) }
1408 =head2 $c->prepare_headers
1414 sub prepare_headers { my $c = shift; $c->engine->prepare_headers( $c, @_ ) }
1416 =head2 $c->prepare_parameters
1418 Prepares parameters.
1422 sub prepare_parameters {
1424 $c->prepare_body_parameters;
1425 $c->engine->prepare_parameters( $c, @_ );
1428 =head2 $c->prepare_path
1430 Prepares path and base.
1434 sub prepare_path { my $c = shift; $c->engine->prepare_path( $c, @_ ) }
1436 =head2 $c->prepare_query_parameters
1438 Prepares query parameters.
1442 sub prepare_query_parameters {
1445 $c->engine->prepare_query_parameters( $c, @_ );
1447 if ( $c->debug && keys %{ $c->request->query_parameters } ) {
1448 my $t = Text::SimpleTable->new( [ 37, 'Key' ], [ 36, 'Value' ] );
1449 for my $key ( sort keys %{ $c->req->query_parameters } ) {
1450 my $param = $c->req->query_parameters->{$key};
1451 my $value = defined($param) ? $param : '';
1453 ref $value eq 'ARRAY' ? ( join ', ', @$value ) : $value );
1455 $c->log->debug( "Query Parameters are:\n" . $t->draw );
1459 =head2 $c->prepare_read
1461 Prepares the input for reading.
1465 sub prepare_read { my $c = shift; $c->engine->prepare_read( $c, @_ ) }
1467 =head2 $c->prepare_request
1469 Prepares the engine request.
1473 sub prepare_request { my $c = shift; $c->engine->prepare_request( $c, @_ ) }
1475 =head2 $c->prepare_uploads
1481 sub prepare_uploads {
1484 $c->engine->prepare_uploads( $c, @_ );
1486 if ( $c->debug && keys %{ $c->request->uploads } ) {
1487 my $t = Text::SimpleTable->new(
1493 for my $key ( sort keys %{ $c->request->uploads } ) {
1494 my $upload = $c->request->uploads->{$key};
1495 for my $u ( ref $upload eq 'ARRAY' ? @{$upload} : ($upload) ) {
1496 $t->row( $key, $u->filename, $u->type, $u->size );
1499 $c->log->debug( "File Uploads are:\n" . $t->draw );
1503 =head2 $c->prepare_write
1505 Prepares the output for writing.
1509 sub prepare_write { my $c = shift; $c->engine->prepare_write( $c, @_ ) }
1511 =head2 $c->request_class
1513 Returns or sets the request class.
1515 =head2 $c->response_class
1517 Returns or sets the response class.
1519 =head2 $c->read( [$maxlength] )
1521 Reads a chunk of data from the request body. This method is designed to
1522 be used in a while loop, reading C<$maxlength> bytes on every call.
1523 C<$maxlength> defaults to the size of the request if not specified.
1525 You have to set C<MyApp-E<gt>config-E<gt>{parse_on_demand}> to use this
1530 sub read { my $c = shift; return $c->engine->read( $c, @_ ) }
1538 sub run { my $c = shift; return $c->engine->run( $c, @_ ) }
1540 =head2 $c->set_action( $action, $code, $namespace, $attrs )
1542 Sets an action in a given namespace.
1546 sub set_action { my $c = shift; $c->dispatcher->set_action( $c, @_ ) }
1548 =head2 $c->setup_actions($component)
1550 Sets up actions for a component.
1554 sub setup_actions { my $c = shift; $c->dispatcher->setup_actions( $c, @_ ) }
1556 =head2 $c->setup_components
1562 sub setup_components {
1565 my $callback = sub {
1566 my ( $component, $context ) = @_;
1568 unless ( $component->can('COMPONENT') ) {
1572 my $suffix = Catalyst::Utils::class2classsuffix($component);
1573 my $config = $class->config->{$suffix} || {};
1577 eval { $instance = $component->COMPONENT( $context, $config ); };
1579 if ( my $error = $@ ) {
1583 Catalyst::Exception->throw( message =>
1584 qq/Couldn't instantiate component "$component", "$error"/ );
1587 Catalyst::Exception->throw( message =>
1588 qq/Couldn't instantiate component "$component", "new() didn't return a object"/
1590 unless ref $instance;
1594 eval "package $class;\n" . q!Module::Pluggable::Fast->import(
1595 name => '_catalyst_components',
1597 "$class\::Controller", "$class\::C",
1598 "$class\::Model", "$class\::M",
1599 "$class\::View", "$class\::V"
1601 callback => $callback
1605 if ( my $error = $@ ) {
1609 Catalyst::Exception->throw(
1610 message => qq/Couldn't load components "$error"/ );
1613 for my $component ( $class->_catalyst_components($class) ) {
1614 $class->components->{ ref $component || $component } = $component;
1618 =head2 $c->setup_dispatcher
1624 sub setup_dispatcher {
1625 my ( $class, $dispatcher ) = @_;
1628 $dispatcher = 'Catalyst::Dispatcher::' . $dispatcher;
1631 if ( $ENV{CATALYST_DISPATCHER} ) {
1632 $dispatcher = 'Catalyst::Dispatcher::' . $ENV{CATALYST_DISPATCHER};
1635 if ( $ENV{ uc($class) . '_DISPATCHER' } ) {
1637 'Catalyst::Dispatcher::' . $ENV{ uc($class) . '_DISPATCHER' };
1640 unless ($dispatcher) {
1641 $dispatcher = $class->dispatcher_class;
1644 $dispatcher->require;
1647 Catalyst::Exception->throw(
1648 message => qq/Couldn't load dispatcher "$dispatcher", "$@"/ );
1651 # dispatcher instance
1652 $class->dispatcher( $dispatcher->new );
1655 =head2 $c->setup_engine
1662 my ( $class, $engine ) = @_;
1665 $engine = 'Catalyst::Engine::' . $engine;
1668 if ( $ENV{CATALYST_ENGINE} ) {
1669 $engine = 'Catalyst::Engine::' . $ENV{CATALYST_ENGINE};
1672 if ( $ENV{ uc($class) . '_ENGINE' } ) {
1673 $engine = 'Catalyst::Engine::' . $ENV{ uc($class) . '_ENGINE' };
1676 if ( $ENV{MOD_PERL} ) {
1678 # create the apache method
1681 *{"$class\::apache"} = sub { shift->engine->apache };
1684 my ( $software, $version ) =
1685 $ENV{MOD_PERL} =~ /^(\S+)\/(\d+(?:[\.\_]\d+)+)/;
1688 $version =~ s/(\.[^.]+)\./$1/g;
1690 if ( $software eq 'mod_perl' ) {
1694 if ( $version >= 1.99922 ) {
1695 $engine = 'Catalyst::Engine::Apache2::MP20';
1698 elsif ( $version >= 1.9901 ) {
1699 $engine = 'Catalyst::Engine::Apache2::MP19';
1702 elsif ( $version >= 1.24 ) {
1703 $engine = 'Catalyst::Engine::Apache::MP13';
1707 Catalyst::Exception->throw( message =>
1708 qq/Unsupported mod_perl version: $ENV{MOD_PERL}/ );
1713 # install the correct mod_perl handler
1714 if ( $version >= 1.9901 ) {
1715 *handler = sub : method {
1716 shift->handle_request(@_);
1720 *handler = sub ($$) { shift->handle_request(@_) };
1725 elsif ( $software eq 'Zeus-Perl' ) {
1726 $engine = 'Catalyst::Engine::Zeus';
1730 Catalyst::Exception->throw(
1731 message => qq/Unsupported mod_perl: $ENV{MOD_PERL}/ );
1736 $engine = $class->engine_class;
1742 Catalyst::Exception->throw( message =>
1743 qq/Couldn't load engine "$engine" (maybe you forgot to install it?), "$@"/
1747 # check for old engines that are no longer compatible
1749 if ( $engine->isa('Catalyst::Engine::Apache')
1750 && !Catalyst::Engine::Apache->VERSION )
1755 elsif ( $engine->isa('Catalyst::Engine::Server::Base')
1756 && Catalyst::Engine::Server->VERSION le '0.02' )
1761 elsif ($engine->isa('Catalyst::Engine::HTTP::POE')
1762 && $engine->VERSION eq '0.01' )
1767 elsif ($engine->isa('Catalyst::Engine::Zeus')
1768 && $engine->VERSION eq '0.01' )
1774 Catalyst::Exception->throw( message =>
1775 qq/Engine "$engine" is not supported by this version of Catalyst/
1780 $class->engine( $engine->new );
1783 =head2 $c->setup_home
1785 Sets up the home directory.
1790 my ( $class, $home ) = @_;
1792 if ( $ENV{CATALYST_HOME} ) {
1793 $home = $ENV{CATALYST_HOME};
1796 if ( $ENV{ uc($class) . '_HOME' } ) {
1797 $home = $ENV{ uc($class) . '_HOME' };
1801 $home = Catalyst::Utils::home($class);
1805 $class->config->{home} ||= $home;
1806 $class->config->{root} ||= dir($home)->subdir('root');
1810 =head2 $c->setup_log
1817 my ( $class, $debug ) = @_;
1819 unless ( $class->log ) {
1820 $class->log( Catalyst::Log->new );
1823 my $app_flag = Catalyst::Utils::class2env($class) . '_DEBUG';
1826 ( defined( $ENV{CATALYST_DEBUG} ) || defined( $ENV{$app_flag} ) )
1827 ? ( $ENV{CATALYST_DEBUG} || $ENV{$app_flag} )
1832 *{"$class\::debug"} = sub { 1 };
1833 $class->log->debug('Debug messages enabled');
1837 =head2 $c->setup_plugins
1844 my ( $class, $plugins ) = @_;
1847 for my $plugin ( reverse @$plugins ) {
1849 $plugin = "Catalyst::Plugin::$plugin";
1854 Catalyst::Exception->throw(
1855 message => qq/Couldn't load plugin "$plugin", "$@"/ );
1860 unshift @{"$class\::ISA"}, $plugin;
1869 =head2 $c->write( $data )
1871 Writes $data to the output stream. When using this method directly, you
1872 will need to manually set the C<Content-Length> header to the length of
1873 your output data, if known.
1880 # Finalize headers if someone manually writes output
1881 $c->finalize_headers;
1883 return $c->engine->write( $c, @_ );
1888 Returns the Catalyst version number. Mostly useful for "powered by"
1889 messages in template systems.
1893 sub version { return $Catalyst::VERSION }
1895 =head1 INTERNAL ACTIONS
1897 Catalyst uses internal actions like C<_DISPATCH>, C<_BEGIN>, C<_AUTO>,
1898 C<_ACTION>, and C<_END>. These are by default not shown in the private
1899 action table, but you can make them visible with a config parameter.
1901 MyApp->config->{show_internal_actions} = 1;
1903 =head1 CASE SENSITIVITY
1905 By default Catalyst is not case sensitive, so C<MyApp::C::FOO::Bar> is
1906 mapped to C</foo/bar>. You can activate case sensitivity with a config
1909 MyApp->config->{case_sensitive} = 1;
1911 This causes C<MyApp::C::Foo::Bar> to map to C</Foo/Bar>.
1913 =head1 ON-DEMAND PARSER
1915 The request body is usually parsed at the beginning of a request,
1916 but if you want to handle input yourself or speed things up a bit,
1917 you can enable on-demand parsing with a config parameter.
1919 MyApp->config->{parse_on_demand} = 1;
1921 =head1 PROXY SUPPORT
1923 Many production servers operate using the common double-server approach,
1924 with a lightweight frontend web server passing requests to a larger
1925 backend server. An application running on the backend server must deal
1926 with two problems: the remote user always appears to be C<127.0.0.1> and
1927 the server's hostname will appear to be C<localhost> regardless of the
1928 virtual host that the user connected through.
1930 Catalyst will automatically detect this situation when you are running
1931 the frontend and backend servers on the same machine. The following
1932 changes are made to the request.
1934 $c->req->address is set to the user's real IP address, as read from
1935 the HTTP X-Forwarded-For header.
1937 The host value for $c->req->base and $c->req->uri is set to the real
1938 host, as read from the HTTP X-Forwarded-Host header.
1940 Obviously, your web server must support these headers for this to work.
1942 In a more complex server farm environment where you may have your
1943 frontend proxy server(s) on different machines, you will need to set a
1944 configuration option to tell Catalyst to read the proxied data from the
1947 MyApp->config->{using_frontend_proxy} = 1;
1949 If you do not wish to use the proxy support at all, you may set:
1951 MyApp->config->{ignore_frontend_proxy} = 1;
1953 =head1 THREAD SAFETY
1955 Catalyst has been tested under Apache 2's threading mpm_worker, mpm_winnt,
1956 and the standalone forking HTTP server on Windows. We believe the Catalyst
1957 core to be thread-safe.
1959 If you plan to operate in a threaded environment, remember that all other
1960 modules you are using must also be thread-safe. Some modules, most notably
1961 L<DBD::SQLite>, are not thread-safe.
1967 Join #catalyst on irc.perl.org.
1971 http://lists.rawmode.org/mailman/listinfo/catalyst
1972 http://lists.rawmode.org/mailman/listinfo/catalyst-dev
1976 http://catalyst.perl.org
1980 http://dev.catalyst.perl.org
1984 =head2 L<Task::Catalyst> - All you need to start with Catalyst
1986 =head2 L<Catalyst::Manual> - The Catalyst Manual
1988 =head2 L<Catalyst::Component>, L<Catalyst::Base> - Base classes for components
1990 =head2 L<Catalyst::Engine> - Core engine
1992 =head2 L<Catalyst::Log> - Log class.
1994 =head2 L<Catalyst::Request> - Request object
1996 =head2 L<Catalyst::Response> - Response object
1998 =head2 L<Catalyst::Test> - The test suite.
2068 Sebastian Riedel, C<sri@oook.de>
2072 This library is free software, you can redistribute it and/or modify it under
2073 the same terms as Perl itself.