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/;
19 use Hash::Util qw/lock_hash/;
20 use HTTP::Headers::ReadOnly;
23 __PACKAGE__->mk_accessors(
24 qw/counter request response state action stack namespace/
27 attributes->import( __PACKAGE__, \&namespace, 'lvalue' );
29 sub depth { scalar @{ shift->stack || [] }; }
36 # For backwards compatibility
37 *finalize_output = \&finalize_body;
42 our $RECURSION = 1000;
43 our $DETACH = "catalyst_detach\n";
45 require Module::Pluggable::Fast;
47 # Helper script generation
48 our $CATALYST_SCRIPT_GEN = 11;
50 __PACKAGE__->mk_classdata($_)
51 for qw/components arguments dispatcher engine log dispatcher_class
52 engine_class context_class request_class response_class/;
54 __PACKAGE__->dispatcher_class('Catalyst::Dispatcher');
55 __PACKAGE__->engine_class('Catalyst::Engine::CGI');
56 __PACKAGE__->request_class('Catalyst::Request');
57 __PACKAGE__->response_class('Catalyst::Response');
59 our $VERSION = '5.52';
62 my ( $class, @arguments ) = @_;
64 # We have to limit $class to Catalyst to avoid pushing Catalyst upon every
66 return unless $class eq 'Catalyst';
68 my $caller = caller(0);
70 unless ( $caller->isa('Catalyst') ) {
72 push @{"$caller\::ISA"}, $class;
75 $caller->arguments( [@arguments] );
81 Catalyst - The Elegant MVC Web Application Framework
85 # use the helper to start a new application
88 # add models, views, controllers
89 script/myapp_create.pl model Database DBIC dbi:SQLite:/path/to/db
90 script/myapp_create.pl view TT TT
91 script/myapp_create.pl controller Search
93 # built in testserver -- use -r to restart automatically on changes
94 script/myapp_server.pl
96 # command line testing interface
97 script/myapp_test.pl /yada
100 use Catalyst qw/-Debug/; # include plugins here as well
102 sub foo : Global { # called for /foo, /foo/1, /foo/1/2, etc.
103 my ( $self, $c, @args ) = @_; # args are qw/1 2/ for /foo/1/2
104 $c->stash->{template} = 'foo.tt'; # set the template
105 # lookup something from db -- stash vars are passed to TT
107 MyApp::Model::Database::Foo->search( { country => $args[0] } );
108 if ( $c->req->params->{bar} ) { # access GET or POST parameters
109 $c->forward( 'bar' ); # process another action
110 # do something else after forward returns
114 # The foo.tt TT template can use the stash data from the database
115 [% WHILE (item = data.next) %]
119 # called for /bar/of/soap, /bar/of/soap/10, etc.
120 sub bar : Path('/bar/of/soap') { ... }
122 # called for all actions, from the top-most controller downwards
124 my ( $self, $c ) = @_;
126 $c->res->redirect( '/login' ); # require login
127 return 0; # abort request and go immediately to end()
129 return 1; # success; carry on to next action
132 # called after all actions are finished
134 my ( $self, $c ) = @_;
135 if ( scalar @{ $c->error } ) { ... } # handle errors
136 return if $c->res->body; # already have a response
137 $c->forward( 'MyApp::View::TT' ); # render template
140 ### in MyApp/Controller/Foo.pm
141 # called for /foo/bar
142 sub bar : Local { ... }
144 # called for /blargle
145 sub blargle : Global { ... }
147 # an index action matches /foo, but not /foo/1, etc.
148 sub index : Private { ... }
150 ### in MyApp/Controller/Foo/Bar.pm
151 # called for /foo/bar/baz
152 sub baz : Local { ... }
154 # first MyApp auto is called, then Foo auto, then this
155 sub auto : Private { ... }
157 # powerful regular expression paths are also possible
158 sub details : Regex('^product/(\w+)/details$') {
159 my ( $self, $c ) = @_;
160 # extract the (\w+) from the URI
161 my $product = $c->req->snippets->[0];
164 See L<Catalyst::Manual::Intro> for additional information.
168 The key concept of Catalyst is DRY (Don't Repeat Yourself).
170 See L<Catalyst::Manual> for more documentation.
172 Catalyst plugins can be loaded by naming them as arguments to the "use
173 Catalyst" statement. Omit the C<Catalyst::Plugin::> prefix from the
174 plugin name, i.e., C<Catalyst::Plugin::My::Module> becomes
177 use Catalyst qw/My::Module/;
179 Special flags like C<-Debug> and C<-Engine> can also be specified as
180 arguments when Catalyst is loaded:
182 use Catalyst qw/-Debug My::Module/;
184 The position of plugins and flags in the chain is important, because
185 they are loaded in exactly the order in which they appear.
187 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];
216 =head2 Information about the current request
222 Returns a L<Catalyst::Action> object for the current action, which
223 stringifies to the action name. See L<Catalyst::Action>.
227 Returns the namespace of the current action, i.e., the uri prefix
228 corresponding to the controller of the current action. For example:
230 # in Controller::Foo::Bar
231 $c->namespace; # returns 'foo/bar';
237 Returns the current L<Catalyst::Request> object. See
238 L<Catalyst::Request>.
242 =head2 Processing and response to the current request
246 =item $c->forward( $action [, \@arguments ] )
248 =item $c->forward( $class, $method, [, \@arguments ] )
250 Forwards processing to a private action. If you give a class name but no
251 method, C<process()> is called. You may also optionally pass arguments
252 in an arrayref. The action will receive the arguments in C<@_> and
253 C<$c-E<gt>req-E<gt>args>. Upon returning from the function,
254 C<$c-E<gt>req-E<gt>args> will be restored to the previous values.
257 $c->forward('index');
258 $c->forward(qw/MyApp::Model::CDBI::Foo do_stuff/);
259 $c->forward('MyApp::View::TT');
263 sub forward { my $c = shift; $c->dispatcher->forward( $c, @_ ) }
265 =item $c->detach( $action [, \@arguments ] )
267 =item $c->detach( $class, $method, [, \@arguments ] )
269 The same as C<forward>, but doesn't return.
273 sub detach { my $c = shift; $c->dispatcher->detach( $c, @_ ) }
277 =item $c->error($error, ...)
279 =item $c->error($arrayref)
281 Returns an arrayref containing error messages.
283 my @error = @{ $c->error };
287 $c->error('Something bad happened');
298 my $error = ref $_[0] eq 'ARRAY' ? $_[0] : [@_];
299 push @{ $c->{error} }, @$error;
301 elsif ( defined $_[0] ) { $c->{error} = undef }
302 return $c->{error} || [];
309 Returns the current L<Catalyst::Response> object.
313 Returns a hashref to the stash, which may be used to store data and pass
314 it between components during a request. You can also set hash keys by
315 passing arguments. The stash is automatically sent to the view. The
316 stash is cleared at the end of a request; it cannot be used for
319 $c->stash->{foo} = $bar;
320 $c->stash( { moose => 'majestic', qux => 0 } );
321 $c->stash( bar => 1, gorch => 2 ); # equivalent to passing a hashref
323 # stash is automatically passed to the view for use in a template
324 $c->forward( 'MyApp::V::TT' );
331 my $stash = @_ > 1 ? {@_} : $_[0];
332 while ( my ( $key, $val ) = each %$stash ) {
333 $c->{stash}->{$key} = $val;
341 Contains the return value of the last executed action.
345 =head2 Component Accessors
349 =item $c->comp($name)
351 =item $c->component($name)
353 Gets a component object by name. This method is no longer recommended,
354 unless you want to get a specific component by full
355 class. C<$c-E<gt>controller>, C<$c-E<gt>model>, and C<$c-E<gt>view>
356 should be used instead.
367 my $appclass = ref $c || $c;
370 $name, "${appclass}::${name}",
371 map { "${appclass}::${_}::${name}" }
372 qw/Model M Controller C View V/
375 foreach my $try (@names) {
377 if ( exists $c->components->{$try} ) {
379 return $c->components->{$try};
383 foreach my $component ( keys %{ $c->components } ) {
385 return $c->components->{$component} if $component =~ /$name/i;
390 return sort keys %{ $c->components };
393 =item $c->controller($name)
395 Gets a L<Catalyst::Controller> instance by name.
397 $c->controller('Foo')->do_stuff;
402 my ( $c, $name ) = @_;
403 my $controller = $c->comp("Controller::$name");
404 return $controller if $controller;
405 return $c->comp("C::$name");
408 =item $c->model($name)
410 Gets a L<Catalyst::Model> instance by name.
412 $c->model('Foo')->do_stuff;
417 my ( $c, $name ) = @_;
418 my $model = $c->comp("Model::$name");
419 return $model if $model;
420 return $c->comp("M::$name");
423 =item $c->view($name)
425 Gets a L<Catalyst::View> instance by name.
427 $c->view('Foo')->do_stuff;
432 my ( $c, $name ) = @_;
433 my $view = $c->comp("View::$name");
434 return $view if $view;
435 return $c->comp("V::$name");
440 =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' });
452 Overload to enable debug messages (same as -Debug option).
460 Returns the dispatcher instance. Stringifies to class name. See
461 L<Catalyst::Dispatcher>.
465 Returns the engine instance. Stringifies to the class name. See
470 Returns the logging object instance. Unless it is already set, Catalyst
471 sets this up with a L<Catalyst::Log> object. To use your own log class:
473 $c->log( MyLogger->new );
474 $c->log->info( 'Now logging with my own logger!' );
476 Your log class should implement the methods described in the
477 L<Catalyst::Log> man page.
483 =head2 Utility methods
487 =item $c->path_to(@path)
489 Merges C<@path> with C<$c-E<gt>config-E<gt>{home}> and returns a
490 L<Path::Class> object.
494 $c->path_to( 'db', 'sqlite.db' );
499 my ( $c, @path ) = @_;
500 my $path = dir( $c->config->{home}, @path );
501 if ( -d $path ) { return $path }
502 else { return file( $c->config->{home}, @path ) }
505 =item $c->plugin( $name, $class, @args )
507 Helper method for plugins. It creates a classdata accessor/mutator and
508 loads and instantiates the given class.
510 MyApp->plugin( 'prototype', 'HTML::Prototype' );
512 $c->prototype->define_javascript_functions;
517 my ( $class, $name, $plugin, @args ) = @_;
520 if ( my $error = $UNIVERSAL::require::ERROR ) {
521 Catalyst::Exception->throw(
522 message => qq/Couldn't load instant plugin "$plugin", "$error"/ );
525 eval { $plugin->import };
526 $class->mk_classdata($name);
528 eval { $obj = $plugin->new(@args) };
531 Catalyst::Exception->throw( message =>
532 qq/Couldn't instantiate instant plugin "$plugin", "$@"/ );
536 $class->log->debug(qq/Initialized instant plugin "$plugin" as "$name"/)
542 Initializes the dispatcher and engine, loads any plugins, and loads the
543 model, view, and controller components. You may also specify an array
544 of plugins to load here, if you choose to not load them in the C<use
548 MyApp->setup( qw/-Debug/ );
553 my ( $class, @arguments ) = @_;
555 unless ( $class->isa('Catalyst') ) {
557 Catalyst::Exception->throw(
558 message => qq/'$class' does not inherit from Catalyst/ );
561 if ( $class->arguments ) {
562 @arguments = ( @arguments, @{ $class->arguments } );
568 foreach (@arguments) {
572 ( $flags->{log} ) ? 'debug,' . $flags->{log} : 'debug';
574 elsif (/^-(\w+)=?(.*)$/) {
575 $flags->{ lc $1 } = $2;
578 push @{ $flags->{plugins} }, $_;
582 $class->setup_log( delete $flags->{log} );
583 $class->setup_plugins( delete $flags->{plugins} );
584 $class->setup_dispatcher( delete $flags->{dispatcher} );
585 $class->setup_engine( delete $flags->{engine} );
586 $class->setup_home( delete $flags->{home} );
588 for my $flag ( sort keys %{$flags} ) {
590 if ( my $code = $class->can( 'setup_' . $flag ) ) {
591 &$code( $class, delete $flags->{$flag} );
594 $class->log->warn(qq/Unknown flag "$flag"/);
599 <<"EOF") if ( $ENV{CATALYST_SCRIPT_GEN} && ( $ENV{CATALYST_SCRIPT_GEN} < $Catalyst::CATALYST_SCRIPT_GEN ) );
600 You are running an old script!
602 Please update by running:
603 catalyst.pl -nonew -scripts $class
606 if ( $class->debug ) {
612 @plugins = grep { /^Catalyst::Plugin/ } @{"$class\::ISA"};
616 my $t = Text::SimpleTable->new(76);
617 $t->row($_) for @plugins;
618 $class->log->debug( "Loaded plugins:\n" . $t->draw );
621 my $dispatcher = $class->dispatcher;
622 my $engine = $class->engine;
623 my $home = $class->config->{home};
625 $class->log->debug(qq/Loaded dispatcher "$dispatcher"/);
626 $class->log->debug(qq/Loaded engine "$engine"/);
630 ? $class->log->debug(qq/Found home "$home"/)
631 : $class->log->debug(qq/Home "$home" doesn't exist/)
632 : $class->log->debug(q/Couldn't find home/);
637 no warnings qw/redefine/;
638 local *setup = sub { };
642 # Initialize our data structure
643 $class->components( {} );
645 $class->setup_components;
647 if ( $class->debug ) {
648 my $t = Text::SimpleTable->new( [ 65, 'Class' ], [ 8, 'Type' ] );
649 for my $comp ( sort keys %{ $class->components } ) {
650 my $type = ref $class->components->{$comp} ? 'instance' : 'class';
651 $t->row( $comp, $type );
653 $class->log->debug( "Loaded components:\n" . $t->draw )
654 if ( keys %{ $class->components } );
657 # Add our self to components, since we are also a component
658 $class->components->{$class} = $class;
660 $class->setup_actions;
662 if ( $class->debug ) {
663 my $name = $class->config->{name} || 'Application';
664 $class->log->info("$name powered by Catalyst $Catalyst::VERSION");
666 $class->log->_flush() if $class->log->can('_flush');
669 =item $c->uri_for( $path, [ @args ] )
671 Merges path with C<$c-E<gt>request-E<gt>base> for absolute uri's and
672 with C<$c-E<gt>namespace> for relative uri's, then returns a
673 normalized L<URI> object. If any args are passed, they are added at the
679 my ( $c, $path, @args ) = @_;
680 my $base = $c->request->base->clone;
681 my $basepath = $base->path;
682 $basepath =~ s/\/$//;
684 my $namespace = $c->namespace;
686 # massage namespace, empty if absolute path
687 $namespace =~ s/^\///;
688 $namespace .= '/' if $namespace;
690 $namespace = '' if $path =~ /^\//;
693 # join args with '/', or a blank string
694 my $args = ( scalar @args ? '/' . join( '/', @args ) : '' );
695 return URI->new_abs( URI->new_abs( "$path$args", "$basepath$namespace" ),
699 =item $c->welcome_message
701 Returns the Catalyst welcome HTML page.
705 sub welcome_message {
707 my $name = $c->config->{name};
708 my $logo = $c->uri_for('/static/images/catalyst_logo.png');
709 my $prefix = Catalyst::Utils::appprefix( ref $c );
710 $c->response->content_type('text/html; charset=utf-8');
712 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
713 "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
714 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
716 <meta http-equiv="Content-Language" content="en" />
717 <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
718 <title>$name on Catalyst $VERSION</title>
719 <style type="text/css">
722 background-color: #eee;
731 background-color: #ccc;
732 border: 1px solid #aaa;
733 -moz-border-radius: 10px;
738 font-family: verdana, tahoma, sans-serif;
741 font-family: verdana, tahoma, sans-serif;
744 text-decoration: none;
746 border-bottom: 1px dotted #bbb;
748 :link:hover, :visited:hover {
761 background-color: #fff;
762 border: 1px solid #aaa;
763 -moz-border-radius: 10px;
789 <h1><span id="appname">$name</span> on <a href="http://catalyst.perl.org">Catalyst</a>
794 <img src="$logo" alt="Catalyst Logo" />
796 <p>Welcome to the wonderful world of Catalyst.
797 This <a href="http://en.wikipedia.org/wiki/MVC">MVC</a>
798 framework will make web development something you had
799 never expected it to be: Fun, rewarding and quick.</p>
800 <h2>What to do now?</h2>
801 <p>That really depends on what <b>you</b> want to do.
802 We do, however, provide you with a few starting points.</p>
803 <p>If you want to jump right into web development with Catalyst
804 you might want to check out the documentation.</p>
805 <pre><code>perldoc <a href="http://cpansearch.perl.org/dist/Catalyst/lib/Catalyst/Manual/Intro.pod">Catalyst::Manual::Intro</a>
806 perldoc <a href="http://cpansearch.perl.org/dist/Catalyst/lib/Catalyst/Manual.pod">Catalyst::Manual</a></code></pre>
807 <h2>What to do next?</h2>
808 <p>Next it's time to write an actual application. Use the
809 helper scripts to generate <a href="http://cpansearch.perl.org/search?query=Catalyst%3A%3AController%3A%3A&mode=all">controllers</a>,
810 <a href="http://cpansearch.perl.org/search?query=Catalyst%3A%3AModel%3A%3A&mode=all">models</a> and
811 <a href="http://cpansearch.perl.org/search?query=Catalyst%3A%3AView%3A%3A&mode=all">views</a>,
812 they can save you a lot of work.</p>
813 <pre><code>script/${prefix}_create.pl -help</code></pre>
814 <p>Also, be sure to check out the vast and growing
815 collection of <a href="http://cpansearch.perl.org/search?query=Catalyst%3A%3APlugin%3A%3A&mode=all">plugins for Catalyst on CPAN</a>,
816 you are likely to find what you need there.
820 <p>Catalyst has a very active community. Here are the main places to
821 get in touch with us.</p>
824 <a href="http://dev.catalyst.perl.org">Wiki</a>
827 <a href="http://lists.rawmode.org/mailman/listinfo/catalyst">Mailing-List</a>
830 <a href="irc://irc.perl.org/catalyst">IRC channel #catalyst on irc.perl.org</a>
833 <h2>In conclusion</h2>
834 <p>The Catalyst team hopes you will enjoy using Catalyst as much
835 as we enjoyed making it. Please contact us if you have ideas
836 for improvement or other feedback.</p>
846 =head1 INTERNAL METHODS
848 These methods are not meant to be used by end users.
852 =item $c->benchmark( $coderef )
854 Takes a coderef with arguments and returns elapsed time as float.
856 my ( $elapsed, $status ) = $c->benchmark( sub { return 1 } );
857 $c->log->info( sprintf "Processing took %f seconds", $elapsed );
864 my $time = [gettimeofday];
865 my @return = &$code(@_);
866 my $elapsed = tv_interval $time;
867 return wantarray ? ( $elapsed, @return ) : $elapsed;
872 Returns a hash of components.
874 =item $c->context_class
876 Returns or sets the context class.
880 Returns a hashref containing coderefs and execution counts (needed for
881 deep recursion detection).
885 Returns the number of actions on the current internal execution stack.
889 Dispatches a request to actions.
893 sub dispatch { my $c = shift; $c->dispatcher->dispatch( $c, @_ ) }
895 =item $c->dispatcher_class
897 Returns or sets the dispatcher class.
901 Returns a list of 2-element array references (name, structure) pairs
902 that will be dumped on the error page in debug mode.
908 [ Request => $c->req ], [ Response => $c->res ], [ Stash => $c->stash ],;
911 =item $c->engine_class
913 Returns or sets the engine class.
915 =item $c->execute( $class, $coderef )
917 Execute a coderef in given class and catch exceptions. Errors are available
923 my ( $c, $class, $code ) = @_;
924 $class = $c->components->{$class} || $class;
928 ( caller(0) )[0]->isa('Catalyst::Action')
935 $action = "/$action" unless $action =~ /\-\>/;
936 $c->counter->{"$code"}++;
938 if ( $c->counter->{"$code"} > $RECURSION ) {
939 my $error = qq/Deep recursion detected in "$action"/;
940 $c->log->error($error);
946 $action = "-> $action" if $callsub =~ /forward$/;
948 push( @{ $c->stack }, $code );
952 my ( $elapsed, @state ) =
953 $c->benchmark( $code, $class, $c, @{ $c->req->args } );
954 unless ( ( $code->name =~ /^_.*/ )
955 && ( !$c->config->{show_internal_actions} ) )
957 push @{ $c->{stats} }, [ $action, sprintf( '%fs', $elapsed ) ];
962 $c->state( &$code( $class, $c, @{ $c->req->args } ) || 0 );
965 pop( @{ $c->stack } );
967 if ( my $error = $@ ) {
969 if ( $error eq $DETACH ) { die $DETACH if $c->depth > 1 }
971 unless ( ref $error ) {
973 $error = qq/Caught exception "$error"/;
984 Finalizes the request.
991 for my $error ( @{ $c->error } ) {
992 $c->log->error($error);
995 $c->finalize_uploads;
998 if ( $#{ $c->error } >= 0 ) {
1002 $c->finalize_headers;
1005 if ( $c->request->method eq 'HEAD' ) {
1006 $c->response->body('');
1011 return $c->response->status;
1014 =item $c->finalize_body
1020 sub finalize_body { my $c = shift; $c->engine->finalize_body( $c, @_ ) }
1022 =item $c->finalize_cookies
1028 sub finalize_cookies {
1030 $c->engine->finalize_cookies( $c, @_ );
1031 lock_hash( %$_ ) for $c->res->cookies, values %{ $c->res->cookies };
1034 =item $c->finalize_error
1040 sub finalize_error { my $c = shift; $c->engine->finalize_error( $c, @_ ) }
1042 =item $c->finalize_headers
1048 sub finalize_headers {
1051 # Check if we already finalized headers
1052 return if $c->response->{_finalized_headers};
1055 if ( my $location = $c->response->redirect ) {
1056 $c->log->debug(qq/Redirecting to "$location"/) if $c->debug;
1057 $c->response->header( Location => $location );
1061 if ( $c->response->body && !$c->response->content_length ) {
1062 $c->response->content_length( bytes::length( $c->response->body ) );
1066 if ( $c->response->status =~ /^(1\d\d|[23]04)$/ ) {
1067 $c->response->headers->remove_header("Content-Length");
1068 $c->response->body('');
1071 $c->finalize_cookies;
1073 $c->engine->finalize_headers( $c, @_ );
1075 bless $c->response->headers, "HTTP::Headers::ReadOnly";
1078 $c->response->{_finalized_headers} = 1;
1081 =item $c->finalize_output
1083 An alias for finalize_body.
1085 =item $c->finalize_read
1087 Finalizes the input after reading is complete.
1091 sub finalize_read { my $c = shift; $c->engine->finalize_read( $c, @_ ) }
1093 =item $c->finalize_uploads
1095 Finalizes uploads. Cleans up any temporary files.
1099 sub finalize_uploads { my $c = shift; $c->engine->finalize_uploads( $c, @_ ) }
1101 =item $c->get_action( $action, $namespace )
1103 Gets an action in a given namespace.
1107 sub get_action { my $c = shift; $c->dispatcher->get_action(@_) }
1109 =item $c->get_actions( $action, $namespace )
1111 Gets all actions of a given name in a namespace and all parent
1116 sub get_actions { my $c = shift; $c->dispatcher->get_actions( $c, @_ ) }
1118 =item handle_request( $class, @arguments )
1120 Called to handle each HTTP request.
1124 sub handle_request {
1125 my ( $class, @arguments ) = @_;
1127 # Always expect worst case!
1133 my $c = $class->prepare(@arguments);
1134 $c->{stats} = \@stats;
1136 return $c->finalize;
1139 if ( $class->debug ) {
1141 ( $elapsed, $status ) = $class->benchmark($handler);
1142 $elapsed = sprintf '%f', $elapsed;
1143 my $av = sprintf '%.3f',
1144 ( $elapsed == 0 ? '??' : ( 1 / $elapsed ) );
1145 my $t = Text::SimpleTable->new( [ 64, 'Action' ], [ 9, 'Time' ] );
1147 for my $stat (@stats) { $t->row( $stat->[0], $stat->[1] ) }
1149 "Request took ${elapsed}s ($av/s)\n" . $t->draw );
1151 else { $status = &$handler }
1155 if ( my $error = $@ ) {
1157 $class->log->error(qq/Caught exception in engine "$error"/);
1161 $class->log->_flush() if $class->log->can('_flush');
1165 =item $c->prepare( @arguments )
1167 Creates a Catalyst context from an engine-specific request (Apache, CGI,
1173 my ( $class, @arguments ) = @_;
1175 $class->context_class( ref $class || $class ) unless $class->context_class;
1176 my $c = $class->context_class->new(
1180 request => $class->request_class->new(
1183 body_parameters => {},
1185 headers => HTTP::Headers->new,
1187 query_parameters => {},
1193 response => $class->response_class->new(
1197 headers => HTTP::Headers->new(),
1206 # For on-demand data
1207 $c->request->{_context} = $c;
1208 $c->response->{_context} = $c;
1209 weaken( $c->request->{_context} );
1210 weaken( $c->response->{_context} );
1213 my $secs = time - $START || 1;
1214 my $av = sprintf '%.3f', $COUNT / $secs;
1215 $c->log->debug('**********************************');
1216 $c->log->debug("* Request $COUNT ($av/s) [$$]");
1217 $c->log->debug('**********************************');
1218 $c->res->headers->header( 'X-Catalyst' => $Catalyst::VERSION );
1221 $c->prepare_request(@arguments);
1222 $c->prepare_connection;
1223 $c->prepare_query_parameters;
1224 $c->prepare_headers;
1225 $c->prepare_cookies;
1229 $c->prepare_body unless $c->config->{parse_on_demand};
1231 my $method = $c->req->method || '';
1232 my $path = $c->req->path || '';
1233 my $address = $c->req->address || '';
1235 $c->log->debug(qq/"$method" request for "$path" from "$address"/)
1243 =item $c->prepare_action
1249 sub prepare_action { my $c = shift; $c->dispatcher->prepare_action( $c, @_ ) }
1251 =item $c->prepare_body
1253 Prepares message body.
1260 # Do we run for the first time?
1261 return if defined $c->request->{_body};
1263 # Initialize on-demand data
1264 $c->engine->prepare_body( $c, @_ );
1265 $c->prepare_parameters;
1266 $c->prepare_uploads;
1268 if ( $c->debug && keys %{ $c->req->body_parameters } ) {
1269 my $t = Text::SimpleTable->new( [ 37, 'Key' ], [ 36, 'Value' ] );
1270 for my $key ( sort keys %{ $c->req->body_parameters } ) {
1271 my $param = $c->req->body_parameters->{$key};
1272 my $value = defined($param) ? $param : '';
1274 ref $value eq 'ARRAY' ? ( join ', ', @$value ) : $value );
1276 $c->log->debug( "Body Parameters are:\n" . $t->draw );
1280 =item $c->prepare_body_chunk( $chunk )
1282 Prepares a chunk of data before sending it to L<HTTP::Body>.
1286 sub prepare_body_chunk {
1288 $c->engine->prepare_body_chunk( $c, @_ );
1291 =item $c->prepare_body_parameters
1293 Prepares body parameters.
1297 sub prepare_body_parameters {
1299 $c->engine->prepare_body_parameters( $c, @_ );
1302 =item $c->prepare_connection
1304 Prepares connection.
1308 sub prepare_connection {
1310 $c->engine->prepare_connection( $c, @_ );
1313 =item $c->prepare_cookies
1319 sub prepare_cookies { my $c = shift; $c->engine->prepare_cookies( $c, @_ ) }
1321 =item $c->prepare_headers
1327 sub prepare_headers { my $c = shift; $c->engine->prepare_headers( $c, @_ ) }
1329 =item $c->prepare_parameters
1331 Prepares parameters.
1335 sub prepare_parameters {
1337 $c->prepare_body_parameters;
1338 $c->engine->prepare_parameters( $c, @_ );
1341 =item $c->prepare_path
1343 Prepares path and base.
1347 sub prepare_path { my $c = shift; $c->engine->prepare_path( $c, @_ ) }
1349 =item $c->prepare_query_parameters
1351 Prepares query parameters.
1355 sub prepare_query_parameters {
1358 $c->engine->prepare_query_parameters( $c, @_ );
1360 if ( $c->debug && keys %{ $c->request->query_parameters } ) {
1361 my $t = Text::SimpleTable->new( [ 37, 'Key' ], [ 36, 'Value' ] );
1362 for my $key ( sort keys %{ $c->req->query_parameters } ) {
1363 my $param = $c->req->query_parameters->{$key};
1364 my $value = defined($param) ? $param : '';
1366 ref $value eq 'ARRAY' ? ( join ', ', @$value ) : $value );
1368 $c->log->debug( "Query Parameters are:\n" . $t->draw );
1372 =item $c->prepare_read
1374 Prepares the input for reading.
1378 sub prepare_read { my $c = shift; $c->engine->prepare_read( $c, @_ ) }
1380 =item $c->prepare_request
1382 Prepares the engine request.
1386 sub prepare_request { my $c = shift; $c->engine->prepare_request( $c, @_ ) }
1388 =item $c->prepare_uploads
1394 sub prepare_uploads {
1397 $c->engine->prepare_uploads( $c, @_ );
1399 if ( $c->debug && keys %{ $c->request->uploads } ) {
1400 my $t = Text::SimpleTable->new(
1406 for my $key ( sort keys %{ $c->request->uploads } ) {
1407 my $upload = $c->request->uploads->{$key};
1408 for my $u ( ref $upload eq 'ARRAY' ? @{$upload} : ($upload) ) {
1409 $t->row( $key, $u->filename, $u->type, $u->size );
1412 $c->log->debug( "File Uploads are:\n" . $t->draw );
1416 =item $c->prepare_write
1418 Prepares the output for writing.
1422 sub prepare_write { my $c = shift; $c->engine->prepare_write( $c, @_ ) }
1424 =item $c->request_class
1426 Returns or sets the request class.
1428 =item $c->response_class
1430 Returns or sets the response class.
1432 =item $c->read( [$maxlength] )
1434 Reads a chunk of data from the request body. This method is designed to
1435 be used in a while loop, reading C<$maxlength> bytes on every call.
1436 C<$maxlength> defaults to the size of the request if not specified.
1438 You have to set C<MyApp-E<gt>config-E<gt>{parse_on_demand}> to use this
1443 sub read { my $c = shift; return $c->engine->read( $c, @_ ) }
1451 sub run { my $c = shift; return $c->engine->run( $c, @_ ) }
1453 =item $c->set_action( $action, $code, $namespace, $attrs )
1455 Sets an action in a given namespace.
1459 sub set_action { my $c = shift; $c->dispatcher->set_action( $c, @_ ) }
1461 =item $c->setup_actions($component)
1463 Sets up actions for a component.
1467 sub setup_actions { my $c = shift; $c->dispatcher->setup_actions( $c, @_ ) }
1469 =item $c->setup_components
1475 sub setup_components {
1478 my $callback = sub {
1479 my ( $component, $context ) = @_;
1481 unless ( $component->isa('Catalyst::Component') ) {
1485 my $suffix = Catalyst::Utils::class2classsuffix($component);
1486 my $config = $class->config->{$suffix} || {};
1490 eval { $instance = $component->new( $context, $config ); };
1492 if ( my $error = $@ ) {
1496 Catalyst::Exception->throw( message =>
1497 qq/Couldn't instantiate component "$component", "$error"/ );
1500 Catalyst::Exception->throw( message =>
1501 qq/Couldn't instantiate component "$component", "new() didn't return a object"/
1503 unless ref $instance;
1508 Module::Pluggable::Fast->import(
1509 name => '_catalyst_components',
1511 "$class\::Controller", "$class\::C",
1512 "$class\::Model", "$class\::M",
1513 "$class\::View", "$class\::V"
1515 callback => $callback
1519 if ( my $error = $@ ) {
1523 Catalyst::Exception->throw(
1524 message => qq/Couldn't load components "$error"/ );
1527 for my $component ( $class->_catalyst_components($class) ) {
1528 $class->components->{ ref $component || $component } = $component;
1532 =item $c->setup_dispatcher
1538 sub setup_dispatcher {
1539 my ( $class, $dispatcher ) = @_;
1542 $dispatcher = 'Catalyst::Dispatcher::' . $dispatcher;
1545 if ( $ENV{CATALYST_DISPATCHER} ) {
1546 $dispatcher = 'Catalyst::Dispatcher::' . $ENV{CATALYST_DISPATCHER};
1549 if ( $ENV{ uc($class) . '_DISPATCHER' } ) {
1551 'Catalyst::Dispatcher::' . $ENV{ uc($class) . '_DISPATCHER' };
1554 unless ($dispatcher) {
1555 $dispatcher = $class->dispatcher_class;
1558 $dispatcher->require;
1561 Catalyst::Exception->throw(
1562 message => qq/Couldn't load dispatcher "$dispatcher", "$@"/ );
1565 # dispatcher instance
1566 $class->dispatcher( $dispatcher->new );
1569 =item $c->setup_engine
1576 my ( $class, $engine ) = @_;
1579 $engine = 'Catalyst::Engine::' . $engine;
1582 if ( $ENV{CATALYST_ENGINE} ) {
1583 $engine = 'Catalyst::Engine::' . $ENV{CATALYST_ENGINE};
1586 if ( $ENV{ uc($class) . '_ENGINE' } ) {
1587 $engine = 'Catalyst::Engine::' . $ENV{ uc($class) . '_ENGINE' };
1590 if ( !$engine && $ENV{MOD_PERL} ) {
1592 # create the apache method
1595 *{"$class\::apache"} = sub { shift->engine->apache };
1598 my ( $software, $version ) =
1599 $ENV{MOD_PERL} =~ /^(\S+)\/(\d+(?:[\.\_]\d+)+)/;
1602 $version =~ s/(\.[^.]+)\./$1/g;
1604 if ( $software eq 'mod_perl' ) {
1606 if ( $version >= 1.99922 ) {
1607 $engine = 'Catalyst::Engine::Apache2::MP20';
1610 elsif ( $version >= 1.9901 ) {
1611 $engine = 'Catalyst::Engine::Apache2::MP19';
1614 elsif ( $version >= 1.24 ) {
1615 $engine = 'Catalyst::Engine::Apache::MP13';
1619 Catalyst::Exception->throw( message =>
1620 qq/Unsupported mod_perl version: $ENV{MOD_PERL}/ );
1623 # install the correct mod_perl handler
1624 if ( $version >= 1.9901 ) {
1625 *handler = sub : method {
1626 shift->handle_request(@_);
1630 *handler = sub ($$) { shift->handle_request(@_) };
1635 elsif ( $software eq 'Zeus-Perl' ) {
1636 $engine = 'Catalyst::Engine::Zeus';
1640 Catalyst::Exception->throw(
1641 message => qq/Unsupported mod_perl: $ENV{MOD_PERL}/ );
1646 $engine = $class->engine_class;
1652 Catalyst::Exception->throw( message =>
1653 qq/Couldn't load engine "$engine" (maybe you forgot to install it?), "$@"/
1657 # check for old engines that are no longer compatible
1659 if ( $engine->isa('Catalyst::Engine::Apache')
1660 && !Catalyst::Engine::Apache->VERSION )
1665 elsif ( $engine->isa('Catalyst::Engine::Server::Base')
1666 && Catalyst::Engine::Server->VERSION le '0.02' )
1671 elsif ($engine->isa('Catalyst::Engine::HTTP::POE')
1672 && $engine->VERSION eq '0.01' )
1677 elsif ($engine->isa('Catalyst::Engine::Zeus')
1678 && $engine->VERSION eq '0.01' )
1684 Catalyst::Exception->throw( message =>
1685 qq/Engine "$engine" is not supported by this version of Catalyst/
1690 $class->engine( $engine->new );
1693 =item $c->setup_home
1695 Sets up the home directory.
1700 my ( $class, $home ) = @_;
1702 if ( $ENV{CATALYST_HOME} ) {
1703 $home = $ENV{CATALYST_HOME};
1706 if ( $ENV{ uc($class) . '_HOME' } ) {
1707 $home = $ENV{ uc($class) . '_HOME' };
1711 $home = Catalyst::Utils::home($class);
1715 $class->config->{home} ||= $home;
1716 $class->config->{root} ||= dir($home)->subdir('root');
1727 my ( $class, $debug ) = @_;
1729 unless ( $class->log ) {
1730 $class->log( Catalyst::Log->new );
1733 my $app_flag = Catalyst::Utils::class2env($class) . '_DEBUG';
1736 ( defined( $ENV{CATALYST_DEBUG} ) || defined( $ENV{$app_flag} ) )
1737 ? ( $ENV{CATALYST_DEBUG} || $ENV{$app_flag} )
1742 *{"$class\::debug"} = sub { 1 };
1743 $class->log->debug('Debug messages enabled');
1747 =item $c->setup_plugins
1754 my ( $class, $plugins ) = @_;
1757 for my $plugin ( reverse @$plugins ) {
1759 $plugin = "Catalyst::Plugin::$plugin";
1764 Catalyst::Exception->throw(
1765 message => qq/Couldn't load plugin "$plugin", "$@"/ );
1770 unshift @{"$class\::ISA"}, $plugin;
1779 =item $c->write( $data )
1781 Writes $data to the output stream. When using this method directly, you
1782 will need to manually set the C<Content-Length> header to the length of
1783 your output data, if known.
1785 Also note that any headers created after the write can no longer be added, and
1786 this includes cookies.
1793 # Finalize headers if someone manually writes output
1794 $c->finalize_headers;
1796 return $c->engine->write( $c, @_ );
1801 Returns the Catalyst version number. Mostly useful for "powered by"
1802 messages in template systems.
1806 sub version { return $Catalyst::VERSION }
1810 =head1 INTERNAL ACTIONS
1812 Catalyst uses internal actions like C<_DISPATCH>, C<_BEGIN>, C<_AUTO>,
1813 C<_ACTION>, and C<_END>. These are by default not shown in the private
1814 action table, but you can make them visible with a config parameter.
1816 MyApp->config->{show_internal_actions} = 1;
1818 =head1 CASE SENSITIVITY
1820 By default Catalyst is not case sensitive, so C<MyApp::C::FOO::Bar> is
1821 mapped to C</foo/bar>. You can activate case sensitivity with a config
1824 MyApp->config->{case_sensitive} = 1;
1826 This causes C<MyApp::C::Foo::Bar> to map to C</Foo/Bar>.
1828 =head1 ON-DEMAND PARSER
1830 The request body is usually parsed at the beginning of a request,
1831 but if you want to handle input yourself or speed things up a bit,
1832 you can enable on-demand parsing with a config parameter.
1834 MyApp->config->{parse_on_demand} = 1;
1836 =head1 PROXY SUPPORT
1838 Many production servers operate using the common double-server approach,
1839 with a lightweight frontend web server passing requests to a larger
1840 backend server. An application running on the backend server must deal
1841 with two problems: the remote user always appears to be C<127.0.0.1> and
1842 the server's hostname will appear to be C<localhost> regardless of the
1843 virtual host that the user connected through.
1845 Catalyst will automatically detect this situation when you are running
1846 the frontend and backend servers on the same machine. The following
1847 changes are made to the request.
1849 $c->req->address is set to the user's real IP address, as read from
1850 the HTTP X-Forwarded-For header.
1852 The host value for $c->req->base and $c->req->uri is set to the real
1853 host, as read from the HTTP X-Forwarded-Host header.
1855 Obviously, your web server must support these headers for this to work.
1857 In a more complex server farm environment where you may have your
1858 frontend proxy server(s) on different machines, you will need to set a
1859 configuration option to tell Catalyst to read the proxied data from the
1862 MyApp->config->{using_frontend_proxy} = 1;
1864 If you do not wish to use the proxy support at all, you may set:
1866 MyApp->config->{ignore_frontend_proxy} = 1;
1868 =head1 THREAD SAFETY
1870 Catalyst has been tested under Apache 2's threading mpm_worker, mpm_winnt,
1871 and the standalone forking HTTP server on Windows. We believe the Catalyst
1872 core to be thread-safe.
1874 If you plan to operate in a threaded environment, remember that all other
1875 modules you are using must also be thread-safe. Some modules, most notably
1876 L<DBD::SQLite>, are not thread-safe.
1882 Join #catalyst on irc.perl.org.
1886 http://lists.rawmode.org/mailman/listinfo/catalyst
1887 http://lists.rawmode.org/mailman/listinfo/catalyst-dev
1891 http://catalyst.perl.org
1895 http://dev.catalyst.perl.org
1901 =item L<Catalyst::Manual> - The Catalyst Manual
1903 =item L<Catalyst::Component>, L<Catalyst::Base> - Base classes for components
1905 =item L<Catalyst::Engine> - Core engine
1907 =item L<Catalyst::Log> - Log class.
1909 =item L<Catalyst::Request> - Request object
1911 =item L<Catalyst::Response> - Response object
1913 =item L<Catalyst::Test> - The test suite.
1983 Sebastian Riedel, C<sri@oook.de>
1987 This library is free software, you can redistribute it and/or modify it under
1988 the same terms as Perl itself.