package Mojo::Message::Request; use Mojo::Base 'Mojo::Message'; use Mojo::Cookie::Request; use Mojo::Util qw(b64_encode b64_decode get_line); use Mojo::URL; has env => sub { {} }; has method => 'GET'; has url => sub { Mojo::URL->new }; my $START_LINE_RE = qr/ ^ ([a-zA-Z]+) # Method \s+ ([0-9a-zA-Z!#\$\%&'()*+,\-.\/:;=?\@[\\\]^_`\{|\}~]+) # URL (?:\s+HTTP\/(\d\.\d))? # Version $ /x; sub clone { my $self = shift; # Dynamic requests cannot be cloned return undef unless my $content = $self->content->clone; my $clone = $self->new( content => $content, method => $self->method, url => $self->url->clone, version => $self->version ); $clone->{proxy} = $self->{proxy}->clone if $self->{proxy}; return $clone; } sub cookies { my $self = shift; # Parse cookies my $headers = $self->headers; return [map { @{Mojo::Cookie::Request->parse($_)} } $headers->cookie] unless @_; # Add cookies my @cookies = $headers->cookie || (); for my $cookie (@_) { $cookie = Mojo::Cookie::Request->new($cookie) if ref $cookie eq 'HASH'; push @cookies, $cookie; } $headers->cookie(join('; ', @cookies)); return $self; } sub extract_start_line { my ($self, $bufref) = @_; # Ignore any leading empty lines $$bufref =~ s/^\s+//; return undef unless defined(my $line = get_line $bufref); # We have a (hopefully) full request line $self->error('Bad request start line', 400) and return undef unless $line =~ $START_LINE_RE; my $url = $self->method($1)->version($3)->url; return !!($1 eq 'CONNECT' ? $url->authority($2) : $url->parse($2)); } sub fix_headers { my $self = shift; $self->{fix} ? return $self : $self->SUPER::fix_headers(@_); # Basic authentication my $url = $self->url; my $headers = $self->headers; my $auth = $url->userinfo; $headers->authorization('Basic ' . b64_encode($auth, '')) if $auth && !$headers->authorization; # Basic proxy authentication if (my $proxy = $self->proxy) { my $proxy_auth = $proxy->userinfo; $headers->proxy_authorization('Basic ' . b64_encode($proxy_auth, '')) if $proxy_auth && !$headers->proxy_authorization; } # Host my $host = $url->ihost; my $port = $url->port; $headers->host($port ? "$host:$port" : $host) unless $headers->host; return $self; } sub get_start_line_chunk { my ($self, $offset) = @_; unless (defined $self->{start_buffer}) { # Path my $url = $self->url; my $path = $url->path->to_string; my $query = $url->query->to_string; $path .= "?$query" if $query; $path = "/$path" unless $path =~ m!^/!; # CONNECT my $method = uc $self->method; if ($method eq 'CONNECT') { my $port = $url->port || ($url->protocol eq 'https' ? '443' : '80'); $path = $url->host . ":$port"; } # Proxy elsif ($self->proxy) { my $clone = $url = $url->clone->userinfo(undef); my $upgrade = lc(defined $self->headers->upgrade ? $self->headers->upgrade : ''); $path = $clone unless $upgrade eq 'websocket' || $url->protocol eq 'https'; } $self->{start_buffer} = "$method $path HTTP/@{[$self->version]}\x0d\x0a"; } $self->emit(progress => 'start_line', $offset); return substr $self->{start_buffer}, $offset, 131072; } sub is_secure { my $url = shift->url; return ($url->protocol || $url->base->protocol) eq 'https'; } sub is_xhr { (do {my $tmp = shift->headers->header('X-Requested-With'); defined $tmp ? $tmp : ''}) =~ /XMLHttpRequest/i; } sub param { shift->params->param(@_) } sub params { my $self = shift; return $self->{params} ||= $self->body_params->clone->merge($self->query_params); } sub parse { my $self = shift; # Parse CGI environment my $env = @_ > 1 ? {@_} : ref $_[0] eq 'HASH' ? $_[0] : undef; $self->env($env)->_parse_env($env) if $env; # Parse normal message my @args = $env ? () : @_; if ((defined $self->{state} ? $self->{state} : '') ne 'cgi') { $self->SUPER::parse(@args) } # Parse CGI content else { $self->content($self->content->parse_body(@args))->SUPER::parse } # Check if we can fix things that require all headers return $self unless $self->is_finished; # Base URL my $base = $self->url->base; $base->scheme('http') unless $base->scheme; my $headers = $self->headers; if (!$base->host && (my $host = $headers->host)) { $base->authority($host) } # Basic authentication my $auth = _parse_basic_auth($headers->authorization); $base->userinfo($auth) if $auth; # Basic proxy authentication my $proxy_auth = _parse_basic_auth($headers->proxy_authorization); $self->proxy(Mojo::URL->new->userinfo($proxy_auth)) if $proxy_auth; # "X-Forwarded-HTTPS" $base->scheme('https') if $ENV{MOJO_REVERSE_PROXY} && $headers->header('X-Forwarded-HTTPS'); return $self; } sub proxy { my $self = shift; return $self->{proxy} unless @_; $self->{proxy} = !$_[0] || ref $_[0] ? shift : Mojo::URL->new(shift); return $self; } sub query_params { shift->url->query } sub _parse_basic_auth { return undef unless my $header = shift; return $header =~ /Basic (.+)$/ ? b64_decode($1) : undef; } sub _parse_env { my ($self, $env) = @_; # Extract headers my $headers = $self->headers; my $url = $self->url; my $base = $url->base; while (my ($name, $value) = each %$env) { next unless $name =~ s/^HTTP_//i; $name =~ s/_/-/g; $headers->header($name => $value); # Host/Port if ($name eq 'HOST') { my ($host, $port) = ($value, undef); ($host, $port) = ($1, $2) if $host =~ /^([^:]*):?(.*)$/; $base->host($host)->port($port); } } # Content-Type is a special case on some servers $headers->content_type($env->{CONTENT_TYPE}) if $env->{CONTENT_TYPE}; # Content-Length is a special case on some servers $headers->content_length($env->{CONTENT_LENGTH}) if $env->{CONTENT_LENGTH}; # Query $url->query->parse($env->{QUERY_STRING}) if $env->{QUERY_STRING}; # Method $self->method($env->{REQUEST_METHOD}) if $env->{REQUEST_METHOD}; # Scheme/Version if ((defined $env->{SERVER_PROTOCOL} ? $env->{SERVER_PROTOCOL} : '') =~ m!^([^/]+)/([^/]+)$!) { $base->scheme($1); $self->version($2); } # HTTPS $base->scheme('https') if $env->{HTTPS}; # Path my $path = $url->path->parse($env->{PATH_INFO} ? $env->{PATH_INFO} : ''); # Base path if (my $value = $env->{SCRIPT_NAME}) { # Make sure there is a trailing slash (important for merging) $base->path->parse($value =~ m!/$! ? $value : "$value/"); # Remove SCRIPT_NAME prefix if necessary my $buffer = $path->to_string; $value =~ s!^/|/$!!g; $buffer =~ s!^/?\Q$value\E/?!!; $buffer =~ s!^/!!; $path->parse($buffer); } # Bypass normal message parser $self->{state} = 'cgi'; } 1; =encoding utf8 =head1 NAME Mojo::Message::Request - HTTP request =head1 SYNOPSIS use Mojo::Message::Request; # Parse my $req = Mojo::Message::Request->new; $req->parse("GET /foo HTTP/1.0\x0d\x0a"); $req->parse("Content-Length: 12\x0d\x0a"); $req->parse("Content-Type: text/plain\x0d\x0a\x0d\x0a"); $req->parse('Hello World!'); say $req->method; say $req->headers->content_type; say $req->body; # Build my $req = Mojo::Message::Request->new; $req->url->parse('http://127.0.0.1/foo/bar'); $req->method('GET'); say $req->to_string; =head1 DESCRIPTION L is a container for HTTP requests as described in RFC 2616 and RFC 2817. =head1 EVENTS L inherits all events from L. =head1 ATTRIBUTES L inherits all attributes from L and implements the following new ones. =head2 env my $env = $req->env; $req = $req->env({}); Direct access to the C or C environment hash if available. # Check CGI version my $version = $req->env->{GATEWAY_INTERFACE}; # Check PSGI version my $version = $req->env->{'psgi.version'}; =head2 method my $method = $req->method; $req = $req->method('POST'); HTTP request method, defaults to C. =head2 url my $url = $req->url; $req = $req->url(Mojo::URL->new); HTTP request URL, defaults to a L object. # Get request information say $req->url->to_abs->userinfo; say $req->url->to_abs->host; say $req->url->to_abs->path; =head1 METHODS L inherits all methods from L and implements the following new ones. =head2 clone my $clone = $req->clone; Clone request if possible, otherwise return C. =head2 cookies my $cookies = $req->cookies; $req = $req->cookies(Mojo::Cookie::Request->new); $req = $req->cookies({name => 'foo', value => 'bar'}); Access request cookies, usually L objects. =head2 extract_start_line my $bool = $req->extract_start_line(\$str); Extract request line from string. =head2 fix_headers $req = $req->fix_headers; Make sure request has all required headers. =head2 get_start_line_chunk my $bytes = $req->get_start_line_chunk($offset); Get a chunk of request line data starting from a specific position. =head2 is_secure my $bool = $req->is_secure; Check if connection is secure. =head2 is_xhr my $bool = $req->is_xhr; Check C header for C value. =head2 param my @names = $req->param; my $foo = $req->param('foo'); my @foo = $req->param('foo'); Access GET and POST parameters. Note that this method caches all data, so it should not be called before the entire request body has been received. Parts of the request body need to be loaded into memory to parse POST parameters, so you have to make sure it is not excessively large. =head2 params my $params = $req->params; All GET and POST parameters, usually a L object. Note that this method caches all data, so it should not be called before the entire request body has been received. Parts of the request body need to be loaded into memory to parse POST parameters, so you have to make sure it is not excessively large. # Get parameter value say $req->params->param('foo'); =head2 parse $req = $req->parse('GET /foo/bar HTTP/1.1'); $req = $req->parse(REQUEST_METHOD => 'GET'); $req = $req->parse({REQUEST_METHOD => 'GET'}); Parse HTTP request chunks or environment hash. =head2 proxy my $proxy = $req->proxy; $req = $req->proxy('http://foo:bar@127.0.0.1:3000'); $req = $req->proxy(Mojo::URL->new('http://127.0.0.1:3000')); Proxy URL for request. # Disable proxy $req->proxy(0); =head2 query_params my $params = $req->query_params; All GET parameters, usually a L object. # Turn GET parameters to hash and extract value say $req->query_params->to_hash->{foo}; =head1 SEE ALSO L, L, L. =cut