X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?a=blobdiff_plain;f=lib%2FCatalyst%2FRequest.pm;h=763c3ef700b82e9c5920cf41006cbfb1d62f598a;hb=6365b5279cf3bbecd61735b3b744809983a7bfdc;hp=ada6c155f088399da2ef14b49450270d3ecacff7;hpb=ee26f4bd0cef4af7cebaf255664024c7bf92bb88;p=catagits%2FCatalyst-Runtime.git diff --git a/lib/Catalyst/Request.pm b/lib/Catalyst/Request.pm index ada6c15..763c3ef 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/ + qw/action address arguments cookies headers query_keywords match method + protocol query_parameters secure captures uri user/ ); *args = \&arguments; @@ -16,6 +19,7 @@ __PACKAGE__->mk_accessors( *params = \¶meters; *query_params = \&query_parameters; *path_info = \&path; +*snippets = \&captures; sub content_encoding { shift->headers->content_encoding(@_) } sub content_length { shift->headers->content_length(@_) } @@ -47,6 +51,7 @@ Catalyst::Request - provides information about the current client request $req->headers; $req->hostname; $req->input; + $req->query_keywords; $req->match; $req->method; $req->param; @@ -58,14 +63,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. +See also L, L. =head1 DESCRIPTION @@ -77,7 +82,11 @@ thus hiding the details of the particular engine implementation. =head2 $req->action -Returns the requested action as a L object. +[DEPRECATED] Returns the name of the requested action. + + +Use C<< $c->action >> instead (which returns a +L object). =head2 $req->address @@ -91,11 +100,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, the string C would be the first and only argument. @@ -136,8 +145,11 @@ C or C. =cut sub body { - my ( $self, $body ) = @_; + my $self = shift; $self->{_context}->prepare_body; + + return unless $self->{_body}; + return $self->{_body}->body; } @@ -248,10 +260,20 @@ sub hostname { Alias for $req->body. +=head2 $req->query_keywords + +Contains the keywords portion of a query string, when no '=' signs are +present. + + http://localhost/path?some+keywords + + $c->request->query_keywords will contain 'some keywords' + =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 +291,7 @@ is an alternative method for accessing parameters in $c->req->parameters. Like L, and B 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 to the multiple values C, C and C. Previously this would have added C as another value to C @@ -353,23 +375,24 @@ Alias for path, added for compability with L. =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 +427,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 captures. -Returns a reference to an array containing regex snippets. + my @captures = @{ $c->request->captures }; + +=head2 $req->snippets - my @snippets = @{ $c->request->snippets }; +C used to be called snippets. This is still available for backwoards +compatibility, but is considered deprecated. =head2 $req->upload @@ -471,7 +499,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 objects. +L object, or an arrayref of +L objects. my $upload = $c->request->uploads->{field}; my $upload = $c->request->uploads->{field}->[0]; @@ -489,6 +518,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