use IO::Socket qw[AF_INET inet_aton];
__PACKAGE__->mk_accessors(
- qw/action address arguments body base cookies headers match method
- parameters path protocol secure snippets uploads user/
+ qw/action address arguments cookies headers match method
+ protocol query_parameters secure snippets uri user/
);
-*args = \&arguments;
-*input = \&body;
-*params = \¶meters;
+*args = \&arguments;
+*body_params = \&body_parameters;
+*input = \&body;
+*params = \¶meters;
+*query_params = \&query_parameters;
+*path_info = \&path;
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(@_) }
+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(@_) }
=head1 NAME
$req->arguments;
$req->base;
$req->body;
+ $req->body_parameters;
$req->content_encoding;
$req->content_length;
$req->content_type;
$req->parameters;
$req->path;
$req->protocol;
+ $req->query_parameters;
+ $req->read;
$req->referer;
$req->secure;
$req->snippets;
print $c->request->arguments->[0];
+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.
+
=item $req->base
-Contains the url base. This will always have a trailing slash.
+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/>.
+
+=cut
+
+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};
+}
=item $req->body
print $c->request->body
+=cut
+
+sub body {
+ my ( $self, $body ) = @_;
+ $self->{_context}->prepare_body;
+ return $self->{_body}->body;
+}
+
+=item $req->body_parameters
+
+Returns a reference to a hash containing body 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
+
+An alias for body_parameters.
+
+=cut
+
+sub body_parameters {
+ my ( $self, $params ) = @_;
+ $self->{_context}->prepare_body;
+ $self->{body_parameters} = $params if $params;
+ return $self->{body_parameters};
+}
+
=item $req->content_encoding
Shortcut to $req->headers->content_encoding
unless ( exists $self->cookies->{$name} ) {
return undef;
}
-
+
return $self->cookies->{$name};
}
}
print $c->request->cookies->{mycookie}->value;
+The cookies in the hash are indexed by name, and the values are C<CGI::Cookie>
+objects.
+
=item $req->header
Shortcut to $req->headers->header
my $self = shift;
if ( @_ == 0 && not $self->{hostname} ) {
- $self->{hostname} = gethostbyaddr( inet_aton( $self->address ), AF_INET );
+ $self->{hostname} =
+ gethostbyaddr( inet_aton( $self->address ), AF_INET );
}
if ( @_ == 1 ) {
if ( @_ > 1 ) {
while ( my ( $field, $value ) = splice( @_, 0, 2 ) ) {
-
+
next unless defined $field;
if ( exists $self->parameters->{$field} ) {
print $c->request->parameters->{field};
print $c->request->parameters->{field}->[0];
+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};
+}
+
=item $req->path
Contains the path.
print $c->request->path;
+=item $req->path_info
+
+alias for path, added for compability with L<CGI>
+
+=cut
+
+sub path {
+ my ( $self, $params ) = @_;
+
+ 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
Contains the protocol.
+=item $req->query_parameters
+
+Returns a reference to a hash containing query 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] )
+
+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
+defaults to the size of the request if not specified.
+
+You have to set MyApp->config->{parse_on_demand} to use this directly.
+
+=cut
+
+sub read { shift->{_context}->read(@_); }
+
=item $req->referer
Shortcut to $req->headers->referer. Referring page.
=item $req->secure
-Contains a boolean whether the communciation is secure.
+Contains a boolean denoting whether the communication is secure.
=item $req->snippets
}
else {
return (wantarray)
- ? ( $self->uploads->{$upload} )
- : $self->uploads->{$upload};
+ ? ( $self->uploads->{$upload} )
+ : $self->uploads->{$upload};
}
}
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;
+sub uploads {
+ my ( $self, $uploads ) = @_;
+ $self->{_context}->prepare_body;
+ $self->{uploads} = $uploads if $uploads;
+ return $self->{uploads};
}
+=item $req->uri
+
+Returns a URI object for the request.
+
=item $req->user
Contains the user name of user if authentication check was successful.
projects / catagits/Catalyst-Runtime.git / blobdiff