1 package Catalyst::Request;
3 use IO::Socket qw[AF_INET inet_aton];
13 with 'MooseX::Emulate::Class::Accessor::Fast';
15 has action => (is => 'rw');
16 has address => (is => 'rw');
17 has arguments => (is => 'rw', default => sub { [] });
18 has cookies => (is => 'rw', default => sub { {} });
19 has query_keywords => (is => 'rw');
20 has match => (is => 'rw');
21 has method => (is => 'rw');
22 has protocol => (is => 'rw');
23 has query_parameters => (is => 'rw', default => sub { {} });
24 has secure => (is => 'rw', default => 0);
25 has captures => (is => 'rw', default => sub { [] });
26 has uri => (is => 'rw', predicate => 'has_uri');
27 has user => (is => 'rw');
30 isa => 'HTTP::Headers',
31 handles => [qw(content_encoding content_length content_type header referer user_agent)],
32 default => sub { HTTP::Headers->new() },
38 # - Can we lose the before modifiers which just call prepare_body ?
39 # they are wasteful, slow us down and feel cluttery.
40 # Can we call prepare_body at BUILD time?
41 # Can we make _body an attribute, have the rest of
42 # these lazy build from there and kill all the direct hash access
43 # in Catalyst.pm and Engine.pm?
49 clearer => '_clear_context',
52 has body_parameters => (
56 default => sub { {} },
59 before body_parameters => sub {
61 $self->_context->prepare_body();
68 default => sub { {} },
75 default => sub { {} },
78 before parameters => sub {
79 my ($self, $params) = @_;
80 if ( $params && !ref $params ) {
81 $self->_context->log->warn(
82 "Attempt to retrieve '$params' with req->params(), " .
83 "you probably meant to call req->param('$params')" );
95 return $self->path if $self->has_uri;
105 $self->_context->prepare_body();
114 gethostbyaddr( inet_aton( $self->address ), AF_INET ) || 'localhost'
118 has _path => ( is => 'rw', predicate => '_has_path', clearer => '_clear_path' );
122 sub args { shift->arguments(@_) }
123 sub body_params { shift->body_parameters(@_) }
124 sub input { shift->body(@_) }
125 sub params { shift->parameters(@_) }
126 sub query_params { shift->query_parameters(@_) }
127 sub path_info { shift->path(@_) }
128 sub snippets { shift->captures(@_) }
132 Catalyst::Request - provides information about the current client request
143 $req->body_parameters;
144 $req->content_encoding;
145 $req->content_length;
153 $req->query_keywords;
161 $req->query_parameters;
165 $req->captures; # previously knows as snippets
172 See also L<Catalyst>, L<Catalyst::Request::Upload>.
176 This is the Catalyst Request class, which provides an interface to data for the
177 current client request. The request object is prepared by L<Catalyst::Engine>,
178 thus hiding the details of the particular engine implementation.
184 [DEPRECATED] Returns the name of the requested action.
187 Use C<< $c->action >> instead (which returns a
188 L<Catalyst::Action|Catalyst::Action> object).
192 Returns the IP address of the client.
194 =head2 $req->arguments
196 Returns a reference to an array containing the arguments.
198 print $c->request->arguments->[0];
200 For example, if your action was
202 package MyApp::C::Foo;
208 and the URI for the request was C<http://.../foo/moose/bah>, the string C<bah>
209 would be the first and only argument.
213 Shortcut for arguments.
217 Contains the URI base. This will always have a trailing slash.
219 If your application was queried with the URI
220 C<http://localhost:3000/some/path> then C<base> is C<http://localhost:3000/>.
224 Returns the message body of the request, unless Content-Type is
225 C<application/x-www-form-urlencoded> or C<multipart/form-data>.
227 =head2 $req->body_parameters
229 Returns a reference to a hash containing body (POST) parameters. Values can
230 be either a scalar or an arrayref containing scalars.
232 print $c->request->body_parameters->{field};
233 print $c->request->body_parameters->{field}->[0];
235 These are the parameters from the POST part of the request, if any.
237 =head2 $req->body_params
239 Shortcut for body_parameters.
241 =head2 $req->content_encoding
243 Shortcut for $req->headers->content_encoding.
245 =head2 $req->content_length
247 Shortcut for $req->headers->content_length.
249 =head2 $req->content_type
251 Shortcut for $req->headers->content_type.
255 A convenient method to access $req->cookies.
257 $cookie = $c->request->cookie('name');
258 @cookies = $c->request->cookie;
266 return keys %{ $self->cookies };
273 unless ( exists $self->cookies->{$name} ) {
277 return $self->cookies->{$name};
283 Returns a reference to a hash containing the cookies.
285 print $c->request->cookies->{mycookie}->value;
287 The cookies in the hash are indexed by name, and the values are L<CGI::Cookie>
292 Shortcut for $req->headers->header.
296 Returns an L<HTTP::Headers> object containing the headers for the current request.
298 print $c->request->headers->header('X-Catalyst');
300 =head2 $req->hostname
302 Returns the hostname of the client.
306 Alias for $req->body.
308 =head2 $req->query_keywords
310 Contains the keywords portion of a query string, when no '=' signs are
313 http://localhost/path?some+keywords
315 $c->request->query_keywords will contain 'some keywords'
319 This contains the matching part of a Regex action. Otherwise
320 it returns the same as 'action', except for default actions,
321 which return an empty string.
325 Contains the request method (C<GET>, C<POST>, C<HEAD>, etc).
329 Returns GET and POST parameters with a CGI.pm-compatible param method. This
330 is an alternative method for accessing parameters in $c->req->parameters.
332 $value = $c->request->param( 'foo' );
333 @values = $c->request->param( 'foo' );
334 @params = $c->request->param;
336 Like L<CGI>, and B<unlike> earlier versions of Catalyst, passing multiple
337 arguments to this method, like this:
339 $c->request->param( 'foo', 'bar', 'gorch', 'quxx' );
341 will set the parameter C<foo> to the multiple values C<bar>, C<gorch> and
342 C<quxx>. Previously this would have added C<bar> as another value to C<foo>
343 (creating it if it didn't exist before), and C<quxx> as another value for
352 return keys %{ $self->parameters };
359 unless ( exists $self->parameters->{$param} ) {
360 return wantarray ? () : undef;
363 if ( ref $self->parameters->{$param} eq 'ARRAY' ) {
365 ? @{ $self->parameters->{$param} }
366 : $self->parameters->{$param}->[0];
370 ? ( $self->parameters->{$param} )
371 : $self->parameters->{$param};
376 $self->parameters->{$field} = [@_];
380 =head2 $req->parameters
382 Returns a reference to a hash containing GET and POST parameters. Values can
383 be either a scalar or an arrayref containing scalars.
385 print $c->request->parameters->{field};
386 print $c->request->parameters->{field}->[0];
388 This is the combination of C<query_parameters> and C<body_parameters>.
392 Shortcut for $req->parameters.
396 Returns the path, i.e. the part of the URI after $req->base, for the current request.
398 =head2 $req->path_info
400 Alias for path, added for compability with L<CGI>.
405 my ( $self, @params ) = @_;
408 $self->uri->path(@params);
411 elsif ( $self->_has_path ) {
415 my $path = $self->uri->path;
416 my $location = $self->base->path;
417 $path =~ s/^(\Q$location\E)?//;
425 =head2 $req->protocol
427 Returns the protocol (HTTP/1.0 or HTTP/1.1) used for the current request.
429 =head2 $req->query_parameters
431 =head2 $req->query_params
433 Returns a reference to a hash containing query string (GET) parameters. Values can
434 be either a scalar or an arrayref containing scalars.
436 print $c->request->query_parameters->{field};
437 print $c->request->query_parameters->{field}->[0];
439 =head2 $req->read( [$maxlength] )
441 Reads a chunk of data from the request body. This method is intended to be
442 used in a while loop, reading $maxlength bytes on every call. $maxlength
443 defaults to the size of the request if not specified.
445 You have to set MyApp->config->{parse_on_demand} to use this directly.
449 Shortcut for $req->headers->referer. Returns the referring page.
453 Returns true or false, indicating whether the connection is secure (https).
455 =head2 $req->captures
457 Returns a reference to an array containing captured args from chained
458 actions or regex captures.
460 my @captures = @{ $c->request->captures };
462 =head2 $req->snippets
464 C<captures> used to be called snippets. This is still available for backwoards
465 compatibility, but is considered deprecated.
469 A convenient method to access $req->uploads.
471 $upload = $c->request->upload('field');
472 @uploads = $c->request->upload('field');
473 @fields = $c->request->upload;
475 for my $upload ( $c->request->upload('field') ) {
476 print $upload->filename;
485 return keys %{ $self->uploads };
492 unless ( exists $self->uploads->{$upload} ) {
493 return wantarray ? () : undef;
496 if ( ref $self->uploads->{$upload} eq 'ARRAY' ) {
498 ? @{ $self->uploads->{$upload} }
499 : $self->uploads->{$upload}->[0];
503 ? ( $self->uploads->{$upload} )
504 : $self->uploads->{$upload};
510 while ( my ( $field, $upload ) = splice( @_, 0, 2 ) ) {
512 if ( exists $self->uploads->{$field} ) {
513 for ( $self->uploads->{$field} ) {
514 $_ = [$_] unless ref($_) eq "ARRAY";
515 push( @$_, $upload );
519 $self->uploads->{$field} = $upload;
527 Returns a reference to a hash containing uploads. Values can be either a
528 L<Catalyst::Request::Upload> object, or an arrayref of
529 L<Catalyst::Request::Upload> objects.
531 my $upload = $c->request->uploads->{field};
532 my $upload = $c->request->uploads->{field}->[0];
536 Returns a URI object for the current request. Stringifies to the URI text.
538 =head2 $req->uri_with( { key => 'value' } );
540 Returns a rewritten URI object for the current request. Key/value pairs
541 passed in will override existing parameters. You can remove an existing
542 parameter by passing in an undef value. Unmodified pairs will be
548 my( $self, $args ) = @_;
550 carp( 'No arguments passed to uri_with()' ) unless $args;
552 foreach my $value ( values %$args ) {
553 next unless defined $value;
554 for ( ref $value eq 'ARRAY' ? @$value : $value ) {
556 utf8::encode( $_ ) if utf8::is_utf8($_);
560 my $uri = $self->uri->clone;
561 my %query = ( %{ $uri->query_form_hash }, %$args );
564 # remove undef values
565 map { defined $query{ $_ } ? ( $_ => $query{ $_ } ) : () } keys %query
572 Returns the currently logged in user. Deprecated. The method recommended for
573 newer plugins is $c->user.
575 =head2 $req->user_agent
577 Shortcut to $req->headers->user_agent. Returns the user agent (browser)
586 Catalyst Contributors, see Catalyst.pm
590 This program is free software, you can redistribute it and/or modify
591 it under the same terms as Perl itself.
595 __PACKAGE__->meta->make_immutable;