X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?p=catagits%2FCatalyst-Runtime.git;a=blobdiff_plain;f=lib%2FCatalyst%2FRequest.pm;h=72103606170cf26e111a19427a35262aff513c2b;hp=f9ff7b327d4e4f968dd6315a6c42ad6c7f892bcb;hb=0bf7ab7160f4f2fd0f00cd3d53ac311e9ad50241;hpb=bd917b94298b00325cb9db7551897c2471ca78ff diff --git a/lib/Catalyst/Request.pm b/lib/Catalyst/Request.pm index f9ff7b3..7210360 100644 --- a/lib/Catalyst/Request.pm +++ b/lib/Catalyst/Request.pm @@ -5,10 +5,14 @@ use base 'Class::Accessor::Fast'; use IO::Socket qw[AF_INET inet_aton]; use Carp; +use utf8; +use URI::http; +use URI::https; +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; @@ -17,6 +21,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(@_) } @@ -48,6 +53,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; @@ -59,14 +65,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 @@ -78,7 +84,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 @@ -92,11 +102,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. @@ -137,8 +147,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; } @@ -249,6 +262,15 @@ 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 @@ -271,7 +293,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 @@ -355,22 +377,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/^\///; - $self->{path} = $path; - - return $path; + return $path; + } } =head2 $req->protocol @@ -379,6 +403,8 @@ Returns the protocol (HTTP/1.0 or HTTP/1.1) used for the current request. =head2 $req->query_parameters +=head2 $req->query_params + Returns a reference to a hash containing query string (GET) parameters. Values can be either a scalar or an arrayref containing scalars. @@ -405,11 +431,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 }; - my @snippets = @{ $c->request->snippets }; +=head2 $req->snippets + +C used to be called snippets. This is still available for backwoards +compatibility, but is considered deprecated. =head2 $req->upload @@ -472,7 +503,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]; @@ -492,8 +524,10 @@ Returns a URI object for the current request. Stringifies to the URI text. =head2 $req->uri_with( { key => 'value' } ); -Returns a rewriten URI object for the current uri. Key/value pairs passed in -will override existing parameters. Unmodified pairs will be preserved. +Returns a rewritten URI object for the current request. Key/value pairs +passed in will override existing parameters. You can remove an existing +parameter by passing in an undef value. Unmodified pairs will be +preserved. =cut @@ -501,12 +535,21 @@ sub uri_with { my( $self, $args ) = @_; carp( 'No arguments passed to uri_with()' ) unless $args; + + foreach my $value ( values %$args ) { + next unless defined $value; + for ( ref $value eq 'ARRAY' ? @$value : $value ) { + $_ = "$_"; + utf8::encode( $_ ) if utf8::is_utf8($_); + } + }; - my $uri = $self->uri->clone; - + my $uri = $self->uri->clone; + my %query = ( %{ $uri->query_form_hash }, %$args ); + $uri->query_form( { - $uri->query_form, - %$args + # remove undef values + map { defined $query{ $_ } ? ( $_ => $query{ $_ } ) : () } keys %query } ); return $uri; } @@ -523,9 +566,7 @@ version string. =head1 AUTHORS -Sebastian Riedel, C - -Marcus Ramberg, C +Catalyst Contributors, see Catalyst.pm =head1 COPYRIGHT