mirror of
https://github.com/nim-lang/Nim.git
synced 2025-12-29 09:24:36 +00:00
891 lines
32 KiB
Nim
891 lines
32 KiB
Nim
#
|
|
#
|
|
# Nim's Runtime Library
|
|
# (c) Copyright 2010 Dominik Picheta, Andreas Rumpf
|
|
#
|
|
# See the file "copying.txt", included in this
|
|
# distribution, for details about the copyright.
|
|
#
|
|
|
|
## This module implements a simple HTTP client that can be used to retrieve
|
|
## webpages/other data.
|
|
##
|
|
##
|
|
## **Note**: This module is not ideal, connection is not kept alive so sites with
|
|
## many redirects are expensive. As such in the future this module may change,
|
|
## and the current procedures will be deprecated.
|
|
##
|
|
## Retrieving a website
|
|
## ====================
|
|
##
|
|
## This example uses HTTP GET to retrieve
|
|
## ``http://google.com``
|
|
##
|
|
## .. code-block:: Nim
|
|
## echo(getContent("http://google.com"))
|
|
##
|
|
## Using HTTP POST
|
|
## ===============
|
|
##
|
|
## This example demonstrates the usage of the W3 HTML Validator, it
|
|
## uses ``multipart/form-data`` as the ``Content-Type`` to send the HTML to
|
|
## the server.
|
|
##
|
|
## .. code-block:: Nim
|
|
## var data = newMultipartData()
|
|
## data["output"] = "soap12"
|
|
## data["uploaded_file"] = ("test.html", "text/html",
|
|
## "<html><head></head><body><p>test</p></body></html>")
|
|
##
|
|
## echo postContent("http://validator.w3.org/check", multipart=data)
|
|
##
|
|
## Asynchronous HTTP requests
|
|
## ==========================
|
|
##
|
|
## You simply have to create a new instance of the ``AsyncHttpClient`` object.
|
|
## You may then use ``await`` on the functions defined for that object.
|
|
## Keep in mind that the following code needs to be inside an asynchronous
|
|
## procedure.
|
|
##
|
|
## .. code-block::nim
|
|
##
|
|
## var client = newAsyncHttpClient()
|
|
## var resp = await client.request("http://google.com")
|
|
##
|
|
## SSL/TLS support
|
|
## ===============
|
|
## This requires the OpenSSL library, fortunately it's widely used and installed
|
|
## on many operating systems. httpclient will use SSL automatically if you give
|
|
## any of the functions a url with the ``https`` schema, for example:
|
|
## ``https://github.com/``, you also have to compile with ``ssl`` defined like so:
|
|
## ``nim c -d:ssl ...``.
|
|
##
|
|
## Timeouts
|
|
## ========
|
|
## Currently all functions support an optional timeout, by default the timeout is set to
|
|
## `-1` which means that the function will never time out. The timeout is
|
|
## measured in milliseconds, once it is set any call on a socket which may
|
|
## block will be susceptible to this timeout, however please remember that the
|
|
## function as a whole can take longer than the specified timeout, only
|
|
## individual internal calls on the socket are affected. In practice this means
|
|
## that as long as the server is sending data an exception will not be raised,
|
|
## if however data does not reach client within the specified timeout an ETimeout
|
|
## exception will then be raised.
|
|
##
|
|
## Proxy
|
|
## =====
|
|
##
|
|
## A proxy can be specified as a param to any of these procedures, the ``newProxy``
|
|
## constructor should be used for this purpose. However,
|
|
## currently only basic authentication is supported.
|
|
|
|
import net, strutils, uri, parseutils, strtabs, base64, os, mimetypes, math
|
|
import asyncnet, asyncdispatch
|
|
import nativesockets
|
|
|
|
type
|
|
Response* = tuple[
|
|
version: string,
|
|
status: string,
|
|
headers: StringTableRef,
|
|
body: string]
|
|
|
|
Proxy* = ref object
|
|
url*: Uri
|
|
auth*: string
|
|
|
|
MultipartEntries* = openarray[tuple[name, content: string]]
|
|
MultipartData* = ref object
|
|
content: seq[string]
|
|
|
|
ProtocolError* = object of IOError ## exception that is raised when server
|
|
## does not conform to the implemented
|
|
## protocol
|
|
|
|
HttpRequestError* = object of IOError ## Thrown in the ``getContent`` proc
|
|
## and ``postContent`` proc,
|
|
## when the server returns an error
|
|
|
|
{.deprecated: [TResponse: Response, PProxy: Proxy,
|
|
EInvalidProtocol: ProtocolError, EHttpRequestErr: HttpRequestError
|
|
].}
|
|
|
|
const defUserAgent* = "Nim httpclient/0.1"
|
|
|
|
proc httpError(msg: string) =
|
|
var e: ref ProtocolError
|
|
new(e)
|
|
e.msg = msg
|
|
raise e
|
|
|
|
proc fileError(msg: string) =
|
|
var e: ref IOError
|
|
new(e)
|
|
e.msg = msg
|
|
raise e
|
|
|
|
proc parseChunks(s: Socket, timeout: int): string =
|
|
result = ""
|
|
var ri = 0
|
|
while true:
|
|
var chunkSizeStr = ""
|
|
var chunkSize = 0
|
|
s.readLine(chunkSizeStr, timeout)
|
|
var i = 0
|
|
if chunkSizeStr == "":
|
|
httpError("Server terminated connection prematurely")
|
|
while true:
|
|
case chunkSizeStr[i]
|
|
of '0'..'9':
|
|
chunkSize = chunkSize shl 4 or (ord(chunkSizeStr[i]) - ord('0'))
|
|
of 'a'..'f':
|
|
chunkSize = chunkSize shl 4 or (ord(chunkSizeStr[i]) - ord('a') + 10)
|
|
of 'A'..'F':
|
|
chunkSize = chunkSize shl 4 or (ord(chunkSizeStr[i]) - ord('A') + 10)
|
|
of '\0':
|
|
break
|
|
of ';':
|
|
# http://tools.ietf.org/html/rfc2616#section-3.6.1
|
|
# We don't care about chunk-extensions.
|
|
break
|
|
else:
|
|
httpError("Invalid chunk size: " & chunkSizeStr)
|
|
inc(i)
|
|
if chunkSize <= 0:
|
|
s.skip(2, timeout) # Skip \c\L
|
|
break
|
|
result.setLen(ri+chunkSize)
|
|
var bytesRead = 0
|
|
while bytesRead != chunkSize:
|
|
let ret = recv(s, addr(result[ri]), chunkSize-bytesRead, timeout)
|
|
ri += ret
|
|
bytesRead += ret
|
|
s.skip(2, timeout) # Skip \c\L
|
|
# Trailer headers will only be sent if the request specifies that we want
|
|
# them: http://tools.ietf.org/html/rfc2616#section-3.6.1
|
|
|
|
proc parseBody(s: Socket, headers: StringTableRef, timeout: int): string =
|
|
result = ""
|
|
if headers.getOrDefault"Transfer-Encoding" == "chunked":
|
|
result = parseChunks(s, timeout)
|
|
else:
|
|
# -REGION- Content-Length
|
|
# (http://tools.ietf.org/html/rfc2616#section-4.4) NR.3
|
|
var contentLengthHeader = headers.getOrDefault"Content-Length"
|
|
if contentLengthHeader != "":
|
|
var length = contentLengthHeader.parseint()
|
|
if length > 0:
|
|
result = newString(length)
|
|
var received = 0
|
|
while true:
|
|
if received >= length: break
|
|
let r = s.recv(addr(result[received]), length-received, timeout)
|
|
if r == 0: break
|
|
received += r
|
|
if received != length:
|
|
httpError("Got invalid content length. Expected: " & $length &
|
|
" got: " & $received)
|
|
else:
|
|
# (http://tools.ietf.org/html/rfc2616#section-4.4) NR.4 TODO
|
|
|
|
# -REGION- Connection: Close
|
|
# (http://tools.ietf.org/html/rfc2616#section-4.4) NR.5
|
|
if headers.getOrDefault"Connection" == "close":
|
|
var buf = ""
|
|
while true:
|
|
buf = newString(4000)
|
|
let r = s.recv(addr(buf[0]), 4000, timeout)
|
|
if r == 0: break
|
|
buf.setLen(r)
|
|
result.add(buf)
|
|
|
|
proc parseResponse(s: Socket, getBody: bool, timeout: int): Response =
|
|
var parsedStatus = false
|
|
var linei = 0
|
|
var fullyRead = false
|
|
var line = ""
|
|
result.headers = newStringTable(modeCaseInsensitive)
|
|
while true:
|
|
line = ""
|
|
linei = 0
|
|
s.readLine(line, timeout)
|
|
if line == "": break # We've been disconnected.
|
|
if line == "\c\L":
|
|
fullyRead = true
|
|
break
|
|
if not parsedStatus:
|
|
# Parse HTTP version info and status code.
|
|
var le = skipIgnoreCase(line, "HTTP/", linei)
|
|
if le <= 0: httpError("invalid http version")
|
|
inc(linei, le)
|
|
le = skipIgnoreCase(line, "1.1", linei)
|
|
if le > 0: result.version = "1.1"
|
|
else:
|
|
le = skipIgnoreCase(line, "1.0", linei)
|
|
if le <= 0: httpError("unsupported http version")
|
|
result.version = "1.0"
|
|
inc(linei, le)
|
|
# Status code
|
|
linei.inc skipWhitespace(line, linei)
|
|
result.status = line[linei .. ^1]
|
|
parsedStatus = true
|
|
else:
|
|
# Parse headers
|
|
var name = ""
|
|
var le = parseUntil(line, name, ':', linei)
|
|
if le <= 0: httpError("invalid headers")
|
|
inc(linei, le)
|
|
if line[linei] != ':': httpError("invalid headers")
|
|
inc(linei) # Skip :
|
|
|
|
result.headers[name] = line[linei.. ^1].strip()
|
|
if not fullyRead:
|
|
httpError("Connection was closed before full request has been made")
|
|
if getBody:
|
|
result.body = parseBody(s, result.headers, timeout)
|
|
else:
|
|
result.body = ""
|
|
|
|
type
|
|
HttpMethod* = enum ## the requested HttpMethod
|
|
httpHEAD, ## Asks for the response identical to the one that would
|
|
## correspond to a GET request, but without the response
|
|
## body.
|
|
httpGET, ## Retrieves the specified resource.
|
|
httpPOST, ## Submits data to be processed to the identified
|
|
## resource. The data is included in the body of the
|
|
## request.
|
|
httpPUT, ## Uploads a representation of the specified resource.
|
|
httpDELETE, ## Deletes the specified resource.
|
|
httpTRACE, ## Echoes back the received request, so that a client
|
|
## can see what intermediate servers are adding or
|
|
## changing in the request.
|
|
httpOPTIONS, ## Returns the HTTP methods that the server supports
|
|
## for specified address.
|
|
httpCONNECT ## Converts the request connection to a transparent
|
|
## TCP/IP tunnel, usually used for proxies.
|
|
|
|
{.deprecated: [THttpMethod: HttpMethod].}
|
|
|
|
when not defined(ssl):
|
|
type SSLContext = ref object
|
|
let defaultSSLContext: SSLContext = nil
|
|
else:
|
|
let defaultSSLContext = newContext(verifyMode = CVerifyNone)
|
|
|
|
proc newProxy*(url: string, auth = ""): Proxy =
|
|
## Constructs a new ``TProxy`` object.
|
|
result = Proxy(url: parseUri(url), auth: auth)
|
|
|
|
proc newMultipartData*: MultipartData =
|
|
## Constructs a new ``MultipartData`` object.
|
|
MultipartData(content: @[])
|
|
|
|
proc add*(p: var MultipartData, name, content: string, filename: string = nil,
|
|
contentType: string = nil) =
|
|
## Add a value to the multipart data. Raises a `ValueError` exception if
|
|
## `name`, `filename` or `contentType` contain newline characters.
|
|
|
|
if {'\c','\L'} in name:
|
|
raise newException(ValueError, "name contains a newline character")
|
|
if filename != nil and {'\c','\L'} in filename:
|
|
raise newException(ValueError, "filename contains a newline character")
|
|
if contentType != nil and {'\c','\L'} in contentType:
|
|
raise newException(ValueError, "contentType contains a newline character")
|
|
|
|
var str = "Content-Disposition: form-data; name=\"" & name & "\""
|
|
if filename != nil:
|
|
str.add("; filename=\"" & filename & "\"")
|
|
str.add("\c\L")
|
|
if contentType != nil:
|
|
str.add("Content-Type: " & contentType & "\c\L")
|
|
str.add("\c\L" & content & "\c\L")
|
|
|
|
p.content.add(str)
|
|
|
|
proc add*(p: var MultipartData, xs: MultipartEntries): MultipartData
|
|
{.discardable.} =
|
|
## Add a list of multipart entries to the multipart data `p`. All values are
|
|
## added without a filename and without a content type.
|
|
##
|
|
## .. code-block:: Nim
|
|
## data.add({"action": "login", "format": "json"})
|
|
for name, content in xs.items:
|
|
p.add(name, content)
|
|
result = p
|
|
|
|
proc newMultipartData*(xs: MultipartEntries): MultipartData =
|
|
## Create a new multipart data object and fill it with the entries `xs`
|
|
## directly.
|
|
##
|
|
## .. code-block:: Nim
|
|
## var data = newMultipartData({"action": "login", "format": "json"})
|
|
result = MultipartData(content: @[])
|
|
result.add(xs)
|
|
|
|
proc addFiles*(p: var MultipartData, xs: openarray[tuple[name, file: string]]):
|
|
MultipartData {.discardable.} =
|
|
## Add files to a multipart data object. The file will be opened from your
|
|
## disk, read and sent with the automatically determined MIME type. Raises an
|
|
## `IOError` if the file cannot be opened or reading fails. To manually
|
|
## specify file content, filename and MIME type, use `[]=` instead.
|
|
##
|
|
## .. code-block:: Nim
|
|
## data.addFiles({"uploaded_file": "public/test.html"})
|
|
var m = newMimetypes()
|
|
for name, file in xs.items:
|
|
var contentType: string
|
|
let (dir, fName, ext) = splitFile(file)
|
|
if ext.len > 0:
|
|
contentType = m.getMimetype(ext[1..ext.high], nil)
|
|
p.add(name, readFile(file), fName & ext, contentType)
|
|
result = p
|
|
|
|
proc `[]=`*(p: var MultipartData, name, content: string) =
|
|
## Add a multipart entry to the multipart data `p`. The value is added
|
|
## without a filename and without a content type.
|
|
##
|
|
## .. code-block:: Nim
|
|
## data["username"] = "NimUser"
|
|
p.add(name, content)
|
|
|
|
proc `[]=`*(p: var MultipartData, name: string,
|
|
file: tuple[name, contentType, content: string]) =
|
|
## Add a file to the multipart data `p`, specifying filename, contentType and
|
|
## content manually.
|
|
##
|
|
## .. code-block:: Nim
|
|
## data["uploaded_file"] = ("test.html", "text/html",
|
|
## "<html><head></head><body><p>test</p></body></html>")
|
|
p.add(name, file.content, file.name, file.contentType)
|
|
|
|
proc format(p: MultipartData): tuple[header, body: string] =
|
|
if p == nil or p.content == nil or p.content.len == 0:
|
|
return ("", "")
|
|
|
|
# Create boundary that is not in the data to be formatted
|
|
var bound: string
|
|
while true:
|
|
bound = $random(int.high)
|
|
var found = false
|
|
for s in p.content:
|
|
if bound in s:
|
|
found = true
|
|
if not found:
|
|
break
|
|
|
|
result.header = "Content-Type: multipart/form-data; boundary=" & bound & "\c\L"
|
|
result.body = ""
|
|
for s in p.content:
|
|
result.body.add("--" & bound & "\c\L" & s)
|
|
result.body.add("--" & bound & "--\c\L")
|
|
|
|
proc request*(url: string, httpMethod: string, extraHeaders = "",
|
|
body = "", sslContext = defaultSSLContext, timeout = -1,
|
|
userAgent = defUserAgent, proxy: Proxy = nil): Response =
|
|
## | Requests ``url`` with the custom method string specified by the
|
|
## | ``httpMethod`` parameter.
|
|
## | Extra headers can be specified and must be separated by ``\c\L``
|
|
## | An optional timeout can be specified in milliseconds, if reading from the
|
|
## server takes longer than specified an ETimeout exception will be raised.
|
|
var r = if proxy == nil: parseUri(url) else: proxy.url
|
|
var headers = substr(httpMethod, len("http"))
|
|
# TODO: Use generateHeaders further down once it supports proxies.
|
|
if proxy == nil:
|
|
headers.add ' '
|
|
if r.path[0] != '/': headers.add '/'
|
|
headers.add(r.path)
|
|
if r.query.len > 0:
|
|
headers.add("?" & r.query)
|
|
else:
|
|
headers.add(" " & url)
|
|
|
|
headers.add(" HTTP/1.1\c\L")
|
|
|
|
if r.port == "":
|
|
add(headers, "Host: " & r.hostname & "\c\L")
|
|
else:
|
|
add(headers, "Host: " & r.hostname & ":" & r.port & "\c\L")
|
|
|
|
if userAgent != "":
|
|
add(headers, "User-Agent: " & userAgent & "\c\L")
|
|
if proxy != nil and proxy.auth != "":
|
|
let auth = base64.encode(proxy.auth, newline = "")
|
|
add(headers, "Proxy-Authorization: basic " & auth & "\c\L")
|
|
add(headers, extraHeaders)
|
|
add(headers, "\c\L")
|
|
|
|
var s = newSocket()
|
|
if s == nil: raiseOSError(osLastError())
|
|
var port = net.Port(80)
|
|
if r.scheme == "https":
|
|
when defined(ssl):
|
|
sslContext.wrapSocket(s)
|
|
port = net.Port(443)
|
|
else:
|
|
raise newException(HttpRequestError,
|
|
"SSL support is not available. Cannot connect over SSL.")
|
|
if r.port != "":
|
|
port = net.Port(r.port.parseInt)
|
|
|
|
if timeout == -1:
|
|
s.connect(r.hostname, port)
|
|
else:
|
|
s.connect(r.hostname, port, timeout)
|
|
s.send(headers)
|
|
if body != "":
|
|
s.send(body)
|
|
|
|
result = parseResponse(s, httpMethod != "httpHEAD", timeout)
|
|
s.close()
|
|
|
|
proc request*(url: string, httpMethod = httpGET, extraHeaders = "",
|
|
body = "", sslContext = defaultSSLContext, timeout = -1,
|
|
userAgent = defUserAgent, proxy: Proxy = nil): Response =
|
|
## | Requests ``url`` with the specified ``httpMethod``.
|
|
## | Extra headers can be specified and must be separated by ``\c\L``
|
|
## | An optional timeout can be specified in milliseconds, if reading from the
|
|
## server takes longer than specified an ETimeout exception will be raised.
|
|
result = request(url, $httpMethod, extraHeaders, body, sslContext, timeout,
|
|
userAgent, proxy)
|
|
|
|
proc redirection(status: string): bool =
|
|
const redirectionNRs = ["301", "302", "303", "307"]
|
|
for i in items(redirectionNRs):
|
|
if status.startsWith(i):
|
|
return true
|
|
|
|
proc getNewLocation(lastUrl: string, headers: StringTableRef): string =
|
|
result = headers.getOrDefault"Location"
|
|
if result == "": httpError("location header expected")
|
|
# Relative URLs. (Not part of the spec, but soon will be.)
|
|
let r = parseUri(result)
|
|
if r.hostname == "" and r.path != "":
|
|
let origParsed = parseUri(lastUrl)
|
|
result = origParsed.hostname & "/" & r.path
|
|
|
|
proc get*(url: string, extraHeaders = "", maxRedirects = 5,
|
|
sslContext: SSLContext = defaultSSLContext,
|
|
timeout = -1, userAgent = defUserAgent,
|
|
proxy: Proxy = nil): Response =
|
|
## | GETs the ``url`` and returns a ``Response`` object
|
|
## | This proc also handles redirection
|
|
## | Extra headers can be specified and must be separated by ``\c\L``.
|
|
## | An optional timeout can be specified in milliseconds, if reading from the
|
|
## server takes longer than specified an ETimeout exception will be raised.
|
|
result = request(url, httpGET, extraHeaders, "", sslContext, timeout,
|
|
userAgent, proxy)
|
|
var lastURL = url
|
|
for i in 1..maxRedirects:
|
|
if result.status.redirection():
|
|
let redirectTo = getNewLocation(lastURL, result.headers)
|
|
result = request(redirectTo, httpGET, extraHeaders, "", sslContext,
|
|
timeout, userAgent, proxy)
|
|
lastUrl = redirectTo
|
|
|
|
proc getContent*(url: string, extraHeaders = "", maxRedirects = 5,
|
|
sslContext: SSLContext = defaultSSLContext,
|
|
timeout = -1, userAgent = defUserAgent,
|
|
proxy: Proxy = nil): string =
|
|
## | GETs the body and returns it as a string.
|
|
## | Raises exceptions for the status codes ``4xx`` and ``5xx``
|
|
## | Extra headers can be specified and must be separated by ``\c\L``.
|
|
## | An optional timeout can be specified in milliseconds, if reading from the
|
|
## server takes longer than specified an ETimeout exception will be raised.
|
|
var r = get(url, extraHeaders, maxRedirects, sslContext, timeout, userAgent,
|
|
proxy)
|
|
if r.status[0] in {'4','5'}:
|
|
raise newException(HttpRequestError, r.status)
|
|
else:
|
|
return r.body
|
|
|
|
proc post*(url: string, extraHeaders = "", body = "",
|
|
maxRedirects = 5,
|
|
sslContext: SSLContext = defaultSSLContext,
|
|
timeout = -1, userAgent = defUserAgent,
|
|
proxy: Proxy = nil,
|
|
multipart: MultipartData = nil): Response =
|
|
## | POSTs ``body`` to the ``url`` and returns a ``Response`` object.
|
|
## | This proc adds the necessary Content-Length header.
|
|
## | This proc also handles redirection.
|
|
## | Extra headers can be specified and must be separated by ``\c\L``.
|
|
## | An optional timeout can be specified in milliseconds, if reading from the
|
|
## server takes longer than specified an ETimeout exception will be raised.
|
|
## | The optional ``multipart`` parameter can be used to create
|
|
## ``multipart/form-data`` POSTs comfortably.
|
|
let (mpHeaders, mpBody) = format(multipart)
|
|
|
|
template withNewLine(x): expr =
|
|
if x.len > 0 and not x.endsWith("\c\L"):
|
|
x & "\c\L"
|
|
else:
|
|
x
|
|
|
|
var xb = mpBody.withNewLine() & body
|
|
|
|
var xh = extraHeaders.withNewLine() & mpHeaders.withNewLine() &
|
|
withNewLine("Content-Length: " & $len(xb))
|
|
|
|
result = request(url, httpPOST, xh, xb, sslContext, timeout, userAgent,
|
|
proxy)
|
|
var lastUrl = ""
|
|
for i in 1..maxRedirects:
|
|
if result.status.redirection():
|
|
let redirectTo = getNewLocation(lastURL, result.headers)
|
|
var meth = if result.status != "307": httpGet else: httpPost
|
|
result = request(redirectTo, meth, xh, xb, sslContext, timeout,
|
|
userAgent, proxy)
|
|
lastUrl = redirectTo
|
|
|
|
proc postContent*(url: string, extraHeaders = "", body = "",
|
|
maxRedirects = 5,
|
|
sslContext: SSLContext = defaultSSLContext,
|
|
timeout = -1, userAgent = defUserAgent,
|
|
proxy: Proxy = nil,
|
|
multipart: MultipartData = nil): string =
|
|
## | POSTs ``body`` to ``url`` and returns the response's body as a string
|
|
## | Raises exceptions for the status codes ``4xx`` and ``5xx``
|
|
## | Extra headers can be specified and must be separated by ``\c\L``.
|
|
## | An optional timeout can be specified in milliseconds, if reading from the
|
|
## server takes longer than specified an ETimeout exception will be raised.
|
|
## | The optional ``multipart`` parameter can be used to create
|
|
## ``multipart/form-data`` POSTs comfortably.
|
|
var r = post(url, extraHeaders, body, maxRedirects, sslContext, timeout,
|
|
userAgent, proxy, multipart)
|
|
if r.status[0] in {'4','5'}:
|
|
raise newException(HttpRequestError, r.status)
|
|
else:
|
|
return r.body
|
|
|
|
proc downloadFile*(url: string, outputFilename: string,
|
|
sslContext: SSLContext = defaultSSLContext,
|
|
timeout = -1, userAgent = defUserAgent,
|
|
proxy: Proxy = nil) =
|
|
## | Downloads ``url`` and saves it to ``outputFilename``
|
|
## | An optional timeout can be specified in milliseconds, if reading from the
|
|
## server takes longer than specified an ETimeout exception will be raised.
|
|
var f: File
|
|
if open(f, outputFilename, fmWrite):
|
|
f.write(getContent(url, sslContext = sslContext, timeout = timeout,
|
|
userAgent = userAgent, proxy = proxy))
|
|
f.close()
|
|
else:
|
|
fileError("Unable to open file")
|
|
|
|
proc generateHeaders(r: Uri, httpMethod: string,
|
|
headers: StringTableRef, body: string): string =
|
|
# TODO: Use this in the blocking HttpClient once it supports proxies.
|
|
result = substr(httpMethod, len("http"))
|
|
# TODO: Proxies
|
|
result.add ' '
|
|
if r.path[0] != '/': result.add '/'
|
|
result.add(r.path)
|
|
if r.query.len > 0:
|
|
result.add("?" & r.query)
|
|
result.add(" HTTP/1.1\c\L")
|
|
|
|
if r.port == "":
|
|
add(result, "Host: " & r.hostname & "\c\L")
|
|
else:
|
|
add(result, "Host: " & r.hostname & ":" & r.port & "\c\L")
|
|
|
|
add(result, "Connection: Keep-Alive\c\L")
|
|
if body.len > 0 and not headers.hasKey("Content-Length"):
|
|
add(result, "Content-Length: " & $body.len & "\c\L")
|
|
for key, val in headers:
|
|
add(result, key & ": " & val & "\c\L")
|
|
|
|
add(result, "\c\L")
|
|
|
|
type
|
|
AsyncHttpClient* = ref object
|
|
socket: AsyncSocket
|
|
connected: bool
|
|
currentURL: Uri ## Where we are currently connected.
|
|
headers*: StringTableRef
|
|
maxRedirects: int
|
|
userAgent: string
|
|
when defined(ssl):
|
|
sslContext: net.SslContext
|
|
|
|
{.deprecated: [PAsyncHttpClient: AsyncHttpClient].}
|
|
|
|
proc newAsyncHttpClient*(userAgent = defUserAgent,
|
|
maxRedirects = 5, sslContext = defaultSslContext): AsyncHttpClient =
|
|
## Creates a new AsyncHttpClient instance.
|
|
##
|
|
## ``userAgent`` specifies the user agent that will be used when making
|
|
## requests.
|
|
##
|
|
## ``maxRedirects`` specifies the maximum amount of redirects to follow,
|
|
## default is 5.
|
|
##
|
|
## ``sslContext`` specifies the SSL context to use for HTTPS requests.
|
|
new result
|
|
result.headers = newStringTable(modeCaseInsensitive)
|
|
result.userAgent = defUserAgent
|
|
result.maxRedirects = maxRedirects
|
|
when defined(ssl):
|
|
result.sslContext = net.SslContext(sslContext)
|
|
|
|
proc close*(client: AsyncHttpClient) =
|
|
## Closes any connections held by the HTTP client.
|
|
if client.connected:
|
|
client.socket.close()
|
|
client.connected = false
|
|
|
|
proc recvFull(socket: AsyncSocket, size: int): Future[string] {.async.} =
|
|
## Ensures that all the data requested is read and returned.
|
|
result = ""
|
|
while true:
|
|
if size == result.len: break
|
|
let data = await socket.recv(size - result.len)
|
|
if data == "": break # We've been disconnected.
|
|
result.add data
|
|
|
|
proc parseChunks(client: AsyncHttpClient): Future[string] {.async.} =
|
|
result = ""
|
|
while true:
|
|
var chunkSize = 0
|
|
var chunkSizeStr = await client.socket.recvLine()
|
|
var i = 0
|
|
if chunkSizeStr == "":
|
|
httpError("Server terminated connection prematurely")
|
|
while true:
|
|
case chunkSizeStr[i]
|
|
of '0'..'9':
|
|
chunkSize = chunkSize shl 4 or (ord(chunkSizeStr[i]) - ord('0'))
|
|
of 'a'..'f':
|
|
chunkSize = chunkSize shl 4 or (ord(chunkSizeStr[i]) - ord('a') + 10)
|
|
of 'A'..'F':
|
|
chunkSize = chunkSize shl 4 or (ord(chunkSizeStr[i]) - ord('A') + 10)
|
|
of '\0':
|
|
break
|
|
of ';':
|
|
# http://tools.ietf.org/html/rfc2616#section-3.6.1
|
|
# We don't care about chunk-extensions.
|
|
break
|
|
else:
|
|
httpError("Invalid chunk size: " & chunkSizeStr)
|
|
inc(i)
|
|
if chunkSize <= 0:
|
|
discard await recvFull(client.socket, 2) # Skip \c\L
|
|
break
|
|
result.add await recvFull(client.socket, chunkSize)
|
|
discard await recvFull(client.socket, 2) # Skip \c\L
|
|
# Trailer headers will only be sent if the request specifies that we want
|
|
# them: http://tools.ietf.org/html/rfc2616#section-3.6.1
|
|
|
|
proc parseBody(client: AsyncHttpClient,
|
|
headers: StringTableRef): Future[string] {.async.} =
|
|
result = ""
|
|
if headers.getOrDefault"Transfer-Encoding" == "chunked":
|
|
result = await parseChunks(client)
|
|
else:
|
|
# -REGION- Content-Length
|
|
# (http://tools.ietf.org/html/rfc2616#section-4.4) NR.3
|
|
var contentLengthHeader = headers.getOrDefault"Content-Length"
|
|
if contentLengthHeader != "":
|
|
var length = contentLengthHeader.parseint()
|
|
if length > 0:
|
|
result = await client.socket.recvFull(length)
|
|
if result == "":
|
|
httpError("Got disconnected while trying to read body.")
|
|
if result.len != length:
|
|
httpError("Received length doesn't match expected length. Wanted " &
|
|
$length & " got " & $result.len)
|
|
else:
|
|
# (http://tools.ietf.org/html/rfc2616#section-4.4) NR.4 TODO
|
|
|
|
# -REGION- Connection: Close
|
|
# (http://tools.ietf.org/html/rfc2616#section-4.4) NR.5
|
|
if headers.getOrDefault"Connection" == "close":
|
|
var buf = ""
|
|
while true:
|
|
buf = await client.socket.recvFull(4000)
|
|
if buf == "": break
|
|
result.add(buf)
|
|
|
|
proc parseResponse(client: AsyncHttpClient,
|
|
getBody: bool): Future[Response] {.async.} =
|
|
var parsedStatus = false
|
|
var linei = 0
|
|
var fullyRead = false
|
|
var line = ""
|
|
result.headers = newStringTable(modeCaseInsensitive)
|
|
while true:
|
|
linei = 0
|
|
line = await client.socket.recvLine()
|
|
if line == "": break # We've been disconnected.
|
|
if line == "\c\L":
|
|
fullyRead = true
|
|
break
|
|
if not parsedStatus:
|
|
# Parse HTTP version info and status code.
|
|
var le = skipIgnoreCase(line, "HTTP/", linei)
|
|
if le <= 0:
|
|
httpError("invalid http version, " & line.repr)
|
|
inc(linei, le)
|
|
le = skipIgnoreCase(line, "1.1", linei)
|
|
if le > 0: result.version = "1.1"
|
|
else:
|
|
le = skipIgnoreCase(line, "1.0", linei)
|
|
if le <= 0: httpError("unsupported http version")
|
|
result.version = "1.0"
|
|
inc(linei, le)
|
|
# Status code
|
|
linei.inc skipWhitespace(line, linei)
|
|
result.status = line[linei .. ^1]
|
|
parsedStatus = true
|
|
else:
|
|
# Parse headers
|
|
var name = ""
|
|
var le = parseUntil(line, name, ':', linei)
|
|
if le <= 0: httpError("invalid headers")
|
|
inc(linei, le)
|
|
if line[linei] != ':': httpError("invalid headers")
|
|
inc(linei) # Skip :
|
|
|
|
result.headers[name] = line[linei.. ^1].strip()
|
|
if not fullyRead:
|
|
httpError("Connection was closed before full request has been made")
|
|
if getBody:
|
|
result.body = await parseBody(client, result.headers)
|
|
else:
|
|
result.body = ""
|
|
|
|
proc newConnection(client: AsyncHttpClient, url: Uri) {.async.} =
|
|
if client.currentURL.hostname != url.hostname or
|
|
client.currentURL.scheme != url.scheme:
|
|
if client.connected: client.close()
|
|
client.socket = newAsyncSocket()
|
|
|
|
# TODO: I should be able to write 'net.Port' here...
|
|
let port =
|
|
if url.port == "":
|
|
if url.scheme.toLower() == "https":
|
|
nativesockets.Port(443)
|
|
else:
|
|
nativesockets.Port(80)
|
|
else: nativesockets.Port(url.port.parseInt)
|
|
|
|
if url.scheme.toLower() == "https":
|
|
when defined(ssl):
|
|
client.sslContext.wrapSocket(client.socket)
|
|
else:
|
|
raise newException(HttpRequestError,
|
|
"SSL support is not available. Cannot connect over SSL.")
|
|
|
|
await client.socket.connect(url.hostname, port)
|
|
client.currentURL = url
|
|
client.connected = true
|
|
|
|
proc request*(client: AsyncHttpClient, url: string, httpMethod: string,
|
|
body = ""): Future[Response] {.async.} =
|
|
## Connects to the hostname specified by the URL and performs a request
|
|
## using the custom method string specified by ``httpMethod``.
|
|
##
|
|
## Connection will kept alive. Further requests on the same ``client`` to
|
|
## the same hostname will not require a new connection to be made. The
|
|
## connection can be closed by using the ``close`` procedure.
|
|
##
|
|
## The returned future will complete once the request is completed.
|
|
let r = parseUri(url)
|
|
await newConnection(client, r)
|
|
|
|
if not client.headers.hasKey("user-agent") and client.userAgent != "":
|
|
client.headers["User-Agent"] = client.userAgent
|
|
|
|
var headers = generateHeaders(r, $httpMethod, client.headers, body)
|
|
|
|
await client.socket.send(headers)
|
|
if body != "":
|
|
await client.socket.send(body)
|
|
|
|
result = await parseResponse(client, httpMethod != "httpHEAD")
|
|
|
|
proc request*(client: AsyncHttpClient, url: string, httpMethod = httpGET,
|
|
body = ""): Future[Response] =
|
|
## Connects to the hostname specified by the URL and performs a request
|
|
## using the method specified.
|
|
##
|
|
## Connection will kept alive. Further requests on the same ``client`` to
|
|
## the same hostname will not require a new connection to be made. The
|
|
## connection can be closed by using the ``close`` procedure.
|
|
##
|
|
## The returned future will complete once the request is completed.
|
|
result = request(client, url, $httpMethod, body)
|
|
|
|
proc get*(client: AsyncHttpClient, url: string): Future[Response] {.async.} =
|
|
## Connects to the hostname specified by the URL and performs a GET request.
|
|
##
|
|
## This procedure will follow redirects up to a maximum number of redirects
|
|
## specified in ``newAsyncHttpClient``.
|
|
result = await client.request(url, httpGET)
|
|
var lastURL = url
|
|
for i in 1..client.maxRedirects:
|
|
if result.status.redirection():
|
|
let redirectTo = getNewLocation(lastURL, result.headers)
|
|
result = await client.request(redirectTo, httpGET)
|
|
lastUrl = redirectTo
|
|
|
|
proc post*(client: AsyncHttpClient, url: string, body = "", multipart: MultipartData = nil): Future[Response] {.async.} =
|
|
## Connects to the hostname specified by the URL and performs a POST request.
|
|
##
|
|
## This procedure will follow redirects up to a maximum number of redirects
|
|
## specified in ``newAsyncHttpClient``.
|
|
let (mpHeader, mpBody) = format(multipart)
|
|
|
|
template withNewLine(x): expr =
|
|
if x.len > 0 and not x.endsWith("\c\L"):
|
|
x & "\c\L"
|
|
else:
|
|
x
|
|
var xb = mpBody.withNewLine() & body
|
|
if multipart != nil:
|
|
client.headers["Content-Type"] = mpHeader.split(": ")[1]
|
|
client.headers["Content-Length"] = $len(xb)
|
|
|
|
result = await client.request(url, httpPOST, xb)
|
|
|
|
when not defined(testing) and isMainModule:
|
|
when true:
|
|
# Async
|
|
proc main() {.async.} =
|
|
var client = newAsyncHttpClient()
|
|
var resp = await client.request("http://picheta.me")
|
|
|
|
echo("Got response: ", resp.status)
|
|
echo("Body:\n")
|
|
echo(resp.body)
|
|
|
|
resp = await client.request("http://picheta.me/asfas.html")
|
|
echo("Got response: ", resp.status)
|
|
|
|
resp = await client.request("http://picheta.me/aboutme.html")
|
|
echo("Got response: ", resp.status)
|
|
|
|
resp = await client.request("http://nim-lang.org/")
|
|
echo("Got response: ", resp.status)
|
|
|
|
resp = await client.request("http://nim-lang.org/download.html")
|
|
echo("Got response: ", resp.status)
|
|
|
|
waitFor main()
|
|
|
|
else:
|
|
#downloadFile("http://force7.de/nim/index.html", "nimindex.html")
|
|
#downloadFile("http://www.httpwatch.com/", "ChunkTest.html")
|
|
#downloadFile("http://validator.w3.org/check?uri=http%3A%2F%2Fgoogle.com",
|
|
# "validator.html")
|
|
|
|
#var r = get("http://validator.w3.org/check?uri=http%3A%2F%2Fgoogle.com&
|
|
# charset=%28detect+automatically%29&doctype=Inline&group=0")
|
|
|
|
var data = newMultipartData()
|
|
data["output"] = "soap12"
|
|
data["uploaded_file"] = ("test.html", "text/html",
|
|
"<html><head></head><body><p>test</p></body></html>")
|
|
|
|
echo postContent("http://validator.w3.org/check", multipart=data)
|