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 blessed/;
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.66';
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 If your plugin starts with a name other than C<Catalyst::Plugin::>, you can
182 fully qualify the name by using a unary plus:
186 +Fully::Qualified::Plugin::Name
189 Special flags like C<-Debug> and C<-Engine> can also be specified as
190 arguments when Catalyst is loaded:
192 use Catalyst qw/-Debug My::Module/;
194 The position of plugins and flags in the chain is important, because
195 they are loaded in exactly the order in which they appear.
197 The following flags are supported:
201 Enables debug output.
205 Forces Catalyst to use a specific engine. Omit the
206 C<Catalyst::Engine::> prefix of the engine name, i.e.:
208 use Catalyst qw/-Engine=CGI/;
212 Forces Catalyst to use a specific home directory, e.g.:
214 use Catalyst qw[-Home=/usr/sri];
222 =head2 Information about the current request
226 Returns a L<Catalyst::Action> object for the current action, which
227 stringifies to the action name. See L<Catalyst::Action>.
231 Returns the namespace of the current action, i.e., the uri prefix
232 corresponding to the controller of the current action. For example:
234 # in Controller::Foo::Bar
235 $c->namespace; # returns 'foo/bar';
241 Returns the current L<Catalyst::Request> object. See
242 L<Catalyst::Request>.
244 =head2 Processing and response to the current request
246 =head2 $c->forward( $action [, \@arguments ] )
248 =head2 $c->forward( $class, $method, [, \@arguments ] )
250 Forwards processing to a private action. If you give a class name but no
251 method, C<process()> is called. You may also optionally pass arguments
252 in an arrayref. The action will receive the arguments in C<@_> and
253 C<$c-E<gt>req-E<gt>args>. Upon returning from the function,
254 C<$c-E<gt>req-E<gt>args> will be restored to the previous values.
256 Any data C<return>ed from the action forwarded to, will be returned by the
259 my $foodata = $c->forward('/foo');
260 $c->forward('index');
261 $c->forward(qw/MyApp::Model::CDBI::Foo do_stuff/);
262 $c->forward('MyApp::View::TT');
266 sub forward { my $c = shift; $c->dispatcher->forward( $c, @_ ) }
268 =head2 $c->detach( $action [, \@arguments ] )
270 =head2 $c->detach( $class, $method, [, \@arguments ] )
272 The same as C<forward>, but doesn't return.
276 sub detach { my $c = shift; $c->dispatcher->detach( $c, @_ ) }
280 =head2 $c->error($error, ...)
282 =head2 $c->error($arrayref)
284 Returns an arrayref containing error messages. If Catalyst encounters an
285 error while processing a request, it stores the error in $c->error. This
286 method should not be used to store non-fatal error messages.
288 my @error = @{ $c->error };
292 $c->error('Something bad happened');
294 Clear errors. You probably don't want to clear the errors unless you are
295 implementing a custom error screen.
304 my $error = ref $_[0] eq 'ARRAY' ? $_[0] : [@_];
305 push @{ $c->{error} }, @$error;
307 elsif ( defined $_[0] ) { $c->{error} = undef }
308 return $c->{error} || [];
315 Returns the current L<Catalyst::Response> object.
319 Returns a hashref to the stash, which may be used to store data and pass
320 it between components during a request. You can also set hash keys by
321 passing arguments. The stash is automatically sent to the view. The
322 stash is cleared at the end of a request; it cannot be used for
325 $c->stash->{foo} = $bar;
326 $c->stash( { moose => 'majestic', qux => 0 } );
327 $c->stash( bar => 1, gorch => 2 ); # equivalent to passing a hashref
329 # stash is automatically passed to the view for use in a template
330 $c->forward( 'MyApp::V::TT' );
337 my $stash = @_ > 1 ? {@_} : $_[0];
338 while ( my ( $key, $val ) = each %$stash ) {
339 $c->{stash}->{$key} = $val;
347 Contains the return value of the last executed action.
353 my ($c, @names) = @_;
355 foreach my $name (@names) {
356 foreach my $component ( keys %{ $c->components } ) {
357 my $comp = $c->components->{$component} if $component =~ /$name/i;
359 if ( eval { $comp->can('ACCEPT_CONTEXT'); } ) {
360 return $comp->ACCEPT_CONTEXT($c);
362 else { return $comp }
370 # try explicit component names
372 my ($c, @names) = @_;
374 foreach my $try (@names) {
375 if ( exists $c->components->{$try} ) {
376 my $comp = $c->components->{$try};
377 if ( eval { $comp->can('ACCEPT_CONTEXT'); } ) {
378 return $comp->ACCEPT_CONTEXT($c);
380 else { return $comp }
387 # like component, but try just these prefixes before regex searching,
388 # and do not try to return "sort keys %{ $c->components }"
390 my ($c, $name, @prefixes) = @_;
392 my $appclass = ref $c || $c;
394 my @names = map { "${appclass}::${_}::${name}" } @prefixes;
396 my $comp = $c->_comp_explicit(@names);
397 return $comp if defined($comp);
398 $comp = $c->_comp_search($name);
402 =head2 Component Accessors
404 =head2 $c->comp($name)
406 =head2 $c->component($name)
408 Gets a component object by name. This method is no longer recommended,
409 unless you want to get a specific component by full
410 class. C<$c-E<gt>controller>, C<$c-E<gt>model>, and C<$c-E<gt>view>
411 should be used instead.
422 my $appclass = ref $c || $c;
425 $name, "${appclass}::${name}",
426 map { "${appclass}::${_}::${name}" }
427 qw/Model M Controller C View V/
430 my $comp = $c->_comp_explicit(@names);
431 return $comp if defined($comp);
433 $comp = $c->_comp_search($name);
434 return $comp if defined($comp);
437 return sort keys %{ $c->components };
440 =head2 $c->controller($name)
442 Gets a L<Catalyst::Controller> instance by name.
444 $c->controller('Foo')->do_stuff;
449 my ( $c, $name ) = @_;
450 return $c->_comp_prefixes($name, qw/Controller C/);
453 =head2 $c->model($name)
455 Gets a L<Catalyst::Model> instance by name.
457 $c->model('Foo')->do_stuff;
462 my ( $c, $name ) = @_;
463 return $c->_comp_prefixes($name, qw/Model M/);
466 =head2 $c->view($name)
468 Gets a L<Catalyst::View> instance by name.
470 $c->view('Foo')->do_stuff;
475 my ( $c, $name ) = @_;
476 return $c->_comp_prefixes($name, qw/View V/);
479 =head2 Class data and helper classes
483 Returns or takes a hashref containing the application's configuration.
485 __PACKAGE__->config( { db => 'dsn:SQLite:foo.db' } );
487 You can also use a L<YAML> config file like myapp.yml in your
488 applications home directory.
491 db: dsn:SQLite:foo.db
498 $c->log->warn("Setting config after setup has been run is not a good idea.")
499 if ( @_ and $c->setup_finished );
501 $c->NEXT::config(@_);
506 Overload to enable debug messages (same as -Debug option).
512 =head2 $c->dispatcher
514 Returns the dispatcher instance. Stringifies to class name. See
515 L<Catalyst::Dispatcher>.
519 Returns the engine instance. Stringifies to the class name. See
524 Returns the logging object instance. Unless it is already set, Catalyst sets
525 this up with a L<Catalyst::Log> object. To use your own log class, set the
526 logger with the C<< __PACKAGE__->log >> method prior to calling
527 C<< __PACKAGE__->setup >>.
529 __PACKAGE__->log( MyLogger->new );
534 $c->log->info( 'Now logging with my own logger!' );
536 Your log class should implement the methods described in the
537 L<Catalyst::Log> man page.
541 =head2 Utility methods
543 =head2 $c->path_to(@path)
545 Merges C<@path> with C<$c-E<gt>config-E<gt>{home}> and returns a
546 L<Path::Class> object.
550 $c->path_to( 'db', 'sqlite.db' );
555 my ( $c, @path ) = @_;
556 my $path = dir( $c->config->{home}, @path );
557 if ( -d $path ) { return $path }
558 else { return file( $c->config->{home}, @path ) }
561 =head2 $c->plugin( $name, $class, @args )
563 Helper method for plugins. It creates a classdata accessor/mutator and
564 loads and instantiates the given class.
566 MyApp->plugin( 'prototype', 'HTML::Prototype' );
568 $c->prototype->define_javascript_functions;
573 my ( $class, $name, $plugin, @args ) = @_;
574 $class->_register_plugin( $plugin, 1 );
576 eval { $plugin->import };
577 $class->mk_classdata($name);
579 eval { $obj = $plugin->new(@args) };
582 Catalyst::Exception->throw( message =>
583 qq/Couldn't instantiate instant plugin "$plugin", "$@"/ );
587 $class->log->debug(qq/Initialized instant plugin "$plugin" as "$name"/)
593 Initializes the dispatcher and engine, loads any plugins, and loads the
594 model, view, and controller components. You may also specify an array
595 of plugins to load here, if you choose to not load them in the C<use
599 MyApp->setup( qw/-Debug/ );
604 my ( $class, @arguments ) = @_;
606 unless ( $class->isa('Catalyst') ) {
608 Catalyst::Exception->throw(
609 message => qq/'$class' does not inherit from Catalyst/ );
612 if ( $class->arguments ) {
613 @arguments = ( @arguments, @{ $class->arguments } );
619 foreach (@arguments) {
623 ( $flags->{log} ) ? 'debug,' . $flags->{log} : 'debug';
625 elsif (/^-(\w+)=?(.*)$/) {
626 $flags->{ lc $1 } = $2;
629 push @{ $flags->{plugins} }, $_;
633 $class->setup_home( delete $flags->{home} );
635 $class->setup_log( delete $flags->{log} );
636 $class->setup_plugins( delete $flags->{plugins} );
637 $class->setup_dispatcher( delete $flags->{dispatcher} );
638 $class->setup_engine( delete $flags->{engine} );
640 for my $flag ( sort keys %{$flags} ) {
642 if ( my $code = $class->can( 'setup_' . $flag ) ) {
643 &$code( $class, delete $flags->{$flag} );
646 $class->log->warn(qq/Unknown flag "$flag"/);
651 <<"EOF") if ( $ENV{CATALYST_SCRIPT_GEN} && ( $ENV{CATALYST_SCRIPT_GEN} < $Catalyst::CATALYST_SCRIPT_GEN ) );
652 You are running an old script!
654 Please update by running (this will overwrite existing files):
655 catalyst.pl -force -scripts $class
657 or (this will not overwrite existing files):
658 catalyst.pl -scripts $class
661 if ( $class->debug ) {
668 map { $_ . ' ' . ( $_->VERSION || '' ) }
669 grep { /^Catalyst::Plugin/ } @{"$class\::ISA"};
673 my $t = Text::SimpleTable->new(76);
674 $t->row($_) for @plugins;
675 $class->log->debug( "Loaded plugins:\n" . $t->draw );
678 my $dispatcher = $class->dispatcher;
679 my $engine = $class->engine;
680 my $home = $class->config->{home};
682 $class->log->debug(qq/Loaded dispatcher "$dispatcher"/);
683 $class->log->debug(qq/Loaded engine "$engine"/);
687 ? $class->log->debug(qq/Found home "$home"/)
688 : $class->log->debug(qq/Home "$home" doesn't exist/)
689 : $class->log->debug(q/Couldn't find home/);
694 no warnings qw/redefine/;
695 local *setup = sub { };
699 # Initialize our data structure
700 $class->components( {} );
702 $class->setup_components;
704 if ( $class->debug ) {
705 my $t = Text::SimpleTable->new( [ 65, 'Class' ], [ 8, 'Type' ] );
706 for my $comp ( sort keys %{ $class->components } ) {
707 my $type = ref $class->components->{$comp} ? 'instance' : 'class';
708 $t->row( $comp, $type );
710 $class->log->debug( "Loaded components:\n" . $t->draw )
711 if ( keys %{ $class->components } );
714 # Add our self to components, since we are also a component
715 $class->components->{$class} = $class;
717 $class->setup_actions;
719 if ( $class->debug ) {
720 my $name = $class->config->{name} || 'Application';
721 $class->log->info("$name powered by Catalyst $Catalyst::VERSION");
723 $class->log->_flush() if $class->log->can('_flush');
725 $class->setup_finished(1);
728 =head2 $c->uri_for( $path, [ @args ] )
730 Merges path with C<$c-E<gt>request-E<gt>base> for absolute uri's and
731 with C<$c-E<gt>namespace> for relative uri's, then returns a
732 normalized L<URI> object. If any args are passed, they are added at the
733 end of the path. If the last argument to uri_for is a hash reference,
734 it is assumed to contain GET parameter key/value pairs, which will be
735 appended to the URI in standard fashion.
740 my ( $c, $path, @args ) = @_;
741 my $base = $c->request->base->clone;
742 my $basepath = $base->path;
743 $basepath =~ s/\/$//;
745 my $namespace = $c->namespace;
747 # massage namespace, empty if absolute path
748 $namespace =~ s/^\///;
749 $namespace .= '/' if $namespace;
751 $namespace = '' if $path =~ /^\//;
755 ( scalar @args && ref $args[$#args] eq 'HASH' ? pop @args : {} );
757 # join args with '/', or a blank string
758 my $args = ( scalar @args ? '/' . join( '/', @args ) : '' );
759 $args =~ s/^\/// unless $path;
761 URI->new_abs( URI->new_abs( "$path$args", "$basepath$namespace" ), $base )
763 $res->query_form(%$params);
767 =head2 $c->welcome_message
769 Returns the Catalyst welcome HTML page.
773 sub welcome_message {
775 my $name = $c->config->{name};
776 my $logo = $c->uri_for('/static/images/catalyst_logo.png');
777 my $prefix = Catalyst::Utils::appprefix( ref $c );
778 $c->response->content_type('text/html; charset=utf-8');
780 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
781 "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
782 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
784 <meta http-equiv="Content-Language" content="en" />
785 <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
786 <title>$name on Catalyst $VERSION</title>
787 <style type="text/css">
790 background-color: #eee;
799 background-color: #ccc;
800 border: 1px solid #aaa;
801 -moz-border-radius: 10px;
806 font-family: verdana, tahoma, sans-serif;
809 font-family: verdana, tahoma, sans-serif;
812 text-decoration: none;
814 border-bottom: 1px dotted #bbb;
816 :link:hover, :visited:hover {
829 background-color: #fff;
830 border: 1px solid #aaa;
831 -moz-border-radius: 10px;
857 <h1><span id="appname">$name</span> on <a href="http://catalyst.perl.org">Catalyst</a>
862 <img src="$logo" alt="Catalyst Logo" />
864 <p>Welcome to the wonderful world of Catalyst.
865 This <a href="http://en.wikipedia.org/wiki/MVC">MVC</a>
866 framework will make web development something you had
867 never expected it to be: Fun, rewarding, and quick.</p>
868 <h2>What to do now?</h2>
869 <p>That really depends on what <b>you</b> want to do.
870 We do, however, provide you with a few starting points.</p>
871 <p>If you want to jump right into web development with Catalyst
872 you might want to check out the documentation.</p>
873 <pre><code>perldoc <a href="http://cpansearch.perl.org/dist/Catalyst/lib/Catalyst/Manual/Intro.pod">Catalyst::Manual::Intro</a>
874 perldoc <a href="http://cpansearch.perl.org/dist/Catalyst/lib/Catalyst/Manual/Tutorial.pod">Catalyst::Manual::Tutorial</a></code>
875 perldoc <a href="http://cpansearch.perl.org/dist/Catalyst/lib/Catalyst/Manual.pod">Catalyst::Manual</a></code></pre>
876 <h2>What to do next?</h2>
877 <p>Next it's time to write an actual application. Use the
878 helper scripts to generate <a href="http://cpansearch.perl.org/search?query=Catalyst%3A%3AController%3A%3A&mode=all">controllers</a>,
879 <a href="http://cpansearch.perl.org/search?query=Catalyst%3A%3AModel%3A%3A&mode=all">models</a>, and
880 <a href="http://cpansearch.perl.org/search?query=Catalyst%3A%3AView%3A%3A&mode=all">views</a>;
881 they can save you a lot of work.</p>
882 <pre><code>script/${prefix}_create.pl -help</code></pre>
883 <p>Also, be sure to check out the vast and growing
884 collection of <a href="http://cpansearch.perl.org/search?query=Catalyst%3A%3APlugin%3A%3A&mode=all">plugins for Catalyst on CPAN</a>;
885 you are likely to find what you need there.
889 <p>Catalyst has a very active community. Here are the main places to
890 get in touch with us.</p>
893 <a href="http://dev.catalyst.perl.org">Wiki</a>
896 <a href="http://lists.rawmode.org/mailman/listinfo/catalyst">Mailing-List</a>
899 <a href="irc://irc.perl.org/catalyst">IRC channel #catalyst on irc.perl.org</a>
902 <h2>In conclusion</h2>
903 <p>The Catalyst team hopes you will enjoy using Catalyst as much
904 as we enjoyed making it. Please contact us if you have ideas
905 for improvement or other feedback.</p>
913 =head1 INTERNAL METHODS
915 These methods are not meant to be used by end users.
917 =head2 $c->components
919 Returns a hash of components.
921 =head2 $c->context_class
923 Returns or sets the context class.
927 Returns a hashref containing coderefs and execution counts (needed for
928 deep recursion detection).
932 Returns the number of actions on the current internal execution stack.
936 Dispatches a request to actions.
940 sub dispatch { my $c = shift; $c->dispatcher->dispatch( $c, @_ ) }
942 =head2 $c->dispatcher_class
944 Returns or sets the dispatcher class.
946 =head2 $c->dump_these
948 Returns a list of 2-element array references (name, structure) pairs
949 that will be dumped on the error page in debug mode.
955 [ Request => $c->req ], [ Response => $c->res ], [ Stash => $c->stash ],;
958 =head2 $c->engine_class
960 Returns or sets the engine class.
962 =head2 $c->execute( $class, $coderef )
964 Execute a coderef in given class and catch exceptions. Errors are available
970 my ( $c, $class, $code ) = @_;
971 $class = $c->component($class) || $class;
974 if ($c->depth >= $RECURSION) {
975 my $action = "$code";
976 $action = "/$action" unless $action =~ /\-\>/;
977 my $error = qq/Deep recursion detected calling "$action"/;
978 $c->log->error($error);
986 my $action = "$code";
987 $action = "/$action" unless $action =~ /\-\>/;
988 $c->counter->{"$code"}++;
990 # determine if the call was the result of a forward
991 # this is done by walking up the call stack and looking for a calling
992 # sub of Catalyst::forward before the eval
994 for my $index ( 1 .. 10 ) {
996 if ( ( caller($index) )[0] eq 'Catalyst'
997 && ( caller($index) )[3] eq '(eval)' );
999 if ( ( caller($index) )[3] =~ /forward$/ ) {
1000 $callsub = ( caller($index) )[3];
1001 $action = "-> $action";
1006 my $node = Tree::Simple->new(
1009 elapsed => undef, # to be filled in later
1012 $node->setUID( "$code" . $c->counter->{"$code"} );
1014 unless ( ( $code->name =~ /^_.*/ )
1015 && ( !$c->config->{show_internal_actions} ) )
1018 # is this a root-level call or a forwarded call?
1019 if ( $callsub =~ /forward$/ ) {
1021 # forward, locate the caller
1022 if ( my $parent = $c->stack->[-1] ) {
1023 my $visitor = Tree::Simple::Visitor::FindByUID->new;
1024 $visitor->searchForUID(
1025 "$parent" . $c->counter->{"$parent"} );
1026 $c->{stats}->accept($visitor);
1027 if ( my $result = $visitor->getResult ) {
1028 $result->addChild($node);
1033 # forward with no caller may come from a plugin
1034 $c->{stats}->addChild($node);
1040 $c->{stats}->addChild($node);
1045 push( @{ $c->stack }, $code );
1048 $start = [gettimeofday] if $c->debug;
1049 eval { $c->state( &$code( $class, $c, @{ $c->req->args } ) || 0 ) };
1050 $elapsed = tv_interval($start) if $c->debug;
1053 unless ( ( $code->name =~ /^_.*/ )
1054 && ( !$c->config->{show_internal_actions} ) )
1057 # FindByUID uses an internal die, so we save the existing error
1060 # locate the node in the tree and update the elapsed time
1061 my $visitor = Tree::Simple::Visitor::FindByUID->new;
1062 $visitor->searchForUID( "$code" . $c->counter->{"$code"} );
1063 $c->{stats}->accept($visitor);
1064 if ( my $result = $visitor->getResult ) {
1065 my $value = $result->getNodeValue;
1066 $value->{elapsed} = sprintf( '%fs', $elapsed );
1067 $result->setNodeValue($value);
1071 $@ = $error || undef;
1074 my $last = ${ $c->stack }[-1];
1075 pop( @{ $c->stack } );
1077 if ( my $error = $@ ) {
1078 if ( $error eq $DETACH ) { die $DETACH if $c->depth > 1 }
1080 unless ( ref $error ) {
1082 my $class = $last->class;
1083 my $name = $last->name;
1084 $error = qq/Caught exception in $class->$name "$error"/;
1095 Finalizes the request.
1102 for my $error ( @{ $c->error } ) {
1103 $c->log->error($error);
1106 $c->finalize_uploads;
1109 if ( $#{ $c->error } >= 0 ) {
1113 $c->finalize_headers;
1116 if ( $c->request->method eq 'HEAD' ) {
1117 $c->response->body('');
1122 return $c->response->status;
1125 =head2 $c->finalize_body
1131 sub finalize_body { my $c = shift; $c->engine->finalize_body( $c, @_ ) }
1133 =head2 $c->finalize_cookies
1139 sub finalize_cookies { my $c = shift; $c->engine->finalize_cookies( $c, @_ ) }
1141 =head2 $c->finalize_error
1147 sub finalize_error { my $c = shift; $c->engine->finalize_error( $c, @_ ) }
1149 =head2 $c->finalize_headers
1155 sub finalize_headers {
1158 # Check if we already finalized headers
1159 return if $c->response->{_finalized_headers};
1162 if ( my $location = $c->response->redirect ) {
1163 $c->log->debug(qq/Redirecting to "$location"/) if $c->debug;
1164 $c->response->header( Location => $location );
1168 if ( $c->response->body && !$c->response->content_length ) {
1170 # get the length from a filehandle
1171 if ( blessed($c->response->body) && $c->response->body->can('read') ) {
1172 if ( my $stat = stat $c->response->body ) {
1173 $c->response->content_length( $stat->size );
1176 $c->log->warn('Serving filehandle without a content-length');
1180 $c->response->content_length( bytes::length( $c->response->body ) );
1185 if ( $c->response->status =~ /^(1\d\d|[23]04)$/ ) {
1186 $c->response->headers->remove_header("Content-Length");
1187 $c->response->body('');
1190 $c->finalize_cookies;
1192 $c->engine->finalize_headers( $c, @_ );
1195 $c->response->{_finalized_headers} = 1;
1198 =head2 $c->finalize_output
1200 An alias for finalize_body.
1202 =head2 $c->finalize_read
1204 Finalizes the input after reading is complete.
1208 sub finalize_read { my $c = shift; $c->engine->finalize_read( $c, @_ ) }
1210 =head2 $c->finalize_uploads
1212 Finalizes uploads. Cleans up any temporary files.
1216 sub finalize_uploads { my $c = shift; $c->engine->finalize_uploads( $c, @_ ) }
1218 =head2 $c->get_action( $action, $namespace )
1220 Gets an action in a given namespace.
1224 sub get_action { my $c = shift; $c->dispatcher->get_action(@_) }
1226 =head2 $c->get_actions( $action, $namespace )
1228 Gets all actions of a given name in a namespace and all parent
1233 sub get_actions { my $c = shift; $c->dispatcher->get_actions( $c, @_ ) }
1235 =head2 handle_request( $class, @arguments )
1237 Called to handle each HTTP request.
1241 sub handle_request {
1242 my ( $class, @arguments ) = @_;
1244 # Always expect worst case!
1247 my $stats = ( $class->debug ) ? Tree::Simple->new: q{};
1250 my $c = $class->prepare(@arguments);
1251 $c->{stats} = $stats;
1253 return $c->finalize;
1256 if ( $class->debug ) {
1257 my $start = [gettimeofday];
1258 $status = &$handler;
1259 my $elapsed = tv_interval $start;
1260 $elapsed = sprintf '%f', $elapsed;
1261 my $av = sprintf '%.3f',
1262 ( $elapsed == 0 ? '??' : ( 1 / $elapsed ) );
1263 my $t = Text::SimpleTable->new( [ 64, 'Action' ], [ 9, 'Time' ] );
1268 my $stat = $action->getNodeValue;
1269 $t->row( ( q{ } x $action->getDepth ) . $stat->{action},
1270 $stat->{elapsed} || '??' );
1275 "Request took ${elapsed}s ($av/s)\n" . $t->draw );
1277 else { $status = &$handler }
1281 if ( my $error = $@ ) {
1283 $class->log->error(qq/Caught exception in engine "$error"/);
1287 $class->log->_flush() if $class->log->can('_flush');
1291 =head2 $c->prepare( @arguments )
1293 Creates a Catalyst context from an engine-specific request (Apache, CGI,
1299 my ( $class, @arguments ) = @_;
1301 $class->context_class( ref $class || $class ) unless $class->context_class;
1302 my $c = $class->context_class->new(
1306 request => $class->request_class->new(
1309 body_parameters => {},
1311 headers => HTTP::Headers->new,
1313 query_parameters => {},
1319 response => $class->response_class->new(
1323 headers => HTTP::Headers->new(),
1332 # For on-demand data
1333 $c->request->{_context} = $c;
1334 $c->response->{_context} = $c;
1335 weaken( $c->request->{_context} );
1336 weaken( $c->response->{_context} );
1339 my $secs = time - $START || 1;
1340 my $av = sprintf '%.3f', $COUNT / $secs;
1341 $c->log->debug('**********************************');
1342 $c->log->debug("* Request $COUNT ($av/s) [$$]");
1343 $c->log->debug('**********************************');
1344 $c->res->headers->header( 'X-Catalyst' => $Catalyst::VERSION );
1347 $c->prepare_request(@arguments);
1348 $c->prepare_connection;
1349 $c->prepare_query_parameters;
1350 $c->prepare_headers;
1351 $c->prepare_cookies;
1355 $c->prepare_body unless $c->config->{parse_on_demand};
1357 my $method = $c->req->method || '';
1358 my $path = $c->req->path || '';
1359 my $address = $c->req->address || '';
1361 $c->log->debug(qq/"$method" request for "$path" from "$address"/)
1369 =head2 $c->prepare_action
1375 sub prepare_action { my $c = shift; $c->dispatcher->prepare_action( $c, @_ ) }
1377 =head2 $c->prepare_body
1379 Prepares message body.
1386 # Do we run for the first time?
1387 return if defined $c->request->{_body};
1389 # Initialize on-demand data
1390 $c->engine->prepare_body( $c, @_ );
1391 $c->prepare_parameters;
1392 $c->prepare_uploads;
1394 if ( $c->debug && keys %{ $c->req->body_parameters } ) {
1395 my $t = Text::SimpleTable->new( [ 37, 'Key' ], [ 36, 'Value' ] );
1396 for my $key ( sort keys %{ $c->req->body_parameters } ) {
1397 my $param = $c->req->body_parameters->{$key};
1398 my $value = defined($param) ? $param : '';
1400 ref $value eq 'ARRAY' ? ( join ', ', @$value ) : $value );
1402 $c->log->debug( "Body Parameters are:\n" . $t->draw );
1406 =head2 $c->prepare_body_chunk( $chunk )
1408 Prepares a chunk of data before sending it to L<HTTP::Body>.
1412 sub prepare_body_chunk {
1414 $c->engine->prepare_body_chunk( $c, @_ );
1417 =head2 $c->prepare_body_parameters
1419 Prepares body parameters.
1423 sub prepare_body_parameters {
1425 $c->engine->prepare_body_parameters( $c, @_ );
1428 =head2 $c->prepare_connection
1430 Prepares connection.
1434 sub prepare_connection {
1436 $c->engine->prepare_connection( $c, @_ );
1439 =head2 $c->prepare_cookies
1445 sub prepare_cookies { my $c = shift; $c->engine->prepare_cookies( $c, @_ ) }
1447 =head2 $c->prepare_headers
1453 sub prepare_headers { my $c = shift; $c->engine->prepare_headers( $c, @_ ) }
1455 =head2 $c->prepare_parameters
1457 Prepares parameters.
1461 sub prepare_parameters {
1463 $c->prepare_body_parameters;
1464 $c->engine->prepare_parameters( $c, @_ );
1467 =head2 $c->prepare_path
1469 Prepares path and base.
1473 sub prepare_path { my $c = shift; $c->engine->prepare_path( $c, @_ ) }
1475 =head2 $c->prepare_query_parameters
1477 Prepares query parameters.
1481 sub prepare_query_parameters {
1484 $c->engine->prepare_query_parameters( $c, @_ );
1486 if ( $c->debug && keys %{ $c->request->query_parameters } ) {
1487 my $t = Text::SimpleTable->new( [ 37, 'Key' ], [ 36, 'Value' ] );
1488 for my $key ( sort keys %{ $c->req->query_parameters } ) {
1489 my $param = $c->req->query_parameters->{$key};
1490 my $value = defined($param) ? $param : '';
1492 ref $value eq 'ARRAY' ? ( join ', ', @$value ) : $value );
1494 $c->log->debug( "Query Parameters are:\n" . $t->draw );
1498 =head2 $c->prepare_read
1500 Prepares the input for reading.
1504 sub prepare_read { my $c = shift; $c->engine->prepare_read( $c, @_ ) }
1506 =head2 $c->prepare_request
1508 Prepares the engine request.
1512 sub prepare_request { my $c = shift; $c->engine->prepare_request( $c, @_ ) }
1514 =head2 $c->prepare_uploads
1520 sub prepare_uploads {
1523 $c->engine->prepare_uploads( $c, @_ );
1525 if ( $c->debug && keys %{ $c->request->uploads } ) {
1526 my $t = Text::SimpleTable->new(
1532 for my $key ( sort keys %{ $c->request->uploads } ) {
1533 my $upload = $c->request->uploads->{$key};
1534 for my $u ( ref $upload eq 'ARRAY' ? @{$upload} : ($upload) ) {
1535 $t->row( $key, $u->filename, $u->type, $u->size );
1538 $c->log->debug( "File Uploads are:\n" . $t->draw );
1542 =head2 $c->prepare_write
1544 Prepares the output for writing.
1548 sub prepare_write { my $c = shift; $c->engine->prepare_write( $c, @_ ) }
1550 =head2 $c->request_class
1552 Returns or sets the request class.
1554 =head2 $c->response_class
1556 Returns or sets the response class.
1558 =head2 $c->read( [$maxlength] )
1560 Reads a chunk of data from the request body. This method is designed to
1561 be used in a while loop, reading C<$maxlength> bytes on every call.
1562 C<$maxlength> defaults to the size of the request if not specified.
1564 You have to set C<MyApp-E<gt>config-E<gt>{parse_on_demand}> to use this
1569 sub read { my $c = shift; return $c->engine->read( $c, @_ ) }
1577 sub run { my $c = shift; return $c->engine->run( $c, @_ ) }
1579 =head2 $c->set_action( $action, $code, $namespace, $attrs )
1581 Sets an action in a given namespace.
1585 sub set_action { my $c = shift; $c->dispatcher->set_action( $c, @_ ) }
1587 =head2 $c->setup_actions($component)
1589 Sets up actions for a component.
1593 sub setup_actions { my $c = shift; $c->dispatcher->setup_actions( $c, @_ ) }
1595 =head2 $c->setup_components
1601 sub setup_components {
1604 my $callback = sub {
1605 my ( $component, $context ) = @_;
1607 unless ( $component->can('COMPONENT') ) {
1611 my $suffix = Catalyst::Utils::class2classsuffix($component);
1612 my $config = $class->config->{$suffix} || {};
1616 eval { $instance = $component->COMPONENT( $context, $config ); };
1618 if ( my $error = $@ ) {
1622 Catalyst::Exception->throw( message =>
1623 qq/Couldn't instantiate component "$component", "$error"/ );
1626 Catalyst::Exception->throw( message =>
1627 qq/Couldn't instantiate component "$component", "COMPONENT() didn't return a object"/
1629 unless ref $instance;
1633 eval "package $class;\n" . q!Module::Pluggable::Fast->import(
1634 name => '_catalyst_components',
1636 "$class\::Controller", "$class\::C",
1637 "$class\::Model", "$class\::M",
1638 "$class\::View", "$class\::V"
1640 callback => $callback
1644 if ( my $error = $@ ) {
1648 Catalyst::Exception->throw(
1649 message => qq/Couldn't load components "$error"/ );
1652 for my $component ( $class->_catalyst_components($class) ) {
1653 $class->components->{ ref $component || $component } = $component;
1657 =head2 $c->setup_dispatcher
1663 sub setup_dispatcher {
1664 my ( $class, $dispatcher ) = @_;
1667 $dispatcher = 'Catalyst::Dispatcher::' . $dispatcher;
1670 if ( $ENV{CATALYST_DISPATCHER} ) {
1671 $dispatcher = 'Catalyst::Dispatcher::' . $ENV{CATALYST_DISPATCHER};
1674 if ( $ENV{ uc($class) . '_DISPATCHER' } ) {
1676 'Catalyst::Dispatcher::' . $ENV{ uc($class) . '_DISPATCHER' };
1679 unless ($dispatcher) {
1680 $dispatcher = $class->dispatcher_class;
1683 $dispatcher->require;
1686 Catalyst::Exception->throw(
1687 message => qq/Couldn't load dispatcher "$dispatcher", "$@"/ );
1690 # dispatcher instance
1691 $class->dispatcher( $dispatcher->new );
1694 =head2 $c->setup_engine
1701 my ( $class, $engine ) = @_;
1704 $engine = 'Catalyst::Engine::' . $engine;
1707 if ( $ENV{CATALYST_ENGINE} ) {
1708 $engine = 'Catalyst::Engine::' . $ENV{CATALYST_ENGINE};
1711 if ( $ENV{ uc($class) . '_ENGINE' } ) {
1712 $engine = 'Catalyst::Engine::' . $ENV{ uc($class) . '_ENGINE' };
1715 if ( $ENV{MOD_PERL} ) {
1717 # create the apache method
1720 *{"$class\::apache"} = sub { shift->engine->apache };
1723 my ( $software, $version ) =
1724 $ENV{MOD_PERL} =~ /^(\S+)\/(\d+(?:[\.\_]\d+)+)/;
1727 $version =~ s/(\.[^.]+)\./$1/g;
1729 if ( $software eq 'mod_perl' ) {
1733 if ( $version >= 1.99922 ) {
1734 $engine = 'Catalyst::Engine::Apache2::MP20';
1737 elsif ( $version >= 1.9901 ) {
1738 $engine = 'Catalyst::Engine::Apache2::MP19';
1741 elsif ( $version >= 1.24 ) {
1742 $engine = 'Catalyst::Engine::Apache::MP13';
1746 Catalyst::Exception->throw( message =>
1747 qq/Unsupported mod_perl version: $ENV{MOD_PERL}/ );
1752 # install the correct mod_perl handler
1753 if ( $version >= 1.9901 ) {
1754 *handler = sub : method {
1755 shift->handle_request(@_);
1759 *handler = sub ($$) { shift->handle_request(@_) };
1764 elsif ( $software eq 'Zeus-Perl' ) {
1765 $engine = 'Catalyst::Engine::Zeus';
1769 Catalyst::Exception->throw(
1770 message => qq/Unsupported mod_perl: $ENV{MOD_PERL}/ );
1775 $engine = $class->engine_class;
1781 Catalyst::Exception->throw( message =>
1782 qq/Couldn't load engine "$engine" (maybe you forgot to install it?), "$@"/
1786 # check for old engines that are no longer compatible
1788 if ( $engine->isa('Catalyst::Engine::Apache')
1789 && !Catalyst::Engine::Apache->VERSION )
1794 elsif ( $engine->isa('Catalyst::Engine::Server::Base')
1795 && Catalyst::Engine::Server->VERSION le '0.02' )
1800 elsif ($engine->isa('Catalyst::Engine::HTTP::POE')
1801 && $engine->VERSION eq '0.01' )
1806 elsif ($engine->isa('Catalyst::Engine::Zeus')
1807 && $engine->VERSION eq '0.01' )
1813 Catalyst::Exception->throw( message =>
1814 qq/Engine "$engine" is not supported by this version of Catalyst/
1819 $class->engine( $engine->new );
1822 =head2 $c->setup_home
1824 Sets up the home directory.
1829 my ( $class, $home ) = @_;
1831 if ( $ENV{CATALYST_HOME} ) {
1832 $home = $ENV{CATALYST_HOME};
1835 if ( $ENV{ uc($class) . '_HOME' } ) {
1836 $home = $ENV{ uc($class) . '_HOME' };
1840 $home = Catalyst::Utils::home($class);
1844 $class->config->{home} ||= $home;
1845 $class->config->{root} ||= dir($home)->subdir('root');
1849 =head2 $c->setup_log
1856 my ( $class, $debug ) = @_;
1858 unless ( $class->log ) {
1859 $class->log( Catalyst::Log->new );
1862 my $app_flag = Catalyst::Utils::class2env($class) . '_DEBUG';
1865 ( defined( $ENV{CATALYST_DEBUG} ) || defined( $ENV{$app_flag} ) )
1866 ? ( $ENV{CATALYST_DEBUG} || $ENV{$app_flag} )
1871 *{"$class\::debug"} = sub { 1 };
1872 $class->log->debug('Debug messages enabled');
1876 =head2 $c->setup_plugins
1882 =head2 $c->registered_plugins
1884 Returns a sorted list of the plugins which have either been stated in the
1885 import list or which have been added via C<< MyApp->plugin(@args); >>.
1887 If passed a given plugin name, it will report a boolean value indicating
1888 whether or not that plugin is loaded. A fully qualified name is required if
1889 the plugin name does not begin with C<Catalyst::Plugin::>.
1891 if ($c->registered_plugins('Some::Plugin')) {
1899 sub registered_plugins {
1901 return sort keys %{$proto->_plugins} unless @_;
1903 return 1 if exists $proto->_plugins->{$plugin};
1904 return exists $proto->_plugins->{"Catalyst::Plugin::$plugin"};
1907 sub _register_plugin {
1908 my ( $proto, $plugin, $instant ) = @_;
1909 my $class = ref $proto || $proto;
1913 if ( my $error = $@ ) {
1914 my $type = $instant ? "instant " : '';
1915 Catalyst::Exception->throw(
1916 message => qq/Couldn't load ${type}plugin "$plugin", $error/ );
1919 $proto->_plugins->{$plugin} = 1;
1922 unshift @{"$class\::ISA"}, $plugin;
1928 my ( $class, $plugins ) = @_;
1930 $class->_plugins( {} ) unless $class->_plugins;
1932 for my $plugin ( reverse @$plugins ) {
1934 unless ( $plugin =~ s/\A\+// ) {
1935 $plugin = "Catalyst::Plugin::$plugin";
1938 $class->_register_plugin($plugin);
1947 =head2 $c->write( $data )
1949 Writes $data to the output stream. When using this method directly, you
1950 will need to manually set the C<Content-Length> header to the length of
1951 your output data, if known.
1958 # Finalize headers if someone manually writes output
1959 $c->finalize_headers;
1961 return $c->engine->write( $c, @_ );
1966 Returns the Catalyst version number. Mostly useful for "powered by"
1967 messages in template systems.
1971 sub version { return $Catalyst::VERSION }
1973 =head1 INTERNAL ACTIONS
1975 Catalyst uses internal actions like C<_DISPATCH>, C<_BEGIN>, C<_AUTO>,
1976 C<_ACTION>, and C<_END>. These are by default not shown in the private
1977 action table, but you can make them visible with a config parameter.
1979 MyApp->config->{show_internal_actions} = 1;
1981 =head1 CASE SENSITIVITY
1983 By default Catalyst is not case sensitive, so C<MyApp::C::FOO::Bar> is
1984 mapped to C</foo/bar>. You can activate case sensitivity with a config
1987 MyApp->config->{case_sensitive} = 1;
1989 This causes C<MyApp::C::Foo::Bar> to map to C</Foo/Bar>.
1991 =head1 ON-DEMAND PARSER
1993 The request body is usually parsed at the beginning of a request,
1994 but if you want to handle input yourself or speed things up a bit,
1995 you can enable on-demand parsing with a config parameter.
1997 MyApp->config->{parse_on_demand} = 1;
1999 =head1 PROXY SUPPORT
2001 Many production servers operate using the common double-server approach,
2002 with a lightweight frontend web server passing requests to a larger
2003 backend server. An application running on the backend server must deal
2004 with two problems: the remote user always appears to be C<127.0.0.1> and
2005 the server's hostname will appear to be C<localhost> regardless of the
2006 virtual host that the user connected through.
2008 Catalyst will automatically detect this situation when you are running
2009 the frontend and backend servers on the same machine. The following
2010 changes are made to the request.
2012 $c->req->address is set to the user's real IP address, as read from
2013 the HTTP X-Forwarded-For header.
2015 The host value for $c->req->base and $c->req->uri is set to the real
2016 host, as read from the HTTP X-Forwarded-Host header.
2018 Obviously, your web server must support these headers for this to work.
2020 In a more complex server farm environment where you may have your
2021 frontend proxy server(s) on different machines, you will need to set a
2022 configuration option to tell Catalyst to read the proxied data from the
2025 MyApp->config->{using_frontend_proxy} = 1;
2027 If you do not wish to use the proxy support at all, you may set:
2029 MyApp->config->{ignore_frontend_proxy} = 1;
2031 =head1 THREAD SAFETY
2033 Catalyst has been tested under Apache 2's threading mpm_worker, mpm_winnt,
2034 and the standalone forking HTTP server on Windows. We believe the Catalyst
2035 core to be thread-safe.
2037 If you plan to operate in a threaded environment, remember that all other
2038 modules you are using must also be thread-safe. Some modules, most notably
2039 L<DBD::SQLite>, are not thread-safe.
2045 Join #catalyst on irc.perl.org.
2049 http://lists.rawmode.org/mailman/listinfo/catalyst
2050 http://lists.rawmode.org/mailman/listinfo/catalyst-dev
2054 http://catalyst.perl.org
2058 http://dev.catalyst.perl.org
2062 =head2 L<Task::Catalyst> - All you need to start with Catalyst
2064 =head2 L<Catalyst::Manual> - The Catalyst Manual
2066 =head2 L<Catalyst::Component>, L<Catalyst::Base> - Base classes for components
2068 =head2 L<Catalyst::Engine> - Core engine
2070 =head2 L<Catalyst::Log> - Log class.
2072 =head2 L<Catalyst::Request> - Request object
2074 =head2 L<Catalyst::Response> - Response object
2076 =head2 L<Catalyst::Test> - The test suite.
2148 Sebastian Riedel, C<sri@oook.de>
2152 This library is free software, you can redistribute it and/or modify it under
2153 the same terms as Perl itself.