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 = 19;
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 $args =~ s/^\/// unless $path;
679 URI->new_abs( URI->new_abs( "$path$args", "$basepath$namespace" ), $base )
684 =head2 $c->welcome_message
686 Returns the Catalyst welcome HTML page.
690 sub welcome_message {
692 my $name = $c->config->{name};
693 my $logo = $c->uri_for('/static/images/catalyst_logo.png');
694 my $prefix = Catalyst::Utils::appprefix( ref $c );
695 $c->response->content_type('text/html; charset=utf-8');
697 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
698 "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
699 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
701 <meta http-equiv="Content-Language" content="en" />
702 <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
703 <title>$name on Catalyst $VERSION</title>
704 <style type="text/css">
707 background-color: #eee;
716 background-color: #ccc;
717 border: 1px solid #aaa;
718 -moz-border-radius: 10px;
723 font-family: verdana, tahoma, sans-serif;
726 font-family: verdana, tahoma, sans-serif;
729 text-decoration: none;
731 border-bottom: 1px dotted #bbb;
733 :link:hover, :visited:hover {
746 background-color: #fff;
747 border: 1px solid #aaa;
748 -moz-border-radius: 10px;
774 <h1><span id="appname">$name</span> on <a href="http://catalyst.perl.org">Catalyst</a>
779 <img src="$logo" alt="Catalyst Logo" />
781 <p>Welcome to the wonderful world of Catalyst.
782 This <a href="http://en.wikipedia.org/wiki/MVC">MVC</a>
783 framework will make web development something you had
784 never expected it to be: Fun, rewarding and quick.</p>
785 <h2>What to do now?</h2>
786 <p>That really depends on what <b>you</b> want to do.
787 We do, however, provide you with a few starting points.</p>
788 <p>If you want to jump right into web development with Catalyst
789 you might want to check out the documentation.</p>
790 <pre><code>perldoc <a href="http://cpansearch.perl.org/dist/Catalyst/lib/Catalyst/Manual/Intro.pod">Catalyst::Manual::Intro</a>
791 perldoc <a href="http://cpansearch.perl.org/dist/Catalyst/lib/Catalyst/Manual.pod">Catalyst::Manual</a></code></pre>
792 <h2>What to do next?</h2>
793 <p>Next it's time to write an actual application. Use the
794 helper scripts to generate <a href="http://cpansearch.perl.org/search?query=Catalyst%3A%3AController%3A%3A&mode=all">controllers</a>,
795 <a href="http://cpansearch.perl.org/search?query=Catalyst%3A%3AModel%3A%3A&mode=all">models</a> and
796 <a href="http://cpansearch.perl.org/search?query=Catalyst%3A%3AView%3A%3A&mode=all">views</a>,
797 they can save you a lot of work.</p>
798 <pre><code>script/${prefix}_create.pl -help</code></pre>
799 <p>Also, be sure to check out the vast and growing
800 collection of <a href="http://cpansearch.perl.org/search?query=Catalyst%3A%3APlugin%3A%3A&mode=all">plugins for Catalyst on CPAN</a>,
801 you are likely to find what you need there.
805 <p>Catalyst has a very active community. Here are the main places to
806 get in touch with us.</p>
809 <a href="http://dev.catalyst.perl.org">Wiki</a>
812 <a href="http://lists.rawmode.org/mailman/listinfo/catalyst">Mailing-List</a>
815 <a href="irc://irc.perl.org/catalyst">IRC channel #catalyst on irc.perl.org</a>
818 <h2>In conclusion</h2>
819 <p>The Catalyst team hopes you will enjoy using Catalyst as much
820 as we enjoyed making it. Please contact us if you have ideas
821 for improvement or other feedback.</p>
829 =head1 INTERNAL METHODS
831 These methods are not meant to be used by end users.
833 =head2 $c->components
835 Returns a hash of components.
837 =head2 $c->context_class
839 Returns or sets the context class.
843 Returns a hashref containing coderefs and execution counts (needed for
844 deep recursion detection).
848 Returns the number of actions on the current internal execution stack.
852 Dispatches a request to actions.
856 sub dispatch { my $c = shift; $c->dispatcher->dispatch( $c, @_ ) }
858 =head2 $c->dispatcher_class
860 Returns or sets the dispatcher class.
862 =head2 $c->dump_these
864 Returns a list of 2-element array references (name, structure) pairs
865 that will be dumped on the error page in debug mode.
871 [ Request => $c->req ], [ Response => $c->res ], [ Stash => $c->stash ],;
874 =head2 $c->engine_class
876 Returns or sets the engine class.
878 =head2 $c->execute( $class, $coderef )
880 Execute a coderef in given class and catch exceptions. Errors are available
886 my ( $c, $class, $code ) = @_;
887 $class = $c->components->{$class} || $class;
891 ( caller(0) )[0]->isa('Catalyst::Action')
898 $action = "/$action" unless $action =~ /\-\>/;
899 $c->counter->{"$code"}++;
901 if ( $c->counter->{"$code"} > $RECURSION ) {
902 my $error = qq/Deep recursion detected in "$action"/;
903 $c->log->error($error);
909 $action = "-> $action" if $callsub =~ /forward$/;
911 push( @{ $c->stack }, $code );
914 $start = [gettimeofday] if $c->debug;
915 eval { $c->state( &$code( $class, $c, @{ $c->req->args } ) || 0 ) };
916 $elapsed = tv_interval($start) if $c->debug;
919 unless ( ( $code->name =~ /^_.*/ )
920 && ( !$c->config->{show_internal_actions} ) )
922 push @{ $c->{stats} }, [ $action, sprintf( '%fs', $elapsed ) ];
925 pop( @{ $c->stack } );
927 if ( my $error = $@ ) {
929 if ( $error eq $DETACH ) { die $DETACH if $c->depth > 1 }
931 unless ( ref $error ) {
933 $error = qq/Caught exception "$error"/;
944 Finalizes the request.
951 for my $error ( @{ $c->error } ) {
952 $c->log->error($error);
955 $c->finalize_uploads;
958 if ( $#{ $c->error } >= 0 ) {
962 $c->finalize_headers;
965 if ( $c->request->method eq 'HEAD' ) {
966 $c->response->body('');
971 return $c->response->status;
974 =head2 $c->finalize_body
980 sub finalize_body { my $c = shift; $c->engine->finalize_body( $c, @_ ) }
982 =head2 $c->finalize_cookies
988 sub finalize_cookies { my $c = shift; $c->engine->finalize_cookies( $c, @_ ) }
990 =head2 $c->finalize_error
996 sub finalize_error { my $c = shift; $c->engine->finalize_error( $c, @_ ) }
998 =head2 $c->finalize_headers
1004 sub finalize_headers {
1007 # Check if we already finalized headers
1008 return if $c->response->{_finalized_headers};
1011 if ( my $location = $c->response->redirect ) {
1012 $c->log->debug(qq/Redirecting to "$location"/) if $c->debug;
1013 $c->response->header( Location => $location );
1017 if ( $c->response->body && !$c->response->content_length ) {
1018 $c->response->content_length( bytes::length( $c->response->body ) );
1022 if ( $c->response->status =~ /^(1\d\d|[23]04)$/ ) {
1023 $c->response->headers->remove_header("Content-Length");
1024 $c->response->body('');
1027 $c->finalize_cookies;
1029 $c->engine->finalize_headers( $c, @_ );
1032 $c->response->{_finalized_headers} = 1;
1035 =head2 $c->finalize_output
1037 An alias for finalize_body.
1039 =head2 $c->finalize_read
1041 Finalizes the input after reading is complete.
1045 sub finalize_read { my $c = shift; $c->engine->finalize_read( $c, @_ ) }
1047 =head2 $c->finalize_uploads
1049 Finalizes uploads. Cleans up any temporary files.
1053 sub finalize_uploads { my $c = shift; $c->engine->finalize_uploads( $c, @_ ) }
1055 =head2 $c->get_action( $action, $namespace )
1057 Gets an action in a given namespace.
1061 sub get_action { my $c = shift; $c->dispatcher->get_action(@_) }
1063 =head2 $c->get_actions( $action, $namespace )
1065 Gets all actions of a given name in a namespace and all parent
1070 sub get_actions { my $c = shift; $c->dispatcher->get_actions( $c, @_ ) }
1072 =head2 handle_request( $class, @arguments )
1074 Called to handle each HTTP request.
1078 sub handle_request {
1079 my ( $class, @arguments ) = @_;
1081 # Always expect worst case!
1087 my $c = $class->prepare(@arguments);
1088 $c->{stats} = \@stats;
1090 return $c->finalize;
1093 if ( $class->debug ) {
1094 my $start = [gettimeofday];
1095 $status = &$handler;
1096 my $elapsed = tv_interval $start;
1097 $elapsed = sprintf '%f', $elapsed;
1098 my $av = sprintf '%.3f',
1099 ( $elapsed == 0 ? '??' : ( 1 / $elapsed ) );
1100 my $t = Text::SimpleTable->new( [ 64, 'Action' ], [ 9, 'Time' ] );
1102 for my $stat (@stats) { $t->row( $stat->[0], $stat->[1] ) }
1104 "Request took ${elapsed}s ($av/s)\n" . $t->draw );
1106 else { $status = &$handler }
1110 if ( my $error = $@ ) {
1112 $class->log->error(qq/Caught exception in engine "$error"/);
1116 $class->log->_flush() if $class->log->can('_flush');
1120 =head2 $c->prepare( @arguments )
1122 Creates a Catalyst context from an engine-specific request (Apache, CGI,
1128 my ( $class, @arguments ) = @_;
1130 $class->context_class( ref $class || $class ) unless $class->context_class;
1131 my $c = $class->context_class->new(
1135 request => $class->request_class->new(
1138 body_parameters => {},
1140 headers => HTTP::Headers->new,
1142 query_parameters => {},
1148 response => $class->response_class->new(
1152 headers => HTTP::Headers->new(),
1161 # For on-demand data
1162 $c->request->{_context} = $c;
1163 $c->response->{_context} = $c;
1164 weaken( $c->request->{_context} );
1165 weaken( $c->response->{_context} );
1168 my $secs = time - $START || 1;
1169 my $av = sprintf '%.3f', $COUNT / $secs;
1170 $c->log->debug('**********************************');
1171 $c->log->debug("* Request $COUNT ($av/s) [$$]");
1172 $c->log->debug('**********************************');
1173 $c->res->headers->header( 'X-Catalyst' => $Catalyst::VERSION );
1176 $c->prepare_request(@arguments);
1177 $c->prepare_connection;
1178 $c->prepare_query_parameters;
1179 $c->prepare_headers;
1180 $c->prepare_cookies;
1184 $c->prepare_body unless $c->config->{parse_on_demand};
1186 my $method = $c->req->method || '';
1187 my $path = $c->req->path || '';
1188 my $address = $c->req->address || '';
1190 $c->log->debug(qq/"$method" request for "$path" from "$address"/)
1198 =head2 $c->prepare_action
1204 sub prepare_action { my $c = shift; $c->dispatcher->prepare_action( $c, @_ ) }
1206 =head2 $c->prepare_body
1208 Prepares message body.
1215 # Do we run for the first time?
1216 return if defined $c->request->{_body};
1218 # Initialize on-demand data
1219 $c->engine->prepare_body( $c, @_ );
1220 $c->prepare_parameters;
1221 $c->prepare_uploads;
1223 if ( $c->debug && keys %{ $c->req->body_parameters } ) {
1224 my $t = Text::SimpleTable->new( [ 37, 'Key' ], [ 36, 'Value' ] );
1225 for my $key ( sort keys %{ $c->req->body_parameters } ) {
1226 my $param = $c->req->body_parameters->{$key};
1227 my $value = defined($param) ? $param : '';
1229 ref $value eq 'ARRAY' ? ( join ', ', @$value ) : $value );
1231 $c->log->debug( "Body Parameters are:\n" . $t->draw );
1235 =head2 $c->prepare_body_chunk( $chunk )
1237 Prepares a chunk of data before sending it to L<HTTP::Body>.
1241 sub prepare_body_chunk {
1243 $c->engine->prepare_body_chunk( $c, @_ );
1246 =head2 $c->prepare_body_parameters
1248 Prepares body parameters.
1252 sub prepare_body_parameters {
1254 $c->engine->prepare_body_parameters( $c, @_ );
1257 =head2 $c->prepare_connection
1259 Prepares connection.
1263 sub prepare_connection {
1265 $c->engine->prepare_connection( $c, @_ );
1268 =head2 $c->prepare_cookies
1274 sub prepare_cookies { my $c = shift; $c->engine->prepare_cookies( $c, @_ ) }
1276 =head2 $c->prepare_headers
1282 sub prepare_headers { my $c = shift; $c->engine->prepare_headers( $c, @_ ) }
1284 =head2 $c->prepare_parameters
1286 Prepares parameters.
1290 sub prepare_parameters {
1292 $c->prepare_body_parameters;
1293 $c->engine->prepare_parameters( $c, @_ );
1296 =head2 $c->prepare_path
1298 Prepares path and base.
1302 sub prepare_path { my $c = shift; $c->engine->prepare_path( $c, @_ ) }
1304 =head2 $c->prepare_query_parameters
1306 Prepares query parameters.
1310 sub prepare_query_parameters {
1313 $c->engine->prepare_query_parameters( $c, @_ );
1315 if ( $c->debug && keys %{ $c->request->query_parameters } ) {
1316 my $t = Text::SimpleTable->new( [ 37, 'Key' ], [ 36, 'Value' ] );
1317 for my $key ( sort keys %{ $c->req->query_parameters } ) {
1318 my $param = $c->req->query_parameters->{$key};
1319 my $value = defined($param) ? $param : '';
1321 ref $value eq 'ARRAY' ? ( join ', ', @$value ) : $value );
1323 $c->log->debug( "Query Parameters are:\n" . $t->draw );
1327 =head2 $c->prepare_read
1329 Prepares the input for reading.
1333 sub prepare_read { my $c = shift; $c->engine->prepare_read( $c, @_ ) }
1335 =head2 $c->prepare_request
1337 Prepares the engine request.
1341 sub prepare_request { my $c = shift; $c->engine->prepare_request( $c, @_ ) }
1343 =head2 $c->prepare_uploads
1349 sub prepare_uploads {
1352 $c->engine->prepare_uploads( $c, @_ );
1354 if ( $c->debug && keys %{ $c->request->uploads } ) {
1355 my $t = Text::SimpleTable->new(
1361 for my $key ( sort keys %{ $c->request->uploads } ) {
1362 my $upload = $c->request->uploads->{$key};
1363 for my $u ( ref $upload eq 'ARRAY' ? @{$upload} : ($upload) ) {
1364 $t->row( $key, $u->filename, $u->type, $u->size );
1367 $c->log->debug( "File Uploads are:\n" . $t->draw );
1371 =head2 $c->prepare_write
1373 Prepares the output for writing.
1377 sub prepare_write { my $c = shift; $c->engine->prepare_write( $c, @_ ) }
1379 =head2 $c->request_class
1381 Returns or sets the request class.
1383 =head2 $c->response_class
1385 Returns or sets the response class.
1387 =head2 $c->read( [$maxlength] )
1389 Reads a chunk of data from the request body. This method is designed to
1390 be used in a while loop, reading C<$maxlength> bytes on every call.
1391 C<$maxlength> defaults to the size of the request if not specified.
1393 You have to set C<MyApp-E<gt>config-E<gt>{parse_on_demand}> to use this
1398 sub read { my $c = shift; return $c->engine->read( $c, @_ ) }
1406 sub run { my $c = shift; return $c->engine->run( $c, @_ ) }
1408 =head2 $c->set_action( $action, $code, $namespace, $attrs )
1410 Sets an action in a given namespace.
1414 sub set_action { my $c = shift; $c->dispatcher->set_action( $c, @_ ) }
1416 =head2 $c->setup_actions($component)
1418 Sets up actions for a component.
1422 sub setup_actions { my $c = shift; $c->dispatcher->setup_actions( $c, @_ ) }
1424 =head2 $c->setup_components
1430 sub setup_components {
1433 my $callback = sub {
1434 my ( $component, $context ) = @_;
1436 unless ( $component->isa('Catalyst::Component') ) {
1440 my $suffix = Catalyst::Utils::class2classsuffix($component);
1441 my $config = $class->config->{$suffix} || {};
1445 eval { $instance = $component->new( $context, $config ); };
1447 if ( my $error = $@ ) {
1451 Catalyst::Exception->throw( message =>
1452 qq/Couldn't instantiate component "$component", "$error"/ );
1455 Catalyst::Exception->throw( message =>
1456 qq/Couldn't instantiate component "$component", "new() didn't return a object"/
1458 unless ref $instance;
1462 eval "package $class;\n" . q!Module::Pluggable::Fast->import(
1463 name => '_catalyst_components',
1465 "$class\::Controller", "$class\::C",
1466 "$class\::Model", "$class\::M",
1467 "$class\::View", "$class\::V"
1469 callback => $callback
1473 if ( my $error = $@ ) {
1477 Catalyst::Exception->throw(
1478 message => qq/Couldn't load components "$error"/ );
1481 for my $component ( $class->_catalyst_components($class) ) {
1482 $class->components->{ ref $component || $component } = $component;
1486 =head2 $c->setup_dispatcher
1492 sub setup_dispatcher {
1493 my ( $class, $dispatcher ) = @_;
1496 $dispatcher = 'Catalyst::Dispatcher::' . $dispatcher;
1499 if ( $ENV{CATALYST_DISPATCHER} ) {
1500 $dispatcher = 'Catalyst::Dispatcher::' . $ENV{CATALYST_DISPATCHER};
1503 if ( $ENV{ uc($class) . '_DISPATCHER' } ) {
1505 'Catalyst::Dispatcher::' . $ENV{ uc($class) . '_DISPATCHER' };
1508 unless ($dispatcher) {
1509 $dispatcher = $class->dispatcher_class;
1512 $dispatcher->require;
1515 Catalyst::Exception->throw(
1516 message => qq/Couldn't load dispatcher "$dispatcher", "$@"/ );
1519 # dispatcher instance
1520 $class->dispatcher( $dispatcher->new );
1523 =head2 $c->setup_engine
1530 my ( $class, $engine ) = @_;
1533 $engine = 'Catalyst::Engine::' . $engine;
1536 if ( $ENV{CATALYST_ENGINE} ) {
1537 $engine = 'Catalyst::Engine::' . $ENV{CATALYST_ENGINE};
1540 if ( $ENV{ uc($class) . '_ENGINE' } ) {
1541 $engine = 'Catalyst::Engine::' . $ENV{ uc($class) . '_ENGINE' };
1544 if ( !$engine && $ENV{MOD_PERL} ) {
1546 # create the apache method
1549 *{"$class\::apache"} = sub { shift->engine->apache };
1552 my ( $software, $version ) =
1553 $ENV{MOD_PERL} =~ /^(\S+)\/(\d+(?:[\.\_]\d+)+)/;
1556 $version =~ s/(\.[^.]+)\./$1/g;
1558 if ( $software eq 'mod_perl' ) {
1560 if ( $version >= 1.99922 ) {
1561 $engine = 'Catalyst::Engine::Apache2::MP20';
1564 elsif ( $version >= 1.9901 ) {
1565 $engine = 'Catalyst::Engine::Apache2::MP19';
1568 elsif ( $version >= 1.24 ) {
1569 $engine = 'Catalyst::Engine::Apache::MP13';
1573 Catalyst::Exception->throw( message =>
1574 qq/Unsupported mod_perl version: $ENV{MOD_PERL}/ );
1577 # install the correct mod_perl handler
1578 if ( $version >= 1.9901 ) {
1579 *handler = sub : method {
1580 shift->handle_request(@_);
1584 *handler = sub ($$) { shift->handle_request(@_) };
1589 elsif ( $software eq 'Zeus-Perl' ) {
1590 $engine = 'Catalyst::Engine::Zeus';
1594 Catalyst::Exception->throw(
1595 message => qq/Unsupported mod_perl: $ENV{MOD_PERL}/ );
1600 $engine = $class->engine_class;
1606 Catalyst::Exception->throw( message =>
1607 qq/Couldn't load engine "$engine" (maybe you forgot to install it?), "$@"/
1611 # check for old engines that are no longer compatible
1613 if ( $engine->isa('Catalyst::Engine::Apache')
1614 && !Catalyst::Engine::Apache->VERSION )
1619 elsif ( $engine->isa('Catalyst::Engine::Server::Base')
1620 && Catalyst::Engine::Server->VERSION le '0.02' )
1625 elsif ($engine->isa('Catalyst::Engine::HTTP::POE')
1626 && $engine->VERSION eq '0.01' )
1631 elsif ($engine->isa('Catalyst::Engine::Zeus')
1632 && $engine->VERSION eq '0.01' )
1638 Catalyst::Exception->throw( message =>
1639 qq/Engine "$engine" is not supported by this version of Catalyst/
1644 $class->engine( $engine->new );
1647 =head2 $c->setup_home
1649 Sets up the home directory.
1654 my ( $class, $home ) = @_;
1656 if ( $ENV{CATALYST_HOME} ) {
1657 $home = $ENV{CATALYST_HOME};
1660 if ( $ENV{ uc($class) . '_HOME' } ) {
1661 $home = $ENV{ uc($class) . '_HOME' };
1665 $home = Catalyst::Utils::home($class);
1669 $class->config->{home} ||= $home;
1670 $class->config->{root} ||= dir($home)->subdir('root');
1674 =head2 $c->setup_log
1681 my ( $class, $debug ) = @_;
1683 unless ( $class->log ) {
1684 $class->log( Catalyst::Log->new );
1687 my $app_flag = Catalyst::Utils::class2env($class) . '_DEBUG';
1690 ( defined( $ENV{CATALYST_DEBUG} ) || defined( $ENV{$app_flag} ) )
1691 ? ( $ENV{CATALYST_DEBUG} || $ENV{$app_flag} )
1696 *{"$class\::debug"} = sub { 1 };
1697 $class->log->debug('Debug messages enabled');
1701 =head2 $c->setup_plugins
1708 my ( $class, $plugins ) = @_;
1711 for my $plugin ( reverse @$plugins ) {
1713 $plugin = "Catalyst::Plugin::$plugin";
1718 Catalyst::Exception->throw(
1719 message => qq/Couldn't load plugin "$plugin", "$@"/ );
1724 unshift @{"$class\::ISA"}, $plugin;
1733 =head2 $c->write( $data )
1735 Writes $data to the output stream. When using this method directly, you
1736 will need to manually set the C<Content-Length> header to the length of
1737 your output data, if known.
1744 # Finalize headers if someone manually writes output
1745 $c->finalize_headers;
1747 return $c->engine->write( $c, @_ );
1752 Returns the Catalyst version number. Mostly useful for "powered by"
1753 messages in template systems.
1757 sub version { return $Catalyst::VERSION }
1759 =head1 INTERNAL ACTIONS
1761 Catalyst uses internal actions like C<_DISPATCH>, C<_BEGIN>, C<_AUTO>,
1762 C<_ACTION>, and C<_END>. These are by default not shown in the private
1763 action table, but you can make them visible with a config parameter.
1765 MyApp->config->{show_internal_actions} = 1;
1767 =head1 CASE SENSITIVITY
1769 By default Catalyst is not case sensitive, so C<MyApp::C::FOO::Bar> is
1770 mapped to C</foo/bar>. You can activate case sensitivity with a config
1773 MyApp->config->{case_sensitive} = 1;
1775 This causes C<MyApp::C::Foo::Bar> to map to C</Foo/Bar>.
1777 =head1 ON-DEMAND PARSER
1779 The request body is usually parsed at the beginning of a request,
1780 but if you want to handle input yourself or speed things up a bit,
1781 you can enable on-demand parsing with a config parameter.
1783 MyApp->config->{parse_on_demand} = 1;
1785 =head1 PROXY SUPPORT
1787 Many production servers operate using the common double-server approach,
1788 with a lightweight frontend web server passing requests to a larger
1789 backend server. An application running on the backend server must deal
1790 with two problems: the remote user always appears to be C<127.0.0.1> and
1791 the server's hostname will appear to be C<localhost> regardless of the
1792 virtual host that the user connected through.
1794 Catalyst will automatically detect this situation when you are running
1795 the frontend and backend servers on the same machine. The following
1796 changes are made to the request.
1798 $c->req->address is set to the user's real IP address, as read from
1799 the HTTP X-Forwarded-For header.
1801 The host value for $c->req->base and $c->req->uri is set to the real
1802 host, as read from the HTTP X-Forwarded-Host header.
1804 Obviously, your web server must support these headers for this to work.
1806 In a more complex server farm environment where you may have your
1807 frontend proxy server(s) on different machines, you will need to set a
1808 configuration option to tell Catalyst to read the proxied data from the
1811 MyApp->config->{using_frontend_proxy} = 1;
1813 If you do not wish to use the proxy support at all, you may set:
1815 MyApp->config->{ignore_frontend_proxy} = 1;
1817 =head1 THREAD SAFETY
1819 Catalyst has been tested under Apache 2's threading mpm_worker, mpm_winnt,
1820 and the standalone forking HTTP server on Windows. We believe the Catalyst
1821 core to be thread-safe.
1823 If you plan to operate in a threaded environment, remember that all other
1824 modules you are using must also be thread-safe. Some modules, most notably
1825 L<DBD::SQLite>, are not thread-safe.
1831 Join #catalyst on irc.perl.org.
1835 http://lists.rawmode.org/mailman/listinfo/catalyst
1836 http://lists.rawmode.org/mailman/listinfo/catalyst-dev
1840 http://catalyst.perl.org
1844 http://dev.catalyst.perl.org
1848 =head2 L<Catalyst::Manual> - The Catalyst Manual
1850 =head2 L<Catalyst::Component>, L<Catalyst::Base> - Base classes for components
1852 =head2 L<Catalyst::Engine> - Core engine
1854 =head2 L<Catalyst::Log> - Log class.
1856 =head2 L<Catalyst::Request> - Request object
1858 =head2 L<Catalyst::Response> - Response object
1860 =head2 L<Catalyst::Test> - The test suite.
1930 Sebastian Riedel, C<sri@oook.de>
1934 This library is free software, you can redistribute it and/or modify it under
1935 the same terms as Perl itself.