X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?a=blobdiff_plain;f=lib%2FCatalyst%2FRequest.pm;h=b38b693e1e0904f7057fa0757e9ccfcaab694c5f;hb=79f8efb873b3bb1d33f156969a5ce5c95d28f4cf;hp=04b7338a626f3a915d49681aec03450d88ec7a0b;hpb=06e1b6164a2c9d7b463f358b0d1934ef83a82845;p=catagits%2FCatalyst-Runtime.git

diff --git a/lib/Catalyst/Request.pm b/lib/Catalyst/Request.pm
index 04b7338..b38b693 100644
--- a/lib/Catalyst/Request.pm
+++ b/lib/Catalyst/Request.pm
@@ -3,37 +3,26 @@ package Catalyst::Request;
 use strict;
 use base 'Class::Accessor::Fast';
 
+use IO::Socket qw[AF_INET inet_aton];
+
 __PACKAGE__->mk_accessors(
-    qw/action address arguments base cookies headers input hostname match 
-      method parameters path snippets uploads/
+    qw/action address arguments base cookies headers match method
+      protocol query_parameters secure snippets uri user/
 );
 
-*args   = \&arguments;
-*params = \&parameters;
+*args         = \&arguments;
+*body_params  = \&body_parameters;
+*input        = \&body;
+*params       = \&parameters;
+*query_params = \&query_parameters;
+*path_info    = \&path;
 
 sub content_encoding { shift->headers->content_encoding(@_) }
-sub content_length   { shift->headers->content_length(@_)   }
-sub content_type     { shift->headers->content_type(@_)     }
-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;
-        }
-    }
-}
+sub content_length   { shift->headers->content_length(@_) }
+sub content_type     { shift->headers->content_type(@_) }
+sub header           { shift->headers->header(@_) }
+sub referer          { shift->headers->referer(@_) }
+sub user_agent       { shift->headers->user_agent(@_) }
 
 =head1 NAME
 
@@ -49,9 +38,11 @@ Catalyst::Request - Catalyst Request Class
     $req->arguments;
     $req->base;
     $req->body;
+    $req->body_parameters;
     $req->content_encoding;
     $req->content_length;
     $req->content_type;
+    $req->cookie;
     $req->cookies;
     $req->header;
     $req->headers;
@@ -63,11 +54,17 @@ Catalyst::Request - Catalyst Request Class
     $req->params;
     $req->parameters;
     $req->path;
+    $req->protocol;
+    $req->query_parameters;
+    $req->read;
     $req->referer;
+    $req->secure;
     $req->snippets;
     $req->upload;
     $req->uploads;
-    $req->user_agent
+    $req->uri;
+    $req->user;
+    $req->user_agent;
 
 See also L<Catalyst>.
 
@@ -110,7 +107,39 @@ Contains the url base. This will always have a trailing slash.
 
 =item $req->body
 
-Shortcut for $req->input.
+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
+
+=cut
+
+sub body {
+    my ( $self, $body ) = @_;
+    $self->{_context}->prepare_body;
+    return $self->{_body}->body;
+}
+
+=item $req->body_parameters
+
+Returns a reference to a hash containing body parameters. Values can
+be either a scalar or an arrayref containing scalars.
+
+    print $c->request->body_parameters->{field};
+    print $c->request->body_parameters->{field}->[0];
+    
+=item $req->body_params
+
+An alias for body_parameters.
+
+=cut
+
+sub body_parameters {
+    my ( $self, $params ) = @_;
+    $self->{_context}->prepare_body;
+    $self->{body_parameters} = $params if $params;
+    return $self->{body_parameters};
+}
 
 =item $req->content_encoding
 
@@ -124,6 +153,34 @@ Shortcut to $req->headers->content_length
 
 Shortcut to $req->headers->content_type
 
+=item $req->cookie
+
+A convenient method to $req->cookies.
+
+    $cookie  = $c->request->cookie('name');
+    @cookies = $c->request->cookie;
+
+=cut
+
+sub cookie {
+    my $self = shift;
+
+    if ( @_ == 0 ) {
+        return keys %{ $self->cookies };
+    }
+
+    if ( @_ == 1 ) {
+
+        my $name = shift;
+
+        unless ( exists $self->cookies->{$name} ) {
+            return undef;
+        }
+
+        return $self->cookies->{$name};
+    }
+}
+
 =item $req->cookies
 
 Returns a reference to a hash containing the cookies.
@@ -142,21 +199,35 @@ Returns an L<HTTP::Headers> object containing the headers.
 
 =item $req->hostname
 
-Contains the hostname of the remote user.
+Lookup the current users DNS hostname.
 
     print $c->request->hostname
+    
+=cut
 
-=item $req->input
+sub hostname {
+    my $self = shift;
 
-Contains the message body of the request unless Content-Type is
-C<application/x-www-form-urlencoded> or C<multipart/form-data>.
+    if ( @_ == 0 && not $self->{hostname} ) {
+        $self->{hostname} =
+          gethostbyaddr( inet_aton( $self->address ), AF_INET );
+    }
+
+    if ( @_ == 1 ) {
+        $self->{hostname} = shift;
+    }
 
-    print $c->request->input
+    return $self->{hostname};
+}
+
+=item $req->input
+
+Shortcut for $req->body.
 
 =item $req->match
 
-This contains be the matching part of a regexp action. otherwise it
-returns the same as 'action'.
+This contains the matching part of a regexp action. Otherwise
+it returns the same as 'action'.
 
     print $c->request->match;
 
@@ -168,7 +239,8 @@ Contains the request method (C<GET>, C<POST>, C<HEAD>, etc).
 
 =item $req->param
 
-Get request parameters with a CGI.pm like param method.
+Get request parameters with a CGI.pm-compatible param method. This 
+is a method for accessing parameters in $c->req->parameters.
 
     $value  = $c->request->param('foo');
     @values = $c->request->param('foo');
@@ -183,21 +255,42 @@ sub param {
         return keys %{ $self->parameters };
     }
 
-    my $param = shift;
+    if ( @_ == 1 ) {
 
-    unless ( exists $self->parameters->{$param} ) {
-        return wantarray ? () : undef;
-    }
+        my $param = shift;
+
+        unless ( exists $self->parameters->{$param} ) {
+            return wantarray ? () : undef;
+        }
 
-    if ( ref $self->parameters->{$param} eq 'ARRAY' ) {
-        return (wantarray)
-          ? @{ $self->parameters->{$param} }
-          : $self->parameters->{$param}->[0];
+        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 ( @_ > 1 ) {
+
+        while ( my ( $field, $value ) = splice( @_, 0, 2 ) ) {
+
+            next unless defined $field;
+
+            if ( exists $self->parameters->{$field} ) {
+                for ( $self->parameters->{$field} ) {
+                    $_ = [$_] unless ref($_) eq "ARRAY";
+                    push( @$_, $value );
+                }
+            }
+            else {
+                $self->parameters->{$field} = $value;
+            }
+        }
     }
 }
 
@@ -208,21 +301,80 @@ Shortcut for $req->parameters.
 =item $req->parameters
 
 Returns a reference to a hash containing parameters. Values can
-be either a scalar or a arrayref containing scalars.
+be either a scalar or an arrayref containing scalars.
 
     print $c->request->parameters->{field};
     print $c->request->parameters->{field}->[0];
 
+=cut
+
+sub parameters {
+    my ( $self, $params ) = @_;
+    $self->{_context}->prepare_body;
+    $self->{parameters} = $params if $params;
+    return $self->{parameters};
+}
+
 =item $req->path
 
 Contains the path.
 
     print $c->request->path;
 
+=item $req->path_info
+
+alias for path, added for compability with L<CGI>
+
+=cut
+
+sub path {
+    my ( $self, $params ) = @_;
+
+    if ($params) {
+        $self->uri->path($params);
+    }
+
+    my $path     = $self->uri->path;
+    my $location = $self->base->path;
+    $path =~ s/^(\Q$location\E)?//;
+    $path =~ s/%([0-9A-Fa-f]{2})/chr(hex($1))/eg;
+    $path =~ s/^\///;
+
+    return $path;
+}
+
+=item $req->protocol
+
+Contains the protocol.
+
+=item $req->query_parameters
+
+Returns a reference to a hash containing query parameters. Values can
+be either a scalar or an arrayref containing scalars.
+
+    print $c->request->query_parameters->{field};
+    print $c->request->query_parameters->{field}->[0];
+    
+=item $req->read( [$maxlength] )
+
+Read a chunk of data from the request body.  This method is designed to be
+used in a while loop, reading $maxlength bytes on every call.  $maxlength
+defaults to the size of the request if not specified.
+
+You have to set MyApp->config->{parse_on_demand} to use this directly.
+
+=cut
+
+sub read { shift->{_context}->read(@_); }
+
 =item $req->referer
 
 Shortcut to $req->headers->referer. Referring page.
 
+=item $req->secure
+
+Contains a boolean denoting whether the communication is secure.
+
 =item $req->snippets
 
 Returns a reference to an array containing regex snippets.
@@ -236,7 +388,7 @@ 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;
     }
@@ -250,32 +402,68 @@ 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 ( @_ > 1 ) {
+
+        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 
+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];
 
+=cut
+
+sub uploads {
+    my ( $self, $uploads ) = @_;
+    $self->{_context}->prepare_body;
+    $self->{uploads} = $uploads if $uploads;
+    return $self->{uploads};
+}
+
+=item $req->uri
+
+Returns a URI object for the request.
+
+=item $req->user
+
+Contains the user name of user if authentication check was successful.
+
 =item $req->user_agent
 
 Shortcut to $req->headers->user_agent. User Agent version string.