X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?a=blobdiff_plain;f=lib%2FCatalyst%2FEngine.pm;h=41a5049c96928f55cd1c7aa815386c2dce7c917f;hb=a135d186f7acefbbab74e8e6d9a43ccd3560d326;hp=21e0da241082ac5c189a16b7f6cf32fa33af9445;hpb=4cf083b156927d49297b5687ff002364203c1be5;p=catagits%2FCatalyst-Runtime.git diff --git a/lib/Catalyst/Engine.pm b/lib/Catalyst/Engine.pm index 21e0da2..41a5049 100644 --- a/lib/Catalyst/Engine.pm +++ b/lib/Catalyst/Engine.pm @@ -3,11 +3,14 @@ package Catalyst::Engine; use strict; use base qw/Class::Data::Inheritable Class::Accessor::Fast/; use UNIVERSAL::require; +use CGI::Cookie; use Data::Dumper; use HTML::Entities; use HTTP::Headers; use Memoize; use Time::HiRes qw/gettimeofday tv_interval/; +use Text::ASCIITable; +use Text::ASCIITable::Wrap 'wrap'; use Tree::Simple; use Tree::Simple::Visitor::FindByPath; use Catalyst::Request; @@ -92,6 +95,50 @@ sub component { } } +=item $c->dispatch + +Dispatch request to actions. + +=cut + +sub dispatch { + my $c = shift; + my $action = $c->req->action; + my $namespace = ''; + $namespace = ( join( '/', @{ $c->req->args } ) || '/' ) + if $action eq 'default'; + unless ($namespace) { + if ( my $result = $c->get_action($action) ) { + $namespace = _class2prefix( $result->[0]->[0]->[0] ); + } + } + my $default = $action eq 'default' ? $namespace : undef; + my $results = $c->get_action( $action, $default ); + $namespace ||= '/'; + if ( @{$results} ) { + for my $begin ( @{ $c->get_action( 'begin', $namespace ) } ) { + $c->execute( @{ $begin->[0] } ); + } + if ( my $action = $c->req->action ) { + for my $result ( @{ $c->get_action( $action, $default ) }[-1] ) { + $c->execute( @{ $result->[0] } ); + last unless $default; + } + } + for my $end ( reverse @{ $c->get_action( 'end', $namespace ) } ) { + $c->execute( @{ $end->[0] } ); + } + } + else { + my $path = $c->req->path; + my $error = $path + ? qq/Unknown resource "$path"/ + : "No default action defined"; + $c->log->error($error) if $c->debug; + $c->error($error); + } +} + =item $c->error =item $c->error($error, ...) @@ -115,6 +162,41 @@ sub error { return $c->{error}; } +=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->comp($class) || $class; + $c->state(0); + my $callsub = ( caller(1) )[3]; + eval { + if ( $c->debug ) + { + my $action = $c->actions->{reverse}->{"$code"}; + $action = "/$action" unless $action =~ /\-\>/; + $action = "-> $action" if $callsub =~ /forward$/; + my ( $elapsed, @state ) = + $c->benchmark( $code, $class, $c, @{ $c->req->args } ); + push @{ $c->{stats} }, [ $action, sprintf( '%fs', $elapsed ) ]; + $c->state(@state); + } + else { $c->state( &$code( $class, $c, @{ $c->req->args } ) ) } + }; + if ( my $error = $@ ) { + chomp $error; + $error = qq/Caught exception "$error"/; + $c->log->error($error); + $c->error($error) if $c->debug; + $c->state(0); + } + return $c->state; +} + =item $c->finalize Finalize request. @@ -124,26 +206,76 @@ Finalize request. sub finalize { my $c = shift; - if ( my $location = $c->res->redirect ) { + $c->finalize_cookies; + + if ( my $location = $c->response->redirect ) { $c->log->debug(qq/Redirecting to "$location"/) if $c->debug; - $c->res->headers->header( Location => $location ); - $c->res->headers->remove_content_headers; - $c->res->status(302); - return $c->finalize_headers; - } - - if ( !$c->res->output || $#{ $c->error } >= 0 ) { - $c->res->headers->content_type('text/html'); - my $name = $c->config->{name} || 'Catalyst Application'; - my ( $title, $error, $infos ); - if ( $c->debug ) { - $error = join '
', @{ $c->error }; - $error ||= 'No output'; - $title = $name = "$name on Catalyst $Catalyst::VERSION"; - my $req = encode_entities Dumper $c->req; - my $res = encode_entities Dumper $c->res; - my $stash = encode_entities Dumper $c->stash; - $infos = <<""; + $c->response->header( Location => $location ); + $c->response->status(302) if $c->response->status !~ /3\d\d$/; + } + + if ( $#{ $c->error } >= 0 ) { + $c->finalize_error; + } + + if ( !$c->response->output && $c->response->status !~ /^(1|3)\d\d$/ ) { + $c->finalize_error; + } + + if ( $c->response->output && !$c->response->content_length ) { + use bytes; # play safe with a utf8 aware perl + $c->response->content_length( length $c->response->output ); + } + + my $status = $c->finalize_headers; + $c->finalize_output; + return $status; +} + +=item $c->finalize_cookies + +Finalize cookies. + +=cut + +sub finalize_cookies { + my $c = shift; + + while ( my ( $name, $cookie ) = each %{ $c->response->cookies } ) { + my $cookie = CGI::Cookie->new( + -name => $name, + -value => $cookie->{value}, + -expires => $cookie->{expires}, + -domain => $cookie->{domain}, + -path => $cookie->{path}, + -secure => $cookie->{secure} || 0 + ); + + $c->res->headers->push_header( 'Set-Cookie' => $cookie->as_string ); + } +} + +=item $c->finalize_error + +Finalize error. + +=cut + +sub finalize_error { + my $c = shift; + + $c->res->headers->content_type('text/html'); + my $name = $c->config->{name} || 'Catalyst Application'; + + my ( $title, $error, $infos ); + if ( $c->debug ) { + $error = join '
', @{ $c->error }; + $error ||= 'No output'; + $title = $name = "$name on Catalyst $Catalyst::VERSION"; + my $req = encode_entities Dumper $c->req; + my $res = encode_entities Dumper $c->res; + my $stash = encode_entities Dumper $c->stash; + $infos = <<"";
Request
$req
@@ -152,11 +284,11 @@ sub finalize { Stash
$stash
- } - else { - $title = $name; - $error = ''; - $infos = <<""; + } + else { + $title = $name; + $error = ''; + $infos = <<"";
 (en) Please come back later
 (de) Bitte versuchen sie es spaeter nocheinmal
@@ -168,67 +300,62 @@ sub finalize {
 (it) Ritornato prego piĆ¹ successivamente
 
- $name = ''; - } - $c->res->{output} = <<""; + $name = ''; + } + $c->res->output( <<"" ); - - $title - - - -
-
$error
-
$infos
-
$name
-
- + + $title + + + +
+
$error
+
$infos
+
$name
+
+ - } - $c->res->headers->content_length( length $c->res->output ); - my $status = $c->finalize_headers; - $c->finalize_output; - return $status; } =item $c->finalize_headers @@ -293,7 +420,7 @@ sub forward { } } for my $result ( @{$results} ) { - $c->state( $c->execute( @{ $result->[0] } ) ); + $c->execute( @{ $result->[0] } ); } return $c->state; } @@ -306,6 +433,7 @@ Get an action in a given namespace. sub get_action { my ( $c, $action, $namespace ) = @_; + return [] unless $action; $namespace ||= ''; if ($namespace) { $namespace = '' if $namespace eq '/'; @@ -351,48 +479,17 @@ Handles the request. =cut -sub handler ($$) { - my ( $class, $r ) = @_; +sub handler { + my ( $class, $engine ) = @_; # Always expect worst case! my $status = -1; eval { + my @stats = (); my $handler = sub { - my $c = $class->prepare($r); - my $action = $c->req->action; - my $namespace = ''; - $namespace = ( join( '/', @{ $c->req->args } ) || '/' ) - if $action eq 'default'; - unless ($namespace) { - if ( my $result = $c->get_action($action) ) { - $namespace = _class2prefix( $result->[0]->[0]->[0] ); - } - } - my $default = $action eq 'default' ? $namespace : undef; - my $results = $c->get_action( $action, $default ); - $namespace ||= '/'; - if ( @{$results} ) { - for my $begin ( @{ $c->get_action( 'begin', $namespace ) } ) { - $c->state( $c->execute( @{ $begin->[0] } ) ); - } - for my $result ( @{ $c->get_action( $action, $default ) }[-1] ) - { - $c->state( $c->execute( @{ $result->[0] } ) ); - last unless $default; - } - for my $end ( reverse @{ $c->get_action( 'end', $namespace ) } ) - { - $c->state( $c->execute( @{ $end->[0] } ) ); - } - } - else { - my $path = $c->req->path; - my $error = $path - ? qq/Unknown resource "$path"/ - : "No default action defined"; - $c->log->error($error) if $c->debug; - $c->error($error); - } + my $c = $class->prepare($engine); + $c->{stats} = \@stats; + $c->dispatch; return $c->finalize; }; if ( $class->debug ) { @@ -400,7 +497,16 @@ sub handler ($$) { ( $elapsed, $status ) = $class->benchmark($handler); $elapsed = sprintf '%f', $elapsed; my $av = sprintf '%.3f', 1 / $elapsed; - $class->log->info( "Request took $elapsed" . "s ($av/s)" ); + my $t = Text::ASCIITable->new; + $t->setCols( 'Action', 'Time' ); + $t->setColWidth( 'Action', 64, 1 ); + $t->setColWidth( 'Time', 9, 1 ); + + for my $stat (@stats) { + $t->addRow( wrap( $stat->[0], 64 ), wrap( $stat->[1], 9 ) ); + } + $class->log->info( "Request took $elapsed" . "s ($av/s)", + $t->draw ); } else { $status = &$handler } }; @@ -441,9 +547,9 @@ sub prepare { if ( $c->debug ) { my $secs = time - $START || 1; my $av = sprintf '%.3f', $COUNT / $secs; - $c->log->debug('********************************'); + $c->log->debug('**********************************'); $c->log->debug("* Request $COUNT ($av/s) [$$]"); - $c->log->debug('********************************'); + $c->log->debug('**********************************'); $c->res->headers->header( 'X-Catalyst' => $Catalyst::VERSION ); } $c->prepare_request($r); @@ -461,12 +567,15 @@ sub prepare { $c->prepare_parameters; if ( $c->debug && keys %{ $c->req->params } ) { - my @params; + my $t = Text::ASCIITable->new; + $t->setCols( 'Key', 'Value' ); + $t->setColWidth( 'Key', 37, 1 ); + $t->setColWidth( 'Value', 36, 1 ); for my $key ( keys %{ $c->req->params } ) { my $value = $c->req->params->{$key} || ''; - push @params, "$key=$value"; + $t->addRow( wrap( $key, 37 ), wrap( $value, 36 ) ); } - $c->log->debug( 'Parameters are', @params ); + $c->log->debug( 'Parameters are', $t->draw ); } $c->prepare_uploads; return $c; @@ -491,7 +600,8 @@ sub prepare_action { if ($#$result) { my $match = $result->[1]; my @snippets = @{ $result->[2] }; - $c->log->debug(qq/Requested action "$path" matched "$match"/) + $c->log->debug( + qq/Requested action is "$path" and matched "$match"/) if $c->debug; $c->log->debug( 'Snippets are "' . join( ' ', @snippets ) . '"' ) @@ -501,7 +611,7 @@ sub prepare_action { } else { $c->req->action($path); - $c->log->debug(qq/Requested action "$path"/) if $c->debug; + $c->log->debug(qq/Requested action is "$path"/) if $c->debug; } $c->req->match($path); last; @@ -530,7 +640,13 @@ Prepare cookies. =cut -sub prepare_cookies { } +sub prepare_cookies { + my $c = shift; + + if ( my $header = $c->request->header('Cookie') ) { + $c->req->cookies( { CGI::Cookie->parse($header) } ); + } +} =item $c->prepare_headers @@ -572,39 +688,6 @@ Prepare uploads. sub prepare_uploads { } -=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->comp($class) || $class; - $c->state(0); - eval { - if ( $c->debug ) - { - my $action = $c->actions->{reverse}->{"$code"} || "$code"; - my ( $elapsed, @state ) = - $c->benchmark( $code, $class, $c, @{ $c->req->args } ); - $c->log->info( sprintf qq/Processing "$action" took %fs/, $elapsed ) - if $c->debug; - $c->state(@state); - } - else { $c->state( &$code( $class, $c, @{ $c->req->args } ) ) } - }; - if ( my $error = $@ ) { - chomp $error; - $error = qq/Caught exception "$error"/; - $c->log->error($error); - $c->error($error) if $c->debug; - $c->state(0); - } - return $c->state; -} - =item $c->run Starts the engine. @@ -682,7 +765,7 @@ sub set_action { if ( $flags{regex} =~ /^"(.*)"$/ ) { $flags{regex} = $1 } } - my $reverse = $prefix ? "$method ($prefix)" : $method; + my $reverse = $prefix ? "$prefix/$method" : $method; if ( $flags{local} || $flags{global} || $flags{path} ) { my $path = $flags{path} || $method; @@ -787,39 +870,65 @@ sub setup_components { $self->components->{ ref $comp } = $comp; $self->setup_actions($comp); } - my @comps = keys %{ $self->components }; - $self->log->debug( 'Loaded components', @comps ) - if ( @comps && $self->debug ); + my $t = Text::ASCIITable->new( { hide_HeadRow => 1, hide_HeadLine => 1 } ); + $t->setCols('Class'); + $t->setColWidth( 'Class', 75, 1 ); + $t->addRow( wrap( $_, 75 ) ) for keys %{ $self->components }; + $self->log->debug( 'Loaded components', $t->draw ) + if ( @{ $t->{tbl_rows} } && $self->debug ); my $actions = $self->actions; - my @messages = ('Loaded private actions'); - my $walker = sub { - my ( $walker, $parent, $messages, $prefix ) = @_; + my $privates = Text::ASCIITable->new; + $privates->setCols( 'Private', 'Class', 'Code' ); + $privates->setColWidth( 'Private', 28, 1 ); + $privates->setColWidth( 'Class', 28, 1 ); + $privates->setColWidth( 'Code', 14, 1 ); + my $walker = sub { + my ( $walker, $parent, $prefix ) = @_; $prefix .= $parent->getNodeValue || ''; $prefix .= '/' unless $prefix =~ /\/$/; my $uid = $parent->getUID; for my $action ( keys %{ $actions->{private}->{$uid} } ) { my ( $class, $code ) = @{ $actions->{private}->{$uid}->{$action} }; - push @$messages, qq/"$prefix$action" in "$class" as "$code"/; + $privates->addRow( + wrap( "$prefix$action", 28 ), + wrap( $class, 28 ), + wrap( $code, 14 ) + ); } - $walker->( $walker, $_, $messages, $prefix ) - for $parent->getAllChildren; + $walker->( $walker, $_, $prefix ) for $parent->getAllChildren; }; - $walker->( $walker, $self->tree, \@messages, '' ); - $self->log->debug(@messages) if ( $#messages && $self->debug ); - @messages = ('Loaded plain actions'); - for my $plain ( keys %{ $actions->{plain} } ) { + $walker->( $walker, $self->tree, '' ); + $self->log->debug( 'Loaded private actions', $privates->draw ) + if ( @{ $privates->{tbl_rows} } && $self->debug ); + my $publics = Text::ASCIITable->new; + $publics->setCols( 'Public', 'Private' ); + $publics->setColWidth( 'Public', 37, 1 ); + $publics->setColWidth( 'Private', 36, 1 ); + + for my $plain ( sort keys %{ $actions->{plain} } ) { my ( $class, $code ) = @{ $actions->{plain}->{$plain} }; - push @messages, qq|"/$plain" in "$class" as "$code"|; + $publics->addRow( wrap( "/$plain", 37 ), + wrap( $self->actions->{reverse}->{$code} || $code, 36 ) ); } - $self->log->debug(@messages) if ( $#messages && $self->debug ); - @messages = ('Loaded regex actions'); - for my $regex ( keys %{ $actions->{regex} } ) { + $self->log->debug( 'Loaded public actions', $publics->draw ) + if ( @{ $publics->{tbl_rows} } && $self->debug ); + my $regexes = Text::ASCIITable->new; + $regexes->setCols( 'Regex', 'Private' ); + $regexes->setColWidth( 'Regex', 37, 1 ); + $regexes->setColWidth( 'Private', 36, 1 ); + for my $regex ( sort keys %{ $actions->{regex} } ) { my ( $class, $code ) = @{ $actions->{regex}->{$regex} }; - push @messages, qq|"$regex" in "$class" as "$code"|; + $regexes->addRow( wrap( $regex, 37 ), + wrap( $self->actions->{reverse}->{$class} || $class, 36 ) ); } - $self->log->debug(@messages) if ( $#messages && $self->debug ); + $self->log->debug( 'Loaded regex actions', $regexes->draw ) + if ( @{ $regexes->{tbl_rows} } && $self->debug ); } +=item $c->state + +Contains the return value of the last executed action. + =item $c->stash Returns a hashref containing all your data.