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;
25 __PACKAGE__->mk_accessors(
26 qw/counter request response state action stack namespace/
29 attributes->import( __PACKAGE__, \&namespace, 'lvalue' );
31 sub depth { scalar @{ shift->stack || [] }; }
38 # For backwards compatibility
39 *finalize_output = \&finalize_body;
44 our $RECURSION = 1000;
45 our $DETACH = "catalyst_detach\n";
47 require Module::Pluggable::Fast;
49 # Helper script generation
50 our $CATALYST_SCRIPT_GEN = 27;
52 __PACKAGE__->mk_classdata($_)
53 for qw/components arguments dispatcher engine log dispatcher_class
54 engine_class context_class request_class response_class setup_finished/;
56 __PACKAGE__->dispatcher_class('Catalyst::Dispatcher');
57 __PACKAGE__->engine_class('Catalyst::Engine::CGI');
58 __PACKAGE__->request_class('Catalyst::Request');
59 __PACKAGE__->response_class('Catalyst::Response');
61 our $VERSION = '5.64';
64 my ( $class, @arguments ) = @_;
66 # We have to limit $class to Catalyst to avoid pushing Catalyst upon every
68 return unless $class eq 'Catalyst';
70 my $caller = caller(0);
72 unless ( $caller->isa('Catalyst') ) {
74 push @{"$caller\::ISA"}, $class, 'Catalyst::Controller';
77 $caller->arguments( [@arguments] );
83 Catalyst - The Elegant MVC Web Application Framework
87 # use the helper to start a new application
90 # add models, views, controllers
91 script/myapp_create.pl model Database DBIC dbi:SQLite:/path/to/db
92 script/myapp_create.pl view TT TT
93 script/myapp_create.pl controller Search
95 # built in testserver -- use -r to restart automatically on changes
96 script/myapp_server.pl
98 # command line testing interface
99 script/myapp_test.pl /yada
102 use Catalyst qw/-Debug/; # include plugins here as well
104 sub foo : Global { # called for /foo, /foo/1, /foo/1/2, etc.
105 my ( $self, $c, @args ) = @_; # args are qw/1 2/ for /foo/1/2
106 $c->stash->{template} = 'foo.tt'; # set the template
107 # lookup something from db -- stash vars are passed to TT
109 MyApp::Model::Database::Foo->search( { country => $args[0] } );
110 if ( $c->req->params->{bar} ) { # access GET or POST parameters
111 $c->forward( 'bar' ); # process another action
112 # do something else after forward returns
116 # The foo.tt TT template can use the stash data from the database
117 [% WHILE (item = data.next) %]
121 # called for /bar/of/soap, /bar/of/soap/10, etc.
122 sub bar : Path('/bar/of/soap') { ... }
124 # called for all actions, from the top-most controller downwards
126 my ( $self, $c ) = @_;
128 $c->res->redirect( '/login' ); # require login
129 return 0; # abort request and go immediately to end()
131 return 1; # success; carry on to next action
134 # called after all actions are finished
136 my ( $self, $c ) = @_;
137 if ( scalar @{ $c->error } ) { ... } # handle errors
138 return if $c->res->body; # already have a response
139 $c->forward( 'MyApp::View::TT' ); # render template
142 ### in MyApp/Controller/Foo.pm
143 # called for /foo/bar
144 sub bar : Local { ... }
146 # called for /blargle
147 sub blargle : Global { ... }
149 # an index action matches /foo, but not /foo/1, etc.
150 sub index : Private { ... }
152 ### in MyApp/Controller/Foo/Bar.pm
153 # called for /foo/bar/baz
154 sub baz : Local { ... }
156 # first MyApp auto is called, then Foo auto, then this
157 sub auto : Private { ... }
159 # powerful regular expression paths are also possible
160 sub details : Regex('^product/(\w+)/details$') {
161 my ( $self, $c ) = @_;
162 # extract the (\w+) from the URI
163 my $product = $c->req->snippets->[0];
166 See L<Catalyst::Manual::Intro> for additional information.
170 The key concept of Catalyst is DRY (Don't Repeat Yourself).
172 See L<Catalyst::Manual> for more documentation.
174 Catalyst plugins can be loaded by naming them as arguments to the "use
175 Catalyst" statement. Omit the C<Catalyst::Plugin::> prefix from the
176 plugin name, i.e., C<Catalyst::Plugin::My::Module> becomes
179 use Catalyst qw/My::Module/;
181 Special flags like C<-Debug> and C<-Engine> can also be specified as
182 arguments when Catalyst is loaded:
184 use Catalyst qw/-Debug My::Module/;
186 The position of plugins and flags in the chain is important, because
187 they are loaded in exactly the order in which they appear.
189 The following flags are supported:
193 Enables debug output.
197 Forces Catalyst to use a specific engine. Omit the
198 C<Catalyst::Engine::> prefix of the engine name, i.e.:
200 use Catalyst qw/-Engine=CGI/;
204 Forces Catalyst to use a specific home directory, e.g.:
206 use Catalyst qw[-Home=/usr/sri];
214 =head2 Information about the current request
218 Returns a L<Catalyst::Action> object for the current action, which
219 stringifies to the action name. See L<Catalyst::Action>.
223 Returns the namespace of the current action, i.e., the uri prefix
224 corresponding to the controller of the current action. For example:
226 # in Controller::Foo::Bar
227 $c->namespace; # returns 'foo/bar';
233 Returns the current L<Catalyst::Request> object. See
234 L<Catalyst::Request>.
236 =head2 Processing and response to the current request
238 =head2 $c->forward( $action [, \@arguments ] )
240 =head2 $c->forward( $class, $method, [, \@arguments ] )
242 Forwards processing to a private action. If you give a class name but no
243 method, C<process()> is called. You may also optionally pass arguments
244 in an arrayref. The action will receive the arguments in C<@_> and
245 C<$c-E<gt>req-E<gt>args>. Upon returning from the function,
246 C<$c-E<gt>req-E<gt>args> will be restored to the previous values.
248 Any data C<return>ed from the action forwarded to, will be returned by the
251 my $foodata = $c->forward('/foo');
252 $c->forward('index');
253 $c->forward(qw/MyApp::Model::CDBI::Foo do_stuff/);
254 $c->forward('MyApp::View::TT');
258 sub forward { my $c = shift; $c->dispatcher->forward( $c, @_ ) }
260 =head2 $c->detach( $action [, \@arguments ] )
262 =head2 $c->detach( $class, $method, [, \@arguments ] )
264 The same as C<forward>, but doesn't return.
268 sub detach { my $c = shift; $c->dispatcher->detach( $c, @_ ) }
272 =head2 $c->error($error, ...)
274 =head2 $c->error($arrayref)
276 Returns an arrayref containing error messages. If Catalyst encounters an
277 error while processing a request, it stores the error in $c->error. This
278 method should not be used to store non-fatal error messages.
280 my @error = @{ $c->error };
284 $c->error('Something bad happened');
286 Clear errors. You probably don't want to clear the errors unless you are
287 implementing a custom error screen.
296 my $error = ref $_[0] eq 'ARRAY' ? $_[0] : [@_];
297 push @{ $c->{error} }, @$error;
299 elsif ( defined $_[0] ) { $c->{error} = undef }
300 return $c->{error} || [];
307 Returns the current L<Catalyst::Response> object.
311 Returns a hashref to the stash, which may be used to store data and pass
312 it between components during a request. You can also set hash keys by
313 passing arguments. The stash is automatically sent to the view. The
314 stash is cleared at the end of a request; it cannot be used for
317 $c->stash->{foo} = $bar;
318 $c->stash( { moose => 'majestic', qux => 0 } );
319 $c->stash( bar => 1, gorch => 2 ); # equivalent to passing a hashref
321 # stash is automatically passed to the view for use in a template
322 $c->forward( 'MyApp::V::TT' );
329 my $stash = @_ > 1 ? {@_} : $_[0];
330 while ( my ( $key, $val ) = each %$stash ) {
331 $c->{stash}->{$key} = $val;
339 Contains the return value of the last executed action.
341 =head2 Component Accessors
343 =head2 $c->comp($name)
345 =head2 $c->component($name)
347 Gets a component object by name. This method is no longer recommended,
348 unless you want to get a specific component by full
349 class. C<$c-E<gt>controller>, C<$c-E<gt>model>, and C<$c-E<gt>view>
350 should be used instead.
361 my $appclass = ref $c || $c;
364 $name, "${appclass}::${name}",
365 map { "${appclass}::${_}::${name}" }
366 qw/Model M Controller C View V/
369 foreach my $try (@names) {
371 if ( exists $c->components->{$try} ) {
373 my $comp = $c->components->{$try};
374 if ( eval { $comp->can('ACCEPT_CONTEXT'); } ) {
375 return $comp->ACCEPT_CONTEXT($c);
377 else { return $comp }
381 foreach my $component ( keys %{ $c->components } ) {
383 $comp = $c->components->{$component} if $component =~ /$name/i;
385 if ( ref $comp && $comp->can('ACCEPT_CONTEXT') ) {
386 return $comp->ACCEPT_CONTEXT($c);
388 else { return $comp }
394 return sort keys %{ $c->components };
397 =head2 $c->controller($name)
399 Gets a L<Catalyst::Controller> instance by name.
401 $c->controller('Foo')->do_stuff;
406 my ( $c, $name ) = @_;
407 my $controller = $c->comp("Controller::$name");
408 return $controller if defined $controller;
409 return $c->comp("C::$name");
412 =head2 $c->model($name)
414 Gets a L<Catalyst::Model> instance by name.
416 $c->model('Foo')->do_stuff;
421 my ( $c, $name ) = @_;
422 my $model = $c->comp("Model::$name");
423 return $model if defined $model;
424 return $c->comp("M::$name");
427 =head2 $c->view($name)
429 Gets a L<Catalyst::View> instance by name.
431 $c->view('Foo')->do_stuff;
436 my ( $c, $name ) = @_;
437 my $view = $c->comp("View::$name");
438 return $view if defined $view;
439 return $c->comp("V::$name");
442 =head2 Class data and helper classes
446 Returns or takes a hashref containing the application's configuration.
448 __PACKAGE__->config( { db => 'dsn:SQLite:foo.db' } );
450 You can also use a L<YAML> config file like myapp.yml in your
451 applications home directory.
454 db: dsn:SQLite:foo.db
461 $c->log->warn("Setting config after setup has been run is not a good idea.")
462 if ( @_ and $c->setup_finished );
464 $c->NEXT::config(@_);
469 Overload to enable debug messages (same as -Debug option).
475 =head2 $c->dispatcher
477 Returns the dispatcher instance. Stringifies to class name. See
478 L<Catalyst::Dispatcher>.
482 Returns the engine instance. Stringifies to the class name. See
487 Returns the logging object instance. Unless it is already set, Catalyst sets
488 this up with a L<Catalyst::Log> object. To use your own log class, set the
489 logger with the C<< __PACKAGE__->log >> method prior to calling
490 C<< __PACKAGE__->setup >>.
492 __PACKAGE__->log( MyLogger->new );
497 $c->log->info( 'Now logging with my own logger!' );
499 Your log class should implement the methods described in the
500 L<Catalyst::Log> man page.
504 =head2 Utility methods
506 =head2 $c->path_to(@path)
508 Merges C<@path> with C<$c-E<gt>config-E<gt>{home}> and returns a
509 L<Path::Class> object.
513 $c->path_to( 'db', 'sqlite.db' );
518 my ( $c, @path ) = @_;
519 my $path = dir( $c->config->{home}, @path );
520 if ( -d $path ) { return $path }
521 else { return file( $c->config->{home}, @path ) }
524 =head2 $c->plugin( $name, $class, @args )
526 Helper method for plugins. It creates a classdata accessor/mutator and
527 loads and instantiates the given class.
529 MyApp->plugin( 'prototype', 'HTML::Prototype' );
531 $c->prototype->define_javascript_functions;
536 my ( $class, $name, $plugin, @args ) = @_;
539 if ( my $error = $UNIVERSAL::require::ERROR ) {
540 Catalyst::Exception->throw(
541 message => qq/Couldn't load instant plugin "$plugin", "$error"/ );
544 eval { $plugin->import };
545 $class->mk_classdata($name);
547 eval { $obj = $plugin->new(@args) };
550 Catalyst::Exception->throw( message =>
551 qq/Couldn't instantiate instant plugin "$plugin", "$@"/ );
555 $class->log->debug(qq/Initialized instant plugin "$plugin" as "$name"/)
561 Initializes the dispatcher and engine, loads any plugins, and loads the
562 model, view, and controller components. You may also specify an array
563 of plugins to load here, if you choose to not load them in the C<use
567 MyApp->setup( qw/-Debug/ );
572 my ( $class, @arguments ) = @_;
574 unless ( $class->isa('Catalyst') ) {
576 Catalyst::Exception->throw(
577 message => qq/'$class' does not inherit from Catalyst/ );
580 if ( $class->arguments ) {
581 @arguments = ( @arguments, @{ $class->arguments } );
587 foreach (@arguments) {
591 ( $flags->{log} ) ? 'debug,' . $flags->{log} : 'debug';
593 elsif (/^-(\w+)=?(.*)$/) {
594 $flags->{ lc $1 } = $2;
597 push @{ $flags->{plugins} }, $_;
601 $class->setup_home( delete $flags->{home} );
603 $class->setup_log( delete $flags->{log} );
604 $class->setup_plugins( delete $flags->{plugins} );
605 $class->setup_dispatcher( delete $flags->{dispatcher} );
606 $class->setup_engine( delete $flags->{engine} );
608 for my $flag ( sort keys %{$flags} ) {
610 if ( my $code = $class->can( 'setup_' . $flag ) ) {
611 &$code( $class, delete $flags->{$flag} );
614 $class->log->warn(qq/Unknown flag "$flag"/);
619 <<"EOF") if ( $ENV{CATALYST_SCRIPT_GEN} && ( $ENV{CATALYST_SCRIPT_GEN} < $Catalyst::CATALYST_SCRIPT_GEN ) );
620 You are running an old script!
622 Please update by running (this will overwrite existing files):
623 catalyst.pl -force -scripts $class
625 or (this will not overwrite existing files):
626 catalyst.pl -scripts $class
629 if ( $class->debug ) {
636 map { $_ . ' ' . ( $_->VERSION || '' ) }
637 grep { /^Catalyst::Plugin/ } @{"$class\::ISA"};
641 my $t = Text::SimpleTable->new(76);
642 $t->row($_) for @plugins;
643 $class->log->debug( "Loaded plugins:\n" . $t->draw );
646 my $dispatcher = $class->dispatcher;
647 my $engine = $class->engine;
648 my $home = $class->config->{home};
650 $class->log->debug(qq/Loaded dispatcher "$dispatcher"/);
651 $class->log->debug(qq/Loaded engine "$engine"/);
655 ? $class->log->debug(qq/Found home "$home"/)
656 : $class->log->debug(qq/Home "$home" doesn't exist/)
657 : $class->log->debug(q/Couldn't find home/);
662 no warnings qw/redefine/;
663 local *setup = sub { };
667 # Initialize our data structure
668 $class->components( {} );
670 $class->setup_components;
672 if ( $class->debug ) {
673 my $t = Text::SimpleTable->new( [ 65, 'Class' ], [ 8, 'Type' ] );
674 for my $comp ( sort keys %{ $class->components } ) {
675 my $type = ref $class->components->{$comp} ? 'instance' : 'class';
676 $t->row( $comp, $type );
678 $class->log->debug( "Loaded components:\n" . $t->draw )
679 if ( keys %{ $class->components } );
682 # Add our self to components, since we are also a component
683 $class->components->{$class} = $class;
685 $class->setup_actions;
687 if ( $class->debug ) {
688 my $name = $class->config->{name} || 'Application';
689 $class->log->info("$name powered by Catalyst $Catalyst::VERSION");
691 $class->log->_flush() if $class->log->can('_flush');
693 $class->setup_finished(1);
696 =head2 $c->uri_for( $path, [ @args ] )
698 Merges path with C<$c-E<gt>request-E<gt>base> for absolute uri's and
699 with C<$c-E<gt>namespace> for relative uri's, then returns a
700 normalized L<URI> object. If any args are passed, they are added at the
706 my ( $c, $path, @args ) = @_;
707 my $base = $c->request->base->clone;
708 my $basepath = $base->path;
709 $basepath =~ s/\/$//;
711 my $namespace = $c->namespace;
713 # massage namespace, empty if absolute path
714 $namespace =~ s/^\///;
715 $namespace .= '/' if $namespace;
717 $namespace = '' if $path =~ /^\//;
720 my $params = (scalar @args && ref $args[$#args] eq 'HASH' ? pop @args : {});
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 )
728 $res->query_form(%$params);
732 =head2 $c->welcome_message
734 Returns the Catalyst welcome HTML page.
738 sub welcome_message {
740 my $name = $c->config->{name};
741 my $logo = $c->uri_for('/static/images/catalyst_logo.png');
742 my $prefix = Catalyst::Utils::appprefix( ref $c );
743 $c->response->content_type('text/html; charset=utf-8');
745 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
746 "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
747 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
749 <meta http-equiv="Content-Language" content="en" />
750 <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
751 <title>$name on Catalyst $VERSION</title>
752 <style type="text/css">
755 background-color: #eee;
764 background-color: #ccc;
765 border: 1px solid #aaa;
766 -moz-border-radius: 10px;
771 font-family: verdana, tahoma, sans-serif;
774 font-family: verdana, tahoma, sans-serif;
777 text-decoration: none;
779 border-bottom: 1px dotted #bbb;
781 :link:hover, :visited:hover {
794 background-color: #fff;
795 border: 1px solid #aaa;
796 -moz-border-radius: 10px;
822 <h1><span id="appname">$name</span> on <a href="http://catalyst.perl.org">Catalyst</a>
827 <img src="$logo" alt="Catalyst Logo" />
829 <p>Welcome to the wonderful world of Catalyst.
830 This <a href="http://en.wikipedia.org/wiki/MVC">MVC</a>
831 framework will make web development something you had
832 never expected it to be: Fun, rewarding, and quick.</p>
833 <h2>What to do now?</h2>
834 <p>That really depends on what <b>you</b> want to do.
835 We do, however, provide you with a few starting points.</p>
836 <p>If you want to jump right into web development with Catalyst
837 you might want to check out the documentation.</p>
838 <pre><code>perldoc <a href="http://cpansearch.perl.org/dist/Catalyst/lib/Catalyst/Manual/Intro.pod">Catalyst::Manual::Intro</a>
839 perldoc <a href="http://cpansearch.perl.org/dist/Catalyst/lib/Catalyst/Manual/Tutorial.pod">Catalyst::Manual::Tutorial</a></code>
840 perldoc <a href="http://cpansearch.perl.org/dist/Catalyst/lib/Catalyst/Manual.pod">Catalyst::Manual</a></code></pre>
841 <h2>What to do next?</h2>
842 <p>Next it's time to write an actual application. Use the
843 helper scripts to generate <a href="http://cpansearch.perl.org/search?query=Catalyst%3A%3AController%3A%3A&mode=all">controllers</a>,
844 <a href="http://cpansearch.perl.org/search?query=Catalyst%3A%3AModel%3A%3A&mode=all">models</a>, and
845 <a href="http://cpansearch.perl.org/search?query=Catalyst%3A%3AView%3A%3A&mode=all">views</a>;
846 they can save you a lot of work.</p>
847 <pre><code>script/${prefix}_create.pl -help</code></pre>
848 <p>Also, be sure to check out the vast and growing
849 collection of <a href="http://cpansearch.perl.org/search?query=Catalyst%3A%3APlugin%3A%3A&mode=all">plugins for Catalyst on CPAN</a>;
850 you are likely to find what you need there.
854 <p>Catalyst has a very active community. Here are the main places to
855 get in touch with us.</p>
858 <a href="http://dev.catalyst.perl.org">Wiki</a>
861 <a href="http://lists.rawmode.org/mailman/listinfo/catalyst">Mailing-List</a>
864 <a href="irc://irc.perl.org/catalyst">IRC channel #catalyst on irc.perl.org</a>
867 <h2>In conclusion</h2>
868 <p>The Catalyst team hopes you will enjoy using Catalyst as much
869 as we enjoyed making it. Please contact us if you have ideas
870 for improvement or other feedback.</p>
878 =head1 INTERNAL METHODS
880 These methods are not meant to be used by end users.
882 =head2 $c->components
884 Returns a hash of components.
886 =head2 $c->context_class
888 Returns or sets the context class.
892 Returns a hashref containing coderefs and execution counts (needed for
893 deep recursion detection).
897 Returns the number of actions on the current internal execution stack.
901 Dispatches a request to actions.
905 sub dispatch { my $c = shift; $c->dispatcher->dispatch( $c, @_ ) }
907 =head2 $c->dispatcher_class
909 Returns or sets the dispatcher class.
911 =head2 $c->dump_these
913 Returns a list of 2-element array references (name, structure) pairs
914 that will be dumped on the error page in debug mode.
920 [ Request => $c->req ], [ Response => $c->res ], [ Stash => $c->stash ],;
923 =head2 $c->engine_class
925 Returns or sets the engine class.
927 =head2 $c->execute( $class, $coderef )
929 Execute a coderef in given class and catch exceptions. Errors are available
935 my ( $c, $class, $code ) = @_;
936 $class = $c->component($class) || $class;
940 my $action = "$code";
941 $action = "/$action" unless $action =~ /\-\>/;
942 $c->counter->{"$code"}++;
944 if ( $c->counter->{"$code"} > $RECURSION ) {
945 my $error = qq/Deep recursion detected in "$action"/;
946 $c->log->error($error);
952 # determine if the call was the result of a forward
953 # this is done by walking up the call stack and looking for a calling
954 # sub of Catalyst::forward before the eval
956 for my $index ( 1 .. 10 ) {
958 if ( ( caller($index) )[0] eq 'Catalyst'
959 && ( caller($index) )[3] eq '(eval)' );
961 if ( ( caller($index) )[3] =~ /forward$/ ) {
962 $callsub = ( caller($index) )[3];
963 $action = "-> $action";
968 my $node = Tree::Simple->new(
971 elapsed => undef, # to be filled in later
974 $node->setUID( "$code" . $c->counter->{"$code"} );
976 unless ( ( $code->name =~ /^_.*/ )
977 && ( !$c->config->{show_internal_actions} ) )
980 # is this a root-level call or a forwarded call?
981 if ( $callsub =~ /forward$/ ) {
983 # forward, locate the caller
984 if ( my $parent = $c->stack->[-1] ) {
985 my $visitor = Tree::Simple::Visitor::FindByUID->new;
986 $visitor->searchForUID(
987 "$parent" . $c->counter->{"$parent"} );
988 $c->{stats}->accept($visitor);
989 if ( my $result = $visitor->getResult ) {
990 $result->addChild($node);
995 # forward with no caller may come from a plugin
996 $c->{stats}->addChild($node);
1002 $c->{stats}->addChild($node);
1007 push( @{ $c->stack }, $code );
1010 $start = [gettimeofday] if $c->debug;
1011 eval { $c->state( &$code( $class, $c, @{ $c->req->args } ) || 0 ) };
1012 $elapsed = tv_interval($start) if $c->debug;
1015 unless ( ( $code->name =~ /^_.*/ )
1016 && ( !$c->config->{show_internal_actions} ) )
1019 # FindByUID uses an internal die, so we save the existing error
1022 # locate the node in the tree and update the elapsed time
1023 my $visitor = Tree::Simple::Visitor::FindByUID->new;
1024 $visitor->searchForUID( "$code" . $c->counter->{"$code"} );
1025 $c->{stats}->accept($visitor);
1026 if ( my $result = $visitor->getResult ) {
1027 my $value = $result->getNodeValue;
1028 $value->{elapsed} = sprintf( '%fs', $elapsed );
1029 $result->setNodeValue($value);
1033 $@ = $error || undef;
1036 my $last = ${ $c->stack }[-1];
1037 pop( @{ $c->stack } );
1039 if ( my $error = $@ ) {
1040 if ( $error eq $DETACH ) { die $DETACH if $c->depth > 1 }
1042 unless ( ref $error ) {
1044 my $class = $last->class;
1045 my $name = $last->name;
1046 $error = qq/Caught exception in $class->$name "$error"/;
1057 Finalizes the request.
1064 for my $error ( @{ $c->error } ) {
1065 $c->log->error($error);
1068 $c->finalize_uploads;
1071 if ( $#{ $c->error } >= 0 ) {
1075 $c->finalize_headers;
1078 if ( $c->request->method eq 'HEAD' ) {
1079 $c->response->body('');
1084 return $c->response->status;
1087 =head2 $c->finalize_body
1093 sub finalize_body { my $c = shift; $c->engine->finalize_body( $c, @_ ) }
1095 =head2 $c->finalize_cookies
1101 sub finalize_cookies { my $c = shift; $c->engine->finalize_cookies( $c, @_ ) }
1103 =head2 $c->finalize_error
1109 sub finalize_error { my $c = shift; $c->engine->finalize_error( $c, @_ ) }
1111 =head2 $c->finalize_headers
1117 sub finalize_headers {
1120 # Check if we already finalized headers
1121 return if $c->response->{_finalized_headers};
1124 if ( my $location = $c->response->redirect ) {
1125 $c->log->debug(qq/Redirecting to "$location"/) if $c->debug;
1126 $c->response->header( Location => $location );
1130 if ( $c->response->body && !$c->response->content_length ) {
1132 # get the length from a filehandle
1133 if ( ref $c->response->body && $c->response->body->can('read') ) {
1134 if ( my $stat = stat $c->response->body ) {
1135 $c->response->content_length( $stat->size );
1138 $c->log->warn('Serving filehandle without a content-length');
1142 $c->response->content_length( bytes::length( $c->response->body ) );
1147 if ( $c->response->status =~ /^(1\d\d|[23]04)$/ ) {
1148 $c->response->headers->remove_header("Content-Length");
1149 $c->response->body('');
1152 $c->finalize_cookies;
1154 $c->engine->finalize_headers( $c, @_ );
1157 $c->response->{_finalized_headers} = 1;
1160 =head2 $c->finalize_output
1162 An alias for finalize_body.
1164 =head2 $c->finalize_read
1166 Finalizes the input after reading is complete.
1170 sub finalize_read { my $c = shift; $c->engine->finalize_read( $c, @_ ) }
1172 =head2 $c->finalize_uploads
1174 Finalizes uploads. Cleans up any temporary files.
1178 sub finalize_uploads { my $c = shift; $c->engine->finalize_uploads( $c, @_ ) }
1180 =head2 $c->get_action( $action, $namespace )
1182 Gets an action in a given namespace.
1186 sub get_action { my $c = shift; $c->dispatcher->get_action(@_) }
1188 =head2 $c->get_actions( $action, $namespace )
1190 Gets all actions of a given name in a namespace and all parent
1195 sub get_actions { my $c = shift; $c->dispatcher->get_actions( $c, @_ ) }
1197 =head2 handle_request( $class, @arguments )
1199 Called to handle each HTTP request.
1203 sub handle_request {
1204 my ( $class, @arguments ) = @_;
1206 # Always expect worst case!
1209 my $stats = ( $class->debug ) ? Tree::Simple->new: q{};
1212 my $c = $class->prepare(@arguments);
1213 $c->{stats} = $stats;
1215 return $c->finalize;
1218 if ( $class->debug ) {
1219 my $start = [gettimeofday];
1220 $status = &$handler;
1221 my $elapsed = tv_interval $start;
1222 $elapsed = sprintf '%f', $elapsed;
1223 my $av = sprintf '%.3f',
1224 ( $elapsed == 0 ? '??' : ( 1 / $elapsed ) );
1225 my $t = Text::SimpleTable->new( [ 64, 'Action' ], [ 9, 'Time' ] );
1230 my $stat = $action->getNodeValue;
1231 $t->row( ( q{ } x $action->getDepth ) . $stat->{action},
1232 $stat->{elapsed} || '??' );
1237 "Request took ${elapsed}s ($av/s)\n" . $t->draw );
1239 else { $status = &$handler }
1243 if ( my $error = $@ ) {
1245 $class->log->error(qq/Caught exception in engine "$error"/);
1249 $class->log->_flush() if $class->log->can('_flush');
1253 =head2 $c->prepare( @arguments )
1255 Creates a Catalyst context from an engine-specific request (Apache, CGI,
1261 my ( $class, @arguments ) = @_;
1263 $class->context_class( ref $class || $class ) unless $class->context_class;
1264 my $c = $class->context_class->new(
1268 request => $class->request_class->new(
1271 body_parameters => {},
1273 headers => HTTP::Headers->new,
1275 query_parameters => {},
1281 response => $class->response_class->new(
1285 headers => HTTP::Headers->new(),
1294 # For on-demand data
1295 $c->request->{_context} = $c;
1296 $c->response->{_context} = $c;
1297 weaken( $c->request->{_context} );
1298 weaken( $c->response->{_context} );
1301 my $secs = time - $START || 1;
1302 my $av = sprintf '%.3f', $COUNT / $secs;
1303 $c->log->debug('**********************************');
1304 $c->log->debug("* Request $COUNT ($av/s) [$$]");
1305 $c->log->debug('**********************************');
1306 $c->res->headers->header( 'X-Catalyst' => $Catalyst::VERSION );
1309 $c->prepare_request(@arguments);
1310 $c->prepare_connection;
1311 $c->prepare_query_parameters;
1312 $c->prepare_headers;
1313 $c->prepare_cookies;
1317 $c->prepare_body unless $c->config->{parse_on_demand};
1319 my $method = $c->req->method || '';
1320 my $path = $c->req->path || '';
1321 my $address = $c->req->address || '';
1323 $c->log->debug(qq/"$method" request for "$path" from "$address"/)
1331 =head2 $c->prepare_action
1337 sub prepare_action { my $c = shift; $c->dispatcher->prepare_action( $c, @_ ) }
1339 =head2 $c->prepare_body
1341 Prepares message body.
1348 # Do we run for the first time?
1349 return if defined $c->request->{_body};
1351 # Initialize on-demand data
1352 $c->engine->prepare_body( $c, @_ );
1353 $c->prepare_parameters;
1354 $c->prepare_uploads;
1356 if ( $c->debug && keys %{ $c->req->body_parameters } ) {
1357 my $t = Text::SimpleTable->new( [ 37, 'Key' ], [ 36, 'Value' ] );
1358 for my $key ( sort keys %{ $c->req->body_parameters } ) {
1359 my $param = $c->req->body_parameters->{$key};
1360 my $value = defined($param) ? $param : '';
1362 ref $value eq 'ARRAY' ? ( join ', ', @$value ) : $value );
1364 $c->log->debug( "Body Parameters are:\n" . $t->draw );
1368 =head2 $c->prepare_body_chunk( $chunk )
1370 Prepares a chunk of data before sending it to L<HTTP::Body>.
1374 sub prepare_body_chunk {
1376 $c->engine->prepare_body_chunk( $c, @_ );
1379 =head2 $c->prepare_body_parameters
1381 Prepares body parameters.
1385 sub prepare_body_parameters {
1387 $c->engine->prepare_body_parameters( $c, @_ );
1390 =head2 $c->prepare_connection
1392 Prepares connection.
1396 sub prepare_connection {
1398 $c->engine->prepare_connection( $c, @_ );
1401 =head2 $c->prepare_cookies
1407 sub prepare_cookies { my $c = shift; $c->engine->prepare_cookies( $c, @_ ) }
1409 =head2 $c->prepare_headers
1415 sub prepare_headers { my $c = shift; $c->engine->prepare_headers( $c, @_ ) }
1417 =head2 $c->prepare_parameters
1419 Prepares parameters.
1423 sub prepare_parameters {
1425 $c->prepare_body_parameters;
1426 $c->engine->prepare_parameters( $c, @_ );
1429 =head2 $c->prepare_path
1431 Prepares path and base.
1435 sub prepare_path { my $c = shift; $c->engine->prepare_path( $c, @_ ) }
1437 =head2 $c->prepare_query_parameters
1439 Prepares query parameters.
1443 sub prepare_query_parameters {
1446 $c->engine->prepare_query_parameters( $c, @_ );
1448 if ( $c->debug && keys %{ $c->request->query_parameters } ) {
1449 my $t = Text::SimpleTable->new( [ 37, 'Key' ], [ 36, 'Value' ] );
1450 for my $key ( sort keys %{ $c->req->query_parameters } ) {
1451 my $param = $c->req->query_parameters->{$key};
1452 my $value = defined($param) ? $param : '';
1454 ref $value eq 'ARRAY' ? ( join ', ', @$value ) : $value );
1456 $c->log->debug( "Query Parameters are:\n" . $t->draw );
1460 =head2 $c->prepare_read
1462 Prepares the input for reading.
1466 sub prepare_read { my $c = shift; $c->engine->prepare_read( $c, @_ ) }
1468 =head2 $c->prepare_request
1470 Prepares the engine request.
1474 sub prepare_request { my $c = shift; $c->engine->prepare_request( $c, @_ ) }
1476 =head2 $c->prepare_uploads
1482 sub prepare_uploads {
1485 $c->engine->prepare_uploads( $c, @_ );
1487 if ( $c->debug && keys %{ $c->request->uploads } ) {
1488 my $t = Text::SimpleTable->new(
1494 for my $key ( sort keys %{ $c->request->uploads } ) {
1495 my $upload = $c->request->uploads->{$key};
1496 for my $u ( ref $upload eq 'ARRAY' ? @{$upload} : ($upload) ) {
1497 $t->row( $key, $u->filename, $u->type, $u->size );
1500 $c->log->debug( "File Uploads are:\n" . $t->draw );
1504 =head2 $c->prepare_write
1506 Prepares the output for writing.
1510 sub prepare_write { my $c = shift; $c->engine->prepare_write( $c, @_ ) }
1512 =head2 $c->request_class
1514 Returns or sets the request class.
1516 =head2 $c->response_class
1518 Returns or sets the response class.
1520 =head2 $c->read( [$maxlength] )
1522 Reads a chunk of data from the request body. This method is designed to
1523 be used in a while loop, reading C<$maxlength> bytes on every call.
1524 C<$maxlength> defaults to the size of the request if not specified.
1526 You have to set C<MyApp-E<gt>config-E<gt>{parse_on_demand}> to use this
1531 sub read { my $c = shift; return $c->engine->read( $c, @_ ) }
1539 sub run { my $c = shift; return $c->engine->run( $c, @_ ) }
1541 =head2 $c->set_action( $action, $code, $namespace, $attrs )
1543 Sets an action in a given namespace.
1547 sub set_action { my $c = shift; $c->dispatcher->set_action( $c, @_ ) }
1549 =head2 $c->setup_actions($component)
1551 Sets up actions for a component.
1555 sub setup_actions { my $c = shift; $c->dispatcher->setup_actions( $c, @_ ) }
1557 =head2 $c->setup_components
1563 sub setup_components {
1566 my $callback = sub {
1567 my ( $component, $context ) = @_;
1569 unless ( $component->can('COMPONENT') ) {
1573 my $suffix = Catalyst::Utils::class2classsuffix($component);
1574 my $config = $class->config->{$suffix} || {};
1578 eval { $instance = $component->COMPONENT( $context, $config ); };
1580 if ( my $error = $@ ) {
1584 Catalyst::Exception->throw( message =>
1585 qq/Couldn't instantiate component "$component", "$error"/ );
1588 Catalyst::Exception->throw( message =>
1589 qq/Couldn't instantiate component "$component", "COMPONENT() didn't return a object"/
1591 unless ref $instance;
1595 eval "package $class;\n" . q!Module::Pluggable::Fast->import(
1596 name => '_catalyst_components',
1598 "$class\::Controller", "$class\::C",
1599 "$class\::Model", "$class\::M",
1600 "$class\::View", "$class\::V"
1602 callback => $callback
1606 if ( my $error = $@ ) {
1610 Catalyst::Exception->throw(
1611 message => qq/Couldn't load components "$error"/ );
1614 for my $component ( $class->_catalyst_components($class) ) {
1615 $class->components->{ ref $component || $component } = $component;
1619 =head2 $c->setup_dispatcher
1625 sub setup_dispatcher {
1626 my ( $class, $dispatcher ) = @_;
1629 $dispatcher = 'Catalyst::Dispatcher::' . $dispatcher;
1632 if ( $ENV{CATALYST_DISPATCHER} ) {
1633 $dispatcher = 'Catalyst::Dispatcher::' . $ENV{CATALYST_DISPATCHER};
1636 if ( $ENV{ uc($class) . '_DISPATCHER' } ) {
1638 'Catalyst::Dispatcher::' . $ENV{ uc($class) . '_DISPATCHER' };
1641 unless ($dispatcher) {
1642 $dispatcher = $class->dispatcher_class;
1645 $dispatcher->require;
1648 Catalyst::Exception->throw(
1649 message => qq/Couldn't load dispatcher "$dispatcher", "$@"/ );
1652 # dispatcher instance
1653 $class->dispatcher( $dispatcher->new );
1656 =head2 $c->setup_engine
1663 my ( $class, $engine ) = @_;
1666 $engine = 'Catalyst::Engine::' . $engine;
1669 if ( $ENV{CATALYST_ENGINE} ) {
1670 $engine = 'Catalyst::Engine::' . $ENV{CATALYST_ENGINE};
1673 if ( $ENV{ uc($class) . '_ENGINE' } ) {
1674 $engine = 'Catalyst::Engine::' . $ENV{ uc($class) . '_ENGINE' };
1677 if ( $ENV{MOD_PERL} ) {
1679 # create the apache method
1682 *{"$class\::apache"} = sub { shift->engine->apache };
1685 my ( $software, $version ) =
1686 $ENV{MOD_PERL} =~ /^(\S+)\/(\d+(?:[\.\_]\d+)+)/;
1689 $version =~ s/(\.[^.]+)\./$1/g;
1691 if ( $software eq 'mod_perl' ) {
1695 if ( $version >= 1.99922 ) {
1696 $engine = 'Catalyst::Engine::Apache2::MP20';
1699 elsif ( $version >= 1.9901 ) {
1700 $engine = 'Catalyst::Engine::Apache2::MP19';
1703 elsif ( $version >= 1.24 ) {
1704 $engine = 'Catalyst::Engine::Apache::MP13';
1708 Catalyst::Exception->throw( message =>
1709 qq/Unsupported mod_perl version: $ENV{MOD_PERL}/ );
1714 # install the correct mod_perl handler
1715 if ( $version >= 1.9901 ) {
1716 *handler = sub : method {
1717 shift->handle_request(@_);
1721 *handler = sub ($$) { shift->handle_request(@_) };
1726 elsif ( $software eq 'Zeus-Perl' ) {
1727 $engine = 'Catalyst::Engine::Zeus';
1731 Catalyst::Exception->throw(
1732 message => qq/Unsupported mod_perl: $ENV{MOD_PERL}/ );
1737 $engine = $class->engine_class;
1743 Catalyst::Exception->throw( message =>
1744 qq/Couldn't load engine "$engine" (maybe you forgot to install it?), "$@"/
1748 # check for old engines that are no longer compatible
1750 if ( $engine->isa('Catalyst::Engine::Apache')
1751 && !Catalyst::Engine::Apache->VERSION )
1756 elsif ( $engine->isa('Catalyst::Engine::Server::Base')
1757 && Catalyst::Engine::Server->VERSION le '0.02' )
1762 elsif ($engine->isa('Catalyst::Engine::HTTP::POE')
1763 && $engine->VERSION eq '0.01' )
1768 elsif ($engine->isa('Catalyst::Engine::Zeus')
1769 && $engine->VERSION eq '0.01' )
1775 Catalyst::Exception->throw( message =>
1776 qq/Engine "$engine" is not supported by this version of Catalyst/
1781 $class->engine( $engine->new );
1784 =head2 $c->setup_home
1786 Sets up the home directory.
1791 my ( $class, $home ) = @_;
1793 if ( $ENV{CATALYST_HOME} ) {
1794 $home = $ENV{CATALYST_HOME};
1797 if ( $ENV{ uc($class) . '_HOME' } ) {
1798 $home = $ENV{ uc($class) . '_HOME' };
1802 $home = Catalyst::Utils::home($class);
1806 $class->config->{home} ||= $home;
1807 $class->config->{root} ||= dir($home)->subdir('root');
1811 =head2 $c->setup_log
1818 my ( $class, $debug ) = @_;
1820 unless ( $class->log ) {
1821 $class->log( Catalyst::Log->new );
1824 my $app_flag = Catalyst::Utils::class2env($class) . '_DEBUG';
1827 ( defined( $ENV{CATALYST_DEBUG} ) || defined( $ENV{$app_flag} ) )
1828 ? ( $ENV{CATALYST_DEBUG} || $ENV{$app_flag} )
1833 *{"$class\::debug"} = sub { 1 };
1834 $class->log->debug('Debug messages enabled');
1838 =head2 $c->setup_plugins
1845 my ( $class, $plugins ) = @_;
1848 for my $plugin ( reverse @$plugins ) {
1850 $plugin = "Catalyst::Plugin::$plugin";
1855 Catalyst::Exception->throw(
1856 message => qq/Couldn't load plugin "$plugin", "$@"/ );
1861 unshift @{"$class\::ISA"}, $plugin;
1870 =head2 $c->write( $data )
1872 Writes $data to the output stream. When using this method directly, you
1873 will need to manually set the C<Content-Length> header to the length of
1874 your output data, if known.
1881 # Finalize headers if someone manually writes output
1882 $c->finalize_headers;
1884 return $c->engine->write( $c, @_ );
1889 Returns the Catalyst version number. Mostly useful for "powered by"
1890 messages in template systems.
1894 sub version { return $Catalyst::VERSION }
1896 =head1 INTERNAL ACTIONS
1898 Catalyst uses internal actions like C<_DISPATCH>, C<_BEGIN>, C<_AUTO>,
1899 C<_ACTION>, and C<_END>. These are by default not shown in the private
1900 action table, but you can make them visible with a config parameter.
1902 MyApp->config->{show_internal_actions} = 1;
1904 =head1 CASE SENSITIVITY
1906 By default Catalyst is not case sensitive, so C<MyApp::C::FOO::Bar> is
1907 mapped to C</foo/bar>. You can activate case sensitivity with a config
1910 MyApp->config->{case_sensitive} = 1;
1912 This causes C<MyApp::C::Foo::Bar> to map to C</Foo/Bar>.
1914 =head1 ON-DEMAND PARSER
1916 The request body is usually parsed at the beginning of a request,
1917 but if you want to handle input yourself or speed things up a bit,
1918 you can enable on-demand parsing with a config parameter.
1920 MyApp->config->{parse_on_demand} = 1;
1922 =head1 PROXY SUPPORT
1924 Many production servers operate using the common double-server approach,
1925 with a lightweight frontend web server passing requests to a larger
1926 backend server. An application running on the backend server must deal
1927 with two problems: the remote user always appears to be C<127.0.0.1> and
1928 the server's hostname will appear to be C<localhost> regardless of the
1929 virtual host that the user connected through.
1931 Catalyst will automatically detect this situation when you are running
1932 the frontend and backend servers on the same machine. The following
1933 changes are made to the request.
1935 $c->req->address is set to the user's real IP address, as read from
1936 the HTTP X-Forwarded-For header.
1938 The host value for $c->req->base and $c->req->uri is set to the real
1939 host, as read from the HTTP X-Forwarded-Host header.
1941 Obviously, your web server must support these headers for this to work.
1943 In a more complex server farm environment where you may have your
1944 frontend proxy server(s) on different machines, you will need to set a
1945 configuration option to tell Catalyst to read the proxied data from the
1948 MyApp->config->{using_frontend_proxy} = 1;
1950 If you do not wish to use the proxy support at all, you may set:
1952 MyApp->config->{ignore_frontend_proxy} = 1;
1954 =head1 THREAD SAFETY
1956 Catalyst has been tested under Apache 2's threading mpm_worker, mpm_winnt,
1957 and the standalone forking HTTP server on Windows. We believe the Catalyst
1958 core to be thread-safe.
1960 If you plan to operate in a threaded environment, remember that all other
1961 modules you are using must also be thread-safe. Some modules, most notably
1962 L<DBD::SQLite>, are not thread-safe.
1968 Join #catalyst on irc.perl.org.
1972 http://lists.rawmode.org/mailman/listinfo/catalyst
1973 http://lists.rawmode.org/mailman/listinfo/catalyst-dev
1977 http://catalyst.perl.org
1981 http://dev.catalyst.perl.org
1985 =head2 L<Task::Catalyst> - All you need to start with Catalyst
1987 =head2 L<Catalyst::Manual> - The Catalyst Manual
1989 =head2 L<Catalyst::Component>, L<Catalyst::Base> - Base classes for components
1991 =head2 L<Catalyst::Engine> - Core engine
1993 =head2 L<Catalyst::Log> - Log class.
1995 =head2 L<Catalyst::Request> - Request object
1997 =head2 L<Catalyst::Response> - Response object
1999 =head2 L<Catalyst::Test> - The test suite.
2069 Sebastian Riedel, C<sri@oook.de>
2073 This library is free software, you can redistribute it and/or modify it under
2074 the same terms as Perl itself.