« get me outta code hell

upd8.js « src - hsmusic-wiki - HSMusic - static wiki software cataloguing collaborative creation
about summary refs log tree commit diff
path: root/src/upd8.js
blob: 545e8375a9c283445565fc4701489232b32624d0 (plain)
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
#!/usr/bin/env node

// HEY N8RDS!
//
// This is one of the 8ACKEND FILES. It's not used anywhere on the actual site
// you are pro8a8ly using right now.
//
// Specifically, this one does all the actual work of the music wiki. The
// process looks something like this:
//
//   1. Crawl the music directories. Well, not so much "crawl" as "look inside
//      the folders for each al8um, and read the metadata file descri8ing that
//      al8um and the tracks within."
//
//   2. Read that metadata. I'm writing this 8efore actually doing any of the
//      code, and I've gotta admit I have no idea what file format they're
//      going to 8e in. May8e JSON, 8ut more likely some weird custom format
//      which will 8e a lot easier to edit.
//
//      Like three years later oh god: SURPISE! We went with the latter, but
//      they're YAML now. Probably. Assuming that hasn't changed, yet.
//
//   3. Generate the page files! They're just static index.html files, and are
//      what gh-pages (or wherever this is hosted) will show to clients.
//      Hopefully pretty minimalistic HTML, 8ut like, shrug. They'll reference
//      CSS (and maaaaaaaay8e JS) files, hard-coded somewhere near the root.
//
//   4. Print an awesome message which says the process is done. This is the
//      most important step.
//
// Oh yeah, like. Just run this through some relatively recent version of
// node.js and you'll 8e fine. ...Within the project root. O8viously.

import * as path from 'path';
import {fileURLToPath} from 'url';

import chroma from 'chroma-js';

import {
  copyFile,
  mkdir,
  stat,
  symlink,
  writeFile,
  unlink,
} from 'fs/promises';

import { execSync } from 'child_process';

import genThumbs from './gen-thumbs.js';
import {listingSpec, listingTargetSpec} from './listing-spec.js';
import urlSpec from './url-spec.js';
import * as pageSpecs from './page/index.js';

import find, {bindFind} from './util/find.js';
import * as html from './util/html.js';
import {getColors} from './util/colors.js';
import {findFiles} from './util/io.js';
import {isMain} from './util/node-utils.js';

import CacheableObject from './data/things/cacheable-object.js';

import {processLanguageFile} from './data/language.js';
import {serializeThings} from './data/serialize.js';

import {
  filterDuplicateDirectories,
  filterReferenceErrors,
  linkWikiDataArrays,
  loadAndProcessDataDocuments,
  sortWikiDataArrays,
  WIKI_INFO_FILE,
} from './data/yaml.js';

import {
  fancifyFlashURL,
  fancifyURL,
  generateAdditionalFilesShortcut,
  generateAdditionalFilesList,
  generateChronologyLinks,
  generateCoverLink,
  generateInfoGalleryLinks,
  generateNavigationLinks,
  generateStickyHeadingContainer,
  generateTrackListDividedByGroups,
  getAlbumGridHTML,
  getAlbumStylesheet,
  getArtistString,
  getFlashGridHTML,
  getFooterLocalizationLinks,
  getGridHTML,
  getCarouselHTML,
  getRevealStringFromTags,
  getRevealStringFromWarnings,
  getThemeString as unbound_getThemeString,
  iconifyURL,
} from './misc-templates.js';

import unbound_link, {
  getLinkThemeString as unbound_getLinkThemeString,
} from './util/link.js';

import {
  color,
  decorateTime,
  logWarn,
  logInfo,
  logError,
  parseOptions,
  progressCallAll,
  progressPromiseAll,
} from './util/cli.js';

import {validateReplacerSpec, transformInline} from './util/replacer.js';

import {
  getAlbumCover,
  getArtistAvatar,
  getFlashCover,
  getTrackCover,
} from './util/wiki-data.js';

/*
import {
  serializeContribs,
  serializeCover,
  serializeGroupsForAlbum,
  serializeGroupsForTrack,
  serializeImagePaths,
  serializeLink,
} from './util/serialize.js';
*/

import {
  bindOpts,
  queue,
  showAggregate,
  withEntries,
} from './util/sugar.js';

import {generateURLs, thumb} from './util/urls.js';

// Pensive emoji!
import { OFFICIAL_GROUP_DIRECTORY } from './util/magic-constants.js';

import FileSizePreloader from './file-size-preloader.js';

const __dirname = path.dirname(fileURLToPath(import.meta.url));

const CACHEBUST = 17;

let COMMIT;
try {
  COMMIT = execSync('git log --format="%h %B" -n 1 HEAD', {cwd: __dirname}).toString().trim();
} catch (error) {
  COMMIT = '(failed to detect)';
}

const BUILD_TIME = new Date();

const DEFAULT_STRINGS_FILE = 'strings-default.json';

// Code that's common 8etween the 8uild code (i.e. upd8.js) and gener8ted
// site code should 8e put here. Which, uh, ~~only really means this one
// file~~ is now a variety of useful utilities!
//
// Rather than hard code it, anything in this directory can 8e shared across
// 8oth ends of the code8ase.
// (This gets symlinked into the --data-path directory.)
const UTILITY_DIRECTORY = 'util';

// Code that's used only in the static site! CSS, cilent JS, etc.
// (This gets symlinked into the --data-path directory.)
const STATIC_DIRECTORY = 'static';

// This exists adjacent to index.html for any page with oEmbed metadata.
const OEMBED_JSON_FILE = 'oembed.json';

// Automatically copied (if present) from media directory to site root.
const FAVICON_FILE = 'favicon.ico';

// Shared varia8les! These are more efficient to access than a shared varia8le
// (or at least I h8pe so), and are easier to pass across functions than a
// 8unch of specific arguments.
//
// Upd8: Okay yeah these aren't actually any different. Still cleaner than
// passing around a data object containing all this, though.
let dataPath;
let mediaPath;
let langPath;
let outputPath;

// Glo8al data o8ject shared 8etween 8uild functions and all that. This keeps
// everything encapsul8ted in one place, so it's easy to pass and share across
// modules!
let wikiData = {};

let queueSize;

const urls = generateURLs(urlSpec);

function splitLines(text) {
  return text.split(/\r\n|\r|\n/);
}

const replacerSpec = {
  album: {
    find: 'album',
    link: 'album',
  },
  'album-commentary': {
    find: 'album',
    link: 'albumCommentary',
  },
  artist: {
    find: 'artist',
    link: 'artist',
  },
  'artist-gallery': {
    find: 'artist',
    link: 'artistGallery',
  },
  'commentary-index': {
    find: null,
    link: 'commentaryIndex',
  },
  date: {
    find: null,
    value: (ref) => new Date(ref),
    html: (date, {language}) =>
      html.tag('time',
        {datetime: date.toString()},
        language.formatDate(date)),
  },
  flash: {
    find: 'flash',
    link: 'flash',
    transformName(name, node, input) {
      const nextCharacter = input[node.iEnd];
      const lastCharacter = name[name.length - 1];
      if (![' ', '\n', '<'].includes(nextCharacter) && lastCharacter === '.') {
        return name.slice(0, -1);
      } else {
        return name;
      }
    },
  },
  group: {
    find: 'group',
    link: 'groupInfo',
  },
  'group-gallery': {
    find: 'group',
    link: 'groupGallery',
  },
  home: {
    find: null,
    link: 'home',
  },
  'listing-index': {
    find: null,
    link: 'listingIndex',
  },
  listing: {
    find: 'listing',
    link: 'listing',
  },
  media: {
    find: null,
    link: 'media',
  },
  'news-index': {
    find: null,
    link: 'newsIndex',
  },
  'news-entry': {
    find: 'newsEntry',
    link: 'newsEntry',
  },
  root: {
    find: null,
    link: 'root',
  },
  site: {
    find: null,
    link: 'site',
  },
  static: {
    find: 'staticPage',
    link: 'staticPage',
  },
  string: {
    find: null,
    value: (ref) => ref,
    html: (ref, {language, args}) => language.$(ref, args),
  },
  tag: {
    find: 'artTag',
    link: 'tag',
  },
  track: {
    find: 'track',
    link: 'track',
  },
};

if (!validateReplacerSpec(replacerSpec, {find, link: unbound_link})) {
  process.exit();
}

function parseAttributes(string, {to}) {
  const attributes = Object.create(null);
  const skipWhitespace = (i) => {
    const ws = /\s/;
    if (ws.test(string[i])) {
      const match = string.slice(i).match(/[^\s]/);
      if (match) {
        return i + match.index;
      } else {
        return string.length;
      }
    } else {
      return i;
    }
  };

  for (let i = 0; i < string.length; ) {
    i = skipWhitespace(i);
    const aStart = i;
    const aEnd = i + string.slice(i).match(/[\s=]|$/).index;
    const attribute = string.slice(aStart, aEnd);
    i = skipWhitespace(aEnd);
    if (string[i] === '=') {
      i = skipWhitespace(i + 1);
      let end, endOffset;
      if (string[i] === '"' || string[i] === "'") {
        end = string[i];
        endOffset = 1;
        i++;
      } else {
        end = '\\s';
        endOffset = 0;
      }
      const vStart = i;
      const vEnd = i + string.slice(i).match(new RegExp(`${end}|$`)).index;
      const value = string.slice(vStart, vEnd);
      i = vEnd + endOffset;
      if (attribute === 'src' && value.startsWith('media/')) {
        attributes[attribute] = to('media.path', value.slice('media/'.length));
      } else {
        attributes[attribute] = value;
      }
    } else {
      attributes[attribute] = attribute;
    }
  }
  return Object.fromEntries(
    Object.entries(attributes).map(([key, val]) => [
      key,
      val === 'true'
        ? true
        : val === 'false'
        ? false
        : val === key
        ? true
        : val,
    ])
  );
}

function joinLineBreaks(sourceLines) {
  const outLines = [];

  let lineSoFar = '';
  for (let i = 0; i < sourceLines.length; i++) {
    const line = sourceLines[i];
    lineSoFar += line;
    if (!line.endsWith('<br>')) {
      outLines.push(lineSoFar);
      lineSoFar = '';
    }
  }

  if (lineSoFar) {
    outLines.push(lineSoFar);
  }

  return outLines;
}

function transformMultiline(text, {parseAttributes, transformInline}) {
  // Heck yes, HTML magics.

  text = transformInline(text.trim());

  const outLines = [];

  const indentString = ' '.repeat(4);

  let levelIndents = [];
  const openLevel = (indent) => {
    // opening a sublist is a pain: to be semantically *and* visually
    // correct, we have to append the <ul> at the end of the existing
    // previous <li>
    const previousLine = outLines[outLines.length - 1];
    if (previousLine?.endsWith('</li>')) {
      // we will re-close the <li> later
      outLines[outLines.length - 1] = previousLine.slice(0, -5) + ' <ul>';
    } else {
      // if the previous line isn't a list item, this is the opening of
      // the first list level, so no need for indent
      outLines.push('<ul>');
    }
    levelIndents.push(indent);
  };
  const closeLevel = () => {
    levelIndents.pop();
    if (levelIndents.length) {
      // closing a sublist, so close the list item containing it too
      outLines.push(indentString.repeat(levelIndents.length) + '</ul></li>');
    } else {
      // closing the final list level! no need for indent here
      outLines.push('</ul>');
    }
  };

  // okay yes we should support nested formatting, more than one blockquote
  // layer, etc, but hear me out here: making all that work would basically
  // be the same as implementing an entire markdown converter, which im not
  // interested in doing lol. sorry!!!
  let inBlockquote = false;

  let lines = splitLines(text);
  lines = joinLineBreaks(lines);
  for (let line of lines) {
    const imageLine = line.startsWith('<img');
    line = line.replace(/<img (.*?)>/g, (match, attributes) =>
      img({
        lazy: true,
        link: true,
        thumb: 'medium',
        ...parseAttributes(attributes),
      })
    );

    let indentThisLine = 0;
    let lineContent = line;
    let lineTag = 'p';

    const listMatch = line.match(/^( *)- *(.*)$/);
    if (listMatch) {
      // is a list item!
      if (!levelIndents.length) {
        // first level is always indent = 0, regardless of actual line
        // content (this is to avoid going to a lesser indent than the
        // initial level)
        openLevel(0);
      } else {
        // find level corresponding to indent
        const indent = listMatch[1].length;
        let i;
        for (i = levelIndents.length - 1; i >= 0; i--) {
          if (levelIndents[i] <= indent) break;
        }
        // note: i cannot equal -1 because the first indentation level
        // is always 0, and the minimum indentation is also 0
        if (levelIndents[i] === indent) {
          // same indent! return to that level
          while (levelIndents.length - 1 > i) closeLevel();
          // (if this is already the current level, the above loop
          // will do nothing)
        } else if (levelIndents[i] < indent) {
          // lesser indent! branch based on index
          if (i === levelIndents.length - 1) {
            // top level is lesser: add a new level
            openLevel(indent);
          } else {
            // lower level is lesser: return to that level
            while (levelIndents.length - 1 > i) closeLevel();
          }
        }
      }
      // finally, set variables for appending content line
      indentThisLine = levelIndents.length;
      lineContent = listMatch[2];
      lineTag = 'li';
    } else {
      // not a list item! close any existing list levels
      while (levelIndents.length) closeLevel();

      // like i said, no nested shenanigans - quotes only appear outside
      // of lists. sorry!
      const quoteMatch = line.match(/^> *(.*)$/);
      if (quoteMatch) {
        // is a quote! open a blockquote tag if it doesnt already exist
        if (!inBlockquote) {
          inBlockquote = true;
          outLines.push('<blockquote>');
        }
        indentThisLine = 1;
        lineContent = quoteMatch[1];
      } else if (inBlockquote) {
        // not a quote! close a blockquote tag if it exists
        inBlockquote = false;
        outLines.push('</blockquote>');
      }

      // let some escaped symbols display as the normal symbol, since the
      // point of escaping them is just to avoid having them be treated as
      // syntax markers!
      if (lineContent.match(/( *)\\-/)) {
        lineContent = lineContent.replace('\\-', '-');
      } else if (lineContent.match(/( *)\\>/)) {
        lineContent = lineContent.replace('\\>', '>');
      }
    }

    if (lineTag === 'p') {
      // certain inline element tags should still be postioned within a
      // paragraph; other elements (e.g. headings) should be added as-is
      const elementMatch = line.match(/^<(.*?)[ >]/);
      if (
        elementMatch &&
        !imageLine &&
        ![
          'a',
          'abbr',
          'b',
          'bdo',
          'br',
          'cite',
          'code',
          'data',
          'datalist',
          'del',
          'dfn',
          'em',
          'i',
          'img',
          'ins',
          'kbd',
          'mark',
          'output',
          'picture',
          'q',
          'ruby',
          'samp',
          'small',
          'span',
          'strong',
          'sub',
          'sup',
          'svg',
          'time',
          'var',
          'wbr',
        ].includes(elementMatch[1])
      ) {
        lineTag = '';
      }

      // for sticky headings!
      if (elementMatch) {
        lineContent = lineContent.replace(/<h2/, `<h2 class="content-heading"`)
      }
    }

    let pushString = indentString.repeat(indentThisLine);
    if (lineTag) {
      pushString += `<${lineTag}>${lineContent}</${lineTag}>`;
    } else {
      pushString += lineContent;
    }
    outLines.push(pushString);
  }

  // after processing all lines...

  // if still in a list, close all levels
  while (levelIndents.length) closeLevel();

  // if still in a blockquote, close its tag
  if (inBlockquote) {
    inBlockquote = false;
    outLines.push('</blockquote>');
  }

  return outLines.join('\n');
}

function transformLyrics(text, {transformInline, transformMultiline}) {
  // Different from transformMultiline 'cuz it joins multiple lines together
  // with line 8reaks (<br>); transformMultiline treats each line as its own
  // complete paragraph (or list, etc).

  // If it looks like old data, then like, oh god.
  // Use the normal transformMultiline tool.
  if (text.includes('<br')) {
    return transformMultiline(text);
  }

  text = transformInline(text.trim());

  let buildLine = '';
  const addLine = () => outLines.push(`<p>${buildLine}</p>`);
  const outLines = [];
  for (const line of text.split('\n')) {
    if (line.length) {
      if (buildLine.length) {
        buildLine += '<br>';
      }
      buildLine += line;
    } else if (buildLine.length) {
      addLine();
      buildLine = '';
    }
  }
  if (buildLine.length) {
    addLine();
  }
  return outLines.join('\n');
}

function stringifyThings(thingData) {
  return JSON.stringify(serializeThings(thingData));
}

function img({
  src,
  alt,
  noSrcText = '',
  thumb: thumbKey,
  reveal,
  id,
  class: className,
  width,
  height,
  link = false,
  lazy = false,
  square = false,
}) {
  const willSquare = square;
  const willLink = typeof link === 'string' || link;

  const originalSrc = src;
  const thumbSrc = src && (thumbKey ? thumb[thumbKey](src) : src);

  const imgAttributes = {
    id: link ? '' : id,
    class: className,
    alt,
    width,
    height,
  };

  const noSrcHTML =
    !src &&
      wrap(
        html.tag('div',
          {class: 'image-text-area'},
          noSrcText));

  const nonlazyHTML =
    src &&
      wrap(
        html.tag('img', {
          ...imgAttributes,
          src: thumbSrc,
        }));

  const lazyHTML =
    src &&
    lazy &&
      wrap(
        html.tag('img',
          {
            ...imgAttributes,
            class: [className, 'lazy'],
            'data-original': thumbSrc,
          }),
        true);

  if (!src) {
    return noSrcHTML;
  } else if (lazy) {
    return html.tag('noscript', nonlazyHTML) + '\n' + lazyHTML;
  } else {
    return nonlazyHTML;
  }

  function wrap(input, hide = false) {
    let wrapped = input;

    wrapped = html.tag('div', {class: 'image-inner-area'}, wrapped);
    wrapped = html.tag('div', {class: 'image-container'}, wrapped);

    if (reveal) {
      wrapped = html.tag('div', {class: 'reveal'}, [
        wrapped,
        html.tag('span', {class: 'reveal-text'}, reveal),
      ]);
    }

    if (willSquare) {
      wrapped = html.tag('div', {class: 'square-content'}, wrapped);
      wrapped = html.tag('div',
        {class: ['square', hide && !willLink && 'js-hide']},
        wrapped);
    }

    if (willLink) {
      wrapped = html.tag('a',
        {
          id,
          class: ['box', hide && 'js-hide'],
          href: typeof link === 'string' ? link : originalSrc,
        },
        wrapped);
    }

    return wrapped;
  }
}

function validateWritePath(path, urlGroup) {
  if (!Array.isArray(path)) {
    return {error: `Expected array, got ${path}`};
  }

  const {paths} = urlGroup;

  const definedKeys = Object.keys(paths);
  const specifiedKey = path[0];

  if (!definedKeys.includes(specifiedKey)) {
    return {error: `Specified key ${specifiedKey} isn't defined`};
  }

  const expectedArgs = paths[specifiedKey].match(/<>/g)?.length ?? 0;
  const specifiedArgs = path.length - 1;

  if (specifiedArgs !== expectedArgs) {
    return {
      error: `Expected ${expectedArgs} arguments, got ${specifiedArgs}`,
    };
  }

  return {success: true};
}

function validateWriteObject(obj) {
  if (typeof obj !== 'object') {
    return {error: `Expected object, got ${typeof obj}`};
  }

  if (typeof obj.type !== 'string') {
    return {error: `Expected type to be string, got ${obj.type}`};
  }

  switch (obj.type) {
    case 'legacy': {
      if (typeof obj.write !== 'function') {
        return {error: `Expected write to be string, got ${obj.write}`};
      }

      break;
    }

    case 'page': {
      const path = validateWritePath(obj.path, urlSpec.localized);
      if (path.error) {
        return {error: `Path validation failed: ${path.error}`};
      }

      if (typeof obj.page !== 'function') {
        return {error: `Expected page to be function, got ${obj.content}`};
      }

      break;
    }

    case 'data': {
      const path = validateWritePath(obj.path, urlSpec.data);
      if (path.error) {
        return {error: `Path validation failed: ${path.error}`};
      }

      if (typeof obj.data !== 'function') {
        return {error: `Expected data to be function, got ${obj.data}`};
      }

      break;
    }

    case 'redirect': {
      const fromPath = validateWritePath(obj.fromPath, urlSpec.localized);
      if (fromPath.error) {
        return {
          error: `Path (fromPath) validation failed: ${fromPath.error}`,
        };
      }

      const toPath = validateWritePath(obj.toPath, urlSpec.localized);
      if (toPath.error) {
        return {error: `Path (toPath) validation failed: ${toPath.error}`};
      }

      if (typeof obj.title !== 'function') {
        return {error: `Expected title to be function, got ${obj.title}`};
      }

      break;
    }

    default: {
      return {error: `Unknown type: ${obj.type}`};
    }
  }

  return {success: true};
}

export function getURLsFrom({
  baseDirectory,
  pageSubKey,
  paths,
}) {
  return (targetFullKey, ...args) => {
    const [groupKey, subKey] = targetFullKey.split('.');
    let path = paths.subdirectoryPrefix;

    let from;
    let to;

    // When linking to *outside* the localized area of the site, we need to
    // make sure the result is correctly relative to the 8ase directory.
    if (
      groupKey !== 'localized' &&
      groupKey !== 'localizedDefaultLanguage' &&
      baseDirectory
    ) {
      from = 'localizedWithBaseDirectory.' + pageSubKey;
      to = targetFullKey;
    } else if (groupKey === 'localizedDefaultLanguage' && baseDirectory) {
      // Special case for specifically linking *from* a page with base
      // directory *to* a page without! Used for the language switcher and
      // hopefully nothing else oh god.
      from = 'localizedWithBaseDirectory.' + pageSubKey;
      to = 'localized.' + subKey;
    } else if (groupKey === 'localizedDefaultLanguage') {
      // Linking to the default, except surprise, we're already IN the default
      // (no baseDirectory set).
      from = 'localized.' + pageSubKey;
      to = 'localized.' + subKey;
    } else {
      // If we're linking inside the localized area (or there just is no
      // 8ase directory), the 8ase directory doesn't matter.
      from = 'localized.' + pageSubKey;
      to = targetFullKey;
    }

    path += urls.from(from).to(to, ...args);

    return path;
  };
}

export function generateDocumentHTML(pageInfo, {
  defaultLanguage,
  getThemeString,
  language,
  languages,
  localizedPaths,
  paths,
  oEmbedJSONHref,
  to,
  transformMultiline,
  wikiData,
}) {
  const {wikiInfo} = wikiData;

  let {
    title = '',
    meta = {},
    theme = '',
    stylesheet = '',

    showWikiNameInTitle = true,
    themeColor = '',

    // missing properties are auto-filled, see below!
    body = {},
    banner = {},
    main = {},
    sidebarLeft = {},
    sidebarRight = {},
    nav = {},
    secondaryNav = {},
    footer = {},
    socialEmbed = {},
  } = pageInfo;

  body.style ??= '';

  theme = theme || getThemeString(wikiInfo.color);

  banner ||= {};
  banner.classes ??= [];
  banner.src ??= '';
  banner.position ??= '';
  banner.dimensions ??= [0, 0];

  main.classes ??= [];
  main.content ??= '';

  sidebarLeft ??= {};
  sidebarRight ??= {};

  for (const sidebar of [sidebarLeft, sidebarRight]) {
    sidebar.classes ??= [];
    sidebar.content ??= '';
    sidebar.collapse ??= true;
  }

  nav.classes ??= [];
  nav.content ??= '';
  nav.bottomRowContent ??= '';
  nav.links ??= [];
  nav.linkContainerClasses ??= [];

  secondaryNav ??= {};
  secondaryNav.content ??= '';
  secondaryNav.content ??= '';

  footer.classes ??= [];
  footer.content ??= wikiInfo.footerContent
    ? transformMultiline(wikiInfo.footerContent)
    : '';

  const colors = themeColor
    ? getColors(themeColor, {chroma})
    : null;

  const canonical = wikiInfo.canonicalBase
    ? wikiInfo.canonicalBase + (paths.pathname === '/' ? '' : paths.pathname)
    : '';

  const localizedCanonical = wikiInfo.canonicalBase
    ? Object.entries(localizedPaths).map(([code, {pathname}]) => ({
        lang: code,
        href: wikiInfo.canonicalBase + (pathname === '/' ? '' : pathname),
      }))
    : [];

  const collapseSidebars =
    sidebarLeft.collapse !== false && sidebarRight.collapse !== false;

  const mainHTML =
    main.content &&
      html.tag('main',
        {
          id: 'content',
          class: main.classes,
        },
        main.content);

  const footerHTML =
    html.tag('footer',
      {
        [html.onlyIfContent]: true,
        id: 'footer',
        class: footer.classes,
      },
      [
        html.tag('div',
          {
            [html.onlyIfContent]: true,
            class: 'footer-content',
          },
          footer.content),

        getFooterLocalizationLinks(paths.pathname, {
          defaultLanguage,
          html,
          language,
          languages,
          paths,
          to,
        }),
      ]);

  const generateSidebarHTML = (id, {
    content,
    multiple,
    classes,
    collapse = true,
    wide = false,

    // 'last' - last or only sidebar box is sticky
    // 'column' - entire column, incl. multiple boxes from top, is sticky
    // 'none' - sidebar not sticky at all, stays at top of page
    stickyMode = 'last',
  }) =>
    content
      ? html.tag('div',
          {
            id,
            class: [
              'sidebar-column',
              'sidebar',
              wide && 'wide',
              !collapse && 'no-hide',
              stickyMode !== 'none' && 'sticky-' + stickyMode,
              ...classes,
            ],
          },
          content)
      : multiple
      ? html.tag('div',
          {
            id,
            class: [
              'sidebar-column',
              'sidebar-multiple',
              wide && 'wide',
              !collapse && 'no-hide',
              stickyMode !== 'none' && 'sticky-' + stickyMode,
            ],
          },
          multiple
            .map((infoOrContent) =>
              (typeof infoOrContent === 'object' && !Array.isArray(infoOrContent))
                ? infoOrContent
                : {content: infoOrContent})
            .filter(({content}) => content)
            .map(({
              content,
              classes: classes2 = [],
            }) =>
              html.tag('div',
                {
                  class: ['sidebar', ...classes, ...classes2],
                },
                html.fragment(content))))
      : '';

  const sidebarLeftHTML = generateSidebarHTML('sidebar-left', sidebarLeft);
  const sidebarRightHTML = generateSidebarHTML('sidebar-right', sidebarRight);

  if (nav.simple) {
    nav.linkContainerClasses = ['nav-links-hierarchy'];
    nav.links = [{toHome: true}, {toCurrentPage: true}];
  }

  const links = (nav.links || []).filter(Boolean);

  const navLinkParts = [];
  for (let i = 0; i < links.length; i++) {
    let cur = links[i];

    let {title: linkTitle} = cur;

    if (cur.toHome) {
      linkTitle ??= wikiInfo.nameShort;
    } else if (cur.toCurrentPage) {
      linkTitle ??= title;
    }

    let partContent;

    if (typeof cur.html === 'string') {
      partContent = cur.html;
    } else {
      const attributes = {
        class: (cur.toCurrentPage || i === links.length - 1) && 'current',
        href: cur.toCurrentPage
          ? ''
          : cur.toHome
          ? to('localized.home')
          : cur.path
          ? to(...cur.path)
          : cur.href
          ? (() => {
              logWarn`Using legacy href format nav link in ${paths.pathname}`;
              return cur.href;
            })()
          : null,
      };
      if (attributes.href === null) {
        throw new Error(
          `Expected some href specifier for link to ${linkTitle} (${JSON.stringify(
            cur
          )})`
        );
      }
      partContent = html.tag('a', attributes, linkTitle);
    }

    if (!partContent) continue;

    const part = html.tag('span',
      {class: cur.divider === false && 'no-divider'},
      partContent);

    navLinkParts.push(part);
  }

  const navHTML = html.tag('nav',
    {
      [html.onlyIfContent]: true,
      id: 'header',
      class: [
        ...nav.classes,
        links.length && 'nav-has-main-links',
        nav.content && 'nav-has-content',
        nav.bottomRowContent && 'nav-has-bottom-row',
      ],
    },
    [
      links.length &&
        html.tag(
          'div',
          {class: ['nav-main-links', ...nav.linkContainerClasses]},
          navLinkParts
        ),
      nav.bottomRowContent &&
        html.tag('div', {class: 'nav-bottom-row'}, nav.bottomRowContent),
      nav.content && html.tag('div', {class: 'nav-content'}, nav.content),
    ]);

  const secondaryNavHTML = html.tag('nav',
    {
      [html.onlyIfContent]: true,
      id: 'secondary-nav',
      class: secondaryNav.classes,
    },
    secondaryNav.content);

  const bannerSrc = banner.src
    ? banner.src
    : banner.path
    ? to(...banner.path)
    : null;

  const bannerHTML =
    banner.position &&
    bannerSrc &&
    html.tag('div',
      {
        id: 'banner',
        class: banner.classes,
      },
      html.tag('img', {
        src: bannerSrc,
        alt: banner.alt,
        width: banner.dimensions[0] || 1100,
        height: banner.dimensions[1] || 200,
      }));

  const layoutHTML = [
    navHTML,
    banner.position === 'top' && bannerHTML,
    secondaryNavHTML,
    html.tag('div',
      {
        class: [
          'layout-columns',
          !collapseSidebars && 'vertical-when-thin',
          (sidebarLeftHTML || sidebarRightHTML) && 'has-one-sidebar',
          (sidebarLeftHTML && sidebarRightHTML) && 'has-two-sidebars',
          !(sidebarLeftHTML || sidebarRightHTML) && 'has-zero-sidebars',
          sidebarLeftHTML && 'has-sidebar-left',
          sidebarRightHTML && 'has-sidebar-right',
        ],
      },
      [
        sidebarLeftHTML,
        mainHTML,
        sidebarRightHTML,
      ]),
    banner.position === 'bottom' && bannerHTML,
    footerHTML,
  ].filter(Boolean).join('\n');

  const infoCardHTML = html.tag('div', {id: 'info-card-container'},
    html.tag('div', {id: 'info-card-decor'},
      html.tag('div', {id: 'info-card'}, [
        html.tag('div', {class: ['info-card-art-container', 'no-reveal']},
          img({
            class: 'info-card-art',
            src: '',
            link: true,
            square: true,
          })),
        html.tag('div', {class: ['info-card-art-container', 'reveal']},
          img({
            class: 'info-card-art',
            src: '',
            link: true,
            square: true,
            reveal: getRevealStringFromWarnings(
              html.tag('span', {class: 'info-card-art-warnings'}),
              {html, language}),
          })),
        html.tag('h1', {class: 'info-card-name'},
          html.tag('a')),
        html.tag('p', {class: 'info-card-album'},
          language.$('releaseInfo.from', {
            album: html.tag('a'),
          })),
        html.tag('p', {class: 'info-card-artists'},
          language.$('releaseInfo.by', {
            artists: html.tag('span'),
          })),
        html.tag('p', {class: 'info-card-cover-artists'},
          language.$('releaseInfo.coverArtBy', {
            artists: html.tag('span'),
          })),
      ])));

  const socialEmbedHTML = [
    socialEmbed.title &&
      html.tag('meta', {property: 'og:title', content: socialEmbed.title}),

    socialEmbed.description &&
      html.tag('meta', {
        property: 'og:description',
        content: socialEmbed.description,
      }),

    socialEmbed.image &&
      html.tag('meta', {property: 'og:image', content: socialEmbed.image}),

    ...html.fragment(
      colors && [
        html.tag('meta', {
          name: 'theme-color',
          content: colors.dark,
          media: '(prefers-color-scheme: dark)',
        }),

        html.tag('meta', {
          name: 'theme-color',
          content: colors.light,
          media: '(prefers-color-scheme: light)',
        }),

        html.tag('meta', {
          name: 'theme-color',
          content: colors.primary,
        }),
      ]),

    oEmbedJSONHref &&
      html.tag('link', {
        type: 'application/json+oembed',
        href: oEmbedJSONHref,
      }),
  ].filter(Boolean).join('\n');

  return `<!DOCTYPE html>\n` + html.tag('html',
    {
      lang: language.intlCode,
      'data-language-code': language.code,
      'data-url-key': paths.urlPath[0],
      ...Object.fromEntries(
        paths.urlPath.slice(1).map((v, i) => [['data-url-value' + i], v])
      ),
      'data-rebase-localized': to('localized.root'),
      'data-rebase-shared': to('shared.root'),
      'data-rebase-media': to('media.root'),
      'data-rebase-data': to('data.root'),
    },
    [
      `<!--\n` + [
        wikiInfo.canonicalBase
          ? `hsmusic.wiki - ${wikiInfo.name}, ${wikiInfo.canonicalBase}`
          : `hsmusic.wiki - ${wikiInfo.name}`,
        'Code copyright 2019-2022 Quasar Nebula et al (MIT License)',
        ...wikiInfo.canonicalBase === 'https://hsmusic.wiki/' ? [
          'Data avidly compiled and localization brought to you',
          'by our awesome team and community of wiki contributors',
          '***',
          'Want to contribute? Join our Discord or leave feedback!',
          '- https://hsmusic.wiki/discord/',
          '- https://hsmusic.wiki/feedback/',
          '- https://github.com/hsmusic/',
        ] : [
          'https://github.com/hsmusic/',
        ],
        '***',
        `Site built: ${BUILD_TIME.toLocaleString('en-US', {
          dateStyle: 'long',
          timeStyle: 'long',
        })}`,
        `Latest code commit: ${COMMIT}`,
      ]
        .filter(Boolean)
        .map(line => `    ` + line)
        .join('\n') + `\n-->`,

      html.tag('head', [
        html.tag('title',
          showWikiNameInTitle
            ? language.formatString('misc.pageTitle.withWikiName', {
                title,
                wikiName: wikiInfo.nameShort,
              })
            : language.formatString('misc.pageTitle', {title})),

        html.tag('meta', {charset: 'utf-8'}),
        html.tag('meta', {
          name: 'viewport',
          content: 'width=device-width, initial-scale=1',
        }),

        ...(
          Object.entries(meta)
            .filter(([key, value]) => value)
            .map(([key, value]) => html.tag('meta', {[key]: value}))),

        canonical &&
          html.tag('link', {
            rel: 'canonical',
            href: canonical,
          }),

        ...(
          localizedCanonical
            .map(({lang, href}) => html.tag('link', {
              rel: 'alternate',
              hreflang: lang,
              href,
            }))),

        socialEmbedHTML,

        html.tag('link', {
          rel: 'stylesheet',
          href: to('shared.staticFile', `site2.css?${CACHEBUST}`),
        }),

        html.tag('style',
          {[html.onlyIfContent]: true},
          [
            theme,
            stylesheet,
          ]),

        html.tag('script', {
          src: to('shared.staticFile', `lazy-loading.js?${CACHEBUST}`),
        }),
      ]),

      html.tag('body',
        {style: body.style || ''},
        [
          html.tag('div', {id: 'page-container'}, [
            mainHTML &&
              html.tag('div', {id: 'skippers'},
                [
                  ['#content', language.$('misc.skippers.skipToContent')],
                  sidebarLeftHTML &&
                    [
                      '#sidebar-left',
                      sidebarRightHTML
                        ? language.$('misc.skippers.skipToSidebar.left')
                        : language.$('misc.skippers.skipToSidebar'),
                    ],
                  sidebarRightHTML &&
                    [
                      '#sidebar-right',
                      sidebarLeftHTML
                        ? language.$('misc.skippers.skipToSidebar.right')
                        : language.$('misc.skippers.skipToSidebar'),
                    ],
                  footerHTML &&
                    ['#footer', language.$('misc.skippers.skipToFooter')],
                ]
                  .filter(Boolean)
                  .map(([href, title]) =>
                    html.tag('span', {class: 'skipper'},
                      html.tag('a', {href}, title)))),
            layoutHTML,
          ]),

          infoCardHTML,

          html.tag('script', {
            type: 'module',
            src: to('shared.staticFile', `client.js?${CACHEBUST}`),
          }),
        ]),
    ]);
}

function generateOEmbedJSON(pageInfo, {language, wikiData}) {
  const {socialEmbed} = pageInfo;
  const {wikiInfo} = wikiData;
  const {canonicalBase, nameShort} = wikiInfo;

  if (!socialEmbed) return '';

  const entries = [
    socialEmbed.heading && [
      'author_name',
      language.$('misc.socialEmbed.heading', {
        wikiName: nameShort,
        heading: socialEmbed.heading,
      }),
    ],
    socialEmbed.headingLink &&
      canonicalBase && [
        'author_url',
        canonicalBase.replace(/\/$/, '') +
          '/' +
          socialEmbed.headingLink.replace(/^\//, ''),
      ],
  ].filter(Boolean);

  if (!entries.length) return '';

  return JSON.stringify(Object.fromEntries(entries));
}

async function writePage({
  html,
  oEmbedJSON = '',
  paths,
}) {
  await mkdir(paths.output.directory, {recursive: true});

  await Promise.all(
    [
      writeFile(paths.output.documentHTML, html),

      oEmbedJSON &&
        writeFile(paths.output.oEmbedJSON, oEmbedJSON),
    ].filter(Boolean)
  );
}

function getPagePaths({
  baseDirectory,
  fullKey,
  urlArgs,

  file = 'index.html',
}) {
  const [groupKey, subKey] = fullKey.split('.');

  const pathname =
    groupKey === 'localized' && baseDirectory
      ? urls
          .from('shared.root')
          .toDevice(
            'localizedWithBaseDirectory.' + subKey,
            baseDirectory,
            ...urlArgs)
      : urls
          .from('shared.root')
          .toDevice(fullKey, ...urlArgs);

  // Needed for the rare path arguments which themselves contains one or more
  // slashes, e.g. for listings, with arguments like 'albums/by-name'.
  const subdirectoryPrefix =
    '../'.repeat(urlArgs.join('/').split('/').length - 1);

  const outputDirectory = path.join(outputPath, pathname);

  const output = {
    directory: outputDirectory,
    documentHTML: path.join(outputDirectory, file),
    oEmbedJSON: path.join(outputDirectory, OEMBED_JSON_FILE)
  };

  return {
    urlPath: [fullKey, ...urlArgs],

    output,
    pathname,
    subdirectoryPrefix,
  };
}

async function writeFavicon() {
  try {
    await stat(path.join(mediaPath, FAVICON_FILE));
  } catch (error) {
    return;
  }

  try {
    await copyFile(
      path.join(mediaPath, FAVICON_FILE),
      path.join(outputPath, FAVICON_FILE)
    );
  } catch (error) {
    logWarn`Failed to copy favicon! ${error.message}`;
    return;
  }

  logInfo`Copied favicon to site root.`;
}

function writeSymlinks() {
  return progressPromiseAll('Writing site symlinks.', [
    link(path.join(__dirname, UTILITY_DIRECTORY), 'shared.utilityRoot'),
    link(path.join(__dirname, STATIC_DIRECTORY), 'shared.staticRoot'),
    link(mediaPath, 'media.root'),
  ]);

  async function link(directory, urlKey) {
    const pathname = urls.from('shared.root').toDevice(urlKey);
    const file = path.join(outputPath, pathname);
    try {
      await unlink(file);
    } catch (error) {
      if (error.code !== 'ENOENT') {
        throw error;
      }
    }
    try {
      await symlink(path.resolve(directory), file);
    } catch (error) {
      if (error.code === 'EPERM') {
        await symlink(path.resolve(directory), file, 'junction');
      }
    }
  }
}

function writeSharedFilesAndPages({language, wikiData}) {
  const {groupData, wikiInfo} = wikiData;

  const redirect = async (title, from, urlKey, directory) => {
    const target = path.relative(
      from,
      urls.from('shared.root').to(urlKey, directory)
    );
    const content = generateRedirectHTML(title, target, {language});
    await mkdir(path.join(outputPath, from), {recursive: true});
    await writeFile(path.join(outputPath, from, 'index.html'), content);
  };

  return progressPromiseAll(`Writing files & pages shared across languages.`, [
    groupData?.some((group) => group.directory === 'fandom') &&
      redirect(
        'Fandom - Gallery',
        'albums/fandom',
        'localized.groupGallery',
        'fandom'
      ),

    groupData?.some((group) => group.directory === 'official') &&
      redirect(
        'Official - Gallery',
        'albums/official',
        'localized.groupGallery',
        'official'
      ),

    wikiInfo.enableListings &&
      redirect(
        'Album Commentary',
        'list/all-commentary',
        'localized.commentaryIndex',
        ''
      ),

    writeFile(
      path.join(outputPath, 'data.json'),
      (
        '{\n' +
        [
          `"albumData": ${stringifyThings(wikiData.albumData)},`,
          wikiInfo.enableFlashesAndGames &&
            `"flashData": ${stringifyThings(wikiData.flashData)},`,
          `"artistData": ${stringifyThings(wikiData.artistData)}`,
        ]
          .filter(Boolean)
          .map(line => '  ' + line)
          .join('\n') +
        '\n}')),
  ].filter(Boolean));
}

function generateRedirectHTML(title, target, {language}) {
  return `<!DOCTYPE html>\n` + html.tag('html', [
    html.tag('head', [
      html.tag('title', language.$('redirectPage.title', {title})),
      html.tag('meta', {charset: 'utf-8'}),

      html.tag('meta', {
        'http-equiv': 'refresh',
        content: `0;url=${target}`,
      }),

      // TODO: Is this OK for localized pages?
      html.tag('link', {
        rel: 'canonical',
        href: target,
      }),
    ]),

    html.tag('body',
      html.tag('main', [
        html.tag('h1',
          language.$('redirectPage.title', {title})),
        html.tag('p',
          language.$('redirectPage.infoLine', {
            target: html.tag('a', {href: target}, target),
          })),
      ])),
  ]);
}

// Wrapper function for running a function once for all languages.
async function wrapLanguages(fn, {languages, writeOneLanguage = null}) {
  const k = writeOneLanguage;
  const languagesToRun = k ? {[k]: languages[k]} : languages;

  const entries = Object.entries(languagesToRun).filter(
    ([key]) => key !== 'default'
  );

  for (let i = 0; i < entries.length; i++) {
    const [_key, language] = entries[i];

    await fn(language, i, entries);
  }
}

async function main() {
  Error.stackTraceLimit = Infinity;

  const WD = wikiData;

  WD.listingSpec = listingSpec;
  WD.listingTargetSpec = listingTargetSpec;

  const miscOptions = await parseOptions(process.argv.slice(2), {
    // Data files for the site, including flash, artist, and al8um data,
    // and like a jillion other things too. Pretty much everything which
    // makes an individual wiki what it is goes here!
    'data-path': {
      type: 'value',
    },

    // Static media will 8e referenced in the site here! The contents are
    // categorized; check out MEDIA_ALBUM_ART_DIRECTORY and other constants
    // near the top of this file (upd8.js).
    'media-path': {
      type: 'value',
    },

    // String files! For the most part, this is used for translating the
    // site to different languages, though you can also customize strings
    // for your own 8uild of the site if you'd like. Files here should all
    // match the format in strings-default.json in this repository. (If a
    // language file is missing any strings, the site code will fall 8ack
    // to what's specified in strings-default.json.)
    //
    // Unlike the other options here, this one's optional - the site will
    // 8uild with the default (English) strings if this path is left
    // unspecified.
    'lang-path': {
      type: 'value',
    },

    // This is the output directory. It's the one you'll upload online with
    // rsync or whatever when you're pushing an upd8, and also the one
    // you'd archive if you wanted to make a 8ackup of the whole dang
    // site. Just keep in mind that the gener8ted result will contain a
    // couple symlinked directories, so if you're uploading, you're pro8a8ly
    // gonna want to resolve those yourself.
    'out-path': {
      type: 'value',
    },

    // Thum8nail gener8tion is *usually* something you want, 8ut it can 8e
    // kinda a pain to run every time, since it does necessit8te reading
    // every media file at run time. Pass this to skip it.
    'skip-thumbs': {
      type: 'flag',
    },

    // Or, if you *only* want to gener8te newly upd8ted thum8nails, you can
    // pass this flag! It exits 8efore 8uilding the rest of the site.
    'thumbs-only': {
      type: 'flag',
    },

    // Just working on data entries and not interested in actually
    // generating site HTML yet? This flag will cut execution off right
    // 8efore any site 8uilding actually happens.
    'no-build': {
      type: 'flag',
    },

    // Only want to 8uild one language during testing? This can chop down
    // 8uild times a pretty 8ig chunk! Just pass a single language code.
    lang: {
      type: 'value',
    },

    // Working without a dev server and just using file:// URLs in your we8
    // 8rowser? This will automatically append index.html to links across
    // the site. Not recommended for production, since it isn't guaranteed
    // 100% error-free (and index.html-style links are less pretty anyway).
    'append-index-html': {
      type: 'flag',
    },

    // Want sweet, sweet trace8ack info in aggreg8te error messages? This
    // will print all the juicy details (or at least the first relevant
    // line) right to your output, 8ut also pro8a8ly give you a headache
    // 8ecause wow that is a lot of visual noise.
    'show-traces': {
      type: 'flag',
    },

    'queue-size': {
      type: 'value',
      validate(size) {
        if (parseInt(size) !== parseFloat(size)) return 'an integer';
        if (parseInt(size) < 0) return 'a counting number or zero';
        return true;
      },
    },
    queue: {alias: 'queue-size'},

    // This option is super slow and has the potential for bugs! It puts
    // CacheableObject in a mode where every instance is a Proxy which will
    // keep track of invalid property accesses.
    'show-invalid-property-accesses': {
      type: 'flag',
    },

    // Compute ALL data properties before moving on to building. This ensures
    // writes are processed at a stable speed (since they don't have to perform
    // any additional data computation besides what is done for the page
    // itself), but it'll also take a long while for the initial caching to
    // complete. This shouldn't have any overall difference on efficiency as
    // it's the same amount of processing being done regardless; the option is
    // mostly present for optimization testing (i.e. if you want to focus on
    // efficiency of data calculation or write generation separately instead of
    // mixed together).
    'precache-data': {
      type: 'flag',
    },

    [parseOptions.handleUnknown]: () => {},
  });

  dataPath = miscOptions['data-path'] || process.env.HSMUSIC_DATA;
  mediaPath = miscOptions['media-path'] || process.env.HSMUSIC_MEDIA;
  langPath = miscOptions['lang-path'] || process.env.HSMUSIC_LANG; // Can 8e left unset!
  outputPath = miscOptions['out-path'] || process.env.HSMUSIC_OUT;

  const writeOneLanguage = miscOptions['lang'];

  {
    let errored = false;
    const error = (cond, msg) => {
      if (cond) {
        console.error(`\x1b[31;1m${msg}\x1b[0m`);
        errored = true;
      }
    };
    error(!dataPath, `Expected --data-path option or HSMUSIC_DATA to be set`);
    error(!mediaPath, `Expected --media-path option or HSMUSIC_MEDIA to be set`);
    error(!outputPath, `Expected --out-path option or HSMUSIC_OUT to be set`);
    if (errored) {
      return;
    }
  }

  const appendIndexHTML = miscOptions['append-index-html'] ?? false;
  if (appendIndexHTML) {
    logWarn`Appending index.html to link hrefs. (Note: not recommended for production release!)`;
    unbound_link.globalOptions.appendIndexHTML = true;
  }

  const skipThumbs = miscOptions['skip-thumbs'] ?? false;
  const thumbsOnly = miscOptions['thumbs-only'] ?? false;
  const noBuild = miscOptions['no-build'] ?? false;
  const showAggregateTraces = miscOptions['show-traces'] ?? false;
  const precacheData = miscOptions['precache-data'] ?? false;

  // NOT for ena8ling or disa8ling specific features of the site!
  // This is only in charge of what general groups of files to 8uild.
  // They're here to make development quicker when you're only working
  // on some particular area(s) of the site rather than making changes
  // across all of them.
  const writeFlags = await parseOptions(process.argv.slice(2), {
    all: {type: 'flag'}, // Defaults to true if none 8elow specified.

    // Kinda a hack t8h!
    ...Object.fromEntries(
      Object.keys(pageSpecs).map((key) => [key, {type: 'flag'}])
    ),

    [parseOptions.handleUnknown]: () => {},
  });

  const writeAll = !Object.keys(writeFlags).length || writeFlags.all;

  logInfo`Writing site pages: ${
    writeAll ? 'all' : Object.keys(writeFlags).join(', ')
  }`;

  const niceShowAggregate = (error, ...opts) => {
    showAggregate(error, {
      showTraces: showAggregateTraces,
      pathToFileURL: (f) => path.relative(__dirname, fileURLToPath(f)),
      ...opts,
    });
  };

  if (skipThumbs && thumbsOnly) {
    logInfo`Well, you've put yourself rather between a roc and a hard place, hmmmm?`;
    return;
  }

  if (skipThumbs) {
    logInfo`Skipping thumbnail generation.`;
  } else {
    logInfo`Begin thumbnail generation... -----+`;
    const result = await genThumbs(mediaPath, {queueSize, quiet: true});
    logInfo`Done thumbnail generation! --------+`;
    if (!result) return;
    if (thumbsOnly) return;
  }

  const showInvalidPropertyAccesses =
    miscOptions['show-invalid-property-accesses'] ?? false;

  if (showInvalidPropertyAccesses) {
    CacheableObject.DEBUG_SLOW_TRACK_INVALID_PROPERTIES = true;
  }

  const {aggregate: processDataAggregate, result: wikiDataResult} =
    await loadAndProcessDataDocuments({dataPath});

  Object.assign(wikiData, wikiDataResult);

  {
    const logThings = (thingDataProp, label) =>
      logInfo` - ${wikiData[thingDataProp]?.length ?? color.red('(Missing!)')} ${color.normal(color.dim(label))}`;
    try {
      logInfo`Loaded data and processed objects:`;
      logThings('albumData', 'albums');
      logThings('trackData', 'tracks');
      logThings('artistData', 'artists');
      if (wikiData.flashData) {
        logThings('flashData', 'flashes');
        logThings('flashActData', 'flash acts');
      }
      logThings('groupData', 'groups');
      logThings('groupCategoryData', 'group categories');
      logThings('artTagData', 'art tags');
      if (wikiData.newsData) {
        logThings('newsData', 'news entries');
      }
      logThings('staticPageData', 'static pages');
      if (wikiData.homepageLayout) {
        logInfo` - ${1} homepage layout (${
          wikiData.homepageLayout.rows.length
        } rows)`;
      }
      if (wikiData.wikiInfo) {
        logInfo` - ${1} wiki config file`;
      }
    } catch (error) {
      console.error(`Error showing data summary:`, error);
    }

    let errorless = true;
    try {
      processDataAggregate.close();
    } catch (error) {
      niceShowAggregate(error);
      logWarn`The above errors were detected while processing data files.`;
      logWarn`If the remaining valid data is complete enough, the wiki will`;
      logWarn`still build - but all errored data will be skipped.`;
      logWarn`(Resolve errors for more complete output!)`;
      errorless = false;
    }

    if (errorless) {
      logInfo`All data processed without any errors - nice!`;
      logInfo`(This means all source files will be fully accounted for during page generation.)`;
    }
  }

  if (!WD.wikiInfo) {
    logError`Can't proceed without wiki info file (${WIKI_INFO_FILE}) successfully loading`;
    return;
  }

  let duplicateDirectoriesErrored = false;

  function filterAndShowDuplicateDirectories() {
    const aggregate = filterDuplicateDirectories(wikiData);
    let errorless = true;
    try {
      aggregate.close();
    } catch (aggregate) {
      niceShowAggregate(aggregate);
      logWarn`The above duplicate directories were detected while reviewing data files.`;
      logWarn`Each thing listed above will been totally excempt from this build of the site!`;
      logWarn`Specify unique 'Directory' fields in data entries to resolve these.`;
      logWarn`${`Note:`} This will probably result in reference errors below.`;
      logWarn`${`. . .`} You should fix duplicate directories first!`;
      logWarn`(Resolve errors for more complete output!)`;
      duplicateDirectoriesErrored = true;
      errorless = false;
    }
    if (errorless) {
      logInfo`No duplicate directories found - nice!`;
    }
  }

  function filterAndShowReferenceErrors() {
    const aggregate = filterReferenceErrors(wikiData);
    let errorless = true;
    try {
      aggregate.close();
    } catch (error) {
      niceShowAggregate(error);
      logWarn`The above errors were detected while validating references in data files.`;
      logWarn`If the remaining valid data is complete enough, the wiki will still build -`;
      logWarn`but all errored references will be skipped.`;
      if (duplicateDirectoriesErrored) {
        logWarn`${`Note:`} Duplicate directories were found as well. Review those first,`;
        logWarn`${`. . .`} as they may have caused some of the errors detected above.`;
      }
      logWarn`(Resolve errors for more complete output!)`;
      errorless = false;
    }
    if (errorless) {
      logInfo`All references validated without any errors - nice!`;
      logInfo`(This means all references between things, such as leitmotif references`;
      logInfo` and artist credits, will be fully accounted for during page generation.)`;
    }
  }

  // Link data arrays so that all essential references between objects are
  // complete, so properties (like dates!) are inherited where that's
  // appropriate.
  linkWikiDataArrays(wikiData);

  // Filter out any things with duplicate directories throughout the data,
  // warning about them too.
  filterAndShowDuplicateDirectories();

  // Filter out any reference errors throughout the data, warning about them
  // too.
  filterAndShowReferenceErrors();

  // Sort data arrays so that they're all in order! This may use properties
  // which are only available after the initial linking.
  sortWikiDataArrays(wikiData);

  if (precacheData) {
    progressCallAll('Caching all data values', Object.entries(wikiData)
      .filter(([key]) =>
        key !== 'listingSpec' &&
        key !== 'listingTargetSpec' &&
        key !== 'officialAlbumData' &&
        key !== 'fandomAlbumData')
      .map(([key, value]) =>
        key === 'wikiInfo' ? [key, [value]] :
        key === 'homepageLayout' ? [key, [value]] :
        [key, value])
      .flatMap(([_key, things]) => things)
      .map(thing => () => CacheableObject.cacheAllExposedProperties(thing)));
  }

  const internalDefaultLanguage = await processLanguageFile(
    path.join(__dirname, DEFAULT_STRINGS_FILE)
  );

  let languages;
  if (langPath) {
    const languageDataFiles = await findFiles(langPath, {
      filter: (f) => path.extname(f) === '.json',
    });

    const results = await progressPromiseAll(
      `Reading & processing language files.`,
      languageDataFiles.map((file) => processLanguageFile(file))
    );

    languages = Object.fromEntries(
      results.map((language) => [language.code, language])
    );
  } else {
    languages = {};
  }

  const customDefaultLanguage =
    languages[WD.wikiInfo.defaultLanguage ?? internalDefaultLanguage.code];
  let finalDefaultLanguage;

  if (customDefaultLanguage) {
    logInfo`Applying new default strings from custom ${customDefaultLanguage.code} language file.`;
    customDefaultLanguage.inheritedStrings = internalDefaultLanguage.strings;
    finalDefaultLanguage = customDefaultLanguage;
  } else if (WD.wikiInfo.defaultLanguage) {
    logError`Wiki info file specified default language is ${WD.wikiInfo.defaultLanguage}, but no such language file exists!`;
    if (langPath) {
      logError`Check if an appropriate file exists in ${langPath}?`;
    } else {
      logError`Be sure to specify ${'--lang'} or ${'HSMUSIC_LANG'} with the path to language files.`;
    }
    return;
  } else {
    languages[internalDefaultLanguage.code] = internalDefaultLanguage;
    finalDefaultLanguage = internalDefaultLanguage;
  }

  for (const language of Object.values(languages)) {
    if (language === finalDefaultLanguage) {
      continue;
    }

    language.inheritedStrings = finalDefaultLanguage.strings;
  }

  logInfo`Loaded language strings: ${Object.keys(languages).join(', ')}`;

  if (noBuild) {
    logInfo`Not generating any site or page files this run (--no-build passed).`;
  } else if (writeOneLanguage && !(writeOneLanguage in languages)) {
    logError`Specified to write only ${writeOneLanguage}, but there is no strings file with this language code!`;
    return;
  } else if (writeOneLanguage) {
    logInfo`Writing only language ${writeOneLanguage} this run.`;
  } else {
    logInfo`Writing all languages.`;
  }

  {
    const tagRefs = new Set(
      [...WD.trackData, ...WD.albumData]
        .flatMap((thing) => thing.artTagsByRef ?? []));

    for (const ref of tagRefs) {
      if (find.artTag(ref, WD.artTagData)) {
        tagRefs.delete(ref);
      }
    }

    if (tagRefs.size) {
      for (const ref of Array.from(tagRefs).sort()) {
        console.log(`\x1b[33;1m- Missing tag: "${ref}"\x1b[0m`);
      }
      return;
    }
  }

  WD.officialAlbumData = WD.albumData
    .filter((album) => album.groups.some((group) => group.directory === OFFICIAL_GROUP_DIRECTORY));
  WD.fandomAlbumData = WD.albumData
    .filter((album) => album.groups.every((group) => group.directory !== OFFICIAL_GROUP_DIRECTORY));

  const fileSizePreloader = new FileSizePreloader();

  // File sizes of additional files need to be precalculated before we can
  // actually reference 'em in site building, so get those loading right
  // away. We actually need to keep track of two things here - the on-device
  // file paths we're actually reading, and the corresponding on-site media
  // paths that will be exposed in site build code. We'll build a mapping
  // function between them so that when site code requests a site path,
  // it'll get the size of the file at the corresponding device path.
  const additionalFilePaths = [
    ...WD.albumData.flatMap((album) =>
      [
        ...(album.additionalFiles ?? []),
        ...album.tracks.flatMap((track) => track.additionalFiles ?? []),
      ]
        .flatMap((fileGroup) => fileGroup.files)
        .map((file) => ({
          device: path.join(
            mediaPath,
            urls
              .from('media.root')
              .toDevice('media.albumAdditionalFile', album.directory, file)
          ),
          media: urls
            .from('media.root')
            .to('media.albumAdditionalFile', album.directory, file),
        }))
    ),
  ];

  const getSizeOfAdditionalFile = (mediaPath) => {
    const {device} =
      additionalFilePaths.find(({media}) => media === mediaPath) || {};
    if (!device) return null;
    return fileSizePreloader.getSizeOfPath(device);
  };

  logInfo`Preloading filesizes for ${additionalFilePaths.length} additional files...`;

  fileSizePreloader.loadPaths(...additionalFilePaths.map((path) => path.device));
  await fileSizePreloader.waitUntilDoneLoading();

  logInfo`Done preloading filesizes!`;

  if (noBuild) return;

  // Makes writing a little nicer on CPU theoretically, 8ut also costs in
  // performance right now 'cuz it'll w8 for file writes to 8e completed
  // 8efore moving on to more data processing. So, defaults to zero, which
  // disa8les the queue feature altogether.
  queueSize = +(miscOptions['queue-size'] ?? 0);

  const buildDictionary = pageSpecs;

  await writeFavicon();
  await writeSymlinks();
  await writeSharedFilesAndPages({language: finalDefaultLanguage, wikiData});

  const buildSteps = writeAll
    ? Object.entries(buildDictionary)
    : Object.entries(buildDictionary).filter(([flag]) => writeFlags[flag]);

  let writes;
  {
    let error = false;

    const buildStepsWithTargets = buildSteps
      .map(([flag, pageSpec]) => {
        // Condition not met: skip this build step altogether.
        if (pageSpec.condition && !pageSpec.condition({wikiData})) {
          return null;
        }

        // May still call writeTargetless if present.
        if (!pageSpec.targets) {
          return {flag, pageSpec, targets: []};
        }

        if (!pageSpec.write) {
          logError`${flag + '.targets'} is specified, but ${flag + '.write'} is missing!`;
          error = true;
          return null;
        }

        const targets = pageSpec.targets({wikiData});
        if (!Array.isArray(targets)) {
          logError`${flag + '.targets'} was called, but it didn't return an array! (${typeof targets})`;
          error = true;
          return null;
        }

        return {flag, pageSpec, targets};
      })
      .filter(Boolean);

    if (error) {
      return;
    }

    const validateWrites = (writes, fnName) => {
      // Do a quick valid8tion! If one of the writeThingPages functions go
      // wrong, this will stall out early and tell us which did.

      if (!Array.isArray(writes)) {
        logError`${fnName} didn't return an array!`;
        error = true;
        return false;
      }

      if (
        !(
          writes.every((obj) => typeof obj === 'object') &&
          writes.every((obj) => {
            const result = validateWriteObject(obj);
            if (result.error) {
              logError`Validating write object failed: ${result.error}`;
              return false;
            } else {
              return true;
            }
          })
        )
      ) {
        logError`${fnName} returned invalid entries!`;
        error = true;
        return false;
      }

      return true;
    };

    // return;

    writes = progressCallAll('Computing page & data writes.', buildStepsWithTargets.flatMap(({flag, pageSpec, targets}) => {
      const writesFns = targets.map(target => () => {
        const writes = pageSpec.write(target, {wikiData})?.slice() || [];
        return validateWrites(writes, flag + '.write') ? writes : [];
      });

      if (pageSpec.writeTargetless) {
        writesFns.push(() => {
          const writes = pageSpec.writeTargetless({wikiData});
          return validateWrites(writes, flag + '.writeTargetless') ? writes : [];
        });
      }

      return writesFns;
    })).flat();

    if (error) {
      return;
    }
  }

  const pageWrites = writes.filter(({type}) => type === 'page');
  const dataWrites = writes.filter(({type}) => type === 'data');
  const redirectWrites = writes.filter(({type}) => type === 'redirect');

  if (writes.length) {
    logInfo`Total of ${writes.length} writes returned. (${pageWrites.length} page, ${dataWrites.length} data [currently skipped], ${redirectWrites.length} redirect)`;
  } else {
    logWarn`No writes returned at all, so exiting early. This is probably a bug!`;
    return;
  }

  /*
  await progressPromiseAll(`Writing data files shared across languages.`, queue(
    dataWrites.map(({path, data}) => () => {
      const bound = {};

      bound.serializeLink = bindOpts(serializeLink, {});

      bound.serializeContribs = bindOpts(serializeContribs, {});

      bound.serializeImagePaths = bindOpts(serializeImagePaths, {
        thumb
      });

      bound.serializeCover = bindOpts(serializeCover, {
        [bindOpts.bindIndex]: 2,
        serializeImagePaths: bound.serializeImagePaths,
        urls
      });

      bound.serializeGroupsForAlbum = bindOpts(serializeGroupsForAlbum, {
        serializeLink
      });

      bound.serializeGroupsForTrack = bindOpts(serializeGroupsForTrack, {
        serializeLink
      });

      // TODO: This only supports one <>-style argument.
      return writeData(path[0], path[1], data({...bound}));
    }),
    queueSize
  ));
  */

  const perLanguageFn = async (language, i, entries) => {
    const baseDirectory =
      language === finalDefaultLanguage ? '' : language.code;

    console.log(`\x1b[34;1m${`[${i + 1}/${entries.length}] ${language.code} (-> /${baseDirectory}) `.padEnd(60, '-')}\x1b[0m`);

    await progressPromiseAll(`Writing ${language.code}`, queue([
      ...pageWrites.map((props) => () => {
        const {path, page} = props;

        const pageSubKey = path[0];
        const urlArgs = path.slice(1);

        const localizedPaths = Object.fromEntries(
          Object.entries(languages)
            .filter(([key, language]) =>
              key !== 'default' &&
              !language.hidden)
            .map(([_key, language]) => [
              language.code,
              getPagePaths({
                baseDirectory:
                  (language === finalDefaultLanguage
                    ? ''
                    : language.code),
                fullKey: 'localized.' + pageSubKey,
                urlArgs,
              }),
            ]));

        const paths = getPagePaths({
          baseDirectory,
          fullKey: 'localized.' + pageSubKey,
          urlArgs,
        });

        const to = getURLsFrom({
          baseDirectory,
          pageSubKey,
          paths,
        });

        const absoluteTo = (targetFullKey, ...args) => {
          const [groupKey, subKey] = targetFullKey.split('.');
          const from = urls.from('shared.root');
          return (
            '/' +
            (groupKey === 'localized' && baseDirectory
              ? from.to(
                  'localizedWithBaseDirectory.' + subKey,
                  baseDirectory,
                  ...args
                )
              : from.to(targetFullKey, ...args))
          );
        };

        // TODO: Is there some nicer way to define these,
        // may8e without totally re-8inding everything for
        // each page?
        const bound = {};

        bound.html = html;

        bound.getColors = bindOpts(getColors, {
          chroma,
        });

        bound.getLinkThemeString = bindOpts(unbound_getLinkThemeString, {
          getColors: bound.getColors,
        });

        bound.getThemeString = bindOpts(unbound_getThemeString, {
          getColors: bound.getColors,
        });

        bound.link = withEntries(unbound_link, (entries) =>
          entries
            .map(([key, fn]) => [key, bindOpts(fn, {
              getLinkThemeString: bound.getLinkThemeString,
              to,
            })]));

        bound.parseAttributes = bindOpts(parseAttributes, {
          to,
        });

        bound.find = bindFind(wikiData, {mode: 'warn'});

        bound.transformInline = bindOpts(transformInline, {
          find: bound.find,
          link: bound.link,
          replacerSpec,
          language,
          to,
          wikiData,
        });

        bound.transformMultiline = bindOpts(transformMultiline, {
          transformInline: bound.transformInline,
          parseAttributes: bound.parseAttributes,
        });

        bound.transformLyrics = bindOpts(transformLyrics, {
          transformInline: bound.transformInline,
          transformMultiline: bound.transformMultiline,
        });

        bound.iconifyURL = bindOpts(iconifyURL, {
          html,
          language,
          to,
        });

        bound.fancifyURL = bindOpts(fancifyURL, {
          html,
          language,
        });

        bound.fancifyFlashURL = bindOpts(fancifyFlashURL, {
          [bindOpts.bindIndex]: 2,
          html,
          language,

          fancifyURL: bound.fancifyURL,
        });

        bound.getRevealStringFromWarnings = bindOpts(getRevealStringFromWarnings, {
          html,
          language,
        });

        bound.getRevealStringFromTags = bindOpts(getRevealStringFromTags, {
          language,

          getRevealStringFromWarnings: bound.getRevealStringFromWarnings,
        });

        bound.getArtistString = bindOpts(getArtistString, {
          html,
          link: bound.link,
          language,

          iconifyURL: bound.iconifyURL,
        });

        bound.getAlbumCover = bindOpts(getAlbumCover, {
          to,
        });

        bound.getTrackCover = bindOpts(getTrackCover, {
          to,
        });

        bound.getFlashCover = bindOpts(getFlashCover, {
          to,
        });

        bound.getArtistAvatar = bindOpts(getArtistAvatar, {
          to,
        });

        bound.generateAdditionalFilesShortcut = bindOpts(generateAdditionalFilesShortcut, {
          html,
          language,
        });

        bound.generateAdditionalFilesList = bindOpts(generateAdditionalFilesList, {
          html,
          language,
        });

        bound.generateNavigationLinks = bindOpts(generateNavigationLinks, {
          link: bound.link,
          language,
        });

        bound.generateStickyHeadingContainer = bindOpts(generateStickyHeadingContainer, {
          [bindOpts.bindIndex]: 0,
          getRevealStringFromTags: bound.getRevealStringFromTags,
          html,
          img,
        });

        bound.generateChronologyLinks = bindOpts(generateChronologyLinks, {
          html,
          language,
          link: bound.link,
          wikiData,

          generateNavigationLinks: bound.generateNavigationLinks,
        });

        bound.generateCoverLink = bindOpts(generateCoverLink, {
          [bindOpts.bindIndex]: 0,
          html,
          img,
          link: bound.link,
          language,
          to,
          wikiData,

          getRevealStringFromTags: bound.getRevealStringFromTags,
        });

        bound.generateInfoGalleryLinks = bindOpts(generateInfoGalleryLinks, {
          [bindOpts.bindIndex]: 2,
          link: bound.link,
          language,
        });

        bound.generateTrackListDividedByGroups = bindOpts(generateTrackListDividedByGroups, {
          html,
          language,
          wikiData,
        });

        bound.getGridHTML = bindOpts(getGridHTML, {
          [bindOpts.bindIndex]: 0,
          img,
          html,
          language,

          getRevealStringFromTags: bound.getRevealStringFromTags,
        });

        bound.getAlbumGridHTML = bindOpts(getAlbumGridHTML, {
          [bindOpts.bindIndex]: 0,
          link: bound.link,
          language,

          getAlbumCover: bound.getAlbumCover,
          getGridHTML: bound.getGridHTML,
        });

        bound.getFlashGridHTML = bindOpts(getFlashGridHTML, {
          [bindOpts.bindIndex]: 0,
          link: bound.link,

          getFlashCover: bound.getFlashCover,
          getGridHTML: bound.getGridHTML,
        });

        bound.getCarouselHTML = bindOpts(getCarouselHTML, {
          [bindOpts.bindIndex]: 0,
          img,
          html,
        })

        bound.getAlbumStylesheet = bindOpts(getAlbumStylesheet, {
          to,
        });

        const pageInfo = page({
          ...bound,

          language,

          absoluteTo,
          relativeTo: to,
          to,
          urls,

          getSizeOfAdditionalFile,
        });

        const oEmbedJSON = generateOEmbedJSON(pageInfo, {
          language,
          wikiData,
        });

        const oEmbedJSONHref =
          oEmbedJSON &&
          wikiData.wikiInfo.canonicalBase &&
          wikiData.wikiInfo.canonicalBase +
            urls
              .from('shared.root')
              .to('shared.path', paths.pathname + OEMBED_JSON_FILE);

        const pageHTML = generateDocumentHTML(pageInfo, {
          defaultLanguage: finalDefaultLanguage,
          getThemeString: bound.getThemeString,
          language,
          languages,
          localizedPaths,
          oEmbedJSONHref,
          paths,
          to,
          transformMultiline: bound.transformMultiline,
          wikiData,
        });

        return writePage({
          html: pageHTML,
          oEmbedJSON,
          paths,
        });
      }),
      ...redirectWrites.map(({fromPath, toPath, title: titleFn}) => () => {
        const title = titleFn({
          language,
        });

        const from = getPagePaths({
          baseDirectory,
          fullKey: 'localized.' + fromPath[0],
          urlArgs: fromPath.slice(1),
        });

        const to = getURLsFrom({
          baseDirectory,
          pageSubKey: fromPath[0],
          paths: from,
        });

        const target = to('localized.' + toPath[0], ...toPath.slice(1));
        const html = generateRedirectHTML(title, target, {language});
        return writePage({html, paths: from});
      }),
    ], queueSize));
  };

  await wrapLanguages(perLanguageFn, {
    languages,
    writeOneLanguage,
  });

  // The single most important step.
  logInfo`Written!`;
}

// TODO: isMain detection isn't consistent across platforms here
/* eslint-disable-next-line no-constant-condition */
if (true || isMain(import.meta.url) || path.basename(process.argv[1]) === 'hsmusic') {
  main()
    .catch((error) => {
      if (error instanceof AggregateError) {
        showAggregate(error);
      } else {
        console.error(error);
      }
    })
    .then(() => {
      decorateTime.displayTime();
      CacheableObject.showInvalidAccesses();
    });
}