1 package Catalyst::Request;
4 use base 'Class::Accessor::Fast';
6 use IO::Socket qw[AF_INET inet_aton];
11 __PACKAGE__->mk_accessors(
12 qw/action address arguments cookies headers match method
13 protocol query_parameters secure captures uri user/
17 *body_params = \&body_parameters;
19 *params = \¶meters;
20 *query_params = \&query_parameters;
22 *snippets = \&captures;
24 sub content_encoding { shift->headers->content_encoding(@_) }
25 sub content_length { shift->headers->content_length(@_) }
26 sub content_type { shift->headers->content_type(@_) }
27 sub header { shift->headers->header(@_) }
28 sub referer { shift->headers->referer(@_) }
29 sub user_agent { shift->headers->user_agent(@_) }
33 Catalyst::Request - provides information about the current client request
44 $req->body_parameters;
45 $req->content_encoding;
61 $req->query_parameters;
65 $req->captures; # previously knows as snippets
72 See also L<Catalyst>, L<Catalyst::Request::Upload>.
76 This is the Catalyst Request class, which provides an interface to data for the
77 current client request. The request object is prepared by L<Catalyst::Engine>,
78 thus hiding the details of the particular engine implementation.
84 [DEPRECATED] Returns the name of the requested action.
87 Use C<< $c->action >> instead (which returns a
88 L<Catalyst::Action|Catalyst::Action> object).
92 Returns the IP address of the client.
94 =head2 $req->arguments
96 Returns a reference to an array containing the arguments.
98 print $c->request->arguments->[0];
100 For example, if your action was
102 package MyApp::C::Foo;
108 and the URI for the request was C<http://.../foo/moose/bah>, the string C<bah>
109 would be the first and only argument.
113 Shortcut for arguments.
117 Contains the URI base. This will always have a trailing slash.
119 If your application was queried with the URI
120 C<http://localhost:3000/some/path> then C<base> is C<http://localhost:3000/>.
125 my ( $self, $base ) = @_;
127 return $self->{base} unless $base;
129 $self->{base} = $base;
131 # set the value in path for backwards-compat
136 return $self->{base};
141 Returns the message body of the request, unless Content-Type is
142 C<application/x-www-form-urlencoded> or C<multipart/form-data>.
147 my ( $self, $body ) = @_;
148 $self->{_context}->prepare_body;
149 return $self->{_body}->body;
152 =head2 $req->body_parameters
154 Returns a reference to a hash containing body (POST) parameters. Values can
155 be either a scalar or an arrayref containing scalars.
157 print $c->request->body_parameters->{field};
158 print $c->request->body_parameters->{field}->[0];
160 These are the parameters from the POST part of the request, if any.
162 =head2 $req->body_params
164 Shortcut for body_parameters.
168 sub body_parameters {
169 my ( $self, $params ) = @_;
170 $self->{_context}->prepare_body;
171 $self->{body_parameters} = $params if $params;
172 return $self->{body_parameters};
175 =head2 $req->content_encoding
177 Shortcut for $req->headers->content_encoding.
179 =head2 $req->content_length
181 Shortcut for $req->headers->content_length.
183 =head2 $req->content_type
185 Shortcut for $req->headers->content_type.
189 A convenient method to access $req->cookies.
191 $cookie = $c->request->cookie('name');
192 @cookies = $c->request->cookie;
200 return keys %{ $self->cookies };
207 unless ( exists $self->cookies->{$name} ) {
211 return $self->cookies->{$name};
217 Returns a reference to a hash containing the cookies.
219 print $c->request->cookies->{mycookie}->value;
221 The cookies in the hash are indexed by name, and the values are L<CGI::Cookie>
226 Shortcut for $req->headers->header.
230 Returns an L<HTTP::Headers> object containing the headers for the current request.
232 print $c->request->headers->header('X-Catalyst');
234 =head2 $req->hostname
236 Returns the hostname of the client.
243 if ( @_ == 0 && not $self->{hostname} ) {
245 gethostbyaddr( inet_aton( $self->address ), AF_INET );
249 $self->{hostname} = shift;
252 return $self->{hostname};
257 Alias for $req->body.
261 This contains the matching part of a Regex action. Otherwise
262 it returns the same as 'action', except for default actions,
263 which return an empty string.
267 Contains the request method (C<GET>, C<POST>, C<HEAD>, etc).
271 Returns GET and POST parameters with a CGI.pm-compatible param method. This
272 is an alternative method for accessing parameters in $c->req->parameters.
274 $value = $c->request->param( 'foo' );
275 @values = $c->request->param( 'foo' );
276 @params = $c->request->param;
278 Like L<CGI>, and B<unlike> earlier versions of Catalyst, passing multiple
279 arguments to this method, like this:
281 $c->request->param( 'foo', 'bar', 'gorch', 'quxx' );
283 will set the parameter C<foo> to the multiple values C<bar>, C<gorch> and
284 C<quxx>. Previously this would have added C<bar> as another value to C<foo>
285 (creating it if it didn't exist before), and C<quxx> as another value for
294 return keys %{ $self->parameters };
301 unless ( exists $self->parameters->{$param} ) {
302 return wantarray ? () : undef;
305 if ( ref $self->parameters->{$param} eq 'ARRAY' ) {
307 ? @{ $self->parameters->{$param} }
308 : $self->parameters->{$param}->[0];
312 ? ( $self->parameters->{$param} )
313 : $self->parameters->{$param};
318 $self->parameters->{$field} = [@_];
322 =head2 $req->parameters
324 Returns a reference to a hash containing GET and POST parameters. Values can
325 be either a scalar or an arrayref containing scalars.
327 print $c->request->parameters->{field};
328 print $c->request->parameters->{field}->[0];
330 This is the combination of C<query_parameters> and C<body_parameters>.
334 Shortcut for $req->parameters.
339 my ( $self, $params ) = @_;
340 $self->{_context}->prepare_body;
343 $self->{parameters} = $params;
346 $self->{_context}->log->warn(
347 "Attempt to retrieve '$params' with req->params(), " .
348 "you probably meant to call req->param('$params')" );
351 return $self->{parameters};
356 Returns the path, i.e. the part of the URI after $req->base, for the current request.
358 =head2 $req->path_info
360 Alias for path, added for compability with L<CGI>.
365 my ( $self, $params ) = @_;
368 $self->uri->path($params);
371 return $self->{path} if $self->{path};
374 my $path = $self->uri->path;
375 my $location = $self->base->path;
376 $path =~ s/^(\Q$location\E)?//;
378 $self->{path} = $path;
383 =head2 $req->protocol
385 Returns the protocol (HTTP/1.0 or HTTP/1.1) used for the current request.
387 =head2 $req->query_parameters
389 Returns a reference to a hash containing query string (GET) parameters. Values can
390 be either a scalar or an arrayref containing scalars.
392 print $c->request->query_parameters->{field};
393 print $c->request->query_parameters->{field}->[0];
395 =head2 $req->read( [$maxlength] )
397 Reads a chunk of data from the request body. This method is intended to be
398 used in a while loop, reading $maxlength bytes on every call. $maxlength
399 defaults to the size of the request if not specified.
401 You have to set MyApp->config->{parse_on_demand} to use this directly.
405 sub read { shift->{_context}->read(@_); }
409 Shortcut for $req->headers->referer. Returns the referring page.
413 Returns true or false, indicating whether the connection is secure (https).
415 =head2 $req->captures
417 Returns a reference to an array containing regex captures.
419 my @captures = @{ $c->request->captures };
421 =head2 $req->snippets
423 C<captures> used to be called snippets. This is still available for backwoards
424 compatibility, but is considered deprecated.
428 A convenient method to access $req->uploads.
430 $upload = $c->request->upload('field');
431 @uploads = $c->request->upload('field');
432 @fields = $c->request->upload;
434 for my $upload ( $c->request->upload('field') ) {
435 print $upload->filename;
444 return keys %{ $self->uploads };
451 unless ( exists $self->uploads->{$upload} ) {
452 return wantarray ? () : undef;
455 if ( ref $self->uploads->{$upload} eq 'ARRAY' ) {
457 ? @{ $self->uploads->{$upload} }
458 : $self->uploads->{$upload}->[0];
462 ? ( $self->uploads->{$upload} )
463 : $self->uploads->{$upload};
469 while ( my ( $field, $upload ) = splice( @_, 0, 2 ) ) {
471 if ( exists $self->uploads->{$field} ) {
472 for ( $self->uploads->{$field} ) {
473 $_ = [$_] unless ref($_) eq "ARRAY";
474 push( @$_, $upload );
478 $self->uploads->{$field} = $upload;
486 Returns a reference to a hash containing uploads. Values can be either a
487 hashref or a arrayref containing L<Catalyst::Request::Upload> objects.
489 my $upload = $c->request->uploads->{field};
490 my $upload = $c->request->uploads->{field}->[0];
495 my ( $self, $uploads ) = @_;
496 $self->{_context}->prepare_body;
497 $self->{uploads} = $uploads if $uploads;
498 return $self->{uploads};
503 Returns a URI object for the current request. Stringifies to the URI text.
505 =head2 $req->uri_with( { key => 'value' } );
507 Returns a rewritten URI object for the current request. Key/value pairs
508 passed in will override existing parameters. Unmodified pairs will be
514 my( $self, $args ) = @_;
516 carp( 'No arguments passed to uri_with()' ) unless $args;
518 for my $value ( values %$args ) {
519 next unless defined $value;
520 for ( ref $value eq 'ARRAY' ? @$value : $value ) {
526 my $uri = $self->uri->clone;
529 %{ $uri->query_form_hash },
537 Returns the currently logged in user. Deprecated. The method recommended for
538 newer plugins is $c->user.
540 =head2 $req->user_agent
542 Shortcut to $req->headers->user_agent. Returns the user agent (browser)
547 Sebastian Riedel, C<sri@cpan.org>
549 Marcus Ramberg, C<mramberg@cpan.org>
553 This program is free software, you can redistribute it and/or modify
554 it under the same terms as Perl itself.