X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?a=blobdiff_plain;f=lib%2FCatalyst%2FRequest.pm;h=ded852a3dd4e0455b939f3d7e8047151b69424e1;hb=7e71fcce56e4bd33dc9801a0d368ccbe4c90ee98;hp=09741abb441d09a3d854caf46bbb7aeafcbc73dd;hpb=8fbcd90cdb30aed53d22d1cdbad95880f1c11693;p=catagits%2FCatalyst-Runtime.git diff --git a/lib/Catalyst/Request.pm b/lib/Catalyst/Request.pm index 09741ab..ded852a 100644 --- a/lib/Catalyst/Request.pm +++ b/lib/Catalyst/Request.pm @@ -3,9 +3,11 @@ package Catalyst::Request; 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; @@ -33,8 +35,6 @@ Catalyst::Request - Catalyst Request Class $req->arguments; $req->base; $req->body; - $req->body_length; - $req->body_ref; $req->content_encoding; $req->content_length; $req->content_type; @@ -49,11 +49,15 @@ Catalyst::Request - Catalyst Request Class $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. @@ -101,45 +105,45 @@ C or C. 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->cookie }; + } -Shortcut to $req->headers->content_length + if ( @_ == 1 ) { -=item $req->content_type + my $name = shift; -Shortcut to $req->headers->content_type + unless ( exists $self->cookie->{$name} ) { + return undef; + } + + return $self->cookie->{$name}; + } +} =item $req->cookies @@ -159,9 +163,25 @@ Returns an L object containing the headers. =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 @@ -169,8 +189,8 @@ Shortcut for $req->body. =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; @@ -182,7 +202,8 @@ Contains the request method (C, C, C, etc). =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'); @@ -197,22 +218,6 @@ sub param { 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; @@ -231,7 +236,25 @@ sub param { ? ( $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 @@ -241,7 +264,7 @@ Shortcut for $req->parameters. =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]; @@ -252,10 +275,18 @@ Contains the path. 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. @@ -283,22 +314,6 @@ sub upload { 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; @@ -318,6 +333,22 @@ sub upload { : $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 @@ -328,6 +359,22 @@ 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; +} + +=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.