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 Moose;
+
+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');
+has user => (is => 'rw');
+has headers => (
+ is => 'rw',
+ isa => 'HTTP::Headers',
+ handles => [qw(content_encoding content_length content_type header referer user_agent)],
+);
+
+has _context => (
+ is => 'rw',
+ weak_ref => 1,
+);
+
+has body_parameters => (
+ is => 'rw',
+ required => 1,
+ lazy => 1,
+ default => sub { {} },
+);
+
+before body_parameters => sub {
+ my ($self) = @_;
+ $self->_context->prepare_body();
+};
-__PACKAGE__->mk_accessors(
- qw/action address arguments body base cookies headers match method
- parameters path protocol secure snippets uploads user/
+has uploads => (
+ is => 'rw',
+ required => 1,
+ lazy => 1,
+ default => sub { {} },
);
-*args = \&arguments;
-*input = \&body;
-*params = \¶meters;
+before uploads => 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 parameters => (
+ is => 'rw',
+ required => 1,
+ lazy => 1,
+ default => sub { {} },
+);
+
+before parameters => sub {
+ my ($self, $params) = @_;
+ $self->_context->prepare_body();
+ 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;
+ if( $self->uri ){
+ return $self->path;
+ }
+ },
+);
+
+has body => (
+ is => 'rw'
+);
+
+before body => sub {
+ my ($self) = @_;
+ $self->_context->prepare_body();
+};
+
+has hostname => (
+ is => 'rw',
+ required => 1,
+ lazy => 1,
+ default => sub {
+ my ($self) = @_;
+ gethostbyaddr( inet_aton( $self->address ), AF_INET )
+ },
+);
+
+no Moose;
+
+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->content_encoding;
$req->content_length;
$req->content_type;
+ $req->cookie;
$req->cookies;
$req->header;
$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
+=head2 $req->action
-=item $req->action
+[DEPRECATED] Returns the name of the requested action.
-Contains the requested action.
- print $c->request->action;
+Use C<< $c->action >> instead (which returns a
+L<Catalyst::Action|Catalyst::Action> object).
-=item $req->address
+=head2 $req->address
-Contains the remote address.
+Returns the IP address of the client.
- print $c->request->address
+=head2 $req->arguments
-=item $req->args
+Returns a reference to an array containing the arguments.
-Shortcut for arguments
+ print $c->request->arguments->[0];
-=item $req->arguments
+For example, if your action was
-Returns a reference to an array containing the arguments.
+ package MyApp::C::Foo;
- print $c->request->arguments->[0];
+ sub moose : Local {
+ ...
+ }
-=item $req->base
+and the URI for the request was C<http://.../foo/moose/bah>, the string C<bah>
+would be the first and only argument.
-Contains the url base. This will always have a trailing slash.
+=head2 $req->args
-=item $req->body
+Shortcut for arguments.
-Contains the message body of the request unless Content-Type is
-C<application/x-www-form-urlencoded> or C<multipart/form-data>.
+=head2 $req->base
- print $c->request->body
+Contains the URI base. This will always have a trailing slash.
-=item $req->content_encoding
+If your application was queried with the URI
+C<http://localhost:3000/some/path> then C<base> is C<http://localhost:3000/>.
-Shortcut to $req->headers->content_encoding
+=head2 $req->body
-=item $req->content_length
+Returns the message body of the request, unless Content-Type is
+C<application/x-www-form-urlencoded> or C<multipart/form-data>.
-Shortcut to $req->headers->content_length
+=head2 $req->body_parameters
-=item $req->content_type
+Returns a reference to a hash containing body (POST) parameters. Values can
+be either a scalar or an arrayref containing scalars.
-Shortcut to $req->headers->content_type
+ print $c->request->body_parameters->{field};
+ print $c->request->body_parameters->{field}->[0];
-=item $req->cookies
+These are the parameters from the POST part of the request, if any.
-Returns a reference to a hash containing the cookies.
+=head2 $req->body_params
- print $c->request->cookies->{mycookie}->value;
+Shortcut for body_parameters.
-=item $req->header
+=head2 $req->content_encoding
-Shortcut to $req->headers->header
+Shortcut for $req->headers->content_encoding.
-=item $req->headers
+=head2 $req->content_length
-Returns an L<HTTP::Headers> object containing the headers.
+Shortcut for $req->headers->content_length.
- print $c->request->headers->header('X-Catalyst');
+=head2 $req->content_type
-=item $req->hostname
+Shortcut for $req->headers->content_type.
-Lookup the current users DNS hostname.
+=head2 $req->cookie
+
+A convenient method to access $req->cookies.
+
+ $cookie = $c->request->cookie('name');
+ @cookies = $c->request->cookie;
- print $c->request->hostname
-
=cut
-sub hostname {
+sub cookie {
my $self = shift;
- if ( @_ == 0 && not $self->{hostname} ) {
- $self->{hostname} = gethostbyaddr( inet_aton( $self->address ), AF_INET );
+ if ( @_ == 0 ) {
+ return keys %{ $self->cookies };
}
if ( @_ == 1 ) {
- $self->{hostname} = shift;
- }
- return $self->{hostname};
+ my $name = shift;
+
+ unless ( exists $self->cookies->{$name} ) {
+ return undef;
+ }
+
+ return $self->cookies->{$name};
+ }
}
-=item $req->input
+=head2 $req->cookies
-Shortcut for $req->body.
+Returns a reference to a hash containing the cookies.
-=item $req->match
+ print $c->request->cookies->{mycookie}->value;
-This contains the matching part of a regexp action. Otherwise
-it returns the same as 'action'.
+The cookies in the hash are indexed by name, and the values are L<CGI::Cookie>
+objects.
- print $c->request->match;
+=head2 $req->header
-=item $req->method
+Shortcut for $req->headers->header.
-Contains the request method (C<GET>, C<POST>, C<HEAD>, etc).
+=head2 $req->headers
+
+Returns an L<HTTP::Headers> object containing the headers for the current request.
+
+ print $c->request->headers->header('X-Catalyst');
+
+=head2 $req->hostname
+
+Returns the hostname of the client.
+
+=head2 $req->input
+
+Alias for $req->body.
+
+=head2 $req->query_keywords
- print $c->request->method;
+Contains the keywords portion of a query string, when no '=' signs are
+present.
-=item $req->param
+ http://localhost/path?some+keywords
-Get request parameters with a CGI.pm-compatible param method. This
-is a method for accessing parameters in $c->req->parameters.
+ $c->request->query_keywords will contain 'some keywords'
- $value = $c->request->param('foo');
- @values = $c->request->param('foo');
+=head2 $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.
+
+=head2 $req->method
+
+Contains the request method (C<GET>, C<POST>, C<HEAD>, etc).
+
+=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.
+
+ $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.
+
+=head2 $req->path
+
+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);
+ undef $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;
+
+ return $path;
}
}
-=item $req->params
+=head2 $req->protocol
-Shortcut for $req->parameters.
+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
-be either a scalar or a arrayref containing scalars.
+=head2 $req->query_params
- print $c->request->parameters->{field};
- print $c->request->parameters->{field}->[0];
+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];
+
+=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
+=head2 $req->uri
+
+Returns a URI object for the current request. Stringifies to the URI text.
+
+=head2 $req->uri_with( { key => 'value' } );
-Shortcut for C<< $req->base . $req->path >>.
+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;
+
+ for 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;
+
+ $uri->query_form( {
+ %{ $uri->query_form_hash },
+ %$args
+ } );
+ return $uri;
}
-=item $req->user
+=head2 $req->user
-Contains the user name of user if authentication check was successful.
+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. User Agent version string.
+Shortcut to $req->headers->user_agent. Returns the user agent (browser)
+version string.
-=back
+=head2 meta
-=head1 AUTHOR
+Provided by Moose
+
+=head1 AUTHORS
Sebastian Riedel, C<sri@cpan.org>
+
Marcus Ramberg, C<mramberg@cpan.org>
=head1 COPYRIGHT
=cut
+__PACKAGE__->meta->make_immutable;
+
1;
projects / catagits/Catalyst-Runtime.git / blobdiff