X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?a=blobdiff_plain;f=lib%2FCatalyst%2FRequest.pm;h=429cadbf67dab3e1ef4b1ee7b7fae917687705d0;hb=cbe555e8935736ebb018aa19ef4b44051b429977;hp=81bda0f962b53cc09f014106a00b41ee2df48baa;hpb=328f225e25408af6c8bf0bf38acc5aecf74dabd6;p=catagits%2FCatalyst-Runtime.git diff --git a/lib/Catalyst/Request.pm b/lib/Catalyst/Request.pm index 81bda0f..429cadb 100644 --- a/lib/Catalyst/Request.pm +++ b/lib/Catalyst/Request.pm @@ -26,7 +26,7 @@ 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 remote_user => (is => 'rw'); has headers => ( is => 'rw', isa => 'HTTP::Headers', @@ -36,14 +36,6 @@ has 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, 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, @@ -58,11 +50,6 @@ has body_parameters => ( default => sub { {} }, ); -before body_parameters => sub { - my ($self) = @_; - $self->_context->prepare_body(); -}; - has uploads => ( is => 'rw', required => 1, @@ -76,6 +63,20 @@ has parameters => ( default => sub { {} }, ); +# 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) { @@ -105,7 +106,7 @@ 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.. +# and provide a custom reader.. sub body { my $self = shift; $self->_context->prepare_body(); @@ -125,6 +126,10 @@ has hostname => ( 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(@_) } sub input { shift->body(@_) } @@ -214,8 +219,7 @@ For example, if your action was and the URI for the request was C, the string C would be the first and only argument. -Arguments just get passed through and B get unescaped automatically, so -you should do that explicitly. +Arguments get automatically URI-unescaped for you. =head2 $req->args @@ -323,7 +327,7 @@ 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 @@ -338,7 +342,7 @@ Contains the request method (C, C, C, etc). =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' ); @@ -355,6 +359,21 @@ C. Previously this would have added C as another value to C (creating it if it didn't exist before), and C as another value for C. +B this is considered a legacy interface and care should be taken when +using it. C<< scalar $c->req->param( 'foo' ) >> will return only the first +C param even if multiple are present; C<< $c->req->param( 'foo' ) >> will +return a list of as many are present, which can have unexpected consequences +when writing code of the form: + + $foo->bar( + a => 'b', + baz => $c->req->param( 'baz' ), + ); + +If multiple C parameters are provided this code might corrupt data or +cause a hash initialization error. For a more straightforward interface see +C<< $c->req->parameters >>. + =cut sub param { @@ -447,7 +466,7 @@ 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 @@ -542,7 +561,7 @@ sub upload { =head2 $req->uploads Returns a reference to a hash containing uploads. Values can be either a -L object, or an arrayref of +L object, or an arrayref of L objects. my $upload = $c->request->uploads->{field}; @@ -563,7 +582,7 @@ preserved. sub uri_with { my( $self, $args ) = @_; - + carp( 'No arguments passed to uri_with()' ) unless $args; foreach my $value ( values %$args ) { @@ -573,7 +592,7 @@ sub uri_with { utf8::encode( $_ ) if utf8::is_utf8($_); } }; - + my $uri = $self->uri->clone; my %query = ( %{ $uri->query_form_hash }, %$args ); @@ -586,8 +605,12 @@ sub uri_with { =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, do not call, +this will be removed in version 5.81. + +=head2 $req->remote_user + +Returns the value of the C environment variable. =head2 $req->user_agent @@ -604,7 +627,7 @@ Catalyst Contributors, see Catalyst.pm =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