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', lazy=>1, default => sub { shift->_use_hash_multivalue ? Hash::MultiValue->new : +{} });
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 if($self->_use_hash_multivalue) {
214 return Hash::MultiValue->new($query_parameters->flatten, $body_parameters->flatten);
217 # We copy, no references
218 foreach my $name (keys %$query_parameters) {
219 my $param = $query_parameters->{$name};
220 $parameters->{$name} = ref $param eq 'ARRAY' ? [ @$param ] : $param;
223 # Merge query and body parameters
224 foreach my $name (keys %$body_parameters) {
225 my $param = $body_parameters->{$name};
226 my @values = ref $param eq 'ARRAY' ? @$param : ($param);
227 if ( my $existing = $parameters->{$name} ) {
228 unshift(@values, (ref $existing eq 'ARRAY' ? @$existing : $existing));
230 $parameters->{$name} = @values > 1 ? \@values : $values[0];
237 predicate => '_has_uploadtmp',
243 # If previously applied middleware created the HTTP::Body object, then we
246 if(my $plack_body = $self->_has_env ? $self->env->{'plack.request.http.body'} : undef) {
247 $self->_body($plack_body);
248 $self->_body->cleanup(1);
252 # If there is nothing to read, set body to naught and return. This
253 # will cause all body code to be skipped
255 return $self->_body(0) unless my $length = $self->_read_length;
257 # Unless the body has already been set, create it. Not sure about this
258 # code, how else might it be set, but this was existing logic.
260 unless ($self->_body) {
261 my $type = $self->header('Content-Type');
262 $self->_body(HTTP::Body->new( $type, $length ));
263 $self->_body->cleanup(1);
265 # JNAP: I'm not sure this is doing what we expect, but it also doesn't
266 # seem to be hurting (seems ->_has_uploadtmp is true more than I would
269 $self->_body->tmpdir( $self->_uploadtmp )
270 if $self->_has_uploadtmp;
273 # Ok if we get this far, we have to read psgi.input into the new body
274 # object. Lets play nice with any plack app or other downstream, so
275 # we create a buffer unless one exists.
278 if ($self->env->{'psgix.input.buffered'}) {
279 # Be paranoid about previous psgi middleware or apps that read the
280 # input but didn't return the buffer to the start.
281 $self->env->{'psgi.input'}->seek(0, 0);
283 $stream_buffer = Stream::Buffered->new($length);
286 # Check for definedness as you could read '0'
287 while ( defined ( my $chunk = $self->read() ) ) {
288 $self->prepare_body_chunk($chunk);
289 $stream_buffer->print($chunk) if $stream_buffer;
292 # Ok, we read the body. Lets play nice for any PSGI app down the pipe
294 if ($stream_buffer) {
295 $self->env->{'psgix.input.buffered'} = 1;
296 $self->env->{'psgi.input'} = $stream_buffer->rewind;
298 $self->env->{'psgi.input'}->seek(0, 0); # Reset the buffer for downstream middleware or apps
301 # paranoia against wrong Content-Length header
302 my $remaining = $length - $self->_read_position;
303 if ( $remaining > 0 ) {
304 Catalyst::Exception->throw("Wrong Content-Length value: $length" );
308 sub prepare_body_chunk {
309 my ( $self, $chunk ) = @_;
311 $self->_body->add($chunk);
314 sub prepare_body_parameters {
317 $self->prepare_body if ! $self->_has_body;
319 unless($self->_body) {
320 return $self->_use_hash_multivalue ? Hash::MultiValue->new : {};
323 return $self->_use_hash_multivalue ?
324 Hash::MultiValue->from_mixed($self->_body->param) :
328 sub prepare_connection {
331 my $env = $self->env;
333 $self->address( $env->{REMOTE_ADDR} );
334 $self->hostname( $env->{REMOTE_HOST} )
335 if exists $env->{REMOTE_HOST};
336 $self->protocol( $env->{SERVER_PROTOCOL} );
337 $self->remote_user( $env->{REMOTE_USER} );
338 $self->method( $env->{REQUEST_METHOD} );
339 $self->secure( $env->{'psgi.url_scheme'} eq 'https' ? 1 : 0 );
342 # XXX - FIXME - method is here now, move this crap...
343 around parameters => sub {
344 my ($orig, $self, $params) = @_;
346 if ( !ref $params ) {
348 "Attempt to retrieve '$params' with req->params(), " .
349 "you probably meant to call req->param('$params')"
353 return $self->$orig($params);
364 return $self->path if $self->has_uri;
369 is => 'rw', clearer => '_clear_body', predicate => '_has_body',
371 # Eugh, ugly. Should just be able to rename accessor methods to 'body'
372 # and provide a custom reader..
375 $self->prepare_body unless $self->_has_body;
376 croak 'body is a reader' if scalar @_;
377 return blessed $self->_body ? $self->_body->body : $self->_body;
386 gethostbyaddr( inet_aton( $self->address ), AF_INET ) || $self->address
390 has _path => ( is => 'rw', predicate => '_has_path', clearer => '_clear_path' );
392 sub args { shift->arguments(@_) }
393 sub body_params { shift->body_parameters(@_) }
394 sub input { shift->body(@_) }
395 sub params { shift->parameters(@_) }
396 sub query_params { shift->query_parameters(@_) }
397 sub path_info { shift->path(@_) }
399 =for stopwords param params
403 Catalyst::Request - provides information about the current client request
408 $req->address eq "127.0.0.1";
414 $req->body_parameters;
415 $req->content_encoding;
416 $req->content_length;
424 $req->query_keywords;
432 $req->query_parameters;
444 See also L<Catalyst>, L<Catalyst::Request::Upload>.
448 This is the Catalyst Request class, which provides an interface to data for the
449 current client request. The request object is prepared by L<Catalyst::Engine>,
450 thus hiding the details of the particular engine implementation.
456 Returns the IP address of the client.
458 =head2 $req->arguments
460 Returns a reference to an array containing the arguments.
462 print $c->request->arguments->[0];
464 For example, if your action was
466 package MyApp::Controller::Foo;
472 and the URI for the request was C<http://.../foo/moose/bah>, the string C<bah>
473 would be the first and only argument.
475 Arguments get automatically URI-unescaped for you.
479 Shortcut for L</arguments>.
483 Contains the URI base. This will always have a trailing slash. Note that the
484 URI scheme (e.g., http vs. https) must be determined through heuristics;
485 depending on your server configuration, it may be incorrect. See $req->secure
488 If your application was queried with the URI
489 C<http://localhost:3000/some/path> then C<base> is C<http://localhost:3000/>.
493 Returns the message body of the request, as returned by L<HTTP::Body>: a string,
494 unless Content-Type is C<application/x-www-form-urlencoded>, C<text/xml>, or
495 C<multipart/form-data>, in which case a L<File::Temp> object is returned.
497 =head2 $req->body_data
499 Returns a Perl representation of POST/PUT body data that is not classic HTML
500 form data, such as JSON, XML, etc. By default, Catalyst will parse incoming
501 data of the type 'application/json' and return access to that data via this
502 method. You may define addition data_handlers via a global configuration
503 setting. See L<Catalyst\DATA HANDLERS> for more information.
505 =head2 $req->body_parameters
507 Returns a reference to a hash containing body (POST) parameters. Values can
508 be either a scalar or an arrayref containing scalars.
510 print $c->request->body_parameters->{field};
511 print $c->request->body_parameters->{field}->[0];
513 These are the parameters from the POST part of the request, if any.
515 =head2 $req->body_params
517 Shortcut for body_parameters.
519 =head2 $req->content_encoding
521 Shortcut for $req->headers->content_encoding.
523 =head2 $req->content_length
525 Shortcut for $req->headers->content_length.
527 =head2 $req->content_type
529 Shortcut for $req->headers->content_type.
533 A convenient method to access $req->cookies.
535 $cookie = $c->request->cookie('name');
536 @cookies = $c->request->cookie;
544 return keys %{ $self->cookies };
551 unless ( exists $self->cookies->{$name} ) {
555 return $self->cookies->{$name};
561 Returns a reference to a hash containing the cookies.
563 print $c->request->cookies->{mycookie}->value;
565 The cookies in the hash are indexed by name, and the values are L<CGI::Simple::Cookie>
570 Shortcut for $req->headers->header.
574 Returns an L<HTTP::Headers> object containing the headers for the current request.
576 print $c->request->headers->header('X-Catalyst');
578 =head2 $req->hostname
580 Returns the hostname of the client. Use C<< $req->uri->host >> to get the hostname of the server.
584 Alias for $req->body.
586 =head2 $req->query_keywords
588 Contains the keywords portion of a query string, when no '=' signs are
591 http://localhost/path?some+keywords
593 $c->request->query_keywords will contain 'some keywords'
597 This contains the matching part of a Regex action. Otherwise
598 it returns the same as 'action', except for default actions,
599 which return an empty string.
603 Contains the request method (C<GET>, C<POST>, C<HEAD>, etc).
607 Returns GET and POST parameters with a CGI.pm-compatible param method. This
608 is an alternative method for accessing parameters in $c->req->parameters.
610 $value = $c->request->param( 'foo' );
611 @values = $c->request->param( 'foo' );
612 @params = $c->request->param;
614 Like L<CGI>, and B<unlike> earlier versions of Catalyst, passing multiple
615 arguments to this method, like this:
617 $c->request->param( 'foo', 'bar', 'gorch', 'quxx' );
619 will set the parameter C<foo> to the multiple values C<bar>, C<gorch> and
620 C<quxx>. Previously this would have added C<bar> as another value to C<foo>
621 (creating it if it didn't exist before), and C<quxx> as another value for
624 B<NOTE> this is considered a legacy interface and care should be taken when
625 using it. C<< scalar $c->req->param( 'foo' ) >> will return only the first
626 C<foo> param even if multiple are present; C<< $c->req->param( 'foo' ) >> will
627 return a list of as many are present, which can have unexpected consequences
628 when writing code of the form:
632 baz => $c->req->param( 'baz' ),
635 If multiple C<baz> parameters are provided this code might corrupt data or
636 cause a hash initialization error. For a more straightforward interface see
637 C<< $c->req->parameters >>.
645 return keys %{ $self->parameters };
648 # If anything in @_ is undef, carp about that, and remove it from
651 my @params = grep { defined($_) ? 1 : do {carp "You called ->params with an undefined value"; 0} } @_;
653 if ( @params == 1 ) {
655 defined(my $param = shift @params) ||
656 carp "You called ->params with an undefined value 2";
658 unless ( exists $self->parameters->{$param} ) {
659 return wantarray ? () : undef;
662 if ( ref $self->parameters->{$param} eq 'ARRAY' ) {
664 ? @{ $self->parameters->{$param} }
665 : $self->parameters->{$param}->[0];
669 ? ( $self->parameters->{$param} )
670 : $self->parameters->{$param};
673 elsif ( @params > 1 ) {
674 my $field = shift @params;
675 $self->parameters->{$field} = [@_];
679 =head2 $req->parameters
681 Returns a reference to a hash containing GET and POST parameters. Values can
682 be either a scalar or an arrayref containing scalars.
684 print $c->request->parameters->{field};
685 print $c->request->parameters->{field}->[0];
687 This is the combination of C<query_parameters> and C<body_parameters>.
691 Shortcut for $req->parameters.
695 Returns the path, i.e. the part of the URI after $req->base, for the current request.
697 http://localhost/path/foo
699 $c->request->path will contain 'path/foo'
701 =head2 $req->path_info
703 Alias for path, added for compatibility with L<CGI>.
708 my ( $self, @params ) = @_;
711 $self->uri->path(@params);
714 elsif ( $self->_has_path ) {
718 my $path = $self->uri->path;
719 my $location = $self->base->path;
720 $path =~ s/^(\Q$location\E)?//;
728 =head2 $req->protocol
730 Returns the protocol (HTTP/1.0 or HTTP/1.1) used for the current request.
732 =head2 $req->query_parameters
734 =head2 $req->query_params
736 Returns a reference to a hash containing query string (GET) parameters. Values can
737 be either a scalar or an arrayref containing scalars.
739 print $c->request->query_parameters->{field};
740 print $c->request->query_parameters->{field}->[0];
742 =head2 $req->read( [$maxlength] )
744 Reads a chunk of data from the request body. This method is intended to be
745 used in a while loop, reading $maxlength bytes on every call. $maxlength
746 defaults to the size of the request if not specified.
748 =head2 $req->read_chunk(\$buff, $max)
752 You have to set MyApp->config(parse_on_demand => 1) to use this directly.
756 Shortcut for $req->headers->referer. Returns the referring page.
760 Returns true or false, indicating whether the connection is secure
761 (https). The reliability of $req->secure may depend on your server
762 configuration; Catalyst relies on PSGI to determine whether or not a
763 request is secure (Catalyst looks at psgi.url_scheme), and different
764 PSGI servers may make this determination in different ways (as by
765 directly passing along information from the server, interpreting any of
766 several HTTP headers, or using heuristics of their own).
768 =head2 $req->captures
770 Returns a reference to an array containing captured args from chained
771 actions or regex captures.
773 my @captures = @{ $c->request->captures };
777 A convenient method to access $req->uploads.
779 $upload = $c->request->upload('field');
780 @uploads = $c->request->upload('field');
781 @fields = $c->request->upload;
783 for my $upload ( $c->request->upload('field') ) {
784 print $upload->filename;
793 return keys %{ $self->uploads };
800 unless ( exists $self->uploads->{$upload} ) {
801 return wantarray ? () : undef;
804 if ( ref $self->uploads->{$upload} eq 'ARRAY' ) {
806 ? @{ $self->uploads->{$upload} }
807 : $self->uploads->{$upload}->[0];
811 ? ( $self->uploads->{$upload} )
812 : $self->uploads->{$upload};
818 while ( my ( $field, $upload ) = splice( @_, 0, 2 ) ) {
820 if ( exists $self->uploads->{$field} ) {
821 for ( $self->uploads->{$field} ) {
822 $_ = [$_] unless ref($_) eq "ARRAY";
823 push( @$_, $upload );
827 $self->uploads->{$field} = $upload;
835 Returns a reference to a hash containing uploads. Values can be either a
836 L<Catalyst::Request::Upload> object, or an arrayref of
837 L<Catalyst::Request::Upload> objects.
839 my $upload = $c->request->uploads->{field};
840 my $upload = $c->request->uploads->{field}->[0];
844 Returns a L<URI> object for the current request. Stringifies to the URI text.
846 =head2 $req->mangle_params( { key => 'value' }, $appendmode);
848 Returns a hashref of parameters stemming from the current request's params,
849 plus the ones supplied. Keys for which no current param exists will be
850 added, keys with undefined values will be removed and keys with existing
851 params will be replaced. Note that you can supply a true value as the final
852 argument to change behavior with regards to existing parameters, appending
853 values rather than replacing them.
857 # URI query params foo=1
858 my $hashref = $req->mangle_params({ foo => 2 });
859 # Result is query params of foo=2
863 # URI query params foo=1
864 my $hashref = $req->mangle_params({ foo => 2 }, 1);
865 # Result is query params of foo=1&foo=2
867 This is the code behind C<uri_with>.
872 my ($self, $args, $append) = @_;
874 carp('No arguments passed to mangle_params()') unless $args;
876 foreach my $value ( values %$args ) {
877 next unless defined $value;
878 for ( ref $value eq 'ARRAY' ? @$value : $value ) {
880 utf8::encode( $_ ) if utf8::is_utf8($_);
884 my %params = %{ $self->uri->query_form_hash };
885 foreach my $key (keys %{ $args }) {
886 my $val = $args->{$key};
889 if($append && exists($params{$key})) {
891 # This little bit of heaven handles appending a new value onto
892 # an existing one regardless if the existing value is an array
893 # or not, and regardless if the new value is an array or not
895 ref($params{$key}) eq 'ARRAY' ? @{ $params{$key} } : $params{$key},
896 ref($val) eq 'ARRAY' ? @{ $val } : $val
900 $params{$key} = $val;
904 # If the param wasn't defined then we delete it.
905 delete($params{$key});
913 =head2 $req->uri_with( { key => 'value' } );
915 Returns a rewritten URI object for the current request. Key/value pairs
916 passed in will override existing parameters. You can remove an existing
917 parameter by passing in an undef value. Unmodified pairs will be
920 You may also pass an optional second parameter that puts C<uri_with> into
923 $req->uri_with( { key => 'value' }, { mode => 'append' } );
925 See C<mangle_params> for an explanation of this behavior.
930 my( $self, $args, $behavior) = @_;
932 carp( 'No arguments passed to uri_with()' ) unless $args;
935 if((ref($behavior) eq 'HASH') && defined($behavior->{mode}) && ($behavior->{mode} eq 'append')) {
939 my $params = $self->mangle_params($args, $append);
941 my $uri = $self->uri->clone;
942 $uri->query_form($params);
947 =head2 $req->remote_user
949 Returns the value of the C<REMOTE_USER> environment variable.
951 =head2 $req->user_agent
953 Shortcut to $req->headers->user_agent. Returns the user agent (browser)
958 Returns a psgix.io bidirectional socket, if your server supports one. Used for
959 when you want to jailbreak out of PSGI and handle bidirectional client server
960 communication manually, such as when you are using cometd or websockets.
964 You should never need to call these yourself in application code,
965 however they are useful if extending Catalyst by applying a request role.
967 =head2 $self->prepare_headers()
969 Sets up the C<< $res->headers >> accessor.
971 =head2 $self->prepare_body()
973 Sets up the body using L<HTTP::Body>
975 =head2 $self->prepare_body_chunk()
977 Add a chunk to the request body.
979 =head2 $self->prepare_body_parameters()
981 Sets up parameters from body.
983 =head2 $self->prepare_cookies()
985 Parse cookies from header. Sets up a L<CGI::Simple::Cookie> object.
987 =head2 $self->prepare_connection()
989 Sets up various fields in the request like the local and remote addresses,
990 request method, hostname requested etc.
992 =head2 $self->prepare_parameters()
994 Ensures that the body has been parsed, then builds the parameters, which are
995 combined from those in the request and those in the body.
997 If parameters have already been set will clear the parameters and build them again.
1001 Access to the raw PSGI env.
1009 Catalyst Contributors, see Catalyst.pm
1013 This library is free software. You can redistribute it and/or modify
1014 it under the same terms as Perl itself.
1018 __PACKAGE__->meta->make_immutable;