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(
21 qw/counter depth request response state action namespace/
29 # For backwards compatibility
30 *finalize_output = \&finalize_body;
35 our $RECURSION = 1000;
36 our $DETACH = "catalyst_detach\n";
38 require Module::Pluggable::Fast;
40 # Helper script generation
41 our $CATALYST_SCRIPT_GEN = 8;
43 __PACKAGE__->mk_classdata($_)
44 for qw/components arguments dispatcher engine log/;
46 our $VERSION = '5.49_01';
48 sub version { return $Catalyst::VERSION }
51 my ( $class, @arguments ) = @_;
53 # We have to limit $class to Catalyst to avoid pushing Catalyst upon every
55 return unless $class eq 'Catalyst';
57 my $caller = caller(0);
59 unless ( $caller->isa('Catalyst') ) {
61 push @{"$caller\::ISA"}, $class;
64 $caller->arguments( [@arguments] );
70 Catalyst - The Elegant MVC Web Application Framework
74 # use the helper to start a new application
78 # add models, views, controllers
79 script/myapp_create.pl model Something
80 script/myapp_create.pl view Stuff
81 script/myapp_create.pl controller Yada
84 script/myapp_server.pl
86 # command line interface
87 script/myapp_test.pl /yada
92 use Catalyst qw/My::Module My::OtherModule/;
94 use Catalyst '-Debug';
96 use Catalyst qw/-Debug -Engine=CGI/;
98 sub default : Private { $_[1]->res->output('Hello') } );
100 sub index : Path('/index.html') {
101 my ( $self, $c ) = @_;
102 $c->res->output('Hello');
106 sub product : Regex('^product[_]*(\d*).html$') {
107 my ( $self, $c ) = @_;
108 $c->stash->{template} = 'product.tt';
109 $c->stash->{product} = $c->req->snippets->[0];
112 See also L<Catalyst::Manual::Intro>
116 The key concept of Catalyst is DRY (Don't Repeat Yourself).
118 See L<Catalyst::Manual> for more documentation.
120 Catalyst plugins can be loaded by naming them as arguments to the "use Catalyst" statement.
121 Omit the C<Catalyst::Plugin::> prefix from the plugin name,
122 so C<Catalyst::Plugin::My::Module> becomes C<My::Module>.
124 use Catalyst 'My::Module';
126 Special flags like -Debug and -Engine can also be specified as arguments when
129 use Catalyst qw/-Debug My::Module/;
131 The position of plugins and flags in the chain is important, because they are
132 loaded in exactly the order that they appear.
134 The following flags are supported:
140 enables debug output, i.e.:
142 use Catalyst '-Debug';
144 this is equivalent to:
151 Force Catalyst to use a specific dispatcher.
155 Force Catalyst to use a specific engine.
156 Omit the C<Catalyst::Engine::> prefix of the engine name, i.e.:
158 use Catalyst '-Engine=CGI';
162 Force Catalyst to use a specific home directory.
176 Accessor for the current action
178 =item $c->comp($name)
180 =item $c->component($name)
182 Get a component object by name.
184 $c->comp('MyApp::Model::MyModel')->do_stuff;
195 my $appclass = ref $c || $c;
198 $name, "${appclass}::${name}",
199 map { "${appclass}::${_}::${name}" } qw/M V C/
202 foreach my $try (@names) {
204 if ( exists $c->components->{$try} ) {
206 return $c->components->{$try};
210 foreach my $component ( keys %{ $c->components } ) {
212 return $c->components->{$component} if $component =~ /$name/i;
217 return sort keys %{ $c->components };
222 Returns a hashref containing your applications settings.
226 Overload to enable debug messages.
232 =item $c->detach( $command [, \@arguments ] )
234 Like C<forward> but doesn't return.
238 sub detach { my $c = shift; $c->dispatcher->detach( $c, @_ ) }
242 Contains the dispatcher instance.
243 Stringifies to class.
245 =item $c->forward( $command [, \@arguments ] )
247 Forward processing to a private action or a method from a class.
248 If you define a class without method it will default to process().
249 also takes an optional arrayref containing arguments to be passed
250 to the new function. $c->req->args will be reset upon returning
254 $c->forward('index');
255 $c->forward(qw/MyApp::Model::CDBI::Foo do_stuff/);
256 $c->forward('MyApp::View::TT');
260 sub forward { my $c = shift; $c->dispatcher->forward( $c, @_ ) }
264 Accessor to the namespace of the current action
275 my ( $class, @arguments ) = @_;
277 unless ( $class->isa('Catalyst') ) {
279 Catalyst::Exception->throw(
280 message => qq/'$class' does not inherit from Catalyst/ );
283 if ( $class->arguments ) {
284 @arguments = ( @arguments, @{ $class->arguments } );
290 foreach (@arguments) {
294 ( $flags->{log} ) ? 'debug,' . $flags->{log} : 'debug';
296 elsif (/^-(\w+)=?(.*)$/) {
297 $flags->{ lc $1 } = $2;
300 push @{ $flags->{plugins} }, $_;
304 $class->setup_log( delete $flags->{log} );
305 $class->setup_plugins( delete $flags->{plugins} );
306 $class->setup_dispatcher( delete $flags->{dispatcher} );
307 $class->setup_engine( delete $flags->{engine} );
308 $class->setup_home( delete $flags->{home} );
310 for my $flag ( sort keys %{$flags} ) {
312 if ( my $code = $class->can( 'setup_' . $flag ) ) {
313 &$code( $class, delete $flags->{$flag} );
316 $class->log->warn(qq/Unknown flag "$flag"/);
320 $class->log->warn( "You are running an old helper script! "
321 . "Please update your scripts by regenerating the "
322 . "application and copying over the new scripts." )
323 if ( $ENV{CATALYST_SCRIPT_GEN}
324 && ( $ENV{CATALYST_SCRIPT_GEN} < $Catalyst::CATALYST_SCRIPT_GEN ) );
326 if ( $class->debug ) {
332 @plugins = grep { /^Catalyst::Plugin/ } @{"$class\::ISA"};
336 my $t = Text::ASCIITable->new;
337 $t->setOptions( 'hide_HeadRow', 1 );
338 $t->setOptions( 'hide_HeadLine', 1 );
339 $t->setCols('Class');
340 $t->setColWidth( 'Class', 75, 1 );
341 $t->addRow($_) for @plugins;
342 $class->log->debug( "Loaded plugins:\n" . $t->draw );
345 my $dispatcher = $class->dispatcher;
346 my $engine = $class->engine;
347 my $home = $class->config->{home};
349 $class->log->debug(qq/Loaded dispatcher "$dispatcher"/);
350 $class->log->debug(qq/Loaded engine "$engine"/);
354 ? $class->log->debug(qq/Found home "$home"/)
355 : $class->log->debug(qq/Home "$home" doesn't exist/)
356 : $class->log->debug(q/Couldn't find home/);
361 no warnings qw/redefine/;
362 local *setup = sub { };
366 # Initialize our data structure
367 $class->components( {} );
369 $class->setup_components;
371 if ( $class->debug ) {
372 my $t = Text::ASCIITable->new;
373 $t->setOptions( 'hide_HeadRow', 1 );
374 $t->setOptions( 'hide_HeadLine', 1 );
375 $t->setCols('Class');
376 $t->setColWidth( 'Class', 75, 1 );
377 $t->addRow($_) for sort keys %{ $class->components };
378 $class->log->debug( "Loaded components:\n" . $t->draw )
379 if ( @{ $t->{tbl_rows} } );
382 # Add our self to components, since we are also a component
383 $class->components->{$class} = $class;
385 $class->setup_actions;
387 if ( $class->debug ) {
388 my $name = $class->config->{name} || 'Application';
389 $class->log->info("$name powered by Catalyst $Catalyst::VERSION");
391 $class->log->_flush() if $class->log->can('_flush');
394 =item $c->uri_for($path,[@args])
396 Merges path with $c->request->base for absolute uri's and with
397 $c->request->match for relative uri's, then returns a normalized
398 L<URI> object. If any args are passed, they are added at the end
404 my ( $c, $path , @args) = @_;
405 my $base = $c->request->base->clone;
406 my $basepath = $base->path;
407 $basepath =~ s/\/$//;
409 my $match = $c->request->match;
410 # massage match, empty if absolute path
412 $match .= '/' if $match;
413 $match = '' if $path =~ /^\//;
415 # join args with '/', or a blank string
416 my $args=(scalar @args ? '/'.join('/',@args) : '');
417 return URI->new_abs( URI->new_abs( "$path$args", "$basepath$match" ), $base )
423 =item $c->error($error, ...)
425 =item $c->error($arrayref)
427 Returns an arrayref containing error messages.
429 my @error = @{ $c->error };
433 $c->error('Something bad happened');
439 my $error = ref $_[0] eq 'ARRAY' ? $_[0] : [@_];
440 push @{ $c->{error} }, @$error;
446 Contains the engine instance.
447 Stringifies to the class.
451 Contains the logging object. Unless it is already set Catalyst sets this up with a
452 C<Catalyst::Log> object. To use your own log class:
454 $c->log( MyLogger->new );
455 $c->log->info("now logging with my own logger!");
457 Your log class should implement the methods described in the C<Catalyst::Log>
460 =item $c->plugin( $name, $class, @args )
462 Instant plugins for Catalyst.
463 Classdata accessor/mutator will be created, class loaded and instantiated.
465 MyApp->plugin( 'prototype', 'HTML::Prototype' );
467 $c->prototype->define_javascript_functions;
472 my ( $class, $name, $plugin, @args ) = @_;
475 if ( my $error = $UNIVERSAL::require::ERROR ) {
476 Catalyst::Exception->throw(
477 message => qq/Couldn't load instant plugin "$plugin", "$error"/ );
480 eval { $plugin->import };
481 $class->mk_classdata($name);
483 eval { $obj = $plugin->new(@args) };
486 Catalyst::Exception->throw( message =>
487 qq/Couldn't instantiate instant plugin "$plugin", "$@"/ );
491 $class->log->debug(qq/Initialized instant plugin "$plugin" as "$name"/)
499 Returns a C<Catalyst::Request> object.
507 Returns a C<Catalyst::Response> object.
513 Contains the return value of the last executed action.
517 Returns a hashref containing all your data.
519 print $c->stash->{foo};
521 Keys may be set in the stash by assigning to the hash reference, or by passing
522 either a single hash reference or a list of key/value pairs as arguments.
526 $c->stash->{foo} ||= 'yada';
527 $c->stash( { moose => 'majestic', qux => 0 } );
528 $c->stash( bar => 1, gorch => 2 );
535 my $stash = @_ > 1 ? {@_} : $_[0];
536 while ( my ( $key, $val ) = each %$stash ) {
537 $c->{stash}->{$key} = $val;
543 =item $c->welcome_message
545 Returns the Catalyst welcome HTML page.
549 sub welcome_message {
551 my $name = $c->config->{name};
552 my $logo = $c->uri_for('/static/images/catalyst_logo.png');
553 my $prefix = Catalyst::Utils::appprefix( ref $c );
557 <title>$name on Catalyst $VERSION</title>
558 <style type="text/css">
563 background-color: #eee;
571 background-color: #ccc;
572 border: 1px solid #aaa;
573 -moz-border-radius: 10px;
578 font-family: verdana, tahoma, sans-serif;
581 font-family: verdana, tahoma, sans-serif;
584 text-decoration: none;
586 border-bottom: 1px dotted #bbb;
588 :link:hover, :visited:hover {
601 background-color: #fff;
602 border: 1px solid #aaa;
603 -moz-border-radius: 10px;
628 <h1><b id="appname">$name</b> on <a href="http://catalyst.perl.org">Catalyst</a>
635 <p>Welcome to the wonderful world of Catalyst.
636 This <a href="http://en.wikipedia.org/wiki/MVC">MVC</a>
637 framework will make web development something you had
638 never expected it to be: Fun, rewarding and quick.</p>
639 <h2>What to do now?</h2>
640 <p>That really depends on what <b>you</b> want to do.
641 We do, however, provide you with a few starting points.</p>
642 <p>If you want to jump right into web development with Catalyst
643 you might want to check out the documentation.</p>
644 <pre><code>perldoc <a href="http://cpansearch.perl.org/dist/Catalyst/lib/Catalyst/Manual/Intro.pod">Catalyst::Manual::Intro</a>
645 perldoc <a href="http://cpansearch.perl.org/dist/Catalyst/lib/Catalyst/Manual.pod">Catalyst::Manual</a></code></pre>
646 <h2>What to do next?</h2>
647 <p>Next it's time to write an actual application. Use the
648 helper scripts to generate <a href="http://cpansearch.perl.org/search?query=Catalyst%3A%3AController%3A%3A&mode=all">controllers</a>,
649 <a href="http://cpansearch.perl.org/search?query=Catalyst%3A%3AModel%3A%3A&mode=all">models</a> and
650 <a href="http://cpansearch.perl.org/search?query=Catalyst%3A%3AView%3A%3A&mode=all">views</a>,
651 they can save you a lot of work.</p>
652 <pre><code>script/${prefix}_create.pl -help</code></pre>
653 <p>Also, be sure to check out the vast and growing
654 collection of <a href="http://cpansearch.perl.org/search?query=Catalyst%3A%3APlugin%3A%3A&mode=all">plugins for Catalyst on CPAN</a>,
655 you are likely to find what you need there.
659 <p>Catalyst has a very active community. Here are the main places to
660 get in touch with us.</p>
663 <a href="http://dev.catalyst.perl.org">Wiki</a>
666 <a href="http://lists.rawmode.org/mailman/listinfo/catalyst">Mailing-List</a>
669 <a href="irc://irc.perl.org/catalyst">IRC channel #catalyst on irc.perl.org</a>
672 <h2>In conclusion</h2>
673 <p>The Catalyst team hope you will enjoy using Catalyst as much
674 as we enjoyed making it. Please contact us if you have ideas
675 for improvement or other feedback.</p>
685 =head1 INTERNAL METHODS
689 =item $c->benchmark($coderef)
691 Takes a coderef with arguments and returns elapsed time as float.
693 my ( $elapsed, $status ) = $c->benchmark( sub { return 1 } );
694 $c->log->info( sprintf "Processing took %f seconds", $elapsed );
701 my $time = [gettimeofday];
702 my @return = &$code(@_);
703 my $elapsed = tv_interval $time;
704 return wantarray ? ( $elapsed, @return ) : $elapsed;
709 Contains the components.
713 Returns a hashref containing coderefs and execution counts.
714 (Needed for deep recursion detection)
718 Returns the actual forward depth.
722 Dispatch request to actions.
726 sub dispatch { my $c = shift; $c->dispatcher->dispatch( $c, @_ ) }
728 =item $c->execute($class, $coderef)
730 Execute a coderef in given class and catch exceptions.
731 Errors are available via $c->error.
736 my ( $c, $class, $code ) = @_;
737 $class = $c->components->{$class} || $class;
739 my $callsub = ( caller(1) )[3];
744 $action = "/$action" unless $action =~ /\-\>/;
745 $c->counter->{"$code"}++;
747 if ( $c->counter->{"$code"} > $RECURSION ) {
748 my $error = qq/Deep recursion detected in "$action"/;
749 $c->log->error($error);
755 $action = "-> $action" if $callsub =~ /forward$/;
760 my ( $elapsed, @state ) =
761 $c->benchmark( $code, $class, $c, @{ $c->req->args } );
762 push @{ $c->{stats} }, [ $action, sprintf( '%fs', $elapsed ) ];
766 $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.
1682 Sebastian Riedel, C<sri@oook.de>
1686 This library is free software, you can redistribute it and/or modify it under
1687 the same terms as Perl itself.