1 package Catalyst::Request;
3 use IO::Socket qw[AF_INET inet_aton];
13 use namespace::clean -except => 'meta';
15 with 'MooseX::Emulate::Class::Accessor::Fast';
17 has action => (is => 'rw');
18 has address => (is => 'rw');
19 has arguments => (is => 'rw', default => sub { [] });
20 has cookies => (is => 'rw', default => sub { {} });
21 has query_keywords => (is => 'rw');
22 has match => (is => 'rw');
23 has method => (is => 'rw');
24 has protocol => (is => 'rw');
25 has query_parameters => (is => 'rw', default => sub { {} });
26 has secure => (is => 'rw', default => 0);
27 has captures => (is => 'rw', default => sub { [] });
28 has uri => (is => 'rw', predicate => 'has_uri');
29 has remote_user => (is => 'rw');
32 isa => 'HTTP::Headers',
33 handles => [qw(content_encoding content_length content_type header referer user_agent)],
34 default => sub { HTTP::Headers->new() },
43 clearer => '_clear_context',
46 has body_parameters => (
50 default => sub { {} },
56 default => sub { {} },
63 default => sub { {} },
67 # - Can we lose the before modifiers which just call prepare_body ?
68 # they are wasteful, slow us down and feel cluttery.
70 # Can we make _body an attribute, have the rest of
71 # these lazy build from there and kill all the direct hash access
72 # in Catalyst.pm and Engine.pm?
76 my $context = $self->_context || return;
77 $context->prepare_body;
78 } for qw/parameters body_parameters/;
80 around parameters => sub {
81 my ($orig, $self, $params) = @_;
84 $self->_context->log->warn(
85 "Attempt to retrieve '$params' with req->params(), " .
86 "you probably meant to call req->param('$params')"
90 return $self->$orig($params);
101 return $self->path if $self->has_uri;
106 is => 'rw', clearer => '_clear_body', predicate => '_has_body',
108 # Eugh, ugly. Should just be able to rename accessor methods to 'body'
109 # and provide a custom reader..
112 $self->_context->prepare_body();
113 $self->_body(@_) if scalar @_;
114 return blessed $self->_body ? $self->_body->body : $self->_body;
123 gethostbyaddr( inet_aton( $self->address ), AF_INET ) || 'localhost'
127 has _path => ( is => 'rw', predicate => '_has_path', clearer => '_clear_path' );
129 # XXX: Deprecated in docs ages ago (2006), deprecated with warning in 5.8000 due
130 # to confusion between Engines and Plugin::Authentication. Remove in 5.8100?
131 has user => (is => 'rw');
133 sub args { shift->arguments(@_) }
134 sub body_params { shift->body_parameters(@_) }
135 sub input { shift->body(@_) }
136 sub params { shift->parameters(@_) }
137 sub query_params { shift->query_parameters(@_) }
138 sub path_info { shift->path(@_) }
139 sub snippets { shift->captures(@_) }
143 Catalyst::Request - provides information about the current client request
154 $req->body_parameters;
155 $req->content_encoding;
156 $req->content_length;
164 $req->query_keywords;
172 $req->query_parameters;
176 $req->captures; # previously knows as snippets
183 See also L<Catalyst>, L<Catalyst::Request::Upload>.
187 This is the Catalyst Request class, which provides an interface to data for the
188 current client request. The request object is prepared by L<Catalyst::Engine>,
189 thus hiding the details of the particular engine implementation.
195 [DEPRECATED] Returns the name of the requested action.
198 Use C<< $c->action >> instead (which returns a
199 L<Catalyst::Action|Catalyst::Action> object).
203 Returns the IP address of the client.
205 =head2 $req->arguments
207 Returns a reference to an array containing the arguments.
209 print $c->request->arguments->[0];
211 For example, if your action was
213 package MyApp::C::Foo;
219 and the URI for the request was C<http://.../foo/moose/bah>, the string C<bah>
220 would be the first and only argument.
222 Arguments just get passed through and B<don't> get unescaped automatically, so
223 you should do that explicitly.
227 Shortcut for arguments.
231 Contains the URI base. This will always have a trailing slash. Note that the
232 URI scheme (eg., http vs. https) must be determined through heuristics;
233 depending on your server configuration, it may be incorrect. See $req->secure
236 If your application was queried with the URI
237 C<http://localhost:3000/some/path> then C<base> is C<http://localhost:3000/>.
241 Returns the message body of the request, unless Content-Type is
242 C<application/x-www-form-urlencoded> or C<multipart/form-data>.
244 =head2 $req->body_parameters
246 Returns a reference to a hash containing body (POST) parameters. Values can
247 be either a scalar or an arrayref containing scalars.
249 print $c->request->body_parameters->{field};
250 print $c->request->body_parameters->{field}->[0];
252 These are the parameters from the POST part of the request, if any.
254 =head2 $req->body_params
256 Shortcut for body_parameters.
258 =head2 $req->content_encoding
260 Shortcut for $req->headers->content_encoding.
262 =head2 $req->content_length
264 Shortcut for $req->headers->content_length.
266 =head2 $req->content_type
268 Shortcut for $req->headers->content_type.
272 A convenient method to access $req->cookies.
274 $cookie = $c->request->cookie('name');
275 @cookies = $c->request->cookie;
283 return keys %{ $self->cookies };
290 unless ( exists $self->cookies->{$name} ) {
294 return $self->cookies->{$name};
300 Returns a reference to a hash containing the cookies.
302 print $c->request->cookies->{mycookie}->value;
304 The cookies in the hash are indexed by name, and the values are L<CGI::Cookie>
309 Shortcut for $req->headers->header.
313 Returns an L<HTTP::Headers> object containing the headers for the current request.
315 print $c->request->headers->header('X-Catalyst');
317 =head2 $req->hostname
319 Returns the hostname of the client.
323 Alias for $req->body.
325 =head2 $req->query_keywords
327 Contains the keywords portion of a query string, when no '=' signs are
330 http://localhost/path?some+keywords
332 $c->request->query_keywords will contain 'some keywords'
336 This contains the matching part of a Regex action. Otherwise
337 it returns the same as 'action', except for default actions,
338 which return an empty string.
342 Contains the request method (C<GET>, C<POST>, C<HEAD>, etc).
346 Returns GET and POST parameters with a CGI.pm-compatible param method. This
347 is an alternative method for accessing parameters in $c->req->parameters.
349 $value = $c->request->param( 'foo' );
350 @values = $c->request->param( 'foo' );
351 @params = $c->request->param;
353 Like L<CGI>, and B<unlike> earlier versions of Catalyst, passing multiple
354 arguments to this method, like this:
356 $c->request->param( 'foo', 'bar', 'gorch', 'quxx' );
358 will set the parameter C<foo> to the multiple values C<bar>, C<gorch> and
359 C<quxx>. Previously this would have added C<bar> as another value to C<foo>
360 (creating it if it didn't exist before), and C<quxx> as another value for
369 return keys %{ $self->parameters };
376 unless ( exists $self->parameters->{$param} ) {
377 return wantarray ? () : undef;
380 if ( ref $self->parameters->{$param} eq 'ARRAY' ) {
382 ? @{ $self->parameters->{$param} }
383 : $self->parameters->{$param}->[0];
387 ? ( $self->parameters->{$param} )
388 : $self->parameters->{$param};
393 $self->parameters->{$field} = [@_];
397 =head2 $req->parameters
399 Returns a reference to a hash containing GET and POST parameters. Values can
400 be either a scalar or an arrayref containing scalars.
402 print $c->request->parameters->{field};
403 print $c->request->parameters->{field}->[0];
405 This is the combination of C<query_parameters> and C<body_parameters>.
409 Shortcut for $req->parameters.
413 Returns the path, i.e. the part of the URI after $req->base, for the current request.
415 =head2 $req->path_info
417 Alias for path, added for compatibility with L<CGI>.
422 my ( $self, @params ) = @_;
425 $self->uri->path(@params);
428 elsif ( $self->_has_path ) {
432 my $path = $self->uri->path;
433 my $location = $self->base->path;
434 $path =~ s/^(\Q$location\E)?//;
442 =head2 $req->protocol
444 Returns the protocol (HTTP/1.0 or HTTP/1.1) used for the current request.
446 =head2 $req->query_parameters
448 =head2 $req->query_params
450 Returns a reference to a hash containing query string (GET) parameters. Values can
451 be either a scalar or an arrayref containing scalars.
453 print $c->request->query_parameters->{field};
454 print $c->request->query_parameters->{field}->[0];
456 =head2 $req->read( [$maxlength] )
458 Reads a chunk of data from the request body. This method is intended to be
459 used in a while loop, reading $maxlength bytes on every call. $maxlength
460 defaults to the size of the request if not specified.
462 You have to set MyApp->config->{parse_on_demand} to use this directly.
466 Shortcut for $req->headers->referer. Returns the referring page.
470 Returns true or false, indicating whether the connection is secure
471 (https). Note that the URI scheme (eg., http vs. https) must be determined
472 through heuristics, and therefore the reliablity of $req->secure will depend
473 on your server configuration. If you are serving secure pages on the standard
474 SSL port (443) and/or setting the HTTPS environment variable, $req->secure
477 =head2 $req->captures
479 Returns a reference to an array containing captured args from chained
480 actions or regex captures.
482 my @captures = @{ $c->request->captures };
484 =head2 $req->snippets
486 C<captures> used to be called snippets. This is still available for backwards
487 compatibility, but is considered deprecated.
491 A convenient method to access $req->uploads.
493 $upload = $c->request->upload('field');
494 @uploads = $c->request->upload('field');
495 @fields = $c->request->upload;
497 for my $upload ( $c->request->upload('field') ) {
498 print $upload->filename;
507 return keys %{ $self->uploads };
514 unless ( exists $self->uploads->{$upload} ) {
515 return wantarray ? () : undef;
518 if ( ref $self->uploads->{$upload} eq 'ARRAY' ) {
520 ? @{ $self->uploads->{$upload} }
521 : $self->uploads->{$upload}->[0];
525 ? ( $self->uploads->{$upload} )
526 : $self->uploads->{$upload};
532 while ( my ( $field, $upload ) = splice( @_, 0, 2 ) ) {
534 if ( exists $self->uploads->{$field} ) {
535 for ( $self->uploads->{$field} ) {
536 $_ = [$_] unless ref($_) eq "ARRAY";
537 push( @$_, $upload );
541 $self->uploads->{$field} = $upload;
549 Returns a reference to a hash containing uploads. Values can be either a
550 L<Catalyst::Request::Upload> object, or an arrayref of
551 L<Catalyst::Request::Upload> objects.
553 my $upload = $c->request->uploads->{field};
554 my $upload = $c->request->uploads->{field}->[0];
558 Returns a URI object for the current request. Stringifies to the URI text.
560 =head2 $req->uri_with( { key => 'value' } );
562 Returns a rewritten URI object for the current request. Key/value pairs
563 passed in will override existing parameters. You can remove an existing
564 parameter by passing in an undef value. Unmodified pairs will be
570 my( $self, $args ) = @_;
572 carp( 'No arguments passed to uri_with()' ) unless $args;
574 foreach my $value ( values %$args ) {
575 next unless defined $value;
576 for ( ref $value eq 'ARRAY' ? @$value : $value ) {
578 utf8::encode( $_ ) if utf8::is_utf8($_);
582 my $uri = $self->uri->clone;
583 my %query = ( %{ $uri->query_form_hash }, %$args );
586 # remove undef values
587 map { defined $query{ $_ } ? ( $_ => $query{ $_ } ) : () } keys %query
594 Returns the currently logged in user. B<Highly deprecated>, do not call,
595 this will be removed in version 5.81.
597 =head2 $req->remote_user
599 Returns the value of the C<REMOTE_USER> environment variable.
601 =head2 $req->user_agent
603 Shortcut to $req->headers->user_agent. Returns the user agent (browser)
612 Catalyst Contributors, see Catalyst.pm
616 This program is free software, you can redistribute it and/or modify
617 it under the same terms as Perl itself.
621 __PACKAGE__->meta->make_immutable;