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
|
<?php
/**
* Base class for all skins.
*
* 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
*/
use MediaWiki\HookContainer\ProtectedHookAccessorTrait;
use MediaWiki\MediaWikiServices;
use MediaWiki\Revision\RevisionLookup;
use Wikimedia\WrappedString;
use Wikimedia\WrappedStringList;
/**
* @defgroup Skins Skins
*/
/**
* The main skin class which provides methods and properties for all other skins.
*
* See docs/Skin.md for more information.
*
* @stable for subclassing
* @ingroup Skins
*/
abstract class Skin extends ContextSource {
use ProtectedHookAccessorTrait;
/**
* @var string|null
*/
protected $skinname = null;
/**
* @var array Skin options passed into constructor
*/
protected $options = [];
protected $mRelevantTitle = null;
protected $mRelevantUser = null;
/**
* @var string Stylesheets set to use. Subdirectory in skins/ where various stylesheets are
* located. Only needs to be set if you intend to use the getSkinStylePath() method.
*/
public $stylename = null;
/**
* Fetch the set of available skins.
* @return array Associative array of strings
*/
public static function getSkinNames() {
$skinFactory = MediaWikiServices::getInstance()->getSkinFactory();
return $skinFactory->getSkinNames();
}
/**
* Fetch the list of user-selectable skins in regards to $wgSkipSkins.
* Useful for Special:Preferences and other places where you
* only want to show skins users _can_ use.
* @return string[]
* @since 1.23
*/
public static function getAllowedSkins() {
global $wgSkipSkins;
$allowedSkins = self::getSkinNames();
// Internal skins not intended for general use
unset( $allowedSkins['fallback'] );
unset( $allowedSkins['apioutput'] );
foreach ( $wgSkipSkins as $skip ) {
unset( $allowedSkins[$skip] );
}
return $allowedSkins;
}
/**
* Normalize a skin preference value to a form that can be loaded.
*
* If a skin can't be found, it will fall back to the configured default ($wgDefaultSkin), or the
* hardcoded default ($wgFallbackSkin) if the default skin is unavailable too.
*
* @param string $key 'monobook', 'vector', etc.
* @return string
*/
public static function normalizeKey( $key ) {
global $wgDefaultSkin, $wgFallbackSkin;
$skinNames = self::getSkinNames();
// Make keys lowercase for case-insensitive matching.
$skinNames = array_change_key_case( $skinNames, CASE_LOWER );
$key = strtolower( $key );
$defaultSkin = strtolower( $wgDefaultSkin );
$fallbackSkin = strtolower( $wgFallbackSkin );
if ( $key == '' || $key == 'default' ) {
// Don't return the default immediately;
// in a misconfiguration we need to fall back.
$key = $defaultSkin;
}
if ( isset( $skinNames[$key] ) ) {
return $key;
}
// Older versions of the software used a numeric setting
// in the user preferences.
$fallback = [
0 => $defaultSkin,
2 => 'cologneblue'
];
if ( isset( $fallback[$key] ) ) {
$key = $fallback[$key];
}
if ( isset( $skinNames[$key] ) ) {
return $key;
} elseif ( isset( $skinNames[$defaultSkin] ) ) {
return $defaultSkin;
} else {
return $fallbackSkin;
}
}
/**
* @since 1.31
* @param string|null|array $options Options for the skin can be an array since 1.35.
* When an array is passed `name` represents skinname,
* `scripts` represents an array of ResourceLoader script modules
* and `styles` represents
* an array of ResourceLoader style modules to load on all pages.
*/
public function __construct( $options = null ) {
if ( is_string( $options ) ) {
$this->skinname = $options;
} elseif ( $options ) {
$this->options = $options;
$name = $options['name'] ?? null;
// Note: skins might override the public $skinname method instead
if ( $name ) {
$this->skinname = $name;
}
}
}
/**
* @return string|null Skin name
*/
public function getSkinName() {
return $this->skinname;
}
/**
* @stable for overriding
* @param OutputPage $out
*/
public function initPage( OutputPage $out ) {
$this->preloadExistence();
}
/**
* Defines the ResourceLoader modules that should be added to the skin
* It is recommended that skins wishing to override call parent::getDefaultModules()
* and substitute out any modules they wish to change by using a key to look them up
*
* Any modules defined with the 'styles' key will be added as render blocking CSS via
* Output::addModuleStyles. Similarly, each key should refer to a list of modules
*
* @stable for overriding
* @return array Array of modules with helper keys for easy overriding
*/
public function getDefaultModules() {
$out = $this->getOutput();
$user = $this->getUser();
// Modules declared in the $modules literal are loaded
// for ALL users, on ALL pages, in ALL skins.
// Keep this list as small as possible!
$modules = [
// The 'styles' key sets render-blocking style modules
// Unlike other keys in $modules, this is an associative array
// where each key is its own group pointing to a list of modules
'styles' => [
'skin' => $this->options['styles'] ?? [],
'core' => [],
'content' => [],
'syndicate' => [],
],
'core' => [
'site',
'mediawiki.page.startup',
],
// modules that enhance the content in some way
'content' => [
'mediawiki.page.ready',
],
// modules relating to search functionality
'search' => [],
// Skins can register their own scripts
'skin' => $this->options['scripts'] ?? [],
// modules relating to functionality relating to watching an article
'watch' => [],
// modules which relate to the current users preferences
'user' => [],
// modules relating to RSS/Atom Feeds
'syndicate' => [],
];
// Preload jquery.tablesorter for mediawiki.page.ready
if ( strpos( $out->getHTML(), 'sortable' ) !== false ) {
$modules['content'][] = 'jquery.tablesorter';
$modules['styles']['content'][] = 'jquery.tablesorter.styles';
}
// Preload jquery.makeCollapsible for mediawiki.page.ready
if ( strpos( $out->getHTML(), 'mw-collapsible' ) !== false ) {
$modules['content'][] = 'jquery.makeCollapsible';
$modules['styles']['content'][] = 'jquery.makeCollapsible.styles';
}
// Deprecated since 1.26: Unconditional loading of mediawiki.ui.button
// on every page is deprecated. Express a dependency instead.
if ( strpos( $out->getHTML(), 'mw-ui-button' ) !== false ) {
$modules['styles']['content'][] = 'mediawiki.ui.button';
}
if ( $out->isTOCEnabled() ) {
$modules['content'][] = 'mediawiki.toc';
$modules['styles']['content'][] = 'mediawiki.toc.styles';
}
$prefMgr = MediaWikiServices::getInstance()->getPermissionManager();
if ( $user->isLoggedIn()
&& $prefMgr->userHasAllRights( $user, 'writeapi', 'viewmywatchlist', 'editmywatchlist' )
&& $this->getRelevantTitle()->canExist()
) {
$modules['watch'][] = 'mediawiki.page.watch.ajax';
}
if ( $user->getBoolOption( 'editsectiononrightclick' )
|| ( $out->isArticle() && $user->getOption( 'editondblclick' ) )
) {
$modules['user'][] = 'mediawiki.misc-authed-pref';
}
if ( $out->isSyndicated() ) {
$modules['styles']['syndicate'][] = 'mediawiki.feedlink';
}
return $modules;
}
/**
* Preload the existence of three commonly-requested pages in a single query
*/
protected function preloadExistence() {
$titles = [];
// User/talk link
$user = $this->getUser();
if ( $user->isLoggedIn() ) {
$titles[] = $user->getUserPage();
$titles[] = $user->getTalkPage();
}
// Check, if the page can hold some kind of content, otherwise do nothing
$title = $this->getRelevantTitle();
if ( $title->canExist() && $title->canHaveTalkPage() ) {
$namespaceInfo = MediaWikiServices::getInstance()->getNamespaceInfo();
if ( $title->isTalkPage() ) {
$titles[] = $namespaceInfo->getSubjectPage( $title );
} else {
$titles[] = $namespaceInfo->getTalkPage( $title );
}
}
// Footer links (used by SkinTemplate::prepareQuickTemplate)
if ( $this->getConfig()->get( 'FooterLinkCacheExpiry' ) <= 0 ) {
$titles = array_merge(
$titles,
array_filter( [
$this->footerLinkTitle( 'privacy', 'privacypage' ),
$this->footerLinkTitle( 'aboutsite', 'aboutpage' ),
$this->footerLinkTitle( 'disclaimers', 'disclaimerpage' ),
] )
);
}
$this->getHookRunner()->onSkinPreloadExistence( $titles, $this );
if ( $titles ) {
$lb = new LinkBatch( $titles );
$lb->setCaller( __METHOD__ );
$lb->execute();
}
}
/**
* Get the current revision ID
*
* @deprecated since 1.34, use OutputPage::getRevisionId instead
* @return int
*/
public function getRevisionId() {
return $this->getOutput()->getRevisionId();
}
/**
* Whether the revision displayed is the latest revision of the page
*
* @deprecated since 1.34, use OutputPage::isRevisionCurrent instead
* @return bool
*/
public function isRevisionCurrent() {
return $this->getOutput()->isRevisionCurrent();
}
/**
* Set the "relevant" title
* @see self::getRelevantTitle()
* @param Title $t
*/
public function setRelevantTitle( $t ) {
$this->mRelevantTitle = $t;
}
/**
* Return the "relevant" title.
* A "relevant" title is not necessarily the actual title of the page.
* Special pages like Special:MovePage use set the page they are acting on
* as their "relevant" title, this allows the skin system to display things
* such as content tabs which belong to to that page instead of displaying
* a basic special page tab which has almost no meaning.
*
* @return Title
*/
public function getRelevantTitle() {
return $this->mRelevantTitle ?? $this->getTitle();
}
/**
* Set the "relevant" user
* @see self::getRelevantUser()
* @param User $u
*/
public function setRelevantUser( $u ) {
$this->mRelevantUser = $u;
}
/**
* Return the "relevant" user.
* A "relevant" user is similar to a relevant title. Special pages like
* Special:Contributions mark the user which they are relevant to so that
* things like the toolbox can display the information they usually are only
* able to display on a user's userpage and talkpage.
* @return User
*/
public function getRelevantUser() {
if ( isset( $this->mRelevantUser ) ) {
return $this->mRelevantUser;
}
$title = $this->getRelevantTitle();
if ( $title->hasSubjectNamespace( NS_USER ) ) {
$rootUser = $title->getRootText();
if ( User::isIP( $rootUser ) ) {
$this->mRelevantUser = User::newFromName( $rootUser, false );
} else {
$user = User::newFromName( $rootUser, false );
if ( $user ) {
$user->load( User::READ_NORMAL );
if ( $user->isLoggedIn() ) {
$this->mRelevantUser = $user;
}
}
}
return $this->mRelevantUser;
}
return null;
}
/**
* Outputs the HTML generated by other functions.
*/
abstract public function outputPage();
/**
* @param array $data
* @param string|null $nonce OutputPage->getCSP()->getNonce()
* @return string|WrappedString HTML
*/
public static function makeVariablesScript( $data, $nonce = null ) {
if ( $data ) {
return ResourceLoader::makeInlineScript(
ResourceLoader::makeConfigSetScript( $data ),
$nonce
);
}
return '';
}
/**
* Get the query to generate a dynamic stylesheet
*
* @deprecated since 1.32 Use action=raw&ctype=text/css directly.
* @return array
*/
public static function getDynamicStylesheetQuery() {
wfDeprecated( __METHOD__, '1.32' );
return [
'action' => 'raw',
'ctype' => 'text/css',
];
}
/**
* Hook point for adding style modules to OutputPage.
*
* @deprecated since 1.32 Use getDefaultModules() instead.
* @param OutputPage $out Legacy parameter, identical to $this->getOutput()
*/
public function setupSkinUserCss( OutputPage $out ) {
// Stub.
}
/**
* TODO: document
* @param Title $title
* @return string
*/
public function getPageClasses( $title ) {
$numeric = 'ns-' . $title->getNamespace();
$user = $this->getUser();
if ( $title->isSpecialPage() ) {
$type = 'ns-special';
// T25315: provide a class based on the canonical special page name without subpages
list( $canonicalName ) = MediaWikiServices::getInstance()->getSpecialPageFactory()->
resolveAlias( $title->getDBkey() );
if ( $canonicalName ) {
$type .= ' ' . Sanitizer::escapeClass( "mw-special-$canonicalName" );
} else {
$type .= ' mw-invalidspecialpage';
}
} else {
if ( $title->isTalkPage() ) {
$type = 'ns-talk';
} else {
$type = 'ns-subject';
}
// T208315: add HTML class when the user can edit the page
if ( MediaWikiServices::getInstance()->getPermissionManager()
->quickUserCan( 'edit', $user, $title )
) {
$type .= ' mw-editable';
}
}
$name = Sanitizer::escapeClass( 'page-' . $title->getPrefixedText() );
$root = Sanitizer::escapeClass( 'rootpage-' . $title->getRootTitle()->getPrefixedText() );
return "$numeric $type $name $root";
}
/**
* Return values for <html> element
* @return array Array of associative name-to-value elements for <html> element
*/
public function getHtmlElementAttributes() {
$lang = $this->getLanguage();
return [
'lang' => $lang->getHtmlCode(),
'dir' => $lang->getDir(),
'class' => 'client-nojs',
];
}
/**
* URL to the default square logo (1x key)
* Please use ResourceLoaderSkinModule::getAvailableLogos
* @return string
*/
protected function getLogo() {
return ResourceLoaderSkinModule::getAvailableLogos( $this->getConfig() )[ '1x' ];
}
/**
* @return string HTML
*/
public function getCategoryLinks() {
$out = $this->getOutput();
$allCats = $out->getCategoryLinks();
$title = $this->getTitle();
$linkRenderer = MediaWikiServices::getInstance()->getLinkRenderer();
if ( $allCats === [] ) {
return '';
}
$embed = "<li>";
$pop = "</li>";
$s = '';
$colon = $this->msg( 'colon-separator' )->escaped();
if ( !empty( $allCats['normal'] ) ) {
$t = $embed . implode( $pop . $embed, $allCats['normal'] ) . $pop;
$msg = $this->msg( 'pagecategories' )->numParams( count( $allCats['normal'] ) );
$linkPage = $this->msg( 'pagecategorieslink' )->inContentLanguage()->text();
$pageCategoriesLinkTitle = Title::newFromText( $linkPage );
if ( $pageCategoriesLinkTitle ) {
$link = $linkRenderer->makeLink( $pageCategoriesLinkTitle, $msg->text() );
} else {
$link = $msg->escaped();
}
$s .= '<div id="mw-normal-catlinks" class="mw-normal-catlinks">' .
$link . $colon . '<ul>' . $t . '</ul></div>';
}
# Hidden categories
if ( isset( $allCats['hidden'] ) ) {
if ( $this->getUser()->getBoolOption( 'showhiddencats' ) ) {
$class = ' mw-hidden-cats-user-shown';
} elseif ( $title->inNamespace( NS_CATEGORY ) ) {
$class = ' mw-hidden-cats-ns-shown';
} else {
$class = ' mw-hidden-cats-hidden';
}
$s .= "<div id=\"mw-hidden-catlinks\" class=\"mw-hidden-catlinks$class\">" .
$this->msg( 'hidden-categories' )->numParams( count( $allCats['hidden'] ) )->escaped() .
$colon . '<ul>' . $embed . implode( $pop . $embed, $allCats['hidden'] ) . $pop . '</ul>' .
'</div>';
}
# optional 'dmoz-like' category browser. Will be shown under the list
# of categories an article belong to
if ( $this->getConfig()->get( 'UseCategoryBrowser' ) ) {
$s .= '<br /><hr />';
# get a big array of the parents tree
$parenttree = $title->getParentCategoryTree();
# Skin object passed by reference cause it can not be
# accessed under the method subfunction drawCategoryBrowser
$tempout = explode( "\n", $this->drawCategoryBrowser( $parenttree ) );
# Clean out bogus first entry and sort them
unset( $tempout[0] );
asort( $tempout );
# Output one per line
$s .= implode( "<br />\n", $tempout );
}
return $s;
}
/**
* Render the array as a series of links.
* @param array $tree Categories tree returned by Title::getParentCategoryTree
* @return string Separated by >, terminate with "\n"
*/
protected function drawCategoryBrowser( $tree ) {
$return = '';
$linkRenderer = MediaWikiServices::getInstance()->getLinkRenderer();
foreach ( $tree as $element => $parent ) {
if ( empty( $parent ) ) {
# element start a new list
$return .= "\n";
} else {
# grab the others elements
$return .= $this->drawCategoryBrowser( $parent ) . ' > ';
}
# add our current element to the list
$eltitle = Title::newFromText( $element );
$return .= $linkRenderer->makeLink( $eltitle, $eltitle->getText() );
}
return $return;
}
/**
* @return string HTML
*/
public function getCategories() {
$catlinks = $this->getCategoryLinks();
// Check what we're showing
$allCats = $this->getOutput()->getCategoryLinks();
$showHidden = $this->getUser()->getBoolOption( 'showhiddencats' ) ||
$this->getTitle()->inNamespace( NS_CATEGORY );
$classes = [ 'catlinks' ];
if ( empty( $allCats['normal'] ) && !( !empty( $allCats['hidden'] ) && $showHidden ) ) {
$classes[] = 'catlinks-allhidden';
}
return Html::rawElement(
'div',
[ 'id' => 'catlinks', 'class' => $classes, 'data-mw' => 'interface' ],
$catlinks
);
}
/**
* This runs a hook to allow extensions placing their stuff after content
* and article metadata (e.g. categories).
* Note: This function has nothing to do with afterContent().
*
* This hook is placed here in order to allow using the same hook for all
* skins, both the SkinTemplate based ones and the older ones, which directly
* use this class to get their data.
*
* The output of this function gets processed in SkinTemplate::outputPage() for
* the SkinTemplate based skins, all other skins should directly echo it.
*
* @return string Empty by default, if not changed by any hook function.
*/
protected function afterContentHook() {
$data = '';
if ( $this->getHookRunner()->onSkinAfterContent( $data, $this ) ) {
// adding just some spaces shouldn't toggle the output
// of the whole <div/>, so we use trim() here
if ( trim( $data ) != '' ) {
// Doing this here instead of in the skins to
// ensure that the div has the same ID in all
// skins
$data = "<div id='mw-data-after-content'>\n" .
"\t$data\n" .
"</div>\n";
}
} else {
wfDebug( "Hook SkinAfterContent changed output processing." );
}
return $data;
}
/**
* Generate debug data HTML for displaying at the bottom of the main content
* area.
*
* @return string HTML containing debug data, if enabled (otherwise empty).
* @deprecated since 1.35. Call MWDebug::getHTMLDebugLog() directly.
*/
protected function generateDebugHTML() {
wfDeprecated( __METHOD__, '1.35' );
return MWDebug::getHTMLDebugLog();
}
/**
* This gets called shortly before the "</body>" tag.
*
* @return string|WrappedStringList HTML containing scripts to put before `</body>`
*/
public function bottomScripts() {
// TODO and the suckage continues. This function is really just a wrapper around
// OutputPage::getBottomScripts() which takes a Skin param. This should be cleaned
// up at some point
$chunks = [ $this->getOutput()->getBottomScripts() ];
// Keep the hook appendage separate to preserve WrappedString objects.
// This enables BaseTemplate::getTrail() to merge them where possible.
$extraHtml = '';
$this->getHookRunner()->onSkinAfterBottomScripts( $this, $extraHtml );
if ( $extraHtml !== '' ) {
$chunks[] = $extraHtml;
}
return WrappedString::join( "\n", $chunks );
}
/**
* Text with the permalink to the source page,
* usually shown on the footer of a printed page
*
* @stable for overriding
* @return string HTML text with an URL
*/
public function printSource() {
$title = $this->getTitle();
$oldid = $this->getOutput()->getRevisionId();
if ( $oldid ) {
$canonicalUrl = $title->getCanonicalURL( 'oldid=' . $oldid );
$url = htmlspecialchars( wfExpandIRI( $canonicalUrl ) );
} else {
// oldid not available for non existing pages
$url = htmlspecialchars( wfExpandIRI( $title->getCanonicalURL() ) );
}
return $this->msg( 'retrievedfrom' )
->rawParams( '<a dir="ltr" href="' . $url . '">' . $url . '</a>' )
->parse();
}
/**
* @return string HTML
*/
public function getUndeleteLink() {
$action = $this->getRequest()->getVal( 'action', 'view' );
$title = $this->getTitle();
$user = $this->getUser();
$linkRenderer = MediaWikiServices::getInstance()->getLinkRenderer();
$permissionManager = MediaWikiServices::getInstance()->getPermissionManager();
if ( ( !$title->exists() || $action == 'history' ) &&
$permissionManager->quickUserCan( 'deletedhistory', $user, $title )
) {
$n = $title->isDeleted();
if ( $n ) {
if ( $permissionManager->quickUserCan( 'undelete', $user, $title ) ) {
$msg = 'thisisdeleted';
} else {
$msg = 'viewdeleted';
}
$subtitle = $this->msg( $msg )->rawParams(
$linkRenderer->makeKnownLink(
SpecialPage::getTitleFor( 'Undelete', $title->getPrefixedDBkey() ),
$this->msg( 'restorelink' )->numParams( $n )->text() )
)->escaped();
// Allow extensions to add more links
$links = [];
$this->getHookRunner()->onUndeletePageToolLinks(
$this->getContext(), $linkRenderer, $links );
if ( $links ) {
$subtitle .= ''
. $this->msg( 'word-separator' )->escaped()
. $this->msg( 'parentheses' )
->rawParams( $this->getLanguage()->pipeList( $links ) )
->escaped();
}
return Html::rawElement( 'div', [ 'class' => 'mw-undelete-subtitle' ], $subtitle );
}
}
return '';
}
/**
* @param OutputPage|null $out Defaults to $this->getOutput() if left as null
* @return string
*/
public function subPageSubtitle( $out = null ) {
$linkRenderer = MediaWikiServices::getInstance()->getLinkRenderer();
$out = $out ?? $this->getOutput();
$title = $out->getTitle();
$subpages = '';
if ( !$this->getHookRunner()->onSkinSubPageSubtitle( $subpages, $this, $out ) ) {
return $subpages;
}
if (
$out->isArticle() && MediaWikiServices::getInstance()->getNamespaceInfo()->
hasSubpages( $title->getNamespace() )
) {
$ptext = $title->getPrefixedText();
if ( strpos( $ptext, '/' ) !== false ) {
$links = explode( '/', $ptext );
array_pop( $links );
$c = 0;
$growinglink = '';
$display = '';
$lang = $this->getLanguage();
foreach ( $links as $link ) {
$growinglink .= $link;
$display .= $link;
$linkObj = Title::newFromText( $growinglink );
if ( is_object( $linkObj ) && $linkObj->isKnown() ) {
$getlink = $linkRenderer->makeKnownLink(
$linkObj, $display
);
$c++;
if ( $c > 1 ) {
$subpages .= $lang->getDirMarkEntity() . $this->msg( 'pipe-separator' )->escaped();
} else {
$subpages .= '< ';
}
$subpages .= $getlink;
$display = '';
} else {
$display .= '/';
}
$growinglink .= '/';
}
}
}
return $subpages;
}
/**
* @return string
*/
protected function getSearchLink() {
$searchPage = SpecialPage::getTitleFor( 'Search' );
return $searchPage->getLocalURL();
}
/**
* @param string $type
* @return string
*/
public function getCopyright( $type = 'detect' ) {
$linkRenderer = MediaWikiServices::getInstance()->getLinkRenderer();
if ( $type == 'detect' ) {
if ( !$this->getOutput()->isRevisionCurrent()
&& !$this->msg( 'history_copyright' )->inContentLanguage()->isDisabled()
) {
$type = 'history';
} else {
$type = 'normal';
}
}
if ( $type == 'history' ) {
$msg = 'history_copyright';
} else {
$msg = 'copyright';
}
$config = $this->getConfig();
if ( $config->get( 'RightsPage' ) ) {
$title = Title::newFromText( $config->get( 'RightsPage' ) );
$link = $linkRenderer->makeKnownLink(
$title, new HtmlArmor( $config->get( 'RightsText' ) )
);
} elseif ( $config->get( 'RightsUrl' ) ) {
$link = Linker::makeExternalLink( $config->get( 'RightsUrl' ), $config->get( 'RightsText' ) );
} elseif ( $config->get( 'RightsText' ) ) {
$link = $config->get( 'RightsText' );
} else {
# Give up now
return '';
}
// Allow for site and per-namespace customization of copyright notice.
$this->getHookRunner()->onSkinCopyrightFooter( $this->getTitle(), $type, $msg, $link );
return $this->msg( $msg )->rawParams( $link )->text();
}
/**
* @return null|string
*/
protected function getCopyrightIcon() {
$out = '';
$config = $this->getConfig();
$footerIcons = $config->get( 'FooterIcons' );
if ( $footerIcons['copyright']['copyright'] ) {
$out = $footerIcons['copyright']['copyright'];
} elseif ( $config->get( 'RightsIcon' ) ) {
$icon = htmlspecialchars( $config->get( 'RightsIcon' ) );
$url = $config->get( 'RightsUrl' );
if ( $url ) {
$out .= '<a href="' . htmlspecialchars( $url ) . '">';
}
$text = htmlspecialchars( $config->get( 'RightsText' ) );
$out .= "<img src=\"$icon\" alt=\"$text\" width=\"88\" height=\"31\" />";
if ( $url ) {
$out .= '</a>';
}
}
return $out;
}
/**
* Gets the powered by MediaWiki icon.
* @return string
*/
protected function getPoweredBy() {
$resourceBasePath = $this->getConfig()->get( 'ResourceBasePath' );
$url1 = htmlspecialchars(
"$resourceBasePath/resources/assets/poweredby_mediawiki_88x31.png"
);
$url1_5 = htmlspecialchars(
"$resourceBasePath/resources/assets/poweredby_mediawiki_132x47.png"
);
$url2 = htmlspecialchars(
"$resourceBasePath/resources/assets/poweredby_mediawiki_176x62.png"
);
$text = '<a href="https://www.mediawiki.org/"><img src="' . $url1
. '" srcset="' . $url1_5 . ' 1.5x, ' . $url2 . ' 2x" '
. 'height="31" width="88" alt="Powered by MediaWiki" loading="lazy" /></a>';
$this->getHookRunner()->onSkinGetPoweredBy( $text, $this );
return $text;
}
/**
* Get the timestamp of the latest revision, formatted in user language
*
* @return string
*/
protected function lastModified() {
$timestamp = $this->getOutput()->getRevisionTimestamp();
$user = $this->getUser();
$language = $this->getLanguage();
# No cached timestamp, load it from the database
if ( $timestamp === null ) {
$timestamp = MediaWikiServices::getInstance()
->getRevisionLookup()
->getTimestampFromId( $this->getOutput()->getRevisionId() );
}
if ( $timestamp ) {
$d = $language->userDate( $timestamp, $user );
$t = $language->userTime( $timestamp, $user );
$s = ' ' . $this->msg( 'lastmodifiedat', $d, $t )->parse();
} else {
$s = '';
}
if ( MediaWikiServices::getInstance()->getDBLoadBalancer()->getLaggedReplicaMode() ) {
$s .= ' <strong>' . $this->msg( 'laggedreplicamode' )->parse() . '</strong>';
}
return $s;
}
/**
* @param string $align
* @return string
*/
public function logoText( $align = '' ) {
if ( $align != '' ) {
$a = " style='float: {$align};'";
} else {
$a = '';
}
$mp = $this->msg( 'mainpage' )->escaped();
$mptitle = Title::newMainPage();
$url = ( is_object( $mptitle ) ? htmlspecialchars( $mptitle->getLocalURL() ) : '' );
$logourl = $this->getLogo();
return "<a href='{$url}'><img{$a} src='{$logourl}' alt='[{$mp}]' /></a>";
}
/**
* Renders a $wgFooterIcons icon according to the method's arguments
* @param array $icon The icon to build the html for, see $wgFooterIcons
* for the format of this array.
* @param bool|string $withImage Whether to use the icon's image or output
* a text-only footericon.
* @return string HTML
*/
public function makeFooterIcon( $icon, $withImage = 'withImage' ) {
if ( is_string( $icon ) ) {
$html = $icon;
} else { // Assuming array
$url = $icon["url"] ?? null;
unset( $icon["url"] );
if ( isset( $icon["src"] ) && $withImage === 'withImage' ) {
// Lazy-load footer icons, since they're not part of the printed view.
$icon["loading"] = 'lazy';
// do this the lazy way, just pass icon data as an attribute array
$html = Html::element( 'img', $icon );
} else {
$html = htmlspecialchars( $icon["alt"] );
}
if ( $url ) {
$html = Html::rawElement( 'a',
[ "href" => $url, "target" => $this->getConfig()->get( 'ExternalLinkTarget' ) ],
$html );
}
}
return $html;
}
/**
* Gets the link to the wiki's main page.
* @return string
*/
public function mainPageLink() {
$linkRenderer = MediaWikiServices::getInstance()->getLinkRenderer();
$s = $linkRenderer->makeKnownLink(
Title::newMainPage(),
$this->msg( 'mainpage' )->text()
);
return $s;
}
/**
* Returns an HTML link for use in the footer
* @param string $desc The i18n message key for the link text
* @param string $page The i18n message key for the page to link to
* @return string HTML anchor
*/
public function footerLink( $desc, $page ) {
$title = $this->footerLinkTitle( $desc, $page );
$linkRenderer = MediaWikiServices::getInstance()->getLinkRenderer();
if ( !$title ) {
return '';
}
return $linkRenderer->makeKnownLink(
$title,
$this->msg( $desc )->text()
);
}
/**
* @param string $desc
* @param string $page
* @return Title|null
*/
private function footerLinkTitle( $desc, $page ) {
// If the link description has been set to "-" in the default language,
if ( $this->msg( $desc )->inContentLanguage()->isDisabled() ) {
// then it is disabled, for all languages.
return null;
}
// Otherwise, we display the link for the user, described in their
// language (which may or may not be the same as the default language),
// but we make the link target be the one site-wide page.
$title = Title::newFromText( $this->msg( $page )->inContentLanguage()->text() );
return $title ?: null;
}
/**
* Gets the link to the wiki's privacy policy, about page, and disclaimer page
*
* @internal For use by SkinTemplate
* @return string[] Map of (key => HTML) for 'privacy', 'about', 'disclaimer'
*/
public function getSiteFooterLinks() {
$callback = function () {
return [
'privacy' => $this->privacyLink(),
'about' => $this->aboutLink(),
'disclaimer' => $this->disclaimerLink()
];
};
$services = MediaWikiServices::getInstance();
$msgCache = $services->getMessageCache();
$wanCache = $services->getMainWANObjectCache();
$config = $this->getConfig();
return ( $config->get( 'FooterLinkCacheExpiry' ) > 0 )
? $wanCache->getWithSetCallback(
$wanCache->makeKey( 'footer-links' ),
$config->get( 'FooterLinkCacheExpiry' ),
$callback,
[
'checkKeys' => [
// Unless there is both no exact $code override nor an i18n definition
// in the software, the only MediaWiki page to check is for $code.
$msgCache->getCheckKey( $this->getLanguage()->getCode() )
],
'lockTSE' => 30
]
)
: $callback();
}
/**
* Gets the link to the wiki's privacy policy page.
* @return string HTML
*/
public function privacyLink() {
return $this->footerLink( 'privacy', 'privacypage' );
}
/**
* Gets the link to the wiki's about page.
* @return string HTML
*/
public function aboutLink() {
return $this->footerLink( 'aboutsite', 'aboutpage' );
}
/**
* Gets the link to the wiki's general disclaimers page.
* @return string HTML
*/
public function disclaimerLink() {
return $this->footerLink( 'disclaimers', 'disclaimerpage' );
}
/**
* Return URL options for the 'edit page' link.
* This may include an 'oldid' specifier, if the current page view is such.
*
* @return array
* @internal
*/
public function editUrlOptions() {
$options = [ 'action' => 'edit' ];
$out = $this->getOutput();
if ( !$out->isRevisionCurrent() ) {
$options['oldid'] = intval( $out->getRevisionId() );
}
return $options;
}
/**
* @param User|int $id
* @return bool
*/
public function showEmailUser( $id ) {
if ( $id instanceof User ) {
$targetUser = $id;
} else {
$targetUser = User::newFromId( $id );
}
# The sending user must have a confirmed email address and the receiving
# user must accept emails from the sender.
return $this->getUser()->canSendEmail()
&& SpecialEmailUser::validateTarget( $targetUser, $this->getUser() ) === '';
}
/**
* Return a fully resolved style path URL to images or styles stored in the
* current skin's folder. This method returns a URL resolved using the
* configured skin style path.
*
* Requires $stylename to be set, otherwise throws MWException.
*
* @param string $name The name or path of a skin resource file
* @return string The fully resolved style path URL
* @throws MWException
*/
public function getSkinStylePath( $name ) {
if ( $this->stylename === null ) {
$class = static::class;
throw new MWException( "$class::\$stylename must be set to use getSkinStylePath()" );
}
return $this->getConfig()->get( 'StylePath' ) . "/{$this->stylename}/$name";
}
/* these are used extensively in SkinTemplate, but also some other places */
/**
* @param string|array $urlaction
* @return string
*/
public static function makeMainPageUrl( $urlaction = '' ) {
$title = Title::newMainPage();
self::checkTitle( $title, '' );
return $title->getLinkURL( $urlaction );
}
/**
* Make a URL for a Special Page using the given query and protocol.
*
* If $proto is set to null, make a local URL. Otherwise, make a full
* URL with the protocol specified.
*
* @param string $name Name of the Special page
* @param string|array $urlaction Query to append
* @param string|null $proto Protocol to use or null for a local URL
* @return string
*/
public static function makeSpecialUrl( $name, $urlaction = '', $proto = null ) {
$title = SpecialPage::getSafeTitleFor( $name );
if ( $proto === null ) {
return $title->getLocalURL( $urlaction );
} else {
return $title->getFullURL( $urlaction, false, $proto );
}
}
/**
* @param string $name
* @param string $subpage
* @param string|array $urlaction
* @return string
*/
public static function makeSpecialUrlSubpage( $name, $subpage, $urlaction = '' ) {
$title = SpecialPage::getSafeTitleFor( $name, $subpage );
return $title->getLocalURL( $urlaction );
}
/**
* @param string $name
* @param string|array $urlaction
* @return string
* @deprecated since 1.35, no longer used
*/
public static function makeI18nUrl( $name, $urlaction = '' ) {
wfDeprecated( __METHOD__, '1.35' );
$title = Title::newFromText( wfMessage( $name )->inContentLanguage()->text() );
self::checkTitle( $title, $name );
return $title->getLocalURL( $urlaction );
}
/**
* @param string $name
* @param string|array $urlaction
* @return string
*/
public static function makeUrl( $name, $urlaction = '' ) {
$title = Title::newFromText( $name );
self::checkTitle( $title, $name );
return $title->getLocalURL( $urlaction );
}
/**
* If url string starts with http, consider as external URL, else
* internal
* @param string $name
* @return string URL
*/
public static function makeInternalOrExternalUrl( $name ) {
if ( preg_match( '/^(?i:' . wfUrlProtocols() . ')/', $name ) ) {
return $name;
} else {
return self::makeUrl( $name );
}
}
/**
* this can be passed the NS number as defined in Language.php
* @param string $name
* @param string|array $urlaction
* @param int $namespace
* @return string
* @deprecated since 1.35, no longer used
*/
public static function makeNSUrl( $name, $urlaction = '', $namespace = NS_MAIN ) {
wfDeprecated( __METHOD__, '1.35' );
$title = Title::makeTitleSafe( $namespace, $name );
self::checkTitle( $title, $name );
return $title->getLocalURL( $urlaction );
}
/**
* these return an array with the 'href' and boolean 'exists'
* @param string $name
* @param string|array $urlaction
* @return array
*/
protected static function makeUrlDetails( $name, $urlaction = '' ) {
$title = Title::newFromText( $name );
self::checkTitle( $title, $name );
return [
'href' => $title->getLocalURL( $urlaction ),
'exists' => $title->isKnown(),
];
}
/**
* Make URL details where the article exists (or at least it's convenient to think so)
* @param string $name Article name
* @param string|array $urlaction
* @return array
*/
protected static function makeKnownUrlDetails( $name, $urlaction = '' ) {
$title = Title::newFromText( $name );
self::checkTitle( $title, $name );
return [
'href' => $title->getLocalURL( $urlaction ),
'exists' => true
];
}
/**
* make sure we have some title to operate on
*
* @param Title &$title
* @param string $name
*/
public static function checkTitle( &$title, $name ) {
if ( !is_object( $title ) ) {
$title = Title::newFromText( $name );
if ( !is_object( $title ) ) {
$title = Title::newFromText( '--error: link target missing--' );
}
}
}
/**
* Allows correcting the language of interlanguage links which, mostly due to
* legacy reasons, do not always match the standards compliant language tag.
*
* @param string $code
* @return string
* @since 1.35
*/
public function mapInterwikiToLanguage( $code ) {
$map = $this->getConfig()->get( 'InterlanguageLinkCodeMap' );
return $map[ $code ] ?? $code;
}
/**
* Generates array of language links for the current page.
* This may includes items added to this section by the SidebarBeforeOutput hook
* (which may not necessarily be language links)
*
* @since 1.35
* @return array
*/
public function getLanguages() {
if ( $this->getConfig()->get( 'HideInterlanguageLinks' ) ) {
return [];
}
$hookContainer = MediaWikiServices::getInstance()->getHookContainer();
$userLang = $this->getLanguage();
$languageLinks = [];
$langNameUtils = MediaWikiServices::getInstance()->getLanguageNameUtils();
foreach ( $this->getOutput()->getLanguageLinks() as $languageLinkText ) {
$class = 'interlanguage-link interwiki-' . explode( ':', $languageLinkText, 2 )[0];
$languageLinkTitle = Title::newFromText( $languageLinkText );
if ( !$languageLinkTitle ) {
continue;
}
$ilInterwikiCode = $this->mapInterwikiToLanguage( $languageLinkTitle->getInterwiki() );
$ilLangName = $langNameUtils->getLanguageName( $ilInterwikiCode );
if ( strval( $ilLangName ) === '' ) {
$ilDisplayTextMsg = $this->msg( "interlanguage-link-$ilInterwikiCode" );
if ( !$ilDisplayTextMsg->isDisabled() ) {
// Use custom MW message for the display text
$ilLangName = $ilDisplayTextMsg->text();
} else {
// Last resort: fallback to the language link target
$ilLangName = $languageLinkText;
}
} else {
// Use the language autonym as display text
$ilLangName = $this->getLanguage()->ucfirst( $ilLangName );
}
// CLDR extension or similar is required to localize the language name;
// otherwise we'll end up with the autonym again.
$ilLangLocalName = $langNameUtils->getLanguageName(
$ilInterwikiCode,
$userLang->getCode()
);
$languageLinkTitleText = $languageLinkTitle->getText();
if ( $ilLangLocalName === '' ) {
$ilFriendlySiteName = $this->msg( "interlanguage-link-sitename-$ilInterwikiCode" );
if ( !$ilFriendlySiteName->isDisabled() ) {
if ( $languageLinkTitleText === '' ) {
$ilTitle = $this->msg(
'interlanguage-link-title-nonlangonly',
$ilFriendlySiteName->text()
)->text();
} else {
$ilTitle = $this->msg(
'interlanguage-link-title-nonlang',
$languageLinkTitleText,
$ilFriendlySiteName->text()
)->text();
}
} else {
// we have nothing friendly to put in the title, so fall back to
// displaying the interlanguage link itself in the title text
// (similar to what is done in page content)
$ilTitle = $languageLinkTitle->getInterwiki() .
":$languageLinkTitleText";
}
} elseif ( $languageLinkTitleText === '' ) {
$ilTitle = $this->msg(
'interlanguage-link-title-langonly',
$ilLangLocalName
)->text();
} else {
$ilTitle = $this->msg(
'interlanguage-link-title',
$languageLinkTitleText,
$ilLangLocalName
)->text();
}
$ilInterwikiCodeBCP47 = LanguageCode::bcp47( $ilInterwikiCode );
$languageLink = [
'href' => $languageLinkTitle->getFullURL(),
'text' => $ilLangName,
'title' => $ilTitle,
'class' => $class,
'link-class' => 'interlanguage-link-target',
'lang' => $ilInterwikiCodeBCP47,
'hreflang' => $ilInterwikiCodeBCP47,
];
$hookContainer->run(
'SkinTemplateGetLanguageLink',
[ &$languageLink, $languageLinkTitle, $this->getTitle(), $this->getOutput() ],
[]
);
$languageLinks[] = $languageLink;
}
return $languageLinks;
}
/**
* Build array of common navigation links.
* Assumes thispage property has been set before execution.
* @since 1.35
* @return array
*/
protected function buildNavUrls() {
$out = $this->getOutput();
$request = $this->getRequest();
$title = $this->getTitle();
$thispage = $title->getPrefixedDBkey();
$uploadNavigationUrl = $this->getConfig()->get( 'UploadNavigationUrl' );
$nav_urls = [];
$nav_urls['mainpage'] = [ 'href' => self::makeMainPageUrl() ];
if ( $uploadNavigationUrl ) {
$nav_urls['upload'] = [ 'href' => $uploadNavigationUrl ];
} elseif ( UploadBase::isEnabled() && UploadBase::isAllowed( $this->getUser() ) === true ) {
$nav_urls['upload'] = [ 'href' => self::makeSpecialUrl( 'Upload' ) ];
} else {
$nav_urls['upload'] = false;
}
$nav_urls['specialpages'] = [ 'href' => self::makeSpecialUrl( 'Specialpages' ) ];
$nav_urls['print'] = false;
$nav_urls['permalink'] = false;
$nav_urls['info'] = false;
$nav_urls['whatlinkshere'] = false;
$nav_urls['recentchangeslinked'] = false;
$nav_urls['contributions'] = false;
$nav_urls['log'] = false;
$nav_urls['blockip'] = false;
$nav_urls['mute'] = false;
$nav_urls['emailuser'] = false;
$nav_urls['userrights'] = false;
// A print stylesheet is attached to all pages, but nobody ever
// figures that out. :) Add a link...
if ( !$out->isPrintable() && ( $out->isArticle() || $title->isSpecialPage() ) ) {
$nav_urls['print'] = [
'text' => $this->msg( 'printableversion' )->text(),
'href' => $title->getLocalURL(
$request->appendQueryValue( 'printable', 'yes' ) )
];
}
if ( $out->isArticle() ) {
// Also add a "permalink" while we're at it
$revid = $out->getRevisionId();
if ( $revid ) {
$nav_urls['permalink'] = [
'text' => $this->msg( 'permalink' )->text(),
'href' => $title->getLocalURL( "oldid=$revid" )
];
}
}
if ( $out->isArticleRelated() ) {
$nav_urls['whatlinkshere'] = [
'href' => SpecialPage::getTitleFor( 'Whatlinkshere', $thispage )->getLocalURL()
];
$nav_urls['info'] = [
'text' => $this->msg( 'pageinfo-toolboxlink' )->text(),
'href' => $title->getLocalURL( "action=info" )
];
if ( $title->exists() || $title->inNamespace( NS_CATEGORY ) ) {
$nav_urls['recentchangeslinked'] = [
'href' => SpecialPage::getTitleFor( 'Recentchangeslinked', $thispage )->getLocalURL()
];
}
}
$user = $this->getRelevantUser();
if ( $user ) {
$rootUser = $user->getName();
$nav_urls['contributions'] = [
'text' => $this->msg( 'contributions', $rootUser )->text(),
'href' => self::makeSpecialUrlSubpage( 'Contributions', $rootUser ),
'tooltip-params' => [ $rootUser ],
];
$nav_urls['log'] = [
'href' => self::makeSpecialUrlSubpage( 'Log', $rootUser )
];
if (
MediaWikiServices::getInstance()
->getPermissionManager()
->userHasRight( $this->getUser(), 'block' )
) {
$nav_urls['blockip'] = [
'text' => $this->msg( 'blockip', $rootUser )->text(),
'href' => self::makeSpecialUrlSubpage( 'Block', $rootUser )
];
}
if ( $this->showEmailUser( $user ) ) {
$nav_urls['emailuser'] = [
'text' => $this->msg( 'tool-link-emailuser', $rootUser )->text(),
'href' => self::makeSpecialUrlSubpage( 'Emailuser', $rootUser ),
'tooltip-params' => [ $rootUser ],
];
}
if ( !$user->isAnon() ) {
if ( $this->getUser()->isRegistered() && $this->getConfig()->get( 'EnableSpecialMute' ) ) {
$nav_urls['mute'] = [
'text' => $this->msg( 'mute-preferences' )->text(),
'href' => self::makeSpecialUrlSubpage( 'Mute', $rootUser )
];
}
$sur = new UserrightsPage;
$sur->setContext( $this->getContext() );
$canChange = $sur->userCanChangeRights( $user );
$nav_urls['userrights'] = [
'text' => $this->msg(
$canChange ? 'tool-link-userrights' : 'tool-link-userrights-readonly',
$rootUser
)->text(),
'href' => self::makeSpecialUrlSubpage( 'Userrights', $rootUser )
];
}
}
return $nav_urls;
}
/**
* Build data structure representing syndication links.
* @since 1.35
* @return array
*/
final protected function buildFeedUrls() {
$feeds = [];
$out = $this->getOutput();
if ( $out->isSyndicated() ) {
foreach ( $out->getSyndicationLinks() as $format => $link ) {
$feeds[$format] = [
// Messages: feed-atom, feed-rss
'text' => $this->msg( "feed-$format" )->text(),
'href' => $link
];
}
}
return $feeds;
}
/**
* Build an array that represents the sidebar(s), the navigation bar among them.
*
* BaseTemplate::getSidebar can be used to simplify the format and id generation in new skins.
*
* The format of the returned array is [ heading => content, ... ], where:
* - heading is the heading of a navigation portlet. It is either:
* - magic string to be handled by the skins ('SEARCH' / 'LANGUAGES' / 'TOOLBOX' / ...)
* - Note that 'SEARCH' unlike others is not supported out-of-the-box by the skins.
* - For it to work, a skin must add custom support for it.
* - a message name (e.g. 'navigation'), the message should be HTML-escaped by the skin
* - plain text, which should be HTML-escaped by the skin
* - content is the contents of the portlet. It is either:
* - HTML text (<ul><li>...</li>...</ul>)
* - array of link data in a format accepted by BaseTemplate::makeListItem()
* - (for a magic string as a key, any value)
*
* Note that extensions can control the sidebar contents using the SkinBuildSidebar hook
* and can technically insert anything in here; skin creators are expected to handle
* values described above.
*
* @stable for overriding
*
* @return array
*/
public function buildSidebar() {
$services = MediaWikiServices::getInstance();
$callback = function ( $old = null, &$ttl = null ) {
$bar = [];
$this->addToSidebar( $bar, 'sidebar' );
$this->getHookRunner()->onSkinBuildSidebar( $this, $bar );
$msgCache = MediaWikiServices::getInstance()->getMessageCache();
if ( $msgCache->isDisabled() ) {
$ttl = WANObjectCache::TTL_UNCACHEABLE; // bug T133069
}
return $bar;
};
$msgCache = $services->getMessageCache();
$wanCache = $services->getMainWANObjectCache();
$config = $this->getConfig();
$languageCode = $this->getLanguage()->getCode();
$sidebar = $config->get( 'EnableSidebarCache' )
? $wanCache->getWithSetCallback(
$wanCache->makeKey( 'sidebar', $languageCode ),
$config->get( 'SidebarCacheExpiry' ),
$callback,
[
'checkKeys' => [
// Unless there is both no exact $code override nor an i18n definition
// in the software, the only MediaWiki page to check is for $code.
$msgCache->getCheckKey( $languageCode )
],
'lockTSE' => 30
]
)
: $callback();
$sidebar['TOOLBOX'] = $this->makeToolbox(
$this->buildNavUrls(),
$this->buildFeedUrls()
);
$sidebar['LANGUAGES'] = $this->getLanguages();
// Apply post-processing to the cached value
$this->getHookRunner()->onSidebarBeforeOutput( $this, $sidebar );
return $sidebar;
}
/**
* Add content from a sidebar system message
* Currently only used for MediaWiki:Sidebar (but may be used by Extensions)
*
* This is just a wrapper around addToSidebarPlain() for backwards compatibility
*
* @param array &$bar
* @param string $message
*/
public function addToSidebar( &$bar, $message ) {
$this->addToSidebarPlain( $bar, $this->msg( $message )->inContentLanguage()->plain() );
}
/**
* Add content from plain text
* @since 1.17
* @param array &$bar
* @param string $text
* @return array
*/
public function addToSidebarPlain( &$bar, $text ) {
$lines = explode( "\n", $text );
$heading = '';
$config = $this->getConfig();
$messageTitle = $config->get( 'EnableSidebarCache' )
? Title::newMainPage() : $this->getTitle();
$messageCache = MediaWikiServices::getInstance()->getMessageCache();
foreach ( $lines as $line ) {
if ( strpos( $line, '*' ) !== 0 ) {
continue;
}
$line = rtrim( $line, "\r" ); // for Windows compat
if ( strpos( $line, '**' ) !== 0 ) {
$heading = trim( $line, '* ' );
if ( !array_key_exists( $heading, $bar ) ) {
$bar[$heading] = [];
}
} else {
$line = trim( $line, '* ' );
if ( strpos( $line, '|' ) !== false ) { // sanity check
$line = $messageCache->transform( $line, false, null, $messageTitle );
$line = array_map( 'trim', explode( '|', $line, 2 ) );
if ( count( $line ) !== 2 ) {
// Second sanity check, could be hit by people doing
// funky stuff with parserfuncs... (T35321)
continue;
}
$extraAttribs = [];
$msgLink = $this->msg( $line[0] )->title( $messageTitle )->inContentLanguage();
if ( $msgLink->exists() ) {
$link = $msgLink->text();
if ( $link == '-' ) {
continue;
}
} else {
$link = $line[0];
}
$msgText = $this->msg( $line[1] )->title( $messageTitle );
if ( $msgText->exists() ) {
$text = $msgText->text();
} else {
$text = $line[1];
}
if ( preg_match( '/^(?i:' . wfUrlProtocols() . ')/', $link ) ) {
$href = $link;
// Parser::getExternalLinkAttribs won't work here because of the Namespace things
if ( $config->get( 'NoFollowLinks' ) &&
!wfMatchesDomainList( $href, $config->get( 'NoFollowDomainExceptions' ) )
) {
$extraAttribs['rel'] = 'nofollow';
}
if ( $config->get( 'ExternalLinkTarget' ) ) {
$extraAttribs['target'] = $config->get( 'ExternalLinkTarget' );
}
} else {
$title = Title::newFromText( $link );
if ( $title ) {
$title = $title->fixSpecialName();
$href = $title->getLinkURL();
} else {
$href = 'INVALID-TITLE';
}
}
$bar[$heading][] = array_merge( [
'text' => $text,
'href' => $href,
'id' => Sanitizer::escapeIdForAttribute( 'n-' . strtr( $line[1], ' ', '-' ) ),
'active' => false,
], $extraAttribs );
} else {
continue;
}
}
}
return $bar;
}
/**
* Gets new talk page messages for the current user and returns an
* appropriate alert message (or an empty string if there are no messages)
* @return string
*/
public function getNewtalks() {
$newMessagesAlert = '';
$user = $this->getUser();
$services = MediaWikiServices::getInstance();
$linkRenderer = $services->getLinkRenderer();
$userHasNewMessages = $services->getTalkPageNotificationManager()
->userHasNewMessages( $user );
$timestamp = $services->getTalkPageNotificationManager()
->getLatestSeenMessageTimestamp( $user );
$newtalks = !$userHasNewMessages ? [] : [
[
// TODO: Deprecate adding wiki and link to array and redesign GetNewMessagesAlert hook
'wiki' => WikiMap::getCurrentWikiId(),
'link' => $user->getTalkPage()->getLocalURL(),
'rev' => $timestamp ? $services->getRevisionLookup()
->getRevisionByTimestamp( $user->getTalkPage(), $timestamp ) : null
]
];
$out = $this->getOutput();
// Allow extensions to disable or modify the new messages alert
if ( !$this->getHookRunner()->onGetNewMessagesAlert(
$newMessagesAlert, $newtalks, $user, $out )
) {
return '';
}
if ( $newMessagesAlert ) {
return $newMessagesAlert;
}
if ( $newtalks !== [] ) {
$uTalkTitle = $user->getTalkPage();
$lastSeenRev = $newtalks[0]['rev'];
$numAuthors = 0;
if ( $lastSeenRev !== null ) {
$plural = true; // Default if we have a last seen revision: if unknown, use plural
$revStore = $services->getRevisionStore();
$latestRev = $revStore->getRevisionByTitle(
$uTalkTitle,
0,
RevisionLookup::READ_NORMAL
);
if ( $latestRev !== null ) {
// Singular if only 1 unseen revision, plural if several unseen revisions.
$plural = $latestRev->getParentId() !== $lastSeenRev->getId();
$numAuthors = $revStore->countAuthorsBetween(
$uTalkTitle->getArticleID(),
$lastSeenRev,
$latestRev,
null,
10,
'include_new'
);
}
} else {
// Singular if no revision -> diff link will show latest change only in any case
$plural = false;
}
$plural = $plural ? 999 : 1;
// 999 signifies "more than one revision". We don't know how many, and even if we did,
// the number of revisions or authors is not necessarily the same as the number of
// "messages".
$newMessagesLink = $linkRenderer->makeKnownLink(
$uTalkTitle,
$this->msg( 'newmessageslinkplural' )->params( $plural )->text(),
[],
$uTalkTitle->isRedirect() ? [ 'redirect' => 'no' ] : []
);
$newMessagesDiffLink = $linkRenderer->makeKnownLink(
$uTalkTitle,
$this->msg( 'newmessagesdifflinkplural' )->params( $plural )->text(),
[],
$lastSeenRev !== null
? [ 'oldid' => $lastSeenRev->getId(), 'diff' => 'cur' ]
: [ 'diff' => 'cur' ]
);
if ( $numAuthors >= 1 && $numAuthors <= 10 ) {
$newMessagesAlert = $this->msg(
'youhavenewmessagesfromusers',
$newMessagesLink,
$newMessagesDiffLink
)->numParams( $numAuthors, $plural );
} else {
// $numAuthors === 11 signifies "11 or more" ("more than 10")
$newMessagesAlert = $this->msg(
$numAuthors > 10 ? 'youhavenewmessagesmanyusers' : 'youhavenewmessages',
$newMessagesLink,
$newMessagesDiffLink
)->numParams( $plural );
}
$newMessagesAlert = $newMessagesAlert->text();
// Disable CDN cache
$out->setCdnMaxage( 0 );
}
return $newMessagesAlert;
}
/**
* Get a cached notice
*
* @param string $name Message name, or 'default' for $wgSiteNotice
* @return string|bool HTML fragment, or false to indicate that the caller
* should fall back to the next notice in its sequence
*/
private function getCachedNotice( $name ) {
$config = $this->getConfig();
if ( $name === 'default' ) {
// special case
$notice = $config->get( 'SiteNotice' );
if ( empty( $notice ) ) {
return false;
}
} else {
$msg = $this->msg( $name )->inContentLanguage();
if ( $msg->isBlank() ) {
return '';
} elseif ( $msg->isDisabled() ) {
return false;
}
$notice = $msg->plain();
}
$services = MediaWikiServices::getInstance();
$cache = $services->getMainWANObjectCache();
$parsed = $cache->getWithSetCallback(
// Use the extra hash appender to let eg SSL variants separately cache
// Key is verified with md5 hash of unparsed wikitext
$cache->makeKey( $name, $config->get( 'RenderHashAppend' ), md5( $notice ) ),
// TTL in seconds
600,
function () use ( $notice ) {
return $this->getOutput()->parseAsInterface( $notice );
}
);
$contLang = $services->getContentLanguage();
return Html::rawElement(
'div',
[
'id' => 'localNotice',
'lang' => $contLang->getHtmlCode(),
'dir' => $contLang->getDir()
],
$parsed
);
}
/**
* Get the site notice
*
* @return string HTML fragment
*/
public function getSiteNotice() {
$siteNotice = '';
if ( $this->getHookRunner()->onSiteNoticeBefore( $siteNotice, $this ) ) {
if ( $this->getUser()->isLoggedIn() ) {
$siteNotice = $this->getCachedNotice( 'sitenotice' );
} else {
$anonNotice = $this->getCachedNotice( 'anonnotice' );
if ( $anonNotice === false ) {
$siteNotice = $this->getCachedNotice( 'sitenotice' );
} else {
$siteNotice = $anonNotice;
}
}
if ( $siteNotice === false ) {
$siteNotice = $this->getCachedNotice( 'default' ) ?: '';
}
}
$this->getHookRunner()->onSiteNoticeAfter( $siteNotice, $this );
return $siteNotice;
}
/**
* Create a section edit link.
*
* @suppress SecurityCheck-XSS $links has keys of different taint types
* @param Title $nt The title being linked to (may not be the same as
* the current page, if the section is included from a template)
* @param string $section The designation of the section being pointed to,
* to be included in the link, like "§ion=$section"
* @param string|null $tooltip The tooltip to use for the link: will be escaped
* and wrapped in the 'editsectionhint' message
* @param Language $lang Language object
* @return string HTML to use for edit link
*/
public function doEditSectionLink( Title $nt, $section, $tooltip, Language $lang ) {
// HTML generated here should probably have userlangattributes
// added to it for LTR text on RTL pages
$attribs = [];
if ( $tooltip !== null ) {
$attribs['title'] = $this->msg( 'editsectionhint' )->rawParams( $tooltip )
->inLanguage( $lang )->text();
}
$links = [
'editsection' => [
'text' => $this->msg( 'editsection' )->inLanguage( $lang )->text(),
'targetTitle' => $nt,
'attribs' => $attribs,
'query' => [ 'action' => 'edit', 'section' => $section ]
]
];
$this->getHookRunner()->onSkinEditSectionLinks( $this, $nt, $section, $tooltip, $links, $lang );
$result = '<span class="mw-editsection"><span class="mw-editsection-bracket">[</span>';
$linkRenderer = MediaWikiServices::getInstance()->getLinkRenderer();
$linksHtml = [];
foreach ( $links as $k => $linkDetails ) {
$linksHtml[] = $linkRenderer->makeKnownLink(
$linkDetails['targetTitle'],
$linkDetails['text'],
$linkDetails['attribs'],
$linkDetails['query']
);
}
$result .= implode(
'<span class="mw-editsection-divider">'
. $this->msg( 'pipe-separator' )->inLanguage( $lang )->escaped()
. '</span>',
$linksHtml
);
$result .= '<span class="mw-editsection-bracket">]</span></span>';
return $result;
}
/**
* Create an array of common toolbox items from the data in the quicktemplate
* stored by SkinTemplate.
* The resulting array is built according to a format intended to be passed
* through makeListItem to generate the html.
* @param array $navUrls
* @param array $feedUrls
* @return array
*/
public function makeToolbox( $navUrls, $feedUrls ) {
$toolbox = [];
if ( $navUrls['whatlinkshere'] ?? null ) {
$toolbox['whatlinkshere'] = $navUrls['whatlinkshere'];
$toolbox['whatlinkshere']['id'] = 't-whatlinkshere';
}
if ( $navUrls['recentchangeslinked'] ?? null ) {
$toolbox['recentchangeslinked'] = $navUrls['recentchangeslinked'];
$toolbox['recentchangeslinked']['msg'] = 'recentchangeslinked-toolbox';
$toolbox['recentchangeslinked']['id'] = 't-recentchangeslinked';
$toolbox['recentchangeslinked']['rel'] = 'nofollow';
}
if ( $feedUrls ?? null ) {
$toolbox['feeds']['id'] = 'feedlinks';
$toolbox['feeds']['links'] = [];
foreach ( $feedUrls as $key => $feed ) {
$toolbox['feeds']['links'][$key] = $feed;
$toolbox['feeds']['links'][$key]['id'] = "feed-$key";
$toolbox['feeds']['links'][$key]['rel'] = 'alternate';
$toolbox['feeds']['links'][$key]['type'] = "application/{$key}+xml";
$toolbox['feeds']['links'][$key]['class'] = 'feedlink';
}
}
foreach ( [ 'contributions', 'log', 'blockip', 'emailuser', 'mute',
'userrights', 'upload', 'specialpages' ] as $special
) {
if ( $navUrls[$special] ?? null ) {
$toolbox[$special] = $navUrls[$special];
$toolbox[$special]['id'] = "t-$special";
}
}
if ( $navUrls['print'] ?? null ) {
$toolbox['print'] = $navUrls['print'];
$toolbox['print']['id'] = 't-print';
$toolbox['print']['rel'] = 'alternate';
$toolbox['print']['msg'] = 'printableversion';
}
if ( $navUrls['permalink'] ?? null ) {
$toolbox['permalink'] = $navUrls['permalink'];
$toolbox['permalink']['id'] = 't-permalink';
}
if ( $navUrls['info'] ?? null ) {
$toolbox['info'] = $navUrls['info'];
$toolbox['info']['id'] = 't-info';
}
return $toolbox;
}
/**
* Get the suggested HTML for page status indicators: icons (or short text snippets) usually
* displayed in the top-right corner of the page, outside of the main content.
*
* Your skin may implement this differently, for example by handling some indicator names
* specially with a different UI. However, it is recommended to use a `<div class="mw-indicator"
* id="mw-indicator-<id>" />` as a wrapper element for each indicator, for better compatibility
* with extensions and user scripts.
*
* The raw data is available in `$this->data['indicators']` as an associative array (keys:
* identifiers, values: contents) internally ordered by keys.
*
* @since 1.35
* @param array $indicators
* @return string HTML
*/
final public function getIndicatorsHTML( $indicators ) {
$out = "<div class=\"mw-indicators mw-body-content\">\n";
foreach ( $this->getIndicatorsData( $indicators ) as $indicatorData ) {
$out .= Html::rawElement(
'div',
[
'id' => $indicatorData['id'],
'class' => $indicatorData['class']
],
$indicatorData['html']
) . "\n";
}
$out .= "</div>\n";
return $out;
}
/**
* Return an array of indicator data.
* Can be used by subclasses but should not be extended.
* @param array $indicators return value of OutputPage::getIndicators
* @return array
*/
protected function getIndicatorsData( $indicators ) {
$indicatorData = [];
foreach ( $indicators as $id => $content ) {
$indicatorData[] = [
'id' => Sanitizer::escapeIdForAttribute( "mw-indicator-$id" ),
'class' => 'mw-indicator',
'html' => $content,
];
}
return $indicatorData;
}
/**
* Create an array of personal tools items from the data in the quicktemplate
* stored by SkinTemplate.
* The resulting array is built according to a format intended to be passed
* through makeListItem to generate the html.
* This is in reality the same list as already stored in personal_urls
* however it is reformatted so that you can just pass the individual items
* to makeListItem instead of hardcoding the element creation boilerplate.
* @since 1.35
* @param array $urls
* @return array
*/
final public function getPersonalToolsForMakeListItem( $urls ) {
$personal_tools = [];
foreach ( $urls as $key => $plink ) {
# The class on a personal_urls item is meant to go on the <a> instead
# of the <li> so we have to use a single item "links" array instead
# of using most of the personal_url's keys directly.
$ptool = [
'links' => [
[ 'single-id' => "pt-$key" ],
],
'id' => "pt-$key",
];
if ( isset( $plink['active'] ) ) {
$ptool['active'] = $plink['active'];
}
foreach ( [
'href',
'class',
'text',
'dir',
'data',
'exists',
'data-mw'
] as $k ) {
if ( isset( $plink[$k] ) ) {
$ptool['links'][0][$k] = $plink[$k];
}
}
$personal_tools[$key] = $ptool;
}
return $personal_tools;
}
/**
* Makes a link, usually used by makeListItem to generate a link for an item
* in a list used in navigation lists, portlets, portals, sidebars, etc...
*
* @since 1.35
* @param string $key Usually a key from the list you are generating this
* link from.
* @param array $item Contains some of a specific set of keys.
*
* The text of the link will be generated either from the contents of the
* "text" key in the $item array, if a "msg" key is present a message by
* that name will be used, and if neither of those are set the $key will be
* used as a message name.
*
* If a "href" key is not present makeLink will just output htmlescaped text.
* The "href", "id", "class", "rel", and "type" keys are used as attributes
* for the link if present.
*
* If an "id" or "single-id" (if you don't want the actual id to be output
* on the link) is present it will be used to generate a tooltip and
* accesskey for the link.
*
* The keys "context" and "primary" are ignored; these keys are used
* internally by skins and are not supposed to be included in the HTML
* output.
*
* If you don't want an accesskey, set $item['tooltiponly'] = true;
*
* If a "data" key is present, it must be an array, where the keys represent
* the data-xxx properties with their provided values. For example,
* $item['data'] = [
* 'foo' => 1,
* 'bar' => 'baz',
* ];
* will render as element properties:
* data-foo='1' data-bar='baz'
*
* @param array $options Can be used to affect the output of a link.
* Possible options are:
* - 'text-wrapper' key to specify a list of elements to wrap the text of
* a link in. This should be an array of arrays containing a 'tag' and
* optionally an 'attributes' key. If you only have one element you don't
* need to wrap it in another array. eg: To use <a><span>...</span></a>
* in all links use [ 'text-wrapper' => [ 'tag' => 'span' ] ]
* for your options.
* - 'link-class' key can be used to specify additional classes to apply
* to all links.
* - 'link-fallback' can be used to specify a tag to use instead of "<a>"
* if there is no link. eg: If you specify 'link-fallback' => 'span' than
* any non-link will output a "<span>" instead of just text.
*
* @return string
*/
final public function makeLink( $key, $item, $options = [] ) {
$text = $item['text'] ?? $this->msg( $item['msg'] ?? $key )->text();
$html = htmlspecialchars( $text );
if ( isset( $options['text-wrapper'] ) ) {
$wrapper = $options['text-wrapper'];
if ( isset( $wrapper['tag'] ) ) {
$wrapper = [ $wrapper ];
}
while ( count( $wrapper ) > 0 ) {
$element = array_pop( $wrapper );
$html = Html::rawElement( $element['tag'], $element['attributes'] ?? null, $html );
}
}
if ( isset( $item['href'] ) || isset( $options['link-fallback'] ) ) {
$attrs = $item;
foreach ( [ 'single-id', 'text', 'msg', 'tooltiponly', 'context', 'primary',
'tooltip-params', 'exists' ] as $k ) {
unset( $attrs[$k] );
}
if ( isset( $attrs['data'] ) ) {
foreach ( $attrs['data'] as $key => $value ) {
$attrs[ 'data-' . $key ] = $value;
}
unset( $attrs[ 'data' ] );
}
if ( isset( $item['id'] ) && !isset( $item['single-id'] ) ) {
$item['single-id'] = $item['id'];
}
$tooltipParams = [];
if ( isset( $item['tooltip-params'] ) ) {
$tooltipParams = $item['tooltip-params'];
}
if ( isset( $item['single-id'] ) ) {
$tooltipOption = isset( $item['exists'] ) && $item['exists'] === false ? 'nonexisting' : null;
if ( isset( $item['tooltiponly'] ) && $item['tooltiponly'] ) {
$title = Linker::titleAttrib( $item['single-id'], $tooltipOption, $tooltipParams );
if ( $title !== false ) {
$attrs['title'] = $title;
}
} else {
$tip = Linker::tooltipAndAccesskeyAttribs(
$item['single-id'],
$tooltipParams,
$tooltipOption
);
if ( isset( $tip['title'] ) && $tip['title'] !== false ) {
$attrs['title'] = $tip['title'];
}
if ( isset( $tip['accesskey'] ) && $tip['accesskey'] !== false ) {
$attrs['accesskey'] = $tip['accesskey'];
}
}
}
if ( isset( $options['link-class'] ) ) {
if ( isset( $attrs['class'] ) ) {
$attrs['class'] .= " {$options['link-class']}";
} else {
$attrs['class'] = $options['link-class'];
}
}
$html = Html::rawElement( isset( $attrs['href'] )
? 'a'
: $options['link-fallback'], $attrs, $html );
}
return $html;
}
/**
* Generates a list item for a navigation, portlet, portal, sidebar... list
*
* @since 1.35
* @param string $key Usually a key from the list you are generating this link from.
* @param array $item Array of list item data containing some of a specific set of keys.
* The "id", "class" and "itemtitle" keys will be used as attributes for the list item,
* if "active" contains a value of true a "active" class will also be appended to class.
* @phan-param array{id?:string,class?:string,itemtitle?:string,active?:bool} $item
*
* @param array $options
* @phan-param array{tag?:string} $options
*
* If you want something other than a "<li>" you can pass a tag name such as
* "tag" => "span" in the $options array to change the tag used.
* link/content data for the list item may come in one of two forms
* A "links" key may be used, in which case it should contain an array with
* a list of links to include inside the list item, see makeLink for the
* format of individual links array items.
*
* Otherwise the relevant keys from the list item $item array will be passed
* to makeLink instead. Note however that "id" and "class" are used by the
* list item directly so they will not be passed to makeLink
* (however the link will still support a tooltip and accesskey from it)
* If you need an id or class on a single link you should include a "links"
* array with just one link item inside of it. You can also set "link-class" in
* $item to set a class on the link itself. If you want to add a title
* to the list item itself, you can set "itemtitle" to the value.
* $options is also passed on to makeLink calls
*
* @return string
*/
final public function makeListItem( $key, $item, $options = [] ) {
// In case this is still set from SkinTemplate, we don't want it to appear in
// the HTML output (normally removed in SkinTemplate::buildContentActionUrls())
unset( $item['redundant'] );
if ( isset( $item['links'] ) ) {
$links = [];
foreach ( $item['links'] as $linkKey => $link ) {
$links[] = $this->makeLink( $linkKey, $link, $options );
}
$html = implode( ' ', $links );
} else {
$link = $item;
// These keys are used by makeListItem and shouldn't be passed on to the link
foreach ( [ 'id', 'class', 'active', 'tag', 'itemtitle' ] as $k ) {
unset( $link[$k] );
}
if ( isset( $item['id'] ) && !isset( $item['single-id'] ) ) {
// The id goes on the <li> not on the <a> for single links
// but makeSidebarLink still needs to know what id to use when
// generating tooltips and accesskeys.
$link['single-id'] = $item['id'];
}
if ( isset( $link['link-class'] ) ) {
// link-class should be set on the <a> itself,
// so pass it in as 'class'
$link['class'] = $link['link-class'];
unset( $link['link-class'] );
}
$html = $this->makeLink( $key, $link, $options );
}
$attrs = [];
foreach ( [ 'id', 'class' ] as $attr ) {
if ( isset( $item[$attr] ) ) {
$attrs[$attr] = $item[$attr];
}
}
if ( isset( $item['active'] ) && $item['active'] ) {
if ( !isset( $attrs['class'] ) ) {
$attrs['class'] = '';
}
$attrs['class'] .= ' active';
$attrs['class'] = trim( $attrs['class'] );
}
if ( isset( $item['itemtitle'] ) ) {
$attrs['title'] = $item['itemtitle'];
}
return Html::rawElement( $options['tag'] ?? 'li', $attrs, $html );
}
/**
* @since 1.35
* @param array $attrs (optional) will be passed to tooltipAndAccesskeyAttribs
* and decorate the resulting input
* @return string of HTML input
*/
final public function makeSearchInput( $attrs = [] ) {
$realAttrs = [
'type' => 'search',
'name' => 'search',
'placeholder' => $this->msg( 'searchsuggest-search' )->text(),
];
$realAttrs = array_merge( $realAttrs, Linker::tooltipAndAccesskeyAttribs( 'search' ), $attrs );
return Html::element( 'input', $realAttrs );
}
/**
* @param string $mode representing the type of button wanted
* either `go`, `fulltext` or `image`
* @param array $attrs (optional)
* @throws MWException if bad value of $mode passed in
* @return string of HTML button
*/
final public function makeSearchButton( $mode, $attrs = [] ) {
switch ( $mode ) {
case 'go':
case 'fulltext':
$realAttrs = [
'type' => 'submit',
'name' => $mode,
'value' => $this->msg( $mode == 'go' ? 'searcharticle' : 'searchbutton' )->text(),
];
$realAttrs = array_merge(
$realAttrs,
Linker::tooltipAndAccesskeyAttribs( "search-$mode" ),
$attrs
);
return Html::element( 'input', $realAttrs );
case 'image':
$buttonAttrs = [
'type' => 'submit',
'name' => 'button',
];
$buttonAttrs = array_merge(
$buttonAttrs,
Linker::tooltipAndAccesskeyAttribs( 'search-fulltext' ),
$attrs
);
unset( $buttonAttrs['src'] );
unset( $buttonAttrs['alt'] );
unset( $buttonAttrs['width'] );
unset( $buttonAttrs['height'] );
$imgAttrs = [
'src' => $attrs['src'],
'alt' => $attrs['alt'] ?? $this->msg( 'searchbutton' )->text(),
'width' => $attrs['width'] ?? null,
'height' => $attrs['height'] ?? null,
];
return Html::rawElement( 'button', $buttonAttrs, Html::element( 'img', $imgAttrs ) );
default:
throw new MWException( 'Unknown mode passed to BaseTemplate::makeSearchButton' );
}
}
/**
* Allows extensions to hook into known portlets and add stuff to them.
* Unlike its BaseTemplate counterpart, this method does not wrap the html
* provided by the hook in a div.
*
* @param string $name
*
* @return string html
* @since 1.35
*/
public function getAfterPortlet( string $name ) : string {
$html = '';
$this->getHookRunner()->onSkinAfterPortlet( $this, $name, $html );
return $html;
}
}
|