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
1873
1874
1875
1876
1877
1878
1879
1880
1881
1882
1883
1884
1885
1886
1887
1888
1889
1890
1891
1892
1893
1894
1895
1896
1897
1898
1899
1900
1901
1902
1903
1904
1905
1906
1907
1908
1909
1910
1911
1912
1913
1914
1915
1916
1917
1918
1919
1920
1921
1922
1923
1924
1925
1926
1927
1928
1929
1930
1931
1932
1933
1934
1935
1936
1937
1938
1939
1940
1941
1942
1943
1944
1945
1946
1947
1948
1949
1950
1951
1952
1953
1954
1955
1956
1957
1958
1959
1960
1961
1962
1963
1964
1965
1966
1967
1968
1969
1970
1971
1972
1973
1974
1975
1976
1977
1978
1979
1980
1981
1982
1983
1984
1985
1986
1987
1988
1989
1990
1991
1992
1993
1994
1995
1996
1997
1998
1999
2000
2001
2002
2003
2004
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
2025
2026
2027
2028
2029
2030
2031
2032
2033
2034
2035
2036
2037
2038
2039
2040
2041
2042
2043
2044
2045
2046
2047
2048
2049
2050
2051
2052
2053
2054
2055
2056
2057
2058
2059
2060
2061
2062
2063
2064
2065
2066
2067
2068
2069
2070
2071
2072
2073
2074
2075
2076
2077
2078
2079
2080
2081
2082
2083
2084
2085
2086
2087
2088
2089
2090
2091
2092
2093
2094
2095
2096
2097
2098
2099
2100
2101
2102
2103
2104
2105
2106
2107
2108
2109
2110
2111
2112
2113
2114
2115
2116
2117
2118
2119
2120
2121
2122
2123
2124
2125
2126
2127
2128
2129
2130
2131
2132
2133
2134
2135
2136
2137
2138
2139
2140
2141
2142
2143
2144
2145
2146
2147
2148
2149
2150
2151
2152
2153
2154
2155
2156
2157
2158
2159
2160
2161
2162
2163
2164
2165
2166
2167
2168
2169
2170
2171
2172
2173
2174
2175
2176
2177
2178
2179
2180
2181
2182
2183
2184
2185
2186
2187
2188
2189
2190
2191
2192
2193
2194
2195
2196
2197
2198
2199
2200
2201
2202
2203
2204
2205
2206
2207
2208
2209
2210
2211
2212
2213
2214
2215
2216
2217
2218
2219
2220
2221
2222
2223
2224
2225
2226
2227
2228
2229
2230
2231
2232
2233
2234
2235
2236
2237
2238
2239
2240
2241
2242
2243
2244
2245
2246
2247
2248
2249
2250
2251
2252
2253
2254
2255
2256
2257
2258
2259
2260
2261
2262
2263
2264
2265
2266
2267
2268
2269
2270
2271
2272
2273
2274
2275
2276
2277
2278
2279
2280
2281
2282
2283
2284
2285
2286
2287
2288
2289
2290
2291
2292
2293
2294
2295
2296
2297
2298
2299
2300
2301
2302
2303
2304
2305
2306
2307
2308
2309
2310
2311
2312
2313
2314
2315
2316
2317
2318
2319
2320
2321
2322
2323
2324
2325
2326
2327
2328
2329
2330
2331
2332
2333
2334
2335
2336
2337
2338
2339
2340
2341
2342
2343
2344
2345
2346
2347
2348
2349
2350
2351
2352
2353
2354
2355
2356
2357
2358
2359
2360
2361
2362
2363
2364
2365
2366
2367
2368
2369
2370
2371
2372
2373
2374
2375
2376
2377
2378
2379
2380
2381
2382
2383
2384
2385
2386
2387
2388
2389
2390
2391
2392
2393
2394
2395
2396
2397
2398
2399
2400
2401
2402
2403
2404
2405
2406
2407
2408
2409
2410
2411
2412
2413
2414
2415
2416
2417
2418
2419
2420
2421
2422
2423
2424
2425
2426
2427
2428
2429
2430
2431
2432
2433
2434
2435
2436
2437
2438
2439
2440
2441
2442
2443
2444
2445
2446
2447
2448
2449
2450
2451
2452
2453
2454
2455
2456
2457
2458
2459
2460
2461
2462
2463
2464
2465
2466
2467
2468
2469
2470
2471
2472
2473
2474
2475
2476
2477
2478
2479
2480
2481
2482
2483
2484
2485
2486
2487
2488
2489
2490
2491
2492
2493
2494
2495
2496
2497
2498
2499
2500
2501
2502
2503
2504
2505
2506
2507
2508
2509
2510
2511
2512
2513
2514
2515
2516
2517
2518
2519
2520
2521
2522
2523
2524
2525
2526
2527
2528
2529
2530
2531
2532
2533
2534
2535
2536
2537
2538
2539
2540
2541
2542
2543
2544
2545
2546
2547
2548
2549
2550
2551
2552
2553
2554
2555
2556
2557
2558
2559
2560
2561
2562
2563
2564
2565
2566
2567
2568
2569
2570
2571
2572
2573
2574
2575
2576
2577
2578
2579
2580
2581
2582
2583
2584
2585
2586
2587
2588
2589
2590
2591
2592
2593
2594
2595
2596
2597
2598
2599
2600
2601
2602
2603
2604
2605
2606
2607
2608
2609
2610
2611
2612
2613
2614
2615
2616
2617
2618
2619
2620
2621
2622
2623
2624
2625
2626
2627
2628
2629
2630
2631
2632
2633
2634
2635
2636
2637
2638
2639
2640
2641
2642
2643
2644
2645
2646
2647
2648
2649
2650
2651
2652
2653
2654
2655
2656
2657
2658
2659
2660
2661
2662
2663
2664
2665
2666
2667
2668
2669
2670
2671
2672
2673
2674
2675
2676
2677
2678
2679
2680
2681
2682
2683
2684
2685
2686
2687
2688
2689
2690
2691
2692
2693
2694
2695
2696
2697
2698
2699
2700
2701
2702
2703
2704
2705
2706
2707
2708
2709
2710
2711
2712
2713
2714
2715
2716
2717
2718
2719
2720
2721
2722
2723
2724
2725
2726
2727
2728
2729
2730
2731
2732
2733
2734
2735
2736
2737
2738
2739
2740
2741
2742
2743
2744
2745
2746
2747
2748
2749
2750
2751
2752
2753
2754
2755
2756
2757
2758
2759
2760
2761
2762
2763
2764
2765
2766
2767
2768
2769
2770
2771
2772
2773
2774
2775
2776
2777
2778
2779
2780
2781
2782
2783
2784
2785
2786
2787
2788
2789
2790
2791
2792
2793
2794
2795
2796
2797
2798
2799
2800
2801
2802
2803
2804
2805
2806
2807
2808
2809
2810
2811
2812
2813
2814
2815
2816
2817
2818
2819
2820
2821
2822
2823
2824
2825
2826
2827
2828
2829
2830
2831
2832
2833
2834
2835
2836
2837
2838
2839
2840
2841
2842
2843
2844
2845
2846
2847
2848
2849
2850
2851
2852
2853
2854
2855
2856
2857
2858
2859
2860
2861
2862
2863
2864
2865
2866
2867
2868
2869
2870
2871
2872
2873
2874
2875
2876
2877
2878
2879
2880
2881
2882
2883
2884
2885
2886
2887
2888
2889
2890
2891
2892
2893
2894
2895
2896
2897
2898
2899
2900
2901
2902
2903
2904
2905
2906
2907
2908
2909
2910
2911
2912
2913
2914
2915
2916
2917
2918
2919
2920
2921
2922
2923
2924
2925
2926
2927
2928
2929
2930
2931
2932
2933
2934
2935
2936
2937
2938
2939
2940
2941
2942
2943
2944
2945
2946
2947
2948
2949
2950
2951
2952
2953
2954
2955
2956
2957
2958
2959
2960
2961
2962
2963
2964
2965
2966
2967
2968
2969
2970
2971
2972
2973
2974
2975
2976
2977
2978
2979
2980
2981
2982
2983
2984
2985
2986
2987
2988
2989
2990
2991
2992
2993
2994
2995
2996
2997
2998
2999
3000
3001
3002
3003
3004
3005
3006
3007
3008
3009
3010
3011
3012
3013
3014
3015
3016
3017
3018
3019
3020
3021
3022
3023
3024
3025
3026
3027
3028
3029
3030
3031
3032
3033
3034
3035
3036
3037
3038
3039
3040
3041
3042
3043
3044
3045
3046
3047
3048
3049
3050
3051
3052
3053
3054
3055
3056
3057
3058
3059
3060
3061
3062
3063
3064
3065
3066
3067
3068
3069
3070
3071
3072
3073
3074
3075
3076
3077
3078
3079
3080
3081
3082
3083
3084
3085
3086
3087
3088
3089
3090
3091
3092
3093
3094
3095
3096
3097
3098
3099
3100
3101
3102
3103
3104
3105
3106
3107
3108
3109
3110
3111
3112
3113
3114
3115
3116
3117
3118
3119
3120
3121
3122
3123
3124
3125
3126
3127
3128
3129
3130
3131
3132
3133
3134
3135
3136
3137
3138
3139
3140
3141
3142
3143
3144
3145
3146
3147
3148
3149
3150
3151
3152
3153
3154
3155
3156
3157
3158
3159
3160
3161
3162
3163
3164
3165
3166
3167
3168
3169
3170
3171
3172
3173
3174
3175
3176
3177
3178
3179
3180
3181
3182
3183
3184
3185
3186
3187
3188
3189
3190
3191
3192
3193
3194
3195
3196
3197
3198
3199
3200
3201
3202
3203
3204
3205
3206
3207
3208
3209
3210
3211
3212
3213
3214
3215
3216
3217
3218
3219
3220
3221
3222
3223
3224
3225
3226
3227
3228
3229
3230
3231
3232
3233
3234
3235
3236
3237
3238
3239
3240
3241
3242
3243
3244
3245
3246
3247
3248
3249
3250
3251
3252
3253
3254
3255
3256
3257
3258
3259
3260
3261
3262
3263
3264
3265
3266
3267
3268
3269
3270
3271
3272
3273
3274
3275
3276
3277
3278
3279
3280
3281
3282
3283
3284
3285
3286
3287
3288
3289
3290
3291
3292
3293
3294
3295
3296
3297
3298
3299
3300
3301
3302
3303
3304
3305
3306
3307
3308
3309
3310
3311
3312
3313
3314
3315
3316
3317
3318
3319
3320
3321
3322
3323
3324
3325
3326
3327
3328
3329
3330
3331
3332
3333
3334
3335
3336
3337
3338
3339
3340
3341
3342
3343
3344
3345
3346
3347
3348
3349
3350
3351
3352
3353
3354
3355
3356
3357
3358
3359
3360
3361
3362
3363
3364
3365
3366
3367
3368
3369
3370
3371
3372
3373
3374
3375
3376
3377
3378
3379
3380
3381
3382
3383
3384
3385
3386
3387
3388
3389
3390
3391
3392
3393
3394
3395
3396
3397
3398
3399
3400
3401
3402
3403
3404
3405
3406
3407
3408
3409
3410
3411
3412
3413
3414
3415
3416
3417
3418
3419
3420
3421
3422
3423
3424
3425
3426
3427
3428
3429
3430
3431
3432
3433
3434
3435
3436
3437
3438
3439
3440
3441
3442
3443
3444
3445
3446
3447
3448
3449
3450
3451
3452
3453
3454
3455
3456
3457
3458
3459
3460
3461
3462
3463
3464
3465
3466
3467
3468
3469
3470
3471
3472
3473
3474
3475
3476
3477
3478
3479
3480
3481
3482
3483
3484
3485
3486
3487
3488
3489
3490
3491
3492
3493
3494
3495
3496
3497
3498
3499
3500
3501
3502
3503
3504
3505
3506
3507
3508
3509
3510
3511
3512
3513
3514
3515
3516
3517
3518
3519
3520
3521
3522
3523
3524
3525
3526
3527
3528
3529
3530
3531
3532
3533
3534
3535
3536
3537
3538
3539
3540
3541
3542
3543
3544
3545
3546
3547
3548
3549
3550
3551
3552
3553
3554
3555
3556
3557
3558
3559
3560
3561
3562
3563
3564
3565
3566
3567
3568
3569
3570
3571
3572
3573
3574
3575
3576
3577
3578
3579
3580
3581
3582
3583
3584
3585
3586
3587
3588
3589
3590
3591
3592
3593
3594
3595
3596
3597
3598
3599
3600
3601
3602
3603
3604
3605
3606
3607
3608
3609
3610
3611
3612
3613
3614
3615
3616
3617
3618
3619
3620
3621
3622
3623
3624
3625
3626
3627
3628
3629
3630
3631
3632
3633
3634
3635
3636
3637
3638
3639
3640
3641
3642
3643
3644
3645
3646
3647
3648
3649
3650
3651
3652
3653
3654
3655
3656
3657
3658
3659
3660
3661
3662
3663
3664
3665
3666
3667
3668
3669
3670
3671
3672
3673
3674
3675
3676
3677
3678
3679
3680
3681
3682
3683
3684
3685
3686
3687
3688
3689
3690
3691
3692
3693
3694
3695
3696
3697
3698
3699
3700
3701
3702
3703
3704
3705
3706
3707
3708
3709
3710
3711
3712
3713
3714
3715
3716
3717
3718
3719
3720
3721
3722
3723
3724
3725
3726
3727
3728
3729
3730
3731
3732
3733
3734
3735
3736
3737
3738
3739
3740
3741
3742
3743
3744
3745
3746
3747
3748
3749
3750
3751
3752
3753
3754
3755
3756
3757
3758
3759
3760
3761
3762
3763
3764
3765
3766
3767
3768
3769
3770
3771
3772
3773
3774
3775
3776
3777
3778
3779
3780
3781
3782
3783
3784
3785
3786
3787
3788
3789
3790
3791
3792
3793
3794
3795
3796
3797
3798
3799
3800
3801
3802
3803
3804
3805
3806
3807
3808
3809
3810
3811
3812
3813
3814
3815
3816
3817
3818
3819
3820
3821
3822
3823
3824
3825
3826
3827
3828
3829
3830
3831
3832
3833
3834
3835
3836
3837
3838
3839
3840
3841
3842
3843
3844
3845
3846
3847
3848
3849
3850
3851
3852
3853
3854
3855
3856
3857
3858
3859
3860
3861
3862
3863
3864
3865
3866
3867
3868
3869
3870
3871
3872
3873
3874
3875
3876
3877
3878
3879
3880
3881
3882
3883
3884
3885
3886
3887
3888
3889
3890
3891
3892
3893
3894
3895
3896
3897
3898
3899
3900
3901
3902
3903
3904
3905
3906
3907
3908
3909
3910
3911
3912
3913
3914
3915
3916
3917
3918
3919
3920
3921
3922
3923
3924
3925
3926
3927
3928
3929
3930
3931
3932
3933
3934
3935
3936
3937
3938
3939
3940
3941
3942
3943
3944
3945
3946
3947
3948
3949
3950
3951
3952
3953
3954
3955
3956
3957
3958
3959
3960
3961
3962
3963
3964
3965
3966
3967
3968
3969
3970
3971
3972
3973
3974
3975
3976
3977
3978
3979
3980
3981
3982
3983
3984
3985
3986
3987
3988
3989
3990
3991
3992
3993
3994
3995
3996
3997
3998
3999
4000
4001
4002
4003
4004
4005
4006
4007
4008
4009
4010
4011
4012
4013
4014
4015
4016
4017
4018
4019
4020
4021
4022
4023
4024
4025
4026
4027
4028
4029
4030
4031
4032
4033
4034
4035
4036
4037
4038
4039
4040
4041
4042
4043
4044
4045
4046
4047
4048
4049
4050
4051
4052
4053
4054
4055
4056
4057
4058
4059
4060
4061
4062
4063
4064
4065
4066
4067
4068
4069
4070
4071
4072
4073
4074
4075
4076
4077
4078
4079
4080
4081
4082
4083
4084
4085
4086
4087
4088
4089
4090
4091
4092
4093
4094
4095
4096
4097
4098
4099
4100
4101
4102
4103
4104
4105
4106
4107
4108
4109
4110
4111
4112
4113
4114
4115
4116
4117
4118
4119
4120
4121
4122
4123
4124
4125
4126
4127
4128
4129
4130
4131
4132
4133
4134
4135
4136
4137
4138
4139
4140
4141
4142
4143
4144
4145
4146
4147
4148
4149
4150
4151
4152
4153
4154
4155
4156
4157
4158
4159
4160
4161
4162
4163
4164
4165
4166
4167
4168
4169
4170
4171
4172
4173
4174
4175
4176
4177
4178
4179
4180
4181
4182
4183
4184
4185
4186
4187
4188
4189
4190
4191
4192
4193
4194
4195
4196
4197
4198
4199
4200
4201
4202
4203
4204
4205
4206
4207
4208
4209
4210
4211
4212
4213
4214
4215
4216
4217
4218
4219
4220
4221
4222
4223
4224
4225
4226
4227
4228
4229
4230
4231
4232
4233
4234
4235
4236
4237
4238
4239
4240
4241
4242
4243
4244
4245
4246
4247
4248
4249
4250
4251
4252
4253
4254
4255
4256
4257
4258
4259
4260
4261
4262
4263
4264
4265
4266
4267
4268
4269
4270
4271
4272
4273
4274
4275
4276
4277
4278
4279
4280
4281
4282
4283
4284
4285
4286
4287
4288
4289
4290
4291
4292
4293
4294
4295
4296
4297
4298
4299
4300
4301
4302
4303
4304
4305
4306
4307
4308
4309
4310
4311
4312
4313
4314
4315
4316
4317
4318
4319
4320
4321
4322
4323
4324
4325
4326
4327
4328
4329
4330
4331
4332
4333
4334
4335
4336
4337
4338
4339
4340
4341
4342
4343
4344
4345
4346
4347
4348
4349
4350
4351
4352
4353
4354
4355
4356
4357
4358
4359
4360
4361
4362
4363
4364
4365
4366
4367
4368
4369
4370
4371
4372
4373
4374
4375
4376
4377
4378
4379
4380
4381
4382
4383
4384
4385
4386
4387
4388
4389
4390
4391
4392
4393
4394
4395
4396
4397
4398
4399
4400
4401
4402
4403
4404
4405
4406
4407
4408
4409
4410
4411
4412
4413
4414
4415
4416
4417
4418
4419
4420
4421
4422
4423
4424
4425
4426
4427
4428
4429
4430
4431
4432
4433
4434
4435
4436
4437
4438
4439
4440
4441
4442
4443
4444
4445
4446
4447
4448
4449
4450
4451
4452
4453
4454
4455
4456
4457
4458
4459
4460
4461
4462
4463
4464
4465
4466
4467
4468
4469
4470
4471
4472
4473
4474
4475
4476
4477
4478
4479
4480
4481
4482
4483
4484
4485
4486
4487
4488
4489
4490
4491
4492
4493
4494
4495
4496
4497
4498
4499
4500
4501
4502
4503
4504
4505
4506
4507
4508
4509
4510
4511
4512
4513
4514
4515
4516
4517
4518
4519
4520
4521
4522
4523
4524
4525
4526
4527
4528
4529
4530
4531
4532
4533
4534
4535
4536
4537
4538
4539
4540
4541
4542
4543
4544
4545
4546
4547
4548
4549
4550
4551
4552
4553
4554
4555
4556
4557
4558
4559
4560
4561
4562
4563
4564
4565
4566
4567
4568
4569
4570
4571
4572
4573
4574
4575
4576
4577
4578
4579
4580
4581
4582
4583
4584
4585
4586
4587
4588
4589
4590
4591
4592
4593
4594
4595
4596
4597
4598
4599
4600
4601
4602
4603
4604
4605
4606
4607
4608
4609
4610
4611
4612
4613
4614
4615
4616
4617
4618
4619
4620
4621
4622
4623
4624
4625
4626
4627
4628
4629
4630
4631
4632
4633
4634
4635
4636
4637
4638
4639
4640
4641
4642
4643
4644
4645
4646
4647
4648
4649
4650
4651
4652
4653
4654
4655
4656
4657
4658
4659
4660
4661
4662
4663
4664
4665
4666
4667
4668
4669
4670
4671
4672
4673
4674
4675
4676
4677
4678
4679
4680
4681
4682
4683
4684
4685
4686
4687
4688
4689
4690
4691
4692
4693
4694
4695
4696
4697
4698
4699
4700
4701
4702
4703
4704
4705
4706
4707
4708
4709
4710
4711
4712
4713
4714
4715
4716
4717
4718
4719
4720
4721
4722
4723
4724
4725
4726
4727
4728
4729
4730
4731
4732
4733
4734
4735
4736
4737
4738
4739
4740
4741
4742
4743
4744
4745
4746
4747
4748
4749
4750
4751
4752
4753
4754
4755
4756
4757
4758
4759
4760
4761
4762
4763
4764
4765
4766
4767
4768
4769
4770
4771
4772
4773
4774
4775
4776
4777
4778
4779
4780
4781
4782
4783
4784
4785
4786
4787
4788
4789
4790
4791
4792
4793
4794
4795
4796
4797
4798
4799
4800
4801
4802
4803
4804
4805
4806
4807
4808
4809
4810
4811
4812
4813
4814
4815
4816
4817
4818
4819
4820
4821
4822
4823
4824
4825
4826
4827
4828
4829
4830
4831
4832
4833
4834
4835
4836
4837
4838
4839
4840
4841
4842
4843
4844
4845
4846
4847
4848
4849
4850
4851
4852
4853
4854
4855
4856
4857
4858
4859
4860
4861
4862
4863
4864
4865
4866
4867
4868
4869
4870
4871
4872
4873
4874
4875
4876
4877
4878
4879
4880
4881
4882
4883
4884
4885
4886
4887
4888
4889
4890
4891
4892
4893
4894
4895
4896
4897
4898
4899
4900
4901
4902
4903
4904
4905
4906
4907
4908
4909
4910
4911
4912
4913
4914
4915
4916
4917
4918
4919
4920
4921
4922
4923
4924
4925
4926
4927
4928
4929
4930
4931
4932
4933
4934
4935
4936
4937
4938
4939
4940
4941
4942
4943
4944
4945
4946
4947
4948
4949
4950
4951
4952
4953
4954
4955
4956
4957
4958
4959
4960
4961
4962
4963
4964
4965
4966
4967
4968
4969
4970
4971
4972
4973
4974
4975
4976
4977
4978
4979
4980
4981
4982
4983
4984
4985
4986
4987
4988
4989
4990
4991
4992
4993
4994
4995
4996
4997
4998
4999
5000
5001
5002
5003
5004
5005
5006
5007
5008
5009
5010
5011
5012
5013
5014
5015
5016
5017
5018
5019
5020
5021
5022
5023
5024
5025
5026
5027
5028
5029
5030
5031
5032
5033
5034
5035
5036
5037
5038
5039
5040
5041
5042
5043
5044
5045
5046
5047
5048
5049
5050
5051
5052
5053
5054
5055
5056
5057
5058
5059
5060
5061
5062
5063
5064
5065
5066
5067
5068
5069
5070
5071
5072
5073
5074
5075
5076
5077
5078
5079
5080
5081
5082
5083
5084
5085
5086
5087
5088
5089
5090
5091
5092
5093
5094
5095
5096
5097
5098
5099
5100
5101
5102
5103
5104
5105
5106
5107
5108
5109
5110
5111
5112
5113
5114
5115
5116
5117
5118
5119
5120
5121
5122
5123
5124
5125
5126
5127
5128
5129
5130
5131
5132
5133
5134
5135
5136
5137
5138
5139
5140
5141
5142
5143
5144
5145
5146
5147
5148
5149
5150
5151
5152
5153
5154
5155
5156
5157
5158
5159
5160
5161
5162
5163
5164
5165
5166
5167
5168
5169
5170
5171
5172
5173
5174
5175
5176
5177
5178
5179
5180
5181
5182
5183
5184
5185
5186
5187
5188
5189
5190
5191
5192
5193
5194
5195
5196
5197
5198
5199
5200
5201
5202
5203
5204
5205
5206
5207
5208
5209
5210
5211
5212
5213
5214
5215
5216
5217
5218
5219
5220
5221
5222
5223
5224
5225
5226
5227
5228
5229
5230
5231
5232
5233
5234
5235
5236
5237
5238
5239
5240
5241
5242
5243
5244
5245
5246
5247
5248
5249
5250
5251
5252
5253
5254
5255
5256
5257
5258
5259
5260
5261
5262
5263
5264
5265
5266
5267
5268
5269
5270
5271
5272
5273
5274
5275
5276
5277
5278
5279
5280
5281
5282
5283
5284
5285
5286
5287
5288
5289
5290
5291
5292
5293
5294
5295
5296
5297
5298
5299
5300
5301
5302
5303
5304
5305
5306
5307
5308
5309
5310
5311
5312
5313
5314
5315
5316
5317
5318
5319
5320
5321
5322
5323
5324
5325
5326
5327
5328
5329
5330
5331
5332
5333
5334
5335
5336
5337
5338
5339
5340
5341
5342
5343
5344
5345
5346
5347
5348
5349
5350
5351
5352
5353
5354
5355
5356
5357
5358
5359
5360
5361
5362
5363
5364
5365
5366
5367
5368
5369
5370
5371
5372
5373
5374
5375
5376
5377
5378
5379
5380
5381
5382
5383
5384
5385
5386
5387
5388
5389
5390
5391
5392
5393
5394
5395
5396
5397
5398
5399
5400
5401
5402
5403
5404
5405
5406
5407
5408
5409
5410
5411
5412
5413
5414
5415
5416
5417
5418
5419
5420
5421
5422
5423
5424
5425
5426
5427
5428
5429
5430
5431
5432
5433
5434
5435
5436
5437
5438
5439
5440
5441
5442
5443
5444
5445
5446
5447
5448
5449
5450
5451
5452
5453
5454
5455
5456
5457
5458
5459
5460
5461
5462
5463
5464
5465
5466
5467
5468
5469
5470
5471
5472
5473
5474
5475
5476
5477
5478
5479
5480
5481
5482
5483
5484
5485
5486
5487
5488
5489
5490
5491
5492
5493
5494
5495
5496
5497
5498
5499
5500
5501
5502
5503
5504
5505
5506
5507
5508
5509
5510
5511
5512
5513
5514
5515
5516
5517
5518
5519
5520
5521
5522
5523
5524
5525
5526
5527
5528
5529
5530
5531
5532
5533
5534
5535
5536
5537
5538
5539
5540
5541
5542
5543
5544
5545
5546
5547
5548
5549
5550
5551
5552
5553
5554
5555
5556
5557
5558
5559
5560
5561
5562
5563
5564
5565
5566
5567
5568
5569
5570
5571
5572
5573
5574
5575
5576
5577
5578
5579
5580
5581
5582
5583
5584
5585
5586
5587
5588
5589
5590
5591
5592
5593
5594
5595
5596
5597
5598
5599
5600
5601
5602
5603
5604
5605
5606
5607
5608
5609
5610
5611
5612
5613
5614
5615
5616
5617
5618
5619
5620
5621
5622
5623
5624
5625
5626
5627
5628
5629
5630
5631
5632
5633
5634
5635
5636
5637
5638
5639
5640
5641
5642
5643
5644
5645
5646
5647
5648
5649
5650
5651
5652
5653
5654
5655
5656
5657
5658
5659
5660
5661
5662
5663
5664
5665
5666
5667
5668
5669
5670
5671
5672
5673
5674
5675
5676
5677
5678
5679
5680
5681
5682
5683
5684
5685
5686
5687
5688
5689
5690
5691
5692
5693
5694
5695
5696
5697
5698
5699
5700
5701
5702
5703
5704
5705
5706
5707
5708
5709
5710
5711
5712
5713
5714
5715
5716
5717
5718
5719
5720
5721
5722
5723
5724
5725
5726
5727
5728
5729
5730
5731
5732
5733
5734
5735
5736
5737
5738
5739
5740
5741
5742
5743
5744
5745
5746
5747
5748
5749
5750
5751
5752
5753
5754
5755
5756
5757
5758
5759
5760
5761
5762
5763
5764
5765
5766
5767
5768
5769
5770
5771
5772
5773
5774
5775
5776
5777
5778
5779
5780
5781
5782
5783
5784
5785
5786
5787
5788
5789
5790
5791
5792
5793
5794
5795
5796
5797
5798
5799
5800
5801
5802
5803
5804
5805
5806
5807
5808
5809
5810
5811
5812
5813
5814
5815
5816
5817
5818
5819
5820
5821
5822
5823
5824
5825
5826
5827
5828
5829
5830
5831
5832
5833
5834
5835
5836
5837
5838
5839
5840
5841
5842
5843
5844
5845
5846
5847
5848
5849
5850
5851
5852
5853
5854
5855
5856
5857
5858
5859
5860
5861
5862
5863
5864
5865
5866
5867
5868
5869
5870
5871
5872
5873
5874
5875
5876
5877
5878
5879
5880
5881
5882
5883
5884
5885
5886
5887
5888
5889
5890
5891
5892
5893
5894
5895
5896
5897
5898
5899
5900
5901
5902
5903
5904
5905
5906
5907
5908
5909
5910
5911
5912
5913
5914
5915
5916
5917
5918
5919
5920
5921
5922
5923
5924
5925
5926
5927
5928
5929
5930
5931
5932
5933
5934
5935
5936
5937
5938
5939
5940
5941
5942
5943
5944
5945
5946
5947
5948
5949
5950
5951
5952
5953
5954
5955
5956
5957
5958
5959
5960
5961
5962
5963
5964
5965
5966
5967
5968
5969
5970
5971
5972
5973
5974
5975
5976
5977
5978
5979
5980
5981
5982
5983
5984
5985
5986
5987
5988
5989
5990
5991
5992
5993
5994
5995
5996
5997
5998
5999
6000
6001
6002
6003
6004
6005
6006
6007
6008
6009
6010
6011
6012
6013
6014
6015
6016
6017
6018
6019
6020
6021
6022
6023
6024
6025
6026
6027
6028
6029
6030
6031
6032
6033
6034
6035
6036
6037
6038
6039
6040
6041
6042
6043
6044
6045
6046
6047
6048
6049
6050
6051
6052
6053
6054
6055
6056
6057
6058
6059
6060
6061
6062
6063
6064
6065
6066
6067
6068
6069
6070
6071
6072
6073
6074
6075
6076
6077
6078
6079
6080
6081
6082
6083
6084
6085
6086
6087
6088
6089
6090
6091
6092
6093
6094
6095
6096
6097
6098
6099
6100
6101
6102
6103
6104
6105
6106
6107
6108
6109
6110
6111
6112
6113
6114
6115
6116
6117
6118
6119
6120
6121
6122
6123
6124
6125
6126
6127
6128
6129
6130
6131
6132
6133
6134
6135
6136
6137
6138
6139
6140
6141
6142
6143
6144
6145
6146
6147
6148
6149
6150
6151
6152
6153
6154
6155
6156
6157
6158
6159
6160
6161
6162
6163
6164
6165
6166
6167
6168
6169
6170
6171
6172
6173
6174
6175
6176
6177
6178
6179
6180
6181
6182
6183
6184
6185
6186
6187
6188
6189
6190
6191
6192
6193
6194
6195
6196
6197
6198
6199
6200
6201
6202
6203
6204
6205
6206
6207
6208
6209
6210
6211
6212
6213
6214
6215
6216
6217
6218
6219
6220
6221
6222
6223
6224
6225
6226
6227
6228
6229
6230
6231
6232
6233
6234
6235
6236
6237
6238
6239
6240
6241
6242
6243
6244
6245
6246
6247
6248
6249
6250
6251
6252
6253
6254
6255
6256
6257
6258
6259
6260
6261
6262
6263
6264
6265
6266
6267
6268
6269
6270
6271
6272
6273
6274
6275
6276
6277
6278
6279
6280
6281
6282
6283
6284
6285
6286
6287
6288
6289
6290
6291
6292
6293
6294
6295
6296
6297
6298
6299
6300
6301
6302
6303
6304
6305
6306
6307
6308
6309
6310
6311
6312
6313
6314
6315
6316
6317
6318
6319
6320
6321
6322
6323
6324
6325
6326
6327
6328
6329
6330
6331
6332
6333
6334
6335
6336
6337
6338
6339
6340
6341
6342
6343
6344
6345
6346
6347
6348
6349
6350
6351
6352
6353
6354
6355
6356
6357
6358
6359
6360
6361
6362
6363
6364
6365
6366
6367
6368
6369
6370
6371
6372
6373
6374
6375
6376
6377
6378
6379
6380
6381
6382
6383
6384
6385
6386
6387
6388
6389
6390
6391
6392
6393
6394
6395
6396
6397
6398
6399
6400
6401
6402
6403
6404
6405
6406
6407
6408
6409
6410
6411
6412
6413
6414
6415
6416
6417
6418
6419
6420
6421
6422
6423
6424
6425
6426
6427
6428
6429
6430
6431
6432
6433
6434
6435
6436
6437
6438
6439
6440
6441
6442
6443
6444
6445
6446
6447
6448
6449
6450
6451
6452
6453
6454
6455
6456
6457
6458
6459
6460
6461
6462
6463
6464
6465
6466
6467
6468
6469
6470
6471
6472
6473
6474
6475
6476
6477
6478
6479
6480
6481
6482
6483
6484
6485
6486
6487
6488
6489
6490
6491
6492
6493
6494
6495
6496
6497
6498
6499
6500
6501
6502
6503
6504
6505
6506
6507
6508
6509
6510
6511
6512
6513
6514
6515
6516
6517
6518
6519
6520
6521
6522
6523
6524
6525
6526
6527
6528
6529
6530
6531
6532
6533
6534
6535
6536
6537
6538
6539
6540
6541
6542
6543
6544
6545
6546
6547
6548
6549
6550
6551
6552
6553
6554
6555
6556
6557
6558
6559
6560
6561
6562
6563
6564
6565
6566
6567
6568
6569
6570
6571
6572
6573
6574
6575
6576
6577
6578
6579
6580
6581
6582
6583
6584
6585
6586
6587
6588
6589
6590
6591
6592
6593
6594
6595
6596
6597
6598
6599
6600
6601
6602
6603
6604
6605
6606
6607
6608
6609
6610
6611
6612
6613
6614
6615
6616
6617
6618
6619
6620
6621
6622
6623
6624
6625
6626
6627
6628
6629
6630
6631
6632
6633
6634
6635
6636
6637
6638
6639
6640
6641
6642
6643
6644
6645
6646
6647
6648
6649
6650
6651
6652
6653
6654
6655
6656
6657
6658
6659
6660
6661
6662
6663
6664
6665
6666
6667
6668
6669
6670
6671
6672
6673
6674
6675
6676
6677
6678
6679
6680
6681
6682
6683
6684
6685
6686
6687
6688
6689
6690
6691
6692
6693
6694
6695
6696
6697
6698
6699
6700
6701
6702
6703
6704
6705
6706
6707
6708
6709
6710
6711
6712
6713
6714
6715
6716
6717
6718
6719
6720
6721
6722
6723
6724
6725
6726
6727
6728
6729
6730
6731
6732
6733
6734
6735
6736
6737
6738
6739
6740
6741
6742
6743
6744
6745
6746
6747
6748
6749
6750
6751
6752
6753
6754
6755
6756
6757
6758
6759
6760
6761
6762
6763
6764
6765
6766
6767
6768
6769
6770
6771
6772
6773
6774
6775
6776
6777
6778
6779
6780
6781
6782
6783
6784
6785
6786
6787
6788
6789
6790
6791
6792
6793
6794
6795
6796
6797
6798
6799
6800
6801
6802
6803
6804
6805
6806
6807
6808
6809
6810
6811
6812
6813
6814
6815
6816
6817
6818
6819
6820
6821
6822
6823
6824
6825
6826
6827
6828
6829
6830
6831
6832
6833
6834
6835
6836
6837
6838
6839
6840
6841
6842
6843
6844
6845
6846
6847
6848
6849
6850
6851
6852
6853
6854
6855
6856
6857
6858
6859
6860
6861
6862
6863
6864
6865
6866
6867
6868
6869
6870
6871
6872
6873
6874
6875
6876
6877
6878
6879
6880
6881
6882
6883
6884
6885
6886
6887
6888
6889
6890
6891
6892
6893
6894
6895
6896
6897
6898
6899
6900
6901
6902
6903
6904
6905
6906
6907
6908
6909
6910
6911
6912
6913
6914
6915
6916
6917
6918
6919
6920
6921
6922
6923
6924
6925
6926
6927
6928
6929
6930
6931
6932
6933
6934
6935
6936
6937
6938
6939
6940
6941
6942
6943
6944
6945
6946
6947
6948
6949
6950
6951
6952
6953
6954
6955
6956
6957
6958
6959
6960
6961
6962
6963
6964
6965
6966
6967
6968
6969
6970
6971
6972
6973
6974
6975
6976
6977
6978
6979
6980
6981
6982
6983
6984
6985
6986
6987
6988
6989
6990
6991
6992
6993
6994
6995
6996
6997
6998
6999
7000
7001
7002
7003
7004
7005
7006
7007
7008
7009
7010
7011
7012
7013
7014
7015
7016
7017
7018
7019
7020
7021
7022
7023
7024
7025
7026
7027
7028
7029
7030
7031
7032
7033
7034
7035
7036
7037
7038
7039
7040
7041
7042
7043
7044
7045
7046
7047
7048
7049
7050
7051
7052
7053
7054
7055
7056
7057
7058
7059
7060
7061
7062
7063
7064
7065
7066
7067
7068
7069
7070
7071
7072
7073
7074
7075
7076
7077
7078
7079
7080
7081
7082
7083
7084
7085
7086
7087
7088
7089
7090
7091
7092
7093
7094
7095
7096
7097
7098
7099
7100
7101
7102
7103
7104
7105
7106
7107
7108
7109
7110
7111
7112
7113
7114
7115
7116
7117
7118
7119
7120
7121
7122
7123
7124
7125
7126
7127
7128
7129
7130
7131
7132
7133
7134
7135
7136
7137
7138
7139
7140
7141
7142
7143
7144
7145
7146
7147
7148
7149
7150
7151
7152
7153
7154
7155
7156
7157
7158
7159
7160
7161
7162
7163
7164
7165
7166
7167
7168
7169
7170
7171
7172
7173
7174
7175
7176
7177
7178
7179
7180
7181
7182
7183
7184
7185
7186
7187
7188
7189
7190
7191
7192
7193
7194
7195
7196
7197
7198
7199
7200
7201
7202
7203
7204
7205
7206
7207
7208
7209
7210
7211
7212
7213
7214
7215
7216
7217
7218
7219
7220
7221
7222
7223
7224
7225
7226
7227
7228
7229
7230
7231
7232
7233
7234
7235
7236
7237
7238
7239
7240
7241
7242
7243
7244
7245
7246
7247
7248
7249
7250
7251
7252
7253
7254
7255
7256
7257
7258
7259
7260
7261
7262
7263
7264
7265
7266
7267
7268
7269
7270
7271
7272
7273
7274
7275
7276
7277
7278
7279
7280
7281
7282
7283
7284
7285
7286
7287
7288
7289
7290
7291
7292
7293
7294
7295
7296
7297
7298
7299
7300
7301
7302
7303
7304
7305
7306
7307
7308
7309
7310
7311
7312
7313
7314
7315
7316
7317
7318
7319
7320
7321
7322
7323
7324
7325
7326
7327
7328
7329
7330
7331
7332
7333
7334
7335
7336
7337
7338
7339
7340
7341
7342
7343
7344
7345
7346
7347
7348
7349
7350
7351
7352
7353
7354
7355
7356
7357
7358
7359
7360
7361
7362
7363
7364
7365
7366
7367
7368
7369
7370
7371
7372
7373
7374
7375
7376
7377
7378
7379
7380
7381
7382
7383
7384
7385
7386
7387
7388
7389
7390
7391
7392
7393
7394
7395
7396
7397
7398
7399
7400
7401
7402
7403
7404
7405
7406
7407
7408
7409
7410
7411
7412
7413
7414
7415
7416
7417
7418
7419
7420
7421
7422
7423
7424
7425
7426
7427
7428
7429
7430
7431
7432
7433
7434
7435
7436
7437
7438
7439
7440
7441
7442
7443
7444
7445
7446
7447
7448
7449
7450
7451
7452
7453
7454
7455
7456
7457
7458
7459
7460
7461
7462
7463
7464
7465
7466
7467
7468
7469
7470
7471
7472
7473
7474
7475
7476
7477
7478
7479
7480
7481
7482
7483
7484
7485
7486
7487
7488
7489
7490
7491
7492
7493
7494
7495
7496
7497
7498
7499
7500
7501
7502
7503
7504
7505
7506
7507
7508
7509
7510
7511
7512
7513
7514
7515
7516
7517
7518
7519
7520
7521
7522
7523
7524
7525
7526
7527
7528
7529
7530
7531
7532
7533
7534
7535
7536
7537
7538
7539
7540
7541
7542
7543
7544
7545
7546
7547
7548
7549
7550
7551
7552
7553
7554
7555
7556
7557
7558
7559
7560
7561
7562
7563
7564
7565
7566
7567
7568
7569
7570
7571
7572
7573
7574
7575
7576
7577
7578
7579
7580
7581
7582
7583
7584
7585
7586
7587
7588
7589
7590
7591
7592
7593
7594
7595
7596
7597
7598
7599
7600
7601
7602
7603
7604
7605
7606
7607
7608
7609
7610
7611
7612
7613
7614
7615
7616
7617
7618
7619
7620
7621
7622
7623
7624
7625
7626
7627
7628
7629
7630
7631
7632
7633
7634
7635
7636
7637
7638
7639
7640
7641
7642
7643
7644
7645
7646
7647
7648
7649
7650
7651
7652
7653
7654
7655
7656
7657
7658
7659
7660
7661
7662
7663
7664
7665
7666
7667
7668
7669
7670
7671
7672
7673
7674
7675
7676
7677
7678
7679
7680
7681
7682
7683
7684
7685
7686
7687
7688
7689
7690
7691
7692
7693
7694
7695
7696
7697
7698
7699
7700
7701
7702
7703
7704
7705
7706
7707
7708
7709
7710
7711
7712
7713
7714
7715
7716
7717
7718
7719
7720
7721
7722
7723
7724
7725
7726
7727
7728
7729
7730
7731
7732
7733
7734
7735
7736
7737
7738
7739
7740
7741
7742
7743
7744
7745
7746
7747
7748
7749
7750
7751
7752
7753
7754
7755
7756
7757
7758
7759
7760
7761
7762
7763
7764
7765
7766
7767
7768
7769
7770
7771
7772
7773
7774
7775
7776
7777
7778
7779
7780
7781
7782
7783
7784
7785
7786
7787
7788
7789
7790
7791
7792
7793
7794
7795
7796
7797
7798
7799
7800
7801
7802
7803
7804
7805
7806
7807
7808
7809
7810
7811
7812
7813
7814
7815
7816
7817
7818
7819
7820
7821
7822
7823
7824
7825
7826
7827
7828
7829
7830
7831
7832
7833
7834
7835
7836
7837
7838
7839
7840
7841
7842
7843
7844
7845
7846
7847
7848
7849
7850
7851
7852
7853
7854
7855
7856
7857
7858
7859
7860
7861
7862
7863
7864
7865
7866
7867
7868
7869
7870
7871
7872
7873
7874
7875
7876
7877
7878
7879
7880
7881
7882
7883
7884
7885
7886
7887
7888
7889
7890
7891
7892
7893
7894
7895
7896
7897
7898
7899
7900
7901
7902
7903
7904
7905
7906
7907
7908
7909
7910
7911
7912
7913
7914
7915
7916
7917
7918
7919
7920
7921
7922
7923
7924
7925
7926
7927
7928
7929
7930
7931
7932
7933
7934
7935
7936
7937
7938
7939
7940
7941
7942
7943
7944
7945
7946
7947
7948
7949
7950
7951
7952
7953
7954
7955
7956
7957
7958
7959
7960
7961
7962
7963
7964
7965
7966
7967
7968
7969
7970
7971
7972
7973
7974
7975
7976
7977
7978
7979
7980
7981
7982
7983
7984
7985
7986
7987
7988
7989
7990
7991
7992
7993
7994
7995
7996
7997
7998
7999
8000
8001
8002
8003
8004
8005
8006
8007
8008
8009
8010
8011
8012
8013
8014
8015
8016
8017
8018
8019
8020
8021
8022
8023
8024
8025
8026
8027
8028
8029
8030
8031
8032
8033
8034
8035
8036
8037
8038
8039
8040
8041
8042
8043
8044
8045
8046
8047
8048
8049
8050
8051
8052
8053
8054
8055
8056
8057
8058
8059
8060
8061
8062
8063
8064
8065
8066
8067
8068
8069
8070
8071
8072
8073
8074
8075
8076
8077
8078
8079
8080
8081
8082
8083
8084
8085
8086
8087
8088
8089
8090
8091
8092
8093
8094
8095
8096
8097
8098
8099
8100
8101
8102
8103
8104
8105
8106
8107
8108
8109
8110
8111
8112
8113
8114
8115
8116
8117
8118
8119
8120
8121
8122
8123
8124
8125
8126
8127
8128
8129
8130
8131
8132
8133
8134
8135
8136
8137
8138
8139
8140
8141
8142
8143
8144
8145
8146
8147
8148
8149
8150
8151
8152
8153
8154
8155
8156
8157
8158
8159
8160
8161
8162
8163
8164
8165
8166
8167
8168
8169
8170
8171
8172
8173
8174
8175
8176
8177
8178
8179
8180
8181
8182
8183
8184
8185
8186
8187
8188
8189
8190
8191
8192
8193
8194
8195
8196
8197
8198
8199
8200
8201
8202
8203
8204
8205
8206
8207
8208
8209
8210
8211
8212
8213
8214
8215
8216
8217
8218
8219
8220
8221
8222
8223
8224
8225
8226
8227
8228
8229
8230
8231
8232
8233
8234
8235
8236
8237
8238
8239
8240
8241
8242
8243
8244
8245
8246
8247
8248
8249
8250
8251
8252
8253
8254
8255
8256
8257
8258
8259
8260
8261
8262
8263
8264
8265
8266
8267
8268
8269
8270
8271
8272
8273
8274
8275
8276
8277
8278
8279
8280
8281
8282
8283
8284
8285
8286
8287
8288
8289
8290
8291
8292
8293
8294
8295
8296
8297
8298
8299
8300
8301
8302
8303
8304
8305
8306
8307
8308
8309
8310
8311
8312
8313
8314
8315
8316
8317
8318
8319
8320
8321
8322
8323
8324
8325
8326
8327
8328
8329
8330
8331
8332
8333
8334
8335
8336
8337
8338
8339
8340
8341
8342
8343
8344
8345
8346
8347
8348
8349
8350
8351
8352
8353
8354
8355
8356
8357
8358
8359
8360
8361
8362
8363
8364
8365
8366
8367
8368
8369
8370
8371
8372
8373
8374
8375
8376
8377
8378
8379
8380
8381
8382
8383
8384
8385
8386
8387
8388
8389
8390
8391
8392
8393
8394
8395
8396
8397
8398
8399
8400
8401
8402
8403
8404
8405
8406
8407
8408
8409
8410
8411
8412
8413
8414
8415
8416
8417
8418
8419
8420
8421
8422
8423
8424
8425
8426
8427
8428
8429
8430
8431
8432
8433
8434
8435
8436
8437
8438
8439
8440
8441
8442
8443
8444
8445
8446
8447
8448
8449
8450
8451
8452
8453
8454
8455
8456
8457
8458
8459
8460
8461
8462
8463
8464
8465
8466
8467
8468
8469
8470
8471
8472
8473
8474
8475
8476
8477
8478
8479
8480
8481
8482
8483
8484
8485
8486
8487
8488
8489
8490
8491
8492
8493
8494
8495
8496
8497
8498
8499
8500
8501
8502
8503
8504
8505
8506
8507
8508
8509
8510
8511
8512
8513
8514
8515
8516
8517
8518
8519
8520
8521
8522
8523
8524
8525
8526
8527
8528
8529
8530
8531
8532
8533
8534
8535
8536
8537
8538
8539
8540
8541
8542
8543
8544
8545
8546
8547
8548
8549
8550
8551
8552
8553
8554
8555
8556
8557
8558
8559
8560
8561
8562
8563
8564
8565
8566
8567
8568
8569
8570
8571
8572
8573
8574
8575
8576
8577
8578
8579
8580
8581
8582
8583
8584
8585
8586
8587
8588
8589
8590
8591
8592
8593
8594
8595
8596
8597
8598
8599
8600
8601
8602
8603
8604
8605
8606
8607
8608
8609
8610
8611
8612
8613
8614
8615
8616
8617
8618
8619
8620
8621
8622
8623
8624
8625
8626
8627
8628
8629
8630
8631
8632
8633
8634
8635
8636
8637
8638
8639
8640
8641
8642
8643
8644
8645
8646
8647
8648
8649
8650
8651
8652
8653
8654
8655
8656
8657
8658
8659
8660
8661
8662
8663
8664
8665
8666
8667
8668
8669
8670
8671
8672
8673
8674
8675
8676
8677
8678
8679
8680
8681
8682
8683
8684
8685
8686
8687
8688
8689
8690
8691
8692
8693
8694
8695
8696
8697
8698
8699
8700
8701
8702
8703
8704
8705
8706
8707
8708
8709
8710
8711
8712
8713
8714
8715
8716
8717
8718
8719
8720
8721
8722
8723
8724
8725
8726
8727
8728
8729
8730
8731
8732
8733
8734
8735
8736
8737
8738
8739
8740
8741
8742
8743
8744
8745
8746
8747
8748
8749
8750
8751
8752
8753
8754
8755
8756
8757
8758
8759
8760
8761
8762
8763
8764
8765
8766
8767
8768
8769
8770
8771
8772
8773
8774
8775
8776
8777
8778
8779
8780
8781
8782
8783
8784
8785
8786
8787
8788
8789
8790
8791
8792
8793
8794
8795
8796
8797
8798
8799
8800
8801
8802
8803
8804
8805
8806
8807
8808
8809
8810
8811
8812
8813
8814
8815
8816
8817
8818
8819
8820
8821
8822
8823
8824
8825
8826
8827
8828
8829
8830
8831
8832
8833
8834
8835
8836
8837
8838
8839
8840
8841
8842
8843
8844
8845
8846
8847
8848
8849
8850
8851
8852
8853
8854
8855
8856
8857
8858
8859
8860
8861
8862
8863
8864
8865
8866
8867
8868
8869
8870
8871
8872
8873
8874
8875
8876
8877
8878
8879
8880
8881
8882
8883
8884
8885
8886
8887
8888
8889
8890
8891
8892
8893
8894
8895
8896
8897
8898
8899
8900
8901
8902
8903
8904
8905
8906
8907
8908
8909
8910
8911
8912
8913
8914
8915
8916
8917
8918
8919
8920
8921
8922
8923
8924
8925
8926
8927
8928
8929
8930
8931
8932
8933
8934
8935
8936
8937
8938
8939
8940
8941
8942
8943
8944
8945
8946
8947
8948
8949
8950
8951
8952
8953
8954
8955
8956
8957
8958
8959
8960
8961
8962
8963
8964
8965
8966
8967
8968
8969
8970
8971
8972
8973
8974
8975
8976
8977
8978
8979
8980
8981
8982
8983
8984
8985
8986
8987
8988
8989
8990
8991
8992
8993
8994
8995
8996
8997
8998
8999
9000
9001
9002
9003
9004
9005
9006
9007
9008
9009
9010
9011
9012
9013
9014
9015
9016
9017
9018
9019
9020
9021
9022
9023
9024
9025
9026
9027
9028
9029
9030
9031
9032
9033
9034
9035
9036
9037
9038
9039
9040
9041
9042
9043
9044
9045
9046
9047
9048
9049
9050
9051
9052
9053
9054
9055
9056
9057
9058
9059
9060
9061
9062
9063
9064
9065
9066
9067
9068
9069
9070
9071
9072
9073
9074
9075
9076
9077
9078
9079
9080
9081
9082
9083
9084
9085
9086
9087
9088
9089
9090
9091
9092
9093
9094
9095
9096
9097
9098
9099
9100
9101
9102
9103
9104
9105
9106
9107
9108
9109
9110
9111
9112
9113
9114
9115
9116
9117
9118
9119
9120
9121
9122
9123
9124
9125
9126
9127
9128
9129
9130
9131
9132
9133
9134
9135
9136
9137
9138
9139
9140
9141
9142
9143
9144
9145
9146
9147
9148
9149
9150
9151
9152
9153
9154
9155
9156
9157
9158
9159
9160
9161
9162
9163
9164
9165
9166
9167
9168
9169
9170
9171
9172
9173
9174
9175
9176
9177
9178
9179
9180
9181
9182
9183
9184
9185
9186
9187
9188
9189
9190
9191
9192
9193
9194
9195
9196
9197
9198
9199
9200
9201
9202
9203
9204
9205
9206
9207
9208
9209
9210
9211
9212
9213
9214
9215
9216
9217
9218
9219
9220
9221
9222
9223
9224
9225
9226
9227
9228
9229
9230
9231
9232
9233
9234
9235
9236
9237
9238
9239
9240
9241
9242
9243
9244
9245
9246
9247
9248
9249
9250
9251
9252
9253
9254
9255
9256
9257
9258
9259
9260
9261
9262
9263
9264
9265
9266
9267
9268
9269
9270
9271
9272
9273
9274
9275
9276
9277
9278
9279
9280
9281
9282
9283
9284
9285
9286
9287
9288
9289
9290
9291
9292
9293
9294
9295
9296
9297
9298
9299
9300
9301
9302
9303
9304
9305
9306
9307
9308
9309
9310
9311
9312
9313
9314
9315
9316
9317
9318
9319
9320
9321
9322
9323
9324
9325
9326
9327
9328
9329
9330
9331
9332
9333
9334
9335
9336
9337
9338
9339
9340
9341
9342
9343
9344
9345
9346
9347
9348
9349
9350
9351
9352
9353
9354
9355
9356
9357
9358
9359
9360
9361
9362
9363
9364
9365
9366
9367
9368
9369
9370
9371
9372
9373
9374
9375
9376
9377
9378
9379
9380
9381
9382
9383
9384
9385
9386
9387
9388
9389
9390
9391
9392
9393
9394
9395
9396
9397
9398
9399
9400
9401
9402
9403
9404
9405
9406
9407
9408
9409
9410
9411
9412
9413
9414
9415
9416
9417
9418
9419
9420
9421
9422
9423
9424
9425
9426
9427
9428
9429
9430
9431
9432
9433
9434
9435
9436
9437
9438
9439
9440
9441
9442
9443
9444
9445
9446
9447
9448
9449
9450
9451
9452
9453
9454
9455
9456
9457
9458
9459
9460
9461
9462
9463
9464
9465
9466
9467
9468
9469
9470
9471
9472
9473
9474
9475
9476
9477
9478
9479
9480
9481
9482
9483
9484
9485
9486
9487
9488
9489
9490
9491
9492
9493
9494
9495
9496
9497
9498
9499
9500
9501
9502
9503
9504
9505
9506
9507
9508
9509
9510
9511
9512
9513
9514
9515
9516
9517
9518
9519
9520
9521
9522
9523
9524
9525
9526
9527
9528
9529
9530
9531
9532
9533
9534
9535
9536
9537
9538
9539
9540
9541
9542
9543
9544
9545
9546
9547
9548
9549
9550
9551
9552
9553
9554
9555
9556
9557
9558
9559
9560
9561
9562
9563
9564
9565
9566
9567
9568
9569
9570
9571
9572
9573
9574
9575
9576
9577
9578
9579
9580
9581
9582
9583
9584
9585
9586
9587
9588
9589
9590
9591
9592
9593
9594
9595
9596
9597
9598
9599
9600
9601
9602
9603
9604
9605
9606
9607
9608
9609
9610
9611
9612
9613
9614
9615
9616
9617
9618
9619
9620
9621
9622
9623
9624
9625
9626
9627
9628
9629
9630
9631
9632
9633
9634
9635
9636
9637
9638
9639
9640
9641
9642
9643
9644
9645
9646
9647
9648
9649
9650
9651
9652
9653
9654
9655
9656
9657
9658
9659
9660
9661
9662
9663
9664
9665
9666
9667
9668
9669
9670
9671
9672
9673
9674
9675
9676
9677
9678
9679
9680
9681
9682
9683
9684
9685
9686
9687
9688
9689
9690
9691
9692
9693
9694
9695
9696
9697
9698
9699
9700
9701
9702
9703
9704
9705
9706
9707
9708
9709
9710
9711
9712
9713
9714
9715
9716
9717
9718
9719
9720
9721
9722
9723
9724
9725
9726
9727
9728
9729
9730
9731
9732
9733
9734
9735
9736
9737
9738
9739
9740
9741
9742
9743
9744
9745
9746
9747
9748
9749
9750
9751
9752
9753
9754
9755
9756
9757
9758
9759
9760
9761
9762
9763
9764
9765
9766
9767
9768
9769
9770
9771
9772
9773
9774
9775
9776
9777
9778
9779
9780
9781
9782
9783
9784
9785
9786
9787
9788
9789
9790
9791
9792
9793
9794
9795
9796
9797
9798
9799
9800
9801
9802
9803
9804
9805
9806
9807
9808
9809
9810
9811
9812
9813
9814
9815
9816
9817
9818
9819
9820
9821
9822
9823
9824
9825
9826
9827
9828
9829
9830
9831
9832
9833
9834
9835
9836
9837
9838
9839
9840
9841
9842
9843
9844
9845
9846
9847
9848
9849
9850
9851
9852
9853
9854
9855
9856
9857
9858
9859
9860
9861
9862
9863
9864
9865
9866
9867
9868
9869
9870
9871
9872
9873
9874
9875
9876
9877
9878
9879
9880
9881
9882
9883
9884
9885
9886
9887
9888
9889
9890
9891
9892
9893
9894
9895
9896
9897
9898
9899
9900
9901
9902
9903
9904
9905
9906
9907
9908
9909
9910
9911
9912
9913
9914
9915
9916
9917
9918
9919
9920
9921
9922
9923
9924
9925
9926
9927
9928
9929
9930
9931
9932
9933
9934
9935
9936
9937
9938
9939
9940
9941
9942
9943
9944
9945
9946
9947
9948
9949
9950
9951
9952
9953
9954
9955
9956
9957
9958
9959
9960
9961
9962
9963
9964
9965
9966
9967
9968
9969
9970
9971
9972
9973
9974
9975
9976
9977
9978
9979
9980
9981
9982
9983
9984
9985
9986
9987
9988
9989
9990
9991
9992
9993
9994
9995
9996
9997
9998
9999
10000
10001
10002
10003
10004
10005
10006
10007
10008
10009
10010
10011
10012
10013
10014
10015
10016
10017
10018
10019
10020
10021
10022
10023
10024
10025
10026
10027
10028
10029
10030
10031
10032
10033
10034
10035
10036
10037
10038
10039
10040
10041
10042
10043
10044
10045
10046
10047
10048
10049
10050
10051
10052
10053
10054
10055
10056
10057
10058
10059
10060
10061
10062
10063
10064
10065
10066
10067
10068
10069
10070
10071
10072
10073
10074
10075
10076
10077
10078
10079
10080
10081
10082
10083
10084
10085
10086
10087
10088
10089
10090
10091
10092
10093
10094
10095
10096
10097
10098
10099
10100
10101
10102
10103
10104
10105
10106
10107
10108
10109
10110
10111
10112
10113
10114
10115
10116
10117
10118
10119
10120
10121
10122
10123
10124
10125
10126
10127
10128
10129
10130
10131
10132
10133
10134
10135
10136
10137
10138
10139
10140
10141
10142
10143
10144
10145
10146
10147
10148
10149
10150
10151
10152
10153
10154
10155
10156
10157
10158
10159
10160
10161
10162
10163
10164
10165
10166
10167
10168
10169
10170
10171
10172
10173
10174
10175
10176
10177
10178
10179
10180
10181
10182
10183
10184
10185
10186
10187
10188
10189
10190
10191
10192
10193
10194
10195
10196
10197
10198
10199
10200
10201
10202
10203
10204
10205
10206
10207
10208
10209
10210
10211
10212
10213
10214
10215
10216
10217
10218
10219
10220
10221
10222
10223
10224
10225
10226
10227
10228
10229
10230
10231
10232
10233
10234
10235
10236
10237
10238
10239
10240
10241
10242
10243
10244
10245
10246
10247
10248
10249
10250
10251
10252
10253
10254
10255
10256
10257
10258
10259
10260
10261
10262
10263
10264
10265
10266
10267
10268
10269
10270
10271
10272
10273
10274
10275
10276
10277
10278
10279
10280
10281
10282
10283
10284
10285
10286
10287
10288
10289
10290
10291
10292
10293
10294
10295
10296
10297
10298
10299
10300
10301
10302
10303
10304
10305
10306
10307
10308
10309
10310
10311
10312
10313
10314
10315
10316
10317
10318
10319
10320
10321
10322
10323
10324
10325
10326
10327
10328
10329
10330
10331
10332
10333
10334
10335
10336
10337
10338
10339
10340
10341
10342
10343
10344
10345
10346
10347
10348
10349
10350
10351
10352
10353
10354
10355
10356
10357
10358
10359
10360
10361
10362
10363
10364
10365
10366
10367
10368
10369
10370
10371
10372
10373
10374
10375
10376
10377
10378
10379
10380
10381
10382
10383
10384
10385
10386
10387
10388
10389
10390
10391
10392
10393
10394
10395
10396
10397
10398
10399
10400
10401
10402
10403
10404
10405
10406
10407
10408
10409
10410
10411
10412
10413
10414
10415
10416
10417
10418
10419
10420
10421
10422
10423
10424
10425
10426
10427
10428
10429
10430
10431
10432
10433
10434
10435
10436
10437
10438
10439
10440
10441
10442
10443
10444
10445
10446
10447
10448
10449
10450
10451
10452
10453
10454
10455
10456
10457
10458
10459
10460
10461
10462
10463
10464
10465
10466
10467
10468
10469
10470
10471
10472
10473
10474
10475
10476
10477
10478
10479
10480
10481
10482
10483
10484
10485
10486
10487
10488
10489
10490
10491
10492
10493
10494
10495
10496
10497
10498
10499
10500
10501
10502
10503
10504
10505
10506
10507
10508
10509
10510
10511
10512
10513
10514
10515
10516
10517
10518
10519
10520
10521
10522
10523
10524
10525
10526
10527
10528
10529
10530
10531
10532
10533
10534
10535
10536
10537
10538
10539
10540
10541
10542
10543
10544
10545
10546
10547
10548
10549
10550
10551
10552
10553
10554
10555
10556
10557
10558
10559
10560
10561
10562
10563
10564
10565
10566
10567
10568
10569
10570
10571
10572
10573
10574
10575
10576
10577
10578
10579
10580
10581
10582
10583
10584
10585
10586
10587
10588
10589
10590
10591
10592
10593
10594
10595
10596
10597
10598
10599
10600
10601
10602
10603
10604
10605
10606
10607
10608
10609
10610
10611
10612
10613
10614
10615
10616
10617
10618
10619
10620
10621
10622
10623
10624
10625
10626
10627
10628
10629
10630
10631
10632
10633
10634
10635
10636
10637
10638
10639
10640
10641
10642
10643
10644
10645
10646
10647
10648
10649
10650
10651
10652
10653
10654
10655
10656
10657
10658
10659
10660
10661
10662
10663
10664
10665
10666
10667
10668
10669
10670
10671
10672
10673
10674
10675
10676
10677
10678
10679
10680
10681
10682
10683
10684
10685
10686
10687
10688
10689
10690
10691
10692
10693
10694
10695
10696
10697
10698
10699
10700
10701
10702
10703
10704
10705
10706
10707
10708
10709
10710
10711
10712
10713
10714
10715
10716
10717
10718
10719
10720
10721
10722
10723
10724
10725
10726
10727
10728
10729
10730
10731
10732
10733
10734
10735
10736
10737
10738
10739
10740
10741
10742
10743
10744
10745
10746
10747
10748
10749
10750
10751
10752
10753
10754
10755
10756
10757
10758
10759
10760
10761
10762
10763
10764
10765
10766
10767
10768
10769
10770
10771
10772
10773
10774
10775
10776
10777
10778
10779
10780
10781
10782
10783
10784
10785
10786
10787
10788
10789
10790
10791
10792
10793
10794
10795
10796
10797
10798
10799
10800
10801
10802
10803
10804
10805
10806
10807
10808
10809
10810
10811
10812
10813
10814
10815
10816
10817
10818
10819
10820
10821
10822
10823
10824
10825
10826
10827
10828
10829
10830
10831
10832
10833
10834
10835
10836
10837
10838
10839
10840
10841
10842
10843
10844
10845
10846
10847
10848
10849
10850
10851
10852
10853
10854
10855
10856
10857
10858
10859
10860
10861
10862
10863
10864
10865
10866
10867
10868
10869
10870
10871
10872
10873
10874
10875
10876
10877
10878
10879
10880
10881
10882
10883
10884
10885
10886
10887
10888
10889
10890
10891
10892
10893
10894
10895
10896
10897
10898
10899
10900
10901
10902
10903
10904
10905
10906
10907
10908
10909
10910
10911
10912
10913
10914
10915
10916
10917
10918
10919
10920
10921
10922
10923
10924
10925
10926
10927
10928
10929
10930
10931
10932
10933
10934
10935
10936
10937
10938
10939
10940
10941
10942
10943
10944
10945
10946
10947
10948
10949
10950
10951
10952
10953
10954
10955
10956
10957
10958
10959
10960
10961
10962
10963
10964
10965
10966
10967
10968
10969
10970
10971
10972
10973
10974
10975
10976
10977
10978
10979
10980
10981
10982
10983
10984
10985
10986
10987
10988
10989
10990
10991
10992
10993
10994
10995
10996
10997
10998
10999
11000
11001
11002
11003
11004
11005
11006
11007
11008
11009
11010
11011
11012
11013
11014
11015
11016
11017
11018
11019
11020
11021
11022
11023
11024
11025
11026
11027
11028
11029
11030
11031
11032
11033
11034
11035
11036
11037
11038
11039
11040
11041
11042
11043
11044
11045
11046
11047
11048
11049
11050
11051
11052
11053
11054
11055
11056
11057
11058
11059
11060
11061
11062
11063
11064
11065
11066
11067
11068
11069
11070
11071
11072
11073
11074
11075
11076
11077
11078
11079
11080
11081
11082
11083
11084
11085
11086
11087
11088
11089
11090
11091
11092
11093
11094
11095
11096
11097
11098
11099
11100
11101
11102
11103
11104
11105
11106
11107
11108
11109
11110
11111
11112
11113
11114
11115
11116
11117
11118
11119
11120
11121
11122
11123
11124
11125
11126
11127
11128
11129
11130
11131
11132
11133
11134
11135
11136
11137
11138
11139
11140
11141
11142
11143
11144
11145
11146
11147
11148
11149
11150
11151
11152
11153
11154
11155
11156
11157
11158
11159
11160
11161
11162
11163
11164
11165
11166
11167
11168
11169
11170
11171
11172
11173
11174
11175
11176
11177
11178
11179
11180
11181
11182
11183
11184
11185
11186
11187
11188
11189
11190
11191
11192
11193
11194
11195
11196
11197
11198
11199
11200
11201
11202
11203
11204
11205
11206
11207
11208
11209
11210
11211
11212
11213
11214
11215
11216
11217
11218
11219
11220
11221
11222
11223
11224
11225
11226
11227
11228
11229
11230
11231
11232
11233
11234
11235
11236
11237
11238
11239
11240
11241
11242
11243
11244
11245
11246
11247
11248
11249
11250
11251
11252
11253
11254
11255
11256
11257
11258
11259
11260
11261
11262
11263
11264
11265
11266
11267
11268
11269
11270
11271
11272
11273
11274
11275
11276
11277
11278
11279
11280
11281
11282
11283
11284
11285
11286
11287
11288
11289
11290
11291
11292
11293
11294
11295
11296
11297
11298
11299
11300
11301
11302
11303
11304
11305
11306
11307
11308
11309
11310
11311
11312
11313
11314
11315
11316
11317
11318
11319
11320
11321
11322
11323
11324
11325
11326
11327
11328
11329
11330
11331
11332
11333
11334
11335
11336
11337
11338
11339
11340
11341
11342
11343
11344
11345
11346
11347
11348
11349
11350
11351
11352
11353
11354
11355
11356
11357
11358
11359
11360
11361
11362
11363
11364
11365
11366
11367
11368
11369
11370
11371
11372
11373
11374
11375
11376
11377
11378
11379
11380
11381
11382
11383
11384
11385
11386
11387
11388
11389
11390
11391
11392
11393
11394
11395
11396
11397
11398
11399
11400
11401
11402
11403
11404
11405
11406
11407
11408
11409
11410
11411
11412
11413
11414
11415
11416
11417
11418
11419
11420
11421
11422
11423
11424
11425
11426
11427
11428
11429
11430
11431
11432
11433
11434
11435
11436
11437
11438
11439
11440
11441
11442
11443
11444
11445
11446
11447
11448
11449
11450
11451
11452
11453
11454
11455
11456
11457
11458
11459
11460
11461
11462
11463
11464
11465
11466
11467
11468
11469
11470
11471
11472
11473
11474
11475
11476
11477
11478
11479
11480
11481
11482
11483
11484
11485
11486
11487
11488
11489
11490
11491
11492
11493
11494
11495
11496
11497
11498
11499
11500
11501
11502
11503
11504
11505
11506
11507
11508
11509
11510
11511
11512
11513
11514
11515
11516
11517
11518
11519
11520
11521
11522
11523
11524
11525
11526
11527
11528
11529
11530
11531
11532
11533
11534
11535
11536
11537
11538
11539
11540
11541
11542
11543
11544
11545
11546
11547
11548
11549
11550
11551
11552
11553
11554
11555
11556
11557
11558
11559
11560
11561
11562
11563
11564
11565
11566
11567
11568
11569
11570
11571
11572
11573
11574
11575
11576
11577
11578
11579
11580
11581
11582
11583
11584
11585
11586
11587
11588
11589
11590
11591
11592
11593
11594
11595
11596
11597
11598
11599
11600
11601
11602
11603
11604
11605
11606
11607
11608
11609
11610
11611
11612
11613
11614
11615
11616
11617
11618
11619
11620
11621
11622
11623
11624
11625
11626
11627
11628
11629
11630
11631
11632
11633
11634
11635
11636
11637
11638
11639
11640
11641
11642
11643
11644
11645
11646
11647
11648
11649
11650
11651
11652
11653
11654
11655
11656
11657
11658
11659
11660
11661
11662
11663
11664
11665
11666
11667
11668
11669
11670
11671
11672
11673
11674
11675
11676
11677
11678
11679
11680
11681
11682
11683
11684
11685
11686
11687
11688
11689
11690
11691
11692
11693
11694
11695
11696
11697
11698
11699
11700
11701
11702
11703
11704
11705
11706
11707
11708
11709
11710
11711
11712
11713
11714
11715
11716
11717
11718
11719
11720
11721
11722
11723
11724
11725
11726
11727
11728
11729
11730
11731
11732
11733
11734
11735
11736
11737
11738
11739
11740
11741
11742
11743
11744
11745
11746
11747
11748
11749
11750
11751
11752
11753
11754
11755
11756
11757
11758
11759
11760
11761
11762
11763
11764
11765
11766
11767
11768
11769
11770
11771
11772
11773
11774
11775
11776
11777
11778
11779
11780
11781
11782
11783
11784
11785
11786
11787
11788
11789
11790
11791
11792
11793
11794
11795
11796
11797
11798
11799
11800
11801
11802
11803
11804
11805
11806
11807
11808
11809
11810
11811
11812
11813
11814
11815
11816
11817
11818
11819
11820
11821
11822
11823
11824
11825
11826
11827
11828
11829
11830
11831
11832
11833
11834
11835
11836
11837
11838
11839
11840
11841
11842
11843
11844
11845
11846
11847
11848
11849
11850
11851
11852
11853
11854
11855
11856
11857
11858
11859
11860
11861
11862
11863
11864
11865
11866
11867
11868
11869
11870
11871
11872
11873
11874
11875
11876
11877
11878
11879
11880
11881
11882
11883
11884
11885
11886
11887
11888
11889
11890
11891
11892
11893
11894
11895
11896
11897
11898
11899
11900
11901
11902
11903
11904
11905
11906
11907
11908
11909
11910
11911
11912
11913
11914
11915
11916
11917
11918
11919
11920
11921
11922
11923
11924
11925
11926
11927
11928
11929
11930
11931
11932
11933
11934
11935
11936
11937
11938
11939
11940
11941
11942
11943
11944
11945
11946
11947
11948
11949
11950
11951
11952
11953
11954
11955
11956
11957
11958
11959
11960
11961
11962
11963
11964
11965
11966
11967
11968
11969
11970
11971
11972
11973
11974
11975
11976
11977
11978
11979
11980
11981
11982
11983
11984
11985
11986
11987
11988
11989
11990
11991
11992
11993
11994
11995
11996
11997
11998
11999
12000
12001
12002
12003
12004
12005
12006
12007
12008
12009
12010
12011
12012
12013
12014
12015
12016
12017
12018
12019
12020
12021
12022
12023
12024
12025
12026
12027
12028
12029
12030
12031
12032
12033
12034
12035
12036
12037
12038
12039
12040
12041
12042
12043
12044
12045
12046
12047
12048
12049
12050
12051
12052
12053
12054
12055
12056
12057
12058
12059
12060
12061
12062
12063
12064
12065
12066
12067
12068
12069
12070
12071
12072
12073
12074
12075
12076
12077
12078
12079
12080
12081
12082
12083
12084
12085
12086
12087
12088
12089
12090
12091
12092
12093
12094
12095
12096
12097
12098
12099
12100
12101
|
// FIXME: if an exception is thrown, we shouldn't necessarily cache...
// FIXME: there's some annoying duplication of code in the various versioned mains
// add the Range header in there too. should return 206
// FIXME: cgi per-request arena allocator
// i need to add a bunch of type templates for validations... mayne @NotNull or NotNull!
// FIXME: I might make a cgi proxy class which can change things; the underlying one is still immutable
// but the later one can edit and simplify the api. You'd have to use the subclass tho!
/*
void foo(int f, @("test") string s) {}
void main() {
static if(is(typeof(foo) Params == __parameters))
//pragma(msg, __traits(getAttributes, Params[0]));
pragma(msg, __traits(getAttributes, Params[1..2]));
else
pragma(msg, "fail");
}
*/
// Note: spawn-fcgi can help with fastcgi on nginx
// FIXME: to do: add openssl optionally
// make sure embedded_httpd doesn't send two answers if one writes() then dies
// future direction: websocket as a separate process that you can sendfile to for an async passoff of those long-lived connections
/*
Session manager process: it spawns a new process, passing a
command line argument, to just be a little key/value store
of some serializable struct. On Windows, it CreateProcess.
On Linux, it can just fork or maybe fork/exec. The session
key is in a cookie.
Server-side event process: spawns an async manager. You can
push stuff out to channel ids and the clients listen to it.
websocket process: spawns an async handler. They can talk to
each other or get info from a cgi request.
Tempting to put web.d 2.0 in here. It would:
* map urls and form generation to functions
* have data presentation magic
* do the skeleton stuff like 1.0
* auto-cache generated stuff in files (at least if pure?)
* introspect functions in json for consumers
https://linux.die.net/man/3/posix_spawn
*/
/++
Provides a uniform server-side API for CGI, FastCGI, SCGI, and HTTP web applications. Offers both lower- and higher- level api options among other common (optional) things like websocket and event source serving support, session management, and job scheduling.
---
import arsd.cgi;
// Instead of writing your own main(), you should write a function
// that takes a Cgi param, and use mixin GenericMain
// for maximum compatibility with different web servers.
void hello(Cgi cgi) {
cgi.setResponseContentType("text/plain");
if("name" in cgi.get)
cgi.write("Hello, " ~ cgi.get["name"]);
else
cgi.write("Hello, world!");
}
mixin GenericMain!hello;
---
Or:
---
import arsd.cgi;
class MyApi : WebObject {
@UrlName("")
string hello(string name = null) {
if(name is null)
return "Hello, world!";
else
return "Hello, " ~ name;
}
}
mixin DispatcherMain!(
"/".serveApi!MyApi
);
---
$(NOTE
Please note that using the higher-level api will add a dependency on arsd.dom and arsd.jsvar to your application.
If you use `dmd -i` or `ldc2 -i` to build, it will just work, but with dub, you will have do `dub add arsd-official:jsvar`
and `dub add arsd-official:dom` yourself.
)
Test on console (works in any interface mode):
$(CONSOLE
$ ./cgi_hello GET / name=whatever
)
If using http version (default on `dub` builds, or on custom builds when passing `-version=embedded_httpd` to dmd):
$(CONSOLE
$ ./cgi_hello --port 8080
# now you can go to http://localhost:8080/?name=whatever
)
Please note: the default port for http is 8085 and for scgi is 4000. I recommend you set your own by the command line argument in a startup script instead of relying on any hard coded defaults. It is possible though to code your own with [RequestServer], however.
Build_Configurations:
cgi.d tries to be flexible to meet your needs. It is possible to configure it both at runtime (by writing your own `main` function and constructing a [RequestServer] object) or at compile time using the `version` switch to the compiler or a dub `subConfiguration`.
If you are using `dub`, use:
```sdlang
subConfiguration "arsd-official:cgi" "VALUE_HERE"
```
or to dub.json:
```json
"subConfigurations": {"arsd-official:cgi": "VALUE_HERE"}
```
to change versions. The possible options for `VALUE_HERE` are:
$(LIST
* `embedded_httpd` for the embedded httpd version (built-in web server). This is the default for dub builds. You can run the program then connect directly to it from your browser. Note: prior to version 11, this would be embedded_httpd_processes on Linux and embedded_httpd_threads everywhere else. It now means embedded_httpd_hybrid everywhere supported and embedded_httpd_threads everywhere else.
* `cgi` for traditional cgi binaries. These are run by an outside web server as-needed to handle requests.
* `fastcgi` for FastCGI builds. FastCGI is managed from an outside helper, there's one built into Microsoft IIS, Apache httpd, and Lighttpd, and a generic program you can use with nginx called `spawn-fcgi`. If you don't already know how to use it, I suggest you use one of the other modes.
* `scgi` for SCGI builds. SCGI is a simplified form of FastCGI, where you run the server as an application service which is proxied by your outside webserver.
* `stdio_http` for speaking raw http over stdin and stdout. This is made for systemd services. See [RequestServer.serveSingleHttpConnectionOnStdio] for more information.
)
With dmd, use:
$(TABLE_ROWS
* + Interfaces
+ (mutually exclusive)
* - `-version=plain_cgi`
- The default building the module alone without dub - a traditional, plain CGI executable will be generated.
* - `-version=embedded_httpd`
- A HTTP server will be embedded in the generated executable. This is default when building with dub.
* - `-version=fastcgi`
- A FastCGI executable will be generated.
* - `-version=scgi`
- A SCGI (SimpleCGI) executable will be generated.
* - `-version=embedded_httpd_hybrid`
- A HTTP server that uses a combination of processes, threads, and fibers to better handle large numbers of idle connections. Recommended if you are going to serve websockets in a non-local application.
* - `-version=embedded_httpd_threads`
- The embedded HTTP server will use a single process with a thread pool. (use instead of plain `embedded_httpd` if you want this specific implementation)
* - `-version=embedded_httpd_processes`
- The embedded HTTP server will use a prefork style process pool. (use instead of plain `embedded_httpd` if you want this specific implementation)
* - `-version=embedded_httpd_processes_accept_after_fork`
- It will call accept() in each child process, after forking. This is currently the only option, though I am experimenting with other ideas. You probably should NOT specify this right now.
* - `-version=stdio_http`
- The embedded HTTP server will be spoken over stdin and stdout.
* + Tweaks
+ (can be used together with others)
* - `-version=cgi_with_websocket`
- The CGI class has websocket server support. (This is on by default now.)
* - `-version=with_openssl`
- not currently used
* - `-version=cgi_embedded_sessions`
- The session server will be embedded in the cgi.d server process
* - `-version=cgi_session_server_process`
- The session will be provided in a separate process, provided by cgi.d.
)
For example,
For CGI, `dmd yourfile.d cgi.d` then put the executable in your cgi-bin directory.
For FastCGI: `dmd yourfile.d cgi.d -version=fastcgi` and run it. spawn-fcgi helps on nginx. You can put the file in the directory for Apache. On IIS, run it with a port on the command line (this causes it to call FCGX_OpenSocket, which can work on nginx too).
For SCGI: `dmd yourfile.d cgi.d -version=scgi` and run the executable, providing a port number on the command line.
For an embedded HTTP server, run `dmd yourfile.d cgi.d -version=embedded_httpd` and run the generated program. It listens on port 8085 by default. You can change this on the command line with the --port option when running your program.
Simulating_requests:
If you are using one of the [GenericMain] or [DispatcherMain] mixins, or main with your own call to [RequestServer.trySimulatedRequest], you can simulate requests from your command-ine shell. Call the program like this:
$(CONSOLE
./yourprogram GET / name=adr
)
And it will print the result to stdout instead of running a server, regardless of build more..
CGI_Setup_tips:
On Apache, you may do `SetHandler cgi-script` in your `.htaccess` file to set a particular file to be run through the cgi program. Note that all "subdirectories" of it also run the program; if you configure `/foo` to be a cgi script, then going to `/foo/bar` will call your cgi handler function with `cgi.pathInfo == "/bar"`.
Overview_Of_Basic_Concepts:
cgi.d offers both lower-level handler apis as well as higher-level auto-dispatcher apis. For a lower-level handler function, you'll probably want to review the following functions:
Input: [Cgi.get], [Cgi.post], [Cgi.request], [Cgi.files], [Cgi.cookies], [Cgi.pathInfo], [Cgi.requestMethod],
and HTTP headers ([Cgi.headers], [Cgi.userAgent], [Cgi.referrer], [Cgi.accept], [Cgi.authorization], [Cgi.lastEventId])
Output: [Cgi.write], [Cgi.header], [Cgi.setResponseStatus], [Cgi.setResponseContentType], [Cgi.gzipResponse]
Cookies: [Cgi.setCookie], [Cgi.clearCookie], [Cgi.cookie], [Cgi.cookies]
Caching: [Cgi.setResponseExpires], [Cgi.updateResponseExpires], [Cgi.setCache]
Redirections: [Cgi.setResponseLocation]
Other Information: [Cgi.remoteAddress], [Cgi.https], [Cgi.port], [Cgi.scriptName], [Cgi.requestUri], [Cgi.getCurrentCompleteUri], [Cgi.onRequestBodyDataReceived]
Websockets: [Websocket], [websocketRequested], [acceptWebsocket]. For websockets, use the `embedded_httpd_hybrid` build mode for best results, because it is optimized for handling large numbers of idle connections compared to the other build modes.
Overriding behavior for special cases streaming input data: see the virtual functions [Cgi.handleIncomingDataChunk], [Cgi.prepareForIncomingDataChunks], [Cgi.cleanUpPostDataState]
A basic program using the lower-level api might look like:
---
import arsd.cgi;
// you write a request handler which always takes a Cgi object
void handler(Cgi cgi) {
/+
when the user goes to your site, suppose you are being hosted at http://example.com/yourapp
If the user goes to http://example.com/yourapp/test?name=value
then the url will be parsed out into the following pieces:
cgi.pathInfo == "/test". This is everything after yourapp's name. (If you are doing an embedded http server, your app's name is blank, so pathInfo will be the whole path of the url.)
cgi.scriptName == "yourapp". With an embedded http server, this will be blank.
cgi.host == "example.com"
cgi.https == false
cgi.queryString == "name=value" (there's also cgi.search, which will be "?name=value", including the ?)
The query string is further parsed into the `get` and `getArray` members, so:
cgi.get == ["name": "value"], meaning you can do `cgi.get["name"] == "value"`
And
cgi.getArray == ["name": ["value"]].
Why is there both `get` and `getArray`? The standard allows names to be repeated. This can be very useful,
it is how http forms naturally pass multiple items like a set of checkboxes. So `getArray` is the complete data
if you need it. But since so often you only care about one value, the `get` member provides more convenient access.
We can use these members to process the request and build link urls. Other info from the request are in other members, we'll look at them later.
+/
switch(cgi.pathInfo) {
// the home page will be a small html form that can set a cookie.
case "/":
cgi.write(`<!DOCTYPE html>
<html>
<body>
<form method="POST" action="set-cookie">
<label>Your name: <input type="text" name="name" /></label>
<input type="submit" value="Submit" />
</form>
</body>
</html>
`, true); // the , true tells it that this is the one, complete response i want to send, allowing some optimizations.
break;
// POSTing to this will set a cookie with our submitted name
case "/set-cookie":
// HTTP has a number of request methods (also called "verbs") to tell
// what you should do with the given resource.
// The most common are GET and POST, the ones used in html forms.
// You can check which one was used with the `cgi.requestMethod` property.
if(cgi.requestMethod == Cgi.RequestMethod.POST) {
// headers like redirections need to be set before we call `write`
cgi.setResponseLocation("read-cookie");
// just like how url params go into cgi.get/getArray, form data submitted in a POST
// body go to cgi.post/postArray. Please note that a POST request can also have get
// params in addition to post params.
//
// There's also a convenience function `cgi.request("name")` which checks post first,
// then get if it isn't found there, and then returns a default value if it is in neither.
if("name" in cgi.post) {
// we can set cookies with a method too
// again, cookies need to be set before calling `cgi.write`, since they
// are a kind of header.
cgi.setCookie("name" , cgi.post["name"]);
}
// the user will probably never see this, since the response location
// is an automatic redirect, but it is still best to say something anyway
cgi.write("Redirecting you to see the cookie...", true);
} else {
// you can write out response codes and headers
// as well as response bodies
//
// But always check the cgi docs before using the generic
// `header` method - if there is a specific method for your
// header, use it before resorting to the generic one to avoid
// a header value from being sent twice.
cgi.setResponseLocation("405 Method Not Allowed");
// there is no special accept member, so you can use the generic header function
cgi.header("Accept: POST");
// but content type does have a method, so prefer to use it:
cgi.setResponseContentType("text/plain");
// all the headers are buffered, and will be sent upon the first body
// write. you can actually modify some of them before sending if need be.
cgi.write("You must use the POST http verb on this resource.", true);
}
break;
// and GETting this will read the cookie back out
case "/read-cookie":
// I did NOT pass `,true` here because this is writing a partial response.
// It is possible to stream data to the user in chunks by writing partial
// responses the calling `cgi.flush();` to send the partial response immediately.
// normally, you'd only send partial chunks if you have to - it is better to build
// a response as a whole and send it as a whole whenever possible - but here I want
// to demo that you can.
cgi.write("Hello, ");
if("name" in cgi.cookies) {
import arsd.dom; // dom.d provides a lot of helpers for html
// since the cookie is set, we need to write it out properly to
// avoid cross-site scripting attacks.
//
// Getting this stuff right automatically is a benefit of using the higher
// level apis, but this demo is to show the fundamental building blocks, so
// we're responsible to take care of it.
cgi.write(htmlEntitiesEncode(cgi.cookies["name"]));
} else {
cgi.write("friend");
}
// note that I never called cgi.setResponseContentType, since the default is text/html.
// it doesn't hurt to do it explicitly though, just remember to do it before any cgi.write
// calls.
break;
default:
// no path matched
cgi.setResponseStatus("404 Not Found");
cgi.write("Resource not found.", true);
}
}
// and this adds the boilerplate to set up a server according to the
// compile version configuration and call your handler as requests come in
mixin GenericMain!handler; // the `handler` here is the name of your function
---
Even if you plan to always use the higher-level apis, I still recommend you at least familiarize yourself with the lower level functions, since they provide the lightest weight, most flexible options to get down to business if you ever need them.
In the lower-level api, the [Cgi] object represents your HTTP transaction. It has functions to describe the request and for you to send your response. It leaves the details of how you o it up to you. The general guideline though is to avoid depending any variables outside your handler function, since there's no guarantee they will survive to another handler. You can use global vars as a lazy initialized cache, but you should always be ready in case it is empty. (One exception: if you use `-version=embedded_httpd_threads -version=cgi_no_fork`, then you can rely on it more, but you should still really write things assuming your function won't have anything survive beyond its return for max scalability and compatibility.)
A basic program using the higher-level apis might look like:
---
/+
import arsd.cgi;
struct LoginData {
string currentUser;
}
class AppClass : WebObject {
string foo() {}
}
mixin DispatcherMain!(
"/assets/.serveStaticFileDirectory("assets/", true), // serve the files in the assets subdirectory
"/".serveApi!AppClass,
"/thing/".serveRestObject,
);
+/
---
Guide_for_PHP_users:
(Please note: I wrote this section in 2008. A lot of PHP hosts still ran 4.x back then, so it was common to avoid using classes - introduced in php 5 - to maintain compatibility! If you're coming from php more recently, this may not be relevant anymore, but still might help you.)
If you are coming from old-style PHP, here's a quick guide to help you get started:
$(SIDE_BY_SIDE
$(COLUMN
```php
<?php
$foo = $_POST["foo"];
$bar = $_GET["bar"];
$baz = $_COOKIE["baz"];
$user_ip = $_SERVER["REMOTE_ADDR"];
$host = $_SERVER["HTTP_HOST"];
$path = $_SERVER["PATH_INFO"];
setcookie("baz", "some value");
echo "hello!";
?>
```
)
$(COLUMN
---
import arsd.cgi;
void app(Cgi cgi) {
string foo = cgi.post["foo"];
string bar = cgi.get["bar"];
string baz = cgi.cookies["baz"];
string user_ip = cgi.remoteAddress;
string host = cgi.host;
string path = cgi.pathInfo;
cgi.setCookie("baz", "some value");
cgi.write("hello!");
}
mixin GenericMain!app
---
)
)
$(H3 Array elements)
In PHP, you can give a form element a name like `"something[]"`, and then
`$_POST["something"]` gives an array. In D, you can use whatever name
you want, and access an array of values with the `cgi.getArray["name"]` and
`cgi.postArray["name"]` members.
$(H3 Databases)
PHP has a lot of stuff in its standard library. cgi.d doesn't include most
of these, but the rest of my arsd repository has much of it. For example,
to access a MySQL database, download `database.d` and `mysql.d` from my
github repo, and try this code (assuming, of course, your database is
set up):
---
import arsd.cgi;
import arsd.mysql;
void app(Cgi cgi) {
auto database = new MySql("localhost", "username", "password", "database_name");
foreach(row; mysql.query("SELECT count(id) FROM people"))
cgi.write(row[0] ~ " people in database");
}
mixin GenericMain!app;
---
Similar modules are available for PostgreSQL, Microsoft SQL Server, and SQLite databases,
implementing the same basic interface.
See_Also:
You may also want to see [arsd.dom], [arsd.webtemplate], and maybe some functions from my old [arsd.html] for more code for making
web applications. dom and webtemplate are used by the higher-level api here in cgi.d.
For working with json, try [arsd.jsvar].
[arsd.database], [arsd.mysql], [arsd.postgres], [arsd.mssql], and [arsd.sqlite] can help in
accessing databases.
If you are looking to access a web application via HTTP, try [arsd.http2].
Copyright:
cgi.d copyright 2008-2023, Adam D. Ruppe. Provided under the Boost Software License.
Yes, this file is old, and yes, it is still actively maintained and used.
History:
An import of `arsd.core` was added on March 21, 2023 (dub v11.0). Prior to this, the module's default configuration was completely stand-alone. You must now include the `core.d` file in your builds with `cgi.d`.
This change is primarily to integrate the event loops across the library, allowing you to more easily use cgi.d along with my other libraries like simpledisplay and http2.d. Previously, you'd have to run separate helper threads. Now, they can all automatically work together.
+/
module arsd.cgi;
static import arsd.core;
version(Posix)
import arsd.core : makeNonBlocking;
// FIXME: Nullable!T can be a checkbox that enables/disables the T on the automatic form
// and a SumType!(T, R) can be a radio box to pick between T and R to disclose the extra boxes on the automatic form
/++
This micro-example uses the [dispatcher] api to act as a simple http file server, serving files found in the current directory and its children.
+/
version(Demo)
unittest {
import arsd.cgi;
mixin DispatcherMain!(
"/".serveStaticFileDirectory(null, true)
);
}
/++
Same as the previous example, but written out long-form without the use of [DispatcherMain] nor [GenericMain].
+/
version(Demo)
unittest {
import arsd.cgi;
void requestHandler(Cgi cgi) {
cgi.dispatcher!(
"/".serveStaticFileDirectory(null, true)
);
}
// mixin GenericMain!requestHandler would add this function:
void main(string[] args) {
// this is all the content of [cgiMainImpl] which you can also call
// cgi.d embeds a few add on functions like real time event forwarders
// and session servers it can run in other processes. this spawns them, if needed.
if(tryAddonServers(args))
return;
// cgi.d allows you to easily simulate http requests from the command line,
// without actually starting a server. this function will do that.
if(trySimulatedRequest!(requestHandler, Cgi)(args))
return;
RequestServer server;
// you can change the default port here if you like
// server.listeningPort = 9000;
// then call this to let the command line args override your default
server.configureFromCommandLine(args);
// here is where you could print out the listeningPort to the user if you wanted
// and serve the request(s) according to the compile configuration
server.serve!(requestHandler)();
// or you could explicitly choose a serve mode like this:
// server.serveEmbeddedHttp!requestHandler();
}
}
/++
cgi.d has built-in testing helpers too. These will provide mock requests and mock sessions that
otherwise run through the rest of the internal mechanisms to call your functions without actually
spinning up a server.
+/
version(Demo)
unittest {
import arsd.cgi;
void requestHandler(Cgi cgi) {
}
// D doesn't let me embed a unittest inside an example unittest
// so this is a function, but you can do it however in your real program
/* unittest */ void runTests() {
auto tester = new CgiTester(&requestHandler);
auto response = tester.GET("/");
assert(response.code == 200);
}
}
static import std.file;
// for a single thread, linear request thing, use:
// -version=embedded_httpd_threads -version=cgi_no_threads
version(Posix) {
version(CRuntime_Musl) {
} else version(minimal) {
} else {
version(FreeBSD) {
// I never implemented the fancy stuff there either
} else {
version=with_breaking_cgi_features;
version=with_sendfd;
version=with_addon_servers;
}
}
}
version(Windows) {
version(minimal) {
} else {
// not too concerned about gdc here since the mingw version is fairly new as well
version=with_breaking_cgi_features;
}
}
// FIXME: can use the arsd.core function now but it is trivial anyway tbh
void cloexec(int fd) {
version(Posix) {
import core.sys.posix.fcntl;
fcntl(fd, F_SETFD, FD_CLOEXEC);
}
}
void cloexec(Socket s) {
version(Posix) {
import core.sys.posix.fcntl;
fcntl(s.handle, F_SETFD, FD_CLOEXEC);
}
}
// the servers must know about the connections to talk to them; the interfaces are vital
version(with_addon_servers)
version=with_addon_servers_connections;
version(embedded_httpd) {
version=embedded_httpd_hybrid;
/*
version(with_openssl) {
pragma(lib, "crypto");
pragma(lib, "ssl");
}
*/
}
version(embedded_httpd_hybrid) {
version=embedded_httpd_threads;
version(cgi_no_fork) {} else version(Posix)
version=cgi_use_fork;
version=cgi_use_fiber;
}
version(cgi_use_fork)
enum cgi_use_fork_default = true;
else
enum cgi_use_fork_default = false;
version(embedded_httpd_processes)
version=embedded_httpd_processes_accept_after_fork; // I am getting much better average performance on this, so just keeping it. But the other way MIGHT help keep the variation down so i wanna keep the code to play with later
version(embedded_httpd_threads) {
// unless the user overrides the default..
version(cgi_session_server_process)
{}
else
version=cgi_embedded_sessions;
}
version(scgi) {
// unless the user overrides the default..
version(cgi_session_server_process)
{}
else
version=cgi_embedded_sessions;
}
// fall back if the other is not defined so we can cleanly version it below
version(cgi_embedded_sessions) {}
else version=cgi_session_server_process;
version=cgi_with_websocket;
enum long defaultMaxContentLength = 5_000_000;
/*
To do a file download offer in the browser:
cgi.setResponseContentType("text/csv");
cgi.header("Content-Disposition: attachment; filename=\"customers.csv\"");
*/
// FIXME: the location header is supposed to be an absolute url I guess.
// FIXME: would be cool to flush part of a dom document before complete
// somehow in here and dom.d.
// these are public so you can mixin GenericMain.
// FIXME: use a function level import instead!
public import std.string;
public import std.stdio;
public import std.conv;
import std.uri;
import std.uni;
import std.algorithm.comparison;
import std.algorithm.searching;
import std.exception;
import std.base64;
static import std.algorithm;
import std.datetime;
import std.range;
import std.process;
import std.zlib;
T[] consume(T)(T[] range, int count) {
if(count > range.length)
count = range.length;
return range[count..$];
}
int locationOf(T)(T[] data, string item) {
const(ubyte[]) d = cast(const(ubyte[])) data;
const(ubyte[]) i = cast(const(ubyte[])) item;
// this is a vague sanity check to ensure we aren't getting insanely
// sized input that will infinite loop below. it should never happen;
// even huge file uploads ought to come in smaller individual pieces.
if(d.length > (int.max/2))
throw new Exception("excessive block of input");
for(int a = 0; a < d.length; a++) {
if(a + i.length > d.length)
return -1;
if(d[a..a+i.length] == i)
return a;
}
return -1;
}
/// If you are doing a custom cgi class, mixing this in can take care of
/// the required constructors for you
mixin template ForwardCgiConstructors() {
this(long maxContentLength = defaultMaxContentLength,
string[string] env = null,
const(ubyte)[] delegate() readdata = null,
void delegate(const(ubyte)[]) _rawDataOutput = null,
void delegate() _flush = null
) { super(maxContentLength, env, readdata, _rawDataOutput, _flush); }
this(string[] args) { super(args); }
this(
BufferedInputRange inputData,
string address, ushort _port,
int pathInfoStarts = 0,
bool _https = false,
void delegate(const(ubyte)[]) _rawDataOutput = null,
void delegate() _flush = null,
// this pointer tells if the connection is supposed to be closed after we handle this
bool* closeConnection = null)
{
super(inputData, address, _port, pathInfoStarts, _https, _rawDataOutput, _flush, closeConnection);
}
this(BufferedInputRange ir, bool* closeConnection) { super(ir, closeConnection); }
}
/// thrown when a connection is closed remotely while we waiting on data from it
class ConnectionClosedException : Exception {
this(string message, string file = __FILE__, size_t line = __LINE__, Throwable next = null) {
super(message, file, line, next);
}
}
version(Windows) {
// FIXME: ugly hack to solve stdin exception problems on Windows:
// reading stdin results in StdioException (Bad file descriptor)
// this is probably due to http://d.puremagic.com/issues/show_bug.cgi?id=3425
private struct stdin {
struct ByChunk { // Replicates std.stdio.ByChunk
private:
ubyte[] chunk_;
public:
this(size_t size)
in {
assert(size, "size must be larger than 0");
}
do {
chunk_ = new ubyte[](size);
popFront();
}
@property bool empty() const {
return !std.stdio.stdin.isOpen || std.stdio.stdin.eof; // Ugly, but seems to do the job
}
@property nothrow ubyte[] front() { return chunk_; }
void popFront() {
enforce(!empty, "Cannot call popFront on empty range");
chunk_ = stdin.rawRead(chunk_);
}
}
import core.sys.windows.windows;
static:
T[] rawRead(T)(T[] buf) {
uint bytesRead;
auto result = ReadFile(GetStdHandle(STD_INPUT_HANDLE), buf.ptr, cast(int) (buf.length * T.sizeof), &bytesRead, null);
if (!result) {
auto err = GetLastError();
if (err == 38/*ERROR_HANDLE_EOF*/ || err == 109/*ERROR_BROKEN_PIPE*/) // 'good' errors meaning end of input
return buf[0..0];
// Some other error, throw it
char* buffer;
scope(exit) LocalFree(buffer);
// FORMAT_MESSAGE_ALLOCATE_BUFFER = 0x00000100
// FORMAT_MESSAGE_FROM_SYSTEM = 0x00001000
FormatMessageA(0x1100, null, err, 0, cast(char*)&buffer, 256, null);
throw new Exception(to!string(buffer));
}
enforce(!(bytesRead % T.sizeof), "I/O error");
return buf[0..bytesRead / T.sizeof];
}
auto byChunk(size_t sz) { return ByChunk(sz); }
void close() {
std.stdio.stdin.close;
}
}
}
/// The main interface with the web request
class Cgi {
public:
/// the methods a request can be
enum RequestMethod { GET, HEAD, POST, PUT, DELETE, // GET and POST are the ones that really work
// these are defined in the standard, but idk if they are useful for anything
OPTIONS, TRACE, CONNECT,
// These seem new, I have only recently seen them
PATCH, MERGE,
// this is an extension for when the method is not specified and you want to assume
CommandLine }
/+
/++
Cgi provides a per-request memory pool
+/
void[] allocateMemory(size_t nBytes) {
}
/// ditto
void[] reallocateMemory(void[] old, size_t nBytes) {
}
/// ditto
void freeMemory(void[] memory) {
}
+/
/*
import core.runtime;
auto args = Runtime.args();
we can call the app a few ways:
1) set up the environment variables and call the app (manually simulating CGI)
2) simulate a call automatically:
./app method 'uri'
for example:
./app get /path?arg arg2=something
Anything on the uri is treated as query string etc
on get method, further args are appended to the query string (encoded automatically)
on post method, further args are done as post
@name means import from file "name". if name == -, it uses stdin
(so info=@- means set info to the value of stdin)
Other arguments include:
--cookie name=value (these are all concated together)
--header 'X-Something: cool'
--referrer 'something'
--port 80
--remote-address some.ip.address.here
--https yes
--user-agent 'something'
--userpass 'user:pass'
--authorization 'Basic base64encoded_user:pass'
--accept 'content' // FIXME: better example
--last-event-id 'something'
--host 'something.com'
Non-simulation arguments:
--port xxx listening port for non-cgi things (valid for the cgi interfaces)
--listening-host the ip address the application should listen on, or if you want to use unix domain sockets, it is here you can set them: `--listening-host unix:filename` or, on Linux, `--listening-host abstract:name`.
*/
/** Initializes it with command line arguments (for easy testing) */
this(string[] args, void delegate(const(ubyte)[]) _rawDataOutput = null) {
rawDataOutput = _rawDataOutput;
// these are all set locally so the loop works
// without triggering errors in dmd 2.064
// we go ahead and set them at the end of it to the this version
int port;
string referrer;
string remoteAddress;
string userAgent;
string authorization;
string origin;
string accept;
string lastEventId;
bool https;
string host;
RequestMethod requestMethod;
string requestUri;
string pathInfo;
string queryString;
bool lookingForMethod;
bool lookingForUri;
string nextArgIs;
string _cookie;
string _queryString;
string[][string] _post;
string[string] _headers;
string[] breakUp(string s) {
string k, v;
auto idx = s.indexOf("=");
if(idx == -1) {
k = s;
} else {
k = s[0 .. idx];
v = s[idx + 1 .. $];
}
return [k, v];
}
lookingForMethod = true;
scriptName = args[0];
scriptFileName = args[0];
environmentVariables = cast(const) environment.toAA;
foreach(arg; args[1 .. $]) {
if(arg.startsWith("--")) {
nextArgIs = arg[2 .. $];
} else if(nextArgIs.length) {
if (nextArgIs == "cookie") {
auto info = breakUp(arg);
if(_cookie.length)
_cookie ~= "; ";
_cookie ~= std.uri.encodeComponent(info[0]) ~ "=" ~ std.uri.encodeComponent(info[1]);
}
else if (nextArgIs == "port") {
port = to!int(arg);
}
else if (nextArgIs == "referrer") {
referrer = arg;
}
else if (nextArgIs == "remote-address") {
remoteAddress = arg;
}
else if (nextArgIs == "user-agent") {
userAgent = arg;
}
else if (nextArgIs == "authorization") {
authorization = arg;
}
else if (nextArgIs == "userpass") {
authorization = "Basic " ~ Base64.encode(cast(immutable(ubyte)[]) (arg)).idup;
}
else if (nextArgIs == "origin") {
origin = arg;
}
else if (nextArgIs == "accept") {
accept = arg;
}
else if (nextArgIs == "last-event-id") {
lastEventId = arg;
}
else if (nextArgIs == "https") {
if(arg == "yes")
https = true;
}
else if (nextArgIs == "header") {
string thing, other;
auto idx = arg.indexOf(":");
if(idx == -1)
throw new Exception("need a colon in a http header");
thing = arg[0 .. idx];
other = arg[idx + 1.. $];
_headers[thing.strip.toLower()] = other.strip;
}
else if (nextArgIs == "host") {
host = arg;
}
// else
// skip, we don't know it but that's ok, it might be used elsewhere so no error
nextArgIs = null;
} else if(lookingForMethod) {
lookingForMethod = false;
lookingForUri = true;
if(arg.asLowerCase().equal("commandline"))
requestMethod = RequestMethod.CommandLine;
else
requestMethod = to!RequestMethod(arg.toUpper());
} else if(lookingForUri) {
lookingForUri = false;
requestUri = arg;
auto idx = arg.indexOf("?");
if(idx == -1)
pathInfo = arg;
else {
pathInfo = arg[0 .. idx];
_queryString = arg[idx + 1 .. $];
}
} else {
// it is an argument of some sort
if(requestMethod == Cgi.RequestMethod.POST || requestMethod == Cgi.RequestMethod.PATCH || requestMethod == Cgi.RequestMethod.PUT || requestMethod == Cgi.RequestMethod.CommandLine) {
auto parts = breakUp(arg);
_post[parts[0]] ~= parts[1];
allPostNamesInOrder ~= parts[0];
allPostValuesInOrder ~= parts[1];
} else {
if(_queryString.length)
_queryString ~= "&";
auto parts = breakUp(arg);
_queryString ~= std.uri.encodeComponent(parts[0]) ~ "=" ~ std.uri.encodeComponent(parts[1]);
}
}
}
acceptsGzip = false;
keepAliveRequested = false;
requestHeaders = cast(immutable) _headers;
cookie = _cookie;
cookiesArray = getCookieArray();
cookies = keepLastOf(cookiesArray);
queryString = _queryString;
getArray = cast(immutable) decodeVariables(queryString, "&", &allGetNamesInOrder, &allGetValuesInOrder);
get = keepLastOf(getArray);
postArray = cast(immutable) _post;
post = keepLastOf(_post);
// FIXME
filesArray = null;
files = null;
isCalledWithCommandLineArguments = true;
this.port = port;
this.referrer = referrer;
this.remoteAddress = remoteAddress;
this.userAgent = userAgent;
this.authorization = authorization;
this.origin = origin;
this.accept = accept;
this.lastEventId = lastEventId;
this.https = https;
this.host = host;
this.requestMethod = requestMethod;
this.requestUri = requestUri;
this.pathInfo = pathInfo;
this.queryString = queryString;
this.postBody = null;
}
private {
string[] allPostNamesInOrder;
string[] allPostValuesInOrder;
string[] allGetNamesInOrder;
string[] allGetValuesInOrder;
}
CgiConnectionHandle getOutputFileHandle() {
return _outputFileHandle;
}
CgiConnectionHandle _outputFileHandle = INVALID_CGI_CONNECTION_HANDLE;
/** Initializes it using a CGI or CGI-like interface */
this(long maxContentLength = defaultMaxContentLength,
// use this to override the environment variable listing
in string[string] env = null,
// and this should return a chunk of data. return empty when done
const(ubyte)[] delegate() readdata = null,
// finally, use this to do custom output if needed
void delegate(const(ubyte)[]) _rawDataOutput = null,
// to flush teh custom output
void delegate() _flush = null
)
{
// these are all set locally so the loop works
// without triggering errors in dmd 2.064
// we go ahead and set them at the end of it to the this version
int port;
string referrer;
string remoteAddress;
string userAgent;
string authorization;
string origin;
string accept;
string lastEventId;
bool https;
string host;
RequestMethod requestMethod;
string requestUri;
string pathInfo;
string queryString;
isCalledWithCommandLineArguments = false;
rawDataOutput = _rawDataOutput;
flushDelegate = _flush;
auto getenv = delegate string(string var) {
if(env is null)
return std.process.environment.get(var);
auto e = var in env;
if(e is null)
return null;
return *e;
};
environmentVariables = env is null ?
cast(const) environment.toAA :
env;
// fetching all the request headers
string[string] requestHeadersHere;
foreach(k, v; env is null ? cast(const) environment.toAA() : env) {
if(k.startsWith("HTTP_")) {
requestHeadersHere[replace(k["HTTP_".length .. $].toLower(), "_", "-")] = v;
}
}
this.requestHeaders = assumeUnique(requestHeadersHere);
requestUri = getenv("REQUEST_URI");
cookie = getenv("HTTP_COOKIE");
cookiesArray = getCookieArray();
cookies = keepLastOf(cookiesArray);
referrer = getenv("HTTP_REFERER");
userAgent = getenv("HTTP_USER_AGENT");
remoteAddress = getenv("REMOTE_ADDR");
host = getenv("HTTP_HOST");
pathInfo = getenv("PATH_INFO");
queryString = getenv("QUERY_STRING");
scriptName = getenv("SCRIPT_NAME");
{
import core.runtime;
auto sfn = getenv("SCRIPT_FILENAME");
scriptFileName = sfn.length ? sfn : (Runtime.args.length ? Runtime.args[0] : null);
}
bool iis = false;
// Because IIS doesn't pass requestUri, we simulate it here if it's empty.
if(requestUri.length == 0) {
// IIS sometimes includes the script name as part of the path info - we don't want that
if(pathInfo.length >= scriptName.length && (pathInfo[0 .. scriptName.length] == scriptName))
pathInfo = pathInfo[scriptName.length .. $];
requestUri = scriptName ~ pathInfo ~ (queryString.length ? ("?" ~ queryString) : "");
iis = true; // FIXME HACK - used in byChunk below - see bugzilla 6339
// FIXME: this works for apache and iis... but what about others?
}
auto ugh = decodeVariables(queryString, "&", &allGetNamesInOrder, &allGetValuesInOrder);
getArray = assumeUnique(ugh);
get = keepLastOf(getArray);
// NOTE: on shitpache, you need to specifically forward this
authorization = getenv("HTTP_AUTHORIZATION");
// this is a hack because Apache is a shitload of fuck and
// refuses to send the real header to us. Compatible
// programs should send both the standard and X- versions
// NOTE: if you have access to .htaccess or httpd.conf, you can make this
// unnecessary with mod_rewrite, so it is commented
//if(authorization.length == 0) // if the std is there, use it
// authorization = getenv("HTTP_X_AUTHORIZATION");
// the REDIRECT_HTTPS check is here because with an Apache hack, the port can become wrong
if(getenv("SERVER_PORT").length && getenv("REDIRECT_HTTPS") != "on")
port = to!int(getenv("SERVER_PORT"));
else
port = 0; // this was probably called from the command line
auto ae = getenv("HTTP_ACCEPT_ENCODING");
if(ae.length && ae.indexOf("gzip") != -1)
acceptsGzip = true;
accept = getenv("HTTP_ACCEPT");
lastEventId = getenv("HTTP_LAST_EVENT_ID");
auto ka = getenv("HTTP_CONNECTION");
if(ka.length && ka.asLowerCase().canFind("keep-alive"))
keepAliveRequested = true;
auto or = getenv("HTTP_ORIGIN");
origin = or;
auto rm = getenv("REQUEST_METHOD");
if(rm.length)
requestMethod = to!RequestMethod(getenv("REQUEST_METHOD"));
else
requestMethod = RequestMethod.CommandLine;
// FIXME: hack on REDIRECT_HTTPS; this is there because the work app uses mod_rewrite which loses the https flag! So I set it with [E=HTTPS=%HTTPS] or whatever but then it gets translated to here so i want it to still work. This is arguably wrong but meh.
https = (getenv("HTTPS") == "on" || getenv("REDIRECT_HTTPS") == "on");
// FIXME: DOCUMENT_ROOT?
// FIXME: what about PUT?
if(requestMethod == RequestMethod.POST || requestMethod == Cgi.RequestMethod.PATCH || requestMethod == Cgi.RequestMethod.PUT || requestMethod == Cgi.RequestMethod.CommandLine) {
version(preserveData) // a hack to make forwarding simpler
immutable(ubyte)[] data;
size_t amountReceived = 0;
auto contentType = getenv("CONTENT_TYPE");
// FIXME: is this ever not going to be set? I guess it depends
// on if the server de-chunks and buffers... seems like it has potential
// to be slow if they did that. The spec says it is always there though.
// And it has worked reliably for me all year in the live environment,
// but some servers might be different.
auto cls = getenv("CONTENT_LENGTH");
auto contentLength = to!size_t(cls.length ? cls : "0");
immutable originalContentLength = contentLength;
if(contentLength) {
if(maxContentLength > 0 && contentLength > maxContentLength) {
setResponseStatus("413 Request entity too large");
write("You tried to upload a file that is too large.");
close();
throw new Exception("POST too large");
}
prepareForIncomingDataChunks(contentType, contentLength);
int processChunk(in ubyte[] chunk) {
if(chunk.length > contentLength) {
handleIncomingDataChunk(chunk[0..contentLength]);
amountReceived += contentLength;
contentLength = 0;
return 1;
} else {
handleIncomingDataChunk(chunk);
contentLength -= chunk.length;
amountReceived += chunk.length;
}
if(contentLength == 0)
return 1;
onRequestBodyDataReceived(amountReceived, originalContentLength);
return 0;
}
if(readdata is null) {
foreach(ubyte[] chunk; stdin.byChunk(iis ? contentLength : 4096))
if(processChunk(chunk))
break;
} else {
// we have a custom data source..
auto chunk = readdata();
while(chunk.length) {
if(processChunk(chunk))
break;
chunk = readdata();
}
}
onRequestBodyDataReceived(amountReceived, originalContentLength);
postArray = assumeUnique(pps._post);
filesArray = assumeUnique(pps._files);
files = keepLastOf(filesArray);
post = keepLastOf(postArray);
this.postBody = pps.postBody;
cleanUpPostDataState();
}
version(preserveData)
originalPostData = data;
}
// fixme: remote_user script name
this.port = port;
this.referrer = referrer;
this.remoteAddress = remoteAddress;
this.userAgent = userAgent;
this.authorization = authorization;
this.origin = origin;
this.accept = accept;
this.lastEventId = lastEventId;
this.https = https;
this.host = host;
this.requestMethod = requestMethod;
this.requestUri = requestUri;
this.pathInfo = pathInfo;
this.queryString = queryString;
}
/// Cleans up any temporary files. Do not use the object
/// after calling this.
///
/// NOTE: it is called automatically by GenericMain
// FIXME: this should be called if the constructor fails too, if it has created some garbage...
void dispose() {
foreach(file; files) {
if(!file.contentInMemory)
if(std.file.exists(file.contentFilename))
std.file.remove(file.contentFilename);
}
}
private {
struct PostParserState {
string contentType;
string boundary;
string localBoundary; // the ones used at the end or something lol
bool isMultipart;
bool needsSavedBody;
ulong expectedLength;
ulong contentConsumed;
immutable(ubyte)[] buffer;
// multipart parsing state
int whatDoWeWant;
bool weHaveAPart;
string[] thisOnesHeaders;
immutable(ubyte)[] thisOnesData;
string postBody;
UploadedFile piece;
bool isFile = false;
size_t memoryCommitted;
// do NOT keep mutable references to these anywhere!
// I assume they are unique in the constructor once we're all done getting data.
string[][string] _post;
UploadedFile[][string] _files;
}
PostParserState pps;
}
/// This represents a file the user uploaded via a POST request.
static struct UploadedFile {
/// If you want to create one of these structs for yourself from some data,
/// use this function.
static UploadedFile fromData(immutable(void)[] data, string name = null) {
Cgi.UploadedFile f;
f.filename = name;
f.content = cast(immutable(ubyte)[]) data;
f.contentInMemory = true;
return f;
}
string name; /// The name of the form element.
string filename; /// The filename the user set.
string contentType; /// The MIME type the user's browser reported. (Not reliable.)
/**
For small files, cgi.d will buffer the uploaded file in memory, and make it
directly accessible to you through the content member. I find this very convenient
and somewhat efficient, since it can avoid hitting the disk entirely. (I
often want to inspect and modify the file anyway!)
I find the file is very large, it is undesirable to eat that much memory just
for a file buffer. In those cases, if you pass a large enough value for maxContentLength
to the constructor so they are accepted, cgi.d will write the content to a temporary
file that you can re-read later.
You can override this behavior by subclassing Cgi and overriding the protected
handlePostChunk method. Note that the object is not initialized when you
write that method - the http headers are available, but the cgi.post method
is not. You may parse the file as it streams in using this method.
Anyway, if the file is small enough to be in memory, contentInMemory will be
set to true, and the content is available in the content member.
If not, contentInMemory will be set to false, and the content saved in a file,
whose name will be available in the contentFilename member.
Tip: if you know you are always dealing with small files, and want the convenience
of ignoring this member, construct Cgi with a small maxContentLength. Then, if
a large file comes in, it simply throws an exception (and HTTP error response)
instead of trying to handle it.
The default value of maxContentLength in the constructor is for small files.
*/
bool contentInMemory = true; // the default ought to always be true
immutable(ubyte)[] content; /// The actual content of the file, if contentInMemory == true
string contentFilename; /// the file where we dumped the content, if contentInMemory == false. Note that if you want to keep it, you MUST move the file, since otherwise it is considered garbage when cgi is disposed.
///
ulong fileSize() const {
if(contentInMemory)
return content.length;
import std.file;
return std.file.getSize(contentFilename);
}
///
void writeToFile(string filenameToSaveTo) const {
import std.file;
if(contentInMemory)
std.file.write(filenameToSaveTo, content);
else
std.file.rename(contentFilename, filenameToSaveTo);
}
}
// given a content type and length, decide what we're going to do with the data..
protected void prepareForIncomingDataChunks(string contentType, ulong contentLength) {
pps.expectedLength = contentLength;
auto terminator = contentType.indexOf(";");
if(terminator == -1)
terminator = contentType.length;
pps.contentType = contentType[0 .. terminator];
auto b = contentType[terminator .. $];
if(b.length) {
auto idx = b.indexOf("boundary=");
if(idx != -1) {
pps.boundary = b[idx + "boundary=".length .. $];
pps.localBoundary = "\r\n--" ~ pps.boundary;
}
}
// while a content type SHOULD be sent according to the RFC, it is
// not required. We're told we SHOULD guess by looking at the content
// but it seems to me that this only happens when it is urlencoded.
if(pps.contentType == "application/x-www-form-urlencoded" || pps.contentType == "") {
pps.isMultipart = false;
pps.needsSavedBody = false;
} else if(pps.contentType == "multipart/form-data") {
pps.isMultipart = true;
enforce(pps.boundary.length, "no boundary");
} else if(pps.contentType == "text/xml") { // FIXME: could this be special and load the post params
// save the body so the application can handle it
pps.isMultipart = false;
pps.needsSavedBody = true;
} else if(pps.contentType == "application/json") { // FIXME: this could prolly try to load post params too
// save the body so the application can handle it
pps.needsSavedBody = true;
pps.isMultipart = false;
} else {
// the rest is 100% handled by the application. just save the body and send it to them
pps.needsSavedBody = true;
pps.isMultipart = false;
}
}
// handles streaming POST data. If you handle some other content type, you should
// override this. If the data isn't the content type you want, you ought to call
// super.handleIncomingDataChunk so regular forms and files still work.
// FIXME: I do some copying in here that I'm pretty sure is unnecessary, and the
// file stuff I'm sure is inefficient. But, my guess is the real bottleneck is network
// input anyway, so I'm not going to get too worked up about it right now.
protected void handleIncomingDataChunk(const(ubyte)[] chunk) {
if(chunk.length == 0)
return;
assert(chunk.length <= 32 * 1024 * 1024); // we use chunk size as a memory constraint thing, so
// if we're passed big chunks, it might throw unnecessarily.
// just pass it smaller chunks at a time.
if(pps.isMultipart) {
// multipart/form-data
// FIXME: this might want to be factored out and factorized
// need to make sure the stream hooks actually work.
void pieceHasNewContent() {
// we just grew the piece's buffer. Do we have to switch to file backing?
if(pps.piece.contentInMemory) {
if(pps.piece.content.length <= 10 * 1024 * 1024)
// meh, I'm ok with it.
return;
else {
// this is too big.
if(!pps.isFile)
throw new Exception("Request entity too large"); // a variable this big is kinda ridiculous, just reject it.
else {
// a file this large is probably acceptable though... let's use a backing file.
pps.piece.contentInMemory = false;
// FIXME: say... how do we intend to delete these things? cgi.dispose perhaps.
int count = 0;
pps.piece.contentFilename = getTempDirectory() ~ "arsd_cgi_uploaded_file_" ~ to!string(getUtcTime()) ~ "-" ~ to!string(count);
// odds are this loop will never be entered, but we want it just in case.
while(std.file.exists(pps.piece.contentFilename)) {
count++;
pps.piece.contentFilename = getTempDirectory() ~ "arsd_cgi_uploaded_file_" ~ to!string(getUtcTime()) ~ "-" ~ to!string(count);
}
// I hope this creates the file pretty quickly, or the loop might be useless...
// FIXME: maybe I should write some kind of custom transaction here.
std.file.write(pps.piece.contentFilename, pps.piece.content);
pps.piece.content = null;
}
}
} else {
// it's already in a file, so just append it to what we have
if(pps.piece.content.length) {
// FIXME: this is surely very inefficient... we'll be calling this by 4kb chunk...
std.file.append(pps.piece.contentFilename, pps.piece.content);
pps.piece.content = null;
}
}
}
void commitPart() {
if(!pps.weHaveAPart)
return;
pieceHasNewContent(); // be sure the new content is handled every time
if(pps.isFile) {
// I'm not sure if other environments put files in post or not...
// I used to not do it, but I think I should, since it is there...
pps._post[pps.piece.name] ~= pps.piece.filename;
pps._files[pps.piece.name] ~= pps.piece;
allPostNamesInOrder ~= pps.piece.name;
allPostValuesInOrder ~= pps.piece.filename;
} else {
pps._post[pps.piece.name] ~= cast(string) pps.piece.content;
allPostNamesInOrder ~= pps.piece.name;
allPostValuesInOrder ~= cast(string) pps.piece.content;
}
/*
stderr.writeln("RECEIVED: ", pps.piece.name, "=",
pps.piece.content.length < 1000
?
to!string(pps.piece.content)
:
"too long");
*/
// FIXME: the limit here
pps.memoryCommitted += pps.piece.content.length;
pps.weHaveAPart = false;
pps.whatDoWeWant = 1;
pps.thisOnesHeaders = null;
pps.thisOnesData = null;
pps.piece = UploadedFile.init;
pps.isFile = false;
}
void acceptChunk() {
pps.buffer ~= chunk;
chunk = null; // we've consumed it into the buffer, so keeping it just brings confusion
}
immutable(ubyte)[] consume(size_t howMuch) {
pps.contentConsumed += howMuch;
auto ret = pps.buffer[0 .. howMuch];
pps.buffer = pps.buffer[howMuch .. $];
return ret;
}
dataConsumptionLoop: do {
switch(pps.whatDoWeWant) {
default: assert(0);
case 0:
acceptChunk();
// the format begins with two extra leading dashes, then we should be at the boundary
if(pps.buffer.length < 2)
return;
assert(pps.buffer[0] == '-', "no leading dash");
consume(1);
assert(pps.buffer[0] == '-', "no second leading dash");
consume(1);
pps.whatDoWeWant = 1;
goto case 1;
/* fallthrough */
case 1: // looking for headers
// here, we should be lined up right at the boundary, which is followed by a \r\n
// want to keep the buffer under control in case we're under attack
//stderr.writeln("here once");
//if(pps.buffer.length + chunk.length > 70 * 1024) // they should be < 1 kb really....
// throw new Exception("wtf is up with the huge mime part headers");
acceptChunk();
if(pps.buffer.length < pps.boundary.length)
return; // not enough data, since there should always be a boundary here at least
if(pps.contentConsumed + pps.boundary.length + 6 == pps.expectedLength) {
assert(pps.buffer.length == pps.boundary.length + 4 + 2); // --, --, and \r\n
// we *should* be at the end here!
assert(pps.buffer[0] == '-');
consume(1);
assert(pps.buffer[0] == '-');
consume(1);
// the message is terminated by --BOUNDARY--\r\n (after a \r\n leading to the boundary)
assert(pps.buffer[0 .. pps.boundary.length] == cast(const(ubyte[])) pps.boundary,
"not lined up on boundary " ~ pps.boundary);
consume(pps.boundary.length);
assert(pps.buffer[0] == '-');
consume(1);
assert(pps.buffer[0] == '-');
consume(1);
assert(pps.buffer[0] == '\r');
consume(1);
assert(pps.buffer[0] == '\n');
consume(1);
assert(pps.buffer.length == 0);
assert(pps.contentConsumed == pps.expectedLength);
break dataConsumptionLoop; // we're done!
} else {
// we're not done yet. We should be lined up on a boundary.
// But, we want to ensure the headers are here before we consume anything!
auto headerEndLocation = locationOf(pps.buffer, "\r\n\r\n");
if(headerEndLocation == -1)
return; // they *should* all be here, so we can handle them all at once.
assert(pps.buffer[0 .. pps.boundary.length] == cast(const(ubyte[])) pps.boundary,
"not lined up on boundary " ~ pps.boundary);
consume(pps.boundary.length);
// the boundary is always followed by a \r\n
assert(pps.buffer[0] == '\r');
consume(1);
assert(pps.buffer[0] == '\n');
consume(1);
}
// re-running since by consuming the boundary, we invalidate the old index.
auto headerEndLocation = locationOf(pps.buffer, "\r\n\r\n");
assert(headerEndLocation >= 0, "no header");
auto thisOnesHeaders = pps.buffer[0..headerEndLocation];
consume(headerEndLocation + 4); // The +4 is the \r\n\r\n that caps it off
pps.thisOnesHeaders = split(cast(string) thisOnesHeaders, "\r\n");
// now we'll parse the headers
foreach(h; pps.thisOnesHeaders) {
auto p = h.indexOf(":");
assert(p != -1, "no colon in header, got " ~ to!string(pps.thisOnesHeaders));
string hn = h[0..p];
string hv = h[p+2..$];
switch(hn.toLower) {
default: assert(0);
case "content-disposition":
auto info = hv.split("; ");
foreach(i; info[1..$]) { // skipping the form-data
auto o = i.split("="); // FIXME
string pn = o[0];
string pv = o[1][1..$-1];
if(pn == "name") {
pps.piece.name = pv;
} else if (pn == "filename") {
pps.piece.filename = pv;
pps.isFile = true;
}
}
break;
case "content-type":
pps.piece.contentType = hv;
break;
}
}
pps.whatDoWeWant++; // move to the next step - the data
break;
case 2:
// when we get here, pps.buffer should contain our first chunk of data
if(pps.buffer.length + chunk.length > 8 * 1024 * 1024) // we might buffer quite a bit but not much
throw new Exception("wtf is up with the huge mime part buffer");
acceptChunk();
// so the trick is, we want to process all the data up to the boundary,
// but what if the chunk's end cuts the boundary off? If we're unsure, we
// want to wait for the next chunk. We start by looking for the whole boundary
// in the buffer somewhere.
auto boundaryLocation = locationOf(pps.buffer, pps.localBoundary);
// assert(boundaryLocation != -1, "should have seen "~to!string(cast(ubyte[]) pps.localBoundary)~" in " ~ to!string(pps.buffer));
if(boundaryLocation != -1) {
// this is easy - we can see it in it's entirety!
pps.piece.content ~= consume(boundaryLocation);
assert(pps.buffer[0] == '\r');
consume(1);
assert(pps.buffer[0] == '\n');
consume(1);
assert(pps.buffer[0] == '-');
consume(1);
assert(pps.buffer[0] == '-');
consume(1);
// the boundary here is always preceded by \r\n--, which is why we used localBoundary instead of boundary to locate it. Cut that off.
pps.weHaveAPart = true;
pps.whatDoWeWant = 1; // back to getting headers for the next part
commitPart(); // we're done here
} else {
// we can't see the whole thing, but what if there's a partial boundary?
enforce(pps.localBoundary.length < 128); // the boundary ought to be less than a line...
assert(pps.localBoundary.length > 1); // should already be sane but just in case
bool potentialBoundaryFound = false;
boundaryCheck: for(int a = 1; a < pps.localBoundary.length; a++) {
// we grow the boundary a bit each time. If we think it looks the
// same, better pull another chunk to be sure it's not the end.
// Starting small because exiting the loop early is desirable, since
// we're not keeping any ambiguity and 1 / 256 chance of exiting is
// the best we can do.
if(a > pps.buffer.length)
break; // FIXME: is this right?
assert(a <= pps.buffer.length);
assert(a > 0);
if(std.algorithm.endsWith(pps.buffer, pps.localBoundary[0 .. a])) {
// ok, there *might* be a boundary here, so let's
// not treat the end as data yet. The rest is good to
// use though, since if there was a boundary there, we'd
// have handled it up above after locationOf.
pps.piece.content ~= pps.buffer[0 .. $ - a];
consume(pps.buffer.length - a);
pieceHasNewContent();
potentialBoundaryFound = true;
break boundaryCheck;
}
}
if(!potentialBoundaryFound) {
// we can consume the whole thing
pps.piece.content ~= pps.buffer;
pieceHasNewContent();
consume(pps.buffer.length);
} else {
// we found a possible boundary, but there was
// insufficient data to be sure.
assert(pps.buffer == cast(const(ubyte[])) pps.localBoundary[0 .. pps.buffer.length]);
return; // wait for the next chunk.
}
}
}
} while(pps.buffer.length);
// btw all boundaries except the first should have a \r\n before them
} else {
// application/x-www-form-urlencoded and application/json
// not using maxContentLength because that might be cranked up to allow
// large file uploads. We can handle them, but a huge post[] isn't any good.
if(pps.buffer.length + chunk.length > 8 * 1024 * 1024) // surely this is plenty big enough
throw new Exception("wtf is up with such a gigantic form submission????");
pps.buffer ~= chunk;
// simple handling, but it works... until someone bombs us with gigabytes of crap at least...
if(pps.buffer.length == pps.expectedLength) {
if(pps.needsSavedBody)
pps.postBody = cast(string) pps.buffer;
else
pps._post = decodeVariables(cast(string) pps.buffer, "&", &allPostNamesInOrder, &allPostValuesInOrder);
version(preserveData)
originalPostData = pps.buffer;
} else {
// just for debugging
}
}
}
protected void cleanUpPostDataState() {
pps = PostParserState.init;
}
/// you can override this function to somehow react
/// to an upload in progress.
///
/// Take note that parts of the CGI object is not yet
/// initialized! Stuff from HTTP headers, including get[], is usable.
/// But, none of post[] is usable, and you cannot write here. That's
/// why this method is const - mutating the object won't do much anyway.
///
/// My idea here was so you can output a progress bar or
/// something to a cooperative client (see arsd.rtud for a potential helper)
///
/// The default is to do nothing. Subclass cgi and use the
/// CustomCgiMain mixin to do something here.
void onRequestBodyDataReceived(size_t receivedSoFar, size_t totalExpected) const {
// This space intentionally left blank.
}
/// Initializes the cgi from completely raw HTTP data. The ir must have a Socket source.
/// *closeConnection will be set to true if you should close the connection after handling this request
this(BufferedInputRange ir, bool* closeConnection) {
isCalledWithCommandLineArguments = false;
import al = std.algorithm;
immutable(ubyte)[] data;
void rdo(const(ubyte)[] d) {
//import std.stdio; writeln(d);
sendAll(ir.source, d);
}
auto ira = ir.source.remoteAddress();
auto irLocalAddress = ir.source.localAddress();
ushort port = 80;
if(auto ia = cast(InternetAddress) irLocalAddress) {
port = ia.port;
} else if(auto ia = cast(Internet6Address) irLocalAddress) {
port = ia.port;
}
// that check for UnixAddress is to work around a Phobos bug
// see: https://github.com/dlang/phobos/pull/7383
// but this might be more useful anyway tbh for this case
version(Posix)
this(ir, ira is null ? null : cast(UnixAddress) ira ? "unix:" : ira.toString(), port, 0, false, &rdo, null, closeConnection);
else
this(ir, ira is null ? null : ira.toString(), port, 0, false, &rdo, null, closeConnection);
}
/**
Initializes it from raw HTTP request data. GenericMain uses this when you compile with -version=embedded_httpd.
NOTE: If you are behind a reverse proxy, the values here might not be what you expect.... it will use X-Forwarded-For for remote IP and X-Forwarded-Host for host
Params:
inputData = the incoming data, including headers and other raw http data.
When the constructor exits, it will leave this range exactly at the start of
the next request on the connection (if there is one).
address = the IP address of the remote user
_port = the port number of the connection
pathInfoStarts = the offset into the path component of the http header where the SCRIPT_NAME ends and the PATH_INFO begins.
_https = if this connection is encrypted (note that the input data must not actually be encrypted)
_rawDataOutput = delegate to accept response data. It should write to the socket or whatever; Cgi does all the needed processing to speak http.
_flush = if _rawDataOutput buffers, this delegate should flush the buffer down the wire
closeConnection = if the request asks to close the connection, *closeConnection == true.
*/
this(
BufferedInputRange inputData,
// string[] headers, immutable(ubyte)[] data,
string address, ushort _port,
int pathInfoStarts = 0, // use this if you know the script name, like if this is in a folder in a bigger web environment
bool _https = false,
void delegate(const(ubyte)[]) _rawDataOutput = null,
void delegate() _flush = null,
// this pointer tells if the connection is supposed to be closed after we handle this
bool* closeConnection = null)
{
// these are all set locally so the loop works
// without triggering errors in dmd 2.064
// we go ahead and set them at the end of it to the this version
int port;
string referrer;
string remoteAddress;
string userAgent;
string authorization;
string origin;
string accept;
string lastEventId;
bool https;
string host;
RequestMethod requestMethod;
string requestUri;
string pathInfo;
string queryString;
string scriptName;
string[string] get;
string[][string] getArray;
bool keepAliveRequested;
bool acceptsGzip;
string cookie;
environmentVariables = cast(const) environment.toAA;
idlol = inputData;
isCalledWithCommandLineArguments = false;
https = _https;
port = _port;
rawDataOutput = _rawDataOutput;
flushDelegate = _flush;
nph = true;
remoteAddress = address;
// streaming parser
import al = std.algorithm;
// FIXME: tis cast is technically wrong, but Phobos deprecated al.indexOf... for some reason.
auto idx = indexOf(cast(string) inputData.front(), "\r\n\r\n");
while(idx == -1) {
inputData.popFront(0);
idx = indexOf(cast(string) inputData.front(), "\r\n\r\n");
}
assert(idx != -1);
string contentType = "";
string[string] requestHeadersHere;
size_t contentLength;
bool isChunked;
{
import core.runtime;
scriptFileName = Runtime.args.length ? Runtime.args[0] : null;
}
int headerNumber = 0;
foreach(line; al.splitter(inputData.front()[0 .. idx], "\r\n"))
if(line.length) {
headerNumber++;
auto header = cast(string) line.idup;
if(headerNumber == 1) {
// request line
auto parts = al.splitter(header, " ");
if(parts.front == "PRI") {
// this is an HTTP/2.0 line - "PRI * HTTP/2.0" - which indicates their payload will follow
// we're going to immediately refuse this, im not interested in implementing http2 (it is unlikely
// to bring me benefit)
throw new HttpVersionNotSupportedException();
}
requestMethod = to!RequestMethod(parts.front);
parts.popFront();
requestUri = parts.front;
// FIXME: the requestUri could be an absolute path!!! should I rename it or something?
scriptName = requestUri[0 .. pathInfoStarts];
auto question = requestUri.indexOf("?");
if(question == -1) {
queryString = "";
// FIXME: double check, this might be wrong since it could be url encoded
pathInfo = requestUri[pathInfoStarts..$];
} else {
queryString = requestUri[question+1..$];
pathInfo = requestUri[pathInfoStarts..question];
}
auto ugh = decodeVariables(queryString, "&", &allGetNamesInOrder, &allGetValuesInOrder);
getArray = cast(string[][string]) assumeUnique(ugh);
if(header.indexOf("HTTP/1.0") != -1) {
http10 = true;
autoBuffer = true;
if(closeConnection) {
// on http 1.0, close is assumed (unlike http/1.1 where we assume keep alive)
*closeConnection = true;
}
}
} else {
// other header
auto colon = header.indexOf(":");
if(colon == -1)
throw new Exception("HTTP headers should have a colon!");
string name = header[0..colon].toLower;
string value = header[colon+2..$]; // skip the colon and the space
requestHeadersHere[name] = value;
if (name == "accept") {
accept = value;
}
else if (name == "origin") {
origin = value;
}
else if (name == "connection") {
if(value == "close" && closeConnection)
*closeConnection = true;
if(value.asLowerCase().canFind("keep-alive")) {
keepAliveRequested = true;
// on http 1.0, the connection is closed by default,
// but not if they request keep-alive. then we don't close
// anymore - undoing the set above
if(http10 && closeConnection) {
*closeConnection = false;
}
}
}
else if (name == "transfer-encoding") {
if(value == "chunked")
isChunked = true;
}
else if (name == "last-event-id") {
lastEventId = value;
}
else if (name == "authorization") {
authorization = value;
}
else if (name == "content-type") {
contentType = value;
}
else if (name == "content-length") {
contentLength = to!size_t(value);
}
else if (name == "x-forwarded-for") {
remoteAddress = value;
}
else if (name == "x-forwarded-host" || name == "host") {
if(name != "host" || host is null)
host = value;
}
// FIXME: https://tools.ietf.org/html/rfc7239
else if (name == "accept-encoding") {
if(value.indexOf("gzip") != -1)
acceptsGzip = true;
}
else if (name == "user-agent") {
userAgent = value;
}
else if (name == "referer") {
referrer = value;
}
else if (name == "cookie") {
cookie ~= value;
} else if(name == "expect") {
if(value == "100-continue") {
// FIXME we should probably give user code a chance
// to process and reject but that needs to be virtual,
// perhaps part of the CGI redesign.
// FIXME: if size is > max content length it should
// also fail at this point.
_rawDataOutput(cast(ubyte[]) "HTTP/1.1 100 Continue\r\n\r\n");
// FIXME: let the user write out 103 early hints too
}
}
// else
// ignore it
}
}
inputData.consume(idx + 4);
// done
requestHeaders = assumeUnique(requestHeadersHere);
ByChunkRange dataByChunk;
// reading Content-Length type data
// We need to read up the data we have, and write it out as a chunk.
if(!isChunked) {
dataByChunk = byChunk(inputData, contentLength);
} else {
// chunked requests happen, but not every day. Since we need to know
// the content length (for now, maybe that should change), we'll buffer
// the whole thing here instead of parse streaming. (I think this is what Apache does anyway in cgi modes)
auto data = dechunk(inputData);
// set the range here
dataByChunk = byChunk(data);
contentLength = data.length;
}
assert(dataByChunk !is null);
if(contentLength) {
prepareForIncomingDataChunks(contentType, contentLength);
foreach(dataChunk; dataByChunk) {
handleIncomingDataChunk(dataChunk);
}
postArray = assumeUnique(pps._post);
filesArray = assumeUnique(pps._files);
files = keepLastOf(filesArray);
post = keepLastOf(postArray);
postBody = pps.postBody;
cleanUpPostDataState();
}
this.port = port;
this.referrer = referrer;
this.remoteAddress = remoteAddress;
this.userAgent = userAgent;
this.authorization = authorization;
this.origin = origin;
this.accept = accept;
this.lastEventId = lastEventId;
this.https = https;
this.host = host;
this.requestMethod = requestMethod;
this.requestUri = requestUri;
this.pathInfo = pathInfo;
this.queryString = queryString;
this.scriptName = scriptName;
this.get = keepLastOf(getArray);
this.getArray = cast(immutable) getArray;
this.keepAliveRequested = keepAliveRequested;
this.acceptsGzip = acceptsGzip;
this.cookie = cookie;
cookiesArray = getCookieArray();
cookies = keepLastOf(cookiesArray);
}
BufferedInputRange idlol;
private immutable(string[string]) keepLastOf(in string[][string] arr) {
string[string] ca;
foreach(k, v; arr)
ca[k] = v[$-1];
return assumeUnique(ca);
}
// FIXME duplication
private immutable(UploadedFile[string]) keepLastOf(in UploadedFile[][string] arr) {
UploadedFile[string] ca;
foreach(k, v; arr)
ca[k] = v[$-1];
return assumeUnique(ca);
}
private immutable(string[][string]) getCookieArray() {
auto forTheLoveOfGod = decodeVariables(cookie, "; ");
return assumeUnique(forTheLoveOfGod);
}
/// Very simple method to require a basic auth username and password.
/// If the http request doesn't include the required credentials, it throws a
/// HTTP 401 error, and an exception.
///
/// Note: basic auth does not provide great security, especially over unencrypted HTTP;
/// the user's credentials are sent in plain text on every request.
///
/// If you are using Apache, the HTTP_AUTHORIZATION variable may not be sent to the
/// application. Either use Apache's built in methods for basic authentication, or add
/// something along these lines to your server configuration:
///
/// RewriteEngine On
/// RewriteCond %{HTTP:Authorization} ^(.*)
/// RewriteRule ^(.*) - [E=HTTP_AUTHORIZATION:%1]
///
/// To ensure the necessary data is available to cgi.d.
void requireBasicAuth(string user, string pass, string message = null) {
if(authorization != "Basic " ~ Base64.encode(cast(immutable(ubyte)[]) (user ~ ":" ~ pass))) {
setResponseStatus("401 Authorization Required");
header ("WWW-Authenticate: Basic realm=\""~message~"\"");
close();
throw new Exception("Not authorized; got " ~ authorization);
}
}
/// Very simple caching controls - setCache(false) means it will never be cached. Good for rapidly updated or sensitive sites.
/// setCache(true) means it will always be cached for as long as possible. Best for static content.
/// Use setResponseExpires and updateResponseExpires for more control
void setCache(bool allowCaching) {
noCache = !allowCaching;
}
/// Set to true and use cgi.write(data, true); to send a gzipped response to browsers
/// who can accept it
bool gzipResponse;
immutable bool acceptsGzip;
immutable bool keepAliveRequested;
/// Set to true if and only if this was initialized with command line arguments
immutable bool isCalledWithCommandLineArguments;
/// This gets a full url for the current request, including port, protocol, host, path, and query
string getCurrentCompleteUri() const {
ushort defaultPort = https ? 443 : 80;
string uri = "http";
if(https)
uri ~= "s";
uri ~= "://";
uri ~= host;
/+ // the host has the port so p sure this never needed, cgi on apache and embedded http all do the right hting now
version(none)
if(!(!port || port == defaultPort)) {
uri ~= ":";
uri ~= to!string(port);
}
+/
uri ~= requestUri;
return uri;
}
/// You can override this if your site base url isn't the same as the script name
string logicalScriptName() const {
return scriptName;
}
/++
Sets the HTTP status of the response. For example, "404 File Not Found" or "500 Internal Server Error".
It assumes "200 OK", and automatically changes to "302 Found" if you call setResponseLocation().
Note setResponseStatus() must be called *before* you write() any data to the output.
History:
The `int` overload was added on January 11, 2021.
+/
void setResponseStatus(string status) {
assert(!outputtedResponseData);
responseStatus = status;
}
/// ditto
void setResponseStatus(int statusCode) {
setResponseStatus(getHttpCodeText(statusCode));
}
private string responseStatus = null;
/// Returns true if it is still possible to output headers
bool canOutputHeaders() {
return !isClosed && !outputtedResponseData;
}
/// Sets the location header, which the browser will redirect the user to automatically.
/// Note setResponseLocation() must be called *before* you write() any data to the output.
/// The optional important argument is used if it's a default suggestion rather than something to insist upon.
void setResponseLocation(string uri, bool important = true, string status = null) {
if(!important && isCurrentResponseLocationImportant)
return; // important redirects always override unimportant ones
if(uri is null) {
responseStatus = "200 OK";
responseLocation = null;
isCurrentResponseLocationImportant = important;
return; // this just cancels the redirect
}
assert(!outputtedResponseData);
if(status is null)
responseStatus = "302 Found";
else
responseStatus = status;
responseLocation = uri.strip;
isCurrentResponseLocationImportant = important;
}
protected string responseLocation = null;
private bool isCurrentResponseLocationImportant = false;
/// Sets the Expires: http header. See also: updateResponseExpires, setPublicCaching
/// The parameter is in unix_timestamp * 1000. Try setResponseExpires(getUTCtime() + SOME AMOUNT) for normal use.
/// Note: the when parameter is different than setCookie's expire parameter.
void setResponseExpires(long when, bool isPublic = false) {
responseExpires = when;
setCache(true); // need to enable caching so the date has meaning
responseIsPublic = isPublic;
responseExpiresRelative = false;
}
/// Sets a cache-control max-age header for whenFromNow, in seconds.
void setResponseExpiresRelative(int whenFromNow, bool isPublic = false) {
responseExpires = whenFromNow;
setCache(true); // need to enable caching so the date has meaning
responseIsPublic = isPublic;
responseExpiresRelative = true;
}
private long responseExpires = long.min;
private bool responseIsPublic = false;
private bool responseExpiresRelative = false;
/// This is like setResponseExpires, but it can be called multiple times. The setting most in the past is the one kept.
/// If you have multiple functions, they all might call updateResponseExpires about their own return value. The program
/// output as a whole is as cacheable as the least cachable part in the chain.
/// setCache(false) always overrides this - it is, by definition, the strictest anti-cache statement available. If your site outputs sensitive user data, you should probably call setCache(false) when you do, to ensure no other functions will cache the content, as it may be a privacy risk.
/// Conversely, setting here overrides setCache(true), since any expiration date is in the past of infinity.
void updateResponseExpires(long when, bool isPublic) {
if(responseExpires == long.min)
setResponseExpires(when, isPublic);
else if(when < responseExpires)
setResponseExpires(when, responseIsPublic && isPublic); // if any part of it is private, it all is
}
/*
/// Set to true if you want the result to be cached publically - that is, is the content shared?
/// Should generally be false if the user is logged in. It assumes private cache only.
/// setCache(true) also turns on public caching, and setCache(false) sets to private.
void setPublicCaching(bool allowPublicCaches) {
publicCaching = allowPublicCaches;
}
private bool publicCaching = false;
*/
/++
History:
Added January 11, 2021
+/
enum SameSitePolicy {
Lax,
Strict,
None
}
/++
Sets an HTTP cookie, automatically encoding the data to the correct string.
expiresIn is how many milliseconds in the future the cookie will expire.
TIP: to make a cookie accessible from subdomains, set the domain to .yourdomain.com.
Note setCookie() must be called *before* you write() any data to the output.
History:
Parameter `sameSitePolicy` was added on January 11, 2021.
+/
void setCookie(string name, string data, long expiresIn = 0, string path = null, string domain = null, bool httpOnly = false, bool secure = false, SameSitePolicy sameSitePolicy = SameSitePolicy.Lax) {
assert(!outputtedResponseData);
string cookie = std.uri.encodeComponent(name) ~ "=";
cookie ~= std.uri.encodeComponent(data);
if(path !is null)
cookie ~= "; path=" ~ path;
// FIXME: should I just be using max-age here? (also in cache below)
if(expiresIn != 0)
cookie ~= "; expires=" ~ printDate(cast(DateTime) Clock.currTime(UTC()) + dur!"msecs"(expiresIn));
if(domain !is null)
cookie ~= "; domain=" ~ domain;
if(secure == true)
cookie ~= "; Secure";
if(httpOnly == true )
cookie ~= "; HttpOnly";
final switch(sameSitePolicy) {
case SameSitePolicy.Lax:
cookie ~= "; SameSite=Lax";
break;
case SameSitePolicy.Strict:
cookie ~= "; SameSite=Strict";
break;
case SameSitePolicy.None:
cookie ~= "; SameSite=None";
assert(secure); // cookie spec requires this now, see: https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Set-Cookie/SameSite
break;
}
if(auto idx = name in cookieIndexes) {
responseCookies[*idx] = cookie;
} else {
cookieIndexes[name] = responseCookies.length;
responseCookies ~= cookie;
}
}
private string[] responseCookies;
private size_t[string] cookieIndexes;
/// Clears a previously set cookie with the given name, path, and domain.
void clearCookie(string name, string path = null, string domain = null) {
assert(!outputtedResponseData);
setCookie(name, "", 1, path, domain);
}
/// Sets the content type of the response, for example "text/html" (the default) for HTML, or "image/png" for a PNG image
void setResponseContentType(string ct) {
assert(!outputtedResponseData);
responseContentType = ct;
}
private string responseContentType = null;
/// Adds a custom header. It should be the name: value, but without any line terminator.
/// For example: header("X-My-Header: Some value");
/// Note you should use the specialized functions in this object if possible to avoid
/// duplicates in the output.
void header(string h) {
customHeaders ~= h;
}
/++
I named the original function `header` after PHP, but this pattern more fits
the rest of the Cgi object.
Either name are allowed.
History:
Alias added June 17, 2022.
+/
alias setResponseHeader = header;
private string[] customHeaders;
private bool websocketMode;
void flushHeaders(const(void)[] t, bool isAll = false) {
StackBuffer buffer = StackBuffer(0);
prepHeaders(t, isAll, &buffer);
if(rawDataOutput !is null)
rawDataOutput(cast(const(ubyte)[]) buffer.get());
else {
stdout.rawWrite(buffer.get());
}
}
private void prepHeaders(const(void)[] t, bool isAll, StackBuffer* buffer) {
string terminator = "\n";
if(rawDataOutput !is null)
terminator = "\r\n";
if(responseStatus !is null) {
if(nph) {
if(http10)
buffer.add("HTTP/1.0 ", responseStatus, terminator);
else
buffer.add("HTTP/1.1 ", responseStatus, terminator);
} else
buffer.add("Status: ", responseStatus, terminator);
} else if (nph) {
if(http10)
buffer.add("HTTP/1.0 200 OK", terminator);
else
buffer.add("HTTP/1.1 200 OK", terminator);
}
if(websocketMode)
goto websocket;
if(nph) { // we're responsible for setting the date too according to http 1.1
char[29] db = void;
printDateToBuffer(cast(DateTime) Clock.currTime(UTC()), db[]);
buffer.add("Date: ", db[], terminator);
}
// FIXME: what if the user wants to set his own content-length?
// The custom header function can do it, so maybe that's best.
// Or we could reuse the isAll param.
if(responseLocation !is null) {
buffer.add("Location: ", responseLocation, terminator);
}
if(!noCache && responseExpires != long.min) { // an explicit expiration date is set
if(responseExpiresRelative) {
buffer.add("Cache-Control: ", responseIsPublic ? "public" : "private", ", max-age=");
buffer.add(responseExpires);
buffer.add(", no-cache=\"set-cookie, set-cookie2\"", terminator);
} else {
auto expires = SysTime(unixTimeToStdTime(cast(int)(responseExpires / 1000)), UTC());
char[29] db = void;
printDateToBuffer(cast(DateTime) expires, db[]);
buffer.add("Expires: ", db[], terminator);
// FIXME: assuming everything is private unless you use nocache - generally right for dynamic pages, but not necessarily
buffer.add("Cache-Control: ", (responseIsPublic ? "public" : "private"), ", no-cache=\"set-cookie, set-cookie2\"");
buffer.add(terminator);
}
}
if(responseCookies !is null && responseCookies.length > 0) {
foreach(c; responseCookies)
buffer.add("Set-Cookie: ", c, terminator);
}
if(noCache) { // we specifically do not want caching (this is actually the default)
buffer.add("Cache-Control: private, no-cache=\"set-cookie\"", terminator);
buffer.add("Expires: 0", terminator);
buffer.add("Pragma: no-cache", terminator);
} else {
if(responseExpires == long.min) { // caching was enabled, but without a date set - that means assume cache forever
buffer.add("Cache-Control: public", terminator);
buffer.add("Expires: Tue, 31 Dec 2030 14:00:00 GMT", terminator); // FIXME: should not be more than one year in the future
}
}
if(responseContentType !is null) {
buffer.add("Content-Type: ", responseContentType, terminator);
} else
buffer.add("Content-Type: text/html; charset=utf-8", terminator);
if(gzipResponse && acceptsGzip && isAll) { // FIXME: isAll really shouldn't be necessary
buffer.add("Content-Encoding: gzip", terminator);
}
if(!isAll) {
if(nph && !http10) {
buffer.add("Transfer-Encoding: chunked", terminator);
responseChunked = true;
}
} else {
buffer.add("Content-Length: ");
buffer.add(t.length);
buffer.add(terminator);
if(nph && keepAliveRequested) {
buffer.add("Connection: Keep-Alive", terminator);
}
}
websocket:
foreach(hd; customHeaders)
buffer.add(hd, terminator);
// FIXME: what about duplicated headers?
// end of header indicator
buffer.add(terminator);
outputtedResponseData = true;
}
/// Writes the data to the output, flushing headers if they have not yet been sent.
void write(const(void)[] t, bool isAll = false, bool maybeAutoClose = true) {
assert(!closed, "Output has already been closed");
StackBuffer buffer = StackBuffer(0);
if(gzipResponse && acceptsGzip && isAll) { // FIXME: isAll really shouldn't be necessary
// actually gzip the data here
auto c = new Compress(HeaderFormat.gzip); // want gzip
auto data = c.compress(t);
data ~= c.flush();
// std.file.write("/tmp/last-item", data);
t = data;
}
if(!outputtedResponseData && (!autoBuffer || isAll)) {
prepHeaders(t, isAll, &buffer);
}
if(requestMethod != RequestMethod.HEAD && t.length > 0) {
if (autoBuffer && !isAll) {
outputBuffer ~= cast(ubyte[]) t;
}
if(!autoBuffer || isAll) {
if(rawDataOutput !is null)
if(nph && responseChunked) {
//rawDataOutput(makeChunk(cast(const(ubyte)[]) t));
// we're making the chunk here instead of in a function
// to avoid unneeded gc pressure
buffer.add(toHex(t.length));
buffer.add("\r\n");
buffer.add(cast(char[]) t, "\r\n");
} else {
buffer.add(cast(char[]) t);
}
else
buffer.add(cast(char[]) t);
}
}
if(rawDataOutput !is null)
rawDataOutput(cast(const(ubyte)[]) buffer.get());
else
stdout.rawWrite(buffer.get());
if(maybeAutoClose && isAll)
close(); // if you say it is all, that means we're definitely done
// maybeAutoClose can be false though to avoid this (important if you call from inside close()!
}
/++
Convenience method to set content type to json and write the string as the complete response.
History:
Added January 16, 2020
+/
void writeJson(string json) {
this.setResponseContentType("application/json");
this.write(json, true);
}
/// Flushes the pending buffer, leaving the connection open so you can send more.
void flush() {
if(rawDataOutput is null)
stdout.flush();
else if(flushDelegate !is null)
flushDelegate();
}
version(autoBuffer)
bool autoBuffer = true;
else
bool autoBuffer = false;
ubyte[] outputBuffer;
/// Flushes the buffers to the network, signifying that you are done.
/// You should always call this explicitly when you are done outputting data.
void close() {
if(closed)
return; // don't double close
if(!outputtedResponseData)
write("", true, false);
// writing auto buffered data
if(requestMethod != RequestMethod.HEAD && autoBuffer) {
if(!nph)
stdout.rawWrite(outputBuffer);
else
write(outputBuffer, true, false); // tell it this is everything
}
// closing the last chunk...
if(nph && rawDataOutput !is null && responseChunked)
rawDataOutput(cast(const(ubyte)[]) "0\r\n\r\n");
if(flushDelegate)
flushDelegate();
closed = true;
}
// Closes without doing anything, shouldn't be used often
void rawClose() {
closed = true;
}
/++
Gets a request variable as a specific type, or the default value of it isn't there
or isn't convertible to the request type.
Checks both GET and POST variables, preferring the POST variable, if available.
A nice trick is using the default value to choose the type:
---
/*
The return value will match the type of the default.
Here, I gave 10 as a default, so the return value will
be an int.
If the user-supplied value cannot be converted to the
requested type, you will get the default value back.
*/
int a = cgi.request("number", 10);
if(cgi.get["number"] == "11")
assert(a == 11); // conversion succeeds
if("number" !in cgi.get)
assert(a == 10); // no value means you can't convert - give the default
if(cgi.get["number"] == "twelve")
assert(a == 10); // conversion from string to int would fail, so we get the default
---
You can use an enum as an easy whitelist, too:
---
enum Operations {
add, remove, query
}
auto op = cgi.request("op", Operations.query);
if(cgi.get["op"] == "add")
assert(op == Operations.add);
if(cgi.get["op"] == "remove")
assert(op == Operations.remove);
if(cgi.get["op"] == "query")
assert(op == Operations.query);
if(cgi.get["op"] == "random string")
assert(op == Operations.query); // the value can't be converted to the enum, so we get the default
---
+/
T request(T = string)(in string name, in T def = T.init) const nothrow {
try {
return
(name in post) ? to!T(post[name]) :
(name in get) ? to!T(get[name]) :
def;
} catch(Exception e) { return def; }
}
/// Is the output already closed?
bool isClosed() const {
return closed;
}
/++
Gets a session object associated with the `cgi` request. You can use different type throughout your application.
+/
Session!Data getSessionObject(Data)() {
if(testInProcess !is null) {
// test mode
auto obj = testInProcess.getSessionOverride(typeid(typeof(return)));
if(obj !is null)
return cast(typeof(return)) obj;
else {
auto o = new MockSession!Data();
testInProcess.setSessionOverride(typeid(typeof(return)), o);
return o;
}
} else {
// normal operation
return new BasicDataServerSession!Data(this);
}
}
// if it is in test mode; triggers mock sessions. Used by CgiTester
version(with_breaking_cgi_features)
private CgiTester testInProcess;
/* Hooks for redirecting input and output */
private void delegate(const(ubyte)[]) rawDataOutput = null;
private void delegate() flushDelegate = null;
/* This info is used when handling a more raw HTTP protocol */
private bool nph;
private bool http10;
private bool closed;
private bool responseChunked = false;
version(preserveData) // note: this can eat lots of memory; don't use unless you're sure you need it.
immutable(ubyte)[] originalPostData;
/++
This holds the posted body data if it has not been parsed into [post] and [postArray].
It is intended to be used for JSON and XML request content types, but also may be used
for other content types your application can handle. But it will NOT be populated
for content types application/x-www-form-urlencoded or multipart/form-data, since those are
parsed into the post and postArray members.
Remember that anything beyond your `maxContentLength` param when setting up [GenericMain], etc.,
will be discarded to the client with an error. This helps keep this array from being exploded in size
and consuming all your server's memory (though it may still be possible to eat excess ram from a concurrent
client in certain build modes.)
History:
Added January 5, 2021
Documented February 21, 2023 (dub v11.0)
+/
public immutable string postBody;
alias postJson = postBody; // old name
/* Internal state flags */
private bool outputtedResponseData;
private bool noCache = true;
const(string[string]) environmentVariables;
/** What follows is data gotten from the HTTP request. It is all fully immutable,
partially because it logically is (your code doesn't change what the user requested...)
and partially because I hate how bad programs in PHP change those superglobals to do
all kinds of hard to follow ugliness. I don't want that to ever happen in D.
For some of these, you'll want to refer to the http or cgi specs for more details.
*/
immutable(string[string]) requestHeaders; /// All the raw headers in the request as name/value pairs. The name is stored as all lower case, but otherwise the same as it is in HTTP; words separated by dashes. For example, "cookie" or "accept-encoding". Many HTTP headers have specialized variables below for more convenience and static name checking; you should generally try to use them.
immutable(char[]) host; /// The hostname in the request. If one program serves multiple domains, you can use this to differentiate between them.
immutable(char[]) origin; /// The origin header in the request, if present. Some HTML5 cross-domain apis set this and you should check it on those cross domain requests and websockets.
immutable(char[]) userAgent; /// The browser's user-agent string. Can be used to identify the browser.
immutable(char[]) pathInfo; /// This is any stuff sent after your program's name on the url, but before the query string. For example, suppose your program is named "app". If the user goes to site.com/app, pathInfo is empty. But, he can also go to site.com/app/some/sub/path; treating your program like a virtual folder. In this case, pathInfo == "/some/sub/path".
immutable(char[]) scriptName; /// The full base path of your program, as seen by the user. If your program is located at site.com/programs/apps, scriptName == "/programs/apps".
immutable(char[]) scriptFileName; /// The physical filename of your script
immutable(char[]) authorization; /// The full authorization string from the header, undigested. Useful for implementing auth schemes such as OAuth 1.0. Note that some web servers do not forward this to the app without taking extra steps. See requireBasicAuth's comment for more info.
immutable(char[]) accept; /// The HTTP accept header is the user agent telling what content types it is willing to accept. This is often */*; they accept everything, so it's not terribly useful. (The similar sounding Accept-Encoding header is handled automatically for chunking and gzipping. Simply set gzipResponse = true and cgi.d handles the details, zipping if the user's browser is willing to accept it.)
immutable(char[]) lastEventId; /// The HTML 5 draft includes an EventSource() object that connects to the server, and remains open to take a stream of events. My arsd.rtud module can help with the server side part of that. The Last-Event-Id http header is defined in the draft to help handle loss of connection. When the browser reconnects to you, it sets this header to the last event id it saw, so you can catch it up. This member has the contents of that header.
immutable(RequestMethod) requestMethod; /// The HTTP request verb: GET, POST, etc. It is represented as an enum in cgi.d (which, like many enums, you can convert back to string with std.conv.to()). A HTTP GET is supposed to, according to the spec, not have side effects; a user can GET something over and over again and always have the same result. On all requests, the get[] and getArray[] members may be filled in. The post[] and postArray[] members are only filled in on POST methods.
immutable(char[]) queryString; /// The unparsed content of the request query string - the stuff after the ? in your URL. See get[] and getArray[] for a parse view of it. Sometimes, the unparsed string is useful though if you want a custom format of data up there (probably not a good idea, unless it is really simple, like "?username" perhaps.)
immutable(char[]) cookie; /// The unparsed content of the Cookie: header in the request. See also the cookies[string] member for a parsed view of the data.
/** The Referer header from the request. (It is misspelled in the HTTP spec, and thus the actual request and cgi specs too, but I spelled the word correctly here because that's sane. The spec's misspelling is an implementation detail.) It contains the site url that referred the user to your program; the site that linked to you, or if you're serving images, the site that has you as an image. Also, if you're in an iframe, the referrer is the site that is framing you.
Important note: if the user copy/pastes your url, this is blank, and, just like with all other user data, their browsers can also lie to you. Don't rely on it for real security.
*/
immutable(char[]) referrer;
immutable(char[]) requestUri; /// The full url if the current request, excluding the protocol and host. requestUri == scriptName ~ pathInfo ~ (queryString.length ? "?" ~ queryString : "");
immutable(char[]) remoteAddress; /// The IP address of the user, as we see it. (Might not match the IP of the user's computer due to things like proxies and NAT.)
immutable bool https; /// Was the request encrypted via https?
immutable int port; /// On what TCP port number did the server receive the request?
/** Here come the parsed request variables - the things that come close to PHP's _GET, _POST, etc. superglobals in content. */
immutable(string[string]) get; /// The data from your query string in the url, only showing the last string of each name. If you want to handle multiple values with the same name, use getArray. This only works right if the query string is x-www-form-urlencoded; the default you see on the web with name=value pairs separated by the & character.
immutable(string[string]) post; /// The data from the request's body, on POST requests. It parses application/x-www-form-urlencoded data (used by most web requests, including typical forms), and multipart/form-data requests (used by file uploads on web forms) into the same container, so you can always access them the same way. It makes no attempt to parse other content types. If you want to accept an XML Post body (for a web api perhaps), you'll need to handle the raw data yourself.
immutable(string[string]) cookies; /// Separates out the cookie header into individual name/value pairs (which is how you set them!)
/**
Represents user uploaded files.
When making a file upload form, be sure to follow the standard: set method="POST" and enctype="multipart/form-data" in your html <form> tag attributes. The key into this array is the name attribute on your input tag, just like with other post variables. See the comments on the UploadedFile struct for more information about the data inside, including important notes on max size and content location.
*/
immutable(UploadedFile[][string]) filesArray;
immutable(UploadedFile[string]) files;
/// Use these if you expect multiple items submitted with the same name. btw, assert(get[name] is getArray[name][$-1); should pass. Same for post and cookies.
/// the order of the arrays is the order the data arrives
immutable(string[][string]) getArray; /// like get, but an array of values per name
immutable(string[][string]) postArray; /// ditto for post
immutable(string[][string]) cookiesArray; /// ditto for cookies
// convenience function for appending to a uri without extra ?
// matches the name and effect of javascript's location.search property
string search() const {
if(queryString.length)
return "?" ~ queryString;
return "";
}
// FIXME: what about multiple files with the same name?
private:
//RequestMethod _requestMethod;
}
/// use this for testing or other isolated things when you want it to be no-ops
Cgi dummyCgi(Cgi.RequestMethod method = Cgi.RequestMethod.GET, string url = null, in ubyte[] data = null, void delegate(const(ubyte)[]) outputSink = null) {
// we want to ignore, not use stdout
if(outputSink is null)
outputSink = delegate void(const(ubyte)[]) { };
string[string] env;
env["REQUEST_METHOD"] = to!string(method);
env["CONTENT_LENGTH"] = to!string(data.length);
auto cgi = new Cgi(
0,
env,
{ return data; },
outputSink,
null);
return cgi;
}
/++
A helper test class for request handler unittests.
+/
version(with_breaking_cgi_features)
class CgiTester {
private {
SessionObject[TypeInfo] mockSessions;
SessionObject getSessionOverride(TypeInfo ti) {
if(auto o = ti in mockSessions)
return *o;
else
return null;
}
void setSessionOverride(TypeInfo ti, SessionObject so) {
mockSessions[ti] = so;
}
}
/++
Gets (and creates if necessary) a mock session object for this test. Note
it will be the same one used for any test operations through this CgiTester instance.
+/
Session!Data getSessionObject(Data)() {
auto obj = getSessionOverride(typeid(typeof(return)));
if(obj !is null)
return cast(typeof(return)) obj;
else {
auto o = new MockSession!Data();
setSessionOverride(typeid(typeof(return)), o);
return o;
}
}
/++
Pass a reference to your request handler when creating the tester.
+/
this(void function(Cgi) requestHandler) {
this.requestHandler = requestHandler;
}
/++
You can check response information with these methods after you call the request handler.
+/
struct Response {
int code;
string[string] headers;
string responseText;
ubyte[] responseBody;
}
/++
Executes a test request on your request handler, and returns the response.
Params:
url = The URL to test. Should be an absolute path, but excluding domain. e.g. `"/test"`.
args = additional arguments. Same format as cgi's command line handler.
+/
Response GET(string url, string[] args = null) {
return executeTest("GET", url, args);
}
/// ditto
Response POST(string url, string[] args = null) {
return executeTest("POST", url, args);
}
/// ditto
Response executeTest(string method, string url, string[] args) {
ubyte[] outputtedRawData;
void outputSink(const(ubyte)[] data) {
outputtedRawData ~= data;
}
auto cgi = new Cgi(["test", method, url] ~ args, &outputSink);
cgi.testInProcess = this;
scope(exit) cgi.dispose();
requestHandler(cgi);
cgi.close();
Response response;
if(outputtedRawData.length) {
enum LINE = "\r\n";
auto idx = outputtedRawData.locationOf(LINE ~ LINE);
assert(idx != -1, to!string(outputtedRawData));
auto headers = cast(string) outputtedRawData[0 .. idx];
response.code = 200;
while(headers.length) {
auto i = headers.locationOf(LINE);
if(i == -1) i = cast(int) headers.length;
auto header = headers[0 .. i];
auto c = header.locationOf(":");
if(c != -1) {
auto name = header[0 .. c];
auto value = header[c + 2 ..$];
if(name == "Status")
response.code = value[0 .. value.locationOf(" ")].to!int;
response.headers[name] = value;
} else {
assert(0);
}
if(i != headers.length)
i += 2;
headers = headers[i .. $];
}
response.responseBody = outputtedRawData[idx + 4 .. $];
response.responseText = cast(string) response.responseBody;
}
return response;
}
private void function(Cgi) requestHandler;
}
// should this be a separate module? Probably, but that's a hassle.
/// Makes a data:// uri that can be used as links in most newer browsers (IE8+).
string makeDataUrl(string mimeType, in void[] data) {
auto data64 = Base64.encode(cast(const(ubyte[])) data);
return "data:" ~ mimeType ~ ";base64," ~ assumeUnique(data64);
}
// FIXME: I don't think this class correctly decodes/encodes the individual parts
/// Represents a url that can be broken down or built up through properties
struct Uri {
alias toString this; // blargh idk a url really is a string, but should it be implicit?
// scheme//userinfo@host:port/path?query#fragment
string scheme; /// e.g. "http" in "http://example.com/"
string userinfo; /// the username (and possibly a password) in the uri
string host; /// the domain name
int port; /// port number, if given. Will be zero if a port was not explicitly given
string path; /// e.g. "/folder/file.html" in "http://example.com/folder/file.html"
string query; /// the stuff after the ? in a uri
string fragment; /// the stuff after the # in a uri.
// idk if i want to keep these, since the functions they wrap are used many, many, many times in existing code, so this is either an unnecessary alias or a gratuitous break of compatibility
// the decode ones need to keep different names anyway because we can't overload on return values...
static string encode(string s) { return std.uri.encodeComponent(s); }
static string encode(string[string] s) { return encodeVariables(s); }
static string encode(string[][string] s) { return encodeVariables(s); }
/// Breaks down a uri string to its components
this(string uri) {
reparse(uri);
}
private void reparse(string uri) {
// from RFC 3986
// the ctRegex triples the compile time and makes ugly errors for no real benefit
// it was a nice experiment but just not worth it.
// enum ctr = ctRegex!r"^(([^:/?#]+):)?(//([^/?#]*))?([^?#]*)(\?([^#]*))?(#(.*))?";
/*
Captures:
0 = whole url
1 = scheme, with :
2 = scheme, no :
3 = authority, with //
4 = authority, no //
5 = path
6 = query string, with ?
7 = query string, no ?
8 = anchor, with #
9 = anchor, no #
*/
// Yikes, even regular, non-CT regex is also unacceptably slow to compile. 1.9s on my computer!
// instead, I will DIY and cut that down to 0.6s on the same computer.
/*
Note that authority is
user:password@domain:port
where the user:password@ part is optional, and the :port is optional.
Regex translation:
Scheme cannot have :, /, ?, or # in it, and must have one or more chars and end in a :. It is optional, but must be first.
Authority must start with //, but cannot have any other /, ?, or # in it. It is optional.
Path cannot have any ? or # in it. It is optional.
Query must start with ? and must not have # in it. It is optional.
Anchor must start with # and can have anything else in it to end of string. It is optional.
*/
this = Uri.init; // reset all state
// empty uri = nothing special
if(uri.length == 0) {
return;
}
size_t idx;
scheme_loop: foreach(char c; uri[idx .. $]) {
switch(c) {
case ':':
case '/':
case '?':
case '#':
break scheme_loop;
default:
}
idx++;
}
if(idx == 0 && uri[idx] == ':') {
// this is actually a path! we skip way ahead
goto path_loop;
}
if(idx == uri.length) {
// the whole thing is a path, apparently
path = uri;
return;
}
if(idx > 0 && uri[idx] == ':') {
scheme = uri[0 .. idx];
idx++;
} else {
// we need to rewind; it found a / but no :, so the whole thing is prolly a path...
idx = 0;
}
if(idx + 2 < uri.length && uri[idx .. idx + 2] == "//") {
// we have an authority....
idx += 2;
auto authority_start = idx;
authority_loop: foreach(char c; uri[idx .. $]) {
switch(c) {
case '/':
case '?':
case '#':
break authority_loop;
default:
}
idx++;
}
auto authority = uri[authority_start .. idx];
auto idx2 = authority.indexOf("@");
if(idx2 != -1) {
userinfo = authority[0 .. idx2];
authority = authority[idx2 + 1 .. $];
}
if(authority.length && authority[0] == '[') {
// ipv6 address special casing
idx2 = authority.indexOf(']');
if(idx2 != -1) {
auto end = authority[idx2 + 1 .. $];
if(end.length && end[0] == ':')
idx2 = idx2 + 1;
else
idx2 = -1;
}
} else {
idx2 = authority.indexOf(":");
}
if(idx2 == -1) {
port = 0; // 0 means not specified; we should use the default for the scheme
host = authority;
} else {
host = authority[0 .. idx2];
if(idx2 + 1 < authority.length)
port = to!int(authority[idx2 + 1 .. $]);
else
port = 0;
}
}
path_loop:
auto path_start = idx;
foreach(char c; uri[idx .. $]) {
if(c == '?' || c == '#')
break;
idx++;
}
path = uri[path_start .. idx];
if(idx == uri.length)
return; // nothing more to examine...
if(uri[idx] == '?') {
idx++;
auto query_start = idx;
foreach(char c; uri[idx .. $]) {
if(c == '#')
break;
idx++;
}
query = uri[query_start .. idx];
}
if(idx < uri.length && uri[idx] == '#') {
idx++;
fragment = uri[idx .. $];
}
// uriInvalidated = false;
}
private string rebuildUri() const {
string ret;
if(scheme.length)
ret ~= scheme ~ ":";
if(userinfo.length || host.length)
ret ~= "//";
if(userinfo.length)
ret ~= userinfo ~ "@";
if(host.length)
ret ~= host;
if(port)
ret ~= ":" ~ to!string(port);
ret ~= path;
if(query.length)
ret ~= "?" ~ query;
if(fragment.length)
ret ~= "#" ~ fragment;
// uri = ret;
// uriInvalidated = false;
return ret;
}
/// Converts the broken down parts back into a complete string
string toString() const {
// if(uriInvalidated)
return rebuildUri();
}
/// Returns a new absolute Uri given a base. It treats this one as
/// relative where possible, but absolute if not. (If protocol, domain, or
/// other info is not set, the new one inherits it from the base.)
///
/// Browsers use a function like this to figure out links in html.
Uri basedOn(in Uri baseUrl) const {
Uri n = this; // copies
if(n.scheme == "data")
return n;
// n.uriInvalidated = true; // make sure we regenerate...
// userinfo is not inherited... is this wrong?
// if anything is given in the existing url, we don't use the base anymore.
if(n.scheme.empty) {
n.scheme = baseUrl.scheme;
if(n.host.empty) {
n.host = baseUrl.host;
if(n.port == 0) {
n.port = baseUrl.port;
if(n.path.length > 0 && n.path[0] != '/') {
auto b = baseUrl.path[0 .. baseUrl.path.lastIndexOf("/") + 1];
if(b.length == 0)
b = "/";
n.path = b ~ n.path;
} else if(n.path.length == 0) {
n.path = baseUrl.path;
}
}
}
}
n.removeDots();
return n;
}
void removeDots() {
auto parts = this.path.split("/");
string[] toKeep;
foreach(part; parts) {
if(part == ".") {
continue;
} else if(part == "..") {
//if(toKeep.length > 1)
toKeep = toKeep[0 .. $-1];
//else
//toKeep = [""];
continue;
} else {
//if(toKeep.length && toKeep[$-1].length == 0 && part.length == 0)
//continue; // skip a `//` situation
toKeep ~= part;
}
}
auto path = toKeep.join("/");
if(path.length && path[0] != '/')
path = "/" ~ path;
this.path = path;
}
unittest {
auto uri = Uri("test.html");
assert(uri.path == "test.html");
uri = Uri("path/1/lol");
assert(uri.path == "path/1/lol");
uri = Uri("http://me@example.com");
assert(uri.scheme == "http");
assert(uri.userinfo == "me");
assert(uri.host == "example.com");
uri = Uri("http://example.com/#a");
assert(uri.scheme == "http");
assert(uri.host == "example.com");
assert(uri.fragment == "a");
uri = Uri("#foo");
assert(uri.fragment == "foo");
uri = Uri("?lol");
assert(uri.query == "lol");
uri = Uri("#foo?lol");
assert(uri.fragment == "foo?lol");
uri = Uri("?lol#foo");
assert(uri.fragment == "foo");
assert(uri.query == "lol");
uri = Uri("http://127.0.0.1/");
assert(uri.host == "127.0.0.1");
assert(uri.port == 0);
uri = Uri("http://127.0.0.1:123/");
assert(uri.host == "127.0.0.1");
assert(uri.port == 123);
uri = Uri("http://[ff:ff::0]/");
assert(uri.host == "[ff:ff::0]");
uri = Uri("http://[ff:ff::0]:123/");
assert(uri.host == "[ff:ff::0]");
assert(uri.port == 123);
}
// This can sometimes be a big pain in the butt for me, so lots of copy/paste here to cover
// the possibilities.
unittest {
auto url = Uri("cool.html"); // checking relative links
assert(url.basedOn(Uri("http://test.com/what/test.html")) == "http://test.com/what/cool.html");
assert(url.basedOn(Uri("https://test.com/what/test.html")) == "https://test.com/what/cool.html");
assert(url.basedOn(Uri("http://test.com/what/")) == "http://test.com/what/cool.html");
assert(url.basedOn(Uri("http://test.com/")) == "http://test.com/cool.html");
assert(url.basedOn(Uri("http://test.com")) == "http://test.com/cool.html");
assert(url.basedOn(Uri("http://test.com/what/test.html?a=b")) == "http://test.com/what/cool.html");
assert(url.basedOn(Uri("http://test.com/what/test.html?a=b&c=d")) == "http://test.com/what/cool.html");
assert(url.basedOn(Uri("http://test.com/what/test.html?a=b&c=d#what")) == "http://test.com/what/cool.html");
assert(url.basedOn(Uri("http://test.com")) == "http://test.com/cool.html");
url = Uri("/something/cool.html"); // same server, different path
assert(url.basedOn(Uri("http://test.com/what/test.html")) == "http://test.com/something/cool.html");
assert(url.basedOn(Uri("https://test.com/what/test.html")) == "https://test.com/something/cool.html");
assert(url.basedOn(Uri("http://test.com/what/")) == "http://test.com/something/cool.html");
assert(url.basedOn(Uri("http://test.com/")) == "http://test.com/something/cool.html");
assert(url.basedOn(Uri("http://test.com")) == "http://test.com/something/cool.html");
assert(url.basedOn(Uri("http://test.com/what/test.html?a=b")) == "http://test.com/something/cool.html");
assert(url.basedOn(Uri("http://test.com/what/test.html?a=b&c=d")) == "http://test.com/something/cool.html");
assert(url.basedOn(Uri("http://test.com/what/test.html?a=b&c=d#what")) == "http://test.com/something/cool.html");
assert(url.basedOn(Uri("http://test.com")) == "http://test.com/something/cool.html");
url = Uri("?query=answer"); // same path. server, protocol, and port, just different query string and fragment
assert(url.basedOn(Uri("http://test.com/what/test.html")) == "http://test.com/what/test.html?query=answer");
assert(url.basedOn(Uri("https://test.com/what/test.html")) == "https://test.com/what/test.html?query=answer");
assert(url.basedOn(Uri("http://test.com/what/")) == "http://test.com/what/?query=answer");
assert(url.basedOn(Uri("http://test.com/")) == "http://test.com/?query=answer");
assert(url.basedOn(Uri("http://test.com")) == "http://test.com?query=answer");
assert(url.basedOn(Uri("http://test.com/what/test.html?a=b")) == "http://test.com/what/test.html?query=answer");
assert(url.basedOn(Uri("http://test.com/what/test.html?a=b&c=d")) == "http://test.com/what/test.html?query=answer");
assert(url.basedOn(Uri("http://test.com/what/test.html?a=b&c=d#what")) == "http://test.com/what/test.html?query=answer");
assert(url.basedOn(Uri("http://test.com")) == "http://test.com?query=answer");
url = Uri("/test/bar");
assert(Uri("./").basedOn(url) == "/test/", Uri("./").basedOn(url));
assert(Uri("../").basedOn(url) == "/");
url = Uri("http://example.com/");
assert(Uri("../foo").basedOn(url) == "http://example.com/foo");
//auto uriBefore = url;
url = Uri("#anchor"); // everything should remain the same except the anchor
//uriBefore.anchor = "anchor");
//assert(url == uriBefore);
url = Uri("//example.com"); // same protocol, but different server. the path here should be blank.
url = Uri("//example.com/example.html"); // same protocol, but different server and path
url = Uri("http://example.com/test.html"); // completely absolute link should never be modified
url = Uri("http://example.com"); // completely absolute link should never be modified, even if it has no path
// FIXME: add something for port too
}
// these are like javascript's location.search and location.hash
string search() const {
return query.length ? ("?" ~ query) : "";
}
string hash() const {
return fragment.length ? ("#" ~ fragment) : "";
}
}
/*
for session, see web.d
*/
/// breaks down a url encoded string
string[][string] decodeVariables(string data, string separator = "&", string[]* namesInOrder = null, string[]* valuesInOrder = null) {
auto vars = data.split(separator);
string[][string] _get;
foreach(var; vars) {
auto equal = var.indexOf("=");
string name;
string value;
if(equal == -1) {
name = decodeComponent(var);
value = "";
} else {
//_get[decodeComponent(var[0..equal])] ~= decodeComponent(var[equal + 1 .. $].replace("+", " "));
// stupid + -> space conversion.
name = decodeComponent(var[0..equal].replace("+", " "));
value = decodeComponent(var[equal + 1 .. $].replace("+", " "));
}
_get[name] ~= value;
if(namesInOrder)
(*namesInOrder) ~= name;
if(valuesInOrder)
(*valuesInOrder) ~= value;
}
return _get;
}
/// breaks down a url encoded string, but only returns the last value of any array
string[string] decodeVariablesSingle(string data) {
string[string] va;
auto varArray = decodeVariables(data);
foreach(k, v; varArray)
va[k] = v[$-1];
return va;
}
/// url encodes the whole string
string encodeVariables(in string[string] data) {
string ret;
bool outputted = false;
foreach(k, v; data) {
if(outputted)
ret ~= "&";
else
outputted = true;
ret ~= std.uri.encodeComponent(k) ~ "=" ~ std.uri.encodeComponent(v);
}
return ret;
}
/// url encodes a whole string
string encodeVariables(in string[][string] data) {
string ret;
bool outputted = false;
foreach(k, arr; data) {
foreach(v; arr) {
if(outputted)
ret ~= "&";
else
outputted = true;
ret ~= std.uri.encodeComponent(k) ~ "=" ~ std.uri.encodeComponent(v);
}
}
return ret;
}
/// Encodes all but the explicitly unreserved characters per rfc 3986
/// Alphanumeric and -_.~ are the only ones left unencoded
/// name is borrowed from php
string rawurlencode(in char[] data) {
string ret;
ret.reserve(data.length * 2);
foreach(char c; data) {
if(
(c >= 'a' && c <= 'z') ||
(c >= 'A' && c <= 'Z') ||
(c >= '0' && c <= '9') ||
c == '-' || c == '_' || c == '.' || c == '~')
{
ret ~= c;
} else {
ret ~= '%';
// since we iterate on char, this should give us the octets of the full utf8 string
ret ~= toHexUpper(c);
}
}
return ret;
}
// http helper functions
// for chunked responses (which embedded http does whenever possible)
version(none) // this is moved up above to avoid making a copy of the data
const(ubyte)[] makeChunk(const(ubyte)[] data) {
const(ubyte)[] ret;
ret = cast(const(ubyte)[]) toHex(data.length);
ret ~= cast(const(ubyte)[]) "\r\n";
ret ~= data;
ret ~= cast(const(ubyte)[]) "\r\n";
return ret;
}
string toHex(long num) {
string ret;
while(num) {
int v = num % 16;
num /= 16;
char d = cast(char) ((v < 10) ? v + '0' : (v-10) + 'a');
ret ~= d;
}
return to!string(array(ret.retro));
}
string toHexUpper(long num) {
string ret;
while(num) {
int v = num % 16;
num /= 16;
char d = cast(char) ((v < 10) ? v + '0' : (v-10) + 'A');
ret ~= d;
}
if(ret.length == 1)
ret ~= "0"; // url encoding requires two digits and that's what this function is used for...
return to!string(array(ret.retro));
}
// the generic mixins
/++
Use this instead of writing your own main
It ultimately calls [cgiMainImpl] which creates a [RequestServer] for you.
+/
mixin template GenericMain(alias fun, long maxContentLength = defaultMaxContentLength) {
mixin CustomCgiMain!(Cgi, fun, maxContentLength);
}
/++
Boilerplate mixin for a main function that uses the [dispatcher] function.
You can send `typeof(null)` as the `Presenter` argument to use a generic one.
History:
Added July 9, 2021
+/
mixin template DispatcherMain(Presenter, DispatcherArgs...) {
/// forwards to [CustomCgiDispatcherMain] with default args
mixin CustomCgiDispatcherMain!(Cgi, defaultMaxContentLength, Presenter, DispatcherArgs);
}
/// ditto
mixin template DispatcherMain(DispatcherArgs...) if(!is(DispatcherArgs[0] : WebPresenter!T, T)) {
class GenericPresenter : WebPresenter!GenericPresenter {}
mixin DispatcherMain!(GenericPresenter, DispatcherArgs);
}
/++
Allows for a generic [DispatcherMain] with custom arguments. Note you can use [defaultMaxContentLength] as the second argument if you like.
History:
Added May 13, 2023 (dub v11.0)
+/
mixin template CustomCgiDispatcherMain(CustomCgi, size_t maxContentLength, Presenter, DispatcherArgs...) {
/++
Handler to the generated presenter you can use from your objects, etc.
+/
Presenter activePresenter;
/++
Request handler that creates the presenter then forwards to the [dispatcher] function.
Renders 404 if the dispatcher did not handle the request.
Will automatically serve the presenter.style and presenter.script as "style.css" and "script.js"
+/
void handler(Cgi cgi) {
auto presenter = new Presenter;
activePresenter = presenter;
scope(exit) activePresenter = null;
if(cgi.dispatcher!DispatcherArgs(presenter))
return;
switch(cgi.pathInfo) {
case "/style.css":
cgi.setCache(true);
cgi.setResponseContentType("text/css");
cgi.write(presenter.style(), true);
break;
case "/script.js":
cgi.setCache(true);
cgi.setResponseContentType("application/javascript");
cgi.write(presenter.script(), true);
break;
default:
presenter.renderBasicError(cgi, 404);
}
}
mixin CustomCgiMain!(CustomCgi, handler, maxContentLength);
}
/// ditto
mixin template CustomCgiDispatcherMain(CustomCgi, size_t maxContentLength, DispatcherArgs...) if(!is(DispatcherArgs[0] : WebPresenter!T, T)) {
class GenericPresenter : WebPresenter!GenericPresenter {}
mixin CustomCgiDispatcherMain!(CustomCgi, maxContentLength, GenericPresenter, DispatcherArgs);
}
private string simpleHtmlEncode(string s) {
return s.replace("&", "&").replace("<", "<").replace(">", ">").replace("\n", "<br />\n");
}
string messageFromException(Throwable t) {
string message;
if(t !is null) {
debug message = t.toString();
else message = "An unexpected error has occurred.";
} else {
message = "Unknown error";
}
return message;
}
string plainHttpError(bool isCgi, string type, Throwable t) {
auto message = messageFromException(t);
message = simpleHtmlEncode(message);
return format("%s %s\r\nContent-Length: %s\r\nConnection: close\r\n\r\n%s",
isCgi ? "Status:" : "HTTP/1.1",
type, message.length, message);
}
// returns true if we were able to recover reasonably
bool handleException(Cgi cgi, Throwable t) {
if(cgi.isClosed) {
// if the channel has been explicitly closed, we can't handle it here
return true;
}
if(cgi.outputtedResponseData) {
// the headers are sent, but the channel is open... since it closes if all was sent, we can append an error message here.
return false; // but I don't want to, since I don't know what condition the output is in; I don't want to inject something (nor check the content-type for that matter. So we say it was not a clean handling.
} else {
// no headers are sent, we can send a full blown error and recover
cgi.setCache(false);
cgi.setResponseContentType("text/html");
cgi.setResponseLocation(null); // cancel the redirect
cgi.setResponseStatus("500 Internal Server Error");
cgi.write(simpleHtmlEncode(messageFromException(t)));
cgi.close();
return true;
}
}
bool isCgiRequestMethod(string s) {
s = s.toUpper();
if(s == "COMMANDLINE")
return true;
foreach(member; __traits(allMembers, Cgi.RequestMethod))
if(s == member)
return true;
return false;
}
/// If you want to use a subclass of Cgi with generic main, use this mixin.
mixin template CustomCgiMain(CustomCgi, alias fun, long maxContentLength = defaultMaxContentLength) if(is(CustomCgi : Cgi)) {
// kinda hacky - the T... is passed to Cgi's constructor in standard cgi mode, and ignored elsewhere
void main(string[] args) {
cgiMainImpl!(fun, CustomCgi, maxContentLength)(args);
}
}
version(embedded_httpd_processes)
__gshared int processPoolSize = 8;
// Returns true if run. You should exit the program after that.
bool tryAddonServers(string[] args) {
if(args.length > 1) {
// run the special separate processes if needed
switch(args[1]) {
case "--websocket-server":
version(with_addon_servers)
websocketServers[args[2]](args[3 .. $]);
else
printf("Add-on servers not compiled in.\n");
return true;
case "--websocket-servers":
import core.demangle;
version(with_addon_servers_connections)
foreach(k, v; websocketServers)
writeln(k, "\t", demangle(k));
return true;
case "--session-server":
version(with_addon_servers)
runSessionServer();
else
printf("Add-on servers not compiled in.\n");
return true;
case "--event-server":
version(with_addon_servers)
runEventServer();
else
printf("Add-on servers not compiled in.\n");
return true;
case "--timer-server":
version(with_addon_servers)
runTimerServer();
else
printf("Add-on servers not compiled in.\n");
return true;
case "--timed-jobs":
import core.demangle;
version(with_addon_servers_connections)
foreach(k, v; scheduledJobHandlers)
writeln(k, "\t", demangle(k));
return true;
case "--timed-job":
scheduledJobHandlers[args[2]](args[3 .. $]);
return true;
default:
// intentionally blank - do nothing and carry on to run normally
}
}
return false;
}
/// Tries to simulate a request from the command line. Returns true if it does, false if it didn't find the args.
bool trySimulatedRequest(alias fun, CustomCgi = Cgi)(string[] args) if(is(CustomCgi : Cgi)) {
// we support command line thing for easy testing everywhere
// it needs to be called ./app method uri [other args...]
if(args.length >= 3 && isCgiRequestMethod(args[1])) {
Cgi cgi = new CustomCgi(args);
scope(exit) cgi.dispose();
fun(cgi);
cgi.close();
return true;
}
return false;
}
/++
A server control and configuration struct, as a potential alternative to calling [GenericMain] or [cgiMainImpl]. See the source of [cgiMainImpl] for a complete, up-to-date, example of how it is used internally.
As of version 11 (released August 2023), you can also make things like this:
---
// listens on both a unix domain socket called `foo` and on the loopback interfaces port 8080
RequestServer server = RequestServer(["http://unix:foo", "http://localhost:8080"]);
// can also:
// RequestServer server = RequestServer(0); // listen on an OS-provided port on all interfaces
// NOT IMPLEMENTED YET
// server.initialize(); // explicit initialization will populate any "any port" things and throw if a bind failed
foreach(listenSpec; server.listenSpecs) {
// you can check what it actually bound to here and see your assigned ports
}
// NOT IMPLEMENTED YET
// server.start!handler(); // starts and runs in the arsd.core event loop
server.serve!handler(); // blocks the thread until the server exits
---
History:
Added Sept 26, 2020 (release version 8.5).
The `listenSpec` member was added July 31, 2023.
+/
struct RequestServer {
/++
Sets the host and port the server will listen on. This is semi-deprecated; the new (as of July 31, 2023) [listenSpec] parameter obsoletes these. You cannot use both together; the listeningHost and listeningPort are ONLY used if listenSpec is null.
+/
string listeningHost = defaultListeningHost();
/// ditto
ushort listeningPort = defaultListeningPort();
static struct ListenSpec {
enum Protocol {
http,
https,
scgi
}
Protocol protocol;
enum AddressType {
ip,
unix,
abstract_
}
AddressType addressType;
string address;
ushort port;
}
/++
The array of addresses you want to listen on. The format looks like a url but has a few differences.
This ONLY works on embedded_httpd_threads, embedded_httpd_hybrid, and scgi builds at this time.
`http://localhost:8080`
`http://unix:filename/here`
`scgi://abstract:/name/here`
`http://[::1]:4444`
Note that IPv6 addresses must be enclosed in brackets. If you want to listen on an interface called `unix` or `abstract`, contact me, that is not supported but I could add some kind of escape mechanism.
If you leave off the protocol, it assumes the default based on compile flags. If you only give a number, it is assumed to be a port on any tcp interface.
`localhost:8080` serves the default protocol.
`8080` or `:8080` assumes default protocol on localhost.
The protocols can be `http:`, `https:`, and `scgi:`. Original `cgi` is not supported with this, since it is transactional with a single process.
Valid hosts are an IPv4 address (with a mandatory port), an IPv6 address (with a mandatory port), just a port alone, `unix:/path/to/unix/socket` (which may be a relative path without a leading slash), or `abstract:/path/to/linux/abstract/namespace`.
`http://unix:foo` will serve http over the unix domain socket named `foo` in the current working directory.
$(PITFALL
If you set this to anything non-null (including a non-null, zero-length array) any `listenSpec` entries, [listeningHost] and [listeningPort] are ignored.
)
Bugs:
The implementation currently ignores the protocol spec in favor of the default compiled in option.
History:
Added July 31, 2023 (dub v11.0)
+/
string[] listenSpec;
/++
Uses a fork() call, if available, to provide additional crash resiliency and possibly improved performance. On the
other hand, if you fork, you must not assume any memory is shared between requests (you shouldn't be anyway though! But
if you have to, you probably want to set this to false and use an explicit threaded server with [serveEmbeddedHttp]) and
[stop] may not work as well.
History:
Added August 12, 2022 (dub v10.9). Previously, this was only configurable through the `-version=cgi_no_fork`
argument to dmd. That version still defines the value of `cgi_use_fork_default`, used to initialize this, for
compatibility.
+/
bool useFork = cgi_use_fork_default;
/++
Determines the number of worker threads to spawn per process, for server modes that use worker threads. 0 will use a
default based on the number of cpus modified by the server mode.
History:
Added August 12, 2022 (dub v10.9)
+/
int numberOfThreads = 0;
/++
Creates a server configured to listen to multiple URLs.
History:
Added July 31, 2023 (dub v11.0)
+/
this(string[] listenTo) {
this.listenSpec = listenTo;
}
/// Creates a server object configured to listen on a single host and port.
this(string defaultHost, ushort defaultPort) {
this.listeningHost = defaultHost;
this.listeningPort = defaultPort;
}
/// ditto
this(ushort defaultPort) {
listeningPort = defaultPort;
}
/++
Reads the command line arguments into the values here.
Possible arguments are `--listen` (can appear multiple times), `--listening-host`, `--listening-port` (or `--port`), `--uid`, and `--gid`.
Please note you cannot combine `--listen` with `--listening-host` or `--listening-port` / `--port`. Use one or the other style.
+/
void configureFromCommandLine(string[] args) {
bool portOrHostFound = false;
bool foundPort = false;
bool foundHost = false;
bool foundUid = false;
bool foundGid = false;
bool foundListen = false;
foreach(arg; args) {
if(foundPort) {
listeningPort = to!ushort(arg);
portOrHostFound = true;
foundPort = false;
continue;
}
if(foundHost) {
listeningHost = arg;
portOrHostFound = true;
foundHost = false;
continue;
}
if(foundUid) {
privilegesDropToUid = to!uid_t(arg);
foundUid = false;
continue;
}
if(foundGid) {
privilegesDropToGid = to!gid_t(arg);
foundGid = false;
continue;
}
if(foundListen) {
this.listenSpec ~= arg;
foundListen = false;
continue;
}
if(arg == "--listening-host" || arg == "-h" || arg == "/listening-host")
foundHost = true;
else if(arg == "--port" || arg == "-p" || arg == "/port" || arg == "--listening-port")
foundPort = true;
else if(arg == "--uid")
foundUid = true;
else if(arg == "--gid")
foundGid = true;
else if(arg == "--listen")
foundListen = true;
}
if(portOrHostFound && listenSpec.length) {
throw new Exception("You passed both a --listening-host or --listening-port and a --listen argument. You should fix your script to ONLY use --listen arguments.");
}
}
version(Windows) {
private alias uid_t = int;
private alias gid_t = int;
}
/// user (uid) to drop privileges to
/// 0 … do nothing
uid_t privilegesDropToUid = 0;
/// group (gid) to drop privileges to
/// 0 … do nothing
gid_t privilegesDropToGid = 0;
private void dropPrivileges() {
version(Posix) {
import core.sys.posix.unistd;
if (privilegesDropToGid != 0 && setgid(privilegesDropToGid) != 0)
throw new Exception("Dropping privileges via setgid() failed.");
if (privilegesDropToUid != 0 && setuid(privilegesDropToUid) != 0)
throw new Exception("Dropping privileges via setuid() failed.");
}
else {
// FIXME: Windows?
//pragma(msg, "Dropping privileges is not implemented for this platform");
}
// done, set zero
privilegesDropToGid = 0;
privilegesDropToUid = 0;
}
/++
Serves a single HTTP request on this thread, with an embedded server, then stops. Designed for cases like embedded oauth responders
History:
Added Oct 10, 2020.
Example:
---
import arsd.cgi;
void main() {
RequestServer server = RequestServer("127.0.0.1", 6789);
string oauthCode;
string oauthScope;
server.serveHttpOnce!((cgi) {
oauthCode = cgi.request("code");
oauthScope = cgi.request("scope");
cgi.write("Thank you, please return to the application.");
});
// use the code and scope given
}
---
+/
void serveHttpOnce(alias fun, CustomCgi = Cgi, long maxContentLength = defaultMaxContentLength)() {
import std.socket;
bool tcp;
void delegate() cleanup;
auto socket = startListening(listeningHost, listeningPort, tcp, cleanup, 1, &dropPrivileges);
auto connection = socket.accept();
doThreadHttpConnectionGuts!(CustomCgi, fun, true)(connection);
if(cleanup)
cleanup();
}
/++
Starts serving requests according to the current configuration.
+/
void serve(alias fun, CustomCgi = Cgi, long maxContentLength = defaultMaxContentLength)() {
version(netman_httpd) {
// Obsolete!
import arsd.httpd;
// what about forwarding the other constructor args?
// this probably needs a whole redoing...
serveHttp!CustomCgi(&fun, listeningPort);//5005);
return;
} else
version(embedded_httpd_processes) {
serveEmbeddedHttpdProcesses!(fun, CustomCgi)(this);
} else
version(embedded_httpd_threads) {
serveEmbeddedHttp!(fun, CustomCgi, maxContentLength)();
} else
version(scgi) {
serveScgi!(fun, CustomCgi, maxContentLength)();
} else
version(fastcgi) {
serveFastCgi!(fun, CustomCgi, maxContentLength)(this);
} else
version(stdio_http) {
serveSingleHttpConnectionOnStdio!(fun, CustomCgi, maxContentLength)();
} else {
//version=plain_cgi;
handleCgiRequest!(fun, CustomCgi, maxContentLength)();
}
}
/++
Runs the embedded HTTP thread server specifically, regardless of which build configuration you have.
If you want the forking worker process server, you do need to compile with the embedded_httpd_processes config though.
+/
void serveEmbeddedHttp(alias fun, CustomCgi = Cgi, long maxContentLength = defaultMaxContentLength)(ThisFor!fun _this) {
globalStopFlag = false;
static if(__traits(isStaticFunction, fun))
alias funToUse = fun;
else
void funToUse(CustomCgi cgi) {
static if(__VERSION__ > 2097)
__traits(child, _this, fun)(cgi);
else static assert(0, "Not implemented in your compiler version!");
}
auto manager = this.listenSpec is null ?
new ListeningConnectionManager(listeningHost, listeningPort, &doThreadHttpConnection!(CustomCgi, funToUse), null, useFork, numberOfThreads) :
new ListeningConnectionManager(this.listenSpec, &doThreadHttpConnection!(CustomCgi, funToUse), null, useFork, numberOfThreads);
manager.listen();
}
/++
Runs the embedded SCGI server specifically, regardless of which build configuration you have.
+/
void serveScgi(alias fun, CustomCgi = Cgi, long maxContentLength = defaultMaxContentLength)() {
globalStopFlag = false;
auto manager = this.listenSpec is null ?
new ListeningConnectionManager(listeningHost, listeningPort, &doThreadScgiConnection!(CustomCgi, fun, maxContentLength), null, useFork, numberOfThreads) :
new ListeningConnectionManager(this.listenSpec, &doThreadScgiConnection!(CustomCgi, fun, maxContentLength), null, useFork, numberOfThreads);
manager.listen();
}
/++
Serves a single "connection", but the connection is spoken on stdin and stdout instead of on a socket.
Intended for cases like working from systemd, like discussed here: [https://forum.dlang.org/post/avmkfdiitirnrenzljwc@forum.dlang.org]
History:
Added May 29, 2021
+/
void serveSingleHttpConnectionOnStdio(alias fun, CustomCgi = Cgi, long maxContentLength = defaultMaxContentLength)() {
doThreadHttpConnectionGuts!(CustomCgi, fun, true)(new FakeSocketForStdin());
}
/++
The [stop] function sets a flag that request handlers can (and should) check periodically. If a handler doesn't
respond to this flag, the library will force the issue. This determines when and how the issue will be forced.
+/
enum ForceStop {
/++
Stops accepting new requests, but lets ones already in the queue start and complete before exiting.
+/
afterQueuedRequestsComplete,
/++
Finishes requests already started their handlers, but drops any others in the queue. Streaming handlers
should cooperate and exit gracefully, but if they don't, it will continue waiting for them.
+/
afterCurrentRequestsComplete,
/++
Partial response writes will throw an exception, cancelling any streaming response, but complete
writes will continue to process. Request handlers that respect the stop token will also gracefully cancel.
+/
cancelStreamingRequestsEarly,
/++
All writes will throw.
+/
cancelAllRequestsEarly,
/++
Use OS facilities to forcibly kill running threads. The server process will be in an undefined state after this call (if this call ever returns).
+/
forciblyTerminate,
}
version(embedded_httpd_processes) {} else
/++
Stops serving after the current requests are completed.
Bugs:
Not implemented on version=embedded_httpd_processes, version=fastcgi on any system, or embedded_httpd on Windows (it does work on embedded_httpd_hybrid
on Windows however). Only partially implemented on non-Linux posix systems.
You might also try SIGINT perhaps.
The stopPriority is not yet fully implemented.
+/
static void stop(ForceStop stopPriority = ForceStop.afterCurrentRequestsComplete) {
globalStopFlag = true;
version(Posix) {
if(cancelfd > 0) {
ulong a = 1;
core.sys.posix.unistd.write(cancelfd, &a, a.sizeof);
}
}
version(Windows) {
if(iocp) {
foreach(i; 0 .. 16) // FIXME
PostQueuedCompletionStatus(iocp, 0, cast(ULONG_PTR) null, null);
}
}
}
}
private alias AliasSeq(T...) = T;
version(with_breaking_cgi_features)
mixin(q{
template ThisFor(alias t) {
static if(__traits(isStaticFunction, t)) {
alias ThisFor = AliasSeq!();
} else {
alias ThisFor = __traits(parent, t);
}
}
});
else
alias ThisFor(alias t) = AliasSeq!();
private __gshared bool globalStopFlag = false;
version(embedded_httpd_processes)
void serveEmbeddedHttpdProcesses(alias fun, CustomCgi = Cgi)(RequestServer params) {
import core.sys.posix.unistd;
import core.sys.posix.sys.socket;
import core.sys.posix.netinet.in_;
//import std.c.linux.socket;
int sock = socket(AF_INET, SOCK_STREAM, 0);
if(sock == -1)
throw new Exception("socket");
cloexec(sock);
{
sockaddr_in addr;
addr.sin_family = AF_INET;
addr.sin_port = htons(params.listeningPort);
auto lh = params.listeningHost;
if(lh.length) {
if(inet_pton(AF_INET, lh.toStringz(), &addr.sin_addr.s_addr) != 1)
throw new Exception("bad listening host given, please use an IP address.\nExample: --listening-host 127.0.0.1 means listen only on Localhost.\nExample: --listening-host 0.0.0.0 means listen on all interfaces.\nOr you can pass any other single numeric IPv4 address.");
} else
addr.sin_addr.s_addr = INADDR_ANY;
// HACKISH
int on = 1;
setsockopt(sock, SOL_SOCKET, SO_REUSEADDR, &on, on.sizeof);
// end hack
if(bind(sock, cast(sockaddr*) &addr, addr.sizeof) == -1) {
close(sock);
throw new Exception("bind");
}
// FIXME: if this queue is full, it will just ignore it
// and wait for the client to retransmit it. This is an
// obnoxious timeout condition there.
if(sock.listen(128) == -1) {
close(sock);
throw new Exception("listen");
}
params.dropPrivileges();
}
version(embedded_httpd_processes_accept_after_fork) {} else {
int pipeReadFd;
int pipeWriteFd;
{
int[2] pipeFd;
if(socketpair(AF_UNIX, SOCK_DGRAM, 0, pipeFd)) {
import core.stdc.errno;
throw new Exception("pipe failed " ~ to!string(errno));
}
pipeReadFd = pipeFd[0];
pipeWriteFd = pipeFd[1];
}
}
int processCount;
pid_t newPid;
reopen:
while(processCount < processPoolSize) {
newPid = fork();
if(newPid == 0) {
// start serving on the socket
//ubyte[4096] backingBuffer;
for(;;) {
bool closeConnection;
uint i;
sockaddr addr;
i = addr.sizeof;
version(embedded_httpd_processes_accept_after_fork) {
int s = accept(sock, &addr, &i);
int opt = 1;
import core.sys.posix.netinet.tcp;
// the Cgi class does internal buffering, so disabling this
// helps with latency in many cases...
setsockopt(s, IPPROTO_TCP, TCP_NODELAY, &opt, opt.sizeof);
cloexec(s);
} else {
int s;
auto readret = read_fd(pipeReadFd, &s, s.sizeof, &s);
if(readret != s.sizeof) {
import core.stdc.errno;
throw new Exception("pipe read failed " ~ to!string(errno));
}
//writeln("process ", getpid(), " got socket ", s);
}
try {
if(s == -1)
throw new Exception("accept");
scope(failure) close(s);
//ubyte[__traits(classInstanceSize, BufferedInputRange)] bufferedRangeContainer;
auto ir = new BufferedInputRange(s);
//auto ir = emplace!BufferedInputRange(bufferedRangeContainer, s, backingBuffer);
while(!ir.empty) {
//ubyte[__traits(classInstanceSize, CustomCgi)] cgiContainer;
Cgi cgi;
try {
cgi = new CustomCgi(ir, &closeConnection);
cgi._outputFileHandle = cast(CgiConnectionHandle) s;
// if we have a single process and the browser tries to leave the connection open while concurrently requesting another, it will block everything an deadlock since there's no other server to accept it. By closing after each request in this situation, it tells the browser to serialize for us.
if(processPoolSize <= 1)
closeConnection = true;
//cgi = emplace!CustomCgi(cgiContainer, ir, &closeConnection);
} catch(HttpVersionNotSupportedException he) {
sendAll(ir.source, plainHttpError(false, "505 HTTP Version Not Supported", he));
closeConnection = true;
break;
} catch(Throwable t) {
// a construction error is either bad code or bad request; bad request is what it should be since this is bug free :P
// anyway let's kill the connection
version(CRuntime_Musl) {
// LockingTextWriter fails here
// so working around it
auto estr = t.toString();
stderr.rawWrite(estr);
stderr.rawWrite("\n");
} else
stderr.writeln(t.toString());
sendAll(ir.source, plainHttpError(false, "400 Bad Request", t));
closeConnection = true;
break;
}
assert(cgi !is null);
scope(exit)
cgi.dispose();
try {
fun(cgi);
cgi.close();
if(cgi.websocketMode)
closeConnection = true;
} catch(ConnectionException ce) {
closeConnection = true;
} catch(Throwable t) {
// a processing error can be recovered from
version(CRuntime_Musl) {
// LockingTextWriter fails here
// so working around it
auto estr = t.toString();
stderr.rawWrite(estr);
} else {
stderr.writeln(t.toString);
}
if(!handleException(cgi, t))
closeConnection = true;
}
if(closeConnection) {
ir.source.close();
break;
} else {
if(!ir.empty)
ir.popFront(); // get the next
else if(ir.sourceClosed) {
ir.source.close();
}
}
}
ir.source.close();
} catch(Throwable t) {
version(CRuntime_Musl) {} else
debug writeln(t);
// most likely cause is a timeout
}
}
} else if(newPid < 0) {
throw new Exception("fork failed");
} else {
processCount++;
}
}
// the parent should wait for its children...
if(newPid) {
import core.sys.posix.sys.wait;
version(embedded_httpd_processes_accept_after_fork) {} else {
import core.sys.posix.sys.select;
int[] fdQueue;
while(true) {
// writeln("select call");
int nfds = pipeWriteFd;
if(sock > pipeWriteFd)
nfds = sock;
nfds += 1;
fd_set read_fds;
fd_set write_fds;
FD_ZERO(&read_fds);
FD_ZERO(&write_fds);
FD_SET(sock, &read_fds);
if(fdQueue.length)
FD_SET(pipeWriteFd, &write_fds);
auto ret = select(nfds, &read_fds, &write_fds, null, null);
if(ret == -1) {
import core.stdc.errno;
if(errno == EINTR)
goto try_wait;
else
throw new Exception("wtf select");
}
int s = -1;
if(FD_ISSET(sock, &read_fds)) {
uint i;
sockaddr addr;
i = addr.sizeof;
s = accept(sock, &addr, &i);
cloexec(s);
import core.sys.posix.netinet.tcp;
int opt = 1;
setsockopt(s, IPPROTO_TCP, TCP_NODELAY, &opt, opt.sizeof);
}
if(FD_ISSET(pipeWriteFd, &write_fds)) {
if(s == -1 && fdQueue.length) {
s = fdQueue[0];
fdQueue = fdQueue[1 .. $]; // FIXME reuse buffer
}
write_fd(pipeWriteFd, &s, s.sizeof, s);
close(s); // we are done with it, let the other process take ownership
} else
fdQueue ~= s;
}
}
try_wait:
int status;
while(-1 != wait(&status)) {
version(CRuntime_Musl) {} else {
import std.stdio; writeln("Process died ", status);
}
processCount--;
goto reopen;
}
close(sock);
}
}
version(fastcgi)
void serveFastCgi(alias fun, CustomCgi = Cgi, long maxContentLength = defaultMaxContentLength)(RequestServer params) {
// SetHandler fcgid-script
FCGX_Stream* input, output, error;
FCGX_ParamArray env;
const(ubyte)[] getFcgiChunk() {
const(ubyte)[] ret;
while(FCGX_HasSeenEOF(input) != -1)
ret ~= cast(ubyte) FCGX_GetChar(input);
return ret;
}
void writeFcgi(const(ubyte)[] data) {
FCGX_PutStr(data.ptr, data.length, output);
}
void doARequest() {
string[string] fcgienv;
for(auto e = env; e !is null && *e !is null; e++) {
string cur = to!string(*e);
auto idx = cur.indexOf("=");
string name, value;
if(idx == -1)
name = cur;
else {
name = cur[0 .. idx];
value = cur[idx + 1 .. $];
}
fcgienv[name] = value;
}
void flushFcgi() {
FCGX_FFlush(output);
}
Cgi cgi;
try {
cgi = new CustomCgi(maxContentLength, fcgienv, &getFcgiChunk, &writeFcgi, &flushFcgi);
} catch(Throwable t) {
FCGX_PutStr(cast(ubyte*) t.msg.ptr, t.msg.length, error);
writeFcgi(cast(const(ubyte)[]) plainHttpError(true, "400 Bad Request", t));
return; //continue;
}
assert(cgi !is null);
scope(exit) cgi.dispose();
try {
fun(cgi);
cgi.close();
} catch(Throwable t) {
// log it to the error stream
FCGX_PutStr(cast(ubyte*) t.msg.ptr, t.msg.length, error);
// handle it for the user, if we can
if(!handleException(cgi, t))
return; // continue;
}
}
auto lp = params.listeningPort;
auto host = params.listeningHost;
FCGX_Request request;
if(lp || !host.empty) {
// if a listening port was specified on the command line, we want to spawn ourself
// (needed for nginx without spawn-fcgi, e.g. on Windows)
FCGX_Init();
int sock;
if(host.startsWith("unix:")) {
sock = FCGX_OpenSocket(toStringz(params.listeningHost["unix:".length .. $]), 12);
} else if(host.startsWith("abstract:")) {
sock = FCGX_OpenSocket(toStringz("\0" ~ params.listeningHost["abstract:".length .. $]), 12);
} else {
sock = FCGX_OpenSocket(toStringz(params.listeningHost ~ ":" ~ to!string(lp)), 12);
}
if(sock < 0)
throw new Exception("Couldn't listen on the port");
FCGX_InitRequest(&request, sock, 0);
while(FCGX_Accept_r(&request) >= 0) {
input = request.inStream;
output = request.outStream;
error = request.errStream;
env = request.envp;
doARequest();
}
} else {
// otherwise, assume the httpd is doing it (the case for Apache, IIS, and Lighttpd)
// using the version with a global variable since we are separate processes anyway
while(FCGX_Accept(&input, &output, &error, &env) >= 0) {
doARequest();
}
}
}
/// Returns the default listening port for the current cgi configuration. 8085 for embedded httpd, 4000 for scgi, irrelevant for others.
ushort defaultListeningPort() {
version(netman_httpd)
return 8080;
else version(embedded_httpd_processes)
return 8085;
else version(embedded_httpd_threads)
return 8085;
else version(scgi)
return 4000;
else
return 0;
}
/// Default host for listening. 127.0.0.1 for scgi, null (aka all interfaces) for all others. If you want the server directly accessible from other computers on the network, normally use null. If not, 127.0.0.1 is a bit better. Settable with default handlers with --listening-host command line argument.
string defaultListeningHost() {
version(netman_httpd)
return null;
else version(embedded_httpd_processes)
return null;
else version(embedded_httpd_threads)
return null;
else version(scgi)
return "127.0.0.1";
else
return null;
}
/++
This is the function [GenericMain] calls. View its source for some simple boilerplate you can copy/paste and modify, or you can call it yourself from your `main`.
Please note that this may spawn other helper processes that will call `main` again. It does this currently for the timer server and event source server (and the quasi-deprecated web socket server).
Params:
fun = Your request handler
CustomCgi = a subclass of Cgi, if you wise to customize it further
maxContentLength = max POST size you want to allow
args = command-line arguments
History:
Documented Sept 26, 2020.
+/
void cgiMainImpl(alias fun, CustomCgi = Cgi, long maxContentLength = defaultMaxContentLength)(string[] args) if(is(CustomCgi : Cgi)) {
if(tryAddonServers(args))
return;
if(trySimulatedRequest!(fun, CustomCgi)(args))
return;
RequestServer server;
// you can change the port here if you like
// server.listeningPort = 9000;
// then call this to let the command line args override your default
server.configureFromCommandLine(args);
// and serve the request(s).
server.serve!(fun, CustomCgi, maxContentLength)();
}
//version(plain_cgi)
void handleCgiRequest(alias fun, CustomCgi = Cgi, long maxContentLength = defaultMaxContentLength)() {
// standard CGI is the default version
// Set stdin to binary mode if necessary to avoid mangled newlines
// the fact that stdin is global means this could be trouble but standard cgi request
// handling is one per process anyway so it shouldn't actually be threaded here or anything.
version(Windows) {
version(Win64)
_setmode(std.stdio.stdin.fileno(), 0x8000);
else
setmode(std.stdio.stdin.fileno(), 0x8000);
}
Cgi cgi;
try {
cgi = new CustomCgi(maxContentLength);
version(Posix)
cgi._outputFileHandle = cast(CgiConnectionHandle) 1; // stdout
else version(Windows)
cgi._outputFileHandle = cast(CgiConnectionHandle) GetStdHandle(STD_OUTPUT_HANDLE);
else static assert(0);
} catch(Throwable t) {
version(CRuntime_Musl) {
// LockingTextWriter fails here
// so working around it
auto s = t.toString();
stderr.rawWrite(s);
stdout.rawWrite(plainHttpError(true, "400 Bad Request", t));
} else {
stderr.writeln(t.msg);
// the real http server will probably handle this;
// most likely, this is a bug in Cgi. But, oh well.
stdout.write(plainHttpError(true, "400 Bad Request", t));
}
return;
}
assert(cgi !is null);
scope(exit) cgi.dispose();
try {
fun(cgi);
cgi.close();
} catch (Throwable t) {
version(CRuntime_Musl) {
// LockingTextWriter fails here
// so working around it
auto s = t.msg;
stderr.rawWrite(s);
} else {
stderr.writeln(t.msg);
}
if(!handleException(cgi, t))
return;
}
}
private __gshared int cancelfd = -1;
/+
The event loop for embedded_httpd_threads will prolly fiber dispatch
cgi constructors too, so slow posts will not monopolize a worker thread.
May want to provide the worker task system just need to ensure all the fibers
has a big enough stack for real work... would also ideally like to reuse them.
So prolly bir would switch it to nonblocking. If it would block, it epoll
registers one shot with this existing fiber to take it over.
new connection comes in. it picks a fiber off the free list,
or if there is none, it creates a new one. this fiber handles
this connection the whole time.
epoll triggers the fiber when something comes in. it is called by
a random worker thread, it might change at any time. at least during
the constructor. maybe into the main body it will stay tied to a thread
just so TLS stuff doesn't randomly change in the middle. but I could
specify if you yield all bets are off.
when the request is finished, if there's more data buffered, it just
keeps going. if there is no more data buffered, it epoll ctls to
get triggered when more data comes in. all one shot.
when a connection is closed, the fiber returns and is then reset
and added to the free list. if the free list is full, the fiber is
just freed, this means it will balloon to a certain size but not generally
grow beyond that unless the activity keeps going.
256 KB stack i thnk per fiber. 4,000 active fibers per gigabyte of memory.
So the fiber has its own magic methods to read and write. if they would block, it registers
for epoll and yields. when it returns, it read/writes and then returns back normal control.
basically you issue the command and it tells you when it is done
it needs to DEL the epoll thing when it is closed. add it when opened. mod it when anther thing issued
+/
/++
The stack size when a fiber is created. You can set this from your main or from a shared static constructor
to optimize your memory use if you know you don't need this much space. Be careful though, some functions use
more stack space than you realize and a recursive function (including ones like in dom.d) can easily grow fast!
History:
Added July 10, 2021. Previously, it used the druntime default of 16 KB.
+/
version(cgi_use_fiber)
__gshared size_t fiberStackSize = 4096 * 100;
version(cgi_use_fiber)
class CgiFiber : Fiber {
private void function(Socket) f_handler;
private void f_handler_dg(Socket s) { // to avoid extra allocation w/ function
f_handler(s);
}
this(void function(Socket) handler) {
this.f_handler = handler;
this(&f_handler_dg);
}
this(void delegate(Socket) handler) {
this.handler = handler;
super(&run, fiberStackSize);
}
Socket connection;
void delegate(Socket) handler;
void run() {
handler(connection);
}
void delegate() postYield;
private void setPostYield(scope void delegate() py) @nogc {
postYield = cast(void delegate()) py;
}
void proceed() {
try {
call();
auto py = postYield;
postYield = null;
if(py !is null)
py();
} catch(Exception e) {
if(connection)
connection.close();
goto terminate;
}
if(state == State.TERM) {
terminate:
import core.memory;
GC.removeRoot(cast(void*) this);
}
}
}
version(cgi_use_fiber)
version(Windows) {
extern(Windows) private {
import core.sys.windows.mswsock;
alias GROUP=uint;
alias LPWSAPROTOCOL_INFOW = void*;
SOCKET WSASocketW(int af, int type, int protocol, LPWSAPROTOCOL_INFOW lpProtocolInfo, GROUP g, DWORD dwFlags);
int WSASend(SOCKET s, LPWSABUF lpBuffers, DWORD dwBufferCount, LPDWORD lpNumberOfBytesSent, DWORD dwFlags, LPWSAOVERLAPPED lpOverlapped, LPWSAOVERLAPPED_COMPLETION_ROUTINE lpCompletionRoutine);
int WSARecv(SOCKET s, LPWSABUF lpBuffers, DWORD dwBufferCount, LPDWORD lpNumberOfBytesRecvd, LPDWORD lpFlags, LPWSAOVERLAPPED lpOverlapped, LPWSAOVERLAPPED_COMPLETION_ROUTINE lpCompletionRoutine);
struct WSABUF {
ULONG len;
CHAR *buf;
}
alias LPWSABUF = WSABUF*;
alias WSAOVERLAPPED = OVERLAPPED;
alias LPWSAOVERLAPPED = LPOVERLAPPED;
/+
alias LPFN_ACCEPTEX =
BOOL
function(
SOCKET sListenSocket,
SOCKET sAcceptSocket,
//_Out_writes_bytes_(dwReceiveDataLength+dwLocalAddressLength+dwRemoteAddressLength) PVOID lpOutputBuffer,
void* lpOutputBuffer,
WORD dwReceiveDataLength,
WORD dwLocalAddressLength,
WORD dwRemoteAddressLength,
LPDWORD lpdwBytesReceived,
LPOVERLAPPED lpOverlapped
);
enum WSAID_ACCEPTEX = GUID([0xb5367df1,0xcbac,0x11cf,[0x95,0xca,0x00,0x80,0x5f,0x48,0xa1,0x92]]);
+/
enum WSAID_GETACCEPTEXSOCKADDRS = GUID(0xb5367df2,0xcbac,0x11cf,[0x95,0xca,0x00,0x80,0x5f,0x48,0xa1,0x92]);
}
private class PseudoblockingOverlappedSocket : Socket {
SOCKET handle;
CgiFiber fiber;
this(AddressFamily af, SocketType st) {
auto handle = WSASocketW(af, st, 0, null, 0, 1 /*WSA_FLAG_OVERLAPPED*/);
if(!handle)
throw new Exception("WSASocketW");
this.handle = handle;
iocp = CreateIoCompletionPort(cast(HANDLE) handle, iocp, cast(ULONG_PTR) cast(void*) this, 0);
if(iocp is null) {
writeln(GetLastError());
throw new Exception("CreateIoCompletionPort");
}
super(cast(socket_t) handle, af);
}
this() pure nothrow @trusted { assert(0); }
override void blocking(bool) {} // meaningless to us, just ignore it.
protected override Socket accepting() pure nothrow {
assert(0);
}
bool addressesParsed;
Address la;
Address ra;
private void populateAddresses() {
if(addressesParsed)
return;
addressesParsed = true;
int lalen, ralen;
sockaddr_in* la;
sockaddr_in* ra;
lpfnGetAcceptExSockaddrs(
scratchBuffer.ptr,
0, // same as in the AcceptEx call!
sockaddr_in.sizeof + 16,
sockaddr_in.sizeof + 16,
cast(sockaddr**) &la,
&lalen,
cast(sockaddr**) &ra,
&ralen
);
if(la)
this.la = new InternetAddress(*la);
if(ra)
this.ra = new InternetAddress(*ra);
}
override @property @trusted Address localAddress() {
populateAddresses();
return la;
}
override @property @trusted Address remoteAddress() {
populateAddresses();
return ra;
}
PseudoblockingOverlappedSocket accepted;
__gshared static LPFN_ACCEPTEX lpfnAcceptEx;
__gshared static typeof(&GetAcceptExSockaddrs) lpfnGetAcceptExSockaddrs;
override Socket accept() @trusted {
__gshared static LPFN_ACCEPTEX lpfnAcceptEx;
if(lpfnAcceptEx is null) {
DWORD dwBytes;
GUID GuidAcceptEx = WSAID_ACCEPTEX;
auto iResult = WSAIoctl(handle, 0xc8000006 /*SIO_GET_EXTENSION_FUNCTION_POINTER*/,
&GuidAcceptEx, GuidAcceptEx.sizeof,
&lpfnAcceptEx, lpfnAcceptEx.sizeof,
&dwBytes, null, null);
GuidAcceptEx = WSAID_GETACCEPTEXSOCKADDRS;
iResult = WSAIoctl(handle, 0xc8000006 /*SIO_GET_EXTENSION_FUNCTION_POINTER*/,
&GuidAcceptEx, GuidAcceptEx.sizeof,
&lpfnGetAcceptExSockaddrs, lpfnGetAcceptExSockaddrs.sizeof,
&dwBytes, null, null);
}
auto pfa = new PseudoblockingOverlappedSocket(AddressFamily.INET, SocketType.STREAM);
accepted = pfa;
SOCKET pendingForAccept = pfa.handle;
DWORD ignored;
auto ret = lpfnAcceptEx(handle,
pendingForAccept,
// buffer to receive up front
pfa.scratchBuffer.ptr,
0,
// size of local and remote addresses. normally + 16.
sockaddr_in.sizeof + 16,
sockaddr_in.sizeof + 16,
&ignored, // bytes would be given through the iocp instead but im not even requesting the thing
&overlapped
);
return pfa;
}
override void connect(Address to) { assert(0); }
DWORD lastAnswer;
ubyte[1024] scratchBuffer;
static assert(scratchBuffer.length > sockaddr_in.sizeof * 2 + 32);
WSABUF[1] buffer;
OVERLAPPED overlapped;
override ptrdiff_t send(scope const(void)[] buf, SocketFlags flags) @trusted {
overlapped = overlapped.init;
buffer[0].len = cast(DWORD) buf.length;
buffer[0].buf = cast(CHAR*) buf.ptr;
fiber.setPostYield( () {
if(!WSASend(handle, buffer.ptr, cast(DWORD) buffer.length, null, 0, &overlapped, null)) {
if(GetLastError() != 997) {
//throw new Exception("WSASend fail");
}
}
});
Fiber.yield();
return lastAnswer;
}
override ptrdiff_t receive(scope void[] buf, SocketFlags flags) @trusted {
overlapped = overlapped.init;
buffer[0].len = cast(DWORD) buf.length;
buffer[0].buf = cast(CHAR*) buf.ptr;
DWORD flags2 = 0;
fiber.setPostYield(() {
if(!WSARecv(handle, buffer.ptr, cast(DWORD) buffer.length, null, &flags2 /* flags */, &overlapped, null)) {
if(GetLastError() != 997) {
//writeln("WSARecv ", WSAGetLastError());
//throw new Exception("WSARecv fail");
}
}
});
Fiber.yield();
return lastAnswer;
}
// I might go back and implement these for udp things.
override ptrdiff_t receiveFrom(scope void[] buf, SocketFlags flags, ref Address from) @trusted {
assert(0);
}
override ptrdiff_t receiveFrom(scope void[] buf, SocketFlags flags) @trusted {
assert(0);
}
override ptrdiff_t sendTo(scope const(void)[] buf, SocketFlags flags, Address to) @trusted {
assert(0);
}
override ptrdiff_t sendTo(scope const(void)[] buf, SocketFlags flags) @trusted {
assert(0);
}
// lol overload sets
alias send = typeof(super).send;
alias receive = typeof(super).receive;
alias sendTo = typeof(super).sendTo;
alias receiveFrom = typeof(super).receiveFrom;
}
}
void doThreadHttpConnection(CustomCgi, alias fun)(Socket connection) {
assert(connection !is null);
version(cgi_use_fiber) {
auto fiber = new CgiFiber(&doThreadHttpConnectionGuts!(CustomCgi, fun));
version(Windows) {
(cast(PseudoblockingOverlappedSocket) connection).fiber = fiber;
}
import core.memory;
GC.addRoot(cast(void*) fiber);
fiber.connection = connection;
fiber.proceed();
} else {
doThreadHttpConnectionGuts!(CustomCgi, fun)(connection);
}
}
void doThreadHttpConnectionGuts(CustomCgi, alias fun, bool alwaysCloseConnection = false)(Socket connection) {
scope(failure) {
// catch all for other errors
try {
sendAll(connection, plainHttpError(false, "500 Internal Server Error", null));
connection.close();
} catch(Exception e) {} // swallow it, we're aborting anyway.
}
bool closeConnection = alwaysCloseConnection;
/+
ubyte[4096] inputBuffer = void;
ubyte[__traits(classInstanceSize, BufferedInputRange)] birBuffer = void;
ubyte[__traits(classInstanceSize, CustomCgi)] cgiBuffer = void;
birBuffer[] = cast(ubyte[]) typeid(BufferedInputRange).initializer()[];
BufferedInputRange ir = cast(BufferedInputRange) cast(void*) birBuffer.ptr;
ir.__ctor(connection, inputBuffer[], true);
+/
auto ir = new BufferedInputRange(connection);
while(!ir.empty) {
if(ir.view.length == 0) {
ir.popFront();
if(ir.sourceClosed) {
connection.close();
closeConnection = true;
break;
}
}
Cgi cgi;
try {
cgi = new CustomCgi(ir, &closeConnection);
// There's a bunch of these casts around because the type matches up with
// the -version=.... specifiers, just you can also create a RequestServer
// and instantiate the things where the types don't match up. It isn't exactly
// correct but I also don't care rn. Might FIXME and either remove it later or something.
cgi._outputFileHandle = cast(CgiConnectionHandle) connection.handle;
} catch(ConnectionClosedException ce) {
closeConnection = true;
break;
} catch(ConnectionException ce) {
// broken pipe or something, just abort the connection
closeConnection = true;
break;
} catch(HttpVersionNotSupportedException ve) {
sendAll(connection, plainHttpError(false, "505 HTTP Version Not Supported", ve));
closeConnection = true;
break;
} catch(Throwable t) {
// a construction error is either bad code or bad request; bad request is what it should be since this is bug free :P
// anyway let's kill the connection
version(CRuntime_Musl) {
stderr.rawWrite(t.toString());
stderr.rawWrite("\n");
} else {
stderr.writeln(t.toString());
}
sendAll(connection, plainHttpError(false, "400 Bad Request", t));
closeConnection = true;
break;
}
assert(cgi !is null);
scope(exit)
cgi.dispose();
try {
fun(cgi);
cgi.close();
if(cgi.websocketMode)
closeConnection = true;
} catch(ConnectionException ce) {
// broken pipe or something, just abort the connection
closeConnection = true;
} catch(ConnectionClosedException ce) {
// broken pipe or something, just abort the connection
closeConnection = true;
} catch(Throwable t) {
// a processing error can be recovered from
version(CRuntime_Musl) {} else
stderr.writeln(t.toString);
if(!handleException(cgi, t))
closeConnection = true;
}
if(globalStopFlag)
closeConnection = true;
if(closeConnection || alwaysCloseConnection) {
connection.shutdown(SocketShutdown.BOTH);
connection.close();
ir.dispose();
closeConnection = false; // don't reclose after loop
break;
} else {
if(ir.front.length) {
ir.popFront(); // we can't just discard the buffer, so get the next bit and keep chugging along
} else if(ir.sourceClosed) {
ir.source.shutdown(SocketShutdown.BOTH);
ir.source.close();
ir.dispose();
closeConnection = false;
} else {
continue;
// break; // this was for a keepalive experiment
}
}
}
if(closeConnection) {
connection.shutdown(SocketShutdown.BOTH);
connection.close();
ir.dispose();
}
// I am otherwise NOT closing it here because the parent thread might still be able to make use of the keep-alive connection!
}
void doThreadScgiConnection(CustomCgi, alias fun, long maxContentLength)(Socket connection) {
// and now we can buffer
scope(failure)
connection.close();
import al = std.algorithm;
size_t size;
string[string] headers;
auto range = new BufferedInputRange(connection);
more_data:
auto chunk = range.front();
// waiting for colon for header length
auto idx = indexOf(cast(string) chunk, ':');
if(idx == -1) {
try {
range.popFront();
} catch(Exception e) {
// it is just closed, no big deal
connection.close();
return;
}
goto more_data;
}
size = to!size_t(cast(string) chunk[0 .. idx]);
chunk = range.consume(idx + 1);
// reading headers
if(chunk.length < size)
range.popFront(0, size + 1);
// we are now guaranteed to have enough
chunk = range.front();
assert(chunk.length > size);
idx = 0;
string key;
string value;
foreach(part; al.splitter(chunk, '\0')) {
if(idx & 1) { // odd is value
value = cast(string)(part.idup);
headers[key] = value; // commit
} else
key = cast(string)(part.idup);
idx++;
}
enforce(chunk[size] == ','); // the terminator
range.consume(size + 1);
// reading data
// this will be done by Cgi
const(ubyte)[] getScgiChunk() {
// we are already primed
auto data = range.front();
if(data.length == 0 && !range.sourceClosed) {
range.popFront(0);
data = range.front();
} else if (range.sourceClosed)
range.source.close();
return data;
}
void writeScgi(const(ubyte)[] data) {
sendAll(connection, data);
}
void flushScgi() {
// I don't *think* I have to do anything....
}
Cgi cgi;
try {
cgi = new CustomCgi(maxContentLength, headers, &getScgiChunk, &writeScgi, &flushScgi);
cgi._outputFileHandle = cast(CgiConnectionHandle) connection.handle;
} catch(Throwable t) {
sendAll(connection, plainHttpError(true, "400 Bad Request", t));
connection.close();
return; // this connection is dead
}
assert(cgi !is null);
scope(exit) cgi.dispose();
try {
fun(cgi);
cgi.close();
connection.close();
} catch(Throwable t) {
// no std err
if(!handleException(cgi, t)) {
connection.close();
return;
} else {
connection.close();
return;
}
}
}
string printDate(DateTime date) {
char[29] buffer = void;
printDateToBuffer(date, buffer[]);
return buffer.idup;
}
int printDateToBuffer(DateTime date, char[] buffer) @nogc {
assert(buffer.length >= 29);
// 29 static length ?
static immutable daysOfWeek = [
"Sun", "Mon", "Tue", "Wed", "Thu", "Fri", "Sat"
];
static immutable months = [
null, "Jan", "Feb", "Mar", "Apr", "May", "Jun", "Jul", "Aug", "Sep", "Oct", "Nov", "Dec"
];
buffer[0 .. 3] = daysOfWeek[date.dayOfWeek];
buffer[3 .. 5] = ", ";
buffer[5] = date.day / 10 + '0';
buffer[6] = date.day % 10 + '0';
buffer[7] = ' ';
buffer[8 .. 11] = months[date.month];
buffer[11] = ' ';
auto y = date.year;
buffer[12] = cast(char) (y / 1000 + '0'); y %= 1000;
buffer[13] = cast(char) (y / 100 + '0'); y %= 100;
buffer[14] = cast(char) (y / 10 + '0'); y %= 10;
buffer[15] = cast(char) (y + '0');
buffer[16] = ' ';
buffer[17] = date.hour / 10 + '0';
buffer[18] = date.hour % 10 + '0';
buffer[19] = ':';
buffer[20] = date.minute / 10 + '0';
buffer[21] = date.minute % 10 + '0';
buffer[22] = ':';
buffer[23] = date.second / 10 + '0';
buffer[24] = date.second % 10 + '0';
buffer[25 .. $] = " GMT";
return 29;
}
// Referencing this gigantic typeid seems to remind the compiler
// to actually put the symbol in the object file. I guess the immutable
// assoc array array isn't actually included in druntime
void hackAroundLinkerError() {
stdout.rawWrite(typeid(const(immutable(char)[][])[immutable(char)[]]).toString());
stdout.rawWrite(typeid(immutable(char)[][][immutable(char)[]]).toString());
stdout.rawWrite(typeid(Cgi.UploadedFile[immutable(char)[]]).toString());
stdout.rawWrite(typeid(Cgi.UploadedFile[][immutable(char)[]]).toString());
stdout.rawWrite(typeid(immutable(Cgi.UploadedFile)[immutable(char)[]]).toString());
stdout.rawWrite(typeid(immutable(Cgi.UploadedFile[])[immutable(char)[]]).toString());
stdout.rawWrite(typeid(immutable(char[])[immutable(char)[]]).toString());
// this is getting kinda ridiculous btw. Moving assoc arrays
// to the library is the pain that keeps on coming.
// eh this broke the build on the work server
// stdout.rawWrite(typeid(immutable(char)[][immutable(string[])]));
stdout.rawWrite(typeid(immutable(string[])[immutable(char)[]]).toString());
}
version(fastcgi) {
pragma(lib, "fcgi");
static if(size_t.sizeof == 8) // 64 bit
alias long c_int;
else
alias int c_int;
extern(C) {
struct FCGX_Stream {
ubyte* rdNext;
ubyte* wrNext;
ubyte* stop;
ubyte* stopUnget;
c_int isReader;
c_int isClosed;
c_int wasFCloseCalled;
c_int FCGI_errno;
void* function(FCGX_Stream* stream) fillBuffProc;
void* function(FCGX_Stream* stream, c_int doClose) emptyBuffProc;
void* data;
}
// note: this is meant to be opaque, so don't access it directly
struct FCGX_Request {
int requestId;
int role;
FCGX_Stream* inStream;
FCGX_Stream* outStream;
FCGX_Stream* errStream;
char** envp;
void* paramsPtr;
int ipcFd;
int isBeginProcessed;
int keepConnection;
int appStatus;
int nWriters;
int flags;
int listen_sock;
}
int FCGX_InitRequest(FCGX_Request *request, int sock, int flags);
void FCGX_Init();
int FCGX_Accept_r(FCGX_Request *request);
alias char** FCGX_ParamArray;
c_int FCGX_Accept(FCGX_Stream** stdin, FCGX_Stream** stdout, FCGX_Stream** stderr, FCGX_ParamArray* envp);
c_int FCGX_GetChar(FCGX_Stream* stream);
c_int FCGX_PutStr(const ubyte* str, c_int n, FCGX_Stream* stream);
int FCGX_HasSeenEOF(FCGX_Stream* stream);
c_int FCGX_FFlush(FCGX_Stream *stream);
int FCGX_OpenSocket(in char*, int);
}
}
/* This might go int a separate module eventually. It is a network input helper class. */
import std.socket;
version(cgi_use_fiber) {
import core.thread;
version(linux) {
import core.sys.linux.epoll;
int epfd = -1; // thread local because EPOLLEXCLUSIVE works much better this way... weirdly.
} else version(Windows) {
// declaring the iocp thing below...
} else static assert(0, "The hybrid fiber server is not implemented on your OS.");
}
version(Windows)
__gshared HANDLE iocp;
version(cgi_use_fiber) {
version(linux)
private enum WakeupEvent {
Read = EPOLLIN,
Write = EPOLLOUT
}
else version(Windows)
private enum WakeupEvent {
Read, Write
}
else static assert(0);
}
version(cgi_use_fiber)
private void registerEventWakeup(bool* registered, Socket source, WakeupEvent e) @nogc {
// static cast since I know what i have in here and don't want to pay for dynamic cast
auto f = cast(CgiFiber) cast(void*) Fiber.getThis();
version(linux) {
f.setPostYield = () {
if(*registered) {
// rearm
epoll_event evt;
evt.events = e | EPOLLONESHOT;
evt.data.ptr = cast(void*) f;
if(epoll_ctl(epfd, EPOLL_CTL_MOD, source.handle, &evt) == -1)
throw new Exception("epoll_ctl");
} else {
// initial registration
*registered = true ;
int fd = source.handle;
epoll_event evt;
evt.events = e | EPOLLONESHOT;
evt.data.ptr = cast(void*) f;
if(epoll_ctl(epfd, EPOLL_CTL_ADD, fd, &evt) == -1)
throw new Exception("epoll_ctl");
}
};
Fiber.yield();
f.setPostYield(null);
} else version(Windows) {
Fiber.yield();
}
else static assert(0);
}
version(cgi_use_fiber)
void unregisterSource(Socket s) {
version(linux) {
epoll_event evt;
epoll_ctl(epfd, EPOLL_CTL_DEL, s.handle(), &evt);
} else version(Windows) {
// intentionally blank
}
else static assert(0);
}
// it is a class primarily for reference semantics
// I might change this interface
/// This is NOT ACTUALLY an input range! It is too different. Historical mistake kinda.
class BufferedInputRange {
version(Posix)
this(int source, ubyte[] buffer = null) {
this(new Socket(cast(socket_t) source, AddressFamily.INET), buffer);
}
this(Socket source, ubyte[] buffer = null, bool allowGrowth = true) {
// if they connect but never send stuff to us, we don't want it wasting the process
// so setting a time out
version(cgi_use_fiber)
source.blocking = false;
else
source.setOption(SocketOptionLevel.SOCKET, SocketOption.RCVTIMEO, dur!"seconds"(3));
this.source = source;
if(buffer is null) {
underlyingBuffer = new ubyte[4096];
this.allowGrowth = true;
} else {
underlyingBuffer = buffer;
this.allowGrowth = allowGrowth;
}
assert(underlyingBuffer.length);
// we assume view.ptr is always inside underlyingBuffer
view = underlyingBuffer[0 .. 0];
popFront(); // prime
}
version(cgi_use_fiber) {
bool registered;
}
void dispose() {
version(cgi_use_fiber) {
if(registered)
unregisterSource(source);
}
}
/**
A slight difference from regular ranges is you can give it the maximum
number of bytes to consume.
IMPORTANT NOTE: the default is to consume nothing, so if you don't call
consume() yourself and use a regular foreach, it will infinitely loop!
The default is to do what a normal range does, and consume the whole buffer
and wait for additional input.
You can also specify 0, to append to the buffer, or any other number
to remove the front n bytes and wait for more.
*/
void popFront(size_t maxBytesToConsume = 0 /*size_t.max*/, size_t minBytesToSettleFor = 0, bool skipConsume = false) {
if(sourceClosed)
throw new ConnectionClosedException("can't get any more data from a closed source");
if(!skipConsume)
consume(maxBytesToConsume);
// we might have to grow the buffer
if(minBytesToSettleFor > underlyingBuffer.length || view.length == underlyingBuffer.length) {
if(allowGrowth) {
//import std.stdio; writeln("growth");
auto viewStart = view.ptr - underlyingBuffer.ptr;
size_t growth = 4096;
// make sure we have enough for what we're being asked for
if(minBytesToSettleFor > 0 && minBytesToSettleFor - underlyingBuffer.length > growth)
growth = minBytesToSettleFor - underlyingBuffer.length;
//import std.stdio; writeln(underlyingBuffer.length, " ", viewStart, " ", view.length, " ", growth, " ", minBytesToSettleFor, " ", minBytesToSettleFor - underlyingBuffer.length);
underlyingBuffer.length += growth;
view = underlyingBuffer[viewStart .. view.length];
} else
throw new Exception("No room left in the buffer");
}
do {
auto freeSpace = underlyingBuffer[view.ptr - underlyingBuffer.ptr + view.length .. $];
try_again:
auto ret = source.receive(freeSpace);
if(ret == Socket.ERROR) {
if(wouldHaveBlocked()) {
version(cgi_use_fiber) {
registerEventWakeup(®istered, source, WakeupEvent.Read);
goto try_again;
} else {
// gonna treat a timeout here as a close
sourceClosed = true;
return;
}
}
version(Posix) {
import core.stdc.errno;
if(errno == EINTR || errno == EAGAIN) {
goto try_again;
}
if(errno == ECONNRESET) {
sourceClosed = true;
return;
}
}
throw new Exception(lastSocketError); // FIXME
}
if(ret == 0) {
sourceClosed = true;
return;
}
//import std.stdio; writeln(view.ptr); writeln(underlyingBuffer.ptr); writeln(view.length, " ", ret, " = ", view.length + ret);
view = underlyingBuffer[view.ptr - underlyingBuffer.ptr .. view.length + ret];
//import std.stdio; writeln(cast(string) view);
} while(view.length < minBytesToSettleFor);
}
/// Removes n bytes from the front of the buffer, and returns the new buffer slice.
/// You might want to idup the data you are consuming if you store it, since it may
/// be overwritten on the new popFront.
///
/// You do not need to call this if you always want to wait for more data when you
/// consume some.
ubyte[] consume(size_t bytes) {
//import std.stdio; writeln("consuime ", bytes, "/", view.length);
view = view[bytes > $ ? $ : bytes .. $];
if(view.length == 0) {
view = underlyingBuffer[0 .. 0]; // go ahead and reuse the beginning
/*
writeln("HERE");
popFront(0, 0, true); // try to load more if we can, checks if the source is closed
writeln(cast(string)front);
writeln("DONE");
*/
}
return front;
}
bool empty() {
return sourceClosed && view.length == 0;
}
ubyte[] front() {
return view;
}
invariant() {
assert(view.ptr >= underlyingBuffer.ptr);
// it should never be equal, since if that happens view ought to be empty, and thus reusing the buffer
assert(view.ptr < underlyingBuffer.ptr + underlyingBuffer.length);
}
ubyte[] underlyingBuffer;
bool allowGrowth;
ubyte[] view;
Socket source;
bool sourceClosed;
}
private class FakeSocketForStdin : Socket {
import std.stdio;
this() {
}
private bool closed;
override ptrdiff_t receive(scope void[] buffer, std.socket.SocketFlags) @trusted {
if(closed)
throw new Exception("Closed");
return stdin.rawRead(buffer).length;
}
override ptrdiff_t send(const scope void[] buffer, std.socket.SocketFlags) @trusted {
if(closed)
throw new Exception("Closed");
stdout.rawWrite(buffer);
return buffer.length;
}
override void close() @trusted scope {
(cast(void delegate() @nogc nothrow) &realClose)();
}
override void shutdown(SocketShutdown s) {
// FIXME
}
override void setOption(SocketOptionLevel, SocketOption, scope void[]) {}
override void setOption(SocketOptionLevel, SocketOption, Duration) {}
override @property @trusted Address remoteAddress() { return null; }
override @property @trusted Address localAddress() { return null; }
void realClose() {
closed = true;
try {
stdin.close();
stdout.close();
} catch(Exception e) {
}
}
}
import core.sync.semaphore;
import core.atomic;
/**
To use this thing:
---
void handler(Socket s) { do something... }
auto manager = new ListeningConnectionManager("127.0.0.1", 80, &handler, &delegateThatDropsPrivileges);
manager.listen();
---
The 4th parameter is optional.
I suggest you use BufferedInputRange(connection) to handle the input. As a packet
comes in, you will get control. You can just continue; though to fetch more.
FIXME: should I offer an event based async thing like netman did too? Yeah, probably.
*/
class ListeningConnectionManager {
Semaphore semaphore;
Socket[256] queue;
shared(ubyte) nextIndexFront;
ubyte nextIndexBack;
shared(int) queueLength;
Socket acceptCancelable() {
version(Posix) {
import core.sys.posix.sys.select;
fd_set read_fds;
FD_ZERO(&read_fds);
int max = 0;
foreach(listener; listeners) {
FD_SET(listener.handle, &read_fds);
if(listener.handle > max)
max = listener.handle;
}
if(cancelfd != -1) {
FD_SET(cancelfd, &read_fds);
if(cancelfd > max)
max = cancelfd;
}
auto ret = select(max + 1, &read_fds, null, null, null);
if(ret == -1) {
import core.stdc.errno;
if(errno == EINTR)
return null;
else
throw new Exception("wtf select");
}
if(cancelfd != -1 && FD_ISSET(cancelfd, &read_fds)) {
return null;
}
foreach(listener; listeners) {
if(FD_ISSET(listener.handle, &read_fds))
return listener.accept();
}
return null;
} else {
auto check = new SocketSet();
keep_looping:
check.reset();
foreach(listener; listeners)
check.add(listener);
// just to check the stop flag on a kinda busy loop. i hate this FIXME
auto got = Socket.select(check, null, null, 3.seconds);
if(got > 0)
foreach(listener; listeners)
if(check.isSet(listener))
return listener.accept();
if(globalStopFlag)
return null;
else
goto keep_looping;
}
}
int defaultNumberOfThreads() {
import std.parallelism;
version(cgi_use_fiber) {
return totalCPUs * 2 + 1; // still chance some will be pointlessly blocked anyway
} else {
// I times 4 here because there's a good chance some will be blocked on i/o.
return totalCPUs * 4;
}
}
void listen() {
shared(int) loopBroken;
version(Posix) {
import core.sys.posix.signal;
signal(SIGPIPE, SIG_IGN);
}
version(linux) {
if(cancelfd == -1)
cancelfd = eventfd(0, 0);
}
version(cgi_no_threads) {
// NEVER USE THIS
// it exists only for debugging and other special occasions
// the thread mode is faster and less likely to stall the whole
// thing when a request is slow
while(!loopBroken && !globalStopFlag) {
auto sn = acceptCancelable();
if(sn is null) continue;
cloexec(sn);
try {
handler(sn);
} catch(Exception e) {
// if a connection goes wrong, we want to just say no, but try to carry on unless it is an Error of some sort (in which case, we'll die. You might want an external helper program to revive the server when it dies)
sn.close();
}
}
} else {
if(useFork) {
version(linux) {
//asm { int 3; }
fork();
}
}
version(cgi_use_fiber) {
version(Windows) {
// please note these are overlapped sockets! so the accept just kicks things off
foreach(listener; listeners)
listener.accept();
}
WorkerThread[] threads = new WorkerThread[](numberOfThreads);
foreach(i, ref thread; threads) {
thread = new WorkerThread(this, handler, cast(int) i);
thread.start();
}
bool fiber_crash_check() {
bool hasAnyRunning;
foreach(thread; threads) {
if(!thread.isRunning) {
thread.join();
} else hasAnyRunning = true;
}
return (!hasAnyRunning);
}
while(!globalStopFlag) {
Thread.sleep(1.seconds);
if(fiber_crash_check())
break;
}
} else {
semaphore = new Semaphore();
ConnectionThread[] threads = new ConnectionThread[](numberOfThreads);
foreach(i, ref thread; threads) {
thread = new ConnectionThread(this, handler, cast(int) i);
thread.start();
}
while(!loopBroken && !globalStopFlag) {
Socket sn;
bool crash_check() {
bool hasAnyRunning;
foreach(thread; threads) {
if(!thread.isRunning) {
thread.join();
} else hasAnyRunning = true;
}
return (!hasAnyRunning);
}
void accept_new_connection() {
sn = acceptCancelable();
if(sn is null) return;
cloexec(sn);
if(tcp) {
// disable Nagle's algorithm to avoid a 40ms delay when we send/recv
// on the socket because we do some buffering internally. I think this helps,
// certainly does for small requests, and I think it does for larger ones too
sn.setOption(SocketOptionLevel.TCP, SocketOption.TCP_NODELAY, 1);
sn.setOption(SocketOptionLevel.SOCKET, SocketOption.RCVTIMEO, dur!"seconds"(10));
}
}
void existing_connection_new_data() {
// wait until a slot opens up
// int waited = 0;
while(queueLength >= queue.length) {
Thread.sleep(1.msecs);
// waited ++;
}
// if(waited) {import std.stdio; writeln(waited);}
synchronized(this) {
queue[nextIndexBack] = sn;
nextIndexBack++;
atomicOp!"+="(queueLength, 1);
}
semaphore.notify();
}
accept_new_connection();
if(sn !is null)
existing_connection_new_data();
else if(sn is null && globalStopFlag) {
foreach(thread; threads) {
semaphore.notify();
}
Thread.sleep(50.msecs);
}
if(crash_check())
break;
}
}
// FIXME: i typically stop this with ctrl+c which never
// actually gets here. i need to do a sigint handler.
if(cleanup)
cleanup();
}
}
//version(linux)
//int epoll_fd;
bool tcp;
void delegate() cleanup;
private void function(Socket) fhandler;
private void dg_handler(Socket s) {
fhandler(s);
}
this(string[] listenSpec, void function(Socket) handler, void delegate() dropPrivs = null, bool useFork = cgi_use_fork_default, int numberOfThreads = 0) {
fhandler = handler;
this(listenSpec, &dg_handler, dropPrivs, useFork, numberOfThreads);
}
this(string[] listenSpec, void delegate(Socket) handler, void delegate() dropPrivs = null, bool useFork = cgi_use_fork_default, int numberOfThreads = 0) {
string[] host;
ushort[] port;
foreach(spec; listenSpec) {
/+
The format:
protocol://
address_spec
Protocol is optional. Must be http, https, scgi, or fastcgi.
address_spec is either:
ipv4 address : port
[ipv6 address] : port
unix:filename
abstract:name
port <which is tcp but on any interface>
+/
string protocol;
string address_spec;
auto protocolIdx = spec.indexOf("://");
if(protocolIdx != -1) {
protocol = spec[0 .. protocolIdx];
address_spec = spec[protocolIdx + "://".length .. $];
} else {
address_spec = spec;
}
if(address_spec.startsWith("unix:") || address_spec.startsWith("abstract:")) {
host ~= address_spec;
port ~= 0;
} else {
auto idx = address_spec.lastIndexOf(":");
if(idx == -1) {
host ~= null;
} else {
auto as = address_spec[0 .. idx];
if(as.length >= 3 && as[0] == '[' && as[$-1] == ']')
as = as[1 .. $-1];
host ~= as;
}
port ~= address_spec[idx + 1 .. $].to!ushort;
}
}
this(host, port, handler, dropPrivs, useFork, numberOfThreads);
}
this(string host, ushort port, void function(Socket) handler, void delegate() dropPrivs = null, bool useFork = cgi_use_fork_default, int numberOfThreads = 0) {
this([host], [port], handler, dropPrivs, useFork, numberOfThreads);
}
this(string host, ushort port, void delegate(Socket) handler, void delegate() dropPrivs = null, bool useFork = cgi_use_fork_default, int numberOfThreads = 0) {
this([host], [port], handler, dropPrivs, useFork, numberOfThreads);
}
this(string[] host, ushort[] port, void function(Socket) handler, void delegate() dropPrivs = null, bool useFork = cgi_use_fork_default, int numberOfThreads = 0) {
fhandler = handler;
this(host, port, &dg_handler, dropPrivs, useFork, numberOfThreads);
}
this(string[] host, ushort[] port, void delegate(Socket) handler, void delegate() dropPrivs = null, bool useFork = cgi_use_fork_default, int numberOfThreads = 0) {
assert(host.length == port.length);
this.handler = handler;
this.useFork = useFork;
this.numberOfThreads = numberOfThreads ? numberOfThreads : defaultNumberOfThreads();
listeners.reserve(host.length);
foreach(i; 0 .. host.length)
if(host[i] == "localhost") {
listeners ~= startListening("127.0.0.1", port[i], tcp, cleanup, 128, dropPrivs);
listeners ~= startListening("::1", port[i], tcp, cleanup, 128, dropPrivs);
} else {
listeners ~= startListening(host[i], port[i], tcp, cleanup, 128, dropPrivs);
}
version(cgi_use_fiber)
if(useFork) {
foreach(listener; listeners)
listener.blocking = false;
}
// this is the UI control thread and thus gets more priority
Thread.getThis.priority = Thread.PRIORITY_MAX;
}
Socket[] listeners;
void delegate(Socket) handler;
immutable bool useFork;
int numberOfThreads;
}
Socket startListening(string host, ushort port, ref bool tcp, ref void delegate() cleanup, int backQueue, void delegate() dropPrivs) {
Socket listener;
if(host.startsWith("unix:")) {
version(Posix) {
listener = new Socket(AddressFamily.UNIX, SocketType.STREAM);
cloexec(listener);
string filename = host["unix:".length .. $].idup;
listener.bind(new UnixAddress(filename));
cleanup = delegate() {
listener.close();
import std.file;
remove(filename);
};
tcp = false;
} else {
throw new Exception("unix sockets not supported on this system");
}
} else if(host.startsWith("abstract:")) {
version(linux) {
listener = new Socket(AddressFamily.UNIX, SocketType.STREAM);
cloexec(listener);
string filename = "\0" ~ host["abstract:".length .. $];
import std.stdio; stderr.writeln("Listening to abstract unix domain socket: ", host["abstract:".length .. $]);
listener.bind(new UnixAddress(filename));
tcp = false;
} else {
throw new Exception("abstract unix sockets not supported on this system");
}
} else {
auto address = host.length ? parseAddress(host, port) : new InternetAddress(port);
version(cgi_use_fiber) {
version(Windows)
listener = new PseudoblockingOverlappedSocket(AddressFamily.INET, SocketType.STREAM);
else
listener = new Socket(address.addressFamily, SocketType.STREAM);
} else {
listener = new Socket(address.addressFamily, SocketType.STREAM);
}
cloexec(listener);
listener.setOption(SocketOptionLevel.SOCKET, SocketOption.REUSEADDR, true);
if(address.addressFamily == AddressFamily.INET6)
listener.setOption(SocketOptionLevel.IPV6, SocketOption.IPV6_V6ONLY, true);
listener.bind(address);
cleanup = delegate() {
listener.close();
};
tcp = true;
}
listener.listen(backQueue);
if (dropPrivs !is null) // can be null, backwards compatibility
dropPrivs();
return listener;
}
// helper function to send a lot to a socket. Since this blocks for the buffer (possibly several times), you should probably call it in a separate thread or something.
void sendAll(Socket s, const(void)[] data, string file = __FILE__, size_t line = __LINE__) {
if(data.length == 0) return;
ptrdiff_t amount;
//import std.stdio; writeln("***",cast(string) data,"///");
do {
amount = s.send(data);
if(amount == Socket.ERROR) {
version(cgi_use_fiber) {
if(wouldHaveBlocked()) {
bool registered = true;
registerEventWakeup(®istered, s, WakeupEvent.Write);
continue;
}
}
throw new ConnectionException(s, lastSocketError, file, line);
}
assert(amount > 0);
data = data[amount .. $];
} while(data.length);
}
class ConnectionException : Exception {
Socket socket;
this(Socket s, string msg, string file = __FILE__, size_t line = __LINE__) {
this.socket = s;
super(msg, file, line);
}
}
class HttpVersionNotSupportedException : Exception {
this(string file = __FILE__, size_t line = __LINE__) {
super("HTTP Version Not Supported", file, line);
}
}
alias void delegate(Socket) CMT;
import core.thread;
/+
cgi.d now uses a hybrid of event i/o and threads at the top level.
Top level thread is responsible for accepting sockets and selecting on them.
It then indicates to a child that a request is pending, and any random worker
thread that is free handles it. It goes into blocking mode and handles that
http request to completion.
At that point, it goes back into the waiting queue.
This concept is only implemented on Linux. On all other systems, it still
uses the worker threads and semaphores (which is perfectly fine for a lot of
things! Just having a great number of keep-alive connections will break that.)
So the algorithm is:
select(accept, event, pending)
if accept -> send socket to free thread, if any. if not, add socket to queue
if event -> send the signaling thread a socket from the queue, if not, mark it free
- event might block until it can be *written* to. it is a fifo sending socket fds!
A worker only does one http request at a time, then signals its availability back to the boss.
The socket the worker was just doing should be added to the one-off epoll read. If it is closed,
great, we can get rid of it. Otherwise, it is considered `pending`. The *kernel* manages that; the
actual FD will not be kept out here.
So:
queue = sockets we know are ready to read now, but no worker thread is available
idle list = worker threads not doing anything else. they signal back and forth
the workers all read off the event fd. This is the semaphore wait
the boss waits on accept or other sockets read events (one off! and level triggered). If anything happens wrt ready read,
it puts it in the queue and writes to the event fd.
The child could put the socket back in the epoll thing itself.
The child needs to be able to gracefully handle being given a socket that just closed with no work.
+/
class ConnectionThread : Thread {
this(ListeningConnectionManager lcm, CMT dg, int myThreadNumber) {
this.lcm = lcm;
this.dg = dg;
this.myThreadNumber = myThreadNumber;
super(&run);
}
void run() {
while(true) {
// so if there's a bunch of idle keep-alive connections, it can
// consume all the worker threads... just sitting there.
lcm.semaphore.wait();
if(globalStopFlag)
return;
Socket socket;
synchronized(lcm) {
auto idx = lcm.nextIndexFront;
socket = lcm.queue[idx];
lcm.queue[idx] = null;
atomicOp!"+="(lcm.nextIndexFront, 1);
atomicOp!"-="(lcm.queueLength, 1);
}
try {
//import std.stdio; writeln(myThreadNumber, " taking it");
dg(socket);
/+
if(socket.isAlive) {
// process it more later
version(linux) {
import core.sys.linux.epoll;
epoll_event ev;
ev.events = EPOLLIN | EPOLLONESHOT | EPOLLET;
ev.data.fd = socket.handle;
import std.stdio; writeln("adding");
if(epoll_ctl(lcm.epoll_fd, EPOLL_CTL_ADD, socket.handle, &ev) == -1) {
if(errno == EEXIST) {
ev.events = EPOLLIN | EPOLLONESHOT | EPOLLET;
ev.data.fd = socket.handle;
if(epoll_ctl(lcm.epoll_fd, EPOLL_CTL_MOD, socket.handle, &ev) == -1)
throw new Exception("epoll_ctl " ~ to!string(errno));
} else
throw new Exception("epoll_ctl " ~ to!string(errno));
}
//import std.stdio; writeln("keep alive");
// writing to this private member is to prevent the GC from closing my precious socket when I'm trying to use it later
__traits(getMember, socket, "sock") = cast(socket_t) -1;
} else {
continue; // hope it times out in a reasonable amount of time...
}
}
+/
} catch(ConnectionClosedException e) {
// can just ignore this, it is fairly normal
socket.close();
} catch(Throwable e) {
import std.stdio; stderr.rawWrite(e.toString); stderr.rawWrite("\n");
socket.close();
}
}
}
ListeningConnectionManager lcm;
CMT dg;
int myThreadNumber;
}
version(cgi_use_fiber)
class WorkerThread : Thread {
this(ListeningConnectionManager lcm, CMT dg, int myThreadNumber) {
this.lcm = lcm;
this.dg = dg;
this.myThreadNumber = myThreadNumber;
super(&run);
}
version(Windows)
void run() {
auto timeout = INFINITE;
PseudoblockingOverlappedSocket key;
OVERLAPPED* overlapped;
DWORD bytes;
while(!globalStopFlag && GetQueuedCompletionStatus(iocp, &bytes, cast(PULONG_PTR) &key, &overlapped, timeout)) {
if(key is null)
continue;
key.lastAnswer = bytes;
if(key.fiber) {
key.fiber.proceed();
} else {
// we have a new connection, issue the first receive on it and issue the next accept
auto sn = key.accepted;
key.accept();
cloexec(sn);
if(lcm.tcp) {
// disable Nagle's algorithm to avoid a 40ms delay when we send/recv
// on the socket because we do some buffering internally. I think this helps,
// certainly does for small requests, and I think it does for larger ones too
sn.setOption(SocketOptionLevel.TCP, SocketOption.TCP_NODELAY, 1);
sn.setOption(SocketOptionLevel.SOCKET, SocketOption.RCVTIMEO, dur!"seconds"(10));
}
dg(sn);
}
}
//SleepEx(INFINITE, TRUE);
}
version(linux)
void run() {
import core.sys.linux.epoll;
epfd = epoll_create1(EPOLL_CLOEXEC);
if(epfd == -1)
throw new Exception("epoll_create1 " ~ to!string(errno));
scope(exit) {
import core.sys.posix.unistd;
close(epfd);
}
{
epoll_event ev;
ev.events = EPOLLIN;
ev.data.fd = cancelfd;
epoll_ctl(epfd, EPOLL_CTL_ADD, cancelfd, &ev);
}
foreach(listener; lcm.listeners) {
epoll_event ev;
ev.events = EPOLLIN | EPOLLEXCLUSIVE; // EPOLLEXCLUSIVE is only available on kernels since like 2017 but that's prolly good enough.
ev.data.fd = listener.handle;
if(epoll_ctl(epfd, EPOLL_CTL_ADD, listener.handle, &ev) == -1)
throw new Exception("epoll_ctl " ~ to!string(errno));
}
while(!globalStopFlag) {
Socket sn;
epoll_event[64] events;
auto nfds = epoll_wait(epfd, events.ptr, events.length, -1);
if(nfds == -1) {
if(errno == EINTR)
continue;
throw new Exception("epoll_wait " ~ to!string(errno));
}
outer: foreach(idx; 0 .. nfds) {
auto flags = events[idx].events;
if(cast(size_t) events[idx].data.ptr == cast(size_t) cancelfd) {
globalStopFlag = true;
//import std.stdio; writeln("exit heard");
break;
} else {
foreach(listener; lcm.listeners) {
if(cast(size_t) events[idx].data.ptr == cast(size_t) listener.handle) {
//import std.stdio; writeln(myThreadNumber, " woken up ", flags);
// this try/catch is because it is set to non-blocking mode
// and Phobos' stupid api throws an exception instead of returning
// if it would block. Why would it block? because a forked process
// might have beat us to it, but the wakeup event thundered our herds.
try
sn = listener.accept(); // don't need to do the acceptCancelable here since the epoll checks it better
catch(SocketAcceptException e) { continue outer; }
cloexec(sn);
if(lcm.tcp) {
// disable Nagle's algorithm to avoid a 40ms delay when we send/recv
// on the socket because we do some buffering internally. I think this helps,
// certainly does for small requests, and I think it does for larger ones too
sn.setOption(SocketOptionLevel.TCP, SocketOption.TCP_NODELAY, 1);
sn.setOption(SocketOptionLevel.SOCKET, SocketOption.RCVTIMEO, dur!"seconds"(10));
}
dg(sn);
continue outer;
} else {
// writeln(events[idx].data.ptr);
}
}
if(cast(size_t) events[idx].data.ptr < 1024) {
throw arsd.core.ArsdException!"this doesn't look like a fiber pointer... "(cast(size_t) events[idx].data.ptr);
}
auto fiber = cast(CgiFiber) events[idx].data.ptr;
fiber.proceed();
}
}
}
}
ListeningConnectionManager lcm;
CMT dg;
int myThreadNumber;
}
/* Done with network helper */
/* Helpers for doing temporary files. Used both here and in web.d */
version(Windows) {
import core.sys.windows.windows;
extern(Windows) DWORD GetTempPathW(DWORD, LPWSTR);
alias GetTempPathW GetTempPath;
}
version(Posix) {
static import linux = core.sys.posix.unistd;
}
string getTempDirectory() {
string path;
version(Windows) {
wchar[1024] buffer;
auto len = GetTempPath(1024, buffer.ptr);
if(len == 0)
throw new Exception("couldn't find a temporary path");
auto b = buffer[0 .. len];
path = to!string(b);
} else
path = "/tmp/";
return path;
}
// I like std.date. These functions help keep my old code and data working with phobos changing.
long sysTimeToDTime(in SysTime sysTime) {
return convert!("hnsecs", "msecs")(sysTime.stdTime - 621355968000000000L);
}
long dateTimeToDTime(in DateTime dt) {
return sysTimeToDTime(cast(SysTime) dt);
}
long getUtcTime() { // renamed primarily to avoid conflict with std.date itself
return sysTimeToDTime(Clock.currTime(UTC()));
}
// NOTE: new SimpleTimeZone(minutes); can perhaps work with the getTimezoneOffset() JS trick
SysTime dTimeToSysTime(long dTime, immutable TimeZone tz = null) {
immutable hnsecs = convert!("msecs", "hnsecs")(dTime) + 621355968000000000L;
return SysTime(hnsecs, tz);
}
// this is a helper to read HTTP transfer-encoding: chunked responses
immutable(ubyte[]) dechunk(BufferedInputRange ir) {
immutable(ubyte)[] ret;
another_chunk:
// If here, we are at the beginning of a chunk.
auto a = ir.front();
int chunkSize;
int loc = locationOf(a, "\r\n");
while(loc == -1) {
ir.popFront();
a = ir.front();
loc = locationOf(a, "\r\n");
}
string hex;
hex = "";
for(int i = 0; i < loc; i++) {
char c = a[i];
if(c >= 'A' && c <= 'Z')
c += 0x20;
if((c >= '0' && c <= '9') || (c >= 'a' && c <= 'z')) {
hex ~= c;
} else {
break;
}
}
assert(hex.length);
int power = 1;
int size = 0;
foreach(cc1; retro(hex)) {
dchar cc = cc1;
if(cc >= 'a' && cc <= 'z')
cc -= 0x20;
int val = 0;
if(cc >= '0' && cc <= '9')
val = cc - '0';
else
val = cc - 'A' + 10;
size += power * val;
power *= 16;
}
chunkSize = size;
assert(size >= 0);
if(loc + 2 > a.length) {
ir.popFront(0, a.length + loc + 2);
a = ir.front();
}
a = ir.consume(loc + 2);
if(chunkSize == 0) { // we're done with the response
// if we got here, will change must be true....
more_footers:
loc = locationOf(a, "\r\n");
if(loc == -1) {
ir.popFront();
a = ir.front;
goto more_footers;
} else {
assert(loc == 0);
ir.consume(loc + 2);
goto finish;
}
} else {
// if we got here, will change must be true....
if(a.length < chunkSize + 2) {
ir.popFront(0, chunkSize + 2);
a = ir.front();
}
ret ~= (a[0..chunkSize]);
if(!(a.length > chunkSize + 2)) {
ir.popFront(0, chunkSize + 2);
a = ir.front();
}
assert(a[chunkSize] == 13);
assert(a[chunkSize+1] == 10);
a = ir.consume(chunkSize + 2);
chunkSize = 0;
goto another_chunk;
}
finish:
return ret;
}
// I want to be able to get data from multiple sources the same way...
interface ByChunkRange {
bool empty();
void popFront();
const(ubyte)[] front();
}
ByChunkRange byChunk(const(ubyte)[] data) {
return new class ByChunkRange {
override bool empty() {
return !data.length;
}
override void popFront() {
if(data.length > 4096)
data = data[4096 .. $];
else
data = null;
}
override const(ubyte)[] front() {
return data[0 .. $ > 4096 ? 4096 : $];
}
};
}
ByChunkRange byChunk(BufferedInputRange ir, size_t atMost) {
const(ubyte)[] f;
f = ir.front;
if(f.length > atMost)
f = f[0 .. atMost];
return new class ByChunkRange {
override bool empty() {
return atMost == 0;
}
override const(ubyte)[] front() {
return f;
}
override void popFront() {
ir.consume(f.length);
atMost -= f.length;
auto a = ir.front();
if(a.length <= atMost) {
f = a;
atMost -= a.length;
a = ir.consume(a.length);
if(atMost != 0)
ir.popFront();
if(f.length == 0) {
f = ir.front();
}
} else {
// we actually have *more* here than we need....
f = a[0..atMost];
atMost = 0;
ir.consume(atMost);
}
}
};
}
version(cgi_with_websocket) {
// http://tools.ietf.org/html/rfc6455
/++
WEBSOCKET SUPPORT:
Full example:
---
import arsd.cgi;
void websocketEcho(Cgi cgi) {
if(cgi.websocketRequested()) {
if(cgi.origin != "http://arsdnet.net")
throw new Exception("bad origin");
auto websocket = cgi.acceptWebsocket();
websocket.send("hello");
websocket.send(" world!");
auto msg = websocket.recv();
while(msg.opcode != WebSocketOpcode.close) {
if(msg.opcode == WebSocketOpcode.text) {
websocket.send(msg.textData);
} else if(msg.opcode == WebSocketOpcode.binary) {
websocket.send(msg.data);
}
msg = websocket.recv();
}
websocket.close();
} else {
cgi.write("You are loading the websocket endpoint in a browser instead of a websocket client. Use a websocket client on this url instead.\n", true);
}
}
mixin GenericMain!websocketEcho;
---
+/
class WebSocket {
Cgi cgi;
private this(Cgi cgi) {
this.cgi = cgi;
Socket socket = cgi.idlol.source;
socket.setOption(SocketOptionLevel.SOCKET, SocketOption.RCVTIMEO, dur!"minutes"(5));
}
// returns true if data available, false if it timed out
bool recvAvailable(Duration timeout = dur!"msecs"(0)) {
if(!waitForNextMessageWouldBlock())
return true;
if(isDataPending(timeout))
return true; // this is kinda a lie.
return false;
}
public bool lowLevelReceive() {
auto bfr = cgi.idlol;
top:
auto got = bfr.front;
if(got.length) {
if(receiveBuffer.length < receiveBufferUsedLength + got.length)
receiveBuffer.length += receiveBufferUsedLength + got.length;
receiveBuffer[receiveBufferUsedLength .. receiveBufferUsedLength + got.length] = got[];
receiveBufferUsedLength += got.length;
bfr.consume(got.length);
return true;
}
if(bfr.sourceClosed)
return false;
bfr.popFront(0);
if(bfr.sourceClosed)
return false;
goto top;
}
bool isDataPending(Duration timeout = 0.seconds) {
Socket socket = cgi.idlol.source;
auto check = new SocketSet();
check.add(socket);
auto got = Socket.select(check, null, null, timeout);
if(got > 0)
return true;
return false;
}
// note: this blocks
WebSocketFrame recv() {
return waitForNextMessage();
}
private void llclose() {
cgi.close();
}
private void llsend(ubyte[] data) {
cgi.write(data);
cgi.flush();
}
void unregisterActiveSocket(WebSocket) {}
/* copy/paste section { */
private int readyState_;
private ubyte[] receiveBuffer;
private size_t receiveBufferUsedLength;
private Config config;
enum CONNECTING = 0; /// Socket has been created. The connection is not yet open.
enum OPEN = 1; /// The connection is open and ready to communicate.
enum CLOSING = 2; /// The connection is in the process of closing.
enum CLOSED = 3; /// The connection is closed or couldn't be opened.
/++
+/
/// Group: foundational
static struct Config {
/++
These control the size of the receive buffer.
It starts at the initial size, will temporarily
balloon up to the maximum size, and will reuse
a buffer up to the likely size.
Anything larger than the maximum size will cause
the connection to be aborted and an exception thrown.
This is to protect you against a peer trying to
exhaust your memory, while keeping the user-level
processing simple.
+/
size_t initialReceiveBufferSize = 4096;
size_t likelyReceiveBufferSize = 4096; /// ditto
size_t maximumReceiveBufferSize = 10 * 1024 * 1024; /// ditto
/++
Maximum combined size of a message.
+/
size_t maximumMessageSize = 10 * 1024 * 1024;
string[string] cookies; /// Cookies to send with the initial request. cookies[name] = value;
string origin; /// Origin URL to send with the handshake, if desired.
string protocol; /// the protocol header, if desired.
int pingFrequency = 5000; /// Amount of time (in msecs) of idleness after which to send an automatic ping
}
/++
Returns one of [CONNECTING], [OPEN], [CLOSING], or [CLOSED].
+/
int readyState() {
return readyState_;
}
/++
Closes the connection, sending a graceful teardown message to the other side.
+/
/// Group: foundational
void close(int code = 0, string reason = null)
//in (reason.length < 123)
in { assert(reason.length < 123); } do
{
if(readyState_ != OPEN)
return; // it cool, we done
WebSocketFrame wss;
wss.fin = true;
wss.opcode = WebSocketOpcode.close;
wss.data = cast(ubyte[]) reason.dup;
wss.send(&llsend);
readyState_ = CLOSING;
llclose();
}
/++
Sends a ping message to the server. This is done automatically by the library if you set a non-zero [Config.pingFrequency], but you can also send extra pings explicitly as well with this function.
+/
/// Group: foundational
void ping() {
WebSocketFrame wss;
wss.fin = true;
wss.opcode = WebSocketOpcode.ping;
wss.send(&llsend);
}
// automatically handled....
void pong() {
WebSocketFrame wss;
wss.fin = true;
wss.opcode = WebSocketOpcode.pong;
wss.send(&llsend);
}
/++
Sends a text message through the websocket.
+/
/// Group: foundational
void send(in char[] textData) {
WebSocketFrame wss;
wss.fin = true;
wss.opcode = WebSocketOpcode.text;
wss.data = cast(ubyte[]) textData.dup;
wss.send(&llsend);
}
/++
Sends a binary message through the websocket.
+/
/// Group: foundational
void send(in ubyte[] binaryData) {
WebSocketFrame wss;
wss.fin = true;
wss.opcode = WebSocketOpcode.binary;
wss.data = cast(ubyte[]) binaryData.dup;
wss.send(&llsend);
}
/++
Waits for and returns the next complete message on the socket.
Note that the onmessage function is still called, right before
this returns.
+/
/// Group: blocking_api
public WebSocketFrame waitForNextMessage() {
do {
auto m = processOnce();
if(m.populated)
return m;
} while(lowLevelReceive());
throw new ConnectionClosedException("Websocket receive timed out");
//return WebSocketFrame.init; // FIXME? maybe.
}
/++
Tells if [waitForNextMessage] would block.
+/
/// Group: blocking_api
public bool waitForNextMessageWouldBlock() {
checkAgain:
if(isMessageBuffered())
return false;
if(!isDataPending())
return true;
while(isDataPending())
lowLevelReceive();
goto checkAgain;
}
/++
Is there a message in the buffer already?
If `true`, [waitForNextMessage] is guaranteed to return immediately.
If `false`, check [isDataPending] as the next step.
+/
/// Group: blocking_api
public bool isMessageBuffered() {
ubyte[] d = receiveBuffer[0 .. receiveBufferUsedLength];
auto s = d;
if(d.length) {
auto orig = d;
auto m = WebSocketFrame.read(d);
// that's how it indicates that it needs more data
if(d !is orig)
return true;
}
return false;
}
private ubyte continuingType;
private ubyte[] continuingData;
//private size_t continuingDataLength;
private WebSocketFrame processOnce() {
ubyte[] d = receiveBuffer[0 .. receiveBufferUsedLength];
auto s = d;
// FIXME: handle continuation frames more efficiently. it should really just reuse the receive buffer.
WebSocketFrame m;
if(d.length) {
auto orig = d;
m = WebSocketFrame.read(d);
// that's how it indicates that it needs more data
if(d is orig)
return WebSocketFrame.init;
m.unmaskInPlace();
switch(m.opcode) {
case WebSocketOpcode.continuation:
if(continuingData.length + m.data.length > config.maximumMessageSize)
throw new Exception("message size exceeded");
continuingData ~= m.data;
if(m.fin) {
if(ontextmessage)
ontextmessage(cast(char[]) continuingData);
if(onbinarymessage)
onbinarymessage(continuingData);
continuingData = null;
}
break;
case WebSocketOpcode.text:
if(m.fin) {
if(ontextmessage)
ontextmessage(m.textData);
} else {
continuingType = m.opcode;
//continuingDataLength = 0;
continuingData = null;
continuingData ~= m.data;
}
break;
case WebSocketOpcode.binary:
if(m.fin) {
if(onbinarymessage)
onbinarymessage(m.data);
} else {
continuingType = m.opcode;
//continuingDataLength = 0;
continuingData = null;
continuingData ~= m.data;
}
break;
case WebSocketOpcode.close:
readyState_ = CLOSED;
if(onclose)
onclose();
unregisterActiveSocket(this);
break;
case WebSocketOpcode.ping:
pong();
break;
case WebSocketOpcode.pong:
// just really references it is still alive, nbd.
break;
default: // ignore though i could and perhaps should throw too
}
}
// the recv thing can be invalidated so gotta copy it over ugh
if(d.length) {
m.data = m.data.dup();
}
import core.stdc.string;
memmove(receiveBuffer.ptr, d.ptr, d.length);
receiveBufferUsedLength = d.length;
return m;
}
private void autoprocess() {
// FIXME
do {
processOnce();
} while(lowLevelReceive());
}
void delegate() onclose; ///
void delegate() onerror; ///
void delegate(in char[]) ontextmessage; ///
void delegate(in ubyte[]) onbinarymessage; ///
void delegate() onopen; ///
/++
+/
/// Group: browser_api
void onmessage(void delegate(in char[]) dg) {
ontextmessage = dg;
}
/// ditto
void onmessage(void delegate(in ubyte[]) dg) {
onbinarymessage = dg;
}
/* } end copy/paste */
}
/++
Returns true if the request headers are asking for a websocket upgrade.
If this returns true, and you want to accept it, call [acceptWebsocket].
+/
bool websocketRequested(Cgi cgi) {
return
"sec-websocket-key" in cgi.requestHeaders
&&
"connection" in cgi.requestHeaders &&
cgi.requestHeaders["connection"].asLowerCase().canFind("upgrade")
&&
"upgrade" in cgi.requestHeaders &&
cgi.requestHeaders["upgrade"].asLowerCase().equal("websocket")
;
}
/++
If [websocketRequested], you can call this to accept it and upgrade the connection. It returns the new [WebSocket] object you use for future communication on this connection; the `cgi` object should no longer be used.
+/
WebSocket acceptWebsocket(Cgi cgi) {
assert(!cgi.closed);
assert(!cgi.outputtedResponseData);
cgi.setResponseStatus("101 Switching Protocols");
cgi.header("Upgrade: WebSocket");
cgi.header("Connection: upgrade");
string key = cgi.requestHeaders["sec-websocket-key"];
key ~= "258EAFA5-E914-47DA-95CA-C5AB0DC85B11"; // the defined guid from the websocket spec
import std.digest.sha;
auto hash = sha1Of(key);
auto accept = Base64.encode(hash);
cgi.header(("Sec-WebSocket-Accept: " ~ accept).idup);
cgi.websocketMode = true;
cgi.write("");
cgi.flush();
return new WebSocket(cgi);
}
// FIXME get websocket to work on other modes, not just embedded_httpd
/* copy/paste in http2.d { */
enum WebSocketOpcode : ubyte {
continuation = 0,
text = 1,
binary = 2,
// 3, 4, 5, 6, 7 RESERVED
close = 8,
ping = 9,
pong = 10,
// 11,12,13,14,15 RESERVED
}
public struct WebSocketFrame {
private bool populated;
bool fin;
bool rsv1;
bool rsv2;
bool rsv3;
WebSocketOpcode opcode; // 4 bits
bool masked;
ubyte lengthIndicator; // don't set this when building one to send
ulong realLength; // don't use when sending
ubyte[4] maskingKey; // don't set this when sending
ubyte[] data;
static WebSocketFrame simpleMessage(WebSocketOpcode opcode, void[] data) {
WebSocketFrame msg;
msg.fin = true;
msg.opcode = opcode;
msg.data = cast(ubyte[]) data.dup;
return msg;
}
private void send(scope void delegate(ubyte[]) llsend) {
ubyte[64] headerScratch;
int headerScratchPos = 0;
realLength = data.length;
{
ubyte b1;
b1 |= cast(ubyte) opcode;
b1 |= rsv3 ? (1 << 4) : 0;
b1 |= rsv2 ? (1 << 5) : 0;
b1 |= rsv1 ? (1 << 6) : 0;
b1 |= fin ? (1 << 7) : 0;
headerScratch[0] = b1;
headerScratchPos++;
}
{
headerScratchPos++; // we'll set header[1] at the end of this
auto rlc = realLength;
ubyte b2;
b2 |= masked ? (1 << 7) : 0;
assert(headerScratchPos == 2);
if(realLength > 65535) {
// use 64 bit length
b2 |= 0x7f;
// FIXME: double check endinaness
foreach(i; 0 .. 8) {
headerScratch[2 + 7 - i] = rlc & 0x0ff;
rlc >>>= 8;
}
headerScratchPos += 8;
} else if(realLength > 125) {
// use 16 bit length
b2 |= 0x7e;
// FIXME: double check endinaness
foreach(i; 0 .. 2) {
headerScratch[2 + 1 - i] = rlc & 0x0ff;
rlc >>>= 8;
}
headerScratchPos += 2;
} else {
// use 7 bit length
b2 |= realLength & 0b_0111_1111;
}
headerScratch[1] = b2;
}
//assert(!masked, "masking key not properly implemented");
if(masked) {
// FIXME: randomize this
headerScratch[headerScratchPos .. headerScratchPos + 4] = maskingKey[];
headerScratchPos += 4;
// we'll just mask it in place...
int keyIdx = 0;
foreach(i; 0 .. data.length) {
data[i] = data[i] ^ maskingKey[keyIdx];
if(keyIdx == 3)
keyIdx = 0;
else
keyIdx++;
}
}
//writeln("SENDING ", headerScratch[0 .. headerScratchPos], data);
llsend(headerScratch[0 .. headerScratchPos]);
llsend(data);
}
static WebSocketFrame read(ref ubyte[] d) {
WebSocketFrame msg;
auto orig = d;
WebSocketFrame needsMoreData() {
d = orig;
return WebSocketFrame.init;
}
if(d.length < 2)
return needsMoreData();
ubyte b = d[0];
msg.populated = true;
msg.opcode = cast(WebSocketOpcode) (b & 0x0f);
b >>= 4;
msg.rsv3 = b & 0x01;
b >>= 1;
msg.rsv2 = b & 0x01;
b >>= 1;
msg.rsv1 = b & 0x01;
b >>= 1;
msg.fin = b & 0x01;
b = d[1];
msg.masked = (b & 0b1000_0000) ? true : false;
msg.lengthIndicator = b & 0b0111_1111;
d = d[2 .. $];
if(msg.lengthIndicator == 0x7e) {
// 16 bit length
msg.realLength = 0;
if(d.length < 2) return needsMoreData();
foreach(i; 0 .. 2) {
msg.realLength |= d[0] << ((1-i) * 8);
d = d[1 .. $];
}
} else if(msg.lengthIndicator == 0x7f) {
// 64 bit length
msg.realLength = 0;
if(d.length < 8) return needsMoreData();
foreach(i; 0 .. 8) {
msg.realLength |= ulong(d[0]) << ((7-i) * 8);
d = d[1 .. $];
}
} else {
// 7 bit length
msg.realLength = msg.lengthIndicator;
}
if(msg.masked) {
if(d.length < 4) return needsMoreData();
msg.maskingKey = d[0 .. 4];
d = d[4 .. $];
}
if(msg.realLength > d.length) {
return needsMoreData();
}
msg.data = d[0 .. cast(size_t) msg.realLength];
d = d[cast(size_t) msg.realLength .. $];
return msg;
}
void unmaskInPlace() {
if(this.masked) {
int keyIdx = 0;
foreach(i; 0 .. this.data.length) {
this.data[i] = this.data[i] ^ this.maskingKey[keyIdx];
if(keyIdx == 3)
keyIdx = 0;
else
keyIdx++;
}
}
}
char[] textData() {
return cast(char[]) data;
}
}
/* } */
}
version(Windows)
{
version(CRuntime_DigitalMars)
{
extern(C) int setmode(int, int) nothrow @nogc;
}
else version(CRuntime_Microsoft)
{
extern(C) int _setmode(int, int) nothrow @nogc;
alias setmode = _setmode;
}
else static assert(0);
}
version(Posix) {
import core.sys.posix.unistd;
version(CRuntime_Musl) {} else {
private extern(C) int posix_spawn(pid_t*, const char*, void*, void*, const char**, const char**);
}
}
// FIXME: these aren't quite public yet.
//private:
// template for laziness
void startAddonServer()(string arg) {
version(OSX) {
assert(0, "Not implemented");
} else version(linux) {
import core.sys.posix.unistd;
pid_t pid;
const(char)*[16] args;
args[0] = "ARSD_CGI_ADDON_SERVER";
args[1] = arg.ptr;
posix_spawn(&pid, "/proc/self/exe",
null,
null,
args.ptr,
null // env
);
} else version(Windows) {
wchar[2048] filename;
auto len = GetModuleFileNameW(null, filename.ptr, cast(DWORD) filename.length);
if(len == 0 || len == filename.length)
throw new Exception("could not get process name to start helper server");
STARTUPINFOW startupInfo;
startupInfo.cb = cast(DWORD) startupInfo.sizeof;
PROCESS_INFORMATION processInfo;
import std.utf;
// I *MIGHT* need to run it as a new job or a service...
auto ret = CreateProcessW(
filename.ptr,
toUTF16z(arg),
null, // process attributes
null, // thread attributes
false, // inherit handles
0, // creation flags
null, // environment
null, // working directory
&startupInfo,
&processInfo
);
if(!ret)
throw new Exception("create process failed");
// when done with those, if we set them
/*
CloseHandle(hStdInput);
CloseHandle(hStdOutput);
CloseHandle(hStdError);
*/
} else static assert(0, "Websocket server not implemented on this system yet (email me, i can prolly do it if you need it)");
}
// template for laziness
/*
The websocket server is a single-process, single-thread, event
I/O thing. It is passed websockets from other CGI processes
and is then responsible for handling their messages and responses.
Note that the CGI process is responsible for websocket setup,
including authentication, etc.
It also gets data sent to it by other processes and is responsible
for distributing that, as necessary.
*/
void runWebsocketServer()() {
assert(0, "not implemented");
}
void sendToWebsocketServer(WebSocket ws, string group) {
assert(0, "not implemented");
}
void sendToWebsocketServer(string content, string group) {
assert(0, "not implemented");
}
void runEventServer()() {
runAddonServer("/tmp/arsd_cgi_event_server", new EventSourceServerImplementation());
}
void runTimerServer()() {
runAddonServer("/tmp/arsd_scheduled_job_server", new ScheduledJobServerImplementation());
}
version(Posix) {
alias LocalServerConnectionHandle = int;
alias CgiConnectionHandle = int;
alias SocketConnectionHandle = int;
enum INVALID_CGI_CONNECTION_HANDLE = -1;
} else version(Windows) {
alias LocalServerConnectionHandle = HANDLE;
version(embedded_httpd_threads) {
alias CgiConnectionHandle = SOCKET;
enum INVALID_CGI_CONNECTION_HANDLE = INVALID_SOCKET;
} else version(fastcgi) {
alias CgiConnectionHandle = void*; // Doesn't actually work! But I don't want compile to fail pointlessly at this point.
enum INVALID_CGI_CONNECTION_HANDLE = null;
} else version(scgi) {
alias CgiConnectionHandle = SOCKET;
enum INVALID_CGI_CONNECTION_HANDLE = INVALID_SOCKET;
} else { /* version(plain_cgi) */
alias CgiConnectionHandle = HANDLE;
enum INVALID_CGI_CONNECTION_HANDLE = null;
}
alias SocketConnectionHandle = SOCKET;
}
version(with_addon_servers_connections)
LocalServerConnectionHandle openLocalServerConnection()(string name, string arg) {
version(Posix) {
import core.sys.posix.unistd;
import core.sys.posix.sys.un;
int sock = socket(AF_UNIX, SOCK_STREAM, 0);
if(sock == -1)
throw new Exception("socket " ~ to!string(errno));
scope(failure)
close(sock);
cloexec(sock);
// add-on server processes are assumed to be local, and thus will
// use unix domain sockets. Besides, I want to pass sockets to them,
// so it basically must be local (except for the session server, but meh).
sockaddr_un addr;
addr.sun_family = AF_UNIX;
version(linux) {
// on linux, we will use the abstract namespace
addr.sun_path[0] = 0;
addr.sun_path[1 .. name.length + 1] = cast(typeof(addr.sun_path[])) name[];
} else {
// but otherwise, just use a file cuz we must.
addr.sun_path[0 .. name.length] = cast(typeof(addr.sun_path[])) name[];
}
bool alreadyTried;
try_again:
if(connect(sock, cast(sockaddr*) &addr, addr.sizeof) == -1) {
if(!alreadyTried && errno == ECONNREFUSED) {
// try auto-spawning the server, then attempt connection again
startAddonServer(arg);
import core.thread;
Thread.sleep(50.msecs);
alreadyTried = true;
goto try_again;
} else
throw new Exception("connect " ~ to!string(errno));
}
return sock;
} else version(Windows) {
return null; // FIXME
}
}
version(with_addon_servers_connections)
void closeLocalServerConnection(LocalServerConnectionHandle handle) {
version(Posix) {
import core.sys.posix.unistd;
close(handle);
} else version(Windows)
CloseHandle(handle);
}
void runSessionServer()() {
runAddonServer("/tmp/arsd_session_server", new BasicDataServerImplementation());
}
import core.stdc.errno;
struct IoOp {
@disable this();
@disable this(this);
/*
So we want to be able to eventually handle generic sockets too.
*/
enum Read = 1;
enum Write = 2;
enum Accept = 3;
enum ReadSocketHandle = 4;
// Your handler may be called in a different thread than the one that initiated the IO request!
// It is also possible to have multiple io requests being called simultaneously. Use proper thread safety caution.
private bool delegate(IoOp*, int) handler; // returns true if you are done and want it to be closed
private void delegate(IoOp*) closeHandler;
private void delegate(IoOp*) completeHandler;
private int internalFd;
private int operation;
private int bufferLengthAllocated;
private int bufferLengthUsed;
private ubyte[1] internalBuffer; // it can be overallocated!
ubyte[] allocatedBuffer() return {
return internalBuffer.ptr[0 .. bufferLengthAllocated];
}
ubyte[] usedBuffer() return {
return allocatedBuffer[0 .. bufferLengthUsed];
}
void reset() {
bufferLengthUsed = 0;
}
int fd() {
return internalFd;
}
}
IoOp* allocateIoOp(int fd, int operation, int bufferSize, bool delegate(IoOp*, int) handler) {
import core.stdc.stdlib;
auto ptr = calloc(IoOp.sizeof + bufferSize, 1);
if(ptr is null)
assert(0); // out of memory!
auto op = cast(IoOp*) ptr;
op.handler = handler;
op.internalFd = fd;
op.operation = operation;
op.bufferLengthAllocated = bufferSize;
op.bufferLengthUsed = 0;
import core.memory;
GC.addRoot(ptr);
return op;
}
void freeIoOp(ref IoOp* ptr) {
import core.memory;
GC.removeRoot(ptr);
import core.stdc.stdlib;
free(ptr);
ptr = null;
}
version(Posix)
version(with_addon_servers_connections)
void nonBlockingWrite(EventIoServer eis, int connection, const void[] data) {
//import std.stdio : writeln; writeln(cast(string) data);
import core.sys.posix.unistd;
auto ret = write(connection, data.ptr, data.length);
if(ret != data.length) {
if(ret == 0 || (ret == -1 && (errno == EPIPE || errno == ETIMEDOUT))) {
// the file is closed, remove it
eis.fileClosed(connection);
} else
throw new Exception("alas " ~ to!string(ret) ~ " " ~ to!string(errno)); // FIXME
}
}
version(Windows)
version(with_addon_servers_connections)
void nonBlockingWrite(EventIoServer eis, int connection, const void[] data) {
// FIXME
}
bool isInvalidHandle(CgiConnectionHandle h) {
return h == INVALID_CGI_CONNECTION_HANDLE;
}
/+
https://docs.microsoft.com/en-us/windows/desktop/api/winsock2/nf-winsock2-wsarecv
https://support.microsoft.com/en-gb/help/181611/socket-overlapped-i-o-versus-blocking-nonblocking-mode
https://stackoverflow.com/questions/18018489/should-i-use-iocps-or-overlapped-wsasend-receive
https://docs.microsoft.com/en-us/windows/desktop/fileio/i-o-completion-ports
https://docs.microsoft.com/en-us/windows/desktop/fileio/createiocompletionport
https://docs.microsoft.com/en-us/windows/desktop/api/mswsock/nf-mswsock-acceptex
https://docs.microsoft.com/en-us/windows/desktop/Sync/waitable-timer-objects
https://docs.microsoft.com/en-us/windows/desktop/api/synchapi/nf-synchapi-setwaitabletimer
https://docs.microsoft.com/en-us/windows/desktop/Sync/using-a-waitable-timer-with-an-asynchronous-procedure-call
https://docs.microsoft.com/en-us/windows/desktop/api/winsock2/nf-winsock2-wsagetoverlappedresult
+/
/++
You can customize your server by subclassing the appropriate server. Then, register your
subclass at compile time with the [registerEventIoServer] template, or implement your own
main function and call it yourself.
$(TIP If you make your subclass a `final class`, there is a slight performance improvement.)
+/
version(with_addon_servers_connections)
interface EventIoServer {
bool handleLocalConnectionData(IoOp* op, int receivedFd);
void handleLocalConnectionClose(IoOp* op);
void handleLocalConnectionComplete(IoOp* op);
void wait_timeout();
void fileClosed(int fd);
void epoll_fd(int fd);
}
// the sink should buffer it
private void serialize(T)(scope void delegate(scope ubyte[]) sink, T t) {
static if(is(T == struct)) {
foreach(member; __traits(allMembers, T))
serialize(sink, __traits(getMember, t, member));
} else static if(is(T : int)) {
// no need to think of endianness just because this is only used
// for local, same-machine stuff anyway. thanks private lol
sink((cast(ubyte*) &t)[0 .. t.sizeof]);
} else static if(is(T == string) || is(T : const(ubyte)[])) {
// these are common enough to optimize
int len = cast(int) t.length; // want length consistent size tho, in case 32 bit program sends to 64 bit server, etc.
sink((cast(ubyte*) &len)[0 .. int.sizeof]);
sink(cast(ubyte[]) t[]);
} else static if(is(T : A[], A)) {
// generic array is less optimal but still prolly ok
int len = cast(int) t.length;
sink((cast(ubyte*) &len)[0 .. int.sizeof]);
foreach(item; t)
serialize(sink, item);
} else static assert(0, T.stringof);
}
// all may be stack buffers, so use cautio
private void deserialize(T)(scope ubyte[] delegate(int sz) get, scope void delegate(T) dg) {
static if(is(T == struct)) {
T t;
foreach(member; __traits(allMembers, T))
deserialize!(typeof(__traits(getMember, T, member)))(get, (mbr) { __traits(getMember, t, member) = mbr; });
dg(t);
} else static if(is(T : int)) {
// no need to think of endianness just because this is only used
// for local, same-machine stuff anyway. thanks private lol
T t;
auto data = get(t.sizeof);
t = (cast(T[]) data)[0];
dg(t);
} else static if(is(T == string) || is(T : const(ubyte)[])) {
// these are common enough to optimize
int len;
auto data = get(len.sizeof);
len = (cast(int[]) data)[0];
/*
typeof(T[0])[2000] stackBuffer;
T buffer;
if(len < stackBuffer.length)
buffer = stackBuffer[0 .. len];
else
buffer = new T(len);
data = get(len * typeof(T[0]).sizeof);
*/
T t = cast(T) get(len * cast(int) typeof(T.init[0]).sizeof);
dg(t);
} else static if(is(T == E[], E)) {
T t;
int len;
auto data = get(len.sizeof);
len = (cast(int[]) data)[0];
t.length = len;
foreach(ref e; t) {
deserialize!E(get, (ele) { e = ele; });
}
dg(t);
} else static assert(0, T.stringof);
}
unittest {
serialize((ubyte[] b) {
deserialize!int( sz => b[0 .. sz], (t) { assert(t == 1); });
}, 1);
serialize((ubyte[] b) {
deserialize!int( sz => b[0 .. sz], (t) { assert(t == 56674); });
}, 56674);
ubyte[1000] buffer;
int bufferPoint;
void add(scope ubyte[] b) {
buffer[bufferPoint .. bufferPoint + b.length] = b[];
bufferPoint += b.length;
}
ubyte[] get(int sz) {
auto b = buffer[bufferPoint .. bufferPoint + sz];
bufferPoint += sz;
return b;
}
serialize(&add, "test here");
bufferPoint = 0;
deserialize!string(&get, (t) { assert(t == "test here"); });
bufferPoint = 0;
struct Foo {
int a;
ubyte c;
string d;
}
serialize(&add, Foo(403, 37, "amazing"));
bufferPoint = 0;
deserialize!Foo(&get, (t) {
assert(t.a == 403);
assert(t.c == 37);
assert(t.d == "amazing");
});
bufferPoint = 0;
}
/*
Here's the way the RPC interface works:
You define the interface that lists the functions you can call on the remote process.
The interface may also have static methods for convenience. These forward to a singleton
instance of an auto-generated class, which actually sends the args over the pipe.
An impl class actually implements it. A receiving server deserializes down the pipe and
calls methods on the class.
I went with the interface to get some nice compiler checking and documentation stuff.
I could have skipped the interface and just implemented it all from the server class definition
itself, but then the usage may call the method instead of rpcing it; I just like having the user
interface and the implementation separate so you aren't tempted to `new impl` to call the methods.
I fiddled with newlines in the mixin string to ensure the assert line numbers matched up to the source code line number. Idk why dmd didn't do this automatically, but it was important to me.
Realistically though the bodies would just be
connection.call(this.mangleof, args...) sooooo.
FIXME: overloads aren't supported
*/
/// Base for storing sessions in an array. Exists primarily for internal purposes and you should generally not use this.
interface SessionObject {}
private immutable void delegate(string[])[string] scheduledJobHandlers;
private immutable void delegate(string[])[string] websocketServers;
version(with_breaking_cgi_features)
mixin(q{
mixin template ImplementRpcClientInterface(T, string serverPath, string cmdArg) {
static import std.traits;
// derivedMembers on an interface seems to give exactly what I want: the virtual functions we need to implement. so I am just going to use it directly without more filtering.
static foreach(idx, member; __traits(derivedMembers, T)) {
static if(__traits(isVirtualMethod, __traits(getMember, T, member)))
mixin( q{
std.traits.ReturnType!(__traits(getMember, T, member))
} ~ member ~ q{(std.traits.Parameters!(__traits(getMember, T, member)) params)
{
SerializationBuffer buffer;
auto i = cast(ushort) idx;
serialize(&buffer.sink, i);
serialize(&buffer.sink, __traits(getMember, T, member).mangleof);
foreach(param; params)
serialize(&buffer.sink, param);
auto sendable = buffer.sendable;
version(Posix) {{
auto ret = send(connectionHandle, sendable.ptr, sendable.length, 0);
if(ret == -1) {
throw new Exception("send returned -1, errno: " ~ to!string(errno));
} else if(ret == 0) {
throw new Exception("Connection to addon server lost");
} if(ret < sendable.length)
throw new Exception("Send failed to send all");
assert(ret == sendable.length);
}} // FIXME Windows impl
static if(!is(typeof(return) == void)) {
// there is a return value; we need to wait for it too
version(Posix) {
ubyte[3000] revBuffer;
auto ret = recv(connectionHandle, revBuffer.ptr, revBuffer.length, 0);
auto got = revBuffer[0 .. ret];
int dataLocation;
ubyte[] grab(int sz) {
auto dataLocation1 = dataLocation;
dataLocation += sz;
return got[dataLocation1 .. dataLocation];
}
typeof(return) retu;
deserialize!(typeof(return))(&grab, (a) { retu = a; });
return retu;
} else {
// FIXME Windows impl
return typeof(return).init;
}
}
}});
}
private static typeof(this) singletonInstance;
private LocalServerConnectionHandle connectionHandle;
static typeof(this) connection() {
if(singletonInstance is null) {
singletonInstance = new typeof(this)();
singletonInstance.connect();
}
return singletonInstance;
}
void connect() {
connectionHandle = openLocalServerConnection(serverPath, cmdArg);
}
void disconnect() {
closeLocalServerConnection(connectionHandle);
}
}
void dispatchRpcServer(Interface, Class)(Class this_, ubyte[] data, int fd) if(is(Class : Interface)) {
ushort calledIdx;
string calledFunction;
int dataLocation;
ubyte[] grab(int sz) {
if(sz == 0) assert(0);
auto d = data[dataLocation .. dataLocation + sz];
dataLocation += sz;
return d;
}
again:
deserialize!ushort(&grab, (a) { calledIdx = a; });
deserialize!string(&grab, (a) { calledFunction = a; });
import std.traits;
sw: switch(calledIdx) {
foreach(idx, memberName; __traits(derivedMembers, Interface))
static if(__traits(isVirtualMethod, __traits(getMember, Interface, memberName))) {
case idx:
assert(calledFunction == __traits(getMember, Interface, memberName).mangleof);
Parameters!(__traits(getMember, Interface, memberName)) params;
foreach(ref param; params)
deserialize!(typeof(param))(&grab, (a) { param = a; });
static if(is(ReturnType!(__traits(getMember, Interface, memberName)) == void)) {
__traits(getMember, this_, memberName)(params);
} else {
auto ret = __traits(getMember, this_, memberName)(params);
SerializationBuffer buffer;
serialize(&buffer.sink, ret);
auto sendable = buffer.sendable;
version(Posix) {
auto r = send(fd, sendable.ptr, sendable.length, 0);
if(r == -1) {
throw new Exception("send returned -1, errno: " ~ to!string(errno));
} else if(r == 0) {
throw new Exception("Connection to addon client lost");
} if(r < sendable.length)
throw new Exception("Send failed to send all");
} // FIXME Windows impl
}
break sw;
}
default: assert(0);
}
if(dataLocation != data.length)
goto again;
}
private struct SerializationBuffer {
ubyte[2048] bufferBacking;
int bufferLocation;
void sink(scope ubyte[] data) {
bufferBacking[bufferLocation .. bufferLocation + data.length] = data[];
bufferLocation += data.length;
}
ubyte[] sendable() return {
return bufferBacking[0 .. bufferLocation];
}
}
/*
FIXME:
add a version command line arg
version data in the library
management gui as external program
at server with event_fd for each run
use .mangleof in the at function name
i think the at server will have to:
pipe args to the child
collect child output for logging
get child return value for logging
on windows timers work differently. idk how to best combine with the io stuff.
will have to have dump and restore too, so i can restart without losing stuff.
*/
/++
A convenience object for talking to the [BasicDataServer] from a higher level.
See: [Cgi.getSessionObject].
You pass it a `Data` struct describing the data you want saved in the session.
Then, this class will generate getter and setter properties that allow access
to that data.
Note that each load and store will be done as-accessed; it doesn't front-load
mutable data nor does it batch updates out of fear of read-modify-write race
conditions. (In fact, right now it does this for everything, but in the future,
I might batch load `immutable` members of the Data struct.)
At some point in the future, I might also let it do different backends, like
a client-side cookie store too, but idk.
Note that the plain-old-data members of your `Data` struct are wrapped by this
interface via a static foreach to make property functions.
See_Also: [MockSession]
+/
interface Session(Data) : SessionObject {
@property string sessionId() const;
/++
Starts a new session. Note that a session is also
implicitly started as soon as you write data to it,
so if you need to alter these parameters from their
defaults, be sure to explicitly call this BEFORE doing
any writes to session data.
Params:
idleLifetime = How long, in seconds, the session
should remain in memory when not being read from
or written to. The default is one day.
NOT IMPLEMENTED
useExtendedLifetimeCookie = The session ID is always
stored in a HTTP cookie, and by default, that cookie
is discarded when the user closes their browser.
But if you set this to true, it will use a non-perishable
cookie for the given idleLifetime.
NOT IMPLEMENTED
+/
void start(int idleLifetime = 2600 * 24, bool useExtendedLifetimeCookie = false);
/++
Regenerates the session ID and updates the associated
cookie.
This is also your chance to change immutable data
(not yet implemented).
+/
void regenerateId();
/++
Terminates this session, deleting all saved data.
+/
void terminate();
/++
Plain-old-data members of your `Data` struct are wrapped here via
the property getters and setters.
If the member is a non-string array, it returns a magical array proxy
object which allows for atomic appends and replaces via overloaded operators.
You can slice this to get a range representing a $(B const) view of the array.
This is to protect you against read-modify-write race conditions.
+/
static foreach(memberName; __traits(allMembers, Data))
static if(is(typeof(__traits(getMember, Data, memberName))))
mixin(q{
@property inout(typeof(__traits(getMember, Data, memberName))) } ~ memberName ~ q{ () inout;
@property typeof(__traits(getMember, Data, memberName)) } ~ memberName ~ q{ (typeof(__traits(getMember, Data, memberName)) value);
});
}
/++
An implementation of [Session] that works on real cgi connections utilizing the
[BasicDataServer].
As opposed to a [MockSession] which is made for testing purposes.
You will not construct one of these directly. See [Cgi.getSessionObject] instead.
+/
class BasicDataServerSession(Data) : Session!Data {
private Cgi cgi;
private string sessionId_;
public @property string sessionId() const {
return sessionId_;
}
protected @property string sessionId(string s) {
return this.sessionId_ = s;
}
private this(Cgi cgi) {
this.cgi = cgi;
if(auto ptr = "sessionId" in cgi.cookies)
sessionId = (*ptr).length ? *ptr : null;
}
void start(int idleLifetime = 2600 * 24, bool useExtendedLifetimeCookie = false) {
assert(sessionId is null);
// FIXME: what if there is a session ID cookie, but no corresponding session on the server?
import std.random, std.conv;
sessionId = to!string(uniform(1, long.max));
BasicDataServer.connection.createSession(sessionId, idleLifetime);
setCookie();
}
protected void setCookie() {
cgi.setCookie(
"sessionId", sessionId,
0 /* expiration */,
"/" /* path */,
null /* domain */,
true /* http only */,
cgi.https /* if the session is started on https, keep it there, otherwise, be flexible */);
}
void regenerateId() {
if(sessionId is null) {
start();
return;
}
import std.random, std.conv;
auto oldSessionId = sessionId;
sessionId = to!string(uniform(1, long.max));
BasicDataServer.connection.renameSession(oldSessionId, sessionId);
setCookie();
}
void terminate() {
BasicDataServer.connection.destroySession(sessionId);
sessionId = null;
setCookie();
}
static foreach(memberName; __traits(allMembers, Data))
static if(is(typeof(__traits(getMember, Data, memberName))))
mixin(q{
@property inout(typeof(__traits(getMember, Data, memberName))) } ~ memberName ~ q{ () inout {
if(sessionId is null)
return typeof(return).init;
import std.traits;
auto v = BasicDataServer.connection.getSessionData(sessionId, fullyQualifiedName!Data ~ "." ~ memberName);
if(v.length == 0)
return typeof(return).init;
import std.conv;
// why this cast? to doesn't like being given an inout argument. so need to do it without that, then
// we need to return it and that needed the cast. It should be fine since we basically respect constness..
// basically. Assuming the session is POD this should be fine.
return cast(typeof(return)) to!(typeof(__traits(getMember, Data, memberName)))(v);
}
@property typeof(__traits(getMember, Data, memberName)) } ~ memberName ~ q{ (typeof(__traits(getMember, Data, memberName)) value) {
if(sessionId is null)
start();
import std.conv;
import std.traits;
BasicDataServer.connection.setSessionData(sessionId, fullyQualifiedName!Data ~ "." ~ memberName, to!string(value));
return value;
}
});
}
/++
A mock object that works like the real session, but doesn't actually interact with any actual database or http connection.
Simply stores the data in its instance members.
+/
class MockSession(Data) : Session!Data {
pure {
@property string sessionId() const { return "mock"; }
void start(int idleLifetime = 2600 * 24, bool useExtendedLifetimeCookie = false) {}
void regenerateId() {}
void terminate() {}
private Data store_;
static foreach(memberName; __traits(allMembers, Data))
static if(is(typeof(__traits(getMember, Data, memberName))))
mixin(q{
@property inout(typeof(__traits(getMember, Data, memberName))) } ~ memberName ~ q{ () inout {
return __traits(getMember, store_, memberName);
}
@property typeof(__traits(getMember, Data, memberName)) } ~ memberName ~ q{ (typeof(__traits(getMember, Data, memberName)) value) {
return __traits(getMember, store_, memberName) = value;
}
});
}
}
/++
Direct interface to the basic data add-on server. You can
typically use [Cgi.getSessionObject] as a more convenient interface.
+/
version(with_addon_servers_connections)
interface BasicDataServer {
///
void createSession(string sessionId, int lifetime);
///
void renewSession(string sessionId, int lifetime);
///
void destroySession(string sessionId);
///
void renameSession(string oldSessionId, string newSessionId);
///
void setSessionData(string sessionId, string dataKey, string dataValue);
///
string getSessionData(string sessionId, string dataKey);
///
static BasicDataServerConnection connection() {
return BasicDataServerConnection.connection();
}
}
version(with_addon_servers_connections)
class BasicDataServerConnection : BasicDataServer {
mixin ImplementRpcClientInterface!(BasicDataServer, "/tmp/arsd_session_server", "--session-server");
}
version(with_addon_servers)
final class BasicDataServerImplementation : BasicDataServer, EventIoServer {
void createSession(string sessionId, int lifetime) {
sessions[sessionId.idup] = Session(lifetime);
}
void destroySession(string sessionId) {
sessions.remove(sessionId);
}
void renewSession(string sessionId, int lifetime) {
sessions[sessionId].lifetime = lifetime;
}
void renameSession(string oldSessionId, string newSessionId) {
sessions[newSessionId.idup] = sessions[oldSessionId];
sessions.remove(oldSessionId);
}
void setSessionData(string sessionId, string dataKey, string dataValue) {
if(sessionId !in sessions)
createSession(sessionId, 3600); // FIXME?
sessions[sessionId].values[dataKey.idup] = dataValue.idup;
}
string getSessionData(string sessionId, string dataKey) {
if(auto session = sessionId in sessions) {
if(auto data = dataKey in (*session).values)
return *data;
else
return null; // no such data
} else {
return null; // no session
}
}
protected:
struct Session {
int lifetime;
string[string] values;
}
Session[string] sessions;
bool handleLocalConnectionData(IoOp* op, int receivedFd) {
auto data = op.usedBuffer;
dispatchRpcServer!BasicDataServer(this, data, op.fd);
return false;
}
void handleLocalConnectionClose(IoOp* op) {} // doesn't really matter, this is a fairly stateless go
void handleLocalConnectionComplete(IoOp* op) {} // again, irrelevant
void wait_timeout() {}
void fileClosed(int fd) {} // stateless so irrelevant
void epoll_fd(int fd) {}
}
/++
See [schedule] to make one of these. You then call one of the methods here to set it up:
---
schedule!fn(args).at(DateTime(2019, 8, 7, 12, 00, 00)); // run the function at August 7, 2019, 12 noon UTC
schedule!fn(args).delay(6.seconds); // run it after waiting 6 seconds
schedule!fn(args).asap(); // run it in the background as soon as the event loop gets around to it
---
+/
version(with_addon_servers_connections)
struct ScheduledJobHelper {
private string func;
private string[] args;
private bool consumed;
private this(string func, string[] args) {
this.func = func;
this.args = args;
}
~this() {
assert(consumed);
}
/++
Schedules the job to be run at the given time.
+/
void at(DateTime when, immutable TimeZone timezone = UTC()) {
consumed = true;
auto conn = ScheduledJobServerConnection.connection;
import std.file;
auto st = SysTime(when, timezone);
auto jobId = conn.scheduleJob(1, cast(int) st.toUnixTime(), thisExePath, func, args);
}
/++
Schedules the job to run at least after the specified delay.
+/
void delay(Duration delay) {
consumed = true;
auto conn = ScheduledJobServerConnection.connection;
import std.file;
auto jobId = conn.scheduleJob(0, cast(int) delay.total!"seconds", thisExePath, func, args);
}
/++
Runs the job in the background ASAP.
$(NOTE It may run in a background thread. Don't segfault!)
+/
void asap() {
consumed = true;
auto conn = ScheduledJobServerConnection.connection;
import std.file;
auto jobId = conn.scheduleJob(0, 1, thisExePath, func, args);
}
/+
/++
Schedules the job to recur on the given pattern.
+/
void recur(string spec) {
}
+/
}
/++
First step to schedule a job on the scheduled job server.
The scheduled job needs to be a top-level function that doesn't read any
variables from outside its arguments because it may be run in a new process,
without any context existing later.
You MUST set details on the returned object to actually do anything!
+/
template schedule(alias fn, T...) if(is(typeof(fn) == function)) {
///
ScheduledJobHelper schedule(T args) {
// this isn't meant to ever be called, but instead just to
// get the compiler to type check the arguments passed for us
auto sample = delegate() {
fn(args);
};
string[] sargs;
foreach(arg; args)
sargs ~= to!string(arg);
return ScheduledJobHelper(fn.mangleof, sargs);
}
shared static this() {
scheduledJobHandlers[fn.mangleof] = delegate(string[] sargs) {
import std.traits;
Parameters!fn args;
foreach(idx, ref arg; args)
arg = to!(typeof(arg))(sargs[idx]);
fn(args);
};
}
}
///
interface ScheduledJobServer {
/// Use the [schedule] function for a higher-level interface.
int scheduleJob(int whenIs, int when, string executable, string func, string[] args);
///
void cancelJob(int jobId);
}
version(with_addon_servers_connections)
class ScheduledJobServerConnection : ScheduledJobServer {
mixin ImplementRpcClientInterface!(ScheduledJobServer, "/tmp/arsd_scheduled_job_server", "--timer-server");
}
version(with_addon_servers)
final class ScheduledJobServerImplementation : ScheduledJobServer, EventIoServer {
// FIXME: we need to handle SIGCHLD in this somehow
// whenIs is 0 for relative, 1 for absolute
protected int scheduleJob(int whenIs, int when, string executable, string func, string[] args) {
auto nj = nextJobId;
nextJobId++;
version(linux) {
import core.sys.linux.timerfd;
import core.sys.linux.epoll;
import core.sys.posix.unistd;
auto fd = timerfd_create(CLOCK_REALTIME, TFD_NONBLOCK | TFD_CLOEXEC);
if(fd == -1)
throw new Exception("fd timer create failed");
foreach(ref arg; args)
arg = arg.idup;
auto job = Job(executable.idup, func.idup, .dup(args), fd, nj);
itimerspec value;
value.it_value.tv_sec = when;
value.it_value.tv_nsec = 0;
value.it_interval.tv_sec = 0;
value.it_interval.tv_nsec = 0;
if(timerfd_settime(fd, whenIs == 1 ? TFD_TIMER_ABSTIME : 0, &value, null) == -1)
throw new Exception("couldn't set fd timer");
auto op = allocateIoOp(fd, IoOp.Read, 16, (IoOp* op, int fd) {
jobs.remove(nj);
epoll_ctl(epoll_fd, EPOLL_CTL_DEL, fd, null);
close(fd);
spawnProcess([job.executable, "--timed-job", job.func] ~ job.args);
return true;
});
scope(failure)
freeIoOp(op);
epoll_event ev;
ev.events = EPOLLIN | EPOLLET;
ev.data.ptr = op;
if(epoll_ctl(epoll_fd, EPOLL_CTL_ADD, fd, &ev) == -1)
throw new Exception("epoll_ctl " ~ to!string(errno));
jobs[nj] = job;
return nj;
} else assert(0);
}
protected void cancelJob(int jobId) {
version(linux) {
auto job = jobId in jobs;
if(job is null)
return;
jobs.remove(jobId);
version(linux) {
import core.sys.linux.timerfd;
import core.sys.linux.epoll;
import core.sys.posix.unistd;
epoll_ctl(epoll_fd, EPOLL_CTL_DEL, job.timerfd, null);
close(job.timerfd);
}
}
jobs.remove(jobId);
}
int nextJobId = 1;
static struct Job {
string executable;
string func;
string[] args;
int timerfd;
int id;
}
Job[int] jobs;
// event io server methods below
bool handleLocalConnectionData(IoOp* op, int receivedFd) {
auto data = op.usedBuffer;
dispatchRpcServer!ScheduledJobServer(this, data, op.fd);
return false;
}
void handleLocalConnectionClose(IoOp* op) {} // doesn't really matter, this is a fairly stateless go
void handleLocalConnectionComplete(IoOp* op) {} // again, irrelevant
void wait_timeout() {}
void fileClosed(int fd) {} // stateless so irrelevant
int epoll_fd_;
void epoll_fd(int fd) {this.epoll_fd_ = fd; }
int epoll_fd() { return epoll_fd_; }
}
///
version(with_addon_servers_connections)
interface EventSourceServer {
/++
sends this cgi request to the event server so it will be fed events. You should not do anything else with the cgi object after this.
$(WARNING This API is extremely unstable. I might change it or remove it without notice.)
See_Also:
[sendEvent]
+/
public static void adoptConnection(Cgi cgi, in char[] eventUrl) {
/*
If lastEventId is missing or empty, you just get new events as they come.
If it is set from something else, it sends all since then (that are still alive)
down the pipe immediately.
The reason it can come from the header is that's what the standard defines for
browser reconnects. The reason it can come from a query string is just convenience
in catching up in a user-defined manner.
The reason the header overrides the query string is if the browser tries to reconnect,
it will send the header AND the query (it reconnects to the same url), so we just
want to do the restart thing.
Note that if you ask for "0" as the lastEventId, it will get ALL still living events.
*/
string lastEventId = cgi.lastEventId;
if(lastEventId.length == 0 && "lastEventId" in cgi.get)
lastEventId = cgi.get["lastEventId"];
cgi.setResponseContentType("text/event-stream");
cgi.write(":\n", false); // to initialize the chunking and send headers before keeping the fd for later
cgi.flush();
cgi.closed = true;
auto s = openLocalServerConnection("/tmp/arsd_cgi_event_server", "--event-server");
scope(exit)
closeLocalServerConnection(s);
version(fastcgi)
throw new Exception("sending fcgi connections not supported");
else {
auto fd = cgi.getOutputFileHandle();
if(isInvalidHandle(fd))
throw new Exception("bad fd from cgi!");
EventSourceServerImplementation.SendableEventConnection sec;
sec.populate(cgi.responseChunked, eventUrl, lastEventId);
version(Posix) {
auto res = write_fd(s, cast(void*) &sec, sec.sizeof, fd);
assert(res == sec.sizeof);
} else version(Windows) {
// FIXME
}
}
}
/++
Sends an event to the event server, starting it if necessary. The event server will distribute it to any listening clients, and store it for `lifetime` seconds for any later listening clients to catch up later.
$(WARNING This API is extremely unstable. I might change it or remove it without notice.)
Params:
url = A string identifying this event "bucket". Listening clients must also connect to this same string. I called it `url` because I envision it being just passed as the url of the request.
event = the event type string, which is used in the Javascript addEventListener API on EventSource
data = the event data. Available in JS as `event.data`.
lifetime = the amount of time to keep this event for replaying on the event server.
See_Also:
[sendEventToEventServer]
+/
public static void sendEvent(string url, string event, string data, int lifetime) {
auto s = openLocalServerConnection("/tmp/arsd_cgi_event_server", "--event-server");
scope(exit)
closeLocalServerConnection(s);
EventSourceServerImplementation.SendableEvent sev;
sev.populate(url, event, data, lifetime);
version(Posix) {
auto ret = send(s, &sev, sev.sizeof, 0);
assert(ret == sev.sizeof);
} else version(Windows) {
// FIXME
}
}
/++
Messages sent to `url` will also be sent to anyone listening on `forwardUrl`.
See_Also: [disconnect]
+/
void connect(string url, string forwardUrl);
/++
Disconnects `forwardUrl` from `url`
See_Also: [connect]
+/
void disconnect(string url, string forwardUrl);
}
///
version(with_addon_servers)
final class EventSourceServerImplementation : EventSourceServer, EventIoServer {
protected:
void connect(string url, string forwardUrl) {
pipes[url] ~= forwardUrl;
}
void disconnect(string url, string forwardUrl) {
auto t = url in pipes;
if(t is null)
return;
foreach(idx, n; (*t))
if(n == forwardUrl) {
(*t)[idx] = (*t)[$-1];
(*t) = (*t)[0 .. $-1];
break;
}
}
bool handleLocalConnectionData(IoOp* op, int receivedFd) {
if(receivedFd != -1) {
//writeln("GOT FD ", receivedFd, " -- ", op.usedBuffer);
//core.sys.posix.unistd.write(receivedFd, "hello".ptr, 5);
SendableEventConnection* got = cast(SendableEventConnection*) op.usedBuffer.ptr;
auto url = got.url.idup;
eventConnectionsByUrl[url] ~= EventConnection(receivedFd, got.responseChunked > 0 ? true : false);
// FIXME: catch up on past messages here
} else {
auto data = op.usedBuffer;
auto event = cast(SendableEvent*) data.ptr;
if(event.magic == 0xdeadbeef) {
handleInputEvent(event);
if(event.url in pipes)
foreach(pipe; pipes[event.url]) {
event.url = pipe;
handleInputEvent(event);
}
} else {
dispatchRpcServer!EventSourceServer(this, data, op.fd);
}
}
return false;
}
void handleLocalConnectionClose(IoOp* op) {
fileClosed(op.fd);
}
void handleLocalConnectionComplete(IoOp* op) {}
void wait_timeout() {
// just keeping alive
foreach(url, connections; eventConnectionsByUrl)
foreach(connection; connections)
if(connection.needsChunking)
nonBlockingWrite(this, connection.fd, "1b\r\nevent: keepalive\ndata: ok\n\n\r\n");
else
nonBlockingWrite(this, connection.fd, "event: keepalive\ndata: ok\n\n\r\n");
}
void fileClosed(int fd) {
outer: foreach(url, ref connections; eventConnectionsByUrl) {
foreach(idx, conn; connections) {
if(fd == conn.fd) {
connections[idx] = connections[$-1];
connections = connections[0 .. $ - 1];
continue outer;
}
}
}
}
void epoll_fd(int fd) {}
private:
struct SendableEventConnection {
ubyte responseChunked;
int urlLength;
char[256] urlBuffer = 0;
int lastEventIdLength;
char[32] lastEventIdBuffer = 0;
char[] url() return {
return urlBuffer[0 .. urlLength];
}
void url(in char[] u) {
urlBuffer[0 .. u.length] = u[];
urlLength = cast(int) u.length;
}
char[] lastEventId() return {
return lastEventIdBuffer[0 .. lastEventIdLength];
}
void populate(bool responseChunked, in char[] url, in char[] lastEventId)
in {
assert(url.length < this.urlBuffer.length);
assert(lastEventId.length < this.lastEventIdBuffer.length);
}
do {
this.responseChunked = responseChunked ? 1 : 0;
this.urlLength = cast(int) url.length;
this.lastEventIdLength = cast(int) lastEventId.length;
this.urlBuffer[0 .. url.length] = url[];
this.lastEventIdBuffer[0 .. lastEventId.length] = lastEventId[];
}
}
struct SendableEvent {
int magic = 0xdeadbeef;
int urlLength;
char[256] urlBuffer = 0;
int typeLength;
char[32] typeBuffer = 0;
int messageLength;
char[2048 * 4] messageBuffer = 0; // this is an arbitrary limit, it needs to fit comfortably in stack (including in a fiber) and be a single send on the kernel side cuz of the impl... i think this is ok for a unix socket.
int _lifetime;
char[] message() return {
return messageBuffer[0 .. messageLength];
}
char[] type() return {
return typeBuffer[0 .. typeLength];
}
char[] url() return {
return urlBuffer[0 .. urlLength];
}
void url(in char[] u) {
urlBuffer[0 .. u.length] = u[];
urlLength = cast(int) u.length;
}
int lifetime() {
return _lifetime;
}
///
void populate(string url, string type, string message, int lifetime)
in {
assert(url.length < this.urlBuffer.length);
assert(type.length < this.typeBuffer.length);
assert(message.length < this.messageBuffer.length);
}
do {
this.urlLength = cast(int) url.length;
this.typeLength = cast(int) type.length;
this.messageLength = cast(int) message.length;
this._lifetime = lifetime;
this.urlBuffer[0 .. url.length] = url[];
this.typeBuffer[0 .. type.length] = type[];
this.messageBuffer[0 .. message.length] = message[];
}
}
struct EventConnection {
int fd;
bool needsChunking;
}
private EventConnection[][string] eventConnectionsByUrl;
private string[][string] pipes;
private void handleInputEvent(scope SendableEvent* event) {
static int eventId;
static struct StoredEvent {
int id;
string type;
string message;
int lifetimeRemaining;
}
StoredEvent[][string] byUrl;
int thisId = ++eventId;
if(event.lifetime)
byUrl[event.url.idup] ~= StoredEvent(thisId, event.type.idup, event.message.idup, event.lifetime);
auto connectionsPtr = event.url in eventConnectionsByUrl;
EventConnection[] connections;
if(connectionsPtr is null)
return;
else
connections = *connectionsPtr;
char[4096] buffer;
char[] formattedMessage;
void append(const char[] a) {
// the 6's here are to leave room for a HTTP chunk header, if it proves necessary
buffer[6 + formattedMessage.length .. 6 + formattedMessage.length + a.length] = a[];
formattedMessage = buffer[6 .. 6 + formattedMessage.length + a.length];
}
import std.algorithm.iteration;
if(connections.length) {
append("id: ");
append(to!string(thisId));
append("\n");
append("event: ");
append(event.type);
append("\n");
foreach(line; event.message.splitter("\n")) {
append("data: ");
append(line);
append("\n");
}
append("\n");
}
// chunk it for HTTP!
auto len = toHex(formattedMessage.length);
buffer[4 .. 6] = "\r\n"[];
buffer[4 - len.length .. 4] = len[];
buffer[6 + formattedMessage.length] = '\r';
buffer[6 + formattedMessage.length + 1] = '\n';
auto chunkedMessage = buffer[4 - len.length .. 6 + formattedMessage.length +2];
// done
// FIXME: send back requests when needed
// FIXME: send a single ":\n" every 15 seconds to keep alive
foreach(connection; connections) {
if(connection.needsChunking) {
nonBlockingWrite(this, connection.fd, chunkedMessage);
} else {
nonBlockingWrite(this, connection.fd, formattedMessage);
}
}
}
}
void runAddonServer(EIS)(string localListenerName, EIS eis) if(is(EIS : EventIoServer)) {
version(Posix) {
import core.sys.posix.unistd;
import core.sys.posix.fcntl;
import core.sys.posix.sys.un;
import core.sys.posix.signal;
signal(SIGPIPE, SIG_IGN);
static extern(C) void sigchldhandler(int) {
int status;
import w = core.sys.posix.sys.wait;
w.wait(&status);
}
signal(SIGCHLD, &sigchldhandler);
int sock = socket(AF_UNIX, SOCK_STREAM, 0);
if(sock == -1)
throw new Exception("socket " ~ to!string(errno));
scope(failure)
close(sock);
cloexec(sock);
// add-on server processes are assumed to be local, and thus will
// use unix domain sockets. Besides, I want to pass sockets to them,
// so it basically must be local (except for the session server, but meh).
sockaddr_un addr;
addr.sun_family = AF_UNIX;
version(linux) {
// on linux, we will use the abstract namespace
addr.sun_path[0] = 0;
addr.sun_path[1 .. localListenerName.length + 1] = cast(typeof(addr.sun_path[])) localListenerName[];
} else {
// but otherwise, just use a file cuz we must.
addr.sun_path[0 .. localListenerName.length] = cast(typeof(addr.sun_path[])) localListenerName[];
}
if(bind(sock, cast(sockaddr*) &addr, addr.sizeof) == -1)
throw new Exception("bind " ~ to!string(errno));
if(listen(sock, 128) == -1)
throw new Exception("listen " ~ to!string(errno));
makeNonBlocking(sock);
version(linux) {
import core.sys.linux.epoll;
auto epoll_fd = epoll_create1(EPOLL_CLOEXEC);
if(epoll_fd == -1)
throw new Exception("epoll_create1 " ~ to!string(errno));
scope(failure)
close(epoll_fd);
} else {
import core.sys.posix.poll;
}
version(linux)
eis.epoll_fd = epoll_fd;
auto acceptOp = allocateIoOp(sock, IoOp.Read, 0, null);
scope(exit)
freeIoOp(acceptOp);
version(linux) {
epoll_event ev;
ev.events = EPOLLIN | EPOLLET;
ev.data.ptr = acceptOp;
if(epoll_ctl(epoll_fd, EPOLL_CTL_ADD, sock, &ev) == -1)
throw new Exception("epoll_ctl " ~ to!string(errno));
epoll_event[64] events;
} else {
pollfd[] pollfds;
IoOp*[int] ioops;
pollfds ~= pollfd(sock, POLLIN);
ioops[sock] = acceptOp;
}
import core.time : MonoTime, seconds;
MonoTime timeout = MonoTime.currTime + 15.seconds;
while(true) {
// FIXME: it should actually do a timerfd that runs on any thing that hasn't been run recently
int timeout_milliseconds = 0; // -1; // infinite
timeout_milliseconds = cast(int) (timeout - MonoTime.currTime).total!"msecs";
if(timeout_milliseconds < 0)
timeout_milliseconds = 0;
//writeln("waiting for ", name);
version(linux) {
auto nfds = epoll_wait(epoll_fd, events.ptr, events.length, timeout_milliseconds);
if(nfds == -1) {
if(errno == EINTR)
continue;
throw new Exception("epoll_wait " ~ to!string(errno));
}
} else {
int nfds = poll(pollfds.ptr, cast(int) pollfds.length, timeout_milliseconds);
size_t lastIdx = 0;
}
if(nfds == 0) {
eis.wait_timeout();
timeout += 15.seconds;
}
foreach(idx; 0 .. nfds) {
version(linux) {
auto flags = events[idx].events;
auto ioop = cast(IoOp*) events[idx].data.ptr;
} else {
IoOp* ioop;
foreach(tidx, thing; pollfds[lastIdx .. $]) {
if(thing.revents) {
ioop = ioops[thing.fd];
lastIdx += tidx + 1;
break;
}
}
}
//writeln(flags, " ", ioop.fd);
void newConnection() {
// on edge triggering, it is important that we get it all
while(true) {
auto size = cast(socklen_t) addr.sizeof;
auto ns = accept(sock, cast(sockaddr*) &addr, &size);
if(ns == -1) {
if(errno == EAGAIN || errno == EWOULDBLOCK) {
// all done, got it all
break;
}
throw new Exception("accept " ~ to!string(errno));
}
cloexec(ns);
makeNonBlocking(ns);
auto niop = allocateIoOp(ns, IoOp.ReadSocketHandle, 4096 * 4, &eis.handleLocalConnectionData);
niop.closeHandler = &eis.handleLocalConnectionClose;
niop.completeHandler = &eis.handleLocalConnectionComplete;
scope(failure) freeIoOp(niop);
version(linux) {
epoll_event nev;
nev.events = EPOLLIN | EPOLLET;
nev.data.ptr = niop;
if(epoll_ctl(epoll_fd, EPOLL_CTL_ADD, ns, &nev) == -1)
throw new Exception("epoll_ctl " ~ to!string(errno));
} else {
bool found = false;
foreach(ref pfd; pollfds) {
if(pfd.fd < 0) {
pfd.fd = ns;
found = true;
}
}
if(!found)
pollfds ~= pollfd(ns, POLLIN);
ioops[ns] = niop;
}
}
}
bool newConnectionCondition() {
version(linux)
return ioop.fd == sock && (flags & EPOLLIN);
else
return pollfds[idx].fd == sock && (pollfds[idx].revents & POLLIN);
}
if(newConnectionCondition()) {
newConnection();
} else if(ioop.operation == IoOp.ReadSocketHandle) {
while(true) {
int in_fd;
auto got = read_fd(ioop.fd, ioop.allocatedBuffer.ptr, ioop.allocatedBuffer.length, &in_fd);
if(got == -1) {
if(errno == EAGAIN || errno == EWOULDBLOCK) {
// all done, got it all
if(ioop.completeHandler)
ioop.completeHandler(ioop);
break;
}
throw new Exception("recv " ~ to!string(errno));
}
if(got == 0) {
if(ioop.closeHandler) {
ioop.closeHandler(ioop);
version(linux) {} // nothing needed
else {
foreach(ref pfd; pollfds) {
if(pfd.fd == ioop.fd)
pfd.fd = -1;
}
}
}
close(ioop.fd);
freeIoOp(ioop);
break;
}
ioop.bufferLengthUsed = cast(int) got;
ioop.handler(ioop, in_fd);
}
} else if(ioop.operation == IoOp.Read) {
while(true) {
auto got = read(ioop.fd, ioop.allocatedBuffer.ptr, ioop.allocatedBuffer.length);
if(got == -1) {
if(errno == EAGAIN || errno == EWOULDBLOCK) {
// all done, got it all
if(ioop.completeHandler)
ioop.completeHandler(ioop);
break;
}
throw new Exception("recv " ~ to!string(ioop.fd) ~ " errno " ~ to!string(errno));
}
if(got == 0) {
if(ioop.closeHandler)
ioop.closeHandler(ioop);
close(ioop.fd);
freeIoOp(ioop);
break;
}
ioop.bufferLengthUsed = cast(int) got;
if(ioop.handler(ioop, ioop.fd)) {
close(ioop.fd);
freeIoOp(ioop);
break;
}
}
}
// EPOLLHUP?
}
}
} else version(Windows) {
// set up a named pipe
// https://msdn.microsoft.com/en-us/library/windows/desktop/ms724251(v=vs.85).aspx
// https://docs.microsoft.com/en-us/windows/desktop/api/winsock2/nf-winsock2-wsaduplicatesocketw
// https://docs.microsoft.com/en-us/windows/desktop/api/winbase/nf-winbase-getnamedpipeserverprocessid
} else static assert(0);
}
version(with_sendfd)
// copied from the web and ported from C
// see https://stackoverflow.com/questions/2358684/can-i-share-a-file-descriptor-to-another-process-on-linux-or-are-they-local-to-t
ssize_t write_fd(int fd, void *ptr, size_t nbytes, int sendfd) {
msghdr msg;
iovec[1] iov;
version(OSX) {
//msg.msg_accrights = cast(cattr_t) &sendfd;
//msg.msg_accrightslen = int.sizeof;
} else version(Android) {
} else {
union ControlUnion {
cmsghdr cm;
char[CMSG_SPACE(int.sizeof)] control;
}
ControlUnion control_un;
cmsghdr* cmptr;
msg.msg_control = control_un.control.ptr;
msg.msg_controllen = control_un.control.length;
cmptr = CMSG_FIRSTHDR(&msg);
cmptr.cmsg_len = CMSG_LEN(int.sizeof);
cmptr.cmsg_level = SOL_SOCKET;
cmptr.cmsg_type = SCM_RIGHTS;
*(cast(int *) CMSG_DATA(cmptr)) = sendfd;
}
msg.msg_name = null;
msg.msg_namelen = 0;
iov[0].iov_base = ptr;
iov[0].iov_len = nbytes;
msg.msg_iov = iov.ptr;
msg.msg_iovlen = 1;
return sendmsg(fd, &msg, 0);
}
version(with_sendfd)
// copied from the web and ported from C
ssize_t read_fd(int fd, void *ptr, size_t nbytes, int *recvfd) {
msghdr msg;
iovec[1] iov;
ssize_t n;
int newfd;
version(OSX) {
//msg.msg_accrights = cast(cattr_t) recvfd;
//msg.msg_accrightslen = int.sizeof;
} else version(Android) {
} else {
union ControlUnion {
cmsghdr cm;
char[CMSG_SPACE(int.sizeof)] control;
}
ControlUnion control_un;
cmsghdr* cmptr;
msg.msg_control = control_un.control.ptr;
msg.msg_controllen = control_un.control.length;
}
msg.msg_name = null;
msg.msg_namelen = 0;
iov[0].iov_base = ptr;
iov[0].iov_len = nbytes;
msg.msg_iov = iov.ptr;
msg.msg_iovlen = 1;
if ( (n = recvmsg(fd, &msg, 0)) <= 0)
return n;
version(OSX) {
//if(msg.msg_accrightslen != int.sizeof)
//*recvfd = -1;
} else version(Android) {
} else {
if ( (cmptr = CMSG_FIRSTHDR(&msg)) != null &&
cmptr.cmsg_len == CMSG_LEN(int.sizeof)) {
if (cmptr.cmsg_level != SOL_SOCKET)
throw new Exception("control level != SOL_SOCKET");
if (cmptr.cmsg_type != SCM_RIGHTS)
throw new Exception("control type != SCM_RIGHTS");
*recvfd = *(cast(int *) CMSG_DATA(cmptr));
} else
*recvfd = -1; /* descriptor was not passed */
}
return n;
}
/* end read_fd */
/*
Event source stuff
The api is:
sendEvent(string url, string type, string data, int timeout = 60*10);
attachEventListener(string url, int fd, lastId)
It just sends to all attached listeners, and stores it until the timeout
for replaying via lastEventId.
*/
/*
Session process stuff
it stores it all. the cgi object has a session object that can grab it
session may be done in the same process if possible, there is a version
switch to choose if you want to override.
*/
struct DispatcherDefinition(alias dispatchHandler, DispatcherDetails = typeof(null)) {// if(is(typeof(dispatchHandler("str", Cgi.init, void) == bool))) { // bool delegate(string urlPrefix, Cgi cgi) dispatchHandler;
alias handler = dispatchHandler;
string urlPrefix;
bool rejectFurther;
immutable(DispatcherDetails) details;
}
private string urlify(string name) pure {
return beautify(name, '-', true);
}
private string beautify(string name, char space = ' ', bool allLowerCase = false) pure {
if(name == "id")
return allLowerCase ? name : "ID";
char[160] buffer;
int bufferIndex = 0;
bool shouldCap = true;
bool shouldSpace;
bool lastWasCap;
foreach(idx, char ch; name) {
if(bufferIndex == buffer.length) return name; // out of space, just give up, not that important
if((ch >= 'A' && ch <= 'Z') || ch == '_') {
if(lastWasCap) {
// two caps in a row, don't change. Prolly acronym.
} else {
if(idx)
shouldSpace = true; // new word, add space
}
lastWasCap = true;
} else {
lastWasCap = false;
}
if(shouldSpace) {
buffer[bufferIndex++] = space;
if(bufferIndex == buffer.length) return name; // out of space, just give up, not that important
shouldSpace = false;
}
if(shouldCap) {
if(ch >= 'a' && ch <= 'z')
ch -= 32;
shouldCap = false;
}
if(allLowerCase && ch >= 'A' && ch <= 'Z')
ch += 32;
buffer[bufferIndex++] = ch;
}
return buffer[0 .. bufferIndex].idup;
}
/*
string urlFor(alias func)() {
return __traits(identifier, func);
}
*/
/++
UDA: The name displayed to the user in auto-generated HTML.
Default is `beautify(identifier)`.
+/
struct DisplayName {
string name;
}
/++
UDA: The name used in the URL or web parameter.
Default is `urlify(identifier)` for functions and `identifier` for parameters and data members.
+/
struct UrlName {
string name;
}
/++
UDA: default format to respond for this method
+/
struct DefaultFormat { string value; }
class MissingArgumentException : Exception {
string functionName;
string argumentName;
string argumentType;
this(string functionName, string argumentName, string argumentType, string file = __FILE__, size_t line = __LINE__, Throwable next = null) {
this.functionName = functionName;
this.argumentName = argumentName;
this.argumentType = argumentType;
super("Missing Argument: " ~ this.argumentName, file, line, next);
}
}
/++
You can throw this from an api handler to indicate a 404 response. This is done by the presentExceptionAsHtml function in the presenter.
History:
Added December 15, 2021 (dub v10.5)
+/
class ResourceNotFoundException : Exception {
string resourceType;
string resourceId;
this(string resourceType, string resourceId, string file = __FILE__, size_t line = __LINE__, Throwable next = null) {
this.resourceType = resourceType;
this.resourceId = resourceId;
super("Resource not found: " ~ resourceType ~ " " ~ resourceId, file, line, next);
}
}
/++
This can be attached to any constructor or function called from the cgi system.
If it is present, the function argument can NOT be set from web params, but instead
is set to the return value of the given `func`.
If `func` can take a parameter of type [Cgi], it will be passed the one representing
the current request. Otherwise, it must take zero arguments.
Any params in your function of type `Cgi` are automatically assumed to take the cgi object
for the connection. Any of type [Session] (with an argument) is also assumed to come from
the cgi object.
const arguments are also supported.
+/
struct ifCalledFromWeb(alias func) {}
// it only looks at query params for GET requests, the rest must be in the body for a function argument.
auto callFromCgi(alias method, T)(T dg, Cgi cgi) {
// FIXME: any array of structs should also be settable or gettable from csv as well.
// FIXME: think more about checkboxes and bools.
import std.traits;
Parameters!method params;
alias idents = ParameterIdentifierTuple!method;
alias defaults = ParameterDefaults!method;
const(string)[] names;
const(string)[] values;
// first, check for missing arguments and initialize to defaults if necessary
static if(is(typeof(method) P == __parameters))
foreach(idx, param; P) {{
// see: mustNotBeSetFromWebParams
static if(is(param : Cgi)) {
static assert(!is(param == immutable));
cast() params[idx] = cgi;
} else static if(is(param == Session!D, D)) {
static assert(!is(param == immutable));
cast() params[idx] = cgi.getSessionObject!D();
} else {
bool populated;
foreach(uda; __traits(getAttributes, P[idx .. idx + 1])) {
static if(is(uda == ifCalledFromWeb!func, alias func)) {
static if(is(typeof(func(cgi))))
params[idx] = func(cgi);
else
params[idx] = func();
populated = true;
}
}
if(!populated) {
static if(__traits(compiles, { params[idx] = param.getAutomaticallyForCgi(cgi); } )) {
params[idx] = param.getAutomaticallyForCgi(cgi);
populated = true;
}
}
if(!populated) {
auto ident = idents[idx];
if(cgi.requestMethod == Cgi.RequestMethod.GET) {
if(ident !in cgi.get) {
static if(is(defaults[idx] == void)) {
static if(is(param == bool))
params[idx] = false;
else
throw new MissingArgumentException(__traits(identifier, method), ident, param.stringof);
} else
params[idx] = defaults[idx];
}
} else {
if(ident !in cgi.post) {
static if(is(defaults[idx] == void)) {
static if(is(param == bool))
params[idx] = false;
else
throw new MissingArgumentException(__traits(identifier, method), ident, param.stringof);
} else
params[idx] = defaults[idx];
}
}
}
}
}}
// second, parse the arguments in order to build up arrays, etc.
static bool setVariable(T)(string name, string paramName, T* what, string value) {
static if(is(T == struct)) {
if(name == paramName) {
*what = T.init;
return true;
} else {
// could be a child. gonna allow either obj.field OR obj[field]
string afterName;
if(name[paramName.length] == '[') {
int count = 1;
auto idx = paramName.length + 1;
while(idx < name.length && count > 0) {
if(name[idx] == '[')
count++;
else if(name[idx] == ']') {
count--;
if(count == 0) break;
}
idx++;
}
if(idx == name.length)
return false; // malformed
auto insideBrackets = name[paramName.length + 1 .. idx];
afterName = name[idx + 1 .. $];
name = name[0 .. paramName.length];
paramName = insideBrackets;
} else if(name[paramName.length] == '.') {
paramName = name[paramName.length + 1 .. $];
name = paramName;
int p = 0;
foreach(ch; paramName) {
if(ch == '.' || ch == '[')
break;
p++;
}
afterName = paramName[p .. $];
paramName = paramName[0 .. p];
} else {
return false;
}
if(paramName.length)
// set the child member
switch(paramName) {
foreach(idx, memberName; __traits(allMembers, T))
static if(__traits(compiles, __traits(getMember, T, memberName).offsetof)) {
// data member!
case memberName:
return setVariable(name ~ afterName, paramName, &(__traits(getMember, *what, memberName)), value);
}
default:
// ok, not a member
}
}
return false;
} else static if(is(T == enum)) {
*what = to!T(value);
return true;
} else static if(isSomeString!T || isIntegral!T || isFloatingPoint!T) {
*what = to!T(value);
return true;
} else static if(is(T == bool)) {
*what = value == "1" || value == "yes" || value == "t" || value == "true" || value == "on";
return true;
} else static if(is(T == K[], K)) {
K tmp;
if(name == paramName) {
// direct - set and append
if(setVariable(name, paramName, &tmp, value)) {
(*what) ~= tmp;
return true;
} else {
return false;
}
} else {
// child, append to last element
// FIXME: what about range violations???
auto ptr = &(*what)[(*what).length - 1];
return setVariable(name, paramName, ptr, value);
}
} else static if(is(T == V[K], K, V)) {
// assoc array, name[key] is valid
if(name == paramName) {
// no action necessary
return true;
} else if(name[paramName.length] == '[') {
int count = 1;
auto idx = paramName.length + 1;
while(idx < name.length && count > 0) {
if(name[idx] == '[')
count++;
else if(name[idx] == ']') {
count--;
if(count == 0) break;
}
idx++;
}
if(idx == name.length)
return false; // malformed
auto insideBrackets = name[paramName.length + 1 .. idx];
auto afterName = name[idx + 1 .. $];
auto k = to!K(insideBrackets);
V v;
if(auto ptr = k in *what)
v = *ptr;
name = name[0 .. paramName.length];
//writeln(name, afterName, " ", paramName);
auto ret = setVariable(name ~ afterName, paramName, &v, value);
if(ret) {
(*what)[k] = v;
return true;
}
}
return false;
} else {
static assert(0, "unsupported type for cgi call " ~ T.stringof);
}
//return false;
}
void setArgument(string name, string value) {
int p;
foreach(ch; name) {
if(ch == '.' || ch == '[')
break;
p++;
}
auto paramName = name[0 .. p];
sw: switch(paramName) {
static if(is(typeof(method) P == __parameters))
foreach(idx, param; P) {
static if(mustNotBeSetFromWebParams!(P[idx], __traits(getAttributes, P[idx .. idx + 1]))) {
// cannot be set from the outside
} else {
case idents[idx]:
static if(is(param == Cgi.UploadedFile)) {
params[idx] = cgi.files[name];
} else static if(is(param : const Cgi.UploadedFile[])) {
(cast() params[idx]) = cgi.filesArray[name];
} else {
setVariable(name, paramName, ¶ms[idx], value);
}
break sw;
}
}
default:
// ignore; not relevant argument
}
}
if(cgi.requestMethod == Cgi.RequestMethod.GET) {
names = cgi.allGetNamesInOrder;
values = cgi.allGetValuesInOrder;
} else {
names = cgi.allPostNamesInOrder;
values = cgi.allPostValuesInOrder;
}
foreach(idx, name; names) {
setArgument(name, values[idx]);
}
static if(is(ReturnType!method == void)) {
typeof(null) ret;
dg(params);
} else {
auto ret = dg(params);
}
// FIXME: format return values
// options are: json, html, csv.
// also may need to wrap in envelope format: none, html, or json.
return ret;
}
private bool mustNotBeSetFromWebParams(T, attrs...)() {
static if(is(T : const(Cgi))) {
return true;
} else static if(is(T : const(Session!D), D)) {
return true;
} else static if(__traits(compiles, T.getAutomaticallyForCgi(Cgi.init))) {
return true;
} else {
foreach(uda; attrs)
static if(is(uda == ifCalledFromWeb!func, alias func))
return true;
return false;
}
}
private bool hasIfCalledFromWeb(attrs...)() {
foreach(uda; attrs)
static if(is(uda == ifCalledFromWeb!func, alias func))
return true;
return false;
}
/++
Implies POST path for the thing itself, then GET will get the automatic form.
The given customizer, if present, will be called as a filter on the Form object.
History:
Added December 27, 2020
+/
template AutomaticForm(alias customizer) { }
/++
This is meant to be returned by a function that takes a form POST submission. You
want to set the url of the new resource it created, which is set as the http
Location header for a "201 Created" result, and you can also set a separate
destination for browser users, which it sets via a "Refresh" header.
The `resourceRepresentation` should generally be the thing you just created, and
it will be the body of the http response when formatted through the presenter.
The exact thing is up to you - it could just return an id, or the whole object, or
perhaps a partial object.
Examples:
---
class Test : WebObject {
@(Cgi.RequestMethod.POST)
CreatedResource!int makeThing(string value) {
return CreatedResource!int(value.to!int, "/resources/id");
}
}
---
History:
Added December 18, 2021
+/
struct CreatedResource(T) {
static if(!is(T == void))
T resourceRepresentation;
string resourceUrl;
string refreshUrl;
}
/+
/++
This can be attached as a UDA to a handler to add a http Refresh header on a
successful run. (It will not be attached if the function throws an exception.)
This will refresh the browser the given number of seconds after the page loads,
to the url returned by `urlFunc`, which can be either a static function or a
member method of the current handler object.
You might use this for a POST handler that is normally used from ajax, but you
want it to degrade gracefully to a temporarily flashed message before reloading
the main page.
History:
Added December 18, 2021
+/
struct Refresh(alias urlFunc) {
int waitInSeconds;
string url() {
static if(__traits(isStaticFunction, urlFunc))
return urlFunc();
else static if(is(urlFunc : string))
return urlFunc;
}
}
+/
/+
/++
Sets a filter to be run before
A before function can do validations of params and log and stop the function from running.
+/
template Before(alias b) {}
template After(alias b) {}
+/
/+
Argument conversions: for the most part, it is to!Thing(string).
But arrays and structs are a bit different. Arrays come from the cgi array. Thus
they are passed
arr=foo&arr=bar <-- notice the same name.
Structs are first declared with an empty thing, then have their members set individually,
with dot notation. The members are not required, just the initial declaration.
struct Foo {
int a;
string b;
}
void test(Foo foo){}
foo&foo.a=5&foo.b=str <-- the first foo declares the arg, the others set the members
Arrays of structs use this declaration.
void test(Foo[] foo) {}
foo&foo.a=5&foo.b=bar&foo&foo.a=9
You can use a hidden input field in HTML forms to achieve this. The value of the naked name
declaration is ignored.
Mind that order matters! The declaration MUST come first in the string.
Arrays of struct members follow this rule recursively.
struct Foo {
int[] a;
}
foo&foo.a=1&foo.a=2&foo&foo.a=1
Associative arrays are formatted with brackets, after a declaration, like structs:
foo&foo[key]=value&foo[other_key]=value
Note: for maximum compatibility with outside code, keep your types simple. Some libraries
do not support the strict ordering requirements to work with these struct protocols.
FIXME: also perhaps accept application/json to better work with outside trash.
Return values are also auto-formatted according to user-requested type:
for json, it loops over and converts.
for html, basic types are strings. Arrays are <ol>. Structs are <dl>. Arrays of structs are tables!
+/
/++
A web presenter is responsible for rendering things to HTML to be usable
in a web browser.
They are passed as template arguments to the base classes of [WebObject]
Responsible for displaying stuff as HTML. You can put this into your own aggregate
and override it. Use forwarding and specialization to customize it.
When you inherit from it, pass your own class as the CRTP argument. This lets the base
class templates and your overridden templates work with each other.
---
class MyPresenter : WebPresenter!(MyPresenter) {
@Override
void presentSuccessfulReturnAsHtml(T : CustomType)(Cgi cgi, T ret, typeof(null) meta) {
// present the CustomType
}
@Override
void presentSuccessfulReturnAsHtml(T)(Cgi cgi, T ret, typeof(null) meta) {
// handle everything else via the super class, which will call
// back to your class when appropriate
super.presentSuccessfulReturnAsHtml(cgi, ret);
}
}
---
The meta argument in there can be overridden by your own facility.
+/
class WebPresenter(CRTP) {
/// A UDA version of the built-in `override`, to be used for static template polymorphism
/// If you override a plain method, use `override`. If a template, use `@Override`.
enum Override;
string script() {
return `
`;
}
string style() {
return `
:root {
--mild-border: #ccc;
--middle-border: #999;
--accent-color: #f2f2f2;
--sidebar-color: #fefefe;
}
` ~ genericFormStyling() ~ genericSiteStyling();
}
string genericFormStyling() {
return
q"css
table.automatic-data-display {
border-collapse: collapse;
border: solid 1px var(--mild-border);
}
table.automatic-data-display td {
vertical-align: top;
border: solid 1px var(--mild-border);
padding: 2px 4px;
}
table.automatic-data-display th {
border: solid 1px var(--mild-border);
border-bottom: solid 1px var(--middle-border);
padding: 2px 4px;
}
ol.automatic-data-display {
margin: 0px;
list-style-position: inside;
padding: 0px;
}
dl.automatic-data-display {
}
.automatic-form {
max-width: 600px;
}
.form-field {
margin: 0.5em;
padding-left: 0.5em;
}
.label-text {
display: block;
font-weight: bold;
margin-left: -0.5em;
}
.submit-button-holder {
padding-left: 2em;
}
.add-array-button {
}
css";
}
string genericSiteStyling() {
return
q"css
* { box-sizing: border-box; }
html, body { margin: 0px; }
body {
font-family: sans-serif;
}
header {
background: var(--accent-color);
height: 64px;
}
footer {
background: var(--accent-color);
height: 64px;
}
#site-container {
display: flex;
}
main {
flex: 1 1 auto;
order: 2;
min-height: calc(100vh - 64px - 64px);
padding: 4px;
padding-left: 1em;
}
#sidebar {
flex: 0 0 16em;
order: 1;
background: var(--sidebar-color);
}
css";
}
import arsd.dom;
Element htmlContainer() {
auto document = new Document(q"html
<!DOCTYPE html>
<html class="no-script">
<head>
<script>document.documentElement.classList.remove("no-script");</script>
<style>.no-script requires-script { display: none; }</style>
<title>D Application</title>
<meta name="viewport" content="initial-scale=1, width=device-width" />
<link rel="stylesheet" href="style.css" />
</head>
<body>
<header></header>
<div id="site-container">
<main></main>
<div id="sidebar"></div>
</div>
<footer></footer>
<script src="script.js"></script>
</body>
</html>
html", true, true);
return document.requireSelector("main");
}
/// Renders a response as an HTTP error with associated html body
void renderBasicError(Cgi cgi, int httpErrorCode) {
cgi.setResponseStatus(getHttpCodeText(httpErrorCode));
auto c = htmlContainer();
c.innerText = getHttpCodeText(httpErrorCode);
cgi.setResponseContentType("text/html; charset=utf-8");
cgi.write(c.parentDocument.toString(), true);
}
template methodMeta(alias method) {
enum methodMeta = null;
}
void presentSuccessfulReturn(T, Meta)(Cgi cgi, T ret, Meta meta, string format) {
switch(format) {
case "html":
(cast(CRTP) this).presentSuccessfulReturnAsHtml(cgi, ret, meta);
break;
case "json":
import arsd.jsvar;
static if(is(typeof(ret) == MultipleResponses!Types, Types...)) {
var json;
foreach(index, type; Types) {
if(ret.contains == index)
json = ret.payload[index];
}
} else {
var json = ret;
}
var envelope = json; // var.emptyObject;
/*
envelope.success = true;
envelope.result = json;
envelope.error = null;
*/
cgi.setResponseContentType("application/json");
cgi.write(envelope.toJson(), true);
break;
default:
cgi.setResponseStatus("406 Not Acceptable"); // not exactly but sort of.
}
}
/// typeof(null) (which is also used to represent functions returning `void`) do nothing
/// in the default presenter - allowing the function to have full low-level control over the
/// response.
void presentSuccessfulReturn(T : typeof(null), Meta)(Cgi cgi, T ret, Meta meta, string format) {
// nothing intentionally!
}
/// Redirections are forwarded to [Cgi.setResponseLocation]
void presentSuccessfulReturn(T : Redirection, Meta)(Cgi cgi, T ret, Meta meta, string format) {
cgi.setResponseLocation(ret.to, true, getHttpCodeText(ret.code));
}
/// [CreatedResource]s send code 201 and will set the given urls, then present the given representation.
void presentSuccessfulReturn(T : CreatedResource!R, Meta, R)(Cgi cgi, T ret, Meta meta, string format) {
cgi.setResponseStatus(getHttpCodeText(201));
if(ret.resourceUrl.length)
cgi.header("Location: " ~ ret.resourceUrl);
if(ret.refreshUrl.length)
cgi.header("Refresh: 0;" ~ ret.refreshUrl);
static if(!is(R == void))
presentSuccessfulReturn(cgi, ret.resourceRepresentation, meta, format);
}
/// Multiple responses deconstruct the algebraic type and forward to the appropriate handler at runtime
void presentSuccessfulReturn(T : MultipleResponses!Types, Meta, Types...)(Cgi cgi, T ret, Meta meta, string format) {
bool outputted = false;
foreach(index, type; Types) {
if(ret.contains == index) {
assert(!outputted);
outputted = true;
(cast(CRTP) this).presentSuccessfulReturn(cgi, ret.payload[index], meta, format);
}
}
if(!outputted)
assert(0);
}
/++
An instance of the [arsd.dom.FileResource] interface has its own content type; assume it is a download of some sort if the filename member is non-null of the FileResource interface.
+/
void presentSuccessfulReturn(T : FileResource, Meta)(Cgi cgi, T ret, Meta meta, string format) {
cgi.setCache(true); // not necessarily true but meh
if(auto fn = ret.filename()) {
cgi.header("Content-Disposition: attachment; filename="~fn~";");
}
cgi.setResponseContentType(ret.contentType);
cgi.write(ret.getData(), true);
}
/// And the default handler for HTML will call [formatReturnValueAsHtml] and place it inside the [htmlContainer].
void presentSuccessfulReturnAsHtml(T)(Cgi cgi, T ret, typeof(null) meta) {
auto container = this.htmlContainer();
container.appendChild(formatReturnValueAsHtml(ret));
cgi.write(container.parentDocument.toString(), true);
}
/++
History:
Added January 23, 2023 (dub v11.0)
+/
void presentExceptionalReturn(Meta)(Cgi cgi, Throwable t, Meta meta, string format) {
switch(format) {
case "html":
presentExceptionAsHtml(cgi, t, meta);
break;
case "json":
presentExceptionAsJsonImpl(cgi, t);
break;
default:
}
}
private void presentExceptionAsJsonImpl()(Cgi cgi, Throwable t) {
cgi.setResponseStatus("500 Internal Server Error");
cgi.setResponseContentType("application/json");
import arsd.jsvar;
var v = var.emptyObject;
v.type = typeid(t).toString;
v.msg = t.msg;
v.fullString = t.toString();
cgi.write(v.toJson(), true);
}
/++
If you override this, you will need to cast the exception type `t` dynamically,
but can then use the template arguments here to refer back to the function.
`func` is an alias to the method itself, and `dg` is a callable delegate to the same
method on the live object. You could, in theory, change arguments and retry, but I
provide that information mostly with the expectation that you will use them to make
useful forms or richer error messages for the user.
History:
BREAKING CHANGE on January 23, 2023 (v11.0 ): it previously took an `alias func` and `T dg` to call the function again.
I removed this in favor of a `Meta` param.
Before: `void presentExceptionAsHtml(alias func, T)(Cgi cgi, Throwable t, T dg)`
After: `void presentExceptionAsHtml(Meta)(Cgi cgi, Throwable t, Meta meta)`
If you used the func for something, move that something into your `methodMeta` template.
What is the benefit of this change? Somewhat smaller executables and faster builds thanks to more reused functions, together with
enabling an easier implementation of [presentExceptionalReturn].
+/
void presentExceptionAsHtml(Meta)(Cgi cgi, Throwable t, Meta meta) {
Form af;
/+
foreach(attr; __traits(getAttributes, func)) {
static if(__traits(isSame, attr, AutomaticForm)) {
af = createAutomaticFormForFunction!(func)(dg);
}
}
+/
presentExceptionAsHtmlImpl(cgi, t, af);
}
void presentExceptionAsHtmlImpl(Cgi cgi, Throwable t, Form automaticForm) {
if(auto e = cast(ResourceNotFoundException) t) {
auto container = this.htmlContainer();
container.addChild("p", e.msg);
if(!cgi.outputtedResponseData)
cgi.setResponseStatus("404 Not Found");
cgi.write(container.parentDocument.toString(), true);
} else if(auto mae = cast(MissingArgumentException) t) {
if(automaticForm is null)
goto generic;
auto container = this.htmlContainer();
if(cgi.requestMethod == Cgi.RequestMethod.POST)
container.appendChild(Element.make("p", "Argument `" ~ mae.argumentName ~ "` of type `" ~ mae.argumentType ~ "` is missing"));
container.appendChild(automaticForm);
cgi.write(container.parentDocument.toString(), true);
} else {
generic:
auto container = this.htmlContainer();
// import std.stdio; writeln(t.toString());
container.appendChild(exceptionToElement(t));
container.addChild("h4", "GET");
foreach(k, v; cgi.get) {
auto deets = container.addChild("details");
deets.addChild("summary", k);
deets.addChild("div", v);
}
container.addChild("h4", "POST");
foreach(k, v; cgi.post) {
auto deets = container.addChild("details");
deets.addChild("summary", k);
deets.addChild("div", v);
}
if(!cgi.outputtedResponseData)
cgi.setResponseStatus("500 Internal Server Error");
cgi.write(container.parentDocument.toString(), true);
}
}
Element exceptionToElement(Throwable t) {
auto div = Element.make("div");
div.addClass("exception-display");
div.addChild("p", t.msg);
div.addChild("p", "Inner code origin: " ~ typeid(t).name ~ "@" ~ t.file ~ ":" ~ to!string(t.line));
auto pre = div.addChild("pre");
string s;
s = t.toString();
Element currentBox;
bool on = false;
foreach(line; s.splitLines) {
if(!on && line.startsWith("-----"))
on = true;
if(!on) continue;
if(line.indexOf("arsd/") != -1) {
if(currentBox is null) {
currentBox = pre.addChild("details");
currentBox.addChild("summary", "Framework code");
}
currentBox.addChild("span", line ~ "\n");
} else {
pre.addChild("span", line ~ "\n");
currentBox = null;
}
}
return div;
}
/++
Returns an element for a particular type
+/
Element elementFor(T)(string displayName, string name, Element function() udaSuggestion) {
import std.traits;
auto div = Element.make("div");
div.addClass("form-field");
static if(is(T : const Cgi.UploadedFile)) {
Element lbl;
if(displayName !is null) {
lbl = div.addChild("label");
lbl.addChild("span", displayName, "label-text");
lbl.appendText(" ");
} else {
lbl = div;
}
auto i = lbl.addChild("input", name);
i.attrs.name = name;
i.attrs.type = "file";
i.attrs.multiple = "multiple";
} else static if(is(T == Cgi.UploadedFile)) {
Element lbl;
if(displayName !is null) {
lbl = div.addChild("label");
lbl.addChild("span", displayName, "label-text");
lbl.appendText(" ");
} else {
lbl = div;
}
auto i = lbl.addChild("input", name);
i.attrs.name = name;
i.attrs.type = "file";
} else static if(is(T == enum)) {
Element lbl;
if(displayName !is null) {
lbl = div.addChild("label");
lbl.addChild("span", displayName, "label-text");
lbl.appendText(" ");
} else {
lbl = div;
}
auto i = lbl.addChild("select", name);
i.attrs.name = name;
foreach(memberName; __traits(allMembers, T))
i.addChild("option", memberName);
} else static if(is(T == struct)) {
if(displayName !is null)
div.addChild("span", displayName, "label-text");
auto fieldset = div.addChild("fieldset");
fieldset.addChild("legend", beautify(T.stringof)); // FIXME
fieldset.addChild("input", name);
foreach(idx, memberName; __traits(allMembers, T))
static if(__traits(compiles, __traits(getMember, T, memberName).offsetof)) {
fieldset.appendChild(elementFor!(typeof(__traits(getMember, T, memberName)))(beautify(memberName), name ~ "." ~ memberName, null /* FIXME: pull off the UDA */));
}
} else static if(isSomeString!T || isIntegral!T || isFloatingPoint!T) {
Element lbl;
if(displayName !is null) {
lbl = div.addChild("label");
lbl.addChild("span", displayName, "label-text");
lbl.appendText(" ");
} else {
lbl = div;
}
Element i;
if(udaSuggestion) {
i = udaSuggestion();
lbl.appendChild(i);
} else {
i = lbl.addChild("input", name);
}
i.attrs.name = name;
static if(isSomeString!T)
i.attrs.type = "text";
else
i.attrs.type = "number";
if(i.tagName == "textarea")
i.textContent = to!string(T.init);
else
i.attrs.value = to!string(T.init);
} else static if(is(T == bool)) {
Element lbl;
if(displayName !is null) {
lbl = div.addChild("label");
lbl.addChild("span", displayName, "label-text");
lbl.appendText(" ");
} else {
lbl = div;
}
auto i = lbl.addChild("input", name);
i.attrs.type = "checkbox";
i.attrs.value = "true";
i.attrs.name = name;
} else static if(is(T == K[], K)) {
auto templ = div.addChild("template");
templ.appendChild(elementFor!(K)(null, name, null /* uda??*/));
if(displayName !is null)
div.addChild("span", displayName, "label-text");
auto btn = div.addChild("button");
btn.addClass("add-array-button");
btn.attrs.type = "button";
btn.innerText = "Add";
btn.attrs.onclick = q{
var a = document.importNode(this.parentNode.firstChild.content, true);
this.parentNode.insertBefore(a, this);
};
} else static if(is(T == V[K], K, V)) {
div.innerText = "assoc array not implemented for automatic form at this time";
} else {
static assert(0, "unsupported type for cgi call " ~ T.stringof);
}
return div;
}
/// creates a form for gathering the function's arguments
Form createAutomaticFormForFunction(alias method, T)(T dg) {
auto form = cast(Form) Element.make("form");
form.method = "POST"; // FIXME
form.addClass("automatic-form");
string formDisplayName = beautify(__traits(identifier, method));
foreach(attr; __traits(getAttributes, method))
static if(is(typeof(attr) == DisplayName))
formDisplayName = attr.name;
form.addChild("h3", formDisplayName);
import std.traits;
//Parameters!method params;
//alias idents = ParameterIdentifierTuple!method;
//alias defaults = ParameterDefaults!method;
static if(is(typeof(method) P == __parameters))
foreach(idx, _; P) {{
alias param = P[idx .. idx + 1];
static if(!mustNotBeSetFromWebParams!(param[0], __traits(getAttributes, param))) {
string displayName = beautify(__traits(identifier, param));
Element function() element;
foreach(attr; __traits(getAttributes, param)) {
static if(is(typeof(attr) == DisplayName))
displayName = attr.name;
else static if(is(typeof(attr) : typeof(element))) {
element = attr;
}
}
auto i = form.appendChild(elementFor!(param)(displayName, __traits(identifier, param), element));
if(i.querySelector("input[type=file]") !is null)
form.setAttribute("enctype", "multipart/form-data");
}
}}
form.addChild("div", Html(`<input type="submit" value="Submit" />`), "submit-button-holder");
return form;
}
/// creates a form for gathering object members (for the REST object thing right now)
Form createAutomaticFormForObject(T)(T obj) {
auto form = cast(Form) Element.make("form");
form.addClass("automatic-form");
form.addChild("h3", beautify(__traits(identifier, T)));
import std.traits;
//Parameters!method params;
//alias idents = ParameterIdentifierTuple!method;
//alias defaults = ParameterDefaults!method;
foreach(idx, memberName; __traits(derivedMembers, T)) {{
static if(__traits(compiles, __traits(getMember, obj, memberName).offsetof)) {
string displayName = beautify(memberName);
Element function() element;
foreach(attr; __traits(getAttributes, __traits(getMember, T, memberName)))
static if(is(typeof(attr) == DisplayName))
displayName = attr.name;
else static if(is(typeof(attr) : typeof(element)))
element = attr;
form.appendChild(elementFor!(typeof(__traits(getMember, T, memberName)))(displayName, memberName, element));
form.setValue(memberName, to!string(__traits(getMember, obj, memberName)));
}}}
form.addChild("div", Html(`<input type="submit" value="Submit" />`), "submit-button-holder");
return form;
}
///
Element formatReturnValueAsHtml(T)(T t) {
import std.traits;
static if(is(T == typeof(null))) {
return Element.make("span");
} else static if(is(T : Element)) {
return t;
} else static if(is(T == MultipleResponses!Types, Types...)) {
foreach(index, type; Types) {
if(t.contains == index)
return formatReturnValueAsHtml(t.payload[index]);
}
assert(0);
} else static if(is(T == Paginated!E, E)) {
auto e = Element.make("div").addClass("paginated-result");
e.appendChild(formatReturnValueAsHtml(t.items));
if(t.nextPageUrl.length)
e.appendChild(Element.make("a", "Next Page", t.nextPageUrl));
return e;
} else static if(isIntegral!T || isSomeString!T || isFloatingPoint!T) {
return Element.make("span", to!string(t), "automatic-data-display");
} else static if(is(T == V[K], K, V)) {
auto dl = Element.make("dl");
dl.addClass("automatic-data-display associative-array");
foreach(k, v; t) {
dl.addChild("dt", to!string(k));
dl.addChild("dd", formatReturnValueAsHtml(v));
}
return dl;
} else static if(is(T == struct)) {
auto dl = Element.make("dl");
dl.addClass("automatic-data-display struct");
foreach(idx, memberName; __traits(allMembers, T))
static if(__traits(compiles, __traits(getMember, T, memberName).offsetof)) {
dl.addChild("dt", beautify(memberName));
dl.addChild("dd", formatReturnValueAsHtml(__traits(getMember, t, memberName)));
}
return dl;
} else static if(is(T == bool)) {
return Element.make("span", t ? "true" : "false", "automatic-data-display");
} else static if(is(T == E[], E)) {
static if(is(E : RestObject!Proxy, Proxy)) {
// treat RestObject similar to struct
auto table = cast(Table) Element.make("table");
table.addClass("automatic-data-display");
string[] names;
foreach(idx, memberName; __traits(derivedMembers, E))
static if(__traits(compiles, __traits(getMember, E, memberName).offsetof)) {
names ~= beautify(memberName);
}
table.appendHeaderRow(names);
foreach(l; t) {
auto tr = table.appendRow();
foreach(idx, memberName; __traits(derivedMembers, E))
static if(__traits(compiles, __traits(getMember, E, memberName).offsetof)) {
static if(memberName == "id") {
string val = to!string(__traits(getMember, l, memberName));
tr.addChild("td", Element.make("a", val, E.stringof.toLower ~ "s/" ~ val)); // FIXME
} else {
tr.addChild("td", formatReturnValueAsHtml(__traits(getMember, l, memberName)));
}
}
}
return table;
} else static if(is(E == struct)) {
// an array of structs is kinda special in that I like
// having those formatted as tables.
auto table = cast(Table) Element.make("table");
table.addClass("automatic-data-display");
string[] names;
foreach(idx, memberName; __traits(allMembers, E))
static if(__traits(compiles, __traits(getMember, E, memberName).offsetof)) {
names ~= beautify(memberName);
}
table.appendHeaderRow(names);
foreach(l; t) {
auto tr = table.appendRow();
foreach(idx, memberName; __traits(allMembers, E))
static if(__traits(compiles, __traits(getMember, E, memberName).offsetof)) {
tr.addChild("td", formatReturnValueAsHtml(__traits(getMember, l, memberName)));
}
}
return table;
} else {
// otherwise, I will just make a list.
auto ol = Element.make("ol");
ol.addClass("automatic-data-display");
foreach(e; t)
ol.addChild("li", formatReturnValueAsHtml(e));
return ol;
}
} else static if(is(T : Object)) {
static if(is(typeof(t.toHtml()))) // FIXME: maybe i will make this an interface
return Element.make("div", t.toHtml());
else
return Element.make("div", t.toString());
} else static assert(0, "bad return value for cgi call " ~ T.stringof);
assert(0);
}
}
/++
The base class for the [dispatcher] function and object support.
+/
class WebObject {
//protected Cgi cgi;
protected void initialize(Cgi cgi) {
//this.cgi = cgi;
}
}
/++
Can return one of the given types, decided at runtime. The syntax
is to declare all the possible types in the return value, then you
can `return typeof(return)(...value...)` to construct it.
It has an auto-generated constructor for each value it can hold.
---
MultipleResponses!(Redirection, string) getData(int how) {
if(how & 1)
return typeof(return)(Redirection("http://dpldocs.info/"));
else
return typeof(return)("hi there!");
}
---
If you have lots of returns, you could, inside the function, `alias r = typeof(return);` to shorten it a little.
+/
struct MultipleResponses(T...) {
private size_t contains;
private union {
private T payload;
}
static foreach(index, type; T)
public this(type t) {
contains = index;
payload[index] = t;
}
/++
This is primarily for testing. It is your way of getting to the response.
Let's say you wanted to test that one holding a Redirection and a string actually
holds a string, by name of "test":
---
auto valueToTest = your_test_function();
valueToTest.visit(
(Redirection r) { assert(0); }, // got a redirection instead of a string, fail the test
(string s) { assert(s == "test"); } // right value, go ahead and test it.
);
---
History:
Was horribly broken until June 16, 2022. Ironically, I wrote it for tests but never actually tested it.
It tried to use alias lambdas before, but runtime delegates work much better so I changed it.
+/
void visit(Handlers...)(Handlers handlers) {
template findHandler(type, int count, HandlersToCheck...) {
static if(HandlersToCheck.length == 0)
enum findHandler = -1;
else {
static if(is(typeof(HandlersToCheck[0].init(type.init))))
enum findHandler = count;
else
enum findHandler = findHandler!(type, count + 1, HandlersToCheck[1 .. $]);
}
}
foreach(index, type; T) {
enum handlerIndex = findHandler!(type, 0, Handlers);
static if(handlerIndex == -1)
static assert(0, "Type " ~ type.stringof ~ " was not handled by visitor");
else {
if(index == this.contains)
handlers[handlerIndex](this.payload[index]);
}
}
}
/+
auto toArsdJsvar()() {
import arsd.jsvar;
return var(null);
}
+/
}
// FIXME: implement this somewhere maybe
struct RawResponse {
int code;
string[] headers;
const(ubyte)[] responseBody;
}
/++
You can return this from [WebObject] subclasses for redirections.
(though note the static types means that class must ALWAYS redirect if
you return this directly. You might want to return [MultipleResponses] if it
can be conditional)
+/
struct Redirection {
string to; /// The URL to redirect to.
int code = 303; /// The HTTP code to return.
}
/++
Serves a class' methods, as a kind of low-state RPC over the web. To be used with [dispatcher].
Usage of this function will add a dependency on [arsd.dom] and [arsd.jsvar] unless you have overriden
the presenter in the dispatcher.
FIXME: explain this better
You can overload functions to a limited extent: you can provide a zero-arg and non-zero-arg function,
and non-zero-arg functions can filter via UDAs for various http methods. Do not attempt other overloads,
the runtime result of that is undefined.
A method is assumed to allow any http method unless it lists some in UDAs, in which case it is limited to only those.
(this might change, like maybe i will use pure as an indicator GET is ok. idk.)
$(WARNING
---
// legal in D, undefined runtime behavior with cgi.d, it may call either method
// even if you put different URL udas on it, the current code ignores them.
void foo(int a) {}
void foo(string a) {}
---
)
See_Also: [serveRestObject], [serveStaticFile]
+/
auto serveApi(T)(string urlPrefix) {
assert(urlPrefix[$ - 1] == '/');
return serveApiInternal!T(urlPrefix);
}
private string nextPieceFromSlash(ref string remainingUrl) {
if(remainingUrl.length == 0)
return remainingUrl;
int slash = 0;
while(slash < remainingUrl.length && remainingUrl[slash] != '/') // && remainingUrl[slash] != '.')
slash++;
// I am specifically passing `null` to differentiate it vs empty string
// so in your ctor, `items` means new T(null) and `items/` means new T("")
auto ident = remainingUrl.length == 0 ? null : remainingUrl[0 .. slash];
// so if it is the last item, the dot can be used to load an alternative view
// otherwise tho the dot is considered part of the identifier
// FIXME
// again notice "" vs null here!
if(slash == remainingUrl.length)
remainingUrl = null;
else
remainingUrl = remainingUrl[slash + 1 .. $];
return ident;
}
/++
UDA used to indicate to the [dispatcher] that a trailing slash should always be added to or removed from the url. It will do it as a redirect header as-needed.
+/
enum AddTrailingSlash;
/// ditto
enum RemoveTrailingSlash;
private auto serveApiInternal(T)(string urlPrefix) {
import arsd.dom;
import arsd.jsvar;
static bool internalHandler(Presenter)(string urlPrefix, Cgi cgi, Presenter presenter, immutable void* details) {
string remainingUrl = cgi.pathInfo[urlPrefix.length .. $];
try {
// see duplicated code below by searching subresource_ctor
// also see mustNotBeSetFromWebParams
static if(is(typeof(T.__ctor) P == __parameters)) {
P params;
foreach(pidx, param; P) {
static if(is(param : Cgi)) {
static assert(!is(param == immutable));
cast() params[pidx] = cgi;
} else static if(is(param == Session!D, D)) {
static assert(!is(param == immutable));
cast() params[pidx] = cgi.getSessionObject!D();
} else {
static if(hasIfCalledFromWeb!(__traits(getAttributes, P[pidx .. pidx + 1]))) {
foreach(uda; __traits(getAttributes, P[pidx .. pidx + 1])) {
static if(is(uda == ifCalledFromWeb!func, alias func)) {
static if(is(typeof(func(cgi))))
params[pidx] = func(cgi);
else
params[pidx] = func();
}
}
} else {
static if(__traits(compiles, { params[pidx] = param.getAutomaticallyForCgi(cgi); } )) {
params[pidx] = param.getAutomaticallyForCgi(cgi);
} else static if(is(param == string)) {
auto ident = nextPieceFromSlash(remainingUrl);
params[pidx] = ident;
} else static assert(0, "illegal type for subresource " ~ param.stringof);
}
}
}
auto obj = new T(params);
} else {
auto obj = new T();
}
return internalHandlerWithObject(obj, remainingUrl, cgi, presenter);
} catch(Throwable t) {
switch(cgi.request("format", "html")) {
case "html":
static void dummy() {}
presenter.presentExceptionAsHtml(cgi, t, null);
return true;
case "json":
var envelope = var.emptyObject;
envelope.success = false;
envelope.result = null;
envelope.error = t.toString();
cgi.setResponseContentType("application/json");
cgi.write(envelope.toJson(), true);
return true;
default:
throw t;
// return true;
}
// return true;
}
assert(0);
}
static bool internalHandlerWithObject(T, Presenter)(T obj, string remainingUrl, Cgi cgi, Presenter presenter) {
obj.initialize(cgi);
/+
Overload rules:
Any unique combination of HTTP verb and url path can be dispatched to function overloads
statically.
Moreover, some args vs no args can be overloaded dynamically.
+/
auto methodNameFromUrl = nextPieceFromSlash(remainingUrl);
/+
auto orig = remainingUrl;
assert(0,
(orig is null ? "__null" : orig)
~ " .. " ~
(methodNameFromUrl is null ? "__null" : methodNameFromUrl));
+/
if(methodNameFromUrl is null)
methodNameFromUrl = "__null";
string hack = to!string(cgi.requestMethod) ~ " " ~ methodNameFromUrl;
if(remainingUrl.length)
hack ~= "/";
switch(hack) {
foreach(methodName; __traits(derivedMembers, T))
static if(methodName != "__ctor")
foreach(idx, overload; __traits(getOverloads, T, methodName)) {
static if(is(typeof(overload) P == __parameters))
static if(is(typeof(overload) R == return))
static if(__traits(getProtection, overload) == "public" || __traits(getProtection, overload) == "export")
{
static foreach(urlNameForMethod; urlNamesForMethod!(overload, urlify(methodName)))
case urlNameForMethod:
static if(is(R : WebObject)) {
// if it returns a WebObject, it is considered a subresource. That means the url is dispatched like the ctor above.
// the only argument it is allowed to take, outside of cgi, session, and set up thingies, is a single string
// subresource_ctor
// also see mustNotBeSetFromWebParams
P params;
string ident;
foreach(pidx, param; P) {
static if(is(param : Cgi)) {
static assert(!is(param == immutable));
cast() params[pidx] = cgi;
} else static if(is(param == typeof(presenter))) {
cast() param[pidx] = presenter;
} else static if(is(param == Session!D, D)) {
static assert(!is(param == immutable));
cast() params[pidx] = cgi.getSessionObject!D();
} else {
static if(hasIfCalledFromWeb!(__traits(getAttributes, P[pidx .. pidx + 1]))) {
foreach(uda; __traits(getAttributes, P[pidx .. pidx + 1])) {
static if(is(uda == ifCalledFromWeb!func, alias func)) {
static if(is(typeof(func(cgi))))
params[pidx] = func(cgi);
else
params[pidx] = func();
}
}
} else {
static if(__traits(compiles, { params[pidx] = param.getAutomaticallyForCgi(cgi); } )) {
params[pidx] = param.getAutomaticallyForCgi(cgi);
} else static if(is(param == string)) {
ident = nextPieceFromSlash(remainingUrl);
if(ident is null) {
// trailing slash mandated on subresources
cgi.setResponseLocation(cgi.pathInfo ~ "/");
return true;
} else {
params[pidx] = ident;
}
} else static assert(0, "illegal type for subresource " ~ param.stringof);
}
}
}
auto nobj = (__traits(getOverloads, obj, methodName)[idx])(ident);
return internalHandlerWithObject!(typeof(nobj), Presenter)(nobj, remainingUrl, cgi, presenter);
} else {
// 404 it if any url left - not a subresource means we don't get to play with that!
if(remainingUrl.length)
return false;
bool automaticForm;
foreach(attr; __traits(getAttributes, overload))
static if(is(attr == AddTrailingSlash)) {
if(remainingUrl is null) {
cgi.setResponseLocation(cgi.pathInfo ~ "/");
return true;
}
} else static if(is(attr == RemoveTrailingSlash)) {
if(remainingUrl !is null) {
cgi.setResponseLocation(cgi.pathInfo[0 .. lastIndexOf(cgi.pathInfo, "/")]);
return true;
}
} else static if(__traits(isSame, AutomaticForm, attr)) {
automaticForm = true;
}
/+
int zeroArgOverload = -1;
int overloadCount = cast(int) __traits(getOverloads, T, methodName).length;
bool calledWithZeroArgs = true;
foreach(k, v; cgi.get)
if(k != "format") {
calledWithZeroArgs = false;
break;
}
foreach(k, v; cgi.post)
if(k != "format") {
calledWithZeroArgs = false;
break;
}
// first, we need to go through and see if there is an empty one, since that
// changes inside. But otherwise, all the stuff I care about can be done via
// simple looping (other improper overloads might be flagged for runtime semantic check)
//
// an argument of type Cgi is ignored for these purposes
static foreach(idx, overload; __traits(getOverloads, T, methodName)) {{
static if(is(typeof(overload) P == __parameters))
static if(P.length == 0)
zeroArgOverload = cast(int) idx;
else static if(P.length == 1 && is(P[0] : Cgi))
zeroArgOverload = cast(int) idx;
}}
// FIXME: static assert if there are multiple non-zero-arg overloads usable with a single http method.
bool overloadHasBeenCalled = false;
static foreach(idx, overload; __traits(getOverloads, T, methodName)) {{
bool callFunction = true;
// there is a zero arg overload and this is NOT it, and we have zero args - don't call this
if(overloadCount > 1 && zeroArgOverload != -1 && idx != zeroArgOverload && calledWithZeroArgs)
callFunction = false;
// if this is the zero-arg overload, obviously it cannot be called if we got any args.
if(overloadCount > 1 && idx == zeroArgOverload && !calledWithZeroArgs)
callFunction = false;
// FIXME: so if you just add ?foo it will give the error below even when. this might not be a great idea.
bool hadAnyMethodRestrictions = false;
bool foundAcceptableMethod = false;
foreach(attr; __traits(getAttributes, overload)) {
static if(is(typeof(attr) == Cgi.RequestMethod)) {
hadAnyMethodRestrictions = true;
if(attr == cgi.requestMethod)
foundAcceptableMethod = true;
}
}
if(hadAnyMethodRestrictions && !foundAcceptableMethod)
callFunction = false;
/+
The overloads we really want to allow are the sane ones
from the web perspective. Which is likely on HTTP verbs,
for the most part, but might also be potentially based on
some args vs zero args, or on argument names. Can't really
do argument types very reliable through the web though; those
should probably be different URLs.
Even names I feel is better done inside the function, so I'm not
going to support that here. But the HTTP verbs and zero vs some
args makes sense - it lets you define custom forms pretty easily.
Moreover, I'm of the opinion that empty overload really only makes
sense on GET for this case. On a POST, it is just a missing argument
exception and that should be handled by the presenter. But meh, I'll
let the user define that, D only allows one empty arg thing anyway
so the method UDAs are irrelevant.
+/
if(callFunction)
+/
auto format = cgi.request("format", defaultFormat!overload());
auto wantsFormFormat = format.startsWith("form-");
if(wantsFormFormat || (automaticForm && cgi.requestMethod == Cgi.RequestMethod.GET)) {
// Should I still show the form on a json thing? idk...
auto ret = presenter.createAutomaticFormForFunction!((__traits(getOverloads, obj, methodName)[idx]))(&(__traits(getOverloads, obj, methodName)[idx]));
presenter.presentSuccessfulReturn(cgi, ret, presenter.methodMeta!(__traits(getOverloads, obj, methodName)[idx]), wantsFormFormat ? format["form_".length .. $] : "html");
return true;
}
try {
// a void return (or typeof(null) lol) means you, the user, is doing it yourself. Gives full control.
auto ret = callFromCgi!(__traits(getOverloads, obj, methodName)[idx])(&(__traits(getOverloads, obj, methodName)[idx]), cgi);
presenter.presentSuccessfulReturn(cgi, ret, presenter.methodMeta!(__traits(getOverloads, obj, methodName)[idx]), format);
} catch(Throwable t) {
// presenter.presentExceptionAsHtml!(__traits(getOverloads, obj, methodName)[idx])(cgi, t, &(__traits(getOverloads, obj, methodName)[idx]));
presenter.presentExceptionalReturn(cgi, t, presenter.methodMeta!(__traits(getOverloads, obj, methodName)[idx]), format);
}
return true;
//}}
//cgi.header("Accept: POST"); // FIXME list the real thing
//cgi.setResponseStatus("405 Method Not Allowed"); // again, not exactly, but sort of. no overload matched our args, almost certainly due to http verb filtering.
//return true;
}
}
}
case "GET script.js":
cgi.setResponseContentType("text/javascript");
cgi.gzipResponse = true;
cgi.write(presenter.script(), true);
return true;
case "GET style.css":
cgi.setResponseContentType("text/css");
cgi.gzipResponse = true;
cgi.write(presenter.style(), true);
return true;
default:
return false;
}
assert(0);
}
return DispatcherDefinition!internalHandler(urlPrefix, false);
}
string defaultFormat(alias method)() {
bool nonConstConditionForWorkingAroundASpuriousDmdWarning = true;
foreach(attr; __traits(getAttributes, method)) {
static if(is(typeof(attr) == DefaultFormat)) {
if(nonConstConditionForWorkingAroundASpuriousDmdWarning)
return attr.value;
}
}
return "html";
}
struct Paginated(T) {
T[] items;
string nextPageUrl;
}
template urlNamesForMethod(alias method, string default_) {
string[] helper() {
auto verb = Cgi.RequestMethod.GET;
bool foundVerb = false;
bool foundNoun = false;
string def = default_;
bool hasAutomaticForm = false;
foreach(attr; __traits(getAttributes, method)) {
static if(is(typeof(attr) == Cgi.RequestMethod)) {
verb = attr;
if(foundVerb)
assert(0, "Multiple http verbs on one function is not currently supported");
foundVerb = true;
}
static if(is(typeof(attr) == UrlName)) {
if(foundNoun)
assert(0, "Multiple url names on one function is not currently supported");
foundNoun = true;
def = attr.name;
}
static if(__traits(isSame, attr, AutomaticForm)) {
hasAutomaticForm = true;
}
}
if(def is null)
def = "__null";
string[] ret;
static if(is(typeof(method) R == return)) {
static if(is(R : WebObject)) {
def ~= "/";
foreach(v; __traits(allMembers, Cgi.RequestMethod))
ret ~= v ~ " " ~ def;
} else {
if(hasAutomaticForm) {
ret ~= "GET " ~ def;
ret ~= "POST " ~ def;
} else {
ret ~= to!string(verb) ~ " " ~ def;
}
}
} else static assert(0);
return ret;
}
enum urlNamesForMethod = helper();
}
enum AccessCheck {
allowed,
denied,
nonExistant,
}
enum Operation {
show,
create,
replace,
remove,
update
}
enum UpdateResult {
accessDenied,
noSuchResource,
success,
failure,
unnecessary
}
enum ValidationResult {
valid,
invalid
}
/++
The base of all REST objects, to be used with [serveRestObject] and [serveRestCollectionOf].
WARNING: this is not stable.
+/
class RestObject(CRTP) : WebObject {
import arsd.dom;
import arsd.jsvar;
/// Prepare the object to be shown.
void show() {}
/// ditto
void show(string urlId) {
load(urlId);
show();
}
/// Override this to provide access control to this object.
AccessCheck accessCheck(string urlId, Operation operation) {
return AccessCheck.allowed;
}
ValidationResult validate() {
// FIXME
return ValidationResult.valid;
}
string getUrlSlug() {
import std.conv;
static if(is(typeof(CRTP.id)))
return to!string((cast(CRTP) this).id);
else
return null;
}
// The functions with more arguments are the low-level ones,
// they forward to the ones with fewer arguments by default.
// POST on a parent collection - this is called from a collection class after the members are updated
/++
Given a populated object, this creates a new entry. Returns the url identifier
of the new object.
+/
string create(scope void delegate() applyChanges) {
applyChanges();
save();
return getUrlSlug();
}
void replace() {
save();
}
void replace(string urlId, scope void delegate() applyChanges) {
load(urlId);
applyChanges();
replace();
}
void update(string[] fieldList) {
save();
}
void update(string urlId, scope void delegate() applyChanges, string[] fieldList) {
load(urlId);
applyChanges();
update(fieldList);
}
void remove() {}
void remove(string urlId) {
load(urlId);
remove();
}
abstract void load(string urlId);
abstract void save();
Element toHtml(Presenter)(Presenter presenter) {
import arsd.dom;
import std.conv;
auto obj = cast(CRTP) this;
auto div = Element.make("div");
div.addClass("Dclass_" ~ CRTP.stringof);
div.dataset.url = getUrlSlug();
bool first = true;
foreach(idx, memberName; __traits(derivedMembers, CRTP))
static if(__traits(compiles, __traits(getMember, obj, memberName).offsetof)) {
if(!first) div.addChild("br"); else first = false;
div.appendChild(presenter.formatReturnValueAsHtml(__traits(getMember, obj, memberName)));
}
return div;
}
var toJson() {
import arsd.jsvar;
var v = var.emptyObject();
auto obj = cast(CRTP) this;
foreach(idx, memberName; __traits(derivedMembers, CRTP))
static if(__traits(compiles, __traits(getMember, obj, memberName).offsetof)) {
v[memberName] = __traits(getMember, obj, memberName);
}
return v;
}
/+
auto structOf(this This) {
}
+/
}
// FIXME XSRF token, prolly can just put in a cookie and then it needs to be copied to header or form hidden value
// https://use-the-index-luke.com/sql/partial-results/fetch-next-page
/++
Base class for REST collections.
+/
class CollectionOf(Obj) : RestObject!(CollectionOf) {
/// You might subclass this and use the cgi object's query params
/// to implement a search filter, for example.
///
/// FIXME: design a way to auto-generate that form
/// (other than using the WebObject thing above lol
// it'll prolly just be some searchParams UDA or maybe an enum.
//
// pagination too perhaps.
//
// and sorting too
IndexResult index() { return IndexResult.init; }
string[] sortableFields() { return null; }
string[] searchableFields() { return null; }
struct IndexResult {
Obj[] results;
string[] sortableFields;
string previousPageIdentifier;
string nextPageIdentifier;
string firstPageIdentifier;
string lastPageIdentifier;
int numberOfPages;
}
override string create(scope void delegate() applyChanges) { assert(0); }
override void load(string urlId) { assert(0); }
override void save() { assert(0); }
override void show() {
index();
}
override void show(string urlId) {
show();
}
/// Proxy POST requests (create calls) to the child collection
alias PostProxy = Obj;
}
/++
Serves a REST object, similar to a Ruby on Rails resource.
You put data members in your class. cgi.d will automatically make something out of those.
It will call your constructor with the ID from the URL. This may be null.
It will then populate the data members from the request.
It will then call a method, if present, telling what happened. You don't need to write these!
It finally returns a reply.
Your methods are passed a list of fields it actually set.
The URL mapping - despite my general skepticism of the wisdom - matches up with what most REST
APIs I have used seem to follow. (I REALLY want to put trailing slashes on it though. Works better
with relative linking. But meh.)
GET /items -> index. all values not set.
GET /items/id -> get. only ID will be set, other params ignored.
POST /items -> create. values set as given
PUT /items/id -> replace. values set as given
or POST /items/id with cgi.post["_method"] (thus urlencoded or multipart content-type) set to "PUT" to work around browser/html limitation
a GET with cgi.get["_method"] (in the url) set to "PUT" will render a form.
PATCH /items/id -> update. values set as given, list of changed fields passed
or POST /items/id with cgi.post["_method"] == "PATCH"
DELETE /items/id -> destroy. only ID guaranteed to be set
or POST /items/id with cgi.post["_method"] == "DELETE"
Following the stupid convention, there will never be a trailing slash here, and if it is there, it will
redirect you away from it.
API clients should set the `Accept` HTTP header to application/json or the cgi.get["_format"] = "json" var.
I will also let you change the default, if you must.
// One add-on is validation. You can issue a HTTP GET to a resource with _method = VALIDATE to check potential changes.
You can define sub-resources on your object inside the object. These sub-resources are also REST objects
that follow the same thing. They may be individual resources or collections themselves.
Your class is expected to have at least the following methods:
FIXME: i kinda wanna add a routes object to the initialize call
create
Create returns the new address on success, some code on failure.
show
index
update
remove
You will want to be able to customize the HTTP, HTML, and JSON returns but generally shouldn't have to - the defaults
should usually work. The returned JSON will include a field "href" on all returned objects along with "id". Or omething like that.
Usage of this function will add a dependency on [arsd.dom] and [arsd.jsvar].
NOT IMPLEMENTED
Really, a collection is a resource with a bunch of subresources.
GET /items
index because it is GET on the top resource
GET /items/foo
item but different than items?
class Items {
}
... but meh, a collection can be automated. not worth making it
a separate thing, let's look at a real example. Users has many
items and a virtual one, /users/current.
the individual users have properties and two sub-resources:
session, which is just one, and comments, a collection.
class User : RestObject!() { // no parent
int id;
string name;
// the default implementations of the urlId ones is to call load(that_id) then call the arg-less one.
// but you can override them to do it differently.
// any member which is of type RestObject can be linked automatically via href btw.
void show() {}
void show(string urlId) {} // automated! GET of this specific thing
void create() {} // POST on a parent collection - this is called from a collection class after the members are updated
void replace(string urlId) {} // this is the PUT; really, it just updates all fields.
void update(string urlId, string[] fieldList) {} // PATCH, it updates some fields.
void remove(string urlId) {} // DELETE
void load(string urlId) {} // the default implementation of show() populates the id, then
this() {}
mixin Subresource!Session;
mixin Subresource!Comment;
}
class Session : RestObject!() {
// the parent object may not be fully constructed/loaded
this(User parent) {}
}
class Comment : CollectionOf!Comment {
this(User parent) {}
}
class Users : CollectionOf!User {
// but you don't strictly need ANYTHING on a collection; it will just... collect. Implement the subobjects.
void index() {} // GET on this specific thing; just like show really, just different name for the different semantics.
User create() {} // You MAY implement this, but the default is to create a new object, populate it from args, and then call create() on the child
}
+/
auto serveRestObject(T)(string urlPrefix) {
assert(urlPrefix[0] == '/');
assert(urlPrefix[$ - 1] != '/', "Do NOT use a trailing slash on REST objects.");
static bool internalHandler(Presenter)(string urlPrefix, Cgi cgi, Presenter presenter, immutable void* details) {
string url = cgi.pathInfo[urlPrefix.length .. $];
if(url.length && url[$ - 1] == '/') {
// remove the final slash...
cgi.setResponseLocation(cgi.scriptName ~ cgi.pathInfo[0 .. $ - 1]);
return true;
}
return restObjectServeHandler!T(cgi, presenter, url);
}
return DispatcherDefinition!internalHandler(urlPrefix, false);
}
/+
/// Convenience method for serving a collection. It will be named the same
/// as type T, just with an s at the end. If you need any further, just
/// write the class yourself.
auto serveRestCollectionOf(T)(string urlPrefix) {
assert(urlPrefix[0] == '/');
mixin(`static class `~T.stringof~`s : CollectionOf!(T) {}`);
return serveRestObject!(mixin(T.stringof ~ "s"))(urlPrefix);
}
+/
bool restObjectServeHandler(T, Presenter)(Cgi cgi, Presenter presenter, string url) {
string urlId = null;
if(url.length && url[0] == '/') {
// asking for a subobject
urlId = url[1 .. $];
foreach(idx, ch; urlId) {
if(ch == '/') {
urlId = urlId[0 .. idx];
break;
}
}
}
// FIXME handle other subresources
static if(is(T : CollectionOf!(C), C)) {
if(urlId !is null) {
return restObjectServeHandler!(C, Presenter)(cgi, presenter, url); // FIXME? urlId);
}
}
// FIXME: support precondition failed, if-modified-since, expectation failed, etc.
auto obj = new T();
obj.initialize(cgi);
// FIXME: populate reflection info delegates
// FIXME: I am not happy with this.
switch(urlId) {
case "script.js":
cgi.setResponseContentType("text/javascript");
cgi.gzipResponse = true;
cgi.write(presenter.script(), true);
return true;
case "style.css":
cgi.setResponseContentType("text/css");
cgi.gzipResponse = true;
cgi.write(presenter.style(), true);
return true;
default:
// intentionally blank
}
static void applyChangesTemplate(Obj)(Cgi cgi, Obj obj) {
foreach(idx, memberName; __traits(derivedMembers, Obj))
static if(__traits(compiles, __traits(getMember, obj, memberName).offsetof)) {
__traits(getMember, obj, memberName) = cgi.request(memberName, __traits(getMember, obj, memberName));
}
}
void applyChanges() {
applyChangesTemplate(cgi, obj);
}
string[] modifiedList;
void writeObject(bool addFormLinks) {
if(cgi.request("format") == "json") {
cgi.setResponseContentType("application/json");
cgi.write(obj.toJson().toString, true);
} else {
auto container = presenter.htmlContainer();
if(addFormLinks) {
static if(is(T : CollectionOf!(C), C))
container.appendHtml(`
<form>
<button type="submit" name="_method" value="POST">Create New</button>
</form>
`);
else
container.appendHtml(`
<a href="..">Back</a>
<form>
<button type="submit" name="_method" value="PATCH">Edit</button>
<button type="submit" name="_method" value="DELETE">Delete</button>
</form>
`);
}
container.appendChild(obj.toHtml(presenter));
cgi.write(container.parentDocument.toString, true);
}
}
// FIXME: I think I need a set type in here....
// it will be nice to pass sets of members.
try
switch(cgi.requestMethod) {
case Cgi.RequestMethod.GET:
// I could prolly use template this parameters in the implementation above for some reflection stuff.
// sure, it doesn't automatically work in subclasses... but I instantiate here anyway...
// automatic forms here for usable basic auto site from browser.
// even if the format is json, it could actually send out the links and formats, but really there i'ma be meh.
switch(cgi.request("_method", "GET")) {
case "GET":
static if(is(T : CollectionOf!(C), C)) {
auto results = obj.index();
if(cgi.request("format", "html") == "html") {
auto container = presenter.htmlContainer();
auto html = presenter.formatReturnValueAsHtml(results.results);
container.appendHtml(`
<form>
<button type="submit" name="_method" value="POST">Create New</button>
</form>
`);
container.appendChild(html);
cgi.write(container.parentDocument.toString, true);
} else {
cgi.setResponseContentType("application/json");
import arsd.jsvar;
var json = var.emptyArray;
foreach(r; results.results) {
var o = var.emptyObject;
foreach(idx, memberName; __traits(derivedMembers, typeof(r)))
static if(__traits(compiles, __traits(getMember, r, memberName).offsetof)) {
o[memberName] = __traits(getMember, r, memberName);
}
json ~= o;
}
cgi.write(json.toJson(), true);
}
} else {
obj.show(urlId);
writeObject(true);
}
break;
case "PATCH":
obj.load(urlId);
goto case;
case "PUT":
case "POST":
// an editing form for the object
auto container = presenter.htmlContainer();
static if(__traits(compiles, () { auto o = new obj.PostProxy(); })) {
auto form = (cgi.request("_method") == "POST") ? presenter.createAutomaticFormForObject(new obj.PostProxy()) : presenter.createAutomaticFormForObject(obj);
} else {
auto form = presenter.createAutomaticFormForObject(obj);
}
form.attrs.method = "POST";
form.setValue("_method", cgi.request("_method", "GET"));
container.appendChild(form);
cgi.write(container.parentDocument.toString(), true);
break;
case "DELETE":
// FIXME: a delete form for the object (can be phrased "are you sure?")
auto container = presenter.htmlContainer();
container.appendHtml(`
<form method="POST">
Are you sure you want to delete this item?
<input type="hidden" name="_method" value="DELETE" />
<input type="submit" value="Yes, Delete It" />
</form>
`);
cgi.write(container.parentDocument.toString(), true);
break;
default:
cgi.write("bad method\n", true);
}
break;
case Cgi.RequestMethod.POST:
// this is to allow compatibility with HTML forms
switch(cgi.request("_method", "POST")) {
case "PUT":
goto PUT;
case "PATCH":
goto PATCH;
case "DELETE":
goto DELETE;
case "POST":
static if(__traits(compiles, () { auto o = new obj.PostProxy(); })) {
auto p = new obj.PostProxy();
void specialApplyChanges() {
applyChangesTemplate(cgi, p);
}
string n = p.create(&specialApplyChanges);
} else {
string n = obj.create(&applyChanges);
}
auto newUrl = cgi.scriptName ~ cgi.pathInfo ~ "/" ~ n;
cgi.setResponseLocation(newUrl);
cgi.setResponseStatus("201 Created");
cgi.write(`The object has been created.`);
break;
default:
cgi.write("bad method\n", true);
}
// FIXME this should be valid on the collection, but not the child....
// 303 See Other
break;
case Cgi.RequestMethod.PUT:
PUT:
obj.replace(urlId, &applyChanges);
writeObject(false);
break;
case Cgi.RequestMethod.PATCH:
PATCH:
obj.update(urlId, &applyChanges, modifiedList);
writeObject(false);
break;
case Cgi.RequestMethod.DELETE:
DELETE:
obj.remove(urlId);
cgi.setResponseStatus("204 No Content");
break;
default:
// FIXME: OPTIONS, HEAD
}
catch(Throwable t) {
presenter.presentExceptionAsHtml(cgi, t);
}
return true;
}
/+
struct SetOfFields(T) {
private void[0][string] storage;
void set(string what) {
//storage[what] =
}
void unset(string what) {}
void setAll() {}
void unsetAll() {}
bool isPresent(string what) { return false; }
}
+/
/+
enum readonly;
enum hideonindex;
+/
/++
Returns true if I recommend gzipping content of this type. You might
want to call it from your Presenter classes before calling cgi.write.
---
cgi.setResponseContentType(yourContentType);
cgi.gzipResponse = gzipRecommendedForContentType(yourContentType);
cgi.write(yourData, true);
---
This is used internally by [serveStaticFile], [serveStaticFileDirectory], [serveStaticData], and maybe others I forgot to update this doc about.
The implementation considers text content to be recommended to gzip. This may change, but it seems reasonable enough for now.
History:
Added January 28, 2023 (dub v11.0)
+/
bool gzipRecommendedForContentType(string contentType) {
if(contentType.startsWith("text/"))
return true;
if(contentType.startsWith("application/javascript"))
return true;
return false;
}
/++
Serves a static file. To be used with [dispatcher].
See_Also: [serveApi], [serveRestObject], [dispatcher], [serveRedirect]
+/
auto serveStaticFile(string urlPrefix, string filename = null, string contentType = null) {
// https://baus.net/on-tcp_cork/
// man 2 sendfile
assert(urlPrefix[0] == '/');
if(filename is null)
filename = decodeComponent(urlPrefix[1 .. $]); // FIXME is this actually correct?
if(contentType is null) {
contentType = contentTypeFromFileExtension(filename);
}
static struct DispatcherDetails {
string filename;
string contentType;
}
static bool internalHandler(string urlPrefix, Cgi cgi, Object presenter, DispatcherDetails details) {
if(details.contentType.indexOf("image/") == 0 || details.contentType.indexOf("audio/") == 0)
cgi.setCache(true);
cgi.setResponseContentType(details.contentType);
cgi.gzipResponse = gzipRecommendedForContentType(details.contentType);
cgi.write(std.file.read(details.filename), true);
return true;
}
return DispatcherDefinition!(internalHandler, DispatcherDetails)(urlPrefix, true, DispatcherDetails(filename, contentType));
}
/++
Serves static data. To be used with [dispatcher].
History:
Added October 31, 2021
+/
auto serveStaticData(string urlPrefix, immutable(void)[] data, string contentType = null) {
assert(urlPrefix[0] == '/');
if(contentType is null) {
contentType = contentTypeFromFileExtension(urlPrefix);
}
static struct DispatcherDetails {
immutable(void)[] data;
string contentType;
}
static bool internalHandler(string urlPrefix, Cgi cgi, Object presenter, DispatcherDetails details) {
cgi.setCache(true);
cgi.setResponseContentType(details.contentType);
cgi.write(details.data, true);
return true;
}
return DispatcherDefinition!(internalHandler, DispatcherDetails)(urlPrefix, true, DispatcherDetails(data, contentType));
}
string contentTypeFromFileExtension(string filename) {
if(filename.endsWith(".png"))
return "image/png";
if(filename.endsWith(".apng"))
return "image/apng";
if(filename.endsWith(".svg"))
return "image/svg+xml";
if(filename.endsWith(".jpg"))
return "image/jpeg";
if(filename.endsWith(".html"))
return "text/html";
if(filename.endsWith(".css"))
return "text/css";
if(filename.endsWith(".js"))
return "application/javascript";
if(filename.endsWith(".wasm"))
return "application/wasm";
if(filename.endsWith(".mp3"))
return "audio/mpeg";
if(filename.endsWith(".pdf"))
return "application/pdf";
return null;
}
/// This serves a directory full of static files, figuring out the content-types from file extensions.
/// It does not let you to descend into subdirectories (or ascend out of it, of course)
auto serveStaticFileDirectory(string urlPrefix, string directory = null, bool recursive = false) {
assert(urlPrefix[0] == '/');
assert(urlPrefix[$-1] == '/');
static struct DispatcherDetails {
string directory;
bool recursive;
}
if(directory is null)
directory = urlPrefix[1 .. $];
if(directory.length == 0)
directory = "./";
assert(directory[$-1] == '/');
static bool internalHandler(string urlPrefix, Cgi cgi, Object presenter, DispatcherDetails details) {
auto file = decodeComponent(cgi.pathInfo[urlPrefix.length .. $]); // FIXME: is this actually correct
if(details.recursive) {
// never allow a backslash since it isn't in a typical url anyway and makes the following checks easier
if(file.indexOf("\\") != -1)
return false;
import std.path;
file = std.path.buildNormalizedPath(file);
enum upOneDir = ".." ~ std.path.dirSeparator;
// also no point doing any kind of up directory things since that makes it more likely to break out of the parent
if(file == ".." || file.startsWith(upOneDir))
return false;
if(std.path.isAbsolute(file))
return false;
// FIXME: if it has slashes and stuff, should we redirect to the canonical resource? or what?
// once it passes these filters it is probably ok.
} else {
if(file.indexOf("/") != -1 || file.indexOf("\\") != -1)
return false;
}
auto contentType = contentTypeFromFileExtension(file);
auto fn = details.directory ~ file;
if(std.file.exists(fn)) {
//if(contentType.indexOf("image/") == 0)
//cgi.setCache(true);
//else if(contentType.indexOf("audio/") == 0)
cgi.setCache(true);
cgi.setResponseContentType(contentType);
cgi.gzipResponse = gzipRecommendedForContentType(contentType);
cgi.write(std.file.read(fn), true);
return true;
} else {
return false;
}
}
return DispatcherDefinition!(internalHandler, DispatcherDetails)(urlPrefix, false, DispatcherDetails(directory, recursive));
}
/++
Redirects one url to another
See_Also: [dispatcher], [serveStaticFile]
+/
auto serveRedirect(string urlPrefix, string redirectTo, int code = 303) {
assert(urlPrefix[0] == '/');
static struct DispatcherDetails {
string redirectTo;
string code;
}
static bool internalHandler(string urlPrefix, Cgi cgi, Object presenter, DispatcherDetails details) {
cgi.setResponseLocation(details.redirectTo, true, details.code);
return true;
}
return DispatcherDefinition!(internalHandler, DispatcherDetails)(urlPrefix, true, DispatcherDetails(redirectTo, getHttpCodeText(code)));
}
/// Used exclusively with `dispatchTo`
struct DispatcherData(Presenter) {
Cgi cgi; /// You can use this cgi object.
Presenter presenter; /// This is the presenter from top level, and will be forwarded to the sub-dispatcher.
size_t pathInfoStart; /// This is forwarded to the sub-dispatcher. It may be marked private later, or at least read-only.
}
/++
Dispatches the URL to a specific function.
+/
auto handleWith(alias handler)(string urlPrefix) {
// cuz I'm too lazy to do it better right now
static class Hack : WebObject {
static import std.traits;
@UrlName("")
auto handle(std.traits.Parameters!handler args) {
return handler(args);
}
}
return urlPrefix.serveApiInternal!Hack;
}
/++
Dispatches the URL (and anything under it) to another dispatcher function. The function should look something like this:
---
bool other(DD)(DD dd) {
return dd.dispatcher!(
"/whatever".serveRedirect("/success"),
"/api/".serveApi!MyClass
);
}
---
The `DD` in there will be an instance of [DispatcherData] which you can inspect, or forward to another dispatcher
here. It is a template to account for any Presenter type, so you can do compile-time analysis in your presenters.
Or, of course, you could just use the exact type in your own code.
You return true if you handle the given url, or false if not. Just returning the result of [dispatcher] will do a
good job.
+/
auto dispatchTo(alias handler)(string urlPrefix) {
assert(urlPrefix[0] == '/');
assert(urlPrefix[$-1] != '/');
static bool internalHandler(Presenter)(string urlPrefix, Cgi cgi, Presenter presenter, const void* details) {
return handler(DispatcherData!Presenter(cgi, presenter, urlPrefix.length));
}
return DispatcherDefinition!(internalHandler)(urlPrefix, false);
}
/++
See [serveStaticFile] if you want to serve a file off disk.
History:
Added January 28, 2023 (dub v11.0)
+/
auto serveStaticData(string urlPrefix, immutable(ubyte)[] data, string contentType, string filenameToSuggestAsDownload = null) {
assert(urlPrefix[0] == '/');
static struct DispatcherDetails {
immutable(ubyte)[] data;
string contentType;
string filenameToSuggestAsDownload;
}
static bool internalHandler(string urlPrefix, Cgi cgi, Object presenter, DispatcherDetails details) {
cgi.setCache(true);
cgi.setResponseContentType(details.contentType);
if(details.filenameToSuggestAsDownload.length)
cgi.header("Content-Disposition: attachment; filename=\""~details.filenameToSuggestAsDownload~"\"");
cgi.gzipResponse = gzipRecommendedForContentType(details.contentType);
cgi.write(details.data, true);
return true;
}
return DispatcherDefinition!(internalHandler, DispatcherDetails)(urlPrefix, true, DispatcherDetails(data, contentType, filenameToSuggestAsDownload));
}
/++
Placeholder for use with [dispatchSubsection]'s `NewPresenter` argument to indicate you want to keep the parent's presenter.
History:
Added January 28, 2023 (dub v11.0)
+/
alias KeepExistingPresenter = typeof(null);
/++
For use with [dispatchSubsection]. Calls your filter with the request and if your filter returns false,
this issues the given errorCode and stops processing.
---
bool hasAdminPermissions(Cgi cgi) {
return true;
}
mixin DispatcherMain!(
"/admin".dispatchSubsection!(
passFilterOrIssueError!(hasAdminPermissions, 403),
KeepExistingPresenter,
"/".serveApi!AdminFunctions
)
);
---
History:
Added January 28, 2023 (dub v11.0)
+/
template passFilterOrIssueError(alias filter, int errorCode) {
bool passFilterOrIssueError(DispatcherDetails)(DispatcherDetails dd) {
if(filter(dd.cgi))
return true;
dd.presenter.renderBasicError(dd.cgi, errorCode);
return false;
}
}
/++
Allows for a subsection of your dispatched urls to be passed through other a pre-request filter, optionally pick up an new presenter class,
and then be dispatched to their own handlers.
---
/+
// a long-form filter function
bool permissionCheck(DispatcherData)(DispatcherData dd) {
// you are permitted to call mutable methods on the Cgi object
// Note if you use a Cgi subclass, you can try dynamic casting it back to your custom type to attach per-request data
// though much of the request is immutable so there's only so much you're allowed to do to modify it.
if(checkPermissionOnRequest(dd.cgi)) {
return true; // OK, allow processing to continue
} else {
dd.presenter.renderBasicError(dd.cgi, 403); // reply forbidden to the requester
return false; // and stop further processing into this subsection
}
}
+/
// but you can also do short-form filters:
bool permissionCheck(Cgi cgi) {
return ("ok" in cgi.get) !is null;
}
// handler for the subsection
class AdminClass : WebObject {
int foo() { return 5; }
}
// handler for the main site
class TheMainSite : WebObject {}
mixin DispatcherMain!(
"/admin".dispatchSubsection!(
// converts our short-form filter into a long-form filter
passFilterOrIssueError!(permissionCheck, 403),
// can use a new presenter if wanted for the subsection
KeepExistingPresenter,
// and then provide child route dispatchers
"/".serveApi!AdminClass
),
// and back to the top level
"/".serveApi!TheMainSite
);
---
Note you can encapsulate sections in files like this:
---
auto adminDispatcher(string urlPrefix) {
return urlPrefix.dispatchSubsection!(
....
);
}
mixin DispatcherMain!(
"/admin".adminDispatcher,
// and so on
)
---
If you want no filter, you can pass `(cgi) => true` as the filter to approve all requests.
If you want to keep the same presenter as the parent, use [KeepExistingPresenter] as the presenter argument.
History:
Added January 28, 2023 (dub v11.0)
+/
auto dispatchSubsection(alias PreRequestFilter, NewPresenter, definitions...)(string urlPrefix) {
assert(urlPrefix[0] == '/');
assert(urlPrefix[$-1] != '/');
static bool internalHandler(Presenter)(string urlPrefix, Cgi cgi, Presenter presenter, const void* details) {
static if(!is(PreRequestFilter == typeof(null))) {
if(!PreRequestFilter(DispatcherData!Presenter(cgi, presenter, urlPrefix.length)))
return true; // we handled it by rejecting it
}
static if(is(NewPresenter == Presenter) || is(NewPresenter == typeof(null))) {
return dispatcher!definitions(DispatcherData!Presenter(cgi, presenter, urlPrefix.length));
} else {
auto newPresenter = new NewPresenter();
return dispatcher!(definitions(DispatcherData!NewPresenter(cgi, presenter, urlPrefix.length)));
}
}
return DispatcherDefinition!(internalHandler)(urlPrefix, false);
}
/++
A URL dispatcher.
---
if(cgi.dispatcher!(
"/api/".serveApi!MyApiClass,
"/objects/lol".serveRestObject!MyRestObject,
"/file.js".serveStaticFile,
"/admin/".dispatchTo!adminHandler
)) return;
---
You define a series of url prefixes followed by handlers.
You may want to do different pre- and post- processing there, for example,
an authorization check and different page layout. You can use different
presenters and different function chains. See [dispatchSubsection] for details.
[dispatchTo] will send the request to another function for handling.
+/
template dispatcher(definitions...) {
bool dispatcher(Presenter)(Cgi cgi, Presenter presenterArg = null) {
static if(is(Presenter == typeof(null))) {
static class GenericWebPresenter : WebPresenter!(GenericWebPresenter) {}
auto presenter = new GenericWebPresenter();
} else
alias presenter = presenterArg;
return dispatcher(DispatcherData!(typeof(presenter))(cgi, presenter, 0));
}
bool dispatcher(DispatcherData)(DispatcherData dispatcherData) if(!is(DispatcherData : Cgi)) {
// I can prolly make this more efficient later but meh.
foreach(definition; definitions) {
if(definition.rejectFurther) {
if(dispatcherData.cgi.pathInfo[dispatcherData.pathInfoStart .. $] == definition.urlPrefix) {
auto ret = definition.handler(
dispatcherData.cgi.pathInfo[0 .. dispatcherData.pathInfoStart + definition.urlPrefix.length],
dispatcherData.cgi, dispatcherData.presenter, definition.details);
if(ret)
return true;
}
} else if(
dispatcherData.cgi.pathInfo[dispatcherData.pathInfoStart .. $].startsWith(definition.urlPrefix) &&
// cgi.d dispatcher urls must be complete or have a /;
// "foo" -> thing should NOT match "foobar", just "foo" or "foo/thing"
(definition.urlPrefix[$-1] == '/' || (dispatcherData.pathInfoStart + definition.urlPrefix.length) == dispatcherData.cgi.pathInfo.length
|| dispatcherData.cgi.pathInfo[dispatcherData.pathInfoStart + definition.urlPrefix.length] == '/')
) {
auto ret = definition.handler(
dispatcherData.cgi.pathInfo[0 .. dispatcherData.pathInfoStart + definition.urlPrefix.length],
dispatcherData.cgi, dispatcherData.presenter, definition.details);
if(ret)
return true;
}
}
return false;
}
}
});
private struct StackBuffer {
char[1024] initial = void;
char[] buffer;
size_t position;
this(int a) {
buffer = initial[];
position = 0;
}
void add(in char[] what) {
if(position + what.length > buffer.length)
buffer.length = position + what.length + 1024; // reallocate with GC to handle special cases
buffer[position .. position + what.length] = what[];
position += what.length;
}
void add(in char[] w1, in char[] w2, in char[] w3 = null) {
add(w1);
add(w2);
add(w3);
}
void add(long v) {
char[16] buffer = void;
auto pos = buffer.length;
bool negative;
if(v < 0) {
negative = true;
v = -v;
}
do {
buffer[--pos] = cast(char) (v % 10 + '0');
v /= 10;
} while(v);
if(negative)
buffer[--pos] = '-';
auto res = buffer[pos .. $];
add(res[]);
}
char[] get() @nogc {
return buffer[0 .. position];
}
}
// duplicated in http2.d
private static string getHttpCodeText(int code) pure nothrow @nogc {
switch(code) {
case 200: return "200 OK";
case 201: return "201 Created";
case 202: return "202 Accepted";
case 203: return "203 Non-Authoritative Information";
case 204: return "204 No Content";
case 205: return "205 Reset Content";
case 206: return "206 Partial Content";
//
case 300: return "300 Multiple Choices";
case 301: return "301 Moved Permanently";
case 302: return "302 Found";
case 303: return "303 See Other";
case 304: return "304 Not Modified";
case 305: return "305 Use Proxy";
case 307: return "307 Temporary Redirect";
case 308: return "308 Permanent Redirect";
//
case 400: return "400 Bad Request";
case 401: return "401 Unauthorized";
case 402: return "402 Payment Required";
case 403: return "403 Forbidden";
case 404: return "404 Not Found";
case 405: return "405 Method Not Allowed";
case 406: return "406 Not Acceptable";
case 407: return "407 Proxy Authentication Required";
case 408: return "408 Request Timeout";
case 409: return "409 Conflict";
case 410: return "410 Gone";
case 411: return "411 Length Required";
case 412: return "412 Precondition Failed";
case 413: return "413 Payload Too Large";
case 414: return "414 URI Too Long";
case 415: return "415 Unsupported Media Type";
case 416: return "416 Range Not Satisfiable";
case 417: return "417 Expectation Failed";
case 418: return "418 I'm a teapot";
case 421: return "421 Misdirected Request";
case 422: return "422 Unprocessable Entity (WebDAV)";
case 423: return "423 Locked (WebDAV)";
case 424: return "424 Failed Dependency (WebDAV)";
case 425: return "425 Too Early";
case 426: return "426 Upgrade Required";
case 428: return "428 Precondition Required";
case 431: return "431 Request Header Fields Too Large";
case 451: return "451 Unavailable For Legal Reasons";
case 500: return "500 Internal Server Error";
case 501: return "501 Not Implemented";
case 502: return "502 Bad Gateway";
case 503: return "503 Service Unavailable";
case 504: return "504 Gateway Timeout";
case 505: return "505 HTTP Version Not Supported";
case 506: return "506 Variant Also Negotiates";
case 507: return "507 Insufficient Storage (WebDAV)";
case 508: return "508 Loop Detected (WebDAV)";
case 510: return "510 Not Extended";
case 511: return "511 Network Authentication Required";
//
default: assert(0, "Unsupported http code");
}
}
/+
/++
This is the beginnings of my web.d 2.0 - it dispatches web requests to a class object.
It relies on jsvar.d and dom.d.
You can get javascript out of it to call. The generated functions need to look
like
function name(a,b,c,d,e) {
return _call("name", {"realName":a,"sds":b});
}
And _call returns an object you can call or set up or whatever.
+/
bool apiDispatcher()(Cgi cgi) {
import arsd.jsvar;
import arsd.dom;
}
+/
version(linux)
private extern(C) int eventfd (uint initval, int flags) nothrow @trusted @nogc;
/*
Copyright: Adam D. Ruppe, 2008 - 2023
License: [http://www.boost.org/LICENSE_1_0.txt|Boost License 1.0].
Authors: Adam D. Ruppe
Copyright Adam D. Ruppe 2008 - 2023.
Distributed under the Boost Software License, Version 1.0.
(See accompanying file LICENSE_1_0.txt or copy at
http://www.boost.org/LICENSE_1_0.txt)
*/
|