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::DBIC::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');
299 my $error = ref $_[0] eq 'ARRAY' ? $_[0] : [@_];
300 push @{ $c->{error} }, @$error;
302 elsif ( defined $_[0] ) { $c->{error} = undef }
303 return $c->{error} || [];
306 =head2 $c->clear_errors
308 Clear errors. You probably don't want to clear the errors unless you are
309 implementing a custom error screen.
311 This is equivalent to running
326 Returns the current L<Catalyst::Response> object.
330 Returns a hashref to the stash, which may be used to store data and pass
331 it between components during a request. You can also set hash keys by
332 passing arguments. The stash is automatically sent to the view. The
333 stash is cleared at the end of a request; it cannot be used for
336 $c->stash->{foo} = $bar;
337 $c->stash( { moose => 'majestic', qux => 0 } );
338 $c->stash( bar => 1, gorch => 2 ); # equivalent to passing a hashref
340 # stash is automatically passed to the view for use in a template
341 $c->forward( 'MyApp::V::TT' );
348 my $stash = @_ > 1 ? {@_} : $_[0];
349 while ( my ( $key, $val ) = each %$stash ) {
350 $c->{stash}->{$key} = $val;
358 Contains the return value of the last executed action.
364 my ($c, @names) = @_;
366 foreach my $name (@names) {
367 foreach my $component ( keys %{ $c->components } ) {
368 my $comp = $c->components->{$component} if $component =~ /$name/i;
370 if ( eval { $comp->can('ACCEPT_CONTEXT'); } ) {
371 return $comp->ACCEPT_CONTEXT($c);
373 else { return $comp }
381 # try explicit component names
383 my ($c, @names) = @_;
385 foreach my $try (@names) {
386 if ( exists $c->components->{$try} ) {
387 my $comp = $c->components->{$try};
388 if ( eval { $comp->can('ACCEPT_CONTEXT'); } ) {
389 return $comp->ACCEPT_CONTEXT($c);
391 else { return $comp }
398 # like component, but try just these prefixes before regex searching,
399 # and do not try to return "sort keys %{ $c->components }"
401 my ($c, $name, @prefixes) = @_;
403 my $appclass = ref $c || $c;
405 my @names = map { "${appclass}::${_}::${name}" } @prefixes;
407 my $comp = $c->_comp_explicit(@names);
408 return $comp if defined($comp);
409 $comp = $c->_comp_search($name);
413 # Return a component if only one matches.
415 my ($c, @prefixes) = @_;
417 my $appclass = ref $c || $c;
419 my ($comp,$rest) = map { $c->_comp_search("^${appclass}::${_}::") }
421 return $comp unless $rest;
424 =head2 COMPONENT ACCESSORS
426 =head2 $c->comp($name)
428 =head2 $c->component($name)
430 Gets a component object by name. This method is no longer recommended,
431 unless you want to get a specific component by full
432 class. C<$c-E<gt>controller>, C<$c-E<gt>model>, and C<$c-E<gt>view>
433 should be used instead.
444 my $appclass = ref $c || $c;
447 $name, "${appclass}::${name}",
448 map { "${appclass}::${_}::${name}" }
449 qw/Model M Controller C View V/
452 my $comp = $c->_comp_explicit(@names);
453 return $comp if defined($comp);
455 $comp = $c->_comp_search($name);
456 return $comp if defined($comp);
459 return sort keys %{ $c->components };
462 =head2 $c->controller($name)
464 Gets a L<Catalyst::Controller> instance by name.
466 $c->controller('Foo')->do_stuff;
468 If name is omitted, will return the controller for the dispatched action.
473 my ( $c, $name ) = @_;
474 return $c->_comp_prefixes($name, qw/Controller C/)
476 return $c->component($c->action->class);
479 =head2 $c->model($name)
481 Gets a L<Catalyst::Model> instance by name.
483 $c->model('Foo')->do_stuff;
485 If the name is omitted, it will look for a config setting 'default_model',
486 or check if there is only one model, and forward to it if that's the case.
491 my ( $c, $name ) = @_;
492 return $c->_comp_prefixes($name, qw/Model M/)
494 return $c->comp($c->config->{default_model})
495 if $c->config->{default_model};
496 return $c->_comp_singular(qw/Model M/);
500 =head2 $c->view($name)
502 Gets a L<Catalyst::View> instance by name.
504 $c->view('Foo')->do_stuff;
506 If the name is omitted, it will look for a config setting 'default_view',
507 or check if there is only one view, and forward to it if that's the case.
512 my ( $c, $name ) = @_;
513 return $c->_comp_prefixes($name, qw/View V/)
515 return $c->comp($c->config->{default_view})
516 if $c->config->{default_view};
517 return $c->_comp_singular(qw/View V/);
520 =head2 Class data and helper classes
524 Returns or takes a hashref containing the application's configuration.
526 __PACKAGE__->config( { db => 'dsn:SQLite:foo.db' } );
528 You can also use a L<YAML> config file like myapp.yml in your
529 applications home directory.
532 db: dsn:SQLite:foo.db
539 $c->log->warn("Setting config after setup has been run is not a good idea.")
540 if ( @_ and $c->setup_finished );
542 $c->NEXT::config(@_);
547 Overload to enable debug messages (same as -Debug option).
553 =head2 $c->dispatcher
555 Returns the dispatcher instance. Stringifies to class name. See
556 L<Catalyst::Dispatcher>.
560 Returns the engine instance. Stringifies to the class name. See
565 Returns the logging object instance. Unless it is already set, Catalyst sets
566 this up with a L<Catalyst::Log> object. To use your own log class, set the
567 logger with the C<< __PACKAGE__->log >> method prior to calling
568 C<< __PACKAGE__->setup >>.
570 __PACKAGE__->log( MyLogger->new );
575 $c->log->info( 'Now logging with my own logger!' );
577 Your log class should implement the methods described in the
578 L<Catalyst::Log> man page.
582 =head2 UTILITY METHODS
584 =head2 $c->path_to(@path)
586 Merges C<@path> with C<$c-E<gt>config-E<gt>{home}> and returns a
587 L<Path::Class> object.
591 $c->path_to( 'db', 'sqlite.db' );
596 my ( $c, @path ) = @_;
597 my $path = dir( $c->config->{home}, @path );
598 if ( -d $path ) { return $path }
599 else { return file( $c->config->{home}, @path ) }
602 =head2 $c->plugin( $name, $class, @args )
604 Helper method for plugins. It creates a classdata accessor/mutator and
605 loads and instantiates the given class.
607 MyApp->plugin( 'prototype', 'HTML::Prototype' );
609 $c->prototype->define_javascript_functions;
614 my ( $class, $name, $plugin, @args ) = @_;
615 $class->_register_plugin( $plugin, 1 );
617 eval { $plugin->import };
618 $class->mk_classdata($name);
620 eval { $obj = $plugin->new(@args) };
623 Catalyst::Exception->throw( message =>
624 qq/Couldn't instantiate instant plugin "$plugin", "$@"/ );
628 $class->log->debug(qq/Initialized instant plugin "$plugin" as "$name"/)
634 Initializes the dispatcher and engine, loads any plugins, and loads the
635 model, view, and controller components. You may also specify an array
636 of plugins to load here, if you choose to not load them in the C<use
640 MyApp->setup( qw/-Debug/ );
645 my ( $class, @arguments ) = @_;
647 unless ( $class->isa('Catalyst') ) {
649 Catalyst::Exception->throw(
650 message => qq/'$class' does not inherit from Catalyst/ );
653 if ( $class->arguments ) {
654 @arguments = ( @arguments, @{ $class->arguments } );
660 foreach (@arguments) {
664 ( $flags->{log} ) ? 'debug,' . $flags->{log} : 'debug';
666 elsif (/^-(\w+)=?(.*)$/) {
667 $flags->{ lc $1 } = $2;
670 push @{ $flags->{plugins} }, $_;
674 $class->setup_home( delete $flags->{home} );
676 $class->setup_log( delete $flags->{log} );
677 $class->setup_plugins( delete $flags->{plugins} );
678 $class->setup_dispatcher( delete $flags->{dispatcher} );
679 $class->setup_engine( delete $flags->{engine} );
681 for my $flag ( sort keys %{$flags} ) {
683 if ( my $code = $class->can( 'setup_' . $flag ) ) {
684 &$code( $class, delete $flags->{$flag} );
687 $class->log->warn(qq/Unknown flag "$flag"/);
692 <<"EOF") if ( $ENV{CATALYST_SCRIPT_GEN} && ( $ENV{CATALYST_SCRIPT_GEN} < $Catalyst::CATALYST_SCRIPT_GEN ) );
693 You are running an old script!
695 Please update by running (this will overwrite existing files):
696 catalyst.pl -force -scripts $class
698 or (this will not overwrite existing files):
699 catalyst.pl -scripts $class
702 if ( $class->debug ) {
709 map { $_ . ' ' . ( $_->VERSION || '' ) }
710 grep { /^Catalyst::Plugin/ } @{"$class\::ISA"};
714 my $t = Text::SimpleTable->new(76);
715 $t->row($_) for @plugins;
716 $class->log->debug( "Loaded plugins:\n" . $t->draw );
719 my $dispatcher = $class->dispatcher;
720 my $engine = $class->engine;
721 my $home = $class->config->{home};
723 $class->log->debug(qq/Loaded dispatcher "$dispatcher"/);
724 $class->log->debug(qq/Loaded engine "$engine"/);
728 ? $class->log->debug(qq/Found home "$home"/)
729 : $class->log->debug(qq/Home "$home" doesn't exist/)
730 : $class->log->debug(q/Couldn't find home/);
735 no warnings qw/redefine/;
736 local *setup = sub { };
740 # Initialize our data structure
741 $class->components( {} );
743 $class->setup_components;
745 if ( $class->debug ) {
746 my $t = Text::SimpleTable->new( [ 65, 'Class' ], [ 8, 'Type' ] );
747 for my $comp ( sort keys %{ $class->components } ) {
748 my $type = ref $class->components->{$comp} ? 'instance' : 'class';
749 $t->row( $comp, $type );
751 $class->log->debug( "Loaded components:\n" . $t->draw )
752 if ( keys %{ $class->components } );
755 # Add our self to components, since we are also a component
756 $class->components->{$class} = $class;
758 $class->setup_actions;
760 if ( $class->debug ) {
761 my $name = $class->config->{name} || 'Application';
762 $class->log->info("$name powered by Catalyst $Catalyst::VERSION");
764 $class->log->_flush() if $class->log->can('_flush');
766 $class->setup_finished(1);
769 =head2 $c->uri_for( $path, [ @args ] )
771 Merges path with C<$c-E<gt>request-E<gt>base> for absolute uri's and
772 with C<$c-E<gt>namespace> for relative uri's, then returns a
773 normalized L<URI> object. If any args are passed, they are added at the
774 end of the path. If the last argument to uri_for is a hash reference,
775 it is assumed to contain GET parameter key/value pairs, which will be
776 appended to the URI in standard fashion.
781 my ( $c, $path, @args ) = @_;
782 my $base = $c->request->base->clone;
783 my $basepath = $base->path;
784 $basepath =~ s/\/$//;
786 my $namespace = $c->namespace;
788 # massage namespace, empty if absolute path
789 $namespace =~ s/^\///;
790 $namespace .= '/' if $namespace;
792 $namespace = '' if $path =~ /^\//;
796 ( scalar @args && ref $args[$#args] eq 'HASH' ? pop @args : {} );
798 # join args with '/', or a blank string
799 my $args = ( scalar @args ? '/' . join( '/', @args ) : '' );
800 $args =~ s/^\/// unless $path;
802 URI->new_abs( URI->new_abs( "$path$args", "$basepath$namespace" ), $base )
804 $res->query_form(%$params);
808 =head2 $c->welcome_message
810 Returns the Catalyst welcome HTML page.
814 sub welcome_message {
816 my $name = $c->config->{name};
817 my $logo = $c->uri_for('/static/images/catalyst_logo.png');
818 my $prefix = Catalyst::Utils::appprefix( ref $c );
819 $c->response->content_type('text/html; charset=utf-8');
821 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
822 "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
823 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
825 <meta http-equiv="Content-Language" content="en" />
826 <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
827 <title>$name on Catalyst $VERSION</title>
828 <style type="text/css">
831 background-color: #eee;
840 background-color: #ccc;
841 border: 1px solid #aaa;
842 -moz-border-radius: 10px;
847 font-family: verdana, tahoma, sans-serif;
850 font-family: verdana, tahoma, sans-serif;
853 text-decoration: none;
855 border-bottom: 1px dotted #bbb;
857 :link:hover, :visited:hover {
870 background-color: #fff;
871 border: 1px solid #aaa;
872 -moz-border-radius: 10px;
898 <h1><span id="appname">$name</span> on <a href="http://catalyst.perl.org">Catalyst</a>
903 <img src="$logo" alt="Catalyst Logo" />
905 <p>Welcome to the wonderful world of Catalyst.
906 This <a href="http://en.wikipedia.org/wiki/MVC">MVC</a>
907 framework will make web development something you had
908 never expected it to be: Fun, rewarding, and quick.</p>
909 <h2>What to do now?</h2>
910 <p>That really depends on what <b>you</b> want to do.
911 We do, however, provide you with a few starting points.</p>
912 <p>If you want to jump right into web development with Catalyst
913 you might want to check out the documentation.</p>
914 <pre><code>perldoc <a href="http://cpansearch.perl.org/dist/Catalyst/lib/Catalyst/Manual/Intro.pod">Catalyst::Manual::Intro</a>
915 perldoc <a href="http://cpansearch.perl.org/dist/Catalyst/lib/Catalyst/Manual/Tutorial.pod">Catalyst::Manual::Tutorial</a></code>
916 perldoc <a href="http://cpansearch.perl.org/dist/Catalyst/lib/Catalyst/Manual.pod">Catalyst::Manual</a></code></pre>
917 <h2>What to do next?</h2>
918 <p>Next it's time to write an actual application. Use the
919 helper scripts to generate <a href="http://cpansearch.perl.org/search?query=Catalyst%3A%3AController%3A%3A&mode=all">controllers</a>,
920 <a href="http://cpansearch.perl.org/search?query=Catalyst%3A%3AModel%3A%3A&mode=all">models</a>, and
921 <a href="http://cpansearch.perl.org/search?query=Catalyst%3A%3AView%3A%3A&mode=all">views</a>;
922 they can save you a lot of work.</p>
923 <pre><code>script/${prefix}_create.pl -help</code></pre>
924 <p>Also, be sure to check out the vast and growing
925 collection of <a href="http://cpansearch.perl.org/search?query=Catalyst%3A%3APlugin%3A%3A&mode=all">plugins for Catalyst on CPAN</a>;
926 you are likely to find what you need there.
930 <p>Catalyst has a very active community. Here are the main places to
931 get in touch with us.</p>
934 <a href="http://dev.catalyst.perl.org">Wiki</a>
937 <a href="http://lists.rawmode.org/mailman/listinfo/catalyst">Mailing-List</a>
940 <a href="irc://irc.perl.org/catalyst">IRC channel #catalyst on irc.perl.org</a>
943 <h2>In conclusion</h2>
944 <p>The Catalyst team hopes you will enjoy using Catalyst as much
945 as we enjoyed making it. Please contact us if you have ideas
946 for improvement or other feedback.</p>
954 =head1 INTERNAL METHODS
956 These methods are not meant to be used by end users.
958 =head2 $c->components
960 Returns a hash of components.
962 =head2 $c->context_class
964 Returns or sets the context class.
968 Returns a hashref containing coderefs and execution counts (needed for
969 deep recursion detection).
973 Returns the number of actions on the current internal execution stack.
977 Dispatches a request to actions.
981 sub dispatch { my $c = shift; $c->dispatcher->dispatch( $c, @_ ) }
983 =head2 $c->dispatcher_class
985 Returns or sets the dispatcher class.
987 =head2 $c->dump_these
989 Returns a list of 2-element array references (name, structure) pairs
990 that will be dumped on the error page in debug mode.
996 [ Request => $c->req ], [ Response => $c->res ], [ Stash => $c->stash ],;
999 =head2 $c->engine_class
1001 Returns or sets the engine class.
1003 =head2 $c->execute( $class, $coderef )
1005 Execute a coderef in given class and catch exceptions. Errors are available
1011 my ( $c, $class, $code ) = @_;
1012 $class = $c->component($class) || $class;
1015 if ($c->depth >= $RECURSION) {
1016 my $action = "$code";
1017 $action = "/$action" unless $action =~ /\-\>/;
1018 my $error = qq/Deep recursion detected calling "$action"/;
1019 $c->log->error($error);
1027 my $action = "$code";
1028 $action = "/$action" unless $action =~ /\-\>/;
1029 $c->counter->{"$code"}++;
1031 # determine if the call was the result of a forward
1032 # this is done by walking up the call stack and looking for a calling
1033 # sub of Catalyst::forward before the eval
1035 for my $index ( 1 .. 10 ) {
1037 if ( ( caller($index) )[0] eq 'Catalyst'
1038 && ( caller($index) )[3] eq '(eval)' );
1040 if ( ( caller($index) )[3] =~ /forward$/ ) {
1041 $callsub = ( caller($index) )[3];
1042 $action = "-> $action";
1047 my $node = Tree::Simple->new(
1050 elapsed => undef, # to be filled in later
1053 $node->setUID( "$code" . $c->counter->{"$code"} );
1055 unless ( ( $code->name =~ /^_.*/ )
1056 && ( !$c->config->{show_internal_actions} ) )
1059 # is this a root-level call or a forwarded call?
1060 if ( $callsub =~ /forward$/ ) {
1062 # forward, locate the caller
1063 if ( my $parent = $c->stack->[-1] ) {
1064 my $visitor = Tree::Simple::Visitor::FindByUID->new;
1065 $visitor->searchForUID(
1066 "$parent" . $c->counter->{"$parent"} );
1067 $c->{stats}->accept($visitor);
1068 if ( my $result = $visitor->getResult ) {
1069 $result->addChild($node);
1074 # forward with no caller may come from a plugin
1075 $c->{stats}->addChild($node);
1081 $c->{stats}->addChild($node);
1086 push( @{ $c->stack }, $code );
1089 $start = [gettimeofday] if $c->debug;
1090 eval { $c->state( &$code( $class, $c, @{ $c->req->args } ) || 0 ) };
1091 $elapsed = tv_interval($start) if $c->debug;
1094 unless ( ( $code->name =~ /^_.*/ )
1095 && ( !$c->config->{show_internal_actions} ) )
1098 # FindByUID uses an internal die, so we save the existing error
1101 # locate the node in the tree and update the elapsed time
1102 my $visitor = Tree::Simple::Visitor::FindByUID->new;
1103 $visitor->searchForUID( "$code" . $c->counter->{"$code"} );
1104 $c->{stats}->accept($visitor);
1105 if ( my $result = $visitor->getResult ) {
1106 my $value = $result->getNodeValue;
1107 $value->{elapsed} = sprintf( '%fs', $elapsed );
1108 $result->setNodeValue($value);
1112 $@ = $error || undef;
1115 my $last = ${ $c->stack }[-1];
1116 pop( @{ $c->stack } );
1118 if ( my $error = $@ ) {
1119 if ( $error eq $DETACH ) { die $DETACH if $c->depth > 1 }
1121 unless ( ref $error ) {
1123 my $class = $last->class;
1124 my $name = $last->name;
1125 $error = qq/Caught exception in $class->$name "$error"/;
1136 Finalizes the request.
1143 for my $error ( @{ $c->error } ) {
1144 $c->log->error($error);
1147 $c->finalize_uploads;
1150 if ( $#{ $c->error } >= 0 ) {
1154 $c->finalize_headers;
1157 if ( $c->request->method eq 'HEAD' ) {
1158 $c->response->body('');
1163 return $c->response->status;
1166 =head2 $c->finalize_body
1172 sub finalize_body { my $c = shift; $c->engine->finalize_body( $c, @_ ) }
1174 =head2 $c->finalize_cookies
1180 sub finalize_cookies { my $c = shift; $c->engine->finalize_cookies( $c, @_ ) }
1182 =head2 $c->finalize_error
1188 sub finalize_error { my $c = shift; $c->engine->finalize_error( $c, @_ ) }
1190 =head2 $c->finalize_headers
1196 sub finalize_headers {
1199 # Check if we already finalized headers
1200 return if $c->response->{_finalized_headers};
1203 if ( my $location = $c->response->redirect ) {
1204 $c->log->debug(qq/Redirecting to "$location"/) if $c->debug;
1205 $c->response->header( Location => $location );
1209 if ( $c->response->body && !$c->response->content_length ) {
1211 # get the length from a filehandle
1212 if ( blessed($c->response->body) && $c->response->body->can('read') ) {
1213 if ( my $stat = stat $c->response->body ) {
1214 $c->response->content_length( $stat->size );
1217 $c->log->warn('Serving filehandle without a content-length');
1221 $c->response->content_length( bytes::length( $c->response->body ) );
1226 if ( $c->response->status =~ /^(1\d\d|[23]04)$/ ) {
1227 $c->response->headers->remove_header("Content-Length");
1228 $c->response->body('');
1231 $c->finalize_cookies;
1233 $c->engine->finalize_headers( $c, @_ );
1236 $c->response->{_finalized_headers} = 1;
1239 =head2 $c->finalize_output
1241 An alias for finalize_body.
1243 =head2 $c->finalize_read
1245 Finalizes the input after reading is complete.
1249 sub finalize_read { my $c = shift; $c->engine->finalize_read( $c, @_ ) }
1251 =head2 $c->finalize_uploads
1253 Finalizes uploads. Cleans up any temporary files.
1257 sub finalize_uploads { my $c = shift; $c->engine->finalize_uploads( $c, @_ ) }
1259 =head2 $c->get_action( $action, $namespace )
1261 Gets an action in a given namespace.
1265 sub get_action { my $c = shift; $c->dispatcher->get_action(@_) }
1267 =head2 $c->get_actions( $action, $namespace )
1269 Gets all actions of a given name in a namespace and all parent
1274 sub get_actions { my $c = shift; $c->dispatcher->get_actions( $c, @_ ) }
1276 =head2 $c->handle_request( $class, @arguments )
1278 Called to handle each HTTP request.
1282 sub handle_request {
1283 my ( $class, @arguments ) = @_;
1285 # Always expect worst case!
1288 my $stats = ( $class->debug ) ? Tree::Simple->new: q{};
1291 my $c = $class->prepare(@arguments);
1292 $c->{stats} = $stats;
1294 return $c->finalize;
1297 if ( $class->debug ) {
1298 my $start = [gettimeofday];
1299 $status = &$handler;
1300 my $elapsed = tv_interval $start;
1301 $elapsed = sprintf '%f', $elapsed;
1302 my $av = sprintf '%.3f',
1303 ( $elapsed == 0 ? '??' : ( 1 / $elapsed ) );
1304 my $t = Text::SimpleTable->new( [ 64, 'Action' ], [ 9, 'Time' ] );
1309 my $stat = $action->getNodeValue;
1310 $t->row( ( q{ } x $action->getDepth ) . $stat->{action},
1311 $stat->{elapsed} || '??' );
1316 "Request took ${elapsed}s ($av/s)\n" . $t->draw );
1318 else { $status = &$handler }
1322 if ( my $error = $@ ) {
1324 $class->log->error(qq/Caught exception in engine "$error"/);
1328 $class->log->_flush() if $class->log->can('_flush');
1332 =head2 $c->prepare( @arguments )
1334 Creates a Catalyst context from an engine-specific request (Apache, CGI,
1340 my ( $class, @arguments ) = @_;
1342 $class->context_class( ref $class || $class ) unless $class->context_class;
1343 my $c = $class->context_class->new(
1347 request => $class->request_class->new(
1350 body_parameters => {},
1352 headers => HTTP::Headers->new,
1354 query_parameters => {},
1360 response => $class->response_class->new(
1364 headers => HTTP::Headers->new(),
1373 # For on-demand data
1374 $c->request->{_context} = $c;
1375 $c->response->{_context} = $c;
1376 weaken( $c->request->{_context} );
1377 weaken( $c->response->{_context} );
1380 my $secs = time - $START || 1;
1381 my $av = sprintf '%.3f', $COUNT / $secs;
1382 $c->log->debug('**********************************');
1383 $c->log->debug("* Request $COUNT ($av/s) [$$]");
1384 $c->log->debug('**********************************');
1385 $c->res->headers->header( 'X-Catalyst' => $Catalyst::VERSION );
1388 $c->prepare_request(@arguments);
1389 $c->prepare_connection;
1390 $c->prepare_query_parameters;
1391 $c->prepare_headers;
1392 $c->prepare_cookies;
1396 $c->prepare_body unless $c->config->{parse_on_demand};
1398 my $method = $c->req->method || '';
1399 my $path = $c->req->path || '';
1400 my $address = $c->req->address || '';
1402 $c->log->debug(qq/"$method" request for "$path" from "$address"/)
1410 =head2 $c->prepare_action
1416 sub prepare_action { my $c = shift; $c->dispatcher->prepare_action( $c, @_ ) }
1418 =head2 $c->prepare_body
1420 Prepares message body.
1427 # Do we run for the first time?
1428 return if defined $c->request->{_body};
1430 # Initialize on-demand data
1431 $c->engine->prepare_body( $c, @_ );
1432 $c->prepare_parameters;
1433 $c->prepare_uploads;
1435 if ( $c->debug && keys %{ $c->req->body_parameters } ) {
1436 my $t = Text::SimpleTable->new( [ 37, 'Key' ], [ 36, 'Value' ] );
1437 for my $key ( sort keys %{ $c->req->body_parameters } ) {
1438 my $param = $c->req->body_parameters->{$key};
1439 my $value = defined($param) ? $param : '';
1441 ref $value eq 'ARRAY' ? ( join ', ', @$value ) : $value );
1443 $c->log->debug( "Body Parameters are:\n" . $t->draw );
1447 =head2 $c->prepare_body_chunk( $chunk )
1449 Prepares a chunk of data before sending it to L<HTTP::Body>.
1453 sub prepare_body_chunk {
1455 $c->engine->prepare_body_chunk( $c, @_ );
1458 =head2 $c->prepare_body_parameters
1460 Prepares body parameters.
1464 sub prepare_body_parameters {
1466 $c->engine->prepare_body_parameters( $c, @_ );
1469 =head2 $c->prepare_connection
1471 Prepares connection.
1475 sub prepare_connection {
1477 $c->engine->prepare_connection( $c, @_ );
1480 =head2 $c->prepare_cookies
1486 sub prepare_cookies { my $c = shift; $c->engine->prepare_cookies( $c, @_ ) }
1488 =head2 $c->prepare_headers
1494 sub prepare_headers { my $c = shift; $c->engine->prepare_headers( $c, @_ ) }
1496 =head2 $c->prepare_parameters
1498 Prepares parameters.
1502 sub prepare_parameters {
1504 $c->prepare_body_parameters;
1505 $c->engine->prepare_parameters( $c, @_ );
1508 =head2 $c->prepare_path
1510 Prepares path and base.
1514 sub prepare_path { my $c = shift; $c->engine->prepare_path( $c, @_ ) }
1516 =head2 $c->prepare_query_parameters
1518 Prepares query parameters.
1522 sub prepare_query_parameters {
1525 $c->engine->prepare_query_parameters( $c, @_ );
1527 if ( $c->debug && keys %{ $c->request->query_parameters } ) {
1528 my $t = Text::SimpleTable->new( [ 37, 'Key' ], [ 36, 'Value' ] );
1529 for my $key ( sort keys %{ $c->req->query_parameters } ) {
1530 my $param = $c->req->query_parameters->{$key};
1531 my $value = defined($param) ? $param : '';
1533 ref $value eq 'ARRAY' ? ( join ', ', @$value ) : $value );
1535 $c->log->debug( "Query Parameters are:\n" . $t->draw );
1539 =head2 $c->prepare_read
1541 Prepares the input for reading.
1545 sub prepare_read { my $c = shift; $c->engine->prepare_read( $c, @_ ) }
1547 =head2 $c->prepare_request
1549 Prepares the engine request.
1553 sub prepare_request { my $c = shift; $c->engine->prepare_request( $c, @_ ) }
1555 =head2 $c->prepare_uploads
1561 sub prepare_uploads {
1564 $c->engine->prepare_uploads( $c, @_ );
1566 if ( $c->debug && keys %{ $c->request->uploads } ) {
1567 my $t = Text::SimpleTable->new(
1573 for my $key ( sort keys %{ $c->request->uploads } ) {
1574 my $upload = $c->request->uploads->{$key};
1575 for my $u ( ref $upload eq 'ARRAY' ? @{$upload} : ($upload) ) {
1576 $t->row( $key, $u->filename, $u->type, $u->size );
1579 $c->log->debug( "File Uploads are:\n" . $t->draw );
1583 =head2 $c->prepare_write
1585 Prepares the output for writing.
1589 sub prepare_write { my $c = shift; $c->engine->prepare_write( $c, @_ ) }
1591 =head2 $c->request_class
1593 Returns or sets the request class.
1595 =head2 $c->response_class
1597 Returns or sets the response class.
1599 =head2 $c->read( [$maxlength] )
1601 Reads a chunk of data from the request body. This method is designed to
1602 be used in a while loop, reading C<$maxlength> bytes on every call.
1603 C<$maxlength> defaults to the size of the request if not specified.
1605 You have to set C<MyApp-E<gt>config-E<gt>{parse_on_demand}> to use this
1610 sub read { my $c = shift; return $c->engine->read( $c, @_ ) }
1618 sub run { my $c = shift; return $c->engine->run( $c, @_ ) }
1620 =head2 $c->set_action( $action, $code, $namespace, $attrs )
1622 Sets an action in a given namespace.
1626 sub set_action { my $c = shift; $c->dispatcher->set_action( $c, @_ ) }
1628 =head2 $c->setup_actions($component)
1630 Sets up actions for a component.
1634 sub setup_actions { my $c = shift; $c->dispatcher->setup_actions( $c, @_ ) }
1636 =head2 $c->setup_components
1642 sub setup_components {
1645 my $callback = sub {
1646 my ( $component, $context ) = @_;
1648 unless ( $component->can('COMPONENT') ) {
1652 my $suffix = Catalyst::Utils::class2classsuffix($component);
1653 my $config = $class->config->{$suffix} || {};
1657 eval { $instance = $component->COMPONENT( $context, $config ); };
1659 if ( my $error = $@ ) {
1663 Catalyst::Exception->throw( message =>
1664 qq/Couldn't instantiate component "$component", "$error"/ );
1667 Catalyst::Exception->throw( message =>
1668 qq/Couldn't instantiate component "$component", "COMPONENT() didn't return a object"/
1670 unless ref $instance;
1674 eval "package $class;\n" . q!Module::Pluggable::Fast->import(
1675 name => '_catalyst_components',
1677 "$class\::Controller", "$class\::C",
1678 "$class\::Model", "$class\::M",
1679 "$class\::View", "$class\::V"
1681 callback => $callback
1685 if ( my $error = $@ ) {
1689 Catalyst::Exception->throw(
1690 message => qq/Couldn't load components "$error"/ );
1693 for my $component ( $class->_catalyst_components($class) ) {
1694 $class->components->{ ref $component || $component } = $component;
1698 =head2 $c->setup_dispatcher
1704 sub setup_dispatcher {
1705 my ( $class, $dispatcher ) = @_;
1708 $dispatcher = 'Catalyst::Dispatcher::' . $dispatcher;
1711 if ( $ENV{CATALYST_DISPATCHER} ) {
1712 $dispatcher = 'Catalyst::Dispatcher::' . $ENV{CATALYST_DISPATCHER};
1715 if ( $ENV{ uc($class) . '_DISPATCHER' } ) {
1717 'Catalyst::Dispatcher::' . $ENV{ uc($class) . '_DISPATCHER' };
1720 unless ($dispatcher) {
1721 $dispatcher = $class->dispatcher_class;
1724 $dispatcher->require;
1727 Catalyst::Exception->throw(
1728 message => qq/Couldn't load dispatcher "$dispatcher", "$@"/ );
1731 # dispatcher instance
1732 $class->dispatcher( $dispatcher->new );
1735 =head2 $c->setup_engine
1742 my ( $class, $engine ) = @_;
1745 $engine = 'Catalyst::Engine::' . $engine;
1748 if ( $ENV{CATALYST_ENGINE} ) {
1749 $engine = 'Catalyst::Engine::' . $ENV{CATALYST_ENGINE};
1752 if ( $ENV{ uc($class) . '_ENGINE' } ) {
1753 $engine = 'Catalyst::Engine::' . $ENV{ uc($class) . '_ENGINE' };
1756 if ( $ENV{MOD_PERL} ) {
1758 # create the apache method
1761 *{"$class\::apache"} = sub { shift->engine->apache };
1764 my ( $software, $version ) =
1765 $ENV{MOD_PERL} =~ /^(\S+)\/(\d+(?:[\.\_]\d+)+)/;
1768 $version =~ s/(\.[^.]+)\./$1/g;
1770 if ( $software eq 'mod_perl' ) {
1774 if ( $version >= 1.99922 ) {
1775 $engine = 'Catalyst::Engine::Apache2::MP20';
1778 elsif ( $version >= 1.9901 ) {
1779 $engine = 'Catalyst::Engine::Apache2::MP19';
1782 elsif ( $version >= 1.24 ) {
1783 $engine = 'Catalyst::Engine::Apache::MP13';
1787 Catalyst::Exception->throw( message =>
1788 qq/Unsupported mod_perl version: $ENV{MOD_PERL}/ );
1793 # install the correct mod_perl handler
1794 if ( $version >= 1.9901 ) {
1795 *handler = sub : method {
1796 shift->handle_request(@_);
1800 *handler = sub ($$) { shift->handle_request(@_) };
1805 elsif ( $software eq 'Zeus-Perl' ) {
1806 $engine = 'Catalyst::Engine::Zeus';
1810 Catalyst::Exception->throw(
1811 message => qq/Unsupported mod_perl: $ENV{MOD_PERL}/ );
1816 $engine = $class->engine_class;
1822 Catalyst::Exception->throw( message =>
1823 qq/Couldn't load engine "$engine" (maybe you forgot to install it?), "$@"/
1827 # check for old engines that are no longer compatible
1829 if ( $engine->isa('Catalyst::Engine::Apache')
1830 && !Catalyst::Engine::Apache->VERSION )
1835 elsif ( $engine->isa('Catalyst::Engine::Server::Base')
1836 && Catalyst::Engine::Server->VERSION le '0.02' )
1841 elsif ($engine->isa('Catalyst::Engine::HTTP::POE')
1842 && $engine->VERSION eq '0.01' )
1847 elsif ($engine->isa('Catalyst::Engine::Zeus')
1848 && $engine->VERSION eq '0.01' )
1854 Catalyst::Exception->throw( message =>
1855 qq/Engine "$engine" is not supported by this version of Catalyst/
1860 $class->engine( $engine->new );
1863 =head2 $c->setup_home
1865 Sets up the home directory.
1870 my ( $class, $home ) = @_;
1872 if ( $ENV{CATALYST_HOME} ) {
1873 $home = $ENV{CATALYST_HOME};
1876 if ( $ENV{ uc($class) . '_HOME' } ) {
1877 $home = $ENV{ uc($class) . '_HOME' };
1881 $home = Catalyst::Utils::home($class);
1885 $class->config->{home} ||= $home;
1886 $class->config->{root} ||= dir($home)->subdir('root');
1890 =head2 $c->setup_log
1897 my ( $class, $debug ) = @_;
1899 unless ( $class->log ) {
1900 $class->log( Catalyst::Log->new );
1903 my $app_flag = Catalyst::Utils::class2env($class) . '_DEBUG';
1906 ( defined( $ENV{CATALYST_DEBUG} ) || defined( $ENV{$app_flag} ) )
1907 ? ( $ENV{CATALYST_DEBUG} || $ENV{$app_flag} )
1912 *{"$class\::debug"} = sub { 1 };
1913 $class->log->debug('Debug messages enabled');
1917 =head2 $c->setup_plugins
1923 =head2 $c->registered_plugins
1925 Returns a sorted list of the plugins which have either been stated in the
1926 import list or which have been added via C<< MyApp->plugin(@args); >>.
1928 If passed a given plugin name, it will report a boolean value indicating
1929 whether or not that plugin is loaded. A fully qualified name is required if
1930 the plugin name does not begin with C<Catalyst::Plugin::>.
1932 if ($c->registered_plugins('Some::Plugin')) {
1940 sub registered_plugins {
1942 return sort keys %{$proto->_plugins} unless @_;
1944 return 1 if exists $proto->_plugins->{$plugin};
1945 return exists $proto->_plugins->{"Catalyst::Plugin::$plugin"};
1948 sub _register_plugin {
1949 my ( $proto, $plugin, $instant ) = @_;
1950 my $class = ref $proto || $proto;
1954 if ( my $error = $@ ) {
1955 my $type = $instant ? "instant " : '';
1956 Catalyst::Exception->throw(
1957 message => qq/Couldn't load ${type}plugin "$plugin", $error/ );
1960 $proto->_plugins->{$plugin} = 1;
1963 unshift @{"$class\::ISA"}, $plugin;
1969 my ( $class, $plugins ) = @_;
1971 $class->_plugins( {} ) unless $class->_plugins;
1973 for my $plugin ( reverse @$plugins ) {
1975 unless ( $plugin =~ s/\A\+// ) {
1976 $plugin = "Catalyst::Plugin::$plugin";
1979 $class->_register_plugin($plugin);
1986 Returns an arrayref of the internal execution stack (actions that are currently
1989 =head2 $c->write( $data )
1991 Writes $data to the output stream. When using this method directly, you
1992 will need to manually set the C<Content-Length> header to the length of
1993 your output data, if known.
2000 # Finalize headers if someone manually writes output
2001 $c->finalize_headers;
2003 return $c->engine->write( $c, @_ );
2008 Returns the Catalyst version number. Mostly useful for "powered by"
2009 messages in template systems.
2013 sub version { return $Catalyst::VERSION }
2015 =head1 INTERNAL ACTIONS
2017 Catalyst uses internal actions like C<_DISPATCH>, C<_BEGIN>, C<_AUTO>,
2018 C<_ACTION>, and C<_END>. These are by default not shown in the private
2019 action table, but you can make them visible with a config parameter.
2021 MyApp->config->{show_internal_actions} = 1;
2023 =head1 CASE SENSITIVITY
2025 By default Catalyst is not case sensitive, so C<MyApp::C::FOO::Bar> is
2026 mapped to C</foo/bar>. You can activate case sensitivity with a config
2029 MyApp->config->{case_sensitive} = 1;
2031 This causes C<MyApp::C::Foo::Bar> to map to C</Foo/Bar>.
2033 =head1 ON-DEMAND PARSER
2035 The request body is usually parsed at the beginning of a request,
2036 but if you want to handle input yourself or speed things up a bit,
2037 you can enable on-demand parsing with a config parameter.
2039 MyApp->config->{parse_on_demand} = 1;
2041 =head1 PROXY SUPPORT
2043 Many production servers operate using the common double-server approach,
2044 with a lightweight frontend web server passing requests to a larger
2045 backend server. An application running on the backend server must deal
2046 with two problems: the remote user always appears to be C<127.0.0.1> and
2047 the server's hostname will appear to be C<localhost> regardless of the
2048 virtual host that the user connected through.
2050 Catalyst will automatically detect this situation when you are running
2051 the frontend and backend servers on the same machine. The following
2052 changes are made to the request.
2054 $c->req->address is set to the user's real IP address, as read from
2055 the HTTP X-Forwarded-For header.
2057 The host value for $c->req->base and $c->req->uri is set to the real
2058 host, as read from the HTTP X-Forwarded-Host header.
2060 Obviously, your web server must support these headers for this to work.
2062 In a more complex server farm environment where you may have your
2063 frontend proxy server(s) on different machines, you will need to set a
2064 configuration option to tell Catalyst to read the proxied data from the
2067 MyApp->config->{using_frontend_proxy} = 1;
2069 If you do not wish to use the proxy support at all, you may set:
2071 MyApp->config->{ignore_frontend_proxy} = 1;
2073 =head1 THREAD SAFETY
2075 Catalyst has been tested under Apache 2's threading mpm_worker, mpm_winnt,
2076 and the standalone forking HTTP server on Windows. We believe the Catalyst
2077 core to be thread-safe.
2079 If you plan to operate in a threaded environment, remember that all other
2080 modules you are using must also be thread-safe. Some modules, most notably
2081 L<DBD::SQLite>, are not thread-safe.
2087 Join #catalyst on irc.perl.org.
2091 http://lists.rawmode.org/mailman/listinfo/catalyst
2092 http://lists.rawmode.org/mailman/listinfo/catalyst-dev
2096 http://catalyst.perl.org
2100 http://dev.catalyst.perl.org
2104 =head2 L<Task::Catalyst> - All you need to start with Catalyst
2106 =head2 L<Catalyst::Manual> - The Catalyst Manual
2108 =head2 L<Catalyst::Component>, L<Catalyst::Base> - Base classes for components
2110 =head2 L<Catalyst::Engine> - Core engine
2112 =head2 L<Catalyst::Log> - Log class.
2114 =head2 L<Catalyst::Request> - Request object
2116 =head2 L<Catalyst::Response> - Response object
2118 =head2 L<Catalyst::Test> - The test suite.
2190 Sebastian Riedel, C<sri@oook.de>
2194 This library is free software, you can redistribute it and/or modify it under
2195 the same terms as Perl itself.