X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?p=catagits%2FCatalyst-Runtime.git;a=blobdiff_plain;f=lib%2FCatalyst%2FEngine.pm;h=7b07f5d5cff6bf3fc2e53bfa7139f42eaeac79cc;hp=358a9402c3a616e2422a9c430edfeb8859438758;hb=c9afa5fc4ed6c36afe6653d7d8fbb9909994c1a8;hpb=748161c4ad23fb071c9906201f98d7aaaad29222

diff --git a/lib/Catalyst/Engine.pm b/lib/Catalyst/Engine.pm
index 358a940..7b07f5d 100644
--- a/lib/Catalyst/Engine.pm
+++ b/lib/Catalyst/Engine.pm
@@ -6,7 +6,10 @@ use UNIVERSAL::require;
 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 Catalyst::Request;
 use Catalyst::Response;
 
@@ -14,11 +17,13 @@ require Module::Pluggable::Fast;
 
 $Data::Dumper::Terse = 1;
 
-__PACKAGE__->mk_classdata($_) for qw/actions components/;
-__PACKAGE__->mk_accessors(qw/request response/);
+__PACKAGE__->mk_classdata($_) for qw/actions components tree/;
+__PACKAGE__->mk_accessors(qw/request response state/);
 
 __PACKAGE__->actions(
-    { plain => {}, regex => {}, compiled => {}, reverse => {} } );
+    { plain => {}, private => {}, regex => {}, compiled => {}, reverse => {} }
+);
+__PACKAGE__->tree( Tree::Simple->new( 0, Tree::Simple->ROOT ) );
 
 *comp = \&component;
 *req  = \&request;
@@ -27,6 +32,8 @@ __PACKAGE__->actions(
 our $COUNT = 1;
 our $START = time;
 
+memoize('_class2prefix');
+
 =head1 NAME
 
 Catalyst::Engine - The Catalyst Engine
@@ -37,22 +44,16 @@ See L<Catalyst>.
 
 =head1 DESCRIPTION
 
-=head2 METHODS
+=head1 METHODS
+
+=over 4
 
-=head3 action
+=item $c->action( $name => $coderef, ... )
 
 Add one or more actions.
 
     $c->action( '!foo' => sub { $_[1]->res->output('Foo!') } );
 
-Get an action's class and coderef.
-
-    my ($class, $code) = @{ $c->action('foo') };
-
-Get a list of available actions.
-
-    my @actions = $c->action;
-
 It also automatically calls setup() if needed.
 
 See L<Catalyst::Manual::Intro> for more informations about actions.
@@ -67,58 +68,112 @@ sub action {
     $_[1] ? ( $action = {@_} ) : ( $action = shift );
     if ( ref $action eq 'HASH' ) {
         while ( my ( $name, $code ) = each %$action ) {
-            my $class = caller(0);
-            if ( $name =~ /^\/(.*)\/$/ ) {
-                my $regex = $1;
-                $self->actions->{compiled}->{qr/$regex/} = $name;
-                $self->actions->{regex}->{$name} = [ $class, $code ];
-            }
-            elsif ( $name =~ /^\?(.*)$/ ) {
-                $name = $1;
-                $name = _prefix( $class, $name );
-                $self->actions->{plain}->{$name} = [ $class, $code ];
-            }
-            elsif ( $name =~ /^\!\?(.*)$/ ) {
-                $name = $1;
-                $name = _prefix( $class, $name );
-                $name = "\!$name";
-                $self->actions->{plain}->{$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;
+            $self->set_action( $name, $code, caller(0) );
         }
     }
-    elsif ($action) {
-        if    ( my $p = $self->actions->{plain}->{$action} ) { return [$p] }
-        elsif ( my $r = $self->actions->{regex}->{$action} ) { return [$r] }
-        else {
-            for my $regex ( keys %{ $self->actions->{compiled} } ) {
-                my $name = $self->actions->{compiled}->{$regex};
-                if ( $action =~ $regex ) {
-                    my @snippets;
-                    for my $i ( 1 .. 9 ) {
-                        no strict 'refs';
-                        last unless ${$i};
-                        push @snippets, ${$i};
-                    }
-                    return [ $self->actions->{regex}->{$name},
-                        $name, \@snippets ];
+    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 0;
     }
-    else {
-        return (
-            keys %{ $self->actions->{plain} },
-            keys %{ $self->actions->{regex} }
-        );
+    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;
 }
 
-=head3 benchmark
+=item $c->benchmark($coderef)
 
 Takes a coderef with arguments and returns elapsed time as float.
 
@@ -136,7 +191,9 @@ sub benchmark {
     return wantarray ? ( $elapsed, @return ) : $elapsed;
 }
 
-=head3 component / comp
+=item $c->comp($name)
+
+=item $c->component($name)
 
 Get a component object by name.
 
@@ -160,7 +217,11 @@ sub component {
     }
 }
 
-=head3 errors
+=item $c->errors
+
+=item $c->errors($error, ...)
+
+=item $c->errors($arrayref)
 
 Returns an arrayref containing errors messages.
 
@@ -179,7 +240,7 @@ sub errors {
     return $c->{errors};
 }
 
-=head3 finalize
+=item $c->finalize
 
 Finalize request.
 
@@ -187,6 +248,13 @@ Finalize request.
 
 sub finalize {
     my $c = shift;
+
+    if ( my $location = $c->res->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';
@@ -280,18 +348,13 @@ sub finalize {
 </html>
 
     }
-    if ( my $location = $c->res->redirect ) {
-        $c->log->debug(qq/Redirecting to "$location"/) if $c->debug;
-        $c->res->headers->header( Location => $location );
-        $c->res->status(302);
-    }
     $c->res->headers->content_length( length $c->res->output );
     my $status = $c->finalize_headers;
     $c->finalize_output;
     return $status;
 }
 
-=head3 finalize_headers
+=item $c->finalize_headers
 
 Finalize headers.
 
@@ -299,7 +362,7 @@ Finalize headers.
 
 sub finalize_headers { }
 
-=head3 finalize_output
+=item $c->finalize_output
 
 Finalize output.
 
@@ -307,7 +370,7 @@ Finalize output.
 
 sub finalize_output { }
 
-=head3 forward
+=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().
@@ -326,42 +389,44 @@ sub forward {
         $c->log->debug('Nothing to forward to') if $c->debug;
         return 0;
     }
+    my $caller = caller(0);
     if ( $command =~ /^\?(.*)$/ ) {
         $command = $1;
-        my $caller = caller(0);
-        $command = _prefix( $caller, $command );
-    }
-    elsif ( $command =~ /^\!\?(.*)$/ ) {
-        $command = $1;
-        my $caller = caller(0);
         $command = _prefix( $caller, $command );
-        $command = "\!$command";
     }
-    elsif ( $command =~ /^\!(.*)$/ ) {
-        my $try    = $1;
-        my $caller = caller(0);
-        my $prefix = _class2prefix($caller);
-        $try = "!$prefix/$command";
-        $command = $try if $c->actions->{plain}->{$try};
+    my $namespace = '';
+    if ( $command =~ /^\!/ ) {
+        $namespace = _class2prefix($caller);
     }
-    my ( $class, $code );
-    if ( my $action = $c->action($command) ) {
-        if ( $action->[2] ) {
-            $c->log->debug(qq/Couldn't forward "$command" to regex action/)
-              if $c->debug;
-            return 0;
+    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 ) );
         }
-        ( $class, $code ) = @{ $action->[0] };
     }
     else {
-        $class = $command;
+        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";
+            $c->state( $c->process( $class, $code ) );
         }
         else {
             $c->log->debug(qq/Couldn't forward to "$class->$method"/)
@@ -369,11 +434,10 @@ sub forward {
             return 0;
         }
     }
-    $class = $c->components->{$class} || $class;
-    return $c->process( $class, $code );
+    return $c->state;
 }
 
-=head3 handler
+=item $c->handler($r)
 
 Handles the request.
 
@@ -386,37 +450,31 @@ sub handler {
     my $status = -1;
     eval {
         my $handler = sub {
-            my $c = $class->prepare($r);
-            if ( my $action = $c->action( $c->req->action ) ) {
-                my ( $begin, $end );
-                my $class  = ${ $action->[0] }[0];
-                my $prefix = _class2prefix($class);
-                if ($prefix) {
-                    if ( $c->actions->{plain}->{"\!$prefix/begin"} ) {
-                        $begin = "\!$prefix/begin";
-                    }
-                    elsif ( $c->actions->{plain}->{'!begin'} ) {
-                        $begin = '!begin';
-                    }
-                    if ( $c->actions->{plain}->{"\!$prefix/end"} ) {
-                        $end = "\!$prefix/end";
-                    }
-                    elsif ( $c->actions->{plain}->{'!end'} ) { $end = '!end' }
+            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 $results = $c->get_action( $action, $namespace );
+            if ( @{$results} ) {
+                for my $begin ( @{ $c->get_action( '!begin', $namespace ) } ) {
+                    $c->state( $c->process( @{ $begin->[0] } ) );
+                }
+                for my $result ( @{ $c->get_action( $action, $namespace ) } ) {
+                    $c->state( $c->process( @{ $result->[0] } ) );
                 }
-                else {
-                    if ( $c->actions->{plain}->{'!begin'} ) {
-                        $begin = '!begin';
-                    }
-                    if ( $c->actions->{plain}->{'!end'} ) { $end = '!end' }
+                for my $end ( @{ $c->get_action( '!end', $namespace ) } ) {
+                    $c->state( $c->process( @{ $end->[0] } ) );
                 }
-                $c->forward($begin)            if $begin;
-                $c->forward( $c->req->action ) if $c->req->action;
-                $c->forward($end)              if $end;
             }
             else {
-                my $action = $c->req->path;
-                my $error  = $action
-                  ? qq/Unknown resource "$action"/
+                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);
@@ -440,9 +498,9 @@ sub handler {
     return $status;
 }
 
-=head3 prepare
+=item $c->prepare($r)
 
-Turns the request (Apache, CGI...) into a Catalyst context.
+Turns the engine-specific request (Apache, CGI...) into a Catalyst context.
 
 =cut
 
@@ -462,7 +520,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;
@@ -476,16 +535,29 @@ sub prepare {
     $c->prepare_path;
     $c->prepare_cookies;
     $c->prepare_headers;
-    my $method = $c->req->method;
-    my $path   = $c->req->path;
-    $c->log->debug(qq/"$method" request for "$path"/) if $c->debug;
+    $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;
+        for my $key ( keys %{ $c->req->params } ) {
+            my $value = $c->req->params->{$key} || '';
+            push @params, "$key=$value";
+        }
+        $c->log->debug( 'Parameters are "' . join( ' ', @params ) . '"' );
+    }
     $c->prepare_uploads;
     return $c;
 }
 
-=head3 prepare_action
+=item $c->prepare_action
 
 Prepare action.
 
@@ -498,7 +570,7 @@ sub prepare_action {
     $c->req->args( \my @args );
     while (@path) {
         $path = join '/', @path;
-        if ( my $result = $c->action($path) ) {
+        if ( my $result = ${ $c->get_action($path) }[0] ) {
 
             # It's a regex
             if ($#$result) {
@@ -522,23 +594,22 @@ sub prepare_action {
         unshift @args, pop @path;
     }
     unless ( $c->req->action ) {
-        my $prefix = $c->req->args->[0];
-        if ( $prefix && $c->actions->{plain}->{"\!$prefix/default"} ) {
-            $c->req->match('');
-            $c->req->action("\!$prefix/default");
-            $c->log->debug('Using prefixed default action') if $c->debug;
-        }
-        elsif ( $c->actions->{plain}->{'!default'} ) {
-            $c->req->match('');
-            $c->req->action('!default');
-            $c->log->debug('Using default action') if $c->debug;
-        }
+        $c->req->action('!default');
+        $c->req->match('');
     }
     $c->log->debug( 'Arguments are "' . join( '/', @args ) . '"' )
       if ( $c->debug && @args );
 }
 
-=head3 prepare_cookies;
+=item $c->prepare_connection
+
+Prepare connection.
+
+=cut
+
+sub prepare_connection { }
+
+=item $c->prepare_cookies
 
 Prepare cookies.
 
@@ -546,7 +617,7 @@ Prepare cookies.
 
 sub prepare_cookies { }
 
-=head3 prepare_headers
+=item $c->prepare_headers
 
 Prepare headers.
 
@@ -554,7 +625,7 @@ Prepare headers.
 
 sub prepare_headers { }
 
-=head3 prepare_parameters
+=item $c->prepare_parameters
 
 Prepare parameters.
 
@@ -562,7 +633,7 @@ Prepare parameters.
 
 sub prepare_parameters { }
 
-=head3 prepare_path
+=item $c->prepare_path
 
 Prepare path and base.
 
@@ -570,7 +641,7 @@ Prepare path and base.
 
 sub prepare_path { }
 
-=head3 prepare_request
+=item $c->prepare_request
 
 Prepare the engine request.
 
@@ -578,7 +649,7 @@ Prepare the engine request.
 
 sub prepare_request { }
 
-=head3 prepare_uploads
+=item $c->prepare_uploads
 
 Prepare uploads.
 
@@ -586,7 +657,7 @@ Prepare uploads.
 
 sub prepare_uploads { }
 
-=head3 process
+=item $c->process($class, $coderef)
 
 Process a coderef in given class and catch exceptions.
 Errors are available via $c->errors.
@@ -618,42 +689,31 @@ sub process {
     return $status;
 }
 
-=head3 remove_action
+=item $c->run
 
-Remove an action.
-
-    $c->remove_action('!foo');
+Starts the engine.
 
 =cut
 
-sub remove_action {
-    my ( $self, $action ) = @_;
-    if ( delete $self->actions->{regex}->{$action} ) {
-        while ( my ( $regex, $name ) = each %{ $self->actions->{compiled} } ) {
-            if ( $name eq $action ) {
-                delete $self->actions->{compiled}->{$regex};
-                last;
-            }
-        }
-    }
-    else {
-        delete $self->actions->{plain}->{$action};
-    }
-}
+sub run { }
+
+=item $c->request
 
-=head3 request (req)
+=item $c->req
 
 Returns a C<Catalyst::Request> object.
 
     my $req = $c->req;
 
-=head3 response (res)
+=item $c->response
+
+=item $c->res
 
 Returns a C<Catalyst::Response> object.
 
     my $res = $c->res;
 
-=head3 setup
+=item $class->setup
 
 Setup.
 
@@ -670,7 +730,7 @@ sub setup {
     }
 }
 
-=head3 setup_components
+=item $class->setup_components
 
 Setup components.
 
@@ -706,7 +766,7 @@ sub setup_components {
       if $self->debug;
 }
 
-=head3 stash
+=item $c->stash
 
 Returns a hashref containing all your data.
 
@@ -734,13 +794,15 @@ sub _prefix {
 }
 
 sub _class2prefix {
-    my $class = shift;
-    $class =~ /^.*::[(M)(Model)(V)(View)(C)(Controller)]+::(.*)$/;
-    my $prefix = lc $1 || '';
-    $prefix =~ s/\:\:/_/g;
+    my $class = shift || '';
+    $class =~ /^.*::([MVC]|Model|View|Controller)?::(.*)$/;
+    my $prefix = lc $2 || '';
+    $prefix =~ s/\:\:/\//g;
     return $prefix;
 }
 
+=back
+
 =head1 AUTHOR
 
 Sebastian Riedel, C<sri@cpan.org>