1 package Catalyst::Request;
3 use IO::Socket qw[AF_INET inet_aton];
16 use namespace::clean -except => 'meta';
18 with 'MooseX::Emulate::Class::Accessor::Fast';
20 has env => (is => 'ro', writer => '_set_env', predicate => 'has_env');
21 # XXX Deprecated crap here - warn?
22 has action => (is => 'rw');
23 # XXX: Deprecated in docs ages ago (2006), deprecated with warning in 5.8000 due
24 # to confusion between Engines and Plugin::Authentication. Remove in 5.8100?
25 has user => (is => 'rw');
26 sub snippets { shift->captures(@_) }
28 has _read_position => (
29 # FIXME: work around Moose bug RT#75367
32 writer => '_set_read_position',
36 # FIXME: work around Moose bug RT#75367
41 $self->header('Content-Length') || 0;
46 has address => (is => 'rw');
47 has arguments => (is => 'rw', default => sub { [] });
48 has cookies => (is => 'ro', builder => 'prepare_cookies', lazy => 1);
53 if ( my $header = $self->header('Cookie') ) {
54 return { CGI::Simple::Cookie->parse($header) };
59 has query_keywords => (is => 'rw');
60 has match => (is => 'rw');
61 has method => (is => 'rw');
62 has protocol => (is => 'rw');
63 has query_parameters => (is => 'rw', default => sub { {} });
64 has secure => (is => 'rw', default => 0);
65 has captures => (is => 'rw', default => sub { [] });
66 has uri => (is => 'rw', predicate => 'has_uri');
67 has remote_user => (is => 'rw');
70 isa => 'HTTP::Headers',
71 handles => [qw(content_encoding content_length content_type header referer user_agent)],
72 builder => 'prepare_headers',
80 my $headers = HTTP::Headers->new();
82 for my $header (keys %{ $env }) {
83 next unless $header =~ /^(HTTP|CONTENT|COOKIE)/i;
84 (my $field = $header) =~ s/^HTTPS?_//;
86 $headers->header($field => $env->{$header});
99 predicate=>'has_io_fh',
101 builder=>'_build_io_fh');
105 return $self->env->{'psgix.io'}
107 $self->env->{'net.async.http.server.req'} &&
108 $self->env->{'net.async.http.server.req'}->stream) ## Until I can make ioasync cabal see the value of supportin psgix.io (jnap)
109 || die "Your Server does not support psgix.io";
112 has data_handlers => ( is=>'ro', isa=>'HashRef', default=>sub { +{} } );
117 builder=>'_build_body_data');
119 sub _build_body_data {
121 my $content_type = $self->content_type;
122 my ($match) = grep { $content_type =~/$_/i }
123 keys(%{$self->data_handlers});
126 my $fh = $self->body;
128 return $self->data_handlers->{$match}->($fh, $self);
134 has _use_hash_multivalue => (
139 # Amount of data to read from input on each pass
140 our $CHUNKSIZE = 64 * 1024;
143 my ($self, $maxlength) = @_;
144 my $remaining = $self->_read_length - $self->_read_position;
145 $maxlength ||= $CHUNKSIZE;
147 # Are we done reading?
148 if ( $remaining <= 0 ) {
152 my $readlen = ( $remaining > $maxlength ) ? $maxlength : $remaining;
153 my $rc = $self->read_chunk( my $buffer, $readlen );
155 if (0 == $rc) { # Nothing more to read even though Content-Length
156 # said there should be.
159 $self->_set_read_position( $self->_read_position + $rc );
163 Catalyst::Exception->throw(
164 message => "Unknown error reading input: $!" );
170 return $self->env->{'psgi.input'}->read(@_);
173 has body_parameters => (
177 builder => 'prepare_body_parameters',
183 default => sub { {} },
189 builder => '_build_parameters',
190 clearer => '_clear_parameters',
194 # - Can we lose the before modifiers which just call prepare_body ?
195 # they are wasteful, slow us down and feel cluttery.
197 # Can we make _body an attribute, have the rest of
198 # these lazy build from there and kill all the direct hash access
199 # in Catalyst.pm and Engine.pm?
201 sub prepare_parameters {
203 $self->_clear_parameters;
204 return $self->parameters;
207 sub _build_parameters {
210 my $body_parameters = $self->body_parameters;
211 my $query_parameters = $self->query_parameters;
213 ## setup for downstream plack
214 $self->env->{'plack.request.merged'} ||= do {
215 my $query = $self->env->{'plack.request.query'} || Hash::MultiValue->new;
216 my $body = $self->env->{'plack.request.body'} || Hash::MultiValue->new;
217 Hash::MultiValue->new($query->flatten, $body->flatten);
220 if($self->_use_hash_multivalue) {
221 return $self->env->{'plack.request.merged'}->clone; # We want a copy, in case your App is evil
224 # We copy, no references
225 foreach my $name (keys %$query_parameters) {
226 my $param = $query_parameters->{$name};
227 $parameters->{$name} = ref $param eq 'ARRAY' ? [ @$param ] : $param;
230 # Merge query and body parameters
231 foreach my $name (keys %$body_parameters) {
232 my $param = $body_parameters->{$name};
233 my @values = ref $param eq 'ARRAY' ? @$param : ($param);
234 if ( my $existing = $parameters->{$name} ) {
235 unshift(@values, (ref $existing eq 'ARRAY' ? @$existing : $existing));
237 $parameters->{$name} = @values > 1 ? \@values : $values[0];
244 predicate => '_has_uploadtmp',
250 # If previously applied middleware created the HTTP::Body object, then we
253 if(my $plack_body = $self->env->{'plack.request.http.body'}) {
254 $self->_body($plack_body);
255 $self->_body->cleanup(1);
259 # Define PSGI ENV placeholders, or for empty should there be no content
260 # body (typical in HEAD or GET). Looks like from Plack::Request that
261 # middleware would probably expect to see this, even if empty
263 $self->env->{'plack.request.body'} = Hash::MultiValue->new;
264 $self->env->{'plack.request.upload'} = Hash::MultiValue->new;
266 # If there is nothing to read, set body to naught and return. This
267 # will cause all body code to be skipped
269 return $self->_body(0) unless my $length = $self->_read_length;
271 # Unless the body has already been set, create it. Not sure about this
272 # code, how else might it be set, but this was existing logic.
274 unless ($self->_body) {
275 my $type = $self->header('Content-Type');
276 $self->_body(HTTP::Body->new( $type, $length ));
277 $self->_body->cleanup(1);
279 # JNAP: I'm not sure this is doing what we expect, but it also doesn't
280 # seem to be hurting (seems ->_has_uploadtmp is true more than I would
283 $self->_body->tmpdir( $self->_uploadtmp )
284 if $self->_has_uploadtmp;
287 # Ok if we get this far, we have to read psgi.input into the new body
288 # object. Lets play nice with any plack app or other downstream, so
289 # we create a buffer unless one exists.
292 if ($self->env->{'psgix.input.buffered'}) {
293 # Be paranoid about previous psgi middleware or apps that read the
294 # input but didn't return the buffer to the start.
295 $self->env->{'psgi.input'}->seek(0, 0);
297 $stream_buffer = Stream::Buffered->new($length);
300 # Check for definedness as you could read '0'
301 while ( defined ( my $chunk = $self->read() ) ) {
302 $self->prepare_body_chunk($chunk);
303 $stream_buffer->print($chunk) if $stream_buffer;
306 # Ok, we read the body. Lets play nice for any PSGI app down the pipe
308 if ($stream_buffer) {
309 $self->env->{'psgix.input.buffered'} = 1;
310 $self->env->{'psgi.input'} = $stream_buffer->rewind;
312 $self->env->{'psgi.input'}->seek(0, 0); # Reset the buffer for downstream middleware or apps
315 $self->env->{'plack.request.http.body'} = $self->_body;
316 $self->env->{'plack.request.body'} = Hash::MultiValue->from_mixed($self->_body->param);
318 # paranoia against wrong Content-Length header
319 my $remaining = $length - $self->_read_position;
320 if ( $remaining > 0 ) {
321 Catalyst::Exception->throw("Wrong Content-Length value: $length" );
325 sub prepare_body_chunk {
326 my ( $self, $chunk ) = @_;
328 $self->_body->add($chunk);
331 sub prepare_body_parameters {
334 $self->prepare_body if ! $self->_has_body;
335 return {} unless $self->_body;
337 return $self->_use_hash_multivalue ?
338 $self->env->{'plack.request.body'}->clone :
342 sub prepare_connection {
345 my $env = $self->env;
347 $self->address( $env->{REMOTE_ADDR} );
348 $self->hostname( $env->{REMOTE_HOST} )
349 if exists $env->{REMOTE_HOST};
350 $self->protocol( $env->{SERVER_PROTOCOL} );
351 $self->remote_user( $env->{REMOTE_USER} );
352 $self->method( $env->{REQUEST_METHOD} );
353 $self->secure( $env->{'psgi.url_scheme'} eq 'https' ? 1 : 0 );
356 # XXX - FIXME - method is here now, move this crap...
357 around parameters => sub {
358 my ($orig, $self, $params) = @_;
360 if ( !ref $params ) {
362 "Attempt to retrieve '$params' with req->params(), " .
363 "you probably meant to call req->param('$params')"
367 return $self->$orig($params);
378 return $self->path if $self->has_uri;
383 is => 'rw', clearer => '_clear_body', predicate => '_has_body',
385 # Eugh, ugly. Should just be able to rename accessor methods to 'body'
386 # and provide a custom reader..
389 $self->prepare_body unless $self->_has_body;
390 croak 'body is a reader' if scalar @_;
391 return blessed $self->_body ? $self->_body->body : $self->_body;
400 gethostbyaddr( inet_aton( $self->address ), AF_INET ) || $self->address
404 has _path => ( is => 'rw', predicate => '_has_path', clearer => '_clear_path' );
406 sub args { shift->arguments(@_) }
407 sub body_params { shift->body_parameters(@_) }
408 sub input { shift->body(@_) }
409 sub params { shift->parameters(@_) }
410 sub query_params { shift->query_parameters(@_) }
411 sub path_info { shift->path(@_) }
413 =for stopwords param params
417 Catalyst::Request - provides information about the current client request
422 $req->address eq "127.0.0.1";
428 $req->body_parameters;
429 $req->content_encoding;
430 $req->content_length;
438 $req->query_keywords;
446 $req->query_parameters;
457 See also L<Catalyst>, L<Catalyst::Request::Upload>.
461 This is the Catalyst Request class, which provides an interface to data for the
462 current client request. The request object is prepared by L<Catalyst::Engine>,
463 thus hiding the details of the particular engine implementation.
469 Returns the IP address of the client.
471 =head2 $req->arguments
473 Returns a reference to an array containing the arguments.
475 print $c->request->arguments->[0];
477 For example, if your action was
479 package MyApp::Controller::Foo;
485 and the URI for the request was C<http://.../foo/moose/bah>, the string C<bah>
486 would be the first and only argument.
488 Arguments get automatically URI-unescaped for you.
492 Shortcut for L</arguments>.
496 Contains the URI base. This will always have a trailing slash. Note that the
497 URI scheme (e.g., http vs. https) must be determined through heuristics;
498 depending on your server configuration, it may be incorrect. See $req->secure
501 If your application was queried with the URI
502 C<http://localhost:3000/some/path> then C<base> is C<http://localhost:3000/>.
506 Returns the message body of the request, as returned by L<HTTP::Body>: a string,
507 unless Content-Type is C<application/x-www-form-urlencoded>, C<text/xml>, or
508 C<multipart/form-data>, in which case a L<File::Temp> object is returned.
510 =head2 $req->body_data
512 Returns a Perl representation of POST/PUT body data that is not classic HTML
513 form data, such as JSON, XML, etc. By default, Catalyst will parse incoming
514 data of the type 'application/json' and return access to that data via this
515 method. You may define addition data_handlers via a global configuration
516 setting. See L<Catalyst\DATA HANDLERS> for more information.
518 =head2 $req->body_parameters
520 Returns a reference to a hash containing body (POST) parameters. Values can
521 be either a scalar or an arrayref containing scalars.
523 print $c->request->body_parameters->{field};
524 print $c->request->body_parameters->{field}->[0];
526 These are the parameters from the POST part of the request, if any.
528 =head2 $req->body_params
530 Shortcut for body_parameters.
532 =head2 $req->content_encoding
534 Shortcut for $req->headers->content_encoding.
536 =head2 $req->content_length
538 Shortcut for $req->headers->content_length.
540 =head2 $req->content_type
542 Shortcut for $req->headers->content_type.
546 A convenient method to access $req->cookies.
548 $cookie = $c->request->cookie('name');
549 @cookies = $c->request->cookie;
557 return keys %{ $self->cookies };
564 unless ( exists $self->cookies->{$name} ) {
568 return $self->cookies->{$name};
574 Returns a reference to a hash containing the cookies.
576 print $c->request->cookies->{mycookie}->value;
578 The cookies in the hash are indexed by name, and the values are L<CGI::Simple::Cookie>
583 Shortcut for $req->headers->header.
587 Returns an L<HTTP::Headers> object containing the headers for the current request.
589 print $c->request->headers->header('X-Catalyst');
591 =head2 $req->hostname
593 Returns the hostname of the client. Use C<< $req->uri->host >> to get the hostname of the server.
597 Alias for $req->body.
599 =head2 $req->query_keywords
601 Contains the keywords portion of a query string, when no '=' signs are
604 http://localhost/path?some+keywords
606 $c->request->query_keywords will contain 'some keywords'
610 This contains the matching part of a Regex action. Otherwise
611 it returns the same as 'action', except for default actions,
612 which return an empty string.
616 Contains the request method (C<GET>, C<POST>, C<HEAD>, etc).
620 Returns GET and POST parameters with a CGI.pm-compatible param method. This
621 is an alternative method for accessing parameters in $c->req->parameters.
623 $value = $c->request->param( 'foo' );
624 @values = $c->request->param( 'foo' );
625 @params = $c->request->param;
627 Like L<CGI>, and B<unlike> earlier versions of Catalyst, passing multiple
628 arguments to this method, like this:
630 $c->request->param( 'foo', 'bar', 'gorch', 'quxx' );
632 will set the parameter C<foo> to the multiple values C<bar>, C<gorch> and
633 C<quxx>. Previously this would have added C<bar> as another value to C<foo>
634 (creating it if it didn't exist before), and C<quxx> as another value for
637 B<NOTE> this is considered a legacy interface and care should be taken when
638 using it. C<< scalar $c->req->param( 'foo' ) >> will return only the first
639 C<foo> param even if multiple are present; C<< $c->req->param( 'foo' ) >> will
640 return a list of as many are present, which can have unexpected consequences
641 when writing code of the form:
645 baz => $c->req->param( 'baz' ),
648 If multiple C<baz> parameters are provided this code might corrupt data or
649 cause a hash initialization error. For a more straightforward interface see
650 C<< $c->req->parameters >>.
658 return keys %{ $self->parameters };
665 unless ( exists $self->parameters->{$param} ) {
666 return wantarray ? () : undef;
669 if ( ref $self->parameters->{$param} eq 'ARRAY' ) {
671 ? @{ $self->parameters->{$param} }
672 : $self->parameters->{$param}->[0];
676 ? ( $self->parameters->{$param} )
677 : $self->parameters->{$param};
682 $self->parameters->{$field} = [@_];
686 =head2 $req->parameters
688 Returns a reference to a hash containing GET and POST parameters. Values can
689 be either a scalar or an arrayref containing scalars.
691 print $c->request->parameters->{field};
692 print $c->request->parameters->{field}->[0];
694 This is the combination of C<query_parameters> and C<body_parameters>.
698 Shortcut for $req->parameters.
702 Returns the path, i.e. the part of the URI after $req->base, for the current request.
704 http://localhost/path/foo
706 $c->request->path will contain 'path/foo'
708 =head2 $req->path_info
710 Alias for path, added for compatibility with L<CGI>.
715 my ( $self, @params ) = @_;
718 $self->uri->path(@params);
721 elsif ( $self->_has_path ) {
725 my $path = $self->uri->path;
726 my $location = $self->base->path;
727 $path =~ s/^(\Q$location\E)?//;
735 =head2 $req->protocol
737 Returns the protocol (HTTP/1.0 or HTTP/1.1) used for the current request.
739 =head2 $req->query_parameters
741 =head2 $req->query_params
743 Returns a reference to a hash containing query string (GET) parameters. Values can
744 be either a scalar or an arrayref containing scalars.
746 print $c->request->query_parameters->{field};
747 print $c->request->query_parameters->{field}->[0];
749 =head2 $req->read( [$maxlength] )
751 Reads a chunk of data from the request body. This method is intended to be
752 used in a while loop, reading $maxlength bytes on every call. $maxlength
753 defaults to the size of the request if not specified.
755 =head2 $req->read_chunk(\$buff, $max)
759 You have to set MyApp->config(parse_on_demand => 1) to use this directly.
763 Shortcut for $req->headers->referer. Returns the referring page.
767 Returns true or false, indicating whether the connection is secure
768 (https). The reliability of $req->secure may depend on your server
769 configuration; Catalyst relies on PSGI to determine whether or not a
770 request is secure (Catalyst looks at psgi.url_scheme), and different
771 PSGI servers may make this determination in different ways (as by
772 directly passing along information from the server, interpreting any of
773 several HTTP headers, or using heuristics of their own).
775 =head2 $req->captures
777 Returns a reference to an array containing captured args from chained
778 actions or regex captures.
780 my @captures = @{ $c->request->captures };
784 A convenient method to access $req->uploads.
786 $upload = $c->request->upload('field');
787 @uploads = $c->request->upload('field');
788 @fields = $c->request->upload;
790 for my $upload ( $c->request->upload('field') ) {
791 print $upload->filename;
800 return keys %{ $self->uploads };
807 unless ( exists $self->uploads->{$upload} ) {
808 return wantarray ? () : undef;
811 if ( ref $self->uploads->{$upload} eq 'ARRAY' ) {
813 ? @{ $self->uploads->{$upload} }
814 : $self->uploads->{$upload}->[0];
818 ? ( $self->uploads->{$upload} )
819 : $self->uploads->{$upload};
825 while ( my ( $field, $upload ) = splice( @_, 0, 2 ) ) {
827 if ( exists $self->uploads->{$field} ) {
828 for ( $self->uploads->{$field} ) {
829 $_ = [$_] unless ref($_) eq "ARRAY";
830 push( @$_, $upload );
834 $self->uploads->{$field} = $upload;
842 Returns a reference to a hash containing uploads. Values can be either a
843 L<Catalyst::Request::Upload> object, or an arrayref of
844 L<Catalyst::Request::Upload> objects.
846 my $upload = $c->request->uploads->{field};
847 my $upload = $c->request->uploads->{field}->[0];
851 Returns a L<URI> object for the current request. Stringifies to the URI text.
853 =head2 $req->mangle_params( { key => 'value' }, $appendmode);
855 Returns a hashref of parameters stemming from the current request's params,
856 plus the ones supplied. Keys for which no current param exists will be
857 added, keys with undefined values will be removed and keys with existing
858 params will be replaced. Note that you can supply a true value as the final
859 argument to change behavior with regards to existing parameters, appending
860 values rather than replacing them.
864 # URI query params foo=1
865 my $hashref = $req->mangle_params({ foo => 2 });
866 # Result is query params of foo=2
870 # URI query params foo=1
871 my $hashref = $req->mangle_params({ foo => 2 }, 1);
872 # Result is query params of foo=1&foo=2
874 This is the code behind C<uri_with>.
879 my ($self, $args, $append) = @_;
881 carp('No arguments passed to mangle_params()') unless $args;
883 foreach my $value ( values %$args ) {
884 next unless defined $value;
885 for ( ref $value eq 'ARRAY' ? @$value : $value ) {
887 utf8::encode( $_ ) if utf8::is_utf8($_);
891 my %params = %{ $self->uri->query_form_hash };
892 foreach my $key (keys %{ $args }) {
893 my $val = $args->{$key};
896 if($append && exists($params{$key})) {
898 # This little bit of heaven handles appending a new value onto
899 # an existing one regardless if the existing value is an array
900 # or not, and regardless if the new value is an array or not
902 ref($params{$key}) eq 'ARRAY' ? @{ $params{$key} } : $params{$key},
903 ref($val) eq 'ARRAY' ? @{ $val } : $val
907 $params{$key} = $val;
911 # If the param wasn't defined then we delete it.
912 delete($params{$key});
920 =head2 $req->uri_with( { key => 'value' } );
922 Returns a rewritten URI object for the current request. Key/value pairs
923 passed in will override existing parameters. You can remove an existing
924 parameter by passing in an undef value. Unmodified pairs will be
927 You may also pass an optional second parameter that puts C<uri_with> into
930 $req->uri_with( { key => 'value' }, { mode => 'append' } );
932 See C<mangle_params> for an explanation of this behavior.
937 my( $self, $args, $behavior) = @_;
939 carp( 'No arguments passed to uri_with()' ) unless $args;
942 if((ref($behavior) eq 'HASH') && defined($behavior->{mode}) && ($behavior->{mode} eq 'append')) {
946 my $params = $self->mangle_params($args, $append);
948 my $uri = $self->uri->clone;
949 $uri->query_form($params);
954 =head2 $req->remote_user
956 Returns the value of the C<REMOTE_USER> environment variable.
958 =head2 $req->user_agent
960 Shortcut to $req->headers->user_agent. Returns the user agent (browser)
965 Returns a psgix.io bidirectional socket, if your server supports one. Used for
966 when you want to jailbreak out of PSGI and handle bidirectional client server
967 communication manually, such as when you are using cometd or websockets.
971 You should never need to call these yourself in application code,
972 however they are useful if extending Catalyst by applying a request role.
974 =head2 $self->prepare_headers()
976 Sets up the C<< $res->headers >> accessor.
978 =head2 $self->prepare_body()
980 Sets up the body using L<HTTP::Body>
982 =head2 $self->prepare_body_chunk()
984 Add a chunk to the request body.
986 =head2 $self->prepare_body_parameters()
988 Sets up parameters from body.
990 =head2 $self->prepare_cookies()
992 Parse cookies from header. Sets up a L<CGI::Simple::Cookie> object.
994 =head2 $self->prepare_connection()
996 Sets up various fields in the request like the local and remote addresses,
997 request method, hostname requested etc.
999 =head2 $self->prepare_parameters()
1001 Ensures that the body has been parsed, then builds the parameters, which are
1002 combined from those in the request and those in the body.
1004 If parameters have already been set will clear the parameters and build them again.
1013 Catalyst Contributors, see Catalyst.pm
1017 This library is free software. You can redistribute it and/or modify
1018 it under the same terms as Perl itself.
1022 __PACKAGE__->meta->make_immutable;