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 body base cookies headers match method
- parameters path protocol secure snippets uploads user/
+ qw/action address arguments cookies headers match method
+ protocol query_parameters secure captures uri user/
);
-*args = \&arguments;
-*input = \&body;
-*params = \¶meters;
+*args = \&arguments;
+*body_params = \&body_parameters;
+*input = \&body;
+*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(@_) }
-sub content_type { shift->headers->content_type(@_) }
-sub header { shift->headers->header(@_) }
-sub referer { shift->headers->referer(@_) }
-sub user_agent { shift->headers->user_agent(@_) }
+sub content_length { shift->headers->content_length(@_) }
+sub content_type { shift->headers->content_type(@_) }
+sub header { shift->headers->header(@_) }
+sub referer { shift->headers->referer(@_) }
+sub user_agent { shift->headers->user_agent(@_) }
=head1 NAME
-Catalyst::Request - Catalyst Request Class
+Catalyst::Request - provides information about the current client request
=head1 SYNOPSIS
-
$req = $c->request;
$req->action;
$req->address;
- $req->args;
$req->arguments;
+ $req->args;
$req->base;
$req->body;
+ $req->body_parameters;
$req->content_encoding;
$req->content_length;
$req->content_type;
$req->cookie;
$req->cookies;
- $req->full_uri;
$req->header;
$req->headers;
$req->hostname;
$req->match;
$req->method;
$req->param;
- $req->params;
$req->parameters;
+ $req->params;
$req->path;
$req->protocol;
+ $req->query_parameters;
+ $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
-This is the Catalyst Request class, which provides a set of accessors to the
-request data. The request object is prepared by the specialized Catalyst
-Engine module thus hiding the details of the particular engine implementation.
-
+This is the Catalyst Request class, which provides an interface to data for the
+current client request. The request object is prepared by L<Catalyst::Engine>,
+thus hiding the details of the particular engine implementation.
=head1 METHODS
-=over 4
+=head2 $req->action
+
+[DEPRECATED] Returns the name of the requested action.
-=item $req->action
-Contains the requested action.
+Use C<< $c->action >> instead (which returns a
+L<Catalyst::Action|Catalyst::Action> object).
- print $c->request->action;
+=head2 $req->address
-=item $req->address
+Returns the IP address of the client.
-Contains the remote address.
+=head2 $req->arguments
- print $c->request->address
+Returns a reference to an array containing the arguments.
-=item $req->args
+ print $c->request->arguments->[0];
-Shortcut for arguments
+For example, if your action was
-=item $req->arguments
+ package MyApp::C::Foo;
+
+ sub moose : Local {
+ ...
+ }
-Returns a reference to an array containing the arguments.
+and the URI for the request was C<http://.../foo/moose/bah>, the string C<bah>
+would be the first and only argument.
- print $c->request->arguments->[0];
+=head2 $req->args
-=item $req->base
+Shortcut for arguments.
-Contains the url base. This will always have a trailing slash.
+=head2 $req->base
-=item $req->body
+Contains the URI base. This will always have a trailing slash.
+
+If your application was queried with the URI
+C<http://localhost:3000/some/path> then C<base> is C<http://localhost:3000/>.
+
+=cut
-Contains the message body of the request unless Content-Type is
+sub base {
+ my ( $self, $base ) = @_;
+
+ return $self->{base} unless $base;
+
+ $self->{base} = $base;
+
+ # set the value in path for backwards-compat
+ if ( $self->uri ) {
+ $self->path;
+ }
+
+ return $self->{base};
+}
+
+=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>.
- print $c->request->body
+=cut
-=item $req->content_encoding
+sub body {
+ my $self = shift;
+ $self->{_context}->prepare_body;
+
+ return unless $self->{_body};
+
+ return $self->{_body}->body;
+}
-Shortcut to $req->headers->content_encoding
+=head2 $req->body_parameters
-=item $req->content_length
+Returns a reference to a hash containing body (POST) parameters. Values can
+be either a scalar or an arrayref containing scalars.
+
+ print $c->request->body_parameters->{field};
+ print $c->request->body_parameters->{field}->[0];
+
+These are the parameters from the POST part of the request, if any.
+
+=head2 $req->body_params
-Shortcut to $req->headers->content_length
+Shortcut for body_parameters.
-=item $req->content_type
+=cut
+
+sub body_parameters {
+ my ( $self, $params ) = @_;
+ $self->{_context}->prepare_body;
+ $self->{body_parameters} = $params if $params;
+ return $self->{body_parameters};
+}
-Shortcut to $req->headers->content_type
+=head2 $req->content_encoding
-=item $req->cookie
+Shortcut for $req->headers->content_encoding.
-A convenient method to $req->cookies.
+=head2 $req->content_length
+
+Shortcut for $req->headers->content_length.
+
+=head2 $req->content_type
+
+Shortcut for $req->headers->content_type.
+
+=head2 $req->cookie
+
+A convenient method to access $req->cookies.
$cookie = $c->request->cookie('name');
@cookies = $c->request->cookie;
unless ( exists $self->cookies->{$name} ) {
return undef;
}
-
+
return $self->cookies->{$name};
}
}
-=item $req->cookies
+=head2 $req->cookies
Returns a reference to a hash containing the cookies.
print $c->request->cookies->{mycookie}->value;
-=item $req->full_uri
+The cookies in the hash are indexed by name, and the values are L<CGI::Cookie>
+objects.
-Returns the complete URI, with the parameter query string.
+=head2 $req->header
-=cut
-
-sub full_uri {
- my $self = shift;
- my $full_uri = $self->uri;
-
- if ( scalar $self->param ) {
- my @params;
- foreach my $arg ( sort keys %{ $self->params } ) {
- if ( ref $self->params->{$arg} ) {
- my $list = $self->params->{$arg};
- push @params, map { "$arg=" . $_ } sort @{$list};
- } else {
- push @params, "$arg=" . $self->params->{$arg};
- }
- }
- $full_uri .= '?' . join( '&', @params );
- }
- return $full_uri;
-}
+Shortcut for $req->headers->header.
-=item $req->header
+=head2 $req->headers
-Shortcut to $req->headers->header
-
-=item $req->headers
-
-Returns an L<HTTP::Headers> object containing the headers.
+Returns an L<HTTP::Headers> object containing the headers for the current request.
print $c->request->headers->header('X-Catalyst');
-=item $req->hostname
-
-Lookup the current users DNS hostname.
+=head2 $req->hostname
- print $c->request->hostname
+Returns the hostname of the client.
=cut
my $self = shift;
if ( @_ == 0 && not $self->{hostname} ) {
- $self->{hostname} = gethostbyaddr( inet_aton( $self->address ), AF_INET );
+ $self->{hostname} =
+ gethostbyaddr( inet_aton( $self->address ), AF_INET );
}
if ( @_ == 1 ) {
return $self->{hostname};
}
-=item $req->input
+=head2 $req->input
-Shortcut for $req->body.
+Alias for $req->body.
-=item $req->match
+=head2 $req->match
-This contains the matching part of a regexp action. Otherwise
-it returns the same as 'action'.
+This contains the matching part of a Regex action. Otherwise
+it returns the same as 'action', except for default actions,
+which return an empty string.
- print $c->request->match;
-
-=item $req->method
+=head2 $req->method
Contains the request method (C<GET>, C<POST>, C<HEAD>, etc).
- print $c->request->method;
-
-=item $req->param
+=head2 $req->param
-Get request parameters with a CGI.pm-compatible param method. This
-is a method for accessing parameters in $c->req->parameters.
+Returns GET and POST parameters with a CGI.pm-compatible param method. This
+is an alternative method for accessing parameters in $c->req->parameters.
- $value = $c->request->param('foo');
- @values = $c->request->param('foo');
+ $value = $c->request->param( 'foo' );
+ @values = $c->request->param( 'foo' );
@params = $c->request->param;
+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' );
+
+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>
+(creating it if it didn't exist before), and C<quxx> as another value for
+C<gorch>.
+
=cut
sub param {
: $self->parameters->{$param};
}
}
+ elsif ( @_ > 1 ) {
+ my $field = shift;
+ $self->parameters->{$field} = [@_];
+ }
+}
- if ( @_ > 1 ) {
+=head2 $req->parameters
- while ( my ( $field, $value ) = splice( @_, 0, 2 ) ) {
-
- next unless defined $field;
+Returns a reference to a hash containing GET and POST parameters. Values can
+be either a scalar or an arrayref containing scalars.
- if ( exists $self->parameters->{$field} ) {
- for ( $self->parameters->{$field} ) {
- $_ = [$_] unless ref($_) eq "ARRAY";
- push( @$_, $value );
- }
- }
- else {
- $self->parameters->{$field} = $value;
- }
+ print $c->request->parameters->{field};
+ print $c->request->parameters->{field}->[0];
+
+This is the combination of C<query_parameters> and C<body_parameters>.
+
+=head2 $req->params
+
+Shortcut for $req->parameters.
+
+=cut
+
+sub parameters {
+ my ( $self, $params ) = @_;
+ $self->{_context}->prepare_body;
+ 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->params
+=head2 $req->path
-Shortcut for $req->parameters.
+Returns the path, i.e. the part of the URI after $req->base, for the current request.
+
+=head2 $req->path_info
+
+Alias for path, added for compability with L<CGI>.
+
+=cut
+
+sub path {
+ my ( $self, $params ) = @_;
+
+ if ($params) {
+ $self->uri->path($params);
+ }
+ else {
+ return $self->{path} if $self->{path};
+ }
+
+ my $path = $self->uri->path;
+ my $location = $self->base->path;
+ $path =~ s/^(\Q$location\E)?//;
+ $path =~ s/^\///;
+ $self->{path} = $path;
+
+ return $path;
+}
+
+=head2 $req->protocol
+
+Returns the protocol (HTTP/1.0 or HTTP/1.1) used for the current request.
-=item $req->parameters
+=head2 $req->query_parameters
-Returns a reference to a hash containing parameters. Values can
+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->parameters->{field};
- print $c->request->parameters->{field}->[0];
+ print $c->request->query_parameters->{field};
+ print $c->request->query_parameters->{field}->[0];
+
+=head2 $req->read( [$maxlength] )
-=item $req->path
+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
+defaults to the size of the request if not specified.
-Contains the path.
+You have to set MyApp->config->{parse_on_demand} to use this directly.
- print $c->request->path;
+=cut
+
+sub read { shift->{_context}->read(@_); }
-=item $req->protocol
+=head2 $req->referer
-Contains the protocol.
+Shortcut for $req->headers->referer. Returns the referring page.
-=item $req->referer
+=head2 $req->secure
-Shortcut to $req->headers->referer. Referring page.
+Returns true or false, indicating whether the connection is secure (https).
-=item $req->secure
+=head2 $req->captures
-Contains a boolean whether the communciation is secure.
+Returns a reference to an array containing regex captures.
-=item $req->snippets
+ 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 $req->uploads.
+A convenient method to access $req->uploads.
$upload = $c->request->upload('field');
@uploads = $c->request->upload('field');
}
else {
return (wantarray)
- ? ( $self->uploads->{$upload} )
- : $self->uploads->{$upload};
+ ? ( $self->uploads->{$upload} )
+ : $self->uploads->{$upload};
}
}
}
}
-=item $req->uploads
+=head2 $req->uploads
Returns a reference to a hash containing uploads. Values can be either a
-hashref or a arrayref containing C<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];
-=item $req->uri
+=cut
+
+sub uploads {
+ my ( $self, $uploads ) = @_;
+ $self->{_context}->prepare_body;
+ $self->{uploads} = $uploads if $uploads;
+ return $self->{uploads};
+}
+
+=head2 $req->uri
+
+Returns a URI object for the current request. Stringifies to the URI text.
-Shortcut for C<< $req->base . $req->path >>.
+=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 {
- my $self = shift;
- my $path = shift || $self->path || '';
- return $self->base . $path;
-}
+sub uri_with {
+ my( $self, $args ) = @_;
+
+ carp( 'No arguments passed to uri_with()' ) unless $args;
-=item $req->user
+ 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;
+}
-Contains the user name of user if authentication check was successful.
+=head2 $req->user
-=item $req->user_agent
+Returns the currently logged in user. Deprecated. The method recommended for
+newer plugins is $c->user.
-Shortcut to $req->headers->user_agent. User Agent version string.
+=head2 $req->user_agent
-=back
+Shortcut to $req->headers->user_agent. Returns the user agent (browser)
+version string.
-=head1 AUTHOR
+=head1 AUTHORS
Sebastian Riedel, C<sri@cpan.org>
+
Marcus Ramberg, C<mramberg@cpan.org>
=head1 COPYRIGHT