X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?a=blobdiff_plain;f=lib%2FCatalyst%2FRequest.pm;h=074e3503a8e6b0b48e1f4809a4b12c20fd74db6e;hb=02fb5d7801fb6d06d064e581120fc33a7ee305e9;hp=b8391736c4e2fd83956cb82c17bc1c0eba7d61d0;hpb=3e19f4f62e73c583245bd21b6b72e20a8a0ce5fa;p=catagits%2FCatalyst-Runtime.git

diff --git a/lib/Catalyst/Request.pm b/lib/Catalyst/Request.pm
index b839173..074e350 100644
--- a/lib/Catalyst/Request.pm
+++ b/lib/Catalyst/Request.pm
@@ -4,10 +4,13 @@ use strict;
 use base 'Class::Accessor::Fast';
 
 use IO::Socket qw[AF_INET inet_aton];
+use Carp;
+use utf8;
+use URI::QueryParam;
 
 __PACKAGE__->mk_accessors(
     qw/action address arguments cookies headers match method
-      protocol query_parameters secure snippets uri user/
+      protocol query_parameters secure captures uri user/
 );
 
 *args         = \&arguments;
@@ -16,6 +19,7 @@ __PACKAGE__->mk_accessors(
 *params       = \&parameters;
 *query_params = \&query_parameters;
 *path_info    = \&path;
+*snippets     = \&captures;
 
 sub content_encoding { shift->headers->content_encoding(@_) }
 sub content_length   { shift->headers->content_length(@_) }
@@ -58,14 +62,14 @@ Catalyst::Request - provides information about the current client request
     $req->read;
     $req->referer;
     $req->secure;
-    $req->snippets;
+    $req->captures; # previously knows as snippets
     $req->upload;
     $req->uploads;
     $req->uri;
     $req->user;
     $req->user_agent;
 
-See also L<Catalyst>.
+See also L<Catalyst>, L<Catalyst::Request::Upload>.
 
 =head1 DESCRIPTION
 
@@ -75,17 +79,19 @@ thus hiding the details of the particular engine implementation.
 
 =head1 METHODS
 
-=over 4
+=head2 $req->action
 
-=item $req->action
+[DEPRECATED] Returns the name of the requested action.
 
-Returns the requested action as a L<Catalyst::Action> object.
 
-=item $req->address
+Use C<< $c->action >> instead (which returns a
+L<Catalyst::Action|Catalyst::Action> object).
+
+=head2 $req->address
 
 Returns the IP address of the client.
 
-=item $req->arguments
+=head2 $req->arguments
 
 Returns a reference to an array containing the arguments.
 
@@ -102,11 +108,11 @@ For example, if your action was
 and the URI for the request was C<http://.../foo/moose/bah>, the string C<bah>
 would be the first and only argument.
 
-=item $req->args
+=head2 $req->args
 
 Shortcut for arguments.
 
-=item $req->base
+=head2 $req->base
 
 Contains the URI base. This will always have a trailing slash.
 
@@ -130,7 +136,7 @@ sub base {
     return $self->{base};
 }
 
-=item $req->body
+=head2 $req->body
 
 Returns the message body of the request, unless Content-Type is
 C<application/x-www-form-urlencoded> or C<multipart/form-data>.
@@ -138,12 +144,15 @@ C<application/x-www-form-urlencoded> or C<multipart/form-data>.
 =cut
 
 sub body {
-    my ( $self, $body ) = @_;
+    my $self = shift;
     $self->{_context}->prepare_body;
+    
+    return unless $self->{_body};
+    
     return $self->{_body}->body;
 }
 
-=item $req->body_parameters
+=head2 $req->body_parameters
 
 Returns a reference to a hash containing body (POST) parameters. Values can
 be either a scalar or an arrayref containing scalars.
@@ -153,7 +162,7 @@ be either a scalar or an arrayref containing scalars.
 
 These are the parameters from the POST part of the request, if any.
     
-=item $req->body_params
+=head2 $req->body_params
 
 Shortcut for body_parameters.
 
@@ -166,19 +175,19 @@ sub body_parameters {
     return $self->{body_parameters};
 }
 
-=item $req->content_encoding
+=head2 $req->content_encoding
 
 Shortcut for $req->headers->content_encoding.
 
-=item $req->content_length
+=head2 $req->content_length
 
 Shortcut for $req->headers->content_length.
 
-=item $req->content_type
+=head2 $req->content_type
 
 Shortcut for $req->headers->content_type.
 
-=item $req->cookie
+=head2 $req->cookie
 
 A convenient method to access $req->cookies.
 
@@ -206,7 +215,7 @@ sub cookie {
     }
 }
 
-=item $req->cookies
+=head2 $req->cookies
 
 Returns a reference to a hash containing the cookies.
 
@@ -215,17 +224,17 @@ Returns a reference to a hash containing the cookies.
 The cookies in the hash are indexed by name, and the values are L<CGI::Cookie>
 objects.
 
-=item $req->header
+=head2 $req->header
 
 Shortcut for $req->headers->header.
 
-=item $req->headers
+=head2 $req->headers
 
 Returns an L<HTTP::Headers> object containing the headers for the current request.
 
     print $c->request->headers->header('X-Catalyst');
 
-=item $req->hostname
+=head2 $req->hostname
 
 Returns the hostname of the client.
     
@@ -246,20 +255,21 @@ sub hostname {
     return $self->{hostname};
 }
 
-=item $req->input
+=head2 $req->input
 
 Alias for $req->body.
 
-=item $req->match
+=head2 $req->match
 
 This contains the matching part of a Regex action. Otherwise
-it returns the same as 'action'.
+it returns the same as 'action', except for default actions,
+which return an empty string.
 
-=item $req->method
+=head2 $req->method
 
 Contains the request method (C<GET>, C<POST>, C<HEAD>, etc).
 
-=item $req->param
+=head2 $req->param
 
 Returns GET and POST parameters with a CGI.pm-compatible param method. This 
 is an alternative method for accessing parameters in $c->req->parameters.
@@ -268,10 +278,10 @@ is an alternative method for accessing parameters in $c->req->parameters.
     @values = $c->request->param( 'foo' );
     @params = $c->request->param;
 
-Like L<CGI>, and B<unlike> previous versions of Catalyst, passing multiple
+Like L<CGI>, and B<unlike> earlier versions of Catalyst, passing multiple
 arguments to this method, like this:
 
-	$c->request( 'foo', 'bar', 'gorch', 'quxx' );
+	$c->request->param( 'foo', 'bar', 'gorch', 'quxx' );
 
 will set the parameter C<foo> to the multiple values C<bar>, C<gorch> and
 C<quxx>. Previously this would have added C<bar> as another value to C<foo>
@@ -312,7 +322,7 @@ sub param {
     }
 }
 
-=item $req->parameters
+=head2 $req->parameters
 
 Returns a reference to a hash containing GET and POST parameters. Values can
 be either a scalar or an arrayref containing scalars.
@@ -322,7 +332,7 @@ be either a scalar or an arrayref containing scalars.
 
 This is the combination of C<query_parameters> and C<body_parameters>.
 
-=item $req->params
+=head2 $req->params
 
 Shortcut for $req->parameters.
 
@@ -331,45 +341,55 @@ Shortcut for $req->parameters.
 sub parameters {
     my ( $self, $params ) = @_;
     $self->{_context}->prepare_body;
-    $self->{parameters} = $params if $params;
+    if ( $params ) {
+        if ( ref $params ) {
+            $self->{parameters} = $params;
+        }
+        else {
+            $self->{_context}->log->warn( 
+                "Attempt to retrieve '$params' with req->params(), " .
+                "you probably meant to call req->param('$params')" );
+        }
+    }
     return $self->{parameters};
 }
 
-=item $req->path
+=head2 $req->path
 
 Returns the path, i.e. the part of the URI after $req->base, for the current request.
 
-=item $req->path_info
+=head2 $req->path_info
 
 Alias for path, added for compability with L<CGI>.
 
 =cut
 
 sub path {
-    my ( $self, $params ) = @_;
+    my ( $self, @params ) = @_;
 
-    if ($params) {
-        $self->uri->path($params);
+    if (@params) {
+        $self->uri->path(@params);
+        undef $self->{path};
     }
-    else {
-        return $self->{path} if $self->{path};
+    elsif ( defined( my $path = $self->{path} ) ) {
+        return $path;
     }
+    else {
+        my $path     = $self->uri->path;
+        my $location = $self->base->path;
+        $path =~ s/^(\Q$location\E)?//;
+        $path =~ s/^\///;
+        $self->{path} = $path;
 
-    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/^\///;
-    $self->{path} = $path;
-
-    return $path;
+        return $path;
+    }
 }
 
-=item $req->protocol
+=head2 $req->protocol
 
 Returns the protocol (HTTP/1.0 or HTTP/1.1) used for the current request.
 
-=item $req->query_parameters
+=head2 $req->query_parameters
 
 Returns a reference to a hash containing query string (GET) parameters. Values can
 be either a scalar or an arrayref containing scalars.
@@ -377,7 +397,7 @@ 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] )
+=head2 $req->read( [$maxlength] )
 
 Reads a chunk of data from the request body. This method is intended to be
 used in a while loop, reading $maxlength bytes on every call. $maxlength
@@ -389,21 +409,26 @@ You have to set MyApp->config->{parse_on_demand} to use this directly.
 
 sub read { shift->{_context}->read(@_); }
 
-=item $req->referer
+=head2 $req->referer
 
 Shortcut for $req->headers->referer. Returns the referring page.
 
-=item $req->secure
+=head2 $req->secure
 
 Returns true or false, indicating whether the connection is secure (https).
 
-=item $req->snippets
+=head2 $req->captures
+
+Returns a reference to an array containing regex captures.
 
-Returns a reference to an array containing regex snippets.
+    my @captures = @{ $c->request->captures };
 
-    my @snippets = @{ $c->request->snippets };
+=head2 $req->snippets
 
-=item $req->upload
+C<captures> used to be called snippets. This is still available for backwoards
+compatibility, but is considered deprecated.
+
+=head2 $req->upload
 
 A convenient method to access $req->uploads.
 
@@ -461,10 +486,11 @@ sub upload {
     }
 }
 
-=item $req->uploads
+=head2 $req->uploads
 
 Returns a reference to a hash containing uploads. Values can be either a
-hashref or a arrayref containing L<Catalyst::Request::Upload> objects.
+L<Catalyst::Request::Upload> object, or an arrayref of 
+L<Catalyst::Request::Upload> objects.
 
     my $upload = $c->request->uploads->{field};
     my $upload = $c->request->uploads->{field}->[0];
@@ -478,22 +504,50 @@ sub uploads {
     return $self->{uploads};
 }
 
-=item $req->uri
+=head2 $req->uri
 
 Returns a URI object for the current request. Stringifies to the URI text.
 
-=item $req->user
+=head2 $req->uri_with( { key => 'value' } );
+
+Returns a rewritten URI object for the current request. Key/value pairs
+passed in will override existing parameters. Unmodified pairs will be
+preserved.
+
+=cut
+
+sub uri_with {
+    my( $self, $args ) = @_;
+    
+    carp( 'No arguments passed to uri_with()' ) unless $args;
+
+    for my $value ( values %$args ) {
+        next unless defined $value;
+        for ( ref $value eq 'ARRAY' ? @$value : $value ) {
+            $_ = "$_";
+            utf8::encode( $_ );
+        }
+    };
+    
+    my $uri = $self->uri->clone;
+    
+    $uri->query_form( {
+        %{ $uri->query_form_hash },
+        %$args
+    } );
+    return $uri;
+}
+
+=head2 $req->user
 
 Returns the currently logged in user. Deprecated. The method recommended for
 newer plugins is $c->user.
 
-=item $req->user_agent
+=head2 $req->user_agent
 
 Shortcut to $req->headers->user_agent. Returns the user agent (browser)
 version string.
 
-=back
-
 =head1 AUTHORS
 
 Sebastian Riedel, C<sri@cpan.org>