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
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
1679
1680
1681
1682
1683
1684
1685
1686
1687
1688
1689
1690
1691
1692
1693
1694
1695
1696
1697
1698
1699
1700
1701
1702
1703
1704
1705
1706
1707
1708
1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
1723
1724
1725
1726
1727
1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
1740
1741
1742
1743
1744
1745
1746
1747
1748
1749
1750
1751
1752
1753
1754
1755
1756
1757
1758
1759
1760
1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
1775
1776
1777
1778
1779
1780
1781
1782
1783
1784
1785
1786
1787
1788
1789
1790
1791
1792
1793
1794
1795
1796
1797
1798
1799
1800
1801
1802
1803
1804
1805
1806
1807
1808
1809
1810
1811
1812
1813
1814
1815
1816
1817
1818
1819
1820
1821
1822
1823
1824
1825
1826
1827
1828
1829
1830
1831
1832
1833
1834
1835
1836
1837
1838
1839
1840
1841
1842
1843
1844
1845
1846
1847
1848
1849
1850
1851
1852
1853
1854
1855
1856
1857
1858
1859
1860
1861
1862
1863
1864
1865
1866
1867
1868
1869
1870
1871
1872
|
# A file loader server (?)
# We receive various types of requests on a control socket, then respond
# to each with a response. In case of the "load" request, we return one
# half of a socket pair, and then send connection information before the
# response body so that the protocol looks like:
# C: Request
# S: (packet 1) res (0 => success, _ => error)
# if success:
# S: (packet 1) output ID
# S: (packet 2) status code, headers
# C: resume (on control socket)
# S: response body
# else:
# S: (packet 1) error message
#
# The body is passed to the stream as-is, so effectively nothing can follow it.
#
# Note: if the consumer closes the request's body after headers have been
# passed, it will *not* be cleaned up until a `resume' command is
# received. (This allows for passing outputIds to the pager for later
# addCacheFile commands there.)
import std/algorithm
import std/deques
import std/options
import std/os
import std/posix
import std/strutils
import std/tables
import std/times
import config/config
import config/cookie
import config/urimethodmap
import html/script
import io/dynstream
import io/packetreader
import io/packetwriter
import io/poll
import monoucha/javascript
import server/connecterror
import server/headers
import server/loaderiface
import server/request
import server/urlfilter
import types/formdata
import types/opt
import types/referrer
import types/url
import utils/twtstr
# Try to make it a SmallChunk.
# We must subtract SmallChunk size, and then FreeCell size.
# (See system/alloc.nim for details.)
#TODO measure this on 32-bit too, we get a few more bytes there
const LoaderBufferPageSize = 4016 # 4096 - 64 - 16
# Override posix.Time
type Time = times.Time
type
CachedItem = ref object
id: int
refc: int
offset: int64
path: string
LoaderBuffer = ref object
len: int
page: seq[uint8]
LoaderHandle = ref object of RootObj
registered: bool # track registered state
stream: PosixStream # input/output stream depending on type
url: URL # URL nominally retrieved by handle before rewrites
InputHandle = ref object of LoaderHandle
outputs: seq[OutputHandle] # list of outputs to be streamed into
cacheId: int # if cached, our ID in a client cacheMap
cacheRef: CachedItem # if this is a tocache handle, a ref to our cache item
parser: HeaderParser # only exists for CGI handles
rstate: ResponseState # track response state
credentials: bool # normalized to "include" (true) or "omit" (false)
contentLen: uint64 # value of Content-Length; uint64.high if no such header
bytesSeen: uint64 # number of bytes read until now
startTime: Time # time when download of the body was started
OutputHandle = ref object of LoaderHandle
parent: InputHandle
currentBuffer: LoaderBuffer
currentBufferIdx: int
buffers: Deque[LoaderBuffer]
owner: ClientHandle
outputId: int
istreamAtEnd: bool
suspended: bool
dead: bool
bytesSent: uint64
HandleParserState = enum
hpsBeforeLines, hpsAfterFirstLine, hpsControlDone
HeaderParser = ref object
state: HandleParserState
crSeen: bool
status: uint16
lineBuffer: string
headers: Headers
ResponseState = enum
rsBeforeResult, rsAfterFailure, rsBeforeStatus, rsAfterHeaders
AuthItem = ref object
origin: Origin
username: string
password: string
ClientHandle = ref object of LoaderHandle
pid: int
# List of cached resources.
cacheMap: seq[CachedItem]
# List of file descriptors passed by the client.
passedFdMap: seq[tuple[name: string; ps: PosixStream]] # host -> ps
config: LoaderClientConfig
# List of credentials the client has access to (same origin only).
authMap: seq[AuthItem]
DownloadItem = ref object
path: string
displayUrl: string
output: OutputHandle
sent: uint64
contentLen: uint64
startTime: Time
LoaderContext = object
pid: int
pagerClient: ClientHandle
forkStream: SocketStream # handle to the fork server
config: LoaderConfig
handleMap: seq[LoaderHandle]
pollData: PollData
tmpfSeq: uint
# List of existing clients (buffer or pager) that may make requests.
clientMap: Table[int, ClientHandle] # pid -> data
# ID of next output. TODO: find a better allocation scheme
outputNum: int
# List of *all* credentials the loader knows of.
authMap: seq[AuthItem]
# Handles to unregister and close at the end of this iteration.
# This is needed so that we don't accidentally replace them with new
# streams in the same iteration as they got closed.
unregRead: seq[InputHandle]
unregWrite: seq[OutputHandle]
unregClient: seq[ClientHandle]
downloadList: seq[DownloadItem]
cookieStream: OutputHandle
LoaderConfig* = object
cgiDir*: seq[string]
uriMethodMap*: URIMethodMap
w3mCGICompat*: bool
tmpdir*: string
configdir*: string
bookmark*: string
PushBufferResult = enum
pbrDone, pbrUnregister
proc pushBuffer(ctx: var LoaderContext; output: OutputHandle;
buffer: LoaderBuffer; ignoreSuspension: bool): PushBufferResult
when defined(debug):
func `$`*(buffer: LoaderBuffer): string =
var s = newString(buffer.len)
copyMem(addr s[0], addr buffer.page[0], buffer.len)
return s
proc put(ctx: var LoaderContext; handle: LoaderHandle) =
let fd = int(handle.stream.fd)
if ctx.handleMap.len <= fd:
ctx.handleMap.setLen(fd + 1)
assert ctx.handleMap[fd] == nil
ctx.handleMap[fd] = handle
proc unset(ctx: var LoaderContext; handle: LoaderHandle) =
assert not handle.registered
let fd = int(handle.stream.fd)
if fd < ctx.handleMap.len:
ctx.handleMap[fd] = nil
proc getOutputId(ctx: var LoaderContext): int =
result = ctx.outputNum
inc ctx.outputNum
# Create a new loader handle, with the output stream ostream.
proc newInputHandle(ctx: var LoaderContext; ostream: PosixStream;
owner: ClientHandle; url: URL; credentials: bool; suspended = true):
InputHandle =
let handle = InputHandle(
cacheId: -1,
contentLen: uint64.high,
url: url,
credentials: credentials
)
let output = OutputHandle(
stream: ostream,
parent: handle,
outputId: ctx.getOutputId(),
owner: owner,
url: url,
suspended: suspended
)
ctx.put(output)
handle.outputs.add(output)
return handle
func cap(buffer: LoaderBuffer): int {.inline.} =
return LoaderBufferPageSize
template isEmpty(output: OutputHandle): bool =
output.currentBuffer == nil and not output.suspended
proc newLoaderBuffer(size = LoaderBufferPageSize): LoaderBuffer =
return LoaderBuffer(page: newSeqUninit[uint8](size))
proc newLoaderBuffer(s: openArray[char]): LoaderBuffer =
let buffer = newLoaderBuffer(s.len)
buffer.len = s.len
copyMem(addr buffer.page[0], unsafeAddr s[0], s.len)
buffer
proc bufferCleared(output: OutputHandle) =
assert output.currentBuffer != nil
output.currentBufferIdx = 0
if output.buffers.len > 0:
output.currentBuffer = output.buffers.popFirst()
else:
output.currentBuffer = nil
proc tee(ctx: var LoaderContext; outputIn: OutputHandle; ostream: PosixStream;
owner: ClientHandle): OutputHandle =
assert outputIn.suspended
let output = OutputHandle(
parent: outputIn.parent,
stream: ostream,
currentBuffer: outputIn.currentBuffer,
currentBufferIdx: outputIn.currentBufferIdx,
buffers: outputIn.buffers,
istreamAtEnd: outputIn.istreamAtEnd,
outputId: ctx.getOutputId(),
owner: owner,
suspended: outputIn.suspended,
url: outputIn.url
)
ctx.put(output)
if outputIn.parent != nil:
assert outputIn.parent.parser == nil
outputIn.parent.outputs.add(output)
return output
template output(handle: InputHandle): OutputHandle =
assert handle.outputs.len == 1
handle.outputs[0]
template bufferFromWriter(w, body: untyped): LoaderBuffer =
var w = initPacketWriter()
body
w.writeSize()
LoaderBuffer(page: move(w.buffer), len: w.bufLen)
proc sendResult(ctx: var LoaderContext; handle: InputHandle; res: int;
msg = ""): PushBufferResult =
assert handle.rstate == rsBeforeResult
let output = handle.output
inc handle.rstate
let buffer = bufferFromWriter w:
w.swrite(res)
if res == 0: # success
assert msg == ""
w.swrite(output.outputId)
inc handle.rstate
else: # error
w.swrite(msg)
return ctx.pushBuffer(output, buffer, ignoreSuspension = true)
proc updateCookies(ctx: var LoaderContext; cookieJar: CookieJar;
url: URL; owner: ClientHandle; values: openArray[string]) =
# Syntax: {jarId} RS {url} RS {persist?} RS {header} [ CR {header} ... ] LF
# Persist is ASCII digit 0 if persist, 1 if not.
const RS = '\x1E' # ASCII record separator
let persist = if owner.config.cookieMode == cmSave: '1' else: '0'
var s = cookieJar.name & RS & $url & RS & persist & RS
for i, it in values.mypairs:
s &= it & [false: '\r', true: '\n'][i == values.high]
let buffer = newLoaderBuffer(s)
case ctx.pushBuffer(ctx.cookieStream, buffer, ignoreSuspension = false)
of pbrDone: discard
of pbrUnregister:
ctx.unregWrite.add(ctx.cookieStream)
ctx.cookieStream.dead = true
ctx.cookieStream = nil
proc sendStatus(ctx: var LoaderContext; handle: InputHandle; status: uint16;
headers: Headers): PushBufferResult =
assert handle.rstate == rsBeforeStatus
inc handle.rstate
let contentLens = headers.getOrDefault("Content-Length")
handle.startTime = getTime()
handle.contentLen = parseUInt64(contentLens).get(uint64.high)
let output = handle.output
let cookieJar = output.owner.config.cookieJar
if cookieJar != nil and handle.credentials:
# Never persist in loader; we save cookies in the pager.
let values = headers.getAllNoComma("Set-Cookie")
if values.len > 0:
cookieJar.setCookie(values, handle.url, persist = false)
if ctx.cookieStream != nil:
ctx.updateCookies(cookieJar, handle.url, output.owner, values)
let buffer = bufferFromWriter w:
w.swrite(status)
w.swrite(headers)
return ctx.pushBuffer(output, buffer, ignoreSuspension = true)
proc writeData(ps: PosixStream; buffer: LoaderBuffer; si = 0): int {.inline.} =
assert buffer.len - si > 0
return ps.writeData(addr buffer.page[si], buffer.len - si)
proc iclose(ctx: var LoaderContext; handle: InputHandle) =
if handle.stream != nil:
ctx.unset(handle)
handle.stream.sclose()
handle.stream = nil
proc oclose(ctx: var LoaderContext; output: OutputHandle) =
ctx.unset(output)
output.stream.sclose()
output.stream = nil
proc close(ctx: var LoaderContext; handle: InputHandle) =
ctx.iclose(handle)
for output in handle.outputs:
if output.stream != nil:
ctx.oclose(output)
proc close(ctx: var LoaderContext; client: ClientHandle) =
# Do *not* unset the client, that breaks temp-file cleanup.
client.stream.sclose()
client.stream = nil
for it in client.cacheMap:
dec it.refc
if it.refc == 0:
discard unlink(cstring(it.path))
func isPrivileged(ctx: LoaderContext; client: ClientHandle): bool =
return ctx.pagerClient == client
#TODO this may be too low if we want to use urimethodmap for everything
const MaxRewrites = 4
func canRewriteForCGICompat(ctx: LoaderContext; path: string): bool =
if path.startsWith("/cgi-bin/") or path.startsWith("/$LIB/"):
return true
for dir in ctx.config.cgiDir:
if path.startsWith(dir):
return true
return false
proc rejectHandle(ctx: var LoaderContext; handle: InputHandle;
code: ConnectionError; msg = "") =
case ctx.sendResult(handle, code, msg)
of pbrDone: discard
of pbrUnregister:
ctx.unregWrite.add(handle.output)
handle.output.dead = true
iterator inputHandles(ctx: LoaderContext): InputHandle {.inline.} =
for it in ctx.handleMap:
if it != nil and it of InputHandle:
yield InputHandle(it)
iterator outputHandles(ctx: LoaderContext): OutputHandle {.inline.} =
for it in ctx.handleMap:
if it != nil and it of OutputHandle:
yield OutputHandle(it)
func findOutput(ctx: var LoaderContext; id: int;
client: ClientHandle): OutputHandle =
assert id != -1
for it in ctx.outputHandles:
if it.outputId == id:
# verify that it's safe to access this handle.
doAssert ctx.isPrivileged(client) or client == it.owner
return it
return nil
func findCachedHandle(ctx: LoaderContext; cacheId: int): InputHandle =
assert cacheId != -1
for it in ctx.inputHandles:
if it.cacheId == cacheId:
return it
return nil
func find(cacheMap: openArray[CachedItem]; id: int): int =
for i, it in cacheMap.mypairs:
if it.id == id:
return i
-1
proc register(ctx: var LoaderContext; handle: InputHandle) =
assert not handle.registered
ctx.pollData.register(handle.stream.fd, cshort(POLLIN))
handle.registered = true
proc unregister(ctx: var LoaderContext; handle: InputHandle) =
assert handle.registered
ctx.pollData.unregister(int(handle.stream.fd))
handle.registered = false
proc register(ctx: var LoaderContext; output: OutputHandle) =
assert not output.registered
ctx.pollData.register(int(output.stream.fd), cshort(POLLOUT))
output.registered = true
proc unregister(ctx: var LoaderContext; output: OutputHandle) =
assert output.registered
ctx.pollData.unregister(int(output.stream.fd))
output.registered = false
proc register(ctx: var LoaderContext; client: ClientHandle) =
assert not client.registered
ctx.clientMap[client.pid] = client
ctx.pollData.register(client.stream.fd, cshort(POLLIN))
client.registered = true
proc unregister(ctx: var LoaderContext; client: ClientHandle) =
assert client.registered
ctx.clientMap.del(client.pid)
ctx.pollData.unregister(int(client.stream.fd))
client.registered = false
# Either write data to the target output, or append it to the list of
# buffers to write and register the output in our selector.
# ignoreSuspension is meant to be used when sending the connection
# result and headers, which are sent irrespective of whether the handle
# is suspended or not.
proc pushBuffer(ctx: var LoaderContext; output: OutputHandle;
buffer: LoaderBuffer; ignoreSuspension: bool): PushBufferResult =
if output.suspended and not ignoreSuspension:
if output.currentBuffer == nil:
output.currentBuffer = buffer
output.currentBufferIdx = 0
else:
output.buffers.addLast(buffer)
elif output.currentBuffer == nil:
var n = output.stream.writeData(buffer)
if n < 0:
let e = errno
if e == EAGAIN or e == EWOULDBLOCK:
n = 0
else:
assert e == EPIPE, $strerror(e)
return pbrUnregister
else:
output.bytesSent += uint64(n)
if n < buffer.len:
output.currentBuffer = buffer
output.currentBufferIdx = n
ctx.register(output)
else:
output.buffers.addLast(buffer)
pbrDone
proc redirectToFile(ctx: var LoaderContext; output: OutputHandle;
targetPath: string; fileOutput: out OutputHandle; osent: out uint64): bool =
fileOutput = nil
osent = 0
discard mkdir(cstring(ctx.config.tmpdir), 0o700)
let ps = newPosixStream(targetPath, O_CREAT or O_WRONLY or O_TRUNC, 0o600)
if ps == nil:
return false
if output.currentBuffer != nil:
var m = output.currentBufferIdx
while m < output.currentBuffer.len:
let n = ps.writeData(output.currentBuffer, m)
if n <= 0:
ps.sclose()
return false
m += n
osent += uint64(n)
for buffer in output.buffers:
var m = 0
while m < buffer.len:
let n = ps.writeData(buffer, m)
if n <= 0:
ps.sclose()
return false
m += n
osent += uint64(n)
if output.istreamAtEnd:
ps.sclose()
elif output.parent != nil:
fileOutput = OutputHandle(
parent: output.parent,
stream: ps,
istreamAtEnd: output.istreamAtEnd,
outputId: ctx.getOutputId(),
bytesSent: osent,
url: output.url
)
output.parent.outputs.add(fileOutput)
return true
proc getTempFile(ctx: var LoaderContext): string =
result = ctx.config.tmpdir / "chaltmp" & $ctx.pid & "-" & $ctx.tmpfSeq
inc ctx.tmpfSeq
proc addCacheFile(ctx: var LoaderContext; client: ClientHandle;
output: OutputHandle): int =
if output.parent != nil and output.parent.cacheId != -1:
# may happen e.g. if client tries to cache a `cache:' URL
return output.parent.cacheId
let tmpf = ctx.getTempFile()
var dummy: OutputHandle
var sent: uint64
if ctx.redirectToFile(output, tmpf, dummy, sent):
let cacheId = output.outputId
if output.parent != nil:
output.parent.cacheId = cacheId
client.cacheMap.add(CachedItem(id: cacheId, path: tmpf, refc: 1))
return cacheId
return -1
proc openCachedItem(client: ClientHandle; id: int): (PosixStream, int) =
let n = client.cacheMap.find(id)
if n != -1:
let item = client.cacheMap[n]
let ps = newPosixStream(client.cacheMap[n].path, O_RDONLY, 0)
if ps == nil:
client.cacheMap.del(n)
return (nil, -1)
assert item.offset != -1
if ps.seek(item.offset) >= 0:
return (ps, n)
return (nil, -1)
proc addFd(ctx: var LoaderContext; handle: InputHandle) =
handle.stream.setBlocking(false)
ctx.register(handle)
ctx.put(handle)
type ControlResult = enum
crDone, crContinue, crError
proc handleFirstLine(ctx: var LoaderContext; handle: InputHandle; line: string):
ControlResult =
if line.startsWithIgnoreCase("HTTP/1.0") or
line.startsWithIgnoreCase("HTTP/1.1"):
let codes = line.until(' ', "HTTP/1.0 ".len)
let code = parseUInt16(codes)
if codes.len > 3 or code.isNone:
ctx.rejectHandle(handle, ceCGIMalformedHeader)
return crError
case ctx.sendResult(handle, 0) # Success
of pbrDone: discard
of pbrUnregister: return crError
handle.parser.status = code.get
return crDone
let k = line.until(':')
if k.len == line.len:
# invalid
ctx.rejectHandle(handle, ceCGIMalformedHeader)
return crError
let v = line.substr(k.len + 1).strip()
if k.equalsIgnoreCase("Status"):
case ctx.sendResult(handle, 0) # success
of pbrDone: discard
of pbrUnregister: return crError
let code = parseUInt16(v)
if v.len > 3 or code.isNone:
ctx.rejectHandle(handle, ceCGIMalformedHeader)
return crError
handle.parser.status = code.get
return crContinue
if k.equalsIgnoreCase("Cha-Control"):
if v.startsWithIgnoreCase("Connected"):
case ctx.sendResult(handle, 0) # success
of pbrDone: discard
of pbrUnregister: return crError
return crContinue
if v.startsWithIgnoreCase("ConnectionError"):
let errs = v.split(' ')
var code = ceCGIInvalidChaControl
var message = ""
if errs.len > 1:
if (let x = parseInt32(errs[1]); x.isSome):
let n = x.get
if n > 0 and n <= int32(ConnectionError.high):
code = ConnectionError(x.get)
elif (let x = strictParseEnum[ConnectionError](errs[1]);
x.get(ceNone) != ceNone):
code = x.get
if errs.len > 2:
message &= errs[2]
for i in 3 ..< errs.len:
message &= ' '
message &= errs[i]
ctx.rejectHandle(handle, code, message)
return crError
if v.startsWithIgnoreCase("ControlDone"):
case ctx.sendResult(handle, 0) # success
of pbrDone: discard
of pbrUnregister: return crError
return crDone
ctx.rejectHandle(handle, ceCGIInvalidChaControl)
return crError
case ctx.sendResult(handle, 0) # success
of pbrDone: discard
of pbrUnregister: return crError
handle.parser.headers.add(k, v)
return crDone
proc handleControlLine(handle: InputHandle; line: string): ControlResult =
let k = line.until(':')
if k.len == line.len:
# invalid
return crError
let v = line.substr(k.len + 1).strip()
if k.equalsIgnoreCase("Status"):
let code = parseUInt16(v)
if v.len > 3 or code.isNone:
return crError
handle.parser.status = parseUInt16(v).get(0)
return crContinue
if k.equalsIgnoreCase("Cha-Control"):
if v.startsWithIgnoreCase("ControlDone"):
return crDone
return crError
handle.parser.headers.add(k, v)
return crDone
proc handleLine(handle: InputHandle; line: string) =
let k = line.until(':')
if k.len < line.len:
let v = line.substr(k.len + 1).strip()
handle.parser.headers.add(k, v)
proc parseHeaders0(ctx: var LoaderContext; handle: InputHandle;
data: openArray[char]): int =
let parser = handle.parser
for i, c in data:
template die =
handle.parser = nil
return -1
if parser.crSeen and c != '\n':
die
parser.crSeen = false
if c == '\r':
parser.crSeen = true
elif c == '\n':
if parser.lineBuffer == "":
if parser.state == hpsBeforeLines:
# body comes immediately, so we haven't had a chance to send result
# yet.
case ctx.sendResult(handle, 0)
of pbrDone: discard
of pbrUnregister: die
let res = ctx.sendStatus(handle, parser.status, parser.headers)
handle.parser = nil
return case res
of pbrDone: i + 1 # +1 to skip \n
of pbrUnregister: -1
case parser.state
of hpsBeforeLines:
case ctx.handleFirstLine(handle, parser.lineBuffer)
of crDone: parser.state = hpsControlDone
of crContinue: parser.state = hpsAfterFirstLine
of crError: die
of hpsAfterFirstLine:
case handle.handleControlLine(parser.lineBuffer)
of crDone: parser.state = hpsControlDone
of crContinue: discard
of crError:
discard ctx.sendStatus(handle, 500, parser.headers)
die
of hpsControlDone:
handle.handleLine(parser.lineBuffer)
parser.lineBuffer = ""
else:
parser.lineBuffer &= c
return data.len
proc parseHeaders(ctx: var LoaderContext; handle: InputHandle;
buffer: LoaderBuffer): int =
if buffer == nil:
return ctx.parseHeaders0(handle, ['\n'])
let p = cast[ptr UncheckedArray[char]](addr buffer.page[0])
return ctx.parseHeaders0(handle, p.toOpenArray(0, buffer.len - 1))
proc finishParse(ctx: var LoaderContext; handle: InputHandle) =
if handle.cacheRef != nil:
assert handle.cacheRef.offset == -1
let ps = newPosixStream(handle.cacheRef.path, O_RDONLY, 0)
if ps != nil:
var buffer {.noinit.}: array[4096, char]
var off = 0i64
while true:
let n = ps.readData(buffer)
if n <= 0:
assert n == 0 or errno != EBADF
break
let pn = ctx.parseHeaders0(handle, buffer.toOpenArray(0, n - 1))
if pn == -1:
break
off += int64(pn)
if pn < n:
handle.parser = nil
break
handle.cacheRef.offset = off
ps.sclose()
handle.cacheRef = nil
if handle.parser != nil:
discard ctx.parseHeaders(handle, nil)
type HandleReadResult = enum
hrrDone, hrrUnregister, hrrBrokenPipe
# Called whenever there is more data available to read.
proc handleRead(ctx: var LoaderContext; handle: InputHandle;
unregWrite: var seq[OutputHandle]): HandleReadResult =
var unregs = 0
let maxUnregs = handle.outputs.len
while true:
var buffer = newLoaderBuffer()
let n = handle.stream.readData(buffer.page)
if n < 0:
let e = errno
if e == EAGAIN or e == EWOULDBLOCK: # retry later
break
else: # sender died; stop streaming
assert e == EPIPE, $strerror(e)
return hrrBrokenPipe
if n == 0: # EOF
return hrrUnregister
buffer.len = n
var si = 0
if handle.parser != nil:
si = ctx.parseHeaders(handle, buffer)
if si == -1: # died while parsing headers; unregister
return hrrUnregister
if si == n: # parsed the entire buffer as headers; skip output handling
continue
if si != 0:
# Some parts of the buffer have been consumed as headers; others
# must be passed on to the client.
# We *could* store si as an offset to the buffer, but it would
# make things much more complex. Let's just do this:
let nlen = buffer.len - si
let nbuffer = newLoaderBuffer(nlen)
nbuffer.len = nlen
copyMem(addr nbuffer.page[0], addr buffer.page[si], nbuffer.len)
buffer = nbuffer
assert nbuffer.len != 0, $si & ' ' & $buffer.len & " n " & $n
else:
handle.bytesSeen += uint64(n)
#TODO stop reading if Content-Length exceeded
for output in handle.outputs:
if output.dead:
# do not push to unregWrite candidates
continue
case ctx.pushBuffer(output, buffer, ignoreSuspension = false)
of pbrUnregister:
output.dead = true
unregWrite.add(output)
inc unregs
of pbrDone: discard
if unregs == maxUnregs:
# early return: no more outputs to write to
break
if n < buffer.cap:
break
hrrDone
# stream is a regular file, so we can't select on it.
#
# cachedHandle is used for attaching the output handle to another
# InputHandle when loadFromCache is called while a download is still
# ongoing (and thus some parts of the document are not cached yet).
proc loadStreamRegular(ctx: var LoaderContext;
handle, cachedHandle: InputHandle) =
assert handle.parser == nil # parser is only used with CGI
var unregWrite: seq[OutputHandle] = @[]
let r = ctx.handleRead(handle, unregWrite)
for output in unregWrite:
output.parent = nil
let i = handle.outputs.find(output)
if output.registered:
ctx.unregister(output)
handle.outputs.del(i)
for output in handle.outputs:
if r == hrrBrokenPipe:
ctx.oclose(output)
elif cachedHandle != nil:
output.parent = cachedHandle
cachedHandle.outputs.add(output)
elif output.registered or output.suspended:
output.parent = nil
output.istreamAtEnd = true
else:
ctx.oclose(output)
handle.outputs.setLen(0)
ctx.iclose(handle)
proc findItem(authMap: seq[AuthItem]; origin: Origin): AuthItem =
for it in authMap:
if origin.isSameOrigin(it.origin):
return it
return nil
proc includeCredentials(config: LoaderClientConfig; request: Request; url: URL):
bool =
return request.credentialsMode == cmInclude or
request.credentialsMode == cmSameOrigin and
config.originURL == nil or
url.origin.isSameOrigin(config.originURL.origin)
proc findAuth(client: ClientHandle; request: Request; url: URL): AuthItem =
if "Authorization" notin request.headers and
client.config.includeCredentials(request, url):
if client.authMap.len > 0:
return client.authMap.findItem(url.authOrigin)
return nil
proc putMappedURL(s: var seq[tuple[name, value: string]]; url: URL;
auth: AuthItem) =
s.add(("MAPPED_URI_SCHEME", url.scheme))
if auth != nil:
s.add(("MAPPED_URI_USERNAME", auth.username))
s.add(("MAPPED_URI_PASSWORD", auth.password))
s.add(("MAPPED_URI_HOST", url.hostname))
s.add(("MAPPED_URI_PORT", url.port))
s.add(("MAPPED_URI_PATH", url.pathname))
s.add(("MAPPED_URI_QUERY", url.search.substr(1)))
type CGIPath = object
basename: string
pathInfo: string
cmd: string
scriptName: string
requestURI: string
myDir: string
proc setupEnv(cpath: CGIPath; request: Request; contentLen: int; prevURL: URL;
config: LoaderClientConfig; auth: AuthItem):
seq[tuple[name, value: string]] =
result = @[]
let url = request.url
result.add(("SCRIPT_NAME", cpath.scriptName))
result.add(("SCRIPT_FILENAME", cpath.cmd))
result.add(("REQUEST_URI", cpath.requestURI))
result.add(("REQUEST_METHOD", $request.httpMethod))
var headers = ""
for k, v in request.headers.allPairs:
headers &= k & ": " & v & "\r\n"
result.add(("REQUEST_HEADERS", headers))
if prevURL != nil:
result.putMappedURL(prevURL, auth)
if cpath.pathInfo != "":
result.add(("PATH_INFO", cpath.pathInfo))
if url.search != "":
result.add(("QUERY_STRING", url.search.substr(1)))
if request.httpMethod == hmPost:
if request.body.t == rbtMultipart:
result.add(("CONTENT_TYPE", request.body.multipart.getContentType()))
else:
let contentType = request.headers.getOrDefault("Content-Type")
result.add(("CONTENT_TYPE", contentType))
result.add(("CONTENT_LENGTH", $contentLen))
let cookie = request.headers.getOrDefault("Cookie")
if cookie != "":
result.add(("HTTP_COOKIE", cookie))
let referer = request.headers.getOrDefault("Referer")
if referer != "":
result.add(("HTTP_REFERER", referer))
if config.proxy != nil:
result.add(("ALL_PROXY", $config.proxy))
if config.insecureSslNoVerify:
result.add(("CHA_INSECURE_SSL_NO_VERIFY", "1"))
proc parseCGIPath(ctx: LoaderContext; request: Request): CGIPath =
var path = percentDecode(request.url.pathname)
if path.startsWith("/cgi-bin/"):
path.delete(0 .. "/cgi-bin/".high)
elif path.startsWith("/$LIB/"):
path.delete(0 .. "/$LIB/".high)
var cpath = CGIPath()
if path == "" or request.url.hostname != "":
return cpath
if path[0] == '/':
for dir in ctx.config.cgiDir:
if path.startsWith(dir):
cpath.basename = path.substr(dir.len).until('/')
cpath.pathInfo = path.substr(dir.len + cpath.basename.len)
cpath.cmd = dir / cpath.basename
if not fileExists(cpath.cmd):
continue
cpath.myDir = dir
cpath.scriptName = path.substr(0, dir.len + cpath.basename.len)
cpath.requestURI = cpath.cmd / cpath.pathInfo & request.url.search
break
else:
cpath.basename = path.until('/')
cpath.pathInfo = path.substr(cpath.basename.len)
cpath.scriptName = "/cgi-bin/" & cpath.basename
cpath.requestURI = "/cgi-bin/" & path & request.url.search
for dir in ctx.config.cgiDir:
cpath.cmd = dir / cpath.basename
if fileExists(cpath.cmd):
cpath.myDir = dir
break
return cpath
proc loadCGI(ctx: var LoaderContext; client: ClientHandle; handle: InputHandle;
request: Request; prevURL: URL; config: LoaderClientConfig) =
let cpath = ctx.parseCGIPath(request)
if cpath.cmd == "" or cpath.basename in ["", ".", ".."] or
cpath.basename[0] == '~':
ctx.rejectHandle(handle, ceInvalidCGIPath)
return
if not fileExists(cpath.cmd):
ctx.rejectHandle(handle, ceCGIFileNotFound)
return
# Pipe the response body as stdout.
var pipefd: array[2, cint] # child -> parent
if pipe(pipefd) == -1:
ctx.rejectHandle(handle, ceFailedToSetUpCGI)
return
let istreamOut = newPosixStream(pipefd[0]) # read by loader
var ostreamOut = newPosixStream(pipefd[1]) # written by child
var ostreamOut2: PosixStream = nil
if request.tocache:
# Set stdout to a file, and repurpose the pipe as a dummy to detect when
# the process ends. outputId is the cache id.
let tmpf = ctx.getTempFile()
ostreamOut2 = ostreamOut
# RDWR, otherwise mmap won't work
ostreamOut = newPosixStream(tmpf, O_CREAT or O_RDWR, 0o600)
if ostreamOut == nil:
ctx.rejectHandle(handle, ceCGIFailedToOpenCacheOutput)
return
let cacheId = handle.output.outputId # welp
let item = CachedItem(
id: cacheId,
path: tmpf,
refc: 1,
offset: -1
)
handle.cacheRef = item
client.cacheMap.add(item)
# Pipe the request body as stdin for POST.
var istream: PosixStream = nil # child end (read)
var ostream: PosixStream = nil # parent end (write)
var istream2: PosixStream = nil # child end (read) for rbtCache
var cachedHandle: InputHandle = nil # for rbtCache
var outputIn: OutputHandle = nil # for rbtOutput
if request.body.t == rbtCache:
var n: int
(istream, n) = client.openCachedItem(request.body.cacheId)
if istream == nil:
ctx.rejectHandle(handle, ceCGICachedBodyNotFound)
return
cachedHandle = ctx.findCachedHandle(request.body.cacheId)
if cachedHandle != nil: # cached item still open, switch to streaming mode
if client.cacheMap[n].offset == -1:
ctx.rejectHandle(handle, ceCGICachedBodyUnavailable)
return
istream2 = istream
elif request.body.t == rbtOutput:
outputIn = ctx.findOutput(request.body.outputId, client)
if outputIn == nil:
ctx.rejectHandle(handle, ceCGIOutputHandleNotFound)
return
if request.body.t in {rbtString, rbtMultipart, rbtOutput} or
request.body.t == rbtCache and istream2 != nil:
var pipefdRead: array[2, cint] # parent -> child
if pipe(pipefdRead) == -1:
ctx.rejectHandle(handle, ceFailedToSetUpCGI)
return
istream = newPosixStream(pipefdRead[0])
ostream = newPosixStream(pipefdRead[1])
let contentLen = request.body.contentLength()
let auth = if prevURL != nil: client.findAuth(request, prevURL) else: nil
let env = setupEnv(cpath, request, contentLen, prevURL, config, auth)
var pid: int
try:
let istream3 = if istream != nil: nil else: newPosixStream("/dev/null")
ctx.forkStream.withPacketWriter w:
if istream != nil:
w.sendFd(istream.fd)
else:
w.sendFd(istream3.fd)
w.sendFd(ostreamOut.fd)
w.swrite(ostreamOut2 != nil)
if ostreamOut2 != nil:
w.sendFd(ostreamOut2.fd)
w.swrite(env)
w.swrite(cpath.myDir)
w.swrite(cpath.cmd)
w.swrite(cpath.basename)
if istream3 != nil:
istream3.sclose()
ctx.forkStream.withPacketReader r:
r.sread(pid)
except EOFError:
pid = -1
ostreamOut.sclose() # close write
if ostreamOut2 != nil:
ostreamOut2.sclose() # close write
if request.body.t != rbtNone:
istream.sclose() # close read
if pid == -1:
ctx.rejectHandle(handle, ceFailedToSetUpCGI)
if ostream != nil:
ostream.sclose()
else:
handle.parser = HeaderParser(headers: newHeaders(hgResponse))
handle.stream = istreamOut
case request.body.t
of rbtString:
ostream.write(request.body.s)
ostream.sclose()
of rbtMultipart:
let boundary = request.body.multipart.boundary
for entry in request.body.multipart.entries:
ostream.writeEntry(entry, boundary)
ostream.writeEnd(boundary)
ostream.sclose()
of rbtOutput:
ostream.setBlocking(false)
let output = ctx.tee(outputIn, ostream, client)
output.suspended = false
if not output.isEmpty:
ctx.register(output)
of rbtCache:
if ostream != nil:
let handle = ctx.newInputHandle(ostream, client,
newURL("cache:/dev/null").get, credentials = false, suspended = false)
handle.stream = istream2
ostream.setBlocking(false)
ctx.loadStreamRegular(handle, cachedHandle)
assert handle.stream == nil
ctx.close(handle)
of rbtNone:
discard
func findPassedFd(client: ClientHandle; name: string): int =
for i in 0 ..< client.passedFdMap.len:
if client.passedFdMap[i].name == name:
return i
return -1
proc loadStream(ctx: var LoaderContext; client: ClientHandle;
handle: InputHandle; request: Request) =
let i = client.findPassedFd(request.url.pathname)
if i == -1:
ctx.rejectHandle(handle, ceFileNotFound, "stream not found")
return
case ctx.sendResult(handle, 0)
of pbrDone: discard
of pbrUnregister: return
case ctx.sendStatus(handle, 200, newHeaders(hgResponse))
of pbrDone: discard
of pbrUnregister: return
let ps = client.passedFdMap[i].ps
var stats: Stat
doAssert fstat(ps.fd, stats) != -1
handle.stream = ps
client.passedFdMap.del(i)
if S_ISCHR(stats.st_mode) or S_ISREG(stats.st_mode):
# regular file: e.g. cha <file
# or character device: e.g. cha </dev/null
handle.output.stream.setBlocking(false)
# not loading from cache, so cachedHandle is nil
ctx.loadStreamRegular(handle, nil)
proc loadFromCache(ctx: var LoaderContext; client: ClientHandle;
handle: InputHandle; request: Request) =
let id = parseInt32(request.url.pathname).get(-1)
let startFrom = parseInt64(request.url.search.substr(1)).get(0)
let (ps, n) = client.openCachedItem(id)
if ps != nil:
if startFrom != 0:
discard ps.seek(startFrom)
handle.stream = ps
if ps == nil:
ctx.rejectHandle(handle, ceFileNotInCache)
client.cacheMap.del(n)
return
case ctx.sendResult(handle, 0)
of pbrDone: discard
of pbrUnregister:
client.cacheMap.del(n)
ctx.close(handle)
return
case ctx.sendStatus(handle, 200, newHeaders(hgResponse))
of pbrDone: discard
of pbrUnregister:
client.cacheMap.del(n)
ctx.close(handle)
return
handle.output.stream.setBlocking(false)
let cachedHandle = ctx.findCachedHandle(id)
ctx.loadStreamRegular(handle, cachedHandle)
else:
ctx.rejectHandle(handle, ceURLNotInCache)
# Data URL handler.
# Moved back into loader from CGI, because data URLs can get extremely long
# and thus no longer fit into the environment.
proc loadDataSend(ctx: var LoaderContext; handle: InputHandle; s, ct: string) =
case ctx.sendResult(handle, 0)
of pbrDone: discard
of pbrUnregister:
ctx.close(handle)
return
case ctx.sendStatus(handle, 200, newHeaders(hgResponse, {"Content-Type": ct}))
of pbrDone: discard
of pbrUnregister:
ctx.close(handle)
return
let output = handle.output
if s.len == 0:
if output.suspended:
output.istreamAtEnd = true
else:
ctx.oclose(output)
return
let buffer = newLoaderBuffer(s)
case ctx.pushBuffer(output, buffer, ignoreSuspension = false)
of pbrUnregister:
if output.registered:
ctx.unregister(output)
ctx.oclose(output)
of pbrDone:
if output.registered or output.suspended:
output.istreamAtEnd = true
else:
ctx.oclose(output)
proc loadData(ctx: var LoaderContext; handle: InputHandle; request: Request) =
let url = request.url
var ct = url.pathname.until(',')
if AllChars - Ascii + Controls - {'\t'} in ct:
ctx.rejectHandle(handle, ceInvalidURL, "invalid data URL")
return
let sd = ct.len + 1 # data start
let body = percentDecode(url.pathname.toOpenArray(sd, url.pathname.high))
if ct.endsWith(";base64"):
var d: string
if d.atob(body).isNone:
ctx.rejectHandle(handle, ceInvalidURL, "invalid data URL")
return
ct.setLen(ct.len - ";base64".len) # remove base64 indicator
ctx.loadDataSend(handle, d, ct)
else:
ctx.loadDataSend(handle, body, ct)
# Download manager. Based on (you guessed it) w3m.
func formatSize(size: uint64): string =
result = ""
var size = size
while size > 0:
let n = size mod 1000
size = size div 1000
var ns = ""
if size != 0:
ns &= ','
if n < 100:
ns &= '0'
if n < 10:
ns &= '0'
ns &= $n
result.insert(ns, 0)
proc formatDuration(dur: Duration): string =
result = ""
let parts = dur.toParts()
if parts[Weeks] != 0:
result &= $parts[Weeks] & " Weeks, "
if parts[Days] != 0:
result &= $parts[Days] & " Days, "
for i, it in [Hours, Minutes, Seconds]:
if i > 0:
result &= ':'
if parts[it] in 0..9:
result &= '0'
result &= $parts[it]
proc makeProgress(it: DownloadItem; now: Time): string =
result = it.displayUrl.htmlEscape() & '\n'
result &= " -> " & it.path & '\n'
result &= " "
#TODO implement progress element and use that
var rat = 0u64
if it.contentLen == uint64.high and it.sent > 0 and it.output == nil:
rat = 80
elif it.contentLen < uint64.high and it.contentLen > 0:
rat = it.sent * 80 div it.contentLen
for i in 0 ..< rat:
result &= '#'
for i in rat ..< 80:
result &= '_'
result &= "\n "
result &= formatSize(it.sent)
if it.sent < it.contentLen and
(it.contentLen < uint64.high or it.output != nil):
if it.contentLen < uint64.high and it.contentLen > 0:
result &= " / " & formatSize(it.contentLen) & " bytes (" &
$(it.sent * 100 div it.contentLen) & "%) "
else:
result &= " bytes loaded "
let dur = now - it.startTime
result &= formatDuration(dur)
result &= " rate "
let udur = max(uint64(dur.inSeconds()), 1)
let rate = it.sent div udur
result &= convertSize(int(rate)) & "/sec"
if it.contentLen < uint64.high:
let left = it.contentLen - it.sent
let eta = initDuration(seconds = int64(left div max(rate, 1)))
result &= " eta " & formatDuration(eta)
else:
result &= " bytes loaded"
result &= '\n'
type
DownloadActionType = enum
datRemove
DownloadAction = object
n: int
t: DownloadActionType
proc parseDownloadActions(ctx: LoaderContext; s: string): seq[DownloadAction] =
result = @[]
for it in s.split('&'):
let name = it.until('=')
if name.startsWith("stop"):
let n = parseIntP(name.substr("stop".len)).get(-1)
if n >= 0 and n < ctx.downloadList.len:
result.add(DownloadAction(n: n, t: datRemove))
result.sort(proc(a, b: DownloadAction): int = return cmp(a.n, b.n),
Descending)
proc loadDownloads(ctx: var LoaderContext; handle: InputHandle;
request: Request) =
if request.httpMethod == hmPost:
# OK clicked
if request.body.t != rbtString:
ctx.rejectHandle(handle, ceInvalidURL, "wat")
return
for it in ctx.parseDownloadActions(request.body.s):
let dl = ctx.downloadList[it.n]
if dl.output != nil:
ctx.unregWrite.add(dl.output)
ctx.downloadList.del(it.n)
var body = """
<!DOCTYPE html>
<title>Download List Panel</title>
<body>
<h1 align=center>Download List Panel</h1>
<hr>
<form method=POST action=about:downloads>
<hr>
<pre>
"""
let now = getTime()
var refresh = false
for i, it in ctx.downloadList.mpairs:
if it.output != nil:
it.sent = it.output.bytesSent
if it.output.stream == nil:
it.output = nil
refresh = true
body &= it.makeProgress(now)
body &= "<input type=submit name=stop" & $i
if it.output != nil:
body &= " value=STOP"
else:
body &= " value=OK"
body &= ">"
body &= "<hr>"
if refresh:
body &= "<meta http-equiv=refresh content=1>" # :P
body &= """
</pre>
</body>
"""
ctx.loadDataSend(handle, body, "text/html")
# Stream for notifying the pager of new cookies set in the loader.
proc loadCookieStream(ctx: var LoaderContext; handle: InputHandle;
request: Request) =
if ctx.cookieStream != nil:
ctx.rejectHandle(handle, ceCookieStreamExists)
return
case ctx.sendResult(handle, 0)
of pbrDone: discard
of pbrUnregister:
ctx.close(handle)
return
case ctx.sendStatus(handle, 200, newHeaders(hgResponse))
of pbrDone: discard
of pbrUnregister:
ctx.close(handle)
return
ctx.cookieStream = handle.output
proc loadAbout(ctx: var LoaderContext; handle: InputHandle; request: Request) =
let url = request.url
case url.pathname
of "blank":
ctx.loadDataSend(handle, "", "text/html")
of "chawan":
const body = staticRead"res/chawan.html"
ctx.loadDataSend(handle, body, "text/html")
of "downloads":
ctx.loadDownloads(handle, request)
of "cookie-stream":
ctx.loadCookieStream(handle, request)
of "license":
const body = staticRead"res/license.md"
ctx.loadDataSend(handle, body, "text/markdown")
else:
ctx.rejectHandle(handle, ceInvalidURL, "invalid about URL")
proc loadResource(ctx: var LoaderContext; client: ClientHandle;
config: LoaderClientConfig; request: Request; handle: InputHandle) =
var redo = true
var tries = 0
var prevurl: URL = nil
while redo and tries < MaxRewrites:
redo = false
if ctx.config.w3mCGICompat and request.url.schemeType == stFile:
let path = request.url.pathname.percentDecode()
if ctx.canRewriteForCGICompat(path):
let newURL = newURL("cgi-bin:" & path & request.url.search)
if newURL.isSome:
request.url = newURL.get
inc tries
redo = true
continue
case request.url.schemeType
of stCgiBin:
ctx.loadCGI(client, handle, request, prevurl, config)
if handle.stream != nil:
ctx.addFd(handle)
else:
ctx.close(handle)
of stStream:
ctx.loadStream(client, handle, request)
if handle.stream != nil:
ctx.addFd(handle)
else:
ctx.close(handle)
of stCache:
ctx.loadFromCache(client, handle, request)
assert handle.stream == nil
of stData:
ctx.loadData(handle, request)
of stAbout:
ctx.loadAbout(handle, request)
else:
prevurl = request.url
case ctx.config.uriMethodMap.findAndRewrite(request.url)
of ummrSuccess:
inc tries
redo = true
of ummrWrongURL:
ctx.rejectHandle(handle, ceInvalidURIMethodEntry)
of ummrNotFound:
ctx.rejectHandle(handle, ceUnknownScheme)
if tries >= MaxRewrites:
ctx.rejectHandle(handle, ceTooManyRewrites)
proc setupRequestDefaults(request: Request; config: LoaderClientConfig;
credentials: bool) =
for k, v in config.defaultHeaders.allPairs:
if k notin request.headers:
request.headers[k] = v
if config.cookieJar != nil and config.cookieJar.cookies.len > 0:
if "Cookie" notin request.headers and credentials:
let cookie = config.cookieJar.serialize(request.url)
if cookie != "":
request.headers["Cookie"] = cookie
let referrer = request.getReferrer()
request.headers.del("Referer")
if referrer != nil:
let r = referrer.getReferrer(request.url, config.referrerPolicy)
if r != "":
request.headers["Referer"] = r
proc load(ctx: var LoaderContext; stream: SocketStream; request: Request;
client: ClientHandle; config: LoaderClientConfig) =
var pipev {.noinit.}: array[2, cint]
var fail = false
stream.withPacketWriter w:
if pipe(pipev) == 0:
w.swrite(true)
w.sendFd(pipev[0])
else:
fail = true
w.swrite(false)
if not fail:
discard close(pipev[0])
let stream = newSocketStream(pipev[1])
stream.setBlocking(false)
let credentials = config.includeCredentials(request, request.url)
let handle = ctx.newInputHandle(stream, client, request.url, credentials)
if not config.filter.match(request.url):
ctx.rejectHandle(handle, ceDisallowedURL)
else:
request.setupRequestDefaults(config, credentials)
ctx.loadResource(client, config, request, handle)
proc load(ctx: var LoaderContext; stream: SocketStream; client: ClientHandle;
r: var PacketReader) =
var request: Request
r.sread(request)
ctx.load(stream, request, client, client.config)
proc loadConfig(ctx: var LoaderContext; stream: SocketStream;
client: ClientHandle; r: var PacketReader) =
var request: Request
var config: LoaderClientConfig
r.sread(request)
r.sread(config)
ctx.load(stream, request, client, config)
proc getCacheFile(ctx: var LoaderContext; stream: SocketStream;
r: var PacketReader) =
var cacheId: int
var sourcePid: int
r.sread(cacheId)
r.sread(sourcePid)
let client = ctx.clientMap.getOrDefault(sourcePid, nil)
let n = if client != nil: client.cacheMap.find(cacheId) else: -1
stream.withPacketWriter w:
if n != -1:
w.swrite(client.cacheMap[n].path)
else:
w.swrite("")
proc addClient(ctx: var LoaderContext; stream: SocketStream;
r: var PacketReader) =
var pid: int
var config: LoaderClientConfig
var clonedFrom: int
r.sread(pid)
r.sread(config)
r.sread(clonedFrom)
assert pid notin ctx.clientMap
var sv {.noinit.}: array[2, cint]
stream.withPacketWriter w:
if socketpair(AF_UNIX, SOCK_STREAM, IPPROTO_IP, sv) == 0:
let stream = newSocketStream(sv[0])
let client = ClientHandle(stream: stream, pid: pid, config: config)
ctx.register(client)
ctx.put(client)
if clonedFrom != -1:
let client2 = ctx.clientMap[clonedFrom]
for item in client2.cacheMap:
inc item.refc
client.cacheMap = client2.cacheMap
if ctx.authMap.len > 0:
let origin = config.originURL.authOrigin
for it in ctx.authMap:
if it.origin.isSameOrigin(origin):
client.authMap.add(it)
w.swrite(true)
w.sendFd(sv[1])
else:
w.swrite(false)
discard close(sv[1])
proc removeClient(ctx: var LoaderContext; stream: SocketStream;
r: var PacketReader) =
var pid: int
r.sread(pid)
if pid in ctx.clientMap:
let client = ctx.clientMap[pid]
ctx.unregClient.add(client)
proc addCacheFile(ctx: var LoaderContext; stream: SocketStream;
client: ClientHandle; r: var PacketReader) =
var outputId: int
r.sread(outputId)
let output = ctx.findOutput(outputId, client)
stream.withPacketWriter w:
if output == nil:
w.swrite(-1)
else:
w.swrite(ctx.addCacheFile(client, output))
proc redirectToFile(ctx: var LoaderContext; stream: SocketStream;
client: ClientHandle; r: var PacketReader) =
var outputId: int
var targetPath: string
var displayUrl: string
r.sread(outputId)
r.sread(targetPath)
r.sread(displayUrl)
let output = ctx.findOutput(outputId, client)
var success = false
if output != nil:
var fileOutput: OutputHandle
var sent: uint64
success = ctx.redirectToFile(output, targetPath, fileOutput, sent)
let contentLen = if output.parent != nil:
output.parent.contentLen
else:
uint64.high
let startTime = if output.parent != nil:
output.parent.startTime
else:
#TODO ???
fromUnix(0)
ctx.downloadList.add(DownloadItem(
path: targetPath,
output: fileOutput,
displayUrl: displayUrl,
sent: sent,
contentLen: contentLen,
startTime: startTime
))
stream.withPacketWriter w:
w.swrite(success)
proc shareCachedItem(ctx: var LoaderContext; stream: SocketStream;
r: var PacketReader) =
# share a cached file with another buffer. this is for newBufferFrom
# (i.e. view source)
var sourcePid: int # pid of source client
var targetPid: int # pid of target client
var id: int
r.sread(sourcePid)
r.sread(targetPid)
r.sread(id)
let sourceClient = ctx.clientMap.getOrDefault(sourcePid)
let targetClient = ctx.clientMap.getOrDefault(targetPid)
let n = if sourceClient != nil and targetClient != nil:
sourceClient.cacheMap.find(id)
else:
-1
if n != -1:
let item = sourceClient.cacheMap[n]
inc item.refc
targetClient.cacheMap.add(item)
stream.withPacketWriter w:
w.swrite(n != -1)
proc openCachedItem(ctx: LoaderContext; stream: SocketStream;
client: ClientHandle; r: var PacketReader) =
# open a cached item
var id: int
r.sread(id)
let (ps, _) = client.openCachedItem(id)
stream.withPacketWriter w:
w.swrite(ps != nil)
if ps != nil:
w.sendFd(ps.fd)
if ps != nil:
ps.sclose()
proc passFd(ctx: var LoaderContext; stream: SocketStream; client: ClientHandle;
r: var PacketReader) =
var id: string
r.sread(id)
let fd = r.recvFd()
#TODO cloexec?
client.passedFdMap.add((id, newPosixStream(fd)))
proc addPipe(ctx: var LoaderContext; stream: SocketStream; client: ClientHandle;
r: var PacketReader) =
var id: string
r.sread(id)
var pipefd {.noinit.}: array[2, cint]
if pipe(pipefd) == -1:
stream.withPacketWriter w:
w.swrite(false)
else:
stream.withPacketWriter w:
w.swrite(true)
w.sendFd(pipefd[1])
discard close(pipefd[1])
let ps = newPosixStream(pipefd[0])
ps.setCloseOnExec()
client.passedFdMap.add((id, ps))
proc removeCachedItem(ctx: var LoaderContext; stream: SocketStream;
client: ClientHandle; r: var PacketReader) =
var id: int
r.sread(id)
let n = client.cacheMap.find(id)
if n != -1:
let item = client.cacheMap[n]
client.cacheMap.del(n)
dec item.refc
if item.refc == 0:
discard unlink(cstring(item.path))
proc tee(ctx: var LoaderContext; stream: SocketStream; client: ClientHandle;
r: var PacketReader) =
var sourceId: int
var targetPid: int
r.sread(sourceId)
r.sread(targetPid)
let outputIn = ctx.findOutput(sourceId, client)
let target = ctx.clientMap.getOrDefault(targetPid)
var pipev {.noinit.}: array[2, cint]
if target != nil and outputIn != nil and pipe(pipev) == 0:
let ostream = newSocketStream(pipev[1])
ostream.setBlocking(false)
let output = ctx.tee(outputIn, ostream, target)
stream.withPacketWriter w:
w.swrite(output.outputId)
w.sendFd(pipev[0])
discard close(pipev[0])
else:
stream.withPacketWriter w:
w.swrite(-1)
proc addAuth(ctx: var LoaderContext; stream: SocketStream;
r: var PacketReader) =
var url: URL
r.sread(url)
let origin = url.authOrigin
let item = ctx.authMap.findItem(origin)
if item != nil:
# Only replace the old item if the URL sets a password or the old
# item's username is different.
# This way, loading a URL with only the username set still lets us
# load the password which is already associated with said username.
if url.password != "" or item.username != url.username:
item.username = url.username
item.password = url.password
else:
let item = AuthItem(
origin: url.authOrigin,
username: url.username,
password: url.password
)
ctx.authMap.add(item)
ctx.pagerClient.authMap.add(item)
proc suspend(ctx: var LoaderContext; stream: SocketStream; client: ClientHandle;
r: var PacketReader) =
var ids: seq[int]
r.sread(ids)
for id in ids:
let output = ctx.findOutput(id, client)
if output != nil:
output.suspended = true
if output.registered:
# do not waste cycles trying to push into output
ctx.unregister(output)
proc resume(ctx: var LoaderContext; stream: SocketStream; client: ClientHandle;
r: var PacketReader) =
var ids: seq[int]
r.sread(ids)
for id in ids:
let output = ctx.findOutput(id, client)
if output != nil:
output.suspended = false
if not output.isEmpty or output.istreamAtEnd:
ctx.register(output)
proc readCommand(ctx: var LoaderContext; client: ClientHandle) =
let stream = SocketStream(client.stream)
try:
assert not client.stream.isend
stream.withPacketReader r:
var cmd: LoaderCommand
r.sread(cmd)
template privileged_command =
doAssert ctx.isPrivileged(client)
case cmd
of lcAddClient:
privileged_command
ctx.addClient(stream, r)
of lcAddAuth:
privileged_command
ctx.addAuth(stream, r)
of lcRemoveClient:
privileged_command
ctx.removeClient(stream, r)
of lcShareCachedItem:
privileged_command
ctx.shareCachedItem(stream, r)
of lcOpenCachedItem:
privileged_command
ctx.openCachedItem(stream, client, r)
of lcRedirectToFile:
privileged_command
ctx.redirectToFile(stream, client, r)
of lcLoadConfig:
privileged_command
ctx.loadConfig(stream, client, r)
of lcGetCacheFile:
privileged_command
ctx.getCacheFile(stream, r)
of lcPassFd:
privileged_command
ctx.passFd(stream, client, r)
of lcAddCacheFile:
ctx.addCacheFile(stream, client, r)
of lcRemoveCachedItem:
ctx.removeCachedItem(stream, client, r)
of lcAddPipe:
ctx.addPipe(stream, client, r)
of lcLoad:
ctx.load(stream, client, r)
of lcTee:
ctx.tee(stream, client, r)
of lcSuspend:
ctx.suspend(stream, client, r)
of lcResume:
ctx.resume(stream, client, r)
assert r.empty()
except EOFError:
# Receiving end died while reading, or sent less bytes than they
# promised. Give up.
ctx.unregClient.add(client)
proc exitLoader(ctx: LoaderContext) =
for it in ctx.handleMap:
if it of ClientHandle:
let client = ClientHandle(it)
for it in client.cacheMap:
dec it.refc
if it.refc <= 0:
discard unlink(cstring(it.path))
exitnow(1)
# This is only called when an OutputHandle could not read enough of one (or
# more) buffers, and we asked select to notify us when it will be available.
proc handleWrite(ctx: var LoaderContext; output: OutputHandle;
unregWrite: var seq[OutputHandle]) =
while output.currentBuffer != nil:
let buffer = output.currentBuffer
let n = output.stream.writeData(buffer, output.currentBufferIdx)
if n < 0:
let e = errno
if e == EAGAIN or e == EWOULDBLOCK: # never mind
break
else: # receiver died; stop streaming
assert e == EPIPE, $strerror(e)
unregWrite.add(output)
break
output.bytesSent += uint64(n)
output.currentBufferIdx += n
if output.currentBufferIdx < buffer.len:
break
output.bufferCleared() # swap out buffer
if output.isEmpty:
if output.istreamAtEnd:
# after EOF, no need to send anything more here
unregWrite.add(output)
else:
# all buffers sent, no need to select on this output again for now
ctx.unregister(output)
proc finishCycle(ctx: var LoaderContext) =
# Unregister handles queued for unregistration.
# It is possible for both unregRead and unregWrite to contain duplicates. To
# avoid double-close/double-unregister, we set the istream/ostream of
# unregistered handles to nil.
for handle in ctx.unregRead:
if handle.stream != nil:
ctx.unregister(handle)
if handle.parser != nil:
ctx.finishParse(handle)
ctx.iclose(handle)
for output in handle.outputs:
output.istreamAtEnd = true
if output.isEmpty:
ctx.unregWrite.add(output)
for output in ctx.unregWrite:
if output.stream != nil:
if output.registered:
ctx.unregister(output)
ctx.oclose(output)
let handle = output.parent
if handle != nil: # may be nil if from loadStream S_ISREG
let i = handle.outputs.find(output)
handle.outputs.del(i)
if handle.outputs.len == 0 and handle.stream != nil:
# premature end of all output streams; kill istream too
ctx.unregister(handle)
if handle.parser != nil:
ctx.finishParse(handle)
ctx.iclose(handle)
for client in ctx.unregClient:
if client.stream != nil:
# Do it in this exact order, or the cleanup procedure will have
# trouble finding all clients if we got interrupted in this loop.
ctx.unregister(client)
let fd = int(client.stream.fd)
ctx.close(client)
if fd < ctx.handleMap.len:
ctx.handleMap[fd] = nil
ctx.unregRead.setLen(0)
ctx.unregWrite.setLen(0)
ctx.unregClient.setLen(0)
proc loaderLoop(ctx: var LoaderContext) =
while true:
ctx.pollData.poll(-1)
for event in ctx.pollData.events:
let efd = int(event.fd)
if (event.revents and POLLIN) != 0:
let handle = ctx.handleMap[efd]
if handle of ClientHandle:
ctx.readCommand(ClientHandle(handle))
else:
let handle = InputHandle(handle)
case ctx.handleRead(handle, ctx.unregWrite)
of hrrDone: discard
of hrrUnregister, hrrBrokenPipe: ctx.unregRead.add(handle)
if (event.revents and POLLOUT) != 0:
let handle = ctx.handleMap[efd]
ctx.handleWrite(OutputHandle(handle), ctx.unregWrite)
if (event.revents and POLLERR) != 0 or (event.revents and POLLHUP) != 0:
let handle = ctx.handleMap[efd]
if handle of InputHandle: # istream died
ctx.unregRead.add(InputHandle(handle))
elif handle of OutputHandle: # ostream died
ctx.unregWrite.add(OutputHandle(handle))
else: # client died
assert handle of ClientHandle
ctx.unregClient.add(ClientHandle(handle))
ctx.finishCycle()
ctx.exitLoader()
proc runFileLoader*(config: LoaderConfig; stream, forkStream: SocketStream) =
var ctx {.global.}: LoaderContext
ctx = LoaderContext(
config: config,
pid: getCurrentProcessId(),
forkStream: forkStream
)
onSignal SIGTERM:
discard sig
ctx.exitLoader()
for dir in ctx.config.cgiDir.mitems:
if dir.len > 0 and dir[^1] != '/':
dir &= '/'
stream.withPacketReader r:
var cmd: LoaderCommand
r.sread(cmd)
doAssert cmd == lcAddClient
var pid: int
var config: LoaderClientConfig
r.sread(pid)
r.sread(config)
stream.withPacketWriter w:
w.swrite(true)
ctx.pagerClient = ClientHandle(stream: stream, pid: pid, config: config)
ctx.register(ctx.pagerClient)
ctx.put(ctx.pagerClient)
ctx.loaderLoop()
|