1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
|
# Interface to server/loader. The idea is that modules don't have to
# depend on the entire loader implementation to interact with it.
#
# See server/loader for a more detailed description of the protocol.
import std/tables
import config/cookie
import io/dynstream
import io/packetreader
import io/packetwriter
import io/promise
import monoucha/javascript
import monoucha/jserror
import server/headers
import server/request
import server/response
import server/urlfilter
import types/opt
import types/referrer
import types/url
type
FileLoader* = ref object
clientPid*: int
map: seq[MapData]
mapFds*: int # number of fds in map
unregistered*: seq[int]
registerFun*: proc(fd: int)
unregisterFun*: proc(fd: int)
# A mechanism to queue up new fds being added to the poll data
# inside the events iterator.
registerBlocked: bool
registerQueue: seq[ConnectData]
# UNIX domain socket to the loader process.
# We send all messages through this.
controlStream*: SocketStream
ConnectDataState = enum
cdsBeforeResult, cdsBeforeStatus
MapData* = ref object of RootObj
stream*: PosixStream
LoaderData = ref object of MapData
ConnectData* = ref object of LoaderData
state: ConnectDataState
res: int
outputId: int
redirectNum: int
promise: FetchPromise
request: Request
OngoingData* = ref object of LoaderData
response*: Response
LoaderCommand* = enum
lcAddAuth
lcAddCacheFile
lcAddClient
lcAddPipe
lcGetCacheFile
lcLoad
lcLoadConfig
lcOpenCachedItem
lcPassFd
lcRedirectToFile
lcRemoveCachedItem
lcRemoveClient
lcResume
lcShareCachedItem
lcSuspend
lcTee
ClientKey* = array[32, uint8]
LoaderClientConfig* = object
originURL*: URL
cookieJar*: CookieJar
defaultHeaders*: Headers
filter*: URLFilter
proxy*: URL
referrerPolicy*: ReferrerPolicy
insecureSslNoVerify*: bool
cookieMode*: CookieMode
proc getRedirect*(response: Response; request: Request): Request =
if response.status in 301u16..303u16 or response.status in 307u16..308u16:
let location = response.headers.getOrDefault("Location")
let url = parseURL(location, option(request.url))
if url.isSome:
let status = response.status
if status == 303 and request.httpMethod notin {hmGet, hmHead} or
status == 301 or
status == 302 and request.httpMethod == hmPost:
return newRequest(url.get, hmGet)
return newRequest(url.get, request.httpMethod, body = request.body)
return nil
template withPacketWriter(loader: FileLoader; w, body: untyped) =
loader.controlStream.withPacketWriter w:
body
# Sometimes, we can return a value even after the loader crashed.
# This improves reliability of the pager.
template withPacketWriter(loader: FileLoader; w, fallback, body: untyped) =
try:
loader.controlStream.withPacketWriter w:
body
except IOError:
return fallback
template withPacketWriterFire(loader: FileLoader; w, body: untyped) =
try:
loader.controlStream.withPacketWriter w:
body
except IOError:
return
template withPacketReader(loader: FileLoader; r, body: untyped) =
loader.controlStream.withPacketReader r:
body
# Start a request. This should not block (not for a significant amount
# of time anyway).
proc startRequest(loader: FileLoader; request: Request): SocketStream =
loader.withPacketWriter w:
w.swrite(lcLoad)
w.swrite(request)
var success: bool
var fd: cint
loader.withPacketReader r:
r.sread(success)
if success:
fd = r.recvFd()
if success:
let res = newSocketStream(fd)
res.setCloseOnExec()
return res
return nil
proc startRequest*(loader: FileLoader; request: Request;
config: LoaderClientConfig): PosixStream =
loader.withPacketWriter w:
w.swrite(lcLoadConfig)
w.swrite(request)
w.swrite(config)
var fd: cint
loader.withPacketReader r:
fd = r.recvFd()
return newPosixStream(fd)
iterator data*(loader: FileLoader): MapData {.inline.} =
for it in loader.map:
if it != nil:
yield it
iterator ongoing*(loader: FileLoader): OngoingData {.inline.} =
for it in loader.data:
if it of OngoingData:
yield OngoingData(it)
func fd*(data: MapData): int =
return int(data.stream.fd)
proc put*(loader: FileLoader; data: MapData) =
let fd = int(data.stream.fd)
if loader.map.len <= fd:
loader.map.setLen(fd + 1)
assert loader.map[fd] == nil
loader.map[fd] = data
if data of LoaderData:
inc loader.mapFds
proc get*(loader: FileLoader; fd: int): MapData =
if fd < loader.map.len:
return loader.map[fd]
return nil
proc unset*(loader: FileLoader; fd: int) =
if loader.map[fd] != nil and loader.map[fd] of LoaderData:
dec loader.mapFds
loader.map[fd] = nil
proc unset*(loader: FileLoader; data: MapData) =
let fd = int(data.stream.fd)
if loader.get(fd) != nil:
loader.unset(fd)
func hasFds*(loader: FileLoader): bool =
return loader.mapFds > 0 or loader.registerQueue.len > 0
proc register(loader: FileLoader; data: ConnectData) =
if loader.registerBlocked:
loader.registerQueue.add(data)
else:
loader.registerFun(int(data.stream.fd))
loader.put(data)
proc blockRegister*(loader: FileLoader) =
assert not loader.registerBlocked
loader.registerBlocked = true
proc unblockRegister*(loader: FileLoader) =
assert loader.registerBlocked
loader.registerBlocked = false
for it in loader.registerQueue:
loader.register(it)
loader.registerQueue.setLen(0)
proc fetch0(loader: FileLoader; input: Request; promise: FetchPromise;
redirectNum: int) =
let stream = loader.startRequest(input)
loader.register(ConnectData(
promise: promise,
request: input,
stream: stream,
redirectNum: redirectNum
))
proc fetch*(loader: FileLoader; input: Request): FetchPromise =
let promise = FetchPromise()
loader.fetch0(input, promise, 0)
return promise
proc reconnect*(loader: FileLoader; data: ConnectData) =
data.stream.sclose()
let stream = loader.startRequest(data.request)
loader.register(ConnectData(
promise: data.promise,
request: data.request,
stream: stream
))
proc suspend*(loader: FileLoader; fds: seq[int]) =
loader.withPacketWriter w:
w.swrite(lcSuspend)
w.swrite(fds)
proc resume*(loader: FileLoader; fds: openArray[int]) =
loader.withPacketWriter w:
w.swrite(lcResume)
w.swrite(fds)
proc resume*(loader: FileLoader; fds: int) =
loader.resume([fds])
proc tee*(loader: FileLoader; sourceId, targetPid: int): (SocketStream, int) =
loader.withPacketWriter w:
w.swrite(lcTee)
w.swrite(sourceId)
w.swrite(targetPid)
var outputId: int
var fd: cint
loader.withPacketReader r:
r.sread(outputId)
fd = r.recvFd()
return (newSocketStream(fd), outputId)
proc addCacheFile*(loader: FileLoader; outputId: int): int =
loader.withPacketWriter w, -1:
w.swrite(lcAddCacheFile)
w.swrite(outputId)
var cacheId: int
loader.withPacketReader r:
r.sread(cacheId)
return cacheId
proc getCacheFile*(loader: FileLoader; cacheId, sourcePid: int): string =
loader.withPacketWriter w, "":
w.swrite(lcGetCacheFile)
w.swrite(cacheId)
w.swrite(sourcePid)
var s: string
loader.withPacketReader r:
r.sread(s)
return s
proc redirectToFile*(loader: FileLoader; outputId: int; targetPath: string;
displayUrl: URL): bool =
loader.withPacketWriter w, false:
w.swrite(lcRedirectToFile)
w.swrite(outputId)
w.swrite(targetPath)
w.swrite($displayUrl)
var res: bool
loader.withPacketReader r:
r.sread(res)
return res
proc onConnected(loader: FileLoader; connectData: ConnectData) =
let stream = connectData.stream
let promise = connectData.promise
let request = connectData.request
stream.withPacketReader r:
case connectData.state
of cdsBeforeResult:
var res: int
r.sread(res) # packet 1
if res == 0:
r.sread(connectData.outputId) # packet 1
inc connectData.state
else:
var msg: string
# msg is discarded.
#TODO maybe print if called from trusted code (i.e. global == client)?
r.sread(msg) # packet 1
let fd = connectData.fd
loader.unregisterFun(fd)
loader.unregistered.add(fd)
stream.sclose()
# delete before resolving the promise
loader.unset(connectData)
promise.resolve(JSResult[Response].err(newFetchTypeError()))
of cdsBeforeStatus:
let response = newResponse(connectData.res, request, stream,
connectData.outputId)
# packet 2
r.sread(response.status)
r.sread(response.headers)
# Only a stream of the response body may arrive after this point.
response.body = stream
# delete before resolving the promise
loader.unset(connectData)
let data = OngoingData(response: response, stream: stream)
loader.put(data)
assert loader.unregisterFun != nil
response.unregisterFun = proc() =
loader.unset(data)
let fd = data.fd
loader.unregistered.add(fd)
loader.unregisterFun(fd)
response.resumeFun = proc(outputId: int) =
loader.resume(outputId)
stream.setBlocking(false)
let redirect = response.getRedirect(request)
if redirect != nil:
response.unregisterFun()
stream.sclose()
let redirectNum = connectData.redirectNum + 1
if redirectNum < 5: #TODO use config.network.max_redirect?
loader.fetch0(redirect, promise, redirectNum)
else:
promise.resolve(JSResult[Response].err(newFetchTypeError()))
else:
promise.resolve(JSResult[Response].ok(response))
proc onRead*(loader: FileLoader; data: OngoingData) =
let response = data.response
response.onRead(response)
if response.body.isend:
if response.onFinish != nil:
response.onFinish(response, true)
response.onFinish = nil
response.close()
proc onRead*(loader: FileLoader; fd: int) =
let data = loader.map[fd]
if data of ConnectData:
loader.onConnected(ConnectData(data))
else:
loader.onRead(OngoingData(data))
proc onError*(loader: FileLoader; data: OngoingData) =
let response = data.response
if response.onFinish != nil:
response.onFinish(response, false)
response.onFinish = nil
response.close()
proc onError*(loader: FileLoader; fd: int): bool =
let data = loader.map[fd]
if data of ConnectData:
# probably shouldn't happen. TODO
return false
else:
loader.onError(OngoingData(data))
return true
# Note: this blocks until headers are received.
proc doRequest*(loader: FileLoader; request: Request): Response =
let stream = loader.startRequest(request)
let response = Response(url: request.url)
var r = stream.initPacketReader()
r.sread(response.res) # packet 1
if response.res == 0:
r.sread(response.outputId) # packet 1
r = stream.initPacketReader() # packet 2
r.sread(response.status)
r.sread(response.headers)
# Only a stream of the response body may arrive after this point.
response.body = stream
response.resumeFun = proc(outputId: int) =
loader.resume(outputId)
else:
var msg: string
r.sread(msg) # packet 1
stream.sclose()
return response
proc shareCachedItem*(loader: FileLoader; id, targetPid: int; sourcePid = -1):
bool =
let sourcePid = if sourcePid != -1: sourcePid else: loader.clientPid
loader.withPacketWriterFire w:
w.swrite(lcShareCachedItem)
w.swrite(sourcePid)
w.swrite(targetPid)
w.swrite(id)
var success: bool
loader.withPacketReader r:
r.sread(success)
return success
proc openCachedItem*(loader: FileLoader; cacheId: int): PosixStream =
loader.withPacketWriter w, nil:
w.swrite(lcOpenCachedItem)
w.swrite(cacheId)
var fd = cint(-1)
loader.withPacketReader r:
var success: bool
r.sread(success)
if success:
fd = r.recvFd()
if fd != -1:
return newPosixStream(fd)
return nil
proc passFd*(loader: FileLoader; id: string; fd: cint) =
loader.withPacketWriterFire w:
w.swrite(lcPassFd)
w.swrite(id)
w.sendFd(fd)
proc removeCachedItem*(loader: FileLoader; cacheId: int) =
loader.withPacketWriterFire w:
w.swrite(lcRemoveCachedItem)
w.swrite(cacheId)
proc addAuth*(loader: FileLoader; url: URL) =
loader.withPacketWriterFire w:
w.swrite(lcAddAuth)
w.swrite(url)
proc addClient*(loader: FileLoader; pid: int; config: LoaderClientConfig;
clonedFrom: int; isPager = false): SocketStream =
loader.withPacketWriter w:
w.swrite(lcAddClient)
w.swrite(pid)
w.swrite(config)
w.swrite(clonedFrom)
var success: bool
var fd: cint
loader.withPacketReader r:
r.sread(success)
if success and not isPager:
fd = r.recvFd()
if success and not isPager:
return newSocketStream(fd)
return nil
proc removeClient*(loader: FileLoader; pid: int) =
loader.withPacketWriter w:
w.swrite(lcRemoveClient)
w.swrite(pid)
# Equivalent to creating a pipe and passing its read half of it through
# passFd.
proc addPipe*(loader: FileLoader; id: string): PosixStream =
loader.withPacketWriter w:
w.swrite(lcAddPipe)
w.swrite(id)
var fd: cint = -1
loader.withPacketReader r:
var success: bool
r.sread(success)
if success:
fd = r.recvFd()
if fd != -1:
return newPosixStream(fd)
return nil
proc doPipeRequest*(loader: FileLoader; id: string):
tuple[ps: PosixStream; response: Response] =
let ps = loader.addPipe(id)
if ps == nil:
return (nil, nil)
let request = newRequest(newURL("stream:" & id).get)
let response = loader.doRequest(request)
if response.res != 0:
ps.sclose()
return (nil, nil)
return (ps, response)
proc newFileLoader*(clientPid: int; controlStream: SocketStream):
FileLoader =
return FileLoader(
clientPid: clientPid,
controlStream: controlStream
)
|