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/;
22 require Catalyst::Helper;
23 require Catalyst::PAR;
24 require Catalyst::Build;
25 require Catalyst::Test;
27 require Catalyst::Engine::HTTP;
28 require Catalyst::Engine::CGI;
30 require Catalyst::Controller;
31 require Catalyst::Model;
32 require Catalyst::View;
34 __PACKAGE__->mk_accessors(
35 qw/counter request response state action stack namespace/
38 attributes->import( __PACKAGE__, \&namespace, 'lvalue' );
40 sub depth { scalar @{ shift->stack || [] }; }
47 # For backwards compatibility
48 *finalize_output = \&finalize_body;
53 our $RECURSION = 1000;
54 our $DETACH = "catalyst_detach\n";
56 require Module::Pluggable::Fast;
58 # Helper script generation
59 our $CATALYST_SCRIPT_GEN = 18;
61 __PACKAGE__->mk_classdata($_)
62 for qw/components arguments dispatcher engine log dispatcher_class
63 engine_class context_class request_class response_class/;
65 __PACKAGE__->dispatcher_class('Catalyst::Dispatcher');
66 __PACKAGE__->engine_class('Catalyst::Engine::CGI');
67 __PACKAGE__->request_class('Catalyst::Request');
68 __PACKAGE__->response_class('Catalyst::Response');
70 our $VERSION = '5.57';
73 my ( $class, @arguments ) = @_;
75 # We have to limit $class to Catalyst to avoid pushing Catalyst upon every
77 return unless $class eq 'Catalyst';
79 my $caller = caller(0);
81 unless ( $caller->isa('Catalyst') ) {
83 push @{"$caller\::ISA"}, $class;
86 $caller->arguments( [@arguments] );
92 Catalyst - The Elegant MVC Web Application Framework
96 # use the helper to start a new application
99 # add models, views, controllers
100 script/myapp_create.pl model Database DBIC dbi:SQLite:/path/to/db
101 script/myapp_create.pl view TT TT
102 script/myapp_create.pl controller Search
104 # built in testserver -- use -r to restart automatically on changes
105 script/myapp_server.pl
107 # command line testing interface
108 script/myapp_test.pl /yada
111 use Catalyst qw/-Debug/; # include plugins here as well
113 sub foo : Global { # called for /foo, /foo/1, /foo/1/2, etc.
114 my ( $self, $c, @args ) = @_; # args are qw/1 2/ for /foo/1/2
115 $c->stash->{template} = 'foo.tt'; # set the template
116 # lookup something from db -- stash vars are passed to TT
118 MyApp::Model::Database::Foo->search( { country => $args[0] } );
119 if ( $c->req->params->{bar} ) { # access GET or POST parameters
120 $c->forward( 'bar' ); # process another action
121 # do something else after forward returns
125 # The foo.tt TT template can use the stash data from the database
126 [% WHILE (item = data.next) %]
130 # called for /bar/of/soap, /bar/of/soap/10, etc.
131 sub bar : Path('/bar/of/soap') { ... }
133 # called for all actions, from the top-most controller downwards
135 my ( $self, $c ) = @_;
137 $c->res->redirect( '/login' ); # require login
138 return 0; # abort request and go immediately to end()
140 return 1; # success; carry on to next action
143 # called after all actions are finished
145 my ( $self, $c ) = @_;
146 if ( scalar @{ $c->error } ) { ... } # handle errors
147 return if $c->res->body; # already have a response
148 $c->forward( 'MyApp::View::TT' ); # render template
151 ### in MyApp/Controller/Foo.pm
152 # called for /foo/bar
153 sub bar : Local { ... }
155 # called for /blargle
156 sub blargle : Global { ... }
158 # an index action matches /foo, but not /foo/1, etc.
159 sub index : Private { ... }
161 ### in MyApp/Controller/Foo/Bar.pm
162 # called for /foo/bar/baz
163 sub baz : Local { ... }
165 # first MyApp auto is called, then Foo auto, then this
166 sub auto : Private { ... }
168 # powerful regular expression paths are also possible
169 sub details : Regex('^product/(\w+)/details$') {
170 my ( $self, $c ) = @_;
171 # extract the (\w+) from the URI
172 my $product = $c->req->snippets->[0];
175 See L<Catalyst::Manual::Intro> for additional information.
179 The key concept of Catalyst is DRY (Don't Repeat Yourself).
181 See L<Catalyst::Manual> for more documentation.
183 Catalyst plugins can be loaded by naming them as arguments to the "use
184 Catalyst" statement. Omit the C<Catalyst::Plugin::> prefix from the
185 plugin name, i.e., C<Catalyst::Plugin::My::Module> becomes
188 use Catalyst qw/My::Module/;
190 Special flags like C<-Debug> and C<-Engine> can also be specified as
191 arguments when Catalyst is loaded:
193 use Catalyst qw/-Debug My::Module/;
195 The position of plugins and flags in the chain is important, because
196 they are loaded in exactly the order in which they appear.
198 The following flags are supported:
204 Enables debug output.
208 Forces Catalyst to use a specific engine. Omit the
209 C<Catalyst::Engine::> prefix of the engine name, i.e.:
211 use Catalyst qw/-Engine=CGI/;
215 Forces Catalyst to use a specific home directory, e.g.:
217 use Catalyst qw[-Home=/usr/sri];
227 =head2 Information about the current request
233 Returns a L<Catalyst::Action> object for the current action, which
234 stringifies to the action name. See L<Catalyst::Action>.
238 Returns the namespace of the current action, i.e., the uri prefix
239 corresponding to the controller of the current action. For example:
241 # in Controller::Foo::Bar
242 $c->namespace; # returns 'foo/bar';
248 Returns the current L<Catalyst::Request> object. See
249 L<Catalyst::Request>.
253 =head2 Processing and response to the current request
257 =item $c->forward( $action [, \@arguments ] )
259 =item $c->forward( $class, $method, [, \@arguments ] )
261 Forwards processing to a private action. If you give a class name but no
262 method, C<process()> is called. You may also optionally pass arguments
263 in an arrayref. The action will receive the arguments in C<@_> and
264 C<$c-E<gt>req-E<gt>args>. Upon returning from the function,
265 C<$c-E<gt>req-E<gt>args> will be restored to the previous values.
268 $c->forward('index');
269 $c->forward(qw/MyApp::Model::CDBI::Foo do_stuff/);
270 $c->forward('MyApp::View::TT');
274 sub forward { my $c = shift; $c->dispatcher->forward( $c, @_ ) }
276 =item $c->detach( $action [, \@arguments ] )
278 =item $c->detach( $class, $method, [, \@arguments ] )
280 The same as C<forward>, but doesn't return.
284 sub detach { my $c = shift; $c->dispatcher->detach( $c, @_ ) }
288 =item $c->error($error, ...)
290 =item $c->error($arrayref)
292 Returns an arrayref containing error messages. If Catalyst encounters an
293 error while processing a request, it stores the error in $c->error. This
294 method should not be used to store non-fatal error messages.
296 my @error = @{ $c->error };
300 $c->error('Something bad happened');
302 Clear errors. You probably don't want to clear the errors unless you are
303 implementing a custom error screen.
312 my $error = ref $_[0] eq 'ARRAY' ? $_[0] : [@_];
313 push @{ $c->{error} }, @$error;
315 elsif ( defined $_[0] ) { $c->{error} = undef }
316 return $c->{error} || [];
323 Returns the current L<Catalyst::Response> object.
327 Returns a hashref to the stash, which may be used to store data and pass
328 it between components during a request. You can also set hash keys by
329 passing arguments. The stash is automatically sent to the view. The
330 stash is cleared at the end of a request; it cannot be used for
333 $c->stash->{foo} = $bar;
334 $c->stash( { moose => 'majestic', qux => 0 } );
335 $c->stash( bar => 1, gorch => 2 ); # equivalent to passing a hashref
337 # stash is automatically passed to the view for use in a template
338 $c->forward( 'MyApp::V::TT' );
345 my $stash = @_ > 1 ? {@_} : $_[0];
346 while ( my ( $key, $val ) = each %$stash ) {
347 $c->{stash}->{$key} = $val;
355 Contains the return value of the last executed action.
359 =head2 Component Accessors
363 =item $c->comp($name)
365 =item $c->component($name)
367 Gets a component object by name. This method is no longer recommended,
368 unless you want to get a specific component by full
369 class. C<$c-E<gt>controller>, C<$c-E<gt>model>, and C<$c-E<gt>view>
370 should be used instead.
381 my $appclass = ref $c || $c;
384 $name, "${appclass}::${name}",
385 map { "${appclass}::${_}::${name}" }
386 qw/Model M Controller C View V/
389 foreach my $try (@names) {
391 if ( exists $c->components->{$try} ) {
393 return $c->components->{$try};
397 foreach my $component ( keys %{ $c->components } ) {
399 return $c->components->{$component} if $component =~ /$name/i;
404 return sort keys %{ $c->components };
407 =item $c->controller($name)
409 Gets a L<Catalyst::Controller> instance by name.
411 $c->controller('Foo')->do_stuff;
416 my ( $c, $name ) = @_;
417 my $controller = $c->comp("Controller::$name");
418 return $controller if $controller;
419 return $c->comp("C::$name");
422 =item $c->model($name)
424 Gets a L<Catalyst::Model> instance by name.
426 $c->model('Foo')->do_stuff;
431 my ( $c, $name ) = @_;
432 my $model = $c->comp("Model::$name");
433 return $model if $model;
434 return $c->comp("M::$name");
437 =item $c->view($name)
439 Gets a L<Catalyst::View> instance by name.
441 $c->view('Foo')->do_stuff;
446 my ( $c, $name ) = @_;
447 my $view = $c->comp("View::$name");
448 return $view if $view;
449 return $c->comp("V::$name");
454 =head2 Class data and helper classes
460 Returns or takes a hashref containing the application's configuration.
462 __PACKAGE__->config({ db => 'dsn:SQLite:foo.db' });
466 Overload to enable debug messages (same as -Debug option).
474 Returns the dispatcher instance. Stringifies to class name. See
475 L<Catalyst::Dispatcher>.
479 Returns the engine instance. Stringifies to the class name. See
484 Returns the logging object instance. Unless it is already set, Catalyst
485 sets this up with a L<Catalyst::Log> object. To use your own log class:
487 $c->log( MyLogger->new );
488 $c->log->info( 'Now logging with my own logger!' );
490 Your log class should implement the methods described in the
491 L<Catalyst::Log> man page.
497 =head2 Utility methods
501 =item $c->path_to(@path)
503 Merges C<@path> with C<$c-E<gt>config-E<gt>{home}> and returns a
504 L<Path::Class> object.
508 $c->path_to( 'db', 'sqlite.db' );
513 my ( $c, @path ) = @_;
514 my $path = dir( $c->config->{home}, @path );
515 if ( -d $path ) { return $path }
516 else { return file( $c->config->{home}, @path ) }
519 =item $c->plugin( $name, $class, @args )
521 Helper method for plugins. It creates a classdata accessor/mutator and
522 loads and instantiates the given class.
524 MyApp->plugin( 'prototype', 'HTML::Prototype' );
526 $c->prototype->define_javascript_functions;
531 my ( $class, $name, $plugin, @args ) = @_;
534 if ( my $error = $UNIVERSAL::require::ERROR ) {
535 Catalyst::Exception->throw(
536 message => qq/Couldn't load instant plugin "$plugin", "$error"/ );
539 eval { $plugin->import };
540 $class->mk_classdata($name);
542 eval { $obj = $plugin->new(@args) };
545 Catalyst::Exception->throw( message =>
546 qq/Couldn't instantiate instant plugin "$plugin", "$@"/ );
550 $class->log->debug(qq/Initialized instant plugin "$plugin" as "$name"/)
556 Initializes the dispatcher and engine, loads any plugins, and loads the
557 model, view, and controller components. You may also specify an array
558 of plugins to load here, if you choose to not load them in the C<use
562 MyApp->setup( qw/-Debug/ );
567 my ( $class, @arguments ) = @_;
569 unless ( $class->isa('Catalyst') ) {
571 Catalyst::Exception->throw(
572 message => qq/'$class' does not inherit from Catalyst/ );
575 if ( $class->arguments ) {
576 @arguments = ( @arguments, @{ $class->arguments } );
582 foreach (@arguments) {
586 ( $flags->{log} ) ? 'debug,' . $flags->{log} : 'debug';
588 elsif (/^-(\w+)=?(.*)$/) {
589 $flags->{ lc $1 } = $2;
592 push @{ $flags->{plugins} }, $_;
596 $class->setup_log( delete $flags->{log} );
597 $class->setup_plugins( delete $flags->{plugins} );
598 $class->setup_dispatcher( delete $flags->{dispatcher} );
599 $class->setup_engine( delete $flags->{engine} );
600 $class->setup_home( delete $flags->{home} );
602 for my $flag ( sort keys %{$flags} ) {
604 if ( my $code = $class->can( 'setup_' . $flag ) ) {
605 &$code( $class, delete $flags->{$flag} );
608 $class->log->warn(qq/Unknown flag "$flag"/);
613 <<"EOF") if ( $ENV{CATALYST_SCRIPT_GEN} && ( $ENV{CATALYST_SCRIPT_GEN} < $Catalyst::CATALYST_SCRIPT_GEN ) );
614 You are running an old script!
616 Please update by running:
617 catalyst.pl -nonew -scripts $class
620 if ( $class->debug ) {
626 @plugins = grep { /^Catalyst::Plugin/ } @{"$class\::ISA"};
630 my $t = Text::SimpleTable->new(76);
631 $t->row($_) for @plugins;
632 $class->log->debug( "Loaded plugins:\n" . $t->draw );
635 my $dispatcher = $class->dispatcher;
636 my $engine = $class->engine;
637 my $home = $class->config->{home};
639 $class->log->debug(qq/Loaded dispatcher "$dispatcher"/);
640 $class->log->debug(qq/Loaded engine "$engine"/);
644 ? $class->log->debug(qq/Found home "$home"/)
645 : $class->log->debug(qq/Home "$home" doesn't exist/)
646 : $class->log->debug(q/Couldn't find home/);
651 no warnings qw/redefine/;
652 local *setup = sub { };
656 # Initialize our data structure
657 $class->components( {} );
659 $class->setup_components;
661 if ( $class->debug ) {
662 my $t = Text::SimpleTable->new( [ 65, 'Class' ], [ 8, 'Type' ] );
663 for my $comp ( sort keys %{ $class->components } ) {
664 my $type = ref $class->components->{$comp} ? 'instance' : 'class';
665 $t->row( $comp, $type );
667 $class->log->debug( "Loaded components:\n" . $t->draw )
668 if ( keys %{ $class->components } );
671 # Add our self to components, since we are also a component
672 $class->components->{$class} = $class;
674 $class->setup_actions;
676 if ( $class->debug ) {
677 my $name = $class->config->{name} || 'Application';
678 $class->log->info("$name powered by Catalyst $Catalyst::VERSION");
680 $class->log->_flush() if $class->log->can('_flush');
683 =item $c->uri_for( $path, [ @args ] )
685 Merges path with C<$c-E<gt>request-E<gt>base> for absolute uri's and
686 with C<$c-E<gt>namespace> for relative uri's, then returns a
687 normalized L<URI> object. If any args are passed, they are added at the
693 my ( $c, $path, @args ) = @_;
694 my $base = $c->request->base->clone;
695 my $basepath = $base->path;
696 $basepath =~ s/\/$//;
698 my $namespace = $c->namespace;
700 # massage namespace, empty if absolute path
701 $namespace =~ s/^\///;
702 $namespace .= '/' if $namespace;
704 $namespace = '' if $path =~ /^\//;
707 # join args with '/', or a blank string
708 my $args = ( scalar @args ? '/' . join( '/', @args ) : '' );
709 return URI->new_abs( URI->new_abs( "$path$args", "$basepath$namespace" ),
713 =item $c->welcome_message
715 Returns the Catalyst welcome HTML page.
719 sub welcome_message {
721 my $name = $c->config->{name};
722 my $logo = $c->uri_for('/static/images/catalyst_logo.png');
723 my $prefix = Catalyst::Utils::appprefix( ref $c );
724 $c->response->content_type('text/html; charset=utf-8');
726 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
727 "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
728 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
730 <meta http-equiv="Content-Language" content="en" />
731 <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
732 <title>$name on Catalyst $VERSION</title>
733 <style type="text/css">
736 background-color: #eee;
745 background-color: #ccc;
746 border: 1px solid #aaa;
747 -moz-border-radius: 10px;
752 font-family: verdana, tahoma, sans-serif;
755 font-family: verdana, tahoma, sans-serif;
758 text-decoration: none;
760 border-bottom: 1px dotted #bbb;
762 :link:hover, :visited:hover {
775 background-color: #fff;
776 border: 1px solid #aaa;
777 -moz-border-radius: 10px;
803 <h1><span id="appname">$name</span> on <a href="http://catalyst.perl.org">Catalyst</a>
808 <img src="$logo" alt="Catalyst Logo" />
810 <p>Welcome to the wonderful world of Catalyst.
811 This <a href="http://en.wikipedia.org/wiki/MVC">MVC</a>
812 framework will make web development something you had
813 never expected it to be: Fun, rewarding and quick.</p>
814 <h2>What to do now?</h2>
815 <p>That really depends on what <b>you</b> want to do.
816 We do, however, provide you with a few starting points.</p>
817 <p>If you want to jump right into web development with Catalyst
818 you might want to check out the documentation.</p>
819 <pre><code>perldoc <a href="http://cpansearch.perl.org/dist/Catalyst/lib/Catalyst/Manual/Intro.pod">Catalyst::Manual::Intro</a>
820 perldoc <a href="http://cpansearch.perl.org/dist/Catalyst/lib/Catalyst/Manual.pod">Catalyst::Manual</a></code></pre>
821 <h2>What to do next?</h2>
822 <p>Next it's time to write an actual application. Use the
823 helper scripts to generate <a href="http://cpansearch.perl.org/search?query=Catalyst%3A%3AController%3A%3A&mode=all">controllers</a>,
824 <a href="http://cpansearch.perl.org/search?query=Catalyst%3A%3AModel%3A%3A&mode=all">models</a> and
825 <a href="http://cpansearch.perl.org/search?query=Catalyst%3A%3AView%3A%3A&mode=all">views</a>,
826 they can save you a lot of work.</p>
827 <pre><code>script/${prefix}_create.pl -help</code></pre>
828 <p>Also, be sure to check out the vast and growing
829 collection of <a href="http://cpansearch.perl.org/search?query=Catalyst%3A%3APlugin%3A%3A&mode=all">plugins for Catalyst on CPAN</a>,
830 you are likely to find what you need there.
834 <p>Catalyst has a very active community. Here are the main places to
835 get in touch with us.</p>
838 <a href="http://dev.catalyst.perl.org">Wiki</a>
841 <a href="http://lists.rawmode.org/mailman/listinfo/catalyst">Mailing-List</a>
844 <a href="irc://irc.perl.org/catalyst">IRC channel #catalyst on irc.perl.org</a>
847 <h2>In conclusion</h2>
848 <p>The Catalyst team hopes you will enjoy using Catalyst as much
849 as we enjoyed making it. Please contact us if you have ideas
850 for improvement or other feedback.</p>
860 =head1 INTERNAL METHODS
862 These methods are not meant to be used by end users.
868 Returns a hash of components.
870 =item $c->context_class
872 Returns or sets the context class.
876 Returns a hashref containing coderefs and execution counts (needed for
877 deep recursion detection).
881 Returns the number of actions on the current internal execution stack.
885 Dispatches a request to actions.
889 sub dispatch { my $c = shift; $c->dispatcher->dispatch( $c, @_ ) }
891 =item $c->dispatcher_class
893 Returns or sets the dispatcher class.
897 Returns a list of 2-element array references (name, structure) pairs
898 that will be dumped on the error page in debug mode.
904 [ Request => $c->req ], [ Response => $c->res ], [ Stash => $c->stash ],;
907 =item $c->engine_class
909 Returns or sets the engine class.
911 =item $c->execute( $class, $coderef )
913 Execute a coderef in given class and catch exceptions. Errors are available
919 my ( $c, $class, $code ) = @_;
920 $class = $c->components->{$class} || $class;
924 ( caller(0) )[0]->isa('Catalyst::Action')
931 $action = "/$action" unless $action =~ /\-\>/;
932 $c->counter->{"$code"}++;
934 if ( $c->counter->{"$code"} > $RECURSION ) {
935 my $error = qq/Deep recursion detected in "$action"/;
936 $c->log->error($error);
942 $action = "-> $action" if $callsub =~ /forward$/;
944 push( @{ $c->stack }, $code );
947 $start = [gettimeofday] if $c->debug;
948 eval { $c->state( &$code( $class, $c, @{ $c->req->args } ) || 0 ) };
949 $elapsed = tv_interval($start) if $c->debug;
952 unless ( ( $code->name =~ /^_.*/ )
953 && ( !$c->config->{show_internal_actions} ) )
955 push @{ $c->{stats} }, [ $action, sprintf( '%fs', $elapsed ) ];
958 pop( @{ $c->stack } );
960 if ( my $error = $@ ) {
962 if ( $error eq $DETACH ) { die $DETACH if $c->depth > 1 }
964 unless ( ref $error ) {
966 $error = qq/Caught exception "$error"/;
977 Finalizes the request.
984 for my $error ( @{ $c->error } ) {
985 $c->log->error($error);
988 $c->finalize_uploads;
991 if ( $#{ $c->error } >= 0 ) {
995 $c->finalize_headers;
998 if ( $c->request->method eq 'HEAD' ) {
999 $c->response->body('');
1004 return $c->response->status;
1007 =item $c->finalize_body
1013 sub finalize_body { my $c = shift; $c->engine->finalize_body( $c, @_ ) }
1015 =item $c->finalize_cookies
1021 sub finalize_cookies { my $c = shift; $c->engine->finalize_cookies( $c, @_ ) }
1023 =item $c->finalize_error
1029 sub finalize_error { my $c = shift; $c->engine->finalize_error( $c, @_ ) }
1031 =item $c->finalize_headers
1037 sub finalize_headers {
1040 # Check if we already finalized headers
1041 return if $c->response->{_finalized_headers};
1044 if ( my $location = $c->response->redirect ) {
1045 $c->log->debug(qq/Redirecting to "$location"/) if $c->debug;
1046 $c->response->header( Location => $location );
1050 if ( $c->response->body && !$c->response->content_length ) {
1051 $c->response->content_length( bytes::length( $c->response->body ) );
1055 if ( $c->response->status =~ /^(1\d\d|[23]04)$/ ) {
1056 $c->response->headers->remove_header("Content-Length");
1057 $c->response->body('');
1060 $c->finalize_cookies;
1062 $c->engine->finalize_headers( $c, @_ );
1065 $c->response->{_finalized_headers} = 1;
1068 =item $c->finalize_output
1070 An alias for finalize_body.
1072 =item $c->finalize_read
1074 Finalizes the input after reading is complete.
1078 sub finalize_read { my $c = shift; $c->engine->finalize_read( $c, @_ ) }
1080 =item $c->finalize_uploads
1082 Finalizes uploads. Cleans up any temporary files.
1086 sub finalize_uploads { my $c = shift; $c->engine->finalize_uploads( $c, @_ ) }
1088 =item $c->get_action( $action, $namespace )
1090 Gets an action in a given namespace.
1094 sub get_action { my $c = shift; $c->dispatcher->get_action(@_) }
1096 =item $c->get_actions( $action, $namespace )
1098 Gets all actions of a given name in a namespace and all parent
1103 sub get_actions { my $c = shift; $c->dispatcher->get_actions( $c, @_ ) }
1105 =item handle_request( $class, @arguments )
1107 Called to handle each HTTP request.
1111 sub handle_request {
1112 my ( $class, @arguments ) = @_;
1114 # Always expect worst case!
1120 my $c = $class->prepare(@arguments);
1121 $c->{stats} = \@stats;
1123 return $c->finalize;
1126 if ( $class->debug ) {
1127 my $start = [gettimeofday];
1128 $status = &$handler;
1129 my $elapsed = tv_interval $start;
1130 $elapsed = sprintf '%f', $elapsed;
1131 my $av = sprintf '%.3f',
1132 ( $elapsed == 0 ? '??' : ( 1 / $elapsed ) );
1133 my $t = Text::SimpleTable->new( [ 64, 'Action' ], [ 9, 'Time' ] );
1135 for my $stat (@stats) { $t->row( $stat->[0], $stat->[1] ) }
1137 "Request took ${elapsed}s ($av/s)\n" . $t->draw );
1139 else { $status = &$handler }
1143 if ( my $error = $@ ) {
1145 $class->log->error(qq/Caught exception in engine "$error"/);
1149 $class->log->_flush() if $class->log->can('_flush');
1153 =item $c->prepare( @arguments )
1155 Creates a Catalyst context from an engine-specific request (Apache, CGI,
1161 my ( $class, @arguments ) = @_;
1163 $class->context_class( ref $class || $class ) unless $class->context_class;
1164 my $c = $class->context_class->new(
1168 request => $class->request_class->new(
1171 body_parameters => {},
1173 headers => HTTP::Headers->new,
1175 query_parameters => {},
1181 response => $class->response_class->new(
1185 headers => HTTP::Headers->new(),
1194 # For on-demand data
1195 $c->request->{_context} = $c;
1196 $c->response->{_context} = $c;
1197 weaken( $c->request->{_context} );
1198 weaken( $c->response->{_context} );
1201 my $secs = time - $START || 1;
1202 my $av = sprintf '%.3f', $COUNT / $secs;
1203 $c->log->debug('**********************************');
1204 $c->log->debug("* Request $COUNT ($av/s) [$$]");
1205 $c->log->debug('**********************************');
1206 $c->res->headers->header( 'X-Catalyst' => $Catalyst::VERSION );
1209 $c->prepare_request(@arguments);
1210 $c->prepare_connection;
1211 $c->prepare_query_parameters;
1212 $c->prepare_headers;
1213 $c->prepare_cookies;
1217 $c->prepare_body unless $c->config->{parse_on_demand};
1219 my $method = $c->req->method || '';
1220 my $path = $c->req->path || '';
1221 my $address = $c->req->address || '';
1223 $c->log->debug(qq/"$method" request for "$path" from "$address"/)
1231 =item $c->prepare_action
1237 sub prepare_action { my $c = shift; $c->dispatcher->prepare_action( $c, @_ ) }
1239 =item $c->prepare_body
1241 Prepares message body.
1248 # Do we run for the first time?
1249 return if defined $c->request->{_body};
1251 # Initialize on-demand data
1252 $c->engine->prepare_body( $c, @_ );
1253 $c->prepare_parameters;
1254 $c->prepare_uploads;
1256 if ( $c->debug && keys %{ $c->req->body_parameters } ) {
1257 my $t = Text::SimpleTable->new( [ 37, 'Key' ], [ 36, 'Value' ] );
1258 for my $key ( sort keys %{ $c->req->body_parameters } ) {
1259 my $param = $c->req->body_parameters->{$key};
1260 my $value = defined($param) ? $param : '';
1262 ref $value eq 'ARRAY' ? ( join ', ', @$value ) : $value );
1264 $c->log->debug( "Body Parameters are:\n" . $t->draw );
1268 =item $c->prepare_body_chunk( $chunk )
1270 Prepares a chunk of data before sending it to L<HTTP::Body>.
1274 sub prepare_body_chunk {
1276 $c->engine->prepare_body_chunk( $c, @_ );
1279 =item $c->prepare_body_parameters
1281 Prepares body parameters.
1285 sub prepare_body_parameters {
1287 $c->engine->prepare_body_parameters( $c, @_ );
1290 =item $c->prepare_connection
1292 Prepares connection.
1296 sub prepare_connection {
1298 $c->engine->prepare_connection( $c, @_ );
1301 =item $c->prepare_cookies
1307 sub prepare_cookies { my $c = shift; $c->engine->prepare_cookies( $c, @_ ) }
1309 =item $c->prepare_headers
1315 sub prepare_headers { my $c = shift; $c->engine->prepare_headers( $c, @_ ) }
1317 =item $c->prepare_parameters
1319 Prepares parameters.
1323 sub prepare_parameters {
1325 $c->prepare_body_parameters;
1326 $c->engine->prepare_parameters( $c, @_ );
1329 =item $c->prepare_path
1331 Prepares path and base.
1335 sub prepare_path { my $c = shift; $c->engine->prepare_path( $c, @_ ) }
1337 =item $c->prepare_query_parameters
1339 Prepares query parameters.
1343 sub prepare_query_parameters {
1346 $c->engine->prepare_query_parameters( $c, @_ );
1348 if ( $c->debug && keys %{ $c->request->query_parameters } ) {
1349 my $t = Text::SimpleTable->new( [ 37, 'Key' ], [ 36, 'Value' ] );
1350 for my $key ( sort keys %{ $c->req->query_parameters } ) {
1351 my $param = $c->req->query_parameters->{$key};
1352 my $value = defined($param) ? $param : '';
1354 ref $value eq 'ARRAY' ? ( join ', ', @$value ) : $value );
1356 $c->log->debug( "Query Parameters are:\n" . $t->draw );
1360 =item $c->prepare_read
1362 Prepares the input for reading.
1366 sub prepare_read { my $c = shift; $c->engine->prepare_read( $c, @_ ) }
1368 =item $c->prepare_request
1370 Prepares the engine request.
1374 sub prepare_request { my $c = shift; $c->engine->prepare_request( $c, @_ ) }
1376 =item $c->prepare_uploads
1382 sub prepare_uploads {
1385 $c->engine->prepare_uploads( $c, @_ );
1387 if ( $c->debug && keys %{ $c->request->uploads } ) {
1388 my $t = Text::SimpleTable->new(
1394 for my $key ( sort keys %{ $c->request->uploads } ) {
1395 my $upload = $c->request->uploads->{$key};
1396 for my $u ( ref $upload eq 'ARRAY' ? @{$upload} : ($upload) ) {
1397 $t->row( $key, $u->filename, $u->type, $u->size );
1400 $c->log->debug( "File Uploads are:\n" . $t->draw );
1404 =item $c->prepare_write
1406 Prepares the output for writing.
1410 sub prepare_write { my $c = shift; $c->engine->prepare_write( $c, @_ ) }
1412 =item $c->request_class
1414 Returns or sets the request class.
1416 =item $c->response_class
1418 Returns or sets the response class.
1420 =item $c->read( [$maxlength] )
1422 Reads a chunk of data from the request body. This method is designed to
1423 be used in a while loop, reading C<$maxlength> bytes on every call.
1424 C<$maxlength> defaults to the size of the request if not specified.
1426 You have to set C<MyApp-E<gt>config-E<gt>{parse_on_demand}> to use this
1431 sub read { my $c = shift; return $c->engine->read( $c, @_ ) }
1439 sub run { my $c = shift; return $c->engine->run( $c, @_ ) }
1441 =item $c->set_action( $action, $code, $namespace, $attrs )
1443 Sets an action in a given namespace.
1447 sub set_action { my $c = shift; $c->dispatcher->set_action( $c, @_ ) }
1449 =item $c->setup_actions($component)
1451 Sets up actions for a component.
1455 sub setup_actions { my $c = shift; $c->dispatcher->setup_actions( $c, @_ ) }
1457 =item $c->setup_components
1463 sub setup_components {
1466 my $callback = sub {
1467 my ( $component, $context ) = @_;
1469 unless ( $component->isa('Catalyst::Component') ) {
1473 my $suffix = Catalyst::Utils::class2classsuffix($component);
1474 my $config = $class->config->{$suffix} || {};
1478 eval { $instance = $component->new( $context, $config ); };
1480 if ( my $error = $@ ) {
1484 Catalyst::Exception->throw( message =>
1485 qq/Couldn't instantiate component "$component", "$error"/ );
1488 Catalyst::Exception->throw( message =>
1489 qq/Couldn't instantiate component "$component", "new() didn't return a object"/
1491 unless ref $instance;
1495 eval "package $class;\n" . q!Module::Pluggable::Fast->import(
1496 name => '_catalyst_components',
1498 "$class\::Controller", "$class\::C",
1499 "$class\::Model", "$class\::M",
1500 "$class\::View", "$class\::V"
1502 callback => $callback
1506 if ( my $error = $@ ) {
1510 Catalyst::Exception->throw(
1511 message => qq/Couldn't load components "$error"/ );
1514 for my $component ( $class->_catalyst_components($class) ) {
1515 $class->components->{ ref $component || $component } = $component;
1519 =item $c->setup_dispatcher
1525 sub setup_dispatcher {
1526 my ( $class, $dispatcher ) = @_;
1529 $dispatcher = 'Catalyst::Dispatcher::' . $dispatcher;
1532 if ( $ENV{CATALYST_DISPATCHER} ) {
1533 $dispatcher = 'Catalyst::Dispatcher::' . $ENV{CATALYST_DISPATCHER};
1536 if ( $ENV{ uc($class) . '_DISPATCHER' } ) {
1538 'Catalyst::Dispatcher::' . $ENV{ uc($class) . '_DISPATCHER' };
1541 unless ($dispatcher) {
1542 $dispatcher = $class->dispatcher_class;
1545 $dispatcher->require;
1548 Catalyst::Exception->throw(
1549 message => qq/Couldn't load dispatcher "$dispatcher", "$@"/ );
1552 # dispatcher instance
1553 $class->dispatcher( $dispatcher->new );
1556 =item $c->setup_engine
1563 my ( $class, $engine ) = @_;
1566 $engine = 'Catalyst::Engine::' . $engine;
1569 if ( $ENV{CATALYST_ENGINE} ) {
1570 $engine = 'Catalyst::Engine::' . $ENV{CATALYST_ENGINE};
1573 if ( $ENV{ uc($class) . '_ENGINE' } ) {
1574 $engine = 'Catalyst::Engine::' . $ENV{ uc($class) . '_ENGINE' };
1577 if ( !$engine && $ENV{MOD_PERL} ) {
1579 # create the apache method
1582 *{"$class\::apache"} = sub { shift->engine->apache };
1585 my ( $software, $version ) =
1586 $ENV{MOD_PERL} =~ /^(\S+)\/(\d+(?:[\.\_]\d+)+)/;
1589 $version =~ s/(\.[^.]+)\./$1/g;
1591 if ( $software eq 'mod_perl' ) {
1593 if ( $version >= 1.99922 ) {
1594 $engine = 'Catalyst::Engine::Apache2::MP20';
1597 elsif ( $version >= 1.9901 ) {
1598 $engine = 'Catalyst::Engine::Apache2::MP19';
1601 elsif ( $version >= 1.24 ) {
1602 $engine = 'Catalyst::Engine::Apache::MP13';
1606 Catalyst::Exception->throw( message =>
1607 qq/Unsupported mod_perl version: $ENV{MOD_PERL}/ );
1610 # install the correct mod_perl handler
1611 if ( $version >= 1.9901 ) {
1612 *handler = sub : method {
1613 shift->handle_request(@_);
1617 *handler = sub ($$) { shift->handle_request(@_) };
1622 elsif ( $software eq 'Zeus-Perl' ) {
1623 $engine = 'Catalyst::Engine::Zeus';
1627 Catalyst::Exception->throw(
1628 message => qq/Unsupported mod_perl: $ENV{MOD_PERL}/ );
1633 $engine = $class->engine_class;
1639 Catalyst::Exception->throw( message =>
1640 qq/Couldn't load engine "$engine" (maybe you forgot to install it?), "$@"/
1644 # check for old engines that are no longer compatible
1646 if ( $engine->isa('Catalyst::Engine::Apache')
1647 && !Catalyst::Engine::Apache->VERSION )
1652 elsif ( $engine->isa('Catalyst::Engine::Server::Base')
1653 && Catalyst::Engine::Server->VERSION le '0.02' )
1658 elsif ($engine->isa('Catalyst::Engine::HTTP::POE')
1659 && $engine->VERSION eq '0.01' )
1664 elsif ($engine->isa('Catalyst::Engine::Zeus')
1665 && $engine->VERSION eq '0.01' )
1671 Catalyst::Exception->throw( message =>
1672 qq/Engine "$engine" is not supported by this version of Catalyst/
1677 $class->engine( $engine->new );
1680 =item $c->setup_home
1682 Sets up the home directory.
1687 my ( $class, $home ) = @_;
1689 if ( $ENV{CATALYST_HOME} ) {
1690 $home = $ENV{CATALYST_HOME};
1693 if ( $ENV{ uc($class) . '_HOME' } ) {
1694 $home = $ENV{ uc($class) . '_HOME' };
1698 $home = Catalyst::Utils::home($class);
1702 $class->config->{home} ||= $home;
1703 $class->config->{root} ||= dir($home)->subdir('root');
1714 my ( $class, $debug ) = @_;
1716 unless ( $class->log ) {
1717 $class->log( Catalyst::Log->new );
1720 my $app_flag = Catalyst::Utils::class2env($class) . '_DEBUG';
1723 ( defined( $ENV{CATALYST_DEBUG} ) || defined( $ENV{$app_flag} ) )
1724 ? ( $ENV{CATALYST_DEBUG} || $ENV{$app_flag} )
1729 *{"$class\::debug"} = sub { 1 };
1730 $class->log->debug('Debug messages enabled');
1734 =item $c->setup_plugins
1741 my ( $class, $plugins ) = @_;
1744 for my $plugin ( reverse @$plugins ) {
1746 $plugin = "Catalyst::Plugin::$plugin";
1751 Catalyst::Exception->throw(
1752 message => qq/Couldn't load plugin "$plugin", "$@"/ );
1757 unshift @{"$class\::ISA"}, $plugin;
1766 =item $c->write( $data )
1768 Writes $data to the output stream. When using this method directly, you
1769 will need to manually set the C<Content-Length> header to the length of
1770 your output data, if known.
1777 # Finalize headers if someone manually writes output
1778 $c->finalize_headers;
1780 return $c->engine->write( $c, @_ );
1785 Returns the Catalyst version number. Mostly useful for "powered by"
1786 messages in template systems.
1790 sub version { return $Catalyst::VERSION }
1794 =head1 INTERNAL ACTIONS
1796 Catalyst uses internal actions like C<_DISPATCH>, C<_BEGIN>, C<_AUTO>,
1797 C<_ACTION>, and C<_END>. These are by default not shown in the private
1798 action table, but you can make them visible with a config parameter.
1800 MyApp->config->{show_internal_actions} = 1;
1802 =head1 CASE SENSITIVITY
1804 By default Catalyst is not case sensitive, so C<MyApp::C::FOO::Bar> is
1805 mapped to C</foo/bar>. You can activate case sensitivity with a config
1808 MyApp->config->{case_sensitive} = 1;
1810 This causes C<MyApp::C::Foo::Bar> to map to C</Foo/Bar>.
1812 =head1 ON-DEMAND PARSER
1814 The request body is usually parsed at the beginning of a request,
1815 but if you want to handle input yourself or speed things up a bit,
1816 you can enable on-demand parsing with a config parameter.
1818 MyApp->config->{parse_on_demand} = 1;
1820 =head1 PROXY SUPPORT
1822 Many production servers operate using the common double-server approach,
1823 with a lightweight frontend web server passing requests to a larger
1824 backend server. An application running on the backend server must deal
1825 with two problems: the remote user always appears to be C<127.0.0.1> and
1826 the server's hostname will appear to be C<localhost> regardless of the
1827 virtual host that the user connected through.
1829 Catalyst will automatically detect this situation when you are running
1830 the frontend and backend servers on the same machine. The following
1831 changes are made to the request.
1833 $c->req->address is set to the user's real IP address, as read from
1834 the HTTP X-Forwarded-For header.
1836 The host value for $c->req->base and $c->req->uri is set to the real
1837 host, as read from the HTTP X-Forwarded-Host header.
1839 Obviously, your web server must support these headers for this to work.
1841 In a more complex server farm environment where you may have your
1842 frontend proxy server(s) on different machines, you will need to set a
1843 configuration option to tell Catalyst to read the proxied data from the
1846 MyApp->config->{using_frontend_proxy} = 1;
1848 If you do not wish to use the proxy support at all, you may set:
1850 MyApp->config->{ignore_frontend_proxy} = 1;
1852 =head1 THREAD SAFETY
1854 Catalyst has been tested under Apache 2's threading mpm_worker, mpm_winnt,
1855 and the standalone forking HTTP server on Windows. We believe the Catalyst
1856 core to be thread-safe.
1858 If you plan to operate in a threaded environment, remember that all other
1859 modules you are using must also be thread-safe. Some modules, most notably
1860 L<DBD::SQLite>, are not thread-safe.
1866 Join #catalyst on irc.perl.org.
1870 http://lists.rawmode.org/mailman/listinfo/catalyst
1871 http://lists.rawmode.org/mailman/listinfo/catalyst-dev
1875 http://catalyst.perl.org
1879 http://dev.catalyst.perl.org
1885 =item L<Catalyst::Manual> - The Catalyst Manual
1887 =item L<Catalyst::Component>, L<Catalyst::Base> - Base classes for components
1889 =item L<Catalyst::Engine> - Core engine
1891 =item L<Catalyst::Log> - Log class.
1893 =item L<Catalyst::Request> - Request object
1895 =item L<Catalyst::Response> - Response object
1897 =item L<Catalyst::Test> - The test suite.
1967 Sebastian Riedel, C<sri@oook.de>
1971 This library is free software, you can redistribute it and/or modify it under
1972 the same terms as Perl itself.