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;
555 text-decoration: none;
557 border-bottom: 1px dotted #bbb;
559 :link:hover, :visited:hover {
560 background-color: #fff;
567 border: 1px dotted #555;
574 background-color: #fff;
575 border: 1px solid #aaa;
576 -moz-border-radius: 10px;
597 <h1>$name on Catalyst $VERSION</h1>
600 <p>Welcome to the wonderfull world of Catalyst.
601 This MVC framework will make webdevelopment
602 something you had never expected it to be:
603 Fun, rewarding and quick.</p>
604 <h2>What to do now?</h2>
605 <p>That all depends really, on what <b>you</b> want to do.
606 We do, however, provide you with a few starting points.</p>
607 <p>If you want to jump right into web development with Catalyst
608 you might want to check out the documentation.</p>
609 <pre><code>perldoc<a href="http://cpansearch.perl.org/dist/Catalyst/lib/Catalyst/Manual.pod">Catalyst::Manual</a>
610 perldoc<a href="http://cpansearch.perl.org/dist/Catalyst/lib/Catalyst/Manual/Intro.pod">Catalyst::Manual::Intro</a></code></pre>
611 <p>If you would like some background information on the
612 MVC-pattern, theese links might be able to help you out.</p>
615 <a href="http://dev.catalyst.perl.org/wiki/Models">
616 Introduction to Models
620 <a href="http://dev.catalyst.perl.org/wiki/Views">
621 Introduction to Views
625 <a href="http://dev.catalyst.perl.org/wiki/Controllers">
626 Introduction to Controllers
630 <h2>What to do next?</h2>
631 <p>Next you need to create an actuall application. Use the
632 helper scripts for what they are worth, they can save you
633 alot of work getting everything set up. Also, be sure to
634 check out the vast array of plugins for Catalyst.
635 They can handle everything from Authentication to Static
636 files, and a whole lot in between.</p>
637 <h2>In conclusion</h2>
638 <p>The Catalyst team hope you will enjoy Catalyst as much as we enjoyed making it, and that rest asure that any and all
639 feedback is welcomed</p>
640 <p class="signature">-- there is no cabal, 2005</p>
650 =head1 INTERNAL METHODS
654 =item $c->benchmark($coderef)
656 Takes a coderef with arguments and returns elapsed time as float.
658 my ( $elapsed, $status ) = $c->benchmark( sub { return 1 } );
659 $c->log->info( sprintf "Processing took %f seconds", $elapsed );
666 my $time = [gettimeofday];
667 my @return = &$code(@_);
668 my $elapsed = tv_interval $time;
669 return wantarray ? ( $elapsed, @return ) : $elapsed;
674 Contains the components.
678 Returns a hashref containing coderefs and execution counts.
679 (Needed for deep recursion detection)
683 Returns the actual forward depth.
687 Dispatch request to actions.
691 sub dispatch { my $c = shift; $c->dispatcher->dispatch( $c, @_ ) }
693 =item $c->execute($class, $coderef)
695 Execute a coderef in given class and catch exceptions.
696 Errors are available via $c->error.
701 my ( $c, $class, $code ) = @_;
702 $class = $c->components->{$class} || $class;
704 my $callsub = ( caller(1) )[3];
709 $action = "/$action" unless $action =~ /\-\>/;
710 $c->counter->{"$code"}++;
712 if ( $c->counter->{"$code"} > $RECURSION ) {
713 my $error = qq/Deep recursion detected in "$action"/;
714 $c->log->error($error);
720 $action = "-> $action" if $callsub =~ /forward$/;
726 my ( $elapsed, @state ) =
727 $c->benchmark( $code, $class, $c, @{ $c->req->args } );
728 push @{ $c->{stats} }, [ $action, sprintf( '%fs', $elapsed ) ];
731 else { $c->state( &$code( $class, $c, @{ $c->req->args } ) || 0 ) }
735 if ( my $error = $@ ) {
737 if ( $error eq $DETACH ) { die $DETACH if $c->{depth} > 1 }
739 unless ( ref $error ) {
741 $error = qq/Caught exception "$error"/;
744 $c->log->error($error);
761 $c->finalize_uploads;
764 if ( $#{ $c->error } >= 0 ) {
768 $c->finalize_headers;
771 if ( $c->request->method eq 'HEAD' ) {
772 $c->response->body('');
777 return $c->response->status;
780 =item $c->finalize_body
786 sub finalize_body { my $c = shift; $c->engine->finalize_body( $c, @_ ) }
788 =item $c->finalize_cookies
794 sub finalize_cookies { my $c = shift; $c->engine->finalize_cookies( $c, @_ ) }
796 =item $c->finalize_error
802 sub finalize_error { my $c = shift; $c->engine->finalize_error( $c, @_ ) }
804 =item $c->finalize_headers
810 sub finalize_headers {
813 # Check if we already finalized headers
814 return if $c->response->{_finalized_headers};
817 if ( my $location = $c->response->redirect ) {
818 $c->log->debug(qq/Redirecting to "$location"/) if $c->debug;
819 $c->response->header( Location => $location );
823 if ( $c->response->body && !$c->response->content_length ) {
824 $c->response->content_length( bytes::length( $c->response->body ) );
828 if ( $c->response->status =~ /^(1\d\d|[23]04)$/ ) {
829 $c->response->headers->remove_header("Content-Length");
830 $c->response->body('');
833 $c->finalize_cookies;
835 $c->engine->finalize_headers( $c, @_ );
838 $c->response->{_finalized_headers} = 1;
841 =item $c->finalize_output
843 An alias for finalize_body.
845 =item $c->finalize_read
847 Finalize the input after reading is complete.
851 sub finalize_read { my $c = shift; $c->engine->finalize_read( $c, @_ ) }
853 =item $c->finalize_uploads
855 Finalize uploads. Cleans up any temporary files.
859 sub finalize_uploads { my $c = shift; $c->engine->finalize_uploads( $c, @_ ) }
861 =item $c->get_action( $action, $namespace, $inherit )
863 Get an action in a given namespace.
867 sub get_action { my $c = shift; $c->dispatcher->get_action( $c, @_ ) }
869 =item handle_request( $class, @arguments )
876 my ( $class, @arguments ) = @_;
878 # Always expect worst case!
884 my $c = $class->prepare(@arguments);
885 $c->{stats} = \@stats;
890 if ( $class->debug ) {
892 ( $elapsed, $status ) = $class->benchmark($handler);
893 $elapsed = sprintf '%f', $elapsed;
894 my $av = sprintf '%.3f',
895 ( $elapsed == 0 ? '??' : ( 1 / $elapsed ) );
896 my $t = Text::ASCIITable->new;
897 $t->setCols( 'Action', 'Time' );
898 $t->setColWidth( 'Action', 64, 1 );
899 $t->setColWidth( 'Time', 9, 1 );
901 for my $stat (@stats) { $t->addRow( $stat->[0], $stat->[1] ) }
903 "Request took ${elapsed}s ($av/s)\n" . $t->draw );
905 else { $status = &$handler }
909 if ( my $error = $@ ) {
911 $class->log->error(qq/Caught exception in engine "$error"/);
915 $class->log->_flush() if $class->log->can('_flush');
919 =item $c->prepare(@arguments)
921 Turns the engine-specific request( Apache, CGI ... )
922 into a Catalyst context .
927 my ( $class, @arguments ) = @_;
932 request => Catalyst::Request->new(
935 body_parameters => {},
937 headers => HTTP::Headers->new,
939 query_parameters => {},
945 response => Catalyst::Response->new(
949 headers => HTTP::Headers->new(),
958 $c->request->{_context} = $c;
959 $c->response->{_context} = $c;
960 weaken( $c->request->{_context} );
961 weaken( $c->response->{_context} );
964 my $secs = time - $START || 1;
965 my $av = sprintf '%.3f', $COUNT / $secs;
966 $c->log->debug('**********************************');
967 $c->log->debug("* Request $COUNT ($av/s) [$$]");
968 $c->log->debug('**********************************');
969 $c->res->headers->header( 'X-Catalyst' => $Catalyst::VERSION );
972 $c->prepare_request(@arguments);
973 $c->prepare_connection;
974 $c->prepare_query_parameters;
980 $c->prepare_body unless $c->config->{parse_on_demand};
983 my $method = $c->req->method || '';
984 my $path = $c->req->path || '';
985 my $address = $c->req->address || '';
987 $c->log->debug(qq/"$method" request for "$path" from $address/)
993 =item $c->prepare_action
999 sub prepare_action { my $c = shift; $c->dispatcher->prepare_action( $c, @_ ) }
1001 =item $c->prepare_body
1003 Prepare message body.
1010 # Do we run for the first time?
1011 return if defined $c->request->{_body};
1013 # Initialize on-demand data
1014 $c->engine->prepare_body( $c, @_ );
1015 $c->prepare_parameters;
1016 $c->prepare_uploads;
1018 if ( $c->debug && keys %{ $c->req->body_parameters } ) {
1019 my $t = Text::ASCIITable->new;
1020 $t->setCols( 'Key', 'Value' );
1021 $t->setColWidth( 'Key', 37, 1 );
1022 $t->setColWidth( 'Value', 36, 1 );
1023 $t->alignCol( 'Value', 'right' );
1024 for my $key ( sort keys %{ $c->req->body_parameters } ) {
1025 my $param = $c->req->body_parameters->{$key};
1026 my $value = defined($param) ? $param : '';
1028 ref $value eq 'ARRAY' ? ( join ', ', @$value ) : $value );
1030 $c->log->debug( "Body Parameters are:\n" . $t->draw );
1034 =item $c->prepare_body_chunk( $chunk )
1036 Prepare a chunk of data before sending it to HTTP::Body.
1040 sub prepare_body_chunk {
1042 $c->engine->prepare_body_chunk( $c, @_ );
1045 =item $c->prepare_body_parameters
1047 Prepare body parameters.
1051 sub prepare_body_parameters {
1053 $c->engine->prepare_body_parameters( $c, @_ );
1056 =item $c->prepare_connection
1062 sub prepare_connection {
1064 $c->engine->prepare_connection( $c, @_ );
1067 =item $c->prepare_cookies
1073 sub prepare_cookies { my $c = shift; $c->engine->prepare_cookies( $c, @_ ) }
1075 =item $c->prepare_headers
1081 sub prepare_headers { my $c = shift; $c->engine->prepare_headers( $c, @_ ) }
1083 =item $c->prepare_parameters
1089 sub prepare_parameters {
1091 $c->prepare_body_parameters;
1092 $c->engine->prepare_parameters( $c, @_ );
1095 =item $c->prepare_path
1097 Prepare path and base.
1101 sub prepare_path { my $c = shift; $c->engine->prepare_path( $c, @_ ) }
1103 =item $c->prepare_query_parameters
1105 Prepare query parameters.
1109 sub prepare_query_parameters {
1112 $c->engine->prepare_query_parameters( $c, @_ );
1114 if ( $c->debug && keys %{ $c->request->query_parameters } ) {
1115 my $t = Text::ASCIITable->new;
1116 $t->setCols( 'Key', 'Value' );
1117 $t->setColWidth( 'Key', 37, 1 );
1118 $t->setColWidth( 'Value', 36, 1 );
1119 $t->alignCol( 'Value', 'right' );
1120 for my $key ( sort keys %{ $c->req->query_parameters } ) {
1121 my $param = $c->req->query_parameters->{$key};
1122 my $value = defined($param) ? $param : '';
1124 ref $value eq 'ARRAY' ? ( join ', ', @$value ) : $value );
1126 $c->log->debug( "Query Parameters are:\n" . $t->draw );
1130 =item $c->prepare_read
1132 Prepare the input for reading.
1136 sub prepare_read { my $c = shift; $c->engine->prepare_read( $c, @_ ) }
1138 =item $c->prepare_request
1140 Prepare the engine request.
1144 sub prepare_request { my $c = shift; $c->engine->prepare_request( $c, @_ ) }
1146 =item $c->prepare_uploads
1152 sub prepare_uploads {
1155 $c->engine->prepare_uploads( $c, @_ );
1157 if ( $c->debug && keys %{ $c->request->uploads } ) {
1158 my $t = Text::ASCIITable->new;
1159 $t->setCols( 'Key', 'Filename', 'Type', 'Size' );
1160 $t->setColWidth( 'Key', 12, 1 );
1161 $t->setColWidth( 'Filename', 28, 1 );
1162 $t->setColWidth( 'Type', 18, 1 );
1163 $t->setColWidth( 'Size', 9, 1 );
1164 $t->alignCol( 'Size', 'left' );
1165 for my $key ( sort keys %{ $c->request->uploads } ) {
1166 my $upload = $c->request->uploads->{$key};
1167 for my $u ( ref $upload eq 'ARRAY' ? @{$upload} : ($upload) ) {
1168 $t->addRow( $key, $u->filename, $u->type, $u->size );
1171 $c->log->debug( "File Uploads are:\n" . $t->draw );
1175 =item $c->prepare_write
1177 Prepare the output for writing.
1181 sub prepare_write { my $c = shift; $c->engine->prepare_write( $c, @_ ) }
1183 =item $c->read( [$maxlength] )
1185 Read a chunk of data from the request body. This method is designed to be
1186 used in a while loop, reading $maxlength bytes on every call. $maxlength
1187 defaults to the size of the request if not specified.
1189 You have to set MyApp->config->{parse_on_demand} to use this directly.
1193 sub read { my $c = shift; return $c->engine->read( $c, @_ ) }
1201 sub run { my $c = shift; return $c->engine->run( $c, @_ ) }
1203 =item $c->set_action( $action, $code, $namespace, $attrs )
1205 Set an action in a given namespace.
1209 sub set_action { my $c = shift; $c->dispatcher->set_action( $c, @_ ) }
1211 =item $c->setup_actions($component)
1213 Setup actions for a component.
1217 sub setup_actions { my $c = shift; $c->dispatcher->setup_actions( $c, @_ ) }
1219 =item $c->setup_components
1225 sub setup_components {
1228 my $callback = sub {
1229 my ( $component, $context ) = @_;
1231 unless ( $component->isa('Catalyst::Base') ) {
1235 my $suffix = Catalyst::Utils::class2classsuffix($component);
1236 my $config = $class->config->{$suffix} || {};
1240 eval { $instance = $component->new( $context, $config ); };
1242 if ( my $error = $@ ) {
1246 Catalyst::Exception->throw( message =>
1247 qq/Couldn't instantiate component "$component", "$error"/ );
1250 Catalyst::Exception->throw( message =>
1251 qq/Couldn't instantiate component "$component", "new() didn't return a object"/
1253 unless ref $instance;
1258 Module::Pluggable::Fast->import(
1259 name => '_catalyst_components',
1261 "$class\::Controller", "$class\::C",
1262 "$class\::Model", "$class\::M",
1263 "$class\::View", "$class\::V"
1265 callback => $callback
1269 if ( my $error = $@ ) {
1273 Catalyst::Exception->throw(
1274 message => qq/Couldn't load components "$error"/ );
1277 for my $component ( $class->_catalyst_components($class) ) {
1278 $class->components->{ ref $component || $component } = $component;
1282 =item $c->setup_dispatcher
1286 sub setup_dispatcher {
1287 my ( $class, $dispatcher ) = @_;
1290 $dispatcher = 'Catalyst::Dispatcher::' . $dispatcher;
1293 if ( $ENV{CATALYST_DISPATCHER} ) {
1294 $dispatcher = 'Catalyst::Dispatcher::' . $ENV{CATALYST_DISPATCHER};
1297 if ( $ENV{ uc($class) . '_DISPATCHER' } ) {
1299 'Catalyst::Dispatcher::' . $ENV{ uc($class) . '_DISPATCHER' };
1302 unless ($dispatcher) {
1303 $dispatcher = 'Catalyst::Dispatcher';
1306 $dispatcher->require;
1309 Catalyst::Exception->throw(
1310 message => qq/Couldn't load dispatcher "$dispatcher", "$@"/ );
1313 # dispatcher instance
1314 $class->dispatcher( $dispatcher->new );
1317 =item $c->setup_engine
1322 my ( $class, $engine ) = @_;
1325 $engine = 'Catalyst::Engine::' . $engine;
1328 if ( $ENV{CATALYST_ENGINE} ) {
1329 $engine = 'Catalyst::Engine::' . $ENV{CATALYST_ENGINE};
1332 if ( $ENV{ uc($class) . '_ENGINE' } ) {
1333 $engine = 'Catalyst::Engine::' . $ENV{ uc($class) . '_ENGINE' };
1336 if ( !$engine && $ENV{MOD_PERL} ) {
1338 # create the apache method
1341 *{"$class\::apache"} = sub { shift->engine->apache };
1344 my ( $software, $version ) =
1345 $ENV{MOD_PERL} =~ /^(\S+)\/(\d+(?:[\.\_]\d+)+)/;
1348 $version =~ s/(\.[^.]+)\./$1/g;
1350 if ( $software eq 'mod_perl' ) {
1352 if ( $version >= 1.99922 ) {
1353 $engine = 'Catalyst::Engine::Apache2::MP20';
1356 elsif ( $version >= 1.9901 ) {
1357 $engine = 'Catalyst::Engine::Apache2::MP19';
1360 elsif ( $version >= 1.24 ) {
1361 $engine = 'Catalyst::Engine::Apache::MP13';
1365 Catalyst::Exception->throw( message =>
1366 qq/Unsupported mod_perl version: $ENV{MOD_PERL}/ );
1369 # install the correct mod_perl handler
1370 if ( $version >= 1.9901 ) {
1371 *handler = sub : method {
1372 shift->handle_request(@_);
1376 *handler = sub ($$) { shift->handle_request(@_) };
1381 elsif ( $software eq 'Zeus-Perl' ) {
1382 $engine = 'Catalyst::Engine::Zeus';
1386 Catalyst::Exception->throw(
1387 message => qq/Unsupported mod_perl: $ENV{MOD_PERL}/ );
1392 $engine = 'Catalyst::Engine::CGI';
1398 Catalyst::Exception->throw( message =>
1399 qq/Couldn't load engine "$engine" (maybe you forgot to install it?), "$@"/
1404 $class->engine( $engine->new );
1407 =item $c->setup_home
1412 my ( $class, $home ) = @_;
1414 if ( $ENV{CATALYST_HOME} ) {
1415 $home = $ENV{CATALYST_HOME};
1418 if ( $ENV{ uc($class) . '_HOME' } ) {
1419 $home = $ENV{ uc($class) . '_HOME' };
1423 $home = Catalyst::Utils::home($class);
1427 $class->config->{home} ||= $home;
1428 $class->config->{root} ||= dir($home)->subdir('root');
1437 my ( $class, $debug ) = @_;
1439 unless ( $class->log ) {
1440 $class->log( Catalyst::Log->new );
1443 if ( $ENV{CATALYST_DEBUG} || $ENV{ uc($class) . '_DEBUG' } || $debug ) {
1445 *{"$class\::debug"} = sub { 1 };
1446 $class->log->debug('Debug messages enabled');
1450 =item $c->setup_plugins
1455 my ( $class, $plugins ) = @_;
1458 for my $plugin ( reverse @$plugins ) {
1460 $plugin = "Catalyst::Plugin::$plugin";
1465 Catalyst::Exception->throw(
1466 message => qq/Couldn't load plugin "$plugin", "$@"/ );
1471 unshift @{"$class\::ISA"}, $plugin;
1476 =item $c->write( $data )
1478 Writes $data to the output stream. When using this method directly, you will
1479 need to manually set the Content-Length header to the length of your output
1487 # Finalize headers if someone manually writes output
1488 $c->finalize_headers;
1490 return $c->engine->write( $c, @_ );
1495 =head1 CASE SENSITIVITY
1497 By default Catalyst is not case sensitive, so C<MyApp::C::FOO::Bar> becomes
1500 But you can activate case sensitivity with a config parameter.
1502 MyApp->config->{case_sensitive} = 1;
1504 So C<MyApp::C::Foo::Bar> becomes C</Foo/Bar>.
1506 =head1 ON-DEMAND PARSER
1508 The request body is usually parsed at the beginning of a request,
1509 but if you want to handle input yourself or speed things up a bit
1510 you can enable on-demand parsing with a config parameter.
1512 MyApp->config->{parse_on_demand} = 1;
1514 =head1 PROXY SUPPORT
1516 Many production servers operate using the common double-server approach, with
1517 a lightweight frontend web server passing requests to a larger backend
1518 server. An application running on the backend server must deal with two
1519 problems: the remote user always appears to be '127.0.0.1' and the server's
1520 hostname will appear to be 'localhost' regardless of the virtual host the
1521 user connected through.
1523 Catalyst will automatically detect this situation when you are running both
1524 the frontend and backend servers on the same machine. The following changes
1525 are made to the request.
1527 $c->req->address is set to the user's real IP address, as read from the
1528 HTTP_X_FORWARDED_FOR header.
1530 The host value for $c->req->base and $c->req->uri is set to the real host,
1531 as read from the HTTP_X_FORWARDED_HOST header.
1533 Obviously, your web server must support these 2 headers for this to work.
1535 In a more complex server farm environment where you may have your frontend
1536 proxy server(s) on different machines, you will need to set a configuration
1537 option to tell Catalyst to read the proxied data from the headers.
1539 MyApp->config->{using_frontend_proxy} = 1;
1541 If you do not wish to use the proxy support at all, you may set:
1543 MyApp->config->{ignore_frontend_proxy} = 1;
1545 =head1 THREAD SAFETY
1547 Catalyst has been tested under Apache 2's threading mpm_worker, mpm_winnt,
1548 and the standalone forking HTTP server on Windows. We believe the Catalyst
1549 core to be thread-safe.
1551 If you plan to operate in a threaded environment, remember that all other
1552 modules you are using must also be thread-safe. Some modules, most notably
1553 DBD::SQLite, are not thread-safe.
1559 Join #catalyst on irc.perl.org.
1563 http://lists.rawmode.org/mailman/listinfo/catalyst
1564 http://lists.rawmode.org/mailman/listinfo/catalyst-dev
1568 http://catalyst.perl.org
1574 =item L<Catalyst::Manual> - The Catalyst Manual
1576 =item L<Catalyst::Engine> - Core Engine
1578 =item L<Catalyst::Log> - The Log Class.
1580 =item L<Catalyst::Request> - The Request Object
1582 =item L<Catalyst::Response> - The Response Object
1584 =item L<Catalyst::Test> - The test suite.
1642 Sebastian Riedel, C<sri@oook.de>
1646 This library is free software . You can redistribute it and/or modify it under
1647 the same terms as perl itself.