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 print $c->stash->{foo};
505 Keys may be set in the stash by assigning to the hash reference, or by passing
506 either a single hash reference or a list of key/value pairs as arguments.
510 $c->stash->{foo} ||= 'yada';
511 $c->stash( { moose => 'majestic', qux => 0 } );
512 $c->stash( bar => 1, gorch => 2 );
519 my $stash = @_ > 1 ? {@_} : $_[0];
520 while ( my ( $key, $val ) = each %$stash ) {
521 $c->{stash}->{$key} = $val;
527 =head1 $c->welcome_message
529 Returns the Catalyst welcome HTML page.
533 sub welcome_message {
535 my $name = $c->config->{name};
536 my $logo = $c->uri_for('/static/images/catalyst_logo.png');
540 <title>$name on Catalyst $VERSION</title>
541 <style type="text/css">
546 background-color: #eee;
554 background-color: #ccc;
555 border: 1px solid #aaa;
556 -moz-border-radius: 10px;
561 font-family: verdana, tahoma, sans-serif;
564 font-family: verdana, tahoma, sans-serif;
567 text-decoration: none;
569 border-bottom: 1px dotted #bbb;
571 :link:hover, :visited:hover {
584 background-color: #fff;
585 border: 1px solid #aaa;
586 -moz-border-radius: 10px;
611 <h1><b id="appname">$name</b> on <a href="http://catalyst.perl.org">Catalyst</a>
618 <p>Welcome to the wonderful world of Catalyst.
619 This MVC framework will make web development
620 something you had never expected it to be:
621 Fun, rewarding and quick.</p>
622 <h2>What to do now?</h2>
623 <p>That really depends on what <b>you</b> want to do.
624 We do, however, provide you with a few starting points.</p>
625 <p>If you want to jump right into web development with Catalyst
626 you might want to check out the documentation.</p>
627 <pre><code>perldoc <a href="http://cpansearch.perl.org/dist/Catalyst/lib/Catalyst/Manual.pod">Catalyst::Manual</a>
628 perldoc <a href="http://cpansearch.perl.org/dist/Catalyst/lib/Catalyst/Manual/Intro.pod">Catalyst::Manual::Intro</a></code></pre>
629 <p>If you would like some background information on the
630 MVC-pattern, these links might be of help to you.</p>
633 <a href="http://dev.catalyst.perl.org/wiki/Models">
634 Introduction to Models
638 <a href="http://dev.catalyst.perl.org/wiki/Views">
639 Introduction to Views
643 <a href="http://dev.catalyst.perl.org/wiki/Controllers">
644 Introduction to Controllers
648 <h2>What to do next?</h2>
649 <p>Next you need to create an actual application. Use the
650 helper scripts for what they are worth, they can save you
651 a lot of work getting everything set up. Also, be sure to
652 check out the vast array of plugins for Catalyst on CPAN.
653 They can handle everything from A to Z
654 , and a whole lot in between.</p>
656 <p>Catalyst has a very active community. The main places to get
657 in touch are these.</p>
660 <a href="http://dev.catalyst.perl.org">Wiki</a>
663 <a href="http://lists.rawmode.org/mailman/listinfo/catalyst">Mailing-List</a>
666 <a href="irc://irc.perl.org/catalyst">IRC channel #catalyst on irc.perl.org</a>
669 <h2>In conclusion</h2>
670 <p>The Catalyst team hope you will enjoy using Catalyst as much
671 as we enjoyed making it, and rest assured that any and all
672 feedback is welcomed.</p>
682 =head1 INTERNAL METHODS
686 =item $c->benchmark($coderef)
688 Takes a coderef with arguments and returns elapsed time as float.
690 my ( $elapsed, $status ) = $c->benchmark( sub { return 1 } );
691 $c->log->info( sprintf "Processing took %f seconds", $elapsed );
698 my $time = [gettimeofday];
699 my @return = &$code(@_);
700 my $elapsed = tv_interval $time;
701 return wantarray ? ( $elapsed, @return ) : $elapsed;
706 Contains the components.
710 Returns a hashref containing coderefs and execution counts.
711 (Needed for deep recursion detection)
715 Returns the actual forward depth.
719 Dispatch request to actions.
723 sub dispatch { my $c = shift; $c->dispatcher->dispatch( $c, @_ ) }
725 =item $c->execute($class, $coderef)
727 Execute a coderef in given class and catch exceptions.
728 Errors are available via $c->error.
733 my ( $c, $class, $code ) = @_;
734 $class = $c->components->{$class} || $class;
736 my $callsub = ( caller(1) )[3];
741 $action = "/$action" unless $action =~ /\-\>/;
742 $c->counter->{"$code"}++;
744 if ( $c->counter->{"$code"} > $RECURSION ) {
745 my $error = qq/Deep recursion detected in "$action"/;
746 $c->log->error($error);
752 $action = "-> $action" if $callsub =~ /forward$/;
758 my ( $elapsed, @state ) =
759 $c->benchmark( $code, $class, $c, @{ $c->req->args } );
760 push @{ $c->{stats} }, [ $action, sprintf( '%fs', $elapsed ) ];
763 else { $c->state( &$code( $class, $c, @{ $c->req->args } ) || 0 ) }
767 if ( my $error = $@ ) {
769 if ( $error eq $DETACH ) { die $DETACH if $c->{depth} > 1 }
771 unless ( ref $error ) {
773 $error = qq/Caught exception "$error"/;
776 $c->log->error($error);
793 $c->finalize_uploads;
796 if ( $#{ $c->error } >= 0 ) {
800 $c->finalize_headers;
803 if ( $c->request->method eq 'HEAD' ) {
804 $c->response->body('');
809 return $c->response->status;
812 =item $c->finalize_body
818 sub finalize_body { my $c = shift; $c->engine->finalize_body( $c, @_ ) }
820 =item $c->finalize_cookies
826 sub finalize_cookies { my $c = shift; $c->engine->finalize_cookies( $c, @_ ) }
828 =item $c->finalize_error
834 sub finalize_error { my $c = shift; $c->engine->finalize_error( $c, @_ ) }
836 =item $c->finalize_headers
842 sub finalize_headers {
845 # Check if we already finalized headers
846 return if $c->response->{_finalized_headers};
849 if ( my $location = $c->response->redirect ) {
850 $c->log->debug(qq/Redirecting to "$location"/) if $c->debug;
851 $c->response->header( Location => $location );
855 if ( $c->response->body && !$c->response->content_length ) {
856 $c->response->content_length( bytes::length( $c->response->body ) );
860 if ( $c->response->status =~ /^(1\d\d|[23]04)$/ ) {
861 $c->response->headers->remove_header("Content-Length");
862 $c->response->body('');
865 $c->finalize_cookies;
867 $c->engine->finalize_headers( $c, @_ );
870 $c->response->{_finalized_headers} = 1;
873 =item $c->finalize_output
875 An alias for finalize_body.
877 =item $c->finalize_read
879 Finalize the input after reading is complete.
883 sub finalize_read { my $c = shift; $c->engine->finalize_read( $c, @_ ) }
885 =item $c->finalize_uploads
887 Finalize uploads. Cleans up any temporary files.
891 sub finalize_uploads { my $c = shift; $c->engine->finalize_uploads( $c, @_ ) }
893 =item $c->get_action( $action, $namespace, $inherit )
895 Get an action in a given namespace.
899 sub get_action { my $c = shift; $c->dispatcher->get_action( $c, @_ ) }
901 =item handle_request( $class, @arguments )
908 my ( $class, @arguments ) = @_;
910 # Always expect worst case!
916 my $c = $class->prepare(@arguments);
917 $c->{stats} = \@stats;
922 if ( $class->debug ) {
924 ( $elapsed, $status ) = $class->benchmark($handler);
925 $elapsed = sprintf '%f', $elapsed;
926 my $av = sprintf '%.3f',
927 ( $elapsed == 0 ? '??' : ( 1 / $elapsed ) );
928 my $t = Text::ASCIITable->new;
929 $t->setCols( 'Action', 'Time' );
930 $t->setColWidth( 'Action', 64, 1 );
931 $t->setColWidth( 'Time', 9, 1 );
933 for my $stat (@stats) { $t->addRow( $stat->[0], $stat->[1] ) }
935 "Request took ${elapsed}s ($av/s)\n" . $t->draw );
937 else { $status = &$handler }
941 if ( my $error = $@ ) {
943 $class->log->error(qq/Caught exception in engine "$error"/);
947 $class->log->_flush() if $class->log->can('_flush');
951 =item $c->prepare(@arguments)
953 Turns the engine-specific request( Apache, CGI ... )
954 into a Catalyst context .
959 my ( $class, @arguments ) = @_;
964 request => Catalyst::Request->new(
967 body_parameters => {},
969 headers => HTTP::Headers->new,
971 query_parameters => {},
977 response => Catalyst::Response->new(
981 headers => HTTP::Headers->new(),
990 $c->request->{_context} = $c;
991 $c->response->{_context} = $c;
992 weaken( $c->request->{_context} );
993 weaken( $c->response->{_context} );
996 my $secs = time - $START || 1;
997 my $av = sprintf '%.3f', $COUNT / $secs;
998 $c->log->debug('**********************************');
999 $c->log->debug("* Request $COUNT ($av/s) [$$]");
1000 $c->log->debug('**********************************');
1001 $c->res->headers->header( 'X-Catalyst' => $Catalyst::VERSION );
1004 $c->prepare_request(@arguments);
1005 $c->prepare_connection;
1006 $c->prepare_query_parameters;
1007 $c->prepare_headers;
1008 $c->prepare_cookies;
1012 $c->prepare_body unless $c->config->{parse_on_demand};
1015 my $method = $c->req->method || '';
1016 my $path = $c->req->path || '';
1017 my $address = $c->req->address || '';
1019 $c->log->debug(qq/"$method" request for "$path" from $address/)
1025 =item $c->prepare_action
1031 sub prepare_action { my $c = shift; $c->dispatcher->prepare_action( $c, @_ ) }
1033 =item $c->prepare_body
1035 Prepare message body.
1042 # Do we run for the first time?
1043 return if defined $c->request->{_body};
1045 # Initialize on-demand data
1046 $c->engine->prepare_body( $c, @_ );
1047 $c->prepare_parameters;
1048 $c->prepare_uploads;
1050 if ( $c->debug && keys %{ $c->req->body_parameters } ) {
1051 my $t = Text::ASCIITable->new;
1052 $t->setCols( 'Key', 'Value' );
1053 $t->setColWidth( 'Key', 37, 1 );
1054 $t->setColWidth( 'Value', 36, 1 );
1055 $t->alignCol( 'Value', 'right' );
1056 for my $key ( sort keys %{ $c->req->body_parameters } ) {
1057 my $param = $c->req->body_parameters->{$key};
1058 my $value = defined($param) ? $param : '';
1060 ref $value eq 'ARRAY' ? ( join ', ', @$value ) : $value );
1062 $c->log->debug( "Body Parameters are:\n" . $t->draw );
1066 =item $c->prepare_body_chunk( $chunk )
1068 Prepare a chunk of data before sending it to HTTP::Body.
1072 sub prepare_body_chunk {
1074 $c->engine->prepare_body_chunk( $c, @_ );
1077 =item $c->prepare_body_parameters
1079 Prepare body parameters.
1083 sub prepare_body_parameters {
1085 $c->engine->prepare_body_parameters( $c, @_ );
1088 =item $c->prepare_connection
1094 sub prepare_connection {
1096 $c->engine->prepare_connection( $c, @_ );
1099 =item $c->prepare_cookies
1105 sub prepare_cookies { my $c = shift; $c->engine->prepare_cookies( $c, @_ ) }
1107 =item $c->prepare_headers
1113 sub prepare_headers { my $c = shift; $c->engine->prepare_headers( $c, @_ ) }
1115 =item $c->prepare_parameters
1121 sub prepare_parameters {
1123 $c->prepare_body_parameters;
1124 $c->engine->prepare_parameters( $c, @_ );
1127 =item $c->prepare_path
1129 Prepare path and base.
1133 sub prepare_path { my $c = shift; $c->engine->prepare_path( $c, @_ ) }
1135 =item $c->prepare_query_parameters
1137 Prepare query parameters.
1141 sub prepare_query_parameters {
1144 $c->engine->prepare_query_parameters( $c, @_ );
1146 if ( $c->debug && keys %{ $c->request->query_parameters } ) {
1147 my $t = Text::ASCIITable->new;
1148 $t->setCols( 'Key', 'Value' );
1149 $t->setColWidth( 'Key', 37, 1 );
1150 $t->setColWidth( 'Value', 36, 1 );
1151 $t->alignCol( 'Value', 'right' );
1152 for my $key ( sort keys %{ $c->req->query_parameters } ) {
1153 my $param = $c->req->query_parameters->{$key};
1154 my $value = defined($param) ? $param : '';
1156 ref $value eq 'ARRAY' ? ( join ', ', @$value ) : $value );
1158 $c->log->debug( "Query Parameters are:\n" . $t->draw );
1162 =item $c->prepare_read
1164 Prepare the input for reading.
1168 sub prepare_read { my $c = shift; $c->engine->prepare_read( $c, @_ ) }
1170 =item $c->prepare_request
1172 Prepare the engine request.
1176 sub prepare_request { my $c = shift; $c->engine->prepare_request( $c, @_ ) }
1178 =item $c->prepare_uploads
1184 sub prepare_uploads {
1187 $c->engine->prepare_uploads( $c, @_ );
1189 if ( $c->debug && keys %{ $c->request->uploads } ) {
1190 my $t = Text::ASCIITable->new;
1191 $t->setCols( 'Key', 'Filename', 'Type', 'Size' );
1192 $t->setColWidth( 'Key', 12, 1 );
1193 $t->setColWidth( 'Filename', 28, 1 );
1194 $t->setColWidth( 'Type', 18, 1 );
1195 $t->setColWidth( 'Size', 9, 1 );
1196 $t->alignCol( 'Size', 'left' );
1197 for my $key ( sort keys %{ $c->request->uploads } ) {
1198 my $upload = $c->request->uploads->{$key};
1199 for my $u ( ref $upload eq 'ARRAY' ? @{$upload} : ($upload) ) {
1200 $t->addRow( $key, $u->filename, $u->type, $u->size );
1203 $c->log->debug( "File Uploads are:\n" . $t->draw );
1207 =item $c->prepare_write
1209 Prepare the output for writing.
1213 sub prepare_write { my $c = shift; $c->engine->prepare_write( $c, @_ ) }
1215 =item $c->read( [$maxlength] )
1217 Read a chunk of data from the request body. This method is designed to be
1218 used in a while loop, reading $maxlength bytes on every call. $maxlength
1219 defaults to the size of the request if not specified.
1221 You have to set MyApp->config->{parse_on_demand} to use this directly.
1225 sub read { my $c = shift; return $c->engine->read( $c, @_ ) }
1233 sub run { my $c = shift; return $c->engine->run( $c, @_ ) }
1235 =item $c->set_action( $action, $code, $namespace, $attrs )
1237 Set an action in a given namespace.
1241 sub set_action { my $c = shift; $c->dispatcher->set_action( $c, @_ ) }
1243 =item $c->setup_actions($component)
1245 Setup actions for a component.
1249 sub setup_actions { my $c = shift; $c->dispatcher->setup_actions( $c, @_ ) }
1251 =item $c->setup_components
1257 sub setup_components {
1260 my $callback = sub {
1261 my ( $component, $context ) = @_;
1263 unless ( $component->isa('Catalyst::Base') ) {
1267 my $suffix = Catalyst::Utils::class2classsuffix($component);
1268 my $config = $class->config->{$suffix} || {};
1272 eval { $instance = $component->new( $context, $config ); };
1274 if ( my $error = $@ ) {
1278 Catalyst::Exception->throw( message =>
1279 qq/Couldn't instantiate component "$component", "$error"/ );
1282 Catalyst::Exception->throw( message =>
1283 qq/Couldn't instantiate component "$component", "new() didn't return a object"/
1285 unless ref $instance;
1290 Module::Pluggable::Fast->import(
1291 name => '_catalyst_components',
1293 "$class\::Controller", "$class\::C",
1294 "$class\::Model", "$class\::M",
1295 "$class\::View", "$class\::V"
1297 callback => $callback
1301 if ( my $error = $@ ) {
1305 Catalyst::Exception->throw(
1306 message => qq/Couldn't load components "$error"/ );
1309 for my $component ( $class->_catalyst_components($class) ) {
1310 $class->components->{ ref $component || $component } = $component;
1314 =item $c->setup_dispatcher
1318 sub setup_dispatcher {
1319 my ( $class, $dispatcher ) = @_;
1322 $dispatcher = 'Catalyst::Dispatcher::' . $dispatcher;
1325 if ( $ENV{CATALYST_DISPATCHER} ) {
1326 $dispatcher = 'Catalyst::Dispatcher::' . $ENV{CATALYST_DISPATCHER};
1329 if ( $ENV{ uc($class) . '_DISPATCHER' } ) {
1331 'Catalyst::Dispatcher::' . $ENV{ uc($class) . '_DISPATCHER' };
1334 unless ($dispatcher) {
1335 $dispatcher = 'Catalyst::Dispatcher';
1338 $dispatcher->require;
1341 Catalyst::Exception->throw(
1342 message => qq/Couldn't load dispatcher "$dispatcher", "$@"/ );
1345 # dispatcher instance
1346 $class->dispatcher( $dispatcher->new );
1349 =item $c->setup_engine
1354 my ( $class, $engine ) = @_;
1357 $engine = 'Catalyst::Engine::' . $engine;
1360 if ( $ENV{CATALYST_ENGINE} ) {
1361 $engine = 'Catalyst::Engine::' . $ENV{CATALYST_ENGINE};
1364 if ( $ENV{ uc($class) . '_ENGINE' } ) {
1365 $engine = 'Catalyst::Engine::' . $ENV{ uc($class) . '_ENGINE' };
1368 if ( !$engine && $ENV{MOD_PERL} ) {
1370 # create the apache method
1373 *{"$class\::apache"} = sub { shift->engine->apache };
1376 my ( $software, $version ) =
1377 $ENV{MOD_PERL} =~ /^(\S+)\/(\d+(?:[\.\_]\d+)+)/;
1380 $version =~ s/(\.[^.]+)\./$1/g;
1382 if ( $software eq 'mod_perl' ) {
1384 if ( $version >= 1.99922 ) {
1385 $engine = 'Catalyst::Engine::Apache2::MP20';
1388 elsif ( $version >= 1.9901 ) {
1389 $engine = 'Catalyst::Engine::Apache2::MP19';
1392 elsif ( $version >= 1.24 ) {
1393 $engine = 'Catalyst::Engine::Apache::MP13';
1397 Catalyst::Exception->throw( message =>
1398 qq/Unsupported mod_perl version: $ENV{MOD_PERL}/ );
1401 # install the correct mod_perl handler
1402 if ( $version >= 1.9901 ) {
1403 *handler = sub : method {
1404 shift->handle_request(@_);
1408 *handler = sub ($$) { shift->handle_request(@_) };
1413 elsif ( $software eq 'Zeus-Perl' ) {
1414 $engine = 'Catalyst::Engine::Zeus';
1418 Catalyst::Exception->throw(
1419 message => qq/Unsupported mod_perl: $ENV{MOD_PERL}/ );
1424 $engine = 'Catalyst::Engine::CGI';
1430 Catalyst::Exception->throw( message =>
1431 qq/Couldn't load engine "$engine" (maybe you forgot to install it?), "$@"/
1436 $class->engine( $engine->new );
1439 =item $c->setup_home
1444 my ( $class, $home ) = @_;
1446 if ( $ENV{CATALYST_HOME} ) {
1447 $home = $ENV{CATALYST_HOME};
1450 if ( $ENV{ uc($class) . '_HOME' } ) {
1451 $home = $ENV{ uc($class) . '_HOME' };
1455 $home = Catalyst::Utils::home($class);
1459 $class->config->{home} ||= $home;
1460 $class->config->{root} ||= dir($home)->subdir('root');
1469 my ( $class, $debug ) = @_;
1471 unless ( $class->log ) {
1472 $class->log( Catalyst::Log->new );
1475 if ( $ENV{CATALYST_DEBUG} || $ENV{ uc($class) . '_DEBUG' } || $debug ) {
1477 *{"$class\::debug"} = sub { 1 };
1478 $class->log->debug('Debug messages enabled');
1482 =item $c->setup_plugins
1487 my ( $class, $plugins ) = @_;
1490 for my $plugin ( reverse @$plugins ) {
1492 $plugin = "Catalyst::Plugin::$plugin";
1497 Catalyst::Exception->throw(
1498 message => qq/Couldn't load plugin "$plugin", "$@"/ );
1503 unshift @{"$class\::ISA"}, $plugin;
1508 =item $c->write( $data )
1510 Writes $data to the output stream. When using this method directly, you will
1511 need to manually set the Content-Length header to the length of your output
1519 # Finalize headers if someone manually writes output
1520 $c->finalize_headers;
1522 return $c->engine->write( $c, @_ );
1527 =head1 CASE SENSITIVITY
1529 By default Catalyst is not case sensitive, so C<MyApp::C::FOO::Bar> becomes
1532 But you can activate case sensitivity with a config parameter.
1534 MyApp->config->{case_sensitive} = 1;
1536 So C<MyApp::C::Foo::Bar> becomes C</Foo/Bar>.
1538 =head1 ON-DEMAND PARSER
1540 The request body is usually parsed at the beginning of a request,
1541 but if you want to handle input yourself or speed things up a bit
1542 you can enable on-demand parsing with a config parameter.
1544 MyApp->config->{parse_on_demand} = 1;
1546 =head1 PROXY SUPPORT
1548 Many production servers operate using the common double-server approach, with
1549 a lightweight frontend web server passing requests to a larger backend
1550 server. An application running on the backend server must deal with two
1551 problems: the remote user always appears to be '127.0.0.1' and the server's
1552 hostname will appear to be 'localhost' regardless of the virtual host the
1553 user connected through.
1555 Catalyst will automatically detect this situation when you are running both
1556 the frontend and backend servers on the same machine. The following changes
1557 are made to the request.
1559 $c->req->address is set to the user's real IP address, as read from the
1560 HTTP_X_FORWARDED_FOR header.
1562 The host value for $c->req->base and $c->req->uri is set to the real host,
1563 as read from the HTTP_X_FORWARDED_HOST header.
1565 Obviously, your web server must support these 2 headers for this to work.
1567 In a more complex server farm environment where you may have your frontend
1568 proxy server(s) on different machines, you will need to set a configuration
1569 option to tell Catalyst to read the proxied data from the headers.
1571 MyApp->config->{using_frontend_proxy} = 1;
1573 If you do not wish to use the proxy support at all, you may set:
1575 MyApp->config->{ignore_frontend_proxy} = 1;
1577 =head1 THREAD SAFETY
1579 Catalyst has been tested under Apache 2's threading mpm_worker, mpm_winnt,
1580 and the standalone forking HTTP server on Windows. We believe the Catalyst
1581 core to be thread-safe.
1583 If you plan to operate in a threaded environment, remember that all other
1584 modules you are using must also be thread-safe. Some modules, most notably
1585 DBD::SQLite, are not thread-safe.
1591 Join #catalyst on irc.perl.org.
1595 http://lists.rawmode.org/mailman/listinfo/catalyst
1596 http://lists.rawmode.org/mailman/listinfo/catalyst-dev
1600 http://catalyst.perl.org
1606 =item L<Catalyst::Manual> - The Catalyst Manual
1608 =item L<Catalyst::Engine> - Core Engine
1610 =item L<Catalyst::Log> - The Log Class.
1612 =item L<Catalyst::Request> - The Request Object
1614 =item L<Catalyst::Response> - The Response Object
1616 =item L<Catalyst::Test> - The test suite.
1676 Sebastian Riedel, C<sri@oook.de>
1680 This library is free software . You can redistribute it and/or modify it under
1681 the same terms as perl itself.