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 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 uri => (is => 'rw', predicate => 'has_uri');
+has remote_user => (is => 'rw');
has headers => (
is => 'rw',
isa => 'HTTP::Headers',
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 and have the rest of these lazy build from there?
-
has _context => (
is => 'rw',
weak_ref => 1,
handles => ['read'],
+ clearer => '_clear_context',
);
has body_parameters => (
default => sub { {} },
);
-before body_parameters => sub {
- my ($self) = @_;
- $self->_context->prepare_body();
-};
-
has uploads => (
is => 'rw',
required => 1,
- lazy => 1,
default => sub { {} },
);
-# modifier was a noop (groditi)
-# before uploads => sub {
-# my ($self) = @_;
-# #$self->_context->prepare_body;
-# };
-
has parameters => (
is => 'rw',
required => 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;
- }
+# TODO:
+# - Can we lose the before modifiers which just call prepare_body ?
+# they are wasteful, slow us down and feel cluttery.
+
+# 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?
+before $_ => sub {
+ my ($self) = @_;
+ my $context = $self->_context || return;
+ $context->prepare_body;
+} for qw/parameters body_parameters/;
+
+around parameters => sub {
+ my ($orig, $self, $params) = @_;
+ if ($params) {
+ if ( !ref $params ) {
+ $self->_context->log->warn(
+ "Attempt to retrieve '$params' with req->params(), " .
+ "you probably meant to call req->param('$params')"
+ );
+ $params = undef;
+ }
+ return $self->$orig($params);
+ }
+ $self->$orig();
};
has base => (
lazy => 1,
default => sub {
my $self = shift;
- return $self->path if $self->uri;
+ return $self->path if $self->has_uri;
},
);
-has body => (
- is => 'rw'
+has _body => (
+ is => 'rw', clearer => '_clear_body', predicate => '_has_body',
);
-
-before body => sub {
- my ($self) = @_;
+# 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',
lazy => 1,
default => sub {
my ($self) = @_;
- gethostbyaddr( inet_aton( $self->address ), AF_INET )
+ gethostbyaddr( inet_aton( $self->address ), AF_INET ) || 'localhost'
},
);
-no Moose;
+has _path => ( is => 'rw', predicate => '_has_path', clearer => '_clear_path' );
+
+# XXX: Deprecated in docs ages ago (2006), deprecated with warning in 5.8000 due
+# to confusion between Engines and Plugin::Authentication. Remove in 5.8100?
+has user => (is => 'rw');
sub args { shift->arguments(@_) }
sub body_params { shift->body_parameters(@_) }
and the URI for the request was C<http://.../foo/moose/bah>, the string C<bah>
would be the first and only argument.
+Arguments get automatically URI-unescaped for you.
+
=head2 $req->args
Shortcut for arguments.
=head2 $req->base
-Contains the URI base. This will always have a trailing slash.
+Contains the URI base. This will always have a trailing slash. Note that the
+URI scheme (eg., http vs. https) must be determined through heuristics;
+depending on your server configuration, it may be incorrect. See $req->secure
+for more info.
If your application was queried with the URI
C<http://localhost:3000/some/path> then C<base> is C<http://localhost:3000/>.
present.
http://localhost/path?some+keywords
-
+
$c->request->query_keywords will contain 'some keywords'
=head2 $req->match
=head2 $req->param
-Returns GET and POST parameters with a CGI.pm-compatible param method. This
+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' );
=head2 $req->path_info
-Alias for path, added for compability with L<CGI>.
+Alias for path, added for compatibility with L<CGI>.
=cut
if (@params) {
$self->uri->path(@params);
- undef $self->{path};
+ $self->_clear_path;
}
- elsif ( defined( my $path = $self->{path} ) ) {
- return $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;
+ $self->_path($path);
return $path;
}
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
=head2 $req->secure
-Returns true or false, indicating whether the connection is secure (https).
+Returns true or false, indicating whether the connection is secure
+(https). Note that the URI scheme (eg., http vs. https) must be determined
+through heuristics, and therefore the reliablity of $req->secure will depend
+on your server configuration. If you are serving secure pages on the standard
+SSL port (443) and/or setting the HTTPS environment variable, $req->secure
+should be valid.
=head2 $req->captures
=head2 $req->snippets
-C<captures> used to be called snippets. This is still available for backwoards
+C<captures> used to be called snippets. This is still available for backwards
compatibility, but is considered deprecated.
=head2 $req->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> object, or an arrayref of
L<Catalyst::Request::Upload> objects.
my $upload = $c->request->uploads->{field};
sub uri_with {
my( $self, $args ) = @_;
-
+
carp( 'No arguments passed to uri_with()' ) unless $args;
foreach my $value ( values %$args ) {
utf8::encode( $_ ) if utf8::is_utf8($_);
}
};
-
+
my $uri = $self->uri->clone;
my %query = ( %{ $uri->query_form_hash }, %$args );
=head2 $req->user
-Returns the currently logged in user. Deprecated. The method recommended for
-newer plugins is $c->user.
+Returns the currently logged in user. B<Highly deprecated>, do not call,
+this will be removed in version 5.81.
+
+=head2 $req->remote_user
+
+Returns the value of the C<REMOTE_USER> environment variable.
=head2 $req->user_agent
=head1 COPYRIGHT
-This program is free software, you can redistribute it and/or modify
+This library is free software. You can redistribute it and/or modify
it under the same terms as Perl itself.
=cut
projects / catagits/Catalyst-Runtime.git / blobdiff