X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?a=blobdiff_plain;f=lib%2FCatalyst%2FEngine.pm;h=486bbf77485924dcc36fa6450246b9ce3841aa5a;hb=61bacdcc9ec458cabeba0cf4ce0d40cb5eb9b8d4;hp=70d07082991419c5fa39c70349b5b5cef75e8457;hpb=b676386894f30ba0b4c7291d466316454bd46113;p=catagits%2FCatalyst-Runtime.git diff --git a/lib/Catalyst/Engine.pm b/lib/Catalyst/Engine.pm index 70d0708..486bbf7 100644 --- a/lib/Catalyst/Engine.pm +++ b/lib/Catalyst/Engine.pm @@ -2,38 +2,34 @@ package Catalyst::Engine; use strict; use base qw/Class::Data::Inheritable Class::Accessor::Fast/; +use attributes (); 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 Tree::Simple; -use Tree::Simple::Visitor::FindByPath; +use Text::ASCIITable; use Catalyst::Request; +use Catalyst::Request::Upload; use Catalyst::Response; require Module::Pluggable::Fast; +# For pretty dumps $Data::Dumper::Terse = 1; -__PACKAGE__->mk_classdata($_) for qw/actions components tree/; -__PACKAGE__->mk_accessors(qw/request response/); - -__PACKAGE__->actions( - { plain => {}, private => {}, regex => {}, compiled => {}, reverse => {} } -); -__PACKAGE__->tree( Tree::Simple->new( 0, Tree::Simple->ROOT ) ); +__PACKAGE__->mk_classdata('components'); +__PACKAGE__->mk_accessors(qw/request response state/); *comp = \&component; *req = \&request; *res = \&response; +# For statistics our $COUNT = 1; our $START = time; -memoize('_class2prefix'); - =head1 NAME Catalyst::Engine - The Catalyst Engine @@ -48,110 +44,6 @@ See L. =over 4 -=item $c->action( $name => $coderef, ... ) - -Add one or more actions. - - $c->action( '!foo' => sub { $_[1]->res->output('Foo!') } ); - -It also automatically calls setup() if needed. - -See L for more informations about actions. - -=cut - -sub action { - my $self = shift; - $self->setup unless $self->components; - $self->actions( {} ) unless $self->actions; - my $action; - $_[1] ? ( $action = {@_} ) : ( $action = shift ); - if ( ref $action eq 'HASH' ) { - while ( my ( $name, $code ) = each %$action ) { - my $class = caller(0); - if ( $name =~ /^\?(.*)$/ ) { - my $prefix = $1 || ''; - $name = $2; - $name = $prefix . _prefix( $class, $name ); - $self->actions->{plain}->{$name} = [ $class, $code ]; - } - if ( $name =~ /^\/(.*)\/$/ ) { - my $regex = $1; - $self->actions->{compiled}->{qr#$regex#} = $name; - $self->actions->{regex}->{$name} = [ $class, $code ]; - } - elsif ( $name =~ /^\!(.*)$/ ) { - $name = $1; - my $parent = $self->tree; - my $visitor = Tree::Simple::Visitor::FindByPath->new; - for my $part ( split '/', _class2prefix($class) ) { - $visitor->setSearchPath($part); - $parent->accept($visitor); - my $child = $visitor->getResult; - unless ($child) { - $child = $parent->addChild( Tree::Simple->new($part) ); - $visitor->setSearchPath($part); - $parent->accept($visitor); - $child = $visitor->getResult; - } - $parent = $child; - } - my $uid = $parent->getUID; - $self->actions->{private}->{$uid}->{$name} = [ $class, $code ]; - } - else { $self->actions->{plain}->{$name} = [ $class, $code ] } - $self->actions->{reverse}->{"$code"} = $name; - $self->log->debug(qq/"$class" defined "$name" as "$code"/) - if $self->debug; - } - } - return 1; -} - -=item $c->find_action( $name, $namespace ) - -Find an action in a given namespace. - -=cut - -sub find_action { - my ( $c, $action, $namespace ) = @_; - $namespace ||= ''; - if ( $action =~ /^\!(.*)/ ) { - $action = $1; - my $parent = $c->tree; - my $result = $c->actions->{private}->{ $parent->getUID }->{$action}; - my $visitor = Tree::Simple::Visitor::FindByPath->new; - for my $part ( split '/', $namespace ) { - $visitor->setSearchPath($part); - $parent->accept($visitor); - my $child = $visitor->getResult; - my $uid = $child->getUID if $child; - my $match = $c->actions->{private}->{$uid}->{$action} if $uid; - $result = $match if $match; - $parent = $child if $child; - } - return [$result] if $result; - } - elsif ( my $p = $c->actions->{plain}->{$action} ) { return [$p] } - elsif ( my $r = $c->actions->{regex}->{$action} ) { return [$r] } - else { - for my $regex ( keys %{ $c->actions->{compiled} } ) { - my $name = $c->actions->{compiled}->{$regex}; - if ( $action =~ $regex ) { - my @snippets; - for my $i ( 1 .. 9 ) { - no strict 'refs'; - last unless ${$i}; - push @snippets, ${$i}; - } - return [ $c->actions->{regex}->{$name}, $name, \@snippets ]; - } - } - } - return 0; -} - =item $c->benchmark($coderef) Takes a coderef with arguments and returns elapsed time as float. @@ -186,37 +78,81 @@ Regex search for a component. sub component { my ( $c, $name ) = @_; + if ( my $component = $c->components->{$name} ) { return $component; } + else { for my $component ( keys %{ $c->components } ) { return $c->components->{$component} if $component =~ /$name/i; } } + } -=item $c->errors +=item $c->error -=item $c->errors($error, ...) +=item $c->error($error, ...) -=item $c->errors($arrayref) +=item $c->error($arrayref) -Returns an arrayref containing errors messages. +Returns an arrayref containing error messages. - my @errors = @{ $c->errors }; + my @error = @{ $c->error }; Add a new error. - $c->errors('Something bad happened'); + $c->error('Something bad happened'); =cut -sub errors { +sub error { my $c = shift; - my $errors = ref $_[0] eq 'ARRAY' ? $_[0] : [@_]; - push @{ $c->{errors} }, @$errors; - return $c->{errors}; + my $error = ref $_[0] eq 'ARRAY' ? $_[0] : [@_]; + push @{ $c->{error} }, @$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 = $@ ) { + + unless ( ref $error ) { + chomp $error; + $error = qq/Caught exception "$error"/; + } + + $c->log->error($error); + $c->error($error); + $c->state(0); + } + return $c->state; } =item $c->finalize @@ -228,24 +164,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->status(302); + $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; - if ( !$c->res->output || $#{ $c->errors } >= 0 ) { - $c->res->headers->content_type('text/html'); - my $name = $c->config->{name} || 'Catalyst Application'; - my ( $title, $errors, $infos ); - if ( $c->debug ) { - $errors = join '
', @{ $c->errors }; - $errors ||= '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->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
@@ -254,11 +242,11 @@ sub finalize { Stash
$stash
- } - else { - $title = $name; - $errors = ''; - $infos = <<""; + } + else { + $title = $name; + $error = ''; + $infos = <<"";
 (en) Please come back later
 (de) Bitte versuchen sie es spaeter nocheinmal
@@ -270,67 +258,62 @@ sub finalize {
 (it) Ritornato prego piĆ¹ successivamente
 
- $name = ''; - } - $c->res->{output} = <<""; + $name = ''; + } + $c->res->output( <<"" ); - - $title - - - -
-
$errors
-
$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 @@ -349,129 +332,64 @@ Finalize output. sub finalize_output { } -=item $c->forward($command) - -Forward processing to a private/public action or a method from a class. -If you define a class without method it will default to process(). - - $c->forward('!foo'); - $c->forward('index.html'); - $c->forward(qw/MyApp::Model::CDBI::Foo do_stuff/); - $c->forward('MyApp::View::TT'); - -=cut - -sub forward { - my $c = shift; - my $command = shift; - unless ($command) { - $c->log->debug('Nothing to forward to') if $c->debug; - return 0; - } - my $caller = caller(0); - if ( $command =~ /^\?(.*)$/ ) { - $command = $1; - $command = _prefix( $caller, $command ); - } - my $namespace = ''; - if ( $command =~ /^\!/ ) { - $namespace = _class2prefix($caller); - } - my ( $class, $code ); - if ( my $action = $c->find_action( $command, $namespace ) ) { - if ( $action->[2] ) { - $c->log->debug(qq/Couldn't forward "$command" to regex action/) - if $c->debug; - return 0; - } - ( $class, $code ) = @{ $action->[0] }; - } - else { - $class = $command; - if ( $class =~ /[^\w\:]/ ) { - $c->log->debug(qq/Couldn't forward to "$class"/) if $c->debug; - return 0; - } - my $method = shift || 'process'; - if ( $code = $class->can($method) ) { - $c->actions->{reverse}->{"$code"} = "$class->$method"; - } - else { - $c->log->debug(qq/Couldn't forward to "$class->$method"/) - if $c->debug; - return 0; - } - } - $class = $c->components->{$class} || $class; - return $c->process( $class, $code ); -} - -=item $c->handler($r) +=item $c->handler( $class, $r ) Handles the request. =cut sub handler { - my ( $class, $r ) = @_; + 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->find_action($action) ) { - $namespace = _class2prefix( $result->[0]->[0] ); - } - } - if ( my $begin = $c->find_action( '!begin', $namespace ) ) { - $c->process( @{ $begin->[0] } ); - } - if ( my $result = $c->find_action( $action, $namespace ) ) { - $c->process( @{ $result->[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->errors($error); - } - if ( my $end = $c->find_action( '!end', $namespace ) ) { - $c->process( @{ $end->[0] } ); - } + my $c = $class->prepare($engine); + $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', 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( $stat->[0], $stat->[1] ) } + $class->log->info( "Request took $elapsed" . "s ($av/s)", + $t->draw ); } else { $status = &$handler } + }; + if ( my $error = $@ ) { chomp $error; $class->log->error(qq/Caught exception in engine "$error"/); } + $COUNT++; return $status; } =item $c->prepare($r) -Turns the engine-specific request (Apache, CGI...) into a Catalyst context. +Turns the engine-specific request( Apache, CGI ... ) +into a Catalyst context . =cut sub prepare { my ( $class, $r ) = @_; + my $c = bless { request => Catalyst::Request->new( { @@ -486,38 +404,48 @@ sub prepare { response => Catalyst::Response->new( { cookies => {}, headers => HTTP::Headers->new, status => 200 } ), - stash => {} + stash => {}, + state => 0 }, $class; + 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); $c->prepare_path; - $c->prepare_cookies; $c->prepare_headers; + $c->prepare_input; + $c->prepare_cookies; $c->prepare_connection; + my $method = $c->req->method || ''; my $path = $c->req->path || ''; my $hostname = $c->req->hostname || ''; my $address = $c->req->address || ''; $c->log->debug(qq/"$method" request for "$path" from $hostname($address)/) if $c->debug; + $c->prepare_action; $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( $key, $value ); } - $c->log->debug( 'Parameters are "' . join( ' ', @params ) . '"' ); + $c->log->debug( 'Parameters are', $t->draw ); } + $c->prepare_uploads; return $c; } @@ -533,15 +461,17 @@ sub prepare_action { my $path = $c->req->path; my @path = split /\//, $c->req->path; $c->req->args( \my @args ); + while (@path) { $path = join '/', @path; - if ( my $result = $c->find_action($path) ) { + if ( my $result = ${ $c->get_action($path) }[0] ) { # It's a regex 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 ) . '"' ) @@ -549,24 +479,28 @@ sub prepare_action { $c->req->action($match); $c->req->snippets( \@snippets ); } + 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; } unshift @args, pop @path; } + unless ( $c->req->action ) { - $c->req->action('!default'); + $c->req->action('default'); $c->req->match(''); } + $c->log->debug( 'Arguments are "' . join( '/', @args ) . '"' ) if ( $c->debug && @args ); } -=item $c->prepare_connection; +=item $c->prepare_connection Prepare connection. @@ -574,13 +508,19 @@ Prepare connection. sub prepare_connection { } -=item $c->prepare_cookies; +=item $c->prepare_cookies 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 @@ -596,6 +536,14 @@ Prepare parameters. =cut +sub prepare_input { } + +=item $c->prepare_input + +Prepare message body. + +=cut + sub prepare_parameters { } =item $c->prepare_path @@ -622,37 +570,13 @@ Prepare uploads. sub prepare_uploads { } -=item $c->process($class, $coderef) +=item $c->run -Process a coderef in given class and catch exceptions. -Errors are available via $c->errors. +Starts the engine. =cut -sub process { - my ( $c, $class, $code ) = @_; - my $status; - eval { - if ( $c->debug ) - { - my $action = $c->actions->{reverse}->{"$code"} || "$code"; - my $elapsed; - ( $elapsed, $status ) = - $c->benchmark( $code, $class, $c, @{ $c->req->args } ); - $c->log->info( sprintf qq/Processing "$action" took %fs/, $elapsed ) - if $c->debug; - } - else { $status = &$code( $class, $c, @{ $c->req->args } ) } - }; - if ( my $error = $@ ) { - chomp $error; - $error = qq/Caught exception "$error"/; - $c->log->error($error); - $c->errors($error) if $c->debug; - return 0; - } - return $status; -} +sub run { } =item $c->request @@ -710,19 +634,30 @@ sub setup_components { if ( my $error = $@ ) { chomp $error; - $self->log->error( - qq/Couldn't initialize "Module::Pluggable::Fast", "$error"/); + die qq/Couldn't load components "$error"/; } + $self->components( {} ); - for my $component ( $self->_components($self) ) { - $self->components->{ ref $component } = $component; + my @comps; + for my $comp ( $self->_components($self) ) { + $self->components->{ ref $comp } = $comp; + push @comps, $comp; } - $self->log->debug( 'Initialized components "' - . join( ' ', keys %{ $self->components } ) - . '"' ) - if $self->debug; + + my $t = Text::ASCIITable->new( { hide_HeadRow => 1, hide_HeadLine => 1 } ); + $t->setCols('Class'); + $t->setColWidth( 'Class', 75, 1 ); + $t->addRow($_) for keys %{ $self->components }; + $self->log->debug( 'Loaded components', $t->draw ) + if ( @{ $t->{tbl_rows} } && $self->debug ); + + $self->setup_actions( [ $self, @comps ] ); } +=item $c->state + +Contains the return value of the last executed action. + =item $c->stash Returns a hashref containing all your data. @@ -743,20 +678,8 @@ sub stash { return $self->{stash}; } -sub _prefix { - my ( $class, $name ) = @_; - my $prefix = _class2prefix($class); - $name = "$prefix/$name" if $prefix; - return $name; -} - -sub _class2prefix { - my $class = shift; - $class =~ /^.*::([MVC]|Model|View|Controller)+::(.*)$/; - my $prefix = lc $2 || ''; - $prefix =~ s/\:\:/\//g; - return $prefix; -} +# Takes a coderef and returns an arrayref containing attributes +sub _get_attrs { attributes::get( $_[0] ) || [] } =back