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
|
<?php
/**
* Preparation for the final page rendering.
*
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation; either version 2 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License along
* with this program; if not, write to the Free Software Foundation, Inc.,
* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
* http://www.gnu.org/copyleft/gpl.html
*
* @file
*/
namespace MediaWiki\Output;
use Article;
use CSSJanus;
use Exception;
use File;
use HtmlArmor;
use InvalidArgumentException;
use MediaWiki\Cache\LinkCache;
use MediaWiki\Config\Config;
use MediaWiki\Content\Content;
use MediaWiki\Content\JavaScriptContent;
use MediaWiki\Content\TextContent;
use MediaWiki\Context\ContextSource;
use MediaWiki\Context\IContextSource;
use MediaWiki\Context\RequestContext;
use MediaWiki\Debug\DeprecationHelper;
use MediaWiki\Debug\MWDebug;
use MediaWiki\HookContainer\ProtectedHookAccessorTrait;
use MediaWiki\Html\Html;
use MediaWiki\Language\Language;
use MediaWiki\Language\LanguageCode;
use MediaWiki\Linker\LinkTarget;
use MediaWiki\MainConfigNames;
use MediaWiki\MediaWikiServices;
use MediaWiki\Message\Message;
use MediaWiki\Page\PageRecord;
use MediaWiki\Page\PageReference;
use MediaWiki\Parser\Parser;
use MediaWiki\Parser\ParserOptions;
use MediaWiki\Parser\ParserOutput;
use MediaWiki\Parser\ParserOutputFlags;
use MediaWiki\Parser\Sanitizer;
use MediaWiki\Permissions\PermissionStatus;
use MediaWiki\Registration\ExtensionRegistry;
use MediaWiki\Request\ContentSecurityPolicy;
use MediaWiki\Request\FauxRequest;
use MediaWiki\Request\WebRequest;
use MediaWiki\ResourceLoader as RL;
use MediaWiki\ResourceLoader\ResourceLoader;
use MediaWiki\Session\SessionManager;
use MediaWiki\SpecialPage\SpecialPage;
use MediaWiki\Title\Title;
use MediaWiki\Title\TitleValue;
use MediaWiki\Utils\MWTimestamp;
use OOUI\Element;
use OOUI\Theme;
use RuntimeException;
use Skin;
use Wikimedia\Assert\Assert;
use Wikimedia\Bcp47Code\Bcp47Code;
use Wikimedia\LightweightObjectStore\ExpirationAwareness;
use Wikimedia\Message\MessageSpecifier;
use Wikimedia\Parsoid\Core\LinkTarget as ParsoidLinkTarget;
use Wikimedia\Parsoid\Core\TOCData;
use Wikimedia\Rdbms\IResultWrapper;
use Wikimedia\RelPath;
use Wikimedia\WrappedString;
use Wikimedia\WrappedStringList;
/**
* This is one of the Core classes and should
* be read at least once by any new developers. Also documented at
* https://www.mediawiki.org/wiki/Manual:Architectural_modules/OutputPage
*
* This class is used to prepare the final rendering. A skin is then
* applied to the output parameters (links, javascript, html, categories ...).
*
* @todo FIXME: Another class handles sending the whole page to the client.
*
* Some comments comes from a pairing session between Zak Greant and Antoine Musso
* in November 2010.
*
* @todo document
*/
class OutputPage extends ContextSource {
use ProtectedHookAccessorTrait;
use DeprecationHelper;
/** Output CSP policies as headers */
public const CSP_HEADERS = 'headers';
/** Output CSP policies as meta tags */
public const CSP_META = 'meta';
// Constants for getJSVars()
private const JS_VAR_EARLY = 1;
private const JS_VAR_LATE = 2;
// Core config vars that opt-in to JS_VAR_LATE.
// Extensions use the 'LateJSConfigVarNames' attribute instead.
private const CORE_LATE_JS_CONFIG_VAR_NAMES = [];
/** @var bool Whether setupOOUI() has been called */
private static $oouiSetupDone = false;
/** @var string[][] Should be private. Used with addMeta() which adds "<meta>" */
protected $mMetatags = [];
/** @var array */
protected $mLinktags = [];
/** @var string|false */
protected $mCanonicalUrl = false;
/**
* @var string The contents of <h1>
*/
private $mPageTitle = '';
/**
* @var string The displayed title of the page. Different from page title
* if overridden by display title magic word or hooks. Can contain safe
* HTML. Different from page title which may contain messages such as
* "Editing X" which is displayed in h1. This can be used for other places
* where the page name is referred on the page.
*/
private $displayTitle;
/** @var bool See OutputPage::couldBePublicCached. */
private $cacheIsFinal = false;
/**
* @var string Contains all of the "<body>" content. Should be private we
* got set/get accessors and the append() method.
*/
public $mBodytext = '';
/** @var string Stores contents of "<title>" tag */
private $mHTMLtitle = '';
/**
* @var bool Is the displayed content related to the source of the
* corresponding wiki article.
*/
private $mIsArticle = false;
/** @var bool Stores "article flag" toggle. */
private $mIsArticleRelated = true;
/** @var bool Is the content subject to copyright */
private $mHasCopyright = false;
/**
* @var bool We have to set isPrintable(). Some pages should
* never be printed (ex: redirections).
*/
private $mPrintable = false;
/**
* @var ?TOCData Table of Contents information from ParserOutput, or
* null if no TOCData was ever set.
*/
private $tocData;
/**
* @var array Contains the page subtitle. Special pages usually have some
* links here. Don't confuse with site subtitle added by skins.
*/
private $mSubtitle = [];
/** @var string */
public $mRedirect = '';
/** @var int */
protected $mStatusCode;
/**
* @var string Used for sending cache control.
* The whole caching system should probably be moved into its own class.
*/
protected $mLastModified = '';
/**
* @var string[][]
* @deprecated since 1.38; will be made private (T301020)
*/
private $mCategoryLinks = [];
/**
* @var string[][]
* @deprecated since 1.38, will be made private (T301020)
*/
private $mCategories = [
'hidden' => [],
'normal' => [],
];
/**
* Internal storage for categories on the OutputPage, stored as an array:
* * sortKey: category title text as a sort key,
* * type: category type (hidden,normal)
* * title: category title,
* * link: link string, nullable to support ::setCategoryLinks()
*
* @var list<array{sortKey:string,type:'normal'|'hidden',title:string,link:?string}>
*/
private array $mCategoryData = [];
/**
* Keep track of whether mCategoryData has been
* sorted. We do this on-demand to avoid redundant sorts
* of incremental additions to the category list.
*/
private bool $mCategoriesSorted = true;
/**
* @var string[]
* @deprecated since 1.38; will be made private (T301020)
*/
private $mIndicators = [];
/**
* Used for JavaScript (predates ResourceLoader)
* @todo We should split JS / CSS.
* mScripts content is inserted as is in "<head>" by Skin. This might
* contain either a link to a stylesheet or inline CSS.
* @var string
*/
private $mScripts = '';
/** @var string Inline CSS styles. Use addInlineStyle() sparingly */
protected $mInlineStyles = '';
/**
* Additional <html> classes; This should be rarely modified; prefer mAdditionalBodyClasses.
* @var array
*/
protected $mAdditionalHtmlClasses = [];
/**
* @var string[] Array of elements in "<head>". Parser might add its own headers!
* @deprecated since 1.38; will be made private (T301020)
*/
private $mHeadItems = [];
/** @var array Additional <body> classes; there are also <body> classes from other sources */
protected $mAdditionalBodyClasses = [];
/**
* @var array
* @deprecated since 1.38; will be made private (T301020)
*/
private $mModules = [];
/**
* @var array
* @deprecated since 1.38; will be made private (T301020)
*/
private $mModuleStyles = [];
/** @var ResourceLoader */
protected $mResourceLoader;
/** @var RL\ClientHtml */
private $rlClient;
/** @var RL\Context */
private $rlClientContext;
/** @var array */
private $rlExemptStyleModules;
/**
* @var array
* @deprecated since 1.38; will be made private (T301020)
*/
private $mJsConfigVars = [];
/**
* @var array<int,array<string,int>>
* @deprecated since 1.38; will be made private (T301020)
*/
private $mTemplateIds = [];
/** @var array */
protected $mImageTimeKeys = [];
/** @var string */
public $mRedirectCode = '';
/** @var null */
protected $mFeedLinksAppendQuery = null;
/** @var array
* What level of 'untrustworthiness' is allowed in CSS/JS modules loaded on this page?
* @see RL\Module::$origin
* RL\Module::ORIGIN_ALL is assumed unless overridden;
*/
protected $mAllowedModules = [
RL\Module::TYPE_COMBINED => RL\Module::ORIGIN_ALL,
];
/** @var bool Whether output is disabled. If this is true, the 'output' method will do nothing. */
protected $mDoNothing = false;
// Parser related.
/**
* lazy initialised, use parserOptions()
* @var ParserOptions
*/
protected $mParserOptions = null;
/**
* Handles the Atom / RSS links.
* We probably only support Atom in 2011.
* @see $wgAdvertisedFeedTypes
* @var array
*/
private $mFeedLinks = [];
/**
* @var bool Set to false to send no-cache headers, disabling
* client-side caching. (This variable should really be named
* in the opposite sense; see ::disableClientCache().)
* @deprecated since 1.38; will be made private (T301020)
*/
private $mEnableClientCache = true;
/** @var bool Flag if output should only contain the body of the article. */
private $mArticleBodyOnly = false;
/**
* @var bool
* @deprecated since 1.38; will be made private (T301020)
*/
private $mNewSectionLink = false;
/**
* @var bool
* @deprecated since 1.38; will be made private (T301020)
*/
private $mHideNewSectionLink = false;
/**
* @var bool Comes from the parser. This was probably made to load CSS/JS
* only if we had "<gallery>". Used directly in CategoryViewer.php.
* Looks like ResourceLoader can replace this.
* @deprecated since 1.38; will be made private (T301020)
*/
private $mNoGallery = false;
/** @var int Cache stuff. Looks like mEnableClientCache */
protected $mCdnMaxage = 0;
/** @var int Upper limit on mCdnMaxage */
protected $mCdnMaxageLimit = INF;
/** @var int|null To include the variable {{REVISIONID}} */
private $mRevisionId = null;
/** @var bool|null */
private $mRevisionIsCurrent = null;
/** @var string */
private $mRevisionTimestamp = null;
/** @var array */
protected $mFileVersion = null;
/**
* @var array An array of stylesheet filenames (relative from skins path),
* with options for CSS media, IE conditions, and RTL/LTR direction.
* For internal use; add settings in the skin via $this->addStyle()
*
* Style again! This seems like a code duplication since we already have
* mStyles. This is what makes Open Source amazing.
*/
protected $styles = [];
/** @var string */
private $mFollowPolicy = 'follow';
/** @var array */
private $mRobotsOptions = [ 'max-image-preview' => 'standard' ];
/**
* @var array Headers that cause the cache to vary. Key is header name,
* value should always be null. (Value was an array of options for
* the `Key` header, which was deprecated in 1.32 and removed in 1.34.)
*/
private $mVaryHeader = [
'Accept-Encoding' => null,
];
/**
* If the current page was reached through a redirect, $mRedirectedFrom contains the title
* of the redirect.
*
* @var PageReference
*/
private $mRedirectedFrom = null;
/**
* Additional key => value data
* @var array
*/
private $mProperties = [];
/**
* @var string|null ResourceLoader target for load.php links. If null, will be omitted
*/
private $mTarget = null;
/**
* @var bool Whether parser output contains a table of contents
*/
private $mEnableTOC = false;
/**
* @var array<string,bool> Flags set in the ParserOutput
*/
private $mOutputFlags = [];
/**
* @var string|null The URL to send in a <link> element with rel=license
*/
private $copyrightUrl;
/**
* @var Language|null
*/
private $contentLang;
/** @var array Profiling data */
private $limitReportJSData = [];
/** @var array Map Title to Content */
private $contentOverrides = [];
/** @var callable[] */
private $contentOverrideCallbacks = [];
/**
* Link: header contents
* @var array
*/
private $mLinkHeader = [];
/**
* @var ContentSecurityPolicy
*/
private $CSP;
private string $cspOutputMode = self::CSP_HEADERS;
/**
* To eliminate redundancy between information kept in OutputPage
* for non-article pages and metadata kept by the Parser for
* article pages, we create a ParserOutput for the OutputPage
* which will collect metadata such as categories, index policy,
* modules, etc, even if no parse actually occurs during the
* rendering of this page.
*/
private ParserOutput $metadata;
/**
* @var array A cache of the names of the cookies that will influence the cache
*/
private static $cacheVaryCookies = null;
/**
* Constructor for OutputPage. This should not be called directly.
* Instead a new RequestContext should be created and it will implicitly create
* a OutputPage tied to that context.
* @param IContextSource $context
*/
public function __construct( IContextSource $context ) {
$this->deprecatePublicProperty( 'mCategoryLinks', '1.38', __CLASS__ );
$this->deprecatePublicProperty( 'mCategories', '1.38', __CLASS__ );
$this->deprecatePublicProperty( 'mIndicators', '1.38', __CLASS__ );
$this->deprecatePublicProperty( 'mHeadItems', '1.38', __CLASS__ );
$this->deprecatePublicProperty( 'mModules', '1.38', __CLASS__ );
$this->deprecatePublicProperty( 'mModuleStyles', '1.38', __CLASS__ );
$this->deprecatePublicProperty( 'mJsConfigVars', '1.38', __CLASS__ );
$this->deprecatePublicProperty( 'mTemplateIds', '1.38', __CLASS__ );
$this->deprecatePublicProperty( 'mEnableClientCache', '1.38', __CLASS__ );
$this->deprecatePublicProperty( 'mNewSectionLink', '1.38', __CLASS__ );
$this->deprecatePublicProperty( 'mHideNewSectionLink', '1.38', __CLASS__ );
$this->deprecatePublicProperty( 'mNoGallery', '1.38', __CLASS__ );
$this->setContext( $context );
$this->metadata = new ParserOutput( null );
$this->metadata->setPreventClickjacking( true ); // OutputPage default
$this->CSP = new ContentSecurityPolicy(
$context->getRequest()->response(),
$context->getConfig(),
$this->getHookContainer()
);
}
/**
* Redirect to $url rather than displaying the normal page
*
* @param string $url
* @param string|int $responsecode HTTP status code
*/
public function redirect( $url, $responsecode = '302' ) {
# Strip newlines as a paranoia check for header injection in PHP<5.1.2
$this->mRedirect = str_replace( "\n", '', $url );
$this->mRedirectCode = (string)$responsecode;
}
/**
* Get the URL to redirect to, or an empty string if not redirect URL set
*
* @return string
*/
public function getRedirect() {
return $this->mRedirect;
}
/**
* Set the copyright URL to send with the output.
* Empty string to omit, null to reset.
*
* @since 1.26
*
* @param string|null $url
*/
public function setCopyrightUrl( $url ) {
$this->copyrightUrl = $url;
}
/**
* Set the HTTP status code to send with the output.
*
* @param int $statusCode
*/
public function setStatusCode( $statusCode ) {
$this->mStatusCode = $statusCode;
}
/**
* Return a ParserOutput that can be used to set metadata properties
* for the current page.
* @return ParserOutput
*/
public function getMetadata(): ParserOutput {
// We can deprecate the redundant
// methods on OutputPage which simply turn around
// and invoke the corresponding method on the metadata
// ParserOutput.
return $this->metadata;
}
/**
* Add a new "<meta>" tag
* To add an http-equiv meta tag, precede the name with "http:"
*
* @param string $name Name of the meta tag
* @param string $val Value of the meta tag
*/
public function addMeta( $name, $val ) {
$this->mMetatags[] = [ $name, $val ];
}
/**
* Returns the current <meta> tags
*
* @since 1.25
* @return array
*/
public function getMetaTags() {
return $this->mMetatags;
}
/**
* Add a new \<link\> tag to the page header.
*
* Note: use setCanonicalUrl() for rel=canonical.
*
* @param array $linkarr Associative array of attributes.
*/
public function addLink( array $linkarr ) {
$this->mLinktags[] = $linkarr;
}
/**
* Returns the current <link> tags
*
* @since 1.25
* @return array
*/
public function getLinkTags() {
return $this->mLinktags;
}
/**
* Set the URL to be used for the <link rel=canonical>. This should be used
* in preference to addLink(), to avoid duplicate link tags.
* @param string $url
*/
public function setCanonicalUrl( $url ) {
$this->mCanonicalUrl = $url;
}
/**
* Returns the URL to be used for the <link rel=canonical> if
* one is set.
*
* @since 1.25
* @return bool|string
*/
public function getCanonicalUrl() {
return $this->mCanonicalUrl;
}
/**
* Add raw HTML to the list of scripts (including \<script\> tag, etc.)
* Internal use only. Use OutputPage::addModules() or OutputPage::addJsConfigVars()
* if possible.
*
* @param string $script Raw HTML
* @param-taint $script exec_html
*/
public function addScript( $script ) {
$this->mScripts .= $script;
}
/**
* Add a JavaScript file to be loaded as `<script>` on this page.
*
* Internal use only. Use OutputPage::addModules() if possible.
*
* @param string $file URL to file (absolute path, protocol-relative, or full url)
* @param string|null $unused Previously used to change the cache-busting query parameter
*/
public function addScriptFile( $file, $unused = null ) {
$this->addScript( Html::linkedScript( $file ) );
}
/**
* Add a self-contained script tag with the given contents
* Internal use only. Use OutputPage::addModules() if possible.
*
* @param string $script JavaScript text, no script tags
* @param-taint $script exec_html
*/
public function addInlineScript( $script ) {
$this->mScripts .= Html::inlineScript( "\n$script\n" ) . "\n";
}
/**
* Filter an array of modules to remove insufficiently trustworthy members, and modules
* which are no longer registered (eg a page is cached before an extension is disabled)
* @param string[] $modules
* @param string|null $position Unused
* @param string $type
* @return string[]
*/
protected function filterModules( array $modules, $position = null,
$type = RL\Module::TYPE_COMBINED
) {
$resourceLoader = $this->getResourceLoader();
$filteredModules = [];
foreach ( $modules as $val ) {
$module = $resourceLoader->getModule( $val );
if ( $module instanceof RL\Module
&& $module->getOrigin() <= $this->getAllowedModules( $type )
) {
$filteredModules[] = $val;
}
}
return $filteredModules;
}
/**
* Get the list of modules to include on this page
*
* @param bool $filter Whether to filter out insufficiently trustworthy modules
* @param string|null $position Unused
* @param string $param
* @param string $type
* @return string[] Array of module names
*/
public function getModules( $filter = false, $position = null, $param = 'mModules',
$type = RL\Module::TYPE_COMBINED
) {
$modules = array_values( array_unique( $this->$param ) );
return $filter
? $this->filterModules( $modules, null, $type )
: $modules;
}
/**
* Load one or more ResourceLoader modules on this page.
*
* @param string|array $modules Module name (string) or array of module names
*/
public function addModules( $modules ) {
$this->mModules = array_merge( $this->mModules, (array)$modules );
}
/**
* Get the list of style-only modules to load on this page.
*
* @param bool $filter
* @param string|null $position Unused
* @return string[] Array of module names
*/
public function getModuleStyles( $filter = false, $position = null ) {
return $this->getModules( $filter, null, 'mModuleStyles',
RL\Module::TYPE_STYLES
);
}
/**
* Load the styles of one or more style-only ResourceLoader modules on this page.
*
* Module styles added through this function will be loaded as a stylesheet,
* using a standard `<link rel=stylesheet>` HTML tag, rather than as a combined
* Javascript and CSS package. Thus, they will even load when JavaScript is disabled.
*
* @param string|array $modules Module name (string) or array of module names
*/
public function addModuleStyles( $modules ) {
$this->mModuleStyles = array_merge( $this->mModuleStyles, (array)$modules );
}
/**
* @return null|string ResourceLoader target
*/
public function getTarget() {
return $this->mTarget;
}
/**
* Force the given Content object for the given page, for things like page preview.
* @see self::addContentOverrideCallback()
* @since 1.32
* @param LinkTarget|PageReference $target
* @param Content $content
*/
public function addContentOverride( $target, Content $content ) {
if ( !$this->contentOverrides ) {
// Register a callback for $this->contentOverrides on the first call
$this->addContentOverrideCallback( function ( $target ) {
$key = $target->getNamespace() . ':' . $target->getDBkey();
return $this->contentOverrides[$key] ?? null;
} );
}
$key = $target->getNamespace() . ':' . $target->getDBkey();
$this->contentOverrides[$key] = $content;
}
/**
* Add a callback for mapping from a Title to a Content object, for things
* like page preview.
* @see RL\Context::getContentOverrideCallback()
* @since 1.32
* @param callable $callback
*/
public function addContentOverrideCallback( callable $callback ) {
$this->contentOverrideCallbacks[] = $callback;
}
/**
* Add a class to the <html> element. This should rarely be used.
* Instead use OutputPage::addBodyClasses() if possible.
*
* @unstable Experimental since 1.35. Prefer OutputPage::addBodyClasses()
* @param string|string[] $classes One or more classes to add
*/
public function addHtmlClasses( $classes ) {
$this->mAdditionalHtmlClasses = array_merge( $this->mAdditionalHtmlClasses, (array)$classes );
}
/**
* Get an array of head items
*
* @return string[]
*/
public function getHeadItemsArray() {
return $this->mHeadItems;
}
/**
* Add or replace a head item to the output
*
* Whenever possible, use more specific options like ResourceLoader modules,
* OutputPage::addLink(), OutputPage::addMeta() and OutputPage::addFeedLink()
* Fallback options for those are: OutputPage::addStyle, OutputPage::addScript(),
* OutputPage::addInlineScript() and OutputPage::addInlineStyle()
* This would be your very LAST fallback.
*
* @param string $name Item name
* @param string $value Raw HTML
* @param-taint $value exec_html
*/
public function addHeadItem( $name, $value ) {
$this->mHeadItems[$name] = $value;
}
/**
* Add one or more head items to the output
*
* @since 1.28
* @param string|string[] $values Raw HTML
* @param-taint $values exec_html
*/
public function addHeadItems( $values ) {
$this->mHeadItems = array_merge( $this->mHeadItems, (array)$values );
}
/**
* Check if the header item $name is already set
*
* @param string $name Item name
* @return bool
*/
public function hasHeadItem( $name ) {
return isset( $this->mHeadItems[$name] );
}
/**
* Add a class to the <body> element
*
* @since 1.30
* @param string|string[] $classes One or more classes to add
*/
public function addBodyClasses( $classes ) {
$this->mAdditionalBodyClasses = array_merge( $this->mAdditionalBodyClasses, (array)$classes );
}
/**
* Set whether the output should only contain the body of the article,
* without any skin, sidebar, etc.
* Used e.g. when calling with "action=render".
*
* @param bool $only Whether to output only the body of the article
*/
public function setArticleBodyOnly( $only ) {
$this->mArticleBodyOnly = $only;
}
/**
* Return whether the output will contain only the body of the article
*
* @return bool
*/
public function getArticleBodyOnly() {
return $this->mArticleBodyOnly;
}
/**
* Set an additional output property
* @since 1.21
*
* @param string $name
* @param mixed $value
*/
public function setProperty( $name, $value ) {
$this->mProperties[$name] = $value;
}
/**
* Get an additional output property
* @since 1.21
*
* @param string $name
* @return mixed Property value or null if not found
*/
public function getProperty( $name ) {
return $this->mProperties[$name] ?? null;
}
/**
* checkLastModified tells the client to use the client-cached page if
* possible. If successful, the OutputPage is disabled so that
* any future call to OutputPage->output() have no effect.
*
* Side effect: sets mLastModified for Last-Modified header
*
* @param string $timestamp
*
* @return bool True if cache-ok headers was sent.
*/
public function checkLastModified( $timestamp ) {
if ( !$timestamp || $timestamp == '19700101000000' ) {
wfDebug( __METHOD__ . ': CACHE DISABLED, NO TIMESTAMP' );
return false;
}
$config = $this->getConfig();
if ( !$config->get( MainConfigNames::CachePages ) ) {
wfDebug( __METHOD__ . ': CACHE DISABLED' );
return false;
}
$timestamp = wfTimestamp( TS_MW, $timestamp );
$modifiedTimes = [
'page' => $timestamp,
'user' => $this->getUser()->getTouched(),
'epoch' => $config->get( MainConfigNames::CacheEpoch )
];
if ( $config->get( MainConfigNames::UseCdn ) ) {
// Ensure Last-Modified is never more than "$wgCdnMaxAge" seconds in the past,
// because even if the wiki page hasn't been edited, other static resources may
// change (site configuration, default preferences, skin HTML, interface messages,
// URLs to other files and services) and must roll-over in a timely manner (T46570)
$modifiedTimes['sepoch'] = wfTimestamp(
TS_MW,
time() - $config->get( MainConfigNames::CdnMaxAge )
);
}
$this->getHookRunner()->onOutputPageCheckLastModified( $modifiedTimes, $this );
$maxModified = max( $modifiedTimes );
$this->mLastModified = wfTimestamp( TS_RFC2822, $maxModified );
$clientHeader = $this->getRequest()->getHeader( 'If-Modified-Since' );
if ( $clientHeader === false ) {
wfDebug( __METHOD__ . ': client did not send If-Modified-Since header', 'private' );
return false;
}
# IE sends sizes after the date like this:
# Wed, 20 Aug 2003 06:51:19 GMT; length=5202
# this breaks strtotime().
$clientHeader = preg_replace( '/;.*$/', '', $clientHeader );
// Ignore timezone warning
// phpcs:ignore Generic.PHP.NoSilencedErrors.Discouraged
$clientHeaderTime = @strtotime( $clientHeader );
if ( !$clientHeaderTime ) {
wfDebug( __METHOD__
. ": unable to parse the client's If-Modified-Since header: $clientHeader" );
return false;
}
$clientHeaderTime = wfTimestamp( TS_MW, $clientHeaderTime );
# Make debug info
$info = '';
foreach ( $modifiedTimes as $name => $value ) {
if ( $info !== '' ) {
$info .= ', ';
}
$info .= "$name=" . wfTimestamp( TS_ISO_8601, $value );
}
wfDebug( __METHOD__ . ': client sent If-Modified-Since: ' .
wfTimestamp( TS_ISO_8601, $clientHeaderTime ), 'private' );
wfDebug( __METHOD__ . ': effective Last-Modified: ' .
wfTimestamp( TS_ISO_8601, $maxModified ), 'private' );
if ( $clientHeaderTime < $maxModified ) {
wfDebug( __METHOD__ . ": STALE, $info", 'private' );
return false;
}
# Not modified
# Give a 304 Not Modified response code and disable body output
wfDebug( __METHOD__ . ": NOT MODIFIED, $info", 'private' );
ini_set( 'zlib.output_compression', 0 );
$this->getRequest()->response()->statusHeader( 304 );
$this->sendCacheControl();
$this->disable();
// Don't output a compressed blob when using ob_gzhandler;
// it's technically against HTTP spec and seems to confuse
// Firefox when the response gets split over two packets.
wfResetOutputBuffers( false );
return true;
}
/**
* Override the last modified timestamp
*
* @param string $timestamp New timestamp, in a format readable by
* wfTimestamp()
*/
public function setLastModified( $timestamp ) {
$this->mLastModified = wfTimestamp( TS_RFC2822, $timestamp );
}
/**
* Set the robot policy for the page: <http://www.robotstxt.org/meta.html>
*
* @param string $policy The literal string to output as the contents of
* the meta tag. Will be parsed according to the spec and output in
* standardized form.
*/
public function setRobotPolicy( $policy ) {
$policy = Article::formatRobotPolicy( $policy );
if ( isset( $policy['index'] ) ) {
$this->setIndexPolicy( $policy['index'] );
}
if ( isset( $policy['follow'] ) ) {
$this->setFollowPolicy( $policy['follow'] );
}
}
/**
* Get the current robot policy for the page as a string in the form
* <index policy>,<follow policy>.
*
* @return string
*/
public function getRobotPolicy() {
$indexPolicy = $this->getIndexPolicy();
return "{$indexPolicy},{$this->mFollowPolicy}";
}
/**
* Format an array of robots options as a string of directives.
*
* @return string The robots policy options.
*/
private function formatRobotsOptions(): string {
$options = $this->mRobotsOptions;
// Check if options array has any non-integer keys.
if ( count( array_filter( array_keys( $options ), 'is_string' ) ) > 0 ) {
// Robots meta tags can have directives that are single strings or
// have parameters that should be formatted like <directive>:<setting>.
// If the options keys are strings, format them accordingly.
// https://developers.google.com/search/docs/advanced/robots/robots_meta_tag
array_walk( $options, static function ( &$value, $key ) {
$value = is_string( $key ) ? "{$key}:{$value}" : "{$value}";
} );
}
return implode( ',', $options );
}
/**
* Set the robots policy with options for the page.
*
* @since 1.38
* @param array $options An array of key-value pairs or a string
* to populate the robots meta tag content attribute as a string.
*/
public function setRobotsOptions( array $options = [] ): void {
$this->mRobotsOptions = array_merge( $this->mRobotsOptions, $options );
}
/**
* Get the robots policy content attribute for the page
* as a string in the form <index policy>,<follow policy>,<options>.
*
* @return string
*/
private function getRobotsContent(): string {
$robotOptionString = $this->formatRobotsOptions();
$robotArgs = ( $this->getIndexPolicy() === 'index' &&
$this->mFollowPolicy === 'follow' ) ?
[] :
[
$this->getIndexPolicy(),
$this->mFollowPolicy,
];
if ( $robotOptionString ) {
$robotArgs[] = $robotOptionString;
}
return implode( ',', $robotArgs );
}
/**
* Set the index policy for the page, but leave the follow policy un-
* touched.
*
* Since 1.43, setting 'index' after 'noindex' is deprecated. In
* a future release, index policy on OutputPage will behave as
* it does in ParserOutput, where 'noindex' takes precedence.
*
* @param string $policy Either 'index' or 'noindex'.
* @deprecated since 1.43; use ->getMetadata()->setIndexPolicy()
* but see note above about the change in behavior when setting
* 'index' after 'noindex'.
*/
public function setIndexPolicy( $policy ) {
$policy = trim( $policy );
if ( $policy === 'index' && $this->metadata->getIndexPolicy() === 'noindex' ) {
wfDeprecated( __METHOD__ . ' with index after noindex', '1.43' );
// ParserOutput::setIndexPolicy has noindex take precedence
// (T16899) but the OutputPage version did not. Preserve
// the behavior but deprecate it for future removal.
$this->metadata->setOutputFlag( ParserOutputFlags::NO_INDEX_POLICY, false );
}
$this->metadata->setIndexPolicy( $policy );
}
/**
* Get the current index policy for the page as a string.
*
* @return string
* @deprecated since 1.43; use ->getMetadata()->getIndexPolicy()
*/
public function getIndexPolicy() {
// Unlike ParserOutput, in OutputPage getIndexPolicy() defaults to
// 'index' if unset.
$policy = $this->metadata->getIndexPolicy();
if ( $policy === '' ) {
$policy = 'index';
}
return $policy;
}
/**
* Set the follow policy for the page, but leave the index policy un-
* touched.
*
* @param string $policy Either 'follow' or 'nofollow'.
*/
public function setFollowPolicy( $policy ) {
$policy = trim( $policy );
if ( in_array( $policy, [ 'follow', 'nofollow' ] ) ) {
$this->mFollowPolicy = $policy;
}
}
/**
* Get the current follow policy for the page as a string.
*
* @return string
*/
public function getFollowPolicy() {
return $this->mFollowPolicy;
}
/**
* "HTML title" means the contents of "<title>".
* It is stored as plain, unescaped text and will be run through htmlspecialchars in the skin file.
*
* @param string|Message $name
*/
public function setHTMLTitle( $name ) {
if ( $name instanceof Message ) {
$this->mHTMLtitle = $name->setContext( $this->getContext() )->text();
} else {
$this->mHTMLtitle = $name;
}
}
/**
* Return the "HTML title", i.e. the content of the "<title>" tag.
*
* @return string
*/
public function getHTMLTitle() {
return $this->mHTMLtitle;
}
/**
* Set $mRedirectedFrom, the page which redirected us to the current page.
*
* @param PageReference $t
*/
public function setRedirectedFrom( PageReference $t ) {
$this->mRedirectedFrom = $t;
}
/**
* "Page title" means the contents of \<h1\>. It is stored as a valid HTML
* fragment. This function allows good tags like \<sup\> in the \<h1\> tag,
* but not bad tags like \<script\>. This function automatically sets
* \<title\> to the same content as \<h1\> but with all tags removed. Bad
* tags that were escaped in \<h1\> will still be escaped in \<title\>, and
* good tags like \<i\> will be dropped entirely.
*
* @param string|Message $name The page title, either as HTML string or
* as a message which will be formatted with FORMAT_TEXT to yield HTML.
* Passing a Message is deprecated, since 1.41; please use
* ::setPageTitleMsg() for that case instead.
* @param-taint $name tainted
* Phan-taint-check gets very confused by $name being either a string or a Message
*/
public function setPageTitle( $name ) {
if ( $name instanceof Message ) {
// T343994: use ::setPageTitleMsg() instead (which uses ::escaped())
wfDeprecated( __METHOD__ . ' with Message argument', '1.41' );
$name = $name->setContext( $this->getContext() )->text();
}
$this->setPageTitleInternal( $name );
}
/**
* "Page title" means the contents of \<h1\>. This message takes a
* Message, which will be formatted with FORMAT_ESCAPED to yield
* HTML. Raw parameters to the message may contain some HTML
* tags; see ::setPageTitle() and Sanitizer::removeSomeTags() for
* details. This function automatically sets \<title\> to the
* same content as \<h1\> but with all tags removed. Bad tags from
* "raw" parameters that were escaped in \<h1\> will still be
* escaped in \<title\>, and good tags like \<i\> will be dropped
* entirely.
*
* @param Message $msg The page title, as a message which will be
* formatted with FORMAT_ESCAPED to yield HTML.
* @since 1.41
*/
public function setPageTitleMsg( Message $msg ): void {
$this->setPageTitleInternal(
$msg->setContext( $this->getContext() )->escaped()
);
}
private function setPageTitleInternal( string $name ): void {
# change "<script>foo&bar</script>" to "<script>foo&bar</script>"
# but leave "<i>foobar</i>" alone
$nameWithTags = Sanitizer::removeSomeTags( $name );
$this->mPageTitle = $nameWithTags;
# change "<i>foo&bar</i>" to "foo&bar"
$this->setHTMLTitle(
$this->msg( 'pagetitle' )->plaintextParams( Sanitizer::stripAllTags( $nameWithTags ) )
->inContentLanguage()
);
}
/**
* Return the "page title", i.e. the content of the \<h1\> tag.
*
* @return string
*/
public function getPageTitle() {
return $this->mPageTitle;
}
/**
* Same as page title but only contains name of the page, not any other text.
*
* @since 1.32
* @param string $html Page title text.
* @see OutputPage::setPageTitle
*/
public function setDisplayTitle( $html ) {
$this->displayTitle = $html;
}
/**
* Returns page display title.
*
* Performs some normalization, but this not as strict the magic word.
*
* @since 1.32
* @return string HTML
*/
public function getDisplayTitle() {
$html = $this->displayTitle;
if ( $html === null ) {
return htmlspecialchars( $this->getTitle()->getPrefixedText(), ENT_NOQUOTES );
}
return Sanitizer::removeSomeTags( $html );
}
/**
* Returns page display title without namespace prefix if possible.
*
* This method is unreliable and best avoided. (T314399)
*
* @since 1.32
* @return string HTML
*/
public function getUnprefixedDisplayTitle() {
$service = MediaWikiServices::getInstance();
$languageConverter = $service->getLanguageConverterFactory()
->getLanguageConverter( $service->getContentLanguage() );
$text = $this->getDisplayTitle();
// Create a regexp with matching groups as placeholders for the namespace, separator and main text
$pageTitleRegexp = '/^' . str_replace(
preg_quote( '(.+?)', '/' ),
'(.+?)',
preg_quote( Parser::formatPageTitle( '(.+?)', '(.+?)', '(.+?)' ), '/' )
) . '$/';
$matches = [];
if ( preg_match( $pageTitleRegexp, $text, $matches ) ) {
// The regexp above could be manipulated by malicious user input,
// sanitize the result just in case
return Sanitizer::removeSomeTags( $matches[3] );
}
$nsPrefix = $languageConverter->convertNamespace(
$this->getTitle()->getNamespace()
) . ':';
$prefix = preg_quote( $nsPrefix, '/' );
return preg_replace( "/^$prefix/i", '', $text );
}
/**
* Set the Title object to use
*
* @param PageReference $t
*/
public function setTitle( PageReference $t ) {
$t = Title::newFromPageReference( $t );
// @phan-suppress-next-next-line PhanUndeclaredMethod
// @fixme Not all implementations of IContextSource have this method!
$this->getContext()->setTitle( $t );
}
/**
* Replace the subtitle with $str
*
* @param string|Message $str New value of the subtitle. String should be safe HTML.
*/
public function setSubtitle( $str ) {
$this->clearSubtitle();
$this->addSubtitle( $str );
}
/**
* Add $str to the subtitle
*
* @param string|Message $str String or Message to add to the subtitle. String should be safe HTML.
* @param-taint $str exec_html
*/
public function addSubtitle( $str ) {
if ( $str instanceof Message ) {
$this->mSubtitle[] = $str->setContext( $this->getContext() )->parse();
} else {
$this->mSubtitle[] = $str;
}
}
/**
* Build message object for a subtitle containing a backlink to a page
*
* @since 1.25
* @param PageReference $page Title to link to
* @param array $query Array of additional parameters to include in the link
* @return Message
*/
public static function buildBacklinkSubtitle( PageReference $page, $query = [] ) {
if ( $page instanceof PageRecord || $page instanceof Title ) {
// Callers will typically have a PageRecord
if ( $page->isRedirect() ) {
$query['redirect'] = 'no';
}
} elseif ( $page->getNamespace() !== NS_SPECIAL ) {
// We don't know whether it's a redirect, so add the parameter, just to be sure.
$query['redirect'] = 'no';
}
$linkRenderer = MediaWikiServices::getInstance()->getLinkRenderer();
return wfMessage( 'backlinksubtitle' )
->rawParams( $linkRenderer->makeLink( $page, null, [], $query ) );
}
/**
* Add a subtitle containing a backlink to a page
*
* @param PageReference $title Title to link to
* @param array $query Array of additional parameters to include in the link
*/
public function addBacklinkSubtitle( PageReference $title, $query = [] ) {
$this->addSubtitle( self::buildBacklinkSubtitle( $title, $query ) );
}
/**
* Clear the subtitles
*/
public function clearSubtitle() {
$this->mSubtitle = [];
}
/**
* @return string
*/
public function getSubtitle() {
return implode( "<br />\n\t\t\t\t", $this->mSubtitle );
}
/**
* Set the page as printable, i.e. it'll be displayed with all
* print styles included
*/
public function setPrintable() {
$this->mPrintable = true;
}
/**
* Return whether the page is "printable"
*
* @return bool
*/
public function isPrintable() {
return $this->mPrintable;
}
/**
* Disable output completely, i.e. calling output() will have no effect
*/
public function disable() {
$this->mDoNothing = true;
}
/**
* Return whether the output will be completely disabled
*
* @return bool
*/
public function isDisabled() {
return $this->mDoNothing;
}
/**
* Show an "add new section" link?
*
* @return bool
*/
public function showNewSectionLink() {
return $this->mNewSectionLink;
}
/**
* Forcibly hide the new section link?
*
* @return bool
*/
public function forceHideNewSectionLink() {
return $this->mHideNewSectionLink;
}
/**
* Add or remove feed links in the page header
* This is mainly kept for backward compatibility, see OutputPage::addFeedLink()
* for the new version
* @see addFeedLink()
*
* @param bool $show True: add default feeds, false: remove all feeds
*/
public function setSyndicated( $show = true ) {
if ( $show ) {
$this->setFeedAppendQuery( false );
} else {
$this->mFeedLinks = [];
}
}
/**
* Return effective list of advertised feed types
* @see addFeedLink()
*
* @return string[] Array of feed type names ( 'rss', 'atom' )
*/
protected function getAdvertisedFeedTypes() {
if ( $this->getConfig()->get( MainConfigNames::Feed ) ) {
return $this->getConfig()->get( MainConfigNames::AdvertisedFeedTypes );
} else {
return [];
}
}
/**
* Add default feeds to the page header
* This is mainly kept for backward compatibility, see OutputPage::addFeedLink()
* for the new version
* @see addFeedLink()
*
* @param string|false $val Query to append to feed links or false to output
* default links
*/
public function setFeedAppendQuery( $val ) {
$this->mFeedLinks = [];
foreach ( $this->getAdvertisedFeedTypes() as $type ) {
$query = "feed=$type";
if ( is_string( $val ) ) {
$query .= '&' . $val;
}
$this->mFeedLinks[$type] = $this->getTitle()->getLocalURL( $query );
}
}
/**
* Add a feed link to the page header
*
* @param string $format Feed type, should be a key of $wgFeedClasses
* @param string $href URL
*/
public function addFeedLink( $format, $href ) {
if ( in_array( $format, $this->getAdvertisedFeedTypes() ) ) {
$this->mFeedLinks[$format] = $href;
}
}
/**
* Should we output feed links for this page?
* @return bool
*/
public function isSyndicated() {
return count( $this->mFeedLinks ) > 0;
}
/**
* Return URLs for each supported syndication format for this page.
* @return array Associating format keys with URLs
*/
public function getSyndicationLinks() {
return $this->mFeedLinks;
}
/**
* Will currently always return null
*
* @return null
*/
public function getFeedAppendQuery() {
return $this->mFeedLinksAppendQuery;
}
/**
* Set whether the displayed content is related to the source of the
* corresponding article on the wiki
* Setting true will cause the change "article related" toggle to true
*
* @param bool $newVal
*/
public function setArticleFlag( $newVal ) {
$this->mIsArticle = $newVal;
if ( $newVal ) {
$this->mIsArticleRelated = $newVal;
}
}
/**
* Return whether the content displayed page is related to the source of
* the corresponding article on the wiki
*
* @return bool
*/
public function isArticle() {
return $this->mIsArticle;
}
/**
* Set whether this page is related an article on the wiki
* Setting false will cause the change of "article flag" toggle to false
*
* @param bool $newVal
*/
public function setArticleRelated( $newVal ) {
$this->mIsArticleRelated = $newVal;
if ( !$newVal ) {
$this->mIsArticle = false;
}
}
/**
* Return whether this page is related an article on the wiki
*
* @return bool
*/
public function isArticleRelated() {
return $this->mIsArticleRelated;
}
/**
* Set whether the standard copyright should be shown for the current page.
*
* @param bool $hasCopyright
*/
public function setCopyright( $hasCopyright ) {
$this->mHasCopyright = $hasCopyright;
}
/**
* Return whether the standard copyright should be shown for the current page.
* By default, it is true for all articles but other pages
* can signal it by using setCopyright( true ).
*
* Used by SkinTemplate to decided whether to show the copyright.
*
* @return bool
*/
public function showsCopyright() {
return $this->isArticle() || $this->mHasCopyright;
}
/**
* Add new language links
*
* @param string[]|ParsoidLinkTarget[] $newLinkArray Array of
* interwiki-prefixed (non DB key) titles (e.g. 'fr:Test page')
*/
public function addLanguageLinks( array $newLinkArray ) {
# $newLinkArray is in order of appearance on the page;
# deduplicate so only the first for a given prefix is used
# using code in ParserOutput (T26502)
foreach ( $newLinkArray as $t ) {
$this->metadata->addLanguageLink( $t );
}
}
/**
* Reset the language links and add new language links
*
* @param string[]|ParsoidLinkTarget[] $newLinkArray Array of interwiki-prefixed (non DB key) titles
* (e.g. 'fr:Test page')
* @deprecated since 1.43, use ::addLanguageLinks() instead, or
* use the LanguageLinksHook in the rare case that you need to remove
* or replace language links from the output page.
*/
public function setLanguageLinks( array $newLinkArray ) {
$this->metadata->setLanguageLinks( $newLinkArray );
}
/**
* Get the list of language links
*
* @return string[] Array of interwiki-prefixed (non DB key) titles (e.g. 'fr:Test page')
*/
public function getLanguageLinks() {
return $this->metadata->getLanguageLinks();
}
/**
* Get the "no gallery" flag
*
* Used directly only in CategoryViewer.php
* @internal
*/
public function getNoGallery(): bool {
return $this->mNoGallery;
}
/**
* Add an array of categories, with names in the keys
*
* @param array $categories Mapping category name => sort key
*/
public function addCategoryLinks( array $categories ) {
if ( !$categories ) {
return;
}
$res = $this->addCategoryLinksToLBAndGetResult( $categories );
# Set all the values to 'normal'.
$categories = array_fill_keys( array_keys( $categories ), 'normal' );
$pageData = [];
# Mark hidden categories
foreach ( $res as $row ) {
if ( isset( $row->pp_value ) ) {
$categories[$row->page_title] = 'hidden';
}
// Page exists, cache results
if ( isset( $row->page_id ) ) {
$pageData[$row->page_title] = $row;
}
}
# Add the remaining categories to the skin
if ( $this->getHookRunner()->onOutputPageMakeCategoryLinks(
$this, $categories, $this->mCategoryLinks )
) {
$services = MediaWikiServices::getInstance();
$linkRenderer = $services->getLinkRenderer();
$languageConverter = $services->getLanguageConverterFactory()
->getLanguageConverter( $services->getContentLanguage() );
$collation = $services->getCollationFactory()->getCategoryCollation();
foreach ( $categories as $category => $type ) {
// array keys will cast numeric category names to ints, so cast back to string
$category = (string)$category;
$origcategory = $category;
if ( array_key_exists( $category, $pageData ) ) {
$title = Title::newFromRow( $pageData[$category] );
} else {
$title = Title::makeTitleSafe( NS_CATEGORY, $category );
}
if ( !$title ) {
continue;
}
$languageConverter->findVariantLink( $category, $title, true );
if ( $category != $origcategory && array_key_exists( $category, $categories ) ) {
continue;
}
$text = $languageConverter->convertHtml( $title->getText() );
$link = null;
$this->getHookRunner()->onOutputPageRenderCategoryLink( $this, $title->toPageIdentity(), $text, $link );
if ( $link === null ) {
$link = $linkRenderer->makeLink( $title, new HtmlArmor( $text ) );
}
$this->mCategoryData[] = [
'sortKey' => $collation->getSortKey( $text ),
'type' => $type,
'title' => $title->getText(),
'link' => $link,
];
$this->mCategoriesSorted = false;
// Setting mCategories and mCategoryLinks is redundant here,
// but it is needed for compatibility until mCategories and
// mCategoryLinks are made private (T301020)
$this->mCategories[$type][] = $title->getText();
$this->mCategoryLinks[$type][] = $link;
}
} else {
// Conservatively assume the hook left the categories unsorted.
$this->mCategoriesSorted = false;
}
}
/**
* @param array $categories
* @return IResultWrapper
*/
protected function addCategoryLinksToLBAndGetResult( array $categories ) {
# Add the links to a LinkBatch
$arr = [ NS_CATEGORY => $categories ];
$linkBatchFactory = MediaWikiServices::getInstance()->getLinkBatchFactory();
$lb = $linkBatchFactory->newLinkBatch();
$lb->setArray( $arr );
# Fetch existence plus the hiddencat property
$dbr = MediaWikiServices::getInstance()->getConnectionProvider()->getReplicaDatabase();
$fields = array_merge(
LinkCache::getSelectFields(),
[ 'pp_value' ]
);
$res = $dbr->newSelectQueryBuilder()
->select( $fields )
->from( 'page' )
->leftJoin( 'page_props', null, [
'pp_propname' => 'hiddencat',
'pp_page = page_id',
] )
->where( $lb->constructSet( 'page', $dbr ) )
->caller( __METHOD__ )
->fetchResultSet();
# Add the results to the link cache
$linkCache = MediaWikiServices::getInstance()->getLinkCache();
$lb->addResultToCache( $linkCache, $res );
return $res;
}
/**
* Reset the category links (but not the category list) and add $categories
*
* @param array $categories Mapping category name => sort key
* @deprecated since 1.43, use ::addCategoryLinks()
*/
public function setCategoryLinks( array $categories ) {
wfDeprecated( __METHOD__, '1.43' );
$this->mCategoryLinks = [];
foreach ( $this->mCategoryData as &$arr ) {
// null out the 'link' entry for existing category data
$arr['link'] = null;
}
$this->addCategoryLinks( $categories );
}
/**
* Get the list of category links, in a 2-D array with the following format:
* $arr[$type][] = $link, where $type is either "normal" or "hidden" (for
* hidden categories) and $link a HTML fragment with a link to the category
* page
*
* @return string[][]
* @return-taint none
*/
public function getCategoryLinks() {
$this->maybeSortCategories();
return $this->mCategoryLinks;
}
/**
* Get the list of category names this page belongs to.
*
* @param string $type The type of categories which should be returned. Possible values:
* * all: all categories of all types
* * hidden: only the hidden categories
* * normal: all categories, except hidden categories
* @return string[]
*/
public function getCategories( $type = 'all' ) {
$this->maybeSortCategories();
if ( $type === 'all' ) {
$allCategories = [];
foreach ( $this->mCategories as $categories ) {
$allCategories = array_merge( $allCategories, $categories );
}
return $allCategories;
}
if ( !isset( $this->mCategories[$type] ) ) {
throw new InvalidArgumentException( 'Invalid category type given: ' . $type );
}
return $this->mCategories[$type];
}
/**
* Ensure that the category lists are sorted, so that we don't
* inadvertently depend on the exact evaluation order of various
* ParserOutput fragments.
*/
private function maybeSortCategories(): void {
if ( $this->mCategoriesSorted ) {
return;
}
// Check wiki configuration...
$sortCategories = $this->getConfig()->get( MainConfigNames::SortedCategories );
// ...but allow override with query parameter.
$sortCategories = $this->getRequest()->getFuzzyBool( 'sortcat', $sortCategories );
if ( $sortCategories ) {
// Primary sort key is the first element of category data, but
// break ties by looking at the other elements.
usort( $this->mCategoryData, static function ( $a, $b ): int {
return $a['type'] <=> $b['type'] ?:
$a['sortKey'] <=> $b['sortKey'] ?:
$a['title'] <=> $b['sortKey'] ?:
$a['link'] <=> $b['link'];
} );
}
// Rebuild mCategories and mCategoryLinks
$this->mCategories = [
'hidden' => [],
'normal' => [],
];
$this->mCategoryLinks = [];
foreach ( $this->mCategoryData as $c ) {
$this->mCategories[$c['type']][] = $c['title'];
if ( $c['link'] !== null ) {
// This test only needed because of ::setCategoryLinks()
$this->mCategoryLinks[$c['type']][] = $c['link'];
}
}
$this->mCategoriesSorted = true;
}
/**
* Add an array of indicators, with their identifiers as array
* keys and HTML contents as values.
*
* In case of duplicate keys, existing values are overwritten.
*
* @note External code which calls this method should ensure that
* any indicators sourced from parsed wikitext are wrapped with
* the appropriate class; see note in ::getIndicators().
*
* @param string[] $indicators
* @param-taint $indicators exec_html
* @since 1.25
*/
public function setIndicators( array $indicators ) {
$this->mIndicators = $indicators + $this->mIndicators;
// Keep ordered by key
ksort( $this->mIndicators );
}
/**
* Get the indicators associated with this page.
*
* The array will be internally ordered by item keys.
*
* @return string[] Keys: identifiers, values: HTML contents
* @since 1.25
*/
public function getIndicators(): array {
// Note that some -- but not all -- indicators will be wrapped
// with a class appropriate for user-generated wikitext content
// (usually .mw-parser-output). The exceptions would be an
// indicator added via ::addHelpLink() below, which adds content
// which don't come from the parser and is not user-generated;
// and any indicators added by extensions which may call
// OutputPage::setIndicators() directly. In the latter case the
// caller is responsible for wrapping any parser-generated
// indicators.
return $this->mIndicators;
}
/**
* Adds help link with an icon via page indicators.
* Link target can be overridden by a local message containing a wikilink:
* the message key is: lowercase action or special page name + '-helppage'.
* @param string $to Target MediaWiki.org page title or encoded URL.
* @param bool $overrideBaseUrl Whether $url is a full URL, to avoid MediaWiki.org.
* @since 1.25
*/
public function addHelpLink( $to, $overrideBaseUrl = false ) {
$this->addModuleStyles( 'mediawiki.helplink' );
$text = $this->msg( 'helppage-top-gethelp' )->escaped();
if ( $overrideBaseUrl ) {
$helpUrl = $to;
} else {
$toUrlencoded = wfUrlencode( str_replace( ' ', '_', $to ) );
$helpUrl = "https://www.mediawiki.org/wiki/Special:MyLanguage/$toUrlencoded";
}
$link = Html::rawElement(
'a',
[
'href' => $helpUrl,
'target' => '_blank',
'class' => 'mw-helplink',
],
Html::element( 'span', [ 'class' => 'mw-helplink-icon' ] ) . $text
);
// See note in ::getIndicators() above -- unlike wikitext-generated
// indicators which come from ParserOutput, this indicator will not
// be wrapped.
$this->setIndicators( [ 'mw-helplink' => $link ] );
}
/**
* Do not allow scripts which can be modified by wiki users to load on this page;
* only allow scripts bundled with, or generated by, the software.
* Site-wide styles are controlled by a config setting, since they can be
* used to create a custom skin/theme, but not user-specific ones.
*
* @todo this should be given a more accurate name
*/
public function disallowUserJs() {
$this->reduceAllowedModules(
RL\Module::TYPE_SCRIPTS,
RL\Module::ORIGIN_CORE_INDIVIDUAL
);
// Site-wide styles are controlled by a config setting, see T73621
// for background on why. User styles are never allowed.
if ( $this->getConfig()->get( MainConfigNames::AllowSiteCSSOnRestrictedPages ) ) {
$styleOrigin = RL\Module::ORIGIN_USER_SITEWIDE;
} else {
$styleOrigin = RL\Module::ORIGIN_CORE_INDIVIDUAL;
}
$this->reduceAllowedModules(
RL\Module::TYPE_STYLES,
$styleOrigin
);
}
/**
* Show what level of JavaScript / CSS untrustworthiness is allowed on this page
* @see RL\Module::$origin
* @param string $type RL\Module TYPE_ constant
* @return int Module ORIGIN_ class constant
*/
public function getAllowedModules( $type ) {
if ( $type == RL\Module::TYPE_COMBINED ) {
return min( array_values( $this->mAllowedModules ) );
} else {
return $this->mAllowedModules[$type] ?? RL\Module::ORIGIN_ALL;
}
}
/**
* Limit the highest level of CSS/JS untrustworthiness allowed.
*
* If passed the same or a higher level than the current level of untrustworthiness set, the
* level will remain unchanged.
*
* @param string $type
* @param int $level RL\Module class constant
*/
public function reduceAllowedModules( $type, $level ) {
$this->mAllowedModules[$type] = min( $this->getAllowedModules( $type ), $level );
}
/**
* Prepend $text to the body HTML
*
* @param string $text HTML
* @param-taint $text exec_html
*/
public function prependHTML( $text ) {
$this->mBodytext = $text . $this->mBodytext;
}
/**
* Append $text to the body HTML
*
* @param string $text HTML
* @param-taint $text exec_html
*/
public function addHTML( $text ) {
$this->mBodytext .= $text;
}
/**
* Shortcut for adding an Html::element via addHTML.
*
* @since 1.19
*
* @param string $element
* @param array $attribs
* @param string $contents
*/
public function addElement( $element, array $attribs = [], $contents = '' ) {
$this->addHTML( Html::element( $element, $attribs, $contents ) );
}
/**
* Clear the body HTML
*/
public function clearHTML() {
$this->mBodytext = '';
}
/**
* Get the body HTML
*
* @return string HTML
*/
public function getHTML() {
return $this->mBodytext;
}
/**
* Get/set the ParserOptions object to use for wikitext parsing
*
* @return ParserOptions
*/
public function parserOptions() {
if ( !$this->mParserOptions ) {
if ( !$this->getUser()->isSafeToLoad() ) {
// Context user isn't unstubbable yet, so don't try to get a
// ParserOptions for it. And don't cache this ParserOptions
// either.
$po = ParserOptions::newFromAnon();
$po->setAllowUnsafeRawHtml( false );
return $po;
}
$this->mParserOptions = ParserOptions::newFromContext( $this->getContext() );
$this->mParserOptions->setAllowUnsafeRawHtml( false );
}
return $this->mParserOptions;
}
/**
* Set the revision ID which will be seen by the wiki text parser
* for things such as embedded {{REVISIONID}} variable use.
*
* @param int|null $revid A positive integer, or null
* @return mixed Previous value
*/
public function setRevisionId( $revid ) {
$val = $revid === null ? null : intval( $revid );
return wfSetVar( $this->mRevisionId, $val, true );
}
/**
* Get the displayed revision ID
*
* @return int|null
*/
public function getRevisionId() {
return $this->mRevisionId;
}
/**
* Set whether the revision displayed (as set in ::setRevisionId())
* is the latest revision of the page.
*
* @param bool $isCurrent
*/
public function setRevisionIsCurrent( bool $isCurrent ): void {
$this->mRevisionIsCurrent = $isCurrent;
}
/**
* Whether the revision displayed is the latest revision of the page
*
* @since 1.34
* @return bool
*/
public function isRevisionCurrent(): bool {
return $this->mRevisionId == 0 || (
$this->mRevisionIsCurrent ?? (
$this->mRevisionId == $this->getTitle()->getLatestRevID()
)
);
}
/**
* Set the timestamp of the revision which will be displayed. This is used
* to avoid a extra DB call in SkinComponentFooter::lastModified().
*
* @param string|null $timestamp
* @return mixed Previous value
*/
public function setRevisionTimestamp( $timestamp ) {
return wfSetVar( $this->mRevisionTimestamp, $timestamp, true );
}
/**
* Get the timestamp of displayed revision.
* This will be null if not filled by setRevisionTimestamp().
*
* @return string|null
*/
public function getRevisionTimestamp() {
return $this->mRevisionTimestamp;
}
/**
* Set the displayed file version
*
* @param File|null $file
* @return mixed Previous value
*/
public function setFileVersion( $file ) {
$val = null;
if ( $file instanceof File && $file->exists() ) {
$val = [ 'time' => $file->getTimestamp(), 'sha1' => $file->getSha1() ];
}
return wfSetVar( $this->mFileVersion, $val, true );
}
/**
* Get the displayed file version
*
* @return array|null ('time' => MW timestamp, 'sha1' => sha1)
*/
public function getFileVersion() {
return $this->mFileVersion;
}
/**
* Get the templates used on this page
*
* @return array<int,array<string,int>> (namespace => dbKey => revId)
* @since 1.18
*/
public function getTemplateIds() {
return $this->mTemplateIds;
}
/**
* Get the files used on this page
*
* @return array [ dbKey => [ 'time' => MW timestamp or null, 'sha1' => sha1 or '' ] ]
* @since 1.18
*/
public function getFileSearchOptions() {
return $this->mImageTimeKeys;
}
/**
* Convert wikitext *in the user interface language* to HTML and
* add it to the buffer. The result will not be
* language-converted, as user interface messages are already
* localized into a specific variant. Assumes that the current
* page title will be used if optional $title is not
* provided. Output will be tidy.
*
* @param string $text Wikitext in the user interface language
* @param bool $linestart Is this the start of a line? (Defaults to true)
* @param PageReference|null $title Optional title to use; default of `null`
* means use current page title.
* @since 1.32
*/
public function addWikiTextAsInterface(
$text, $linestart = true, ?PageReference $title = null
) {
$title ??= $this->getTitle();
if ( $title === null ) {
throw new RuntimeException( 'No title in ' . __METHOD__ );
}
$this->addWikiTextTitleInternal( $text, $title, $linestart, /*interface*/true );
}
/**
* Convert wikitext *in the user interface language* to HTML and
* add it to the buffer with a `<div class="$wrapperClass">`
* wrapper. The result will not be language-converted, as user
* interface messages as already localized into a specific
* variant. The $text will be parsed in start-of-line context.
* Output will be tidy.
*
* @param string $wrapperClass The class attribute value for the <div>
* wrapper in the output HTML
* @param string $text Wikitext in the user interface language
* @since 1.32
*/
public function wrapWikiTextAsInterface(
$wrapperClass, $text
) {
$title = $this->getTitle();
if ( $title === null ) {
throw new RuntimeException( 'No title in ' . __METHOD__ );
}
$this->addWikiTextTitleInternal(
$text, $title,
/*linestart*/true, /*interface*/true,
$wrapperClass
);
}
/**
* Convert wikitext *in the page content language* to HTML and add
* it to the buffer. The result with be language-converted to the
* user's preferred variant. Assumes that the current page title
* will be used if optional $title is not provided. Output will be
* tidy.
*
* @param string $text Wikitext in the page content language
* @param bool $linestart Is this the start of a line? (Defaults to true)
* @param PageReference|null $title Optional title to use; default of `null`
* means use current page title.
* @since 1.32
*/
public function addWikiTextAsContent(
$text, $linestart = true, ?PageReference $title = null
) {
$title ??= $this->getTitle();
if ( !$title ) {
throw new RuntimeException( 'No title in ' . __METHOD__ );
}
$this->addWikiTextTitleInternal( $text, $title, $linestart, /*interface*/false );
}
/**
* Add wikitext with a custom Title object.
* Output is unwrapped.
*
* @param string $text Wikitext
* @param PageReference $title
* @param bool $linestart Is this the start of a line?@param
* @param bool $interface Whether it is an interface message
* (for example disables conversion)
* @param string|null $wrapperClass if not empty, wraps the output in
* a `<div class="$wrapperClass">`
*/
private function addWikiTextTitleInternal(
string $text, PageReference $title, bool $linestart, bool $interface,
?string $wrapperClass = null
) {
$parserOutput = $this->parseInternal(
$text, $title, $linestart, $interface
);
$this->addParserOutput( $parserOutput, [
'enableSectionEditLinks' => false,
'wrapperDivClass' => $wrapperClass ?? '',
] );
}
/**
* Adds Table of Contents data to OutputPage from ParserOutput
* @param TOCData $tocData
* @internal For use by Article.php
*/
public function setTOCData( TOCData $tocData ) {
$this->tocData = $tocData;
}
/**
* @internal For usage in Skin::getTOCData() only.
* @return ?TOCData Table of Contents data, or
* null if OutputPage::setTOCData() has not been called.
*/
public function getTOCData(): ?TOCData {
return $this->tocData;
}
/**
* @internal Will be replaced by direct access to
* ParserOutput::getOutputFlag()
* @param string $name A flag name from ParserOutputFlags
* @return bool
*/
public function getOutputFlag( string $name ): bool {
return isset( $this->mOutputFlags[$name] );
}
/**
* @internal For use by ViewAction/Article only
* @since 1.42
* @param Bcp47Code $lang
*/
public function setContentLangForJS( Bcp47Code $lang ): void {
$this->contentLang = MediaWikiServices::getInstance()->getLanguageFactory()
->getLanguage( $lang );
}
/**
* Which language getJSVars should use
*
* Use of this is strongly discouraged in favour of ParserOutput::getLanguage(),
* and should not be needed in most cases given that the OutputTransform
* already takes care of 'lang' and 'dir' attributes.
*
* Consider whether RequestContext::getLanguage (e.g. OutputPage::getLanguage
* or Skin::getLanguage) or MediaWikiServices::getContentLanguage is more
* appropiate first for your use case.
*
* @since 1.42
* @return Language
*/
private function getContentLangForJS(): Language {
if ( !$this->contentLang ) {
// If this is not set, then we're likely not on in a request that renders page content
// (e.g. ViewAction or ApiParse), but rather a different Action or SpecialPage.
// In that case there isn't a main ParserOutput object to represent the page or output.
// But, the skin and frontend code mostly don't make this distinction, and so we still
// need to return something for mw.config.
//
// For historical reasons, the expectation is that:
// * on a SpecialPage, we return the language for the content area just like on a
// page view. SpecialPage content is localised, and so this is the user language.
// * on an Action about a WikiPage, we return the language that content would have
// been shown in, if this were a page view. This is generally the page language
// as stored in the database, except adapted to the current user (e.g. in case of
// translated pages or a language variant preference)
//
// This mess was centralised to here in 2023 (T341244).
$title = $this->getTitle();
if ( $title->isSpecialPage() ) {
// Special pages render in the interface language, based on request context.
// If the user's preference (or request parameter) specifies a variant,
// the content may have been converted to the user's language variant.
$pageLang = $this->getLanguage();
} else {
wfDebug( __METHOD__ . ' has to guess ParserOutput language' );
// Guess what Article::getParserOutput and ParserOptions::optionsHash() would decide
// on a page view:
//
// - Pages may have a custom page_lang set in the database,
// via Title::getPageLanguage/Title::getDbPageLanguage
//
// - Interface messages (NS_MEDIAWIKI) render based on their subpage,
// via Title::getPageLanguage/ContentHandler::getPageLanguage/MessageCache::figureMessage
//
// - Otherwise, pages are assumed to be in the wiki's default content language.
// via Title::getPageLanguage/ContentHandler::getPageLanguage/MediaWikiServices::getContentLanguage
$pageLang = $title->getPageLanguage();
}
if ( $title->getNamespace() !== NS_MEDIAWIKI ) {
$services = MediaWikiServices::getInstance();
$langConv = $services->getLanguageConverterFactory()->getLanguageConverter( $pageLang );
// NOTE: LanguageConverter::getPreferredVariant inspects global RequestContext.
// This usually returns $pageLang unchanged.
$variant = $langConv->getPreferredVariant();
if ( $pageLang->getCode() !== $variant ) {
$pageLang = $services->getLanguageFactory()->getLanguage( $variant );
}
}
$this->contentLang = $pageLang;
}
return $this->contentLang;
}
/**
* Add all metadata associated with a ParserOutput object, but without the actual HTML. This
* includes categories, language links, ResourceLoader modules, effects of certain magic words,
* and so on. It does *not* include section information.
*
* @since 1.24
* @param ParserOutput $parserOutput
*/
public function addParserOutputMetadata( ParserOutput $parserOutput ) {
// T301020 This should eventually use the standard "merge ParserOutput"
// function between $parserOutput and $this->metadata.
$this->addLanguageLinks( $parserOutput->getLanguageLinks() );
$this->addCategoryLinks( $parserOutput->getCategoryMap() );
// Parser-generated indicators get wrapped like other parser output.
$wrapClass = $parserOutput->getWrapperDivClass();
$result = [];
foreach ( $parserOutput->getIndicators() as $name => $html ) {
if ( $html !== '' && $wrapClass !== '' ) {
$html = Html::rawElement( 'div', [ 'class' => $wrapClass ], $html );
}
$result[$name] = $html;
}
$this->setIndicators( $result );
$tocData = $parserOutput->getTOCData();
// Do not override existing TOC data if the new one is empty (T307256#8817705)
// TODO: Invent a way to merge TOCs from multiple outputs (T327429)
if ( $tocData !== null && ( $this->tocData === null || count( $tocData->getSections() ) > 0 ) ) {
$this->setTOCData( $tocData );
}
// FIXME: Best practice is for OutputPage to be an accumulator, as
// addParserOutputMetadata() may be called multiple times, but the
// following lines overwrite any previous data. These should
// be migrated to an injection pattern. (T301020, T300979)
// (Note that OutputPage::getOutputFlag() also contains this
// information, with flags from each $parserOutput all OR'ed together.)
$this->mNewSectionLink = $parserOutput->getNewSection();
$this->mHideNewSectionLink = $parserOutput->getHideNewSection();
$this->mNoGallery = $parserOutput->getNoGallery();
if ( !$parserOutput->isCacheable() ) {
$this->disableClientCache();
}
$this->addHeadItems( $parserOutput->getHeadItems() );
$this->addModules( $parserOutput->getModules() );
$this->addModuleStyles( $parserOutput->getModuleStyles() );
$this->addJsConfigVars( $parserOutput->getJsConfigVars() );
if ( $parserOutput->getPreventClickjacking() ) {
$this->metadata->setPreventClickjacking( true );
}
$scriptSrcs = $parserOutput->getExtraCSPScriptSrcs();
foreach ( $scriptSrcs as $src ) {
$this->getCSP()->addScriptSrc( $src );
}
$defaultSrcs = $parserOutput->getExtraCSPDefaultSrcs();
foreach ( $defaultSrcs as $src ) {
$this->getCSP()->addDefaultSrc( $src );
}
$styleSrcs = $parserOutput->getExtraCSPStyleSrcs();
foreach ( $styleSrcs as $src ) {
$this->getCSP()->addStyleSrc( $src );
}
// If $wgImagePreconnect is true, and if the output contains images, give the user-agent
// a hint about a remote hosts from which images may be served. Launched in T123582.
if ( $this->getConfig()->get( MainConfigNames::ImagePreconnect ) && count( $parserOutput->getImages() ) ) {
$preconnect = [];
// Optimization: Instead of processing each image, assume that wikis either serve both
// foreign and local from the same remote hostname (e.g. public wikis at WMF), or that
// foreign images are common enough to be worth the preconnect (e.g. private wikis).
$repoGroup = MediaWikiServices::getInstance()->getRepoGroup();
$repoGroup->forEachForeignRepo( static function ( $repo ) use ( &$preconnect ) {
$preconnect[] = $repo->getZoneUrl( 'thumb' );
} );
// Consider both foreign and local repos. While LocalRepo by default uses a relative
// path on the same domain, wiki farms may configure it to use a dedicated hostname.
$preconnect[] = $repoGroup->getLocalRepo()->getZoneUrl( 'thumb' );
foreach ( $preconnect as $url ) {
$host = parse_url( $url, PHP_URL_HOST );
// It is expected that file URLs are often path-only, without hostname (T317329).
if ( $host ) {
$this->addLink( [ 'rel' => 'preconnect', 'href' => '//' . $host ] );
break;
}
}
}
// Template versioning...
foreach ( (array)$parserOutput->getTemplateIds() as $ns => $dbks ) {
if ( isset( $this->mTemplateIds[$ns] ) ) {
$this->mTemplateIds[$ns] = $dbks + $this->mTemplateIds[$ns];
} else {
$this->mTemplateIds[$ns] = $dbks;
}
}
// File versioning...
foreach ( (array)$parserOutput->getFileSearchOptions() as $dbk => $data ) {
$this->mImageTimeKeys[$dbk] = $data;
}
// Enable OOUI if requested via ParserOutput
if ( $parserOutput->getEnableOOUI() ) {
$this->enableOOUI();
}
// Include parser limit report
// FIXME: This should append, rather than overwrite, or else this
// data should be injected into the OutputPage like is done for the
// other page-level things (like OutputPage::setTOCData()).
if ( !$this->limitReportJSData ) {
$this->limitReportJSData = $parserOutput->getLimitReportJSData();
}
// Link flags are ignored for now, but may in the future be
// used to mark individual language links.
$linkFlags = [];
$languageLinks = $this->metadata->getLanguageLinks();
// This hook can be used to remove/replace language links
$this->getHookRunner()->onLanguageLinks( $this->getTitle(), $languageLinks, $linkFlags );
$this->metadata->setLanguageLinks( $languageLinks );
$this->getHookRunner()->onOutputPageParserOutput( $this, $parserOutput );
// This check must be after 'OutputPageParserOutput' runs in addParserOutputMetadata
// so that extensions may modify ParserOutput to toggle TOC.
// This cannot be moved to addParserOutputText because that is not
// called by EditPage for Preview.
// ParserOutputFlags::SHOW_TOC is used to indicate whether the TOC
// should be shown (or hidden) in the output.
$this->mEnableTOC = $this->mEnableTOC ||
$parserOutput->getOutputFlag( ParserOutputFlags::SHOW_TOC );
// Uniform handling of all boolean flags: they are OR'ed together
// (See ParserOutput::collectMetadata())
$flags =
array_flip( $parserOutput->getAllFlags() ) +
array_flip( ParserOutputFlags::cases() );
foreach ( $flags as $name => $ignore ) {
if ( $parserOutput->getOutputFlag( $name ) ) {
$this->mOutputFlags[$name] = true;
}
}
}
private function getParserOutputText( ParserOutput $parserOutput, array $poOptions = [] ): string {
// Add default options from the skin
$skin = $this->getSkin();
$skinOptions = $skin->getOptions();
$oldText = $parserOutput->getRawText();
$poOptions += [
'allowClone' => false, // T371022
'skin' => $skin,
'injectTOC' => $skinOptions['toc'],
];
$pipeline = MediaWikiServices::getInstance()->getDefaultOutputPipeline();
// Note: this path absolutely expects the metadata of $parserOutput to be mutated by the pipeline,
// but the raw text should not be, see T353257
// TODO T371008 consider if using the Content framework makes sense instead of creating the pipeline
$text = $pipeline->run( $parserOutput, $this->parserOptions(), $poOptions )->getContentHolderText();
$parserOutput->setRawText( $oldText );
return $text;
}
/**
* Add the HTML and enhancements for it (like ResourceLoader modules) associated with a
* ParserOutput object, without any other metadata.
*
* @since 1.24
* @param ParserOutput $parserOutput
* @param array $poOptions Options to OutputTransformPipeline::run() (to be deprecated)
*/
public function addParserOutputContent( ParserOutput $parserOutput, $poOptions = [] ) {
$text = $this->getParserOutputText( $parserOutput, $poOptions );
$this->addParserOutputText( $text, $poOptions );
$this->addModules( $parserOutput->getModules() );
$this->addModuleStyles( $parserOutput->getModuleStyles() );
$this->addJsConfigVars( $parserOutput->getJsConfigVars() );
}
/**
* Add the HTML associated with a ParserOutput object, without any metadata.
*
* @internal For local use only
* @param string|ParserOutput $text
* @param array $poOptions Options to OutputTransformPipeline::run() (to be deprecated)
*/
public function addParserOutputText( $text, $poOptions = [] ) {
if ( $text instanceof ParserOutput ) {
wfDeprecated( __METHOD__ . ' with ParserOutput as first arg', '1.42' );
$text = $this->getParserOutputText( $text, $poOptions );
}
$this->getHookRunner()->onOutputPageBeforeHTML( $this, $text );
$this->addHTML( $text );
}
/**
* Add everything from a ParserOutput object.
*
* @param ParserOutput $parserOutput
* @param array $poOptions Options to OutputTransformPipeline::run() (to be deprecated)
*/
public function addParserOutput( ParserOutput $parserOutput, $poOptions = [] ) {
$text = $this->getParserOutputText( $parserOutput, $poOptions );
$this->addParserOutputMetadata( $parserOutput );
$this->addParserOutputText( $text, $poOptions );
}
/**
* Add the output of a QuickTemplate to the output buffer
*
* @param \QuickTemplate &$template
*/
public function addTemplate( &$template ) {
$this->addHTML( $template->getHTML() );
}
/**
* Parse wikitext *in the page content language* and return the HTML.
* The result will be language-converted to the user's preferred variant.
* Output will be tidy.
*
* @param string $text Wikitext in the page content language
* @param bool $linestart Is this the start of a line? (Defaults to true)
* @return string HTML
* @since 1.32
*/
public function parseAsContent( $text, $linestart = true ) {
$title = $this->getTitle();
if ( $title === null ) {
throw new RuntimeException( 'No title in ' . __METHOD__ );
}
$po = $this->parseInternal(
$text, $title, $linestart, /*interface*/false
);
$pipeline = MediaWikiServices::getInstance()->getDefaultOutputPipeline();
// TODO T371008 consider if using the Content framework makes sense instead of creating the pipeline
return $pipeline->run( $po, $this->parserOptions(), [
'allowTOC' => false,
'enableSectionEditLinks' => false,
'wrapperDivClass' => '',
'userLang' => $this->getContext()->getLanguage(),
] )->getContentHolderText();
}
/**
* Parse wikitext *in the user interface language* and return the HTML.
* The result will not be language-converted, as user interface messages
* are already localized into a specific variant.
* Output will be tidy.
*
* @param string $text Wikitext in the user interface language
* @param bool $linestart Is this the start of a line? (Defaults to true)
* @return string HTML
* @since 1.32
*/
public function parseAsInterface( $text, $linestart = true ) {
$title = $this->getTitle();
if ( $title === null ) {
throw new RuntimeException( 'No title in ' . __METHOD__ );
}
$po = $this->parseInternal(
$text, $title, $linestart, /*interface*/true
);
$pipeline = MediaWikiServices::getInstance()->getDefaultOutputPipeline();
// TODO T371008 consider if using the Content framework makes sense instead of creating the pipeline
return $pipeline->run( $po, $this->parserOptions(), [
'allowTOC' => false,
'enableSectionEditLinks' => false,
'wrapperDivClass' => '',
'userLang' => $this->getContext()->getLanguage(),
] )->getContentHolderText();
}
/**
* Parse wikitext *in the user interface language*, strip
* paragraph wrapper, and return the HTML.
* The result will not be language-converted, as user interface messages
* are already localized into a specific variant.
* Output will be tidy. Outer paragraph wrapper will only be stripped
* if the result is a single paragraph.
*
* @param string $text Wikitext in the user interface language
* @param bool $linestart Is this the start of a line? (Defaults to true)
* @return string HTML
* @since 1.32
*/
public function parseInlineAsInterface( $text, $linestart = true ) {
return Parser::stripOuterParagraph(
$this->parseAsInterface( $text, $linestart )
);
}
/**
* Parse wikitext and return the HTML (internal implementation helper)
*
* @param string $text
* @param PageReference $title The title to use
* @param bool $linestart Is this the start of a line?
* @param bool $interface Use interface language (instead of content language) while parsing
* language sensitive magic words like GRAMMAR and PLURAL. This also disables
* LanguageConverter.
* @return ParserOutput
*/
private function parseInternal(
string $text, PageReference $title, bool $linestart, bool $interface
) {
$popts = $this->parserOptions();
$oldInterface = $popts->setInterfaceMessage( $interface );
$parserOutput = MediaWikiServices::getInstance()->getParserFactory()->getInstance()
->parse(
$text, $title, $popts,
$linestart, true, $this->mRevisionId
);
$popts->setInterfaceMessage( $oldInterface );
return $parserOutput;
}
/**
* Set the value of the "s-maxage" part of the "Cache-control" HTTP header
*
* @param int $maxage Maximum cache time on the CDN, in seconds.
*/
public function setCdnMaxage( $maxage ) {
$this->mCdnMaxage = min( $maxage, $this->mCdnMaxageLimit );
}
/**
* Set the value of the "s-maxage" part of the "Cache-control" HTTP header to $maxage if that is
* lower than the current s-maxage. Either way, $maxage is now an upper limit on s-maxage, so
* that future calls to setCdnMaxage() will no longer be able to raise the s-maxage above
* $maxage.
*
* @param int $maxage Maximum cache time on the CDN, in seconds
* @since 1.27
*/
public function lowerCdnMaxage( $maxage ) {
$this->mCdnMaxageLimit = min( $maxage, $this->mCdnMaxageLimit );
$this->setCdnMaxage( $this->mCdnMaxage );
}
/**
* Get TTL in [$minTTL,$maxTTL] and pass it to lowerCdnMaxage()
*
* This sets and returns $minTTL if $mtime is false or null. Otherwise,
* the TTL is higher the older the $mtime timestamp is. Essentially, the
* TTL is 90% of the age of the object, subject to the min and max.
*
* @param string|int|float|false|null $mtime Last-Modified timestamp
* @param int $minTTL Minimum TTL in seconds [default: 1 minute]
* @param int $maxTTL Maximum TTL in seconds [default: $wgCdnMaxAge]
* @since 1.28
*/
public function adaptCdnTTL( $mtime, $minTTL = 0, $maxTTL = 0 ) {
$minTTL = $minTTL ?: ExpirationAwareness::TTL_MINUTE;
$maxTTL = $maxTTL ?: $this->getConfig()->get( MainConfigNames::CdnMaxAge );
if ( $mtime === null || $mtime === false ) {
return; // entity does not exist
}
$age = MWTimestamp::time() - (int)wfTimestamp( TS_UNIX, $mtime );
$adaptiveTTL = max( 0.9 * $age, $minTTL );
$adaptiveTTL = min( $adaptiveTTL, $maxTTL );
$this->lowerCdnMaxage( (int)$adaptiveTTL );
}
/**
* Do not send nocache headers
*/
public function enableClientCache(): void {
$this->mEnableClientCache = true;
}
/**
* Force the page to send nocache headers
* @since 1.38
*/
public function disableClientCache(): void {
$this->mEnableClientCache = false;
}
/**
* Whether the output might become publicly cached.
*
* @since 1.34
* @return bool
*/
public function couldBePublicCached() {
if ( !$this->cacheIsFinal ) {
// - The entry point handles its own caching and/or doesn't use OutputPage.
// (such as load.php, or MediaWiki\Rest\EntryPoint).
//
// - Or, we haven't finished processing the main part of the request yet
// (e.g. Action::show, SpecialPage::execute), and the state may still
// change via enableClientCache().
return true;
}
// e.g. various error-type pages disable all client caching
return $this->mEnableClientCache;
}
/**
* Set the expectation that cache control will not change after this point.
*
* This should be called after the main processing logic has completed
* (e.g. Action::show or SpecialPage::execute), but may be called
* before Skin output has started (OutputPage::output).
*
* @since 1.34
*/
public function considerCacheSettingsFinal() {
$this->cacheIsFinal = true;
}
/**
* Get the list of cookie names that will influence the cache
*
* @return array
*/
public function getCacheVaryCookies() {
if ( self::$cacheVaryCookies === null ) {
$config = $this->getConfig();
self::$cacheVaryCookies = array_values( array_unique( array_merge(
SessionManager::singleton()->getVaryCookies(),
[
'forceHTTPS',
],
$config->get( MainConfigNames::CacheVaryCookies )
) ) );
$this->getHookRunner()->onGetCacheVaryCookies( $this, self::$cacheVaryCookies );
}
return self::$cacheVaryCookies;
}
/**
* Check if the request has a cache-varying cookie header
* If it does, it's very important that we don't allow public caching
*
* @return bool
*/
public function haveCacheVaryCookies() {
$request = $this->getRequest();
foreach ( $this->getCacheVaryCookies() as $cookieName ) {
if ( $request->getCookie( $cookieName, '', '' ) !== '' ) {
wfDebug( __METHOD__ . ": found $cookieName" );
return true;
}
}
wfDebug( __METHOD__ . ': no cache-varying cookies found' );
return false;
}
/**
* Add an HTTP header that will have an influence on the cache
*
* @param string $header Header name
*/
public function addVaryHeader( $header ) {
if ( !array_key_exists( $header, $this->mVaryHeader ) ) {
$this->mVaryHeader[$header] = null;
}
}
/**
* Return a Vary: header on which to vary caches. Based on the keys of $mVaryHeader,
* such as Accept-Encoding or Cookie
*
* @return string
*/
public function getVaryHeader() {
// If we vary on cookies, let's make sure it's always included here too.
if ( $this->getCacheVaryCookies() ) {
$this->addVaryHeader( 'Cookie' );
}
foreach ( SessionManager::singleton()->getVaryHeaders() as $header => $_ ) {
$this->addVaryHeader( $header );
}
return 'Vary: ' . implode( ', ', array_keys( $this->mVaryHeader ) );
}
/**
* Add an HTTP Link: header
*
* @param string $header Header value
*/
public function addLinkHeader( $header ) {
$this->mLinkHeader[] = $header;
}
/**
* Return a Link: header. Based on the values of $mLinkHeader.
*
* @return string|false
*/
public function getLinkHeader() {
if ( !$this->mLinkHeader ) {
return false;
}
return 'Link: ' . implode( ',', $this->mLinkHeader );
}
/**
* T23672: Add Accept-Language to Vary header if there's no 'variant' parameter in GET.
*
* For example:
* /w/index.php?title=Main_page will vary based on Accept-Language; but
* /w/index.php?title=Main_page&variant=zh-cn will not.
*/
private function addAcceptLanguage() {
$title = $this->getTitle();
if ( !$title instanceof Title ) {
return;
}
$languageConverter = MediaWikiServices::getInstance()->getLanguageConverterFactory()
->getLanguageConverter( $title->getPageLanguage() );
if ( !$this->getRequest()->getCheck( 'variant' ) && $languageConverter->hasVariants() ) {
$this->addVaryHeader( 'Accept-Language' );
}
}
/**
* Set the prevent-clickjacking flag.
*
* If true, will cause an X-Frame-Options header appropriate for
* edit pages to be sent. The header value is controlled by
* $wgEditPageFrameOptions. This is the default for special
* pages. If you display a CSRF-protected form on an ordinary view
* page, then you need to call this function.
*
* Setting this flag to false will turn off frame-breaking. This
* can be called from pages which do not contain any
* CSRF-protected HTML form.
*
* @param bool $enable If true, will cause an X-Frame-Options header
* appropriate for edit pages to be sent.
*
* @since 1.38
* @deprecated since 1.43; use ->getMetadata()->setPreventClickjacking()
*/
public function setPreventClickjacking( bool $enable ) {
$this->metadata->setPreventClickjacking( $enable );
}
/**
* Get the prevent-clickjacking flag
*
* @since 1.24
* @return bool
* @deprecated since 1.43; use ->getMetadata()->getPreventClickjacking()
*/
public function getPreventClickjacking() {
return $this->metadata->getPreventClickjacking();
}
/**
* Get the X-Frame-Options header value (without the name part), or false
* if there isn't one. This is used by Skin to determine whether to enable
* JavaScript frame-breaking, for clients that don't support X-Frame-Options.
*
* @return string|false
*/
public function getFrameOptions() {
$config = $this->getConfig();
if ( $config->get( MainConfigNames::BreakFrames ) ) {
return 'DENY';
} elseif (
$this->metadata->getPreventClickjacking() &&
$config->get( MainConfigNames::EditPageFrameOptions )
) {
return $config->get( MainConfigNames::EditPageFrameOptions );
}
return false;
}
private function getReportTo() {
$config = $this->getConfig();
$expiry = $config->get( MainConfigNames::ReportToExpiry );
if ( !$expiry ) {
return false;
}
$endpoints = $config->get( MainConfigNames::ReportToEndpoints );
if ( !$endpoints ) {
return false;
}
$output = [ 'max_age' => $expiry, 'endpoints' => [] ];
foreach ( $endpoints as $endpoint ) {
$output['endpoints'][] = [ 'url' => $endpoint ];
}
return json_encode( $output, JSON_UNESCAPED_SLASHES );
}
private function getFeaturePolicyReportOnly() {
$config = $this->getConfig();
$features = $config->get( MainConfigNames::FeaturePolicyReportOnly );
return implode( ';', $features );
}
/**
* Send cache control HTTP headers
*/
public function sendCacheControl() {
$response = $this->getRequest()->response();
$config = $this->getConfig();
$this->addVaryHeader( 'Cookie' );
$this->addAcceptLanguage();
# don't serve compressed data to clients who can't handle it
# maintain different caches for logged-in users and non-logged in ones
$response->header( $this->getVaryHeader() );
if ( $this->mEnableClientCache ) {
if ( !$config->get( MainConfigNames::UseCdn ) ) {
$privateReason = 'config';
} elseif ( $response->hasCookies() ) {
$privateReason = 'set-cookies';
// The client might use methods other than cookies to appear logged-in.
// E.g. HTTP headers, or query parameter tokens, OAuth, etc.
} elseif ( SessionManager::getGlobalSession()->isPersistent() ) {
$privateReason = 'session';
} elseif ( $this->isPrintable() ) {
$privateReason = 'printable';
} elseif ( $this->mCdnMaxage == 0 ) {
$privateReason = 'no-maxage';
} elseif ( $this->haveCacheVaryCookies() ) {
$privateReason = 'cache-vary-cookies';
} else {
$privateReason = false;
}
if ( $privateReason === false ) {
# We'll purge the proxy cache for anons explicitly, but require end user agents
# to revalidate against the proxy on each visit.
# IMPORTANT! The CDN needs to replace the Cache-Control header with
# Cache-Control: s-maxage=0, must-revalidate, max-age=0
wfDebug( __METHOD__ .
": local proxy caching; {$this->mLastModified} **", 'private' );
# start with a shorter timeout for initial testing
# header( "Cache-Control: s-maxage=2678400, must-revalidate, max-age=0" );
$response->header( 'Cache-Control: ' .
"s-maxage={$this->mCdnMaxage}, must-revalidate, max-age=0" );
} else {
# We do want clients to cache if they can, but they *must* check for updates
# on revisiting the page.
wfDebug( __METHOD__ . ": private caching ($privateReason); {$this->mLastModified} **", 'private' );
$response->header( 'Expires: ' . gmdate( 'D, d M Y H:i:s', 0 ) . ' GMT' );
$response->header( 'Cache-Control: private, must-revalidate, max-age=0' );
}
if ( $this->mLastModified ) {
$response->header( "Last-Modified: {$this->mLastModified}" );
}
} else {
wfDebug( __METHOD__ . ': no caching **', 'private' );
# In general, the absence of a last modified header should be enough to prevent
# the client from using its cache. We send a few other things just to make sure.
$response->header( 'Expires: ' . gmdate( 'D, d M Y H:i:s', 0 ) . ' GMT' );
$response->header( 'Cache-Control: no-cache, no-store, max-age=0, must-revalidate' );
}
}
/**
* Transfer styles and JavaScript modules from skin.
*
* @param Skin $sk to load modules for
*/
public function loadSkinModules( $sk ) {
foreach ( $sk->getDefaultModules() as $group => $modules ) {
if ( $group === 'styles' ) {
foreach ( $modules as $moduleMembers ) {
$this->addModuleStyles( $moduleMembers );
}
} else {
$this->addModules( $modules );
}
}
}
/**
* Finally, all the text has been munged and accumulated into
* the object, let's actually output it:
*
* @param bool $return Set to true to get the result as a string rather than sending it
* @return string|null
*/
public function output( $return = false ) {
if ( $this->mDoNothing ) {
return $return ? '' : null;
}
$request = $this->getRequest();
$response = $request->response();
$config = $this->getConfig();
if ( $this->mRedirect != '' ) {
$services = MediaWikiServices::getInstance();
// Modern standards don't require redirect URLs to be absolute, but make it so just in case.
// Note that this doesn't actually guarantee an absolute URL: relative-path URLs are left intact.
$this->mRedirect = (string)$services->getUrlUtils()->expand( $this->mRedirect, PROTO_CURRENT );
$redirect = $this->mRedirect;
$code = $this->mRedirectCode;
$content = '';
if ( $this->getHookRunner()->onBeforePageRedirect( $this, $redirect, $code ) ) {
if ( $code == '301' || $code == '303' ) {
if ( !$config->get( MainConfigNames::DebugRedirects ) ) {
$response->statusHeader( (int)$code );
}
$this->mLastModified = wfTimestamp( TS_RFC2822 );
}
if ( $config->get( MainConfigNames::VaryOnXFP ) ) {
$this->addVaryHeader( 'X-Forwarded-Proto' );
}
$this->sendCacheControl();
$response->header( 'Content-Type: text/html; charset=UTF-8' );
if ( $config->get( MainConfigNames::DebugRedirects ) ) {
$url = htmlspecialchars( $redirect );
$content = "<!DOCTYPE html>\n<html>\n<head>\n"
. "<title>Redirect</title>\n</head>\n<body>\n"
. "<p>Location: <a href=\"$url\">$url</a></p>\n"
. "</body>\n</html>\n";
if ( !$return ) {
print $content;
}
} else {
$response->header( 'Location: ' . $redirect );
}
}
return $return ? $content : null;
} elseif ( $this->mStatusCode ) {
$response->statusHeader( $this->mStatusCode );
}
# Buffer output; final headers may depend on later processing
ob_start();
$response->header( 'Content-language: ' .
MediaWikiServices::getInstance()->getContentLanguage()->getHtmlCode() );
$linkHeader = $this->getLinkHeader();
if ( $linkHeader ) {
$response->header( $linkHeader );
}
// Prevent framing, if requested
$frameOptions = $this->getFrameOptions();
if ( $frameOptions ) {
$response->header( "X-Frame-Options: $frameOptions" );
}
// Get the Origin-Trial header values. This is used to enable Chrome Origin
// Trials: https://github.com/GoogleChrome/OriginTrials
$originTrials = $config->get( MainConfigNames::OriginTrials );
foreach ( $originTrials as $originTrial ) {
$response->header( "Origin-Trial: $originTrial", false );
}
$reportTo = $this->getReportTo();
if ( $reportTo ) {
$response->header( "Report-To: $reportTo" );
}
$featurePolicyReportOnly = $this->getFeaturePolicyReportOnly();
if ( $featurePolicyReportOnly ) {
$response->header( "Feature-Policy-Report-Only: $featurePolicyReportOnly" );
}
if ( $this->mArticleBodyOnly ) {
$response->header( 'Content-type: ' . $config->get( MainConfigNames::MimeType ) . '; charset=UTF-8' );
if ( $this->cspOutputMode === self::CSP_HEADERS ) {
$this->CSP->sendHeaders();
}
echo $this->mBodytext;
} else {
// Enable safe mode if requested (T152169)
if ( $this->getRequest()->getBool( 'safemode' ) ) {
$this->disallowUserJs();
}
$sk = $this->getSkin();
$skinOptions = $sk->getOptions();
if ( $skinOptions['format'] === 'json' ) {
$response->header( 'Content-type: application/json; charset=UTF-8' );
return json_encode( [
$this->msg( 'skin-json-warning' )->escaped() => $this->msg( 'skin-json-warning-message' )->escaped()
] + $sk->getTemplateData() );
}
$response->header( 'Content-type: ' . $config->get( MainConfigNames::MimeType ) . '; charset=UTF-8' );
$this->loadSkinModules( $sk );
MWDebug::addModules( $this );
// Hook that allows last minute changes to the output page, e.g.
// adding of CSS or Javascript by extensions, adding CSP sources.
$this->getHookRunner()->onBeforePageDisplay( $this, $sk );
if ( $this->cspOutputMode === self::CSP_HEADERS ) {
$this->CSP->sendHeaders();
}
try {
$sk->outputPageFinal( $this );
} catch ( Exception $e ) {
ob_end_clean(); // bug T129657
throw $e;
}
}
try {
// This hook allows last minute changes to final overall output by modifying output buffer
$this->getHookRunner()->onAfterFinalPageOutput( $this );
} catch ( Exception $e ) {
ob_end_clean(); // bug T129657
throw $e;
}
$this->sendCacheControl();
if ( $return ) {
return ob_get_clean();
} else {
ob_end_flush();
return null;
}
}
/**
* Prepare this object to display an error page; disable caching and
* indexing, clear the current text and redirect, set the page's title
* and optionally a custom HTML title (content of the "<title>" tag).
*
* @param string|Message|null $pageTitle Will be passed directly to setPageTitle()
* @param string|Message|false $htmlTitle Will be passed directly to setHTMLTitle();
* optional, if not passed the "<title>" attribute will be
* based on $pageTitle
* @note Explicitly passing $pageTitle or $htmlTitle has been deprecated
* since 1.41; use ::setPageTitleMsg() and ::setHTMLTitle() instead.
*/
public function prepareErrorPage( $pageTitle = null, $htmlTitle = false ) {
if ( $pageTitle !== null || $htmlTitle !== false ) {
wfDeprecated( __METHOD__ . ' with explicit arguments', '1.41' );
if ( $pageTitle !== null ) {
$this->setPageTitle( $pageTitle );
}
if ( $htmlTitle !== false ) {
$this->setHTMLTitle( $htmlTitle );
}
}
$this->setRobotPolicy( 'noindex,nofollow' );
$this->setArticleRelated( false );
$this->disableClientCache();
$this->mRedirect = '';
$this->clearSubtitle();
$this->clearHTML();
}
/**
* Output a standard error page
*
* showErrorPage( 'titlemsg', 'pagetextmsg' );
* showErrorPage( 'titlemsg', 'pagetextmsg', [ 'param1', 'param2' ] );
* showErrorPage( 'titlemsg', $messageObject );
* showErrorPage( $titleMessageObject, $messageObject );
*
* @param string|MessageSpecifier $title Message key (string) for page title, or a MessageSpecifier
* @param string|MessageSpecifier $msg Message key (string) for page text, or a MessageSpecifier
* @param array $params Message parameters; ignored if $msg is a Message object
* @param PageReference|LinkTarget|string|null $returnto Page to show a return link to;
* defaults to the 'returnto' URL parameter
* @param string|null $returntoquery Query string for the return to link;
* defaults to the 'returntoquery' URL parameter
*/
public function showErrorPage(
$title, $msg, $params = [], $returnto = null, $returntoquery = null
) {
if ( !$title instanceof Message ) {
$title = $this->msg( $title );
}
$this->prepareErrorPage();
$this->setPageTitleMsg( $title );
if ( $msg instanceof Message ) {
if ( $params !== [] ) {
trigger_error( 'Argument ignored: $params. The message parameters argument '
. 'is discarded when the $msg argument is a Message object instead of '
. 'a string.', E_USER_NOTICE );
}
$this->addHTML( $msg->parseAsBlock() );
} else {
$this->addWikiMsgArray( $msg, $params );
}
$this->returnToMain( null, $returnto, $returntoquery );
}
/**
* Output a standard permission error page
*
* @param PermissionStatus $status
* @param string|null $action Action that was denied or null if unknown
*/
public function showPermissionStatus( PermissionStatus $status, $action = null ) {
Assert::precondition( !$status->isGood(), 'Status must have errors' );
$this->showPermissionInternal(
array_map( fn ( $msg ) => $this->msg( $msg ), $status->getMessages() ),
$action
);
}
/**
* Output a standard permission error page
*
* @deprecated since 1.43. Use ::showPermissionStatus instead
* @param array $errors Error message keys or [key, param...] arrays
* @param string|null $action Action that was denied or null if unknown
*/
public function showPermissionsErrorPage( array $errors, $action = null ) {
wfDeprecated( __METHOD__, '1.43' );
foreach ( $errors as $key => $error ) {
$errors[$key] = (array)$error;
}
$this->showPermissionInternal(
// @phan-suppress-next-line PhanParamTooFewUnpack Elements of $errors already annotated as non-empty
array_map( fn ( $err ) => $this->msg( ...$err ), $errors ),
$action
);
}
/**
* Helper for showPermissionStatus() and deprecated showPermissionsErrorMessage(),
* should be inlined when the deprecated method is removed.
*
* @param Message[] $messages
* @param string|null $action
*/
public function showPermissionInternal( array $messages, $action = null ) {
$services = MediaWikiServices::getInstance();
$groupPermissionsLookup = $services->getGroupPermissionsLookup();
// For some actions (read, edit, create and upload), display a "login to do this action"
// error if all of the following conditions are met:
// 1. the user is not logged in as a named user, and so cannot be added to groups
// 2. the only error is insufficient permissions (i.e. no block or something else)
// 3. the error can be avoided simply by logging in
if ( in_array( $action, [ 'read', 'edit', 'createpage', 'createtalk', 'upload' ] )
&& !$this->getUser()->isNamed() && count( $messages ) == 1
&& ( $messages[0]->getKey() == 'badaccess-groups' || $messages[0]->getKey() == 'badaccess-group0' )
&& ( $groupPermissionsLookup->groupHasPermission( 'user', $action )
|| $groupPermissionsLookup->groupHasPermission( 'autoconfirmed', $action ) )
) {
$displayReturnto = null;
# Due to T34276, if a user does not have read permissions,
# $this->getTitle() will just give Special:Badtitle, which is
# not especially useful as a returnto parameter. Use the title
# from the request instead, if there was one.
$request = $this->getRequest();
$returnto = Title::newFromText( $request->getText( 'title' ) );
if ( $action == 'edit' ) {
$msg = 'whitelistedittext';
$displayReturnto = $returnto;
} elseif ( $action == 'createpage' || $action == 'createtalk' ) {
$msg = 'nocreatetext';
} elseif ( $action == 'upload' ) {
$msg = 'uploadnologintext';
} else { # Read
$msg = 'loginreqpagetext';
$displayReturnto = Title::newMainPage();
}
$query = [];
if ( $returnto ) {
$query['returnto'] = $returnto->getPrefixedText();
if ( !$request->wasPosted() ) {
$returntoquery = $request->getValues();
unset( $returntoquery['title'] );
unset( $returntoquery['returnto'] );
unset( $returntoquery['returntoquery'] );
$query['returntoquery'] = wfArrayToCgi( $returntoquery );
}
}
$title = SpecialPage::getTitleFor( 'Userlogin' );
$linkRenderer = $services->getLinkRenderer();
$loginUrl = $title->getLinkURL( $query, false, PROTO_RELATIVE );
$loginLink = $linkRenderer->makeKnownLink(
$title,
$this->msg( 'loginreqlink' )->text(),
[],
$query
);
$this->prepareErrorPage();
$this->setPageTitleMsg( $this->msg( 'loginreqtitle' ) );
$this->addHTML( $this->msg( $msg )->rawParams( $loginLink )->params( $loginUrl )->parse() );
# Don't return to a page the user can't read otherwise
# we'll end up in a pointless loop
if ( $displayReturnto && $this->getAuthority()->probablyCan( 'read', $displayReturnto ) ) {
$this->returnToMain( null, $displayReturnto );
}
} else {
$this->prepareErrorPage();
$this->setPageTitleMsg( $this->msg( 'permissionserrors' ) );
$this->addWikiTextAsInterface( $this->formatPermissionInternal( $messages, $action ) );
}
}
/**
* Display an error page indicating that a given version of MediaWiki is
* required to use it
*
* @param mixed $version The version of MediaWiki needed to use the page
*/
public function versionRequired( $version ) {
$this->prepareErrorPage();
$this->setPageTitleMsg(
$this->msg( 'versionrequired' )->plaintextParams( $version )
);
$this->addWikiMsg( 'versionrequiredtext', $version );
$this->returnToMain();
}
/**
* Format permission $status obtained from Authority for display.
*
* @param PermissionStatus $status
* @param-taint $status none
* @param string|null $action that was denied or null if unknown
* @return string
* @return-taint tainted
*/
public function formatPermissionStatus( PermissionStatus $status, ?string $action = null ): string {
if ( $status->isGood() ) {
return '';
}
return $this->formatPermissionInternal(
array_map( fn ( $msg ) => $this->msg( $msg ), $status->getMessages() ),
$action
);
}
/**
* Format a list of error messages
*
* @deprecated since 1.36. Use ::formatPermissionStatus instead
* @param array $errors Array of arrays returned by PermissionManager::getPermissionErrors
* @param-taint $errors none
* @phan-param non-empty-array[] $errors
* @param string|null $action Action that was denied or null if unknown
* @return string The wikitext error-messages, formatted into a list.
* @return-taint tainted
*/
public function formatPermissionsErrorMessage( array $errors, $action = null ) {
wfDeprecated( __METHOD__, '1.36' );
return $this->formatPermissionInternal(
// @phan-suppress-next-line PhanParamTooFewUnpack Elements of $errors already annotated as non-empty
array_map( fn ( $err ) => $this->msg( ...$err ), $errors ),
$action
);
}
/**
* Helper for formatPermissionStatus() and deprecated formatPermissionsErrorMessage(),
* should be inlined when the deprecated method is removed.
*
* @param Message[] $messages
* @param-taint $messages none
* @param string|null $action
* @return string
* @return-taint tainted
*
* @suppress SecurityCheck-DoubleEscaped Working with plain text, not HTML
*/
private function formatPermissionInternal( array $messages, $action = null ) {
if ( $action == null ) {
$text = $this->msg( 'permissionserrorstext', count( $messages ) )->plain() . "\n\n";
} else {
$action_desc = $this->msg( "action-$action" )->plain();
$text = $this->msg(
'permissionserrorstext-withaction',
count( $messages ),
$action_desc
)->plain() . "\n\n";
}
if ( count( $messages ) > 1 ) {
$text .= Html::openElement( 'ul', [ 'class' => 'permissions-errors' ] );
foreach ( $messages as $message ) {
$text .= Html::rawElement(
'li',
[ 'class' => 'mw-permissionerror-' . $message->getKey() ],
$message->plain()
);
}
$text .= Html::closeElement( 'ul' );
} else {
$text .= Html::openElement( 'div', [ 'class' => 'permissions-errors' ] );
$text .= Html::rawElement(
'div',
[ 'class' => 'mw-permissionerror-' . $messages[ 0 ]->getKey() ],
$messages[ 0 ]->plain()
);
$text .= Html::closeElement( 'div' );
}
return $text;
}
/**
* Show a warning about replica DB lag
*
* If the lag is higher than $wgDatabaseReplicaLagCritical seconds,
* then the warning is a bit more obvious. If the lag is
* lower than $wgDatabaseReplicaLagWarning, then no warning is shown.
*
* @param int $lag Replica lag
*/
public function showLagWarning( $lag ) {
$config = $this->getConfig();
if ( $lag >= $config->get( MainConfigNames::DatabaseReplicaLagWarning ) ) {
$lag = floor( $lag ); // floor to avoid nano seconds to display
$message = $lag < $config->get( MainConfigNames::DatabaseReplicaLagCritical )
? 'lag-warn-normal'
: 'lag-warn-high';
// For grep: mw-lag-warn-normal, mw-lag-warn-high
$wrap = Html::rawElement( 'div', [ 'class' => "mw-{$message}" ], "\n$1\n" );
$this->wrapWikiMsg( "$wrap\n", [ $message, $this->getLanguage()->formatNum( $lag ) ] );
}
}
/**
* Output an error page
*
* @deprecated since 1.43 Use showErrorPage() instead
* @param string $message Error to output. Must be escaped for HTML.
*/
public function showFatalError( $message ) {
wfDeprecated( __METHOD__, '1.43' );
$this->prepareErrorPage();
$this->setPageTitleMsg( $this->msg( 'internalerror' ) );
$this->addHTML( $message );
}
/**
* Add a "return to" link pointing to a specified title
*
* @param LinkTarget $title Title to link
* @param array $query Query string parameters
* @param string|null $text Text of the link (input is not escaped)
* @param array $options Options array to pass to Linker
*/
public function addReturnTo( $title, array $query = [], $text = null, $options = [] ) {
$linkRenderer = MediaWikiServices::getInstance()
->getLinkRendererFactory()->createFromLegacyOptions( $options );
$link = $this->msg( 'returnto' )->rawParams(
$linkRenderer->makeLink( $title, $text, [], $query ) )->escaped();
$this->addHTML( "<p id=\"mw-returnto\">{$link}</p>\n" );
}
/**
* Add a "return to" link pointing to a specified title,
* or the title indicated in the request, or else the main page
*
* @param mixed|null $unused
* @param PageReference|LinkTarget|string|null $returnto Page to return to
* @param string|null $returntoquery Query string for the return to link
*/
public function returnToMain( $unused = null, $returnto = null, $returntoquery = null ) {
$returnto ??= $this->getRequest()->getText( 'returnto' );
$returntoquery ??= $this->getRequest()->getText( 'returntoquery' );
if ( $returnto === '' ) {
$returnto = Title::newMainPage();
}
if ( is_object( $returnto ) ) {
$linkTarget = TitleValue::castPageToLinkTarget( $returnto );
} else {
$linkTarget = Title::newFromText( $returnto );
}
// We don't want people to return to external interwiki. That
// might potentially be used as part of a phishing scheme
if ( !is_object( $linkTarget ) || $linkTarget->isExternal() ) {
$linkTarget = Title::newMainPage();
}
$this->addReturnTo( $linkTarget, wfCgiToArray( $returntoquery ) );
}
/**
* Output a standard "wait for takeover" warning
*
* This is useful for extensions which are hooking an action and
* suppressing its normal output so it can be taken over with JS.
*
* showPendingTakeover( 'url', 'pagetextmsg' );
* showPendingTakeover( 'url', 'pagetextmsg', [ 'param1', 'param2' ] );
* showPendingTakeover( 'url', $messageObject );
*
* @param string $fallbackUrl URL to redirect to if the user doesn't have JavaScript
* or ResourceLoader available; this should ideally be to a page that provides similar
* functionality without requiring JavaScript
* @param string|MessageSpecifier $msg Message key (string) for page text, or a MessageSpecifier
* @param mixed ...$params Message parameters; ignored if $msg is a Message object
*/
public function showPendingTakeover(
$fallbackUrl, $msg, ...$params
) {
if ( $msg instanceof Message ) {
if ( $params !== [] ) {
trigger_error( 'Argument ignored: $params. The message parameters argument '
. 'is discarded when the $msg argument is a Message object instead of '
. 'a string.', E_USER_NOTICE );
}
$this->addHTML( $msg->parseAsBlock() );
} else {
$this->addHTML( $this->msg( $msg, ...$params )->parseAsBlock() );
}
// Redirect if the user has no JS (<noscript>)
$escapedUrl = htmlspecialchars( $fallbackUrl );
$this->addHeadItem(
'mw-noscript-fallback',
// https://html.spec.whatwg.org/#attr-meta-http-equiv-refresh
// means that if $fallbackUrl contains unencoded quotation marks
// then this will behave confusingly, but shouldn't break the page
"<noscript><meta http-equiv=\"refresh\" content=\"0; url=$escapedUrl\"></noscript>"
);
// Redirect if the user has no ResourceLoader
$this->addScript( Html::inlineScript(
'(window.NORLQ=window.NORLQ||[]).push(' .
'function(){' .
'location.href=' . json_encode( $fallbackUrl ) . ';' .
'}' .
');'
) );
}
private function getRlClientContext() {
if ( !$this->rlClientContext ) {
$query = ResourceLoader::makeLoaderQuery(
[], // modules; not relevant
$this->getLanguage()->getCode(),
$this->getSkin()->getSkinName(),
$this->getUser()->isRegistered() ? $this->getUser()->getName() : null,
null, // version; not relevant
ResourceLoader::inDebugMode(),
null, // only; not relevant
$this->isPrintable()
);
$this->rlClientContext = new RL\Context(
$this->getResourceLoader(),
new FauxRequest( $query )
);
if ( $this->contentOverrideCallbacks ) {
$this->rlClientContext = new RL\DerivativeContext( $this->rlClientContext );
$this->rlClientContext->setContentOverrideCallback( function ( $page ) {
foreach ( $this->contentOverrideCallbacks as $callback ) {
$content = $callback( $page );
if ( $content !== null ) {
$text = ( $content instanceof TextContent ) ? $content->getText() : '';
if ( preg_match( '/<\/?script/i', $text ) ) {
// Proactively replace this so that we can display a message
// to the user, instead of letting it go to Html::inlineScript(),
// where it would be considered a server-side issue.
$content = new JavaScriptContent(
Html::encodeJsCall( 'mw.log.error', [
"Cannot preview $page due to suspecting script tag inside (T200506)."
] )
);
}
return $content;
}
}
return null;
} );
}
}
return $this->rlClientContext;
}
/**
* Call this to freeze the module queue and JS config and create a formatter.
*
* Depending on the Skin, this may get lazy-initialised in either headElement() or
* getBottomScripts(). See SkinTemplate::prepareQuickTemplate(). Calling this too early may
* cause unexpected side-effects since disallowUserJs() may be called at any time to change
* the module filters retroactively. Skins and extension hooks may also add modules until very
* late in the request lifecycle.
*
* @return RL\ClientHtml
*/
public function getRlClient() {
if ( !$this->rlClient ) {
$context = $this->getRlClientContext();
$rl = $this->getResourceLoader();
$this->addModules( [
'user',
'user.options',
] );
$this->addModuleStyles( [
'site.styles',
'noscript',
'user.styles',
] );
// Prepare exempt modules for buildExemptModules()
$exemptGroups = [
RL\Module::GROUP_SITE => [],
RL\Module::GROUP_NOSCRIPT => [],
RL\Module::GROUP_PRIVATE => [],
RL\Module::GROUP_USER => []
];
$exemptStates = [];
$moduleStyles = $this->getModuleStyles( /*filter*/ true );
// Preload getTitleInfo for isKnownEmpty calls below and in RL\ClientHtml
// Separate user-specific batch for improved cache-hit ratio.
$userBatch = [ 'user.styles', 'user' ];
$siteBatch = array_diff( $moduleStyles, $userBatch );
RL\WikiModule::preloadTitleInfo( $context, $siteBatch );
RL\WikiModule::preloadTitleInfo( $context, $userBatch );
// Filter out modules handled by buildExemptModules()
$moduleStyles = array_filter( $moduleStyles,
static function ( $name ) use ( $rl, $context, &$exemptGroups, &$exemptStates ) {
$module = $rl->getModule( $name );
if ( $module ) {
$group = $module->getGroup();
if ( $group !== null && isset( $exemptGroups[$group] ) ) {
// The `noscript` module is excluded from the client
// side registry, no need to set its state either.
// But we still output it. See T291735
if ( $group !== RL\Module::GROUP_NOSCRIPT ) {
$exemptStates[$name] = 'ready';
}
if ( !$module->isKnownEmpty( $context ) ) {
// E.g. Don't output empty <styles>
$exemptGroups[$group][] = $name;
}
return false;
}
}
return true;
}
);
$this->rlExemptStyleModules = $exemptGroups;
$config = $this->getConfig();
// Client preferences are controlled by the skin and specific to unregistered
// users. See mw.user.clientPrefs for details on how this works and how to
// handle registered users.
$clientPrefEnabled = (
$this->getSkin()->getOptions()['clientPrefEnabled'] &&
!$this->getUser()->isNamed()
);
$clientPrefCookiePrefix = $config->get( MainConfigNames::CookiePrefix );
$rlClient = new RL\ClientHtml( $context, [
'target' => $this->getTarget(),
// When 'safemode', disallowUserJs(), or reduceAllowedModules() is used
// to only restrict modules to ORIGIN_CORE (ie. disallow ORIGIN_USER), the list of
// modules enqueued for loading on this page is filtered to just those.
// However, to make sure we also apply the restriction to dynamic dependencies and
// lazy-loaded modules at run-time on the client-side, pass 'safemode' down to the
// StartupModule so that the client-side registry will not contain any restricted
// modules either. (T152169, T185303)
'safemode' => ( $this->getAllowedModules( RL\Module::TYPE_COMBINED )
<= RL\Module::ORIGIN_CORE_INDIVIDUAL
) ? '1' : null,
'clientPrefEnabled' => $clientPrefEnabled,
'clientPrefCookiePrefix' => $clientPrefCookiePrefix,
] );
$rlClient->setConfig( $this->getJSVars( self::JS_VAR_EARLY ) );
$rlClient->setModules( $this->getModules( /*filter*/ true ) );
$rlClient->setModuleStyles( $moduleStyles );
$rlClient->setExemptStates( $exemptStates );
$this->rlClient = $rlClient;
}
return $this->rlClient;
}
/**
* @param Skin $sk The given Skin
* @param bool $includeStyle Unused
* @return string The doctype, opening "<html>", and head element.
*/
public function headElement( Skin $sk, $includeStyle = true ) {
$config = $this->getConfig();
$userdir = $this->getLanguage()->getDir();
$services = MediaWikiServices::getInstance();
$sitedir = $services->getContentLanguage()->getDir();
$pieces = [];
$htmlAttribs = Sanitizer::mergeAttributes( Sanitizer::mergeAttributes(
$this->getRlClient()->getDocumentAttributes(),
$sk->getHtmlElementAttributes()
), [ 'class' => implode( ' ', $this->mAdditionalHtmlClasses ) ] );
$pieces[] = Html::htmlHeader( $htmlAttribs );
$pieces[] = Html::openElement( 'head' );
if ( $this->getHTMLTitle() == '' ) {
$this->setHTMLTitle( $this->msg( 'pagetitle', $this->getPageTitle() )->inContentLanguage() );
}
if ( !Html::isXmlMimeType( $config->get( MainConfigNames::MimeType ) ) ) {
// Add <meta charset="UTF-8">
// This should be before <title> since it defines the charset used by
// text including the text inside <title>.
// The spec recommends defining XHTML5's charset using the XML declaration
// instead of meta.
// Our XML declaration is output by Html::htmlHeader.
// https://html.spec.whatwg.org/multipage/semantics.html#attr-meta-http-equiv-content-type
// https://html.spec.whatwg.org/multipage/semantics.html#charset
$pieces[] = Html::element( 'meta', [ 'charset' => 'UTF-8' ] );
}
$pieces[] = Html::element( 'title', [], $this->getHTMLTitle() );
$pieces[] = $this->getRlClient()->getHeadHtml( $htmlAttribs['class'] ?? null );
$pieces[] = $this->buildExemptModules();
$pieces = array_merge( $pieces, array_values( $this->getHeadLinksArray() ) );
$pieces = array_merge( $pieces, array_values( $this->mHeadItems ) );
$pieces[] = Html::closeElement( 'head' );
$skinOptions = $sk->getOptions();
$bodyClasses = array_merge( $this->mAdditionalBodyClasses, $skinOptions['bodyClasses'] );
$bodyClasses[] = 'mediawiki';
# Classes for LTR/RTL directionality support
$bodyClasses[] = $userdir;
$bodyClasses[] = "sitedir-$sitedir";
// See Article:showDiffPage for class to support article diff styling
$underline = $services->getUserOptionsLookup()->getOption( $this->getUser(), 'underline' );
if ( $underline < 2 ) {
// The following classes can be used here:
// * mw-underline-always
// * mw-underline-never
$bodyClasses[] = 'mw-underline-' . ( $underline ? 'always' : 'never' );
}
// Parser feature migration class
// The idea is that this will eventually be removed, after the wikitext
// which requires it is cleaned up.
$bodyClasses[] = 'mw-hide-empty-elt';
$bodyClasses[] = $sk->getPageClasses( $this->getTitle() );
$bodyClasses[] = 'skin-' . Sanitizer::escapeClass( $sk->getSkinName() );
$bodyClasses[] =
'action-' . Sanitizer::escapeClass( $this->getContext()->getActionName() );
if ( $sk->isResponsive() ) {
$bodyClasses[] = 'skin--responsive';
}
$bodyAttrs = [];
// While the implode() is not strictly needed, it's used for backwards compatibility
// (this used to be built as a string and hooks likely still expect that).
$bodyAttrs['class'] = implode( ' ', $bodyClasses );
$this->getHookRunner()->onOutputPageBodyAttributes( $this, $sk, $bodyAttrs );
$pieces[] = Html::openElement( 'body', $bodyAttrs );
return self::combineWrappedStrings( $pieces );
}
/**
* Get a ResourceLoader object associated with this OutputPage
*
* @return ResourceLoader
*/
public function getResourceLoader() {
if ( $this->mResourceLoader === null ) {
// Lazy-initialise as needed
$this->mResourceLoader = MediaWikiServices::getInstance()->getResourceLoader();
}
return $this->mResourceLoader;
}
/**
* Explicitly load or embed modules on a page.
*
* @param array|string $modules One or more module names
* @param string $only RL\Module TYPE_ class constant
* @param array $extraQuery [optional] Array with extra query parameters for the request
* @return string|WrappedStringList HTML
*/
public function makeResourceLoaderLink( $modules, $only, array $extraQuery = [] ) {
// Apply 'origin' filters
$modules = $this->filterModules( (array)$modules, null, $only );
return RL\ClientHtml::makeLoad(
$this->getRlClientContext(),
$modules,
$only,
$extraQuery
);
}
/**
* Combine WrappedString chunks and filter out empty ones
*
* @param array $chunks
* @return string|WrappedStringList HTML
*/
protected static function combineWrappedStrings( array $chunks ) {
// Filter out empty values
$chunks = array_filter( $chunks, 'strlen' );
return WrappedString::join( "\n", $chunks );
}
/**
* JS stuff to put at the bottom of the `<body>`.
* These are legacy scripts ($this->mScripts), and user JS.
*
* @return string|WrappedStringList HTML
*/
public function getBottomScripts() {
// Keep the hook appendage separate to preserve WrappedString objects.
// This enables to merge them where possible.
$extraHtml = '';
$this->getHookRunner()->onSkinAfterBottomScripts( $this->getSkin(), $extraHtml );
$chunks = [];
$chunks[] = $this->getRlClient()->getBodyHtml();
// Legacy non-ResourceLoader scripts
$chunks[] = $this->mScripts;
// Keep hostname and backend time as the first variables for quick view-source access.
// This other variables will form a very long inline blob.
$vars = [];
if ( $this->getConfig()->get( MainConfigNames::ShowHostnames ) ) {
$vars['wgHostname'] = wfHostname();
}
$elapsed = $this->getRequest()->getElapsedTime();
// seconds to milliseconds
$vars['wgBackendResponseTime'] = round( $elapsed * 1000 );
$vars += $this->getJSVars( self::JS_VAR_LATE );
if ( $this->limitReportJSData ) {
$vars['wgPageParseReport'] = $this->limitReportJSData;
}
$rlContext = $this->getRlClientContext();
$chunks[] = ResourceLoader::makeInlineScript(
'mw.config.set(' . $rlContext->encodeJson( $vars ) . ');'
);
$chunks = [ self::combineWrappedStrings( $chunks ) ];
if ( $extraHtml !== '' ) {
$chunks[] = $extraHtml;
}
return WrappedString::join( "\n", $chunks );
}
/**
* Get the javascript config vars to include on this page
*
* @return array Array of javascript config vars
* @since 1.23
*/
public function getJsConfigVars() {
return $this->mJsConfigVars;
}
/**
* Add one or more variables to be set in mw.config in JavaScript
*
* @param string|array $keys Key or array of key/value pairs
* @param mixed|null $value [optional] Value of the configuration variable
*/
public function addJsConfigVars( $keys, $value = null ) {
if ( is_array( $keys ) ) {
foreach ( $keys as $key => $value ) {
$this->mJsConfigVars[$key] = $value;
}
return;
}
$this->mJsConfigVars[$keys] = $value;
}
/**
* Get an array containing the variables to be set in mw.config in JavaScript.
*
* Do not add things here which can be evaluated in RL\StartUpModule,
* in other words, page-independent/site-wide variables (without state).
* These would add a blocking HTML cost to page rendering time, and require waiting for
* HTTP caches to expire before configuration changes take effect everywhere.
*
* By default, these are loaded in the HTML head and block page rendering.
* Config variable names can be set in CORE_LATE_JS_CONFIG_VAR_NAMES, or
* for extensions via the 'LateJSConfigVarNames' attribute, to opt-in to
* being sent from the end of the HTML body instead, to improve page load time.
* In JavaScript, late variables should be accessed via mw.hook('wikipage.content').
*
* @param int|null $flag Return only the specified kind of variables: self::JS_VAR_EARLY or self::JS_VAR_LATE.
* For internal use only.
* @return array
*/
public function getJSVars( ?int $flag = null ) {
$curRevisionId = 0;
$articleId = 0;
$canonicalSpecialPageName = false; # T23115
$services = MediaWikiServices::getInstance();
$title = $this->getTitle();
$ns = $title->getNamespace();
$nsInfo = $services->getNamespaceInfo();
$canonicalNamespace = $nsInfo->exists( $ns )
? $nsInfo->getCanonicalName( $ns )
: $title->getNsText();
$sk = $this->getSkin();
// Get the relevant title so that AJAX features can use the correct page name
// when making API requests from certain special pages (T36972).
$relevantTitle = $sk->getRelevantTitle();
if ( $ns === NS_SPECIAL ) {
[ $canonicalSpecialPageName, /*...*/ ] =
$services->getSpecialPageFactory()->
resolveAlias( $title->getDBkey() );
} elseif ( $this->canUseWikiPage() ) {
$wikiPage = $this->getWikiPage();
// If we already know that the latest revision ID is the same as the revision ID being viewed,
// avoid fetching it again, as it may give inconsistent results (T339164).
if ( $this->isRevisionCurrent() && $this->getRevisionId() ) {
$curRevisionId = $this->getRevisionId();
} else {
$curRevisionId = $wikiPage->getLatest();
}
$articleId = $wikiPage->getId();
}
// ParserOutput informs HTML/CSS via lang/dir attributes.
// We inform JavaScript via mw.config from here.
$lang = $this->getContentLangForJS();
// Pre-process information
$separatorTransTable = $lang->separatorTransformTable();
$separatorTransTable = $separatorTransTable ?: [];
$compactSeparatorTransTable = [
implode( "\t", array_keys( $separatorTransTable ) ),
implode( "\t", $separatorTransTable ),
];
$digitTransTable = $lang->digitTransformTable();
$digitTransTable = $digitTransTable ?: [];
$compactDigitTransTable = [
implode( "\t", array_keys( $digitTransTable ) ),
implode( "\t", $digitTransTable ),
];
$user = $this->getUser();
// Internal variables for MediaWiki core
$vars = [
// @internal For mediawiki.page.ready
'wgBreakFrames' => $this->getFrameOptions() == 'DENY',
// @internal For jquery.tablesorter
'wgSeparatorTransformTable' => $compactSeparatorTransTable,
'wgDigitTransformTable' => $compactDigitTransTable,
'wgDefaultDateFormat' => $lang->getDefaultDateFormat(),
'wgMonthNames' => $lang->getMonthNamesArray(),
// @internal For debugging purposes
'wgRequestId' => WebRequest::getRequestId(),
];
// Start of supported and stable config vars (for use by extensions/gadgets).
$vars += [
'wgCanonicalNamespace' => $canonicalNamespace,
'wgCanonicalSpecialPageName' => $canonicalSpecialPageName,
'wgNamespaceNumber' => $title->getNamespace(),
'wgPageName' => $title->getPrefixedDBkey(),
'wgTitle' => $title->getText(),
'wgCurRevisionId' => $curRevisionId,
'wgRevisionId' => (int)$this->getRevisionId(),
'wgArticleId' => $articleId,
'wgIsArticle' => $this->isArticle(),
'wgIsRedirect' => $title->isRedirect(),
'wgAction' => $this->getContext()->getActionName(),
'wgUserName' => $user->isAnon() ? null : $user->getName(),
'wgUserGroups' => $services->getUserGroupManager()->getUserEffectiveGroups( $user ),
'wgCategories' => $this->getCategories(),
'wgPageViewLanguage' => $lang->getCode(),
'wgPageContentLanguage' => $lang->getCode(),
'wgPageContentModel' => $title->getContentModel(),
'wgRelevantPageName' => $relevantTitle->getPrefixedDBkey(),
'wgRelevantArticleId' => $relevantTitle->getArticleID(),
];
if ( $user->isRegistered() ) {
$vars['wgUserId'] = $user->getId();
$vars['wgUserIsTemp'] = $user->isTemp();
$vars['wgUserEditCount'] = $user->getEditCount();
$userReg = $user->getRegistration();
$vars['wgUserRegistration'] = $userReg ? (int)wfTimestamp( TS_UNIX, $userReg ) * 1000 : null;
$userFirstReg = $services->getUserRegistrationLookup()->getFirstRegistration( $user );
$vars['wgUserFirstRegistration'] = $userFirstReg ? (int)wfTimestamp( TS_UNIX, $userFirstReg ) * 1000 : null;
// Get the revision ID of the oldest new message on the user's talk
// page. This can be used for constructing new message alerts on
// the client side.
$userNewMsgRevId = $this->getLastSeenUserTalkRevId();
// Only occupy precious space in the <head> when it is non-null (T53640)
// mw.config.get returns null by default.
if ( $userNewMsgRevId ) {
$vars['wgUserNewMsgRevisionId'] = $userNewMsgRevId;
}
} else {
$tempUserCreator = $services->getTempUserCreator();
if ( $tempUserCreator->isEnabled() ) {
// For logged-out users only (without a temporary account): get the user name that will
// be used for their temporary account, if it has already been acquired.
// This may be used in previews.
$session = $this->getRequest()->getSession();
$vars['wgTempUserName'] = $tempUserCreator->getStashedName( $session );
}
}
$languageConverter = $services->getLanguageConverterFactory()
->getLanguageConverter( $title->getPageLanguage() );
if ( $languageConverter->hasVariants() ) {
$vars['wgUserVariant'] = $languageConverter->getPreferredVariant();
}
// Same test as SkinTemplate
$vars['wgIsProbablyEditable'] = $this->getAuthority()->probablyCan( 'edit', $title );
$vars['wgRelevantPageIsProbablyEditable'] = $relevantTitle &&
$this->getAuthority()->probablyCan( 'edit', $relevantTitle );
$restrictionStore = $services->getRestrictionStore();
foreach ( $restrictionStore->listApplicableRestrictionTypes( $title ) as $type ) {
// Following keys are set in $vars:
// wgRestrictionCreate, wgRestrictionEdit, wgRestrictionMove, wgRestrictionUpload
$vars['wgRestriction' . ucfirst( $type )] = $restrictionStore->getRestrictions( $title, $type );
}
if ( $title->isMainPage() ) {
$vars['wgIsMainPage'] = true;
}
$relevantUser = $sk->getRelevantUser();
if ( $relevantUser ) {
$vars['wgRelevantUserName'] = $relevantUser->getName();
}
// End of stable config vars
$titleFormatter = $services->getTitleFormatter();
if ( $this->mRedirectedFrom ) {
// @internal For skin JS
$vars['wgRedirectedFrom'] = $titleFormatter->getPrefixedDBkey( $this->mRedirectedFrom );
}
// Allow extensions to add their custom variables to the mw.config map.
// Use the 'ResourceLoaderGetConfigVars' hook if the variable is not
// page-dependent but site-wide (without state).
// Alternatively, you may want to use OutputPage->addJsConfigVars() instead.
$this->getHookRunner()->onMakeGlobalVariablesScript( $vars, $this );
// Merge in variables from addJsConfigVars last
$vars = array_merge( $vars, $this->getJsConfigVars() );
// Return only early or late vars if requested
if ( $flag !== null ) {
$lateVarNames =
array_fill_keys( self::CORE_LATE_JS_CONFIG_VAR_NAMES, true ) +
array_fill_keys( ExtensionRegistry::getInstance()->getAttribute( 'LateJSConfigVarNames' ), true );
foreach ( $vars as $name => $_ ) {
// If the variable's late flag doesn't match the requested late flag, unset it
if ( isset( $lateVarNames[ $name ] ) !== ( $flag === self::JS_VAR_LATE ) ) {
unset( $vars[ $name ] );
}
}
}
return $vars;
}
/**
* Get the revision ID for the last user talk page revision viewed by the talk page owner.
*
* @return int|null
*/
private function getLastSeenUserTalkRevId() {
$services = MediaWikiServices::getInstance();
$user = $this->getUser();
$userHasNewMessages = $services
->getTalkPageNotificationManager()
->userHasNewMessages( $user );
if ( !$userHasNewMessages ) {
return null;
}
$timestamp = $services
->getTalkPageNotificationManager()
->getLatestSeenMessageTimestamp( $user );
if ( !$timestamp ) {
return null;
}
$revRecord = $services->getRevisionLookup()->getRevisionByTimestamp(
$user->getTalkPage(),
$timestamp
);
return $revRecord ? $revRecord->getId() : null;
}
/**
* To make it harder for someone to slip a user a fake
* JavaScript or CSS preview, a random token
* is associated with the login session. If it's not
* passed back with the preview request, we won't render
* the code.
*
* @return bool
*/
public function userCanPreview() {
$request = $this->getRequest();
if (
$request->getRawVal( 'action' ) !== 'submit' ||
!$request->wasPosted()
) {
return false;
}
$user = $this->getUser();
if ( !$user->isRegistered() ) {
// Anons have predictable edit tokens
return false;
}
if ( !$user->matchEditToken( $request->getVal( 'wpEditToken' ) ) ) {
return false;
}
$title = $this->getTitle();
if ( !$this->getAuthority()->probablyCan( 'edit', $title ) ) {
return false;
}
return true;
}
/**
* @return array Array in format "link name or number => 'link html'".
*/
public function getHeadLinksArray() {
$tags = [];
$config = $this->getConfig();
if ( $this->cspOutputMode === self::CSP_META ) {
foreach ( $this->CSP->getDirectives() as $header => $directive ) {
$tags["meta-csp-$header"] = Html::element( 'meta', [
'http-equiv' => $header,
'content' => $directive,
] );
}
}
$tags['meta-generator'] = Html::element( 'meta', [
'name' => 'generator',
'content' => 'MediaWiki ' . MW_VERSION,
] );
if ( $config->get( MainConfigNames::ReferrerPolicy ) !== false ) {
// Per https://w3c.github.io/webappsec-referrer-policy/#unknown-policy-values
// fallbacks should come before the primary value so we need to reverse the array.
foreach ( array_reverse( (array)$config->get( MainConfigNames::ReferrerPolicy ) ) as $i => $policy ) {
$tags["meta-referrer-$i"] = Html::element( 'meta', [
'name' => 'referrer',
'content' => $policy,
] );
}
}
$p = $this->getRobotsContent();
if ( $p ) {
// http://www.robotstxt.org/wc/meta-user.html
// Only show if it's different from the default robots policy
$tags['meta-robots'] = Html::element( 'meta', [
'name' => 'robots',
'content' => $p,
] );
}
# Browser based phonenumber detection
if ( $config->get( MainConfigNames::BrowserFormatDetection ) !== false ) {
$tags['meta-format-detection'] = Html::element( 'meta', [
'name' => 'format-detection',
'content' => $config->get( MainConfigNames::BrowserFormatDetection ),
] );
}
foreach ( $this->mMetatags as [ $name, $val ] ) {
$attrs = [];
if ( strncasecmp( $name, 'http:', 5 ) === 0 ) {
$name = substr( $name, 5 );
$attrs['http-equiv'] = $name;
} elseif ( strncasecmp( $name, 'og:', 3 ) === 0 ) {
$attrs['property'] = $name;
} else {
$attrs['name'] = $name;
}
$attrs['content'] = $val;
$tagName = "meta-$name";
if ( isset( $tags[$tagName] ) ) {
$tagName .= $val;
}
$tags[$tagName] = Html::element( 'meta', $attrs );
}
foreach ( $this->mLinktags as $tag ) {
$tags[] = Html::element( 'link', $tag );
}
if ( $config->get( MainConfigNames::UniversalEditButton ) && $this->isArticleRelated() ) {
if ( $this->getAuthority()->probablyCan( 'edit', $this->getTitle() ) ) {
$msg = $this->msg( 'edit' )->text();
// Use mime type per https://phabricator.wikimedia.org/T21165#6946526
$tags['universal-edit-button'] = Html::element( 'link', [
'rel' => 'alternate',
'type' => 'application/x-wiki',
'title' => $msg,
'href' => $this->getTitle()->getEditURL(),
] );
}
}
# Generally the order of the favicon and apple-touch-icon links
# should not matter, but Konqueror (3.5.9 at least) incorrectly
# uses whichever one appears later in the HTML source. Make sure
# apple-touch-icon is specified first to avoid this.
$appleTouchIconHref = $config->get( MainConfigNames::AppleTouchIcon );
# Browser look for those by default, unnessecary to set a link tag
if (
$appleTouchIconHref !== false &&
$appleTouchIconHref !== '/apple-touch-icon.png' &&
$appleTouchIconHref !== '/apple-touch-icon-precomposed.png'
) {
$tags['apple-touch-icon'] = Html::element( 'link', [
'rel' => 'apple-touch-icon',
'href' => $appleTouchIconHref
] );
}
$faviconHref = $config->get( MainConfigNames::Favicon );
# Browser look for those by default, unnessecary to set a link tag
if ( $faviconHref !== false && $faviconHref !== '/favicon.ico' ) {
$tags['favicon'] = Html::element( 'link', [
'rel' => 'icon',
'href' => $faviconHref
] );
}
# OpenSearch description link
$tags['opensearch'] = Html::element( 'link', [
'rel' => 'search',
'type' => 'application/opensearchdescription+xml',
'href' => wfScript( 'rest' ) . '/v1/search',
'title' => $this->msg( 'opensearch-desc' )->inContentLanguage()->text(),
] );
$services = MediaWikiServices::getInstance();
# Real Simple Discovery link, provides auto-discovery information
# for the MediaWiki API (and potentially additional custom API
# support such as WordPress or Twitter-compatible APIs for a
# blogging extension, etc)
$tags['rsd'] = Html::element( 'link', [
'rel' => 'EditURI',
'type' => 'application/rsd+xml',
// Output a protocol-relative URL here if $wgServer is protocol-relative.
// Whether RSD accepts relative or protocol-relative URLs is completely
// undocumented, though.
'href' => (string)$services->getUrlUtils()->expand( wfAppendQuery(
wfScript( 'api' ),
[ 'action' => 'rsd' ] ),
PROTO_RELATIVE
),
] );
$tags = array_merge(
$tags,
$this->getHeadLinksCanonicalURLArray( $config ),
$this->getHeadLinksAlternateURLsArray(),
$this->getHeadLinksCopyrightArray( $config ),
$this->getHeadLinksSyndicationArray( $config ),
);
// Allow extensions to add, remove and/or otherwise manipulate these links
// If you want only to *add* <head> links, please use the addHeadItem()
// (or addHeadItems() for multiple items) method instead.
// This hook is provided as a last resort for extensions to modify these
// links before the output is sent to client.
$this->getHookRunner()->onOutputPageAfterGetHeadLinksArray( $tags, $this );
return $tags;
}
/**
* Canonical URL and alternate URLs
*
* isCanonicalUrlAction affects all requests where "setArticleRelated" is true.
* This is typically all requests that show content (query title, curid, oldid, diff),
* and all wikipage actions (edit, delete, purge, info, history etc.).
* It does not apply to file pages and special pages.
* 'history' and 'info' actions address page metadata rather than the page
* content itself, so they may not be canonicalized to the view page url.
* TODO: this logic should be owned by Action subclasses.
* See T67402
*/
/**
* Get head links relating to the canonical URL
* Note: There should only be one canonical URL.
* @param Config $config
* @return array
*/
private function getHeadLinksCanonicalURLArray( Config $config ) {
$tags = [];
$canonicalUrl = $this->mCanonicalUrl;
if ( $config->get( MainConfigNames::EnableCanonicalServerLink ) ) {
$query = [];
$action = $this->getContext()->getActionName();
$isCanonicalUrlAction = in_array( $action, [ 'history', 'info' ] );
$services = MediaWikiServices::getInstance();
$languageConverterFactory = $services->getLanguageConverterFactory();
$isLangConversionDisabled = $languageConverterFactory->isConversionDisabled();
$pageLang = $this->getTitle()->getPageLanguage();
$pageLanguageConverter = $languageConverterFactory->getLanguageConverter( $pageLang );
$urlVariant = $pageLanguageConverter->getURLVariant();
if ( $canonicalUrl !== false ) {
$canonicalUrl = (string)$services->getUrlUtils()->expand( $canonicalUrl, PROTO_CANONICAL );
} elseif ( $this->isArticleRelated() ) {
if ( $isCanonicalUrlAction ) {
$query['action'] = $action;
} elseif ( !$isLangConversionDisabled && $urlVariant ) {
# T54429, T108443: Making canonical URL language-variant-aware.
$query['variant'] = $urlVariant;
}
$canonicalUrl = $this->getTitle()->getCanonicalURL( $query );
} else {
$reqUrl = $this->getRequest()->getRequestURL();
$canonicalUrl = (string)$services->getUrlUtils()->expand( $reqUrl, PROTO_CANONICAL );
}
}
if ( $canonicalUrl !== false ) {
$tags['link-canonical'] = Html::element( 'link', [
'rel' => 'canonical',
'href' => $canonicalUrl
] );
}
return $tags;
}
/**
* Get head links relating to alternate URL(s) in languages including language variants
* Output fully-qualified URL since meta alternate URLs must be fully-qualified
* Per https://developers.google.com/search/docs/advanced/crawling/localized-versions
* See T294716
*
* @return array
*/
private function getHeadLinksAlternateURLsArray() {
$tags = [];
$languageUrls = [];
$action = $this->getContext()->getActionName();
$isCanonicalUrlAction = in_array( $action, [ 'history', 'info' ] );
$services = MediaWikiServices::getInstance();
$languageConverterFactory = $services->getLanguageConverterFactory();
$isLangConversionDisabled = $languageConverterFactory->isConversionDisabled();
$pageLang = $this->getTitle()->getPageLanguage();
$pageLanguageConverter = $languageConverterFactory->getLanguageConverter( $pageLang );
# Language variants
if (
$this->isArticleRelated() &&
!$isCanonicalUrlAction &&
$pageLanguageConverter->hasVariants() &&
!$isLangConversionDisabled
) {
$variants = $pageLanguageConverter->getVariants();
foreach ( $variants as $variant ) {
$bcp47 = LanguageCode::bcp47( $variant );
$languageUrls[$bcp47] = $this->getTitle()
->getFullURL( [ 'variant' => $variant ], false, PROTO_CURRENT );
}
}
# Alternate URLs for interlanguage links would be handeled in HTML body tag instead of
# head tag, see T326829.
if ( $languageUrls ) {
# Force the alternate URL of page language code to be self.
# T123901, T305540, T108443: Override mixed-variant variant link in language variant links.
$currentUrl = $this->getTitle()->getFullURL( [], false, PROTO_CURRENT );
$pageLangCodeBcp47 = LanguageCode::bcp47( $pageLang->getCode() );
$languageUrls[$pageLangCodeBcp47] = $currentUrl;
ksort( $languageUrls );
# Also add x-default link per https://support.google.com/webmasters/answer/189077?hl=en
$languageUrls['x-default'] = $currentUrl;
# Process all of language variants and interlanguage links
foreach ( $languageUrls as $bcp47 => $languageUrl ) {
$bcp47lowercase = strtolower( $bcp47 );
$tags['link-alternate-language-' . $bcp47lowercase] = Html::element( 'link', [
'rel' => 'alternate',
'hreflang' => $bcp47,
'href' => $languageUrl,
] );
}
}
return $tags;
}
/**
* Get head links relating to copyright
*
* @param Config $config
* @return array
*/
private function getHeadLinksCopyrightArray( Config $config ) {
$tags = [];
if ( $this->copyrightUrl !== null ) {
$copyright = $this->copyrightUrl;
} else {
$copyright = '';
if ( $config->get( MainConfigNames::RightsPage ) ) {
$copy = Title::newFromText( $config->get( MainConfigNames::RightsPage ) );
if ( $copy ) {
$copyright = $copy->getLocalURL();
}
}
if ( !$copyright && $config->get( MainConfigNames::RightsUrl ) ) {
$copyright = $config->get( MainConfigNames::RightsUrl );
}
}
if ( $copyright ) {
$tags['copyright'] = Html::element( 'link', [
'rel' => 'license',
'href' => $copyright
] );
}
return $tags;
}
/**
* Get head links relating to syndication feeds.
*
* @param Config $config
* @return array
*/
private function getHeadLinksSyndicationArray( Config $config ) {
if ( !$config->get( MainConfigNames::Feed ) ) {
return [];
}
$tags = [];
$feedLinks = [];
foreach ( $this->getSyndicationLinks() as $format => $link ) {
# Use the page name for the title. In principle, this could
# lead to issues with having the same name for different feeds
# corresponding to the same page, but we can't avoid that at
# this low a level.
$feedLinks[] = $this->feedLink(
$format,
$link,
# Used messages: 'page-rss-feed' and 'page-atom-feed' (for an easier grep)
$this->msg(
"page-{$format}-feed", $this->getTitle()->getPrefixedText()
)->text()
);
}
# Recent changes feed should appear on every page (except recentchanges,
# that would be redundant). Put it after the per-page feed to avoid
# changing existing behavior. It's still available, probably via a
# menu in your browser. Some sites might have a different feed they'd
# like to promote instead of the RC feed (maybe like a "Recent New Articles"
# or "Breaking news" one). For this, we see if $wgOverrideSiteFeed is defined.
# If so, use it instead.
$sitename = $config->get( MainConfigNames::Sitename );
$overrideSiteFeed = $config->get( MainConfigNames::OverrideSiteFeed );
if ( $overrideSiteFeed ) {
foreach ( $overrideSiteFeed as $type => $feedUrl ) {
// Note, this->feedLink escapes the url.
$feedLinks[] = $this->feedLink(
$type,
$feedUrl,
$this->msg( "site-{$type}-feed", $sitename )->text()
);
}
} elseif ( !$this->getTitle()->isSpecial( 'Recentchanges' ) ) {
$rctitle = SpecialPage::getTitleFor( 'Recentchanges' );
foreach ( $this->getAdvertisedFeedTypes() as $format ) {
$feedLinks[] = $this->feedLink(
$format,
$rctitle->getLocalURL( [ 'feed' => $format ] ),
# For grep: 'site-rss-feed', 'site-atom-feed'
$this->msg( "site-{$format}-feed", $sitename )->text()
);
}
}
# Allow extensions to change the list pf feeds. This hook is primarily for changing,
# manipulating or removing existing feed tags. If you want to add new feeds, you should
# use OutputPage::addFeedLink() instead.
$this->getHookRunner()->onAfterBuildFeedLinks( $feedLinks );
$tags += $feedLinks;
return $tags;
}
/**
* Generate a "<link rel/>" for a feed.
*
* @param string $type Feed type
* @param string $url URL to the feed
* @param string $text Value of the "title" attribute
* @return string HTML fragment
*/
private function feedLink( $type, $url, $text ) {
return Html::element( 'link', [
'rel' => 'alternate',
'type' => "application/$type+xml",
'title' => $text,
'href' => $url ]
);
}
/**
* Add a local or specified stylesheet, with the given media options.
* Internal use only. Use OutputPage::addModuleStyles() if possible.
*
* @param string $style URL to the file
* @param string $media To specify a media type, 'screen', 'printable', 'handheld' or any.
* @param string $condition For IE conditional comments, specifying an IE version
* @param string $dir Set to 'rtl' or 'ltr' for direction-specific sheets
*/
public function addStyle( $style, $media = '', $condition = '', $dir = '' ) {
$options = [];
if ( $media ) {
$options['media'] = $media;
}
if ( $condition ) {
$options['condition'] = $condition;
}
if ( $dir ) {
$options['dir'] = $dir;
}
$this->styles[$style] = $options;
}
/**
* Adds inline CSS styles
* Internal use only. Use OutputPage::addModuleStyles() if possible.
*
* @param mixed $style_css Inline CSS
* @param-taint $style_css exec_html
* @param string $flip Set to 'flip' to flip the CSS if needed
*/
public function addInlineStyle( $style_css, $flip = 'noflip' ) {
if ( $flip === 'flip' && $this->getLanguage()->isRTL() ) {
# If wanted, and the interface is right-to-left, flip the CSS
$style_css = CSSJanus::transform( $style_css, true, false );
}
$this->mInlineStyles .= Html::inlineStyle( $style_css );
}
/**
* Build exempt modules and legacy non-ResourceLoader styles.
*
* @return string|WrappedStringList HTML
*/
protected function buildExemptModules() {
$chunks = [];
// Requirements:
// - Within modules provided by the software (core, skin, extensions),
// styles from skin stylesheets should be overridden by styles
// from modules dynamically loaded with JavaScript.
// - Styles from site-specific, private, and user modules should override
// both of the above.
//
// The effective order for stylesheets must thus be:
// 1. Page style modules, formatted server-side by RL\ClientHtml.
// 2. Dynamically-loaded styles, inserted client-side by mw.loader.
// 3. Styles that are site-specific, private or from the user, formatted
// server-side by this function.
//
// The 'ResourceLoaderDynamicStyles' marker helps JavaScript know where
// point #2 is.
// Add legacy styles added through addStyle()/addInlineStyle() here
$chunks[] = implode( '', $this->buildCssLinksArray() ) . $this->mInlineStyles;
// Things that go after the ResourceLoaderDynamicStyles marker
$append = [];
$separateReq = [ 'site.styles', 'user.styles' ];
foreach ( $this->rlExemptStyleModules as $moduleNames ) {
if ( $moduleNames ) {
$append[] = $this->makeResourceLoaderLink(
array_diff( $moduleNames, $separateReq ),
RL\Module::TYPE_STYLES
);
foreach ( array_intersect( $moduleNames, $separateReq ) as $name ) {
// These require their own dedicated request in order to support "@import"
// syntax, which is incompatible with concatenation. (T147667, T37562)
$append[] = $this->makeResourceLoaderLink( $name,
RL\Module::TYPE_STYLES
);
}
}
}
if ( $append ) {
$chunks[] = Html::element(
'meta',
[ 'name' => 'ResourceLoaderDynamicStyles', 'content' => '' ]
);
$chunks = array_merge( $chunks, $append );
}
return self::combineWrappedStrings( $chunks );
}
/**
* @return array
*/
public function buildCssLinksArray() {
$links = [];
foreach ( $this->styles as $file => $options ) {
$link = $this->styleLink( $file, $options );
if ( $link ) {
$links[$file] = $link;
}
}
return $links;
}
/**
* Generate \<link\> tags for stylesheets
*
* @param string $style URL to the file
* @param array $options Option, can contain 'condition', 'dir', 'media' keys
* @return string HTML fragment
*/
protected function styleLink( $style, array $options ) {
if ( isset( $options['dir'] ) && $this->getLanguage()->getDir() != $options['dir'] ) {
return '';
}
if ( isset( $options['media'] ) ) {
$media = self::transformCssMedia( $options['media'] );
if ( $media === null ) {
return '';
}
} else {
$media = 'all';
}
if ( str_starts_with( $style, '/' ) ||
str_starts_with( $style, 'http:' ) ||
str_starts_with( $style, 'https:' )
) {
$url = $style;
} else {
$config = $this->getConfig();
// Append file hash as query parameter
$url = self::transformResourcePath(
$config,
$config->get( MainConfigNames::StylePath ) . '/' . $style
);
}
$link = Html::linkedStyle( $url, $media );
if ( isset( $options['condition'] ) ) {
$condition = htmlspecialchars( $options['condition'] );
$link = "<!--[if $condition]>$link<![endif]-->";
}
return $link;
}
/**
* Transform path to web-accessible static resource.
*
* This is used to add a validation hash as query string.
* This aids various behaviors:
*
* - Put long Cache-Control max-age headers on responses for improved
* cache performance.
* - Get the correct version of a file as expected by the current page.
* - Instantly get the updated version of a file after deployment.
*
* Avoid using this for urls included in HTML as otherwise clients may get different
* versions of a resource when navigating the site depending on when the page was cached.
* If changes to the url propagate, this is not a problem (e.g. if the url is in
* an external stylesheet).
*
* @since 1.27
* @param Config $config
* @param string $path Path-absolute URL to file (from document root, must start with "/")
* @return string URL
*/
public static function transformResourcePath( Config $config, $path ) {
$localDir = $config->get( MainConfigNames::BaseDirectory );
$remotePathPrefix = $config->get( MainConfigNames::ResourceBasePath );
if ( $remotePathPrefix === '' ) {
// The configured base path is required to be empty string for
// wikis in the domain root
$remotePath = '/';
} else {
$remotePath = $remotePathPrefix;
}
if ( !str_starts_with( $path, $remotePath ) || str_starts_with( $path, '//' ) ) {
// - Path is outside wgResourceBasePath, ignore.
// - Path is protocol-relative. Fixes T155310. Not supported by RelPath lib.
return $path;
}
// For files in resources, extensions/ or skins/, ResourceBasePath is preferred here.
// For other misc files in $IP, we'll fallback to that as well. There is, however, a fourth
// supported dir/path pair in the configuration (wgUploadDirectory, wgUploadPath)
// which is not expected to be in wgResourceBasePath on CDNs. (T155146)
$uploadPath = $config->get( MainConfigNames::UploadPath );
if ( strpos( $path, $uploadPath ) === 0 ) {
$localDir = $config->get( MainConfigNames::UploadDirectory );
$remotePathPrefix = $remotePath = $uploadPath;
}
$path = RelPath::getRelativePath( $path, $remotePath );
return self::transformFilePath( $remotePathPrefix, $localDir, $path );
}
/**
* Utility method for transformResourceFilePath().
*
* Caller is responsible for ensuring the file exists. Emits a PHP warning otherwise.
*
* @since 1.27
* @param string $remotePathPrefix URL path prefix that points to $localPath
* @param string $localPath File directory exposed at $remotePath
* @param string $file Path to target file relative to $localPath
* @return string URL
*/
public static function transformFilePath( $remotePathPrefix, $localPath, $file ) {
// This MUST match the equivalent logic in CSSMin::remapOne()
$localFile = "$localPath/$file";
$url = "$remotePathPrefix/$file";
if ( is_file( $localFile ) ) {
$hash = md5_file( $localFile );
if ( $hash === false ) {
wfLogWarning( __METHOD__ . ": Failed to hash $localFile" );
$hash = '';
}
$url .= '?' . substr( $hash, 0, 5 );
}
return $url;
}
/**
* Transform "media" attribute based on request parameters
*
* @param string $media Current value of the "media" attribute
* @return string|null Modified value of the "media" attribute, or null to disable
* this stylesheet
*/
public static function transformCssMedia( $media ) {
global $wgRequest;
if ( $wgRequest->getBool( 'printable' ) ) {
// When browsing with printable=yes, apply "print" media styles
// as if they are screen styles (no media, media="").
if ( $media === 'print' ) {
return '';
}
// https://www.w3.org/TR/css3-mediaqueries/#syntax
//
// This regex will not attempt to understand a comma-separated media_query_list
// Example supported values for $media:
//
// 'screen', 'only screen', 'screen and (min-width: 982px)' ),
//
// Example NOT supported value for $media:
//
// '3d-glasses, screen, print and resolution > 90dpi'
//
// If it's a "printable" request, we disable all screen stylesheets.
$screenMediaQueryRegex = '/^(?:only\s+)?screen\b/i';
if ( preg_match( $screenMediaQueryRegex, $media ) === 1 ) {
return null;
}
}
return $media;
}
/**
* Add a wikitext-formatted message to the output.
*
* @param string|MessageSpecifier $name Message key
* @param mixed ...$args Message parameters. Unlike wfMessage(), this method only accepts
* variadic parameters (they can't be passed as a single array parameter).
*/
public function addWikiMsg( $name, ...$args ) {
$this->addWikiMsgArray( $name, $args );
}
/**
* Add a wikitext-formatted message to the output.
*
* @param string|MessageSpecifier $name Message key
* @param array $args Message parameters. Unlike wfMessage(), this method only accepts
* the parameters as an array (they can't be passed as variadic parameters),
* or just a single parameter (this only works by accident, don't rely on it).
*/
public function addWikiMsgArray( $name, $args ) {
$this->addHTML( $this->msg( $name, $args )->parseAsBlock() );
}
/**
* This function takes a number of message/argument specifications, wraps them in
* some overall structure, and then parses the result and adds it to the output.
*
* In the $wrap, $1 is replaced with the first message, $2 with the second,
* and so on. The subsequent arguments may be either
* 1) strings, in which case they are message names, or
* 2) arrays, in which case, within each array, the first element is the message
* name, and subsequent elements are the parameters to that message.
*
* Don't use this for messages that are not in the user's interface language.
*
* For example:
*
* $wgOut->wrapWikiMsg( "<div class='customclass'>\n$1\n</div>", 'some-msg-key' );
*
* Is equivalent to:
*
* $wgOut->addWikiTextAsInterface( "<div class='customclass'>\n"
* . wfMessage( 'some-msg-key' )->plain() . "\n</div>" );
*
* The newline after the opening div is needed in some wikitext. See T21226.
*
* @param string $wrap
* @param mixed ...$msgSpecs
*/
public function wrapWikiMsg( $wrap, ...$msgSpecs ) {
$s = $wrap;
foreach ( $msgSpecs as $n => $spec ) {
if ( is_array( $spec ) ) {
$args = $spec;
$name = array_shift( $args );
} else {
$args = [];
$name = $spec;
}
$s = str_replace( '$' . ( $n + 1 ), $this->msg( $name, $args )->plain(), $s );
}
$this->addWikiTextAsInterface( $s );
}
/**
* Whether the output has a table of contents when the ToC is
* rendered inline.
* @return bool
* @since 1.22
*/
public function isTOCEnabled() {
return $this->mEnableTOC;
}
/**
* Helper function to setup the PHP implementation of OOUI to use in this request.
*
* @since 1.26
* @param string|null $skinName Ignored since 1.41
* @param string|null $dir Ignored since 1.41
*/
public static function setupOOUI( $skinName = null, $dir = null ) {
if ( !self::$oouiSetupDone ) {
self::$oouiSetupDone = true;
$context = RequestContext::getMain();
$skinName = $context->getSkinName();
$dir = $context->getLanguage()->getDir();
$themes = RL\OOUIFileModule::getSkinThemeMap();
$theme = $themes[$skinName] ?? $themes['default'];
// For example, 'OOUI\WikimediaUITheme'.
$themeClass = "OOUI\\{$theme}Theme";
Theme::setSingleton( new $themeClass() );
Element::setDefaultDir( $dir );
}
}
/**
* Notify of a change in global skin or language which would necessitate
* reinitialization of OOUI global static data.
* @internal
*/
public static function resetOOUI() {
if ( self::$oouiSetupDone ) {
self::$oouiSetupDone = false;
self::setupOOUI();
}
}
/**
* Add ResourceLoader module styles for OOUI and set up the PHP implementation of it for use with
* MediaWiki and this OutputPage instance.
*
* @since 1.25
*/
public function enableOOUI() {
self::setupOOUI();
$this->addModuleStyles( [
'oojs-ui-core.styles',
'oojs-ui.styles.indicators',
'mediawiki.widgets.styles',
'oojs-ui-core.icons',
] );
}
/**
* Get the ContentSecurityPolicy object
*
* @since 1.35
* @return ContentSecurityPolicy
*/
public function getCSP() {
return $this->CSP;
}
/**
* Sets the output mechanism for content security policies (HTTP headers or meta tags).
* Defaults to HTTP headers; in most cases this should not be changed.
*
* Meta mode should not be used together with setArticleBodyOnly() as meta tags and other
* headers are not output when that flag is set.
*
* @param string $mode One of the CSP_* constants
* @phan-param 'headers'|'meta' $mode
* @return void
* @see self::CSP_HEADERS
* @see self::CSP_META
*/
public function setCspOutputMode( string $mode ): void {
$this->cspOutputMode = $mode;
}
/**
* The final bits that go to the bottom of a page
* HTML document including the closing tags
*
* @internal
* @since 1.37
* @param Skin $skin
* @return string
*/
public function tailElement( $skin ) {
$tail = [
MWDebug::getDebugHTML( $skin ),
$this->getBottomScripts(),
MWDebug::getHTMLDebugLog(),
Html::closeElement( 'body' ),
Html::closeElement( 'html' ),
];
return WrappedStringList::join( "\n", $tail );
}
}
/** @deprecated class alias since 1.41 */
class_alias( OutputPage::class, 'OutputPage' );
|