4 use base 'Catalyst::Base';
6 use UNIVERSAL::require;
7 use Catalyst::Exception;
10 use Catalyst::Request::Upload;
11 use Catalyst::Response;
14 use Text::SimpleTable;
16 use Time::HiRes qw/gettimeofday tv_interval/;
18 use Scalar::Util qw/weaken/;
21 __PACKAGE__->mk_accessors(
22 qw/counter request response state action stack namespace/
25 attributes->import( __PACKAGE__, \&namespace, 'lvalue' );
27 sub depth { scalar @{ shift->stack || [] }; }
34 # For backwards compatibility
35 *finalize_output = \&finalize_body;
40 our $RECURSION = 1000;
41 our $DETACH = "catalyst_detach\n";
43 require Module::Pluggable::Fast;
45 # Helper script generation
46 our $CATALYST_SCRIPT_GEN = 11;
48 __PACKAGE__->mk_classdata($_)
49 for qw/components arguments dispatcher engine log dispatcher_class
50 engine_class context_class request_class response_class/;
52 __PACKAGE__->dispatcher_class('Catalyst::Dispatcher');
53 __PACKAGE__->engine_class('Catalyst::Engine::CGI');
54 __PACKAGE__->request_class('Catalyst::Request');
55 __PACKAGE__->response_class('Catalyst::Response');
57 our $VERSION = '5.49_04';
60 my ( $class, @arguments ) = @_;
62 # We have to limit $class to Catalyst to avoid pushing Catalyst upon every
64 return unless $class eq 'Catalyst';
66 my $caller = caller(0);
68 unless ( $caller->isa('Catalyst') ) {
70 push @{"$caller\::ISA"}, $class;
73 $caller->arguments( [@arguments] );
79 Catalyst - The Elegant MVC Web Application Framework
83 # use the helper to start a new application
86 # add models, views, controllers
87 script/myapp_create.pl model Database DBIC dbi:SQLite:/path/to/db
88 script/myapp_create.pl view TT TT
89 script/myapp_create.pl controller Search
91 # built in testserver -- use -r to restart automatically on changes
92 script/myapp_server.pl
94 # command line testing interface
95 script/myapp_test.pl /yada
98 use Catalyst qw/-Debug/; # include plugins here as well
100 sub foo : Global { # called for /foo, /foo/1, /foo/1/2, etc.
101 my ( $self, $c, @args ) = @_; # args are qw/on you/ for /foo/on/you
102 $c->stash->{template} = 'foo.tt';
103 # lookup something from db -- stash vars are passed to TT
104 $c->stash->{data} = MyApp::Model::Database::Foo->search;
105 if ( $c->req->params->{bar} ) { # access GET or POST parameters
106 $c->forward( 'bar' ); # process another action
107 # do something else after forward returns
111 # The foo.tt TT template can easily use the stash data from the database
112 [% WHILE (item = data.next) %]
116 # called for /bar/of/soap, /bar/of/soap/10, etc.
117 sub bar : Path('/bar/of/soap') { ... }
119 # called for / and only /, no other args
120 sub baz : Path { ... }
121 sub baz : Index { ... }
123 # called for all actions, from the top-most controller inwards
125 my ( $self, $c ) = @_;
127 $c->res->redirect( '/login' ); # require login
128 return 0; # abort request and go immediately to end()
133 # called after the main action is finished
135 my ( $self, $c ) = @_;
136 if ( scalar @{ $c->error } ) { ... } # handle errors
137 return if $c->res->body; # already have a response
138 $c->forward( 'MyApp::View::TT' ); # render template
141 ### in MyApp/Controller/Foo.pm
142 # called for /foo/bar
143 sub bar : Local { ... }
145 # overrides /foo, but not /foo/1, etc.
146 sub index : Path { ... }
148 ### in MyApp/Controller/Foo/Bar.pm
149 # called for /foo/bar/baz
150 sub baz : Local { ... }
152 # first MyApp auto is called, then Foo auto, then this
153 sub auto : Private { ... }
155 # powerful regular expression paths are also possible
156 sub details : Regex('^product/(\w+)/details$') {
157 my ( $self, $c ) = @_;
158 # extract the (\w+) from the URI
159 my $product = $c->req->snippets->[0];
162 See L<Catalyst::Manual::Intro> for additional information.
166 The key concept of Catalyst is DRY (Don't Repeat Yourself).
168 See L<Catalyst::Manual> for more documentation.
170 Catalyst plugins can be loaded by naming them as arguments to the "use Catalyst" statement.
171 Omit the C<Catalyst::Plugin::> prefix from the plugin name, i.e.,
172 C<Catalyst::Plugin::My::Module> becomes C<My::Module>.
174 use Catalyst qw/My::Module/;
176 Special flags like -Debug and -Engine can also be specified as arguments when
179 use Catalyst qw/-Debug My::Module/;
181 The position of plugins and flags in the chain is important, because they are
182 loaded in exactly the order that they appear.
184 The following flags are supported:
190 Enables debug output.
194 Forces Catalyst to use a specific engine.
195 Omit the C<Catalyst::Engine::> prefix of the engine name, i.e.:
197 use Catalyst qw/-Engine=CGI/;
201 Forces Catalyst to use a specific home directory.
211 =head2 Information about the current request
217 Returns a L<Catalyst::Action> object for the current action, which stringifies to the action name.
221 Returns the namespace of the current action, i.e., the uri prefix corresponding to the
222 controller of the current action.
228 Returns the current L<Catalyst::Request> object.
234 =head2 Processing and response to the current request
238 =item $c->forward( $action [, \@arguments ] )
240 =item $c->forward( $class, $method, [, \@arguments ] )
242 Forwards processing to a private action. If you give a class name but
243 no method, process() is called. You may also optionally pass arguments
244 in an arrayref. The action will receive the arguments in @_ and $c->req->args.
245 Upon returning from the function, $c->req->args will be restored to the previous
249 $c->forward('index');
250 $c->forward(qw/MyApp::Model::CDBI::Foo do_stuff/);
251 $c->forward('MyApp::View::TT');
255 sub forward { my $c = shift; $c->dispatcher->forward( $c, @_ ) }
257 =item $c->detach( $action [, \@arguments ] )
259 =item $c->detach( $class, $method, [, \@arguments ] )
261 The same as C<forward>, but doesn't return.
265 sub detach { my $c = shift; $c->dispatcher->detach( $c, @_ ) }
269 =item $c->error($error, ...)
271 =item $c->error($arrayref)
273 Returns an arrayref containing error messages.
275 my @error = @{ $c->error };
279 $c->error('Something bad happened');
290 my $error = ref $_[0] eq 'ARRAY' ? $_[0] : [@_];
291 push @{ $c->{error} }, @$error;
293 elsif ( defined $_[0] ) { $c->{error} = undef }
294 return $c->{error} || [];
301 Returns the current L<Catalyst::Response> object.
307 Returns a hashref to the stash, which may be used to store data and pass it
308 between components. You can also set hash keys by passing arguments. The
309 stash is automatically sent to the view.
311 $c->stash->{foo} = $bar;
312 $c->stash( { moose => 'majestic', qux => 0 } );
313 $c->stash( bar => 1, gorch => 2 ); # equivalent to passing a hashref
315 # stash is automatically passed to the view for use in a template
316 $c->forward( 'MyApp::V::TT' );
323 my $stash = @_ > 1 ? {@_} : $_[0];
324 while ( my ( $key, $val ) = each %$stash ) {
325 $c->{stash}->{$key} = $val;
333 Contains the return value of the last executed action.
337 =head2 Component Accessors
341 =item $c->comp($name)
343 =item $c->component($name)
345 Gets a component object by name. This method is no longer recommended.
346 $c->controller, $c->model, and $c->view should be used instead.
357 my $appclass = ref $c || $c;
360 $name, "${appclass}::${name}",
361 map { "${appclass}::${_}::${name}" } qw/M V C/
364 foreach my $try (@names) {
366 if ( exists $c->components->{$try} ) {
368 return $c->components->{$try};
372 foreach my $component ( keys %{ $c->components } ) {
374 return $c->components->{$component} if $component =~ /$name/i;
379 return sort keys %{ $c->components };
382 =item $c->controller($name)
384 Gets a L<Catalyst::Controller> instance by name.
386 $c->controller('Foo')->do_stuff;
391 my ( $c, $name ) = @_;
392 my $controller = $c->comp("Controller::$name");
393 return $controller if $controller;
394 return $c->comp("C::$name");
397 =item $c->model($name)
399 Gets a L<Catalyst::Model> instance by name.
401 $c->model('Foo')->do_stuff;
406 my ( $c, $name ) = @_;
407 my $model = $c->comp("Model::$name");
408 return $model if $model;
409 return $c->comp("M::$name");
412 =item $c->view($name)
414 Gets a L<Catalyst::View> instance by name.
416 $c->view('Foo')->do_stuff;
421 my ( $c, $name ) = @_;
422 my $view = $c->comp("View::$name");
423 return $view if $view;
424 return $c->comp("V::$name");
429 =head2 Class data and helper classes
435 Returns or takes a hashref containing the application's configuration.
437 __PACKAGE__->config({ db => 'dsn:SQLite:foo.db' });
441 Overload to enable debug messages (same as -Debug option).
449 Returns the dispatcher instance. Stringifies to class name.
453 Returns the engine instance. Stringifies to the class name.
457 Returns the logging object instance. Unless it is already set, Catalyst sets this up with a
458 L<Catalyst::Log> object. To use your own log class:
460 $c->log( MyLogger->new );
461 $c->log->info( 'now logging with my own logger!' );
463 Your log class should implement the methods described in the L<Catalyst::Log>
470 =head2 Utility methods
474 =item $c->path_to(@path)
476 Merges C<@path> with $c->config->{home} and returns a L<Path::Class> object.
480 $c->path_to( 'db', 'sqlite.db' );
485 my ( $c, @path ) = @_;
486 my $path = dir( $c->config->{home}, @path );
487 if ( -d $path ) { return $path }
488 else { return file( $c->config->{home}, @path ) }
491 =item $c->plugin( $name, $class, @args )
493 Helper method for plugins. It creates a classdata accessor/mutator and loads
494 and instantiates the given class.
496 MyApp->plugin( 'prototype', 'HTML::Prototype' );
498 $c->prototype->define_javascript_functions;
503 my ( $class, $name, $plugin, @args ) = @_;
506 if ( my $error = $UNIVERSAL::require::ERROR ) {
507 Catalyst::Exception->throw(
508 message => qq/Couldn't load instant plugin "$plugin", "$error"/ );
511 eval { $plugin->import };
512 $class->mk_classdata($name);
514 eval { $obj = $plugin->new(@args) };
517 Catalyst::Exception->throw( message =>
518 qq/Couldn't instantiate instant plugin "$plugin", "$@"/ );
522 $class->log->debug(qq/Initialized instant plugin "$plugin" as "$name"/)
528 Initializes the dispatcher and engine, loads any plugins, and loads the
529 model, view, and controller components. You may also specify an array of
530 plugins to load here, if you choose to not load them in the 'use Catalyst'
534 MyApp->setup( qw/-Debug/ );
539 my ( $class, @arguments ) = @_;
541 unless ( $class->isa('Catalyst') ) {
543 Catalyst::Exception->throw(
544 message => qq/'$class' does not inherit from Catalyst/ );
547 if ( $class->arguments ) {
548 @arguments = ( @arguments, @{ $class->arguments } );
554 foreach (@arguments) {
558 ( $flags->{log} ) ? 'debug,' . $flags->{log} : 'debug';
560 elsif (/^-(\w+)=?(.*)$/) {
561 $flags->{ lc $1 } = $2;
564 push @{ $flags->{plugins} }, $_;
568 $class->setup_log( delete $flags->{log} );
569 $class->setup_plugins( delete $flags->{plugins} );
570 $class->setup_dispatcher( delete $flags->{dispatcher} );
571 $class->setup_engine( delete $flags->{engine} );
572 $class->setup_home( delete $flags->{home} );
574 for my $flag ( sort keys %{$flags} ) {
576 if ( my $code = $class->can( 'setup_' . $flag ) ) {
577 &$code( $class, delete $flags->{$flag} );
580 $class->log->warn(qq/Unknown flag "$flag"/);
585 <<"EOF") if ( $ENV{CATALYST_SCRIPT_GEN} && ( $ENV{CATALYST_SCRIPT_GEN} < $Catalyst::CATALYST_SCRIPT_GEN ) );
586 You are running an old script!
588 Please update by running:
589 catalyst.pl -nonew -scripts $class
592 if ( $class->debug ) {
598 @plugins = grep { /^Catalyst::Plugin/ } @{"$class\::ISA"};
602 my $t = Text::SimpleTable->new(76);
603 $t->row($_) for @plugins;
604 $class->log->debug( "Loaded plugins:\n" . $t->draw );
607 my $dispatcher = $class->dispatcher;
608 my $engine = $class->engine;
609 my $home = $class->config->{home};
611 $class->log->debug(qq/Loaded dispatcher "$dispatcher"/);
612 $class->log->debug(qq/Loaded engine "$engine"/);
616 ? $class->log->debug(qq/Found home "$home"/)
617 : $class->log->debug(qq/Home "$home" doesn't exist/)
618 : $class->log->debug(q/Couldn't find home/);
623 no warnings qw/redefine/;
624 local *setup = sub { };
628 # Initialize our data structure
629 $class->components( {} );
631 $class->setup_components;
633 if ( $class->debug ) {
634 my $t = Text::SimpleTable->new( [ 65, 'Class' ], [ 8, 'Type' ] );
635 for my $comp ( sort keys %{ $class->components } ) {
636 my $type = ref $class->components->{$comp} ? 'instance' : 'class';
637 $t->row( $comp, $type );
639 $class->log->debug( "Loaded components:\n" . $t->draw )
640 if ( keys %{ $class->components } );
643 # Add our self to components, since we are also a component
644 $class->components->{$class} = $class;
646 $class->setup_actions;
648 if ( $class->debug ) {
649 my $name = $class->config->{name} || 'Application';
650 $class->log->info("$name powered by Catalyst $Catalyst::VERSION");
652 $class->log->_flush() if $class->log->can('_flush');
655 =item $c->uri_for( $path, [ @args ] )
657 Merges path with $c->request->base for absolute uri's and with
658 $c->request->match for relative uri's, then returns a normalized
659 L<URI> object. If any args are passed, they are added at the end
665 my ( $c, $path, @args ) = @_;
666 my $base = $c->request->base->clone;
667 my $basepath = $base->path;
668 $basepath =~ s/\/$//;
670 my $match = $c->request->match;
672 # massage match, empty if absolute path
674 $match .= '/' if $match;
676 $match = '' if $path =~ /^\//;
679 # join args with '/', or a blank string
680 my $args = ( scalar @args ? '/' . join( '/', @args ) : '' );
681 return URI->new_abs( URI->new_abs( "$path$args", "$basepath$match" ),
685 =item $c->welcome_message
687 Returns the Catalyst welcome HTML page.
691 sub welcome_message {
693 my $name = $c->config->{name};
694 my $logo = $c->uri_for('/static/images/catalyst_logo.png');
695 my $prefix = Catalyst::Utils::appprefix( ref $c );
696 $c->response->content_type('text/html; charset=utf-8');
698 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
699 "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
700 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
702 <meta http-equiv="Content-Language" content="en" />
703 <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
704 <title>$name on Catalyst $VERSION</title>
705 <style type="text/css">
708 background-color: #eee;
717 background-color: #ccc;
718 border: 1px solid #aaa;
719 -moz-border-radius: 10px;
724 font-family: verdana, tahoma, sans-serif;
727 font-family: verdana, tahoma, sans-serif;
730 text-decoration: none;
732 border-bottom: 1px dotted #bbb;
734 :link:hover, :visited:hover {
747 background-color: #fff;
748 border: 1px solid #aaa;
749 -moz-border-radius: 10px;
775 <h1><span id="appname">$name</span> on <a href="http://catalyst.perl.org">Catalyst</a>
780 <img src="$logo" alt="Catalyst Logo" />
782 <p>Welcome to the wonderful world of Catalyst.
783 This <a href="http://en.wikipedia.org/wiki/MVC">MVC</a>
784 framework will make web development something you had
785 never expected it to be: Fun, rewarding and quick.</p>
786 <h2>What to do now?</h2>
787 <p>That really depends on what <b>you</b> want to do.
788 We do, however, provide you with a few starting points.</p>
789 <p>If you want to jump right into web development with Catalyst
790 you might want to check out the documentation.</p>
791 <pre><code>perldoc <a href="http://cpansearch.perl.org/dist/Catalyst/lib/Catalyst/Manual/Intro.pod">Catalyst::Manual::Intro</a>
792 perldoc <a href="http://cpansearch.perl.org/dist/Catalyst/lib/Catalyst/Manual.pod">Catalyst::Manual</a></code></pre>
793 <h2>What to do next?</h2>
794 <p>Next it's time to write an actual application. Use the
795 helper scripts to generate <a href="http://cpansearch.perl.org/search?query=Catalyst%3A%3AController%3A%3A&mode=all">controllers</a>,
796 <a href="http://cpansearch.perl.org/search?query=Catalyst%3A%3AModel%3A%3A&mode=all">models</a> and
797 <a href="http://cpansearch.perl.org/search?query=Catalyst%3A%3AView%3A%3A&mode=all">views</a>,
798 they can save you a lot of work.</p>
799 <pre><code>script/${prefix}_create.pl -help</code></pre>
800 <p>Also, be sure to check out the vast and growing
801 collection of <a href="http://cpansearch.perl.org/search?query=Catalyst%3A%3APlugin%3A%3A&mode=all">plugins for Catalyst on CPAN</a>,
802 you are likely to find what you need there.
806 <p>Catalyst has a very active community. Here are the main places to
807 get in touch with us.</p>
810 <a href="http://dev.catalyst.perl.org">Wiki</a>
813 <a href="http://lists.rawmode.org/mailman/listinfo/catalyst">Mailing-List</a>
816 <a href="irc://irc.perl.org/catalyst">IRC channel #catalyst on irc.perl.org</a>
819 <h2>In conclusion</h2>
820 <p>The Catalyst team hopes you will enjoy using Catalyst as much
821 as we enjoyed making it. Please contact us if you have ideas
822 for improvement or other feedback.</p>
832 =head1 INTERNAL METHODS
836 =item $c->benchmark( $coderef )
838 Takes a coderef with arguments and returns elapsed time as float.
840 my ( $elapsed, $status ) = $c->benchmark( sub { return 1 } );
841 $c->log->info( sprintf "Processing took %f seconds", $elapsed );
848 my $time = [gettimeofday];
849 my @return = &$code(@_);
850 my $elapsed = tv_interval $time;
851 return wantarray ? ( $elapsed, @return ) : $elapsed;
856 Returns a hash of components.
858 =item $c->context_class
860 Returns or sets the context class.
864 Returns a hashref containing coderefs and execution counts (needed for deep
865 recursion detection).
869 Returns the number of actions on the current internal execution stack.
873 Dispatches a request to actions.
877 sub dispatch { my $c = shift; $c->dispatcher->dispatch( $c, @_ ) }
879 =item $c->dispatcher_class
881 Returns or sets the dispatcher class.
885 Returns a list of 2-element array references (name, structure) pairs that will
886 be dumped on the error page in debug mode.
892 [ Request => $c->req ], [ Response => $c->res ], [ Stash => $c->stash ],;
895 =item $c->engine_class
897 Returns or sets the engine class.
899 =item $c->execute( $class, $coderef )
901 Execute a coderef in given class and catch exceptions. Errors are available
907 my ( $c, $class, $code ) = @_;
908 $class = $c->components->{$class} || $class;
912 ( caller(0) )[0]->isa('Catalyst::Action')
919 $action = "/$action" unless $action =~ /\-\>/;
920 $c->counter->{"$code"}++;
922 if ( $c->counter->{"$code"} > $RECURSION ) {
923 my $error = qq/Deep recursion detected in "$action"/;
924 $c->log->error($error);
930 $action = "-> $action" if $callsub =~ /forward$/;
932 push( @{ $c->stack }, $code );
936 my ( $elapsed, @state ) =
937 $c->benchmark( $code, $class, $c, @{ $c->req->args } );
938 unless ( ( $code->name =~ /^_.*/ )
939 && ( !$c->config->{show_internal_actions} ) )
941 push @{ $c->{stats} }, [ $action, sprintf( '%fs', $elapsed ) ];
946 $c->state( &$code( $class, $c, @{ $c->req->args } ) || 0 );
949 pop( @{ $c->stack } );
951 if ( my $error = $@ ) {
953 if ( $error eq $DETACH ) { die $DETACH if $c->depth > 1 }
955 unless ( ref $error ) {
957 $error = qq/Caught exception "$error"/;
968 Finalizes the request.
975 for my $error ( @{ $c->error } ) {
976 $c->log->error($error);
979 $c->finalize_uploads;
982 if ( $#{ $c->error } >= 0 ) {
986 $c->finalize_headers;
989 if ( $c->request->method eq 'HEAD' ) {
990 $c->response->body('');
995 return $c->response->status;
998 =item $c->finalize_body
1004 sub finalize_body { my $c = shift; $c->engine->finalize_body( $c, @_ ) }
1006 =item $c->finalize_cookies
1012 sub finalize_cookies { my $c = shift; $c->engine->finalize_cookies( $c, @_ ) }
1014 =item $c->finalize_error
1020 sub finalize_error { my $c = shift; $c->engine->finalize_error( $c, @_ ) }
1022 =item $c->finalize_headers
1028 sub finalize_headers {
1031 # Check if we already finalized headers
1032 return if $c->response->{_finalized_headers};
1035 if ( my $location = $c->response->redirect ) {
1036 $c->log->debug(qq/Redirecting to "$location"/) if $c->debug;
1037 $c->response->header( Location => $location );
1041 if ( $c->response->body && !$c->response->content_length ) {
1042 $c->response->content_length( bytes::length( $c->response->body ) );
1046 if ( $c->response->status =~ /^(1\d\d|[23]04)$/ ) {
1047 $c->response->headers->remove_header("Content-Length");
1048 $c->response->body('');
1051 $c->finalize_cookies;
1053 $c->engine->finalize_headers( $c, @_ );
1056 $c->response->{_finalized_headers} = 1;
1059 =item $c->finalize_output
1061 An alias for finalize_body.
1063 =item $c->finalize_read
1065 Finalizes the input after reading is complete.
1069 sub finalize_read { my $c = shift; $c->engine->finalize_read( $c, @_ ) }
1071 =item $c->finalize_uploads
1073 Finalizes uploads. Cleans up any temporary files.
1077 sub finalize_uploads { my $c = shift; $c->engine->finalize_uploads( $c, @_ ) }
1079 =item $c->get_action( $action, $namespace )
1081 Gets an action in a given namespace.
1085 sub get_action { my $c = shift; $c->dispatcher->get_action(@_) }
1087 =item $c->get_actions( $action, $namespace )
1089 Gets all actions of a given name in a namespace and all parent namespaces.
1093 sub get_actions { my $c = shift; $c->dispatcher->get_actions( $c, @_ ) }
1095 =item handle_request( $class, @arguments )
1097 Called to handle each HTTP request.
1101 sub handle_request {
1102 my ( $class, @arguments ) = @_;
1104 # Always expect worst case!
1110 my $c = $class->prepare(@arguments);
1111 $c->{stats} = \@stats;
1113 return $c->finalize;
1116 if ( $class->debug ) {
1118 ( $elapsed, $status ) = $class->benchmark($handler);
1119 $elapsed = sprintf '%f', $elapsed;
1120 my $av = sprintf '%.3f',
1121 ( $elapsed == 0 ? '??' : ( 1 / $elapsed ) );
1122 my $t = Text::SimpleTable->new( [ 64, 'Action' ], [ 9, 'Time' ] );
1124 for my $stat (@stats) { $t->row( $stat->[0], $stat->[1] ) }
1126 "Request took ${elapsed}s ($av/s)\n" . $t->draw );
1128 else { $status = &$handler }
1132 if ( my $error = $@ ) {
1134 $class->log->error(qq/Caught exception in engine "$error"/);
1138 $class->log->_flush() if $class->log->can('_flush');
1142 =item $c->prepare( @arguments )
1144 Creates a Catalyst context from an engine-specific request
1145 (Apache, CGI, etc.).
1150 my ( $class, @arguments ) = @_;
1152 $class->context_class( ref $class || $class ) unless $class->context_class;
1153 my $c = $class->context_class->new(
1157 request => $class->request_class->new(
1160 body_parameters => {},
1162 headers => HTTP::Headers->new,
1164 query_parameters => {},
1170 response => $class->response_class->new(
1174 headers => HTTP::Headers->new(),
1183 # For on-demand data
1184 $c->request->{_context} = $c;
1185 $c->response->{_context} = $c;
1186 weaken( $c->request->{_context} );
1187 weaken( $c->response->{_context} );
1190 my $secs = time - $START || 1;
1191 my $av = sprintf '%.3f', $COUNT / $secs;
1192 $c->log->debug('**********************************');
1193 $c->log->debug("* Request $COUNT ($av/s) [$$]");
1194 $c->log->debug('**********************************');
1195 $c->res->headers->header( 'X-Catalyst' => $Catalyst::VERSION );
1198 $c->prepare_request(@arguments);
1199 $c->prepare_connection;
1200 $c->prepare_query_parameters;
1201 $c->prepare_headers;
1202 $c->prepare_cookies;
1206 $c->prepare_body unless $c->config->{parse_on_demand};
1209 my $method = $c->req->method || '';
1210 my $path = $c->req->path || '';
1211 my $address = $c->req->address || '';
1213 $c->log->debug(qq/"$method" request for "$path" from $address/)
1219 =item $c->prepare_action
1225 sub prepare_action { my $c = shift; $c->dispatcher->prepare_action( $c, @_ ) }
1227 =item $c->prepare_body
1229 Prepares message body.
1236 # Do we run for the first time?
1237 return if defined $c->request->{_body};
1239 # Initialize on-demand data
1240 $c->engine->prepare_body( $c, @_ );
1241 $c->prepare_parameters;
1242 $c->prepare_uploads;
1244 if ( $c->debug && keys %{ $c->req->body_parameters } ) {
1245 my $t = Text::SimpleTable->new( [ 37, 'Key' ], [ 36, 'Value' ] );
1246 for my $key ( sort keys %{ $c->req->body_parameters } ) {
1247 my $param = $c->req->body_parameters->{$key};
1248 my $value = defined($param) ? $param : '';
1250 ref $value eq 'ARRAY' ? ( join ', ', @$value ) : $value );
1252 $c->log->debug( "Body Parameters are:\n" . $t->draw );
1256 =item $c->prepare_body_chunk( $chunk )
1258 Prepares a chunk of data before sending it to L<HTTP::Body>.
1262 sub prepare_body_chunk {
1264 $c->engine->prepare_body_chunk( $c, @_ );
1267 =item $c->prepare_body_parameters
1269 Prepares body parameters.
1273 sub prepare_body_parameters {
1275 $c->engine->prepare_body_parameters( $c, @_ );
1278 =item $c->prepare_connection
1280 Prepares connection.
1284 sub prepare_connection {
1286 $c->engine->prepare_connection( $c, @_ );
1289 =item $c->prepare_cookies
1295 sub prepare_cookies { my $c = shift; $c->engine->prepare_cookies( $c, @_ ) }
1297 =item $c->prepare_headers
1303 sub prepare_headers { my $c = shift; $c->engine->prepare_headers( $c, @_ ) }
1305 =item $c->prepare_parameters
1307 Prepares parameters.
1311 sub prepare_parameters {
1313 $c->prepare_body_parameters;
1314 $c->engine->prepare_parameters( $c, @_ );
1317 =item $c->prepare_path
1319 Prepares path and base.
1323 sub prepare_path { my $c = shift; $c->engine->prepare_path( $c, @_ ) }
1325 =item $c->prepare_query_parameters
1327 Prepares query parameters.
1331 sub prepare_query_parameters {
1334 $c->engine->prepare_query_parameters( $c, @_ );
1336 if ( $c->debug && keys %{ $c->request->query_parameters } ) {
1337 my $t = Text::SimpleTable->new( [ 37, 'Key' ], [ 36, 'Value' ] );
1338 for my $key ( sort keys %{ $c->req->query_parameters } ) {
1339 my $param = $c->req->query_parameters->{$key};
1340 my $value = defined($param) ? $param : '';
1342 ref $value eq 'ARRAY' ? ( join ', ', @$value ) : $value );
1344 $c->log->debug( "Query Parameters are:\n" . $t->draw );
1348 =item $c->prepare_read
1350 Prepares the input for reading.
1354 sub prepare_read { my $c = shift; $c->engine->prepare_read( $c, @_ ) }
1356 =item $c->prepare_request
1358 Prepares the engine request.
1362 sub prepare_request { my $c = shift; $c->engine->prepare_request( $c, @_ ) }
1364 =item $c->prepare_uploads
1370 sub prepare_uploads {
1373 $c->engine->prepare_uploads( $c, @_ );
1375 if ( $c->debug && keys %{ $c->request->uploads } ) {
1376 my $t = Text::SimpleTable->new(
1382 for my $key ( sort keys %{ $c->request->uploads } ) {
1383 my $upload = $c->request->uploads->{$key};
1384 for my $u ( ref $upload eq 'ARRAY' ? @{$upload} : ($upload) ) {
1385 $t->row( $key, $u->filename, $u->type, $u->size );
1388 $c->log->debug( "File Uploads are:\n" . $t->draw );
1392 =item $c->prepare_write
1394 Prepares the output for writing.
1398 sub prepare_write { my $c = shift; $c->engine->prepare_write( $c, @_ ) }
1400 =item $c->request_class
1402 Returns or sets the request class.
1404 =item $c->response_class
1406 Returns or sets the response class.
1408 =item $c->read( [$maxlength] )
1410 Reads a chunk of data from the request body. This method is designed to be
1411 used in a while loop, reading $maxlength bytes on every call. $maxlength
1412 defaults to the size of the request if not specified.
1414 You have to set MyApp->config->{parse_on_demand} to use this directly.
1418 sub read { my $c = shift; return $c->engine->read( $c, @_ ) }
1426 sub run { my $c = shift; return $c->engine->run( $c, @_ ) }
1428 =item $c->set_action( $action, $code, $namespace, $attrs )
1430 Sets an action in a given namespace.
1434 sub set_action { my $c = shift; $c->dispatcher->set_action( $c, @_ ) }
1436 =item $c->setup_actions($component)
1438 Sets up actions for a component.
1442 sub setup_actions { my $c = shift; $c->dispatcher->setup_actions( $c, @_ ) }
1444 =item $c->setup_components
1450 sub setup_components {
1453 my $callback = sub {
1454 my ( $component, $context ) = @_;
1456 unless ( $component->isa('Catalyst::Component') ) {
1460 my $suffix = Catalyst::Utils::class2classsuffix($component);
1461 my $config = $class->config->{$suffix} || {};
1465 eval { $instance = $component->new( $context, $config ); };
1467 if ( my $error = $@ ) {
1471 Catalyst::Exception->throw( message =>
1472 qq/Couldn't instantiate component "$component", "$error"/ );
1475 Catalyst::Exception->throw( message =>
1476 qq/Couldn't instantiate component "$component", "new() didn't return a object"/
1478 unless ref $instance;
1483 Module::Pluggable::Fast->import(
1484 name => '_catalyst_components',
1486 "$class\::Controller", "$class\::C",
1487 "$class\::Model", "$class\::M",
1488 "$class\::View", "$class\::V"
1490 callback => $callback
1494 if ( my $error = $@ ) {
1498 Catalyst::Exception->throw(
1499 message => qq/Couldn't load components "$error"/ );
1502 for my $component ( $class->_catalyst_components($class) ) {
1503 $class->components->{ ref $component || $component } = $component;
1507 =item $c->setup_dispatcher
1511 sub setup_dispatcher {
1512 my ( $class, $dispatcher ) = @_;
1515 $dispatcher = 'Catalyst::Dispatcher::' . $dispatcher;
1518 if ( $ENV{CATALYST_DISPATCHER} ) {
1519 $dispatcher = 'Catalyst::Dispatcher::' . $ENV{CATALYST_DISPATCHER};
1522 if ( $ENV{ uc($class) . '_DISPATCHER' } ) {
1524 'Catalyst::Dispatcher::' . $ENV{ uc($class) . '_DISPATCHER' };
1527 unless ($dispatcher) {
1528 $dispatcher = $class->dispatcher_class;
1531 $dispatcher->require;
1534 Catalyst::Exception->throw(
1535 message => qq/Couldn't load dispatcher "$dispatcher", "$@"/ );
1538 # dispatcher instance
1539 $class->dispatcher( $dispatcher->new );
1542 =item $c->setup_engine
1547 my ( $class, $engine ) = @_;
1550 $engine = 'Catalyst::Engine::' . $engine;
1553 if ( $ENV{CATALYST_ENGINE} ) {
1554 $engine = 'Catalyst::Engine::' . $ENV{CATALYST_ENGINE};
1557 if ( $ENV{ uc($class) . '_ENGINE' } ) {
1558 $engine = 'Catalyst::Engine::' . $ENV{ uc($class) . '_ENGINE' };
1561 if ( !$engine && $ENV{MOD_PERL} ) {
1563 # create the apache method
1566 *{"$class\::apache"} = sub { shift->engine->apache };
1569 my ( $software, $version ) =
1570 $ENV{MOD_PERL} =~ /^(\S+)\/(\d+(?:[\.\_]\d+)+)/;
1573 $version =~ s/(\.[^.]+)\./$1/g;
1575 if ( $software eq 'mod_perl' ) {
1577 if ( $version >= 1.99922 ) {
1578 $engine = 'Catalyst::Engine::Apache2::MP20';
1581 elsif ( $version >= 1.9901 ) {
1582 $engine = 'Catalyst::Engine::Apache2::MP19';
1585 elsif ( $version >= 1.24 ) {
1586 $engine = 'Catalyst::Engine::Apache::MP13';
1590 Catalyst::Exception->throw( message =>
1591 qq/Unsupported mod_perl version: $ENV{MOD_PERL}/ );
1594 # install the correct mod_perl handler
1595 if ( $version >= 1.9901 ) {
1596 *handler = sub : method {
1597 shift->handle_request(@_);
1601 *handler = sub ($$) { shift->handle_request(@_) };
1606 elsif ( $software eq 'Zeus-Perl' ) {
1607 $engine = 'Catalyst::Engine::Zeus';
1611 Catalyst::Exception->throw(
1612 message => qq/Unsupported mod_perl: $ENV{MOD_PERL}/ );
1617 $engine = $class->engine_class;
1623 Catalyst::Exception->throw( message =>
1624 qq/Couldn't load engine "$engine" (maybe you forgot to install it?), "$@"/
1628 # check for old engines that are no longer compatible
1630 if ( $engine->isa('Catalyst::Engine::Apache')
1631 && !Catalyst::Engine::Apache->VERSION )
1636 elsif ( $engine->isa('Catalyst::Engine::Server::Base')
1637 && Catalyst::Engine::Server->VERSION le '0.02' )
1642 elsif ($engine->isa('Catalyst::Engine::HTTP::POE')
1643 && $engine->VERSION eq '0.01' )
1648 elsif ($engine->isa('Catalyst::Engine::Zeus')
1649 && $engine->VERSION eq '0.01' )
1655 Catalyst::Exception->throw( message =>
1656 qq/Engine "$engine" is not supported by this version of Catalyst/
1661 $class->engine( $engine->new );
1664 =item $c->setup_home
1669 my ( $class, $home ) = @_;
1671 if ( $ENV{CATALYST_HOME} ) {
1672 $home = $ENV{CATALYST_HOME};
1675 if ( $ENV{ uc($class) . '_HOME' } ) {
1676 $home = $ENV{ uc($class) . '_HOME' };
1680 $home = Catalyst::Utils::home($class);
1684 $class->config->{home} ||= $home;
1685 $class->config->{root} ||= dir($home)->subdir('root');
1694 my ( $class, $debug ) = @_;
1696 unless ( $class->log ) {
1697 $class->log( Catalyst::Log->new );
1700 my $app_flag = Catalyst::Utils::class2env($class) . '_DEBUG';
1703 ( defined( $ENV{CATALYST_DEBUG} ) || defined( $ENV{$app_flag} ) )
1704 ? ( $ENV{CATALYST_DEBUG} || $ENV{$app_flag} )
1709 *{"$class\::debug"} = sub { 1 };
1710 $class->log->debug('Debug messages enabled');
1714 =item $c->setup_plugins
1719 my ( $class, $plugins ) = @_;
1722 for my $plugin ( reverse @$plugins ) {
1724 $plugin = "Catalyst::Plugin::$plugin";
1729 Catalyst::Exception->throw(
1730 message => qq/Couldn't load plugin "$plugin", "$@"/ );
1735 unshift @{"$class\::ISA"}, $plugin;
1744 =item $c->write( $data )
1746 Writes $data to the output stream. When using this method directly, you will
1747 need to manually set the Content-Length header to the length of your output
1755 # Finalize headers if someone manually writes output
1756 $c->finalize_headers;
1758 return $c->engine->write( $c, @_ );
1763 Returns the Catalyst version number. Mostly useful for "powered by" messages
1764 in template systems.
1768 sub version { return $Catalyst::VERSION }
1772 =head1 INTERNAL ACTIONS
1774 Catalyst uses internal actions like C<_DISPATCH>, C<_BEGIN>, C<_AUTO>
1775 C<_ACTION> and C<_END>, these are by default not shown in the private
1778 But you can deactivate this with a config parameter.
1780 MyApp->config->{show_internal_actions} = 1;
1782 =head1 CASE SENSITIVITY
1784 By default Catalyst is not case sensitive, so C<MyApp::C::FOO::Bar> becomes
1787 But you can activate case sensitivity with a config parameter.
1789 MyApp->config->{case_sensitive} = 1;
1791 So C<MyApp::C::Foo::Bar> becomes C</Foo/Bar>.
1793 =head1 ON-DEMAND PARSER
1795 The request body is usually parsed at the beginning of a request,
1796 but if you want to handle input yourself or speed things up a bit
1797 you can enable on-demand parsing with a config parameter.
1799 MyApp->config->{parse_on_demand} = 1;
1801 =head1 PROXY SUPPORT
1803 Many production servers operate using the common double-server approach, with
1804 a lightweight frontend web server passing requests to a larger backend
1805 server. An application running on the backend server must deal with two
1806 problems: the remote user always appears to be '127.0.0.1' and the server's
1807 hostname will appear to be 'localhost' regardless of the virtual host the
1808 user connected through.
1810 Catalyst will automatically detect this situation when you are running both
1811 the frontend and backend servers on the same machine. The following changes
1812 are made to the request.
1814 $c->req->address is set to the user's real IP address, as read from the
1815 HTTP_X_FORWARDED_FOR header.
1817 The host value for $c->req->base and $c->req->uri is set to the real host,
1818 as read from the HTTP_X_FORWARDED_HOST header.
1820 Obviously, your web server must support these 2 headers for this to work.
1822 In a more complex server farm environment where you may have your frontend
1823 proxy server(s) on different machines, you will need to set a configuration
1824 option to tell Catalyst to read the proxied data from the headers.
1826 MyApp->config->{using_frontend_proxy} = 1;
1828 If you do not wish to use the proxy support at all, you may set:
1830 MyApp->config->{ignore_frontend_proxy} = 1;
1832 =head1 THREAD SAFETY
1834 Catalyst has been tested under Apache 2's threading mpm_worker, mpm_winnt,
1835 and the standalone forking HTTP server on Windows. We believe the Catalyst
1836 core to be thread-safe.
1838 If you plan to operate in a threaded environment, remember that all other
1839 modules you are using must also be thread-safe. Some modules, most notably
1840 DBD::SQLite, are not thread-safe.
1846 Join #catalyst on irc.perl.org.
1850 http://lists.rawmode.org/mailman/listinfo/catalyst
1851 http://lists.rawmode.org/mailman/listinfo/catalyst-dev
1855 http://catalyst.perl.org
1859 http://dev.catalyst.perl.org
1865 =item L<Catalyst::Manual> - The Catalyst Manual
1867 =item L<Catalyst::Component>, L<Catalyst::Base> - Base classes for components
1869 =item L<Catalyst::Engine> - Core Engine
1871 =item L<Catalyst::Log> - The Log Class.
1873 =item L<Catalyst::Request> - The Request Object
1875 =item L<Catalyst::Response> - The Response Object
1877 =item L<Catalyst::Test> - The test suite.
1947 Sebastian Riedel, C<sri@oook.de>
1951 This library is free software, you can redistribute it and/or modify it under
1952 the same terms as Perl itself.