4 use base 'Catalyst::Base';
6 use UNIVERSAL::require;
7 use Catalyst::Exception;
10 use Catalyst::Request::Upload;
11 use Catalyst::Response;
15 use Text::SimpleTable;
17 use Time::HiRes qw/gettimeofday tv_interval/;
19 use Scalar::Util qw/weaken/;
22 __PACKAGE__->mk_accessors(
23 qw/counter request response state action stack namespace/
26 attributes->import( __PACKAGE__, \&namespace, 'lvalue' );
28 sub depth { scalar @{ shift->stack || [] }; }
35 # For backwards compatibility
36 *finalize_output = \&finalize_body;
41 our $RECURSION = 1000;
42 our $DETACH = "catalyst_detach\n";
44 require Module::Pluggable::Fast;
46 # Helper script generation
47 our $CATALYST_SCRIPT_GEN = 25;
49 __PACKAGE__->mk_classdata($_)
50 for qw/components arguments dispatcher engine log dispatcher_class
51 engine_class context_class request_class response_class/;
53 __PACKAGE__->dispatcher_class('Catalyst::Dispatcher');
54 __PACKAGE__->engine_class('Catalyst::Engine::CGI');
55 __PACKAGE__->request_class('Catalyst::Request');
56 __PACKAGE__->response_class('Catalyst::Response');
58 our $VERSION = '5.62';
61 my ( $class, @arguments ) = @_;
63 # We have to limit $class to Catalyst to avoid pushing Catalyst upon every
65 return unless $class eq 'Catalyst';
67 my $caller = caller(0);
69 unless ( $caller->isa('Catalyst') ) {
71 push @{"$caller\::ISA"}, $class;
74 $caller->arguments( [@arguments] );
80 Catalyst - The Elegant MVC Web Application Framework
84 # use the helper to start a new application
87 # add models, views, controllers
88 script/myapp_create.pl model Database DBIC dbi:SQLite:/path/to/db
89 script/myapp_create.pl view TT TT
90 script/myapp_create.pl controller Search
92 # built in testserver -- use -r to restart automatically on changes
93 script/myapp_server.pl
95 # command line testing interface
96 script/myapp_test.pl /yada
99 use Catalyst qw/-Debug/; # include plugins here as well
101 sub foo : Global { # called for /foo, /foo/1, /foo/1/2, etc.
102 my ( $self, $c, @args ) = @_; # args are qw/1 2/ for /foo/1/2
103 $c->stash->{template} = 'foo.tt'; # set the template
104 # lookup something from db -- stash vars are passed to TT
106 MyApp::Model::Database::Foo->search( { country => $args[0] } );
107 if ( $c->req->params->{bar} ) { # access GET or POST parameters
108 $c->forward( 'bar' ); # process another action
109 # do something else after forward returns
113 # The foo.tt TT template can use the stash data from the database
114 [% WHILE (item = data.next) %]
118 # called for /bar/of/soap, /bar/of/soap/10, etc.
119 sub bar : Path('/bar/of/soap') { ... }
121 # called for all actions, from the top-most controller downwards
123 my ( $self, $c ) = @_;
125 $c->res->redirect( '/login' ); # require login
126 return 0; # abort request and go immediately to end()
128 return 1; # success; carry on to next action
131 # called after all actions are finished
133 my ( $self, $c ) = @_;
134 if ( scalar @{ $c->error } ) { ... } # handle errors
135 return if $c->res->body; # already have a response
136 $c->forward( 'MyApp::View::TT' ); # render template
139 ### in MyApp/Controller/Foo.pm
140 # called for /foo/bar
141 sub bar : Local { ... }
143 # called for /blargle
144 sub blargle : Global { ... }
146 # an index action matches /foo, but not /foo/1, etc.
147 sub index : Private { ... }
149 ### in MyApp/Controller/Foo/Bar.pm
150 # called for /foo/bar/baz
151 sub baz : Local { ... }
153 # first MyApp auto is called, then Foo auto, then this
154 sub auto : Private { ... }
156 # powerful regular expression paths are also possible
157 sub details : Regex('^product/(\w+)/details$') {
158 my ( $self, $c ) = @_;
159 # extract the (\w+) from the URI
160 my $product = $c->req->snippets->[0];
163 See L<Catalyst::Manual::Intro> for additional information.
167 The key concept of Catalyst is DRY (Don't Repeat Yourself).
169 See L<Catalyst::Manual> for more documentation.
171 Catalyst plugins can be loaded by naming them as arguments to the "use
172 Catalyst" statement. Omit the C<Catalyst::Plugin::> prefix from the
173 plugin name, i.e., C<Catalyst::Plugin::My::Module> becomes
176 use Catalyst qw/My::Module/;
178 Special flags like C<-Debug> and C<-Engine> can also be specified as
179 arguments when Catalyst is loaded:
181 use Catalyst qw/-Debug My::Module/;
183 The position of plugins and flags in the chain is important, because
184 they are loaded in exactly the order in which they appear.
186 The following flags are supported:
190 Enables debug output.
194 Forces Catalyst to use a specific engine. Omit the
195 C<Catalyst::Engine::> prefix of the engine name, i.e.:
197 use Catalyst qw/-Engine=CGI/;
201 Forces Catalyst to use a specific home directory, e.g.:
203 use Catalyst qw[-Home=/usr/sri];
211 =head2 Information about the current request
215 Returns a L<Catalyst::Action> object for the current action, which
216 stringifies to the action name. See L<Catalyst::Action>.
220 Returns the namespace of the current action, i.e., the uri prefix
221 corresponding to the controller of the current action. For example:
223 # in Controller::Foo::Bar
224 $c->namespace; # returns 'foo/bar';
230 Returns the current L<Catalyst::Request> object. See
231 L<Catalyst::Request>.
233 =head2 Processing and response to the current request
235 =head2 $c->forward( $action [, \@arguments ] )
237 =head2 $c->forward( $class, $method, [, \@arguments ] )
239 Forwards processing to a private action. If you give a class name but no
240 method, C<process()> is called. You may also optionally pass arguments
241 in an arrayref. The action will receive the arguments in C<@_> and
242 C<$c-E<gt>req-E<gt>args>. Upon returning from the function,
243 C<$c-E<gt>req-E<gt>args> will be restored to the previous values.
246 $c->forward('index');
247 $c->forward(qw/MyApp::Model::CDBI::Foo do_stuff/);
248 $c->forward('MyApp::View::TT');
252 sub forward { my $c = shift; $c->dispatcher->forward( $c, @_ ) }
254 =head2 $c->detach( $action [, \@arguments ] )
256 =head2 $c->detach( $class, $method, [, \@arguments ] )
258 The same as C<forward>, but doesn't return.
262 sub detach { my $c = shift; $c->dispatcher->detach( $c, @_ ) }
266 =head2 $c->error($error, ...)
268 =head2 $c->error($arrayref)
270 Returns an arrayref containing error messages. If Catalyst encounters an
271 error while processing a request, it stores the error in $c->error. This
272 method should not be used to store non-fatal error messages.
274 my @error = @{ $c->error };
278 $c->error('Something bad happened');
280 Clear errors. You probably don't want to clear the errors unless you are
281 implementing a custom error screen.
290 my $error = ref $_[0] eq 'ARRAY' ? $_[0] : [@_];
291 push @{ $c->{error} }, @$error;
293 elsif ( defined $_[0] ) { $c->{error} = undef }
294 return $c->{error} || [];
301 Returns the current L<Catalyst::Response> object.
305 Returns a hashref to the stash, which may be used to store data and pass
306 it between components during a request. You can also set hash keys by
307 passing arguments. The stash is automatically sent to the view. The
308 stash is cleared at the end of a request; it cannot be used for
311 $c->stash->{foo} = $bar;
312 $c->stash( { moose => 'majestic', qux => 0 } );
313 $c->stash( bar => 1, gorch => 2 ); # equivalent to passing a hashref
315 # stash is automatically passed to the view for use in a template
316 $c->forward( 'MyApp::V::TT' );
323 my $stash = @_ > 1 ? {@_} : $_[0];
324 while ( my ( $key, $val ) = each %$stash ) {
325 $c->{stash}->{$key} = $val;
333 Contains the return value of the last executed action.
335 =head2 Component Accessors
337 =head2 $c->comp($name)
339 =head2 $c->component($name)
341 Gets a component object by name. This method is no longer recommended,
342 unless you want to get a specific component by full
343 class. C<$c-E<gt>controller>, C<$c-E<gt>model>, and C<$c-E<gt>view>
344 should be used instead.
355 my $appclass = ref $c || $c;
358 $name, "${appclass}::${name}",
359 map { "${appclass}::${_}::${name}" }
360 qw/Model M Controller C View V/
363 foreach my $try (@names) {
365 if ( exists $c->components->{$try} ) {
367 return $c->components->{$try};
371 foreach my $component ( keys %{ $c->components } ) {
373 return $c->components->{$component} if $component =~ /$name/i;
378 return sort keys %{ $c->components };
381 =head2 $c->controller($name)
383 Gets a L<Catalyst::Controller> instance by name.
385 $c->controller('Foo')->do_stuff;
390 my ( $c, $name ) = @_;
391 my $controller = $c->comp("Controller::$name");
392 return $controller if defined $controller;
393 return $c->comp("C::$name");
396 =head2 $c->model($name)
398 Gets a L<Catalyst::Model> instance by name.
400 $c->model('Foo')->do_stuff;
405 my ( $c, $name ) = @_;
406 my $model = $c->comp("Model::$name");
407 return $model if defined $model;
408 return $c->comp("M::$name");
411 =head2 $c->view($name)
413 Gets a L<Catalyst::View> instance by name.
415 $c->view('Foo')->do_stuff;
420 my ( $c, $name ) = @_;
421 my $view = $c->comp("View::$name");
422 return $view if defined $view;
423 return $c->comp("V::$name");
426 =head2 Class data and helper classes
430 Returns or takes a hashref containing the application's configuration.
432 __PACKAGE__->config({ db => 'dsn:SQLite:foo.db' });
436 Overload to enable debug messages (same as -Debug option).
442 =head2 $c->dispatcher
444 Returns the dispatcher instance. Stringifies to class name. See
445 L<Catalyst::Dispatcher>.
449 Returns the engine instance. Stringifies to the class name. See
454 Returns the logging object instance. Unless it is already set, Catalyst
455 sets this up with a L<Catalyst::Log> object. To use your own log class:
457 $c->log( MyLogger->new );
458 $c->log->info( 'Now logging with my own logger!' );
460 Your log class should implement the methods described in the
461 L<Catalyst::Log> man page.
465 =head2 Utility methods
467 =head2 $c->path_to(@path)
469 Merges C<@path> with C<$c-E<gt>config-E<gt>{home}> and returns a
470 L<Path::Class> object.
474 $c->path_to( 'db', 'sqlite.db' );
479 my ( $c, @path ) = @_;
480 my $path = dir( $c->config->{home}, @path );
481 if ( -d $path ) { return $path }
482 else { return file( $c->config->{home}, @path ) }
485 =head2 $c->plugin( $name, $class, @args )
487 Helper method for plugins. It creates a classdata accessor/mutator and
488 loads and instantiates the given class.
490 MyApp->plugin( 'prototype', 'HTML::Prototype' );
492 $c->prototype->define_javascript_functions;
497 my ( $class, $name, $plugin, @args ) = @_;
500 if ( my $error = $UNIVERSAL::require::ERROR ) {
501 Catalyst::Exception->throw(
502 message => qq/Couldn't load instant plugin "$plugin", "$error"/ );
505 eval { $plugin->import };
506 $class->mk_classdata($name);
508 eval { $obj = $plugin->new(@args) };
511 Catalyst::Exception->throw( message =>
512 qq/Couldn't instantiate instant plugin "$plugin", "$@"/ );
516 $class->log->debug(qq/Initialized instant plugin "$plugin" as "$name"/)
522 Initializes the dispatcher and engine, loads any plugins, and loads the
523 model, view, and controller components. You may also specify an array
524 of plugins to load here, if you choose to not load them in the C<use
528 MyApp->setup( qw/-Debug/ );
533 my ( $class, @arguments ) = @_;
535 unless ( $class->isa('Catalyst') ) {
537 Catalyst::Exception->throw(
538 message => qq/'$class' does not inherit from Catalyst/ );
541 if ( $class->arguments ) {
542 @arguments = ( @arguments, @{ $class->arguments } );
548 foreach (@arguments) {
552 ( $flags->{log} ) ? 'debug,' . $flags->{log} : 'debug';
554 elsif (/^-(\w+)=?(.*)$/) {
555 $flags->{ lc $1 } = $2;
558 push @{ $flags->{plugins} }, $_;
562 $class->setup_log( delete $flags->{log} );
563 $class->setup_plugins( delete $flags->{plugins} );
564 $class->setup_dispatcher( delete $flags->{dispatcher} );
565 $class->setup_engine( delete $flags->{engine} );
566 $class->setup_home( delete $flags->{home} );
568 for my $flag ( sort keys %{$flags} ) {
570 if ( my $code = $class->can( 'setup_' . $flag ) ) {
571 &$code( $class, delete $flags->{$flag} );
574 $class->log->warn(qq/Unknown flag "$flag"/);
579 <<"EOF") if ( $ENV{CATALYST_SCRIPT_GEN} && ( $ENV{CATALYST_SCRIPT_GEN} < $Catalyst::CATALYST_SCRIPT_GEN ) );
580 You are running an old script!
582 Please update by running (this will overwrite existing files):
583 catalyst.pl -force -scripts $class
585 or (this will not overwrite existing files):
586 catalyst.pl -scripts $class
589 if ( $class->debug ) {
596 map { $_ . ' ' . ( $_->VERSION || '' ) }
597 grep { /^Catalyst::Plugin/ } @{"$class\::ISA"};
601 my $t = Text::SimpleTable->new(76);
602 $t->row($_) for @plugins;
603 $class->log->debug( "Loaded plugins:\n" . $t->draw );
606 my $dispatcher = $class->dispatcher;
607 my $engine = $class->engine;
608 my $home = $class->config->{home};
610 $class->log->debug(qq/Loaded dispatcher "$dispatcher"/);
611 $class->log->debug(qq/Loaded engine "$engine"/);
615 ? $class->log->debug(qq/Found home "$home"/)
616 : $class->log->debug(qq/Home "$home" doesn't exist/)
617 : $class->log->debug(q/Couldn't find home/);
622 no warnings qw/redefine/;
623 local *setup = sub { };
627 # Initialize our data structure
628 $class->components( {} );
630 $class->setup_components;
632 if ( $class->debug ) {
633 my $t = Text::SimpleTable->new( [ 65, 'Class' ], [ 8, 'Type' ] );
634 for my $comp ( sort keys %{ $class->components } ) {
635 my $type = ref $class->components->{$comp} ? 'instance' : 'class';
636 $t->row( $comp, $type );
638 $class->log->debug( "Loaded components:\n" . $t->draw )
639 if ( keys %{ $class->components } );
642 # Add our self to components, since we are also a component
643 $class->components->{$class} = $class;
645 $class->setup_actions;
647 if ( $class->debug ) {
648 my $name = $class->config->{name} || 'Application';
649 $class->log->info("$name powered by Catalyst $Catalyst::VERSION");
651 $class->log->_flush() if $class->log->can('_flush');
654 =head2 $c->uri_for( $path, [ @args ] )
656 Merges path with C<$c-E<gt>request-E<gt>base> for absolute uri's and
657 with C<$c-E<gt>namespace> for relative uri's, then returns a
658 normalized L<URI> object. If any args are passed, they are added at the
664 my ( $c, $path, @args ) = @_;
665 my $base = $c->request->base->clone;
666 my $basepath = $base->path;
667 $basepath =~ s/\/$//;
669 my $namespace = $c->namespace;
671 # massage namespace, empty if absolute path
672 $namespace =~ s/^\///;
673 $namespace .= '/' if $namespace;
675 $namespace = '' if $path =~ /^\//;
678 # join args with '/', or a blank string
679 my $args = ( scalar @args ? '/' . join( '/', @args ) : '' );
680 $args =~ s/^\/// unless $path;
682 URI->new_abs( URI->new_abs( "$path$args", "$basepath$namespace" ), $base )
687 =head2 $c->welcome_message
689 Returns the Catalyst welcome HTML page.
693 sub welcome_message {
695 my $name = $c->config->{name};
696 my $logo = $c->uri_for('/static/images/catalyst_logo.png');
697 my $prefix = Catalyst::Utils::appprefix( ref $c );
698 $c->response->content_type('text/html; charset=utf-8');
700 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
701 "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
702 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
704 <meta http-equiv="Content-Language" content="en" />
705 <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
706 <title>$name on Catalyst $VERSION</title>
707 <style type="text/css">
710 background-color: #eee;
719 background-color: #ccc;
720 border: 1px solid #aaa;
721 -moz-border-radius: 10px;
726 font-family: verdana, tahoma, sans-serif;
729 font-family: verdana, tahoma, sans-serif;
732 text-decoration: none;
734 border-bottom: 1px dotted #bbb;
736 :link:hover, :visited:hover {
749 background-color: #fff;
750 border: 1px solid #aaa;
751 -moz-border-radius: 10px;
777 <h1><span id="appname">$name</span> on <a href="http://catalyst.perl.org">Catalyst</a>
782 <img src="$logo" alt="Catalyst Logo" />
784 <p>Welcome to the wonderful world of Catalyst.
785 This <a href="http://en.wikipedia.org/wiki/MVC">MVC</a>
786 framework will make web development something you had
787 never expected it to be: Fun, rewarding, and quick.</p>
788 <h2>What to do now?</h2>
789 <p>That really depends on what <b>you</b> want to do.
790 We do, however, provide you with a few starting points.</p>
791 <p>If you want to jump right into web development with Catalyst
792 you might want to check out the documentation.</p>
793 <pre><code>perldoc <a href="http://cpansearch.perl.org/dist/Catalyst/lib/Catalyst/Manual/Intro.pod">Catalyst::Manual::Intro</a>
794 perldoc <a href="http://cpansearch.perl.org/dist/Catalyst/lib/Catalyst/Manual.pod">Catalyst::Manual</a></code></pre>
795 <h2>What to do next?</h2>
796 <p>Next it's time to write an actual application. Use the
797 helper scripts to generate <a href="http://cpansearch.perl.org/search?query=Catalyst%3A%3AController%3A%3A&mode=all">controllers</a>,
798 <a href="http://cpansearch.perl.org/search?query=Catalyst%3A%3AModel%3A%3A&mode=all">models</a>, and
799 <a href="http://cpansearch.perl.org/search?query=Catalyst%3A%3AView%3A%3A&mode=all">views</a>;
800 they can save you a lot of work.</p>
801 <pre><code>script/${prefix}_create.pl -help</code></pre>
802 <p>Also, be sure to check out the vast and growing
803 collection of <a href="http://cpansearch.perl.org/search?query=Catalyst%3A%3APlugin%3A%3A&mode=all">plugins for Catalyst on CPAN</a>;
804 you are likely to find what you need there.
808 <p>Catalyst has a very active community. Here are the main places to
809 get in touch with us.</p>
812 <a href="http://dev.catalyst.perl.org">Wiki</a>
815 <a href="http://lists.rawmode.org/mailman/listinfo/catalyst">Mailing-List</a>
818 <a href="irc://irc.perl.org/catalyst">IRC channel #catalyst on irc.perl.org</a>
821 <h2>In conclusion</h2>
822 <p>The Catalyst team hopes you will enjoy using Catalyst as much
823 as we enjoyed making it. Please contact us if you have ideas
824 for improvement or other feedback.</p>
832 =head1 INTERNAL METHODS
834 These methods are not meant to be used by end users.
836 =head2 $c->components
838 Returns a hash of components.
840 =head2 $c->context_class
842 Returns or sets the context class.
846 Returns a hashref containing coderefs and execution counts (needed for
847 deep recursion detection).
851 Returns the number of actions on the current internal execution stack.
855 Dispatches a request to actions.
859 sub dispatch { my $c = shift; $c->dispatcher->dispatch( $c, @_ ) }
861 =head2 $c->dispatcher_class
863 Returns or sets the dispatcher class.
865 =head2 $c->dump_these
867 Returns a list of 2-element array references (name, structure) pairs
868 that will be dumped on the error page in debug mode.
874 [ Request => $c->req ], [ Response => $c->res ], [ Stash => $c->stash ],;
877 =head2 $c->engine_class
879 Returns or sets the engine class.
881 =head2 $c->execute( $class, $coderef )
883 Execute a coderef in given class and catch exceptions. Errors are available
889 my ( $c, $class, $code ) = @_;
890 $class = $c->components->{$class} || $class;
894 ( caller(0) )[0]->isa('Catalyst::Action')
901 $action = "/$action" unless $action =~ /\-\>/;
902 $c->counter->{"$code"}++;
904 if ( $c->counter->{"$code"} > $RECURSION ) {
905 my $error = qq/Deep recursion detected in "$action"/;
906 $c->log->error($error);
912 $action = "-> $action" if $callsub =~ /forward$/;
914 push( @{ $c->stack }, $code );
917 $start = [gettimeofday] if $c->debug;
918 eval { $c->state( &$code( $class, $c, @{ $c->req->args } ) || 0 ) };
919 $elapsed = tv_interval($start) if $c->debug;
922 unless ( ( $code->name =~ /^_.*/ )
923 && ( !$c->config->{show_internal_actions} ) )
925 push @{ $c->{stats} }, [ $action, sprintf( '%fs', $elapsed ) ];
928 my $last = ${ $c->stack }[-1];
929 pop( @{ $c->stack } );
931 if ( my $error = $@ ) {
933 if ( $error eq $DETACH ) { die $DETACH if $c->depth > 1 }
935 unless ( ref $error ) {
937 my $class = $last->class;
938 my $name = $last->name;
939 $error = qq/Caught exception in $class->$name "$error"/;
950 Finalizes the request.
957 for my $error ( @{ $c->error } ) {
958 $c->log->error($error);
961 $c->finalize_uploads;
964 if ( $#{ $c->error } >= 0 ) {
968 $c->finalize_headers;
971 if ( $c->request->method eq 'HEAD' ) {
972 $c->response->body('');
977 return $c->response->status;
980 =head2 $c->finalize_body
986 sub finalize_body { my $c = shift; $c->engine->finalize_body( $c, @_ ) }
988 =head2 $c->finalize_cookies
994 sub finalize_cookies { my $c = shift; $c->engine->finalize_cookies( $c, @_ ) }
996 =head2 $c->finalize_error
1002 sub finalize_error { my $c = shift; $c->engine->finalize_error( $c, @_ ) }
1004 =head2 $c->finalize_headers
1010 sub finalize_headers {
1013 # Check if we already finalized headers
1014 return if $c->response->{_finalized_headers};
1017 if ( my $location = $c->response->redirect ) {
1018 $c->log->debug(qq/Redirecting to "$location"/) if $c->debug;
1019 $c->response->header( Location => $location );
1023 if ( $c->response->body && !$c->response->content_length ) {
1025 # get the length from a filehandle
1026 if ( ref $c->response->body && $c->response->body->can('read') ) {
1027 if ( my $stat = stat $c->response->body ) {
1028 $c->response->content_length( $stat->size );
1031 $c->log->warn('Serving filehandle without a content-length');
1035 $c->response->content_length( bytes::length( $c->response->body ) );
1040 if ( $c->response->status =~ /^(1\d\d|[23]04)$/ ) {
1041 $c->response->headers->remove_header("Content-Length");
1042 $c->response->body('');
1045 $c->finalize_cookies;
1047 $c->engine->finalize_headers( $c, @_ );
1050 $c->response->{_finalized_headers} = 1;
1053 =head2 $c->finalize_output
1055 An alias for finalize_body.
1057 =head2 $c->finalize_read
1059 Finalizes the input after reading is complete.
1063 sub finalize_read { my $c = shift; $c->engine->finalize_read( $c, @_ ) }
1065 =head2 $c->finalize_uploads
1067 Finalizes uploads. Cleans up any temporary files.
1071 sub finalize_uploads { my $c = shift; $c->engine->finalize_uploads( $c, @_ ) }
1073 =head2 $c->get_action( $action, $namespace )
1075 Gets an action in a given namespace.
1079 sub get_action { my $c = shift; $c->dispatcher->get_action(@_) }
1081 =head2 $c->get_actions( $action, $namespace )
1083 Gets all actions of a given name in a namespace and all parent
1088 sub get_actions { my $c = shift; $c->dispatcher->get_actions( $c, @_ ) }
1090 =head2 handle_request( $class, @arguments )
1092 Called to handle each HTTP request.
1096 sub handle_request {
1097 my ( $class, @arguments ) = @_;
1099 # Always expect worst case!
1105 my $c = $class->prepare(@arguments);
1106 $c->{stats} = \@stats;
1108 return $c->finalize;
1111 if ( $class->debug ) {
1112 my $start = [gettimeofday];
1113 $status = &$handler;
1114 my $elapsed = tv_interval $start;
1115 $elapsed = sprintf '%f', $elapsed;
1116 my $av = sprintf '%.3f',
1117 ( $elapsed == 0 ? '??' : ( 1 / $elapsed ) );
1118 my $t = Text::SimpleTable->new( [ 64, 'Action' ], [ 9, 'Time' ] );
1120 for my $stat (@stats) { $t->row( $stat->[0], $stat->[1] ) }
1122 "Request took ${elapsed}s ($av/s)\n" . $t->draw );
1124 else { $status = &$handler }
1128 if ( my $error = $@ ) {
1130 $class->log->error(qq/Caught exception in engine "$error"/);
1134 $class->log->_flush() if $class->log->can('_flush');
1138 =head2 $c->prepare( @arguments )
1140 Creates a Catalyst context from an engine-specific request (Apache, CGI,
1146 my ( $class, @arguments ) = @_;
1148 $class->context_class( ref $class || $class ) unless $class->context_class;
1149 my $c = $class->context_class->new(
1153 request => $class->request_class->new(
1156 body_parameters => {},
1158 headers => HTTP::Headers->new,
1160 query_parameters => {},
1166 response => $class->response_class->new(
1170 headers => HTTP::Headers->new(),
1179 # For on-demand data
1180 $c->request->{_context} = $c;
1181 $c->response->{_context} = $c;
1182 weaken( $c->request->{_context} );
1183 weaken( $c->response->{_context} );
1186 my $secs = time - $START || 1;
1187 my $av = sprintf '%.3f', $COUNT / $secs;
1188 $c->log->debug('**********************************');
1189 $c->log->debug("* Request $COUNT ($av/s) [$$]");
1190 $c->log->debug('**********************************');
1191 $c->res->headers->header( 'X-Catalyst' => $Catalyst::VERSION );
1194 $c->prepare_request(@arguments);
1195 $c->prepare_connection;
1196 $c->prepare_query_parameters;
1197 $c->prepare_headers;
1198 $c->prepare_cookies;
1202 $c->prepare_body unless $c->config->{parse_on_demand};
1204 my $method = $c->req->method || '';
1205 my $path = $c->req->path || '';
1206 my $address = $c->req->address || '';
1208 $c->log->debug(qq/"$method" request for "$path" from "$address"/)
1216 =head2 $c->prepare_action
1222 sub prepare_action { my $c = shift; $c->dispatcher->prepare_action( $c, @_ ) }
1224 =head2 $c->prepare_body
1226 Prepares message body.
1233 # Do we run for the first time?
1234 return if defined $c->request->{_body};
1236 # Initialize on-demand data
1237 $c->engine->prepare_body( $c, @_ );
1238 $c->prepare_parameters;
1239 $c->prepare_uploads;
1241 if ( $c->debug && keys %{ $c->req->body_parameters } ) {
1242 my $t = Text::SimpleTable->new( [ 37, 'Key' ], [ 36, 'Value' ] );
1243 for my $key ( sort keys %{ $c->req->body_parameters } ) {
1244 my $param = $c->req->body_parameters->{$key};
1245 my $value = defined($param) ? $param : '';
1247 ref $value eq 'ARRAY' ? ( join ', ', @$value ) : $value );
1249 $c->log->debug( "Body Parameters are:\n" . $t->draw );
1253 =head2 $c->prepare_body_chunk( $chunk )
1255 Prepares a chunk of data before sending it to L<HTTP::Body>.
1259 sub prepare_body_chunk {
1261 $c->engine->prepare_body_chunk( $c, @_ );
1264 =head2 $c->prepare_body_parameters
1266 Prepares body parameters.
1270 sub prepare_body_parameters {
1272 $c->engine->prepare_body_parameters( $c, @_ );
1275 =head2 $c->prepare_connection
1277 Prepares connection.
1281 sub prepare_connection {
1283 $c->engine->prepare_connection( $c, @_ );
1286 =head2 $c->prepare_cookies
1292 sub prepare_cookies { my $c = shift; $c->engine->prepare_cookies( $c, @_ ) }
1294 =head2 $c->prepare_headers
1300 sub prepare_headers { my $c = shift; $c->engine->prepare_headers( $c, @_ ) }
1302 =head2 $c->prepare_parameters
1304 Prepares parameters.
1308 sub prepare_parameters {
1310 $c->prepare_body_parameters;
1311 $c->engine->prepare_parameters( $c, @_ );
1314 =head2 $c->prepare_path
1316 Prepares path and base.
1320 sub prepare_path { my $c = shift; $c->engine->prepare_path( $c, @_ ) }
1322 =head2 $c->prepare_query_parameters
1324 Prepares query parameters.
1328 sub prepare_query_parameters {
1331 $c->engine->prepare_query_parameters( $c, @_ );
1333 if ( $c->debug && keys %{ $c->request->query_parameters } ) {
1334 my $t = Text::SimpleTable->new( [ 37, 'Key' ], [ 36, 'Value' ] );
1335 for my $key ( sort keys %{ $c->req->query_parameters } ) {
1336 my $param = $c->req->query_parameters->{$key};
1337 my $value = defined($param) ? $param : '';
1339 ref $value eq 'ARRAY' ? ( join ', ', @$value ) : $value );
1341 $c->log->debug( "Query Parameters are:\n" . $t->draw );
1345 =head2 $c->prepare_read
1347 Prepares the input for reading.
1351 sub prepare_read { my $c = shift; $c->engine->prepare_read( $c, @_ ) }
1353 =head2 $c->prepare_request
1355 Prepares the engine request.
1359 sub prepare_request { my $c = shift; $c->engine->prepare_request( $c, @_ ) }
1361 =head2 $c->prepare_uploads
1367 sub prepare_uploads {
1370 $c->engine->prepare_uploads( $c, @_ );
1372 if ( $c->debug && keys %{ $c->request->uploads } ) {
1373 my $t = Text::SimpleTable->new(
1379 for my $key ( sort keys %{ $c->request->uploads } ) {
1380 my $upload = $c->request->uploads->{$key};
1381 for my $u ( ref $upload eq 'ARRAY' ? @{$upload} : ($upload) ) {
1382 $t->row( $key, $u->filename, $u->type, $u->size );
1385 $c->log->debug( "File Uploads are:\n" . $t->draw );
1389 =head2 $c->prepare_write
1391 Prepares the output for writing.
1395 sub prepare_write { my $c = shift; $c->engine->prepare_write( $c, @_ ) }
1397 =head2 $c->request_class
1399 Returns or sets the request class.
1401 =head2 $c->response_class
1403 Returns or sets the response class.
1405 =head2 $c->read( [$maxlength] )
1407 Reads a chunk of data from the request body. This method is designed to
1408 be used in a while loop, reading C<$maxlength> bytes on every call.
1409 C<$maxlength> defaults to the size of the request if not specified.
1411 You have to set C<MyApp-E<gt>config-E<gt>{parse_on_demand}> to use this
1416 sub read { my $c = shift; return $c->engine->read( $c, @_ ) }
1424 sub run { my $c = shift; return $c->engine->run( $c, @_ ) }
1426 =head2 $c->set_action( $action, $code, $namespace, $attrs )
1428 Sets an action in a given namespace.
1432 sub set_action { my $c = shift; $c->dispatcher->set_action( $c, @_ ) }
1434 =head2 $c->setup_actions($component)
1436 Sets up actions for a component.
1440 sub setup_actions { my $c = shift; $c->dispatcher->setup_actions( $c, @_ ) }
1442 =head2 $c->setup_components
1448 sub setup_components {
1451 my $callback = sub {
1452 my ( $component, $context ) = @_;
1454 unless ( $component->isa('Catalyst::Component') ) {
1458 my $suffix = Catalyst::Utils::class2classsuffix($component);
1459 my $config = $class->config->{$suffix} || {};
1463 eval { $instance = $component->new( $context, $config ); };
1465 if ( my $error = $@ ) {
1469 Catalyst::Exception->throw( message =>
1470 qq/Couldn't instantiate component "$component", "$error"/ );
1473 Catalyst::Exception->throw( message =>
1474 qq/Couldn't instantiate component "$component", "new() didn't return a object"/
1476 unless ref $instance;
1480 eval "package $class;\n" . q!Module::Pluggable::Fast->import(
1481 name => '_catalyst_components',
1483 "$class\::Controller", "$class\::C",
1484 "$class\::Model", "$class\::M",
1485 "$class\::View", "$class\::V"
1487 callback => $callback
1491 if ( my $error = $@ ) {
1495 Catalyst::Exception->throw(
1496 message => qq/Couldn't load components "$error"/ );
1499 for my $component ( $class->_catalyst_components($class) ) {
1500 $class->components->{ ref $component || $component } = $component;
1504 =head2 $c->setup_dispatcher
1510 sub setup_dispatcher {
1511 my ( $class, $dispatcher ) = @_;
1514 $dispatcher = 'Catalyst::Dispatcher::' . $dispatcher;
1517 if ( $ENV{CATALYST_DISPATCHER} ) {
1518 $dispatcher = 'Catalyst::Dispatcher::' . $ENV{CATALYST_DISPATCHER};
1521 if ( $ENV{ uc($class) . '_DISPATCHER' } ) {
1523 'Catalyst::Dispatcher::' . $ENV{ uc($class) . '_DISPATCHER' };
1526 unless ($dispatcher) {
1527 $dispatcher = $class->dispatcher_class;
1530 $dispatcher->require;
1533 Catalyst::Exception->throw(
1534 message => qq/Couldn't load dispatcher "$dispatcher", "$@"/ );
1537 # dispatcher instance
1538 $class->dispatcher( $dispatcher->new );
1541 =head2 $c->setup_engine
1548 my ( $class, $engine ) = @_;
1551 $engine = 'Catalyst::Engine::' . $engine;
1554 if ( $ENV{CATALYST_ENGINE} ) {
1555 $engine = 'Catalyst::Engine::' . $ENV{CATALYST_ENGINE};
1558 if ( $ENV{ uc($class) . '_ENGINE' } ) {
1559 $engine = 'Catalyst::Engine::' . $ENV{ uc($class) . '_ENGINE' };
1562 if ( $ENV{MOD_PERL} ) {
1564 # create the apache method
1567 *{"$class\::apache"} = sub { shift->engine->apache };
1570 my ( $software, $version ) =
1571 $ENV{MOD_PERL} =~ /^(\S+)\/(\d+(?:[\.\_]\d+)+)/;
1574 $version =~ s/(\.[^.]+)\./$1/g;
1576 if ( $software eq 'mod_perl' ) {
1580 if ( $version >= 1.99922 ) {
1581 $engine = 'Catalyst::Engine::Apache2::MP20';
1584 elsif ( $version >= 1.9901 ) {
1585 $engine = 'Catalyst::Engine::Apache2::MP19';
1588 elsif ( $version >= 1.24 ) {
1589 $engine = 'Catalyst::Engine::Apache::MP13';
1593 Catalyst::Exception->throw( message =>
1594 qq/Unsupported mod_perl version: $ENV{MOD_PERL}/ );
1599 # install the correct mod_perl handler
1600 if ( $version >= 1.9901 ) {
1601 *handler = sub : method {
1602 shift->handle_request(@_);
1606 *handler = sub ($$) { shift->handle_request(@_) };
1611 elsif ( $software eq 'Zeus-Perl' ) {
1612 $engine = 'Catalyst::Engine::Zeus';
1616 Catalyst::Exception->throw(
1617 message => qq/Unsupported mod_perl: $ENV{MOD_PERL}/ );
1622 $engine = $class->engine_class;
1628 Catalyst::Exception->throw( message =>
1629 qq/Couldn't load engine "$engine" (maybe you forgot to install it?), "$@"/
1633 # check for old engines that are no longer compatible
1635 if ( $engine->isa('Catalyst::Engine::Apache')
1636 && !Catalyst::Engine::Apache->VERSION )
1641 elsif ( $engine->isa('Catalyst::Engine::Server::Base')
1642 && Catalyst::Engine::Server->VERSION le '0.02' )
1647 elsif ($engine->isa('Catalyst::Engine::HTTP::POE')
1648 && $engine->VERSION eq '0.01' )
1653 elsif ($engine->isa('Catalyst::Engine::Zeus')
1654 && $engine->VERSION eq '0.01' )
1660 Catalyst::Exception->throw( message =>
1661 qq/Engine "$engine" is not supported by this version of Catalyst/
1666 $class->engine( $engine->new );
1669 =head2 $c->setup_home
1671 Sets up the home directory.
1676 my ( $class, $home ) = @_;
1678 if ( $ENV{CATALYST_HOME} ) {
1679 $home = $ENV{CATALYST_HOME};
1682 if ( $ENV{ uc($class) . '_HOME' } ) {
1683 $home = $ENV{ uc($class) . '_HOME' };
1687 $home = Catalyst::Utils::home($class);
1691 $class->config->{home} ||= $home;
1692 $class->config->{root} ||= dir($home)->subdir('root');
1696 =head2 $c->setup_log
1703 my ( $class, $debug ) = @_;
1705 unless ( $class->log ) {
1706 $class->log( Catalyst::Log->new );
1709 my $app_flag = Catalyst::Utils::class2env($class) . '_DEBUG';
1712 ( defined( $ENV{CATALYST_DEBUG} ) || defined( $ENV{$app_flag} ) )
1713 ? ( $ENV{CATALYST_DEBUG} || $ENV{$app_flag} )
1718 *{"$class\::debug"} = sub { 1 };
1719 $class->log->debug('Debug messages enabled');
1723 =head2 $c->setup_plugins
1730 my ( $class, $plugins ) = @_;
1733 for my $plugin ( reverse @$plugins ) {
1735 $plugin = "Catalyst::Plugin::$plugin";
1740 Catalyst::Exception->throw(
1741 message => qq/Couldn't load plugin "$plugin", "$@"/ );
1746 unshift @{"$class\::ISA"}, $plugin;
1755 =head2 $c->write( $data )
1757 Writes $data to the output stream. When using this method directly, you
1758 will need to manually set the C<Content-Length> header to the length of
1759 your output data, if known.
1766 # Finalize headers if someone manually writes output
1767 $c->finalize_headers;
1769 return $c->engine->write( $c, @_ );
1774 Returns the Catalyst version number. Mostly useful for "powered by"
1775 messages in template systems.
1779 sub version { return $Catalyst::VERSION }
1781 =head1 INTERNAL ACTIONS
1783 Catalyst uses internal actions like C<_DISPATCH>, C<_BEGIN>, C<_AUTO>,
1784 C<_ACTION>, and C<_END>. These are by default not shown in the private
1785 action table, but you can make them visible with a config parameter.
1787 MyApp->config->{show_internal_actions} = 1;
1789 =head1 CASE SENSITIVITY
1791 By default Catalyst is not case sensitive, so C<MyApp::C::FOO::Bar> is
1792 mapped to C</foo/bar>. You can activate case sensitivity with a config
1795 MyApp->config->{case_sensitive} = 1;
1797 This causes C<MyApp::C::Foo::Bar> to map to C</Foo/Bar>.
1799 =head1 ON-DEMAND PARSER
1801 The request body is usually parsed at the beginning of a request,
1802 but if you want to handle input yourself or speed things up a bit,
1803 you can enable on-demand parsing with a config parameter.
1805 MyApp->config->{parse_on_demand} = 1;
1807 =head1 PROXY SUPPORT
1809 Many production servers operate using the common double-server approach,
1810 with a lightweight frontend web server passing requests to a larger
1811 backend server. An application running on the backend server must deal
1812 with two problems: the remote user always appears to be C<127.0.0.1> and
1813 the server's hostname will appear to be C<localhost> regardless of the
1814 virtual host that the user connected through.
1816 Catalyst will automatically detect this situation when you are running
1817 the frontend and backend servers on the same machine. The following
1818 changes are made to the request.
1820 $c->req->address is set to the user's real IP address, as read from
1821 the HTTP X-Forwarded-For header.
1823 The host value for $c->req->base and $c->req->uri is set to the real
1824 host, as read from the HTTP X-Forwarded-Host header.
1826 Obviously, your web server must support these headers for this to work.
1828 In a more complex server farm environment where you may have your
1829 frontend proxy server(s) on different machines, you will need to set a
1830 configuration option to tell Catalyst to read the proxied data from the
1833 MyApp->config->{using_frontend_proxy} = 1;
1835 If you do not wish to use the proxy support at all, you may set:
1837 MyApp->config->{ignore_frontend_proxy} = 1;
1839 =head1 THREAD SAFETY
1841 Catalyst has been tested under Apache 2's threading mpm_worker, mpm_winnt,
1842 and the standalone forking HTTP server on Windows. We believe the Catalyst
1843 core to be thread-safe.
1845 If you plan to operate in a threaded environment, remember that all other
1846 modules you are using must also be thread-safe. Some modules, most notably
1847 L<DBD::SQLite>, are not thread-safe.
1853 Join #catalyst on irc.perl.org.
1857 http://lists.rawmode.org/mailman/listinfo/catalyst
1858 http://lists.rawmode.org/mailman/listinfo/catalyst-dev
1862 http://catalyst.perl.org
1866 http://dev.catalyst.perl.org
1870 =head2 L<Task::Catalyst> - All you need to start with Catalyst
1872 =head2 L<Catalyst::Manual> - The Catalyst Manual
1874 =head2 L<Catalyst::Component>, L<Catalyst::Base> - Base classes for components
1876 =head2 L<Catalyst::Engine> - Core engine
1878 =head2 L<Catalyst::Log> - Log class.
1880 =head2 L<Catalyst::Request> - Request object
1882 =head2 L<Catalyst::Response> - Response object
1884 =head2 L<Catalyst::Test> - The test suite.
1954 Sebastian Riedel, C<sri@oook.de>
1958 This library is free software, you can redistribute it and/or modify it under
1959 the same terms as Perl itself.