Fix to allow uri_for and uri_with to stringify non-array references

[catagits/Catalyst-Runtime.git] / lib / Catalyst / Request.pm

diff --git a/lib/Catalyst/Request.pm b/lib/Catalyst/Request.pm
index 3dfbee4..219a7c1 100644 (file)
--- 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
 
@@ -251,7 +255,8 @@ Alias for $req->body.
 =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.
 
 =head2 $req->method
 
@@ -329,7 +334,16 @@ 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};
 }
 
@@ -356,7 +370,6 @@ sub 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;
 
@@ -395,11 +408,16 @@ Shortcut for $req->headers->referer. Returns the referring page.
 
 Returns true or false, indicating whether the connection is secure (https).
 
-=head2 $req->snippets
+=head2 $req->captures
 
-Returns a reference to an array containing regex snippets.
+Returns a reference to an array containing regex captures.
 
-    my @snippets = @{ $c->request->snippets };
+    my @captures = @{ $c->request->captures };
+
+=head2 $req->snippets
+
+C<captures> used to be called snippets. This is still available for backwoards
+compatibility, but is considered deprecated.
 
 =head2 $req->upload
 
@@ -480,6 +498,35 @@ sub uploads {
 
 Returns a URI object for the current request. Stringifies to the URI text.
 
+=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 ) {
+        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