4 use base 'Catalyst::Base';
6 use UNIVERSAL::require;
7 use Catalyst::Exception;
10 use Catalyst::Request::Upload;
11 use Catalyst::Response;
14 use Text::SimpleTable;
16 use Time::HiRes qw/gettimeofday tv_interval/;
18 use Scalar::Util qw/weaken/;
21 __PACKAGE__->mk_accessors(
22 qw/counter request response state action stack namespace/
25 attributes->import( __PACKAGE__, \&namespace, 'lvalue' );
27 sub depth { scalar @{ shift->stack || [] }; }
34 # For backwards compatibility
35 *finalize_output = \&finalize_body;
40 our $RECURSION = 1000;
41 our $DETACH = "catalyst_detach\n";
43 require Module::Pluggable::Fast;
45 # Helper script generation
46 our $CATALYST_SCRIPT_GEN = 18;
48 __PACKAGE__->mk_classdata($_)
49 for qw/components arguments dispatcher engine log dispatcher_class
50 engine_class context_class request_class response_class/;
52 __PACKAGE__->dispatcher_class('Catalyst::Dispatcher');
53 __PACKAGE__->engine_class('Catalyst::Engine::CGI');
54 __PACKAGE__->request_class('Catalyst::Request');
55 __PACKAGE__->response_class('Catalyst::Response');
57 our $VERSION = '5.57';
60 my ( $class, @arguments ) = @_;
62 # We have to limit $class to Catalyst to avoid pushing Catalyst upon every
64 return unless $class eq 'Catalyst';
66 my $caller = caller(0);
68 unless ( $caller->isa('Catalyst') ) {
70 push @{"$caller\::ISA"}, $class;
73 $caller->arguments( [@arguments] );
79 Catalyst - The Elegant MVC Web Application Framework
83 # use the helper to start a new application
86 # add models, views, controllers
87 script/myapp_create.pl model Database DBIC dbi:SQLite:/path/to/db
88 script/myapp_create.pl view TT TT
89 script/myapp_create.pl controller Search
91 # built in testserver -- use -r to restart automatically on changes
92 script/myapp_server.pl
94 # command line testing interface
95 script/myapp_test.pl /yada
98 use Catalyst qw/-Debug/; # include plugins here as well
100 sub foo : Global { # called for /foo, /foo/1, /foo/1/2, etc.
101 my ( $self, $c, @args ) = @_; # args are qw/1 2/ for /foo/1/2
102 $c->stash->{template} = 'foo.tt'; # set the template
103 # lookup something from db -- stash vars are passed to TT
105 MyApp::Model::Database::Foo->search( { country => $args[0] } );
106 if ( $c->req->params->{bar} ) { # access GET or POST parameters
107 $c->forward( 'bar' ); # process another action
108 # do something else after forward returns
112 # The foo.tt TT template can use the stash data from the database
113 [% WHILE (item = data.next) %]
117 # called for /bar/of/soap, /bar/of/soap/10, etc.
118 sub bar : Path('/bar/of/soap') { ... }
120 # called for all actions, from the top-most controller downwards
122 my ( $self, $c ) = @_;
124 $c->res->redirect( '/login' ); # require login
125 return 0; # abort request and go immediately to end()
127 return 1; # success; carry on to next action
130 # called after all actions are finished
132 my ( $self, $c ) = @_;
133 if ( scalar @{ $c->error } ) { ... } # handle errors
134 return if $c->res->body; # already have a response
135 $c->forward( 'MyApp::View::TT' ); # render template
138 ### in MyApp/Controller/Foo.pm
139 # called for /foo/bar
140 sub bar : Local { ... }
142 # called for /blargle
143 sub blargle : Global { ... }
145 # an index action matches /foo, but not /foo/1, etc.
146 sub index : Private { ... }
148 ### in MyApp/Controller/Foo/Bar.pm
149 # called for /foo/bar/baz
150 sub baz : Local { ... }
152 # first MyApp auto is called, then Foo auto, then this
153 sub auto : Private { ... }
155 # powerful regular expression paths are also possible
156 sub details : Regex('^product/(\w+)/details$') {
157 my ( $self, $c ) = @_;
158 # extract the (\w+) from the URI
159 my $product = $c->req->snippets->[0];
162 See L<Catalyst::Manual::Intro> for additional information.
166 The key concept of Catalyst is DRY (Don't Repeat Yourself).
168 See L<Catalyst::Manual> for more documentation.
170 Catalyst plugins can be loaded by naming them as arguments to the "use
171 Catalyst" statement. Omit the C<Catalyst::Plugin::> prefix from the
172 plugin name, i.e., C<Catalyst::Plugin::My::Module> becomes
175 use Catalyst qw/My::Module/;
177 Special flags like C<-Debug> and C<-Engine> can also be specified as
178 arguments when Catalyst is loaded:
180 use Catalyst qw/-Debug My::Module/;
182 The position of plugins and flags in the chain is important, because
183 they are loaded in exactly the order in which they appear.
185 The following flags are supported:
189 Enables debug output.
193 Forces Catalyst to use a specific engine. Omit the
194 C<Catalyst::Engine::> prefix of the engine name, i.e.:
196 use Catalyst qw/-Engine=CGI/;
200 Forces Catalyst to use a specific home directory, e.g.:
202 use Catalyst qw[-Home=/usr/sri];
210 =head2 Information about the current request
214 Returns a L<Catalyst::Action> object for the current action, which
215 stringifies to the action name. See L<Catalyst::Action>.
219 Returns the namespace of the current action, i.e., the uri prefix
220 corresponding to the controller of the current action. For example:
222 # in Controller::Foo::Bar
223 $c->namespace; # returns 'foo/bar';
229 Returns the current L<Catalyst::Request> object. See
230 L<Catalyst::Request>.
232 =head2 Processing and response to the current request
234 =head2 $c->forward( $action [, \@arguments ] )
236 =head2 $c->forward( $class, $method, [, \@arguments ] )
238 Forwards processing to a private action. If you give a class name but no
239 method, C<process()> is called. You may also optionally pass arguments
240 in an arrayref. The action will receive the arguments in C<@_> and
241 C<$c-E<gt>req-E<gt>args>. Upon returning from the function,
242 C<$c-E<gt>req-E<gt>args> will be restored to the previous values.
245 $c->forward('index');
246 $c->forward(qw/MyApp::Model::CDBI::Foo do_stuff/);
247 $c->forward('MyApp::View::TT');
251 sub forward { my $c = shift; $c->dispatcher->forward( $c, @_ ) }
253 =head2 $c->detach( $action [, \@arguments ] )
255 =head2 $c->detach( $class, $method, [, \@arguments ] )
257 The same as C<forward>, but doesn't return.
261 sub detach { my $c = shift; $c->dispatcher->detach( $c, @_ ) }
265 =head2 $c->error($error, ...)
267 =head2 $c->error($arrayref)
269 Returns an arrayref containing error messages. If Catalyst encounters an
270 error while processing a request, it stores the error in $c->error. This
271 method should not be used to store non-fatal error messages.
273 my @error = @{ $c->error };
277 $c->error('Something bad happened');
279 Clear errors. You probably don't want to clear the errors unless you are
280 implementing a custom error screen.
289 my $error = ref $_[0] eq 'ARRAY' ? $_[0] : [@_];
290 push @{ $c->{error} }, @$error;
292 elsif ( defined $_[0] ) { $c->{error} = undef }
293 return $c->{error} || [];
300 Returns the current L<Catalyst::Response> object.
304 Returns a hashref to the stash, which may be used to store data and pass
305 it between components during a request. You can also set hash keys by
306 passing arguments. The stash is automatically sent to the view. The
307 stash is cleared at the end of a request; it cannot be used for
310 $c->stash->{foo} = $bar;
311 $c->stash( { moose => 'majestic', qux => 0 } );
312 $c->stash( bar => 1, gorch => 2 ); # equivalent to passing a hashref
314 # stash is automatically passed to the view for use in a template
315 $c->forward( 'MyApp::V::TT' );
322 my $stash = @_ > 1 ? {@_} : $_[0];
323 while ( my ( $key, $val ) = each %$stash ) {
324 $c->{stash}->{$key} = $val;
332 Contains the return value of the last executed action.
334 =head2 Component Accessors
336 =head2 $c->comp($name)
338 =head2 $c->component($name)
340 Gets a component object by name. This method is no longer recommended,
341 unless you want to get a specific component by full
342 class. C<$c-E<gt>controller>, C<$c-E<gt>model>, and C<$c-E<gt>view>
343 should be used instead.
354 my $appclass = ref $c || $c;
357 $name, "${appclass}::${name}",
358 map { "${appclass}::${_}::${name}" }
359 qw/Model M Controller C View V/
362 foreach my $try (@names) {
364 if ( exists $c->components->{$try} ) {
366 return $c->components->{$try};
370 foreach my $component ( keys %{ $c->components } ) {
372 return $c->components->{$component} if $component =~ /$name/i;
377 return sort keys %{ $c->components };
380 =head2 $c->controller($name)
382 Gets a L<Catalyst::Controller> instance by name.
384 $c->controller('Foo')->do_stuff;
389 my ( $c, $name ) = @_;
390 my $controller = $c->comp("Controller::$name");
391 return $controller if $controller;
392 return $c->comp("C::$name");
395 =head2 $c->model($name)
397 Gets a L<Catalyst::Model> instance by name.
399 $c->model('Foo')->do_stuff;
404 my ( $c, $name ) = @_;
405 my $model = $c->comp("Model::$name");
406 return $model if $model;
407 return $c->comp("M::$name");
410 =head2 $c->view($name)
412 Gets a L<Catalyst::View> instance by name.
414 $c->view('Foo')->do_stuff;
419 my ( $c, $name ) = @_;
420 my $view = $c->comp("View::$name");
421 return $view if $view;
422 return $c->comp("V::$name");
425 =head2 Class data and helper classes
429 Returns or takes a hashref containing the application's configuration.
431 __PACKAGE__->config({ db => 'dsn:SQLite:foo.db' });
435 Overload to enable debug messages (same as -Debug option).
441 =head2 $c->dispatcher
443 Returns the dispatcher instance. Stringifies to class name. See
444 L<Catalyst::Dispatcher>.
448 Returns the engine instance. Stringifies to the class name. See
453 Returns the logging object instance. Unless it is already set, Catalyst
454 sets this up with a L<Catalyst::Log> object. To use your own log class:
456 $c->log( MyLogger->new );
457 $c->log->info( 'Now logging with my own logger!' );
459 Your log class should implement the methods described in the
460 L<Catalyst::Log> man page.
464 =head2 Utility methods
466 =head2 $c->path_to(@path)
468 Merges C<@path> with C<$c-E<gt>config-E<gt>{home}> and returns a
469 L<Path::Class> object.
473 $c->path_to( 'db', 'sqlite.db' );
478 my ( $c, @path ) = @_;
479 my $path = dir( $c->config->{home}, @path );
480 if ( -d $path ) { return $path }
481 else { return file( $c->config->{home}, @path ) }
484 =head2 $c->plugin( $name, $class, @args )
486 Helper method for plugins. It creates a classdata accessor/mutator and
487 loads and instantiates the given class.
489 MyApp->plugin( 'prototype', 'HTML::Prototype' );
491 $c->prototype->define_javascript_functions;
496 my ( $class, $name, $plugin, @args ) = @_;
499 if ( my $error = $UNIVERSAL::require::ERROR ) {
500 Catalyst::Exception->throw(
501 message => qq/Couldn't load instant plugin "$plugin", "$error"/ );
504 eval { $plugin->import };
505 $class->mk_classdata($name);
507 eval { $obj = $plugin->new(@args) };
510 Catalyst::Exception->throw( message =>
511 qq/Couldn't instantiate instant plugin "$plugin", "$@"/ );
515 $class->log->debug(qq/Initialized instant plugin "$plugin" as "$name"/)
521 Initializes the dispatcher and engine, loads any plugins, and loads the
522 model, view, and controller components. You may also specify an array
523 of plugins to load here, if you choose to not load them in the C<use
527 MyApp->setup( qw/-Debug/ );
532 my ( $class, @arguments ) = @_;
534 unless ( $class->isa('Catalyst') ) {
536 Catalyst::Exception->throw(
537 message => qq/'$class' does not inherit from Catalyst/ );
540 if ( $class->arguments ) {
541 @arguments = ( @arguments, @{ $class->arguments } );
547 foreach (@arguments) {
551 ( $flags->{log} ) ? 'debug,' . $flags->{log} : 'debug';
553 elsif (/^-(\w+)=?(.*)$/) {
554 $flags->{ lc $1 } = $2;
557 push @{ $flags->{plugins} }, $_;
561 $class->setup_log( delete $flags->{log} );
562 $class->setup_plugins( delete $flags->{plugins} );
563 $class->setup_dispatcher( delete $flags->{dispatcher} );
564 $class->setup_engine( delete $flags->{engine} );
565 $class->setup_home( delete $flags->{home} );
567 for my $flag ( sort keys %{$flags} ) {
569 if ( my $code = $class->can( 'setup_' . $flag ) ) {
570 &$code( $class, delete $flags->{$flag} );
573 $class->log->warn(qq/Unknown flag "$flag"/);
578 <<"EOF") if ( $ENV{CATALYST_SCRIPT_GEN} && ( $ENV{CATALYST_SCRIPT_GEN} < $Catalyst::CATALYST_SCRIPT_GEN ) );
579 You are running an old script!
581 Please update by running (this will overwrite existing files):
582 catalyst.pl -force -scripts $class
584 or (this will not overwrite existing files):
585 catalyst.pl -scripts $class
588 if ( $class->debug ) {
594 @plugins = grep { /^Catalyst::Plugin/ } @{"$class\::ISA"};
598 my $t = Text::SimpleTable->new(76);
599 $t->row($_) for @plugins;
600 $class->log->debug( "Loaded plugins:\n" . $t->draw );
603 my $dispatcher = $class->dispatcher;
604 my $engine = $class->engine;
605 my $home = $class->config->{home};
607 $class->log->debug(qq/Loaded dispatcher "$dispatcher"/);
608 $class->log->debug(qq/Loaded engine "$engine"/);
612 ? $class->log->debug(qq/Found home "$home"/)
613 : $class->log->debug(qq/Home "$home" doesn't exist/)
614 : $class->log->debug(q/Couldn't find home/);
619 no warnings qw/redefine/;
620 local *setup = sub { };
624 # Initialize our data structure
625 $class->components( {} );
627 $class->setup_components;
629 if ( $class->debug ) {
630 my $t = Text::SimpleTable->new( [ 65, 'Class' ], [ 8, 'Type' ] );
631 for my $comp ( sort keys %{ $class->components } ) {
632 my $type = ref $class->components->{$comp} ? 'instance' : 'class';
633 $t->row( $comp, $type );
635 $class->log->debug( "Loaded components:\n" . $t->draw )
636 if ( keys %{ $class->components } );
639 # Add our self to components, since we are also a component
640 $class->components->{$class} = $class;
642 $class->setup_actions;
644 if ( $class->debug ) {
645 my $name = $class->config->{name} || 'Application';
646 $class->log->info("$name powered by Catalyst $Catalyst::VERSION");
648 $class->log->_flush() if $class->log->can('_flush');
651 =head2 $c->uri_for( $path, [ @args ] )
653 Merges path with C<$c-E<gt>request-E<gt>base> for absolute uri's and
654 with C<$c-E<gt>namespace> for relative uri's, then returns a
655 normalized L<URI> object. If any args are passed, they are added at the
661 my ( $c, $path, @args ) = @_;
662 my $base = $c->request->base->clone;
663 my $basepath = $base->path;
664 $basepath =~ s/\/$//;
666 my $namespace = $c->namespace;
668 # massage namespace, empty if absolute path
669 $namespace =~ s/^\///;
670 $namespace .= '/' if $namespace;
672 $namespace = '' if $path =~ /^\//;
675 # join args with '/', or a blank string
676 my $args = ( scalar @args ? '/' . join( '/', @args ) : '' );
677 return URI->new_abs( URI->new_abs( "$path$args", "$basepath$namespace" ),
681 =head2 $c->welcome_message
683 Returns the Catalyst welcome HTML page.
687 sub welcome_message {
689 my $name = $c->config->{name};
690 my $logo = $c->uri_for('/static/images/catalyst_logo.png');
691 my $prefix = Catalyst::Utils::appprefix( ref $c );
692 $c->response->content_type('text/html; charset=utf-8');
694 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
695 "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
696 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
698 <meta http-equiv="Content-Language" content="en" />
699 <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
700 <title>$name on Catalyst $VERSION</title>
701 <style type="text/css">
704 background-color: #eee;
713 background-color: #ccc;
714 border: 1px solid #aaa;
715 -moz-border-radius: 10px;
720 font-family: verdana, tahoma, sans-serif;
723 font-family: verdana, tahoma, sans-serif;
726 text-decoration: none;
728 border-bottom: 1px dotted #bbb;
730 :link:hover, :visited:hover {
743 background-color: #fff;
744 border: 1px solid #aaa;
745 -moz-border-radius: 10px;
771 <h1><span id="appname">$name</span> on <a href="http://catalyst.perl.org">Catalyst</a>
776 <img src="$logo" alt="Catalyst Logo" />
778 <p>Welcome to the wonderful world of Catalyst.
779 This <a href="http://en.wikipedia.org/wiki/MVC">MVC</a>
780 framework will make web development something you had
781 never expected it to be: Fun, rewarding and quick.</p>
782 <h2>What to do now?</h2>
783 <p>That really depends on what <b>you</b> want to do.
784 We do, however, provide you with a few starting points.</p>
785 <p>If you want to jump right into web development with Catalyst
786 you might want to check out the documentation.</p>
787 <pre><code>perldoc <a href="http://cpansearch.perl.org/dist/Catalyst/lib/Catalyst/Manual/Intro.pod">Catalyst::Manual::Intro</a>
788 perldoc <a href="http://cpansearch.perl.org/dist/Catalyst/lib/Catalyst/Manual.pod">Catalyst::Manual</a></code></pre>
789 <h2>What to do next?</h2>
790 <p>Next it's time to write an actual application. Use the
791 helper scripts to generate <a href="http://cpansearch.perl.org/search?query=Catalyst%3A%3AController%3A%3A&mode=all">controllers</a>,
792 <a href="http://cpansearch.perl.org/search?query=Catalyst%3A%3AModel%3A%3A&mode=all">models</a> and
793 <a href="http://cpansearch.perl.org/search?query=Catalyst%3A%3AView%3A%3A&mode=all">views</a>,
794 they can save you a lot of work.</p>
795 <pre><code>script/${prefix}_create.pl -help</code></pre>
796 <p>Also, be sure to check out the vast and growing
797 collection of <a href="http://cpansearch.perl.org/search?query=Catalyst%3A%3APlugin%3A%3A&mode=all">plugins for Catalyst on CPAN</a>,
798 you are likely to find what you need there.
802 <p>Catalyst has a very active community. Here are the main places to
803 get in touch with us.</p>
806 <a href="http://dev.catalyst.perl.org">Wiki</a>
809 <a href="http://lists.rawmode.org/mailman/listinfo/catalyst">Mailing-List</a>
812 <a href="irc://irc.perl.org/catalyst">IRC channel #catalyst on irc.perl.org</a>
815 <h2>In conclusion</h2>
816 <p>The Catalyst team hopes you will enjoy using Catalyst as much
817 as we enjoyed making it. Please contact us if you have ideas
818 for improvement or other feedback.</p>
826 =head1 INTERNAL METHODS
828 These methods are not meant to be used by end users.
830 =head2 $c->components
832 Returns a hash of components.
834 =head2 $c->context_class
836 Returns or sets the context class.
840 Returns a hashref containing coderefs and execution counts (needed for
841 deep recursion detection).
845 Returns the number of actions on the current internal execution stack.
849 Dispatches a request to actions.
853 sub dispatch { my $c = shift; $c->dispatcher->dispatch( $c, @_ ) }
855 =head2 $c->dispatcher_class
857 Returns or sets the dispatcher class.
859 =head2 $c->dump_these
861 Returns a list of 2-element array references (name, structure) pairs
862 that will be dumped on the error page in debug mode.
868 [ Request => $c->req ], [ Response => $c->res ], [ Stash => $c->stash ],;
871 =head2 $c->engine_class
873 Returns or sets the engine class.
875 =head2 $c->execute( $class, $coderef )
877 Execute a coderef in given class and catch exceptions. Errors are available
883 my ( $c, $class, $code ) = @_;
884 $class = $c->components->{$class} || $class;
888 ( caller(0) )[0]->isa('Catalyst::Action')
895 $action = "/$action" unless $action =~ /\-\>/;
896 $c->counter->{"$code"}++;
898 if ( $c->counter->{"$code"} > $RECURSION ) {
899 my $error = qq/Deep recursion detected in "$action"/;
900 $c->log->error($error);
906 $action = "-> $action" if $callsub =~ /forward$/;
908 push( @{ $c->stack }, $code );
911 $start = [gettimeofday] if $c->debug;
912 eval { $c->state( &$code( $class, $c, @{ $c->req->args } ) || 0 ) };
913 $elapsed = tv_interval($start) if $c->debug;
916 unless ( ( $code->name =~ /^_.*/ )
917 && ( !$c->config->{show_internal_actions} ) )
919 push @{ $c->{stats} }, [ $action, sprintf( '%fs', $elapsed ) ];
922 pop( @{ $c->stack } );
924 if ( my $error = $@ ) {
926 if ( $error eq $DETACH ) { die $DETACH if $c->depth > 1 }
928 unless ( ref $error ) {
930 $error = qq/Caught exception "$error"/;
941 Finalizes the request.
948 for my $error ( @{ $c->error } ) {
949 $c->log->error($error);
952 $c->finalize_uploads;
955 if ( $#{ $c->error } >= 0 ) {
959 $c->finalize_headers;
962 if ( $c->request->method eq 'HEAD' ) {
963 $c->response->body('');
968 return $c->response->status;
971 =head2 $c->finalize_body
977 sub finalize_body { my $c = shift; $c->engine->finalize_body( $c, @_ ) }
979 =head2 $c->finalize_cookies
985 sub finalize_cookies { my $c = shift; $c->engine->finalize_cookies( $c, @_ ) }
987 =head2 $c->finalize_error
993 sub finalize_error { my $c = shift; $c->engine->finalize_error( $c, @_ ) }
995 =head2 $c->finalize_headers
1001 sub finalize_headers {
1004 # Check if we already finalized headers
1005 return if $c->response->{_finalized_headers};
1008 if ( my $location = $c->response->redirect ) {
1009 $c->log->debug(qq/Redirecting to "$location"/) if $c->debug;
1010 $c->response->header( Location => $location );
1014 if ( $c->response->body && !$c->response->content_length ) {
1015 $c->response->content_length( bytes::length( $c->response->body ) );
1019 if ( $c->response->status =~ /^(1\d\d|[23]04)$/ ) {
1020 $c->response->headers->remove_header("Content-Length");
1021 $c->response->body('');
1024 $c->finalize_cookies;
1026 $c->engine->finalize_headers( $c, @_ );
1029 $c->response->{_finalized_headers} = 1;
1032 =head2 $c->finalize_output
1034 An alias for finalize_body.
1036 =head2 $c->finalize_read
1038 Finalizes the input after reading is complete.
1042 sub finalize_read { my $c = shift; $c->engine->finalize_read( $c, @_ ) }
1044 =head2 $c->finalize_uploads
1046 Finalizes uploads. Cleans up any temporary files.
1050 sub finalize_uploads { my $c = shift; $c->engine->finalize_uploads( $c, @_ ) }
1052 =head2 $c->get_action( $action, $namespace )
1054 Gets an action in a given namespace.
1058 sub get_action { my $c = shift; $c->dispatcher->get_action(@_) }
1060 =head2 $c->get_actions( $action, $namespace )
1062 Gets all actions of a given name in a namespace and all parent
1067 sub get_actions { my $c = shift; $c->dispatcher->get_actions( $c, @_ ) }
1069 =head2 handle_request( $class, @arguments )
1071 Called to handle each HTTP request.
1075 sub handle_request {
1076 my ( $class, @arguments ) = @_;
1078 # Always expect worst case!
1084 my $c = $class->prepare(@arguments);
1085 $c->{stats} = \@stats;
1087 return $c->finalize;
1090 if ( $class->debug ) {
1091 my $start = [gettimeofday];
1092 $status = &$handler;
1093 my $elapsed = tv_interval $start;
1094 $elapsed = sprintf '%f', $elapsed;
1095 my $av = sprintf '%.3f',
1096 ( $elapsed == 0 ? '??' : ( 1 / $elapsed ) );
1097 my $t = Text::SimpleTable->new( [ 64, 'Action' ], [ 9, 'Time' ] );
1099 for my $stat (@stats) { $t->row( $stat->[0], $stat->[1] ) }
1101 "Request took ${elapsed}s ($av/s)\n" . $t->draw );
1103 else { $status = &$handler }
1107 if ( my $error = $@ ) {
1109 $class->log->error(qq/Caught exception in engine "$error"/);
1113 $class->log->_flush() if $class->log->can('_flush');
1117 =head2 $c->prepare( @arguments )
1119 Creates a Catalyst context from an engine-specific request (Apache, CGI,
1125 my ( $class, @arguments ) = @_;
1127 $class->context_class( ref $class || $class ) unless $class->context_class;
1128 my $c = $class->context_class->new(
1132 request => $class->request_class->new(
1135 body_parameters => {},
1137 headers => HTTP::Headers->new,
1139 query_parameters => {},
1145 response => $class->response_class->new(
1149 headers => HTTP::Headers->new(),
1158 # For on-demand data
1159 $c->request->{_context} = $c;
1160 $c->response->{_context} = $c;
1161 weaken( $c->request->{_context} );
1162 weaken( $c->response->{_context} );
1165 my $secs = time - $START || 1;
1166 my $av = sprintf '%.3f', $COUNT / $secs;
1167 $c->log->debug('**********************************');
1168 $c->log->debug("* Request $COUNT ($av/s) [$$]");
1169 $c->log->debug('**********************************');
1170 $c->res->headers->header( 'X-Catalyst' => $Catalyst::VERSION );
1173 $c->prepare_request(@arguments);
1174 $c->prepare_connection;
1175 $c->prepare_query_parameters;
1176 $c->prepare_headers;
1177 $c->prepare_cookies;
1181 $c->prepare_body unless $c->config->{parse_on_demand};
1183 my $method = $c->req->method || '';
1184 my $path = $c->req->path || '';
1185 my $address = $c->req->address || '';
1187 $c->log->debug(qq/"$method" request for "$path" from "$address"/)
1195 =head2 $c->prepare_action
1201 sub prepare_action { my $c = shift; $c->dispatcher->prepare_action( $c, @_ ) }
1203 =head2 $c->prepare_body
1205 Prepares message body.
1212 # Do we run for the first time?
1213 return if defined $c->request->{_body};
1215 # Initialize on-demand data
1216 $c->engine->prepare_body( $c, @_ );
1217 $c->prepare_parameters;
1218 $c->prepare_uploads;
1220 if ( $c->debug && keys %{ $c->req->body_parameters } ) {
1221 my $t = Text::SimpleTable->new( [ 37, 'Key' ], [ 36, 'Value' ] );
1222 for my $key ( sort keys %{ $c->req->body_parameters } ) {
1223 my $param = $c->req->body_parameters->{$key};
1224 my $value = defined($param) ? $param : '';
1226 ref $value eq 'ARRAY' ? ( join ', ', @$value ) : $value );
1228 $c->log->debug( "Body Parameters are:\n" . $t->draw );
1232 =head2 $c->prepare_body_chunk( $chunk )
1234 Prepares a chunk of data before sending it to L<HTTP::Body>.
1238 sub prepare_body_chunk {
1240 $c->engine->prepare_body_chunk( $c, @_ );
1243 =head2 $c->prepare_body_parameters
1245 Prepares body parameters.
1249 sub prepare_body_parameters {
1251 $c->engine->prepare_body_parameters( $c, @_ );
1254 =head2 $c->prepare_connection
1256 Prepares connection.
1260 sub prepare_connection {
1262 $c->engine->prepare_connection( $c, @_ );
1265 =head2 $c->prepare_cookies
1271 sub prepare_cookies { my $c = shift; $c->engine->prepare_cookies( $c, @_ ) }
1273 =head2 $c->prepare_headers
1279 sub prepare_headers { my $c = shift; $c->engine->prepare_headers( $c, @_ ) }
1281 =head2 $c->prepare_parameters
1283 Prepares parameters.
1287 sub prepare_parameters {
1289 $c->prepare_body_parameters;
1290 $c->engine->prepare_parameters( $c, @_ );
1293 =head2 $c->prepare_path
1295 Prepares path and base.
1299 sub prepare_path { my $c = shift; $c->engine->prepare_path( $c, @_ ) }
1301 =head2 $c->prepare_query_parameters
1303 Prepares query parameters.
1307 sub prepare_query_parameters {
1310 $c->engine->prepare_query_parameters( $c, @_ );
1312 if ( $c->debug && keys %{ $c->request->query_parameters } ) {
1313 my $t = Text::SimpleTable->new( [ 37, 'Key' ], [ 36, 'Value' ] );
1314 for my $key ( sort keys %{ $c->req->query_parameters } ) {
1315 my $param = $c->req->query_parameters->{$key};
1316 my $value = defined($param) ? $param : '';
1318 ref $value eq 'ARRAY' ? ( join ', ', @$value ) : $value );
1320 $c->log->debug( "Query Parameters are:\n" . $t->draw );
1324 =head2 $c->prepare_read
1326 Prepares the input for reading.
1330 sub prepare_read { my $c = shift; $c->engine->prepare_read( $c, @_ ) }
1332 =head2 $c->prepare_request
1334 Prepares the engine request.
1338 sub prepare_request { my $c = shift; $c->engine->prepare_request( $c, @_ ) }
1340 =head2 $c->prepare_uploads
1346 sub prepare_uploads {
1349 $c->engine->prepare_uploads( $c, @_ );
1351 if ( $c->debug && keys %{ $c->request->uploads } ) {
1352 my $t = Text::SimpleTable->new(
1358 for my $key ( sort keys %{ $c->request->uploads } ) {
1359 my $upload = $c->request->uploads->{$key};
1360 for my $u ( ref $upload eq 'ARRAY' ? @{$upload} : ($upload) ) {
1361 $t->row( $key, $u->filename, $u->type, $u->size );
1364 $c->log->debug( "File Uploads are:\n" . $t->draw );
1368 =head2 $c->prepare_write
1370 Prepares the output for writing.
1374 sub prepare_write { my $c = shift; $c->engine->prepare_write( $c, @_ ) }
1376 =head2 $c->request_class
1378 Returns or sets the request class.
1380 =head2 $c->response_class
1382 Returns or sets the response class.
1384 =head2 $c->read( [$maxlength] )
1386 Reads a chunk of data from the request body. This method is designed to
1387 be used in a while loop, reading C<$maxlength> bytes on every call.
1388 C<$maxlength> defaults to the size of the request if not specified.
1390 You have to set C<MyApp-E<gt>config-E<gt>{parse_on_demand}> to use this
1395 sub read { my $c = shift; return $c->engine->read( $c, @_ ) }
1403 sub run { my $c = shift; return $c->engine->run( $c, @_ ) }
1405 =head2 $c->set_action( $action, $code, $namespace, $attrs )
1407 Sets an action in a given namespace.
1411 sub set_action { my $c = shift; $c->dispatcher->set_action( $c, @_ ) }
1413 =head2 $c->setup_actions($component)
1415 Sets up actions for a component.
1419 sub setup_actions { my $c = shift; $c->dispatcher->setup_actions( $c, @_ ) }
1421 =head2 $c->setup_components
1427 sub setup_components {
1430 my $callback = sub {
1431 my ( $component, $context ) = @_;
1433 unless ( $component->isa('Catalyst::Component') ) {
1437 my $suffix = Catalyst::Utils::class2classsuffix($component);
1438 my $config = $class->config->{$suffix} || {};
1442 eval { $instance = $component->new( $context, $config ); };
1444 if ( my $error = $@ ) {
1448 Catalyst::Exception->throw( message =>
1449 qq/Couldn't instantiate component "$component", "$error"/ );
1452 Catalyst::Exception->throw( message =>
1453 qq/Couldn't instantiate component "$component", "new() didn't return a object"/
1455 unless ref $instance;
1459 eval "package $class;\n" . q!Module::Pluggable::Fast->import(
1460 name => '_catalyst_components',
1462 "$class\::Controller", "$class\::C",
1463 "$class\::Model", "$class\::M",
1464 "$class\::View", "$class\::V"
1466 callback => $callback
1470 if ( my $error = $@ ) {
1474 Catalyst::Exception->throw(
1475 message => qq/Couldn't load components "$error"/ );
1478 for my $component ( $class->_catalyst_components($class) ) {
1479 $class->components->{ ref $component || $component } = $component;
1483 =head2 $c->setup_dispatcher
1489 sub setup_dispatcher {
1490 my ( $class, $dispatcher ) = @_;
1493 $dispatcher = 'Catalyst::Dispatcher::' . $dispatcher;
1496 if ( $ENV{CATALYST_DISPATCHER} ) {
1497 $dispatcher = 'Catalyst::Dispatcher::' . $ENV{CATALYST_DISPATCHER};
1500 if ( $ENV{ uc($class) . '_DISPATCHER' } ) {
1502 'Catalyst::Dispatcher::' . $ENV{ uc($class) . '_DISPATCHER' };
1505 unless ($dispatcher) {
1506 $dispatcher = $class->dispatcher_class;
1509 $dispatcher->require;
1512 Catalyst::Exception->throw(
1513 message => qq/Couldn't load dispatcher "$dispatcher", "$@"/ );
1516 # dispatcher instance
1517 $class->dispatcher( $dispatcher->new );
1520 =head2 $c->setup_engine
1527 my ( $class, $engine ) = @_;
1530 $engine = 'Catalyst::Engine::' . $engine;
1533 if ( $ENV{CATALYST_ENGINE} ) {
1534 $engine = 'Catalyst::Engine::' . $ENV{CATALYST_ENGINE};
1537 if ( $ENV{ uc($class) . '_ENGINE' } ) {
1538 $engine = 'Catalyst::Engine::' . $ENV{ uc($class) . '_ENGINE' };
1541 if ( !$engine && $ENV{MOD_PERL} ) {
1543 # create the apache method
1546 *{"$class\::apache"} = sub { shift->engine->apache };
1549 my ( $software, $version ) =
1550 $ENV{MOD_PERL} =~ /^(\S+)\/(\d+(?:[\.\_]\d+)+)/;
1553 $version =~ s/(\.[^.]+)\./$1/g;
1555 if ( $software eq 'mod_perl' ) {
1557 if ( $version >= 1.99922 ) {
1558 $engine = 'Catalyst::Engine::Apache2::MP20';
1561 elsif ( $version >= 1.9901 ) {
1562 $engine = 'Catalyst::Engine::Apache2::MP19';
1565 elsif ( $version >= 1.24 ) {
1566 $engine = 'Catalyst::Engine::Apache::MP13';
1570 Catalyst::Exception->throw( message =>
1571 qq/Unsupported mod_perl version: $ENV{MOD_PERL}/ );
1574 # install the correct mod_perl handler
1575 if ( $version >= 1.9901 ) {
1576 *handler = sub : method {
1577 shift->handle_request(@_);
1581 *handler = sub ($$) { shift->handle_request(@_) };
1586 elsif ( $software eq 'Zeus-Perl' ) {
1587 $engine = 'Catalyst::Engine::Zeus';
1591 Catalyst::Exception->throw(
1592 message => qq/Unsupported mod_perl: $ENV{MOD_PERL}/ );
1597 $engine = $class->engine_class;
1603 Catalyst::Exception->throw( message =>
1604 qq/Couldn't load engine "$engine" (maybe you forgot to install it?), "$@"/
1608 # check for old engines that are no longer compatible
1610 if ( $engine->isa('Catalyst::Engine::Apache')
1611 && !Catalyst::Engine::Apache->VERSION )
1616 elsif ( $engine->isa('Catalyst::Engine::Server::Base')
1617 && Catalyst::Engine::Server->VERSION le '0.02' )
1622 elsif ($engine->isa('Catalyst::Engine::HTTP::POE')
1623 && $engine->VERSION eq '0.01' )
1628 elsif ($engine->isa('Catalyst::Engine::Zeus')
1629 && $engine->VERSION eq '0.01' )
1635 Catalyst::Exception->throw( message =>
1636 qq/Engine "$engine" is not supported by this version of Catalyst/
1641 $class->engine( $engine->new );
1644 =head2 $c->setup_home
1646 Sets up the home directory.
1651 my ( $class, $home ) = @_;
1653 if ( $ENV{CATALYST_HOME} ) {
1654 $home = $ENV{CATALYST_HOME};
1657 if ( $ENV{ uc($class) . '_HOME' } ) {
1658 $home = $ENV{ uc($class) . '_HOME' };
1662 $home = Catalyst::Utils::home($class);
1666 $class->config->{home} ||= $home;
1667 $class->config->{root} ||= dir($home)->subdir('root');
1671 =head2 $c->setup_log
1678 my ( $class, $debug ) = @_;
1680 unless ( $class->log ) {
1681 $class->log( Catalyst::Log->new );
1684 my $app_flag = Catalyst::Utils::class2env($class) . '_DEBUG';
1687 ( defined( $ENV{CATALYST_DEBUG} ) || defined( $ENV{$app_flag} ) )
1688 ? ( $ENV{CATALYST_DEBUG} || $ENV{$app_flag} )
1693 *{"$class\::debug"} = sub { 1 };
1694 $class->log->debug('Debug messages enabled');
1698 =head2 $c->setup_plugins
1705 my ( $class, $plugins ) = @_;
1708 for my $plugin ( reverse @$plugins ) {
1710 $plugin = "Catalyst::Plugin::$plugin";
1715 Catalyst::Exception->throw(
1716 message => qq/Couldn't load plugin "$plugin", "$@"/ );
1721 unshift @{"$class\::ISA"}, $plugin;
1730 =head2 $c->write( $data )
1732 Writes $data to the output stream. When using this method directly, you
1733 will need to manually set the C<Content-Length> header to the length of
1734 your output data, if known.
1741 # Finalize headers if someone manually writes output
1742 $c->finalize_headers;
1744 return $c->engine->write( $c, @_ );
1749 Returns the Catalyst version number. Mostly useful for "powered by"
1750 messages in template systems.
1754 sub version { return $Catalyst::VERSION }
1756 =head1 INTERNAL ACTIONS
1758 Catalyst uses internal actions like C<_DISPATCH>, C<_BEGIN>, C<_AUTO>,
1759 C<_ACTION>, and C<_END>. These are by default not shown in the private
1760 action table, but you can make them visible with a config parameter.
1762 MyApp->config->{show_internal_actions} = 1;
1764 =head1 CASE SENSITIVITY
1766 By default Catalyst is not case sensitive, so C<MyApp::C::FOO::Bar> is
1767 mapped to C</foo/bar>. You can activate case sensitivity with a config
1770 MyApp->config->{case_sensitive} = 1;
1772 This causes C<MyApp::C::Foo::Bar> to map to C</Foo/Bar>.
1774 =head1 ON-DEMAND PARSER
1776 The request body is usually parsed at the beginning of a request,
1777 but if you want to handle input yourself or speed things up a bit,
1778 you can enable on-demand parsing with a config parameter.
1780 MyApp->config->{parse_on_demand} = 1;
1782 =head1 PROXY SUPPORT
1784 Many production servers operate using the common double-server approach,
1785 with a lightweight frontend web server passing requests to a larger
1786 backend server. An application running on the backend server must deal
1787 with two problems: the remote user always appears to be C<127.0.0.1> and
1788 the server's hostname will appear to be C<localhost> regardless of the
1789 virtual host that the user connected through.
1791 Catalyst will automatically detect this situation when you are running
1792 the frontend and backend servers on the same machine. The following
1793 changes are made to the request.
1795 $c->req->address is set to the user's real IP address, as read from
1796 the HTTP X-Forwarded-For header.
1798 The host value for $c->req->base and $c->req->uri is set to the real
1799 host, as read from the HTTP X-Forwarded-Host header.
1801 Obviously, your web server must support these headers for this to work.
1803 In a more complex server farm environment where you may have your
1804 frontend proxy server(s) on different machines, you will need to set a
1805 configuration option to tell Catalyst to read the proxied data from the
1808 MyApp->config->{using_frontend_proxy} = 1;
1810 If you do not wish to use the proxy support at all, you may set:
1812 MyApp->config->{ignore_frontend_proxy} = 1;
1814 =head1 THREAD SAFETY
1816 Catalyst has been tested under Apache 2's threading mpm_worker, mpm_winnt,
1817 and the standalone forking HTTP server on Windows. We believe the Catalyst
1818 core to be thread-safe.
1820 If you plan to operate in a threaded environment, remember that all other
1821 modules you are using must also be thread-safe. Some modules, most notably
1822 L<DBD::SQLite>, are not thread-safe.
1828 Join #catalyst on irc.perl.org.
1832 http://lists.rawmode.org/mailman/listinfo/catalyst
1833 http://lists.rawmode.org/mailman/listinfo/catalyst-dev
1837 http://catalyst.perl.org
1841 http://dev.catalyst.perl.org
1845 =head2 L<Catalyst::Manual> - The Catalyst Manual
1847 =head2 L<Catalyst::Component>, L<Catalyst::Base> - Base classes for components
1849 =head2 L<Catalyst::Engine> - Core engine
1851 =head2 L<Catalyst::Log> - Log class.
1853 =head2 L<Catalyst::Request> - Request object
1855 =head2 L<Catalyst::Response> - Response object
1857 =head2 L<Catalyst::Test> - The test suite.
1927 Sebastian Riedel, C<sri@oook.de>
1931 This library is free software, you can redistribute it and/or modify it under
1932 the same terms as Perl itself.