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 Returns the requested action as a L<Catalyst::Action> object.
88 Returns the IP address of the client.
90 =head2 $req->arguments
92 Returns a reference to an array containing the arguments.
94 print $c->request->arguments->[0];
96 For example, if your action was
98 package MyApp::C::Foo;
104 and the URI for the request was C<http://.../foo/moose/bah>, the string C<bah>
105 would be the first and only argument.
109 Shortcut for arguments.
113 Contains the URI base. This will always have a trailing slash.
115 If your application was queried with the URI
116 C<http://localhost:3000/some/path> then C<base> is C<http://localhost:3000/>.
121 my ( $self, $base ) = @_;
123 return $self->{base} unless $base;
125 $self->{base} = $base;
127 # set the value in path for backwards-compat
132 return $self->{base};
137 Returns the message body of the request, unless Content-Type is
138 C<application/x-www-form-urlencoded> or C<multipart/form-data>.
143 my ( $self, $body ) = @_;
144 $self->{_context}->prepare_body;
145 return $self->{_body}->body;
148 =head2 $req->body_parameters
150 Returns a reference to a hash containing body (POST) parameters. Values can
151 be either a scalar or an arrayref containing scalars.
153 print $c->request->body_parameters->{field};
154 print $c->request->body_parameters->{field}->[0];
156 These are the parameters from the POST part of the request, if any.
158 =head2 $req->body_params
160 Shortcut for body_parameters.
164 sub body_parameters {
165 my ( $self, $params ) = @_;
166 $self->{_context}->prepare_body;
167 $self->{body_parameters} = $params if $params;
168 return $self->{body_parameters};
171 =head2 $req->content_encoding
173 Shortcut for $req->headers->content_encoding.
175 =head2 $req->content_length
177 Shortcut for $req->headers->content_length.
179 =head2 $req->content_type
181 Shortcut for $req->headers->content_type.
185 A convenient method to access $req->cookies.
187 $cookie = $c->request->cookie('name');
188 @cookies = $c->request->cookie;
196 return keys %{ $self->cookies };
203 unless ( exists $self->cookies->{$name} ) {
207 return $self->cookies->{$name};
213 Returns a reference to a hash containing the cookies.
215 print $c->request->cookies->{mycookie}->value;
217 The cookies in the hash are indexed by name, and the values are L<CGI::Cookie>
222 Shortcut for $req->headers->header.
226 Returns an L<HTTP::Headers> object containing the headers for the current request.
228 print $c->request->headers->header('X-Catalyst');
230 =head2 $req->hostname
232 Returns the hostname of the client.
239 if ( @_ == 0 && not $self->{hostname} ) {
241 gethostbyaddr( inet_aton( $self->address ), AF_INET );
245 $self->{hostname} = shift;
248 return $self->{hostname};
253 Alias for $req->body.
257 This contains the matching part of a Regex action. Otherwise
258 it returns the same as 'action', except for default actions,
259 which return an empty string.
263 Contains the request method (C<GET>, C<POST>, C<HEAD>, etc).
267 Returns GET and POST parameters with a CGI.pm-compatible param method. This
268 is an alternative method for accessing parameters in $c->req->parameters.
270 $value = $c->request->param( 'foo' );
271 @values = $c->request->param( 'foo' );
272 @params = $c->request->param;
274 Like L<CGI>, and B<unlike> earlier versions of Catalyst, passing multiple
275 arguments to this method, like this:
277 $c->request->param( 'foo', 'bar', 'gorch', 'quxx' );
279 will set the parameter C<foo> to the multiple values C<bar>, C<gorch> and
280 C<quxx>. Previously this would have added C<bar> as another value to C<foo>
281 (creating it if it didn't exist before), and C<quxx> as another value for
290 return keys %{ $self->parameters };
297 unless ( exists $self->parameters->{$param} ) {
298 return wantarray ? () : undef;
301 if ( ref $self->parameters->{$param} eq 'ARRAY' ) {
303 ? @{ $self->parameters->{$param} }
304 : $self->parameters->{$param}->[0];
308 ? ( $self->parameters->{$param} )
309 : $self->parameters->{$param};
314 $self->parameters->{$field} = [@_];
318 =head2 $req->parameters
320 Returns a reference to a hash containing GET and POST parameters. Values can
321 be either a scalar or an arrayref containing scalars.
323 print $c->request->parameters->{field};
324 print $c->request->parameters->{field}->[0];
326 This is the combination of C<query_parameters> and C<body_parameters>.
330 Shortcut for $req->parameters.
335 my ( $self, $params ) = @_;
336 $self->{_context}->prepare_body;
339 $self->{parameters} = $params;
342 $self->{_context}->log->warn(
343 "Attempt to retrieve '$params' with req->params(), " .
344 "you probably meant to call req->param('$params')" );
347 return $self->{parameters};
352 Returns the path, i.e. the part of the URI after $req->base, for the current request.
354 =head2 $req->path_info
356 Alias for path, added for compability with L<CGI>.
361 my ( $self, $params ) = @_;
364 $self->uri->path($params);
367 return $self->{path} if $self->{path};
370 my $path = $self->uri->path;
371 my $location = $self->base->path;
372 $path =~ s/^(\Q$location\E)?//;
374 $self->{path} = $path;
379 =head2 $req->protocol
381 Returns the protocol (HTTP/1.0 or HTTP/1.1) used for the current request.
383 =head2 $req->query_parameters
385 Returns a reference to a hash containing query string (GET) parameters. Values can
386 be either a scalar or an arrayref containing scalars.
388 print $c->request->query_parameters->{field};
389 print $c->request->query_parameters->{field}->[0];
391 =head2 $req->read( [$maxlength] )
393 Reads a chunk of data from the request body. This method is intended to be
394 used in a while loop, reading $maxlength bytes on every call. $maxlength
395 defaults to the size of the request if not specified.
397 You have to set MyApp->config->{parse_on_demand} to use this directly.
401 sub read { shift->{_context}->read(@_); }
405 Shortcut for $req->headers->referer. Returns the referring page.
409 Returns true or false, indicating whether the connection is secure (https).
411 =head2 $req->captures
413 Returns a reference to an array containing regex captures.
415 my @captures = @{ $c->request->captures };
417 =head2 $req->snippets
419 C<captures> used to be called snippets. This is still available for backwoards
420 compatibility, but is considered deprecated.
424 A convenient method to access $req->uploads.
426 $upload = $c->request->upload('field');
427 @uploads = $c->request->upload('field');
428 @fields = $c->request->upload;
430 for my $upload ( $c->request->upload('field') ) {
431 print $upload->filename;
440 return keys %{ $self->uploads };
447 unless ( exists $self->uploads->{$upload} ) {
448 return wantarray ? () : undef;
451 if ( ref $self->uploads->{$upload} eq 'ARRAY' ) {
453 ? @{ $self->uploads->{$upload} }
454 : $self->uploads->{$upload}->[0];
458 ? ( $self->uploads->{$upload} )
459 : $self->uploads->{$upload};
465 while ( my ( $field, $upload ) = splice( @_, 0, 2 ) ) {
467 if ( exists $self->uploads->{$field} ) {
468 for ( $self->uploads->{$field} ) {
469 $_ = [$_] unless ref($_) eq "ARRAY";
470 push( @$_, $upload );
474 $self->uploads->{$field} = $upload;
482 Returns a reference to a hash containing uploads. Values can be either a
483 hashref or a arrayref containing L<Catalyst::Request::Upload> objects.
485 my $upload = $c->request->uploads->{field};
486 my $upload = $c->request->uploads->{field}->[0];
491 my ( $self, $uploads ) = @_;
492 $self->{_context}->prepare_body;
493 $self->{uploads} = $uploads if $uploads;
494 return $self->{uploads};
499 Returns a URI object for the current request. Stringifies to the URI text.
501 =head2 $req->uri_with( { key => 'value' } );
503 Returns a rewritten URI object for the current request. Key/value pairs
504 passed in will override existing parameters. Unmodified pairs will be
510 my( $self, $args ) = @_;
512 carp( 'No arguments passed to uri_with()' ) unless $args;
514 for my $value ( values %$args ) {
515 for ( ref $value eq 'ARRAY' ? @$value : $value ) {
521 my $uri = $self->uri->clone;
524 %{ $uri->query_form_hash },
532 Returns the currently logged in user. Deprecated. The method recommended for
533 newer plugins is $c->user.
535 =head2 $req->user_agent
537 Shortcut to $req->headers->user_agent. Returns the user agent (browser)
542 Sebastian Riedel, C<sri@cpan.org>
544 Marcus Ramberg, C<mramberg@cpan.org>
548 This program is free software, you can redistribute it and/or modify
549 it under the same terms as Perl itself.