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
|
/**
* Base library for MediaWiki.
*
* Exposed as globally as `mediaWiki` with `mw` as shortcut.
*
* @class mw
* @alternateClassName mediaWiki
* @singleton
*/
( function ( $ ) {
'use strict';
/* Private Members */
var mw,
hasOwn = Object.prototype.hasOwnProperty,
slice = Array.prototype.slice,
trackCallbacks = $.Callbacks( 'memory' ),
trackQueue = [];
/**
* Log a message to window.console, if possible. Useful to force logging of some
* errors that are otherwise hard to detect (I.e., this logs also in production mode).
* Gets console references in each invocation, so that delayed debugging tools work
* fine. No need for optimization here, which would only result in losing logs.
*
* @private
* @method log_
* @param {string} msg text for the log entry.
* @param {Error} [e]
*/
function log( msg, e ) {
var console = window.console;
if ( console && console.log ) {
console.log( msg );
// If we have an exception object, log it through .error() to trigger
// proper stacktraces in browsers that support it. There are no (known)
// browsers that don't support .error(), that do support .log() and
// have useful exception handling through .log().
if ( e && console.error ) {
console.error( String( e ), e );
}
}
}
/* Object constructors */
/**
* Creates an object that can be read from or written to from prototype functions
* that allow both single and multiple variables at once.
*
* @example
*
* var addies, wanted, results;
*
* // Create your address book
* addies = new mw.Map();
*
* // This data could be coming from an external source (eg. API/AJAX)
* addies.set( {
* 'John Doe' : '10 Wall Street, New York, USA',
* 'Jane Jackson' : '21 Oxford St, London, UK',
* 'Dominique van Halen' : 'Kalverstraat 7, Amsterdam, NL'
* } );
*
* wanted = ['Dominique van Halen', 'George Johnson', 'Jane Jackson'];
*
* // You can detect missing keys first
* if ( !addies.exists( wanted ) ) {
* // One or more are missing (in this case: "George Johnson")
* mw.log( 'One or more names were not found in your address book' );
* }
*
* // Or just let it give you what it can
* results = addies.get( wanted, 'Middle of Nowhere, Alaska, US' );
* mw.log( results['Jane Jackson'] ); // "21 Oxford St, London, UK"
* mw.log( results['George Johnson'] ); // "Middle of Nowhere, Alaska, US"
*
* @class mw.Map
*
* @constructor
* @param {Object|boolean} [values] Value-bearing object to map, or boolean
* true to map over the global object. Defaults to an empty object.
*/
function Map( values ) {
this.values = values === true ? window : ( values || {} );
return this;
}
Map.prototype = {
/**
* Get the value of one or multiple a keys.
*
* If called with no arguments, all values will be returned.
*
* @param {string|Array} selection String key or array of keys to get values for.
* @param {Mixed} [fallback] Value to use in case key(s) do not exist.
* @return mixed If selection was a string returns the value or null,
* If selection was an array, returns an object of key/values (value is null if not found),
* If selection was not passed or invalid, will return the 'values' object member (be careful as
* objects are always passed by reference in JavaScript!).
* @return {string|Object|null} Values as a string or object, null if invalid/inexistant.
*/
get: function ( selection, fallback ) {
var results, i;
// If we only do this in the `return` block, it'll fail for the
// call to get() from the mutli-selection block.
fallback = arguments.length > 1 ? fallback : null;
if ( $.isArray( selection ) ) {
selection = slice.call( selection );
results = {};
for ( i = 0; i < selection.length; i++ ) {
results[selection[i]] = this.get( selection[i], fallback );
}
return results;
}
if ( typeof selection === 'string' ) {
if ( !hasOwn.call( this.values, selection ) ) {
return fallback;
}
return this.values[selection];
}
if ( selection === undefined ) {
return this.values;
}
// invalid selection key
return null;
},
/**
* Sets one or multiple key/value pairs.
*
* @param {string|Object} selection String key to set value for, or object mapping keys to values.
* @param {Mixed} [value] Value to set (optional, only in use when key is a string)
* @return {Boolean} This returns true on success, false on failure.
*/
set: function ( selection, value ) {
var s;
if ( $.isPlainObject( selection ) ) {
for ( s in selection ) {
this.values[s] = selection[s];
}
return true;
}
if ( typeof selection === 'string' && arguments.length > 1 ) {
this.values[selection] = value;
return true;
}
return false;
},
/**
* Checks if one or multiple keys exist.
*
* @param {Mixed} selection String key or array of keys to check
* @return {boolean} Existence of key(s)
*/
exists: function ( selection ) {
var s;
if ( $.isArray( selection ) ) {
for ( s = 0; s < selection.length; s++ ) {
if ( typeof selection[s] !== 'string' || !hasOwn.call( this.values, selection[s] ) ) {
return false;
}
}
return true;
}
return typeof selection === 'string' && hasOwn.call( this.values, selection );
}
};
/**
* Object constructor for messages.
*
* Similar to the Message class in MediaWiki PHP.
*
* Format defaults to 'text'.
*
* @example
*
* var obj, str;
* mw.messages.set( {
* 'hello': 'Hello world',
* 'hello-user': 'Hello, $1!',
* 'welcome-user': 'Welcome back to $2, $1! Last visit by $1: $3'
* } );
*
* obj = new mw.Message( mw.messages, 'hello' );
* mw.log( obj.text() );
* // Hello world
*
* obj = new mw.Message( mw.messages, 'hello-user', [ 'John Doe' ] );
* mw.log( obj.text() );
* // Hello, John Doe!
*
* obj = new mw.Message( mw.messages, 'welcome-user', [ 'John Doe', 'Wikipedia', '2 hours ago' ] );
* mw.log( obj.text() );
* // Welcome back to Wikipedia, John Doe! Last visit by John Doe: 2 hours ago
*
* // Using mw.message shortcut
* obj = mw.message( 'hello-user', 'John Doe' );
* mw.log( obj.text() );
* // Hello, John Doe!
*
* // Using mw.msg shortcut
* str = mw.msg( 'hello-user', 'John Doe' );
* mw.log( str );
* // Hello, John Doe!
*
* // Different formats
* obj = new mw.Message( mw.messages, 'hello-user', [ 'John "Wiki" <3 Doe' ] );
*
* obj.format = 'text';
* str = obj.toString();
* // Same as:
* str = obj.text();
*
* mw.log( str );
* // Hello, John "Wiki" <3 Doe!
*
* mw.log( obj.escaped() );
* // Hello, John "Wiki" <3 Doe!
*
* @class mw.Message
*
* @constructor
* @param {mw.Map} map Message storage
* @param {string} key
* @param {Array} [parameters]
*/
function Message( map, key, parameters ) {
this.format = 'text';
this.map = map;
this.key = key;
this.parameters = parameters === undefined ? [] : slice.call( parameters );
return this;
}
Message.prototype = {
/**
* Simple message parser, does $N replacement and nothing else.
*
* This may be overridden to provide a more complex message parser.
*
* The primary override is in mediawiki.jqueryMsg.
*
* This function will not be called for nonexistent messages.
*/
parser: function () {
var parameters = this.parameters;
return this.map.get( this.key ).replace( /\$(\d+)/g, function ( str, match ) {
var index = parseInt( match, 10 ) - 1;
return parameters[index] !== undefined ? parameters[index] : '$' + match;
} );
},
/**
* Appends (does not replace) parameters for replacement to the .parameters property.
*
* @param {Array} parameters
* @chainable
*/
params: function ( parameters ) {
var i;
for ( i = 0; i < parameters.length; i += 1 ) {
this.parameters.push( parameters[i] );
}
return this;
},
/**
* Converts message object to its string form based on the state of format.
*
* @return {string} Message as a string in the current form or `<key>` if key does not exist.
*/
toString: function () {
var text;
if ( !this.exists() ) {
// Use <key> as text if key does not exist
if ( this.format === 'escaped' || this.format === 'parse' ) {
// format 'escaped' and 'parse' need to have the brackets and key html escaped
return mw.html.escape( '<' + this.key + '>' );
}
return '<' + this.key + '>';
}
if ( this.format === 'plain' || this.format === 'text' || this.format === 'parse' ) {
text = this.parser();
}
if ( this.format === 'escaped' ) {
text = this.parser();
text = mw.html.escape( text );
}
return text;
},
/**
* Changes format to 'parse' and converts message to string
*
* If jqueryMsg is loaded, this parses the message text from wikitext
* (where supported) to HTML
*
* Otherwise, it is equivalent to plain.
*
* @return {string} String form of parsed message
*/
parse: function () {
this.format = 'parse';
return this.toString();
},
/**
* Changes format to 'plain' and converts message to string
*
* This substitutes parameters, but otherwise does not change the
* message text.
*
* @return {string} String form of plain message
*/
plain: function () {
this.format = 'plain';
return this.toString();
},
/**
* Changes format to 'text' and converts message to string
*
* If jqueryMsg is loaded, {{-transformation is done where supported
* (such as {{plural:}}, {{gender:}}, {{int:}}).
*
* Otherwise, it is equivalent to plain.
*/
text: function () {
this.format = 'text';
return this.toString();
},
/**
* Changes the format to 'escaped' and converts message to string
*
* This is equivalent to using the 'text' format (see text method), then
* HTML-escaping the output.
*
* @return {string} String form of html escaped message
*/
escaped: function () {
this.format = 'escaped';
return this.toString();
},
/**
* Checks if message exists
*
* @see mw.Map#exists
* @return {boolean}
*/
exists: function () {
return this.map.exists( this.key );
}
};
/**
* @class mw
*/
mw = {
/* Public Members */
/**
* Get the current time, measured in milliseconds since January 1, 1970 (UTC).
*
* On browsers that implement the Navigation Timing API, this function will produce floating-point
* values with microsecond precision that are guaranteed to be monotonic. On all other browsers,
* it will fall back to using `Date`.
*
* @return {number} Current time
*/
now: ( function () {
var perf = window.performance,
navStart = perf && perf.timing && perf.timing.navigationStart;
return navStart && typeof perf.now === 'function' ?
function () { return navStart + perf.now(); } :
function () { return +new Date(); };
}() ),
/**
* Track an analytic event.
*
* This method provides a generic means for MediaWiki JavaScript code to capture state
* information for analysis. Each logged event specifies a string topic name that describes
* the kind of event that it is. Topic names consist of dot-separated path components,
* arranged from most general to most specific. Each path component should have a clear and
* well-defined purpose.
*
* Data handlers are registered via `mw.trackSubscribe`, and receive the full set of
* events that match their subcription, including those that fired before the handler was
* bound.
*
* @param {string} topic Topic name
* @param {Object} [data] Data describing the event, encoded as an object
*/
track: function ( topic, data ) {
trackQueue.push( { topic: topic, timeStamp: mw.now(), data: data } );
trackCallbacks.fire( trackQueue );
},
/**
* Register a handler for subset of analytic events, specified by topic
*
* Handlers will be called once for each tracked event, including any events that fired before the
* handler was registered; 'this' is set to a plain object with a 'timeStamp' property indicating
* the exact time at which the event fired, a string 'topic' property naming the event, and a
* 'data' property which is an object of event-specific data. The event topic and event data are
* also passed to the callback as the first and second arguments, respectively.
*
* @param {string} topic Handle events whose name starts with this string prefix
* @param {Function} callback Handler to call for each matching tracked event
*/
trackSubscribe: function ( topic, callback ) {
var seen = 0;
trackCallbacks.add( function ( trackQueue ) {
var event;
for ( ; seen < trackQueue.length; seen++ ) {
event = trackQueue[ seen ];
if ( event.topic.indexOf( topic ) === 0 ) {
callback.call( event, event.topic, event.data );
}
}
} );
},
// Make the Map constructor publicly available.
Map: Map,
// Make the Message constructor publicly available.
Message: Message,
/**
* Map of configuration values
*
* Check out [the complete list of configuration values](https://www.mediawiki.org/wiki/Manual:Interface/JavaScript#mw.config)
* on mediawiki.org.
*
* If `$wgLegacyJavaScriptGlobals` is true, this Map will add its values to the
* global `window` object.
*
* @property {mw.Map} config
*/
// Dummy placeholder. Re-assigned in ResourceLoaderStartupModule to an instance of `mw.Map`.
config: null,
/**
* Empty object that plugins can be installed in.
* @property
*/
libs: {},
/**
* Access container for deprecated functionality that can be moved from
* from their legacy location and attached to this object (e.g. a global
* function that is deprecated and as stop-gap can be exposed through here).
*
* This was reserved for future use but never ended up being used.
*
* @deprecated since 1.22 Let deprecated identifiers keep their original name
* and use mw.log#deprecate to create an access container for tracking.
* @property
*/
legacy: {},
/**
* Localization system
* @property {mw.Map}
*/
messages: new Map(),
/* Public Methods */
/**
* Get a message object.
*
* Shorcut for `new mw.Message( mw.messages, key, parameters )`.
*
* @see mw.Message
* @param {string} key Key of message to get
* @param {Mixed...} parameters Parameters for the $N replacements in messages.
* @return {mw.Message}
*/
message: function ( key ) {
// Variadic arguments
var parameters = slice.call( arguments, 1 );
return new Message( mw.messages, key, parameters );
},
/**
* Get a message string using the (default) 'text' format.
*
* Shortcut for `mw.message( key, parameters... ).text()`.
*
* @see mw.Message
* @param {string} key Key of message to get
* @param {Mixed...} parameters Parameters for the $N replacements in messages.
* @return {string}
*/
msg: function () {
return mw.message.apply( mw.message, arguments ).toString();
},
/**
* Dummy placeholder for {@link mw.log}
* @method
*/
log: ( function () {
// Also update the restoration of methods in mediawiki.log.js
// when adding or removing methods here.
var log = function () {};
/**
* @class mw.log
* @singleton
*/
/**
* Write a message the console's warning channel.
* Also logs a stacktrace for easier debugging.
* Each action is silently ignored if the browser doesn't support it.
*
* @param {string...} msg Messages to output to console
*/
log.warn = function () {
var console = window.console;
if ( console && console.warn && console.warn.apply ) {
console.warn.apply( console, arguments );
if ( console.trace ) {
console.trace();
}
}
};
/**
* Create a property in a host object that, when accessed, will produce
* a deprecation warning in the console with backtrace.
*
* @param {Object} obj Host object of deprecated property
* @param {string} key Name of property to create in `obj`
* @param {Mixed} val The value this property should return when accessed
* @param {string} [msg] Optional text to include in the deprecation message.
*/
log.deprecate = !Object.defineProperty ? function ( obj, key, val ) {
obj[key] = val;
} : function ( obj, key, val, msg ) {
msg = 'Use of "' + key + '" is deprecated.' + ( msg ? ( ' ' + msg ) : '' );
try {
Object.defineProperty( obj, key, {
configurable: true,
enumerable: true,
get: function () {
mw.track( 'mw.deprecate', key );
mw.log.warn( msg );
return val;
},
set: function ( newVal ) {
mw.track( 'mw.deprecate', key );
mw.log.warn( msg );
val = newVal;
}
} );
} catch ( err ) {
// IE8 can throw on Object.defineProperty
obj[key] = val;
}
};
return log;
}() ),
/**
* Client-side module loader which integrates with the MediaWiki ResourceLoader
* @class mw.loader
* @singleton
*/
loader: ( function () {
/* Private Members */
/**
* Mapping of registered modules
*
* The jquery module is pre-registered, because it must have already
* been provided for this object to have been built, and in debug mode
* jquery would have been provided through a unique loader request,
* making it impossible to hold back registration of jquery until after
* mediawiki.
*
* For exact details on support for script, style and messages, look at
* mw.loader.implement.
*
* Format:
* {
* 'moduleName': {
* // At registry
* 'version': ############## (unix timestamp),
* 'dependencies': ['required.foo', 'bar.also', ...], (or) function () {}
* 'group': 'somegroup', (or) null,
* 'source': 'local', 'someforeignwiki', (or) null
* 'state': 'registered', 'loaded', 'loading', 'ready', 'error' or 'missing'
* 'skip': 'return !!window.Example', (or) null
*
* // Added during implementation
* 'skipped': true,
* 'script': ...,
* 'style': ...,
* 'messages': { 'key': 'value' },
* }
* }
*
* @property
* @private
*/
var registry = {},
//
// Mapping of sources, keyed by source-id, values are strings.
// Format:
// {
// 'sourceId': 'http://foo.bar/w/load.php'
// }
//
sources = {},
// List of modules which will be loaded as when ready
batch = [],
// List of modules to be loaded
queue = [],
// List of callback functions waiting for modules to be ready to be called
jobs = [],
// Selector cache for the marker element. Use getMarker() to get/use the marker!
$marker = null,
// Buffer for addEmbeddedCSS.
cssBuffer = '',
// Callbacks for addEmbeddedCSS.
cssCallbacks = $.Callbacks();
/* Private methods */
function getMarker() {
// Cached
if ( !$marker ) {
$marker = $( 'meta[name="ResourceLoaderDynamicStyles"]' );
if ( !$marker.length ) {
mw.log( 'No <meta name="ResourceLoaderDynamicStyles"> found, inserting dynamically' );
$marker = $( '<meta>' ).attr( 'name', 'ResourceLoaderDynamicStyles' ).appendTo( 'head' );
}
}
return $marker;
}
/**
* Create a new style tag and add it to the DOM.
*
* @private
* @param {string} text CSS text
* @param {HTMLElement|jQuery} [nextnode=document.head] The element where the style tag should be
* inserted before. Otherwise it will be appended to `<head>`.
* @return {HTMLElement} Reference to the created `<style>` element.
*/
function newStyleTag( text, nextnode ) {
var s = document.createElement( 'style' );
// Insert into document before setting cssText (bug 33305)
if ( nextnode ) {
// Must be inserted with native insertBefore, not $.fn.before.
// When using jQuery to insert it, like $nextnode.before( s ),
// then IE6 will throw "Access is denied" when trying to append
// to .cssText later. Some kind of weird security measure.
// http://stackoverflow.com/q/12586482/319266
// Works: jsfiddle.net/zJzMy/1
// Fails: jsfiddle.net/uJTQz
// Works again: http://jsfiddle.net/Azr4w/ (diff: the next 3 lines)
if ( nextnode.jquery ) {
nextnode = nextnode.get( 0 );
}
nextnode.parentNode.insertBefore( s, nextnode );
} else {
document.getElementsByTagName( 'head' )[0].appendChild( s );
}
if ( s.styleSheet ) {
// IE
s.styleSheet.cssText = text;
} else {
// Other browsers.
// (Safari sometimes borks on non-string values,
// play safe by casting to a string, just in case.)
s.appendChild( document.createTextNode( String( text ) ) );
}
return s;
}
/**
* Checks whether it is safe to add this css to a stylesheet.
*
* @private
* @param {string} cssText
* @return {boolean} False if a new one must be created.
*/
function canExpandStylesheetWith( cssText ) {
// Makes sure that cssText containing `@import`
// rules will end up in a new stylesheet (as those only work when
// placed at the start of a stylesheet; bug 35562).
return cssText.indexOf( '@import' ) === -1;
}
/**
* Add a bit of CSS text to the current browser page.
*
* The CSS will be appended to an existing ResourceLoader-created `<style>` tag
* or create a new one based on whether the given `cssText` is safe for extension.
*
* @param {string} [cssText=cssBuffer] If called without cssText,
* the internal buffer will be inserted instead.
* @param {Function} [callback]
*/
function addEmbeddedCSS( cssText, callback ) {
var $style, styleEl;
if ( callback ) {
cssCallbacks.add( callback );
}
// Yield once before inserting the <style> tag. There are likely
// more calls coming up which we can combine this way.
// Appending a stylesheet and waiting for the browser to repaint
// is fairly expensive, this reduces it (bug 45810)
if ( cssText ) {
// Be careful not to extend the buffer with css that needs a new stylesheet
if ( !cssBuffer || canExpandStylesheetWith( cssText ) ) {
// Linebreak for somewhat distinguishable sections
// (the rl-cachekey comment separating each)
cssBuffer += '\n' + cssText;
// TODO: Use requestAnimationFrame in the future which will
// perform even better by not injecting styles while the browser
// is paiting.
setTimeout( function () {
// Can't pass addEmbeddedCSS to setTimeout directly because Firefox
// (below version 13) has the non-standard behaviour of passing a
// numerical "lateness" value as first argument to this callback
// http://benalman.com/news/2009/07/the-mysterious-firefox-settime/
addEmbeddedCSS();
} );
return;
}
// This is a delayed call and we got a buffer still
} else if ( cssBuffer ) {
cssText = cssBuffer;
cssBuffer = '';
} else {
// This is a delayed call, but buffer is already cleared by
// another delayed call.
return;
}
// By default, always create a new <style>. Appending text to a <style>
// tag is bad as it means the contents have to be re-parsed (bug 45810).
//
// Except, of course, in IE 9 and below. In there we default to re-using and
// appending to a <style> tag due to the IE stylesheet limit (bug 31676).
if ( 'documentMode' in document && document.documentMode <= 9 ) {
$style = getMarker().prev();
// Verify that the the element before Marker actually is a
// <style> tag and one that came from ResourceLoader
// (not some other style tag or even a `<meta>` or `<script>`).
if ( $style.data( 'ResourceLoaderDynamicStyleTag' ) === true ) {
// There's already a dynamic <style> tag present and
// canExpandStylesheetWith() gave a green light to append more to it.
styleEl = $style.get( 0 );
if ( styleEl.styleSheet ) {
try {
styleEl.styleSheet.cssText += cssText; // IE
} catch ( e ) {
log( 'Stylesheet error', e );
}
} else {
styleEl.appendChild( document.createTextNode( String( cssText ) ) );
}
cssCallbacks.fire().empty();
return;
}
}
$( newStyleTag( cssText, getMarker() ) ).data( 'ResourceLoaderDynamicStyleTag', true );
cssCallbacks.fire().empty();
}
/**
* Generates an ISO8601 "basic" string from a UNIX timestamp
* @private
*/
function formatVersionNumber( timestamp ) {
var d = new Date();
function pad( a, b, c ) {
return [a < 10 ? '0' + a : a, b < 10 ? '0' + b : b, c < 10 ? '0' + c : c].join( '' );
}
d.setTime( timestamp * 1000 );
return [
pad( d.getUTCFullYear(), d.getUTCMonth() + 1, d.getUTCDate() ), 'T',
pad( d.getUTCHours(), d.getUTCMinutes(), d.getUTCSeconds() ), 'Z'
].join( '' );
}
/**
* Resolves dependencies and detects circular references.
*
* @private
* @param {string} module Name of the top-level module whose dependencies shall be
* resolved and sorted.
* @param {Array} resolved Returns a topological sort of the given module and its
* dependencies, such that later modules depend on earlier modules. The array
* contains the module names. If the array contains already some module names,
* this function appends its result to the pre-existing array.
* @param {Object} [unresolved] Hash used to track the current dependency
* chain; used to report loops in the dependency graph.
* @throws {Error} If any unregistered module or a dependency loop is encountered
*/
function sortDependencies( module, resolved, unresolved ) {
var n, deps, len, skip;
if ( registry[module] === undefined ) {
throw new Error( 'Unknown dependency: ' + module );
}
if ( registry[module].skip !== null ) {
/*jshint evil:true */
skip = new Function( registry[module].skip );
registry[module].skip = null;
if ( skip() ) {
registry[module].skipped = true;
registry[module].dependencies = [];
registry[module].state = 'ready';
handlePending( module );
return;
}
}
// Resolves dynamic loader function and replaces it with its own results
if ( $.isFunction( registry[module].dependencies ) ) {
registry[module].dependencies = registry[module].dependencies();
// Ensures the module's dependencies are always in an array
if ( typeof registry[module].dependencies !== 'object' ) {
registry[module].dependencies = [registry[module].dependencies];
}
}
if ( $.inArray( module, resolved ) !== -1 ) {
// Module already resolved; nothing to do.
return;
}
// unresolved is optional, supply it if not passed in
if ( !unresolved ) {
unresolved = {};
}
// Tracks down dependencies
deps = registry[module].dependencies;
len = deps.length;
for ( n = 0; n < len; n += 1 ) {
if ( $.inArray( deps[n], resolved ) === -1 ) {
if ( unresolved[deps[n]] ) {
throw new Error(
'Circular reference detected: ' + module +
' -> ' + deps[n]
);
}
// Add to unresolved
unresolved[module] = true;
sortDependencies( deps[n], resolved, unresolved );
delete unresolved[module];
}
}
resolved[resolved.length] = module;
}
/**
* Gets a list of module names that a module depends on in their proper dependency
* order.
*
* @private
* @param {string} module Module name or array of string module names
* @return {Array} list of dependencies, including 'module'.
* @throws {Error} If circular reference is detected
*/
function resolve( module ) {
var m, resolved;
// Allow calling with an array of module names
if ( $.isArray( module ) ) {
resolved = [];
for ( m = 0; m < module.length; m += 1 ) {
sortDependencies( module[m], resolved );
}
return resolved;
}
if ( typeof module === 'string' ) {
resolved = [];
sortDependencies( module, resolved );
return resolved;
}
throw new Error( 'Invalid module argument: ' + module );
}
/**
* Narrows a list of module names down to those matching a specific
* state (see comment on top of this scope for a list of valid states).
* One can also filter for 'unregistered', which will return the
* modules names that don't have a registry entry.
*
* @private
* @param {string|string[]} states Module states to filter by
* @param {Array} [modules] List of module names to filter (optional, by default the entire
* registry is used)
* @return {Array} List of filtered module names
*/
function filter( states, modules ) {
var list, module, s, m;
// Allow states to be given as a string
if ( typeof states === 'string' ) {
states = [states];
}
// If called without a list of modules, build and use a list of all modules
list = [];
if ( modules === undefined ) {
modules = [];
for ( module in registry ) {
modules[modules.length] = module;
}
}
// Build a list of modules which are in one of the specified states
for ( s = 0; s < states.length; s += 1 ) {
for ( m = 0; m < modules.length; m += 1 ) {
if ( registry[modules[m]] === undefined ) {
// Module does not exist
if ( states[s] === 'unregistered' ) {
// OK, undefined
list[list.length] = modules[m];
}
} else {
// Module exists, check state
if ( registry[modules[m]].state === states[s] ) {
// OK, correct state
list[list.length] = modules[m];
}
}
}
}
return list;
}
/**
* Determine whether all dependencies are in state 'ready', which means we may
* execute the module or job now.
*
* @private
* @param {Array} dependencies Dependencies (module names) to be checked.
* @return {boolean} True if all dependencies are in state 'ready', false otherwise
*/
function allReady( dependencies ) {
return filter( 'ready', dependencies ).length === dependencies.length;
}
/**
* A module has entered state 'ready', 'error', or 'missing'. Automatically update pending jobs
* and modules that depend upon this module. if the given module failed, propagate the 'error'
* state up the dependency tree; otherwise, execute all jobs/modules that now have all their
* dependencies satisfied. On jobs depending on a failed module, run the error callback, if any.
*
* @private
* @param {string} module Name of module that entered one of the states 'ready', 'error', or 'missing'.
*/
function handlePending( module ) {
var j, job, hasErrors, m, stateChange;
// Modules.
if ( $.inArray( registry[module].state, ['error', 'missing'] ) !== -1 ) {
// If the current module failed, mark all dependent modules also as failed.
// Iterate until steady-state to propagate the error state upwards in the
// dependency tree.
do {
stateChange = false;
for ( m in registry ) {
if ( $.inArray( registry[m].state, ['error', 'missing'] ) === -1 ) {
if ( filter( ['error', 'missing'], registry[m].dependencies ).length > 0 ) {
registry[m].state = 'error';
stateChange = true;
}
}
}
} while ( stateChange );
}
// Execute all jobs whose dependencies are either all satisfied or contain at least one failed module.
for ( j = 0; j < jobs.length; j += 1 ) {
hasErrors = filter( ['error', 'missing'], jobs[j].dependencies ).length > 0;
if ( hasErrors || allReady( jobs[j].dependencies ) ) {
// All dependencies satisfied, or some have errors
job = jobs[j];
jobs.splice( j, 1 );
j -= 1;
try {
if ( hasErrors ) {
if ( $.isFunction( job.error ) ) {
job.error( new Error( 'Module ' + module + ' has failed dependencies' ), [module] );
}
} else {
if ( $.isFunction( job.ready ) ) {
job.ready();
}
}
} catch ( e ) {
// A user-defined callback raised an exception.
// Swallow it to protect our state machine!
log( 'Exception thrown by user callback', e );
}
}
}
if ( registry[module].state === 'ready' ) {
// The current module became 'ready'. Set it in the module store, and recursively execute all
// dependent modules that are loaded and now have all dependencies satisfied.
mw.loader.store.set( module, registry[module] );
for ( m in registry ) {
if ( registry[m].state === 'loaded' && allReady( registry[m].dependencies ) ) {
execute( m );
}
}
}
}
/**
* Adds a script tag to the DOM, either using document.write or low-level DOM manipulation,
* depending on whether document-ready has occurred yet and whether we are in async mode.
*
* @private
* @param {string} src URL to script, will be used as the src attribute in the script tag
* @param {Function} [callback] Callback which will be run when the script is done
* @param {boolean} [async=false] Whether to load modules asynchronously.
* Ignored (and defaulted to `true`) if the document-ready event has already occurred.
*/
function addScript( src, callback, async ) {
// Using isReady directly instead of storing it locally from a $().ready callback (bug 31895)
if ( $.isReady || async ) {
$.ajax( {
url: src,
dataType: 'script',
// Force jQuery behaviour to be for crossDomain. Otherwise jQuery would use
// XHR for a same domain request instead of <script>, which changes the request
// headers (potentially missing a cache hit), and reduces caching in general
// since browsers cache XHR much less (if at all). And XHR means we retreive
// text, so we'd need to $.globalEval, which then messes up line numbers.
crossDomain: true,
cache: true,
async: true
} ).always( callback );
} else {
/*jshint evil:true */
document.write( mw.html.element( 'script', { 'src': src }, '' ) );
if ( callback ) {
// Document.write is synchronous, so this is called when it's done.
// FIXME: That's a lie. doc.write isn't actually synchronous.
callback();
}
}
}
/**
* Executes a loaded module, making it ready to use
*
* @private
* @param {string} module Module name to execute
*/
function execute( module ) {
var key, value, media, i, urls, cssHandle, checkCssHandles,
cssHandlesRegistered = false;
if ( registry[module] === undefined ) {
throw new Error( 'Module has not been registered yet: ' + module );
} else if ( registry[module].state === 'registered' ) {
throw new Error( 'Module has not been requested from the server yet: ' + module );
} else if ( registry[module].state === 'loading' ) {
throw new Error( 'Module has not completed loading yet: ' + module );
} else if ( registry[module].state === 'ready' ) {
throw new Error( 'Module has already been executed: ' + module );
}
/**
* Define loop-function here for efficiency
* and to avoid re-using badly scoped variables.
* @ignore
*/
function addLink( media, url ) {
var el = document.createElement( 'link' );
// For IE: Insert in document *before* setting href
getMarker().before( el );
el.rel = 'stylesheet';
if ( media && media !== 'all' ) {
el.media = media;
}
// If you end up here from an IE exception "SCRIPT: Invalid property value.",
// see #addEmbeddedCSS, bug 31676, and bug 47277 for details.
el.href = url;
}
function runScript() {
var script, markModuleReady, nestedAddScript;
try {
script = registry[module].script;
markModuleReady = function () {
registry[module].state = 'ready';
handlePending( module );
};
nestedAddScript = function ( arr, callback, async, i ) {
// Recursively call addScript() in its own callback
// for each element of arr.
if ( i >= arr.length ) {
// We're at the end of the array
callback();
return;
}
addScript( arr[i], function () {
nestedAddScript( arr, callback, async, i + 1 );
}, async );
};
if ( $.isArray( script ) ) {
nestedAddScript( script, markModuleReady, registry[module].async, 0 );
} else if ( $.isFunction( script ) ) {
registry[module].state = 'ready';
// Pass jQuery twice so that the signature of the closure which wraps
// the script can bind both '$' and 'jQuery'.
script( $, $ );
handlePending( module );
}
} catch ( e ) {
// This needs to NOT use mw.log because these errors are common in production mode
// and not in debug mode, such as when a symbol that should be global isn't exported
log( 'Exception thrown by ' + module, e );
registry[module].state = 'error';
handlePending( module );
}
}
// This used to be inside runScript, but since that is now fired asychronously
// (after CSS is loaded) we need to set it here right away. It is crucial that
// when execute() is called this is set synchronously, otherwise modules will get
// executed multiple times as the registry will state that it isn't loading yet.
registry[module].state = 'loading';
// Add localizations to message system
if ( $.isPlainObject( registry[module].messages ) ) {
mw.messages.set( registry[module].messages );
}
if ( $.isReady || registry[module].async ) {
// Make sure we don't run the scripts until all (potentially asynchronous)
// stylesheet insertions have completed.
( function () {
var pending = 0;
checkCssHandles = function () {
// cssHandlesRegistered ensures we don't take off too soon, e.g. when
// one of the cssHandles is fired while we're still creating more handles.
if ( cssHandlesRegistered && pending === 0 && runScript ) {
runScript();
runScript = undefined; // Revoke
}
};
cssHandle = function () {
var check = checkCssHandles;
pending++;
return function () {
if (check) {
pending--;
check();
check = undefined; // Revoke
}
};
};
}() );
} else {
// We are in blocking mode, and so we can't afford to wait for CSS
cssHandle = function () {};
// Run immediately
checkCssHandles = runScript;
}
// Process styles (see also mw.loader.implement)
// * back-compat: { <media>: css }
// * back-compat: { <media>: [url, ..] }
// * { "css": [css, ..] }
// * { "url": { <media>: [url, ..] } }
if ( $.isPlainObject( registry[module].style ) ) {
for ( key in registry[module].style ) {
value = registry[module].style[key];
media = undefined;
if ( key !== 'url' && key !== 'css' ) {
// Backwards compatibility, key is a media-type
if ( typeof value === 'string' ) {
// back-compat: { <media>: css }
// Ignore 'media' because it isn't supported (nor was it used).
// Strings are pre-wrapped in "@media". The media-type was just ""
// (because it had to be set to something).
// This is one of the reasons why this format is no longer used.
addEmbeddedCSS( value, cssHandle() );
} else {
// back-compat: { <media>: [url, ..] }
media = key;
key = 'bc-url';
}
}
// Array of css strings in key 'css',
// or back-compat array of urls from media-type
if ( $.isArray( value ) ) {
for ( i = 0; i < value.length; i += 1 ) {
if ( key === 'bc-url' ) {
// back-compat: { <media>: [url, ..] }
addLink( media, value[i] );
} else if ( key === 'css' ) {
// { "css": [css, ..] }
addEmbeddedCSS( value[i], cssHandle() );
}
}
// Not an array, but a regular object
// Array of urls inside media-type key
} else if ( typeof value === 'object' ) {
// { "url": { <media>: [url, ..] } }
for ( media in value ) {
urls = value[media];
for ( i = 0; i < urls.length; i += 1 ) {
addLink( media, urls[i] );
}
}
}
}
}
// Kick off.
cssHandlesRegistered = true;
checkCssHandles();
}
/**
* Adds a dependencies to the queue with optional callbacks to be run
* when the dependencies are ready or fail
*
* @private
* @param {string|string[]} dependencies Module name or array of string module names
* @param {Function} [ready] Callback to execute when all dependencies are ready
* @param {Function} [error] Callback to execute when any dependency fails
* @param {boolean} [async=false] Whether to load modules asynchronously.
* Ignored (and defaulted to `true`) if the document-ready event has already occurred.
*/
function request( dependencies, ready, error, async ) {
var n;
// Allow calling by single module name
if ( typeof dependencies === 'string' ) {
dependencies = [dependencies];
}
// Add ready and error callbacks if they were given
if ( ready !== undefined || error !== undefined ) {
jobs[jobs.length] = {
'dependencies': filter(
['registered', 'loading', 'loaded'],
dependencies
),
'ready': ready,
'error': error
};
}
// Queue up any dependencies that are registered
dependencies = filter( ['registered'], dependencies );
for ( n = 0; n < dependencies.length; n += 1 ) {
if ( $.inArray( dependencies[n], queue ) === -1 ) {
queue[queue.length] = dependencies[n];
if ( async ) {
// Mark this module as async in the registry
registry[dependencies[n]].async = true;
}
}
}
// Work the queue
mw.loader.work();
}
function sortQuery( o ) {
var sorted = {}, key, a = [];
for ( key in o ) {
if ( hasOwn.call( o, key ) ) {
a.push( key );
}
}
a.sort();
for ( key = 0; key < a.length; key += 1 ) {
sorted[a[key]] = o[a[key]];
}
return sorted;
}
/**
* Converts a module map of the form { foo: [ 'bar', 'baz' ], bar: [ 'baz, 'quux' ] }
* to a query string of the form foo.bar,baz|bar.baz,quux
* @private
*/
function buildModulesString( moduleMap ) {
var arr = [], p, prefix;
for ( prefix in moduleMap ) {
p = prefix === '' ? '' : prefix + '.';
arr.push( p + moduleMap[prefix].join( ',' ) );
}
return arr.join( '|' );
}
/**
* Asynchronously append a script tag to the end of the body
* that invokes load.php
* @private
* @param {Object} moduleMap Module map, see #buildModulesString
* @param {Object} currReqBase Object with other parameters (other than 'modules') to use in the request
* @param {string} sourceLoadScript URL of load.php
* @param {boolean} async Whether to load modules asynchronously.
* Ignored (and defaulted to `true`) if the document-ready event has already occurred.
*/
function doRequest( moduleMap, currReqBase, sourceLoadScript, async ) {
var request = $.extend(
{ modules: buildModulesString( moduleMap ) },
currReqBase
);
request = sortQuery( request );
// Append &* to avoid triggering the IE6 extension check
addScript( sourceLoadScript + '?' + $.param( request ) + '&*', null, async );
}
/* Public Members */
return {
/**
* The module registry is exposed as an aid for debugging and inspecting page
* state; it is not a public interface for modifying the registry.
*
* @see #registry
* @property
* @private
*/
moduleRegistry: registry,
/**
* @inheritdoc #newStyleTag
* @method
*/
addStyleTag: newStyleTag,
/**
* Batch-request queued dependencies from the server.
*/
work: function () {
var reqBase, splits, maxQueryLength, q, b, bSource, bGroup, bSourceGroup,
source, concatSource, origBatch, group, g, i, modules, maxVersion, sourceLoadScript,
currReqBase, currReqBaseLength, moduleMap, l,
lastDotIndex, prefix, suffix, bytesAdded, async;
// Build a list of request parameters common to all requests.
reqBase = {
skin: mw.config.get( 'skin' ),
lang: mw.config.get( 'wgUserLanguage' ),
debug: mw.config.get( 'debug' )
};
// Split module batch by source and by group.
splits = {};
maxQueryLength = mw.config.get( 'wgResourceLoaderMaxQueryLength', -1 );
// Appends a list of modules from the queue to the batch
for ( q = 0; q < queue.length; q += 1 ) {
// Only request modules which are registered
if ( registry[queue[q]] !== undefined && registry[queue[q]].state === 'registered' ) {
// Prevent duplicate entries
if ( $.inArray( queue[q], batch ) === -1 ) {
batch[batch.length] = queue[q];
// Mark registered modules as loading
registry[queue[q]].state = 'loading';
}
}
}
mw.loader.store.init();
if ( mw.loader.store.enabled ) {
concatSource = [];
origBatch = batch;
batch = $.grep( batch, function ( module ) {
var source = mw.loader.store.get( module );
if ( source ) {
concatSource.push( source );
return false;
}
return true;
} );
try {
$.globalEval( concatSource.join( ';' ) );
} catch ( err ) {
// Not good, the cached mw.loader.implement calls failed! This should
// never happen, barring ResourceLoader bugs, browser bugs and PEBKACs.
// Depending on how corrupt the string is, it is likely that some
// modules' implement() succeeded while the ones after the error will
// never run and leave their modules in the 'loading' state forever.
// Since this is an error not caused by an individual module but by
// something that infected the implement call itself, don't take any
// risks and clear everything in this cache.
mw.loader.store.clear();
// Re-add the ones still pending back to the batch and let the server
// repopulate these modules to the cache.
// This means that at most one module will be useless (the one that had
// the error) instead of all of them.
log( 'Error while evaluating data from mw.loader.store', err );
origBatch = $.grep( origBatch, function ( module ) {
return registry[module].state === 'loading';
} );
batch = batch.concat( origBatch );
}
}
// Early exit if there's nothing to load...
if ( !batch.length ) {
return;
}
// The queue has been processed into the batch, clear up the queue.
queue = [];
// Always order modules alphabetically to help reduce cache
// misses for otherwise identical content.
batch.sort();
// Split batch by source and by group.
for ( b = 0; b < batch.length; b += 1 ) {
bSource = registry[batch[b]].source;
bGroup = registry[batch[b]].group;
if ( splits[bSource] === undefined ) {
splits[bSource] = {};
}
if ( splits[bSource][bGroup] === undefined ) {
splits[bSource][bGroup] = [];
}
bSourceGroup = splits[bSource][bGroup];
bSourceGroup[bSourceGroup.length] = batch[b];
}
// Clear the batch - this MUST happen before we append any
// script elements to the body or it's possible that a script
// will be locally cached, instantly load, and work the batch
// again, all before we've cleared it causing each request to
// include modules which are already loaded.
batch = [];
for ( source in splits ) {
sourceLoadScript = sources[source];
for ( group in splits[source] ) {
// Cache access to currently selected list of
// modules for this group from this source.
modules = splits[source][group];
// Calculate the highest timestamp
maxVersion = 0;
for ( g = 0; g < modules.length; g += 1 ) {
if ( registry[modules[g]].version > maxVersion ) {
maxVersion = registry[modules[g]].version;
}
}
currReqBase = $.extend( { version: formatVersionNumber( maxVersion ) }, reqBase );
// For user modules append a user name to the request.
if ( group === 'user' && mw.config.get( 'wgUserName' ) !== null ) {
currReqBase.user = mw.config.get( 'wgUserName' );
}
currReqBaseLength = $.param( currReqBase ).length;
async = true;
// We may need to split up the request to honor the query string length limit,
// so build it piece by piece.
l = currReqBaseLength + 9; // '&modules='.length == 9
moduleMap = {}; // { prefix: [ suffixes ] }
for ( i = 0; i < modules.length; i += 1 ) {
// Determine how many bytes this module would add to the query string
lastDotIndex = modules[i].lastIndexOf( '.' );
// If lastDotIndex is -1, substr() returns an empty string
prefix = modules[i].substr( 0, lastDotIndex );
suffix = modules[i].slice( lastDotIndex + 1 );
bytesAdded = moduleMap[prefix] !== undefined
? suffix.length + 3 // '%2C'.length == 3
: modules[i].length + 3; // '%7C'.length == 3
// If the request would become too long, create a new one,
// but don't create empty requests
if ( maxQueryLength > 0 && !$.isEmptyObject( moduleMap ) && l + bytesAdded > maxQueryLength ) {
// This request would become too long, create a new one
// and fire off the old one
doRequest( moduleMap, currReqBase, sourceLoadScript, async );
moduleMap = {};
async = true;
l = currReqBaseLength + 9;
}
if ( moduleMap[prefix] === undefined ) {
moduleMap[prefix] = [];
}
moduleMap[prefix].push( suffix );
if ( !registry[modules[i]].async ) {
// If this module is blocking, make the entire request blocking
// This is slightly suboptimal, but in practice mixing of blocking
// and async modules will only occur in debug mode.
async = false;
}
l += bytesAdded;
}
// If there's anything left in moduleMap, request that too
if ( !$.isEmptyObject( moduleMap ) ) {
doRequest( moduleMap, currReqBase, sourceLoadScript, async );
}
}
}
},
/**
* Register a source.
*
* The #work method will use this information to split up requests by source.
*
* mw.loader.addSource( 'mediawikiwiki', '//www.mediawiki.org/w/load.php' );
*
* @param {string} id Short string representing a source wiki, used internally for
* registered modules to indicate where they should be loaded from (usually lowercase a-z).
* @param {Object|string} loadUrl load.php url, may be an object for backwards-compatibility
* @return {boolean}
*/
addSource: function ( id, loadUrl ) {
var source;
// Allow multiple additions
if ( typeof id === 'object' ) {
for ( source in id ) {
mw.loader.addSource( source, id[source] );
}
return true;
}
if ( sources[id] !== undefined ) {
throw new Error( 'source already registered: ' + id );
}
if ( typeof loadUrl === 'object' ) {
loadUrl = loadUrl.loadScript;
}
sources[id] = loadUrl;
return true;
},
/**
* Register a module, letting the system know about it and its
* properties. Startup modules contain calls to this function.
*
* @param {string} module Module name
* @param {number} version Module version number as a timestamp (falls backs to 0)
* @param {string|Array|Function} dependencies One string or array of strings of module
* names on which this module depends, or a function that returns that array.
* @param {string} [group=null] Group which the module is in
* @param {string} [source='local'] Name of the source
* @param {string} [skip=null] Script body of the skip function
*/
register: function ( module, version, dependencies, group, source, skip ) {
var m;
// Allow multiple registration
if ( typeof module === 'object' ) {
for ( m = 0; m < module.length; m += 1 ) {
// module is an array of module names
if ( typeof module[m] === 'string' ) {
mw.loader.register( module[m] );
// module is an array of arrays
} else if ( typeof module[m] === 'object' ) {
mw.loader.register.apply( mw.loader, module[m] );
}
}
return;
}
// Validate input
if ( typeof module !== 'string' ) {
throw new Error( 'module must be a string, not a ' + typeof module );
}
if ( registry[module] !== undefined ) {
throw new Error( 'module already registered: ' + module );
}
// List the module as registered
registry[module] = {
version: version !== undefined ? parseInt( version, 10 ) : 0,
dependencies: [],
group: typeof group === 'string' ? group : null,
source: typeof source === 'string' ? source : 'local',
state: 'registered',
skip: typeof skip === 'string' ? skip : null
};
if ( typeof dependencies === 'string' ) {
// Allow dependencies to be given as a single module name
registry[module].dependencies = [ dependencies ];
} else if ( typeof dependencies === 'object' || $.isFunction( dependencies ) ) {
// Allow dependencies to be given as an array of module names
// or a function which returns an array
registry[module].dependencies = dependencies;
}
},
/**
* Implement a module given the components that make up the module.
*
* When #load or #using requests one or more modules, the server
* response contain calls to this function.
*
* All arguments are required.
*
* @param {string} module Name of module
* @param {Function|Array} script Function with module code or Array of URLs to
* be used as the src attribute of a new `<script>` tag.
* @param {Object} style Should follow one of the following patterns:
*
* { "css": [css, ..] }
* { "url": { <media>: [url, ..] } }
*
* And for backwards compatibility (needs to be supported forever due to caching):
*
* { <media>: css }
* { <media>: [url, ..] }
*
* The reason css strings are not concatenated anymore is bug 31676. We now check
* whether it's safe to extend the stylesheet (see #canExpandStylesheetWith).
*
* @param {Object} msgs List of key/value pairs to be added to mw#messages.
*/
implement: function ( module, script, style, msgs ) {
// Validate input
if ( typeof module !== 'string' ) {
throw new Error( 'module must be a string, not a ' + typeof module );
}
if ( !$.isFunction( script ) && !$.isArray( script ) ) {
throw new Error( 'script must be a function or an array, not a ' + typeof script );
}
if ( !$.isPlainObject( style ) ) {
throw new Error( 'style must be an object, not a ' + typeof style );
}
if ( !$.isPlainObject( msgs ) ) {
throw new Error( 'msgs must be an object, not a ' + typeof msgs );
}
// Automatically register module
if ( registry[module] === undefined ) {
mw.loader.register( module );
}
// Check for duplicate implementation
if ( registry[module] !== undefined && registry[module].script !== undefined ) {
throw new Error( 'module already implemented: ' + module );
}
// Attach components
registry[module].script = script;
registry[module].style = style;
registry[module].messages = msgs;
// The module may already have been marked as erroneous
if ( $.inArray( registry[module].state, ['error', 'missing'] ) === -1 ) {
registry[module].state = 'loaded';
if ( allReady( registry[module].dependencies ) ) {
execute( module );
}
}
},
/**
* Execute a function as soon as one or more required modules are ready.
*
* Example of inline dependency on OOjs:
*
* mw.loader.using( 'oojs', function () {
* OO.compare( [ 1 ], [ 1 ] );
* } );
*
* @param {string|Array} dependencies Module name or array of modules names the callback
* dependends on to be ready before executing
* @param {Function} [ready] Callback to execute when all dependencies are ready
* @param {Function} [error] Callback to execute if one or more dependencies failed
* @return {jQuery.Promise}
*/
using: function ( dependencies, ready, error ) {
var deferred = $.Deferred();
// Allow calling with a single dependency as a string
if ( typeof dependencies === 'string' ) {
dependencies = [ dependencies ];
} else if ( !$.isArray( dependencies ) ) {
// Invalid input
throw new Error( 'Dependencies must be a string or an array' );
}
if ( ready ) {
deferred.done( ready );
}
if ( error ) {
deferred.fail( error );
}
// Resolve entire dependency map
dependencies = resolve( dependencies );
if ( allReady( dependencies ) ) {
// Run ready immediately
deferred.resolve();
} else if ( filter( ['error', 'missing'], dependencies ).length ) {
// Execute error immediately if any dependencies have errors
deferred.reject(
new Error( 'One or more dependencies failed to load' ),
dependencies
);
} else {
// Not all dependencies are ready: queue up a request
request( dependencies, deferred.resolve, deferred.reject );
}
return deferred.promise();
},
/**
* Load an external script or one or more modules.
*
* @param {string|Array} modules Either the name of a module, array of modules,
* or a URL of an external script or style
* @param {string} [type='text/javascript'] MIME type to use if calling with a URL of an
* external script or style; acceptable values are "text/css" and
* "text/javascript"; if no type is provided, text/javascript is assumed.
* @param {boolean} [async] Whether to load modules asynchronously.
* Ignored (and defaulted to `true`) if the document-ready event has already occurred.
* Defaults to `true` if loading a URL, `false` otherwise.
*/
load: function ( modules, type, async ) {
var filtered, m, module, l;
// Validate input
if ( typeof modules !== 'object' && typeof modules !== 'string' ) {
throw new Error( 'modules must be a string or an array, not a ' + typeof modules );
}
// Allow calling with an external url or single dependency as a string
if ( typeof modules === 'string' ) {
// Support adding arbitrary external scripts
if ( /^(https?:)?\/\//.test( modules ) ) {
if ( async === undefined ) {
// Assume async for bug 34542
async = true;
}
if ( type === 'text/css' ) {
// IE7-8 throws security warnings when inserting a <link> tag
// with a protocol-relative URL set though attributes (instead of
// properties) - when on HTTPS. See also bug 41331.
l = document.createElement( 'link' );
l.rel = 'stylesheet';
l.href = modules;
$( 'head' ).append( l );
return;
}
if ( type === 'text/javascript' || type === undefined ) {
addScript( modules, null, async );
return;
}
// Unknown type
throw new Error( 'invalid type for external url, must be text/css or text/javascript. not ' + type );
}
// Called with single module
modules = [ modules ];
}
// Filter out undefined modules, otherwise resolve() will throw
// an exception for trying to load an undefined module.
// Undefined modules are acceptable here in load(), because load() takes
// an array of unrelated modules, whereas the modules passed to
// using() are related and must all be loaded.
for ( filtered = [], m = 0; m < modules.length; m += 1 ) {
module = registry[modules[m]];
if ( module !== undefined ) {
if ( $.inArray( module.state, ['error', 'missing'] ) === -1 ) {
filtered[filtered.length] = modules[m];
}
}
}
if ( filtered.length === 0 ) {
return;
}
// Resolve entire dependency map
filtered = resolve( filtered );
// If all modules are ready, nothing to be done
if ( allReady( filtered ) ) {
return;
}
// If any modules have errors: also quit.
if ( filter( ['error', 'missing'], filtered ).length ) {
return;
}
// Since some modules are not yet ready, queue up a request.
request( filtered, undefined, undefined, async );
},
/**
* Change the state of one or more modules.
*
* @param {string|Object} module Module name or object of module name/state pairs
* @param {string} state State name
*/
state: function ( module, state ) {
var m;
if ( typeof module === 'object' ) {
for ( m in module ) {
mw.loader.state( m, module[m] );
}
return;
}
if ( registry[module] === undefined ) {
mw.loader.register( module );
}
if ( $.inArray( state, ['ready', 'error', 'missing'] ) !== -1
&& registry[module].state !== state ) {
// Make sure pending modules depending on this one get executed if their
// dependencies are now fulfilled!
registry[module].state = state;
handlePending( module );
} else {
registry[module].state = state;
}
},
/**
* Get the version of a module.
*
* @param {string} module Name of module to get version for
* @return {string|null} The version, or null if the module (or its version) is not
* in the registry.
*/
getVersion: function ( module ) {
if ( registry[module] !== undefined && registry[module].version !== undefined ) {
return formatVersionNumber( registry[module].version );
}
return null;
},
/**
* Get the state of a module.
*
* @param {string} module Name of module to get state for
*/
getState: function ( module ) {
if ( registry[module] !== undefined && registry[module].state !== undefined ) {
return registry[module].state;
}
return null;
},
/**
* Get the names of all registered modules.
*
* @return {Array}
*/
getModuleNames: function () {
return $.map( registry, function ( i, key ) {
return key;
} );
},
/**
* @inheritdoc mw.inspect#runReports
* @method
*/
inspect: function () {
var args = slice.call( arguments );
mw.loader.using( 'mediawiki.inspect', function () {
mw.inspect.runReports.apply( mw.inspect, args );
} );
},
/**
* On browsers that implement the localStorage API, the module store serves as a
* smart complement to the browser cache. Unlike the browser cache, the module store
* can slice a concatenated response from ResourceLoader into its constituent
* modules and cache each of them separately, using each module's versioning scheme
* to determine when the cache should be invalidated.
*
* @singleton
* @class mw.loader.store
*/
store: {
// Whether the store is in use on this page.
enabled: null,
// The contents of the store, mapping '[module name]@[version]' keys
// to module implementations.
items: {},
// Cache hit stats
stats: { hits: 0, misses: 0, expired: 0 },
/**
* Construct a JSON-serializable object representing the content of the store.
* @return {Object} Module store contents.
*/
toJSON: function () {
return { items: mw.loader.store.items, vary: mw.loader.store.getVary() };
},
/**
* Get the localStorage key for the entire module store. The key references
* $wgDBname to prevent clashes between wikis which share a common host.
*
* @return {string} localStorage item key
*/
getStoreKey: function () {
return 'MediaWikiModuleStore:' + mw.config.get( 'wgDBname' );
},
/**
* Get a string key on which to vary the module cache.
* @return {string} String of concatenated vary conditions.
*/
getVary: function () {
return [
mw.config.get( 'skin' ),
mw.config.get( 'wgResourceLoaderStorageVersion' ),
mw.config.get( 'wgUserLanguage' )
].join( ':' );
},
/**
* Get a string key for a specific module. The key format is '[name]@[version]'.
*
* @param {string} module Module name
* @return {string|null} Module key or null if module does not exist
*/
getModuleKey: function ( module ) {
return typeof registry[module] === 'object' ?
( module + '@' + registry[module].version ) : null;
},
/**
* Initialize the store.
*
* Retrieves store from localStorage and (if successfully retrieved) decoding
* the stored JSON value to a plain object.
*
* The try / catch block is used for JSON & localStorage feature detection.
* See the in-line documentation for Modernizr's localStorage feature detection
* code for a full account of why we need a try / catch:
* <https://github.com/Modernizr/Modernizr/blob/v2.7.1/modernizr.js#L771-L796>.
*/
init: function () {
var raw, data;
if ( mw.loader.store.enabled !== null ) {
// Init already ran
return;
}
if ( !mw.config.get( 'wgResourceLoaderStorageEnabled' ) || mw.config.get( 'debug' ) ) {
// Disabled by configuration, or because debug mode is set
mw.loader.store.enabled = false;
return;
}
try {
raw = localStorage.getItem( mw.loader.store.getStoreKey() );
// If we get here, localStorage is available; mark enabled
mw.loader.store.enabled = true;
data = JSON.parse( raw );
if ( data && typeof data.items === 'object' && data.vary === mw.loader.store.getVary() ) {
mw.loader.store.items = data.items;
return;
}
} catch ( e ) {
log( 'Storage error', e );
}
if ( raw === undefined ) {
// localStorage failed; disable store
mw.loader.store.enabled = false;
} else {
mw.loader.store.update();
}
},
/**
* Retrieve a module from the store and update cache hit stats.
*
* @param {string} module Module name
* @return {string|boolean} Module implementation or false if unavailable
*/
get: function ( module ) {
var key;
if ( !mw.loader.store.enabled ) {
return false;
}
key = mw.loader.store.getModuleKey( module );
if ( key in mw.loader.store.items ) {
mw.loader.store.stats.hits++;
return mw.loader.store.items[key];
}
mw.loader.store.stats.misses++;
return false;
},
/**
* Stringify a module and queue it for storage.
*
* @param {string} module Module name
* @param {Object} descriptor The module's descriptor as set in the registry
*/
set: function ( module, descriptor ) {
var args, key;
if ( !mw.loader.store.enabled ) {
return false;
}
key = mw.loader.store.getModuleKey( module );
if (
// Already stored a copy of this exact version
key in mw.loader.store.items ||
// Module failed to load
descriptor.state !== 'ready' ||
// Unversioned, private, or site-/user-specific
( !descriptor.version || $.inArray( descriptor.group, [ 'private', 'user', 'site' ] ) !== -1 ) ||
// Partial descriptor
$.inArray( undefined, [ descriptor.script, descriptor.style, descriptor.messages ] ) !== -1
) {
// Decline to store
return false;
}
try {
args = [
JSON.stringify( module ),
typeof descriptor.script === 'function' ?
String( descriptor.script ) :
JSON.stringify( descriptor.script ),
JSON.stringify( descriptor.style ),
JSON.stringify( descriptor.messages )
];
// Attempted workaround for a possible Opera bug (bug 57567).
// This regex should never match under sane conditions.
if ( /^\s*\(/.test( args[1] ) ) {
args[1] = 'function' + args[1];
log( 'Detected malformed function stringification (bug 57567)' );
}
} catch ( e ) {
log( 'Storage error', e );
return;
}
mw.loader.store.items[key] = 'mw.loader.implement(' + args.join( ',' ) + ');';
mw.loader.store.update();
},
/**
* Iterate through the module store, removing any item that does not correspond
* (in name and version) to an item in the module registry.
*/
prune: function () {
var key, module;
if ( !mw.loader.store.enabled ) {
return false;
}
for ( key in mw.loader.store.items ) {
module = key.slice( 0, key.indexOf( '@' ) );
if ( mw.loader.store.getModuleKey( module ) !== key ) {
mw.loader.store.stats.expired++;
delete mw.loader.store.items[key];
}
}
},
/**
* Clear the entire module store right now.
*/
clear: function () {
mw.loader.store.items = {};
localStorage.removeItem( mw.loader.store.getStoreKey() );
},
/**
* Sync modules to localStorage.
*
* This function debounces localStorage updates. When called multiple times in
* quick succession, the calls are coalesced into a single update operation.
* This allows us to call #update without having to consider the module load
* queue; the call to localStorage.setItem will be naturally deferred until the
* page is quiescent.
*
* Because localStorage is shared by all pages with the same origin, if multiple
* pages are loaded with different module sets, the possibility exists that
* modules saved by one page will be clobbered by another. But the impact would
* be minor and the problem would be corrected by subsequent page views.
*
* @method
*/
update: ( function () {
var timer;
function flush() {
var data,
key = mw.loader.store.getStoreKey();
if ( !mw.loader.store.enabled ) {
return false;
}
mw.loader.store.prune();
try {
// Replacing the content of the module store might fail if the new
// contents would exceed the browser's localStorage size limit. To
// avoid clogging the browser with stale data, always remove the old
// value before attempting to set the new one.
localStorage.removeItem( key );
data = JSON.stringify( mw.loader.store );
localStorage.setItem( key, data );
} catch ( e ) {
log( 'Storage error', e );
}
}
return function () {
clearTimeout( timer );
timer = setTimeout( flush, 2000 );
};
}() )
}
};
}() ),
/**
* HTML construction helper functions
*
* @example
*
* var Html, output;
*
* Html = mw.html;
* output = Html.element( 'div', {}, new Html.Raw(
* Html.element( 'img', { src: '<' } )
* ) );
* mw.log( output ); // <div><img src="<"/></div>
*
* @class mw.html
* @singleton
*/
html: ( function () {
function escapeCallback( s ) {
switch ( s ) {
case '\'':
return ''';
case '"':
return '"';
case '<':
return '<';
case '>':
return '>';
case '&':
return '&';
}
}
return {
/**
* Escape a string for HTML.
*
* Converts special characters to HTML entities.
*
* mw.html.escape( '< > \' & "' );
* // Returns < > ' & "
*
* @param {string} s The string to escape
* @return {string} HTML
*/
escape: function ( s ) {
return s.replace( /['"<>&]/g, escapeCallback );
},
/**
* Create an HTML element string, with safe escaping.
*
* @param {string} name The tag name.
* @param {Object} attrs An object with members mapping element names to values
* @param {Mixed} contents The contents of the element. May be either:
*
* - string: The string is escaped.
* - null or undefined: The short closing form is used, e.g. `<br/>`.
* - this.Raw: The value attribute is included without escaping.
* - this.Cdata: The value attribute is included, and an exception is
* thrown if it contains an illegal ETAGO delimiter.
* See <http://www.w3.org/TR/1999/REC-html401-19991224/appendix/notes.html#h-B.3.2>.
* @return {string} HTML
*/
element: function ( name, attrs, contents ) {
var v, attrName, s = '<' + name;
for ( attrName in attrs ) {
v = attrs[attrName];
// Convert name=true, to name=name
if ( v === true ) {
v = attrName;
// Skip name=false
} else if ( v === false ) {
continue;
}
s += ' ' + attrName + '="' + this.escape( String( v ) ) + '"';
}
if ( contents === undefined || contents === null ) {
// Self close tag
s += '/>';
return s;
}
// Regular open tag
s += '>';
switch ( typeof contents ) {
case 'string':
// Escaped
s += this.escape( contents );
break;
case 'number':
case 'boolean':
// Convert to string
s += String( contents );
break;
default:
if ( contents instanceof this.Raw ) {
// Raw HTML inclusion
s += contents.value;
} else if ( contents instanceof this.Cdata ) {
// CDATA
if ( /<\/[a-zA-z]/.test( contents.value ) ) {
throw new Error( 'mw.html.element: Illegal end tag found in CDATA' );
}
s += contents.value;
} else {
throw new Error( 'mw.html.element: Invalid type of contents' );
}
}
s += '</' + name + '>';
return s;
},
/**
* Wrapper object for raw HTML passed to mw.html.element().
* @class mw.html.Raw
*/
Raw: function ( value ) {
this.value = value;
},
/**
* Wrapper object for CDATA element contents passed to mw.html.element()
* @class mw.html.Cdata
*/
Cdata: function ( value ) {
this.value = value;
}
};
}() ),
// Skeleton user object. mediawiki.user.js extends this
user: {
options: new Map(),
tokens: new Map()
},
/**
* Registry and firing of events.
*
* MediaWiki has various interface components that are extended, enhanced
* or manipulated in some other way by extensions, gadgets and even
* in core itself.
*
* This framework helps streamlining the timing of when these other
* code paths fire their plugins (instead of using document-ready,
* which can and should be limited to firing only once).
*
* Features like navigating to other wiki pages, previewing an edit
* and editing itself – without a refresh – can then retrigger these
* hooks accordingly to ensure everything still works as expected.
*
* Example usage:
*
* mw.hook( 'wikipage.content' ).add( fn ).remove( fn );
* mw.hook( 'wikipage.content' ).fire( $content );
*
* Handlers can be added and fired for arbitrary event names at any time. The same
* event can be fired multiple times. The last run of an event is memorized
* (similar to `$(document).ready` and `$.Deferred().done`).
* This means if an event is fired, and a handler added afterwards, the added
* function will be fired right away with the last given event data.
*
* Like Deferreds and Promises, the mw.hook object is both detachable and chainable.
* Thus allowing flexible use and optimal maintainability and authority control.
* You can pass around the `add` and/or `fire` method to another piece of code
* without it having to know the event name (or `mw.hook` for that matter).
*
* var h = mw.hook( 'bar.ready' );
* new mw.Foo( .. ).fetch( { callback: h.fire } );
*
* Note: Events are documented with an underscore instead of a dot in the event
* name due to jsduck not supporting dots in that position.
*
* @class mw.hook
*/
hook: ( function () {
var lists = {};
/**
* Create an instance of mw.hook.
*
* @method hook
* @member mw
* @param {string} name Name of hook.
* @return {mw.hook}
*/
return function ( name ) {
var list = hasOwn.call( lists, name ) ?
lists[name] :
lists[name] = $.Callbacks( 'memory' );
return {
/**
* Register a hook handler
* @param {Function...} handler Function to bind.
* @chainable
*/
add: list.add,
/**
* Unregister a hook handler
* @param {Function...} handler Function to unbind.
* @chainable
*/
remove: list.remove,
/**
* Run a hook.
* @param {Mixed...} data
* @chainable
*/
fire: function () {
return list.fireWith.call( this, null, slice.call( arguments ) );
}
};
};
}() )
};
// Alias $j to jQuery for backwards compatibility
// @deprecated since 1.23 Use $ or jQuery instead
mw.log.deprecate( window, '$j', $, 'Use $ or jQuery instead.' );
// Attach to window and globally alias
window.mw = window.mediaWiki = mw;
// Auto-register from pre-loaded startup scripts
if ( $.isFunction( window.startUp ) ) {
window.startUp();
window.startUp = undefined;
}
}( jQuery ) );
|