X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?p=catagits%2FCatalyst-Runtime.git;a=blobdiff_plain;f=lib%2FCatalyst.pm;h=15b3ea3e0d42f1f5c6ff7b12d4b837a255c16341;hp=243f473af98080c85e60b232b50728a2ea397324;hb=496021a4740bcccf5b630f9fbd6f6bff0882dfc7;hpb=10dd68969b311a61e17dd130373909f2c7aaeb93 diff --git a/lib/Catalyst.pm b/lib/Catalyst.pm index 243f473..15b3ea3 100644 --- a/lib/Catalyst.pm +++ b/lib/Catalyst.pm @@ -1,20 +1,78 @@ package Catalyst; use strict; -use base qw[ Catalyst::Base Catalyst::Setup ]; +use base 'Catalyst::Base'; +use bytes; use UNIVERSAL::require; use Catalyst::Exception; use Catalyst::Log; +use Catalyst::Request; +use Catalyst::Request::Upload; +use Catalyst::Response; use Catalyst::Utils; use NEXT; -use Text::ASCIITable; +use Text::SimpleTable; use Path::Class; -our $CATALYST_SCRIPT_GEN = 4; +use Time::HiRes qw/gettimeofday tv_interval/; +use URI; +use Scalar::Util qw/weaken/; +use attributes; -__PACKAGE__->mk_classdata($_) for qw/arguments dispatcher engine log/; +__PACKAGE__->mk_accessors( + qw/counter request response state action stack namespace/ +); -our $VERSION = '5.24'; -our @ISA; +attributes->import( __PACKAGE__, \&namespace, 'lvalue' ); + +sub depth { scalar @{ shift->stack || [] }; } + +# Laziness++ +*comp = \&component; +*req = \&request; +*res = \&response; + +# For backwards compatibility +*finalize_output = \&finalize_body; + +# For statistics +our $COUNT = 1; +our $START = time; +our $RECURSION = 1000; +our $DETACH = "catalyst_detach\n"; + +require Module::Pluggable::Fast; + +# Helper script generation +our $CATALYST_SCRIPT_GEN = 11; + +__PACKAGE__->mk_classdata($_) + for qw/components arguments dispatcher engine log dispatcher_class + engine_class context_class request_class response_class/; + +__PACKAGE__->dispatcher_class('Catalyst::Dispatcher'); +__PACKAGE__->engine_class('Catalyst::Engine::CGI'); +__PACKAGE__->request_class('Catalyst::Request'); +__PACKAGE__->response_class('Catalyst::Response'); + +our $VERSION = '5.5'; + +sub import { + my ( $class, @arguments ) = @_; + + # We have to limit $class to Catalyst to avoid pushing Catalyst upon every + # callers @ISA. + return unless $class eq 'Catalyst'; + + my $caller = caller(0); + + unless ( $caller->isa('Catalyst') ) { + no strict 'refs'; + push @{"$caller\::ISA"}, $class; + } + + $caller->arguments( [@arguments] ); + $caller->setup_home; +} =head1 NAME @@ -24,43 +82,84 @@ Catalyst - The Elegant MVC Web Application Framework # use the helper to start a new application catalyst.pl MyApp - cd MyApp # add models, views, controllers - script/myapp_create.pl model Something - script/myapp_create.pl view Stuff - script/myapp_create.pl controller Yada + script/myapp_create.pl model Database DBIC dbi:SQLite:/path/to/db + script/myapp_create.pl view TT TT + script/myapp_create.pl controller Search - # built in testserver + # built in testserver -- use -r to restart automatically on changes script/myapp_server.pl - # command line interface + # command line testing interface script/myapp_test.pl /yada + ### in MyApp.pm + use Catalyst qw/-Debug/; # include plugins here as well + + sub foo : Global { # called for /foo, /foo/1, /foo/1/2, etc. + my ( $self, $c, @args ) = @_; # args are qw/1 2/ for /foo/1/2 + $c->stash->{template} = 'foo.tt'; # set the template + # lookup something from db -- stash vars are passed to TT + $c->stash->{data} = + MyApp::Model::Database::Foo->search( { country => $args[0] } ); + if ( $c->req->params->{bar} ) { # access GET or POST parameters + $c->forward( 'bar' ); # process another action + # do something else after forward returns + } + } + + # The foo.tt TT template can use the stash data from the database + [% WHILE (item = data.next) %] + [% item.foo %] + [% END %] + + # called for /bar/of/soap, /bar/of/soap/10, etc. + sub bar : Path('/bar/of/soap') { ... } - use Catalyst; - - use Catalyst qw/My::Module My::OtherModule/; - - use Catalyst '-Debug'; - - use Catalyst qw/-Debug -Engine=CGI/; - - sub default : Private { $_[1]->res->output('Hello') } ); - - sub index : Path('/index.html') { + # called for all actions, from the top-most controller downwards + sub auto : Private { + my ( $self, $c ) = @_; + if ( !$c->user ) { + $c->res->redirect( '/login' ); # require login + return 0; # abort request and go immediately to end() + } + return 1; # success; carry on to next action + } + + # called after all actions are finished + sub end : Private { my ( $self, $c ) = @_; - $c->res->output('Hello'); - $c->forward('foo'); + if ( scalar @{ $c->error } ) { ... } # handle errors + return if $c->res->body; # already have a response + $c->forward( 'MyApp::View::TT' ); # render template } - sub product : Regex('^product[_]*(\d*).html$') { + ### in MyApp/Controller/Foo.pm + # called for /foo/bar + sub bar : Local { ... } + + # called for /blargle + sub blargle : Global { ... } + + # an index action matches /foo, but not /foo/1, etc. + sub index : Private { ... } + + ### in MyApp/Controller/Foo/Bar.pm + # called for /foo/bar/baz + sub baz : Local { ... } + + # first MyApp auto is called, then Foo auto, then this + sub auto : Private { ... } + + # powerful regular expression paths are also possible + sub details : Regex('^product/(\w+)/details$') { my ( $self, $c ) = @_; - $c->stash->{template} = 'product.tt'; - $c->stash->{product} = $c->req->snippets->[0]; + # extract the (\w+) from the URI + my $product = $c->req->snippets->[0]; } -See also L +See L for additional information. =head1 DESCRIPTION @@ -68,19 +167,20 @@ The key concept of Catalyst is DRY (Don't Repeat Yourself). See L for more documentation. -Catalyst plugins can be loaded by naming them as arguments to the "use Catalyst" statement. -Omit the C prefix from the plugin name, -so C becomes C. +Catalyst plugins can be loaded by naming them as arguments to the "use +Catalyst" statement. Omit the C prefix from the +plugin name, i.e., C becomes +C. - use Catalyst 'My::Module'; + use Catalyst qw/My::Module/; -Special flags like -Debug and -Engine can also be specifed as arguments when -Catalyst is loaded: +Special flags like C<-Debug> and C<-Engine> can also be specified as +arguments when Catalyst is loaded: use Catalyst qw/-Debug My::Module/; -The position of plugins and flags in the chain is important, because they are -loaded in exactly the order that they appear. +The position of plugins and flags in the chain is important, because +they are loaded in exactly the order in which they appear. The following flags are supported: @@ -88,79 +188,322 @@ The following flags are supported: =item -Debug -enables debug output, i.e.: +Enables debug output. + +=item -Engine - use Catalyst '-Debug'; +Forces Catalyst to use a specific engine. Omit the +C prefix of the engine name, i.e.: -this is equivalent to: + use Catalyst qw/-Engine=CGI/; - use Catalyst; - sub debug { 1 } +=item -Home -=item -Engine +Forces Catalyst to use a specific home directory, e.g.: -Force Catalyst to use a specific engine. -Omit the C prefix of the engine name, i.e.: + use Catalyst qw[-Home=/usr/sri]; - use Catalyst '-Engine=CGI'; +=item -Log + +Specifies log level. =back =head1 METHODS +=head2 Information about the current request + +=over 4 + +=item $c->action + +Returns a L object for the current action, which +stringifies to the action name. See L. + +=item $c->namespace + +Returns the namespace of the current action, i.e., the uri prefix +corresponding to the controller of the current action. For example: + + # in Controller::Foo::Bar + $c->namespace; # returns 'foo/bar'; + +=item $c->request + +=item $c->req + +Returns the current L object. See +L. + +=back + +=head2 Processing and response to the current request + =over 4 -=item debug +=item $c->forward( $action [, \@arguments ] ) + +=item $c->forward( $class, $method, [, \@arguments ] ) -Overload to enable debug messages. +Forwards processing to a private action. If you give a class name but no +method, C is called. You may also optionally pass arguments +in an arrayref. The action will receive the arguments in C<@_> and +C<$c-Ereq-Eargs>. Upon returning from the function, +C<$c-Ereq-Eargs> will be restored to the previous values. + + $c->forward('/foo'); + $c->forward('index'); + $c->forward(qw/MyApp::Model::CDBI::Foo do_stuff/); + $c->forward('MyApp::View::TT'); =cut -sub debug { 0 } +sub forward { my $c = shift; $c->dispatcher->forward( $c, @_ ) } -=item config +=item $c->detach( $action [, \@arguments ] ) -Returns a hashref containing your applications settings. +=item $c->detach( $class, $method, [, \@arguments ] ) + +The same as C, but doesn't return. =cut -sub import { - my ( $class, @arguments ) = @_; +sub detach { my $c = shift; $c->dispatcher->detach( $c, @_ ) } - my $caller = caller(0); +=item $c->error + +=item $c->error($error, ...) + +=item $c->error($arrayref) + +Returns an arrayref containing error messages. + + my @error = @{ $c->error }; + +Add a new error. + + $c->error('Something bad happened'); + +Clear errors. + + $c->error(0); + +=cut + +sub error { + my $c = shift; + if ( $_[0] ) { + my $error = ref $_[0] eq 'ARRAY' ? $_[0] : [@_]; + push @{ $c->{error} }, @$error; + } + elsif ( defined $_[0] ) { $c->{error} = undef } + return $c->{error} || []; +} + +=item $c->response + +=item $c->res + +Returns the current L object. + +=item $c->stash + +Returns a hashref to the stash, which may be used to store data and pass +it between components during a request. You can also set hash keys by +passing arguments. The stash is automatically sent to the view. The +stash is cleared at the end of a request; it cannot be used for +persistent storage. + + $c->stash->{foo} = $bar; + $c->stash( { moose => 'majestic', qux => 0 } ); + $c->stash( bar => 1, gorch => 2 ); # equivalent to passing a hashref - # Prepare inheritance - unless ( $caller->isa($class) ) { - - no strict 'refs'; - push @{"$caller\::ISA"}, $class; - - *{"$caller\::import"} = sub { 1 }; + # stash is automatically passed to the view for use in a template + $c->forward( 'MyApp::V::TT' ); + +=cut + +sub stash { + my $c = shift; + if (@_) { + my $stash = @_ > 1 ? {@_} : $_[0]; + while ( my ( $key, $val ) = each %$stash ) { + $c->{stash}->{$key} = $val; + } } + return $c->{stash}; +} - $caller->arguments( [ @arguments ] ); - $caller->setup_home; +=item $c->state + +Contains the return value of the last executed action. + +=back + +=head2 Component Accessors + +=over 4 + +=item $c->comp($name) + +=item $c->component($name) + +Gets a component object by name. This method is no longer recommended, +unless you want to get a specific component by full +class. C<$c-Econtroller>, C<$c-Emodel>, and C<$c-Eview> +should be used instead. + +=cut + +sub component { + my $c = shift; + + if (@_) { + + my $name = shift; + + my $appclass = ref $c || $c; + + my @names = ( + $name, "${appclass}::${name}", + map { "${appclass}::${_}::${name}" } + qw/Model M Controller C View V/ + ); + + foreach my $try (@names) { + + if ( exists $c->components->{$try} ) { + + return $c->components->{$try}; + } + } + + foreach my $component ( keys %{ $c->components } ) { + + return $c->components->{$component} if $component =~ /$name/i; + } + + } + + return sort keys %{ $c->components }; +} + +=item $c->controller($name) + +Gets a L instance by name. + + $c->controller('Foo')->do_stuff; + +=cut + +sub controller { + my ( $c, $name ) = @_; + my $controller = $c->comp("Controller::$name"); + return $controller if $controller; + return $c->comp("C::$name"); +} + +=item $c->model($name) + +Gets a L instance by name. + + $c->model('Foo')->do_stuff; + +=cut + +sub model { + my ( $c, $name ) = @_; + my $model = $c->comp("Model::$name"); + return $model if $model; + return $c->comp("M::$name"); +} + +=item $c->view($name) + +Gets a L instance by name. + + $c->view('Foo')->do_stuff; + +=cut + +sub view { + my ( $c, $name ) = @_; + my $view = $c->comp("View::$name"); + return $view if $view; + return $c->comp("V::$name"); } +=back + +=head2 Class data and helper classes + +=over 4 + +=item $c->config + +Returns or takes a hashref containing the application's configuration. + + __PACKAGE__->config({ db => 'dsn:SQLite:foo.db' }); + +=item $c->debug + +Overload to enable debug messages (same as -Debug option). + +=cut + +sub debug { 0 } + +=item $c->dispatcher + +Returns the dispatcher instance. Stringifies to class name. See +L. + =item $c->engine -Contains the engine class. +Returns the engine instance. Stringifies to the class name. See +L. =item $c->log -Contains the logging object. Unless it is already set Catalyst sets this up with a -C object. To use your own log class: +Returns the logging object instance. Unless it is already set, Catalyst +sets this up with a L object. To use your own log class: $c->log( MyLogger->new ); - $c->log->info("now logging with my own logger!"); + $c->log->info( 'Now logging with my own logger!' ); + +Your log class should implement the methods described in the +L man page. + +=cut + +=back + +=head2 Utility methods + +=over 4 -Your log class should implement the methods described in the C -man page. +=item $c->path_to(@path) + +Merges C<@path> with C<$c-Econfig-E{home}> and returns a +L object. + +For example: + + $c->path_to( 'db', 'sqlite.db' ); + +=cut + +sub path_to { + my ( $c, @path ) = @_; + my $path = dir( $c->config->{home}, @path ); + if ( -d $path ) { return $path } + else { return file( $c->config->{home}, @path ) } +} =item $c->plugin( $name, $class, @args ) -Instant plugins for Catalyst. -Classdata accessor/mutator will be created, class loaded and instantiated. +Helper method for plugins. It creates a classdata accessor/mutator and +loads and instantiates the given class. MyApp->plugin( 'prototype', 'HTML::Prototype' ); @@ -174,8 +517,7 @@ sub plugin { if ( my $error = $UNIVERSAL::require::ERROR ) { Catalyst::Exception->throw( - message => qq/Couldn't load instant plugin "$plugin", "$error"/ - ); + message => qq/Couldn't load instant plugin "$plugin", "$error"/ ); } eval { $plugin->import }; @@ -183,10 +525,9 @@ sub plugin { my $obj; eval { $obj = $plugin->new(@args) }; - if ( $@ ) { - Catalyst::Exception->throw( - message => qq/Couldn't instantiate instant plugin "$plugin", "$@"/ - ); + if ($@) { + Catalyst::Exception->throw( message => + qq/Couldn't instantiate instant plugin "$plugin", "$@"/ ); } $class->$name($obj); @@ -194,61 +535,1446 @@ sub plugin { if $class->debug; } -=back +=item MyApp->setup -=head1 LIMITATIONS +Initializes the dispatcher and engine, loads any plugins, and loads the +model, view, and controller components. You may also specify an array +of plugins to load here, if you choose to not load them in the C line. -mod_perl2 support is considered experimental and may contain bugs. + MyApp->setup; + MyApp->setup( qw/-Debug/ ); -=head1 SUPPORT +=cut -IRC: +sub setup { + my ( $class, @arguments ) = @_; - Join #catalyst on irc.perl.org. + unless ( $class->isa('Catalyst') ) { -Mailing-Lists: + Catalyst::Exception->throw( + message => qq/'$class' does not inherit from Catalyst/ ); + } - http://lists.rawmode.org/mailman/listinfo/catalyst - http://lists.rawmode.org/mailman/listinfo/catalyst-dev + if ( $class->arguments ) { + @arguments = ( @arguments, @{ $class->arguments } ); + } -Web: + # Process options + my $flags = {}; + + foreach (@arguments) { + + if (/^-Debug$/) { + $flags->{log} = + ( $flags->{log} ) ? 'debug,' . $flags->{log} : 'debug'; + } + elsif (/^-(\w+)=?(.*)$/) { + $flags->{ lc $1 } = $2; + } + else { + push @{ $flags->{plugins} }, $_; + } + } - http://catalyst.perl.org + $class->setup_log( delete $flags->{log} ); + $class->setup_plugins( delete $flags->{plugins} ); + $class->setup_dispatcher( delete $flags->{dispatcher} ); + $class->setup_engine( delete $flags->{engine} ); + $class->setup_home( delete $flags->{home} ); -=head1 SEE ALSO + for my $flag ( sort keys %{$flags} ) { -=over 4 + if ( my $code = $class->can( 'setup_' . $flag ) ) { + &$code( $class, delete $flags->{$flag} ); + } + else { + $class->log->warn(qq/Unknown flag "$flag"/); + } + } -=item L - The Catalyst Manual + $class->log->warn( + <<"EOF") if ( $ENV{CATALYST_SCRIPT_GEN} && ( $ENV{CATALYST_SCRIPT_GEN} < $Catalyst::CATALYST_SCRIPT_GEN ) ); +You are running an old script! -=item L - Core Engine + Please update by running: + catalyst.pl -nonew -scripts $class +EOF -=item L - The Log Class. + if ( $class->debug ) { -=item L - The Request Object + my @plugins = (); -=item L - The Response Object + { + no strict 'refs'; + @plugins = grep { /^Catalyst::Plugin/ } @{"$class\::ISA"}; + } -=item L - The test suite. + if (@plugins) { + my $t = Text::SimpleTable->new(76); + $t->row($_) for @plugins; + $class->log->debug( "Loaded plugins:\n" . $t->draw ); + } + + my $dispatcher = $class->dispatcher; + my $engine = $class->engine; + my $home = $class->config->{home}; + + $class->log->debug(qq/Loaded dispatcher "$dispatcher"/); + $class->log->debug(qq/Loaded engine "$engine"/); + + $home + ? ( -d $home ) + ? $class->log->debug(qq/Found home "$home"/) + : $class->log->debug(qq/Home "$home" doesn't exist/) + : $class->log->debug(q/Couldn't find home/); + } + + # Call plugins setup + { + no warnings qw/redefine/; + local *setup = sub { }; + $class->setup; + } + + # Initialize our data structure + $class->components( {} ); + + $class->setup_components; + + if ( $class->debug ) { + my $t = Text::SimpleTable->new( [ 65, 'Class' ], [ 8, 'Type' ] ); + for my $comp ( sort keys %{ $class->components } ) { + my $type = ref $class->components->{$comp} ? 'instance' : 'class'; + $t->row( $comp, $type ); + } + $class->log->debug( "Loaded components:\n" . $t->draw ) + if ( keys %{ $class->components } ); + } + + # Add our self to components, since we are also a component + $class->components->{$class} = $class; + + $class->setup_actions; + + if ( $class->debug ) { + my $name = $class->config->{name} || 'Application'; + $class->log->info("$name powered by Catalyst $Catalyst::VERSION"); + } + $class->log->_flush() if $class->log->can('_flush'); +} + +=item $c->uri_for( $path, [ @args ] ) + +Merges path with C<$c-Erequest-Ebase> for absolute uri's and +with C<$c-Erequest-Ematch> for relative uri's, then returns a +normalized L object. If any args are passed, they are added at the +end of the path. + +=cut + +sub uri_for { + my ( $c, $path, @args ) = @_; + my $base = $c->request->base->clone; + my $basepath = $base->path; + $basepath =~ s/\/$//; + $basepath .= '/'; + my $match = $c->request->match; + + # massage match, empty if absolute path + $match =~ s/^\///; + $match .= '/' if $match; + $path ||= ''; + $match = '' if $path =~ /^\//; + $path =~ s/^\///; + + # join args with '/', or a blank string + my $args = ( scalar @args ? '/' . join( '/', @args ) : '' ); + return URI->new_abs( URI->new_abs( "$path$args", "$basepath$match" ), + $base )->canonical; +} + +=item $c->welcome_message + +Returns the Catalyst welcome HTML page. + +=cut + +sub welcome_message { + my $c = shift; + my $name = $c->config->{name}; + my $logo = $c->uri_for('/static/images/catalyst_logo.png'); + my $prefix = Catalyst::Utils::appprefix( ref $c ); + $c->response->content_type('text/html; charset=utf-8'); + return <<"EOF"; + + + + + + $name on Catalyst $VERSION + + + +
+
+

$name on Catalyst + $VERSION

+
+
+

+ Catalyst Logo +

+

Welcome to the wonderful world of Catalyst. + This MVC + framework will make web development something you had + never expected it to be: Fun, rewarding and quick.

+

What to do now?

+

That really depends on what you want to do. + We do, however, provide you with a few starting points.

+

If you want to jump right into web development with Catalyst + you might want to check out the documentation.

+ 
perldoc Catalyst::Manual::Intro
+perldoc Catalyst::Manual
+

What to do next?

+

Next it's time to write an actual application. Use the + helper scripts to generate controllers, + models and + views, + they can save you a lot of work.

+ 
script/${prefix}_create.pl -help
+

Also, be sure to check out the vast and growing + collection of plugins for Catalyst on CPAN, + you are likely to find what you need there. +

+ +

Need help?

+

Catalyst has a very active community. Here are the main places to + get in touch with us.

+ +

In conclusion

+

The Catalyst team hopes you will enjoy using Catalyst as much + as we enjoyed making it. Please contact us if you have ideas + for improvement or other feedback.

+
+
+ + +EOF +} =back -=head1 AUTHOR +=head1 INTERNAL METHODS -Sebastian Riedel, C +These methods are not meant to be used by end users. + +=over 4 + +=item $c->benchmark( $coderef ) + +Takes a coderef with arguments and returns elapsed time as float. + + my ( $elapsed, $status ) = $c->benchmark( sub { return 1 } ); + $c->log->info( sprintf "Processing took %f seconds", $elapsed ); + +=cut + +sub benchmark { + my $c = shift; + my $code = shift; + my $time = [gettimeofday]; + my @return = &$code(@_); + my $elapsed = tv_interval $time; + return wantarray ? ( $elapsed, @return ) : $elapsed; +} + +=item $c->components + +Returns a hash of components. + +=item $c->context_class + +Returns or sets the context class. + +=item $c->counter + +Returns a hashref containing coderefs and execution counts (needed for +deep recursion detection). + +=item $c->depth + +Returns the number of actions on the current internal execution stack. + +=item $c->dispatch + +Dispatches a request to actions. + +=cut + +sub dispatch { my $c = shift; $c->dispatcher->dispatch( $c, @_ ) } -=head1 THANK YOU +=item $c->dispatcher_class -Andy Grundman, Andrew Ford, Andrew Ruthven, Autrijus Tang, Christian Hansen, -Christopher Hicks, Dan Sully, Danijel Milicevic, David Naughton, -Gary Ashton Jones, Geoff Richards, Jesse Sheidlower, Jody Belka, -Johan Lindstrom, Juan Camacho, Leon Brocard, Marcus Ramberg, -Tatsuhiko Miyagawa and all the others who've helped. +Returns or sets the dispatcher class. + +=item $c->dump_these + +Returns a list of 2-element array references (name, structure) pairs +that will be dumped on the error page in debug mode. + +=cut + +sub dump_these { + my $c = shift; + [ Request => $c->req ], [ Response => $c->res ], [ Stash => $c->stash ],; +} + +=item $c->engine_class + +Returns or sets the engine class. + +=item $c->execute( $class, $coderef ) + +Execute a coderef in given class and catch exceptions. Errors are available +via $c->error. + +=cut + +sub execute { + my ( $c, $class, $code ) = @_; + $class = $c->components->{$class} || $class; + $c->state(0); + + my $callsub = + ( caller(0) )[0]->isa('Catalyst::Action') + ? ( caller(2) )[3] + : ( caller(1) )[3]; + + my $action = ''; + if ( $c->debug ) { + $action = "$code"; + $action = "/$action" unless $action =~ /\-\>/; + $c->counter->{"$code"}++; + + if ( $c->counter->{"$code"} > $RECURSION ) { + my $error = qq/Deep recursion detected in "$action"/; + $c->log->error($error); + $c->error($error); + $c->state(0); + return $c->state; + } + + $action = "-> $action" if $callsub =~ /forward$/; + } + push( @{ $c->stack }, $code ); + eval { + if ( $c->debug ) + { + my ( $elapsed, @state ) = + $c->benchmark( $code, $class, $c, @{ $c->req->args } ); + unless ( ( $code->name =~ /^_.*/ ) + && ( !$c->config->{show_internal_actions} ) ) + { + push @{ $c->{stats} }, [ $action, sprintf( '%fs', $elapsed ) ]; + } + $c->state(@state); + } + else { + $c->state( &$code( $class, $c, @{ $c->req->args } ) || 0 ); + } + }; + pop( @{ $c->stack } ); + + if ( my $error = $@ ) { + + if ( $error eq $DETACH ) { die $DETACH if $c->depth > 1 } + else { + unless ( ref $error ) { + chomp $error; + $error = qq/Caught exception "$error"/; + } + $c->error($error); + $c->state(0); + } + } + return $c->state; +} + +=item $c->finalize + +Finalizes the request. + +=cut + +sub finalize { + my $c = shift; + + for my $error ( @{ $c->error } ) { + $c->log->error($error); + } + + $c->finalize_uploads; + + # Error + if ( $#{ $c->error } >= 0 ) { + $c->finalize_error; + } + + $c->finalize_headers; + + # HEAD request + if ( $c->request->method eq 'HEAD' ) { + $c->response->body(''); + } + + $c->finalize_body; + + return $c->response->status; +} + +=item $c->finalize_body + +Finalizes body. + +=cut + +sub finalize_body { my $c = shift; $c->engine->finalize_body( $c, @_ ) } + +=item $c->finalize_cookies + +Finalizes cookies. + +=cut + +sub finalize_cookies { my $c = shift; $c->engine->finalize_cookies( $c, @_ ) } + +=item $c->finalize_error + +Finalizes error. + +=cut + +sub finalize_error { my $c = shift; $c->engine->finalize_error( $c, @_ ) } + +=item $c->finalize_headers + +Finalizes headers. + +=cut + +sub finalize_headers { + my $c = shift; + + # Check if we already finalized headers + return if $c->response->{_finalized_headers}; + + # Handle redirects + if ( my $location = $c->response->redirect ) { + $c->log->debug(qq/Redirecting to "$location"/) if $c->debug; + $c->response->header( Location => $location ); + } + + # Content-Length + if ( $c->response->body && !$c->response->content_length ) { + $c->response->content_length( bytes::length( $c->response->body ) ); + } + + # Errors + if ( $c->response->status =~ /^(1\d\d|[23]04)$/ ) { + $c->response->headers->remove_header("Content-Length"); + $c->response->body(''); + } + + $c->finalize_cookies; + + $c->engine->finalize_headers( $c, @_ ); + + # Done + $c->response->{_finalized_headers} = 1; +} + +=item $c->finalize_output + +An alias for finalize_body. + +=item $c->finalize_read + +Finalizes the input after reading is complete. + +=cut + +sub finalize_read { my $c = shift; $c->engine->finalize_read( $c, @_ ) } + +=item $c->finalize_uploads + +Finalizes uploads. Cleans up any temporary files. + +=cut + +sub finalize_uploads { my $c = shift; $c->engine->finalize_uploads( $c, @_ ) } + +=item $c->get_action( $action, $namespace ) + +Gets an action in a given namespace. + +=cut + +sub get_action { my $c = shift; $c->dispatcher->get_action(@_) } + +=item $c->get_actions( $action, $namespace ) + +Gets all actions of a given name in a namespace and all parent +namespaces. + +=cut + +sub get_actions { my $c = shift; $c->dispatcher->get_actions( $c, @_ ) } + +=item handle_request( $class, @arguments ) + +Called to handle each HTTP request. + +=cut + +sub handle_request { + my ( $class, @arguments ) = @_; + + # Always expect worst case! + my $status = -1; + eval { + my @stats = (); + + my $handler = sub { + my $c = $class->prepare(@arguments); + $c->{stats} = \@stats; + $c->dispatch; + return $c->finalize; + }; + + if ( $class->debug ) { + my $elapsed; + ( $elapsed, $status ) = $class->benchmark($handler); + $elapsed = sprintf '%f', $elapsed; + my $av = sprintf '%.3f', + ( $elapsed == 0 ? '??' : ( 1 / $elapsed ) ); + my $t = Text::SimpleTable->new( [ 64, 'Action' ], [ 9, 'Time' ] ); + + for my $stat (@stats) { $t->row( $stat->[0], $stat->[1] ) } + $class->log->info( + "Request took ${elapsed}s ($av/s)\n" . $t->draw ); + } + else { $status = &$handler } + + }; + + if ( my $error = $@ ) { + chomp $error; + $class->log->error(qq/Caught exception in engine "$error"/); + } + + $COUNT++; + $class->log->_flush() if $class->log->can('_flush'); + return $status; +} + +=item $c->prepare( @arguments ) + +Creates a Catalyst context from an engine-specific request (Apache, CGI, +etc.). + +=cut + +sub prepare { + my ( $class, @arguments ) = @_; + + $class->context_class( ref $class || $class ) unless $class->context_class; + my $c = $class->context_class->new( + { + counter => {}, + stack => [], + request => $class->request_class->new( + { + arguments => [], + body_parameters => {}, + cookies => {}, + headers => HTTP::Headers->new, + parameters => {}, + query_parameters => {}, + secure => 0, + snippets => [], + uploads => {} + } + ), + response => $class->response_class->new( + { + body => '', + cookies => {}, + headers => HTTP::Headers->new(), + status => 200 + } + ), + stash => {}, + state => 0 + } + ); + + # For on-demand data + $c->request->{_context} = $c; + $c->response->{_context} = $c; + weaken( $c->request->{_context} ); + weaken( $c->response->{_context} ); + + if ( $c->debug ) { + my $secs = time - $START || 1; + my $av = sprintf '%.3f', $COUNT / $secs; + $c->log->debug('**********************************'); + $c->log->debug("* Request $COUNT ($av/s) [$$]"); + $c->log->debug('**********************************'); + $c->res->headers->header( 'X-Catalyst' => $Catalyst::VERSION ); + } + + $c->prepare_request(@arguments); + $c->prepare_connection; + $c->prepare_query_parameters; + $c->prepare_headers; + $c->prepare_cookies; + $c->prepare_path; + + # On-demand parsing + $c->prepare_body unless $c->config->{parse_on_demand}; + + my $method = $c->req->method || ''; + my $path = $c->req->path || ''; + my $address = $c->req->address || ''; + + $c->log->debug(qq/"$method" request for "$path" from "$address"/) + if $c->debug; + + $c->prepare_action; + + return $c; +} + +=item $c->prepare_action + +Prepares action. + +=cut + +sub prepare_action { my $c = shift; $c->dispatcher->prepare_action( $c, @_ ) } + +=item $c->prepare_body + +Prepares message body. + +=cut + +sub prepare_body { + my $c = shift; + + # Do we run for the first time? + return if defined $c->request->{_body}; + + # Initialize on-demand data + $c->engine->prepare_body( $c, @_ ); + $c->prepare_parameters; + $c->prepare_uploads; + + if ( $c->debug && keys %{ $c->req->body_parameters } ) { + my $t = Text::SimpleTable->new( [ 37, 'Key' ], [ 36, 'Value' ] ); + for my $key ( sort keys %{ $c->req->body_parameters } ) { + my $param = $c->req->body_parameters->{$key}; + my $value = defined($param) ? $param : ''; + $t->row( $key, + ref $value eq 'ARRAY' ? ( join ', ', @$value ) : $value ); + } + $c->log->debug( "Body Parameters are:\n" . $t->draw ); + } +} + +=item $c->prepare_body_chunk( $chunk ) + +Prepares a chunk of data before sending it to L. + +=cut + +sub prepare_body_chunk { + my $c = shift; + $c->engine->prepare_body_chunk( $c, @_ ); +} + +=item $c->prepare_body_parameters + +Prepares body parameters. + +=cut + +sub prepare_body_parameters { + my $c = shift; + $c->engine->prepare_body_parameters( $c, @_ ); +} + +=item $c->prepare_connection + +Prepares connection. + +=cut + +sub prepare_connection { + my $c = shift; + $c->engine->prepare_connection( $c, @_ ); +} + +=item $c->prepare_cookies + +Prepares cookies. + +=cut + +sub prepare_cookies { my $c = shift; $c->engine->prepare_cookies( $c, @_ ) } + +=item $c->prepare_headers + +Prepares headers. + +=cut + +sub prepare_headers { my $c = shift; $c->engine->prepare_headers( $c, @_ ) } + +=item $c->prepare_parameters + +Prepares parameters. + +=cut + +sub prepare_parameters { + my $c = shift; + $c->prepare_body_parameters; + $c->engine->prepare_parameters( $c, @_ ); +} + +=item $c->prepare_path + +Prepares path and base. + +=cut + +sub prepare_path { my $c = shift; $c->engine->prepare_path( $c, @_ ) } + +=item $c->prepare_query_parameters + +Prepares query parameters. + +=cut + +sub prepare_query_parameters { + my $c = shift; + + $c->engine->prepare_query_parameters( $c, @_ ); + + if ( $c->debug && keys %{ $c->request->query_parameters } ) { + my $t = Text::SimpleTable->new( [ 37, 'Key' ], [ 36, 'Value' ] ); + for my $key ( sort keys %{ $c->req->query_parameters } ) { + my $param = $c->req->query_parameters->{$key}; + my $value = defined($param) ? $param : ''; + $t->row( $key, + ref $value eq 'ARRAY' ? ( join ', ', @$value ) : $value ); + } + $c->log->debug( "Query Parameters are:\n" . $t->draw ); + } +} + +=item $c->prepare_read + +Prepares the input for reading. + +=cut + +sub prepare_read { my $c = shift; $c->engine->prepare_read( $c, @_ ) } + +=item $c->prepare_request + +Prepares the engine request. + +=cut + +sub prepare_request { my $c = shift; $c->engine->prepare_request( $c, @_ ) } + +=item $c->prepare_uploads + +Prepares uploads. + +=cut + +sub prepare_uploads { + my $c = shift; + + $c->engine->prepare_uploads( $c, @_ ); + + if ( $c->debug && keys %{ $c->request->uploads } ) { + my $t = Text::SimpleTable->new( + [ 12, 'Key' ], + [ 28, 'Filename' ], + [ 18, 'Type' ], + [ 9, 'Size' ] + ); + for my $key ( sort keys %{ $c->request->uploads } ) { + my $upload = $c->request->uploads->{$key}; + for my $u ( ref $upload eq 'ARRAY' ? @{$upload} : ($upload) ) { + $t->row( $key, $u->filename, $u->type, $u->size ); + } + } + $c->log->debug( "File Uploads are:\n" . $t->draw ); + } +} + +=item $c->prepare_write + +Prepares the output for writing. + +=cut + +sub prepare_write { my $c = shift; $c->engine->prepare_write( $c, @_ ) } + +=item $c->request_class + +Returns or sets the request class. + +=item $c->response_class + +Returns or sets the response class. + +=item $c->read( [$maxlength] ) + +Reads a chunk of data from the request body. This method is designed to +be used in a while loop, reading C<$maxlength> bytes on every call. +C<$maxlength> defaults to the size of the request if not specified. + +You have to set Cconfig-E{parse_on_demand}> to use this +directly. + +=cut + +sub read { my $c = shift; return $c->engine->read( $c, @_ ) } + +=item $c->run + +Starts the engine. + +=cut + +sub run { my $c = shift; return $c->engine->run( $c, @_ ) } + +=item $c->set_action( $action, $code, $namespace, $attrs ) + +Sets an action in a given namespace. + +=cut + +sub set_action { my $c = shift; $c->dispatcher->set_action( $c, @_ ) } + +=item $c->setup_actions($component) + +Sets up actions for a component. + +=cut + +sub setup_actions { my $c = shift; $c->dispatcher->setup_actions( $c, @_ ) } + +=item $c->setup_components + +Sets up components. + +=cut + +sub setup_components { + my $class = shift; + + my $callback = sub { + my ( $component, $context ) = @_; + + unless ( $component->isa('Catalyst::Component') ) { + return $component; + } + + my $suffix = Catalyst::Utils::class2classsuffix($component); + my $config = $class->config->{$suffix} || {}; + + my $instance; + + eval { $instance = $component->new( $context, $config ); }; + + if ( my $error = $@ ) { + + chomp $error; + + Catalyst::Exception->throw( message => + qq/Couldn't instantiate component "$component", "$error"/ ); + } + + Catalyst::Exception->throw( message => +qq/Couldn't instantiate component "$component", "new() didn't return a object"/ + ) + unless ref $instance; + return $instance; + }; + + eval { + Module::Pluggable::Fast->import( + name => '_catalyst_components', + search => [ + "$class\::Controller", "$class\::C", + "$class\::Model", "$class\::M", + "$class\::View", "$class\::V" + ], + callback => $callback + ); + }; + + if ( my $error = $@ ) { + + chomp $error; + + Catalyst::Exception->throw( + message => qq/Couldn't load components "$error"/ ); + } + + for my $component ( $class->_catalyst_components($class) ) { + $class->components->{ ref $component || $component } = $component; + } +} + +=item $c->setup_dispatcher + +Sets up dispatcher. + +=cut + +sub setup_dispatcher { + my ( $class, $dispatcher ) = @_; + + if ($dispatcher) { + $dispatcher = 'Catalyst::Dispatcher::' . $dispatcher; + } + + if ( $ENV{CATALYST_DISPATCHER} ) { + $dispatcher = 'Catalyst::Dispatcher::' . $ENV{CATALYST_DISPATCHER}; + } + + if ( $ENV{ uc($class) . '_DISPATCHER' } ) { + $dispatcher = + 'Catalyst::Dispatcher::' . $ENV{ uc($class) . '_DISPATCHER' }; + } + + unless ($dispatcher) { + $dispatcher = $class->dispatcher_class; + } + + $dispatcher->require; + + if ($@) { + Catalyst::Exception->throw( + message => qq/Couldn't load dispatcher "$dispatcher", "$@"/ ); + } + + # dispatcher instance + $class->dispatcher( $dispatcher->new ); +} + +=item $c->setup_engine + +Sets up engine. + +=cut + +sub setup_engine { + my ( $class, $engine ) = @_; + + if ($engine) { + $engine = 'Catalyst::Engine::' . $engine; + } + + if ( $ENV{CATALYST_ENGINE} ) { + $engine = 'Catalyst::Engine::' . $ENV{CATALYST_ENGINE}; + } + + if ( $ENV{ uc($class) . '_ENGINE' } ) { + $engine = 'Catalyst::Engine::' . $ENV{ uc($class) . '_ENGINE' }; + } + + if ( !$engine && $ENV{MOD_PERL} ) { + + # create the apache method + { + no strict 'refs'; + *{"$class\::apache"} = sub { shift->engine->apache }; + } + + my ( $software, $version ) = + $ENV{MOD_PERL} =~ /^(\S+)\/(\d+(?:[\.\_]\d+)+)/; + + $version =~ s/_//g; + $version =~ s/(\.[^.]+)\./$1/g; + + if ( $software eq 'mod_perl' ) { + + if ( $version >= 1.99922 ) { + $engine = 'Catalyst::Engine::Apache2::MP20'; + } + + elsif ( $version >= 1.9901 ) { + $engine = 'Catalyst::Engine::Apache2::MP19'; + } + + elsif ( $version >= 1.24 ) { + $engine = 'Catalyst::Engine::Apache::MP13'; + } + + else { + Catalyst::Exception->throw( message => + qq/Unsupported mod_perl version: $ENV{MOD_PERL}/ ); + } + + # install the correct mod_perl handler + if ( $version >= 1.9901 ) { + *handler = sub : method { + shift->handle_request(@_); + }; + } + else { + *handler = sub ($$) { shift->handle_request(@_) }; + } + + } + + elsif ( $software eq 'Zeus-Perl' ) { + $engine = 'Catalyst::Engine::Zeus'; + } + + else { + Catalyst::Exception->throw( + message => qq/Unsupported mod_perl: $ENV{MOD_PERL}/ ); + } + } + + unless ($engine) { + $engine = $class->engine_class; + } + + $engine->require; + + if ($@) { + Catalyst::Exception->throw( message => +qq/Couldn't load engine "$engine" (maybe you forgot to install it?), "$@"/ + ); + } + + # check for old engines that are no longer compatible + my $old_engine; + if ( $engine->isa('Catalyst::Engine::Apache') + && !Catalyst::Engine::Apache->VERSION ) + { + $old_engine = 1; + } + + elsif ( $engine->isa('Catalyst::Engine::Server::Base') + && Catalyst::Engine::Server->VERSION le '0.02' ) + { + $old_engine = 1; + } + + elsif ($engine->isa('Catalyst::Engine::HTTP::POE') + && $engine->VERSION eq '0.01' ) + { + $old_engine = 1; + } + + elsif ($engine->isa('Catalyst::Engine::Zeus') + && $engine->VERSION eq '0.01' ) + { + $old_engine = 1; + } + + if ($old_engine) { + Catalyst::Exception->throw( message => + qq/Engine "$engine" is not supported by this version of Catalyst/ + ); + } + + # engine instance + $class->engine( $engine->new ); +} + +=item $c->setup_home + +Sets up the home directory. + +=cut + +sub setup_home { + my ( $class, $home ) = @_; + + if ( $ENV{CATALYST_HOME} ) { + $home = $ENV{CATALYST_HOME}; + } + + if ( $ENV{ uc($class) . '_HOME' } ) { + $home = $ENV{ uc($class) . '_HOME' }; + } + + unless ($home) { + $home = Catalyst::Utils::home($class); + } + + if ($home) { + $class->config->{home} ||= $home; + $class->config->{root} ||= dir($home)->subdir('root'); + } +} + +=item $c->setup_log + +Sets up log. + +=cut + +sub setup_log { + my ( $class, $debug ) = @_; + + unless ( $class->log ) { + $class->log( Catalyst::Log->new ); + } + + my $app_flag = Catalyst::Utils::class2env($class) . '_DEBUG'; + + if ( + ( defined( $ENV{CATALYST_DEBUG} ) || defined( $ENV{$app_flag} ) ) + ? ( $ENV{CATALYST_DEBUG} || $ENV{$app_flag} ) + : $debug + ) + { + no strict 'refs'; + *{"$class\::debug"} = sub { 1 }; + $class->log->debug('Debug messages enabled'); + } +} + +=item $c->setup_plugins + +Sets up plugins. + +=cut + +sub setup_plugins { + my ( $class, $plugins ) = @_; + + $plugins ||= []; + for my $plugin ( reverse @$plugins ) { + + $plugin = "Catalyst::Plugin::$plugin"; + + $plugin->require; + + if ($@) { + Catalyst::Exception->throw( + message => qq/Couldn't load plugin "$plugin", "$@"/ ); + } + + { + no strict 'refs'; + unshift @{"$class\::ISA"}, $plugin; + } + } +} + +=item $c->stack + +Returns the stack. + +=item $c->write( $data ) + +Writes $data to the output stream. When using this method directly, you +will need to manually set the C header to the length of +your output data, if known. + +=cut + +sub write { + my $c = shift; + + # Finalize headers if someone manually writes output + $c->finalize_headers; + + return $c->engine->write( $c, @_ ); +} + +=item version + +Returns the Catalyst version number. Mostly useful for "powered by" +messages in template systems. + +=cut + +sub version { return $Catalyst::VERSION } + +=back + +=head1 INTERNAL ACTIONS + +Catalyst uses internal actions like C<_DISPATCH>, C<_BEGIN>, C<_AUTO>, +C<_ACTION>, and C<_END>. These are by default not shown in the private +action table, but you can make them visible with a config parameter. + + MyApp->config->{show_internal_actions} = 1; + +=head1 CASE SENSITIVITY + +By default Catalyst is not case sensitive, so C is +mapped to C. You can activate case sensitivity with a config +parameter. + + MyApp->config->{case_sensitive} = 1; + +This causes C to map to C. + +=head1 ON-DEMAND PARSER + +The request body is usually parsed at the beginning of a request, +but if you want to handle input yourself or speed things up a bit, +you can enable on-demand parsing with a config parameter. + + MyApp->config->{parse_on_demand} = 1; + +=head1 PROXY SUPPORT + +Many production servers operate using the common double-server approach, +with a lightweight frontend web server passing requests to a larger +backend server. An application running on the backend server must deal +with two problems: the remote user always appears to be C<127.0.0.1> and +the server's hostname will appear to be C regardless of the +virtual host that the user connected through. + +Catalyst will automatically detect this situation when you are running +the frontend and backend servers on the same machine. The following +changes are made to the request. + + $c->req->address is set to the user's real IP address, as read from + the HTTP X-Forwarded-For header. + + The host value for $c->req->base and $c->req->uri is set to the real + host, as read from the HTTP X-Forwarded-Host header. + +Obviously, your web server must support these headers for this to work. + +In a more complex server farm environment where you may have your +frontend proxy server(s) on different machines, you will need to set a +configuration option to tell Catalyst to read the proxied data from the +headers. + + MyApp->config->{using_frontend_proxy} = 1; + +If you do not wish to use the proxy support at all, you may set: + + MyApp->config->{ignore_frontend_proxy} = 1; + +=head1 THREAD SAFETY + +Catalyst has been tested under Apache 2's threading mpm_worker, mpm_winnt, +and the standalone forking HTTP server on Windows. We believe the Catalyst +core to be thread-safe. + +If you plan to operate in a threaded environment, remember that all other +modules you are using must also be thread-safe. Some modules, most notably +L, are not thread-safe. + +=head1 SUPPORT + +IRC: + + Join #catalyst on irc.perl.org. + +Mailing Lists: + + http://lists.rawmode.org/mailman/listinfo/catalyst + http://lists.rawmode.org/mailman/listinfo/catalyst-dev + +Web: + + http://catalyst.perl.org + +Wiki: + + http://dev.catalyst.perl.org + +=head1 SEE ALSO + +=over 4 + +=item L - The Catalyst Manual + +=item L, L - Base classes for components + +=item L - Core engine + +=item L - Log class. + +=item L - Request object + +=item L - Response object + +=item L - The test suite. + +=back + +=head1 CREDITS + +Andy Grundman + +Andy Wardley + +Andreas Marienborg + +Andrew Bramble + +Andrew Ford + +Andrew Ruthven + +Arthur Bergman + +Autrijus Tang + +Brian Cassidy + +Christian Hansen + +Christopher Hicks + +Dan Sully + +Danijel Milicevic + +David Kamholz + +David Naughton + +Gary Ashton Jones + +Geoff Richards + +Jesse Sheidlower + +Jesse Vincent + +Jody Belka + +Johan Lindstrom + +Juan Camacho + +Leon Brocard + +Marcus Ramberg + +Matt S Trout + +Robert Sedlacek + +Sam Vilain + +Sascha Kiefer + +Tatsuhiko Miyagawa + +Ulf Edvinsson + +Yuval Kogman + +=head1 AUTHOR + +Sebastian Riedel, C =head1 LICENSE -This library is free software . You can redistribute it and/or modify it under -the same terms as perl itself. +This library is free software, you can redistribute it and/or modify it under +the same terms as Perl itself. =cut