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;
411 # massage match, empty if absolute path
413 $match .= '/' if $match;
414 $match = '' if $path =~ /^\//;
417 # join args with '/', or a blank string
418 my $args = ( scalar @args ? '/' . join( '/', @args ) : '' );
419 return URI->new_abs( URI->new_abs( "$path$args", "$basepath$match" ),
425 =item $c->error($error, ...)
427 =item $c->error($arrayref)
429 Returns an arrayref containing error messages.
431 my @error = @{ $c->error };
435 $c->error('Something bad happened');
446 my $error = ref $_[0] eq 'ARRAY' ? $_[0] : [@_];
447 push @{ $c->{error} }, @$error;
449 elsif ( defined $_[0] ) { $c->{error} = undef }
450 return $c->{error} || [];
455 Contains the engine instance.
456 Stringifies to the class.
460 Contains the logging object. Unless it is already set Catalyst sets this up with a
461 C<Catalyst::Log> object. To use your own log class:
463 $c->log( MyLogger->new );
464 $c->log->info("now logging with my own logger!");
466 Your log class should implement the methods described in the C<Catalyst::Log>
469 =item $c->plugin( $name, $class, @args )
471 Instant plugins for Catalyst.
472 Classdata accessor/mutator will be created, class loaded and instantiated.
474 MyApp->plugin( 'prototype', 'HTML::Prototype' );
476 $c->prototype->define_javascript_functions;
481 my ( $class, $name, $plugin, @args ) = @_;
484 if ( my $error = $UNIVERSAL::require::ERROR ) {
485 Catalyst::Exception->throw(
486 message => qq/Couldn't load instant plugin "$plugin", "$error"/ );
489 eval { $plugin->import };
490 $class->mk_classdata($name);
492 eval { $obj = $plugin->new(@args) };
495 Catalyst::Exception->throw( message =>
496 qq/Couldn't instantiate instant plugin "$plugin", "$@"/ );
500 $class->log->debug(qq/Initialized instant plugin "$plugin" as "$name"/)
508 Returns a C<Catalyst::Request> object.
516 Returns a C<Catalyst::Response> object.
522 Contains the return value of the last executed action.
526 Returns a hashref containing all your data.
528 print $c->stash->{foo};
530 Keys may be set in the stash by assigning to the hash reference, or by passing
531 either a single hash reference or a list of key/value pairs as arguments.
535 $c->stash->{foo} ||= 'yada';
536 $c->stash( { moose => 'majestic', qux => 0 } );
537 $c->stash( bar => 1, gorch => 2 );
544 my $stash = @_ > 1 ? {@_} : $_[0];
545 while ( my ( $key, $val ) = each %$stash ) {
546 $c->{stash}->{$key} = $val;
552 =item $c->welcome_message
554 Returns the Catalyst welcome HTML page.
558 sub welcome_message {
560 my $name = $c->config->{name};
561 my $logo = $c->uri_for('/static/images/catalyst_logo.png');
562 my $prefix = Catalyst::Utils::appprefix( ref $c );
566 <title>$name on Catalyst $VERSION</title>
567 <style type="text/css">
572 background-color: #eee;
580 background-color: #ccc;
581 border: 1px solid #aaa;
582 -moz-border-radius: 10px;
587 font-family: verdana, tahoma, sans-serif;
590 font-family: verdana, tahoma, sans-serif;
593 text-decoration: none;
595 border-bottom: 1px dotted #bbb;
597 :link:hover, :visited:hover {
610 background-color: #fff;
611 border: 1px solid #aaa;
612 -moz-border-radius: 10px;
637 <h1><b id="appname">$name</b> on <a href="http://catalyst.perl.org">Catalyst</a>
644 <p>Welcome to the wonderful world of Catalyst.
645 This <a href="http://en.wikipedia.org/wiki/MVC">MVC</a>
646 framework will make web development something you had
647 never expected it to be: Fun, rewarding and quick.</p>
648 <h2>What to do now?</h2>
649 <p>That really depends on what <b>you</b> want to do.
650 We do, however, provide you with a few starting points.</p>
651 <p>If you want to jump right into web development with Catalyst
652 you might want to check out the documentation.</p>
653 <pre><code>perldoc <a href="http://cpansearch.perl.org/dist/Catalyst/lib/Catalyst/Manual/Intro.pod">Catalyst::Manual::Intro</a>
654 perldoc <a href="http://cpansearch.perl.org/dist/Catalyst/lib/Catalyst/Manual.pod">Catalyst::Manual</a></code></pre>
655 <h2>What to do next?</h2>
656 <p>Next it's time to write an actual application. Use the
657 helper scripts to generate <a href="http://cpansearch.perl.org/search?query=Catalyst%3A%3AController%3A%3A&mode=all">controllers</a>,
658 <a href="http://cpansearch.perl.org/search?query=Catalyst%3A%3AModel%3A%3A&mode=all">models</a> and
659 <a href="http://cpansearch.perl.org/search?query=Catalyst%3A%3AView%3A%3A&mode=all">views</a>,
660 they can save you a lot of work.</p>
661 <pre><code>script/${prefix}_create.pl -help</code></pre>
662 <p>Also, be sure to check out the vast and growing
663 collection of <a href="http://cpansearch.perl.org/search?query=Catalyst%3A%3APlugin%3A%3A&mode=all">plugins for Catalyst on CPAN</a>,
664 you are likely to find what you need there.
668 <p>Catalyst has a very active community. Here are the main places to
669 get in touch with us.</p>
672 <a href="http://dev.catalyst.perl.org">Wiki</a>
675 <a href="http://lists.rawmode.org/mailman/listinfo/catalyst">Mailing-List</a>
678 <a href="irc://irc.perl.org/catalyst">IRC channel #catalyst on irc.perl.org</a>
681 <h2>In conclusion</h2>
682 <p>The Catalyst team hope you will enjoy using Catalyst as much
683 as we enjoyed making it. Please contact us if you have ideas
684 for improvement or other feedback.</p>
694 =head1 INTERNAL METHODS
698 =item $c->benchmark($coderef)
700 Takes a coderef with arguments and returns elapsed time as float.
702 my ( $elapsed, $status ) = $c->benchmark( sub { return 1 } );
703 $c->log->info( sprintf "Processing took %f seconds", $elapsed );
710 my $time = [gettimeofday];
711 my @return = &$code(@_);
712 my $elapsed = tv_interval $time;
713 return wantarray ? ( $elapsed, @return ) : $elapsed;
718 Contains the components.
722 Returns a hashref containing coderefs and execution counts.
723 (Needed for deep recursion detection)
727 Returns the actual forward depth.
731 Dispatch request to actions.
735 sub dispatch { my $c = shift; $c->dispatcher->dispatch( $c, @_ ) }
737 =item $c->execute($class, $coderef)
739 Execute a coderef in given class and catch exceptions.
740 Errors are available via $c->error.
745 my ( $c, $class, $code ) = @_;
746 $class = $c->components->{$class} || $class;
748 my $callsub = ( caller(1) )[3];
753 $action = "/$action" unless $action =~ /\-\>/;
754 $c->counter->{"$code"}++;
756 if ( $c->counter->{"$code"} > $RECURSION ) {
757 my $error = qq/Deep recursion detected in "$action"/;
758 $c->log->error($error);
764 $action = "-> $action" if $callsub =~ /forward$/;
770 my ( $elapsed, @state ) =
771 $c->benchmark( $code, $class, $c, @{ $c->req->args } );
772 push @{ $c->{stats} }, [ $action, sprintf( '%fs', $elapsed ) ];
776 $c->state( &$code( $class, $c, @{ $c->req->args } ) || 0 );
781 if ( my $error = $@ ) {
783 if ( $error eq $DETACH ) { die $DETACH if $c->{depth} > 1 }
785 unless ( ref $error ) {
787 $error = qq/Caught exception "$error"/;
790 $c->log->error($error);
807 $c->finalize_uploads;
810 if ( $#{ $c->error } >= 0 ) {
814 $c->finalize_headers;
817 if ( $c->request->method eq 'HEAD' ) {
818 $c->response->body('');
823 return $c->response->status;
826 =item $c->finalize_body
832 sub finalize_body { my $c = shift; $c->engine->finalize_body( $c, @_ ) }
834 =item $c->finalize_cookies
840 sub finalize_cookies { my $c = shift; $c->engine->finalize_cookies( $c, @_ ) }
842 =item $c->finalize_error
848 sub finalize_error { my $c = shift; $c->engine->finalize_error( $c, @_ ) }
850 =item $c->finalize_headers
856 sub finalize_headers {
859 # Check if we already finalized headers
860 return if $c->response->{_finalized_headers};
863 if ( my $location = $c->response->redirect ) {
864 $c->log->debug(qq/Redirecting to "$location"/) if $c->debug;
865 $c->response->header( Location => $location );
869 if ( $c->response->body && !$c->response->content_length ) {
870 $c->response->content_length( bytes::length( $c->response->body ) );
874 if ( $c->response->status =~ /^(1\d\d|[23]04)$/ ) {
875 $c->response->headers->remove_header("Content-Length");
876 $c->response->body('');
879 $c->finalize_cookies;
881 $c->engine->finalize_headers( $c, @_ );
884 $c->response->{_finalized_headers} = 1;
887 =item $c->finalize_output
889 An alias for finalize_body.
891 =item $c->finalize_read
893 Finalize the input after reading is complete.
897 sub finalize_read { my $c = shift; $c->engine->finalize_read( $c, @_ ) }
899 =item $c->finalize_uploads
901 Finalize uploads. Cleans up any temporary files.
905 sub finalize_uploads { my $c = shift; $c->engine->finalize_uploads( $c, @_ ) }
907 =item $c->get_action( $action, $namespace, $inherit )
909 Get an action in a given namespace.
913 sub get_action { my $c = shift; $c->dispatcher->get_action( $c, @_ ) }
915 =item handle_request( $class, @arguments )
922 my ( $class, @arguments ) = @_;
924 # Always expect worst case!
930 my $c = $class->prepare(@arguments);
931 $c->{stats} = \@stats;
936 if ( $class->debug ) {
938 ( $elapsed, $status ) = $class->benchmark($handler);
939 $elapsed = sprintf '%f', $elapsed;
940 my $av = sprintf '%.3f',
941 ( $elapsed == 0 ? '??' : ( 1 / $elapsed ) );
942 my $t = Text::ASCIITable->new;
943 $t->setCols( 'Action', 'Time' );
944 $t->setColWidth( 'Action', 64, 1 );
945 $t->setColWidth( 'Time', 9, 1 );
947 for my $stat (@stats) { $t->addRow( $stat->[0], $stat->[1] ) }
949 "Request took ${elapsed}s ($av/s)\n" . $t->draw );
951 else { $status = &$handler }
955 if ( my $error = $@ ) {
957 $class->log->error(qq/Caught exception in engine "$error"/);
961 $class->log->_flush() if $class->log->can('_flush');
965 =item $c->prepare(@arguments)
967 Turns the engine-specific request( Apache, CGI ... )
968 into a Catalyst context .
973 my ( $class, @arguments ) = @_;
978 request => Catalyst::Request->new(
981 body_parameters => {},
983 headers => HTTP::Headers->new,
985 query_parameters => {},
991 response => Catalyst::Response->new(
995 headers => HTTP::Headers->new(),
1003 # For on-demand data
1004 $c->request->{_context} = $c;
1005 $c->response->{_context} = $c;
1006 weaken( $c->request->{_context} );
1007 weaken( $c->response->{_context} );
1010 my $secs = time - $START || 1;
1011 my $av = sprintf '%.3f', $COUNT / $secs;
1012 $c->log->debug('**********************************');
1013 $c->log->debug("* Request $COUNT ($av/s) [$$]");
1014 $c->log->debug('**********************************');
1015 $c->res->headers->header( 'X-Catalyst' => $Catalyst::VERSION );
1018 $c->prepare_request(@arguments);
1019 $c->prepare_connection;
1020 $c->prepare_query_parameters;
1021 $c->prepare_headers;
1022 $c->prepare_cookies;
1026 $c->prepare_body unless $c->config->{parse_on_demand};
1029 my $method = $c->req->method || '';
1030 my $path = $c->req->path || '';
1031 my $address = $c->req->address || '';
1033 $c->log->debug(qq/"$method" request for "$path" from $address/)
1039 =item $c->prepare_action
1045 sub prepare_action { my $c = shift; $c->dispatcher->prepare_action( $c, @_ ) }
1047 =item $c->prepare_body
1049 Prepare message body.
1056 # Do we run for the first time?
1057 return if defined $c->request->{_body};
1059 # Initialize on-demand data
1060 $c->engine->prepare_body( $c, @_ );
1061 $c->prepare_parameters;
1062 $c->prepare_uploads;
1064 if ( $c->debug && keys %{ $c->req->body_parameters } ) {
1065 my $t = Text::ASCIITable->new;
1066 $t->setCols( 'Key', 'Value' );
1067 $t->setColWidth( 'Key', 37, 1 );
1068 $t->setColWidth( 'Value', 36, 1 );
1069 $t->alignCol( 'Value', 'right' );
1070 for my $key ( sort keys %{ $c->req->body_parameters } ) {
1071 my $param = $c->req->body_parameters->{$key};
1072 my $value = defined($param) ? $param : '';
1074 ref $value eq 'ARRAY' ? ( join ', ', @$value ) : $value );
1076 $c->log->debug( "Body Parameters are:\n" . $t->draw );
1080 =item $c->prepare_body_chunk( $chunk )
1082 Prepare a chunk of data before sending it to HTTP::Body.
1086 sub prepare_body_chunk {
1088 $c->engine->prepare_body_chunk( $c, @_ );
1091 =item $c->prepare_body_parameters
1093 Prepare body parameters.
1097 sub prepare_body_parameters {
1099 $c->engine->prepare_body_parameters( $c, @_ );
1102 =item $c->prepare_connection
1108 sub prepare_connection {
1110 $c->engine->prepare_connection( $c, @_ );
1113 =item $c->prepare_cookies
1119 sub prepare_cookies { my $c = shift; $c->engine->prepare_cookies( $c, @_ ) }
1121 =item $c->prepare_headers
1127 sub prepare_headers { my $c = shift; $c->engine->prepare_headers( $c, @_ ) }
1129 =item $c->prepare_parameters
1135 sub prepare_parameters {
1137 $c->prepare_body_parameters;
1138 $c->engine->prepare_parameters( $c, @_ );
1141 =item $c->prepare_path
1143 Prepare path and base.
1147 sub prepare_path { my $c = shift; $c->engine->prepare_path( $c, @_ ) }
1149 =item $c->prepare_query_parameters
1151 Prepare query parameters.
1155 sub prepare_query_parameters {
1158 $c->engine->prepare_query_parameters( $c, @_ );
1160 if ( $c->debug && keys %{ $c->request->query_parameters } ) {
1161 my $t = Text::ASCIITable->new;
1162 $t->setCols( 'Key', 'Value' );
1163 $t->setColWidth( 'Key', 37, 1 );
1164 $t->setColWidth( 'Value', 36, 1 );
1165 $t->alignCol( 'Value', 'right' );
1166 for my $key ( sort keys %{ $c->req->query_parameters } ) {
1167 my $param = $c->req->query_parameters->{$key};
1168 my $value = defined($param) ? $param : '';
1170 ref $value eq 'ARRAY' ? ( join ', ', @$value ) : $value );
1172 $c->log->debug( "Query Parameters are:\n" . $t->draw );
1176 =item $c->prepare_read
1178 Prepare the input for reading.
1182 sub prepare_read { my $c = shift; $c->engine->prepare_read( $c, @_ ) }
1184 =item $c->prepare_request
1186 Prepare the engine request.
1190 sub prepare_request { my $c = shift; $c->engine->prepare_request( $c, @_ ) }
1192 =item $c->prepare_uploads
1198 sub prepare_uploads {
1201 $c->engine->prepare_uploads( $c, @_ );
1203 if ( $c->debug && keys %{ $c->request->uploads } ) {
1204 my $t = Text::ASCIITable->new;
1205 $t->setCols( 'Key', 'Filename', 'Type', 'Size' );
1206 $t->setColWidth( 'Key', 12, 1 );
1207 $t->setColWidth( 'Filename', 28, 1 );
1208 $t->setColWidth( 'Type', 18, 1 );
1209 $t->setColWidth( 'Size', 9, 1 );
1210 $t->alignCol( 'Size', 'left' );
1211 for my $key ( sort keys %{ $c->request->uploads } ) {
1212 my $upload = $c->request->uploads->{$key};
1213 for my $u ( ref $upload eq 'ARRAY' ? @{$upload} : ($upload) ) {
1214 $t->addRow( $key, $u->filename, $u->type, $u->size );
1217 $c->log->debug( "File Uploads are:\n" . $t->draw );
1221 =item $c->prepare_write
1223 Prepare the output for writing.
1227 sub prepare_write { my $c = shift; $c->engine->prepare_write( $c, @_ ) }
1229 =item $c->read( [$maxlength] )
1231 Read a chunk of data from the request body. This method is designed to be
1232 used in a while loop, reading $maxlength bytes on every call. $maxlength
1233 defaults to the size of the request if not specified.
1235 You have to set MyApp->config->{parse_on_demand} to use this directly.
1239 sub read { my $c = shift; return $c->engine->read( $c, @_ ) }
1247 sub run { my $c = shift; return $c->engine->run( $c, @_ ) }
1249 =item $c->set_action( $action, $code, $namespace, $attrs )
1251 Set an action in a given namespace.
1255 sub set_action { my $c = shift; $c->dispatcher->set_action( $c, @_ ) }
1257 =item $c->setup_actions($component)
1259 Setup actions for a component.
1263 sub setup_actions { my $c = shift; $c->dispatcher->setup_actions( $c, @_ ) }
1265 =item $c->setup_components
1271 sub setup_components {
1274 my $callback = sub {
1275 my ( $component, $context ) = @_;
1277 unless ( $component->isa('Catalyst::Base') ) {
1281 my $suffix = Catalyst::Utils::class2classsuffix($component);
1282 my $config = $class->config->{$suffix} || {};
1286 eval { $instance = $component->new( $context, $config ); };
1288 if ( my $error = $@ ) {
1292 Catalyst::Exception->throw( message =>
1293 qq/Couldn't instantiate component "$component", "$error"/ );
1296 Catalyst::Exception->throw( message =>
1297 qq/Couldn't instantiate component "$component", "new() didn't return a object"/
1299 unless ref $instance;
1304 Module::Pluggable::Fast->import(
1305 name => '_catalyst_components',
1307 "$class\::Controller", "$class\::C",
1308 "$class\::Model", "$class\::M",
1309 "$class\::View", "$class\::V"
1311 callback => $callback
1315 if ( my $error = $@ ) {
1319 Catalyst::Exception->throw(
1320 message => qq/Couldn't load components "$error"/ );
1323 for my $component ( $class->_catalyst_components($class) ) {
1324 $class->components->{ ref $component || $component } = $component;
1328 =item $c->setup_dispatcher
1332 sub setup_dispatcher {
1333 my ( $class, $dispatcher ) = @_;
1336 $dispatcher = 'Catalyst::Dispatcher::' . $dispatcher;
1339 if ( $ENV{CATALYST_DISPATCHER} ) {
1340 $dispatcher = 'Catalyst::Dispatcher::' . $ENV{CATALYST_DISPATCHER};
1343 if ( $ENV{ uc($class) . '_DISPATCHER' } ) {
1345 'Catalyst::Dispatcher::' . $ENV{ uc($class) . '_DISPATCHER' };
1348 unless ($dispatcher) {
1349 $dispatcher = 'Catalyst::Dispatcher';
1352 $dispatcher->require;
1355 Catalyst::Exception->throw(
1356 message => qq/Couldn't load dispatcher "$dispatcher", "$@"/ );
1359 # dispatcher instance
1360 $class->dispatcher( $dispatcher->new );
1363 =item $c->setup_engine
1368 my ( $class, $engine ) = @_;
1371 $engine = 'Catalyst::Engine::' . $engine;
1374 if ( $ENV{CATALYST_ENGINE} ) {
1375 $engine = 'Catalyst::Engine::' . $ENV{CATALYST_ENGINE};
1378 if ( $ENV{ uc($class) . '_ENGINE' } ) {
1379 $engine = 'Catalyst::Engine::' . $ENV{ uc($class) . '_ENGINE' };
1382 if ( !$engine && $ENV{MOD_PERL} ) {
1384 # create the apache method
1387 *{"$class\::apache"} = sub { shift->engine->apache };
1390 my ( $software, $version ) =
1391 $ENV{MOD_PERL} =~ /^(\S+)\/(\d+(?:[\.\_]\d+)+)/;
1394 $version =~ s/(\.[^.]+)\./$1/g;
1396 if ( $software eq 'mod_perl' ) {
1398 if ( $version >= 1.99922 ) {
1399 $engine = 'Catalyst::Engine::Apache2::MP20';
1402 elsif ( $version >= 1.9901 ) {
1403 $engine = 'Catalyst::Engine::Apache2::MP19';
1406 elsif ( $version >= 1.24 ) {
1407 $engine = 'Catalyst::Engine::Apache::MP13';
1411 Catalyst::Exception->throw( message =>
1412 qq/Unsupported mod_perl version: $ENV{MOD_PERL}/ );
1415 # install the correct mod_perl handler
1416 if ( $version >= 1.9901 ) {
1417 *handler = sub : method {
1418 shift->handle_request(@_);
1422 *handler = sub ($$) { shift->handle_request(@_) };
1427 elsif ( $software eq 'Zeus-Perl' ) {
1428 $engine = 'Catalyst::Engine::Zeus';
1432 Catalyst::Exception->throw(
1433 message => qq/Unsupported mod_perl: $ENV{MOD_PERL}/ );
1438 $engine = 'Catalyst::Engine::CGI';
1444 Catalyst::Exception->throw( message =>
1445 qq/Couldn't load engine "$engine" (maybe you forgot to install it?), "$@"/
1450 $class->engine( $engine->new );
1453 =item $c->setup_home
1458 my ( $class, $home ) = @_;
1460 if ( $ENV{CATALYST_HOME} ) {
1461 $home = $ENV{CATALYST_HOME};
1464 if ( $ENV{ uc($class) . '_HOME' } ) {
1465 $home = $ENV{ uc($class) . '_HOME' };
1469 $home = Catalyst::Utils::home($class);
1473 $class->config->{home} ||= $home;
1474 $class->config->{root} ||= dir($home)->subdir('root');
1483 my ( $class, $debug ) = @_;
1485 unless ( $class->log ) {
1486 $class->log( Catalyst::Log->new );
1489 if ( $ENV{CATALYST_DEBUG} || $ENV{ uc($class) . '_DEBUG' } || $debug ) {
1491 *{"$class\::debug"} = sub { 1 };
1492 $class->log->debug('Debug messages enabled');
1496 =item $c->setup_plugins
1501 my ( $class, $plugins ) = @_;
1504 for my $plugin ( reverse @$plugins ) {
1506 $plugin = "Catalyst::Plugin::$plugin";
1511 Catalyst::Exception->throw(
1512 message => qq/Couldn't load plugin "$plugin", "$@"/ );
1517 unshift @{"$class\::ISA"}, $plugin;
1522 =item $c->write( $data )
1524 Writes $data to the output stream. When using this method directly, you will
1525 need to manually set the Content-Length header to the length of your output
1533 # Finalize headers if someone manually writes output
1534 $c->finalize_headers;
1536 return $c->engine->write( $c, @_ );
1541 =head1 CASE SENSITIVITY
1543 By default Catalyst is not case sensitive, so C<MyApp::C::FOO::Bar> becomes
1546 But you can activate case sensitivity with a config parameter.
1548 MyApp->config->{case_sensitive} = 1;
1550 So C<MyApp::C::Foo::Bar> becomes C</Foo/Bar>.
1552 =head1 ON-DEMAND PARSER
1554 The request body is usually parsed at the beginning of a request,
1555 but if you want to handle input yourself or speed things up a bit
1556 you can enable on-demand parsing with a config parameter.
1558 MyApp->config->{parse_on_demand} = 1;
1560 =head1 PROXY SUPPORT
1562 Many production servers operate using the common double-server approach, with
1563 a lightweight frontend web server passing requests to a larger backend
1564 server. An application running on the backend server must deal with two
1565 problems: the remote user always appears to be '127.0.0.1' and the server's
1566 hostname will appear to be 'localhost' regardless of the virtual host the
1567 user connected through.
1569 Catalyst will automatically detect this situation when you are running both
1570 the frontend and backend servers on the same machine. The following changes
1571 are made to the request.
1573 $c->req->address is set to the user's real IP address, as read from the
1574 HTTP_X_FORWARDED_FOR header.
1576 The host value for $c->req->base and $c->req->uri is set to the real host,
1577 as read from the HTTP_X_FORWARDED_HOST header.
1579 Obviously, your web server must support these 2 headers for this to work.
1581 In a more complex server farm environment where you may have your frontend
1582 proxy server(s) on different machines, you will need to set a configuration
1583 option to tell Catalyst to read the proxied data from the headers.
1585 MyApp->config->{using_frontend_proxy} = 1;
1587 If you do not wish to use the proxy support at all, you may set:
1589 MyApp->config->{ignore_frontend_proxy} = 1;
1591 =head1 THREAD SAFETY
1593 Catalyst has been tested under Apache 2's threading mpm_worker, mpm_winnt,
1594 and the standalone forking HTTP server on Windows. We believe the Catalyst
1595 core to be thread-safe.
1597 If you plan to operate in a threaded environment, remember that all other
1598 modules you are using must also be thread-safe. Some modules, most notably
1599 DBD::SQLite, are not thread-safe.
1605 Join #catalyst on irc.perl.org.
1609 http://lists.rawmode.org/mailman/listinfo/catalyst
1610 http://lists.rawmode.org/mailman/listinfo/catalyst-dev
1614 http://catalyst.perl.org
1620 =item L<Catalyst::Manual> - The Catalyst Manual
1622 =item L<Catalyst::Engine> - Core Engine
1624 =item L<Catalyst::Log> - The Log Class.
1626 =item L<Catalyst::Request> - The Request Object
1628 =item L<Catalyst::Response> - The Response Object
1630 =item L<Catalyst::Test> - The test suite.
1692 Sebastian Riedel, C<sri@oook.de>
1696 This library is free software, you can redistribute it and/or modify it under
1697 the same terms as Perl itself.