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 $c->stash->{foo} ||= 'yada';
504 print $c->stash->{foo};
511 my $stash = @_ > 1 ? {@_} : $_[0];
512 while ( my ( $key, $val ) = each %$stash ) {
513 $c->{stash}->{$key} = $val;
519 =head1 $c->welcome_message
521 Returns the Catalyst welcome HTML page.
525 sub welcome_message {
527 my $name = $c->config->{name};
531 <title>$name on Catalyst $VERSION</title>
532 <style type="text/css">
537 background-color: #eee;
545 background-color: #ccc;
546 border: 1px solid #aaa;
547 -moz-border-radius: 10px;
552 font-family: garamond, verdana, tahoma, sans-serif;
560 background-color: #eee;
561 border: 1px solid #aaa;
562 -moz-border-radius: 10px;
583 <h1>$name on Catalyst $VERSION</h1>
586 <p>Welcome to the wonderfull world of Catalyst.
587 This MVC framework will make webdevelopment
588 something you had never expected it to be:
589 Fun, rewarding and quick.</p>
590 <h2>What to do now?</h2>
591 <p>That all depends really, on what <b>you</b> want to do.
592 We do, however, provide you with a few starting points.</p>
593 <p>If you want to jump right into web development with Catalyst
594 you might want to check out the following links.</p>
597 <a href="http://catalyst.perl.org">
598 Catalyst::Manual::Intro
602 <p>If you would like some background information on the
603 MVC-pattern, theese links might be able to help you out.</p>
606 <a href="http://catalyst.perl.org">
607 Introduction to Models
611 <a href="http://catalyst.perl.org">
612 Introduction to Views
616 <a href="http://catalyst.perl.org">
617 Introduction to Controllers
621 <h2>What to do next?</h2>
622 <p>Next you need to create an actuall application. Use the
623 helper scripts for what they are worth, they can save you
624 alot of work getting everything set up. Also, be sure to
625 check out the vast array of plugins for Catalyst.
626 They can handle everything from Authentication to Static
627 files, and a whole lot in between.</p>
628 <h2>In conclusion</h2>
629 <p>The Catalyst team hope you will enjoy Catalyst as much as we enjoyed making it, and that rest asure that any and all
630 feedback is welcomed</p>
631 <p class="signature">-- there is no cabal, 2005</p>
641 =head1 INTERNAL METHODS
645 =item $c->benchmark($coderef)
647 Takes a coderef with arguments and returns elapsed time as float.
649 my ( $elapsed, $status ) = $c->benchmark( sub { return 1 } );
650 $c->log->info( sprintf "Processing took %f seconds", $elapsed );
657 my $time = [gettimeofday];
658 my @return = &$code(@_);
659 my $elapsed = tv_interval $time;
660 return wantarray ? ( $elapsed, @return ) : $elapsed;
665 Contains the components.
669 Returns a hashref containing coderefs and execution counts.
670 (Needed for deep recursion detection)
674 Returns the actual forward depth.
678 Dispatch request to actions.
682 sub dispatch { my $c = shift; $c->dispatcher->dispatch( $c, @_ ) }
684 =item $c->execute($class, $coderef)
686 Execute a coderef in given class and catch exceptions.
687 Errors are available via $c->error.
692 my ( $c, $class, $code ) = @_;
693 $class = $c->components->{$class} || $class;
695 my $callsub = ( caller(1) )[3];
700 $action = "/$action" unless $action =~ /\-\>/;
701 $c->counter->{"$code"}++;
703 if ( $c->counter->{"$code"} > $RECURSION ) {
704 my $error = qq/Deep recursion detected in "$action"/;
705 $c->log->error($error);
711 $action = "-> $action" if $callsub =~ /forward$/;
717 my ( $elapsed, @state ) =
718 $c->benchmark( $code, $class, $c, @{ $c->req->args } );
719 push @{ $c->{stats} }, [ $action, sprintf( '%fs', $elapsed ) ];
722 else { $c->state( &$code( $class, $c, @{ $c->req->args } ) || 0 ) }
726 if ( my $error = $@ ) {
728 if ( $error eq $DETACH ) { die $DETACH if $c->{depth} > 1 }
730 unless ( ref $error ) {
732 $error = qq/Caught exception "$error"/;
735 $c->log->error($error);
752 $c->finalize_uploads;
755 if ( $#{ $c->error } >= 0 ) {
759 $c->finalize_headers;
762 if ( $c->request->method eq 'HEAD' ) {
763 $c->response->body('');
768 return $c->response->status;
771 =item $c->finalize_body
777 sub finalize_body { my $c = shift; $c->engine->finalize_body( $c, @_ ) }
779 =item $c->finalize_cookies
785 sub finalize_cookies { my $c = shift; $c->engine->finalize_cookies( $c, @_ ) }
787 =item $c->finalize_error
793 sub finalize_error { my $c = shift; $c->engine->finalize_error( $c, @_ ) }
795 =item $c->finalize_headers
801 sub finalize_headers {
804 # Check if we already finalized headers
805 return if $c->response->{_finalized_headers};
808 if ( my $location = $c->response->redirect ) {
809 $c->log->debug(qq/Redirecting to "$location"/) if $c->debug;
810 $c->response->header( Location => $location );
814 if ( $c->response->body && !$c->response->content_length ) {
815 $c->response->content_length( bytes::length( $c->response->body ) );
819 if ( $c->response->status =~ /^(1\d\d|[23]04)$/ ) {
820 $c->response->headers->remove_header("Content-Length");
821 $c->response->body('');
824 $c->finalize_cookies;
826 $c->engine->finalize_headers( $c, @_ );
829 $c->response->{_finalized_headers} = 1;
832 =item $c->finalize_output
834 An alias for finalize_body.
836 =item $c->finalize_read
838 Finalize the input after reading is complete.
842 sub finalize_read { my $c = shift; $c->engine->finalize_read( $c, @_ ) }
844 =item $c->finalize_uploads
846 Finalize uploads. Cleans up any temporary files.
850 sub finalize_uploads { my $c = shift; $c->engine->finalize_uploads( $c, @_ ) }
852 =item $c->get_action( $action, $namespace, $inherit )
854 Get an action in a given namespace.
858 sub get_action { my $c = shift; $c->dispatcher->get_action( $c, @_ ) }
860 =item handle_request( $class, @arguments )
867 my ( $class, @arguments ) = @_;
869 # Always expect worst case!
875 my $c = $class->prepare(@arguments);
876 $c->{stats} = \@stats;
881 if ( $class->debug ) {
883 ( $elapsed, $status ) = $class->benchmark($handler);
884 $elapsed = sprintf '%f', $elapsed;
885 my $av = sprintf '%.3f',
886 ( $elapsed == 0 ? '??' : ( 1 / $elapsed ) );
887 my $t = Text::ASCIITable->new;
888 $t->setCols( 'Action', 'Time' );
889 $t->setColWidth( 'Action', 64, 1 );
890 $t->setColWidth( 'Time', 9, 1 );
892 for my $stat (@stats) { $t->addRow( $stat->[0], $stat->[1] ) }
894 "Request took ${elapsed}s ($av/s)\n" . $t->draw );
896 else { $status = &$handler }
900 if ( my $error = $@ ) {
902 $class->log->error(qq/Caught exception in engine "$error"/);
906 $class->log->_flush() if $class->log->can('_flush');
910 =item $c->prepare(@arguments)
912 Turns the engine-specific request( Apache, CGI ... )
913 into a Catalyst context .
918 my ( $class, @arguments ) = @_;
923 request => Catalyst::Request->new(
926 body_parameters => {},
928 headers => HTTP::Headers->new,
930 query_parameters => {},
936 response => Catalyst::Response->new(
940 headers => HTTP::Headers->new(),
949 $c->request->{_context} = $c;
950 $c->response->{_context} = $c;
951 weaken( $c->request->{_context} );
952 weaken( $c->response->{_context} );
955 my $secs = time - $START || 1;
956 my $av = sprintf '%.3f', $COUNT / $secs;
957 $c->log->debug('**********************************');
958 $c->log->debug("* Request $COUNT ($av/s) [$$]");
959 $c->log->debug('**********************************');
960 $c->res->headers->header( 'X-Catalyst' => $Catalyst::VERSION );
963 $c->prepare_request(@arguments);
964 $c->prepare_connection;
965 $c->prepare_query_parameters;
971 $c->prepare_body unless $c->config->{parse_on_demand};
974 my $method = $c->req->method || '';
975 my $path = $c->req->path || '';
976 my $address = $c->req->address || '';
978 $c->log->debug(qq/"$method" request for "$path" from $address/)
984 =item $c->prepare_action
990 sub prepare_action { my $c = shift; $c->dispatcher->prepare_action( $c, @_ ) }
992 =item $c->prepare_body
994 Prepare message body.
1001 # Do we run for the first time?
1002 return if defined $c->request->{_body};
1004 # Initialize on-demand data
1005 $c->engine->prepare_body( $c, @_ );
1006 $c->prepare_parameters;
1007 $c->prepare_uploads;
1009 if ( $c->debug && keys %{ $c->req->body_parameters } ) {
1010 my $t = Text::ASCIITable->new;
1011 $t->setCols( 'Key', 'Value' );
1012 $t->setColWidth( 'Key', 37, 1 );
1013 $t->setColWidth( 'Value', 36, 1 );
1014 $t->alignCol( 'Value', 'right' );
1015 for my $key ( sort keys %{ $c->req->body_parameters } ) {
1016 my $param = $c->req->body_parameters->{$key};
1017 my $value = defined($param) ? $param : '';
1019 ref $value eq 'ARRAY' ? ( join ', ', @$value ) : $value );
1021 $c->log->debug( "Body Parameters are:\n" . $t->draw );
1025 =item $c->prepare_body_chunk( $chunk )
1027 Prepare a chunk of data before sending it to HTTP::Body.
1031 sub prepare_body_chunk {
1033 $c->engine->prepare_body_chunk( $c, @_ );
1036 =item $c->prepare_body_parameters
1038 Prepare body parameters.
1042 sub prepare_body_parameters {
1044 $c->engine->prepare_body_parameters( $c, @_ );
1047 =item $c->prepare_connection
1053 sub prepare_connection {
1055 $c->engine->prepare_connection( $c, @_ );
1058 =item $c->prepare_cookies
1064 sub prepare_cookies { my $c = shift; $c->engine->prepare_cookies( $c, @_ ) }
1066 =item $c->prepare_headers
1072 sub prepare_headers { my $c = shift; $c->engine->prepare_headers( $c, @_ ) }
1074 =item $c->prepare_parameters
1080 sub prepare_parameters {
1082 $c->prepare_body_parameters;
1083 $c->engine->prepare_parameters( $c, @_ );
1086 =item $c->prepare_path
1088 Prepare path and base.
1092 sub prepare_path { my $c = shift; $c->engine->prepare_path( $c, @_ ) }
1094 =item $c->prepare_query_parameters
1096 Prepare query parameters.
1100 sub prepare_query_parameters {
1103 $c->engine->prepare_query_parameters( $c, @_ );
1105 if ( $c->debug && keys %{ $c->request->query_parameters } ) {
1106 my $t = Text::ASCIITable->new;
1107 $t->setCols( 'Key', 'Value' );
1108 $t->setColWidth( 'Key', 37, 1 );
1109 $t->setColWidth( 'Value', 36, 1 );
1110 $t->alignCol( 'Value', 'right' );
1111 for my $key ( sort keys %{ $c->req->query_parameters } ) {
1112 my $param = $c->req->query_parameters->{$key};
1113 my $value = defined($param) ? $param : '';
1115 ref $value eq 'ARRAY' ? ( join ', ', @$value ) : $value );
1117 $c->log->debug( "Query Parameters are:\n" . $t->draw );
1121 =item $c->prepare_read
1123 Prepare the input for reading.
1127 sub prepare_read { my $c = shift; $c->engine->prepare_read( $c, @_ ) }
1129 =item $c->prepare_request
1131 Prepare the engine request.
1135 sub prepare_request { my $c = shift; $c->engine->prepare_request( $c, @_ ) }
1137 =item $c->prepare_uploads
1143 sub prepare_uploads {
1146 $c->engine->prepare_uploads( $c, @_ );
1148 if ( $c->debug && keys %{ $c->request->uploads } ) {
1149 my $t = Text::ASCIITable->new;
1150 $t->setCols( 'Key', 'Filename', 'Type', 'Size' );
1151 $t->setColWidth( 'Key', 12, 1 );
1152 $t->setColWidth( 'Filename', 28, 1 );
1153 $t->setColWidth( 'Type', 18, 1 );
1154 $t->setColWidth( 'Size', 9, 1 );
1155 $t->alignCol( 'Size', 'left' );
1156 for my $key ( sort keys %{ $c->request->uploads } ) {
1157 my $upload = $c->request->uploads->{$key};
1158 for my $u ( ref $upload eq 'ARRAY' ? @{$upload} : ($upload) ) {
1159 $t->addRow( $key, $u->filename, $u->type, $u->size );
1162 $c->log->debug( "File Uploads are:\n" . $t->draw );
1166 =item $c->prepare_write
1168 Prepare the output for writing.
1172 sub prepare_write { my $c = shift; $c->engine->prepare_write( $c, @_ ) }
1174 =item $c->read( [$maxlength] )
1176 Read a chunk of data from the request body. This method is designed to be
1177 used in a while loop, reading $maxlength bytes on every call. $maxlength
1178 defaults to the size of the request if not specified.
1180 You have to set MyApp->config->{parse_on_demand} to use this directly.
1184 sub read { my $c = shift; return $c->engine->read( $c, @_ ) }
1192 sub run { my $c = shift; return $c->engine->run( $c, @_ ) }
1194 =item $c->set_action( $action, $code, $namespace, $attrs )
1196 Set an action in a given namespace.
1200 sub set_action { my $c = shift; $c->dispatcher->set_action( $c, @_ ) }
1202 =item $c->setup_actions($component)
1204 Setup actions for a component.
1208 sub setup_actions { my $c = shift; $c->dispatcher->setup_actions( $c, @_ ) }
1210 =item $c->setup_components
1216 sub setup_components {
1219 my $callback = sub {
1220 my ( $component, $context ) = @_;
1222 unless ( $component->isa('Catalyst::Base') ) {
1226 my $suffix = Catalyst::Utils::class2classsuffix($component);
1227 my $config = $class->config->{$suffix} || {};
1231 eval { $instance = $component->new( $context, $config ); };
1233 if ( my $error = $@ ) {
1237 Catalyst::Exception->throw( message =>
1238 qq/Couldn't instantiate component "$component", "$error"/ );
1241 Catalyst::Exception->throw( message =>
1242 qq/Couldn't instantiate component "$component", "new() didn't return a object"/
1244 unless ref $instance;
1249 Module::Pluggable::Fast->import(
1250 name => '_catalyst_components',
1252 "$class\::Controller", "$class\::C",
1253 "$class\::Model", "$class\::M",
1254 "$class\::View", "$class\::V"
1256 callback => $callback
1260 if ( my $error = $@ ) {
1264 Catalyst::Exception->throw(
1265 message => qq/Couldn't load components "$error"/ );
1268 for my $component ( $class->_catalyst_components($class) ) {
1269 $class->components->{ ref $component || $component } = $component;
1273 =item $c->setup_dispatcher
1277 sub setup_dispatcher {
1278 my ( $class, $dispatcher ) = @_;
1281 $dispatcher = 'Catalyst::Dispatcher::' . $dispatcher;
1284 if ( $ENV{CATALYST_DISPATCHER} ) {
1285 $dispatcher = 'Catalyst::Dispatcher::' . $ENV{CATALYST_DISPATCHER};
1288 if ( $ENV{ uc($class) . '_DISPATCHER' } ) {
1290 'Catalyst::Dispatcher::' . $ENV{ uc($class) . '_DISPATCHER' };
1293 unless ($dispatcher) {
1294 $dispatcher = 'Catalyst::Dispatcher';
1297 $dispatcher->require;
1300 Catalyst::Exception->throw(
1301 message => qq/Couldn't load dispatcher "$dispatcher", "$@"/ );
1304 # dispatcher instance
1305 $class->dispatcher( $dispatcher->new );
1308 =item $c->setup_engine
1313 my ( $class, $engine ) = @_;
1316 $engine = 'Catalyst::Engine::' . $engine;
1319 if ( $ENV{CATALYST_ENGINE} ) {
1320 $engine = 'Catalyst::Engine::' . $ENV{CATALYST_ENGINE};
1323 if ( $ENV{ uc($class) . '_ENGINE' } ) {
1324 $engine = 'Catalyst::Engine::' . $ENV{ uc($class) . '_ENGINE' };
1327 if ( !$engine && $ENV{MOD_PERL} ) {
1329 # create the apache method
1332 *{"$class\::apache"} = sub { shift->engine->apache };
1335 my ( $software, $version ) =
1336 $ENV{MOD_PERL} =~ /^(\S+)\/(\d+(?:[\.\_]\d+)+)/;
1339 $version =~ s/(\.[^.]+)\./$1/g;
1341 if ( $software eq 'mod_perl' ) {
1343 if ( $version >= 1.99922 ) {
1344 $engine = 'Catalyst::Engine::Apache2::MP20';
1347 elsif ( $version >= 1.9901 ) {
1348 $engine = 'Catalyst::Engine::Apache2::MP19';
1351 elsif ( $version >= 1.24 ) {
1352 $engine = 'Catalyst::Engine::Apache::MP13';
1356 Catalyst::Exception->throw( message =>
1357 qq/Unsupported mod_perl version: $ENV{MOD_PERL}/ );
1360 # install the correct mod_perl handler
1361 if ( $version >= 1.9901 ) {
1362 *handler = sub : method {
1363 shift->handle_request(@_);
1367 *handler = sub ($$) { shift->handle_request(@_) };
1372 elsif ( $software eq 'Zeus-Perl' ) {
1373 $engine = 'Catalyst::Engine::Zeus';
1377 Catalyst::Exception->throw(
1378 message => qq/Unsupported mod_perl: $ENV{MOD_PERL}/ );
1383 $engine = 'Catalyst::Engine::CGI';
1389 Catalyst::Exception->throw( message =>
1390 qq/Couldn't load engine "$engine" (maybe you forgot to install it?), "$@"/
1395 $class->engine( $engine->new );
1398 =item $c->setup_home
1403 my ( $class, $home ) = @_;
1405 if ( $ENV{CATALYST_HOME} ) {
1406 $home = $ENV{CATALYST_HOME};
1409 if ( $ENV{ uc($class) . '_HOME' } ) {
1410 $home = $ENV{ uc($class) . '_HOME' };
1414 $home = Catalyst::Utils::home($class);
1418 $class->config->{home} ||= $home;
1419 $class->config->{root} ||= dir($home)->subdir('root');
1428 my ( $class, $debug ) = @_;
1430 unless ( $class->log ) {
1431 $class->log( Catalyst::Log->new );
1434 if ( $ENV{CATALYST_DEBUG} || $ENV{ uc($class) . '_DEBUG' } || $debug ) {
1436 *{"$class\::debug"} = sub { 1 };
1437 $class->log->debug('Debug messages enabled');
1441 =item $c->setup_plugins
1446 my ( $class, $plugins ) = @_;
1449 for my $plugin ( reverse @$plugins ) {
1451 $plugin = "Catalyst::Plugin::$plugin";
1456 Catalyst::Exception->throw(
1457 message => qq/Couldn't load plugin "$plugin", "$@"/ );
1462 unshift @{"$class\::ISA"}, $plugin;
1467 =item $c->write( $data )
1469 Writes $data to the output stream. When using this method directly, you will
1470 need to manually set the Content-Length header to the length of your output
1478 # Finalize headers if someone manually writes output
1479 $c->finalize_headers;
1481 return $c->engine->write( $c, @_ );
1486 =head1 CASE SENSITIVITY
1488 By default Catalyst is not case sensitive, so C<MyApp::C::FOO::Bar> becomes
1491 But you can activate case sensitivity with a config parameter.
1493 MyApp->config->{case_sensitive} = 1;
1495 So C<MyApp::C::Foo::Bar> becomes C</Foo/Bar>.
1497 =head1 ON-DEMAND PARSER
1499 The request body is usually parsed at the beginning of a request,
1500 but if you want to handle input yourself or speed things up a bit
1501 you can enable on-demand parsing with a config parameter.
1503 MyApp->config->{parse_on_demand} = 1;
1505 =head1 PROXY SUPPORT
1507 Many production servers operate using the common double-server approach, with
1508 a lightweight frontend web server passing requests to a larger backend
1509 server. An application running on the backend server must deal with two
1510 problems: the remote user always appears to be '127.0.0.1' and the server's
1511 hostname will appear to be 'localhost' regardless of the virtual host the
1512 user connected through.
1514 Catalyst will automatically detect this situation when you are running both
1515 the frontend and backend servers on the same machine. The following changes
1516 are made to the request.
1518 $c->req->address is set to the user's real IP address, as read from the
1519 HTTP_X_FORWARDED_FOR header.
1521 The host value for $c->req->base and $c->req->uri is set to the real host,
1522 as read from the HTTP_X_FORWARDED_HOST header.
1524 Obviously, your web server must support these 2 headers for this to work.
1526 In a more complex server farm environment where you may have your frontend
1527 proxy server(s) on different machines, you will need to set a configuration
1528 option to tell Catalyst to read the proxied data from the headers.
1530 MyApp->config->{using_frontend_proxy} = 1;
1532 If you do not wish to use the proxy support at all, you may set:
1534 MyApp->config->{ignore_frontend_proxy} = 1;
1536 =head1 THREAD SAFETY
1538 Catalyst has been tested under Apache 2's threading mpm_worker, mpm_winnt,
1539 and the standalone forking HTTP server on Windows. We believe the Catalyst
1540 core to be thread-safe.
1542 If you plan to operate in a threaded environment, remember that all other
1543 modules you are using must also be thread-safe. Some modules, most notably
1544 DBD::SQLite, are not thread-safe.
1550 Join #catalyst on irc.perl.org.
1554 http://lists.rawmode.org/mailman/listinfo/catalyst
1555 http://lists.rawmode.org/mailman/listinfo/catalyst-dev
1559 http://catalyst.perl.org
1565 =item L<Catalyst::Manual> - The Catalyst Manual
1567 =item L<Catalyst::Engine> - Core Engine
1569 =item L<Catalyst::Log> - The Log Class.
1571 =item L<Catalyst::Request> - The Request Object
1573 =item L<Catalyst::Response> - The Response Object
1575 =item L<Catalyst::Test> - The test suite.
1633 Sebastian Riedel, C<sri@oook.de>
1637 This library is free software . You can redistribute it and/or modify it under
1638 the same terms as perl itself.