1
0
mirror of https://github.com/vlang/v.git synced 2023-08-10 21:13:21 +03:00
v/vlib/net/http/http.v

390 lines
11 KiB
V
Raw Normal View History

// Copyright (c) 2019-2021 Alexander Medvednikov. All rights reserved.
2019-06-23 05:21:30 +03:00
// Use of this source code is governed by an MIT license
// that can be found in the LICENSE file.
2019-06-22 21:20:28 +03:00
module http
2019-08-06 15:43:09 +03:00
import net.urllib
2019-12-30 07:42:23 +03:00
import net.http.chunked
2020-05-20 20:21:57 +03:00
import net
import io
2019-08-06 15:43:09 +03:00
const (
2020-05-16 17:12:23 +03:00
max_redirects = 4
2020-01-16 20:16:11 +03:00
content_type_default = 'text/plain'
bufsize = 1536
)
// Request holds information about an HTTP request
2019-10-24 19:44:49 +03:00
pub struct Request {
2020-04-28 14:57:48 +03:00
pub mut:
version Version = .v1_1
method Method
header Header
2020-01-16 20:16:11 +03:00
cookies map[string]string
2019-12-22 01:41:42 +03:00
data string
url string
2020-05-20 09:58:57 +03:00
user_agent string = 'v.http'
2020-01-16 20:16:11 +03:00
verbose bool
2019-12-22 01:41:42 +03:00
user_ptr voidptr
ws_func voidptr
2019-06-22 21:20:28 +03:00
}
// FetchConfig holds configurations of fetch
2020-01-16 20:16:11 +03:00
pub struct FetchConfig {
pub mut:
method Method
header Header
data string
params map[string]string
cookies map[string]string
2020-05-20 09:58:57 +03:00
user_agent string = 'v.http'
verbose bool
2020-01-16 20:16:11 +03:00
}
// Response represents the result of the request
2019-10-24 19:44:49 +03:00
pub struct Response {
2019-06-22 21:20:28 +03:00
pub:
2019-07-31 23:10:28 +03:00
text string
header Header
2020-01-16 20:16:11 +03:00
cookies map[string]string
2019-06-22 21:20:28 +03:00
status_code int
}
pub fn new_request(method Method, url_ string, data string) ?Request {
url := if method == .get { url_ + '?' + data } else { url_ }
// println('new req() method=$method url="$url" dta="$data"')
return Request{
method: method
url: url
data: data
/*
headers: {
'Accept-Encoding': 'compress'
}
*/
}
}
// get sends a GET HTTP request to the URL
2020-01-16 20:16:11 +03:00
pub fn get(url string) ?Response {
return fetch_with_method(.get, url, FetchConfig{})
2020-01-15 01:19:50 +03:00
}
// post sends a POST HTTP request to the URL with a string data
pub fn post(url string, data string) ?Response {
return fetch_with_method(.post, url,
data: data
header: new_header({key: .content_type, value: http.content_type_default})
)
2020-01-15 01:19:50 +03:00
}
// post_json sends a POST HTTP request to the URL with a JSON data
pub fn post_json(url string, data string) ?Response {
return fetch_with_method(.post, url,
data: data
header: new_header({key: .content_type, value: 'application/json'})
)
}
// post_form sends a POST HTTP request to the URL with X-WWW-FORM-URLENCODED data
2020-01-16 20:16:11 +03:00
pub fn post_form(url string, data map[string]string) ?Response {
return fetch_with_method(.post, url,
header: new_header({key: .content_type, value: 'application/x-www-form-urlencoded'})
data: url_encode_form_data(data)
)
2020-01-15 01:19:50 +03:00
}
// put sends a PUT HTTP request to the URL with a string data
pub fn put(url string, data string) ?Response {
return fetch_with_method(.put, url,
data: data
header: new_header({key: .content_type, value: http.content_type_default})
)
2020-01-15 01:19:50 +03:00
}
// patch sends a PATCH HTTP request to the URL with a string data
pub fn patch(url string, data string) ?Response {
return fetch_with_method(.patch, url,
data: data
header: new_header({key: .content_type, value: http.content_type_default})
)
2019-07-29 20:18:26 +03:00
}
// head sends a HEAD HTTP request to the URL
2020-01-16 20:16:11 +03:00
pub fn head(url string) ?Response {
return fetch_with_method(.head, url, FetchConfig{})
2019-06-22 21:20:28 +03:00
}
// delete sends a DELETE HTTP request to the URL
2020-01-16 20:16:11 +03:00
pub fn delete(url string) ?Response {
return fetch_with_method(.delete, url, FetchConfig{})
}
// fetch sends an HTTP request to the URL with the given method and configurations
2020-01-16 20:16:11 +03:00
pub fn fetch(_url string, config FetchConfig) ?Response {
2019-07-29 20:18:26 +03:00
if _url == '' {
2020-01-16 20:16:11 +03:00
return error('http.fetch: empty url')
2019-07-29 20:18:26 +03:00
}
url := build_url_from_fetch(_url, config) or { return error('http.fetch: invalid url $_url') }
2020-01-16 20:16:11 +03:00
data := config.data
req := Request{
method: config.method
url: url
data: data
header: config.header
2020-01-16 20:16:11 +03:00
cookies: config.cookies
user_agent: config.user_agent
2019-06-22 21:20:28 +03:00
ws_func: 0
user_ptr: 0
2020-01-16 20:16:11 +03:00
verbose: config.verbose
2019-06-22 21:20:28 +03:00
}
res := req.do() ?
2020-01-16 20:16:11 +03:00
return res
2019-06-22 21:20:28 +03:00
}
// get_text sends a GET HTTP request to the URL and returns the text content of the response
2019-07-31 23:10:28 +03:00
pub fn get_text(url string) string {
resp := fetch(url, method: .get) or { return '' }
2019-10-24 19:44:49 +03:00
return resp.text
}
2019-07-31 23:10:28 +03:00
// url_encode_form_data converts mapped data to an URL encoded string
2020-01-16 20:16:11 +03:00
pub fn url_encode_form_data(data map[string]string) string {
2020-04-26 14:49:31 +03:00
mut pieces := []string{}
for key_, value_ in data {
key := urllib.query_escape(key_)
value := urllib.query_escape(value_)
2020-01-16 20:16:11 +03:00
pieces << '$key=$value'
}
return pieces.join('&')
}
fn fetch_with_method(method Method, url string, _config FetchConfig) ?Response {
2020-01-16 20:16:11 +03:00
mut config := _config
config.method = method
return fetch(url, config)
}
fn build_url_from_fetch(_url string, config FetchConfig) ?string {
mut url := urllib.parse(_url) ?
if config.params.len == 0 {
2020-01-16 20:16:11 +03:00
return url.str()
}
mut pieces := []string{cap: config.params.len}
for key, val in config.params {
pieces << '$key=$val'
2020-01-16 20:16:11 +03:00
}
mut query := pieces.join('&')
if url.raw_query.len > 1 {
query = url.raw_query + '&' + query
}
url.raw_query = query
return url.str()
}
2020-05-16 17:12:23 +03:00
fn (mut req Request) free() {
unsafe { req.header.free() }
2019-06-22 21:20:28 +03:00
}
2020-05-16 17:12:23 +03:00
fn (mut resp Response) free() {
unsafe { resp.header.data.free() }
2019-06-22 21:20:28 +03:00
}
2019-11-18 00:42:25 +03:00
// add_header adds the key and value of an HTTP request header
// To add a custom header, use add_custom_header
pub fn (mut req Request) add_header(key CommonHeader, val string) {
req.header.add(key, val)
2019-06-22 21:20:28 +03:00
}
// add_custom_header adds the key and value of an HTTP request header
// This method may fail if the key contains characters that are not permitted
pub fn (mut req Request) add_custom_header(key string, val string) ? {
return req.header.add_custom(key, val)
2019-09-05 15:46:24 +03:00
}
2019-11-18 00:42:25 +03:00
// do will send the HTTP request and returns `http.Response` as soon as the response is recevied
pub fn (req &Request) do() ?Response {
mut url := urllib.parse(req.url) or { return error('http.Request.do: invalid url $req.url') }
2019-08-21 20:04:06 +03:00
mut rurl := url
2019-12-23 13:37:52 +03:00
mut resp := Response{}
mut no_redirects := 0
2019-08-21 20:04:06 +03:00
for {
if no_redirects == http.max_redirects {
return error('http.request.do: maximum number of redirects reached ($http.max_redirects)')
2019-12-22 01:41:42 +03:00
}
qresp := req.method_and_url_to_response(req.method, rurl) ?
2019-08-21 20:04:06 +03:00
resp = qresp
if resp.status_code !in [301, 302, 303, 307, 308] {
2019-12-22 01:41:42 +03:00
break
}
2019-08-21 20:04:06 +03:00
// follow any redirects
mut redirect_url := resp.header.get(.location) or { '' }
if redirect_url.len > 0 && redirect_url[0] == `/` {
url.set_path(redirect_url) or {
return error('http.request.do: invalid path in redirect: "$redirect_url"')
}
redirect_url = url.str()
}
2019-12-22 01:41:42 +03:00
qrurl := urllib.parse(redirect_url) or {
return error('http.request.do: invalid URL in redirect "$redirect_url"')
}
2019-08-21 20:04:06 +03:00
rurl = qrurl
no_redirects++
}
return resp
}
fn (req &Request) method_and_url_to_response(method Method, url urllib.URL) ?Response {
2019-08-25 01:48:06 +03:00
host_name := url.hostname()
scheme := url.scheme
p := url.path.trim_left('/')
path := if url.query().len > 0 { '/$p?$url.query().encode()' } else { '/$p' }
2019-08-21 20:04:06 +03:00
mut nport := url.port().int()
if nport == 0 {
2019-12-22 01:41:42 +03:00
if scheme == 'http' {
nport = 80
}
if scheme == 'https' {
nport = 443
}
2019-08-21 20:04:06 +03:00
}
2019-12-22 01:41:42 +03:00
// println('fetch $method, $scheme, $host_name, $nport, $path ')
2019-08-21 20:04:06 +03:00
if scheme == 'https' {
2019-12-22 01:41:42 +03:00
// println('ssl_do( $nport, $method, $host_name, $path )')
res := req.ssl_do(nport, method, host_name, path) ?
2019-10-10 20:24:36 +03:00
return res
2020-05-16 17:12:23 +03:00
} else if scheme == 'http' {
2019-12-22 01:41:42 +03:00
// println('http_do( $nport, $method, $host_name, $path )')
res := req.http_do('$host_name:$nport', method, path) ?
2019-10-10 20:24:36 +03:00
return res
2019-08-21 20:04:06 +03:00
}
return error('http.request.method_and_url_to_response: unsupported scheme: "$scheme"')
2019-08-21 20:04:06 +03:00
}
pub fn parse_response(resp string) Response {
mut header := new_header()
2020-01-16 20:16:11 +03:00
// TODO: Cookie data type
2020-05-16 17:12:23 +03:00
mut cookies := map[string]string{}
2019-10-24 19:44:49 +03:00
first_header := resp.all_before('\n')
mut status_code := 0
if first_header.contains('HTTP/') {
val := first_header.find_between(' ', ' ')
status_code = val.int()
}
2019-10-24 19:44:49 +03:00
mut text := ''
// Build resp header map and separate the body
2019-10-24 19:44:49 +03:00
mut nl_pos := 3
mut i := 1
for {
old_pos := nl_pos
2019-12-22 01:41:42 +03:00
nl_pos = resp.index_after('\n', nl_pos + 1)
if nl_pos == -1 {
2019-10-24 19:44:49 +03:00
break
}
h := resp[old_pos + 1..nl_pos]
2019-10-24 19:44:49 +03:00
// End of headers
if h.len <= 1 {
text = resp[nl_pos + 1..]
2019-10-24 19:44:49 +03:00
break
}
i++
pos := h.index(':') or { continue }
mut key := h[..pos]
val := h[pos + 2..].trim_space()
header.add_custom(key, val) or { eprintln('error parsing header: $err') }
}
// set cookies
for cookie in header.values(.set_cookie) {
parts := cookie.split_nth('=', 2)
cookies[parts[0]] = parts[1]
2019-08-07 04:57:47 +03:00
}
if header.get(.transfer_encoding) or { '' } == 'chunked' || header.get(.content_length) or { '' } == '' {
2019-12-22 01:41:42 +03:00
text = chunked.decode(text)
2019-08-07 04:57:47 +03:00
}
2019-12-22 01:41:42 +03:00
return Response{
2019-10-24 19:44:49 +03:00
status_code: status_code
header: header
2020-01-16 20:16:11 +03:00
cookies: cookies
2019-10-24 19:44:49 +03:00
text: text
}
}
fn (req &Request) build_request_headers(method Method, host_name string, path string) string {
2019-08-25 01:48:06 +03:00
ua := req.user_agent
2020-04-26 14:49:31 +03:00
mut uheaders := []string{}
if !req.header.contains(.host) {
2020-01-16 20:16:11 +03:00
uheaders << 'Host: $host_name\r\n'
}
if !req.header.contains(.user_agent) {
2020-01-16 20:16:11 +03:00
uheaders << 'User-Agent: $ua\r\n'
}
if req.data.len > 0 && !req.header.contains(.content_length) {
uheaders << 'Content-Length: $req.data.len\r\n'
2020-01-16 20:16:11 +03:00
}
for key in req.header.keys() {
if key == CommonHeader.cookie.str() {
2020-01-16 20:16:11 +03:00
continue
}
val := req.header.custom_values(key).join('; ')
uheaders << '$key: $val\r\n'
2019-08-25 01:48:06 +03:00
}
2020-01-16 20:16:11 +03:00
uheaders << req.build_request_cookies_header()
version := if req.version == .unknown { Version.v1_1 } else { req.version }
return '$method $path $version\r\n' + uheaders.join('') + 'Connection: close\r\n\r\n' + req.data
2020-01-16 20:16:11 +03:00
}
fn (req &Request) build_request_cookies_header() string {
if req.cookies.keys().len < 1 {
return ''
}
2020-04-26 14:49:31 +03:00
mut cookie := []string{}
2020-01-16 20:16:11 +03:00
for key, val in req.cookies {
2020-07-26 16:54:18 +03:00
cookie << '$key=$val'
2020-01-16 20:16:11 +03:00
}
cookie << req.header.values(.cookie)
2020-01-16 20:16:11 +03:00
return 'Cookie: ' + cookie.join('; ') + '\r\n'
}
// unescape_url is deprecated, use urllib.query_unescape() instead
pub fn unescape_url(s string) string {
2019-10-24 19:44:49 +03:00
panic('http.unescape_url() was replaced with urllib.query_unescape()')
}
// escape_url is deprecated, use urllib.query_escape() instead
pub fn escape_url(s string) string {
2019-10-24 19:44:49 +03:00
panic('http.escape_url() was replaced with urllib.query_escape()')
}
// unescape is deprecated, use urllib.query_escape() instead
pub fn unescape(s string) string {
2019-10-24 19:44:49 +03:00
panic('http.unescape() was replaced with http.unescape_url()')
}
// escape is deprecated, use urllib.query_unescape() instead
pub fn escape(s string) string {
2019-10-24 19:44:49 +03:00
panic('http.escape() was replaced with http.escape_url()')
}
2020-05-20 20:21:57 +03:00
fn (req &Request) http_do(host string, method Method, path string) ?Response {
host_name, _ := net.split_address(host) ?
2020-05-20 20:21:57 +03:00
s := req.build_request_headers(method, host_name, path)
mut client := net.dial_tcp(host) ?
// TODO this really needs to be exposed somehow
client.write(s.bytes()) ?
$if trace_http_request ? {
eprintln('> $s')
}
mut bytes := io.read_all(reader: client) ?
client.close() ?
response_text := bytes.bytestr()
$if trace_http_response ? {
eprintln('< $response_text')
}
return parse_response(response_text)
2020-05-20 20:21:57 +03:00
}
2020-07-07 15:37:43 +03:00
// referer returns 'Referer' header value of the given request
2020-07-07 15:37:43 +03:00
pub fn (req &Request) referer() string {
return req.header.get(.referer) or { '' }
2020-07-07 15:37:43 +03:00
}