Added $c-req->protocol and $c->req->secure
[catagits/Catalyst-Runtime.git] / lib / Catalyst / Request.pm
index f076fbd..d8b69b2 100644 (file)
@@ -4,11 +4,12 @@ use strict;
 use base 'Class::Accessor::Fast';
 
 __PACKAGE__->mk_accessors(
-    qw/action address arguments base cookies headers hostname match method
-      parameters path snippets uploads/
+    qw/action address arguments body base cookies headers hostname match
+      method parameters path protocol secure snippets uploads/
 );
 
 *args   = \&arguments;
+*input  = \&body;
 *params = \&parameters;
 
 sub content_encoding { shift->headers->content_encoding(@_) }
@@ -18,24 +19,6 @@ sub header           { shift->headers->header(@_)           }
 sub referer          { shift->headers->referer(@_)          }
 sub user_agent       { shift->headers->user_agent(@_)       }
 
-
-sub _assign_values {
-    my ( $self, $map, $values ) = @_;
-    
-    while ( my ( $name, $value ) = splice( @{ $values }, 0, 2 ) ) {
-
-        if ( exists $map->{$name} ) {
-            for ( $map->{$name} ) {
-                $_ = [$_] unless ref($_) eq "ARRAY";
-                push( @$_, $value );
-            }
-        }
-        else {
-            $map->{$name} = $value;
-        }
-    }
-}
-
 =head1 NAME
 
 Catalyst::Request - Catalyst Request Class
@@ -49,6 +32,7 @@ Catalyst::Request - Catalyst Request Class
     $req->args;
     $req->arguments;
     $req->base;
+    $req->body;
     $req->content_encoding;
     $req->content_length;
     $req->content_type;
@@ -56,13 +40,16 @@ Catalyst::Request - Catalyst Request Class
     $req->header;
     $req->headers;
     $req->hostname;
+    $req->input;
     $req->match;
     $req->method;
     $req->param;
     $req->params;
     $req->parameters;
     $req->path;
+    $req->protocol;
     $req->referer;
+    $req->secure;
     $req->snippets;
     $req->upload;
     $req->uploads;
@@ -107,6 +94,13 @@ Returns a reference to an array containing the arguments.
 
 Contains the url base. This will always have a trailing slash.
 
+=item $req->body
+
+Contains the message body of the request unless Content-Type is
+C<application/x-www-form-urlencoded> or C<multipart/form-data>.
+
+    print $c->request->body
+
 =item $req->content_encoding
 
 Shortcut to $req->headers->content_encoding
@@ -141,6 +135,10 @@ Contains the hostname of the remote user.
 
     print $c->request->hostname
 
+=item $req->input
+
+Shortcut for $req->body.
+
 =item $req->match
 
 This contains be the matching part of a regexp action. otherwise it
@@ -171,21 +169,40 @@ sub param {
         return keys %{ $self->parameters };
     }
 
-    my $param = shift;
+    if ( @_ == 1 ) {
 
-    unless ( exists $self->parameters->{$param} ) {
-        return wantarray ? () : undef;
-    }
+        my $param = shift;
 
-    if ( ref $self->parameters->{$param} eq 'ARRAY' ) {
-        return (wantarray)
-          ? @{ $self->parameters->{$param} }
-          : $self->parameters->{$param}->[0];
+        unless ( exists $self->parameters->{$param} ) {
+            return wantarray ? () : undef;
+        }
+
+        if ( ref $self->parameters->{$param} eq 'ARRAY' ) {
+            return (wantarray)
+              ? @{ $self->parameters->{$param} }
+              : $self->parameters->{$param}->[0];
+        }
+        else {
+            return (wantarray)
+              ? ( $self->parameters->{$param} )
+              : $self->parameters->{$param};
+        }
     }
-    else {
-        return (wantarray)
-          ? ( $self->parameters->{$param} )
-          : $self->parameters->{$param};
+
+    if ( @_ => 2  ) {
+
+        while ( my ( $field, $value ) = splice( @_, 0, 2 ) ) {
+
+            if ( exists $self->parameters->{$field} ) {
+                for ( $self->parameters->{$field} ) {
+                    $_ = [$_] unless ref($_) eq "ARRAY";
+                    push( @$_, $value );
+                }
+            }
+            else {
+                $self->parameters->{$field} = $value;
+            }
+        }
     }
 }
 
@@ -207,10 +224,18 @@ Contains the path.
 
     print $c->request->path;
 
+=item $req->protocol
+
+Contains the protocol.
+
 =item $req->referer
 
 Shortcut to $req->headers->referer. Referring page.
 
+=item $req->secure
+
+Contains a boolean whether the communciation is secure.
+
 =item $req->snippets
 
 Returns a reference to an array containing regex snippets.
@@ -224,9 +249,9 @@ A convenient method to $req->uploads.
     $upload  = $c->request->upload('field');
     @uploads = $c->request->upload('field');
     @fields  = $c->request->upload;
-    
+
     for my $upload ( $c->request->upload('field') ) {
-        print $upload->{filename};
+        print $upload->filename;
     }
 
 =cut
@@ -238,58 +263,51 @@ sub upload {
         return keys %{ $self->uploads };
     }
 
-    my $upload = shift;
+    if ( @_ == 1 ) {
 
-    unless ( exists $self->uploads->{$upload} ) {
-        return wantarray ? () : undef;
-    }
+        my $upload = shift;
+
+        unless ( exists $self->uploads->{$upload} ) {
+            return wantarray ? () : undef;
+        }
 
-    if ( ref $self->uploads->{$upload} eq 'ARRAY' ) {
-        return (wantarray)
-          ? @{ $self->uploads->{$upload} }
-          : $self->uploads->{$upload}->[0];
+        if ( ref $self->uploads->{$upload} eq 'ARRAY' ) {
+            return (wantarray)
+              ? @{ $self->uploads->{$upload} }
+              : $self->uploads->{$upload}->[0];
+        }
+        else {
+            return (wantarray)
+               ? ( $self->uploads->{$upload} )
+               : $self->uploads->{$upload};
+        }
     }
-    else {
-        return (wantarray)
-          ? ( $self->uploads->{$upload} )
-          : $self->uploads->{$upload};
+
+    if ( @_ => 2 ) {
+
+        while ( my ( $field, $upload ) = splice( @_, 0, 2 ) ) {
+
+            if ( exists $self->uploads->{$field} ) {
+                for ( $self->uploads->{$field} ) {
+                    $_ = [$_] unless ref($_) eq "ARRAY";
+                    push( @$_, $upload );
+                }
+            }
+            else {
+                $self->uploads->{$field} = $upload;
+            }
+        }
     }
 }
 
 =item $req->uploads
 
-Returns a reference to a hash containing uploads. Values can
-be either a hashref or a arrayref containing hashrefs.
+Returns a reference to a hash containing uploads. Values can be either a
+hashref or a arrayref containing C<Catalyst::Request::Upload> objects.
 
     my $upload = $c->request->uploads->{field};
     my $upload = $c->request->uploads->{field}->[0];
 
-The upload hashref contains the following keys:
-
-=over 4
-
-=item * fh 
-
-Filehandle.
-
-=item * filename 
-
-Client supplied filename.
-
-=item * size
-
-Size of the file in bytes.
-
-=item * tempname
-
-Path to the temporary spool file.
-
-=item * type
-
-Client supplied Content-Type.
-
-=back
-
 =item $req->user_agent
 
 Shortcut to $req->headers->user_agent. User Agent version string.