use strict;
use base 'Class::Accessor::Fast';
+use IO::Socket qw[AF_INET inet_aton];
+
__PACKAGE__->mk_accessors(
- qw/action address arguments body base cookies headers hostname match
- method parameters path snippets uploads/
+ qw/action address arguments body base cookies headers match method
+ parameters path protocol secure snippets uploads user/
);
*args = \&arguments;
$req->arguments;
$req->base;
$req->body;
- $req->body_length;
- $req->body_ref;
$req->content_encoding;
$req->content_length;
$req->content_type;
+ $req->cookie;
$req->cookies;
+ $req->full_uri;
$req->header;
$req->headers;
$req->hostname;
$req->params;
$req->parameters;
$req->path;
+ $req->protocol;
$req->referer;
+ $req->secure;
$req->snippets;
$req->upload;
$req->uploads;
- $req->user_agent
+ $req->uri;
+ $req->user;
+ $req->user_agent;
See also L<Catalyst>.
print $c->request->body
-=item $req->body_length
+=item $req->content_encoding
-Returns the length of body in bytes.
+Shortcut to $req->headers->content_encoding
- print $c->request->body_length
+=item $req->content_length
-=cut
+Shortcut to $req->headers->content_length
-sub body_length {
- my $self = shift;
-
- use bytes;
-
- return 0 unless $self->body;
- return length($self->body);
-}
+=item $req->content_type
-=item $req->body_ref
+Shortcut to $req->headers->content_type
-Returns a reference to body.
+=item $req->cookie
-=cut
+A convenient method to $req->cookies.
-sub body_ref {
- my $self = shift;
- return \$self->{body};
-}
+ $cookie = $c->request->cookie('name');
+ @cookies = $c->request->cookie;
-=item $req->content_encoding
+=cut
-Shortcut to $req->headers->content_encoding
+sub cookie {
+ my $self = shift;
-=item $req->content_length
+ if ( @_ == 0 ) {
+ return keys %{ $self->cookies };
+ }
-Shortcut to $req->headers->content_length
+ if ( @_ == 1 ) {
-=item $req->content_type
+ my $name = shift;
-Shortcut to $req->headers->content_type
+ unless ( exists $self->cookies->{$name} ) {
+ return undef;
+ }
+
+ return $self->cookies->{$name};
+ }
+}
=item $req->cookies
print $c->request->cookies->{mycookie}->value;
+=item $req->full_uri
+
+Returns the complete URI, with the parameter query string.
+
+=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;
+}
+
=item $req->header
Shortcut to $req->headers->header
=item $req->hostname
-Contains the hostname of the remote user.
+Lookup the current users DNS hostname.
print $c->request->hostname
+
+=cut
+
+sub hostname {
+ my $self = shift;
+
+ if ( @_ == 0 && not $self->{hostname} ) {
+ $self->{hostname} = gethostbyaddr( inet_aton( $self->address ), AF_INET );
+ }
+
+ if ( @_ == 1 ) {
+ $self->{hostname} = shift;
+ }
+
+ return $self->{hostname};
+}
=item $req->input
=item $req->match
-This contains be the matching part of a regexp action. otherwise it
-returns the same as 'action'.
+This contains the matching part of a regexp action. Otherwise
+it returns the same as 'action'.
print $c->request->match;
=item $req->param
-Get request parameters with a CGI.pm like param method.
+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');
return keys %{ $self->parameters };
}
- if ( @_ == 1 and ref( $_[0] ) eq 'ARRAY' ) {
-
- while ( my ( $field, $value ) = splice( @{ $_[0] }, 0, 2 ) ) {
-
- if ( exists $self->parameters->{$field} ) {
- for ( $self->parameters->{$field} ) {
- $_ = [$_] unless ref($_) eq "ARRAY";
- push( @$_, $value );
- }
- }
- else {
- $self->parameters->{$field} = $value;
- }
- }
- }
-
if ( @_ == 1 ) {
my $param = shift;
? ( $self->parameters->{$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;
+ }
+ }
+ }
}
=item $req->params
=item $req->parameters
Returns a reference to a hash containing parameters. Values can
-be either a scalar or a arrayref containing scalars.
+be either a scalar or an arrayref containing scalars.
print $c->request->parameters->{field};
print $c->request->parameters->{field}->[0];
print $c->request->path;
+=item $req->protocol
+
+Contains the protocol.
+
=item $req->referer
Shortcut to $req->headers->referer. Referring page.
+=item $req->secure
+
+Contains a boolean whether the communciation is secure.
+
=item $req->snippets
Returns a reference to an array containing regex snippets.
return keys %{ $self->uploads };
}
- if ( @_ == 1 and ref( $_[0] ) eq 'ARRAY' ) {
-
- while ( my ( $field, $upload ) = splice( @{ $_[0] }, 0, 2 ) ) {
-
- if ( exists $self->uploads->{$field} ) {
- for ( $self->uploads->{$field} ) {
- $_ = [$_] unless ref($_) eq "ARRAY";
- push( @$_, $upload );
- }
- }
- else {
- $self->uploads->{$field} = $upload;
- }
- }
- }
-
if ( @_ == 1 ) {
my $upload = shift;
: $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;
+ }
+ }
+ }
}
=item $req->uploads
my $upload = $c->request->uploads->{field};
my $upload = $c->request->uploads->{field}->[0];
+=item $req->uri
+
+Shortcut for C<< $req->base . $req->path >>.
+
+=cut
+
+sub uri {
+ my $self = shift;
+ my $path = shift || $self->path || '';
+ return $self->base . $path;
+}
+
+=item $req->user
+
+Contains the user name of user if authentication check was successful.
+
=item $req->user_agent
Shortcut to $req->headers->user_agent. User Agent version string.