mirror of
https://github.com/nim-lang/Nim.git
synced 2025-12-29 09:24:36 +00:00
304 lines
9.7 KiB
Nim
304 lines
9.7 KiB
Nim
#
|
|
#
|
|
# Nim's Runtime Library
|
|
# (c) Copyright 2015 Dominik Picheta
|
|
#
|
|
# See the file "copying.txt", included in this
|
|
# distribution, for details about the copyright.
|
|
#
|
|
|
|
## This module implements a high performance asynchronous HTTP server.
|
|
##
|
|
## This HTTP server has not been designed to be used in production, but
|
|
## for testing applications locally. Because of this, when deploying your
|
|
## application you should use a reverse proxy (for example nginx) instead of
|
|
## allowing users to connect directly to this server.
|
|
##
|
|
##
|
|
## Examples
|
|
## --------
|
|
##
|
|
## This example will create an HTTP server on port 8080. The server will
|
|
## respond to all requests with a ``200 OK`` response code and "Hello World"
|
|
## as the response body.
|
|
##
|
|
## .. code-block::nim
|
|
## import asynchttpserver, asyncdispatch
|
|
##
|
|
## var server = newAsyncHttpServer()
|
|
## proc cb(req: Request) {.async.} =
|
|
## await req.respond(Http200, "Hello World")
|
|
##
|
|
## waitFor server.serve(Port(8080), cb)
|
|
|
|
import tables, asyncnet, asyncdispatch, parseutils, uri, strutils
|
|
import httpcore
|
|
|
|
export httpcore except parseHeader
|
|
|
|
const
|
|
maxLine = 8*1024
|
|
|
|
# TODO: If it turns out that the decisions that asynchttpserver makes
|
|
# explicitly, about whether to close the client sockets or upgrade them are
|
|
# wrong, then add a return value which determines what to do for the callback.
|
|
# Also, maybe move `client` out of `Request` object and into the args for
|
|
# the proc.
|
|
type
|
|
Request* = object
|
|
client*: AsyncSocket # TODO: Separate this into a Response object?
|
|
reqMethod*: HttpMethod
|
|
headers*: HttpHeaders
|
|
protocol*: tuple[orig: string, major, minor: int]
|
|
url*: Uri
|
|
hostname*: string ## The hostname of the client that made the request.
|
|
body*: string
|
|
|
|
AsyncHttpServer* = ref object
|
|
socket: AsyncSocket
|
|
reuseAddr: bool
|
|
reusePort: bool
|
|
|
|
{.deprecated: [TRequest: Request, PAsyncHttpServer: AsyncHttpServer,
|
|
THttpCode: HttpCode, THttpVersion: HttpVersion].}
|
|
|
|
proc newAsyncHttpServer*(reuseAddr = true, reusePort = false): AsyncHttpServer =
|
|
## Creates a new ``AsyncHttpServer`` instance.
|
|
new result
|
|
result.reuseAddr = reuseAddr
|
|
result.reusePort = reusePort
|
|
|
|
proc addHeaders(msg: var string, headers: HttpHeaders) =
|
|
for k, v in headers:
|
|
msg.add(k & ": " & v & "\c\L")
|
|
|
|
proc sendHeaders*(req: Request, headers: HttpHeaders): Future[void] =
|
|
## Sends the specified headers to the requesting client.
|
|
var msg = ""
|
|
addHeaders(msg, headers)
|
|
return req.client.send(msg)
|
|
|
|
proc respond*(req: Request, code: HttpCode, content: string,
|
|
headers: HttpHeaders = nil): Future[void] =
|
|
## Responds to the request with the specified ``HttpCode``, headers and
|
|
## content.
|
|
##
|
|
## This procedure will **not** close the client socket.
|
|
##
|
|
## Examples
|
|
## --------
|
|
## .. code-block::nim
|
|
## import json
|
|
## proc handler(req: Request) {.async.} =
|
|
## if req.url.path == "/hello-world":
|
|
## let msg = %* {"message": "Hello World"}
|
|
## let headers = newHttpHeaders([("Content-Type","application/json")])
|
|
## await req.respond(Http200, $msg, headers)
|
|
## else:
|
|
## await req.respond(Http404, "Not Found")
|
|
var msg = "HTTP/1.1 " & $code & "\c\L"
|
|
|
|
if headers != nil:
|
|
msg.addHeaders(headers)
|
|
msg.add("Content-Length: ")
|
|
# this particular way saves allocations:
|
|
msg.add content.len
|
|
msg.add "\c\L\c\L"
|
|
msg.add(content)
|
|
result = req.client.send(msg)
|
|
|
|
proc respondError(req: Request, code: HttpCode): Future[void] =
|
|
## Responds to the request with the specified ``HttpCode``.
|
|
let content = $code
|
|
var msg = "HTTP/1.1 " & content & "\c\L"
|
|
|
|
msg.add("Content-Length: " & $content.len & "\c\L\c\L")
|
|
msg.add(content)
|
|
result = req.client.send(msg)
|
|
|
|
proc parseProtocol(protocol: string): tuple[orig: string, major, minor: int] =
|
|
var i = protocol.skipIgnoreCase("HTTP/")
|
|
if i != 5:
|
|
raise newException(ValueError, "Invalid request protocol. Got: " &
|
|
protocol)
|
|
result.orig = protocol
|
|
i.inc protocol.parseInt(result.major, i)
|
|
i.inc # Skip .
|
|
i.inc protocol.parseInt(result.minor, i)
|
|
|
|
proc sendStatus(client: AsyncSocket, status: string): Future[void] =
|
|
client.send("HTTP/1.1 " & status & "\c\L\c\L")
|
|
|
|
proc processClient(client: AsyncSocket, address: string,
|
|
callback: proc (request: Request):
|
|
Future[void] {.closure, gcsafe.}) {.async.} =
|
|
var request: Request
|
|
request.url = initUri()
|
|
request.headers = newHttpHeaders()
|
|
var lineFut = newFutureVar[string]("asynchttpserver.processClient")
|
|
lineFut.mget() = newStringOfCap(80)
|
|
var key, value = ""
|
|
|
|
while not client.isClosed:
|
|
# GET /path HTTP/1.1
|
|
# Header: val
|
|
# \n
|
|
request.headers.clear()
|
|
request.body = ""
|
|
request.hostname.shallowCopy(address)
|
|
assert client != nil
|
|
request.client = client
|
|
|
|
# We should skip at least one empty line before the request
|
|
# https://tools.ietf.org/html/rfc7230#section-3.5
|
|
for i in 0..1:
|
|
lineFut.mget().setLen(0)
|
|
lineFut.clean()
|
|
await client.recvLineInto(lineFut, maxLength=maxLine) # TODO: Timeouts.
|
|
|
|
if lineFut.mget == "":
|
|
client.close()
|
|
return
|
|
|
|
if lineFut.mget.len > maxLine:
|
|
await request.respondError(Http413)
|
|
client.close()
|
|
return
|
|
if lineFut.mget != "\c\L":
|
|
break
|
|
|
|
# First line - GET /path HTTP/1.1
|
|
var i = 0
|
|
for linePart in lineFut.mget.split(' '):
|
|
case i
|
|
of 0:
|
|
try:
|
|
# TODO: this is likely slow.
|
|
request.reqMethod = parseEnum[HttpMethod]("http" & linePart)
|
|
except ValueError:
|
|
asyncCheck request.respondError(Http400)
|
|
continue
|
|
of 1:
|
|
try:
|
|
parseUri(linePart, request.url)
|
|
except ValueError:
|
|
asyncCheck request.respondError(Http400)
|
|
continue
|
|
of 2:
|
|
try:
|
|
request.protocol = parseProtocol(linePart)
|
|
except ValueError:
|
|
asyncCheck request.respondError(Http400)
|
|
continue
|
|
else:
|
|
await request.respondError(Http400)
|
|
continue
|
|
inc i
|
|
|
|
# Headers
|
|
while true:
|
|
i = 0
|
|
lineFut.mget.setLen(0)
|
|
lineFut.clean()
|
|
await client.recvLineInto(lineFut, maxLength=maxLine)
|
|
|
|
if lineFut.mget == "":
|
|
client.close(); return
|
|
if lineFut.mget.len > maxLine:
|
|
await request.respondError(Http413)
|
|
client.close(); return
|
|
if lineFut.mget == "\c\L": break
|
|
let (key, value) = parseHeader(lineFut.mget)
|
|
request.headers[key] = value
|
|
# Ensure the client isn't trying to DoS us.
|
|
if request.headers.len > headerLimit:
|
|
await client.sendStatus("400 Bad Request")
|
|
request.client.close()
|
|
return
|
|
|
|
if request.reqMethod == HttpPost:
|
|
# Check for Expect header
|
|
if request.headers.hasKey("Expect"):
|
|
if "100-continue" in request.headers["Expect"]:
|
|
await client.sendStatus("100 Continue")
|
|
else:
|
|
await client.sendStatus("417 Expectation Failed")
|
|
|
|
# Read the body
|
|
# - Check for Content-length header
|
|
if request.headers.hasKey("Content-Length"):
|
|
var contentLength = 0
|
|
if parseInt(request.headers["Content-Length"],
|
|
contentLength) == 0:
|
|
await request.respond(Http400, "Bad Request. Invalid Content-Length.")
|
|
continue
|
|
else:
|
|
request.body = await client.recv(contentLength)
|
|
if request.body.len != contentLength:
|
|
await request.respond(Http400, "Bad Request. Content-Length does not match actual.")
|
|
continue
|
|
elif request.reqMethod == HttpPost:
|
|
await request.respond(Http411, "Content-Length required.")
|
|
continue
|
|
|
|
# Call the user's callback.
|
|
await callback(request)
|
|
|
|
if "upgrade" in request.headers.getOrDefault("connection"):
|
|
return
|
|
|
|
# Persistent connections
|
|
if (request.protocol == HttpVer11 and
|
|
request.headers.getOrDefault("connection").normalize != "close") or
|
|
(request.protocol == HttpVer10 and
|
|
request.headers.getOrDefault("connection").normalize == "keep-alive"):
|
|
# In HTTP 1.1 we assume that connection is persistent. Unless connection
|
|
# header states otherwise.
|
|
# In HTTP 1.0 we assume that the connection should not be persistent.
|
|
# Unless the connection header states otherwise.
|
|
discard
|
|
else:
|
|
request.client.close()
|
|
break
|
|
|
|
proc serve*(server: AsyncHttpServer, port: Port,
|
|
callback: proc (request: Request): Future[void] {.closure,gcsafe.},
|
|
address = "") {.async.} =
|
|
## Starts the process of listening for incoming HTTP connections on the
|
|
## specified address and port.
|
|
##
|
|
## When a request is made by a client the specified callback will be called.
|
|
server.socket = newAsyncSocket()
|
|
if server.reuseAddr:
|
|
server.socket.setSockOpt(OptReuseAddr, true)
|
|
if server.reusePort:
|
|
server.socket.setSockOpt(OptReusePort, true)
|
|
server.socket.bindAddr(port, address)
|
|
server.socket.listen()
|
|
|
|
while true:
|
|
# TODO: Causes compiler crash.
|
|
#var (address, client) = await server.socket.acceptAddr()
|
|
var fut = await server.socket.acceptAddr()
|
|
asyncCheck processClient(fut.client, fut.address, callback)
|
|
#echo(f.isNil)
|
|
#echo(f.repr)
|
|
|
|
proc close*(server: AsyncHttpServer) =
|
|
## Terminates the async http server instance.
|
|
server.socket.close()
|
|
|
|
when not defined(testing) and isMainModule:
|
|
proc main =
|
|
var server = newAsyncHttpServer()
|
|
proc cb(req: Request) {.async.} =
|
|
#echo(req.reqMethod, " ", req.url)
|
|
#echo(req.headers)
|
|
let headers = {"Date": "Tue, 29 Apr 2014 23:40:08 GMT",
|
|
"Content-type": "text/plain; charset=utf-8"}
|
|
await req.respond(Http200, "Hello World", headers.newHttpHeaders())
|
|
|
|
asyncCheck server.serve(Port(5555), cb)
|
|
runForever()
|
|
main()
|