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:
204 Enables debug output.
208 Forces Catalyst to use a specific engine. Omit the
209 C<Catalyst::Engine::> prefix of the engine name, i.e.:
211 use Catalyst qw/-Engine=CGI/;
215 Forces Catalyst to use a specific home directory, e.g.:
217 use Catalyst qw[-Home=/usr/sri];
227 =head2 Information about the current request
233 Returns a L<Catalyst::Action> object for the current action, which
234 stringifies to the action name. See L<Catalyst::Action>.
238 Returns the namespace of the current action, i.e., the uri prefix
239 corresponding to the controller of the current action. For example:
241 # in Controller::Foo::Bar
242 $c->namespace; # returns 'foo/bar';
248 Returns the current L<Catalyst::Request> object. See
249 L<Catalyst::Request>.
253 =head2 Processing and response to the current request
257 =item $c->forward( $action [, \@arguments ] )
259 =item $c->forward( $class, $method, [, \@arguments ] )
261 Forwards processing to a private action. If you give a class name but no
262 method, C<process()> is called. You may also optionally pass arguments
263 in an arrayref. The action will receive the arguments in C<@_> and
264 C<$c-E<gt>req-E<gt>args>. Upon returning from the function,
265 C<$c-E<gt>req-E<gt>args> will be restored to the previous values.
268 $c->forward('index');
269 $c->forward(qw/MyApp::Model::CDBI::Foo do_stuff/);
270 $c->forward('MyApp::View::TT');
274 sub forward { my $c = shift; $c->dispatcher->forward( $c, @_ ) }
276 =item $c->detach( $action [, \@arguments ] )
278 =item $c->detach( $class, $method, [, \@arguments ] )
280 The same as C<forward>, but doesn't return.
284 sub detach { my $c = shift; $c->dispatcher->detach( $c, @_ ) }
288 =item $c->error($error, ...)
290 =item $c->error($arrayref)
292 Returns an arrayref containing error messages.
294 my @error = @{ $c->error };
298 $c->error('Something bad happened');
309 my $error = ref $_[0] eq 'ARRAY' ? $_[0] : [@_];
310 push @{ $c->{error} }, @$error;
312 elsif ( defined $_[0] ) { $c->{error} = undef }
313 return $c->{error} || [];
320 Returns the current L<Catalyst::Response> object.
324 Returns a hashref to the stash, which may be used to store data and pass
325 it between components during a request. You can also set hash keys by
326 passing arguments. The stash is automatically sent to the view. The
327 stash is cleared at the end of a request; it cannot be used for
330 $c->stash->{foo} = $bar;
331 $c->stash( { moose => 'majestic', qux => 0 } );
332 $c->stash( bar => 1, gorch => 2 ); # equivalent to passing a hashref
334 # stash is automatically passed to the view for use in a template
335 $c->forward( 'MyApp::V::TT' );
342 my $stash = @_ > 1 ? {@_} : $_[0];
343 while ( my ( $key, $val ) = each %$stash ) {
344 $c->{stash}->{$key} = $val;
352 Contains the return value of the last executed action.
356 =head2 Component Accessors
360 =item $c->comp($name)
362 =item $c->component($name)
364 Gets a component object by name. This method is no longer recommended,
365 unless you want to get a specific component by full
366 class. C<$c-E<gt>controller>, C<$c-E<gt>model>, and C<$c-E<gt>view>
367 should be used instead.
378 my $appclass = ref $c || $c;
381 $name, "${appclass}::${name}",
382 map { "${appclass}::${_}::${name}" }
383 qw/Model M Controller C View V/
386 foreach my $try (@names) {
388 if ( exists $c->components->{$try} ) {
390 return $c->components->{$try};
394 foreach my $component ( keys %{ $c->components } ) {
396 return $c->components->{$component} if $component =~ /$name/i;
401 return sort keys %{ $c->components };
404 =item $c->controller($name)
406 Gets a L<Catalyst::Controller> instance by name.
408 $c->controller('Foo')->do_stuff;
413 my ( $c, $name ) = @_;
414 my $controller = $c->comp("Controller::$name");
415 return $controller if $controller;
416 return $c->comp("C::$name");
419 =item $c->model($name)
421 Gets a L<Catalyst::Model> instance by name.
423 $c->model('Foo')->do_stuff;
428 my ( $c, $name ) = @_;
429 my $model = $c->comp("Model::$name");
430 return $model if $model;
431 return $c->comp("M::$name");
434 =item $c->view($name)
436 Gets a L<Catalyst::View> instance by name.
438 $c->view('Foo')->do_stuff;
443 my ( $c, $name ) = @_;
444 my $view = $c->comp("View::$name");
445 return $view if $view;
446 return $c->comp("V::$name");
451 =head2 Class data and helper classes
457 Returns or takes a hashref containing the application's configuration.
459 __PACKAGE__->config({ db => 'dsn:SQLite:foo.db' });
463 Overload to enable debug messages (same as -Debug option).
471 Returns the dispatcher instance. Stringifies to class name. See
472 L<Catalyst::Dispatcher>.
476 Returns the engine instance. Stringifies to the class name. See
481 Returns the logging object instance. Unless it is already set, Catalyst
482 sets this up with a L<Catalyst::Log> object. To use your own log class:
484 $c->log( MyLogger->new );
485 $c->log->info( 'Now logging with my own logger!' );
487 Your log class should implement the methods described in the
488 L<Catalyst::Log> man page.
494 =head2 Utility methods
498 =item $c->path_to(@path)
500 Merges C<@path> with C<$c-E<gt>config-E<gt>{home}> and returns a
501 L<Path::Class> object.
505 $c->path_to( 'db', 'sqlite.db' );
510 my ( $c, @path ) = @_;
511 my $path = dir( $c->config->{home}, @path );
512 if ( -d $path ) { return $path }
513 else { return file( $c->config->{home}, @path ) }
516 =item $c->plugin( $name, $class, @args )
518 Helper method for plugins. It creates a classdata accessor/mutator and
519 loads and instantiates the given class.
521 MyApp->plugin( 'prototype', 'HTML::Prototype' );
523 $c->prototype->define_javascript_functions;
528 my ( $class, $name, $plugin, @args ) = @_;
531 if ( my $error = $UNIVERSAL::require::ERROR ) {
532 Catalyst::Exception->throw(
533 message => qq/Couldn't load instant plugin "$plugin", "$error"/ );
536 eval { $plugin->import };
537 $class->mk_classdata($name);
539 eval { $obj = $plugin->new(@args) };
542 Catalyst::Exception->throw( message =>
543 qq/Couldn't instantiate instant plugin "$plugin", "$@"/ );
547 $class->log->debug(qq/Initialized instant plugin "$plugin" as "$name"/)
553 Initializes the dispatcher and engine, loads any plugins, and loads the
554 model, view, and controller components. You may also specify an array
555 of plugins to load here, if you choose to not load them in the C<use
559 MyApp->setup( qw/-Debug/ );
564 my ( $class, @arguments ) = @_;
566 unless ( $class->isa('Catalyst') ) {
568 Catalyst::Exception->throw(
569 message => qq/'$class' does not inherit from Catalyst/ );
572 if ( $class->arguments ) {
573 @arguments = ( @arguments, @{ $class->arguments } );
579 foreach (@arguments) {
583 ( $flags->{log} ) ? 'debug,' . $flags->{log} : 'debug';
585 elsif (/^-(\w+)=?(.*)$/) {
586 $flags->{ lc $1 } = $2;
589 push @{ $flags->{plugins} }, $_;
593 $class->setup_log( delete $flags->{log} );
594 $class->setup_plugins( delete $flags->{plugins} );
595 $class->setup_dispatcher( delete $flags->{dispatcher} );
596 $class->setup_engine( delete $flags->{engine} );
597 $class->setup_home( delete $flags->{home} );
599 for my $flag ( sort keys %{$flags} ) {
601 if ( my $code = $class->can( 'setup_' . $flag ) ) {
602 &$code( $class, delete $flags->{$flag} );
605 $class->log->warn(qq/Unknown flag "$flag"/);
610 <<"EOF") if ( $ENV{CATALYST_SCRIPT_GEN} && ( $ENV{CATALYST_SCRIPT_GEN} < $Catalyst::CATALYST_SCRIPT_GEN ) );
611 You are running an old script!
613 Please update by running:
614 catalyst.pl -nonew -scripts $class
617 if ( $class->debug ) {
623 @plugins = grep { /^Catalyst::Plugin/ } @{"$class\::ISA"};
627 my $t = Text::SimpleTable->new(76);
628 $t->row($_) for @plugins;
629 $class->log->debug( "Loaded plugins:\n" . $t->draw );
632 my $dispatcher = $class->dispatcher;
633 my $engine = $class->engine;
634 my $home = $class->config->{home};
636 $class->log->debug(qq/Loaded dispatcher "$dispatcher"/);
637 $class->log->debug(qq/Loaded engine "$engine"/);
641 ? $class->log->debug(qq/Found home "$home"/)
642 : $class->log->debug(qq/Home "$home" doesn't exist/)
643 : $class->log->debug(q/Couldn't find home/);
648 no warnings qw/redefine/;
649 local *setup = sub { };
653 # Initialize our data structure
654 $class->components( {} );
656 $class->setup_components;
658 if ( $class->debug ) {
659 my $t = Text::SimpleTable->new( [ 65, 'Class' ], [ 8, 'Type' ] );
660 for my $comp ( sort keys %{ $class->components } ) {
661 my $type = ref $class->components->{$comp} ? 'instance' : 'class';
662 $t->row( $comp, $type );
664 $class->log->debug( "Loaded components:\n" . $t->draw )
665 if ( keys %{ $class->components } );
668 # Add our self to components, since we are also a component
669 $class->components->{$class} = $class;
671 $class->setup_actions;
673 if ( $class->debug ) {
674 my $name = $class->config->{name} || 'Application';
675 $class->log->info("$name powered by Catalyst $Catalyst::VERSION");
677 $class->log->_flush() if $class->log->can('_flush');
680 =item $c->uri_for( $path, [ @args ] )
682 Merges path with C<$c-E<gt>request-E<gt>base> for absolute uri's and
683 with C<$c-E<gt>namespace> for relative uri's, then returns a
684 normalized L<URI> object. If any args are passed, they are added at the
690 my ( $c, $path, @args ) = @_;
691 my $base = $c->request->base->clone;
692 my $basepath = $base->path;
693 $basepath =~ s/\/$//;
695 my $namespace = $c->namespace;
697 # massage namespace, empty if absolute path
698 $namespace =~ s/^\///;
699 $namespace .= '/' if $namespace;
701 $namespace = '' if $path =~ /^\//;
704 # join args with '/', or a blank string
705 my $args = ( scalar @args ? '/' . join( '/', @args ) : '' );
706 return URI->new_abs( URI->new_abs( "$path$args", "$basepath$namespace" ),
710 =item $c->welcome_message
712 Returns the Catalyst welcome HTML page.
716 sub welcome_message {
718 my $name = $c->config->{name};
719 my $logo = $c->uri_for('/static/images/catalyst_logo.png');
720 my $prefix = Catalyst::Utils::appprefix( ref $c );
721 $c->response->content_type('text/html; charset=utf-8');
723 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
724 "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
725 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
727 <meta http-equiv="Content-Language" content="en" />
728 <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
729 <title>$name on Catalyst $VERSION</title>
730 <style type="text/css">
733 background-color: #eee;
742 background-color: #ccc;
743 border: 1px solid #aaa;
744 -moz-border-radius: 10px;
749 font-family: verdana, tahoma, sans-serif;
752 font-family: verdana, tahoma, sans-serif;
755 text-decoration: none;
757 border-bottom: 1px dotted #bbb;
759 :link:hover, :visited:hover {
772 background-color: #fff;
773 border: 1px solid #aaa;
774 -moz-border-radius: 10px;
800 <h1><span id="appname">$name</span> on <a href="http://catalyst.perl.org">Catalyst</a>
805 <img src="$logo" alt="Catalyst Logo" />
807 <p>Welcome to the wonderful world of Catalyst.
808 This <a href="http://en.wikipedia.org/wiki/MVC">MVC</a>
809 framework will make web development something you had
810 never expected it to be: Fun, rewarding and quick.</p>
811 <h2>What to do now?</h2>
812 <p>That really depends on what <b>you</b> want to do.
813 We do, however, provide you with a few starting points.</p>
814 <p>If you want to jump right into web development with Catalyst
815 you might want to check out the documentation.</p>
816 <pre><code>perldoc <a href="http://cpansearch.perl.org/dist/Catalyst/lib/Catalyst/Manual/Intro.pod">Catalyst::Manual::Intro</a>
817 perldoc <a href="http://cpansearch.perl.org/dist/Catalyst/lib/Catalyst/Manual.pod">Catalyst::Manual</a></code></pre>
818 <h2>What to do next?</h2>
819 <p>Next it's time to write an actual application. Use the
820 helper scripts to generate <a href="http://cpansearch.perl.org/search?query=Catalyst%3A%3AController%3A%3A&mode=all">controllers</a>,
821 <a href="http://cpansearch.perl.org/search?query=Catalyst%3A%3AModel%3A%3A&mode=all">models</a> and
822 <a href="http://cpansearch.perl.org/search?query=Catalyst%3A%3AView%3A%3A&mode=all">views</a>,
823 they can save you a lot of work.</p>
824 <pre><code>script/${prefix}_create.pl -help</code></pre>
825 <p>Also, be sure to check out the vast and growing
826 collection of <a href="http://cpansearch.perl.org/search?query=Catalyst%3A%3APlugin%3A%3A&mode=all">plugins for Catalyst on CPAN</a>,
827 you are likely to find what you need there.
831 <p>Catalyst has a very active community. Here are the main places to
832 get in touch with us.</p>
835 <a href="http://dev.catalyst.perl.org">Wiki</a>
838 <a href="http://lists.rawmode.org/mailman/listinfo/catalyst">Mailing-List</a>
841 <a href="irc://irc.perl.org/catalyst">IRC channel #catalyst on irc.perl.org</a>
844 <h2>In conclusion</h2>
845 <p>The Catalyst team hopes you will enjoy using Catalyst as much
846 as we enjoyed making it. Please contact us if you have ideas
847 for improvement or other feedback.</p>
857 =head1 INTERNAL METHODS
859 These methods are not meant to be used by end users.
865 Returns a hash of components.
867 =item $c->context_class
869 Returns or sets the context class.
873 Returns a hashref containing coderefs and execution counts (needed for
874 deep recursion detection).
878 Returns the number of actions on the current internal execution stack.
882 Dispatches a request to actions.
886 sub dispatch { my $c = shift; $c->dispatcher->dispatch( $c, @_ ) }
888 =item $c->dispatcher_class
890 Returns or sets the dispatcher class.
894 Returns a list of 2-element array references (name, structure) pairs
895 that will be dumped on the error page in debug mode.
901 [ Request => $c->req ], [ Response => $c->res ], [ Stash => $c->stash ],;
904 =item $c->engine_class
906 Returns or sets the engine class.
908 =item $c->execute( $class, $coderef )
910 Execute a coderef in given class and catch exceptions. Errors are available
916 my ( $c, $class, $code ) = @_;
917 $class = $c->components->{$class} || $class;
921 ( caller(0) )[0]->isa('Catalyst::Action')
928 $action = "/$action" unless $action =~ /\-\>/;
929 $c->counter->{"$code"}++;
931 if ( $c->counter->{"$code"} > $RECURSION ) {
932 my $error = qq/Deep recursion detected in "$action"/;
933 $c->log->error($error);
939 $action = "-> $action" if $callsub =~ /forward$/;
941 push( @{ $c->stack }, $code );
944 $start = [gettimeofday] if $c->debug;
945 eval { $c->state( &$code( $class, $c, @{ $c->req->args } ) || 0 ) };
946 $elapsed = tv_interval($start) if $c->debug;
949 unless ( ( $code->name =~ /^_.*/ )
950 && ( !$c->config->{show_internal_actions} ) )
952 push @{ $c->{stats} }, [ $action, sprintf( '%fs', $elapsed ) ];
955 pop( @{ $c->stack } );
957 if ( my $error = $@ ) {
959 if ( $error eq $DETACH ) { die $DETACH if $c->depth > 1 }
961 unless ( ref $error ) {
963 $error = qq/Caught exception "$error"/;
974 Finalizes the request.
981 for my $error ( @{ $c->error } ) {
982 $c->log->error($error);
985 $c->finalize_uploads;
988 if ( $#{ $c->error } >= 0 ) {
992 $c->finalize_headers;
995 if ( $c->request->method eq 'HEAD' ) {
996 $c->response->body('');
1001 return $c->response->status;
1004 =item $c->finalize_body
1010 sub finalize_body { my $c = shift; $c->engine->finalize_body( $c, @_ ) }
1012 =item $c->finalize_cookies
1018 sub finalize_cookies { my $c = shift; $c->engine->finalize_cookies( $c, @_ ) }
1020 =item $c->finalize_error
1026 sub finalize_error { my $c = shift; $c->engine->finalize_error( $c, @_ ) }
1028 =item $c->finalize_headers
1034 sub finalize_headers {
1037 # Check if we already finalized headers
1038 return if $c->response->{_finalized_headers};
1041 if ( my $location = $c->response->redirect ) {
1042 $c->log->debug(qq/Redirecting to "$location"/) if $c->debug;
1043 $c->response->header( Location => $location );
1047 if ( $c->response->body && !$c->response->content_length ) {
1048 $c->response->content_length( bytes::length( $c->response->body ) );
1052 if ( $c->response->status =~ /^(1\d\d|[23]04)$/ ) {
1053 $c->response->headers->remove_header("Content-Length");
1054 $c->response->body('');
1057 $c->finalize_cookies;
1059 $c->engine->finalize_headers( $c, @_ );
1062 $c->response->{_finalized_headers} = 1;
1065 =item $c->finalize_output
1067 An alias for finalize_body.
1069 =item $c->finalize_read
1071 Finalizes the input after reading is complete.
1075 sub finalize_read { my $c = shift; $c->engine->finalize_read( $c, @_ ) }
1077 =item $c->finalize_uploads
1079 Finalizes uploads. Cleans up any temporary files.
1083 sub finalize_uploads { my $c = shift; $c->engine->finalize_uploads( $c, @_ ) }
1085 =item $c->get_action( $action, $namespace )
1087 Gets an action in a given namespace.
1091 sub get_action { my $c = shift; $c->dispatcher->get_action(@_) }
1093 =item $c->get_actions( $action, $namespace )
1095 Gets all actions of a given name in a namespace and all parent
1100 sub get_actions { my $c = shift; $c->dispatcher->get_actions( $c, @_ ) }
1102 =item handle_request( $class, @arguments )
1104 Called to handle each HTTP request.
1108 sub handle_request {
1109 my ( $class, @arguments ) = @_;
1111 # Always expect worst case!
1117 my $c = $class->prepare(@arguments);
1118 $c->{stats} = \@stats;
1120 return $c->finalize;
1123 if ( $class->debug ) {
1124 my $start = [gettimeofday];
1125 $status = &$handler;
1126 my $elapsed = tv_interval $start;
1127 $elapsed = sprintf '%f', $elapsed;
1128 my $av = sprintf '%.3f',
1129 ( $elapsed == 0 ? '??' : ( 1 / $elapsed ) );
1130 my $t = Text::SimpleTable->new( [ 64, 'Action' ], [ 9, 'Time' ] );
1132 for my $stat (@stats) { $t->row( $stat->[0], $stat->[1] ) }
1134 "Request took ${elapsed}s ($av/s)\n" . $t->draw );
1136 else { $status = &$handler }
1140 if ( my $error = $@ ) {
1142 $class->log->error(qq/Caught exception in engine "$error"/);
1146 $class->log->_flush() if $class->log->can('_flush');
1150 =item $c->prepare( @arguments )
1152 Creates a Catalyst context from an engine-specific request (Apache, CGI,
1158 my ( $class, @arguments ) = @_;
1160 $class->context_class( ref $class || $class ) unless $class->context_class;
1161 my $c = $class->context_class->new(
1165 request => $class->request_class->new(
1168 body_parameters => {},
1170 headers => HTTP::Headers->new,
1172 query_parameters => {},
1178 response => $class->response_class->new(
1182 headers => HTTP::Headers->new(),
1191 # For on-demand data
1192 $c->request->{_context} = $c;
1193 $c->response->{_context} = $c;
1194 weaken( $c->request->{_context} );
1195 weaken( $c->response->{_context} );
1198 my $secs = time - $START || 1;
1199 my $av = sprintf '%.3f', $COUNT / $secs;
1200 $c->log->debug('**********************************');
1201 $c->log->debug("* Request $COUNT ($av/s) [$$]");
1202 $c->log->debug('**********************************');
1203 $c->res->headers->header( 'X-Catalyst' => $Catalyst::VERSION );
1206 $c->prepare_request(@arguments);
1207 $c->prepare_connection;
1208 $c->prepare_query_parameters;
1209 $c->prepare_headers;
1210 $c->prepare_cookies;
1214 $c->prepare_body unless $c->config->{parse_on_demand};
1216 my $method = $c->req->method || '';
1217 my $path = $c->req->path || '';
1218 my $address = $c->req->address || '';
1220 $c->log->debug(qq/"$method" request for "$path" from "$address"/)
1228 =item $c->prepare_action
1234 sub prepare_action { my $c = shift; $c->dispatcher->prepare_action( $c, @_ ) }
1236 =item $c->prepare_body
1238 Prepares message body.
1245 # Do we run for the first time?
1246 return if defined $c->request->{_body};
1248 # Initialize on-demand data
1249 $c->engine->prepare_body( $c, @_ );
1250 $c->prepare_parameters;
1251 $c->prepare_uploads;
1253 if ( $c->debug && keys %{ $c->req->body_parameters } ) {
1254 my $t = Text::SimpleTable->new( [ 37, 'Key' ], [ 36, 'Value' ] );
1255 for my $key ( sort keys %{ $c->req->body_parameters } ) {
1256 my $param = $c->req->body_parameters->{$key};
1257 my $value = defined($param) ? $param : '';
1259 ref $value eq 'ARRAY' ? ( join ', ', @$value ) : $value );
1261 $c->log->debug( "Body Parameters are:\n" . $t->draw );
1265 =item $c->prepare_body_chunk( $chunk )
1267 Prepares a chunk of data before sending it to L<HTTP::Body>.
1271 sub prepare_body_chunk {
1273 $c->engine->prepare_body_chunk( $c, @_ );
1276 =item $c->prepare_body_parameters
1278 Prepares body parameters.
1282 sub prepare_body_parameters {
1284 $c->engine->prepare_body_parameters( $c, @_ );
1287 =item $c->prepare_connection
1289 Prepares connection.
1293 sub prepare_connection {
1295 $c->engine->prepare_connection( $c, @_ );
1298 =item $c->prepare_cookies
1304 sub prepare_cookies { my $c = shift; $c->engine->prepare_cookies( $c, @_ ) }
1306 =item $c->prepare_headers
1312 sub prepare_headers { my $c = shift; $c->engine->prepare_headers( $c, @_ ) }
1314 =item $c->prepare_parameters
1316 Prepares parameters.
1320 sub prepare_parameters {
1322 $c->prepare_body_parameters;
1323 $c->engine->prepare_parameters( $c, @_ );
1326 =item $c->prepare_path
1328 Prepares path and base.
1332 sub prepare_path { my $c = shift; $c->engine->prepare_path( $c, @_ ) }
1334 =item $c->prepare_query_parameters
1336 Prepares query parameters.
1340 sub prepare_query_parameters {
1343 $c->engine->prepare_query_parameters( $c, @_ );
1345 if ( $c->debug && keys %{ $c->request->query_parameters } ) {
1346 my $t = Text::SimpleTable->new( [ 37, 'Key' ], [ 36, 'Value' ] );
1347 for my $key ( sort keys %{ $c->req->query_parameters } ) {
1348 my $param = $c->req->query_parameters->{$key};
1349 my $value = defined($param) ? $param : '';
1351 ref $value eq 'ARRAY' ? ( join ', ', @$value ) : $value );
1353 $c->log->debug( "Query Parameters are:\n" . $t->draw );
1357 =item $c->prepare_read
1359 Prepares the input for reading.
1363 sub prepare_read { my $c = shift; $c->engine->prepare_read( $c, @_ ) }
1365 =item $c->prepare_request
1367 Prepares the engine request.
1371 sub prepare_request { my $c = shift; $c->engine->prepare_request( $c, @_ ) }
1373 =item $c->prepare_uploads
1379 sub prepare_uploads {
1382 $c->engine->prepare_uploads( $c, @_ );
1384 if ( $c->debug && keys %{ $c->request->uploads } ) {
1385 my $t = Text::SimpleTable->new(
1391 for my $key ( sort keys %{ $c->request->uploads } ) {
1392 my $upload = $c->request->uploads->{$key};
1393 for my $u ( ref $upload eq 'ARRAY' ? @{$upload} : ($upload) ) {
1394 $t->row( $key, $u->filename, $u->type, $u->size );
1397 $c->log->debug( "File Uploads are:\n" . $t->draw );
1401 =item $c->prepare_write
1403 Prepares the output for writing.
1407 sub prepare_write { my $c = shift; $c->engine->prepare_write( $c, @_ ) }
1409 =item $c->request_class
1411 Returns or sets the request class.
1413 =item $c->response_class
1415 Returns or sets the response class.
1417 =item $c->read( [$maxlength] )
1419 Reads a chunk of data from the request body. This method is designed to
1420 be used in a while loop, reading C<$maxlength> bytes on every call.
1421 C<$maxlength> defaults to the size of the request if not specified.
1423 You have to set C<MyApp-E<gt>config-E<gt>{parse_on_demand}> to use this
1428 sub read { my $c = shift; return $c->engine->read( $c, @_ ) }
1436 sub run { my $c = shift; return $c->engine->run( $c, @_ ) }
1438 =item $c->set_action( $action, $code, $namespace, $attrs )
1440 Sets an action in a given namespace.
1444 sub set_action { my $c = shift; $c->dispatcher->set_action( $c, @_ ) }
1446 =item $c->setup_actions($component)
1448 Sets up actions for a component.
1452 sub setup_actions { my $c = shift; $c->dispatcher->setup_actions( $c, @_ ) }
1454 =item $c->setup_components
1460 sub setup_components {
1463 my $callback = sub {
1464 my ( $component, $context ) = @_;
1466 unless ( $component->isa('Catalyst::Component') ) {
1470 my $suffix = Catalyst::Utils::class2classsuffix($component);
1471 my $config = $class->config->{$suffix} || {};
1475 eval { $instance = $component->new( $context, $config ); };
1477 if ( my $error = $@ ) {
1481 Catalyst::Exception->throw( message =>
1482 qq/Couldn't instantiate component "$component", "$error"/ );
1485 Catalyst::Exception->throw( message =>
1486 qq/Couldn't instantiate component "$component", "new() didn't return a object"/
1488 unless ref $instance;
1492 eval "package $class;\n" . q!Module::Pluggable::Fast->import(
1493 name => '_catalyst_components',
1495 "$class\::Controller", "$class\::C",
1496 "$class\::Model", "$class\::M",
1497 "$class\::View", "$class\::V"
1499 callback => $callback
1503 if ( my $error = $@ ) {
1507 Catalyst::Exception->throw(
1508 message => qq/Couldn't load components "$error"/ );
1511 for my $component ( $class->_catalyst_components($class) ) {
1512 $class->components->{ ref $component || $component } = $component;
1516 =item $c->setup_dispatcher
1522 sub setup_dispatcher {
1523 my ( $class, $dispatcher ) = @_;
1526 $dispatcher = 'Catalyst::Dispatcher::' . $dispatcher;
1529 if ( $ENV{CATALYST_DISPATCHER} ) {
1530 $dispatcher = 'Catalyst::Dispatcher::' . $ENV{CATALYST_DISPATCHER};
1533 if ( $ENV{ uc($class) . '_DISPATCHER' } ) {
1535 'Catalyst::Dispatcher::' . $ENV{ uc($class) . '_DISPATCHER' };
1538 unless ($dispatcher) {
1539 $dispatcher = $class->dispatcher_class;
1542 $dispatcher->require;
1545 Catalyst::Exception->throw(
1546 message => qq/Couldn't load dispatcher "$dispatcher", "$@"/ );
1549 # dispatcher instance
1550 $class->dispatcher( $dispatcher->new );
1553 =item $c->setup_engine
1560 my ( $class, $engine ) = @_;
1563 $engine = 'Catalyst::Engine::' . $engine;
1566 if ( $ENV{CATALYST_ENGINE} ) {
1567 $engine = 'Catalyst::Engine::' . $ENV{CATALYST_ENGINE};
1570 if ( $ENV{ uc($class) . '_ENGINE' } ) {
1571 $engine = 'Catalyst::Engine::' . $ENV{ uc($class) . '_ENGINE' };
1574 if ( !$engine && $ENV{MOD_PERL} ) {
1576 # create the apache method
1579 *{"$class\::apache"} = sub { shift->engine->apache };
1582 my ( $software, $version ) =
1583 $ENV{MOD_PERL} =~ /^(\S+)\/(\d+(?:[\.\_]\d+)+)/;
1586 $version =~ s/(\.[^.]+)\./$1/g;
1588 if ( $software eq 'mod_perl' ) {
1590 if ( $version >= 1.99922 ) {
1591 $engine = 'Catalyst::Engine::Apache2::MP20';
1594 elsif ( $version >= 1.9901 ) {
1595 $engine = 'Catalyst::Engine::Apache2::MP19';
1598 elsif ( $version >= 1.24 ) {
1599 $engine = 'Catalyst::Engine::Apache::MP13';
1603 Catalyst::Exception->throw( message =>
1604 qq/Unsupported mod_perl version: $ENV{MOD_PERL}/ );
1607 # install the correct mod_perl handler
1608 if ( $version >= 1.9901 ) {
1609 *handler = sub : method {
1610 shift->handle_request(@_);
1614 *handler = sub ($$) { shift->handle_request(@_) };
1619 elsif ( $software eq 'Zeus-Perl' ) {
1620 $engine = 'Catalyst::Engine::Zeus';
1624 Catalyst::Exception->throw(
1625 message => qq/Unsupported mod_perl: $ENV{MOD_PERL}/ );
1630 $engine = $class->engine_class;
1636 Catalyst::Exception->throw( message =>
1637 qq/Couldn't load engine "$engine" (maybe you forgot to install it?), "$@"/
1641 # check for old engines that are no longer compatible
1643 if ( $engine->isa('Catalyst::Engine::Apache')
1644 && !Catalyst::Engine::Apache->VERSION )
1649 elsif ( $engine->isa('Catalyst::Engine::Server::Base')
1650 && Catalyst::Engine::Server->VERSION le '0.02' )
1655 elsif ($engine->isa('Catalyst::Engine::HTTP::POE')
1656 && $engine->VERSION eq '0.01' )
1661 elsif ($engine->isa('Catalyst::Engine::Zeus')
1662 && $engine->VERSION eq '0.01' )
1668 Catalyst::Exception->throw( message =>
1669 qq/Engine "$engine" is not supported by this version of Catalyst/
1674 $class->engine( $engine->new );
1677 =item $c->setup_home
1679 Sets up the home directory.
1684 my ( $class, $home ) = @_;
1686 if ( $ENV{CATALYST_HOME} ) {
1687 $home = $ENV{CATALYST_HOME};
1690 if ( $ENV{ uc($class) . '_HOME' } ) {
1691 $home = $ENV{ uc($class) . '_HOME' };
1695 $home = Catalyst::Utils::home($class);
1699 $class->config->{home} ||= $home;
1700 $class->config->{root} ||= dir($home)->subdir('root');
1711 my ( $class, $debug ) = @_;
1713 unless ( $class->log ) {
1714 $class->log( Catalyst::Log->new );
1717 my $app_flag = Catalyst::Utils::class2env($class) . '_DEBUG';
1720 ( defined( $ENV{CATALYST_DEBUG} ) || defined( $ENV{$app_flag} ) )
1721 ? ( $ENV{CATALYST_DEBUG} || $ENV{$app_flag} )
1726 *{"$class\::debug"} = sub { 1 };
1727 $class->log->debug('Debug messages enabled');
1731 =item $c->setup_plugins
1738 my ( $class, $plugins ) = @_;
1741 for my $plugin ( reverse @$plugins ) {
1743 $plugin = "Catalyst::Plugin::$plugin";
1748 Catalyst::Exception->throw(
1749 message => qq/Couldn't load plugin "$plugin", "$@"/ );
1754 unshift @{"$class\::ISA"}, $plugin;
1763 =item $c->write( $data )
1765 Writes $data to the output stream. When using this method directly, you
1766 will need to manually set the C<Content-Length> header to the length of
1767 your output data, if known.
1774 # Finalize headers if someone manually writes output
1775 $c->finalize_headers;
1777 return $c->engine->write( $c, @_ );
1782 Returns the Catalyst version number. Mostly useful for "powered by"
1783 messages in template systems.
1787 sub version { return $Catalyst::VERSION }
1791 =head1 INTERNAL ACTIONS
1793 Catalyst uses internal actions like C<_DISPATCH>, C<_BEGIN>, C<_AUTO>,
1794 C<_ACTION>, and C<_END>. These are by default not shown in the private
1795 action table, but you can make them visible with a config parameter.
1797 MyApp->config->{show_internal_actions} = 1;
1799 =head1 CASE SENSITIVITY
1801 By default Catalyst is not case sensitive, so C<MyApp::C::FOO::Bar> is
1802 mapped to C</foo/bar>. You can activate case sensitivity with a config
1805 MyApp->config->{case_sensitive} = 1;
1807 This causes C<MyApp::C::Foo::Bar> to map to C</Foo/Bar>.
1809 =head1 ON-DEMAND PARSER
1811 The request body is usually parsed at the beginning of a request,
1812 but if you want to handle input yourself or speed things up a bit,
1813 you can enable on-demand parsing with a config parameter.
1815 MyApp->config->{parse_on_demand} = 1;
1817 =head1 PROXY SUPPORT
1819 Many production servers operate using the common double-server approach,
1820 with a lightweight frontend web server passing requests to a larger
1821 backend server. An application running on the backend server must deal
1822 with two problems: the remote user always appears to be C<127.0.0.1> and
1823 the server's hostname will appear to be C<localhost> regardless of the
1824 virtual host that the user connected through.
1826 Catalyst will automatically detect this situation when you are running
1827 the frontend and backend servers on the same machine. The following
1828 changes are made to the request.
1830 $c->req->address is set to the user's real IP address, as read from
1831 the HTTP X-Forwarded-For header.
1833 The host value for $c->req->base and $c->req->uri is set to the real
1834 host, as read from the HTTP X-Forwarded-Host header.
1836 Obviously, your web server must support these headers for this to work.
1838 In a more complex server farm environment where you may have your
1839 frontend proxy server(s) on different machines, you will need to set a
1840 configuration option to tell Catalyst to read the proxied data from the
1843 MyApp->config->{using_frontend_proxy} = 1;
1845 If you do not wish to use the proxy support at all, you may set:
1847 MyApp->config->{ignore_frontend_proxy} = 1;
1849 =head1 THREAD SAFETY
1851 Catalyst has been tested under Apache 2's threading mpm_worker, mpm_winnt,
1852 and the standalone forking HTTP server on Windows. We believe the Catalyst
1853 core to be thread-safe.
1855 If you plan to operate in a threaded environment, remember that all other
1856 modules you are using must also be thread-safe. Some modules, most notably
1857 L<DBD::SQLite>, are not thread-safe.
1863 Join #catalyst on irc.perl.org.
1867 http://lists.rawmode.org/mailman/listinfo/catalyst
1868 http://lists.rawmode.org/mailman/listinfo/catalyst-dev
1872 http://catalyst.perl.org
1876 http://dev.catalyst.perl.org
1882 =item L<Catalyst::Manual> - The Catalyst Manual
1884 =item L<Catalyst::Component>, L<Catalyst::Base> - Base classes for components
1886 =item L<Catalyst::Engine> - Core engine
1888 =item L<Catalyst::Log> - Log class.
1890 =item L<Catalyst::Request> - Request object
1892 =item L<Catalyst::Response> - Response object
1894 =item L<Catalyst::Test> - The test suite.
1964 Sebastian Riedel, C<sri@oook.de>
1968 This library is free software, you can redistribute it and/or modify it under
1969 the same terms as Perl itself.