tabs => spaces

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

diff --git a/lib/Catalyst/Request.pm b/lib/Catalyst/Request.pm
index ada6c15..24e39bf 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
 
@@ -77,7 +81,11 @@ thus hiding the details of the particular engine implementation.
 
 =head2 $req->action
 
-Returns the requested action as a L<Catalyst::Action> object.
+[DEPRECATED] Returns the name of the requested action.
+
+
+Use C<< $c->action >> instead (which returns a
+L<Catalyst::Action|Catalyst::Action> object).
 
 =head2 $req->address
 
@@ -91,11 +99,11 @@ Returns a reference to an array containing the arguments.
 
 For example, if your action was
 
-       package MyApp::C::Foo;
-       
-       sub moose : Local {
-               ...
-       }
+    package MyApp::C::Foo;
+
+    sub moose : Local {
+        ...
+    }
 
 and the URI for the request was C<http://.../foo/moose/bah>, the string C<bah>
 would be the first and only argument.
@@ -136,8 +144,11 @@ 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;
 }
 
@@ -251,7 +262,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
 
@@ -269,7 +281,7 @@ is an alternative method for accessing parameters in $c->req->parameters.
 Like L<CGI>, and B<unlike> earlier versions of Catalyst, passing multiple
 arguments to this method, like this:
 
-       $c->request->param( '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>
@@ -353,23 +365,24 @@ 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;
+    }
 }
 
 =head2 $req->protocol
@@ -404,11 +417,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
 
@@ -471,7 +489,8 @@ sub upload {
 =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];
@@ -489,6 +508,36 @@ 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 ) {
+        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