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 base cookies headers match method
- protocol query_parameters secure snippets uri user/
+ qw/action address arguments cookies headers 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(@_) }
=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->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
-=item $req->action
+Returns the requested action as a L<Catalyst::Action> object.
-Contains the requested action.
+=head2 $req->address
- print $c->request->action;
+Returns the IP address of the client.
-=item $req->address
+=head2 $req->arguments
-Contains the remote address.
+Returns a reference to an array containing the arguments.
- print $c->request->address
+ print $c->request->arguments->[0];
-=item $req->args
+For example, if your action was
-Shortcut for arguments
+ package MyApp::C::Foo;
+
+ sub moose : Local {
+ ...
+ }
-=item $req->arguments
+and the URI for the request was C<http://.../foo/moose/bah>, the string C<bah>
+would be the first and only argument.
-Returns a reference to an array containing the arguments.
+=head2 $req->args
- print $c->request->arguments->[0];
+Shortcut for arguments.
-=item $req->base
+=head2 $req->base
-Contains the url base. This will always have a trailing slash.
+Contains the URI base. This will always have a trailing slash.
-=item $req->body
+If your application was queried with the URI
+C<http://localhost:3000/some/path> then C<base> is C<http://localhost:3000/>.
-Contains the message body of the request unless Content-Type is
-C<application/x-www-form-urlencoded> or C<multipart/form-data>.
+=cut
+
+sub base {
+ my ( $self, $base ) = @_;
- print $c->request->body
+ 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>.
=cut
return $self->{_body}->body;
}
-=item $req->body_parameters
+=head2 $req->body_parameters
-Returns a reference to a hash containing body parameters. Values can
+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.
-=item $req->body_params
+=head2 $req->body_params
-An alias for body_parameters.
+Shortcut for body_parameters.
=cut
return $self->{body_parameters};
}
-=item $req->content_encoding
+=head2 $req->content_encoding
-Shortcut to $req->headers->content_encoding
+Shortcut for $req->headers->content_encoding.
-=item $req->content_length
+=head2 $req->content_length
-Shortcut to $req->headers->content_length
+Shortcut for $req->headers->content_length.
-=item $req->content_type
+=head2 $req->content_type
-Shortcut to $req->headers->content_type
+Shortcut for $req->headers->content_type.
-=item $req->cookie
+=head2 $req->cookie
-A convenient method to $req->cookies.
+A convenient method to access $req->cookies.
$cookie = $c->request->cookie('name');
@cookies = $c->request->cookie;
}
}
-=item $req->cookies
+=head2 $req->cookies
Returns a reference to a hash containing the cookies.
print $c->request->cookies->{mycookie}->value;
-=item $req->header
+The cookies in the hash are indexed by name, and the values are L<CGI::Cookie>
+objects.
-Shortcut to $req->headers->header
+=head2 $req->header
-=item $req->headers
+Shortcut for $req->headers->header.
-Returns an L<HTTP::Headers> object containing the headers.
+=head2 $req->headers
- print $c->request->headers->header('X-Catalyst');
+Returns an L<HTTP::Headers> object containing the headers for the current request.
-=item $req->hostname
+ print $c->request->headers->header('X-Catalyst');
-Lookup the current users DNS hostname.
+=head2 $req->hostname
- print $c->request->hostname
+Returns the hostname of the client.
=cut
return $self->{hostname};
}
-=item $req->input
-
-Shortcut for $req->body.
+=head2 $req->input
-=item $req->match
+Alias for $req->body.
-This contains the matching part of a regexp action. Otherwise
-it returns the same as 'action'.
+=head2 $req->match
- print $c->request->match;
+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.
-=item $req->method
+=head2 $req->method
Contains the request method (C<GET>, C<POST>, C<HEAD>, etc).
- print $c->request->method;
+=head2 $req->param
-=item $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.
-Get request parameters with a CGI.pm-compatible param method. This
-is a 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};
}
}
-
- if ( @_ > 1 ) {
-
- while ( my ( $field, $value ) = splice( @_, 0, 2 ) ) {
-
- next unless defined $field;
-
- if ( exists $self->parameters->{$field} ) {
- for ( $self->parameters->{$field} ) {
- $_ = [$_] unless ref($_) eq "ARRAY";
- push( @$_, $value );
- }
- }
- else {
- $self->parameters->{$field} = $value;
- }
- }
+ elsif ( @_ > 1 ) {
+ my $field = shift;
+ $self->parameters->{$field} = [@_];
}
}
-=item $req->params
-
-Shortcut for $req->parameters.
+=head2 $req->parameters
-=item $req->parameters
-
-Returns a reference to a hash containing parameters. Values can
+Returns a reference to a hash containing GET and POST parameters. Values can
be either a scalar or an arrayref containing scalars.
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;
- $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
-
-Contains the path.
+=head2 $req->path
- print $c->request->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>
+Alias for path, added for compability with L<CGI>.
=cut
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/%([0-9A-Fa-f]{2})/chr(hex($1))/eg;
$path =~ s/^\///;
+ $self->{path} = $path;
return $path;
}
-=item $req->protocol
+=head2 $req->protocol
-Contains the protocol.
+Returns the protocol (HTTP/1.0 or HTTP/1.1) used for the current request.
-=item $req->query_parameters
+=head2 $req->query_parameters
-Returns a reference to a hash containing query 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->query_parameters->{field};
print $c->request->query_parameters->{field}->[0];
-=item $req->read( [$maxlength] )
+=head2 $req->read( [$maxlength] )
-Read a chunk of data from the request body. This method is designed to be
-used in a while loop, reading $maxlength bytes on every call. $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
defaults to the size of the request if not specified.
You have to set MyApp->config->{parse_on_demand} to use this directly.
sub read { shift->{_context}->read(@_); }
-=item $req->referer
+=head2 $req->referer
+
+Shortcut for $req->headers->referer. Returns the referring page.
-Shortcut to $req->headers->referer. Referring page.
+=head2 $req->secure
-=item $req->secure
+Returns true or false, indicating whether the connection is secure (https).
-Contains a boolean denoting whether the communication is secure.
+=head2 $req->captures
-=item $req->snippets
+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
-=item $req->upload
+C<captures> used to be called snippets. This is still available for backwoards
+compatibility, but is considered deprecated.
-A convenient method to $req->uploads.
+=head2 $req->upload
+
+A convenient method to access $req->uploads.
$upload = $c->request->upload('field');
@uploads = $c->request->upload('field');
}
}
-=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.
+hashref or a arrayref containing 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.
+
+=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.
-Returns a URI object for the request.
+=cut
+
+sub uri_with {
+ my( $self, $args ) = @_;
+
+ carp( 'No arguments passed to uri_with()' ) unless $args;
-=item $req->user
+ for my $value ( values %$args ) {
+ 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
projects / catagits/Catalyst-Runtime.git / blobdiff