package Catalyst::Request;
-use strict;
-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;
+use HTTP::Headers;
+
+use Moose;
+
+use namespace::clean -except => 'meta';
+
+with 'MooseX::Emulate::Class::Accessor::Fast';
+
+has action => (is => 'rw');
+has address => (is => 'rw');
+has arguments => (is => 'rw', default => sub { [] });
+has cookies => (is => 'rw', default => sub { {} });
+has query_keywords => (is => 'rw');
+has match => (is => 'rw');
+has method => (is => 'rw');
+has protocol => (is => 'rw');
+has query_parameters => (is => 'rw', default => sub { {} });
+has secure => (is => 'rw', default => 0);
+has captures => (is => 'rw', default => sub { [] });
+has uri => (is => 'rw', predicate => 'has_uri');
+has user => (is => 'rw');
+has headers => (
+ is => 'rw',
+ isa => 'HTTP::Headers',
+ handles => [qw(content_encoding content_length content_type header referer user_agent)],
+ default => sub { HTTP::Headers->new() },
+ required => 1,
+ lazy => 1,
+);
+
+# Moose TODO:
+# - Can we lose the before modifiers which just call prepare_body ?
+# they are wasteful, slow us down and feel cluttery.
+# Can we call prepare_body at BUILD time?
+# Can we make _body an attribute, have the rest of
+# these lazy build from there and kill all the direct hash access
+# in Catalyst.pm and Engine.pm?
+
+has _context => (
+ is => 'rw',
+ weak_ref => 1,
+ handles => ['read'],
+ clearer => '_clear_context',
+);
-__PACKAGE__->mk_accessors(
- qw/action address arguments cookies headers match method
- protocol query_parameters secure snippets uri user/
+has body_parameters => (
+ is => 'rw',
+ required => 1,
+ lazy => 1,
+ default => sub { {} },
);
-*args = \&arguments;
-*body_params = \&body_parameters;
-*input = \&body;
-*params = \¶meters;
-*query_params = \&query_parameters;
-*path_info = \&path;
+before body_parameters => sub {
+ my ($self) = @_;
+ $self->_context->prepare_body();
+};
-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(@_) }
+has uploads => (
+ is => 'rw',
+ required => 1,
+ default => sub { {} },
+);
+
+has parameters => (
+ is => 'rw',
+ required => 1,
+ lazy => 1,
+ default => sub { {} },
+);
+
+before parameters => sub {
+ my ($self, $params) = @_;
+ if ( $params && !ref $params ) {
+ $self->_context->log->warn(
+ "Attempt to retrieve '$params' with req->params(), " .
+ "you probably meant to call req->param('$params')" );
+ $params = undef;
+ }
+
+};
+
+has base => (
+ is => 'rw',
+ required => 1,
+ lazy => 1,
+ default => sub {
+ my $self = shift;
+ return $self->path if $self->has_uri;
+ },
+);
+
+has _body => (
+ is => 'rw', clearer => '_clear_body', predicate => '_has_body',
+);
+# Eugh, ugly. Should just be able to rename accessor methods to 'body'
+# and provide a custom reader..
+sub body {
+ my $self = shift;
+ $self->_context->prepare_body();
+ $self->_body(@_) if scalar @_;
+ return blessed $self->_body ? $self->_body->body : $self->_body;
+}
+
+has hostname => (
+ is => 'rw',
+ required => 1,
+ lazy => 1,
+ default => sub {
+ my ($self) = @_;
+ gethostbyaddr( inet_aton( $self->address ), AF_INET ) || 'localhost'
+ },
+);
+
+has _path => ( is => 'rw', predicate => '_has_path', clearer => '_clear_path' );
+
+sub args { shift->arguments(@_) }
+sub body_params { shift->body_parameters(@_) }
+sub input { shift->body(@_) }
+sub params { shift->parameters(@_) }
+sub query_params { shift->query_parameters(@_) }
+sub path_info { shift->path(@_) }
+sub snippets { shift->captures(@_) }
=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->headers;
$req->hostname;
$req->input;
+ $req->query_keywords;
$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
-
-=item $req->action
+=head2 $req->action
-Contains the requested action.
+[DEPRECATED] Returns the name of the requested action.
- print $c->request->action;
-=item $req->address
+Use C<< $c->action >> instead (which returns a
+L<Catalyst::Action|Catalyst::Action> object).
-Contains the remote address.
+=head2 $req->address
- print $c->request->address
+Returns the IP address of the client.
-=item $req->args
-
-Shortcut for arguments
-
-=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 {
- ...
- }
-
-And the URI for the request was C<http://.../foo/moose/bah> the string C<bah>
-would be the first and only argument.
+ package MyApp::C::Foo;
-=item $req->base
+ sub moose : Local {
+ ...
+ }
-Contains the URI base. This will always have a trailing slash.
+and the URI for the request was C<http://.../foo/moose/bah>, the string C<bah>
+would be the first and only argument.
-If your application was queried with the URI C<http://localhost:3000/some/path>
-then C<base> is C<http://localhost:3000/>.
+Arguments just get passed through and B<don't> get unescaped automatically, so
+you should do that explicitly.
-=cut
+=head2 $req->args
-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};
-}
+Shortcut for arguments.
-=item $req->body
+=head2 $req->base
-Contains the message body of the request unless Content-Type is
-C<application/x-www-form-urlencoded> or C<multipart/form-data>.
+Contains the URI base. This will always have a trailing slash.
- print $c->request->body
+If your application was queried with the URI
+C<http://localhost:3000/some/path> then C<base> is C<http://localhost:3000/>.
-=cut
+=head2 $req->body
-sub body {
- my ( $self, $body ) = @_;
- $self->{_context}->prepare_body;
- return $self->{_body}->body;
-}
+Returns the message body of the request, unless Content-Type is
+C<application/x-www-form-urlencoded> or C<multipart/form-data>.
-=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 paramaters from the POST part of the request, if any.
-
-=item $req->body_params
-
-An alias for body_parameters.
+These are the parameters from the POST part of the request, if any.
-=cut
+=head2 $req->body_params
-sub body_parameters {
- my ( $self, $params ) = @_;
- $self->{_context}->prepare_body;
- $self->{body_parameters} = $params if $params;
- return $self->{body_parameters};
-}
+Shortcut for 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;
-The cookies in the hash are indexed by name, and the values are C<CGI::Cookie>
+The cookies in the hash are indexed by name, and the values are L<CGI::Cookie>
objects.
-=item $req->header
+=head2 $req->header
-Shortcut to $req->headers->header
+Shortcut for $req->headers->header.
-=item $req->headers
+=head2 $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
+=head2 $req->hostname
-Lookup the current users DNS hostname.
+Returns the hostname of the client.
- print $c->request->hostname
-
-=cut
-
-sub hostname {
- my $self = shift;
+=head2 $req->input
- if ( @_ == 0 && not $self->{hostname} ) {
- $self->{hostname} =
- gethostbyaddr( inet_aton( $self->address ), AF_INET );
- }
+Alias for $req->body.
- if ( @_ == 1 ) {
- $self->{hostname} = shift;
- }
+=head2 $req->query_keywords
- return $self->{hostname};
-}
+Contains the keywords portion of a query string, when no '=' signs are
+present.
-=item $req->input
+ http://localhost/path?some+keywords
+
+ $c->request->query_keywords will contain 'some keywords'
-Shortcut for $req->body.
+=head2 $req->match
-=item $req->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.
-This contains the matching part of a regexp action. Otherwise
-it returns the same as 'action'.
+=head2 $req->method
- print $c->request->match;
+Contains the request method (C<GET>, C<POST>, C<HEAD>, etc).
-=item $req->method
+=head2 $req->param
-Contains the request method (C<GET>, C<POST>, C<HEAD>, etc).
+Returns GET and POST parameters with a CGI.pm-compatible param method. This
+is an alternative method for accessing parameters in $c->req->parameters.
- print $c->request->method;
+ $value = $c->request->param( 'foo' );
+ @values = $c->request->param( 'foo' );
+ @params = $c->request->param;
-=item $req->param
+Like L<CGI>, and B<unlike> earlier versions of Catalyst, passing multiple
+arguments to this method, like this:
-Get request parameters with a CGI.pm-compatible param method. This
-is a method for accessing parameters in $c->req->parameters.
+ $c->request->param( 'foo', 'bar', 'gorch', 'quxx' );
- $value = $c->request->param('foo');
- @values = $c->request->param('foo');
- @params = $c->request->param;
+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
: $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
+=head2 $req->parameters
-Shortcut for $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};
This is the combination of C<query_parameters> and C<body_parameters>.
-=cut
-
-sub parameters {
- my ( $self, $params ) = @_;
- $self->{_context}->prepare_body;
- $self->{parameters} = $params if $params;
- return $self->{parameters};
-}
+=head2 $req->params
-=item $req->path
+Shortcut for $req->parameters.
-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 compatibility with L<CGI>.
=cut
sub path {
- my ( $self, $params ) = @_;
+ my ( $self, @params ) = @_;
- if ($params) {
- $self->uri->path($params);
+ if (@params) {
+ $self->uri->path(@params);
+ $self->_clear_path;
}
- else {
- return $self->{path} if $self->{path};
+ elsif ( $self->_has_path ) {
+ return $self->_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.
-Contains the protocol.
+=head2 $req->query_parameters
-=item $req->query_parameters
+=head2 $req->query_params
-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];
-
-These are the parameters from the query string portion of the request's URI, if
-any.
-=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.
-=cut
+=head2 $req->referer
-sub read { shift->{_context}->read(@_); }
+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 denoting whether the communication is secure.
+Returns a reference to an array containing captured args from chained
+actions or 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 backwards
+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');
}
}
-=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];
+=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. You can remove an existing
+parameter by passing in an undef value. Unmodified pairs will be
+preserved.
+
=cut
-sub uploads {
- my ( $self, $uploads ) = @_;
- $self->{_context}->prepare_body;
- $self->{uploads} = $uploads if $uploads;
- return $self->{uploads};
-}
+sub uri_with {
+ my( $self, $args ) = @_;
+
+ carp( 'No arguments passed to uri_with()' ) unless $args;
-=item $req->uri
+ 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;
+}
-Returns a URI object for the request.
+=head2 $req->user
-=item $req->user
+Returns the currently logged in user. Deprecated. The method recommended for
+newer plugins is $c->user.
-Contains the user name of user if authentication check was successful.
+=head2 $req->user_agent
-=item $req->user_agent
+Shortcut to $req->headers->user_agent. Returns the user agent (browser)
+version string.
-Shortcut to $req->headers->user_agent. User Agent version string.
+=head2 meta
-=back
+Provided by Moose
-=head1 AUTHOR
+=head1 AUTHORS
-Sebastian Riedel, C<sri@cpan.org>
-Marcus Ramberg, C<mramberg@cpan.org>
+Catalyst Contributors, see Catalyst.pm
=head1 COPYRIGHT
=cut
+__PACKAGE__->meta->make_immutable;
+
1;
projects / catagits/Catalyst-Runtime.git / blobdiff