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 # join args with '/', or a blank string
721 my $args = ( scalar @args ? '/' . join( '/', @args ) : '' );
722 $args =~ s/^\/// unless $path;
724 URI->new_abs( URI->new_abs( "$path$args", "$basepath$namespace" ), $base )
729 =head2 $c->welcome_message
731 Returns the Catalyst welcome HTML page.
735 sub welcome_message {
737 my $name = $c->config->{name};
738 my $logo = $c->uri_for('/static/images/catalyst_logo.png');
739 my $prefix = Catalyst::Utils::appprefix( ref $c );
740 $c->response->content_type('text/html; charset=utf-8');
742 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
743 "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
744 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
746 <meta http-equiv="Content-Language" content="en" />
747 <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
748 <title>$name on Catalyst $VERSION</title>
749 <style type="text/css">
752 background-color: #eee;
761 background-color: #ccc;
762 border: 1px solid #aaa;
763 -moz-border-radius: 10px;
768 font-family: verdana, tahoma, sans-serif;
771 font-family: verdana, tahoma, sans-serif;
774 text-decoration: none;
776 border-bottom: 1px dotted #bbb;
778 :link:hover, :visited:hover {
791 background-color: #fff;
792 border: 1px solid #aaa;
793 -moz-border-radius: 10px;
819 <h1><span id="appname">$name</span> on <a href="http://catalyst.perl.org">Catalyst</a>
824 <img src="$logo" alt="Catalyst Logo" />
826 <p>Welcome to the wonderful world of Catalyst.
827 This <a href="http://en.wikipedia.org/wiki/MVC">MVC</a>
828 framework will make web development something you had
829 never expected it to be: Fun, rewarding, and quick.</p>
830 <h2>What to do now?</h2>
831 <p>That really depends on what <b>you</b> want to do.
832 We do, however, provide you with a few starting points.</p>
833 <p>If you want to jump right into web development with Catalyst
834 you might want to check out the documentation.</p>
835 <pre><code>perldoc <a href="http://cpansearch.perl.org/dist/Catalyst/lib/Catalyst/Manual/Intro.pod">Catalyst::Manual::Intro</a>
836 perldoc <a href="http://cpansearch.perl.org/dist/Catalyst/lib/Catalyst/Manual/Tutorial.pod">Catalyst::Manual::Tutorial</a></code>
837 perldoc <a href="http://cpansearch.perl.org/dist/Catalyst/lib/Catalyst/Manual.pod">Catalyst::Manual</a></code></pre>
838 <h2>What to do next?</h2>
839 <p>Next it's time to write an actual application. Use the
840 helper scripts to generate <a href="http://cpansearch.perl.org/search?query=Catalyst%3A%3AController%3A%3A&mode=all">controllers</a>,
841 <a href="http://cpansearch.perl.org/search?query=Catalyst%3A%3AModel%3A%3A&mode=all">models</a>, and
842 <a href="http://cpansearch.perl.org/search?query=Catalyst%3A%3AView%3A%3A&mode=all">views</a>;
843 they can save you a lot of work.</p>
844 <pre><code>script/${prefix}_create.pl -help</code></pre>
845 <p>Also, be sure to check out the vast and growing
846 collection of <a href="http://cpansearch.perl.org/search?query=Catalyst%3A%3APlugin%3A%3A&mode=all">plugins for Catalyst on CPAN</a>;
847 you are likely to find what you need there.
851 <p>Catalyst has a very active community. Here are the main places to
852 get in touch with us.</p>
855 <a href="http://dev.catalyst.perl.org">Wiki</a>
858 <a href="http://lists.rawmode.org/mailman/listinfo/catalyst">Mailing-List</a>
861 <a href="irc://irc.perl.org/catalyst">IRC channel #catalyst on irc.perl.org</a>
864 <h2>In conclusion</h2>
865 <p>The Catalyst team hopes you will enjoy using Catalyst as much
866 as we enjoyed making it. Please contact us if you have ideas
867 for improvement or other feedback.</p>
875 =head1 INTERNAL METHODS
877 These methods are not meant to be used by end users.
879 =head2 $c->components
881 Returns a hash of components.
883 =head2 $c->context_class
885 Returns or sets the context class.
889 Returns a hashref containing coderefs and execution counts (needed for
890 deep recursion detection).
894 Returns the number of actions on the current internal execution stack.
898 Dispatches a request to actions.
902 sub dispatch { my $c = shift; $c->dispatcher->dispatch( $c, @_ ) }
904 =head2 $c->dispatcher_class
906 Returns or sets the dispatcher class.
908 =head2 $c->dump_these
910 Returns a list of 2-element array references (name, structure) pairs
911 that will be dumped on the error page in debug mode.
917 [ Request => $c->req ], [ Response => $c->res ], [ Stash => $c->stash ],;
920 =head2 $c->engine_class
922 Returns or sets the engine class.
924 =head2 $c->execute( $class, $coderef )
926 Execute a coderef in given class and catch exceptions. Errors are available
932 my ( $c, $class, $code ) = @_;
933 $class = $c->component($class) || $class;
937 my $action = "$code";
938 $action = "/$action" unless $action =~ /\-\>/;
939 $c->counter->{"$code"}++;
941 if ( $c->counter->{"$code"} > $RECURSION ) {
942 my $error = qq/Deep recursion detected in "$action"/;
943 $c->log->error($error);
949 # determine if the call was the result of a forward
950 # this is done by walking up the call stack and looking for a calling
951 # sub of Catalyst::forward before the eval
953 for my $index ( 1 .. 10 ) {
955 if ( ( caller($index) )[0] eq 'Catalyst'
956 && ( caller($index) )[3] eq '(eval)' );
958 if ( ( caller($index) )[3] =~ /forward$/ ) {
959 $callsub = ( caller($index) )[3];
960 $action = "-> $action";
965 my $node = Tree::Simple->new(
968 elapsed => undef, # to be filled in later
971 $node->setUID( "$code" . $c->counter->{"$code"} );
973 unless ( ( $code->name =~ /^_.*/ )
974 && ( !$c->config->{show_internal_actions} ) )
977 # is this a root-level call or a forwarded call?
978 if ( $callsub =~ /forward$/ ) {
980 # forward, locate the caller
981 if ( my $parent = $c->stack->[-1] ) {
982 my $visitor = Tree::Simple::Visitor::FindByUID->new;
983 $visitor->searchForUID(
984 "$parent" . $c->counter->{"$parent"} );
985 $c->{stats}->accept($visitor);
986 if ( my $result = $visitor->getResult ) {
987 $result->addChild($node);
992 # forward with no caller may come from a plugin
993 $c->{stats}->addChild($node);
999 $c->{stats}->addChild($node);
1004 push( @{ $c->stack }, $code );
1007 $start = [gettimeofday] if $c->debug;
1008 eval { $c->state( &$code( $class, $c, @{ $c->req->args } ) || 0 ) };
1009 $elapsed = tv_interval($start) if $c->debug;
1012 unless ( ( $code->name =~ /^_.*/ )
1013 && ( !$c->config->{show_internal_actions} ) )
1016 # FindByUID uses an internal die, so we save the existing error
1019 # locate the node in the tree and update the elapsed time
1020 my $visitor = Tree::Simple::Visitor::FindByUID->new;
1021 $visitor->searchForUID( "$code" . $c->counter->{"$code"} );
1022 $c->{stats}->accept($visitor);
1023 if ( my $result = $visitor->getResult ) {
1024 my $value = $result->getNodeValue;
1025 $value->{elapsed} = sprintf( '%fs', $elapsed );
1026 $result->setNodeValue($value);
1030 $@ = $error || undef;
1033 my $last = ${ $c->stack }[-1];
1034 pop( @{ $c->stack } );
1036 if ( my $error = $@ ) {
1037 if ( $error eq $DETACH ) { die $DETACH if $c->depth > 1 }
1039 unless ( ref $error ) {
1041 my $class = $last->class;
1042 my $name = $last->name;
1043 $error = qq/Caught exception in $class->$name "$error"/;
1054 Finalizes the request.
1061 for my $error ( @{ $c->error } ) {
1062 $c->log->error($error);
1065 $c->finalize_uploads;
1068 if ( $#{ $c->error } >= 0 ) {
1072 $c->finalize_headers;
1075 if ( $c->request->method eq 'HEAD' ) {
1076 $c->response->body('');
1081 return $c->response->status;
1084 =head2 $c->finalize_body
1090 sub finalize_body { my $c = shift; $c->engine->finalize_body( $c, @_ ) }
1092 =head2 $c->finalize_cookies
1098 sub finalize_cookies { my $c = shift; $c->engine->finalize_cookies( $c, @_ ) }
1100 =head2 $c->finalize_error
1106 sub finalize_error { my $c = shift; $c->engine->finalize_error( $c, @_ ) }
1108 =head2 $c->finalize_headers
1114 sub finalize_headers {
1117 # Check if we already finalized headers
1118 return if $c->response->{_finalized_headers};
1121 if ( my $location = $c->response->redirect ) {
1122 $c->log->debug(qq/Redirecting to "$location"/) if $c->debug;
1123 $c->response->header( Location => $location );
1127 if ( $c->response->body && !$c->response->content_length ) {
1129 # get the length from a filehandle
1130 if ( ref $c->response->body && $c->response->body->can('read') ) {
1131 if ( my $stat = stat $c->response->body ) {
1132 $c->response->content_length( $stat->size );
1135 $c->log->warn('Serving filehandle without a content-length');
1139 $c->response->content_length( bytes::length( $c->response->body ) );
1144 if ( $c->response->status =~ /^(1\d\d|[23]04)$/ ) {
1145 $c->response->headers->remove_header("Content-Length");
1146 $c->response->body('');
1149 $c->finalize_cookies;
1151 $c->engine->finalize_headers( $c, @_ );
1154 $c->response->{_finalized_headers} = 1;
1157 =head2 $c->finalize_output
1159 An alias for finalize_body.
1161 =head2 $c->finalize_read
1163 Finalizes the input after reading is complete.
1167 sub finalize_read { my $c = shift; $c->engine->finalize_read( $c, @_ ) }
1169 =head2 $c->finalize_uploads
1171 Finalizes uploads. Cleans up any temporary files.
1175 sub finalize_uploads { my $c = shift; $c->engine->finalize_uploads( $c, @_ ) }
1177 =head2 $c->get_action( $action, $namespace )
1179 Gets an action in a given namespace.
1183 sub get_action { my $c = shift; $c->dispatcher->get_action(@_) }
1185 =head2 $c->get_actions( $action, $namespace )
1187 Gets all actions of a given name in a namespace and all parent
1192 sub get_actions { my $c = shift; $c->dispatcher->get_actions( $c, @_ ) }
1194 =head2 handle_request( $class, @arguments )
1196 Called to handle each HTTP request.
1200 sub handle_request {
1201 my ( $class, @arguments ) = @_;
1203 # Always expect worst case!
1206 my $stats = ( $class->debug ) ? Tree::Simple->new: q{};
1209 my $c = $class->prepare(@arguments);
1210 $c->{stats} = $stats;
1212 return $c->finalize;
1215 if ( $class->debug ) {
1216 my $start = [gettimeofday];
1217 $status = &$handler;
1218 my $elapsed = tv_interval $start;
1219 $elapsed = sprintf '%f', $elapsed;
1220 my $av = sprintf '%.3f',
1221 ( $elapsed == 0 ? '??' : ( 1 / $elapsed ) );
1222 my $t = Text::SimpleTable->new( [ 64, 'Action' ], [ 9, 'Time' ] );
1227 my $stat = $action->getNodeValue;
1228 $t->row( ( q{ } x $action->getDepth ) . $stat->{action},
1229 $stat->{elapsed} || '??' );
1234 "Request took ${elapsed}s ($av/s)\n" . $t->draw );
1236 else { $status = &$handler }
1240 if ( my $error = $@ ) {
1242 $class->log->error(qq/Caught exception in engine "$error"/);
1246 $class->log->_flush() if $class->log->can('_flush');
1250 =head2 $c->prepare( @arguments )
1252 Creates a Catalyst context from an engine-specific request (Apache, CGI,
1258 my ( $class, @arguments ) = @_;
1260 $class->context_class( ref $class || $class ) unless $class->context_class;
1261 my $c = $class->context_class->new(
1265 request => $class->request_class->new(
1268 body_parameters => {},
1270 headers => HTTP::Headers->new,
1272 query_parameters => {},
1278 response => $class->response_class->new(
1282 headers => HTTP::Headers->new(),
1291 # For on-demand data
1292 $c->request->{_context} = $c;
1293 $c->response->{_context} = $c;
1294 weaken( $c->request->{_context} );
1295 weaken( $c->response->{_context} );
1298 my $secs = time - $START || 1;
1299 my $av = sprintf '%.3f', $COUNT / $secs;
1300 $c->log->debug('**********************************');
1301 $c->log->debug("* Request $COUNT ($av/s) [$$]");
1302 $c->log->debug('**********************************');
1303 $c->res->headers->header( 'X-Catalyst' => $Catalyst::VERSION );
1306 $c->prepare_request(@arguments);
1307 $c->prepare_connection;
1308 $c->prepare_query_parameters;
1309 $c->prepare_headers;
1310 $c->prepare_cookies;
1314 $c->prepare_body unless $c->config->{parse_on_demand};
1316 my $method = $c->req->method || '';
1317 my $path = $c->req->path || '';
1318 my $address = $c->req->address || '';
1320 $c->log->debug(qq/"$method" request for "$path" from "$address"/)
1328 =head2 $c->prepare_action
1334 sub prepare_action { my $c = shift; $c->dispatcher->prepare_action( $c, @_ ) }
1336 =head2 $c->prepare_body
1338 Prepares message body.
1345 # Do we run for the first time?
1346 return if defined $c->request->{_body};
1348 # Initialize on-demand data
1349 $c->engine->prepare_body( $c, @_ );
1350 $c->prepare_parameters;
1351 $c->prepare_uploads;
1353 if ( $c->debug && keys %{ $c->req->body_parameters } ) {
1354 my $t = Text::SimpleTable->new( [ 37, 'Key' ], [ 36, 'Value' ] );
1355 for my $key ( sort keys %{ $c->req->body_parameters } ) {
1356 my $param = $c->req->body_parameters->{$key};
1357 my $value = defined($param) ? $param : '';
1359 ref $value eq 'ARRAY' ? ( join ', ', @$value ) : $value );
1361 $c->log->debug( "Body Parameters are:\n" . $t->draw );
1365 =head2 $c->prepare_body_chunk( $chunk )
1367 Prepares a chunk of data before sending it to L<HTTP::Body>.
1371 sub prepare_body_chunk {
1373 $c->engine->prepare_body_chunk( $c, @_ );
1376 =head2 $c->prepare_body_parameters
1378 Prepares body parameters.
1382 sub prepare_body_parameters {
1384 $c->engine->prepare_body_parameters( $c, @_ );
1387 =head2 $c->prepare_connection
1389 Prepares connection.
1393 sub prepare_connection {
1395 $c->engine->prepare_connection( $c, @_ );
1398 =head2 $c->prepare_cookies
1404 sub prepare_cookies { my $c = shift; $c->engine->prepare_cookies( $c, @_ ) }
1406 =head2 $c->prepare_headers
1412 sub prepare_headers { my $c = shift; $c->engine->prepare_headers( $c, @_ ) }
1414 =head2 $c->prepare_parameters
1416 Prepares parameters.
1420 sub prepare_parameters {
1422 $c->prepare_body_parameters;
1423 $c->engine->prepare_parameters( $c, @_ );
1426 =head2 $c->prepare_path
1428 Prepares path and base.
1432 sub prepare_path { my $c = shift; $c->engine->prepare_path( $c, @_ ) }
1434 =head2 $c->prepare_query_parameters
1436 Prepares query parameters.
1440 sub prepare_query_parameters {
1443 $c->engine->prepare_query_parameters( $c, @_ );
1445 if ( $c->debug && keys %{ $c->request->query_parameters } ) {
1446 my $t = Text::SimpleTable->new( [ 37, 'Key' ], [ 36, 'Value' ] );
1447 for my $key ( sort keys %{ $c->req->query_parameters } ) {
1448 my $param = $c->req->query_parameters->{$key};
1449 my $value = defined($param) ? $param : '';
1451 ref $value eq 'ARRAY' ? ( join ', ', @$value ) : $value );
1453 $c->log->debug( "Query Parameters are:\n" . $t->draw );
1457 =head2 $c->prepare_read
1459 Prepares the input for reading.
1463 sub prepare_read { my $c = shift; $c->engine->prepare_read( $c, @_ ) }
1465 =head2 $c->prepare_request
1467 Prepares the engine request.
1471 sub prepare_request { my $c = shift; $c->engine->prepare_request( $c, @_ ) }
1473 =head2 $c->prepare_uploads
1479 sub prepare_uploads {
1482 $c->engine->prepare_uploads( $c, @_ );
1484 if ( $c->debug && keys %{ $c->request->uploads } ) {
1485 my $t = Text::SimpleTable->new(
1491 for my $key ( sort keys %{ $c->request->uploads } ) {
1492 my $upload = $c->request->uploads->{$key};
1493 for my $u ( ref $upload eq 'ARRAY' ? @{$upload} : ($upload) ) {
1494 $t->row( $key, $u->filename, $u->type, $u->size );
1497 $c->log->debug( "File Uploads are:\n" . $t->draw );
1501 =head2 $c->prepare_write
1503 Prepares the output for writing.
1507 sub prepare_write { my $c = shift; $c->engine->prepare_write( $c, @_ ) }
1509 =head2 $c->request_class
1511 Returns or sets the request class.
1513 =head2 $c->response_class
1515 Returns or sets the response class.
1517 =head2 $c->read( [$maxlength] )
1519 Reads a chunk of data from the request body. This method is designed to
1520 be used in a while loop, reading C<$maxlength> bytes on every call.
1521 C<$maxlength> defaults to the size of the request if not specified.
1523 You have to set C<MyApp-E<gt>config-E<gt>{parse_on_demand}> to use this
1528 sub read { my $c = shift; return $c->engine->read( $c, @_ ) }
1536 sub run { my $c = shift; return $c->engine->run( $c, @_ ) }
1538 =head2 $c->set_action( $action, $code, $namespace, $attrs )
1540 Sets an action in a given namespace.
1544 sub set_action { my $c = shift; $c->dispatcher->set_action( $c, @_ ) }
1546 =head2 $c->setup_actions($component)
1548 Sets up actions for a component.
1552 sub setup_actions { my $c = shift; $c->dispatcher->setup_actions( $c, @_ ) }
1554 =head2 $c->setup_components
1560 sub setup_components {
1563 my $callback = sub {
1564 my ( $component, $context ) = @_;
1566 unless ( $component->can('COMPONENT') ) {
1570 my $suffix = Catalyst::Utils::class2classsuffix($component);
1571 my $config = $class->config->{$suffix} || {};
1575 eval { $instance = $component->COMPONENT( $context, $config ); };
1577 if ( my $error = $@ ) {
1581 Catalyst::Exception->throw( message =>
1582 qq/Couldn't instantiate component "$component", "$error"/ );
1585 Catalyst::Exception->throw( message =>
1586 qq/Couldn't instantiate component "$component", "COMPONENT() didn't return a object"/
1588 unless ref $instance;
1592 eval "package $class;\n" . q!Module::Pluggable::Fast->import(
1593 name => '_catalyst_components',
1595 "$class\::Controller", "$class\::C",
1596 "$class\::Model", "$class\::M",
1597 "$class\::View", "$class\::V"
1599 callback => $callback
1603 if ( my $error = $@ ) {
1607 Catalyst::Exception->throw(
1608 message => qq/Couldn't load components "$error"/ );
1611 for my $component ( $class->_catalyst_components($class) ) {
1612 $class->components->{ ref $component || $component } = $component;
1616 =head2 $c->setup_dispatcher
1622 sub setup_dispatcher {
1623 my ( $class, $dispatcher ) = @_;
1626 $dispatcher = 'Catalyst::Dispatcher::' . $dispatcher;
1629 if ( $ENV{CATALYST_DISPATCHER} ) {
1630 $dispatcher = 'Catalyst::Dispatcher::' . $ENV{CATALYST_DISPATCHER};
1633 if ( $ENV{ uc($class) . '_DISPATCHER' } ) {
1635 'Catalyst::Dispatcher::' . $ENV{ uc($class) . '_DISPATCHER' };
1638 unless ($dispatcher) {
1639 $dispatcher = $class->dispatcher_class;
1642 $dispatcher->require;
1645 Catalyst::Exception->throw(
1646 message => qq/Couldn't load dispatcher "$dispatcher", "$@"/ );
1649 # dispatcher instance
1650 $class->dispatcher( $dispatcher->new );
1653 =head2 $c->setup_engine
1660 my ( $class, $engine ) = @_;
1663 $engine = 'Catalyst::Engine::' . $engine;
1666 if ( $ENV{CATALYST_ENGINE} ) {
1667 $engine = 'Catalyst::Engine::' . $ENV{CATALYST_ENGINE};
1670 if ( $ENV{ uc($class) . '_ENGINE' } ) {
1671 $engine = 'Catalyst::Engine::' . $ENV{ uc($class) . '_ENGINE' };
1674 if ( $ENV{MOD_PERL} ) {
1676 # create the apache method
1679 *{"$class\::apache"} = sub { shift->engine->apache };
1682 my ( $software, $version ) =
1683 $ENV{MOD_PERL} =~ /^(\S+)\/(\d+(?:[\.\_]\d+)+)/;
1686 $version =~ s/(\.[^.]+)\./$1/g;
1688 if ( $software eq 'mod_perl' ) {
1692 if ( $version >= 1.99922 ) {
1693 $engine = 'Catalyst::Engine::Apache2::MP20';
1696 elsif ( $version >= 1.9901 ) {
1697 $engine = 'Catalyst::Engine::Apache2::MP19';
1700 elsif ( $version >= 1.24 ) {
1701 $engine = 'Catalyst::Engine::Apache::MP13';
1705 Catalyst::Exception->throw( message =>
1706 qq/Unsupported mod_perl version: $ENV{MOD_PERL}/ );
1711 # install the correct mod_perl handler
1712 if ( $version >= 1.9901 ) {
1713 *handler = sub : method {
1714 shift->handle_request(@_);
1718 *handler = sub ($$) { shift->handle_request(@_) };
1723 elsif ( $software eq 'Zeus-Perl' ) {
1724 $engine = 'Catalyst::Engine::Zeus';
1728 Catalyst::Exception->throw(
1729 message => qq/Unsupported mod_perl: $ENV{MOD_PERL}/ );
1734 $engine = $class->engine_class;
1740 Catalyst::Exception->throw( message =>
1741 qq/Couldn't load engine "$engine" (maybe you forgot to install it?), "$@"/
1745 # check for old engines that are no longer compatible
1747 if ( $engine->isa('Catalyst::Engine::Apache')
1748 && !Catalyst::Engine::Apache->VERSION )
1753 elsif ( $engine->isa('Catalyst::Engine::Server::Base')
1754 && Catalyst::Engine::Server->VERSION le '0.02' )
1759 elsif ($engine->isa('Catalyst::Engine::HTTP::POE')
1760 && $engine->VERSION eq '0.01' )
1765 elsif ($engine->isa('Catalyst::Engine::Zeus')
1766 && $engine->VERSION eq '0.01' )
1772 Catalyst::Exception->throw( message =>
1773 qq/Engine "$engine" is not supported by this version of Catalyst/
1778 $class->engine( $engine->new );
1781 =head2 $c->setup_home
1783 Sets up the home directory.
1788 my ( $class, $home ) = @_;
1790 if ( $ENV{CATALYST_HOME} ) {
1791 $home = $ENV{CATALYST_HOME};
1794 if ( $ENV{ uc($class) . '_HOME' } ) {
1795 $home = $ENV{ uc($class) . '_HOME' };
1799 $home = Catalyst::Utils::home($class);
1803 $class->config->{home} ||= $home;
1804 $class->config->{root} ||= dir($home)->subdir('root');
1808 =head2 $c->setup_log
1815 my ( $class, $debug ) = @_;
1817 unless ( $class->log ) {
1818 $class->log( Catalyst::Log->new );
1821 my $app_flag = Catalyst::Utils::class2env($class) . '_DEBUG';
1824 ( defined( $ENV{CATALYST_DEBUG} ) || defined( $ENV{$app_flag} ) )
1825 ? ( $ENV{CATALYST_DEBUG} || $ENV{$app_flag} )
1830 *{"$class\::debug"} = sub { 1 };
1831 $class->log->debug('Debug messages enabled');
1835 =head2 $c->setup_plugins
1842 my ( $class, $plugins ) = @_;
1845 for my $plugin ( reverse @$plugins ) {
1847 $plugin = "Catalyst::Plugin::$plugin";
1852 Catalyst::Exception->throw(
1853 message => qq/Couldn't load plugin "$plugin", "$@"/ );
1858 unshift @{"$class\::ISA"}, $plugin;
1867 =head2 $c->write( $data )
1869 Writes $data to the output stream. When using this method directly, you
1870 will need to manually set the C<Content-Length> header to the length of
1871 your output data, if known.
1878 # Finalize headers if someone manually writes output
1879 $c->finalize_headers;
1881 return $c->engine->write( $c, @_ );
1886 Returns the Catalyst version number. Mostly useful for "powered by"
1887 messages in template systems.
1891 sub version { return $Catalyst::VERSION }
1893 =head1 INTERNAL ACTIONS
1895 Catalyst uses internal actions like C<_DISPATCH>, C<_BEGIN>, C<_AUTO>,
1896 C<_ACTION>, and C<_END>. These are by default not shown in the private
1897 action table, but you can make them visible with a config parameter.
1899 MyApp->config->{show_internal_actions} = 1;
1901 =head1 CASE SENSITIVITY
1903 By default Catalyst is not case sensitive, so C<MyApp::C::FOO::Bar> is
1904 mapped to C</foo/bar>. You can activate case sensitivity with a config
1907 MyApp->config->{case_sensitive} = 1;
1909 This causes C<MyApp::C::Foo::Bar> to map to C</Foo/Bar>.
1911 =head1 ON-DEMAND PARSER
1913 The request body is usually parsed at the beginning of a request,
1914 but if you want to handle input yourself or speed things up a bit,
1915 you can enable on-demand parsing with a config parameter.
1917 MyApp->config->{parse_on_demand} = 1;
1919 =head1 PROXY SUPPORT
1921 Many production servers operate using the common double-server approach,
1922 with a lightweight frontend web server passing requests to a larger
1923 backend server. An application running on the backend server must deal
1924 with two problems: the remote user always appears to be C<127.0.0.1> and
1925 the server's hostname will appear to be C<localhost> regardless of the
1926 virtual host that the user connected through.
1928 Catalyst will automatically detect this situation when you are running
1929 the frontend and backend servers on the same machine. The following
1930 changes are made to the request.
1932 $c->req->address is set to the user's real IP address, as read from
1933 the HTTP X-Forwarded-For header.
1935 The host value for $c->req->base and $c->req->uri is set to the real
1936 host, as read from the HTTP X-Forwarded-Host header.
1938 Obviously, your web server must support these headers for this to work.
1940 In a more complex server farm environment where you may have your
1941 frontend proxy server(s) on different machines, you will need to set a
1942 configuration option to tell Catalyst to read the proxied data from the
1945 MyApp->config->{using_frontend_proxy} = 1;
1947 If you do not wish to use the proxy support at all, you may set:
1949 MyApp->config->{ignore_frontend_proxy} = 1;
1951 =head1 THREAD SAFETY
1953 Catalyst has been tested under Apache 2's threading mpm_worker, mpm_winnt,
1954 and the standalone forking HTTP server on Windows. We believe the Catalyst
1955 core to be thread-safe.
1957 If you plan to operate in a threaded environment, remember that all other
1958 modules you are using must also be thread-safe. Some modules, most notably
1959 L<DBD::SQLite>, are not thread-safe.
1965 Join #catalyst on irc.perl.org.
1969 http://lists.rawmode.org/mailman/listinfo/catalyst
1970 http://lists.rawmode.org/mailman/listinfo/catalyst-dev
1974 http://catalyst.perl.org
1978 http://dev.catalyst.perl.org
1982 =head2 L<Task::Catalyst> - All you need to start with Catalyst
1984 =head2 L<Catalyst::Manual> - The Catalyst Manual
1986 =head2 L<Catalyst::Component>, L<Catalyst::Base> - Base classes for components
1988 =head2 L<Catalyst::Engine> - Core engine
1990 =head2 L<Catalyst::Log> - Log class.
1992 =head2 L<Catalyst::Request> - Request object
1994 =head2 L<Catalyst::Response> - Response object
1996 =head2 L<Catalyst::Test> - The test suite.
2066 Sebastian Riedel, C<sri@oook.de>
2070 This library is free software, you can redistribute it and/or modify it under
2071 the same terms as Perl itself.