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: 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 wonderful world of Catalyst.
601 This MVC framework will make web development
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 really depends 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, these links might be of help to you.</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 actual application. Use the
632 helper scripts for what they are worth, they can save you
633 a lot of work getting everything set up. Also, be sure to
634 check out the vast array of plugins for Catalyst on CPAN.
635 They can handle everything from A to Z
636 , and a whole lot in between.</p>
638 <p>Catalyst has a very active community. The main places to get
639 in touch are these.</p>
642 <a href="http://dev.catalyst.perl.org">Wiki</a>
645 <a href="http://lists.rawmode.org/mailman/listinfo/catalyst">Mailing-List</a>
648 <a href="irc://irc.perl.org/catalyst">IRC channel</a>
651 <h2>In conclusion</h2>
652 <p>The Catalyst team hope you will enjoy using Catalyst as much
653 as we enjoyed making it, and rest assured that any and all
654 feedback is welcomed</p>
655 <p class="signature">-- #1. the first rule of the Cabal is, you do not
656 talk about the Cabal.<br/>
657 #2. the second rule of the Cabal is, you DO NOT
658 talkk about the Cabal.</p>
668 =head1 INTERNAL METHODS
672 =item $c->benchmark($coderef)
674 Takes a coderef with arguments and returns elapsed time as float.
676 my ( $elapsed, $status ) = $c->benchmark( sub { return 1 } );
677 $c->log->info( sprintf "Processing took %f seconds", $elapsed );
684 my $time = [gettimeofday];
685 my @return = &$code(@_);
686 my $elapsed = tv_interval $time;
687 return wantarray ? ( $elapsed, @return ) : $elapsed;
692 Contains the components.
696 Returns a hashref containing coderefs and execution counts.
697 (Needed for deep recursion detection)
701 Returns the actual forward depth.
705 Dispatch request to actions.
709 sub dispatch { my $c = shift; $c->dispatcher->dispatch( $c, @_ ) }
711 =item $c->execute($class, $coderef)
713 Execute a coderef in given class and catch exceptions.
714 Errors are available via $c->error.
719 my ( $c, $class, $code ) = @_;
720 $class = $c->components->{$class} || $class;
722 my $callsub = ( caller(1) )[3];
727 $action = "/$action" unless $action =~ /\-\>/;
728 $c->counter->{"$code"}++;
730 if ( $c->counter->{"$code"} > $RECURSION ) {
731 my $error = qq/Deep recursion detected in "$action"/;
732 $c->log->error($error);
738 $action = "-> $action" if $callsub =~ /forward$/;
744 my ( $elapsed, @state ) =
745 $c->benchmark( $code, $class, $c, @{ $c->req->args } );
746 push @{ $c->{stats} }, [ $action, sprintf( '%fs', $elapsed ) ];
749 else { $c->state( &$code( $class, $c, @{ $c->req->args } ) || 0 ) }
753 if ( my $error = $@ ) {
755 if ( $error eq $DETACH ) { die $DETACH if $c->{depth} > 1 }
757 unless ( ref $error ) {
759 $error = qq/Caught exception "$error"/;
762 $c->log->error($error);
779 $c->finalize_uploads;
782 if ( $#{ $c->error } >= 0 ) {
786 $c->finalize_headers;
789 if ( $c->request->method eq 'HEAD' ) {
790 $c->response->body('');
795 return $c->response->status;
798 =item $c->finalize_body
804 sub finalize_body { my $c = shift; $c->engine->finalize_body( $c, @_ ) }
806 =item $c->finalize_cookies
812 sub finalize_cookies { my $c = shift; $c->engine->finalize_cookies( $c, @_ ) }
814 =item $c->finalize_error
820 sub finalize_error { my $c = shift; $c->engine->finalize_error( $c, @_ ) }
822 =item $c->finalize_headers
828 sub finalize_headers {
831 # Check if we already finalized headers
832 return if $c->response->{_finalized_headers};
835 if ( my $location = $c->response->redirect ) {
836 $c->log->debug(qq/Redirecting to "$location"/) if $c->debug;
837 $c->response->header( Location => $location );
841 if ( $c->response->body && !$c->response->content_length ) {
842 $c->response->content_length( bytes::length( $c->response->body ) );
846 if ( $c->response->status =~ /^(1\d\d|[23]04)$/ ) {
847 $c->response->headers->remove_header("Content-Length");
848 $c->response->body('');
851 $c->finalize_cookies;
853 $c->engine->finalize_headers( $c, @_ );
856 $c->response->{_finalized_headers} = 1;
859 =item $c->finalize_output
861 An alias for finalize_body.
863 =item $c->finalize_read
865 Finalize the input after reading is complete.
869 sub finalize_read { my $c = shift; $c->engine->finalize_read( $c, @_ ) }
871 =item $c->finalize_uploads
873 Finalize uploads. Cleans up any temporary files.
877 sub finalize_uploads { my $c = shift; $c->engine->finalize_uploads( $c, @_ ) }
879 =item $c->get_action( $action, $namespace, $inherit )
881 Get an action in a given namespace.
885 sub get_action { my $c = shift; $c->dispatcher->get_action( $c, @_ ) }
887 =item handle_request( $class, @arguments )
894 my ( $class, @arguments ) = @_;
896 # Always expect worst case!
902 my $c = $class->prepare(@arguments);
903 $c->{stats} = \@stats;
908 if ( $class->debug ) {
910 ( $elapsed, $status ) = $class->benchmark($handler);
911 $elapsed = sprintf '%f', $elapsed;
912 my $av = sprintf '%.3f',
913 ( $elapsed == 0 ? '??' : ( 1 / $elapsed ) );
914 my $t = Text::ASCIITable->new;
915 $t->setCols( 'Action', 'Time' );
916 $t->setColWidth( 'Action', 64, 1 );
917 $t->setColWidth( 'Time', 9, 1 );
919 for my $stat (@stats) { $t->addRow( $stat->[0], $stat->[1] ) }
921 "Request took ${elapsed}s ($av/s)\n" . $t->draw );
923 else { $status = &$handler }
927 if ( my $error = $@ ) {
929 $class->log->error(qq/Caught exception in engine "$error"/);
933 $class->log->_flush() if $class->log->can('_flush');
937 =item $c->prepare(@arguments)
939 Turns the engine-specific request( Apache, CGI ... )
940 into a Catalyst context .
945 my ( $class, @arguments ) = @_;
950 request => Catalyst::Request->new(
953 body_parameters => {},
955 headers => HTTP::Headers->new,
957 query_parameters => {},
963 response => Catalyst::Response->new(
967 headers => HTTP::Headers->new(),
976 $c->request->{_context} = $c;
977 $c->response->{_context} = $c;
978 weaken( $c->request->{_context} );
979 weaken( $c->response->{_context} );
982 my $secs = time - $START || 1;
983 my $av = sprintf '%.3f', $COUNT / $secs;
984 $c->log->debug('**********************************');
985 $c->log->debug("* Request $COUNT ($av/s) [$$]");
986 $c->log->debug('**********************************');
987 $c->res->headers->header( 'X-Catalyst' => $Catalyst::VERSION );
990 $c->prepare_request(@arguments);
991 $c->prepare_connection;
992 $c->prepare_query_parameters;
998 $c->prepare_body unless $c->config->{parse_on_demand};
1001 my $method = $c->req->method || '';
1002 my $path = $c->req->path || '';
1003 my $address = $c->req->address || '';
1005 $c->log->debug(qq/"$method" request for "$path" from $address/)
1011 =item $c->prepare_action
1017 sub prepare_action { my $c = shift; $c->dispatcher->prepare_action( $c, @_ ) }
1019 =item $c->prepare_body
1021 Prepare message body.
1028 # Do we run for the first time?
1029 return if defined $c->request->{_body};
1031 # Initialize on-demand data
1032 $c->engine->prepare_body( $c, @_ );
1033 $c->prepare_parameters;
1034 $c->prepare_uploads;
1036 if ( $c->debug && keys %{ $c->req->body_parameters } ) {
1037 my $t = Text::ASCIITable->new;
1038 $t->setCols( 'Key', 'Value' );
1039 $t->setColWidth( 'Key', 37, 1 );
1040 $t->setColWidth( 'Value', 36, 1 );
1041 $t->alignCol( 'Value', 'right' );
1042 for my $key ( sort keys %{ $c->req->body_parameters } ) {
1043 my $param = $c->req->body_parameters->{$key};
1044 my $value = defined($param) ? $param : '';
1046 ref $value eq 'ARRAY' ? ( join ', ', @$value ) : $value );
1048 $c->log->debug( "Body Parameters are:\n" . $t->draw );
1052 =item $c->prepare_body_chunk( $chunk )
1054 Prepare a chunk of data before sending it to HTTP::Body.
1058 sub prepare_body_chunk {
1060 $c->engine->prepare_body_chunk( $c, @_ );
1063 =item $c->prepare_body_parameters
1065 Prepare body parameters.
1069 sub prepare_body_parameters {
1071 $c->engine->prepare_body_parameters( $c, @_ );
1074 =item $c->prepare_connection
1080 sub prepare_connection {
1082 $c->engine->prepare_connection( $c, @_ );
1085 =item $c->prepare_cookies
1091 sub prepare_cookies { my $c = shift; $c->engine->prepare_cookies( $c, @_ ) }
1093 =item $c->prepare_headers
1099 sub prepare_headers { my $c = shift; $c->engine->prepare_headers( $c, @_ ) }
1101 =item $c->prepare_parameters
1107 sub prepare_parameters {
1109 $c->prepare_body_parameters;
1110 $c->engine->prepare_parameters( $c, @_ );
1113 =item $c->prepare_path
1115 Prepare path and base.
1119 sub prepare_path { my $c = shift; $c->engine->prepare_path( $c, @_ ) }
1121 =item $c->prepare_query_parameters
1123 Prepare query parameters.
1127 sub prepare_query_parameters {
1130 $c->engine->prepare_query_parameters( $c, @_ );
1132 if ( $c->debug && keys %{ $c->request->query_parameters } ) {
1133 my $t = Text::ASCIITable->new;
1134 $t->setCols( 'Key', 'Value' );
1135 $t->setColWidth( 'Key', 37, 1 );
1136 $t->setColWidth( 'Value', 36, 1 );
1137 $t->alignCol( 'Value', 'right' );
1138 for my $key ( sort keys %{ $c->req->query_parameters } ) {
1139 my $param = $c->req->query_parameters->{$key};
1140 my $value = defined($param) ? $param : '';
1142 ref $value eq 'ARRAY' ? ( join ', ', @$value ) : $value );
1144 $c->log->debug( "Query Parameters are:\n" . $t->draw );
1148 =item $c->prepare_read
1150 Prepare the input for reading.
1154 sub prepare_read { my $c = shift; $c->engine->prepare_read( $c, @_ ) }
1156 =item $c->prepare_request
1158 Prepare the engine request.
1162 sub prepare_request { my $c = shift; $c->engine->prepare_request( $c, @_ ) }
1164 =item $c->prepare_uploads
1170 sub prepare_uploads {
1173 $c->engine->prepare_uploads( $c, @_ );
1175 if ( $c->debug && keys %{ $c->request->uploads } ) {
1176 my $t = Text::ASCIITable->new;
1177 $t->setCols( 'Key', 'Filename', 'Type', 'Size' );
1178 $t->setColWidth( 'Key', 12, 1 );
1179 $t->setColWidth( 'Filename', 28, 1 );
1180 $t->setColWidth( 'Type', 18, 1 );
1181 $t->setColWidth( 'Size', 9, 1 );
1182 $t->alignCol( 'Size', 'left' );
1183 for my $key ( sort keys %{ $c->request->uploads } ) {
1184 my $upload = $c->request->uploads->{$key};
1185 for my $u ( ref $upload eq 'ARRAY' ? @{$upload} : ($upload) ) {
1186 $t->addRow( $key, $u->filename, $u->type, $u->size );
1189 $c->log->debug( "File Uploads are:\n" . $t->draw );
1193 =item $c->prepare_write
1195 Prepare the output for writing.
1199 sub prepare_write { my $c = shift; $c->engine->prepare_write( $c, @_ ) }
1201 =item $c->read( [$maxlength] )
1203 Read a chunk of data from the request body. This method is designed to be
1204 used in a while loop, reading $maxlength bytes on every call. $maxlength
1205 defaults to the size of the request if not specified.
1207 You have to set MyApp->config->{parse_on_demand} to use this directly.
1211 sub read { my $c = shift; return $c->engine->read( $c, @_ ) }
1219 sub run { my $c = shift; return $c->engine->run( $c, @_ ) }
1221 =item $c->set_action( $action, $code, $namespace, $attrs )
1223 Set an action in a given namespace.
1227 sub set_action { my $c = shift; $c->dispatcher->set_action( $c, @_ ) }
1229 =item $c->setup_actions($component)
1231 Setup actions for a component.
1235 sub setup_actions { my $c = shift; $c->dispatcher->setup_actions( $c, @_ ) }
1237 =item $c->setup_components
1243 sub setup_components {
1246 my $callback = sub {
1247 my ( $component, $context ) = @_;
1249 unless ( $component->isa('Catalyst::Base') ) {
1253 my $suffix = Catalyst::Utils::class2classsuffix($component);
1254 my $config = $class->config->{$suffix} || {};
1258 eval { $instance = $component->new( $context, $config ); };
1260 if ( my $error = $@ ) {
1264 Catalyst::Exception->throw( message =>
1265 qq/Couldn't instantiate component "$component", "$error"/ );
1268 Catalyst::Exception->throw( message =>
1269 qq/Couldn't instantiate component "$component", "new() didn't return a object"/
1271 unless ref $instance;
1276 Module::Pluggable::Fast->import(
1277 name => '_catalyst_components',
1279 "$class\::Controller", "$class\::C",
1280 "$class\::Model", "$class\::M",
1281 "$class\::View", "$class\::V"
1283 callback => $callback
1287 if ( my $error = $@ ) {
1291 Catalyst::Exception->throw(
1292 message => qq/Couldn't load components "$error"/ );
1295 for my $component ( $class->_catalyst_components($class) ) {
1296 $class->components->{ ref $component || $component } = $component;
1300 =item $c->setup_dispatcher
1304 sub setup_dispatcher {
1305 my ( $class, $dispatcher ) = @_;
1308 $dispatcher = 'Catalyst::Dispatcher::' . $dispatcher;
1311 if ( $ENV{CATALYST_DISPATCHER} ) {
1312 $dispatcher = 'Catalyst::Dispatcher::' . $ENV{CATALYST_DISPATCHER};
1315 if ( $ENV{ uc($class) . '_DISPATCHER' } ) {
1317 'Catalyst::Dispatcher::' . $ENV{ uc($class) . '_DISPATCHER' };
1320 unless ($dispatcher) {
1321 $dispatcher = 'Catalyst::Dispatcher';
1324 $dispatcher->require;
1327 Catalyst::Exception->throw(
1328 message => qq/Couldn't load dispatcher "$dispatcher", "$@"/ );
1331 # dispatcher instance
1332 $class->dispatcher( $dispatcher->new );
1335 =item $c->setup_engine
1340 my ( $class, $engine ) = @_;
1343 $engine = 'Catalyst::Engine::' . $engine;
1346 if ( $ENV{CATALYST_ENGINE} ) {
1347 $engine = 'Catalyst::Engine::' . $ENV{CATALYST_ENGINE};
1350 if ( $ENV{ uc($class) . '_ENGINE' } ) {
1351 $engine = 'Catalyst::Engine::' . $ENV{ uc($class) . '_ENGINE' };
1354 if ( !$engine && $ENV{MOD_PERL} ) {
1356 # create the apache method
1359 *{"$class\::apache"} = sub { shift->engine->apache };
1362 my ( $software, $version ) =
1363 $ENV{MOD_PERL} =~ /^(\S+)\/(\d+(?:[\.\_]\d+)+)/;
1366 $version =~ s/(\.[^.]+)\./$1/g;
1368 if ( $software eq 'mod_perl' ) {
1370 if ( $version >= 1.99922 ) {
1371 $engine = 'Catalyst::Engine::Apache2::MP20';
1374 elsif ( $version >= 1.9901 ) {
1375 $engine = 'Catalyst::Engine::Apache2::MP19';
1378 elsif ( $version >= 1.24 ) {
1379 $engine = 'Catalyst::Engine::Apache::MP13';
1383 Catalyst::Exception->throw( message =>
1384 qq/Unsupported mod_perl version: $ENV{MOD_PERL}/ );
1387 # install the correct mod_perl handler
1388 if ( $version >= 1.9901 ) {
1389 *handler = sub : method {
1390 shift->handle_request(@_);
1394 *handler = sub ($$) { shift->handle_request(@_) };
1399 elsif ( $software eq 'Zeus-Perl' ) {
1400 $engine = 'Catalyst::Engine::Zeus';
1404 Catalyst::Exception->throw(
1405 message => qq/Unsupported mod_perl: $ENV{MOD_PERL}/ );
1410 $engine = 'Catalyst::Engine::CGI';
1416 Catalyst::Exception->throw( message =>
1417 qq/Couldn't load engine "$engine" (maybe you forgot to install it?), "$@"/
1422 $class->engine( $engine->new );
1425 =item $c->setup_home
1430 my ( $class, $home ) = @_;
1432 if ( $ENV{CATALYST_HOME} ) {
1433 $home = $ENV{CATALYST_HOME};
1436 if ( $ENV{ uc($class) . '_HOME' } ) {
1437 $home = $ENV{ uc($class) . '_HOME' };
1441 $home = Catalyst::Utils::home($class);
1445 $class->config->{home} ||= $home;
1446 $class->config->{root} ||= dir($home)->subdir('root');
1455 my ( $class, $debug ) = @_;
1457 unless ( $class->log ) {
1458 $class->log( Catalyst::Log->new );
1461 if ( $ENV{CATALYST_DEBUG} || $ENV{ uc($class) . '_DEBUG' } || $debug ) {
1463 *{"$class\::debug"} = sub { 1 };
1464 $class->log->debug('Debug messages enabled');
1468 =item $c->setup_plugins
1473 my ( $class, $plugins ) = @_;
1476 for my $plugin ( reverse @$plugins ) {
1478 $plugin = "Catalyst::Plugin::$plugin";
1483 Catalyst::Exception->throw(
1484 message => qq/Couldn't load plugin "$plugin", "$@"/ );
1489 unshift @{"$class\::ISA"}, $plugin;
1494 =item $c->write( $data )
1496 Writes $data to the output stream. When using this method directly, you will
1497 need to manually set the Content-Length header to the length of your output
1505 # Finalize headers if someone manually writes output
1506 $c->finalize_headers;
1508 return $c->engine->write( $c, @_ );
1513 =head1 CASE SENSITIVITY
1515 By default Catalyst is not case sensitive, so C<MyApp::C::FOO::Bar> becomes
1518 But you can activate case sensitivity with a config parameter.
1520 MyApp->config->{case_sensitive} = 1;
1522 So C<MyApp::C::Foo::Bar> becomes C</Foo/Bar>.
1524 =head1 ON-DEMAND PARSER
1526 The request body is usually parsed at the beginning of a request,
1527 but if you want to handle input yourself or speed things up a bit
1528 you can enable on-demand parsing with a config parameter.
1530 MyApp->config->{parse_on_demand} = 1;
1532 =head1 PROXY SUPPORT
1534 Many production servers operate using the common double-server approach, with
1535 a lightweight frontend web server passing requests to a larger backend
1536 server. An application running on the backend server must deal with two
1537 problems: the remote user always appears to be '127.0.0.1' and the server's
1538 hostname will appear to be 'localhost' regardless of the virtual host the
1539 user connected through.
1541 Catalyst will automatically detect this situation when you are running both
1542 the frontend and backend servers on the same machine. The following changes
1543 are made to the request.
1545 $c->req->address is set to the user's real IP address, as read from the
1546 HTTP_X_FORWARDED_FOR header.
1548 The host value for $c->req->base and $c->req->uri is set to the real host,
1549 as read from the HTTP_X_FORWARDED_HOST header.
1551 Obviously, your web server must support these 2 headers for this to work.
1553 In a more complex server farm environment where you may have your frontend
1554 proxy server(s) on different machines, you will need to set a configuration
1555 option to tell Catalyst to read the proxied data from the headers.
1557 MyApp->config->{using_frontend_proxy} = 1;
1559 If you do not wish to use the proxy support at all, you may set:
1561 MyApp->config->{ignore_frontend_proxy} = 1;
1563 =head1 THREAD SAFETY
1565 Catalyst has been tested under Apache 2's threading mpm_worker, mpm_winnt,
1566 and the standalone forking HTTP server on Windows. We believe the Catalyst
1567 core to be thread-safe.
1569 If you plan to operate in a threaded environment, remember that all other
1570 modules you are using must also be thread-safe. Some modules, most notably
1571 DBD::SQLite, are not thread-safe.
1577 Join #catalyst on irc.perl.org.
1581 http://lists.rawmode.org/mailman/listinfo/catalyst
1582 http://lists.rawmode.org/mailman/listinfo/catalyst-dev
1586 http://catalyst.perl.org
1592 =item L<Catalyst::Manual> - The Catalyst Manual
1594 =item L<Catalyst::Engine> - Core Engine
1596 =item L<Catalyst::Log> - The Log Class.
1598 =item L<Catalyst::Request> - The Request Object
1600 =item L<Catalyst::Response> - The Response Object
1602 =item L<Catalyst::Test> - The test suite.
1660 Sebastian Riedel, C<sri@oook.de>
1664 This library is free software . You can redistribute it and/or modify it under
1665 the same terms as perl itself.