X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?a=blobdiff_plain;f=lib%2FCatalyst%2FEngine.pm;h=d8d47b51d40be920f379ce2b406ddd687be48c3a;hb=72596f03a20aff3156e410d35e267ec90ee2b849;hp=efdc18d1a64e989eb57371bdaa821ff46f373b6c;hpb=66d9e175a28989d4454714edf2cc2dab5ad64d96;p=catagits%2FCatalyst-Runtime.git diff --git a/lib/Catalyst/Engine.pm b/lib/Catalyst/Engine.pm index efdc18d..d8d47b5 100644 --- a/lib/Catalyst/Engine.pm +++ b/lib/Catalyst/Engine.pm @@ -3,6 +3,7 @@ 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; @@ -21,7 +22,7 @@ __PACKAGE__->mk_classdata($_) for qw/actions components tree/; __PACKAGE__->mk_accessors(qw/request response state/); __PACKAGE__->actions( - { plain => {}, private => {}, regex => {}, compiled => {}, reverse => {} } + { plain => {}, private => {}, regex => {}, compiled => [], reverse => {} } ); __PACKAGE__->tree( Tree::Simple->new( 0, Tree::Simple->ROOT ) ); @@ -48,32 +49,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 ) { - $self->set_action( $name, $code, caller(0) ); - } - } - return 1; -} - =item $c->benchmark($coderef) Takes a coderef with arguments and returns elapsed time as float. @@ -118,27 +93,63 @@ sub component { } } -=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} }, + _prettify_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 @@ -150,24 +161,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); - } - - 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->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
@@ -176,11 +239,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
@@ -192,67 +255,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 @@ -273,11 +331,11 @@ sub finalize_output { } =item $c->forward($command) -Forward processing to a private/public action or a method from a class. +Forward processing to a private 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('/foo'); + $c->forward('index'); $c->forward(qw/MyApp::Model::CDBI::Foo do_stuff/); $c->forward('MyApp::View::TT'); @@ -290,36 +348,16 @@ sub forward { $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 $caller = caller(0); + my $namespace = '/'; + if ( $command =~ /^\// ) { + $command =~ /^(.*)\/(\w+)$/; + $namespace = $1 || '/'; + $command = $2; } + else { $namespace = _class2prefix($caller) || '/' } my $results = $c->get_action( $command, $namespace ); - if ( @{$results} ) { - if ( $command =~ /^\!/ ) { - for my $result ( @{$results} ) { - my ( $class, $code ) = @{ $result->[0] }; - $c->state( $c->process( $class, $code ) ); - } - } - else { - return 0 unless my $result = $results->[0]; - if ( $result->[2] ) { - $c->log->debug(qq/Couldn't forward "$command" to regex action/) - if $c->debug; - return 0; - } - my ( $class, $code ) = @{ $result->[0] }; - $class = $c->components->{$class} || $class; - $c->state( $c->process( $class, $code ) ); - } - } - else { + unless ( @{$results} ) { my $class = $command; if ( $class =~ /[^\w\:]/ ) { $c->log->debug(qq/Couldn't forward to "$class"/) if $c->debug; @@ -328,8 +366,7 @@ sub forward { my $method = shift || 'process'; if ( my $code = $class->can($method) ) { $c->actions->{reverse}->{"$code"} = "$class->$method"; - $class = $c->comp($class) || $class; - $c->state( $c->process( $class, $code ) ); + $results = [ [ [ $class, $code ] ] ]; } else { $c->log->debug(qq/Couldn't forward to "$class->$method"/) @@ -337,6 +374,9 @@ sub forward { return 0; } } + for my $result ( @{$results} ) { + $c->state( $c->execute( @{ $result->[0] } ) ); + } return $c->state; } @@ -349,8 +389,8 @@ Get an action in a given namespace. sub get_action { my ( $c, $action, $namespace ) = @_; $namespace ||= ''; - if ( $action =~ /^\!(.*)/ ) { - $action = $1; + if ($namespace) { + $namespace = '' if $namespace eq '/'; my $parent = $c->tree; my @results; my $result = $c->actions->{private}->{ $parent->getUID }->{$action}; @@ -370,8 +410,9 @@ sub get_action { 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}; + for my $i ( 0 .. $#{ $c->actions->{compiled} } ) { + my $name = $c->actions->{compiled}->[$i]->[0]; + my $regex = $c->actions->{compiled}->[$i]->[1]; if ( $action =~ $regex ) { my @snippets; for my $i ( 1 .. 9 ) { @@ -386,38 +427,46 @@ sub get_action { return []; } -=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 $c = $class->prepare($engine); + $c->{stats} = \@stats; my $action = $c->req->action; my $namespace = ''; - $namespace = join '/', @{ $c->req->args } if $action eq '!default'; + $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 $results = $c->get_action( $action, $namespace ); + 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->process( @{ $begin->[0] } ) ); + for my $begin ( @{ $c->get_action( 'begin', $namespace ) } ) { + $c->state( $c->execute( @{ $begin->[0] } ) ); } - for my $result ( @{ $c->get_action( $action, $namespace ) } ) { - $c->state( $c->process( @{ $result->[0] } ) ); + for my $result ( @{ $c->get_action( $action, $default ) }[-1] ) + { + $c->state( $c->execute( @{ $result->[0] } ) ); + last unless $default; } - for my $end ( @{ $c->get_action( '!end', $namespace ) } ) { - $c->state( $c->process( @{ $end->[0] } ) ); + for my $end ( reverse @{ $c->get_action( 'end', $namespace ) } ) + { + $c->state( $c->execute( @{ $end->[0] } ) ); } } else { @@ -426,7 +475,7 @@ sub handler { ? qq/Unknown resource "$path"/ : "No default action defined"; $c->log->error($error) if $c->debug; - $c->errors($error); + $c->error($error); } return $c->finalize; }; @@ -435,7 +484,7 @@ 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)" ); + $class->log->info( "Request took $elapsed" . "s ($av/s)", @stats ); } else { $status = &$handler } }; @@ -449,7 +498,8 @@ sub handler { =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 @@ -482,8 +532,8 @@ sub prepare { } $c->prepare_request($r); $c->prepare_path; - $c->prepare_cookies; $c->prepare_headers; + $c->prepare_cookies; $c->prepare_connection; my $method = $c->req->method || ''; my $path = $c->req->path || ''; @@ -498,9 +548,9 @@ sub prepare { my @params; for my $key ( keys %{ $c->req->params } ) { my $value = $c->req->params->{$key} || ''; - push @params, "$key=$value"; + push @params, " $key=$value"; } - $c->log->debug( 'Parameters are "' . join( ' ', @params ) . '"' ); + $c->log->debug( 'Parameters are', @params ); } $c->prepare_uploads; return $c; @@ -543,7 +593,7 @@ sub prepare_action { 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 ) . '"' ) @@ -564,7 +614,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 @@ -606,38 +662,6 @@ Prepare uploads. sub prepare_uploads { } -=item $c->process($class, $coderef) - -Process a coderef in given class and catch exceptions. -Errors are available via $c->errors. - -=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; -} - =item $c->run Starts the engine. @@ -662,57 +686,78 @@ Returns a C object. my $res = $c->res; -=item $c->set_action( $action, $code, $namespace ) +=item $c->set_action( $action, $code, $namespace, $attrs ) Set an action in a given namespace. =cut sub set_action { - my ( $c, $action, $code, $namespace ) = @_; - - my $prefix = ''; - if ( $action =~ /^\?(.*)$/ ) { - my $prefix = $1 || ''; - $action = $2; - $action = $prefix . _prefix( $namespace, $action ); - $c->actions->{plain}->{$action} = [ $namespace, $code ]; - } - if ( $action =~ /^\/(.*)\/$/ ) { - my $regex = $1; - $c->actions->{compiled}->{qr#$regex#} = $action; - $c->actions->{regex}->{$action} = [ $namespace, $code ]; - } - elsif ( $action =~ /^\!(.*)$/ ) { - $action = $1; - my $parent = $c->tree; - my $visitor = Tree::Simple::Visitor::FindByPath->new; - $prefix = _class2prefix($namespace); - for my $part ( split '/', $prefix ) { + my ( $c, $method, $code, $namespace, $attrs ) = @_; + + my $prefix = _class2prefix($namespace) || ''; + my %flags; + + for my $attr ( @{$attrs} ) { + if ( $attr =~ /^(Local|Relative)$/ ) { $flags{local}++ } + elsif ( $attr =~ /^(Global|Absolute)$/ ) { $flags{global}++ } + elsif ( $attr =~ /^Path\((.+)\)$/i ) { $flags{path} = $1 } + elsif ( $attr =~ /^Private$/i ) { $flags{private}++ } + elsif ( $attr =~ /^(Regex|Regexp)\((.+)\)$/i ) { $flags{regex} = $2 } + } + + return unless keys %flags; + + my $parent = $c->tree; + my $visitor = Tree::Simple::Visitor::FindByPath->new; + for my $part ( split '/', $prefix ) { + $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); - my $child = $visitor->getResult; - unless ($child) { - $child = $parent->addChild( Tree::Simple->new($part) ); - $visitor->setSearchPath($part); - $parent->accept($visitor); - $child = $visitor->getResult; - } - $parent = $child; + $child = $visitor->getResult; } - my $uid = $parent->getUID; - $c->actions->{private}->{$uid}->{$action} = [ $namespace, $code ]; - $action = "!$action"; + $parent = $child; } - else { - $c->actions->{plain}->{$action} = [ $namespace, $code ]; + my $uid = $parent->getUID; + $c->actions->{private}->{$uid}->{$method} = [ $namespace, $code ]; + my $forward = $prefix ? "$prefix/$method" : $method; + + if ( $flags{path} ) { + $flags{path} =~ s/^\w+//; + $flags{path} =~ s/\w+$//; + if ( $flags{path} =~ /^'(.*)'$/ ) { $flags{path} = $1 } + if ( $flags{path} =~ /^"(.*)"$/ ) { $flags{path} = $1 } + } + if ( $flags{regex} ) { + $flags{regex} =~ s/^\w+//; + $flags{regex} =~ s/\w+$//; + if ( $flags{regex} =~ /^'(.*)'$/ ) { $flags{regex} = $1 } + if ( $flags{regex} =~ /^"(.*)"$/ ) { $flags{regex} = $1 } } - my $reverse = $prefix ? "$action ($prefix)" : $action; - $c->actions->{reverse}->{"$code"} = $reverse; + my $reverse = $prefix ? "$prefix/$method" : $method; - $c->log->debug(qq/"$namespace" defined "$action" as "$code"/) - if $c->debug; + if ( $flags{local} || $flags{global} || $flags{path} ) { + my $path = $flags{path} || $method; + my $absolute = 0; + if ( $path =~ /^\/(.+)/ ) { + $path = $1; + $absolute = 1; + } + $absolute = 1 if $flags{global}; + my $name = $absolute ? $path : "$prefix/$path"; + $c->actions->{plain}->{$name} = [ $namespace, $code ]; + } + if ( my $regex = $flags{regex} ) { + push @{ $c->actions->{compiled} }, [ $regex, qr#$regex# ]; + $c->actions->{regex}->{$regex} = [ $namespace, $code ]; + } + + $c->actions->{reverse}->{"$code"} = $reverse; } =item $class->setup @@ -732,6 +777,41 @@ sub setup { } } +=item $class->setup_actions($component) + +Setup actions for a component. + +=cut + +sub setup_actions { + my ( $self, $comp ) = @_; + $comp = ref $comp || $comp; + for my $action ( @{ $comp->_cache } ) { + my ( $code, $attrs ) = @{$action}; + my $name = ''; + no strict 'refs'; + my @cache = ( $comp, @{"$comp\::ISA"} ); + my %namespaces; + while ( my $namespace = shift @cache ) { + $namespaces{$namespace}++; + for my $isa ( @{"$comp\::ISA"} ) { + next if $namespaces{$isa}; + push @cache, $isa; + $namespaces{$isa}++; + } + } + for my $namespace ( keys %namespaces ) { + for my $sym ( values %{ $namespace . '::' } ) { + if ( *{$sym}{CODE} && *{$sym}{CODE} == $code ) { + $name = *{$sym}{NAME}; + $self->set_action( $name, $code, $comp, $attrs ); + last; + } + } + } + } +} + =item $class->setup_components Setup components. @@ -758,14 +838,45 @@ sub setup_components { $self->log->error( qq/Couldn't initialize "Module::Pluggable::Fast", "$error"/); } + $self->setup_actions($self); $self->components( {} ); - for my $component ( $self->_components($self) ) { - $self->components->{ ref $component } = $component; + for my $comp ( $self->_components($self) ) { + $self->components->{ ref $comp } = $comp; + $self->setup_actions($comp); } - $self->log->debug( 'Initialized components "' - . join( ' ', keys %{ $self->components } ) - . '"' ) - if $self->debug; + my @comps; + push @comps, " $_" for keys %{ $self->components }; + $self->log->debug( 'Loaded components', @comps ) + if ( @comps && $self->debug ); + my $actions = $self->actions; + my @messages = ('Loaded private actions'); + my $walker = sub { + my ( $walker, $parent, $messages, $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, + _prettify_action( "$prefix$action", $class, $code ); + } + $walker->( $walker, $_, $messages, $prefix ) + for $parent->getAllChildren; + }; + $walker->( $walker, $self->tree, \@messages, '' ); + $self->log->debug(@messages) if ( $#messages && $self->debug ); + @messages = ('Loaded plain actions'); + for my $plain ( sort keys %{ $actions->{plain} } ) { + my ( $class, $code ) = @{ $actions->{plain}->{$plain} }; + push @messages, _prettify_action( "/$plain", $class, $code ); + } + $self->log->debug(@messages) if ( $#messages && $self->debug ); + @messages = ('Loaded regex actions'); + for my $regex ( sort keys %{ $actions->{regex} } ) { + my ( $class, $code ) = @{ $actions->{regex}->{$regex} }; + push @messages, _prettify_action( $regex, $class, $code ); + } + $self->log->debug(@messages) if ( $#messages && $self->debug ); } =item $c->stash @@ -797,12 +908,33 @@ sub _prefix { sub _class2prefix { my $class = shift || ''; - $class =~ /^.*::([MVC]|Model|View|Controller)?::(.*)$/; - my $prefix = lc $2 || ''; - $prefix =~ s/\:\:/\//g; + my $prefix; + if ( $class =~ /^.*::([MVC]|Model|View|Controller)?::(.*)$/ ) { + $prefix = lc $2; + $prefix =~ s/\:\:/\//g; + } return $prefix; } +sub _prettify_action { + my ( $val1, $val2, $val3 ) = @_; + formline +' @<<<<<<<<<<<<<<<<<<<<<<<<<<<<< @<<<<<<<<<<<<<<<<<<<<<<<<<<<< @>>>>>>>>>>>>>> ', + $val1, $val2, $val3; + my $formatted = $^A; + $^A = ''; + return $formatted; +} + +sub _prettify_stats { + my ( $val1, $val2 ) = @_; + formline ' @<<<<<<<<<<<<<<<<<<<<<<<<<<<<< @<<<<<<<<<<<<<<<<<<<<<<<<<<<< ', + $val1, $val2; + my $formatted = $^A; + $^A = ''; + return $formatted; +} + =back =head1 AUTHOR