4 use base 'Catalyst::Base';
6 use UNIVERSAL::require;
7 use Catalyst::Exception;
10 use Catalyst::Request::Upload;
11 use Catalyst::Response;
14 use Text::SimpleTable;
16 use Time::HiRes qw/gettimeofday tv_interval/;
18 use Scalar::Util qw/weaken/;
22 require Catalyst::Helper;
23 require Catalyst::PAR;
24 require Catalyst::Build;
25 require Catalyst::Test;
27 require Catalyst::Engine::HTTP;
28 require Catalyst::Engine::CGI;
30 require Catalyst::Controller;
31 require Catalyst::Model;
32 require Catalyst::View;
34 __PACKAGE__->mk_accessors(
35 qw/counter request response state action stack namespace/
38 attributes->import( __PACKAGE__, \&namespace, 'lvalue' );
40 sub depth { scalar @{ shift->stack || [] }; }
47 # For backwards compatibility
48 *finalize_output = \&finalize_body;
53 our $RECURSION = 1000;
54 our $DETACH = "catalyst_detach\n";
56 require Module::Pluggable::Fast;
58 # Helper script generation
59 our $CATALYST_SCRIPT_GEN = 18;
61 __PACKAGE__->mk_classdata($_)
62 for qw/components arguments dispatcher engine log dispatcher_class
63 engine_class context_class request_class response_class/;
65 __PACKAGE__->dispatcher_class('Catalyst::Dispatcher');
66 __PACKAGE__->engine_class('Catalyst::Engine::CGI');
67 __PACKAGE__->request_class('Catalyst::Request');
68 __PACKAGE__->response_class('Catalyst::Response');
70 our $VERSION = '5.57';
73 my ( $class, @arguments ) = @_;
75 # We have to limit $class to Catalyst to avoid pushing Catalyst upon every
77 return unless $class eq 'Catalyst';
79 my $caller = caller(0);
81 unless ( $caller->isa('Catalyst') ) {
83 push @{"$caller\::ISA"}, $class;
86 $caller->arguments( [@arguments] );
92 Catalyst - The Elegant MVC Web Application Framework
96 # use the helper to start a new application
99 # add models, views, controllers
100 script/myapp_create.pl model Database DBIC dbi:SQLite:/path/to/db
101 script/myapp_create.pl view TT TT
102 script/myapp_create.pl controller Search
104 # built in testserver -- use -r to restart automatically on changes
105 script/myapp_server.pl
107 # command line testing interface
108 script/myapp_test.pl /yada
111 use Catalyst qw/-Debug/; # include plugins here as well
113 sub foo : Global { # called for /foo, /foo/1, /foo/1/2, etc.
114 my ( $self, $c, @args ) = @_; # args are qw/1 2/ for /foo/1/2
115 $c->stash->{template} = 'foo.tt'; # set the template
116 # lookup something from db -- stash vars are passed to TT
118 MyApp::Model::Database::Foo->search( { country => $args[0] } );
119 if ( $c->req->params->{bar} ) { # access GET or POST parameters
120 $c->forward( 'bar' ); # process another action
121 # do something else after forward returns
125 # The foo.tt TT template can use the stash data from the database
126 [% WHILE (item = data.next) %]
130 # called for /bar/of/soap, /bar/of/soap/10, etc.
131 sub bar : Path('/bar/of/soap') { ... }
133 # called for all actions, from the top-most controller downwards
135 my ( $self, $c ) = @_;
137 $c->res->redirect( '/login' ); # require login
138 return 0; # abort request and go immediately to end()
140 return 1; # success; carry on to next action
143 # called after all actions are finished
145 my ( $self, $c ) = @_;
146 if ( scalar @{ $c->error } ) { ... } # handle errors
147 return if $c->res->body; # already have a response
148 $c->forward( 'MyApp::View::TT' ); # render template
151 ### in MyApp/Controller/Foo.pm
152 # called for /foo/bar
153 sub bar : Local { ... }
155 # called for /blargle
156 sub blargle : Global { ... }
158 # an index action matches /foo, but not /foo/1, etc.
159 sub index : Private { ... }
161 ### in MyApp/Controller/Foo/Bar.pm
162 # called for /foo/bar/baz
163 sub baz : Local { ... }
165 # first MyApp auto is called, then Foo auto, then this
166 sub auto : Private { ... }
168 # powerful regular expression paths are also possible
169 sub details : Regex('^product/(\w+)/details$') {
170 my ( $self, $c ) = @_;
171 # extract the (\w+) from the URI
172 my $product = $c->req->snippets->[0];
175 See L<Catalyst::Manual::Intro> for additional information.
179 The key concept of Catalyst is DRY (Don't Repeat Yourself).
181 See L<Catalyst::Manual> for more documentation.
183 Catalyst plugins can be loaded by naming them as arguments to the "use
184 Catalyst" statement. Omit the C<Catalyst::Plugin::> prefix from the
185 plugin name, i.e., C<Catalyst::Plugin::My::Module> becomes
188 use Catalyst qw/My::Module/;
190 Special flags like C<-Debug> and C<-Engine> can also be specified as
191 arguments when Catalyst is loaded:
193 use Catalyst qw/-Debug My::Module/;
195 The position of plugins and flags in the chain is important, because
196 they are loaded in exactly the order in which they appear.
198 The following flags are supported:
202 Enables debug output.
206 Forces Catalyst to use a specific engine. Omit the
207 C<Catalyst::Engine::> prefix of the engine name, i.e.:
209 use Catalyst qw/-Engine=CGI/;
213 Forces Catalyst to use a specific home directory, e.g.:
215 use Catalyst qw[-Home=/usr/sri];
223 =head2 Information about the current request
227 Returns a L<Catalyst::Action> object for the current action, which
228 stringifies to the action name. See L<Catalyst::Action>.
232 Returns the namespace of the current action, i.e., the uri prefix
233 corresponding to the controller of the current action. For example:
235 # in Controller::Foo::Bar
236 $c->namespace; # returns 'foo/bar';
242 Returns the current L<Catalyst::Request> object. See
243 L<Catalyst::Request>.
245 =head2 Processing and response to the current request
247 =head2 $c->forward( $action [, \@arguments ] )
249 =head2 $c->forward( $class, $method, [, \@arguments ] )
251 Forwards processing to a private action. If you give a class name but no
252 method, C<process()> is called. You may also optionally pass arguments
253 in an arrayref. The action will receive the arguments in C<@_> and
254 C<$c-E<gt>req-E<gt>args>. Upon returning from the function,
255 C<$c-E<gt>req-E<gt>args> will be restored to the previous values.
258 $c->forward('index');
259 $c->forward(qw/MyApp::Model::CDBI::Foo do_stuff/);
260 $c->forward('MyApp::View::TT');
264 sub forward { my $c = shift; $c->dispatcher->forward( $c, @_ ) }
266 =head2 $c->detach( $action [, \@arguments ] )
268 =head2 $c->detach( $class, $method, [, \@arguments ] )
270 The same as C<forward>, but doesn't return.
274 sub detach { my $c = shift; $c->dispatcher->detach( $c, @_ ) }
278 =head2 $c->error($error, ...)
280 =head2 $c->error($arrayref)
282 Returns an arrayref containing error messages. If Catalyst encounters an
283 error while processing a request, it stores the error in $c->error. This
284 method should not be used to store non-fatal error messages.
286 my @error = @{ $c->error };
290 $c->error('Something bad happened');
292 Clear errors. You probably don't want to clear the errors unless you are
293 implementing a custom error screen.
302 my $error = ref $_[0] eq 'ARRAY' ? $_[0] : [@_];
303 push @{ $c->{error} }, @$error;
305 elsif ( defined $_[0] ) { $c->{error} = undef }
306 return $c->{error} || [];
313 Returns the current L<Catalyst::Response> object.
317 Returns a hashref to the stash, which may be used to store data and pass
318 it between components during a request. You can also set hash keys by
319 passing arguments. The stash is automatically sent to the view. The
320 stash is cleared at the end of a request; it cannot be used for
323 $c->stash->{foo} = $bar;
324 $c->stash( { moose => 'majestic', qux => 0 } );
325 $c->stash( bar => 1, gorch => 2 ); # equivalent to passing a hashref
327 # stash is automatically passed to the view for use in a template
328 $c->forward( 'MyApp::V::TT' );
335 my $stash = @_ > 1 ? {@_} : $_[0];
336 while ( my ( $key, $val ) = each %$stash ) {
337 $c->{stash}->{$key} = $val;
345 Contains the return value of the last executed action.
347 =head2 Component Accessors
349 =head2 $c->comp($name)
351 =head2 $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 =head2 $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 =head2 $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 =head2 $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");
438 =head2 Class data and helper classes
442 Returns or takes a hashref containing the application's configuration.
444 __PACKAGE__->config({ db => 'dsn:SQLite:foo.db' });
448 Overload to enable debug messages (same as -Debug option).
454 =head2 $c->dispatcher
456 Returns the dispatcher instance. Stringifies to class name. See
457 L<Catalyst::Dispatcher>.
461 Returns the engine instance. Stringifies to the class name. See
466 Returns the logging object instance. Unless it is already set, Catalyst
467 sets this up with a L<Catalyst::Log> object. To use your own log class:
469 $c->log( MyLogger->new );
470 $c->log->info( 'Now logging with my own logger!' );
472 Your log class should implement the methods described in the
473 L<Catalyst::Log> man page.
477 =head2 Utility methods
479 =head2 $c->path_to(@path)
481 Merges C<@path> with C<$c-E<gt>config-E<gt>{home}> and returns a
482 L<Path::Class> object.
486 $c->path_to( 'db', 'sqlite.db' );
491 my ( $c, @path ) = @_;
492 my $path = dir( $c->config->{home}, @path );
493 if ( -d $path ) { return $path }
494 else { return file( $c->config->{home}, @path ) }
497 =head2 $c->plugin( $name, $class, @args )
499 Helper method for plugins. It creates a classdata accessor/mutator and
500 loads and instantiates the given class.
502 MyApp->plugin( 'prototype', 'HTML::Prototype' );
504 $c->prototype->define_javascript_functions;
509 my ( $class, $name, $plugin, @args ) = @_;
512 if ( my $error = $UNIVERSAL::require::ERROR ) {
513 Catalyst::Exception->throw(
514 message => qq/Couldn't load instant plugin "$plugin", "$error"/ );
517 eval { $plugin->import };
518 $class->mk_classdata($name);
520 eval { $obj = $plugin->new(@args) };
523 Catalyst::Exception->throw( message =>
524 qq/Couldn't instantiate instant plugin "$plugin", "$@"/ );
528 $class->log->debug(qq/Initialized instant plugin "$plugin" as "$name"/)
534 Initializes the dispatcher and engine, loads any plugins, and loads the
535 model, view, and controller components. You may also specify an array
536 of plugins to load here, if you choose to not load them in the C<use
540 MyApp->setup( qw/-Debug/ );
545 my ( $class, @arguments ) = @_;
547 unless ( $class->isa('Catalyst') ) {
549 Catalyst::Exception->throw(
550 message => qq/'$class' does not inherit from Catalyst/ );
553 if ( $class->arguments ) {
554 @arguments = ( @arguments, @{ $class->arguments } );
560 foreach (@arguments) {
564 ( $flags->{log} ) ? 'debug,' . $flags->{log} : 'debug';
566 elsif (/^-(\w+)=?(.*)$/) {
567 $flags->{ lc $1 } = $2;
570 push @{ $flags->{plugins} }, $_;
574 $class->setup_log( delete $flags->{log} );
575 $class->setup_plugins( delete $flags->{plugins} );
576 $class->setup_dispatcher( delete $flags->{dispatcher} );
577 $class->setup_engine( delete $flags->{engine} );
578 $class->setup_home( delete $flags->{home} );
580 for my $flag ( sort keys %{$flags} ) {
582 if ( my $code = $class->can( 'setup_' . $flag ) ) {
583 &$code( $class, delete $flags->{$flag} );
586 $class->log->warn(qq/Unknown flag "$flag"/);
591 <<"EOF") if ( $ENV{CATALYST_SCRIPT_GEN} && ( $ENV{CATALYST_SCRIPT_GEN} < $Catalyst::CATALYST_SCRIPT_GEN ) );
592 You are running an old script!
594 Please update by running (this will overwrite existing files):
595 catalyst.pl -force -scripts $class
597 or (this will not overwrite existing files):
598 catalyst.pl -scripts $class
601 if ( $class->debug ) {
607 @plugins = grep { /^Catalyst::Plugin/ } @{"$class\::ISA"};
611 my $t = Text::SimpleTable->new(76);
612 $t->row($_) for @plugins;
613 $class->log->debug( "Loaded plugins:\n" . $t->draw );
616 my $dispatcher = $class->dispatcher;
617 my $engine = $class->engine;
618 my $home = $class->config->{home};
620 $class->log->debug(qq/Loaded dispatcher "$dispatcher"/);
621 $class->log->debug(qq/Loaded engine "$engine"/);
625 ? $class->log->debug(qq/Found home "$home"/)
626 : $class->log->debug(qq/Home "$home" doesn't exist/)
627 : $class->log->debug(q/Couldn't find home/);
632 no warnings qw/redefine/;
633 local *setup = sub { };
637 # Initialize our data structure
638 $class->components( {} );
640 $class->setup_components;
642 if ( $class->debug ) {
643 my $t = Text::SimpleTable->new( [ 65, 'Class' ], [ 8, 'Type' ] );
644 for my $comp ( sort keys %{ $class->components } ) {
645 my $type = ref $class->components->{$comp} ? 'instance' : 'class';
646 $t->row( $comp, $type );
648 $class->log->debug( "Loaded components:\n" . $t->draw )
649 if ( keys %{ $class->components } );
652 # Add our self to components, since we are also a component
653 $class->components->{$class} = $class;
655 $class->setup_actions;
657 if ( $class->debug ) {
658 my $name = $class->config->{name} || 'Application';
659 $class->log->info("$name powered by Catalyst $Catalyst::VERSION");
661 $class->log->_flush() if $class->log->can('_flush');
664 =head2 $c->uri_for( $path, [ @args ] )
666 Merges path with C<$c-E<gt>request-E<gt>base> for absolute uri's and
667 with C<$c-E<gt>namespace> for relative uri's, then returns a
668 normalized L<URI> object. If any args are passed, they are added at the
674 my ( $c, $path, @args ) = @_;
675 my $base = $c->request->base->clone;
676 my $basepath = $base->path;
677 $basepath =~ s/\/$//;
679 my $namespace = $c->namespace;
681 # massage namespace, empty if absolute path
682 $namespace =~ s/^\///;
683 $namespace .= '/' if $namespace;
685 $namespace = '' if $path =~ /^\//;
688 # join args with '/', or a blank string
689 my $args = ( scalar @args ? '/' . join( '/', @args ) : '' );
690 return URI->new_abs( URI->new_abs( "$path$args", "$basepath$namespace" ),
694 =head2 $c->welcome_message
696 Returns the Catalyst welcome HTML page.
700 sub welcome_message {
702 my $name = $c->config->{name};
703 my $logo = $c->uri_for('/static/images/catalyst_logo.png');
704 my $prefix = Catalyst::Utils::appprefix( ref $c );
705 $c->response->content_type('text/html; charset=utf-8');
707 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
708 "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
709 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
711 <meta http-equiv="Content-Language" content="en" />
712 <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
713 <title>$name on Catalyst $VERSION</title>
714 <style type="text/css">
717 background-color: #eee;
726 background-color: #ccc;
727 border: 1px solid #aaa;
728 -moz-border-radius: 10px;
733 font-family: verdana, tahoma, sans-serif;
736 font-family: verdana, tahoma, sans-serif;
739 text-decoration: none;
741 border-bottom: 1px dotted #bbb;
743 :link:hover, :visited:hover {
756 background-color: #fff;
757 border: 1px solid #aaa;
758 -moz-border-radius: 10px;
784 <h1><span id="appname">$name</span> on <a href="http://catalyst.perl.org">Catalyst</a>
789 <img src="$logo" alt="Catalyst Logo" />
791 <p>Welcome to the wonderful world of Catalyst.
792 This <a href="http://en.wikipedia.org/wiki/MVC">MVC</a>
793 framework will make web development something you had
794 never expected it to be: Fun, rewarding and quick.</p>
795 <h2>What to do now?</h2>
796 <p>That really depends on what <b>you</b> want to do.
797 We do, however, provide you with a few starting points.</p>
798 <p>If you want to jump right into web development with Catalyst
799 you might want to check out the documentation.</p>
800 <pre><code>perldoc <a href="http://cpansearch.perl.org/dist/Catalyst/lib/Catalyst/Manual/Intro.pod">Catalyst::Manual::Intro</a>
801 perldoc <a href="http://cpansearch.perl.org/dist/Catalyst/lib/Catalyst/Manual.pod">Catalyst::Manual</a></code></pre>
802 <h2>What to do next?</h2>
803 <p>Next it's time to write an actual application. Use the
804 helper scripts to generate <a href="http://cpansearch.perl.org/search?query=Catalyst%3A%3AController%3A%3A&mode=all">controllers</a>,
805 <a href="http://cpansearch.perl.org/search?query=Catalyst%3A%3AModel%3A%3A&mode=all">models</a> and
806 <a href="http://cpansearch.perl.org/search?query=Catalyst%3A%3AView%3A%3A&mode=all">views</a>,
807 they can save you a lot of work.</p>
808 <pre><code>script/${prefix}_create.pl -help</code></pre>
809 <p>Also, be sure to check out the vast and growing
810 collection of <a href="http://cpansearch.perl.org/search?query=Catalyst%3A%3APlugin%3A%3A&mode=all">plugins for Catalyst on CPAN</a>,
811 you are likely to find what you need there.
815 <p>Catalyst has a very active community. Here are the main places to
816 get in touch with us.</p>
819 <a href="http://dev.catalyst.perl.org">Wiki</a>
822 <a href="http://lists.rawmode.org/mailman/listinfo/catalyst">Mailing-List</a>
825 <a href="irc://irc.perl.org/catalyst">IRC channel #catalyst on irc.perl.org</a>
828 <h2>In conclusion</h2>
829 <p>The Catalyst team hopes you will enjoy using Catalyst as much
830 as we enjoyed making it. Please contact us if you have ideas
831 for improvement or other feedback.</p>
839 =head1 INTERNAL METHODS
841 These methods are not meant to be used by end users.
843 =head2 $c->components
845 Returns a hash of components.
847 =head2 $c->context_class
849 Returns or sets the context class.
853 Returns a hashref containing coderefs and execution counts (needed for
854 deep recursion detection).
858 Returns the number of actions on the current internal execution stack.
862 Dispatches a request to actions.
866 sub dispatch { my $c = shift; $c->dispatcher->dispatch( $c, @_ ) }
868 =head2 $c->dispatcher_class
870 Returns or sets the dispatcher class.
872 =head2 $c->dump_these
874 Returns a list of 2-element array references (name, structure) pairs
875 that will be dumped on the error page in debug mode.
881 [ Request => $c->req ], [ Response => $c->res ], [ Stash => $c->stash ],;
884 =head2 $c->engine_class
886 Returns or sets the engine class.
888 =head2 $c->execute( $class, $coderef )
890 Execute a coderef in given class and catch exceptions. Errors are available
896 my ( $c, $class, $code ) = @_;
897 $class = $c->components->{$class} || $class;
901 ( caller(0) )[0]->isa('Catalyst::Action')
908 $action = "/$action" unless $action =~ /\-\>/;
909 $c->counter->{"$code"}++;
911 if ( $c->counter->{"$code"} > $RECURSION ) {
912 my $error = qq/Deep recursion detected in "$action"/;
913 $c->log->error($error);
919 $action = "-> $action" if $callsub =~ /forward$/;
921 push( @{ $c->stack }, $code );
924 $start = [gettimeofday] if $c->debug;
925 eval { $c->state( &$code( $class, $c, @{ $c->req->args } ) || 0 ) };
926 $elapsed = tv_interval($start) if $c->debug;
929 unless ( ( $code->name =~ /^_.*/ )
930 && ( !$c->config->{show_internal_actions} ) )
932 push @{ $c->{stats} }, [ $action, sprintf( '%fs', $elapsed ) ];
935 pop( @{ $c->stack } );
937 if ( my $error = $@ ) {
939 if ( $error eq $DETACH ) { die $DETACH if $c->depth > 1 }
941 unless ( ref $error ) {
943 $error = qq/Caught exception "$error"/;
954 Finalizes the request.
961 for my $error ( @{ $c->error } ) {
962 $c->log->error($error);
965 $c->finalize_uploads;
968 if ( $#{ $c->error } >= 0 ) {
972 $c->finalize_headers;
975 if ( $c->request->method eq 'HEAD' ) {
976 $c->response->body('');
981 return $c->response->status;
984 =head2 $c->finalize_body
990 sub finalize_body { my $c = shift; $c->engine->finalize_body( $c, @_ ) }
992 =head2 $c->finalize_cookies
998 sub finalize_cookies { my $c = shift; $c->engine->finalize_cookies( $c, @_ ) }
1000 =head2 $c->finalize_error
1006 sub finalize_error { my $c = shift; $c->engine->finalize_error( $c, @_ ) }
1008 =head2 $c->finalize_headers
1014 sub finalize_headers {
1017 # Check if we already finalized headers
1018 return if $c->response->{_finalized_headers};
1021 if ( my $location = $c->response->redirect ) {
1022 $c->log->debug(qq/Redirecting to "$location"/) if $c->debug;
1023 $c->response->header( Location => $location );
1027 if ( $c->response->body && !$c->response->content_length ) {
1028 $c->response->content_length( bytes::length( $c->response->body ) );
1032 if ( $c->response->status =~ /^(1\d\d|[23]04)$/ ) {
1033 $c->response->headers->remove_header("Content-Length");
1034 $c->response->body('');
1037 $c->finalize_cookies;
1039 $c->engine->finalize_headers( $c, @_ );
1042 $c->response->{_finalized_headers} = 1;
1045 =head2 $c->finalize_output
1047 An alias for finalize_body.
1049 =head2 $c->finalize_read
1051 Finalizes the input after reading is complete.
1055 sub finalize_read { my $c = shift; $c->engine->finalize_read( $c, @_ ) }
1057 =head2 $c->finalize_uploads
1059 Finalizes uploads. Cleans up any temporary files.
1063 sub finalize_uploads { my $c = shift; $c->engine->finalize_uploads( $c, @_ ) }
1065 =head2 $c->get_action( $action, $namespace )
1067 Gets an action in a given namespace.
1071 sub get_action { my $c = shift; $c->dispatcher->get_action(@_) }
1073 =head2 $c->get_actions( $action, $namespace )
1075 Gets all actions of a given name in a namespace and all parent
1080 sub get_actions { my $c = shift; $c->dispatcher->get_actions( $c, @_ ) }
1082 =head2 handle_request( $class, @arguments )
1084 Called to handle each HTTP request.
1088 sub handle_request {
1089 my ( $class, @arguments ) = @_;
1091 # Always expect worst case!
1097 my $c = $class->prepare(@arguments);
1098 $c->{stats} = \@stats;
1100 return $c->finalize;
1103 if ( $class->debug ) {
1104 my $start = [gettimeofday];
1105 $status = &$handler;
1106 my $elapsed = tv_interval $start;
1107 $elapsed = sprintf '%f', $elapsed;
1108 my $av = sprintf '%.3f',
1109 ( $elapsed == 0 ? '??' : ( 1 / $elapsed ) );
1110 my $t = Text::SimpleTable->new( [ 64, 'Action' ], [ 9, 'Time' ] );
1112 for my $stat (@stats) { $t->row( $stat->[0], $stat->[1] ) }
1114 "Request took ${elapsed}s ($av/s)\n" . $t->draw );
1116 else { $status = &$handler }
1120 if ( my $error = $@ ) {
1122 $class->log->error(qq/Caught exception in engine "$error"/);
1126 $class->log->_flush() if $class->log->can('_flush');
1130 =head2 $c->prepare( @arguments )
1132 Creates a Catalyst context from an engine-specific request (Apache, CGI,
1138 my ( $class, @arguments ) = @_;
1140 $class->context_class( ref $class || $class ) unless $class->context_class;
1141 my $c = $class->context_class->new(
1145 request => $class->request_class->new(
1148 body_parameters => {},
1150 headers => HTTP::Headers->new,
1152 query_parameters => {},
1158 response => $class->response_class->new(
1162 headers => HTTP::Headers->new(),
1171 # For on-demand data
1172 $c->request->{_context} = $c;
1173 $c->response->{_context} = $c;
1174 weaken( $c->request->{_context} );
1175 weaken( $c->response->{_context} );
1178 my $secs = time - $START || 1;
1179 my $av = sprintf '%.3f', $COUNT / $secs;
1180 $c->log->debug('**********************************');
1181 $c->log->debug("* Request $COUNT ($av/s) [$$]");
1182 $c->log->debug('**********************************');
1183 $c->res->headers->header( 'X-Catalyst' => $Catalyst::VERSION );
1186 $c->prepare_request(@arguments);
1187 $c->prepare_connection;
1188 $c->prepare_query_parameters;
1189 $c->prepare_headers;
1190 $c->prepare_cookies;
1194 $c->prepare_body unless $c->config->{parse_on_demand};
1196 my $method = $c->req->method || '';
1197 my $path = $c->req->path || '';
1198 my $address = $c->req->address || '';
1200 $c->log->debug(qq/"$method" request for "$path" from "$address"/)
1208 =head2 $c->prepare_action
1214 sub prepare_action { my $c = shift; $c->dispatcher->prepare_action( $c, @_ ) }
1216 =head2 $c->prepare_body
1218 Prepares message body.
1225 # Do we run for the first time?
1226 return if defined $c->request->{_body};
1228 # Initialize on-demand data
1229 $c->engine->prepare_body( $c, @_ );
1230 $c->prepare_parameters;
1231 $c->prepare_uploads;
1233 if ( $c->debug && keys %{ $c->req->body_parameters } ) {
1234 my $t = Text::SimpleTable->new( [ 37, 'Key' ], [ 36, 'Value' ] );
1235 for my $key ( sort keys %{ $c->req->body_parameters } ) {
1236 my $param = $c->req->body_parameters->{$key};
1237 my $value = defined($param) ? $param : '';
1239 ref $value eq 'ARRAY' ? ( join ', ', @$value ) : $value );
1241 $c->log->debug( "Body Parameters are:\n" . $t->draw );
1245 =head2 $c->prepare_body_chunk( $chunk )
1247 Prepares a chunk of data before sending it to L<HTTP::Body>.
1251 sub prepare_body_chunk {
1253 $c->engine->prepare_body_chunk( $c, @_ );
1256 =head2 $c->prepare_body_parameters
1258 Prepares body parameters.
1262 sub prepare_body_parameters {
1264 $c->engine->prepare_body_parameters( $c, @_ );
1267 =head2 $c->prepare_connection
1269 Prepares connection.
1273 sub prepare_connection {
1275 $c->engine->prepare_connection( $c, @_ );
1278 =head2 $c->prepare_cookies
1284 sub prepare_cookies { my $c = shift; $c->engine->prepare_cookies( $c, @_ ) }
1286 =head2 $c->prepare_headers
1292 sub prepare_headers { my $c = shift; $c->engine->prepare_headers( $c, @_ ) }
1294 =head2 $c->prepare_parameters
1296 Prepares parameters.
1300 sub prepare_parameters {
1302 $c->prepare_body_parameters;
1303 $c->engine->prepare_parameters( $c, @_ );
1306 =head2 $c->prepare_path
1308 Prepares path and base.
1312 sub prepare_path { my $c = shift; $c->engine->prepare_path( $c, @_ ) }
1314 =head2 $c->prepare_query_parameters
1316 Prepares query parameters.
1320 sub prepare_query_parameters {
1323 $c->engine->prepare_query_parameters( $c, @_ );
1325 if ( $c->debug && keys %{ $c->request->query_parameters } ) {
1326 my $t = Text::SimpleTable->new( [ 37, 'Key' ], [ 36, 'Value' ] );
1327 for my $key ( sort keys %{ $c->req->query_parameters } ) {
1328 my $param = $c->req->query_parameters->{$key};
1329 my $value = defined($param) ? $param : '';
1331 ref $value eq 'ARRAY' ? ( join ', ', @$value ) : $value );
1333 $c->log->debug( "Query Parameters are:\n" . $t->draw );
1337 =head2 $c->prepare_read
1339 Prepares the input for reading.
1343 sub prepare_read { my $c = shift; $c->engine->prepare_read( $c, @_ ) }
1345 =head2 $c->prepare_request
1347 Prepares the engine request.
1351 sub prepare_request { my $c = shift; $c->engine->prepare_request( $c, @_ ) }
1353 =head2 $c->prepare_uploads
1359 sub prepare_uploads {
1362 $c->engine->prepare_uploads( $c, @_ );
1364 if ( $c->debug && keys %{ $c->request->uploads } ) {
1365 my $t = Text::SimpleTable->new(
1371 for my $key ( sort keys %{ $c->request->uploads } ) {
1372 my $upload = $c->request->uploads->{$key};
1373 for my $u ( ref $upload eq 'ARRAY' ? @{$upload} : ($upload) ) {
1374 $t->row( $key, $u->filename, $u->type, $u->size );
1377 $c->log->debug( "File Uploads are:\n" . $t->draw );
1381 =head2 $c->prepare_write
1383 Prepares the output for writing.
1387 sub prepare_write { my $c = shift; $c->engine->prepare_write( $c, @_ ) }
1389 =head2 $c->request_class
1391 Returns or sets the request class.
1393 =head2 $c->response_class
1395 Returns or sets the response class.
1397 =head2 $c->read( [$maxlength] )
1399 Reads a chunk of data from the request body. This method is designed to
1400 be used in a while loop, reading C<$maxlength> bytes on every call.
1401 C<$maxlength> defaults to the size of the request if not specified.
1403 You have to set C<MyApp-E<gt>config-E<gt>{parse_on_demand}> to use this
1408 sub read { my $c = shift; return $c->engine->read( $c, @_ ) }
1416 sub run { my $c = shift; return $c->engine->run( $c, @_ ) }
1418 =head2 $c->set_action( $action, $code, $namespace, $attrs )
1420 Sets an action in a given namespace.
1424 sub set_action { my $c = shift; $c->dispatcher->set_action( $c, @_ ) }
1426 =head2 $c->setup_actions($component)
1428 Sets up actions for a component.
1432 sub setup_actions { my $c = shift; $c->dispatcher->setup_actions( $c, @_ ) }
1434 =head2 $c->setup_components
1440 sub setup_components {
1443 my $callback = sub {
1444 my ( $component, $context ) = @_;
1446 unless ( $component->isa('Catalyst::Component') ) {
1450 my $suffix = Catalyst::Utils::class2classsuffix($component);
1451 my $config = $class->config->{$suffix} || {};
1455 eval { $instance = $component->new( $context, $config ); };
1457 if ( my $error = $@ ) {
1461 Catalyst::Exception->throw( message =>
1462 qq/Couldn't instantiate component "$component", "$error"/ );
1465 Catalyst::Exception->throw( message =>
1466 qq/Couldn't instantiate component "$component", "new() didn't return a object"/
1468 unless ref $instance;
1472 eval "package $class;\n" . q!Module::Pluggable::Fast->import(
1473 name => '_catalyst_components',
1475 "$class\::Controller", "$class\::C",
1476 "$class\::Model", "$class\::M",
1477 "$class\::View", "$class\::V"
1479 callback => $callback
1483 if ( my $error = $@ ) {
1487 Catalyst::Exception->throw(
1488 message => qq/Couldn't load components "$error"/ );
1491 for my $component ( $class->_catalyst_components($class) ) {
1492 $class->components->{ ref $component || $component } = $component;
1496 =head2 $c->setup_dispatcher
1502 sub setup_dispatcher {
1503 my ( $class, $dispatcher ) = @_;
1506 $dispatcher = 'Catalyst::Dispatcher::' . $dispatcher;
1509 if ( $ENV{CATALYST_DISPATCHER} ) {
1510 $dispatcher = 'Catalyst::Dispatcher::' . $ENV{CATALYST_DISPATCHER};
1513 if ( $ENV{ uc($class) . '_DISPATCHER' } ) {
1515 'Catalyst::Dispatcher::' . $ENV{ uc($class) . '_DISPATCHER' };
1518 unless ($dispatcher) {
1519 $dispatcher = $class->dispatcher_class;
1522 $dispatcher->require;
1525 Catalyst::Exception->throw(
1526 message => qq/Couldn't load dispatcher "$dispatcher", "$@"/ );
1529 # dispatcher instance
1530 $class->dispatcher( $dispatcher->new );
1533 =head2 $c->setup_engine
1540 my ( $class, $engine ) = @_;
1543 $engine = 'Catalyst::Engine::' . $engine;
1546 if ( $ENV{CATALYST_ENGINE} ) {
1547 $engine = 'Catalyst::Engine::' . $ENV{CATALYST_ENGINE};
1550 if ( $ENV{ uc($class) . '_ENGINE' } ) {
1551 $engine = 'Catalyst::Engine::' . $ENV{ uc($class) . '_ENGINE' };
1554 if ( !$engine && $ENV{MOD_PERL} ) {
1556 # create the apache method
1559 *{"$class\::apache"} = sub { shift->engine->apache };
1562 my ( $software, $version ) =
1563 $ENV{MOD_PERL} =~ /^(\S+)\/(\d+(?:[\.\_]\d+)+)/;
1566 $version =~ s/(\.[^.]+)\./$1/g;
1568 if ( $software eq 'mod_perl' ) {
1570 if ( $version >= 1.99922 ) {
1571 $engine = 'Catalyst::Engine::Apache2::MP20';
1574 elsif ( $version >= 1.9901 ) {
1575 $engine = 'Catalyst::Engine::Apache2::MP19';
1578 elsif ( $version >= 1.24 ) {
1579 $engine = 'Catalyst::Engine::Apache::MP13';
1583 Catalyst::Exception->throw( message =>
1584 qq/Unsupported mod_perl version: $ENV{MOD_PERL}/ );
1587 # install the correct mod_perl handler
1588 if ( $version >= 1.9901 ) {
1589 *handler = sub : method {
1590 shift->handle_request(@_);
1594 *handler = sub ($$) { shift->handle_request(@_) };
1599 elsif ( $software eq 'Zeus-Perl' ) {
1600 $engine = 'Catalyst::Engine::Zeus';
1604 Catalyst::Exception->throw(
1605 message => qq/Unsupported mod_perl: $ENV{MOD_PERL}/ );
1610 $engine = $class->engine_class;
1616 Catalyst::Exception->throw( message =>
1617 qq/Couldn't load engine "$engine" (maybe you forgot to install it?), "$@"/
1621 # check for old engines that are no longer compatible
1623 if ( $engine->isa('Catalyst::Engine::Apache')
1624 && !Catalyst::Engine::Apache->VERSION )
1629 elsif ( $engine->isa('Catalyst::Engine::Server::Base')
1630 && Catalyst::Engine::Server->VERSION le '0.02' )
1635 elsif ($engine->isa('Catalyst::Engine::HTTP::POE')
1636 && $engine->VERSION eq '0.01' )
1641 elsif ($engine->isa('Catalyst::Engine::Zeus')
1642 && $engine->VERSION eq '0.01' )
1648 Catalyst::Exception->throw( message =>
1649 qq/Engine "$engine" is not supported by this version of Catalyst/
1654 $class->engine( $engine->new );
1657 =head2 $c->setup_home
1659 Sets up the home directory.
1664 my ( $class, $home ) = @_;
1666 if ( $ENV{CATALYST_HOME} ) {
1667 $home = $ENV{CATALYST_HOME};
1670 if ( $ENV{ uc($class) . '_HOME' } ) {
1671 $home = $ENV{ uc($class) . '_HOME' };
1675 $home = Catalyst::Utils::home($class);
1679 $class->config->{home} ||= $home;
1680 $class->config->{root} ||= dir($home)->subdir('root');
1684 =head2 $c->setup_log
1691 my ( $class, $debug ) = @_;
1693 unless ( $class->log ) {
1694 $class->log( Catalyst::Log->new );
1697 my $app_flag = Catalyst::Utils::class2env($class) . '_DEBUG';
1700 ( defined( $ENV{CATALYST_DEBUG} ) || defined( $ENV{$app_flag} ) )
1701 ? ( $ENV{CATALYST_DEBUG} || $ENV{$app_flag} )
1706 *{"$class\::debug"} = sub { 1 };
1707 $class->log->debug('Debug messages enabled');
1711 =head2 $c->setup_plugins
1718 my ( $class, $plugins ) = @_;
1721 for my $plugin ( reverse @$plugins ) {
1723 $plugin = "Catalyst::Plugin::$plugin";
1728 Catalyst::Exception->throw(
1729 message => qq/Couldn't load plugin "$plugin", "$@"/ );
1734 unshift @{"$class\::ISA"}, $plugin;
1743 =head2 $c->write( $data )
1745 Writes $data to the output stream. When using this method directly, you
1746 will need to manually set the C<Content-Length> header to the length of
1747 your output data, if known.
1754 # Finalize headers if someone manually writes output
1755 $c->finalize_headers;
1757 return $c->engine->write( $c, @_ );
1762 Returns the Catalyst version number. Mostly useful for "powered by"
1763 messages in template systems.
1767 sub version { return $Catalyst::VERSION }
1769 =head1 INTERNAL ACTIONS
1771 Catalyst uses internal actions like C<_DISPATCH>, C<_BEGIN>, C<_AUTO>,
1772 C<_ACTION>, and C<_END>. These are by default not shown in the private
1773 action table, but you can make them visible with a config parameter.
1775 MyApp->config->{show_internal_actions} = 1;
1777 =head1 CASE SENSITIVITY
1779 By default Catalyst is not case sensitive, so C<MyApp::C::FOO::Bar> is
1780 mapped to C</foo/bar>. You can activate case sensitivity with a config
1783 MyApp->config->{case_sensitive} = 1;
1785 This causes C<MyApp::C::Foo::Bar> to map to C</Foo/Bar>.
1787 =head1 ON-DEMAND PARSER
1789 The request body is usually parsed at the beginning of a request,
1790 but if you want to handle input yourself or speed things up a bit,
1791 you can enable on-demand parsing with a config parameter.
1793 MyApp->config->{parse_on_demand} = 1;
1795 =head1 PROXY SUPPORT
1797 Many production servers operate using the common double-server approach,
1798 with a lightweight frontend web server passing requests to a larger
1799 backend server. An application running on the backend server must deal
1800 with two problems: the remote user always appears to be C<127.0.0.1> and
1801 the server's hostname will appear to be C<localhost> regardless of the
1802 virtual host that the user connected through.
1804 Catalyst will automatically detect this situation when you are running
1805 the frontend and backend servers on the same machine. The following
1806 changes are made to the request.
1808 $c->req->address is set to the user's real IP address, as read from
1809 the HTTP X-Forwarded-For header.
1811 The host value for $c->req->base and $c->req->uri is set to the real
1812 host, as read from the HTTP X-Forwarded-Host header.
1814 Obviously, your web server must support these headers for this to work.
1816 In a more complex server farm environment where you may have your
1817 frontend proxy server(s) on different machines, you will need to set a
1818 configuration option to tell Catalyst to read the proxied data from the
1821 MyApp->config->{using_frontend_proxy} = 1;
1823 If you do not wish to use the proxy support at all, you may set:
1825 MyApp->config->{ignore_frontend_proxy} = 1;
1827 =head1 THREAD SAFETY
1829 Catalyst has been tested under Apache 2's threading mpm_worker, mpm_winnt,
1830 and the standalone forking HTTP server on Windows. We believe the Catalyst
1831 core to be thread-safe.
1833 If you plan to operate in a threaded environment, remember that all other
1834 modules you are using must also be thread-safe. Some modules, most notably
1835 L<DBD::SQLite>, are not thread-safe.
1841 Join #catalyst on irc.perl.org.
1845 http://lists.rawmode.org/mailman/listinfo/catalyst
1846 http://lists.rawmode.org/mailman/listinfo/catalyst-dev
1850 http://catalyst.perl.org
1854 http://dev.catalyst.perl.org
1858 =head2 L<Catalyst::Manual> - The Catalyst Manual
1860 =head2 L<Catalyst::Component>, L<Catalyst::Base> - Base classes for components
1862 =head2 L<Catalyst::Engine> - Core engine
1864 =head2 L<Catalyst::Log> - Log class.
1866 =head2 L<Catalyst::Request> - Request object
1868 =head2 L<Catalyst::Response> - Response object
1870 =head2 L<Catalyst::Test> - The test suite.
1940 Sebastian Riedel, C<sri@oook.de>
1944 This library is free software, you can redistribute it and/or modify it under
1945 the same terms as Perl itself.