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',
+);
+
+has body_parameters => (
+ is => 'rw',
+ required => 1,
+ lazy => 1,
+ default => sub { {} },
+);
+
+before body_parameters => sub {
+ my ($self) = @_;
+ $self->_context->prepare_body();
+};
+
+has uploads => (
+ is => 'rw',
+ required => 1,
+ default => sub { {} },
+);
-__PACKAGE__->mk_accessors(
- qw/action arguments base cookies headers match method parameters path
- server_base snippets uploads/
+has parameters => (
+ is => 'rw',
+ required => 1,
+ lazy => 1,
+ default => sub { {} },
);
-*args = \&arguments;
-*params = \¶meters;
+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
-See L<Catalyst>.
+ $req = $c->request;
+ $req->action;
+ $req->address;
+ $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->parameters;
+ $req->params;
+ $req->path;
+ $req->protocol;
+ $req->query_parameters;
+ $req->read;
+ $req->referer;
+ $req->secure;
+ $req->captures; # previously knows as snippets
+ $req->upload;
+ $req->uploads;
+ $req->uri;
+ $req->user;
+ $req->user_agent;
+
+See also L<Catalyst>, L<Catalyst::Request::Upload>.
=head1 DESCRIPTION
-The Catalyst Request.
+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
+
+=head2 $req->action
-=head2 METHODS
+[DEPRECATED] Returns the name of the requested action.
-=head3 action
-Contains the action.
+Use C<< $c->action >> instead (which returns a
+L<Catalyst::Action|Catalyst::Action> object).
- print $c->request->action;
+=head2 $req->address
-=head3 arguments (args)
+Returns the IP address of the client.
-Returns an arrayref containing the arguments.
+=head2 $req->arguments
+
+Returns a reference to an array containing the arguments.
print $c->request->arguments->[0];
-=head3 base
+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.
+
+Arguments just get passed through and B<don't> get unescaped automatically, so
+you should do that explicitly.
+
+=head2 $req->args
+
+Shortcut for arguments.
+
+=head2 $req->base
+
+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/>.
+
+=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>.
+
+=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.
+
+ print $c->request->body_parameters->{field};
+ print $c->request->body_parameters->{field}->[0];
-Contains the uri base.
+These are the parameters from the POST part of the request, if any.
-=head3 cookies
+=head2 $req->body_params
-Returns a hashref containing the cookies.
+Shortcut for body_parameters.
+
+=head2 $req->content_encoding
+
+Shortcut for $req->headers->content_encoding.
+
+=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;
+
+=cut
+
+sub cookie {
+ my $self = shift;
+
+ if ( @_ == 0 ) {
+ return keys %{ $self->cookies };
+ }
+
+ if ( @_ == 1 ) {
+
+ my $name = shift;
+
+ unless ( exists $self->cookies->{$name} ) {
+ return undef;
+ }
+
+ return $self->cookies->{$name};
+ }
+}
+
+=head2 $req->cookies
+
+Returns a reference to a hash containing the cookies.
print $c->request->cookies->{mycookie}->value;
-=head3 headers
+The cookies in the hash are indexed by name, and the values are L<CGI::Cookie>
+objects.
+
+=head2 $req->header
-Returns a L<HTTP::Headers> object containing the headers.
+Shortcut for $req->headers->header.
+
+=head2 $req->headers
+
+Returns an L<HTTP::Headers> object containing the headers for the current request.
print $c->request->headers->header('X-Catalyst');
-=head3 match
+=head2 $req->hostname
+
+Returns the hostname of the client.
+
+=head2 $req->input
+
+Alias for $req->body.
+
+=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', except for default actions,
+which return an empty string.
+
+=head2 $req->method
-Contains the match.
+Contains the request method (C<GET>, C<POST>, C<HEAD>, etc).
- print $c->request->match;
+=head2 $req->param
-=head3 parameters (params)
+Returns GET and POST parameters with a CGI.pm-compatible param method. This
+is an alternative method for accessing parameters in $c->req->parameters.
-Returns a hashref containing the parameters.
+ $value = $c->request->param( 'foo' );
+ @values = $c->request->param( 'foo' );
+ @params = $c->request->param;
- print $c->request->parameters->{foo};
+Like L<CGI>, and B<unlike> earlier versions of Catalyst, passing multiple
+arguments to this method, like this:
-=head3 path
+ $c->request->param( 'foo', 'bar', 'gorch', 'quxx' );
-Contains the path.
+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>.
- print $c->request->path;
+=cut
+
+sub param {
+ my $self = shift;
+
+ if ( @_ == 0 ) {
+ return keys %{ $self->parameters };
+ }
+
+ if ( @_ == 1 ) {
+
+ my $param = shift;
+
+ unless ( exists $self->parameters->{$param} ) {
+ return wantarray ? () : undef;
+ }
+
+ if ( ref $self->parameters->{$param} eq 'ARRAY' ) {
+ return (wantarray)
+ ? @{ $self->parameters->{$param} }
+ : $self->parameters->{$param}->[0];
+ }
+ else {
+ return (wantarray)
+ ? ( $self->parameters->{$param} )
+ : $self->parameters->{$param};
+ }
+ }
+ elsif ( @_ > 1 ) {
+ my $field = shift;
+ $self->parameters->{$field} = [@_];
+ }
+}
+
+=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.
+
+ 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 compatibility with L<CGI>.
+
+=cut
+
+sub path {
+ my ( $self, @params ) = @_;
+
+ if (@params) {
+ $self->uri->path(@params);
+ $self->_clear_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);
+
+ return $path;
+ }
+}
+
+=head2 $req->protocol
+
+Returns the protocol (HTTP/1.0 or HTTP/1.1) used for the current request.
+
+=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];
+
+=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
+defaults to the size of the request if not specified.
+
+You have to set MyApp->config->{parse_on_demand} to use this directly.
+
+=head2 $req->referer
-=head3 method
+Shortcut for $req->headers->referer. Returns the referring page.
-Contains the request method.
+=head2 $req->secure
- print $c->request->method
+Returns true or false, indicating whether the connection is secure (https).
-=head3 server_base
+=head2 $req->captures
-Contains the server part of the uri base.
+Returns a reference to an array containing captured args from chained
+actions or regex captures.
-=head3 snippets
+ my @captures = @{ $c->request->captures };
-Returns an arrayref 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.
-=head3 uploads
+=head2 $req->upload
-Returns a hashref containing the uploads.
+A convenient method to access $req->uploads.
- my $filename = $c->req->parameters->{foo};
- print $c->request->uploads->{$filename}->type;
- print $c->request->uploads->{$filename}->size;
- my $fh = $c->request->uploads->{$filename}->fh;
- my $content = do { local $/; <$fh> };
+ $upload = $c->request->upload('field');
+ @uploads = $c->request->upload('field');
+ @fields = $c->request->upload;
-=head1 AUTHOR
+ for my $upload ( $c->request->upload('field') ) {
+ print $upload->filename;
+ }
-Sebastian Riedel, C<sri@cpan.org>
+=cut
+
+sub upload {
+ my $self = shift;
+
+ if ( @_ == 0 ) {
+ return keys %{ $self->uploads };
+ }
+
+ if ( @_ == 1 ) {
+
+ my $upload = shift;
+
+ unless ( exists $self->uploads->{$upload} ) {
+ return wantarray ? () : undef;
+ }
+
+ if ( ref $self->uploads->{$upload} eq 'ARRAY' ) {
+ return (wantarray)
+ ? @{ $self->uploads->{$upload} }
+ : $self->uploads->{$upload}->[0];
+ }
+ else {
+ return (wantarray)
+ ? ( $self->uploads->{$upload} )
+ : $self->uploads->{$upload};
+ }
+ }
+
+ if ( @_ > 1 ) {
+
+ while ( my ( $field, $upload ) = splice( @_, 0, 2 ) ) {
+
+ if ( exists $self->uploads->{$field} ) {
+ for ( $self->uploads->{$field} ) {
+ $_ = [$_] unless ref($_) eq "ARRAY";
+ push( @$_, $upload );
+ }
+ }
+ else {
+ $self->uploads->{$field} = $upload;
+ }
+ }
+ }
+}
+
+=head2 $req->uploads
+
+Returns a reference to a hash containing uploads. Values can be either a
+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 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.
+
+=head2 $req->user_agent
+
+Shortcut to $req->headers->user_agent. Returns the user agent (browser)
+version string.
+
+=head2 meta
+
+Provided by Moose
+
+=head1 AUTHORS
+
+Catalyst Contributors, see Catalyst.pm
=head1 COPYRIGHT
-This program is free software, you can redistribute it and/or modify it under
-the same terms as Perl itself.
+This program is free software, you can redistribute it and/or modify
+it under the same terms as Perl itself.
=cut
+__PACKAGE__->meta->make_immutable;
+
1;
projects / catagits/Catalyst-Runtime.git / blobdiff