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 = 11;
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');
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:
191 Enables debug output.
195 Forces Catalyst to use a specific engine. Omit the
196 C<Catalyst::Engine::> prefix of the engine name, i.e.:
198 use Catalyst qw/-Engine=CGI/;
202 Forces Catalyst to use a specific home directory, e.g.:
204 use Catalyst qw[-Home=/usr/sri];
214 =head2 Information about the current request
220 Returns a L<Catalyst::Action> object for the current action, which
221 stringifies to the action name. See L<Catalyst::Action>.
225 Returns the namespace of the current action, i.e., the uri prefix
226 corresponding to the controller of the current action. For example:
228 # in Controller::Foo::Bar
229 $c->namespace; # returns 'foo/bar';
235 Returns the current L<Catalyst::Request> object. See
236 L<Catalyst::Request>.
240 =head2 Processing and response to the current request
244 =item $c->forward( $action [, \@arguments ] )
246 =item $c->forward( $class, $method, [, \@arguments ] )
248 Forwards processing to a private action. If you give a class name but no
249 method, C<process()> is called. You may also optionally pass arguments
250 in an arrayref. The action will receive the arguments in C<@_> and
251 C<$c-E<gt>req-E<gt>args>. Upon returning from the function,
252 C<$c-E<gt>req-E<gt>args> will be restored to the previous values.
255 $c->forward('index');
256 $c->forward(qw/MyApp::Model::CDBI::Foo do_stuff/);
257 $c->forward('MyApp::View::TT');
261 sub forward { my $c = shift; $c->dispatcher->forward( $c, @_ ) }
263 =item $c->detach( $action [, \@arguments ] )
265 =item $c->detach( $class, $method, [, \@arguments ] )
267 The same as C<forward>, but doesn't return.
271 sub detach { my $c = shift; $c->dispatcher->detach( $c, @_ ) }
275 =item $c->error($error, ...)
277 =item $c->error($arrayref)
279 Returns an arrayref containing error messages.
281 my @error = @{ $c->error };
285 $c->error('Something bad happened');
296 my $error = ref $_[0] eq 'ARRAY' ? $_[0] : [@_];
297 push @{ $c->{error} }, @$error;
299 elsif ( defined $_[0] ) { $c->{error} = undef }
300 return $c->{error} || [];
307 Returns the current L<Catalyst::Response> object.
311 Returns a hashref to the stash, which may be used to store data and pass
312 it between components during a request. You can also set hash keys by
313 passing arguments. The stash is automatically sent to the view. The
314 stash is cleared at the end of a request; it cannot be used for
317 $c->stash->{foo} = $bar;
318 $c->stash( { moose => 'majestic', qux => 0 } );
319 $c->stash( bar => 1, gorch => 2 ); # equivalent to passing a hashref
321 # stash is automatically passed to the view for use in a template
322 $c->forward( 'MyApp::V::TT' );
329 my $stash = @_ > 1 ? {@_} : $_[0];
330 while ( my ( $key, $val ) = each %$stash ) {
331 $c->{stash}->{$key} = $val;
339 Contains the return value of the last executed action.
343 =head2 Component Accessors
347 =item $c->comp($name)
349 =item $c->component($name)
351 Gets a component object by name. This method is no longer recommended,
352 unless you want to get a specific component by full
353 class. C<$c-E<gt>controller>, C<$c-E<gt>model>, and C<$c-E<gt>view>
354 should be used instead.
365 my $appclass = ref $c || $c;
368 $name, "${appclass}::${name}",
369 map { "${appclass}::${_}::${name}" }
370 qw/Model M Controller C View V/
373 foreach my $try (@names) {
375 if ( exists $c->components->{$try} ) {
377 return $c->components->{$try};
381 foreach my $component ( keys %{ $c->components } ) {
383 return $c->components->{$component} if $component =~ /$name/i;
388 return sort keys %{ $c->components };
391 =item $c->controller($name)
393 Gets a L<Catalyst::Controller> instance by name.
395 $c->controller('Foo')->do_stuff;
400 my ( $c, $name ) = @_;
401 my $controller = $c->comp("Controller::$name");
402 return $controller if $controller;
403 return $c->comp("C::$name");
406 =item $c->model($name)
408 Gets a L<Catalyst::Model> instance by name.
410 $c->model('Foo')->do_stuff;
415 my ( $c, $name ) = @_;
416 my $model = $c->comp("Model::$name");
417 return $model if $model;
418 return $c->comp("M::$name");
421 =item $c->view($name)
423 Gets a L<Catalyst::View> instance by name.
425 $c->view('Foo')->do_stuff;
430 my ( $c, $name ) = @_;
431 my $view = $c->comp("View::$name");
432 return $view if $view;
433 return $c->comp("V::$name");
438 =head2 Class data and helper classes
444 Returns or takes a hashref containing the application's configuration.
446 __PACKAGE__->config({ db => 'dsn:SQLite:foo.db' });
450 Overload to enable debug messages (same as -Debug option).
458 Returns the dispatcher instance. Stringifies to class name. See
459 L<Catalyst::Dispatcher>.
463 Returns the engine instance. Stringifies to the class name. See
468 Returns the logging object instance. Unless it is already set, Catalyst
469 sets this up with a L<Catalyst::Log> object. To use your own log class:
471 $c->log( MyLogger->new );
472 $c->log->info( 'Now logging with my own logger!' );
474 Your log class should implement the methods described in the
475 L<Catalyst::Log> man page.
481 =head2 Utility methods
485 =item $c->path_to(@path)
487 Merges C<@path> with C<$c-E<gt>config-E<gt>{home}> and returns a
488 L<Path::Class> object.
492 $c->path_to( 'db', 'sqlite.db' );
497 my ( $c, @path ) = @_;
498 my $path = dir( $c->config->{home}, @path );
499 if ( -d $path ) { return $path }
500 else { return file( $c->config->{home}, @path ) }
503 =item $c->plugin( $name, $class, @args )
505 Helper method for plugins. It creates a classdata accessor/mutator and
506 loads and instantiates the given class.
508 MyApp->plugin( 'prototype', 'HTML::Prototype' );
510 $c->prototype->define_javascript_functions;
515 my ( $class, $name, $plugin, @args ) = @_;
518 if ( my $error = $UNIVERSAL::require::ERROR ) {
519 Catalyst::Exception->throw(
520 message => qq/Couldn't load instant plugin "$plugin", "$error"/ );
523 eval { $plugin->import };
524 $class->mk_classdata($name);
526 eval { $obj = $plugin->new(@args) };
529 Catalyst::Exception->throw( message =>
530 qq/Couldn't instantiate instant plugin "$plugin", "$@"/ );
534 $class->log->debug(qq/Initialized instant plugin "$plugin" as "$name"/)
540 Initializes the dispatcher and engine, loads any plugins, and loads the
541 model, view, and controller components. You may also specify an array
542 of plugins to load here, if you choose to not load them in the C<use
546 MyApp->setup( qw/-Debug/ );
551 my ( $class, @arguments ) = @_;
553 unless ( $class->isa('Catalyst') ) {
555 Catalyst::Exception->throw(
556 message => qq/'$class' does not inherit from Catalyst/ );
559 if ( $class->arguments ) {
560 @arguments = ( @arguments, @{ $class->arguments } );
566 foreach (@arguments) {
570 ( $flags->{log} ) ? 'debug,' . $flags->{log} : 'debug';
572 elsif (/^-(\w+)=?(.*)$/) {
573 $flags->{ lc $1 } = $2;
576 push @{ $flags->{plugins} }, $_;
580 $class->setup_log( delete $flags->{log} );
581 $class->setup_plugins( delete $flags->{plugins} );
582 $class->setup_dispatcher( delete $flags->{dispatcher} );
583 $class->setup_engine( delete $flags->{engine} );
584 $class->setup_home( delete $flags->{home} );
586 for my $flag ( sort keys %{$flags} ) {
588 if ( my $code = $class->can( 'setup_' . $flag ) ) {
589 &$code( $class, delete $flags->{$flag} );
592 $class->log->warn(qq/Unknown flag "$flag"/);
597 <<"EOF") if ( $ENV{CATALYST_SCRIPT_GEN} && ( $ENV{CATALYST_SCRIPT_GEN} < $Catalyst::CATALYST_SCRIPT_GEN ) );
598 You are running an old script!
600 Please update by running:
601 catalyst.pl -nonew -scripts $class
604 if ( $class->debug ) {
610 @plugins = grep { /^Catalyst::Plugin/ } @{"$class\::ISA"};
614 my $t = Text::SimpleTable->new(76);
615 $t->row($_) for @plugins;
616 $class->log->debug( "Loaded plugins:\n" . $t->draw );
619 my $dispatcher = $class->dispatcher;
620 my $engine = $class->engine;
621 my $home = $class->config->{home};
623 $class->log->debug(qq/Loaded dispatcher "$dispatcher"/);
624 $class->log->debug(qq/Loaded engine "$engine"/);
628 ? $class->log->debug(qq/Found home "$home"/)
629 : $class->log->debug(qq/Home "$home" doesn't exist/)
630 : $class->log->debug(q/Couldn't find home/);
635 no warnings qw/redefine/;
636 local *setup = sub { };
640 # Initialize our data structure
641 $class->components( {} );
643 $class->setup_components;
645 if ( $class->debug ) {
646 my $t = Text::SimpleTable->new( [ 65, 'Class' ], [ 8, 'Type' ] );
647 for my $comp ( sort keys %{ $class->components } ) {
648 my $type = ref $class->components->{$comp} ? 'instance' : 'class';
649 $t->row( $comp, $type );
651 $class->log->debug( "Loaded components:\n" . $t->draw )
652 if ( keys %{ $class->components } );
655 # Add our self to components, since we are also a component
656 $class->components->{$class} = $class;
658 $class->setup_actions;
660 if ( $class->debug ) {
661 my $name = $class->config->{name} || 'Application';
662 $class->log->info("$name powered by Catalyst $Catalyst::VERSION");
664 $class->log->_flush() if $class->log->can('_flush');
667 =item $c->uri_for( $path, [ @args ] )
669 Merges path with C<$c-E<gt>request-E<gt>base> for absolute uri's and
670 with C<$c-E<gt>request-E<gt>match> for relative uri's, then returns a
671 normalized L<URI> object. If any args are passed, they are added at the
677 my ( $c, $path, @args ) = @_;
678 my $base = $c->request->base->clone;
679 my $basepath = $base->path;
680 $basepath =~ s/\/$//;
682 my $match = $c->request->match;
684 # massage match, empty if absolute path
686 $match .= '/' if $match;
688 $match = '' if $path =~ /^\//;
691 # join args with '/', or a blank string
692 my $args = ( scalar @args ? '/' . join( '/', @args ) : '' );
693 return URI->new_abs( URI->new_abs( "$path$args", "$basepath$match" ),
697 =item $c->welcome_message
699 Returns the Catalyst welcome HTML page.
703 sub welcome_message {
705 my $name = $c->config->{name};
706 my $logo = $c->uri_for('/static/images/catalyst_logo.png');
707 my $prefix = Catalyst::Utils::appprefix( ref $c );
708 $c->response->content_type('text/html; charset=utf-8');
710 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
711 "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
712 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
714 <meta http-equiv="Content-Language" content="en" />
715 <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
716 <title>$name on Catalyst $VERSION</title>
717 <style type="text/css">
720 background-color: #eee;
729 background-color: #ccc;
730 border: 1px solid #aaa;
731 -moz-border-radius: 10px;
736 font-family: verdana, tahoma, sans-serif;
739 font-family: verdana, tahoma, sans-serif;
742 text-decoration: none;
744 border-bottom: 1px dotted #bbb;
746 :link:hover, :visited:hover {
759 background-color: #fff;
760 border: 1px solid #aaa;
761 -moz-border-radius: 10px;
787 <h1><span id="appname">$name</span> on <a href="http://catalyst.perl.org">Catalyst</a>
792 <img src="$logo" alt="Catalyst Logo" />
794 <p>Welcome to the wonderful world of Catalyst.
795 This <a href="http://en.wikipedia.org/wiki/MVC">MVC</a>
796 framework will make web development something you had
797 never expected it to be: Fun, rewarding and quick.</p>
798 <h2>What to do now?</h2>
799 <p>That really depends on what <b>you</b> want to do.
800 We do, however, provide you with a few starting points.</p>
801 <p>If you want to jump right into web development with Catalyst
802 you might want to check out the documentation.</p>
803 <pre><code>perldoc <a href="http://cpansearch.perl.org/dist/Catalyst/lib/Catalyst/Manual/Intro.pod">Catalyst::Manual::Intro</a>
804 perldoc <a href="http://cpansearch.perl.org/dist/Catalyst/lib/Catalyst/Manual.pod">Catalyst::Manual</a></code></pre>
805 <h2>What to do next?</h2>
806 <p>Next it's time to write an actual application. Use the
807 helper scripts to generate <a href="http://cpansearch.perl.org/search?query=Catalyst%3A%3AController%3A%3A&mode=all">controllers</a>,
808 <a href="http://cpansearch.perl.org/search?query=Catalyst%3A%3AModel%3A%3A&mode=all">models</a> and
809 <a href="http://cpansearch.perl.org/search?query=Catalyst%3A%3AView%3A%3A&mode=all">views</a>,
810 they can save you a lot of work.</p>
811 <pre><code>script/${prefix}_create.pl -help</code></pre>
812 <p>Also, be sure to check out the vast and growing
813 collection of <a href="http://cpansearch.perl.org/search?query=Catalyst%3A%3APlugin%3A%3A&mode=all">plugins for Catalyst on CPAN</a>,
814 you are likely to find what you need there.
818 <p>Catalyst has a very active community. Here are the main places to
819 get in touch with us.</p>
822 <a href="http://dev.catalyst.perl.org">Wiki</a>
825 <a href="http://lists.rawmode.org/mailman/listinfo/catalyst">Mailing-List</a>
828 <a href="irc://irc.perl.org/catalyst">IRC channel #catalyst on irc.perl.org</a>
831 <h2>In conclusion</h2>
832 <p>The Catalyst team hopes you will enjoy using Catalyst as much
833 as we enjoyed making it. Please contact us if you have ideas
834 for improvement or other feedback.</p>
844 =head1 INTERNAL METHODS
846 These methods are not meant to be used by end users.
850 =item $c->benchmark( $coderef )
852 Takes a coderef with arguments and returns elapsed time as float.
854 my ( $elapsed, $status ) = $c->benchmark( sub { return 1 } );
855 $c->log->info( sprintf "Processing took %f seconds", $elapsed );
862 my $time = [gettimeofday];
863 my @return = &$code(@_);
864 my $elapsed = tv_interval $time;
865 return wantarray ? ( $elapsed, @return ) : $elapsed;
870 Returns a hash of components.
872 =item $c->context_class
874 Returns or sets the context class.
878 Returns a hashref containing coderefs and execution counts (needed for
879 deep recursion detection).
883 Returns the number of actions on the current internal execution stack.
887 Dispatches a request to actions.
891 sub dispatch { my $c = shift; $c->dispatcher->dispatch( $c, @_ ) }
893 =item $c->dispatcher_class
895 Returns or sets the dispatcher class.
899 Returns a list of 2-element array references (name, structure) pairs
900 that will be dumped on the error page in debug mode.
906 [ Request => $c->req ], [ Response => $c->res ], [ Stash => $c->stash ],;
909 =item $c->engine_class
911 Returns or sets the engine class.
913 =item $c->execute( $class, $coderef )
915 Execute a coderef in given class and catch exceptions. Errors are available
921 my ( $c, $class, $code ) = @_;
922 $class = $c->components->{$class} || $class;
926 ( caller(0) )[0]->isa('Catalyst::Action')
933 $action = "/$action" unless $action =~ /\-\>/;
934 $c->counter->{"$code"}++;
936 if ( $c->counter->{"$code"} > $RECURSION ) {
937 my $error = qq/Deep recursion detected in "$action"/;
938 $c->log->error($error);
944 $action = "-> $action" if $callsub =~ /forward$/;
946 push( @{ $c->stack }, $code );
950 my ( $elapsed, @state ) =
951 $c->benchmark( $code, $class, $c, @{ $c->req->args } );
952 unless ( ( $code->name =~ /^_.*/ )
953 && ( !$c->config->{show_internal_actions} ) )
955 push @{ $c->{stats} }, [ $action, sprintf( '%fs', $elapsed ) ];
960 $c->state( &$code( $class, $c, @{ $c->req->args } ) || 0 );
963 pop( @{ $c->stack } );
965 if ( my $error = $@ ) {
967 if ( $error eq $DETACH ) { die $DETACH if $c->depth > 1 }
969 unless ( ref $error ) {
971 $error = qq/Caught exception "$error"/;
982 Finalizes the request.
989 for my $error ( @{ $c->error } ) {
990 $c->log->error($error);
993 $c->finalize_uploads;
996 if ( $#{ $c->error } >= 0 ) {
1000 $c->finalize_headers;
1003 if ( $c->request->method eq 'HEAD' ) {
1004 $c->response->body('');
1009 return $c->response->status;
1012 =item $c->finalize_body
1018 sub finalize_body { my $c = shift; $c->engine->finalize_body( $c, @_ ) }
1020 =item $c->finalize_cookies
1026 sub finalize_cookies { my $c = shift; $c->engine->finalize_cookies( $c, @_ ) }
1028 =item $c->finalize_error
1034 sub finalize_error { my $c = shift; $c->engine->finalize_error( $c, @_ ) }
1036 =item $c->finalize_headers
1042 sub finalize_headers {
1045 # Check if we already finalized headers
1046 return if $c->response->{_finalized_headers};
1049 if ( my $location = $c->response->redirect ) {
1050 $c->log->debug(qq/Redirecting to "$location"/) if $c->debug;
1051 $c->response->header( Location => $location );
1055 if ( $c->response->body && !$c->response->content_length ) {
1056 $c->response->content_length( bytes::length( $c->response->body ) );
1060 if ( $c->response->status =~ /^(1\d\d|[23]04)$/ ) {
1061 $c->response->headers->remove_header("Content-Length");
1062 $c->response->body('');
1065 $c->finalize_cookies;
1067 $c->engine->finalize_headers( $c, @_ );
1070 $c->response->{_finalized_headers} = 1;
1073 =item $c->finalize_output
1075 An alias for finalize_body.
1077 =item $c->finalize_read
1079 Finalizes the input after reading is complete.
1083 sub finalize_read { my $c = shift; $c->engine->finalize_read( $c, @_ ) }
1085 =item $c->finalize_uploads
1087 Finalizes uploads. Cleans up any temporary files.
1091 sub finalize_uploads { my $c = shift; $c->engine->finalize_uploads( $c, @_ ) }
1093 =item $c->get_action( $action, $namespace )
1095 Gets an action in a given namespace.
1099 sub get_action { my $c = shift; $c->dispatcher->get_action(@_) }
1101 =item $c->get_actions( $action, $namespace )
1103 Gets all actions of a given name in a namespace and all parent
1108 sub get_actions { my $c = shift; $c->dispatcher->get_actions( $c, @_ ) }
1110 =item handle_request( $class, @arguments )
1112 Called to handle each HTTP request.
1116 sub handle_request {
1117 my ( $class, @arguments ) = @_;
1119 # Always expect worst case!
1125 my $c = $class->prepare(@arguments);
1126 $c->{stats} = \@stats;
1128 return $c->finalize;
1131 if ( $class->debug ) {
1133 ( $elapsed, $status ) = $class->benchmark($handler);
1134 $elapsed = sprintf '%f', $elapsed;
1135 my $av = sprintf '%.3f',
1136 ( $elapsed == 0 ? '??' : ( 1 / $elapsed ) );
1137 my $t = Text::SimpleTable->new( [ 64, 'Action' ], [ 9, 'Time' ] );
1139 for my $stat (@stats) { $t->row( $stat->[0], $stat->[1] ) }
1141 "Request took ${elapsed}s ($av/s)\n" . $t->draw );
1143 else { $status = &$handler }
1147 if ( my $error = $@ ) {
1149 $class->log->error(qq/Caught exception in engine "$error"/);
1153 $class->log->_flush() if $class->log->can('_flush');
1157 =item $c->prepare( @arguments )
1159 Creates a Catalyst context from an engine-specific request (Apache, CGI,
1165 my ( $class, @arguments ) = @_;
1167 $class->context_class( ref $class || $class ) unless $class->context_class;
1168 my $c = $class->context_class->new(
1172 request => $class->request_class->new(
1175 body_parameters => {},
1177 headers => HTTP::Headers->new,
1179 query_parameters => {},
1185 response => $class->response_class->new(
1189 headers => HTTP::Headers->new(),
1198 # For on-demand data
1199 $c->request->{_context} = $c;
1200 $c->response->{_context} = $c;
1201 weaken( $c->request->{_context} );
1202 weaken( $c->response->{_context} );
1205 my $secs = time - $START || 1;
1206 my $av = sprintf '%.3f', $COUNT / $secs;
1207 $c->log->debug('**********************************');
1208 $c->log->debug("* Request $COUNT ($av/s) [$$]");
1209 $c->log->debug('**********************************');
1210 $c->res->headers->header( 'X-Catalyst' => $Catalyst::VERSION );
1213 $c->prepare_request(@arguments);
1214 $c->prepare_connection;
1215 $c->prepare_query_parameters;
1216 $c->prepare_headers;
1217 $c->prepare_cookies;
1221 $c->prepare_body unless $c->config->{parse_on_demand};
1223 my $method = $c->req->method || '';
1224 my $path = $c->req->path || '';
1225 my $address = $c->req->address || '';
1227 $c->log->debug(qq/"$method" request for "$path" from "$address"/)
1235 =item $c->prepare_action
1241 sub prepare_action { my $c = shift; $c->dispatcher->prepare_action( $c, @_ ) }
1243 =item $c->prepare_body
1245 Prepares message body.
1252 # Do we run for the first time?
1253 return if defined $c->request->{_body};
1255 # Initialize on-demand data
1256 $c->engine->prepare_body( $c, @_ );
1257 $c->prepare_parameters;
1258 $c->prepare_uploads;
1260 if ( $c->debug && keys %{ $c->req->body_parameters } ) {
1261 my $t = Text::SimpleTable->new( [ 37, 'Key' ], [ 36, 'Value' ] );
1262 for my $key ( sort keys %{ $c->req->body_parameters } ) {
1263 my $param = $c->req->body_parameters->{$key};
1264 my $value = defined($param) ? $param : '';
1266 ref $value eq 'ARRAY' ? ( join ', ', @$value ) : $value );
1268 $c->log->debug( "Body Parameters are:\n" . $t->draw );
1272 =item $c->prepare_body_chunk( $chunk )
1274 Prepares a chunk of data before sending it to L<HTTP::Body>.
1278 sub prepare_body_chunk {
1280 $c->engine->prepare_body_chunk( $c, @_ );
1283 =item $c->prepare_body_parameters
1285 Prepares body parameters.
1289 sub prepare_body_parameters {
1291 $c->engine->prepare_body_parameters( $c, @_ );
1294 =item $c->prepare_connection
1296 Prepares connection.
1300 sub prepare_connection {
1302 $c->engine->prepare_connection( $c, @_ );
1305 =item $c->prepare_cookies
1311 sub prepare_cookies { my $c = shift; $c->engine->prepare_cookies( $c, @_ ) }
1313 =item $c->prepare_headers
1319 sub prepare_headers { my $c = shift; $c->engine->prepare_headers( $c, @_ ) }
1321 =item $c->prepare_parameters
1323 Prepares parameters.
1327 sub prepare_parameters {
1329 $c->prepare_body_parameters;
1330 $c->engine->prepare_parameters( $c, @_ );
1333 =item $c->prepare_path
1335 Prepares path and base.
1339 sub prepare_path { my $c = shift; $c->engine->prepare_path( $c, @_ ) }
1341 =item $c->prepare_query_parameters
1343 Prepares query parameters.
1347 sub prepare_query_parameters {
1350 $c->engine->prepare_query_parameters( $c, @_ );
1352 if ( $c->debug && keys %{ $c->request->query_parameters } ) {
1353 my $t = Text::SimpleTable->new( [ 37, 'Key' ], [ 36, 'Value' ] );
1354 for my $key ( sort keys %{ $c->req->query_parameters } ) {
1355 my $param = $c->req->query_parameters->{$key};
1356 my $value = defined($param) ? $param : '';
1358 ref $value eq 'ARRAY' ? ( join ', ', @$value ) : $value );
1360 $c->log->debug( "Query Parameters are:\n" . $t->draw );
1364 =item $c->prepare_read
1366 Prepares the input for reading.
1370 sub prepare_read { my $c = shift; $c->engine->prepare_read( $c, @_ ) }
1372 =item $c->prepare_request
1374 Prepares the engine request.
1378 sub prepare_request { my $c = shift; $c->engine->prepare_request( $c, @_ ) }
1380 =item $c->prepare_uploads
1386 sub prepare_uploads {
1389 $c->engine->prepare_uploads( $c, @_ );
1391 if ( $c->debug && keys %{ $c->request->uploads } ) {
1392 my $t = Text::SimpleTable->new(
1398 for my $key ( sort keys %{ $c->request->uploads } ) {
1399 my $upload = $c->request->uploads->{$key};
1400 for my $u ( ref $upload eq 'ARRAY' ? @{$upload} : ($upload) ) {
1401 $t->row( $key, $u->filename, $u->type, $u->size );
1404 $c->log->debug( "File Uploads are:\n" . $t->draw );
1408 =item $c->prepare_write
1410 Prepares the output for writing.
1414 sub prepare_write { my $c = shift; $c->engine->prepare_write( $c, @_ ) }
1416 =item $c->request_class
1418 Returns or sets the request class.
1420 =item $c->response_class
1422 Returns or sets the response class.
1424 =item $c->read( [$maxlength] )
1426 Reads a chunk of data from the request body. This method is designed to
1427 be used in a while loop, reading C<$maxlength> bytes on every call.
1428 C<$maxlength> defaults to the size of the request if not specified.
1430 You have to set C<MyApp-E<gt>config-E<gt>{parse_on_demand}> to use this
1435 sub read { my $c = shift; return $c->engine->read( $c, @_ ) }
1443 sub run { my $c = shift; return $c->engine->run( $c, @_ ) }
1445 =item $c->set_action( $action, $code, $namespace, $attrs )
1447 Sets an action in a given namespace.
1451 sub set_action { my $c = shift; $c->dispatcher->set_action( $c, @_ ) }
1453 =item $c->setup_actions($component)
1455 Sets up actions for a component.
1459 sub setup_actions { my $c = shift; $c->dispatcher->setup_actions( $c, @_ ) }
1461 =item $c->setup_components
1467 sub setup_components {
1470 my $callback = sub {
1471 my ( $component, $context ) = @_;
1473 unless ( $component->isa('Catalyst::Component') ) {
1477 my $suffix = Catalyst::Utils::class2classsuffix($component);
1478 my $config = $class->config->{$suffix} || {};
1482 eval { $instance = $component->new( $context, $config ); };
1484 if ( my $error = $@ ) {
1488 Catalyst::Exception->throw( message =>
1489 qq/Couldn't instantiate component "$component", "$error"/ );
1492 Catalyst::Exception->throw( message =>
1493 qq/Couldn't instantiate component "$component", "new() didn't return a object"/
1495 unless ref $instance;
1500 Module::Pluggable::Fast->import(
1501 name => '_catalyst_components',
1503 "$class\::Controller", "$class\::C",
1504 "$class\::Model", "$class\::M",
1505 "$class\::View", "$class\::V"
1507 callback => $callback
1511 if ( my $error = $@ ) {
1515 Catalyst::Exception->throw(
1516 message => qq/Couldn't load components "$error"/ );
1519 for my $component ( $class->_catalyst_components($class) ) {
1520 $class->components->{ ref $component || $component } = $component;
1524 =item $c->setup_dispatcher
1530 sub setup_dispatcher {
1531 my ( $class, $dispatcher ) = @_;
1534 $dispatcher = 'Catalyst::Dispatcher::' . $dispatcher;
1537 if ( $ENV{CATALYST_DISPATCHER} ) {
1538 $dispatcher = 'Catalyst::Dispatcher::' . $ENV{CATALYST_DISPATCHER};
1541 if ( $ENV{ uc($class) . '_DISPATCHER' } ) {
1543 'Catalyst::Dispatcher::' . $ENV{ uc($class) . '_DISPATCHER' };
1546 unless ($dispatcher) {
1547 $dispatcher = $class->dispatcher_class;
1550 $dispatcher->require;
1553 Catalyst::Exception->throw(
1554 message => qq/Couldn't load dispatcher "$dispatcher", "$@"/ );
1557 # dispatcher instance
1558 $class->dispatcher( $dispatcher->new );
1561 =item $c->setup_engine
1568 my ( $class, $engine ) = @_;
1571 $engine = 'Catalyst::Engine::' . $engine;
1574 if ( $ENV{CATALYST_ENGINE} ) {
1575 $engine = 'Catalyst::Engine::' . $ENV{CATALYST_ENGINE};
1578 if ( $ENV{ uc($class) . '_ENGINE' } ) {
1579 $engine = 'Catalyst::Engine::' . $ENV{ uc($class) . '_ENGINE' };
1582 if ( !$engine && $ENV{MOD_PERL} ) {
1584 # create the apache method
1587 *{"$class\::apache"} = sub { shift->engine->apache };
1590 my ( $software, $version ) =
1591 $ENV{MOD_PERL} =~ /^(\S+)\/(\d+(?:[\.\_]\d+)+)/;
1594 $version =~ s/(\.[^.]+)\./$1/g;
1596 if ( $software eq 'mod_perl' ) {
1598 if ( $version >= 1.99922 ) {
1599 $engine = 'Catalyst::Engine::Apache2::MP20';
1602 elsif ( $version >= 1.9901 ) {
1603 $engine = 'Catalyst::Engine::Apache2::MP19';
1606 elsif ( $version >= 1.24 ) {
1607 $engine = 'Catalyst::Engine::Apache::MP13';
1611 Catalyst::Exception->throw( message =>
1612 qq/Unsupported mod_perl version: $ENV{MOD_PERL}/ );
1615 # install the correct mod_perl handler
1616 if ( $version >= 1.9901 ) {
1617 *handler = sub : method {
1618 shift->handle_request(@_);
1622 *handler = sub ($$) { shift->handle_request(@_) };
1627 elsif ( $software eq 'Zeus-Perl' ) {
1628 $engine = 'Catalyst::Engine::Zeus';
1632 Catalyst::Exception->throw(
1633 message => qq/Unsupported mod_perl: $ENV{MOD_PERL}/ );
1638 $engine = $class->engine_class;
1644 Catalyst::Exception->throw( message =>
1645 qq/Couldn't load engine "$engine" (maybe you forgot to install it?), "$@"/
1649 # check for old engines that are no longer compatible
1651 if ( $engine->isa('Catalyst::Engine::Apache')
1652 && !Catalyst::Engine::Apache->VERSION )
1657 elsif ( $engine->isa('Catalyst::Engine::Server::Base')
1658 && Catalyst::Engine::Server->VERSION le '0.02' )
1663 elsif ($engine->isa('Catalyst::Engine::HTTP::POE')
1664 && $engine->VERSION eq '0.01' )
1669 elsif ($engine->isa('Catalyst::Engine::Zeus')
1670 && $engine->VERSION eq '0.01' )
1676 Catalyst::Exception->throw( message =>
1677 qq/Engine "$engine" is not supported by this version of Catalyst/
1682 $class->engine( $engine->new );
1685 =item $c->setup_home
1687 Sets up the home directory.
1692 my ( $class, $home ) = @_;
1694 if ( $ENV{CATALYST_HOME} ) {
1695 $home = $ENV{CATALYST_HOME};
1698 if ( $ENV{ uc($class) . '_HOME' } ) {
1699 $home = $ENV{ uc($class) . '_HOME' };
1703 $home = Catalyst::Utils::home($class);
1707 $class->config->{home} ||= $home;
1708 $class->config->{root} ||= dir($home)->subdir('root');
1719 my ( $class, $debug ) = @_;
1721 unless ( $class->log ) {
1722 $class->log( Catalyst::Log->new );
1725 my $app_flag = Catalyst::Utils::class2env($class) . '_DEBUG';
1728 ( defined( $ENV{CATALYST_DEBUG} ) || defined( $ENV{$app_flag} ) )
1729 ? ( $ENV{CATALYST_DEBUG} || $ENV{$app_flag} )
1734 *{"$class\::debug"} = sub { 1 };
1735 $class->log->debug('Debug messages enabled');
1739 =item $c->setup_plugins
1746 my ( $class, $plugins ) = @_;
1749 for my $plugin ( reverse @$plugins ) {
1751 $plugin = "Catalyst::Plugin::$plugin";
1756 Catalyst::Exception->throw(
1757 message => qq/Couldn't load plugin "$plugin", "$@"/ );
1762 unshift @{"$class\::ISA"}, $plugin;
1771 =item $c->write( $data )
1773 Writes $data to the output stream. When using this method directly, you
1774 will need to manually set the C<Content-Length> header to the length of
1775 your output data, if known.
1782 # Finalize headers if someone manually writes output
1783 $c->finalize_headers;
1785 return $c->engine->write( $c, @_ );
1790 Returns the Catalyst version number. Mostly useful for "powered by"
1791 messages in template systems.
1795 sub version { return $Catalyst::VERSION }
1799 =head1 INTERNAL ACTIONS
1801 Catalyst uses internal actions like C<_DISPATCH>, C<_BEGIN>, C<_AUTO>,
1802 C<_ACTION>, and C<_END>. These are by default not shown in the private
1803 action table, but you can make them visible with a config parameter.
1805 MyApp->config->{show_internal_actions} = 1;
1807 =head1 CASE SENSITIVITY
1809 By default Catalyst is not case sensitive, so C<MyApp::C::FOO::Bar> is
1810 mapped to C</foo/bar>. You can activate case sensitivity with a config
1813 MyApp->config->{case_sensitive} = 1;
1815 This causes C<MyApp::C::Foo::Bar> to map to C</Foo/Bar>.
1817 =head1 ON-DEMAND PARSER
1819 The request body is usually parsed at the beginning of a request,
1820 but if you want to handle input yourself or speed things up a bit,
1821 you can enable on-demand parsing with a config parameter.
1823 MyApp->config->{parse_on_demand} = 1;
1825 =head1 PROXY SUPPORT
1827 Many production servers operate using the common double-server approach,
1828 with a lightweight frontend web server passing requests to a larger
1829 backend server. An application running on the backend server must deal
1830 with two problems: the remote user always appears to be C<127.0.0.1> and
1831 the server's hostname will appear to be C<localhost> regardless of the
1832 virtual host that the user connected through.
1834 Catalyst will automatically detect this situation when you are running
1835 the frontend and backend servers on the same machine. The following
1836 changes are made to the request.
1838 $c->req->address is set to the user's real IP address, as read from
1839 the HTTP X-Forwarded-For header.
1841 The host value for $c->req->base and $c->req->uri is set to the real
1842 host, as read from the HTTP X-Forwarded-Host header.
1844 Obviously, your web server must support these headers for this to work.
1846 In a more complex server farm environment where you may have your
1847 frontend proxy server(s) on different machines, you will need to set a
1848 configuration option to tell Catalyst to read the proxied data from the
1851 MyApp->config->{using_frontend_proxy} = 1;
1853 If you do not wish to use the proxy support at all, you may set:
1855 MyApp->config->{ignore_frontend_proxy} = 1;
1857 =head1 THREAD SAFETY
1859 Catalyst has been tested under Apache 2's threading mpm_worker, mpm_winnt,
1860 and the standalone forking HTTP server on Windows. We believe the Catalyst
1861 core to be thread-safe.
1863 If you plan to operate in a threaded environment, remember that all other
1864 modules you are using must also be thread-safe. Some modules, most notably
1865 L<DBD::SQLite>, are not thread-safe.
1871 Join #catalyst on irc.perl.org.
1875 http://lists.rawmode.org/mailman/listinfo/catalyst
1876 http://lists.rawmode.org/mailman/listinfo/catalyst-dev
1880 http://catalyst.perl.org
1884 http://dev.catalyst.perl.org
1890 =item L<Catalyst::Manual> - The Catalyst Manual
1892 =item L<Catalyst::Component>, L<Catalyst::Base> - Base classes for components
1894 =item L<Catalyst::Engine> - Core engine
1896 =item L<Catalyst::Log> - Log class.
1898 =item L<Catalyst::Request> - Request object
1900 =item L<Catalyst::Response> - Response object
1902 =item L<Catalyst::Test> - The test suite.
1972 Sebastian Riedel, C<sri@oook.de>
1976 This library is free software, you can redistribute it and/or modify it under
1977 the same terms as Perl itself.