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=ff2e79785161a6f657c76698942a3019ef7491b2;hp=b5cba7bc343d215c0b17eca0bba63de43b6654e7;hb=4ab87e274ac0a05f98c10a4cdba467ba4398b0d3;hpb=e0616220ee0bf2a2a9f0bacc0cb3b7fd2a464f36

diff --git a/lib/Catalyst/Engine.pm b/lib/Catalyst/Engine.pm
index b5cba7b..ff2e797 100644
--- a/lib/Catalyst/Engine.pm
+++ b/lib/Catalyst/Engine.pm
@@ -30,13 +30,8 @@ See L<Catalyst>.
 
 =head1 METHODS
 
-=over 4
 
-=item $self->finalize_output
-
-<obsolete>, see finalize_body
-
-=item $self->finalize_body($c)
+=head2 $self->finalize_body($c)
 
 Finalize body.  Prints the response output.
 
@@ -44,11 +39,21 @@ Finalize body.  Prints the response output.
 
 sub finalize_body {
     my ( $self, $c ) = @_;
-
-    $self->write( $c, $c->response->output );
+    if ( ref $c->response->body && $c->response->body->can('read') ) {
+        while ( !$c->response->body->eof() ) {
+            $c->response->body->read( my $buffer, $CHUNKSIZE );
+            last unless $self->write( $c, $buffer );
+        }
+        $c->response->body->close();
+    }
+    else {
+        $self->write( $c, $c->response->body );
+    }
 }
 
-=item $self->finalize_cookies($c)
+=head2 $self->finalize_cookies($c)
+
+Create CGI::Cookies from $c->res->cookies, and set them as response headers.
 
 =cut
 
@@ -70,19 +75,23 @@ sub finalize_cookies {
         push @cookies, $cookie->as_string;
     }
 
-    if (@cookies) {
-        $c->res->headers->push_header( 'Set-Cookie' => join ',', @cookies );
+    for my $cookie (@cookies) {
+        $c->res->headers->push_header( 'Set-Cookie' => $cookie );
     }
 }
 
-=item $self->finalize_error($c)
+=head2 $self->finalize_error($c)
+
+Output an apropriate error message, called if there's an error in $c
+after the dispatch has finished. Will output debug messages if Catalyst
+is in debug mode, or a `please come back later` message otherwise.
 
 =cut
 
 sub finalize_error {
     my ( $self, $c ) = @_;
 
-    $c->res->headers->content_type('text/html');
+    $c->res->content_type('text/html; charset=utf-8');
     my $name = $c->config->{name} || 'Catalyst Application';
 
     my ( $title, $error, $infos );
@@ -90,11 +99,15 @@ sub finalize_error {
 
         # For pretty dumps
         local $Data::Dumper::Terse = 1;
-        $error = join '',
-          map { '<code class="error">' . encode_entities($_) . '</code>' }
-          @{ $c->error };
+        $error = join '', map {
+                '<p><code class="error">'
+              . encode_entities($_)
+              . '</code></p>'
+        } @{ $c->error };
         $error ||= 'No output';
+        $error = qq{<pre wrap="">$error</pre>};
         $title = $name = "$name on Catalyst $Catalyst::VERSION";
+        $name  = "<h1>$name</h1>";
 
         # Don't show context in the dump
         delete $c->req->{_context};
@@ -109,15 +122,21 @@ sub finalize_error {
         my $req   = encode_entities Dumper $c->req;
         my $res   = encode_entities Dumper $c->res;
         my $stash = encode_entities Dumper $c->stash;
-        $infos = <<"";
-<br/>
-<b><u>Request</u></b><br/>
-<pre>$req</pre>
-<b><u>Response</u></b><br/>
-<pre>$res</pre>
-<b><u>Stash</u></b><br/>
-<pre>$stash</pre>
 
+        my @infos;
+        my $i = 0;
+        for my $dump ( $c->dump_these ) {
+            my $name  = $dump->[0];
+            my $value = encode_entities( Dumper $dump->[1] );
+            push @infos, sprintf <<"EOF", $name, $value;
+<h2><a href="#" onclick="toggleDump('dump_$i'); return false">%s</a></h2>
+<div id="dump_$i">
+    <pre wrap="">%s</pre>
+</div>
+EOF
+            $i++;
+        }
+        $infos = join "\n", @infos;
     }
     else {
         $title = $name;
@@ -126,20 +145,35 @@ sub finalize_error {
 <pre>
 (en) Please come back later
 (de) Bitte versuchen sie es spaeter nocheinmal
-(nl) Gelieve te komen later terug
+(at) Konnten's bitt'schoen spaeter nochmal reinschauen
 (no) Vennligst prov igjen senere
-(fr) Veuillez revenir plus tard
-(es) Vuelto por favor mas adelante
-(pt) Voltado por favor mais tarde
-(it) Ritornato prego più successivamente
+(dk) Venligst prov igen senere
+(pl) Prosze sprobowac pozniej
 </pre>
 
         $name = '';
     }
     $c->res->body( <<"" );
-<html>
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
+    "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
 <head>
+    <meta http-equiv="Content-Language" content="en" />
+    <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
     <title>$title</title>
+    <script type="text/javascript">
+        <!--
+        function toggleDump (dumpElement) {
+            var e = document.getElementById( dumpElement );
+            if (e.style.display == "none") {
+                e.style.display = "";
+            }
+            else {
+                e.style.display = "none";
+            }
+        }
+        -->
+    </script>
     <style type="text/css">
         body {
             font-family: "Bitstream Vera Sans", "Trebuchet MS", Verdana,
@@ -149,7 +183,11 @@ sub finalize_error {
             margin: 0px;
             padding: 0px;
         }
+        :link, :link:hover, :visited, :visited:hover {
+            color: #ddd;
+        }
         div.box {
+            position: relative;
             background-color: #ccc;
             border: 1px solid #aaa;
             padding: 4px;
@@ -183,7 +221,29 @@ sub finalize_error {
             display: block;
             margin: 1em 0;
             overflow: auto;
-            white-space: pre;
+        }
+        div.name h1, div.error p {
+            margin: 0;
+        }
+        h2 {
+            margin-top: 0;
+            margin-bottom: 10px;
+            font-size: medium;
+            font-weight: bold;
+            text-decoration: underline;
+        }
+        h1 {
+            font-size: medium;
+            font-weight: normal;
+        }
+        /* from http://users.tkk.fi/~tkarvine/linux/doc/pre-wrap/pre-wrap-css3-mozilla-opera-ie.html */
+        /* Browser specific (not valid) styles to make preformatted text wrap */
+        pre { 
+            white-space: pre-wrap;       /* css-3 */
+            white-space: -moz-pre-wrap;  /* Mozilla, since 1999 */
+            white-space: -pre-wrap;      /* Opera 4-6 */
+            white-space: -o-pre-wrap;    /* Opera 7 */
+            word-wrap: break-word;       /* Internet Explorer 5.5+ */
         }
     </style>
 </head>
@@ -196,15 +256,23 @@ sub finalize_error {
 </body>
 </html>
 
+
+    # Trick IE
+    $c->res->{body} .= ( ' ' x 512 );
+
+    # Return 500
+    $c->res->status(500);
 }
 
-=item $self->finalize_headers($c)
+=head2 $self->finalize_headers($c)
+
+Abstract method, allows engines to write headers to response
 
 =cut
 
 sub finalize_headers { }
 
-=item $self->finalize_read($c)
+=head2 $self->finalize_read($c)
 
 =cut
 
@@ -214,7 +282,9 @@ sub finalize_read {
     undef $self->{_prepared_read};
 }
 
-=item $self->finalize_uploads($c)
+=head2 $self->finalize_uploads($c)
+
+Clean up after uploads, deleting temp files.
 
 =cut
 
@@ -231,7 +301,9 @@ sub finalize_uploads {
     }
 }
 
-=item $self->prepare_body($c)
+=head2 $self->prepare_body($c)
+
+sets up the L<Catalyst::Request> object body using L<HTTP::Body>
 
 =cut
 
@@ -249,10 +321,19 @@ sub prepare_body {
         while ( my $buffer = $self->read($c) ) {
             $c->prepare_body_chunk($buffer);
         }
+
+        # paranoia against wrong Content-Length header
+        my $remaining = $self->read_length - $self->read_position;
+        if ($remaining > 0) {
+            $self->finalize_read($c);
+            Catalyst::Exception->throw("Wrong Content-Length value: ". $self->read_length);
+        }
     }
 }
 
-=item $self->prepare_body_chunk($c)
+=head2 $self->prepare_body_chunk($c)
+
+Add a chunk to the request body.
 
 =cut
 
@@ -262,7 +343,9 @@ sub prepare_body_chunk {
     $c->request->{_body}->add($chunk);
 }
 
-=item $self->prepare_body_parameters($c)
+=head2 $self->prepare_body_parameters($c)
+
+Sets up parameters from body. 
 
 =cut
 
@@ -271,13 +354,17 @@ sub prepare_body_parameters {
     $c->request->body_parameters( $c->request->{_body}->param );
 }
 
-=item $self->prepare_connection($c)
+=head2 $self->prepare_connection($c)
+
+Abstract method implemented in engines.
 
 =cut
 
 sub prepare_connection { }
 
-=item $self->prepare_cookies($c)
+=head2 $self->prepare_cookies($c)
+
+Parse cookies from header. Sets a L<CGI::Cookie> object.
 
 =cut
 
@@ -289,13 +376,15 @@ sub prepare_cookies {
     }
 }
 
-=item $self->prepare_headers($c)
+=head2 $self->prepare_headers($c)
 
 =cut
 
 sub prepare_headers { }
 
-=item $self->prepare_parameters($c)
+=head2 $self->prepare_parameters($c)
+
+sets up parameters from query and post parameters.
 
 =cut
 
@@ -322,15 +411,19 @@ sub prepare_parameters {
     }
 }
 
-=item $self->prepare_path($c)
+=head2 $self->prepare_path($c)
+
+abstract method, implemented by engines.
 
 =cut
 
 sub prepare_path { }
 
-=item $self->prepare_request($c)
+=head2 $self->prepare_request($c)
+
+=head2 $self->prepare_query_parameters($c)
 
-=item $self->prepare_query_parameters($c)
+process the query string and extract query parameters.
 
 =cut
 
@@ -341,14 +434,16 @@ sub prepare_query_parameters {
     $query_string =~ s/;/&/g;
 
     my $u = URI->new( '', 'http' );
-        $u->query( $query_string );
-        for my $key ( $u->query_param ) {
-        my @vals = $u->query_param($key);  
-        $c->request->query_parameters->{$key} = @vals > 1 ? [@vals] : $vals[0];  
+    $u->query($query_string);
+    for my $key ( $u->query_param ) {
+        my @vals = $u->query_param($key);
+        $c->request->query_parameters->{$key} = @vals > 1 ? [@vals] : $vals[0];
     }
 }
 
-=item $self->prepare_read($c)
+=head2 $self->prepare_read($c)
+
+prepare to read from the engine.
 
 =cut
 
@@ -359,13 +454,15 @@ sub prepare_read {
     $self->read_position(0);
 }
 
-=item $self->prepare_request(@arguments)
+=head2 $self->prepare_request(@arguments)
+
+Populate the context object from the request object.
 
 =cut
 
 sub prepare_request { }
 
-=item $self->prepare_uploads($c)
+=head2 $self->prepare_uploads($c)
 
 =cut
 
@@ -386,21 +483,23 @@ sub prepare_uploads {
             push @uploads, $u;
         }
         $c->request->uploads->{$name} = @uploads > 1 ? \@uploads : $uploads[0];
-        
+
         # support access to the filename as a normal param
         my @filenames = map { $_->{filename} } @uploads;
-        $c->request->parameters->{$name} 
-            = @filenames > 1 ? \@filenames : $filenames[0];
+        $c->request->parameters->{$name} =
+          @filenames > 1 ? \@filenames : $filenames[0];
     }
 }
 
-=item $self->prepare_write($c)
+=head2 $self->prepare_write($c)
+
+Abstract method. Implemented by the engines.
 
 =cut
 
 sub prepare_write { }
 
-=item $self->read($c, [$maxlength])
+=head2 $self->read($c, [$maxlength])
 
 =cut
 
@@ -433,7 +532,7 @@ sub read {
     }
 }
 
-=item $self->read_chunk($c, $buffer, $length)
+=head2 $self->read_chunk($c, $buffer, $length)
 
 Each engine inplements read_chunk as its preferred way of reading a chunk
 of data.
@@ -442,22 +541,26 @@ of data.
 
 sub read_chunk { }
 
-=item $self->read_length
+=head2 $self->read_length
 
 The length of input data to be read.  This is obtained from the Content-Length
 header.
 
-=item $self->read_position
+=head2 $self->read_position
 
 The amount of input data that has already been read.
 
-=item $self->run($c)
+=head2 $self->run($c)
+
+Start the engine. Implemented by the various engine classes.
 
 =cut
 
 sub run { }
 
-=item $self->write($c, $buffer)
+=head2 $self->write($c, $buffer)
+
+Writes the buffer to the client. Can only be called once for a request.
 
 =cut
 
@@ -472,7 +575,9 @@ sub write {
     print STDOUT $buffer;
 }
 
-=back
+=head2 $self->finalize_output
+
+<obsolete>, see finalize_body
 
 =head1 AUTHORS