Added recursive -r flag to prove example
[catagits/Catalyst-Runtime.git] / lib / Catalyst / Engine.pm
index dfab421..de7e082 100644 (file)
@@ -10,17 +10,14 @@ use HTML::Entities;
 use HTTP::Headers;
 use Time::HiRes qw/gettimeofday tv_interval/;
 use Text::ASCIITable;
+use Catalyst::Exception;
 use Catalyst::Request;
 use Catalyst::Request::Upload;
 use Catalyst::Response;
-
-require Module::Pluggable::Fast;
-
-# For pretty dumps
-$Data::Dumper::Terse = 1;
+use Catalyst::Utils;
 
 __PACKAGE__->mk_classdata('components');
-__PACKAGE__->mk_accessors(qw/request response state/);
+__PACKAGE__->mk_accessors(qw/counter depth request response state/);
 
 *comp = \&component;
 *req  = \&request;
@@ -30,8 +27,10 @@ __PACKAGE__->mk_accessors(qw/request response state/);
 *finalize_output = \&finalize_body;
 
 # For statistics
-our $COUNT = 1;
-our $START = time;
+our $COUNT     = 1;
+our $START     = time;
+our $RECURSION = 1000;
+our $DETACH    = "catalyst_detach\n";
 
 =head1 NAME
 
@@ -80,20 +79,35 @@ Regex search for a component.
 =cut
 
 sub component {
-    my ( $c, $name ) = @_;
+    my $c = shift;
 
-    if ( my $component = $c->components->{$name} ) {
-        return $component;
-    }
+    if (@_) {
 
-    else {
-        for my $component ( keys %{ $c->components } ) {
-            return $c->components->{$component} if $component =~ /$name/i;
+        my $name = shift;
+
+        if ( my $component = $c->components->{$name} ) {
+            return $component;
+        }
+
+        else {
+            for my $component ( keys %{ $c->components } ) {
+                return $c->components->{$component} if $component =~ /$name/i;
+            }
         }
     }
 
+    return sort keys %{ $c->components };
 }
 
+=item $c->counter
+
+Returns a hashref containing coderefs and execution counts.
+(Needed for deep recursion detection)
+
+=item $c->depth
+
+Returns the actual forward depth.
+
 =item $c->error
 
 =item $c->error($error, ...)
@@ -126,34 +140,53 @@ Errors are available via $c->error.
 
 sub execute {
     my ( $c, $class, $code ) = @_;
-    $class = $c->comp($class) || $class;
+    $class = $c->components->{$class} || $class;
     $c->state(0);
     my $callsub = ( caller(1) )[3];
 
+    my $action = '';
+    if ( $c->debug ) {
+        $action = $c->actions->{reverse}->{"$code"};
+        $action = "/$action" unless $action =~ /\-\>/;
+        $c->counter->{"$code"}++;
+
+        if ( $c->counter->{"$code"} > $RECURSION ) {
+            my $error = qq/Deep recursion detected in "$action"/;
+            $c->log->error($error);
+            $c->error($error);
+            $c->state(0);
+            return $c->state;
+        }
+
+        $action = "-> $action" if $callsub =~ /forward$/;
+    }
+
+    $c->{depth}++;
     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 } ) ) }
+        else { $c->state( &$code( $class, $c, @{ $c->req->args } ) || 0 ) }
     };
+    $c->{depth}--;
 
     if ( my $error = $@ ) {
 
-        unless ( ref $error ) {
-            chomp $error;
-            $error = qq/Caught exception "$error"/;
-        }
+        if ( $error eq $DETACH ) { die $DETACH if $c->{depth} > 1 }
+        else {
+            unless ( ref $error ) {
+                chomp $error;
+                $error = qq/Caught exception "$error"/;
+            }
 
-        $c->log->error($error);
-        $c->error($error);
-        $c->state(0);
+            $c->log->error($error);
+            $c->error($error);
+            $c->state(0);
+        }
     }
     return $c->state;
 }
@@ -179,13 +212,21 @@ sub finalize {
         $c->finalize_error;
     }
 
-    if ( !$c->response->body && $c->response->status !~ /^(1|3)\d\d$/ ) {
+    if ( !$c->response->body && $c->response->status == 200 ) {
         $c->finalize_error;
     }
 
     if ( $c->response->body && !$c->response->content_length ) {
-        use bytes;    # play safe with a utf8 aware perl
-        $c->response->content_length( length $c->response->body );
+        $c->response->content_length( bytes::length( $c->response->body ) );
+    }
+
+    if ( $c->response->status =~ /^(1\d\d|[23]04)$/ ) {
+        $c->response->headers->remove_header("Content-Length");
+        $c->response->body('');
+    }
+
+    if ( $c->request->method eq 'HEAD' ) {
+        $c->response->body('');
     }
 
     my $status = $c->finalize_headers;
@@ -193,6 +234,10 @@ sub finalize {
     return $status;
 }
 
+=item $c->finalize_output
+
+<obsolete>, see finalize_body
+
 =item $c->finalize_body
 
 Finalize body.
@@ -238,7 +283,12 @@ sub finalize_error {
 
     my ( $title, $error, $infos );
     if ( $c->debug ) {
-        $error = join '<br/>', @{ $c->error };
+
+        # For pretty dumps
+        local $Data::Dumper::Terse = 1;
+        $error = join '',
+          map { '<code class="error">' . encode_entities($_) . '</code>' }
+          @{ $c->error };
         $error ||= 'No output';
         $title = $name = "$name on Catalyst $Catalyst::VERSION";
         my $req   = encode_entities Dumper $c->req;
@@ -314,6 +364,12 @@ sub finalize_error {
             margin: 4px;
             -moz-border-radius: 10px;
         }
+        code.error {
+            display: block;
+            margin: 1em 0;
+            overflow: auto;
+            white-space: pre;
+        }
     </style>
 </head>
 <body>
@@ -335,14 +391,14 @@ Finalize headers.
 
 sub finalize_headers { }
 
-=item $c->handler( $class, $engine )
+=item $c->handler( $class, @arguments )
 
 Handles the request.
 
 =cut
 
 sub handler {
-    my ( $class, $engine ) = @_;
+    my ( $class, @arguments ) = @_;
 
     # Always expect worst case!
     my $status = -1;
@@ -350,7 +406,7 @@ sub handler {
         my @stats = ();
 
         my $handler = sub {
-            my $c = $class->prepare($engine);
+            my $c = $class->prepare(@arguments);
             $c->{stats} = \@stats;
             $c->dispatch;
             return $c->finalize;
@@ -360,15 +416,16 @@ sub handler {
             my $elapsed;
             ( $elapsed, $status ) = $class->benchmark($handler);
             $elapsed = sprintf '%f', $elapsed;
-            my $av = sprintf '%.3f', 1 / $elapsed;
+            my $av = sprintf '%.3f',
+              ( $elapsed == 0 ? '??' : ( 1 / $elapsed ) );
             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 );
+            $class->log->info(
+                "Request took ${elapsed}s ($av/s)\n" . $t->draw );
         }
         else { $status = &$handler }
 
@@ -383,7 +440,7 @@ sub handler {
     return $status;
 }
 
-=item $c->prepare($r)
+=item $c->prepare(@arguments)
 
 Turns the engine-specific request( Apache, CGI ... )
 into a Catalyst context .
@@ -391,21 +448,29 @@ into a Catalyst context .
 =cut
 
 sub prepare {
-    my ( $class, $engine ) = @_;
+    my ( $class, @arguments ) = @_;
 
     my $c = bless {
+        counter => {},
+        depth   => 0,
         request => Catalyst::Request->new(
             {
                 arguments  => [],
                 cookies    => {},
                 headers    => HTTP::Headers->new,
                 parameters => {},
+                secure     => 0,
                 snippets   => [],
                 uploads    => {}
             }
         ),
         response => Catalyst::Response->new(
-            { cookies => {}, headers => HTTP::Headers->new, status => 200 }
+            {
+                body    => '',
+                cookies => {},
+                headers => HTTP::Headers->new( 'Content-Length' => 0 ),
+                status  => 200
+            }
         ),
         stash => {},
         state => 0
@@ -420,19 +485,18 @@ sub prepare {
         $c->res->headers->header( 'X-Catalyst' => $Catalyst::VERSION );
     }
 
-    $c->prepare_request($engine);
-    $c->prepare_path;
+    $c->prepare_request(@arguments);
+    $c->prepare_connection;
     $c->prepare_headers;
     $c->prepare_cookies;
-    $c->prepare_connection;
+    $c->prepare_path;
     $c->prepare_action;
 
-    my $method   = $c->req->method   || '';
-    my $path     = $c->req->path     || '';
-    my $hostname = $c->req->hostname || '';
-    my $address  = $c->req->address  || '';
+    my $method  = $c->req->method  || '';
+    my $path    = $c->req->path    || '';
+    my $address = $c->req->address || '';
 
-    $c->log->debug(qq/"$method" request for "$path" from $hostname($address)/)
+    $c->log->debug(qq/"$method" request for "$path" from $address/)
       if $c->debug;
 
     if ( $c->request->method eq 'POST' and $c->request->content_length ) {
@@ -458,11 +522,12 @@ sub prepare {
         $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} || '';
+        for my $key ( sort keys %{ $c->req->params } ) {
+            my $param = $c->req->params->{$key};
+            my $value = defined($param) ? $param : '';
             $t->addRow( $key, $value );
         }
-        $c->log->debug( 'Parameters are', $t->draw );
+        $c->log->debug( "Parameters are:\n" . $t->draw );
     }
 
     return $c;
@@ -612,66 +677,6 @@ Returns a C<Catalyst::Response> object.
 
     my $res = $c->res;
 
-=item $class->setup
-
-Setup.
-
-    MyApp->setup;
-
-=cut
-
-sub setup {
-    my $self = shift;
-    $self->setup_components;
-    if ( $self->debug ) {
-        my $name = $self->config->{name} || 'Application';
-        $self->log->info("$name powered by Catalyst $Catalyst::VERSION");
-    }
-}
-
-=item $class->setup_components
-
-Setup components.
-
-=cut
-
-sub setup_components {
-    my $self = shift;
-
-    # Components
-    my $class = ref $self || $self;
-    eval <<"";
-        package $class;
-        import Module::Pluggable::Fast
-          name   => '_components',
-          search => [
-            '$class\::Controller', '$class\::C',
-            '$class\::Model',      '$class\::M',
-            '$class\::View',       '$class\::V'
-          ];
-
-    if ( my $error = $@ ) {
-        chomp $error;
-        die qq/Couldn't load components "$error"/;
-    }
-
-    $self->components( {} );
-    my @comps;
-    for my $comp ( $self->_components($self) ) {
-        $self->components->{ ref $comp } = $comp;
-        push @comps, $comp;
-    }
-
-    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.
@@ -687,8 +692,8 @@ Returns a hashref containing all your data.
 
 sub stash {
     my $self = shift;
-    if ( $_[0] ) {
-        my $stash = $_[1] ? {@_} : $_[0];
+    if (@_) {
+        my $stash = @_ > 1 ? {@_} : $_[0];
         while ( my ( $key, $val ) = each %$stash ) {
             $self->{stash}->{$key} = $val;
         }