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;
*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(@_) }
$req->headers;
$req->hostname;
$req->input;
+ $req->query_keywords;
$req->match;
$req->method;
$req->param;
$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
=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
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.
=cut
sub body {
- my ( $self, $body ) = @_;
+ my $self = shift;
$self->{_context}->prepare_body;
+
+ return unless $self->{_body};
+
return $self->{_body}->body;
}
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
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>
=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
=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.
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<captures> used to be called snippets. This is still available for backwoards
+compatibility, but is considered deprecated.
=head2 $req->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];
=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
my( $self, $args ) = @_;
carp( 'No arguments passed to uri_with()' ) unless $args;
-
- for my $value ( values %$args ) {
- my $isa_ref = ref $value;
- if( $isa_ref and $isa_ref ne 'ARRAY' ) {
- croak( "Non-array reference ($isa_ref) passed to uri_with()" );
+
+ foreach my $value ( values %$args ) {
+ next unless defined $value;
+ for ( ref $value eq 'ARRAY' ? @$value : $value ) {
+ $_ = "$_";
+ utf8::encode( $_ ) if utf8::is_utf8($_);
}
- utf8::encode( $_ ) for $isa_ref ? @$value : $value;
};
- my $uri = $self->uri->clone;
+ my $uri = $self->uri->clone;
+ my %query = ( %{ $uri->query_form_hash }, %$args );
+
$uri->query_form( {
- %{ $uri->query_form_hash },
- %$args
+ # remove undef values
+ map { defined $query{ $_ } ? ( $_ => $query{ $_ } ) : () } keys %query
} );
return $uri;
}
=head1 AUTHORS
-Sebastian Riedel, C<sri@cpan.org>
-
-Marcus Ramberg, C<mramberg@cpan.org>
+Catalyst Contributors, see Catalyst.pm
=head1 COPYRIGHT
projects / catagits/Catalyst-Runtime.git / blobdiff