Fixed run-on sentence in COPYRIGHT and s/program/library/
[catagits/Catalyst-Runtime.git] / lib / Catalyst / Engine.pm
index 1f22735..d66bb5d 100644 (file)
@@ -10,14 +10,16 @@ use HTML::Entities;
 use HTTP::Body;
 use HTTP::Headers;
 use URI::QueryParam;
-use Scalar::Util ();
+
+use namespace::clean -except => 'meta';
+
+has env => (is => 'rw');
 
 # input position and length
 has read_length => (is => 'rw');
 has read_position => (is => 'rw');
 
-# Stringify to class
-use overload '""' => sub { return ref shift }, fallback => 1;
+has _prepared_write => (is => 'rw');
 
 # Amount of data to read from input on each pass
 our $CHUNKSIZE = 64 * 1024;
@@ -45,7 +47,7 @@ sub finalize_body {
     my ( $self, $c ) = @_;
     my $body = $c->response->body;
     no warnings 'uninitialized';
-    if ( Scalar::Util::blessed($body) && $body->can('read') or ref($body) eq 'GLOB' ) {
+    if ( blessed($body) && $body->can('read') or ref($body) eq 'GLOB' ) {
         while ( !eof $body ) {
             read $body, my ($buffer), $CHUNKSIZE;
             last unless $self->write( $c, $buffer );
@@ -70,10 +72,12 @@ sub finalize_cookies {
     my @cookies;
     my $response = $c->response;
 
-    while( my($name, $val) = each %{ $response->cookies } ) {
+    foreach my $name (keys %{ $response->cookies }) {
+
+        my $val = $response->cookies->{$name};
 
         my $cookie = (
-            Scalar::Util::blessed($val)
+            blessed($val)
             ? $val
             : CGI::Simple::Cookie->new(
                 -name    => $name,
@@ -81,7 +85,8 @@ sub finalize_cookies {
                 -expires => $val->{expires},
                 -domain  => $val->{domain},
                 -path    => $val->{path},
-                -secure  => $val->{secure} || 0
+                -secure  => $val->{secure} || 0,
+                -httponly => $val->{httponly} || 0,
             )
         );
 
@@ -95,7 +100,7 @@ sub finalize_cookies {
 
 =head2 $self->finalize_error($c)
 
-Output an apropriate error message, called if there's an error in $c
+Output an appropriate 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.
 
@@ -122,14 +127,11 @@ sub finalize_error {
         $name  = "<h1>$name</h1>";
 
         # Don't show context in the dump
-        delete $c->req->{_context};
-        delete $c->res->{_context};
+        $c->req->_clear_context;
+        $c->res->_clear_context;
 
         # Don't show body parser in the dump
-        delete $c->req->{_body};
-
-        # Don't show response header state in dump
-        delete $c->res->{_finalized_headers};
+        $c->req->_clear_body;
 
         my @infos;
         my $i = 0;
@@ -158,6 +160,9 @@ EOF
 (no) Vennligst prov igjen senere
 (dk) Venligst prov igen senere
 (pl) Prosze sprobowac pozniej
+(pt) Por favor volte mais tarde
+(ru) Попробуйте еще раз позже
+(ua) Спробуйте ще раз пізніше
 </pre>
 
         $name = '';
@@ -243,7 +248,7 @@ EOF
         }
         /* 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 {
+        pre { 
             white-space: pre-wrap;       /* css-3 */
             white-space: -moz-pre-wrap;  /* Mozilla, since 1999 */
             white-space: -pre-wrap;      /* Opera 4-6 */
@@ -293,7 +298,8 @@ sub finalize_uploads {
     my ( $self, $c ) = @_;
 
     my $request = $c->request;
-    while( my($key,$upload) = each %{ $request->uploads } ) {
+    foreach my $key (keys %{ $request->uploads }) {
+        my $upload = $request->uploads->{$key};
         unlink grep { -e $_ } map { $_->tempname }
           (ref $upload eq 'ARRAY' ? @{$upload} : ($upload));
     }
@@ -311,13 +317,13 @@ sub prepare_body {
 
     if ( my $length = $self->read_length ) {
         my $request = $c->request;
-        unless ( $request->{_body} ) {
+        unless ( $request->_body ) {
             my $type = $request->header('Content-Type');
-            $request->{_body} = HTTP::Body->new( $type, $length );
-            $request->{_body}->{tmpdir} = $c->config->{uploadtmp}
+            $request->_body(HTTP::Body->new( $type, $length ));
+            $request->_body->tmpdir( $c->config->{uploadtmp} )
               if exists $c->config->{uploadtmp};
         }
-
+        
         while ( my $buffer = $self->read($c) ) {
             $c->prepare_body_chunk($buffer);
         }
@@ -332,7 +338,7 @@ sub prepare_body {
     }
     else {
         # Defined but will cause all body code to be skipped
-        $c->request->{_body} = 0;
+        $c->request->_body(0);
     }
 }
 
@@ -345,21 +351,21 @@ Add a chunk to the request body.
 sub prepare_body_chunk {
     my ( $self, $c, $chunk ) = @_;
 
-    $c->request->{_body}->add($chunk);
+    $c->request->_body->add($chunk);
 }
 
 =head2 $self->prepare_body_parameters($c)
 
-Sets up parameters from body.
+Sets up parameters from body. 
 
 =cut
 
 sub prepare_body_parameters {
     my ( $self, $c ) = @_;
-
-    return unless $c->request->{_body};
-
-    $c->request->body_parameters( $c->request->{_body}->param );
+    
+    return unless $c->request->_body;
+    
+    $c->request->body_parameters( $c->request->_body->param );
 }
 
 =head2 $self->prepare_connection($c)
@@ -404,12 +410,14 @@ sub prepare_parameters {
     my $body_parameters = $request->body_parameters;
     my $query_parameters = $request->query_parameters;
     # We copy, no references
-    while( my($name, $param) = each(%$query_parameters) ) {
+    foreach my $name (keys %$query_parameters) {
+        my $param = $query_parameters->{$name};
         $parameters->{$name} = ref $param eq 'ARRAY' ? [ @$param ] : $param;
     }
 
     # Merge query and body parameters
-    while( my($name, $param) = each(%$body_parameters) ) {
+    foreach my $name (keys %$body_parameters) {
+        my $param = $body_parameters->{$name};
         my @values = ref $param eq 'ARRAY' ? @$param : ($param);
         if ( my $existing = $parameters->{$name} ) {
           unshift(@values, (ref $existing eq 'ARRAY' ? @$existing : $existing));
@@ -436,7 +444,7 @@ process the query string and extract query parameters.
 
 sub prepare_query_parameters {
     my ( $self, $c, $query_string ) = @_;
-
+    
     # Check for keywords (no = signs)
     # (yes, index() is faster than a regex :))
     if ( index( $query_string, '=' ) < 0 ) {
@@ -448,17 +456,17 @@ sub prepare_query_parameters {
 
     # replace semi-colons
     $query_string =~ s/;/&/g;
-
-    my @params = split /&/, $query_string;
+    
+    my @params = grep { length $_ } split /&/, $query_string;
 
     for my $item ( @params ) {
-
-        my ($param, $value)
+        
+        my ($param, $value) 
             = map { $self->unescape_uri($_) }
               split( /=/, $item, 2 );
-
+          
         $param = $self->unescape_uri($item) unless defined $param;
-
+        
         if ( exists $query{$param} ) {
             if ( ref $query{$param} ) {
                 push @{ $query{$param} }, $value;
@@ -486,7 +494,7 @@ sub prepare_read {
 
     # Initialize the read position
     $self->read_position(0);
-
+    
     # Initialize the amount of data we think we need to read
     $self->read_length( $c->request->header('Content-Length') || 0 );
 }
@@ -507,11 +515,12 @@ sub prepare_uploads {
     my ( $self, $c ) = @_;
 
     my $request = $c->request;
-    return unless $request->{_body};
+    return unless $request->_body;
 
-    my $uploads = $request->{_body}->upload;
+    my $uploads = $request->_body->upload;
     my $parameters = $request->parameters;
-    while(my($name,$files) = each(%$uploads) ) {
+    foreach my $name (keys %$uploads) {
+        my $files = $uploads->{$name};
         my @uploads;
         for my $upload (ref $files eq 'ARRAY' ? @$files : ($files)) {
             my $headers = HTTP::Headers->new( %{ $upload->{headers} } );
@@ -582,7 +591,7 @@ sub read {
 
 =head2 $self->read_chunk($c, $buffer, $length)
 
-Each engine inplements read_chunk as its preferred way of reading a chunk
+Each engine implements read_chunk as its preferred way of reading a chunk
 of data.
 
 =cut
@@ -615,19 +624,21 @@ Writes the buffer to the client.
 sub write {
     my ( $self, $c, $buffer ) = @_;
 
-    unless ( $self->{_prepared_write} ) {
+    unless ( $self->_prepared_write ) {
         $self->prepare_write($c);
-        $self->{_prepared_write} = 1;
+        $self->_prepared_write(1);
     }
-
+    
+    return 0 if !defined $buffer;
+    
     my $len   = length($buffer);
     my $wrote = syswrite STDOUT, $buffer;
-
+    
     if ( !defined $wrote && $! == EWOULDBLOCK ) {
         # Unable to write on the first try, will retry in the loop below
         $wrote = 0;
     }
-
+    
     if ( defined $wrote && $wrote < $len ) {
         # We didn't write the whole buffer
         while (1) {
@@ -639,11 +650,11 @@ sub write {
                 next if $! == EWOULDBLOCK;
                 return;
             }
-
+            
             last if $wrote >= $len;
         }
     }
-
+    
     return $wrote;
 }
 
@@ -666,15 +677,25 @@ sub unescape_uri {
 
 <obsolete>, see finalize_body
 
-=head1 AUTHORS
+=head2 $self->env
+
+Hash containing enviroment variables including many special variables inserted
+by WWW server - like SERVER_*, REMOTE_*, HTTP_* ...
+
+Before accesing enviroment variables consider whether the same information is
+not directly available via Catalyst objects $c->request, $c->engine ...
 
-Sebastian Riedel, <sri@cpan.org>
+BEWARE: If you really need to access some enviroment variable from your Catalyst
+application you should use $c->engine->env->{VARNAME} instead of $ENV{VARNAME},
+as in some enviroments the %ENV hash does not contain what you would expect.
+
+=head1 AUTHORS
 
-Andy Grundman, <andy@hybridized.org>
+Catalyst Contributors, see Catalyst.pm
 
 =head1 COPYRIGHT
 
-This program is free software, you can redistribute it and/or modify it under
+This library is free software. You can redistribute it and/or modify it under
 the same terms as Perl itself.
 
 =cut