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;
*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
=head1 METHODS
-=over 4
+=head2 $req->action
-=item $req->action
+[DEPRECATED] Returns the name of the requested action.
-Returns the requested action as a L<Catalyst::Action> object.
-=item $req->address
+Use C<< $c->action >> instead (which returns a
+L<Catalyst::Action|Catalyst::Action> object).
+
+=head2 $req->address
Returns the IP address of the client.
-=item $req->arguments
+=head2 $req->arguments
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.
-=item $req->args
+=head2 $req->args
Shortcut for arguments.
-=item $req->base
+=head2 $req->base
Contains the URI base. This will always have a trailing slash.
return $self->{base};
}
-=item $req->body
+=head2 $req->body
Returns the message body of the request, unless Content-Type is
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;
}
-=item $req->body_parameters
+=head2 $req->body_parameters
Returns a reference to a hash containing body (POST) parameters. Values can
be either a scalar or an arrayref containing scalars.
These are the parameters from the POST part of the request, if any.
-=item $req->body_params
+=head2 $req->body_params
Shortcut for body_parameters.
return $self->{body_parameters};
}
-=item $req->content_encoding
+=head2 $req->content_encoding
Shortcut for $req->headers->content_encoding.
-=item $req->content_length
+=head2 $req->content_length
Shortcut for $req->headers->content_length.
-=item $req->content_type
+=head2 $req->content_type
Shortcut for $req->headers->content_type.
-=item $req->cookie
+=head2 $req->cookie
A convenient method to access $req->cookies.
}
}
-=item $req->cookies
+=head2 $req->cookies
Returns a reference to a hash containing the cookies.
The cookies in the hash are indexed by name, and the values are L<CGI::Cookie>
objects.
-=item $req->header
+=head2 $req->header
Shortcut for $req->headers->header.
-=item $req->headers
+=head2 $req->headers
Returns an L<HTTP::Headers> object containing the headers for the current request.
print $c->request->headers->header('X-Catalyst');
-=item $req->hostname
+=head2 $req->hostname
Returns the hostname of the client.
return $self->{hostname};
}
-=item $req->input
+=head2 $req->input
Alias for $req->body.
-=item $req->match
+=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.
-=item $req->method
+=head2 $req->method
Contains the request method (C<GET>, C<POST>, C<HEAD>, etc).
-=item $req->param
+=head2 $req->param
Returns GET and POST parameters with a CGI.pm-compatible param method. This
is an alternative method for accessing parameters in $c->req->parameters.
@values = $c->request->param( 'foo' );
@params = $c->request->param;
-Like L<CGI>, and B<unlike> previous versions of Catalyst, passing multiple
+Like L<CGI>, and B<unlike> earlier versions of Catalyst, passing multiple
arguments to this method, like this:
- $c->request( '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>
}
}
-=item $req->parameters
+=head2 $req->parameters
Returns a reference to a hash containing GET and POST parameters. Values can
be either a scalar or an arrayref containing scalars.
This is the combination of C<query_parameters> and C<body_parameters>.
-=item $req->params
+=head2 $req->params
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};
}
-=item $req->path
+=head2 $req->path
Returns the path, i.e. the part of the URI after $req->base, for the current request.
-=item $req->path_info
+=head2 $req->path_info
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;
+ }
}
-=item $req->protocol
+=head2 $req->protocol
Returns the protocol (HTTP/1.0 or HTTP/1.1) used for the current request.
-=item $req->query_parameters
+=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.
print $c->request->query_parameters->{field};
print $c->request->query_parameters->{field}->[0];
-=item $req->read( [$maxlength] )
+=head2 $req->read( [$maxlength] )
Reads a chunk of data from the request body. This method is intended to be
used in a while loop, reading $maxlength bytes on every call. $maxlength
sub read { shift->{_context}->read(@_); }
-=item $req->referer
+=head2 $req->referer
Shortcut for $req->headers->referer. Returns the referring page.
-=item $req->secure
+=head2 $req->secure
Returns true or false, indicating whether the connection is secure (https).
-=item $req->snippets
+=head2 $req->captures
+
+Returns a reference to an array containing regex captures.
+
+ my @captures = @{ $c->request->captures };
-Returns a reference to an array containing regex snippets.
+=head2 $req->snippets
- my @snippets = @{ $c->request->snippets };
+C<captures> used to be called snippets. This is still available for backwoards
+compatibility, but is considered deprecated.
-=item $req->upload
+=head2 $req->upload
A convenient method to access $req->uploads.
}
}
-=item $req->uploads
+=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];
return $self->{uploads};
}
-=item $req->uri
+=head2 $req->uri
Returns a URI object for the current request. Stringifies to the URI text.
-=item $req->user
+=head2 $req->uri_with( { key => 'value' } );
+
+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
+
+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 %query = ( %{ $uri->query_form_hash }, %$args );
+
+ $uri->query_form( {
+ # remove undef values
+ map { defined $query{ $_ } ? ( $_ => $query{ $_ } ) : () } keys %query
+ } );
+ return $uri;
+}
+
+=head2 $req->user
Returns the currently logged in user. Deprecated. The method recommended for
newer plugins is $c->user.
-=item $req->user_agent
+=head2 $req->user_agent
Shortcut to $req->headers->user_agent. Returns the user agent (browser)
version string.
-=back
-
=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