X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?a=blobdiff_plain;f=lib%2FCatalyst%2FEngine.pm;h=b477b4c5921e499f84db979c0a9fe1e482746c08;hb=f8568ac8fb1ae94ac4ed01a5ac1812b93af422be;hp=70d07082991419c5fa39c70349b5b5cef75e8457;hpb=b676386894f30ba0b4c7291d466316454bd46113;p=catagits%2FCatalyst-Runtime.git diff --git a/lib/Catalyst/Engine.pm b/lib/Catalyst/Engine.pm index 70d0708..b477b4c 100644 --- a/lib/Catalyst/Engine.pm +++ b/lib/Catalyst/Engine.pm @@ -18,10 +18,10 @@ require Module::Pluggable::Fast; $Data::Dumper::Terse = 1; __PACKAGE__->mk_classdata($_) for qw/actions components tree/; -__PACKAGE__->mk_accessors(qw/request response/); +__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,110 +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 ) { - 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. @@ -196,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 @@ -234,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; @@ -256,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
@@ -292,7 +188,7 @@ sub finalize {
                 margin: 10px;
                 -moz-border-radius: 10px;
             }
-            div.errors {
+            div.error {
                 background-color: #977;
                 border: 1px solid #755;
                 padding: 8px;
@@ -319,7 +215,7 @@ sub finalize {
     
     
         
-
$errors
+
$error
$infos
$name
@@ -351,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'); @@ -368,33 +264,21 @@ 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 ( $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; + my $caller = caller(0); + my $namespace = '/'; + if ( $command =~ /^\/(.*)$/ ) { $command = $1 } + 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; return 0; } my $method = shift || 'process'; - if ( $code = $class->can($method) ) { + if ( my $code = $class->can($method) ) { $c->actions->{reverse}->{"$code"} = "$class->$method"; + $results = [ [ [ $class, $code ] ] ]; } else { $c->log->debug(qq/Couldn't forward to "$class->$method"/) @@ -402,17 +286,69 @@ sub forward { return 0; } } - $class = $c->components->{$class} || $class; - return $c->process( $class, $code ); + for my $result ( @{$results} ) { + $c->state( $c->execute( @{ $result->[0] } ) ); + } + return $c->state; +} + +=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; + if ($match) { + $action eq 'end' ? unshift @results, [$match] : push @results, + [$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($r) +=item $c->handler( $class, $r ) Handles the request. =cut -sub handler { +sub handler ($$) { my ( $class, $r ) = @_; # Always expect worst case! @@ -422,17 +358,27 @@ 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->find_action($action) ) { - $namespace = _class2prefix( $result->[0]->[0] ); + if ( my $result = $c->get_action($action) ) { + $namespace = _class2prefix( $result->[0]->[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] } ); + 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 ) } ) { + $c->state( $c->execute( @{ $result->[0] } ) ); + last unless $default; + } + for my $end ( @{ $c->get_action( 'end', $namespace ) } ) { + $c->state( $c->execute( @{ $end->[0] } ) ); + } } else { my $path = $c->req->path; @@ -440,10 +386,7 @@ sub handler { ? 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] } ); + $c->error($error); } return $c->finalize; }; @@ -466,7 +409,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 @@ -486,7 +430,8 @@ 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; @@ -535,7 +480,7 @@ sub prepare_action { $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) { @@ -559,14 +504,14 @@ 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 ) . '"' ) if ( $c->debug && @args ); } -=item $c->prepare_connection; +=item $c->prepare_connection Prepare connection. @@ -574,7 +519,7 @@ Prepare connection. sub prepare_connection { } -=item $c->prepare_cookies; +=item $c->prepare_cookies Prepare cookies. @@ -622,38 +567,47 @@ 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 + +Starts the engine. + +=cut + +sub run { } + =item $c->request =item $c->req @@ -670,6 +624,105 @@ 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 $action = 0; + my $public = 0; + my $regex = 0; + my $arg = ''; + my $absolute = 0; + + for my $attr ( @{$attrs} ) { + if ( $attr =~ /^Action$/ ) { + $action++; + $arg = $1 if $1; + } + elsif ( $attr =~ /^Path\((.+)\)$/i ) { + $arg = $1; + $public++; + } + elsif ( $attr =~ /^Public$/i ) { + $public++; + } + elsif ( $attr =~ /^Private$/i ) { + $action++; + } + elsif ( $attr =~ /Regex(?:\((.+)\))?$/i ) { + $regex++; + $action++; + $arg = $1 if $1; + } + elsif ( $attr =~ /Absolute(?:\((.+)\))?$/i ) { + $action++; + $absolute++; + $public++; + $arg = $1 if $1; + } + elsif ( $attr =~ /Relative(?:\((.+)\))?$/i ) { + $action++; + $public++; + $arg = $1 if $1; + } + } + + return unless $action; + + 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; + + $arg =~ s/^\w+//; + $arg =~ s/\w+$//; + if ( $arg =~ /^'(.*)'$/ ) { $arg = $1 } + if ( $arg =~ /^"(.*)"$/ ) { $arg = $1 } + + my $reverse = $prefix ? "$method ($prefix)" : $method; + + if ($public) { + my $is_absolute = 0; + $is_absolute = 1 if $absolute; + if ( $arg =~ /^\/(.+)/ ) { + $arg = $1; + $is_absolute = 1; + } + my $name = + $is_absolute ? ( $arg || $method ) : "$prefix/" . ( $arg || $method ); + $c->actions->{plain}->{$name} = [ $namespace, $code ]; + $c->log->debug(qq|Public "/$name" is "/$forward"|) if $c->debug; + } + if ($regex) { + push @{ $c->actions->{compiled} }, [ $arg, qr#$arg# ]; + $c->actions->{regex}->{$arg} = [ $namespace, $code ]; + $c->log->debug(qq|Public "$arg" is "/$forward"|) if $c->debug; + } + + $c->actions->{reverse}->{"$code"} = $reverse; +} + =item $class->setup Setup. @@ -687,6 +740,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. @@ -713,9 +788,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 } ) @@ -751,8 +828,8 @@ sub _prefix { } sub _class2prefix { - my $class = shift; - $class =~ /^.*::([MVC]|Model|View|Controller)+::(.*)$/; + my $class = shift || ''; + $class =~ /^.*::([MVC]|Model|View|Controller)?::(.*)$/; my $prefix = lc $2 || ''; $prefix =~ s/\:\:/\//g; return $prefix;