X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?a=blobdiff_plain;f=lib%2FCatalyst%2FEngine.pm;h=af59ea25965697aa3cc3a565932f84201335323c;hb=a5d4355ad06c6bb91dd9d26ddfd52ace70be0a48;hp=7b07f5d5cff6bf3fc2e53bfa7139f42eaeac79cc;hpb=c9afa5fc4ed6c36afe6653d7d8fbb9909994c1a8;p=catagits%2FCatalyst-Runtime.git diff --git a/lib/Catalyst/Engine.pm b/lib/Catalyst/Engine.pm index 7b07f5d..af59ea2 100644 --- a/lib/Catalyst/Engine.pm +++ b/lib/Catalyst/Engine.pm @@ -21,7 +21,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,131 +48,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->get_action( $action, $namespace ) - -Get an action in a given namespace. - -=cut - -sub get_action { - my ( $c, $action, $namespace ) = @_; - $namespace ||= ''; - if ( $action =~ /^\!(.*)/ ) { - $action = $1; - my $parent = $c->tree; - my @results; - my $result = $c->actions->{private}->{ $parent->getUID }->{$action}; - push @results, [$result] if $result; - 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; - push @results, [$match] if $match; - $parent = $child if $child; - } - return \@results; - } - 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 []; -} - -=item $c->set_action( $action, $code, $namespace ) - -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 ) { - $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; - $c->actions->{private}->{$uid}->{$action} = [ $namespace, $code ]; - $action = "!$action"; - } - else { - $c->actions->{plain}->{$action} = [ $namespace, $code ]; - } - - my $reverse = $prefix ? "$action ($prefix)" : $action; - $c->actions->{reverse}->{"$code"} = $reverse; - - $c->log->debug(qq/"$namespace" defined "$action" as "$code"/) - if $c->debug; -} - =item $c->benchmark($coderef) Takes a coderef with arguments and returns elapsed time as float. @@ -217,27 +92,27 @@ 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->finalize @@ -255,13 +130,13 @@ sub finalize { $c->res->status(302); } - if ( !$c->res->output || $#{ $c->errors } >= 0 ) { + if ( !$c->res->output || $#{ $c->error } >= 0 ) { $c->res->headers->content_type('text/html'); my $name = $c->config->{name} || 'Catalyst Application'; - my ( $title, $errors, $infos ); + my ( $title, $error, $infos ); if ( $c->debug ) { - $errors = join '
', @{ $c->errors }; - $errors ||= 'No output'; + $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; @@ -277,9 +152,9 @@ sub finalize { } else { - $title = $name; - $errors = ''; - $infos = <<""; + $title = $name; + $error = ''; + $infos = <<"";
 (en) Please come back later
 (de) Bitte versuchen sie es spaeter nocheinmal
@@ -313,7 +188,7 @@ sub finalize {
                 margin: 10px;
                 -moz-border-radius: 10px;
             }
-            div.errors {
+            div.error {
                 background-color: #977;
                 border: 1px solid #755;
                 padding: 8px;
@@ -340,7 +215,7 @@ sub finalize {
     
     
         
-
$errors
+
$error
$infos
$name
@@ -372,11 +247,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'); @@ -389,35 +264,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); - } - if ( my $results = $c->get_action( $command, $namespace ) ) { - 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 ) ); - } + my $caller = caller(0); + my $namespace = '/'; + if ( $command =~ /^\/$/ ) { + $command =~ /^(.*)\/(\w+)$/; + $namespace = $1 || '/'; + $command = $2; } - else { + else { $namespace = _class2prefix($caller) || '/' } + my $results = $c->get_action( $command, $namespace ); + unless ( @{$results} ) { my $class = $command; if ( $class =~ /[^\w\:]/ ) { $c->log->debug(qq/Couldn't forward to "$class"/) if $c->debug; @@ -426,7 +282,7 @@ sub forward { my $method = shift || 'process'; if ( my $code = $class->can($method) ) { $c->actions->{reverse}->{"$code"} = "$class->$method"; - $c->state( $c->process( $class, $code ) ); + $results = [ [ [ $class, $code ] ] ]; } else { $c->log->debug(qq/Couldn't forward to "$class->$method"/) @@ -434,16 +290,66 @@ sub forward { return 0; } } + for my $result ( @{$results} ) { + $c->state( $c->execute( @{ $result->[0] } ) ); + } return $c->state; } -=item $c->handler($r) +=item $c->get_action( $action, $namespace ) + +Get an action in a given namespace. + +=cut + +sub get_action { + my ( $c, $action, $namespace ) = @_; + $namespace ||= ''; + if ($namespace) { + $namespace = '' if $namespace eq '/'; + my $parent = $c->tree; + my @results; + my $result = $c->actions->{private}->{ $parent->getUID }->{$action}; + push @results, [$result] if $result; + 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; + push @results, [$match] if $match; + $parent = $child if $child; + } + return \@results; + } + elsif ( my $p = $c->actions->{plain}->{$action} ) { return [ [$p] ] } + elsif ( my $r = $c->actions->{regex}->{$action} ) { return [ [$r] ] } + else { + 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 ) { + no strict 'refs'; + last unless ${$i}; + push @snippets, ${$i}; + } + return [ [ $c->actions->{regex}->{$name}, $name, \@snippets ] ]; + } + } + } + return []; +} + +=item $c->handler( $class, $r ) Handles the request. =cut -sub handler { +sub handler ($$) { my ( $class, $r ) = @_; # Always expect worst case! @@ -453,22 +359,26 @@ sub handler { my $c = $class->prepare($r); 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 ) } ) { + $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 ( @{ $c->get_action( 'end', $namespace ) } ) { + $c->state( $c->execute( @{ $end->[0] } ) ); } } else { @@ -477,7 +387,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; }; @@ -500,7 +410,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 @@ -594,7 +505,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 ) . '"' ) @@ -657,36 +568,37 @@ Prepare uploads. sub prepare_uploads { } -=item $c->process($class, $coderef) +=item $c->execute($class, $coderef) -Process a coderef in given class and catch exceptions. -Errors are available via $c->errors. +Execute a coderef in given class and catch exceptions. +Errors are available via $c->error. =cut -sub process { +sub execute { my ( $c, $class, $code ) = @_; - my $status; + $class = $c->comp($class) || $class; + $c->state(0); eval { if ( $c->debug ) { my $action = $c->actions->{reverse}->{"$code"} || "$code"; - my $elapsed; - ( $elapsed, $status ) = + 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 { $status = &$code( $class, $c, @{ $c->req->args } ) } + else { $c->state( &$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; + $c->error($error) if $c->debug; + $c->state(0); } - return $status; + return $c->state; } =item $c->run @@ -713,6 +625,84 @@ Returns a C object. my $res = $c->res; +=item $c->set_action( $action, $code, $namespace, $attrs ) + +Set an action in a given namespace. + +=cut + +sub set_action { + my ( $c, $method, $code, $namespace, $attrs ) = @_; + + my $prefix = _class2prefix($namespace) || ''; + my %flags; + + for my $attr ( @{$attrs} ) { + if ( $attr =~ /^Local$/ ) { $flags{local}++ } + elsif ( $attr =~ /^Global$/ ) { $flags{global}++ } + elsif ( $attr =~ /^Path\((.+)\)$/i ) { $flags{path} = $1 } + elsif ( $attr =~ /^Private$/i ) { $flags{private}++ } + elsif ( $attr =~ /Regex\((.+)\)$/i ) { $flags{regex} = $1 } + } + + 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); + $child = $visitor->getResult; + } + $parent = $child; + } + my $uid = $parent->getUID; + $c->actions->{private}->{$uid}->{$method} = [ $namespace, $code ]; + my $forward = $prefix ? "$prefix/$method" : $method; + $c->log->debug(qq|Private "/$forward" is "$namespace->$method"|) + if $c->debug; + + 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 ? "$method ($prefix)" : $method; + + 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 ]; + $c->log->debug(qq|Public "/$name" is "/$forward"|) if $c->debug; + } + if ( my $regex = $flags{regex} ) { + push @{ $c->actions->{compiled} }, [ $regex, qr#$regex# ]; + $c->actions->{regex}->{$regex} = [ $namespace, $code ]; + $c->log->debug(qq|Public "$regex" is "/$forward"|) if $c->debug; + } + + $c->actions->{reverse}->{"$code"} = $reverse; +} + =item $class->setup Setup. @@ -730,6 +720,28 @@ 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'; + for my $sym ( values %{ $comp . '::' } ) { + if ( *{$sym}{CODE} && *{$sym}{CODE} == $code ) { + $name = *{$sym}{NAME}; + $self->set_action( $name, $code, $comp, $attrs ); + } + } + } +} + =item $class->setup_components Setup components. @@ -756,9 +768,11 @@ 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 } )