1 package Catalyst::Request;
3 use Socket qw( getaddrinfo getnameinfo AI_NUMERICHOST NI_DGRAM NIx_NOSERV );
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 next unless $stream_buffer;
298 $stream_buffer->print($chunk)
299 || die sprintf "Failed to write %d bytes to psgi.input file: $!", length( $chunk );
302 # Ok, we read the body. Lets play nice for any PSGI app down the pipe
304 if ($stream_buffer) {
305 $self->env->{'psgix.input.buffered'} = 1;
306 $self->env->{'psgi.input'} = $stream_buffer->rewind;
308 $self->env->{'psgi.input'}->seek(0, 0); # Reset the buffer for downstream middleware or apps
311 # paranoia against wrong Content-Length header
312 my $remaining = $length - $self->_read_position;
313 if ( $remaining > 0 ) {
314 Catalyst::Exception->throw("Wrong Content-Length value: $length" );
318 sub prepare_body_chunk {
319 my ( $self, $chunk ) = @_;
321 $self->_body->add($chunk);
324 sub prepare_body_parameters {
325 my ( $self, $c ) = @_;
326 return $self->body_parameters if $self->has_body_parameters;
327 $self->prepare_body if ! $self->_has_body;
329 unless($self->_body) {
330 my $return = $self->_use_hash_multivalue ? Hash::MultiValue->new : {};
331 $self->body_parameters($return);
336 my %part_data = %{$self->_body->part_data};
337 if(scalar %part_data && !$c->config->{skip_complex_post_part_handling}) {
338 foreach my $key (keys %part_data) {
339 my $proto_value = $part_data{$key};
340 my ($val, @extra) = (ref($proto_value)||'') eq 'ARRAY' ? @$proto_value : ($proto_value);
342 $key = $c->_handle_param_unicode_decoding($key)
343 if ($c and $c->encoding and !$c->config->{skip_body_param_unicode_decoding});
346 $params->{$key} = [map { Catalyst::Request::PartData->build_from_part_data($c, $_) } ($val,@extra)];
348 $params->{$key} = Catalyst::Request::PartData->build_from_part_data($c, $val);
352 $params = $self->_body->param;
354 # If we have an encoding configured (like UTF-8) in general we expect a client
355 # to POST with the encoding we fufilled the request in. Otherwise don't do any
356 # encoding (good change wide chars could be in HTML entity style llike the old
359 # so, now that HTTP::Body prepared the body params, we gotta 'walk' the structure
360 # and do any needed decoding.
362 # This only does something if the encoding is set via the encoding param. Remember
363 # this is assuming the client is not bad and responds with what you provided. In
364 # general you can just use utf8 and get away with it.
366 # I need to see if $c is here since this also doubles as a builder for the object :(
368 if($c and $c->encoding and !$c->config->{skip_body_param_unicode_decoding}) {
369 $params = $c->_handle_unicode_decoding($params);
373 my $return = $self->_use_hash_multivalue ?
374 Hash::MultiValue->from_mixed($params) :
377 $self->body_parameters($return) unless $self->has_body_parameters;
381 sub prepare_connection {
384 my $env = $self->env;
386 $self->address( $env->{REMOTE_ADDR} );
387 $self->hostname( $env->{REMOTE_HOST} )
388 if exists $env->{REMOTE_HOST};
389 $self->protocol( $env->{SERVER_PROTOCOL} );
390 $self->remote_user( $env->{REMOTE_USER} );
391 $self->method( $env->{REQUEST_METHOD} );
392 $self->secure( $env->{'psgi.url_scheme'} eq 'https' ? 1 : 0 );
395 # XXX - FIXME - method is here now, move this crap...
396 around parameters => sub {
397 my ($orig, $self, $params) = @_;
399 if ( !ref $params ) {
401 "Attempt to retrieve '$params' with req->params(), " .
402 "you probably meant to call req->param('$params')"
406 return $self->$orig($params);
417 return $self->path if $self->has_uri;
422 is => 'rw', clearer => '_clear_body', predicate => '_has_body',
424 # Eugh, ugly. Should just be able to rename accessor methods to 'body'
425 # and provide a custom reader..
428 $self->prepare_body unless $self->_has_body;
429 croak 'body is a reader' if scalar @_;
430 return blessed $self->_body ? $self->_body->body : $self->_body;
439 my ( $err, $sockaddr ) = getaddrinfo(
443 { flags => AI_NUMERICHOST }
446 $self->_log->warn("resolve of hostname failed: $err");
447 return $self->address;
449 ( $err, my $hostname ) = getnameinfo(
451 # we are only interested in the hostname, not the servicename
455 $self->_log->warn("resolve of hostname failed: $err");
456 return $self->address;
462 has _path => ( is => 'rw', predicate => '_has_path', clearer => '_clear_path' );
464 sub args { shift->arguments(@_) }
465 sub body_params { shift->body_parameters(@_) }
466 sub input { shift->body(@_) }
467 sub params { shift->parameters(@_) }
468 sub query_params { shift->query_parameters(@_) }
469 sub path_info { shift->path(@_) }
471 =for stopwords param params
475 Catalyst::Request - provides information about the current client request
480 $req->address eq "127.0.0.1";
486 $req->body_parameters;
487 $req->content_encoding;
488 $req->content_length;
496 $req->query_keywords;
504 $req->query_parameters;
516 See also L<Catalyst>, L<Catalyst::Request::Upload>.
520 This is the Catalyst Request class, which provides an interface to data for the
521 current client request. The request object is prepared by L<Catalyst::Engine>,
522 thus hiding the details of the particular engine implementation.
528 Returns the IP address of the client.
530 =head2 $req->arguments
532 Returns a reference to an array containing the arguments.
534 print $c->request->arguments->[0];
536 For example, if your action was
538 package MyApp::Controller::Foo;
544 and the URI for the request was C<http://.../foo/moose/bah>, the string C<bah>
545 would be the first and only argument.
547 Arguments get automatically URI-unescaped for you.
551 Shortcut for L</arguments>.
555 Contains the URI base. This will always have a trailing slash. Note that the
556 URI scheme (e.g., http vs. https) must be determined through heuristics;
557 depending on your server configuration, it may be incorrect. See $req->secure
560 If your application was queried with the URI
561 C<http://localhost:3000/some/path> then C<base> is C<http://localhost:3000/>.
565 Returns the message body of the request, as returned by L<HTTP::Body>: a string,
566 unless Content-Type is C<application/x-www-form-urlencoded>, C<text/xml>, or
567 C<multipart/form-data>, in which case a L<File::Temp> object is returned.
569 =head2 $req->body_data
571 Returns a Perl representation of POST/PUT body data that is not classic HTML
572 form data, such as JSON, XML, etc. By default, Catalyst will parse incoming
573 data of the type 'application/json' and return access to that data via this
574 method. You may define addition data_handlers via a global configuration
575 setting. See L<Catalyst\DATA HANDLERS> for more information.
577 If the POST is malformed in some way (such as undefined or not content that
578 matches the content-type) we raise a L<Catalyst::Exception> with the error
581 If the POSTed content type does not match an available data handler, this
582 will also raise an exception.
584 =head2 $req->body_parameters
586 Returns a reference to a hash containing body (POST) parameters. Values can
587 be either a scalar or an arrayref containing scalars.
589 print $c->request->body_parameters->{field};
590 print $c->request->body_parameters->{field}->[0];
592 These are the parameters from the POST part of the request, if any.
594 B<NOTE> If your POST is multipart, but contains non file upload parts (such
595 as an line part with an alternative encoding or content type) we do our best to
596 try and figure out how the value should be presented. If there's a specified character
597 set we will use that to decode rather than the default encoding set by the application.
598 However if there are complex headers and we cannot determine
599 the correct way to extra a meaningful value from the upload, in this case any
600 part like this will be represented as an instance of L<Catalyst::Request::PartData>.
602 Patches and review of this part of the code welcomed.
604 =head2 $req->body_params
606 Shortcut for body_parameters.
608 =head2 $req->content_encoding
610 Shortcut for $req->headers->content_encoding.
612 =head2 $req->content_length
614 Shortcut for $req->headers->content_length.
616 =head2 $req->content_type
618 Shortcut for $req->headers->content_type.
622 A convenient method to access $req->cookies.
624 $cookie = $c->request->cookie('name');
625 @cookies = $c->request->cookie;
633 return keys %{ $self->cookies };
640 unless ( exists $self->cookies->{$name} ) {
644 return $self->cookies->{$name};
650 Returns a reference to a hash containing the cookies.
652 print $c->request->cookies->{mycookie}->value;
654 The cookies in the hash are indexed by name, and the values are L<CGI::Simple::Cookie>
659 Shortcut for $req->headers->header.
663 Returns an L<HTTP::Headers> object containing the headers for the current request.
665 print $c->request->headers->header('X-Catalyst');
667 =head2 $req->hostname
669 Returns the hostname of the client. Use C<< $req->uri->host >> to get the hostname of the server.
673 Alias for $req->body.
675 =head2 $req->query_keywords
677 Contains the keywords portion of a query string, when no '=' signs are
680 http://localhost/path?some+keywords
682 $c->request->query_keywords will contain 'some keywords'
686 This contains the matching part of a Regex action. Otherwise
687 it returns the same as 'action', except for default actions,
688 which return an empty string.
692 Contains the request method (C<GET>, C<POST>, C<HEAD>, etc).
696 Returns GET and POST parameters with a CGI.pm-compatible param method. This
697 is an alternative method for accessing parameters in $c->req->parameters.
699 $value = $c->request->param( 'foo' );
700 @values = $c->request->param( 'foo' );
701 @params = $c->request->param;
703 Like L<CGI>, and B<unlike> earlier versions of Catalyst, passing multiple
704 arguments to this method, like this:
706 $c->request->param( 'foo', 'bar', 'gorch', 'quxx' );
708 will set the parameter C<foo> to the multiple values C<bar>, C<gorch> and
709 C<quxx>. Previously this would have added C<bar> as another value to C<foo>
710 (creating it if it didn't exist before), and C<quxx> as another value for
713 B<NOTE> this is considered a legacy interface and care should be taken when
714 using it. C<< scalar $c->req->param( 'foo' ) >> will return only the first
715 C<foo> param even if multiple are present; C<< $c->req->param( 'foo' ) >> will
716 return a list of as many are present, which can have unexpected consequences
717 when writing code of the form:
721 baz => $c->req->param( 'baz' ),
724 If multiple C<baz> parameters are provided this code might corrupt data or
725 cause a hash initialization error. For a more straightforward interface see
726 C<< $c->req->parameters >>.
728 B<NOTE> Interfaces like this, which are based on L<CGI> and the C<param> method
729 are known to cause demonstrated exploits. It is highly recommended that you
730 avoid using this method, and migrate existing code away from it. Here's a
731 whitepaper of the exploit:
733 L<http://blog.gerv.net/2014/10/new-class-of-vulnerability-in-perl-web-applications/>
735 B<NOTE> Further discussion on IRC indicate that the L<Catalyst> core team from 'back then'
736 were well aware of this hack and this is the main reason we added the new approach to
737 getting parameters in the first place.
739 Basically this is an exploit that takes advantage of how L<\param> will do one thing
740 in scalar context and another thing in list context. This is combined with how Perl
741 chooses to deal with duplicate keys in a hash definition by overwriting the value of
742 existing keys with a new value if the same key shows up again. Generally you will be
743 vulnerable to this exploit if you are using this method in a direct assignment in a
744 hash, such as with a L<DBIx::Class> create statement. For example, if you have
747 user?user=123&foo=a&foo=user&foo=456
749 You could end up with extra parameters injected into your method calls:
751 $c->model('User')->create({
752 user => $c->req->param('user'),
753 foo => $c->req->param('foo'),
756 Which would look like:
758 $c->model('User')->create({
760 foo => qw(a user 456),
763 (or to be absolutely clear if you are not seeing it):
765 $c->model('User')->create({
770 Possible remediations include scrubbing your parameters with a form validator like
771 L<HTML::FormHandler> or being careful to force scalar context using the scalar
774 $c->model('User')->create({
775 user => scalar($c->req->param('user')),
776 foo => scalar($c->req->param('foo')),
779 Upcoming versions of L<Catalyst> will disable this interface by default and require
780 you to positively enable it should you require it for backwards compatibility reasons.
788 return keys %{ $self->parameters };
791 # If anything in @_ is undef, carp about that, and remove it from
794 my @params = grep { defined($_) ? 1 : do {carp "You called ->params with an undefined value"; 0} } @_;
796 if ( @params == 1 ) {
798 defined(my $param = shift @params) ||
799 carp "You called ->params with an undefined value 2";
801 unless ( exists $self->parameters->{$param} ) {
802 return wantarray ? () : undef;
805 if ( ref $self->parameters->{$param} eq 'ARRAY' ) {
807 ? @{ $self->parameters->{$param} }
808 : $self->parameters->{$param}->[0];
812 ? ( $self->parameters->{$param} )
813 : $self->parameters->{$param};
816 elsif ( @params > 1 ) {
817 my $field = shift @params;
818 $self->parameters->{$field} = [@params];
822 =head2 $req->parameters
824 Returns a reference to a hash containing GET and POST parameters. Values can
825 be either a scalar or an arrayref containing scalars.
827 print $c->request->parameters->{field};
828 print $c->request->parameters->{field}->[0];
830 This is the combination of C<query_parameters> and C<body_parameters>.
834 Shortcut for $req->parameters.
838 Returns the path, i.e. the part of the URI after $req->base, for the current request.
840 http://localhost/path/foo
842 $c->request->path will contain 'path/foo'
844 =head2 $req->path_info
846 Alias for path, added for compatibility with L<CGI>.
851 my ( $self, @params ) = @_;
854 $self->uri->path(@params);
857 elsif ( $self->_has_path ) {
861 my $path = $self->uri->path;
862 my $location = $self->base->path;
863 $path =~ s/^(\Q$location\E)?//;
871 =head2 $req->protocol
873 Returns the protocol (HTTP/1.0 or HTTP/1.1) used for the current request.
875 =head2 $req->query_parameters
877 =head2 $req->query_params
879 Returns a reference to a hash containing query string (GET) parameters. Values can
880 be either a scalar or an arrayref containing scalars.
882 print $c->request->query_parameters->{field};
883 print $c->request->query_parameters->{field}->[0];
885 =head2 $req->read( [$maxlength] )
887 Reads a chunk of data from the request body. This method is intended to be
888 used in a while loop, reading $maxlength bytes on every call. $maxlength
889 defaults to the size of the request if not specified.
891 =head2 $req->read_chunk(\$buff, $max)
895 You have to set MyApp->config(parse_on_demand => 1) to use this directly.
899 Shortcut for $req->headers->referer. Returns the referring page.
903 Returns true or false, indicating whether the connection is secure
904 (https). The reliability of $req->secure may depend on your server
905 configuration; Catalyst relies on PSGI to determine whether or not a
906 request is secure (Catalyst looks at psgi.url_scheme), and different
907 PSGI servers may make this determination in different ways (as by
908 directly passing along information from the server, interpreting any of
909 several HTTP headers, or using heuristics of their own).
911 =head2 $req->captures
913 Returns a reference to an array containing captured args from chained
914 actions or regex captures.
916 my @captures = @{ $c->request->captures };
920 A convenient method to access $req->uploads.
922 $upload = $c->request->upload('field');
923 @uploads = $c->request->upload('field');
924 @fields = $c->request->upload;
926 for my $upload ( $c->request->upload('field') ) {
927 print $upload->filename;
936 return keys %{ $self->uploads };
943 unless ( exists $self->uploads->{$upload} ) {
944 return wantarray ? () : undef;
947 if ( ref $self->uploads->{$upload} eq 'ARRAY' ) {
949 ? @{ $self->uploads->{$upload} }
950 : $self->uploads->{$upload}->[0];
954 ? ( $self->uploads->{$upload} )
955 : $self->uploads->{$upload};
961 while ( my ( $field, $upload ) = splice( @_, 0, 2 ) ) {
963 if ( exists $self->uploads->{$field} ) {
964 for ( $self->uploads->{$field} ) {
965 $_ = [$_] unless ref($_) eq "ARRAY";
966 push( @$_, $upload );
970 $self->uploads->{$field} = $upload;
978 Returns a reference to a hash containing uploads. Values can be either a
979 L<Catalyst::Request::Upload> object, or an arrayref of
980 L<Catalyst::Request::Upload> objects.
982 my $upload = $c->request->uploads->{field};
983 my $upload = $c->request->uploads->{field}->[0];
987 Returns a L<URI> object for the current request. Stringifies to the URI text.
989 =head2 $req->mangle_params( { key => 'value' }, $appendmode);
991 Returns a hashref of parameters stemming from the current request's params,
992 plus the ones supplied. Keys for which no current param exists will be
993 added, keys with undefined values will be removed and keys with existing
994 params will be replaced. Note that you can supply a true value as the final
995 argument to change behavior with regards to existing parameters, appending
996 values rather than replacing them.
1000 # URI query params foo=1
1001 my $hashref = $req->mangle_params({ foo => 2 });
1002 # Result is query params of foo=2
1006 # URI query params foo=1
1007 my $hashref = $req->mangle_params({ foo => 2 }, 1);
1008 # Result is query params of foo=1&foo=2
1010 This is the code behind C<uri_with>.
1015 my ($self, $args, $append) = @_;
1017 carp('No arguments passed to mangle_params()') unless $args;
1019 foreach my $value ( values %$args ) {
1020 next unless defined $value;
1021 for ( ref $value eq 'ARRAY' ? @$value : $value ) {
1027 my %params = %{ $self->uri->query_form_hash };
1028 foreach my $key (keys %{ $args }) {
1029 my $val = $args->{$key};
1032 if($append && exists($params{$key})) {
1034 # This little bit of heaven handles appending a new value onto
1035 # an existing one regardless if the existing value is an array
1036 # or not, and regardless if the new value is an array or not
1038 ref($params{$key}) eq 'ARRAY' ? @{ $params{$key} } : $params{$key},
1039 ref($val) eq 'ARRAY' ? @{ $val } : $val
1043 $params{$key} = $val;
1047 # If the param wasn't defined then we delete it.
1048 delete($params{$key});
1056 =head2 $req->uri_with( { key => 'value' } );
1058 Returns a rewritten URI object for the current request. Key/value pairs
1059 passed in will override existing parameters. You can remove an existing
1060 parameter by passing in an undef value. Unmodified pairs will be
1063 You may also pass an optional second parameter that puts C<uri_with> into
1066 $req->uri_with( { key => 'value' }, { mode => 'append' } );
1068 See C<mangle_params> for an explanation of this behavior.
1073 my( $self, $args, $behavior) = @_;
1075 carp( 'No arguments passed to uri_with()' ) unless $args;
1078 if((ref($behavior) eq 'HASH') && defined($behavior->{mode}) && ($behavior->{mode} eq 'append')) {
1082 my $params = $self->mangle_params($args, $append);
1084 my $uri = $self->uri->clone;
1085 $uri->query_form($params);
1090 =head2 $req->remote_user
1092 Returns the value of the C<REMOTE_USER> environment variable.
1094 =head2 $req->user_agent
1096 Shortcut to $req->headers->user_agent. Returns the user agent (browser)
1101 Returns a psgix.io bidirectional socket, if your server supports one. Used for
1102 when you want to jailbreak out of PSGI and handle bidirectional client server
1103 communication manually, such as when you are using cometd or websockets.
1105 =head1 SETUP METHODS
1107 You should never need to call these yourself in application code,
1108 however they are useful if extending Catalyst by applying a request role.
1110 =head2 $self->prepare_headers()
1112 Sets up the C<< $res->headers >> accessor.
1114 =head2 $self->prepare_body()
1116 Sets up the body using L<HTTP::Body>
1118 =head2 $self->prepare_body_chunk()
1120 Add a chunk to the request body.
1122 =head2 $self->prepare_body_parameters()
1124 Sets up parameters from body.
1126 =head2 $self->prepare_cookies()
1128 Parse cookies from header. Sets up a L<CGI::Simple::Cookie> object.
1130 =head2 $self->prepare_connection()
1132 Sets up various fields in the request like the local and remote addresses,
1133 request method, hostname requested etc.
1135 =head2 $self->prepare_parameters()
1137 Ensures that the body has been parsed, then builds the parameters, which are
1138 combined from those in the request and those in the body.
1140 If parameters have already been set will clear the parameters and build them again.
1144 Access to the raw PSGI env.
1152 Catalyst Contributors, see Catalyst.pm
1156 This library is free software. You can redistribute it and/or modify
1157 it under the same terms as Perl itself.
1161 __PACKAGE__->meta->make_immutable;