X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?a=blobdiff_plain;f=lib%2FCatalyst%2FRequest.pm;h=b38b693e1e0904f7057fa0757e9ccfcaab694c5f;hb=22f3a8dd32e5940d87a1d21642fa39c7813bc921;hp=66112554305ab8ffb663b1d488661202e7dbb123;hpb=b77e7869b55e0d2df5aaa3a37ad2cca9c0989abc;p=catagits%2FCatalyst-Runtime.git diff --git a/lib/Catalyst/Request.pm b/lib/Catalyst/Request.pm index 6611255..b38b693 100644 --- a/lib/Catalyst/Request.pm +++ b/lib/Catalyst/Request.pm @@ -6,20 +6,23 @@ use base 'Class::Accessor::Fast'; 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 base 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 @@ -35,6 +38,7 @@ Catalyst::Request - Catalyst Request Class $req->arguments; $req->base; $req->body; + $req->body_parameters; $req->content_encoding; $req->content_length; $req->content_type; @@ -51,6 +55,8 @@ Catalyst::Request - Catalyst Request Class $req->parameters; $req->path; $req->protocol; + $req->query_parameters; + $req->read; $req->referer; $req->secure; $req->snippets; @@ -106,6 +112,35 @@ C or C. 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]; + +=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 @@ -141,7 +176,7 @@ sub cookie { unless ( exists $self->cookies->{$name} ) { return undef; } - + return $self->cookies->{$name}; } } @@ -174,7 +209,8 @@ sub hostname { 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 ) { @@ -242,7 +278,7 @@ sub param { if ( @_ > 1 ) { while ( my ( $field, $value ) = splice( @_, 0, 2 ) ) { - + next unless defined $field; if ( exists $self->parameters->{$field} ) { @@ -270,23 +306,74 @@ be either a scalar or an arrayref containing scalars. print $c->request->parameters->{field}; print $c->request->parameters->{field}->[0]; +=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 + +=cut + +sub path { + my ( $self, $params ) = @_; + + if ($params) { + $self->uri->path($params); + } + + 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/^\///; + + 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]; + +=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 @@ -330,8 +417,8 @@ sub upload { } else { return (wantarray) - ? ( $self->uploads->{$upload} ) - : $self->uploads->{$upload}; + ? ( $self->uploads->{$upload} ) + : $self->uploads->{$upload}; } } @@ -360,18 +447,19 @@ hashref or a arrayref containing C objects. 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.