4 use base 'Catalyst::Base';
6 use UNIVERSAL::require;
7 use Catalyst::Exception;
10 use Catalyst::Request::Upload;
11 use Catalyst::Response;
16 use Time::HiRes qw/gettimeofday tv_interval/;
18 use Scalar::Util qw/weaken/;
20 __PACKAGE__->mk_accessors(qw/counter depth request response state/);
27 # For backwards compatibility
28 *finalize_output = \&finalize_body;
33 our $RECURSION = 1000;
34 our $DETACH = "catalyst_detach\n";
36 require Module::Pluggable::Fast;
38 # Helper script generation
39 our $CATALYST_SCRIPT_GEN = 8;
41 __PACKAGE__->mk_classdata($_)
42 for qw/components arguments dispatcher engine log/;
44 our $VERSION = '5.49_01';
47 my ( $class, @arguments ) = @_;
49 # We have to limit $class to Catalyst to avoid pushing Catalyst upon every
51 return unless $class eq 'Catalyst';
53 my $caller = caller(0);
55 unless ( $caller->isa('Catalyst') ) {
57 push @{"$caller\::ISA"}, $class;
60 $caller->arguments( [@arguments] );
66 Catalyst - The Elegant MVC Web Application Framework
70 # use the helper to start a new application
74 # add models, views, controllers
75 script/myapp_create.pl model Something
76 script/myapp_create.pl view Stuff
77 script/myapp_create.pl controller Yada
80 script/myapp_server.pl
82 # command line interface
83 script/myapp_test.pl /yada
88 use Catalyst qw/My::Module My::OtherModule/;
90 use Catalyst '-Debug';
92 use Catalyst qw/-Debug -Engine=CGI/;
94 sub default : Private { $_[1]->res->output('Hello') } );
96 sub index : Path('/index.html') {
97 my ( $self, $c ) = @_;
98 $c->res->output('Hello');
102 sub product : Regex('^product[_]*(\d*).html$') {
103 my ( $self, $c ) = @_;
104 $c->stash->{template} = 'product.tt';
105 $c->stash->{product} = $c->req->snippets->[0];
108 See also L<Catalyst::Manual::Intro>
112 The key concept of Catalyst is DRY (Don't Repeat Yourself).
114 See L<Catalyst::Manual> for more documentation.
116 Catalyst plugins can be loaded by naming them as arguments to the "use Catalyst" statement.
117 Omit the C<Catalyst::Plugin::> prefix from the plugin name,
118 so C<Catalyst::Plugin::My::Module> becomes C<My::Module>.
120 use Catalyst 'My::Module';
122 Special flags like -Debug and -Engine can also be specified as arguments when
125 use Catalyst qw/-Debug My::Module/;
127 The position of plugins and flags in the chain is important, because they are
128 loaded in exactly the order that they appear.
130 The following flags are supported:
136 enables debug output, i.e.:
138 use Catalyst '-Debug';
140 this is equivalent to:
147 Force Catalyst to use a specific dispatcher.
151 Force Catalyst to use a specific engine.
152 Omit the C<Catalyst::Engine::> prefix of the engine name, i.e.:
154 use Catalyst '-Engine=CGI';
158 Force Catalyst to use a specific home directory.
170 =item $c->comp($name)
172 =item $c->component($name)
174 Get a component object by name.
176 $c->comp('MyApp::Model::MyModel')->do_stuff;
187 my $appclass = ref $c || $c;
190 $name, "${appclass}::${name}",
191 map { "${appclass}::${_}::${name}" } qw/M V C/
194 foreach my $try (@names) {
196 if ( exists $c->components->{$try} ) {
198 return $c->components->{$try};
202 foreach my $component ( keys %{ $c->components } ) {
204 return $c->components->{$component} if $component =~ /$name/i;
209 return sort keys %{ $c->components };
214 Returns a hashref containing your applications settings.
218 Overload to enable debug messages.
224 =item $c->detach( $command [, \@arguments ] )
226 Like C<forward> but doesn't return.
230 sub detach { my $c = shift; $c->dispatcher->detach( $c, @_ ) }
234 Contains the dispatcher instance.
235 Stringifies to class.
237 =item $c->forward( $command [, \@arguments ] )
239 Forward processing to a private action or a method from a class.
240 If you define a class without method it will default to process().
241 also takes an optional arrayref containing arguments to be passed
242 to the new function. $c->req->args will be reset upon returning
246 $c->forward('index');
247 $c->forward(qw/MyApp::Model::CDBI::Foo do_stuff/);
248 $c->forward('MyApp::View::TT');
252 sub forward { my $c = shift; $c->dispatcher->forward( $c, @_ ) }
263 my ( $class, @arguments ) = @_;
265 unless ( $class->isa('Catalyst') ) {
267 Catalyst::Exception->throw(
268 message => qq/'$class' does not inherit from Catalyst/ );
271 if ( $class->arguments ) {
272 @arguments = ( @arguments, @{ $class->arguments } );
278 foreach (@arguments) {
282 ( $flags->{log} ) ? 'debug,' . $flags->{log} : 'debug';
284 elsif (/^-(\w+)=?(.*)$/) {
285 $flags->{ lc $1 } = $2;
288 push @{ $flags->{plugins} }, $_;
292 $class->setup_log( delete $flags->{log} );
293 $class->setup_plugins( delete $flags->{plugins} );
294 $class->setup_dispatcher( delete $flags->{dispatcher} );
295 $class->setup_engine( delete $flags->{engine} );
296 $class->setup_home( delete $flags->{home} );
298 for my $flag ( sort keys %{$flags} ) {
300 if ( my $code = $class->can( 'setup_' . $flag ) ) {
301 &$code( $class, delete $flags->{$flag} );
304 $class->log->warn(qq/Unknown flag "$flag"/);
308 $class->log->warn( "You are running an old helper script! "
309 . "Please update your scripts by regenerating the "
310 . "application and copying over the new scripts." )
311 if ( $ENV{CATALYST_SCRIPT_GEN}
312 && ( $ENV{CATALYST_SCRIPT_GEN} < $Catalyst::CATALYST_SCRIPT_GEN ) );
314 if ( $class->debug ) {
320 @plugins = grep { /^Catalyst::Plugin/ } @{"$class\::ISA"};
324 my $t = Text::ASCIITable->new;
325 $t->setOptions( 'hide_HeadRow', 1 );
326 $t->setOptions( 'hide_HeadLine', 1 );
327 $t->setCols('Class');
328 $t->setColWidth( 'Class', 75, 1 );
329 $t->addRow($_) for @plugins;
330 $class->log->debug( "Loaded plugins:\n" . $t->draw );
333 my $dispatcher = $class->dispatcher;
334 my $engine = $class->engine;
335 my $home = $class->config->{home};
337 $class->log->debug(qq/Loaded dispatcher "$dispatcher"/);
338 $class->log->debug(qq/Loaded engine "$engine"/);
342 ? $class->log->debug(qq/Found home "$home"/)
343 : $class->log->debug(qq/Home "$home" doesn't exist/)
344 : $class->log->debug(q/Couldn't find home/);
349 no warnings qw/redefine/;
350 local *setup = sub { };
354 # Initialize our data structure
355 $class->components( {} );
357 $class->setup_components;
359 if ( $class->debug ) {
360 my $t = Text::ASCIITable->new;
361 $t->setOptions( 'hide_HeadRow', 1 );
362 $t->setOptions( 'hide_HeadLine', 1 );
363 $t->setCols('Class');
364 $t->setColWidth( 'Class', 75, 1 );
365 $t->addRow($_) for sort keys %{ $class->components };
366 $class->log->debug( "Loaded components:\n" . $t->draw )
367 if ( @{ $t->{tbl_rows} } );
370 # Add our self to components, since we are also a component
371 $class->components->{$class} = $class;
373 $class->setup_actions;
375 if ( $class->debug ) {
376 my $name = $class->config->{name} || 'Application';
377 $class->log->info("$name powered by Catalyst $Catalyst::VERSION");
379 $class->log->_flush() if $class->log->can('_flush');
382 =item $c->uri_for($path)
384 Merges path with $c->request->base for absolute uri's and with
385 $c->request->match for relative uri's, then returns a normalized
391 my ( $c, $path ) = @_;
392 my $base = $c->request->base->clone;
393 my $basepath = $base->path;
394 $basepath =~ s/\/$//;
396 my $match = $c->request->match;
398 $match .= '/' if $match;
399 $match = '' if $path =~ /^\//;
401 return URI->new_abs( URI->new_abs( $path, "$basepath$match" ), $base )
407 =item $c->error($error, ...)
409 =item $c->error($arrayref)
411 Returns an arrayref containing error messages.
413 my @error = @{ $c->error };
417 $c->error('Something bad happened');
423 my $error = ref $_[0] eq 'ARRAY' ? $_[0] : [@_];
424 push @{ $c->{error} }, @$error;
430 Contains the engine instance.
431 Stringifies to the class.
435 Contains the logging object. Unless it is already set Catalyst sets this up with a
436 C<Catalyst::Log> object. To use your own log class:
438 $c->log( MyLogger->new );
439 $c->log->info("now logging with my own logger!");
441 Your log class should implement the methods described in the C<Catalyst::Log>
444 =item $c->plugin( $name, $class, @args )
446 Instant plugins for Catalyst.
447 Classdata accessor/mutator will be created, class loaded and instantiated.
449 MyApp->plugin( 'prototype', 'HTML::Prototype' );
451 $c->prototype->define_javascript_functions;
456 my ( $class, $name, $plugin, @args ) = @_;
459 if ( my $error = $UNIVERSAL::require::ERROR ) {
460 Catalyst::Exception->throw(
461 message => qq/Couldn't load instant plugin "$plugin", "$error"/ );
464 eval { $plugin->import };
465 $class->mk_classdata($name);
467 eval { $obj = $plugin->new(@args) };
470 Catalyst::Exception->throw( message =>
471 qq/Couldn't instantiate instant plugin "$plugin", "$@"/ );
475 $class->log->debug(qq/Initialized instant plugin "$plugin" as "$name"/)
483 Returns a C<Catalyst::Request> object.
491 Returns a C<Catalyst::Response> object.
497 Contains the return value of the last executed action.
501 Returns a hashref containing all your data.
503 print $c->stash->{foo};
505 Keys may be set in the stash by assigning to the hash reference, or by passing
506 either a single hash reference or a list of key/value pairs as arguments.
510 $c->stash->{foo} ||= 'yada';
511 $c->stash( { moose => 'majestic', qux => 0 } );
512 $c->stash( bar => 1, gorch => 2 );
519 my $stash = @_ > 1 ? {@_} : $_[0];
520 while ( my ( $key, $val ) = each %$stash ) {
521 $c->{stash}->{$key} = $val;
527 =head1 $c->welcome_message
529 Returns the Catalyst welcome HTML page.
533 sub welcome_message {
535 my $name = $c->config->{name};
536 my $logo = $c->uri_for('/static/images/catalyst_logo.png');
540 <title>$name on Catalyst $VERSION</title>
541 <style type="text/css">
546 background-color: #eee;
554 background-color: #ccc;
555 border: 1px solid #aaa;
556 -moz-border-radius: 10px;
561 font-family: verdana, tahoma, sans-serif;
564 font-family: verdana, tahoma, sans-serif;
567 text-decoration: none;
569 border-bottom: 1px dotted #bbb;
571 :link:hover, :visited:hover {
584 background-color: #fff;
585 border: 1px solid #aaa;
586 -moz-border-radius: 10px;
611 <h1>$name on <a href="http://catalyst.perl.org">Catalyst</a>
618 <p>Welcome to the wonderful world of Catalyst.
619 This MVC framework will make web development
620 something you had never expected it to be:
621 Fun, rewarding and quick.</p>
622 <h2>What to do now?</h2>
623 <p>That really depends on what <b>you</b> want to do.
624 We do, however, provide you with a few starting points.</p>
625 <p>If you want to jump right into web development with Catalyst
626 you might want to check out the documentation.</p>
627 <pre><code>perldoc <a href="http://cpansearch.perl.org/dist/Catalyst/lib/Catalyst/Manual.pod">Catalyst::Manual</a>
628 perldoc <a href="http://cpansearch.perl.org/dist/Catalyst/lib/Catalyst/Manual/Intro.pod">Catalyst::Manual::Intro</a></code></pre>
629 <p>If you would like some background information on the
630 MVC-pattern, these links might be of help to you.</p>
633 <a href="http://dev.catalyst.perl.org/wiki/Models">
634 Introduction to Models
638 <a href="http://dev.catalyst.perl.org/wiki/Views">
639 Introduction to Views
643 <a href="http://dev.catalyst.perl.org/wiki/Controllers">
644 Introduction to Controllers
648 <h2>What to do next?</h2>
649 <p>Next you need to create an actual application. Use the
650 helper scripts for what they are worth, they can save you
651 a lot of work getting everything set up. Also, be sure to
652 check out the vast array of plugins for Catalyst on CPAN.
653 They can handle everything from A to Z
654 , and a whole lot in between.</p>
656 <p>Catalyst has a very active community. The main places to get
657 in touch are these.</p>
660 <a href="http://dev.catalyst.perl.org">Wiki</a>
663 <a href="http://lists.rawmode.org/mailman/listinfo/catalyst">Mailing-List</a>
666 <a href="irc://irc.perl.org/catalyst">IRC channel #catalyst on irc.perl.org</a>
669 <h2>In conclusion</h2>
670 <p>The Catalyst team hope you will enjoy using Catalyst as much
671 as we enjoyed making it, and rest assured that any and all
672 feedback is welcomed.</p>
673 <p class="signature">-- #1. the first rule of the Cabal is, you do not
674 talk about the Cabal.<br/>
675 #2. the second rule of the Cabal is, you DO NOT
676 talk about the Cabal.</p>
686 =head1 INTERNAL METHODS
690 =item $c->benchmark($coderef)
692 Takes a coderef with arguments and returns elapsed time as float.
694 my ( $elapsed, $status ) = $c->benchmark( sub { return 1 } );
695 $c->log->info( sprintf "Processing took %f seconds", $elapsed );
702 my $time = [gettimeofday];
703 my @return = &$code(@_);
704 my $elapsed = tv_interval $time;
705 return wantarray ? ( $elapsed, @return ) : $elapsed;
710 Contains the components.
714 Returns a hashref containing coderefs and execution counts.
715 (Needed for deep recursion detection)
719 Returns the actual forward depth.
723 Dispatch request to actions.
727 sub dispatch { my $c = shift; $c->dispatcher->dispatch( $c, @_ ) }
729 =item $c->execute($class, $coderef)
731 Execute a coderef in given class and catch exceptions.
732 Errors are available via $c->error.
737 my ( $c, $class, $code ) = @_;
738 $class = $c->components->{$class} || $class;
740 my $callsub = ( caller(1) )[3];
745 $action = "/$action" unless $action =~ /\-\>/;
746 $c->counter->{"$code"}++;
748 if ( $c->counter->{"$code"} > $RECURSION ) {
749 my $error = qq/Deep recursion detected in "$action"/;
750 $c->log->error($error);
756 $action = "-> $action" if $callsub =~ /forward$/;
762 my ( $elapsed, @state ) =
763 $c->benchmark( $code, $class, $c, @{ $c->req->args } );
764 push @{ $c->{stats} }, [ $action, sprintf( '%fs', $elapsed ) ];
767 else { $c->state( &$code( $class, $c, @{ $c->req->args } ) || 0 ) }
771 if ( my $error = $@ ) {
773 if ( $error eq $DETACH ) { die $DETACH if $c->{depth} > 1 }
775 unless ( ref $error ) {
777 $error = qq/Caught exception "$error"/;
780 $c->log->error($error);
797 $c->finalize_uploads;
800 if ( $#{ $c->error } >= 0 ) {
804 $c->finalize_headers;
807 if ( $c->request->method eq 'HEAD' ) {
808 $c->response->body('');
813 return $c->response->status;
816 =item $c->finalize_body
822 sub finalize_body { my $c = shift; $c->engine->finalize_body( $c, @_ ) }
824 =item $c->finalize_cookies
830 sub finalize_cookies { my $c = shift; $c->engine->finalize_cookies( $c, @_ ) }
832 =item $c->finalize_error
838 sub finalize_error { my $c = shift; $c->engine->finalize_error( $c, @_ ) }
840 =item $c->finalize_headers
846 sub finalize_headers {
849 # Check if we already finalized headers
850 return if $c->response->{_finalized_headers};
853 if ( my $location = $c->response->redirect ) {
854 $c->log->debug(qq/Redirecting to "$location"/) if $c->debug;
855 $c->response->header( Location => $location );
859 if ( $c->response->body && !$c->response->content_length ) {
860 $c->response->content_length( bytes::length( $c->response->body ) );
864 if ( $c->response->status =~ /^(1\d\d|[23]04)$/ ) {
865 $c->response->headers->remove_header("Content-Length");
866 $c->response->body('');
869 $c->finalize_cookies;
871 $c->engine->finalize_headers( $c, @_ );
874 $c->response->{_finalized_headers} = 1;
877 =item $c->finalize_output
879 An alias for finalize_body.
881 =item $c->finalize_read
883 Finalize the input after reading is complete.
887 sub finalize_read { my $c = shift; $c->engine->finalize_read( $c, @_ ) }
889 =item $c->finalize_uploads
891 Finalize uploads. Cleans up any temporary files.
895 sub finalize_uploads { my $c = shift; $c->engine->finalize_uploads( $c, @_ ) }
897 =item $c->get_action( $action, $namespace, $inherit )
899 Get an action in a given namespace.
903 sub get_action { my $c = shift; $c->dispatcher->get_action( $c, @_ ) }
905 =item handle_request( $class, @arguments )
912 my ( $class, @arguments ) = @_;
914 # Always expect worst case!
920 my $c = $class->prepare(@arguments);
921 $c->{stats} = \@stats;
926 if ( $class->debug ) {
928 ( $elapsed, $status ) = $class->benchmark($handler);
929 $elapsed = sprintf '%f', $elapsed;
930 my $av = sprintf '%.3f',
931 ( $elapsed == 0 ? '??' : ( 1 / $elapsed ) );
932 my $t = Text::ASCIITable->new;
933 $t->setCols( 'Action', 'Time' );
934 $t->setColWidth( 'Action', 64, 1 );
935 $t->setColWidth( 'Time', 9, 1 );
937 for my $stat (@stats) { $t->addRow( $stat->[0], $stat->[1] ) }
939 "Request took ${elapsed}s ($av/s)\n" . $t->draw );
941 else { $status = &$handler }
945 if ( my $error = $@ ) {
947 $class->log->error(qq/Caught exception in engine "$error"/);
951 $class->log->_flush() if $class->log->can('_flush');
955 =item $c->prepare(@arguments)
957 Turns the engine-specific request( Apache, CGI ... )
958 into a Catalyst context .
963 my ( $class, @arguments ) = @_;
968 request => Catalyst::Request->new(
971 body_parameters => {},
973 headers => HTTP::Headers->new,
975 query_parameters => {},
981 response => Catalyst::Response->new(
985 headers => HTTP::Headers->new(),
994 $c->request->{_context} = $c;
995 $c->response->{_context} = $c;
996 weaken( $c->request->{_context} );
997 weaken( $c->response->{_context} );
1000 my $secs = time - $START || 1;
1001 my $av = sprintf '%.3f', $COUNT / $secs;
1002 $c->log->debug('**********************************');
1003 $c->log->debug("* Request $COUNT ($av/s) [$$]");
1004 $c->log->debug('**********************************');
1005 $c->res->headers->header( 'X-Catalyst' => $Catalyst::VERSION );
1008 $c->prepare_request(@arguments);
1009 $c->prepare_connection;
1010 $c->prepare_query_parameters;
1011 $c->prepare_headers;
1012 $c->prepare_cookies;
1016 $c->prepare_body unless $c->config->{parse_on_demand};
1019 my $method = $c->req->method || '';
1020 my $path = $c->req->path || '';
1021 my $address = $c->req->address || '';
1023 $c->log->debug(qq/"$method" request for "$path" from $address/)
1029 =item $c->prepare_action
1035 sub prepare_action { my $c = shift; $c->dispatcher->prepare_action( $c, @_ ) }
1037 =item $c->prepare_body
1039 Prepare message body.
1046 # Do we run for the first time?
1047 return if defined $c->request->{_body};
1049 # Initialize on-demand data
1050 $c->engine->prepare_body( $c, @_ );
1051 $c->prepare_parameters;
1052 $c->prepare_uploads;
1054 if ( $c->debug && keys %{ $c->req->body_parameters } ) {
1055 my $t = Text::ASCIITable->new;
1056 $t->setCols( 'Key', 'Value' );
1057 $t->setColWidth( 'Key', 37, 1 );
1058 $t->setColWidth( 'Value', 36, 1 );
1059 $t->alignCol( 'Value', 'right' );
1060 for my $key ( sort keys %{ $c->req->body_parameters } ) {
1061 my $param = $c->req->body_parameters->{$key};
1062 my $value = defined($param) ? $param : '';
1064 ref $value eq 'ARRAY' ? ( join ', ', @$value ) : $value );
1066 $c->log->debug( "Body Parameters are:\n" . $t->draw );
1070 =item $c->prepare_body_chunk( $chunk )
1072 Prepare a chunk of data before sending it to HTTP::Body.
1076 sub prepare_body_chunk {
1078 $c->engine->prepare_body_chunk( $c, @_ );
1081 =item $c->prepare_body_parameters
1083 Prepare body parameters.
1087 sub prepare_body_parameters {
1089 $c->engine->prepare_body_parameters( $c, @_ );
1092 =item $c->prepare_connection
1098 sub prepare_connection {
1100 $c->engine->prepare_connection( $c, @_ );
1103 =item $c->prepare_cookies
1109 sub prepare_cookies { my $c = shift; $c->engine->prepare_cookies( $c, @_ ) }
1111 =item $c->prepare_headers
1117 sub prepare_headers { my $c = shift; $c->engine->prepare_headers( $c, @_ ) }
1119 =item $c->prepare_parameters
1125 sub prepare_parameters {
1127 $c->prepare_body_parameters;
1128 $c->engine->prepare_parameters( $c, @_ );
1131 =item $c->prepare_path
1133 Prepare path and base.
1137 sub prepare_path { my $c = shift; $c->engine->prepare_path( $c, @_ ) }
1139 =item $c->prepare_query_parameters
1141 Prepare query parameters.
1145 sub prepare_query_parameters {
1148 $c->engine->prepare_query_parameters( $c, @_ );
1150 if ( $c->debug && keys %{ $c->request->query_parameters } ) {
1151 my $t = Text::ASCIITable->new;
1152 $t->setCols( 'Key', 'Value' );
1153 $t->setColWidth( 'Key', 37, 1 );
1154 $t->setColWidth( 'Value', 36, 1 );
1155 $t->alignCol( 'Value', 'right' );
1156 for my $key ( sort keys %{ $c->req->query_parameters } ) {
1157 my $param = $c->req->query_parameters->{$key};
1158 my $value = defined($param) ? $param : '';
1160 ref $value eq 'ARRAY' ? ( join ', ', @$value ) : $value );
1162 $c->log->debug( "Query Parameters are:\n" . $t->draw );
1166 =item $c->prepare_read
1168 Prepare the input for reading.
1172 sub prepare_read { my $c = shift; $c->engine->prepare_read( $c, @_ ) }
1174 =item $c->prepare_request
1176 Prepare the engine request.
1180 sub prepare_request { my $c = shift; $c->engine->prepare_request( $c, @_ ) }
1182 =item $c->prepare_uploads
1188 sub prepare_uploads {
1191 $c->engine->prepare_uploads( $c, @_ );
1193 if ( $c->debug && keys %{ $c->request->uploads } ) {
1194 my $t = Text::ASCIITable->new;
1195 $t->setCols( 'Key', 'Filename', 'Type', 'Size' );
1196 $t->setColWidth( 'Key', 12, 1 );
1197 $t->setColWidth( 'Filename', 28, 1 );
1198 $t->setColWidth( 'Type', 18, 1 );
1199 $t->setColWidth( 'Size', 9, 1 );
1200 $t->alignCol( 'Size', 'left' );
1201 for my $key ( sort keys %{ $c->request->uploads } ) {
1202 my $upload = $c->request->uploads->{$key};
1203 for my $u ( ref $upload eq 'ARRAY' ? @{$upload} : ($upload) ) {
1204 $t->addRow( $key, $u->filename, $u->type, $u->size );
1207 $c->log->debug( "File Uploads are:\n" . $t->draw );
1211 =item $c->prepare_write
1213 Prepare the output for writing.
1217 sub prepare_write { my $c = shift; $c->engine->prepare_write( $c, @_ ) }
1219 =item $c->read( [$maxlength] )
1221 Read a chunk of data from the request body. This method is designed to be
1222 used in a while loop, reading $maxlength bytes on every call. $maxlength
1223 defaults to the size of the request if not specified.
1225 You have to set MyApp->config->{parse_on_demand} to use this directly.
1229 sub read { my $c = shift; return $c->engine->read( $c, @_ ) }
1237 sub run { my $c = shift; return $c->engine->run( $c, @_ ) }
1239 =item $c->set_action( $action, $code, $namespace, $attrs )
1241 Set an action in a given namespace.
1245 sub set_action { my $c = shift; $c->dispatcher->set_action( $c, @_ ) }
1247 =item $c->setup_actions($component)
1249 Setup actions for a component.
1253 sub setup_actions { my $c = shift; $c->dispatcher->setup_actions( $c, @_ ) }
1255 =item $c->setup_components
1261 sub setup_components {
1264 my $callback = sub {
1265 my ( $component, $context ) = @_;
1267 unless ( $component->isa('Catalyst::Base') ) {
1271 my $suffix = Catalyst::Utils::class2classsuffix($component);
1272 my $config = $class->config->{$suffix} || {};
1276 eval { $instance = $component->new( $context, $config ); };
1278 if ( my $error = $@ ) {
1282 Catalyst::Exception->throw( message =>
1283 qq/Couldn't instantiate component "$component", "$error"/ );
1286 Catalyst::Exception->throw( message =>
1287 qq/Couldn't instantiate component "$component", "new() didn't return a object"/
1289 unless ref $instance;
1294 Module::Pluggable::Fast->import(
1295 name => '_catalyst_components',
1297 "$class\::Controller", "$class\::C",
1298 "$class\::Model", "$class\::M",
1299 "$class\::View", "$class\::V"
1301 callback => $callback
1305 if ( my $error = $@ ) {
1309 Catalyst::Exception->throw(
1310 message => qq/Couldn't load components "$error"/ );
1313 for my $component ( $class->_catalyst_components($class) ) {
1314 $class->components->{ ref $component || $component } = $component;
1318 =item $c->setup_dispatcher
1322 sub setup_dispatcher {
1323 my ( $class, $dispatcher ) = @_;
1326 $dispatcher = 'Catalyst::Dispatcher::' . $dispatcher;
1329 if ( $ENV{CATALYST_DISPATCHER} ) {
1330 $dispatcher = 'Catalyst::Dispatcher::' . $ENV{CATALYST_DISPATCHER};
1333 if ( $ENV{ uc($class) . '_DISPATCHER' } ) {
1335 'Catalyst::Dispatcher::' . $ENV{ uc($class) . '_DISPATCHER' };
1338 unless ($dispatcher) {
1339 $dispatcher = 'Catalyst::Dispatcher';
1342 $dispatcher->require;
1345 Catalyst::Exception->throw(
1346 message => qq/Couldn't load dispatcher "$dispatcher", "$@"/ );
1349 # dispatcher instance
1350 $class->dispatcher( $dispatcher->new );
1353 =item $c->setup_engine
1358 my ( $class, $engine ) = @_;
1361 $engine = 'Catalyst::Engine::' . $engine;
1364 if ( $ENV{CATALYST_ENGINE} ) {
1365 $engine = 'Catalyst::Engine::' . $ENV{CATALYST_ENGINE};
1368 if ( $ENV{ uc($class) . '_ENGINE' } ) {
1369 $engine = 'Catalyst::Engine::' . $ENV{ uc($class) . '_ENGINE' };
1372 if ( !$engine && $ENV{MOD_PERL} ) {
1374 # create the apache method
1377 *{"$class\::apache"} = sub { shift->engine->apache };
1380 my ( $software, $version ) =
1381 $ENV{MOD_PERL} =~ /^(\S+)\/(\d+(?:[\.\_]\d+)+)/;
1384 $version =~ s/(\.[^.]+)\./$1/g;
1386 if ( $software eq 'mod_perl' ) {
1388 if ( $version >= 1.99922 ) {
1389 $engine = 'Catalyst::Engine::Apache2::MP20';
1392 elsif ( $version >= 1.9901 ) {
1393 $engine = 'Catalyst::Engine::Apache2::MP19';
1396 elsif ( $version >= 1.24 ) {
1397 $engine = 'Catalyst::Engine::Apache::MP13';
1401 Catalyst::Exception->throw( message =>
1402 qq/Unsupported mod_perl version: $ENV{MOD_PERL}/ );
1405 # install the correct mod_perl handler
1406 if ( $version >= 1.9901 ) {
1407 *handler = sub : method {
1408 shift->handle_request(@_);
1412 *handler = sub ($$) { shift->handle_request(@_) };
1417 elsif ( $software eq 'Zeus-Perl' ) {
1418 $engine = 'Catalyst::Engine::Zeus';
1422 Catalyst::Exception->throw(
1423 message => qq/Unsupported mod_perl: $ENV{MOD_PERL}/ );
1428 $engine = 'Catalyst::Engine::CGI';
1434 Catalyst::Exception->throw( message =>
1435 qq/Couldn't load engine "$engine" (maybe you forgot to install it?), "$@"/
1440 $class->engine( $engine->new );
1443 =item $c->setup_home
1448 my ( $class, $home ) = @_;
1450 if ( $ENV{CATALYST_HOME} ) {
1451 $home = $ENV{CATALYST_HOME};
1454 if ( $ENV{ uc($class) . '_HOME' } ) {
1455 $home = $ENV{ uc($class) . '_HOME' };
1459 $home = Catalyst::Utils::home($class);
1463 $class->config->{home} ||= $home;
1464 $class->config->{root} ||= dir($home)->subdir('root');
1473 my ( $class, $debug ) = @_;
1475 unless ( $class->log ) {
1476 $class->log( Catalyst::Log->new );
1479 if ( $ENV{CATALYST_DEBUG} || $ENV{ uc($class) . '_DEBUG' } || $debug ) {
1481 *{"$class\::debug"} = sub { 1 };
1482 $class->log->debug('Debug messages enabled');
1486 =item $c->setup_plugins
1491 my ( $class, $plugins ) = @_;
1494 for my $plugin ( reverse @$plugins ) {
1496 $plugin = "Catalyst::Plugin::$plugin";
1501 Catalyst::Exception->throw(
1502 message => qq/Couldn't load plugin "$plugin", "$@"/ );
1507 unshift @{"$class\::ISA"}, $plugin;
1512 =item $c->write( $data )
1514 Writes $data to the output stream. When using this method directly, you will
1515 need to manually set the Content-Length header to the length of your output
1523 # Finalize headers if someone manually writes output
1524 $c->finalize_headers;
1526 return $c->engine->write( $c, @_ );
1531 =head1 CASE SENSITIVITY
1533 By default Catalyst is not case sensitive, so C<MyApp::C::FOO::Bar> becomes
1536 But you can activate case sensitivity with a config parameter.
1538 MyApp->config->{case_sensitive} = 1;
1540 So C<MyApp::C::Foo::Bar> becomes C</Foo/Bar>.
1542 =head1 ON-DEMAND PARSER
1544 The request body is usually parsed at the beginning of a request,
1545 but if you want to handle input yourself or speed things up a bit
1546 you can enable on-demand parsing with a config parameter.
1548 MyApp->config->{parse_on_demand} = 1;
1550 =head1 PROXY SUPPORT
1552 Many production servers operate using the common double-server approach, with
1553 a lightweight frontend web server passing requests to a larger backend
1554 server. An application running on the backend server must deal with two
1555 problems: the remote user always appears to be '127.0.0.1' and the server's
1556 hostname will appear to be 'localhost' regardless of the virtual host the
1557 user connected through.
1559 Catalyst will automatically detect this situation when you are running both
1560 the frontend and backend servers on the same machine. The following changes
1561 are made to the request.
1563 $c->req->address is set to the user's real IP address, as read from the
1564 HTTP_X_FORWARDED_FOR header.
1566 The host value for $c->req->base and $c->req->uri is set to the real host,
1567 as read from the HTTP_X_FORWARDED_HOST header.
1569 Obviously, your web server must support these 2 headers for this to work.
1571 In a more complex server farm environment where you may have your frontend
1572 proxy server(s) on different machines, you will need to set a configuration
1573 option to tell Catalyst to read the proxied data from the headers.
1575 MyApp->config->{using_frontend_proxy} = 1;
1577 If you do not wish to use the proxy support at all, you may set:
1579 MyApp->config->{ignore_frontend_proxy} = 1;
1581 =head1 THREAD SAFETY
1583 Catalyst has been tested under Apache 2's threading mpm_worker, mpm_winnt,
1584 and the standalone forking HTTP server on Windows. We believe the Catalyst
1585 core to be thread-safe.
1587 If you plan to operate in a threaded environment, remember that all other
1588 modules you are using must also be thread-safe. Some modules, most notably
1589 DBD::SQLite, are not thread-safe.
1595 Join #catalyst on irc.perl.org.
1599 http://lists.rawmode.org/mailman/listinfo/catalyst
1600 http://lists.rawmode.org/mailman/listinfo/catalyst-dev
1604 http://catalyst.perl.org
1610 =item L<Catalyst::Manual> - The Catalyst Manual
1612 =item L<Catalyst::Engine> - Core Engine
1614 =item L<Catalyst::Log> - The Log Class.
1616 =item L<Catalyst::Request> - The Request Object
1618 =item L<Catalyst::Response> - The Response Object
1620 =item L<Catalyst::Test> - The test suite.
1678 Sebastian Riedel, C<sri@oook.de>
1682 This library is free software . You can redistribute it and/or modify it under
1683 the same terms as perl itself.