1 package Catalyst::Request;
3 use IO::Socket qw[AF_INET inet_aton];
14 use Catalyst::Exception;
15 use Catalyst::Request::PartData;
18 use namespace::clean -except => 'meta';
20 with 'MooseX::Emulate::Class::Accessor::Fast';
22 has env => (is => 'ro', writer => '_set_env', predicate => '_has_env');
23 # XXX Deprecated crap here - warn?
24 has action => (is => 'rw');
25 # XXX: Deprecated in docs ages ago (2006), deprecated with warning in 5.8000 due
26 # to confusion between Engines and Plugin::Authentication. Remove in 5.8100?
27 has user => (is => 'rw');
28 sub snippets { shift->captures(@_) }
30 has _read_position => (
31 # FIXME: work around Moose bug RT#75367
34 writer => '_set_read_position',
38 # FIXME: work around Moose bug RT#75367
43 $self->header('Content-Length') || 0;
48 has address => (is => 'rw');
49 has arguments => (is => 'rw', default => sub { [] });
50 has cookies => (is => 'ro', builder => 'prepare_cookies', lazy => 1);
55 if ( my $header = $self->header('Cookie') ) {
56 return { CGI::Simple::Cookie->parse($header) };
61 has query_keywords => (is => 'rw');
62 has match => (is => 'rw');
63 has method => (is => 'rw');
64 has protocol => (is => 'rw');
65 has query_parameters => (is => 'rw', lazy=>1, default => sub { shift->_use_hash_multivalue ? Hash::MultiValue->new : +{} });
66 has secure => (is => 'rw', default => 0);
67 has captures => (is => 'rw', default => sub { [] });
68 has uri => (is => 'rw', predicate => 'has_uri');
69 has remote_user => (is => 'rw');
72 isa => 'HTTP::Headers',
73 handles => [qw(content_encoding content_length content_type header referer user_agent)],
74 builder => 'prepare_headers',
82 my $headers = HTTP::Headers->new();
84 for my $header (keys %{ $env }) {
85 next unless $header =~ /^(HTTP|CONTENT|COOKIE)/i;
86 (my $field = $header) =~ s/^HTTPS?_//;
88 $headers->header($field => $env->{$header});
101 predicate=>'_has_io_fh',
103 builder=>'_build_io_fh');
107 return $self->env->{'psgix.io'}
109 $self->env->{'net.async.http.server.req'} &&
110 $self->env->{'net.async.http.server.req'}->stream) ## Until I can make ioasync cabal see the value of supportin psgix.io (jnap)
111 || die "Your Server does not support psgix.io";
114 has data_handlers => ( is=>'ro', isa=>'HashRef', default=>sub { +{} } );
119 builder=>'_build_body_data');
121 sub _build_body_data {
124 # Not sure if these returns should not be exceptions...
125 my $content_type = $self->content_type || return;
126 return unless ($self->method eq 'POST' || $self->method eq 'PUT');
128 my ($match) = grep { $content_type =~/$_/i }
129 keys(%{$self->data_handlers});
132 my $fh = $self->body;
134 return $self->data_handlers->{$match}->($fh, $self);
136 Catalyst::Exception->throw("$content_type is does not have an available data handler");
140 has _use_hash_multivalue => (
145 # Amount of data to read from input on each pass
146 our $CHUNKSIZE = 64 * 1024;
149 my ($self, $maxlength) = @_;
150 my $remaining = $self->_read_length - $self->_read_position;
151 $maxlength ||= $CHUNKSIZE;
153 # Are we done reading?
154 if ( $remaining <= 0 ) {
158 my $readlen = ( $remaining > $maxlength ) ? $maxlength : $remaining;
159 my $rc = $self->read_chunk( my $buffer, $readlen );
161 if (0 == $rc) { # Nothing more to read even though Content-Length
162 # said there should be.
165 $self->_set_read_position( $self->_read_position + $rc );
169 Catalyst::Exception->throw(
170 message => "Unknown error reading input: $!" );
176 return $self->env->{'psgi.input'}->read(@_);
179 has body_parameters => (
183 predicate => 'has_body_parameters',
184 builder => 'prepare_body_parameters',
190 default => sub { {} },
196 builder => '_build_parameters',
197 clearer => '_clear_parameters',
201 # - Can we lose the before modifiers which just call prepare_body ?
202 # they are wasteful, slow us down and feel cluttery.
204 # Can we make _body an attribute, have the rest of
205 # these lazy build from there and kill all the direct hash access
206 # in Catalyst.pm and Engine.pm?
208 sub prepare_parameters {
210 $self->_clear_parameters;
211 return $self->parameters;
214 sub _build_parameters {
217 my $body_parameters = $self->body_parameters;
218 my $query_parameters = $self->query_parameters;
220 if($self->_use_hash_multivalue) {
221 return Hash::MultiValue->new($query_parameters->flatten, $body_parameters->flatten);
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->_has_env ? $self->env->{'plack.request.http.body'} : undef) {
254 $self->_body($plack_body);
255 $self->_body->cleanup(1);
259 # If there is nothing to read, set body to naught and return. This
260 # will cause all body code to be skipped
262 return $self->_body(0) unless my $length = $self->_read_length;
264 # Unless the body has already been set, create it. Not sure about this
265 # code, how else might it be set, but this was existing logic.
267 unless ($self->_body) {
268 my $type = $self->header('Content-Type');
269 $self->_body(HTTP::Body->new( $type, $length ));
270 $self->_body->cleanup(1);
272 # JNAP: I'm not sure this is doing what we expect, but it also doesn't
273 # seem to be hurting (seems ->_has_uploadtmp is true more than I would
276 $self->_body->tmpdir( $self->_uploadtmp )
277 if $self->_has_uploadtmp;
280 # Ok if we get this far, we have to read psgi.input into the new body
281 # object. Lets play nice with any plack app or other downstream, so
282 # we create a buffer unless one exists.
285 if ($self->env->{'psgix.input.buffered'}) {
286 # Be paranoid about previous psgi middleware or apps that read the
287 # input but didn't return the buffer to the start.
288 $self->env->{'psgi.input'}->seek(0, 0);
290 $stream_buffer = Stream::Buffered->new($length);
293 # Check for definedness as you could read '0'
294 while ( defined ( my $chunk = $self->read() ) ) {
295 $self->prepare_body_chunk($chunk);
296 $stream_buffer->print($chunk) if $stream_buffer;
299 # Ok, we read the body. Lets play nice for any PSGI app down the pipe
301 if ($stream_buffer) {
302 $self->env->{'psgix.input.buffered'} = 1;
303 $self->env->{'psgi.input'} = $stream_buffer->rewind;
305 $self->env->{'psgi.input'}->seek(0, 0); # Reset the buffer for downstream middleware or apps
308 # paranoia against wrong Content-Length header
309 my $remaining = $length - $self->_read_position;
310 if ( $remaining > 0 ) {
311 Catalyst::Exception->throw("Wrong Content-Length value: $length" );
315 sub prepare_body_chunk {
316 my ( $self, $chunk ) = @_;
318 $self->_body->add($chunk);
321 sub prepare_body_parameters {
322 my ( $self, $c ) = @_;
323 return $self->body_parameters if $self->has_body_parameters;
324 $self->prepare_body if ! $self->_has_body;
326 unless($self->_body) {
327 my $return = $self->_use_hash_multivalue ? Hash::MultiValue->new : {};
328 $self->body_parameters($return);
333 my %part_data = %{$self->_body->part_data};
334 if(scalar %part_data && !$c->config->{skip_complex_post_part_handling}) {
335 foreach my $key (keys %part_data) {
336 my $proto_value = $part_data{$key};
337 my ($val, @extra) = (ref($proto_value)||'') eq 'ARRAY' ? @$proto_value : ($proto_value);
340 $params->{$key} = [map { Catalyst::Request::PartData->build_from_part_data($_) } ($val,@extra)];
342 $params->{$key} = Catalyst::Request::PartData->build_from_part_data($val);
346 $params = $self->_body->param;
349 # If we have an encoding configured (like UTF-8) in general we expect a client
350 # to POST with the encoding we fufilled the request in. Otherwise don't do any
351 # encoding (good change wide chars could be in HTML entity style llike the old
354 # so, now that HTTP::Body prepared the body params, we gotta 'walk' the structure
355 # and do any needed decoding.
357 # This only does something if the encoding is set via the encoding param. Remember
358 # this is assuming the client is not bad and responds with what you provided. In
359 # general you can just use utf8 and get away with it.
361 # I need to see if $c is here since this also doubles as a builder for the object :(
363 if($c and $c->encoding and !$c->config->{skip_body_param_unicode_decoding}) {
364 $params = $c->_handle_unicode_decoding($params);
367 my $return = $self->_use_hash_multivalue ?
368 Hash::MultiValue->from_mixed($params) :
371 $self->body_parameters($return) unless $self->has_body_parameters;
375 sub prepare_connection {
378 my $env = $self->env;
380 $self->address( $env->{REMOTE_ADDR} );
381 $self->hostname( $env->{REMOTE_HOST} )
382 if exists $env->{REMOTE_HOST};
383 $self->protocol( $env->{SERVER_PROTOCOL} );
384 $self->remote_user( $env->{REMOTE_USER} );
385 $self->method( $env->{REQUEST_METHOD} );
386 $self->secure( $env->{'psgi.url_scheme'} eq 'https' ? 1 : 0 );
389 # XXX - FIXME - method is here now, move this crap...
390 around parameters => sub {
391 my ($orig, $self, $params) = @_;
393 if ( !ref $params ) {
395 "Attempt to retrieve '$params' with req->params(), " .
396 "you probably meant to call req->param('$params')"
400 return $self->$orig($params);
411 return $self->path if $self->has_uri;
416 is => 'rw', clearer => '_clear_body', predicate => '_has_body',
418 # Eugh, ugly. Should just be able to rename accessor methods to 'body'
419 # and provide a custom reader..
422 $self->prepare_body unless $self->_has_body;
423 croak 'body is a reader' if scalar @_;
424 return blessed $self->_body ? $self->_body->body : $self->_body;
433 gethostbyaddr( inet_aton( $self->address ), AF_INET ) || $self->address
437 has _path => ( is => 'rw', predicate => '_has_path', clearer => '_clear_path' );
439 sub args { shift->arguments(@_) }
440 sub body_params { shift->body_parameters(@_) }
441 sub input { shift->body(@_) }
442 sub params { shift->parameters(@_) }
443 sub query_params { shift->query_parameters(@_) }
444 sub path_info { shift->path(@_) }
446 =for stopwords param params
450 Catalyst::Request - provides information about the current client request
455 $req->address eq "127.0.0.1";
461 $req->body_parameters;
462 $req->content_encoding;
463 $req->content_length;
471 $req->query_keywords;
479 $req->query_parameters;
491 See also L<Catalyst>, L<Catalyst::Request::Upload>.
495 This is the Catalyst Request class, which provides an interface to data for the
496 current client request. The request object is prepared by L<Catalyst::Engine>,
497 thus hiding the details of the particular engine implementation.
503 Returns the IP address of the client.
505 =head2 $req->arguments
507 Returns a reference to an array containing the arguments.
509 print $c->request->arguments->[0];
511 For example, if your action was
513 package MyApp::Controller::Foo;
519 and the URI for the request was C<http://.../foo/moose/bah>, the string C<bah>
520 would be the first and only argument.
522 Arguments get automatically URI-unescaped for you.
526 Shortcut for L</arguments>.
530 Contains the URI base. This will always have a trailing slash. Note that the
531 URI scheme (e.g., http vs. https) must be determined through heuristics;
532 depending on your server configuration, it may be incorrect. See $req->secure
535 If your application was queried with the URI
536 C<http://localhost:3000/some/path> then C<base> is C<http://localhost:3000/>.
540 Returns the message body of the request, as returned by L<HTTP::Body>: a string,
541 unless Content-Type is C<application/x-www-form-urlencoded>, C<text/xml>, or
542 C<multipart/form-data>, in which case a L<File::Temp> object is returned.
544 =head2 $req->body_data
546 Returns a Perl representation of POST/PUT body data that is not classic HTML
547 form data, such as JSON, XML, etc. By default, Catalyst will parse incoming
548 data of the type 'application/json' and return access to that data via this
549 method. You may define addition data_handlers via a global configuration
550 setting. See L<Catalyst\DATA HANDLERS> for more information.
552 If the POST is malformed in some way (such as undefined or not content that
553 matches the content-type) we raise a L<Catalyst::Exception> with the error
556 If the POSTed content type does not match an available data handler, this
557 will also raise an exception.
559 =head2 $req->body_parameters
561 Returns a reference to a hash containing body (POST) parameters. Values can
562 be either a scalar or an arrayref containing scalars.
564 print $c->request->body_parameters->{field};
565 print $c->request->body_parameters->{field}->[0];
567 These are the parameters from the POST part of the request, if any.
569 B<NOTE> If your POST is multipart, but contains non file upload parts (such
570 as an line part with an alternative encoding or content type) we cannot determine
571 the correct way to extra a meaningful value from the upload. In this case any
572 part like this will be represented as an instance of L<Catalyst::Request::PartData>.
574 =head2 $req->body_params
576 Shortcut for body_parameters.
578 =head2 $req->content_encoding
580 Shortcut for $req->headers->content_encoding.
582 =head2 $req->content_length
584 Shortcut for $req->headers->content_length.
586 =head2 $req->content_type
588 Shortcut for $req->headers->content_type.
592 A convenient method to access $req->cookies.
594 $cookie = $c->request->cookie('name');
595 @cookies = $c->request->cookie;
603 return keys %{ $self->cookies };
610 unless ( exists $self->cookies->{$name} ) {
614 return $self->cookies->{$name};
620 Returns a reference to a hash containing the cookies.
622 print $c->request->cookies->{mycookie}->value;
624 The cookies in the hash are indexed by name, and the values are L<CGI::Simple::Cookie>
629 Shortcut for $req->headers->header.
633 Returns an L<HTTP::Headers> object containing the headers for the current request.
635 print $c->request->headers->header('X-Catalyst');
637 =head2 $req->hostname
639 Returns the hostname of the client. Use C<< $req->uri->host >> to get the hostname of the server.
643 Alias for $req->body.
645 =head2 $req->query_keywords
647 Contains the keywords portion of a query string, when no '=' signs are
650 http://localhost/path?some+keywords
652 $c->request->query_keywords will contain 'some keywords'
656 This contains the matching part of a Regex action. Otherwise
657 it returns the same as 'action', except for default actions,
658 which return an empty string.
662 Contains the request method (C<GET>, C<POST>, C<HEAD>, etc).
666 Returns GET and POST parameters with a CGI.pm-compatible param method. This
667 is an alternative method for accessing parameters in $c->req->parameters.
669 $value = $c->request->param( 'foo' );
670 @values = $c->request->param( 'foo' );
671 @params = $c->request->param;
673 Like L<CGI>, and B<unlike> earlier versions of Catalyst, passing multiple
674 arguments to this method, like this:
676 $c->request->param( 'foo', 'bar', 'gorch', 'quxx' );
678 will set the parameter C<foo> to the multiple values C<bar>, C<gorch> and
679 C<quxx>. Previously this would have added C<bar> as another value to C<foo>
680 (creating it if it didn't exist before), and C<quxx> as another value for
683 B<NOTE> this is considered a legacy interface and care should be taken when
684 using it. C<< scalar $c->req->param( 'foo' ) >> will return only the first
685 C<foo> param even if multiple are present; C<< $c->req->param( 'foo' ) >> will
686 return a list of as many are present, which can have unexpected consequences
687 when writing code of the form:
691 baz => $c->req->param( 'baz' ),
694 If multiple C<baz> parameters are provided this code might corrupt data or
695 cause a hash initialization error. For a more straightforward interface see
696 C<< $c->req->parameters >>.
698 B<NOTE> Interfaces like this, which are based on L<CGI> and the C<param> method
699 are known to cause demonstrated exploits. It is highly recommended that you
700 avoid using this method, and migrate existing code away from it. Here's a
701 whitepaper of the exploit:
703 L<http://blog.gerv.net/2014/10/new-class-of-vulnerability-in-perl-web-applications/>
705 B<NOTE> Further discussion on IRC indicate that the L<Catalyst> core team from 'back then'
706 were well aware of this hack and this is the main reason we added the new approach to
707 getting parameters in the first place.
709 Basically this is an exploit that takes advantage of how L<\param> will do one thing
710 in scalar context and another thing in list context. This is combined with how Perl
711 chooses to deal with duplicate keys in a hash definition by overwriting the value of
712 existing keys with a new value if the same key shows up again. Generally you will be
713 vulnerable to this exploit if you are using this method in a direct assignment in a
714 hash, such as with a L<DBIx::Class> create statement. For example, if you have
717 user?user=123&foo=a&foo=user&foo=456
719 You could end up with extra parameters injected into your method calls:
721 $c->model('User')->create({
722 user => $c->req->param('user'),
723 foo => $c->req->param('foo'),
726 Which would look like:
728 $c->model('User')->create({
730 foo => qw(a user 456),
733 (or to be absolutely clear if you are not seeing it):
735 $c->model('User')->create({
740 Possible remediations include scrubbing your parameters with a form validator like
741 L<HTML::FormHandler> or being careful to force scalar context using the scalar
744 $c->model('User')->create({
745 user => scalar($c->req->param('user')),
746 foo => scalar($c->req->param('foo')),
749 Upcoming versions of L<Catalyst> will disable this interface by default and require
750 you to positively enable it should you require it for backwards compatibility reasons.
758 return keys %{ $self->parameters };
761 # If anything in @_ is undef, carp about that, and remove it from
764 my @params = grep { defined($_) ? 1 : do {carp "You called ->params with an undefined value"; 0} } @_;
766 if ( @params == 1 ) {
768 defined(my $param = shift @params) ||
769 carp "You called ->params with an undefined value 2";
771 unless ( exists $self->parameters->{$param} ) {
772 return wantarray ? () : undef;
775 if ( ref $self->parameters->{$param} eq 'ARRAY' ) {
777 ? @{ $self->parameters->{$param} }
778 : $self->parameters->{$param}->[0];
782 ? ( $self->parameters->{$param} )
783 : $self->parameters->{$param};
786 elsif ( @params > 1 ) {
787 my $field = shift @params;
788 $self->parameters->{$field} = [@params];
792 =head2 $req->parameters
794 Returns a reference to a hash containing GET and POST parameters. Values can
795 be either a scalar or an arrayref containing scalars.
797 print $c->request->parameters->{field};
798 print $c->request->parameters->{field}->[0];
800 This is the combination of C<query_parameters> and C<body_parameters>.
804 Shortcut for $req->parameters.
808 Returns the path, i.e. the part of the URI after $req->base, for the current request.
810 http://localhost/path/foo
812 $c->request->path will contain 'path/foo'
814 =head2 $req->path_info
816 Alias for path, added for compatibility with L<CGI>.
821 my ( $self, @params ) = @_;
824 $self->uri->path(@params);
827 elsif ( $self->_has_path ) {
831 my $path = $self->uri->path;
832 my $location = $self->base->path;
833 $path =~ s/^(\Q$location\E)?//;
841 =head2 $req->protocol
843 Returns the protocol (HTTP/1.0 or HTTP/1.1) used for the current request.
845 =head2 $req->query_parameters
847 =head2 $req->query_params
849 Returns a reference to a hash containing query string (GET) parameters. Values can
850 be either a scalar or an arrayref containing scalars.
852 print $c->request->query_parameters->{field};
853 print $c->request->query_parameters->{field}->[0];
855 =head2 $req->read( [$maxlength] )
857 Reads a chunk of data from the request body. This method is intended to be
858 used in a while loop, reading $maxlength bytes on every call. $maxlength
859 defaults to the size of the request if not specified.
861 =head2 $req->read_chunk(\$buff, $max)
865 You have to set MyApp->config(parse_on_demand => 1) to use this directly.
869 Shortcut for $req->headers->referer. Returns the referring page.
873 Returns true or false, indicating whether the connection is secure
874 (https). The reliability of $req->secure may depend on your server
875 configuration; Catalyst relies on PSGI to determine whether or not a
876 request is secure (Catalyst looks at psgi.url_scheme), and different
877 PSGI servers may make this determination in different ways (as by
878 directly passing along information from the server, interpreting any of
879 several HTTP headers, or using heuristics of their own).
881 =head2 $req->captures
883 Returns a reference to an array containing captured args from chained
884 actions or regex captures.
886 my @captures = @{ $c->request->captures };
890 A convenient method to access $req->uploads.
892 $upload = $c->request->upload('field');
893 @uploads = $c->request->upload('field');
894 @fields = $c->request->upload;
896 for my $upload ( $c->request->upload('field') ) {
897 print $upload->filename;
906 return keys %{ $self->uploads };
913 unless ( exists $self->uploads->{$upload} ) {
914 return wantarray ? () : undef;
917 if ( ref $self->uploads->{$upload} eq 'ARRAY' ) {
919 ? @{ $self->uploads->{$upload} }
920 : $self->uploads->{$upload}->[0];
924 ? ( $self->uploads->{$upload} )
925 : $self->uploads->{$upload};
931 while ( my ( $field, $upload ) = splice( @_, 0, 2 ) ) {
933 if ( exists $self->uploads->{$field} ) {
934 for ( $self->uploads->{$field} ) {
935 $_ = [$_] unless ref($_) eq "ARRAY";
936 push( @$_, $upload );
940 $self->uploads->{$field} = $upload;
948 Returns a reference to a hash containing uploads. Values can be either a
949 L<Catalyst::Request::Upload> object, or an arrayref of
950 L<Catalyst::Request::Upload> objects.
952 my $upload = $c->request->uploads->{field};
953 my $upload = $c->request->uploads->{field}->[0];
957 Returns a L<URI> object for the current request. Stringifies to the URI text.
959 =head2 $req->mangle_params( { key => 'value' }, $appendmode);
961 Returns a hashref of parameters stemming from the current request's params,
962 plus the ones supplied. Keys for which no current param exists will be
963 added, keys with undefined values will be removed and keys with existing
964 params will be replaced. Note that you can supply a true value as the final
965 argument to change behavior with regards to existing parameters, appending
966 values rather than replacing them.
970 # URI query params foo=1
971 my $hashref = $req->mangle_params({ foo => 2 });
972 # Result is query params of foo=2
976 # URI query params foo=1
977 my $hashref = $req->mangle_params({ foo => 2 }, 1);
978 # Result is query params of foo=1&foo=2
980 This is the code behind C<uri_with>.
985 my ($self, $args, $append) = @_;
987 carp('No arguments passed to mangle_params()') unless $args;
989 foreach my $value ( values %$args ) {
990 next unless defined $value;
991 for ( ref $value eq 'ARRAY' ? @$value : $value ) {
997 my %params = %{ $self->uri->query_form_hash };
998 foreach my $key (keys %{ $args }) {
999 my $val = $args->{$key};
1002 if($append && exists($params{$key})) {
1004 # This little bit of heaven handles appending a new value onto
1005 # an existing one regardless if the existing value is an array
1006 # or not, and regardless if the new value is an array or not
1008 ref($params{$key}) eq 'ARRAY' ? @{ $params{$key} } : $params{$key},
1009 ref($val) eq 'ARRAY' ? @{ $val } : $val
1013 $params{$key} = $val;
1017 # If the param wasn't defined then we delete it.
1018 delete($params{$key});
1026 =head2 $req->uri_with( { key => 'value' } );
1028 Returns a rewritten URI object for the current request. Key/value pairs
1029 passed in will override existing parameters. You can remove an existing
1030 parameter by passing in an undef value. Unmodified pairs will be
1033 You may also pass an optional second parameter that puts C<uri_with> into
1036 $req->uri_with( { key => 'value' }, { mode => 'append' } );
1038 See C<mangle_params> for an explanation of this behavior.
1043 my( $self, $args, $behavior) = @_;
1045 carp( 'No arguments passed to uri_with()' ) unless $args;
1048 if((ref($behavior) eq 'HASH') && defined($behavior->{mode}) && ($behavior->{mode} eq 'append')) {
1052 my $params = $self->mangle_params($args, $append);
1054 my $uri = $self->uri->clone;
1055 $uri->query_form($params);
1060 =head2 $req->remote_user
1062 Returns the value of the C<REMOTE_USER> environment variable.
1064 =head2 $req->user_agent
1066 Shortcut to $req->headers->user_agent. Returns the user agent (browser)
1071 Returns a psgix.io bidirectional socket, if your server supports one. Used for
1072 when you want to jailbreak out of PSGI and handle bidirectional client server
1073 communication manually, such as when you are using cometd or websockets.
1075 =head1 SETUP METHODS
1077 You should never need to call these yourself in application code,
1078 however they are useful if extending Catalyst by applying a request role.
1080 =head2 $self->prepare_headers()
1082 Sets up the C<< $res->headers >> accessor.
1084 =head2 $self->prepare_body()
1086 Sets up the body using L<HTTP::Body>
1088 =head2 $self->prepare_body_chunk()
1090 Add a chunk to the request body.
1092 =head2 $self->prepare_body_parameters()
1094 Sets up parameters from body.
1096 =head2 $self->prepare_cookies()
1098 Parse cookies from header. Sets up a L<CGI::Simple::Cookie> object.
1100 =head2 $self->prepare_connection()
1102 Sets up various fields in the request like the local and remote addresses,
1103 request method, hostname requested etc.
1105 =head2 $self->prepare_parameters()
1107 Ensures that the body has been parsed, then builds the parameters, which are
1108 combined from those in the request and those in the body.
1110 If parameters have already been set will clear the parameters and build them again.
1114 Access to the raw PSGI env.
1122 Catalyst Contributors, see Catalyst.pm
1126 This library is free software. You can redistribute it and/or modify
1127 it under the same terms as Perl itself.
1131 __PACKAGE__->meta->make_immutable;