1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 1461 1462 1463 1464 1465 1466 1467 1468 1469 1470 1471 1472 1473 1474 1475 1476 1477 1478 1479 1480 1481 1482 1483 1484 1485 1486 1487 1488 1489 1490 1491 1492 1493 1494 1495 1496 1497 1498 1499 1500 1501 1502 1503 1504 1505 1506 1507 1508 1509 1510 1511 1512 1513 1514 1515 1516 1517 1518 1519 1520 1521 1522 1523 1524 1525 1526 1527 1528 1529 1530 1531 1532 1533 1534 1535 1536 1537 1538 1539 1540 1541 1542 1543 1544 1545 1546 1547 1548 1549 1550 1551 1552 1553 1554 1555 1556 1557 1558 1559 1560 1561 1562 1563 1564 1565 1566 1567 1568 1569 1570 1571 1572 1573 1574 1575 1576 1577 1578 1579 1580 1581 1582 1583 1584 1585 1586 1587 1588 1589 1590 1591 1592 1593 1594 1595 1596 1597 1598 1599 1600 1601 1602 1603 1604 1605 1606 1607 1608 1609 1610 1611 1612 1613 1614 1615 1616 1617 1618 1619 1620 1621 1622 1623 1624 1625 1626 1627 1628 1629 1630 1631 1632 1633 1634 1635 1636 1637 1638 1639 1640 1641 1642 1643 1644 1645 1646 1647 1648 1649 1650 1651 1652 1653 1654 1655 1656 1657 1658 1659 1660 1661 1662 1663 1664 1665 1666 1667 1668 1669 1670 1671 1672 1673 1674 1675 1676 1677 1678 1679 1680 1681 1682 1683 1684 1685 1686 1687 1688 1689 1690 1691 1692 1693 1694 1695 1696 1697 1698 1699 1700 1701 1702 1703 1704 1705 1706 1707 1708 1709 1710 1711 1712 1713 1714 1715 1716 1717 1718 1719 1720 1721 1722 1723 1724 1725 1726 1727 1728 1729 1730 1731 1732 1733 1734 1735 1736 1737 1738 1739 1740 1741 1742 1743 1744 1745 1746 1747 1748 1749 1750 1751 1752 1753 1754 1755 1756 1757 1758 1759 1760 1761 1762 1763 1764 1765 1766 1767 1768 1769 1770 1771 1772 1773 1774 1775 1776 1777 1778 1779 1780 1781 1782 1783 1784 1785 1786 1787 1788 1789 1790 1791 1792 1793 1794 1795 1796 1797 1798 1799 1800 1801 1802 1803 1804 1805 1806 1807 1808 1809 1810 1811 1812 1813 1814 1815 1816 1817 1818 1819 1820 1821 1822 1823 1824 1825 1826 1827 1828 1829 1830 1831 1832 1833 1834 1835 1836 1837 1838 1839 1840 1841 1842 1843 1844 1845 1846 1847 1848 1849 1850 1851 1852 1853 1854 1855 1856 1857 1858 1859 1860 1861 1862 1863 1864 1865 1866 1867 1868 1869 1870 1871 1872 1873 1874 1875 1876 1877 1878 1879 1880 1881 1882 1883 1884 1885 1886 1887 1888 1889 1890 1891 1892 1893 1894 1895 1896 1897 1898 1899 1900 1901 1902 1903 1904 1905 1906 1907 1908 1909 1910 1911 1912 1913 1914 1915 1916 1917 1918 1919 1920 1921 1922 1923 1924 1925 1926 1927 1928 1929 1930 1931 1932 1933 1934 1935 1936 1937 1938 1939 1940 1941 1942 1943 1944 1945 1946 1947 1948 1949 1950 1951 1952 1953 1954 1955 1956 1957 1958 1959 1960 1961 1962 1963 1964 1965 1966 1967 1968 1969 1970 1971 1972 1973 1974 1975 1976 1977 1978 1979 1980 1981 1982 1983 1984 1985 1986 1987 1988 1989 1990 1991 1992 1993 1994 1995 1996 1997 1998 1999 2000 2001 2002 2003 2004 2005 2006 2007 2008 2009 2010 2011 2012 2013 2014 2015 2016 2017 2018 2019 2020 2021 2022 2023 2024 2025 2026 2027 2028 2029 2030 2031 2032 2033 2034 2035 2036 2037 2038 2039 2040 2041 2042 2043 2044 2045 2046 2047 2048 2049 2050 2051 2052 2053 2054 2055 2056 2057 2058 2059 2060 2061 2062 2063 2064 2065 2066 2067 2068 2069 2070 2071 2072 2073 2074 2075 2076 2077 2078 2079 2080 2081 2082 2083 2084 2085 2086 2087 2088 2089 2090 2091 2092 2093 2094 2095 2096 2097 2098 2099 2100 2101 2102 2103 2104 2105 2106 2107 2108 2109 2110 2111 2112 2113 2114 2115 2116 2117 2118 2119 2120 2121 2122 2123 2124 2125 2126 2127 2128 2129 2130 2131 2132 2133 2134 2135 2136 2137 2138 2139 2140 2141 2142 2143 2144 2145 2146 2147 2148 2149 2150 2151 2152 2153 2154 2155 2156 2157 2158 2159 2160 2161 2162 2163 2164 2165 2166 2167 2168 2169 2170 2171 2172 2173 2174 2175 2176 2177 2178 2179 2180 2181 2182 2183 2184 2185 2186 2187 2188 2189 2190 2191 2192 2193 2194 2195 2196 2197 2198 2199 2200 2201 2202 2203 2204 2205 2206 2207 2208 2209 2210 2211 2212 2213 2214 2215 2216 2217 2218 2219 2220 2221 2222 2223 2224 2225 2226 2227 2228 2229 2230 2231 2232 2233 2234 2235 2236 2237 2238 2239 2240 2241 2242 2243 2244 2245 2246 2247 2248 2249 2250 2251 2252 2253 2254 2255 2256 2257 2258 2259 2260 2261 2262 2263 2264 2265 2266 2267 2268 2269 2270 2271 2272 2273 2274 2275 2276 2277 2278 2279 2280 2281 2282 2283 2284 2285 2286 2287 2288 2289 2290 2291 2292 2293 2294 2295 2296 2297 2298 2299 2300 2301 2302 2303 2304 2305 2306 2307 2308 2309 2310 2311 2312 2313 2314 2315 2316 2317 2318 2319 2320 2321 2322 2323 2324 2325 2326 2327 2328 2329 2330 2331 2332 2333 2334 2335 2336 2337 2338 2339 2340 2341 2342 2343 2344 2345 2346 2347 2348 2349 2350 2351 2352 2353 2354 2355 2356 2357 2358 2359 2360 2361 2362 2363 2364 2365 2366 2367 2368 2369 2370 2371 2372 2373 2374 2375 2376 2377 2378 2379 2380 2381 2382 2383 2384 2385 2386 2387 2388 2389 2390 2391 2392 2393 2394 2395 2396 2397 2398 2399 2400 2401 2402 2403 2404 2405 2406 2407 2408 2409 2410 2411 2412 2413 2414 2415 2416 2417 2418 2419 2420 2421 2422 2423 2424 2425 2426 2427 2428 2429 2430 2431 2432 2433 2434 2435 2436 2437 2438 2439 2440 2441 2442 2443 2444 2445 2446 2447 2448 2449 2450 2451 2452 2453 2454 2455 2456 2457 2458 2459 2460 2461 2462 2463 2464 2465 2466 2467 2468 2469 2470 2471 2472 2473 2474 2475 2476 2477 2478 2479 2480 2481 2482 2483 2484 2485 2486 2487 2488 2489 2490 2491 2492 2493 2494 2495 2496 2497 2498 2499 2500 2501 2502 2503 2504 2505 2506 2507 2508 2509 2510 2511 2512 2513 2514 2515 2516 2517 2518 2519 2520 2521 2522 2523 2524 2525 2526 2527 2528 2529 2530 2531 2532 2533 2534 2535 2536 2537 2538 2539 2540 2541 2542 2543 2544 2545 2546 2547 2548 2549 2550 2551 2552 2553 2554 2555 2556 2557 2558 2559 2560 2561 2562 2563 2564 2565 2566 2567 2568 2569 2570 2571 2572 2573 2574 2575 2576 2577 2578 2579 2580 2581 2582 2583 2584 2585 2586 2587 2588 2589 2590 2591 2592 2593 2594 2595 2596 2597 2598 2599 2600 2601 2602 2603 2604 2605 2606 2607 2608 2609 2610 2611 2612 2613 2614 2615 2616 2617 2618 2619 2620 2621 2622 2623 2624 2625 2626 2627 2628 2629 2630 2631 2632 2633 2634 2635 2636 2637 2638 2639 2640 2641 2642 2643 2644 2645 2646 2647 2648 2649 2650 2651 2652 2653 2654 2655 2656 2657 2658 2659 2660 2661 2662 2663 2664 2665 2666 2667 2668 2669 2670 2671 2672 2673 2674 2675 2676 2677 2678 2679 2680 2681 2682 2683 2684 2685 2686 2687 2688 2689 2690 2691 2692 2693 2694 2695 2696 2697 2698 2699 2700 2701 2702 2703 2704 2705 2706 2707 2708 2709 2710 2711 2712 2713 2714 2715 2716 2717 2718 2719 2720 2721 2722 2723 2724 2725 2726 2727 2728 2729 2730 2731 2732 2733 2734 2735 2736 2737 2738 2739 2740 2741 2742 2743 2744 2745 2746 2747 2748 2749 2750 2751 2752 2753 2754 2755 2756 2757 2758 2759 2760 2761 2762 2763 2764 2765 2766 2767 2768 2769 2770 2771 2772 2773 2774 2775 2776 2777 2778 2779 2780 2781 2782 2783 2784 2785 2786 2787 2788 2789 2790 2791 2792 2793 2794 2795 2796 2797 2798 2799 2800 2801 2802 2803 2804 2805 2806 2807 2808 2809 2810 2811 2812 2813 2814 2815 2816 2817 2818 2819 2820 2821 2822 2823 2824 2825 2826 2827 2828 2829 2830 2831 2832 2833 2834 2835 2836 2837 2838 2839 2840 2841 2842 2843 2844 2845 2846 2847 2848 2849 2850 2851 2852 2853 2854 2855 2856 2857 2858 2859 2860 2861 2862 2863 2864 2865 2866 2867 2868 2869 2870 2871 2872 2873 2874 2875 2876 2877 2878 2879 2880 2881 2882 2883 2884 2885 2886 2887 2888 2889 2890 2891 2892 2893 2894 2895 2896 2897 2898 2899 2900 2901 2902 2903 2904 2905 2906 2907 2908 2909 2910 2911 2912 2913 2914 2915 2916 2917 2918 2919 2920 2921 2922 2923 2924 2925 2926 2927 2928 2929 2930 2931 2932 2933 2934 2935 2936 2937 2938 2939 2940 2941 2942 2943 2944 2945 2946 2947 2948 2949 2950 2951 2952 2953 2954 2955 2956 2957 2958 2959 2960 2961 2962 2963 2964 2965 2966 2967 2968 2969 2970 2971 2972 2973 2974 2975 2976 2977 2978 2979 2980 2981 2982 2983 2984 2985 2986 2987 2988 2989 2990 2991 2992 2993 2994 2995 2996 2997 2998 2999 3000 3001 3002 3003 3004 3005 3006 3007 3008 3009 3010 3011 3012 3013 3014 3015 3016 3017 3018 3019 3020 3021 3022 3023 3024 3025 3026 3027 3028 3029 3030 3031 3032 3033 3034 3035 3036 3037 3038 3039 3040 3041 3042 3043 3044 3045 3046 3047 3048 3049 3050 3051 3052 3053 3054 3055 3056 3057 3058 3059 3060 3061 3062 3063 3064 3065 3066 3067 3068 3069 3070 3071 3072 3073 3074 3075 3076 3077 3078 3079 3080 3081 3082 3083 3084 3085 3086 3087 3088 3089 3090 3091 3092 3093 3094 3095 3096 3097 3098 3099 3100 3101 3102 3103 3104 3105 3106 3107 3108 3109 3110 3111 3112 3113 3114 3115 3116 3117 3118 3119 3120 3121 3122 3123 3124 3125 3126 3127 3128 3129 3130 3131 3132 3133 3134 3135 3136 3137 3138 3139 3140 3141 3142 3143 3144 3145 3146 3147 3148 3149 3150 3151 3152 3153 3154 3155 3156 3157 3158 3159 3160 3161 3162 3163 3164 3165 3166 3167 3168 3169 3170 3171 3172 3173 3174 3175 3176 3177 3178 3179 3180 3181 3182 3183 3184 3185 3186 3187 3188 3189 3190 3191 3192 3193 3194 3195 3196 3197 3198 3199 3200 3201 3202 3203 3204 3205 3206 3207 3208 3209 3210 3211 3212 3213 3214 3215 3216 3217 3218 3219 3220 3221 3222 3223 3224 3225 3226 3227 3228 3229 3230 3231 3232 3233 3234 3235 3236 3237 3238 3239 3240 3241 3242 3243 3244 3245 3246 3247 3248 3249 3250 3251 3252 3253 3254 3255 3256 3257 3258 3259 3260 3261 3262 3263 3264 3265 3266 3267 3268 3269 3270 3271 3272 3273 3274 3275 3276 3277 3278 3279 3280 3281 3282 3283 3284 3285 3286 3287 3288 3289 3290 3291 3292 3293 3294 3295 3296 3297 3298 3299 3300 3301 3302 3303 3304 3305 3306 3307 3308 3309 3310 3311 3312 3313 3314 3315 3316 3317 3318 3319 3320 3321 3322 3323 3324 3325 3326 3327 3328 3329 3330 3331 3332 3333 3334 3335 3336 3337 3338 3339 3340 3341 3342 3343 3344 3345 3346 3347 3348 3349 3350 3351 3352 3353 3354 3355 3356 3357 3358 3359 3360 3361 3362 3363 3364 3365 3366 3367 3368 3369 3370 3371 3372 3373 3374 3375 3376 3377 3378 3379 3380 3381 3382 3383 3384 3385 3386 3387 3388 3389 3390 3391 3392 3393 3394 3395 3396 3397 3398 3399 3400 3401 3402 3403 3404 3405 3406 3407 3408 3409 3410 3411 3412 3413 3414 3415 3416 3417 3418 3419 3420 3421 3422 3423 3424 3425 3426 3427 3428 3429 3430 3431 3432 3433 3434 3435 3436 3437 3438 3439 3440 3441 3442 3443 3444 3445 3446 3447 3448 3449 3450 3451 3452 3453 3454 3455 3456 3457 3458 3459 3460 3461 3462 3463 3464 3465 3466 3467 3468 3469 3470 3471 3472 3473 3474 3475 3476 3477 3478 3479 3480 3481 3482 3483 3484 3485 3486 3487 3488 3489 3490 3491 3492 3493 3494 3495 3496 3497 3498 3499 3500 3501 3502 3503 3504 3505 3506 3507 3508 3509 3510 3511 3512 3513 3514 3515 3516 3517 3518 3519 3520 3521 3522 3523 3524 3525 3526 3527 3528 3529 3530 3531 3532 3533 3534 3535 3536 3537 3538 3539 3540 3541 3542 3543 3544 3545 3546 3547 3548 3549 3550 3551 3552 3553 3554 3555 3556 3557 3558 3559 3560 3561 3562 3563 3564 3565 3566 3567 3568 3569 3570 3571 3572 3573 3574 3575 3576 3577 3578 3579 3580 3581 3582 3583 3584 3585 3586 3587 3588 3589 3590 3591 3592 3593 3594 3595 3596 3597 3598 3599 3600 3601 3602 3603 3604 3605 3606 3607 3608 3609 3610 3611 3612 3613 3614 3615 3616 3617 3618 3619 3620 3621 3622 3623 3624 3625 3626 3627 3628 3629 3630 3631 3632 3633 3634 3635 3636 3637 3638 3639 3640 3641 3642 3643 3644 3645 3646 3647 3648 3649 3650 3651 3652 3653 3654 3655 3656 3657 3658 3659 3660 3661 3662 3663 3664 3665 3666 3667 3668 3669 3670 3671 3672 3673 3674 3675 3676 3677 3678 3679 3680 3681 3682 3683 3684 3685 3686 3687 3688 3689 3690 3691 3692 3693 3694 3695 3696 3697 3698 3699 3700 3701 3702 3703 3704 3705 3706 3707 3708 3709 3710 3711 3712 3713 3714 3715 3716 3717 3718 3719 3720 3721 3722 3723 3724 3725 3726 3727 3728 3729 3730 3731 3732 3733 3734 3735 3736 3737 3738 3739 3740 3741 3742 3743 3744 3745 3746 3747 3748 3749 3750 3751 3752 3753 3754 3755 3756 3757 3758 3759 3760 3761 3762 3763 3764 3765 3766 3767 3768 3769 3770 3771 3772 3773 3774 3775 3776 3777 3778 3779 3780 3781 3782 3783 3784 3785 3786 3787 3788 3789 3790 3791 3792 3793 3794 3795 3796 3797 3798 3799 3800 3801 3802 3803 3804 3805 3806 3807 3808 3809 3810 3811 3812 3813 3814 3815 3816 3817 3818 3819 3820 3821 3822 3823 3824 3825 3826 3827 3828 3829 3830 3831 3832 3833 3834 3835 3836 3837 3838 3839 3840 3841 3842 3843 3844 3845 3846 3847 3848 3849 3850 3851 3852 3853 3854 3855 3856 3857 3858 3859 3860 3861 3862 3863 3864 3865 3866 3867 3868 3869 3870 3871 3872 3873 3874 3875 3876 3877 3878 3879 3880 3881 3882 3883 3884 3885 3886 3887 3888 3889 3890 3891 3892 3893 3894 3895 3896 3897 3898 3899 3900 3901 3902 3903 3904 3905 3906 3907 3908 3909 3910 3911 3912 3913 3914 3915 3916 3917 3918 3919 3920 3921 3922 3923 3924 3925 3926 3927 3928 3929 3930 3931 3932 3933 3934 3935 3936 3937 3938 3939 3940 3941 3942 3943 3944 3945 3946 3947 3948 3949 3950 3951 3952 3953 3954 3955 3956 3957 3958 3959 3960 3961 3962 3963 3964 3965 3966 3967 3968 3969 3970 3971 3972 3973 3974 3975 3976 3977 3978 3979 3980 3981 3982 3983 3984 3985 3986 3987 3988 3989 3990 3991 3992 3993 3994 3995 3996 3997 3998 3999 4000 4001 4002 4003 4004 4005 4006 4007 4008 4009 4010 4011 4012 4013 4014 4015 4016 4017 4018 4019 4020 4021 4022 4023 4024 4025 4026 4027 4028 4029 4030 4031 4032 4033 4034 4035 4036 4037 4038 4039 4040 4041 4042 4043 4044 4045 4046 4047 4048 4049 4050 4051 4052 4053 4054 4055 4056 4057 4058 4059 4060 4061 4062 4063 4064 4065 4066 4067 4068 4069 4070 4071 4072 4073 4074 4075 4076 4077 4078 4079 4080 4081 4082 4083 4084 4085 4086 4087 4088 4089 4090 4091 4092 4093 4094 4095 4096 4097 4098 4099 4100 4101 4102 4103 4104 4105 4106 4107 4108 4109 4110 4111 4112 4113 4114 4115 4116 4117 4118 4119 4120 4121 4122 4123 4124 4125 4126 4127 4128 4129 4130 4131 4132 4133 4134 4135 4136 4137 4138 4139 4140 4141 4142 4143 4144 4145 4146 4147 4148 4149 4150 4151 4152 4153 4154 4155 4156 4157 4158 4159 4160 4161 4162 4163 4164 4165 4166 4167 4168 4169 4170 4171 4172 4173 4174 4175 4176 4177 4178 4179 4180 4181 4182 4183 4184 4185 4186 4187 4188 4189 4190 4191 4192 4193 4194 4195 4196 4197 4198 4199 4200 4201 4202 4203 4204 4205 4206 4207 4208 4209 4210 4211 4212 4213 4214 4215 4216 4217 4218 4219 4220 4221 4222 4223 4224 4225 4226 4227 4228 4229 4230 4231 4232 4233 4234 4235 4236 4237 4238 4239 4240 4241 4242 4243 4244 4245 4246 4247 4248 4249 4250 4251 4252 4253 4254 4255 4256 4257 4258 4259 4260 4261 4262 4263 4264 4265 4266 4267 4268 4269 4270 4271 4272 4273 4274 4275 4276 4277 4278 4279 4280 4281 4282 4283 4284 4285 4286 4287 4288 4289 4290 4291 4292 4293 4294 4295 4296 4297 4298 4299 4300 4301 4302 4303 4304 4305 4306 4307 4308 4309 4310 4311 4312 4313 4314 4315 4316 4317 4318 4319 4320 4321 4322 4323 4324 4325 4326 4327 4328 4329 4330 4331 4332 4333 4334 4335 4336 4337 4338 4339 4340 4341 4342 4343 4344 4345 4346 4347 4348 4349 4350 4351 4352 4353 4354 4355 4356 4357 4358 4359 4360 4361 4362 4363 4364 4365 4366 4367 4368 4369 4370 4371 4372 4373 4374 4375 4376 4377 4378 4379 4380 4381 4382 4383 4384 4385 4386 4387 4388 4389 4390 4391 4392 4393 4394 4395 4396 4397 4398 4399 4400 4401 4402 4403 4404 4405 4406 4407 4408 4409 4410 4411 4412 4413 4414 4415 4416 4417 4418 4419 4420 4421 4422 4423 4424 4425 4426 4427 4428 4429 4430 4431 4432 4433 4434 4435 4436 4437 4438 4439 4440 4441 4442 4443 4444 4445 4446 4447 4448 4449 4450 4451 4452 4453 4454 4455 4456 4457 4458 4459 4460 4461 4462 4463 4464 4465 4466 4467 4468 4469 4470 4471 4472 4473 4474 4475 4476 4477 4478 4479 4480 4481 4482 4483 4484 4485 4486 4487 4488 4489 4490 4491 4492 4493 4494 4495 4496 4497 4498 4499 4500 4501 4502 4503 4504 4505 4506 4507 4508 4509 4510 4511 4512 4513 4514 4515 4516 4517 4518 4519 4520 4521 4522 4523 4524 4525 4526 4527 4528 4529 4530 4531 4532 4533 4534 4535 4536 4537 4538 4539 4540 4541 4542 4543 4544 4545 4546 4547 4548 4549 4550 4551 4552 4553 4554 4555 4556 4557 4558 4559 4560 4561 4562 4563 4564 4565 4566 4567 4568 4569 4570 4571 4572 4573 4574 4575 4576 4577 4578 4579 4580 4581 4582 4583 4584 4585 4586 4587 4588 4589 4590 4591 4592 4593 4594 4595 4596 4597 4598 4599 4600 4601 4602 4603 4604 4605 4606 4607 4608 4609 4610 4611 4612 4613 4614 4615 4616 4617 4618 4619 4620 4621 4622 4623 4624 4625 4626 4627 4628 4629 4630 4631 4632 4633 4634 4635 4636 4637 4638 4639 4640 4641 4642 4643 4644 4645 4646 4647 4648 4649 4650 4651 4652 4653 4654 4655 4656 4657 4658 4659 4660 4661 4662 4663 4664 4665 4666 4667 4668 4669 4670 4671 4672 4673 4674 4675 4676 4677 4678 4679 4680 4681 4682 4683 4684 4685 4686 4687 4688 4689 4690 4691 4692 4693 4694 4695 4696 4697 4698 4699 4700 4701 4702 4703 4704 4705 4706 4707 4708 4709 4710 4711 4712 4713 4714 4715 4716 4717 4718 4719 4720 4721 4722 4723 4724 4725 4726 4727 4728 4729 4730 4731 4732 4733 4734 4735 4736 4737 4738 4739 4740 4741 4742 4743 4744 4745 4746 4747 4748 4749 4750 4751 4752 4753 4754 4755 4756 4757 4758 4759 4760 4761 4762 4763 4764 4765 4766 4767 4768 4769 4770 4771 4772 4773 4774 4775 4776 4777 4778 4779 4780 4781 4782 4783 4784 4785 4786 4787 4788 4789 4790 4791 4792 4793 4794 4795 4796 4797 4798 4799 4800 4801 4802 4803 4804 4805 4806 4807 4808 4809 4810 4811 4812 4813 4814 4815 4816 4817 4818 4819 4820 4821 4822 4823 4824 4825 4826 4827 4828 4829 4830 4831 4832 4833 4834 4835 4836 4837 4838 4839 4840 4841 4842 4843 4844 4845 4846 4847 4848 4849 4850 4851 4852 4853 4854 4855 4856 4857 4858 4859 4860 4861 4862 4863 4864 4865 4866 4867 4868 4869 4870 4871 4872 4873 4874 4875 4876 4877 4878 4879 4880 4881 4882 4883 4884 4885 4886 4887 4888 4889 4890 4891 4892 4893 4894 4895 4896 4897 4898 4899 4900 4901 4902 4903 4904 4905 4906 4907 4908 4909 4910 4911 4912 4913 4914 4915 4916 4917 4918 4919 4920 4921 4922 4923 4924 4925 4926 4927 4928 4929 4930 4931 4932 4933 4934 4935 4936 4937 4938 4939 4940 4941 4942 4943 4944 4945 4946 4947 4948 4949 4950 4951 4952 4953 4954 4955 4956 4957 4958 4959 4960 4961 4962 4963 4964 4965 4966 4967 4968 4969 4970 4971 4972 4973 4974 4975 4976 4977 4978 4979 4980 4981 4982 4983 4984 4985 4986 4987 4988 4989 4990 4991 4992 4993 4994 4995 4996 4997 4998 4999 5000 5001 5002 5003 5004 5005 5006 5007 5008 5009 5010 5011 5012 5013 5014 5015 5016 5017 5018 5019 5020 5021 5022 5023 5024 5025 5026 5027 5028 5029 5030 5031 5032 5033 5034 5035 5036 5037 5038 5039 5040 5041 5042 5043 5044 5045 5046 5047 5048 5049 5050 5051 5052 5053 5054 5055 5056 5057 5058 5059 5060 5061 5062 5063 5064 5065 5066 5067 5068 5069 5070 5071 5072 5073 5074 5075 5076 5077 5078 5079 5080 5081 5082 5083 5084 5085 5086 5087 5088 5089 5090 5091 5092 5093 5094 5095 5096 5097 5098 5099 5100 5101 5102 5103 5104 5105 5106 5107 5108 5109 5110 5111 5112 5113 5114 5115 5116 5117 5118 5119 5120 5121 5122 5123 5124 5125 5126 5127 5128 5129 5130 5131 5132 5133 5134 5135 5136 5137 5138 5139 5140 5141 5142 5143 5144 5145 5146 5147 5148 5149 5150 5151 5152 5153 5154 5155 5156 5157 5158 5159 5160 5161 5162 5163 5164 5165 5166 5167 5168 5169 5170 5171 5172 5173 5174 5175 5176 5177 5178 5179 5180 5181 5182 5183 5184 5185 5186 5187 5188 5189 5190 5191 5192 5193 5194 5195 5196 5197 5198 5199 5200 5201 5202 5203 5204 5205 5206 5207 5208 5209 5210 5211 5212 5213 5214 5215 5216 5217 5218 5219 5220 5221 5222 5223 5224 5225 5226 5227 5228 5229 5230 5231 5232 5233 5234 5235 5236 5237 5238 5239 5240 5241 5242 5243 5244 5245 5246 5247 5248 5249 5250 5251 5252 5253 5254 5255 5256 5257 5258 5259 5260 5261 5262 5263 5264 5265 5266 5267 5268 5269 5270 5271 5272 5273 5274 5275 5276 5277 5278 5279 5280 5281 5282 5283 5284 5285 5286 5287 5288 5289 5290 5291 5292 5293 5294 5295 5296 5297 5298 5299 5300 5301 5302 5303 5304 5305 5306 5307 5308 5309 5310 5311 5312 5313 5314 5315 5316 5317 5318 5319 5320 5321 5322 5323 5324 5325 5326 5327 5328 5329 5330 5331 5332 5333 5334 5335 5336 5337 5338 5339 5340 5341 5342 5343 5344 5345 5346 5347 5348 5349 5350 5351 5352 5353 5354 5355 5356 5357 5358 5359 5360 5361 5362 5363 5364 5365 5366 5367 5368 5369 5370 5371 5372 5373 5374 5375 5376 5377 5378 5379 5380 5381 5382 5383 5384 5385 5386 5387 5388 5389 5390 5391 5392 5393 5394 5395 5396 5397 5398 5399 5400 5401 5402 5403 5404 5405 5406 5407 5408 5409 5410 5411 5412 5413 5414 5415 5416 5417 5418 5419 5420 5421 5422 5423 5424 5425 5426 5427 5428 5429 5430 5431 5432 5433 5434 5435 5436 5437 5438 5439 5440 5441 5442 5443 5444 5445 5446 5447 5448 5449 5450 5451 5452 5453 5454 5455 5456 5457 5458 5459 5460 5461 5462 5463 5464 5465 5466 5467 5468 5469 5470 5471 5472 5473 5474 5475 5476 5477 5478 5479 5480 5481 5482 5483 5484 5485 5486 5487 5488 5489 5490 5491 5492 5493 5494 5495 5496 5497 5498 5499 5500 5501 5502 5503 5504 5505 5506 5507 5508 5509 5510 5511 5512 5513 5514 5515 5516 5517 5518 5519 5520 5521 5522 5523 5524 5525 5526 5527 5528 5529 5530 5531 5532 5533 5534 5535 5536 5537 5538 5539 5540 5541 5542 5543 5544 5545 5546 5547 5548 5549 5550 5551 5552 5553 5554 5555 5556 5557 5558 5559 5560 5561 5562 5563 5564 5565 5566 5567 5568 5569 5570 5571 5572 5573 5574 5575 5576 5577 5578 5579 5580 5581 5582 5583 5584 5585 5586 5587 5588 5589 5590 5591 5592 5593 5594 5595 5596 5597 5598 5599 5600 5601 5602 5603 5604 5605 5606 5607 5608 5609 5610 5611 5612 5613 5614 5615 5616 5617 5618 5619 5620 5621 5622 5623 5624 5625 5626 5627 5628 5629 5630 5631 5632 5633 5634 5635 5636 5637 5638 5639 5640 5641 5642 5643 5644 5645 5646 5647 5648 5649 5650 5651 5652 5653 5654 5655 5656 5657 5658 5659 5660 5661 5662 5663 5664 5665 5666 5667 5668 5669 5670 5671 5672 5673 5674 5675 5676 5677 5678 5679 5680 5681 5682 5683 5684 5685 5686 5687 5688 5689 5690 5691 5692 5693 5694 5695 5696 5697 5698 5699 5700 5701 5702 5703 5704 5705 5706 5707 5708 5709 5710 5711 5712 5713 5714 5715 5716 5717 5718 5719 5720 5721 5722 5723 5724 5725 5726 5727 5728 5729 5730 5731 5732 5733 5734 5735 5736 5737 5738 5739 5740 5741 5742 5743 5744 5745 5746 5747 5748 5749 5750 5751 5752 5753 5754 5755 5756 5757 5758 5759 5760 5761 5762 5763 5764 5765 5766 5767 5768 5769 5770 5771 5772 5773 5774 5775 5776 5777 5778 5779 5780 5781 5782 5783 5784 5785 5786 5787 5788 5789 5790 5791 5792 5793 5794 5795 5796 5797 5798 5799 5800 5801 5802 5803 5804 5805 5806 5807 5808 5809 5810 5811 5812 5813 5814 5815 5816 5817 5818 5819 5820 5821 5822 5823 5824 5825 5826 5827 5828 5829 5830 5831 5832 5833 5834 5835 5836 5837 5838 5839 5840 5841 5842 5843 5844 5845 5846 5847 5848 5849 5850 5851 5852 5853 5854 5855 5856 5857 5858 5859 5860 5861 5862 5863 5864 5865 5866 5867 5868 5869 5870 5871 5872 5873 5874 5875 5876 5877 5878 5879 5880 5881 5882 5883 5884 5885 5886 5887 5888 5889 5890 5891 5892 5893 5894 5895 5896 5897 5898 5899 5900 5901 5902 5903 5904 5905 5906 5907 5908 5909 5910 5911 5912 5913 5914 5915 5916 5917 5918 5919 5920 5921 5922 5923 5924 5925 5926 5927 5928 5929 5930 5931 5932 5933 5934 5935 5936 5937 5938 5939 5940 5941 5942 5943 5944 5945 5946 5947 5948 5949 5950 5951 5952 5953 5954 5955 5956 5957 5958 5959 5960 5961 5962 5963 5964 5965 5966 5967 5968 5969 5970 5971 5972 5973 5974 5975 5976 5977 5978 5979 5980 5981 5982 5983 5984 5985 5986 5987 5988 5989 5990 5991 5992 5993 5994 5995 5996 5997 5998 5999 6000 6001 6002 6003 6004 6005 6006 6007 6008 6009 6010 6011 6012 6013 6014 6015 6016 6017 6018 6019 6020 6021 6022 6023 6024 6025 6026 6027 6028 6029 6030 6031 6032 6033 6034 6035 6036 6037 6038 6039 6040 6041 6042 6043 6044 6045 6046 6047 6048 6049 6050 6051 6052 6053 6054 6055 6056 6057 6058 6059 6060 6061 6062 6063 6064 6065 6066 6067 6068 6069 6070 6071 6072 6073 6074 6075 6076 6077 6078 6079 6080 6081 6082 6083 6084 6085 6086 6087 6088 6089 6090 6091 6092 6093 6094 6095 6096 6097 6098 6099 6100 6101 6102 6103 6104 6105 6106 6107 6108 6109 6110 6111 6112 6113 6114 6115 6116 6117 6118 6119 6120 6121 6122 6123 6124 6125 6126 6127 6128 6129 6130 6131 6132 6133 6134 6135 6136 6137 6138 6139 6140 6141 6142 6143 6144 6145 6146 6147 6148 6149 6150 6151 6152 6153 6154 6155 6156 6157 6158 6159 6160 6161 6162 6163 6164 6165 6166 6167 6168 6169 6170 6171 6172 6173 6174 6175 6176 6177 6178 6179 6180 6181 6182 6183 6184 6185 6186 6187 6188 6189 6190 6191 6192 6193 6194 6195 6196 6197 6198 6199 6200 6201 6202 6203 6204 6205 6206 6207 6208 6209 6210 6211 6212 6213 6214 6215 6216 6217 6218 6219 6220 6221 6222 6223 6224 6225 6226 6227 6228 6229 6230 6231 6232 6233 6234 6235 6236 6237 6238 6239 6240 6241 6242 6243 6244 6245 6246 6247 6248 6249 6250 6251 6252 6253 6254 6255 6256 6257 6258 6259 6260 6261 6262 6263 6264 6265 6266 6267 6268 6269 6270 6271 6272 6273 6274 6275 6276 6277 6278 6279 6280 6281 6282 6283 6284 6285 6286 6287 6288 6289 6290 6291 6292 6293 6294 6295 6296 6297 6298 6299 6300 6301 6302 6303 6304 6305 6306 6307 6308 6309 6310 6311 6312 6313 6314 6315 6316 6317 6318 6319 6320 6321 6322 6323 6324 6325 6326 6327 6328 6329 6330 6331 6332 6333 6334 6335 6336 6337 6338 6339 6340 6341 6342 6343 6344 6345 6346 6347 6348 6349 6350 6351 6352 6353 6354 6355 6356 6357 6358 6359 6360 6361 6362 6363 6364 6365 6366 6367 6368 6369 6370 6371 6372 6373 6374 6375 6376 6377 6378 6379 6380 6381 6382 6383 6384 6385 6386 6387 6388 6389 6390 6391 6392 6393 6394 6395 6396 6397 6398 6399 6400 6401 6402 6403 6404 6405 6406 6407 6408 6409 6410 6411 6412 6413 6414 6415 6416 6417 6418 6419 6420 6421 6422 6423 6424 6425 6426 6427 6428 6429 6430 6431 6432 6433 6434 6435 6436 6437 6438 6439 6440 6441 6442 6443 6444 6445 6446 6447 6448 6449 6450 6451 6452 6453 6454 6455 6456 6457 6458 6459 6460 6461 6462 6463 6464 6465 6466 6467 6468 6469 6470 6471 6472 6473 6474 6475 6476 6477 6478 6479 6480 6481 6482 6483 6484 6485 6486 6487 6488 6489 6490 6491 6492 6493 6494 6495 6496 6497 6498 6499 6500 6501 6502 6503 6504 6505 6506 6507 6508 6509 6510 6511 6512 6513 6514 6515 6516 6517 6518
|
<?php
/**
* PHP parser that converts wiki markup to HTML.
*
* 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
* @ingroup Parser
*/
namespace MediaWiki\Parser;
use BadMethodCallException;
use Exception;
use File;
use HtmlArmor;
use ImageGalleryBase;
use ImageGalleryClassNotFoundException;
use InvalidArgumentException;
use LogicException;
use MapCacheLRU;
use MediaHandler;
use MediaWiki\Cache\CacheKeyHelper;
use MediaWiki\Category\TrackingCategories;
use MediaWiki\Config\ServiceOptions;
use MediaWiki\Content\TextContent;
use MediaWiki\Context\RequestContext;
use MediaWiki\Debug\DeprecationHelper;
use MediaWiki\HookContainer\HookContainer;
use MediaWiki\HookContainer\HookRunner;
use MediaWiki\Html\Html;
use MediaWiki\Http\HttpRequestFactory;
use MediaWiki\Language\ILanguageConverter;
use MediaWiki\Language\Language;
use MediaWiki\Language\LanguageCode;
use MediaWiki\Language\RawMessage;
use MediaWiki\Languages\LanguageConverterFactory;
use MediaWiki\Languages\LanguageNameUtils;
use MediaWiki\Linker\Linker;
use MediaWiki\Linker\LinkRenderer;
use MediaWiki\Linker\LinkRendererFactory;
use MediaWiki\Linker\LinkTarget;
use MediaWiki\MainConfigNames;
use MediaWiki\MediaWikiServices;
use MediaWiki\Message\Message;
use MediaWiki\Output\OutputPage;
use MediaWiki\Page\File\BadFileLookup;
use MediaWiki\Page\PageIdentity;
use MediaWiki\Page\PageReference;
use MediaWiki\Preferences\SignatureValidatorFactory;
use MediaWiki\Request\FauxRequest;
use MediaWiki\Revision\RevisionAccessException;
use MediaWiki\Revision\RevisionRecord;
use MediaWiki\Revision\SlotRecord;
use MediaWiki\SpecialPage\SpecialPage;
use MediaWiki\SpecialPage\SpecialPageFactory;
use MediaWiki\Tidy\TidyDriverBase;
use MediaWiki\Title\MalformedTitleException;
use MediaWiki\Title\MediaWikiTitleCodec;
use MediaWiki\Title\NamespaceInfo;
use MediaWiki\Title\Title;
use MediaWiki\Title\TitleFormatter;
use MediaWiki\User\Options\UserOptionsLookup;
use MediaWiki\User\User;
use MediaWiki\User\UserFactory;
use MediaWiki\User\UserIdentity;
use MediaWiki\User\UserNameUtils;
use MediaWiki\Utils\MWTimestamp;
use MediaWiki\Utils\UrlUtils;
use MediaWiki\Xml\Xml;
use Psr\Log\LoggerInterface;
use RuntimeException;
use SectionProfiler;
use StringUtils;
use UnexpectedValueException;
use Wikimedia\Bcp47Code\Bcp47CodeValue;
use Wikimedia\IPUtils;
use Wikimedia\ObjectCache\WANObjectCache;
use Wikimedia\Parsoid\Core\SectionMetadata;
use Wikimedia\Parsoid\Core\TOCData;
use Wikimedia\Parsoid\DOM\Comment;
use Wikimedia\Parsoid\DOM\DocumentFragment;
use Wikimedia\Parsoid\DOM\Element;
use Wikimedia\Parsoid\DOM\Node;
use Wikimedia\Parsoid\Utils\DOMCompat;
use Wikimedia\Parsoid\Utils\DOMUtils;
use Wikimedia\ScopedCallback;
/**
* @defgroup Parser Parser
*/
/**
* PHP Parser - Processes wiki markup (which uses a more user-friendly
* syntax, such as "[[link]]" for making links), and provides a one-way
* transformation of that wiki markup it into (X)HTML output / markup
* (which in turn the browser understands, and can display).
*
* There are seven main entry points into the Parser class:
*
* - Parser::parse()
* produces HTML output
* - Parser::preSaveTransform()
* produces altered wiki markup
* - Parser::preprocess()
* removes HTML comments and expands templates
* - Parser::cleanSig() and Parser::cleanSigInSig()
* cleans a signature before saving it to preferences
* - Parser::getSection()
* return the content of a section from an article for section editing
* - Parser::replaceSection()
* replaces a section by number inside an article
* - Parser::getPreloadText()
* removes <noinclude> sections and <includeonly> tags
*
* @warning $wgUser or $wgTitle or $wgRequest or $wgLang. Keep them away!
*
* @par Settings:
* $wgNamespacesWithSubpages
*
* @par Settings only within ParserOptions:
* $wgAllowExternalImages
* $wgAllowSpecialInclusion
* $wgInterwikiMagic
* $wgMaxArticleSize
*
* @ingroup Parser
*/
#[\AllowDynamicProperties]
class Parser {
use DeprecationHelper;
# Flags for Parser::setFunctionHook
public const SFH_NO_HASH = 1;
public const SFH_OBJECT_ARGS = 2;
# Constants needed for external link processing
/**
* Everything except bracket, space, or control characters.
* \p{Zs} is unicode 'separator, space' category. It covers the space 0x20
* as well as U+3000 is IDEOGRAPHIC SPACE for T21052.
* \x{FFFD} is the Unicode replacement character, which the HTML5 spec
* uses to replace invalid HTML characters.
*/
public const EXT_LINK_URL_CLASS = '[^][<>"\\x00-\\x20\\x7F\p{Zs}\x{FFFD}]';
/**
* Simplified expression to match an IPv4 or IPv6 address, or
* at least one character of a host name (embeds Parser::EXT_LINK_URL_CLASS)
*/
// phpcs:ignore Generic.Files.LineLength
private const EXT_LINK_ADDR = '(?:[0-9.]+|\\[(?i:[0-9a-f:.]+)\\]|[^][<>"\\x00-\\x20\\x7F\p{Zs}\x{FFFD}])';
/** RegExp to make image URLs (embeds IPv6 part of Parser::EXT_LINK_ADDR) */
// phpcs:ignore Generic.Files.LineLength
private const EXT_IMAGE_REGEX = '/^(http:\/\/|https:\/\/)((?:\\[(?i:[0-9a-f:.]+)\\])?[^][<>"\\x00-\\x20\\x7F\p{Zs}\x{FFFD}]+)
\\/([A-Za-z0-9_.,~%\\-+&;#*?!=()@\\x80-\\xFF]+)\\.((?i)avif|gif|jpg|jpeg|png|svg|webp)$/Sxu';
/** Regular expression for a non-newline space */
private const SPACE_NOT_NL = '(?:\t| |&\#0*160;|&\#[Xx]0*[Aa]0;|\p{Zs})';
/**
* @var int Preprocess wikitext in transclusion mode
* @deprecated Since 1.36
*/
public const PTD_FOR_INCLUSION = Preprocessor::DOM_FOR_INCLUSION;
# Allowed values for $this->mOutputType
/** Output type: like Parser::parse() */
public const OT_HTML = 1;
/** Output type: like Parser::preSaveTransform() */
public const OT_WIKI = 2;
/** Output type: like Parser::preprocess() */
public const OT_PREPROCESS = 3;
/**
* Output type: like Parser::extractSections() - portions of the
* original are returned unchanged.
*/
public const OT_PLAIN = 4;
/**
* @var string Prefix and suffix for temporary replacement strings
* for the multipass parser.
*
* \x7f should never appear in input as it's disallowed in XML.
* Using it at the front also gives us a little extra robustness
* since it shouldn't match when butted up against identifier-like
* string constructs.
*
* Must not consist of all title characters, or else it will change
* the behavior of <nowiki> in a link.
*
* Must have a character that needs escaping in attributes, otherwise
* someone could put a strip marker in an attribute, to get around
* escaping quote marks, and break out of the attribute. Thus we add
* `'".
*/
public const MARKER_SUFFIX = "-QINU`\"'\x7f";
public const MARKER_PREFIX = "\x7f'\"`UNIQ-";
/**
* Internal marker used by parser to track where the table of
* contents should be. Various magic words can change the position
* during the parse. The table of contents is generated during
* the parse, however skins have the final decision on whether the
* table of contents is injected. This placeholder element
* identifies where in the page the table of contents should be
* injected, if at all.
* @var string
* @see Keep this in sync with BlockLevelPass::execute() and
* RemexCompatMunger::isTableOfContentsMarker()
* @internal Skins should *not* directly reference TOC_PLACEHOLDER
* but instead use Parser::replaceTableOfContentsMarker().
*/
public const TOC_PLACEHOLDER = '<meta property="mw:PageProp/toc" />';
/**
* Permissive regexp matching TOC_PLACEHOLDER. This allows for some
* minor modifications to the placeholder to be made by extensions
* without breaking the TOC (T317857); note also that Parsoid's version
* of the placeholder might include additional attributes.
* @var string
*/
private const TOC_PLACEHOLDER_REGEX = '/<meta\\b[^>]*\\bproperty\\s*=\\s*"mw:PageProp\\/toc"[^>]*>/';
# Persistent:
/** @var array<string,callable> */
private array $mTagHooks = [];
/** @var array<string,array{0:callable,1:int}> */
private array $mFunctionHooks = [];
/** @var array{0:array<string,string>,1:array<string,string>} */
private array $mFunctionSynonyms = [ 0 => [], 1 => [] ];
/** @var string[] */
private array $mStripList = [];
/** @var array<string,string> */
private array $mVarCache = [];
/** @var array<string,array<string,string[]>> */
private array $mImageParams = [];
/** @var array<string,MagicWordArray> */
private array $mImageParamsMagicArray = [];
/** @deprecated since 1.35 */
public $mMarkerIndex = 0;
// Initialised by initializeVariables()
/** @var MagicWordArray */
private MagicWordArray $mVariables;
private MagicWordArray $mSubstWords;
// Initialised in constructor
/** @var string */
private string $mExtLinkBracketedRegex;
private UrlUtils $urlUtils;
private Preprocessor $mPreprocessor;
// Cleared with clearState():
/** @var ParserOutput */
private ParserOutput $mOutput;
private int $mAutonumber = 0;
private StripState $mStripState;
private LinkHolderArray $mLinkHolders;
private int $mLinkID = 0;
private array $mIncludeSizes;
/**
* @internal
* @var int
*/
public $mPPNodeCount;
/**
* @internal
* @var int
*/
public $mHighestExpansionDepth;
private array $mTplRedirCache;
/** @internal */
public array $mHeadings;
/** @var array<string,false> */
private array $mDoubleUnderscores;
/**
* Number of expensive parser function calls
* @deprecated since 1.35
*/
public $mExpensiveFunctionCount;
private bool $mShowToc;
private bool $mForceTocPosition;
private array $mTplDomCache;
private ?UserIdentity $mUser;
# Temporary
# These are variables reset at least once per parse regardless of $clearState
/**
* @var ParserOptions|null
* @deprecated since 1.35, use Parser::getOptions()
*/
private $mOptions;
# Deprecated "dynamic" properties
# These used to be dynamic properties added to the parser, but these
# have been deprecated since 1.42.
/** @deprecated since 1.42: T343229 */
public $scribunto_engine;
/** @deprecated since 1.42: T343230 */
public $extCite;
/** @deprecated since 1.42: T343226 */
public $extTemplateStylesCache;
/** @deprecated since 1.42: T357838 */
public $static_tag_buf;
/** @deprecated since 1.42: T203531 */
public $mExtVariables;
/** @deprecated since 1.42: T203532 */
public $mExtArrays;
/** @deprecated since 1.42: T359887 */
public $mExtHashTables;
/** @deprecated since 1.42: T203563 */
public $mExtLoopsCounter;
/** @deprecated since 1.42: T362664 */
public $proofreadRenderingPages;
/** @deprecated since 1.42: T362693 */
public $mTemplatePath;
/**
* Title context, used for self-link rendering and similar things
*
* @deprecated since 1.35, use Parser::getPage()
*/
private Title $mTitle;
/** Output type, one of the OT_xxx constants */
private int $mOutputType;
/**
* Shortcut alias, see Parser::setOutputType()
* @deprecated since 1.35
*/
private array $ot;
/** ID to display in {{REVISIONID}} tags */
private ?int $mRevisionId = null;
/** The timestamp of the specified revision ID */
private ?string $mRevisionTimestamp = null;
/** User to display in {{REVISIONUSER}} tag */
private ?string $mRevisionUser = null;
/** Size to display in {{REVISIONSIZE}} variable */
private ?int $mRevisionSize = null;
/** @var int|false For {{PAGESIZE}} on current page */
private $mInputSize = false;
private ?RevisionRecord $mRevisionRecordObject = null;
/**
* A cache of the current revisions of titles. Keys are $title->getPrefixedDbKey()
*
* @since 1.24
*/
private ?MapCacheLRU $currentRevisionCache = null;
/**
* @var bool|string Recursive call protection.
* @internal
*/
private $mInParse = false;
private SectionProfiler $mProfiler;
private ?LinkRenderer $mLinkRenderer = null;
private MagicWordFactory $magicWordFactory;
private Language $contLang;
private LanguageConverterFactory $languageConverterFactory;
private LanguageNameUtils $languageNameUtils;
private ParserFactory $factory;
private SpecialPageFactory $specialPageFactory;
private TitleFormatter $titleFormatter;
/**
* This is called $svcOptions instead of $options like elsewhere to avoid confusion with
* $mOptions, which is public and widely used, and also with the local variable $options used
* for ParserOptions throughout this file.
*/
private ServiceOptions $svcOptions;
private LinkRendererFactory $linkRendererFactory;
private NamespaceInfo $nsInfo;
private LoggerInterface $logger;
private BadFileLookup $badFileLookup;
private HookContainer $hookContainer;
private HookRunner $hookRunner;
private TidyDriverBase $tidy;
private WANObjectCache $wanCache;
private UserOptionsLookup $userOptionsLookup;
private UserFactory $userFactory;
private HttpRequestFactory $httpRequestFactory;
private TrackingCategories $trackingCategories;
private SignatureValidatorFactory $signatureValidatorFactory;
private UserNameUtils $userNameUtils;
/**
* @internal For use by ServiceWiring
*/
public const CONSTRUCTOR_OPTIONS = [
// See documentation for the corresponding config options
// Many of these are only used in (eg) CoreMagicVariables
MainConfigNames::AllowDisplayTitle,
MainConfigNames::AllowSlowParserFunctions,
MainConfigNames::ArticlePath,
MainConfigNames::EnableScaryTranscluding,
MainConfigNames::ExtraInterlanguageLinkPrefixes,
MainConfigNames::FragmentMode,
MainConfigNames::Localtimezone,
MainConfigNames::MaxSigChars,
MainConfigNames::MaxTocLevel,
MainConfigNames::MiserMode,
MainConfigNames::RawHtml,
MainConfigNames::ScriptPath,
MainConfigNames::Server,
MainConfigNames::ServerName,
MainConfigNames::ShowHostnames,
MainConfigNames::SignatureValidation,
MainConfigNames::Sitename,
MainConfigNames::StylePath,
MainConfigNames::TranscludeCacheExpiry,
MainConfigNames::PreprocessorCacheThreshold,
MainConfigNames::ParserEnableLegacyMediaDOM,
MainConfigNames::EnableParserLimitReporting,
MainConfigNames::ParserEnableUserLanguage,
];
/**
* Constructing parsers directly is not allowed! Use a ParserFactory.
* @internal
*
* @param ServiceOptions $svcOptions
* @param MagicWordFactory $magicWordFactory
* @param Language $contLang Content language
* @param ParserFactory $factory
* @param UrlUtils $urlUtils
* @param SpecialPageFactory $spFactory
* @param LinkRendererFactory $linkRendererFactory
* @param NamespaceInfo $nsInfo
* @param LoggerInterface $logger
* @param BadFileLookup $badFileLookup
* @param LanguageConverterFactory $languageConverterFactory
* @param LanguageNameUtils $languageNameUtils
* @param HookContainer $hookContainer
* @param TidyDriverBase $tidy
* @param WANObjectCache $wanCache
* @param UserOptionsLookup $userOptionsLookup
* @param UserFactory $userFactory
* @param TitleFormatter $titleFormatter
* @param HttpRequestFactory $httpRequestFactory
* @param TrackingCategories $trackingCategories
* @param SignatureValidatorFactory $signatureValidatorFactory
* @param UserNameUtils $userNameUtils
*/
public function __construct(
ServiceOptions $svcOptions,
MagicWordFactory $magicWordFactory,
Language $contLang,
ParserFactory $factory,
UrlUtils $urlUtils,
SpecialPageFactory $spFactory,
LinkRendererFactory $linkRendererFactory,
NamespaceInfo $nsInfo,
LoggerInterface $logger,
BadFileLookup $badFileLookup,
LanguageConverterFactory $languageConverterFactory,
LanguageNameUtils $languageNameUtils,
HookContainer $hookContainer,
TidyDriverBase $tidy,
WANObjectCache $wanCache,
UserOptionsLookup $userOptionsLookup,
UserFactory $userFactory,
TitleFormatter $titleFormatter,
HttpRequestFactory $httpRequestFactory,
TrackingCategories $trackingCategories,
SignatureValidatorFactory $signatureValidatorFactory,
UserNameUtils $userNameUtils
) {
$this->deprecateDynamicPropertiesAccess( '1.42', __CLASS__ );
$this->deprecatePublicProperty( 'ot', '1.35', __CLASS__ );
$this->deprecatePublicProperty( 'mTitle', '1.35', __CLASS__ );
$this->deprecatePublicProperty( 'mOptions', '1.35', __CLASS__ );
if ( ParserFactory::$inParserFactory === 0 ) {
// Direct construction of Parser was deprecated in 1.34 and
// removed in 1.36; use a ParserFactory instead.
throw new BadMethodCallException( 'Direct construction of Parser not allowed' );
}
$svcOptions->assertRequiredOptions( self::CONSTRUCTOR_OPTIONS );
$this->svcOptions = $svcOptions;
$this->urlUtils = $urlUtils;
$this->mExtLinkBracketedRegex = '/\[(((?i)' . $this->urlUtils->validProtocols() . ')' .
self::EXT_LINK_ADDR .
self::EXT_LINK_URL_CLASS . '*)\p{Zs}*([^\]\\x00-\\x08\\x0a-\\x1F\\x{FFFD}]*)\]/Su';
$this->magicWordFactory = $magicWordFactory;
$this->contLang = $contLang;
$this->factory = $factory;
$this->specialPageFactory = $spFactory;
$this->linkRendererFactory = $linkRendererFactory;
$this->nsInfo = $nsInfo;
$this->logger = $logger;
$this->badFileLookup = $badFileLookup;
$this->languageConverterFactory = $languageConverterFactory;
$this->languageNameUtils = $languageNameUtils;
$this->hookContainer = $hookContainer;
$this->hookRunner = new HookRunner( $hookContainer );
$this->tidy = $tidy;
$this->wanCache = $wanCache;
$this->mPreprocessor = new Preprocessor_Hash(
$this,
$this->wanCache,
[
'cacheThreshold' => $svcOptions->get( MainConfigNames::PreprocessorCacheThreshold ),
'disableLangConversion' => $languageConverterFactory->isConversionDisabled(),
]
);
$this->userOptionsLookup = $userOptionsLookup;
$this->userFactory = $userFactory;
$this->titleFormatter = $titleFormatter;
$this->httpRequestFactory = $httpRequestFactory;
$this->trackingCategories = $trackingCategories;
$this->signatureValidatorFactory = $signatureValidatorFactory;
$this->userNameUtils = $userNameUtils;
// These steps used to be done in "::firstCallInit()"
// (if you're chasing a reference from some old code)
CoreParserFunctions::register(
$this,
new ServiceOptions( CoreParserFunctions::REGISTER_OPTIONS, $svcOptions )
);
CoreTagHooks::register(
$this,
new ServiceOptions( CoreTagHooks::REGISTER_OPTIONS, $svcOptions )
);
$this->initializeVariables();
$this->hookRunner->onParserFirstCallInit( $this );
$this->mTitle = Title::makeTitle( NS_SPECIAL, 'Badtitle/Missing' );
}
/**
* Reduce memory usage to reduce the impact of circular references
*/
public function __destruct() {
// @phan-suppress-next-line PhanRedundantCondition Typed property not set in constructor, may be uninitialized
if ( isset( $this->mLinkHolders ) ) {
// @phan-suppress-next-line PhanTypeObjectUnsetDeclaredProperty
unset( $this->mLinkHolders );
}
// @phan-suppress-next-line PhanTypeSuspiciousNonTraversableForeach
foreach ( $this as $name => $value ) {
unset( $this->$name );
}
}
/**
* Allow extensions to clean up when the parser is cloned
*/
public function __clone() {
$this->mInParse = false;
$this->mPreprocessor = clone $this->mPreprocessor;
$this->mPreprocessor->resetParser( $this );
$this->hookRunner->onParserCloned( $this );
}
/**
* Used to do various kinds of initialisation on the first call of the
* parser.
* @deprecated since 1.35, this initialization is done in the constructor
* and manual calls to ::firstCallInit() have no effect.
* @since 1.7
*/
public function firstCallInit() {
/*
* This method should be hard-deprecated once remaining calls are
* removed; it no longer does anything.
*/
}
/**
* Clear Parser state
*
* @internal
*/
public function clearState() {
$this->resetOutput();
$this->mAutonumber = 0;
$this->mLinkHolders = new LinkHolderArray(
$this,
$this->getContentLanguageConverter(),
$this->getHookContainer()
);
$this->mLinkID = 0;
$this->mRevisionTimestamp = null;
$this->mRevisionId = null;
$this->mRevisionUser = null;
$this->mRevisionSize = null;
$this->mRevisionRecordObject = null;
$this->mVarCache = [];
$this->mUser = null;
$this->currentRevisionCache = null;
$this->mStripState = new StripState( $this );
# Clear these on every parse, T6549
$this->mTplRedirCache = [];
$this->mTplDomCache = [];
$this->mShowToc = true;
$this->mForceTocPosition = false;
$this->mIncludeSizes = [
'post-expand' => 0,
'arg' => 0,
];
$this->mPPNodeCount = 0;
$this->mHighestExpansionDepth = 0;
$this->mHeadings = [];
$this->mDoubleUnderscores = [];
$this->mExpensiveFunctionCount = 0;
$this->mProfiler = new SectionProfiler();
$this->hookRunner->onParserClearState( $this );
}
/**
* Reset the ParserOutput
* @since 1.34
*/
public function resetOutput() {
$this->mOutput = new ParserOutput;
$this->mOptions->registerWatcher( [ $this->mOutput, 'recordOption' ] );
}
/**
* Convert wikitext to HTML
* Do not call this function recursively.
*
* @param string $text Text we want to parse
* @param-taint $text escapes_htmlnoent
* @param PageReference $page
* @param ParserOptions $options
* @param bool $linestart
* @param bool $clearState
* @param int|null $revid ID of the revision being rendered. This is used to render
* REVISION* magic words. 0 means that any current revision will be used. Null means
* that {{REVISIONID}}/{{REVISIONUSER}} will be empty and {{REVISIONTIMESTAMP}} will
* use the current timestamp.
* @return ParserOutput
* @return-taint escaped
* @since 1.10 method is public
*/
public function parse(
$text, PageReference $page, ParserOptions $options,
$linestart = true, $clearState = true, $revid = null
) {
if ( $clearState ) {
// We use U+007F DELETE to construct strip markers, so we have to make
// sure that this character does not occur in the input text.
$text = strtr( $text, "\x7f", "?" );
$magicScopeVariable = $this->lock();
}
// Strip U+0000 NULL (T159174)
$text = str_replace( "\000", '', $text );
$this->startParse( $page, $options, self::OT_HTML, $clearState );
$this->currentRevisionCache = null;
$this->mInputSize = strlen( $text );
$this->mOutput->resetParseStartTime();
$oldRevisionId = $this->mRevisionId;
$oldRevisionRecordObject = $this->mRevisionRecordObject;
$oldRevisionTimestamp = $this->mRevisionTimestamp;
$oldRevisionUser = $this->mRevisionUser;
$oldRevisionSize = $this->mRevisionSize;
if ( $revid !== null ) {
$this->mRevisionId = $revid;
$this->mRevisionRecordObject = null;
$this->mRevisionTimestamp = null;
$this->mRevisionUser = null;
$this->mRevisionSize = null;
}
$text = $this->internalParse( $text );
$this->hookRunner->onParserAfterParse( $this, $text, $this->mStripState );
$text = $this->internalParseHalfParsed( $text, true, $linestart );
/**
* A converted title will be provided in the output object if title and
* content conversion are enabled, the article text does not contain
* a conversion-suppressing double-underscore tag, and no
* {{DISPLAYTITLE:...}} is present. DISPLAYTITLE takes precedence over
* automatic link conversion.
*/
if ( !$options->getDisableTitleConversion()
&& !isset( $this->mDoubleUnderscores['nocontentconvert'] )
&& !isset( $this->mDoubleUnderscores['notitleconvert'] )
&& $this->mOutput->getDisplayTitle() === false
) {
$titleText = $this->getTargetLanguageConverter()->getConvRuleTitle();
if ( $titleText !== false ) {
$titleText = Sanitizer::removeSomeTags( $titleText );
} else {
[ $nsText, $nsSeparator, $mainText ] = $this->getTargetLanguageConverter()->convertSplitTitle( $page );
// In the future, those three pieces could be stored separately rather than joined into $titleText,
// and OutputPage would format them and join them together, to resolve T314399.
$titleText = self::formatPageTitle( $nsText, $nsSeparator, $mainText );
}
$this->mOutput->setTitleText( $titleText );
}
# Recording timing info. Must be called before finalizeAdaptiveCacheExpiry() and
# makeLimitReport(), which make use of the timing info.
$this->mOutput->recordTimeProfile();
# Compute runtime adaptive expiry if set
$this->mOutput->finalizeAdaptiveCacheExpiry();
# Warn if too many heavyweight parser functions were used
if ( $this->mExpensiveFunctionCount > $options->getExpensiveParserFunctionLimit() ) {
$this->limitationWarn( 'expensive-parserfunction',
$this->mExpensiveFunctionCount,
$options->getExpensiveParserFunctionLimit()
);
}
# Information on limits, for the benefit of users who try to skirt them
if ( $this->svcOptions->get( MainConfigNames::EnableParserLimitReporting ) ) {
$this->makeLimitReport();
}
$this->mOutput->setFromParserOptions( $options );
$this->mOutput->setRawText( $text );
$this->mRevisionId = $oldRevisionId;
$this->mRevisionRecordObject = $oldRevisionRecordObject;
$this->mRevisionTimestamp = $oldRevisionTimestamp;
$this->mRevisionUser = $oldRevisionUser;
$this->mRevisionSize = $oldRevisionSize;
$this->mInputSize = false;
$this->currentRevisionCache = null;
return $this->mOutput;
}
/**
* Set the limit report data in the current ParserOutput.
*/
protected function makeLimitReport() {
$maxIncludeSize = $this->mOptions->getMaxIncludeSize();
$cpuTime = $this->mOutput->getTimeProfile( 'cpu' );
if ( $cpuTime !== null ) {
$this->mOutput->setLimitReportData( 'limitreport-cputime',
sprintf( "%.3f", $cpuTime )
);
}
$wallTime = $this->mOutput->getTimeProfile( 'wall' );
$this->mOutput->setLimitReportData( 'limitreport-walltime',
sprintf( "%.3f", $wallTime )
);
$this->mOutput->setLimitReportData( 'limitreport-ppvisitednodes',
[ $this->mPPNodeCount, $this->mOptions->getMaxPPNodeCount() ]
);
$this->mOutput->setLimitReportData( 'limitreport-postexpandincludesize',
[ $this->mIncludeSizes['post-expand'], $maxIncludeSize ]
);
$this->mOutput->setLimitReportData( 'limitreport-templateargumentsize',
[ $this->mIncludeSizes['arg'], $maxIncludeSize ]
);
$this->mOutput->setLimitReportData( 'limitreport-expansiondepth',
[ $this->mHighestExpansionDepth, $this->mOptions->getMaxPPExpandDepth() ]
);
$this->mOutput->setLimitReportData( 'limitreport-expensivefunctioncount',
[ $this->mExpensiveFunctionCount, $this->mOptions->getExpensiveParserFunctionLimit() ]
);
foreach ( $this->mStripState->getLimitReport() as [ $key, $value ] ) {
$this->mOutput->setLimitReportData( $key, $value );
}
$this->hookRunner->onParserLimitReportPrepare( $this, $this->mOutput );
// Add on template profiling data in human/machine readable way
$dataByFunc = $this->mProfiler->getFunctionStats();
uasort( $dataByFunc, static function ( $a, $b ) {
return $b['real'] <=> $a['real']; // descending order
} );
$profileReport = [];
foreach ( array_slice( $dataByFunc, 0, 10 ) as $item ) {
$profileReport[] = sprintf( "%6.2f%% %8.3f %6d %s",
$item['%real'], $item['real'], $item['calls'],
htmlspecialchars( $item['name'] ) );
}
$this->mOutput->setLimitReportData( 'limitreport-timingprofile', $profileReport );
// Add other cache related metadata
if ( $this->svcOptions->get( MainConfigNames::ShowHostnames ) ) {
$this->mOutput->setLimitReportData( 'cachereport-origin', wfHostname() );
}
$this->mOutput->setLimitReportData( 'cachereport-timestamp',
$this->mOutput->getCacheTime() );
$this->mOutput->setLimitReportData( 'cachereport-ttl',
$this->mOutput->getCacheExpiry() );
$this->mOutput->setLimitReportData( 'cachereport-transientcontent',
$this->mOutput->hasReducedExpiry() );
}
/**
* Half-parse wikitext to half-parsed HTML. This recursive parser entry point
* can be called from an extension tag hook.
*
* The output of this function IS NOT SAFE PARSED HTML; it is "half-parsed"
* instead, which means that lists and links have not been fully parsed yet,
* and strip markers are still present.
*
* Use recursiveTagParseFully() to fully parse wikitext to output-safe HTML.
*
* Use this function if you're a parser tag hook and you want to parse
* wikitext before or after applying additional transformations, and you
* intend to *return the result as hook output*, which will cause it to go
* through the rest of parsing process automatically.
*
* If $frame is not provided, then template variables (e.g., {{{1}}}) within
* $text are not expanded
*
* @param string $text Text extension wants to have parsed
* @param-taint $text escapes_htmlnoent
* @param PPFrame|false $frame The frame to use for expanding any template variables
* @return string UNSAFE half-parsed HTML
* @return-taint escaped
* @since 1.8
*/
public function recursiveTagParse( $text, $frame = false ) {
$text = $this->internalParse( $text, false, $frame );
return $text;
}
/**
* Fully parse wikitext to fully parsed HTML. This recursive parser entry
* point can be called from an extension tag hook.
*
* The output of this function is fully-parsed HTML that is safe for output.
* If you're a parser tag hook, you might want to use recursiveTagParse()
* instead.
*
* If $frame is not provided, then template variables (e.g., {{{1}}}) within
* $text are not expanded
*
* @since 1.25
*
* @param string $text Text extension wants to have parsed
* @param-taint $text escapes_htmlnoent
* @param PPFrame|false $frame The frame to use for expanding any template variables
* @return string Fully parsed HTML
* @return-taint escaped
*/
public function recursiveTagParseFully( $text, $frame = false ) {
$text = $this->recursiveTagParse( $text, $frame );
$text = $this->internalParseHalfParsed( $text, false );
return $text;
}
/**
* Needed by Parsoid/PHP to ensure all the hooks for extensions
* are run in the right order. The primary differences between this
* and recursiveTagParseFully are:
* (a) absence of $frame
* (b) passing true to internalParseHalfParse so all hooks are run
* (c) running 'ParserAfterParse' hook at the same point in the parsing
* pipeline when parse() does it. This kinda mimics Parsoid/JS behavior
* where exttags are processed by the M/w API.
*
* This is a temporary convenience method and will go away as we proceed
* further with Parsoid <-> Parser.php integration.
*
* @internal
* @deprecated
* @param string $text Wikitext source of the extension
* @return string
* @return-taint escaped
*/
public function parseExtensionTagAsTopLevelDoc( $text ) {
$text = $this->recursiveTagParse( $text );
$this->hookRunner->onParserAfterParse( $this, $text, $this->mStripState );
$text = $this->internalParseHalfParsed( $text, true );
return $text;
}
/**
* Expand templates and variables in the text, producing valid, static wikitext.
* Also removes comments.
* Do not call this function recursively.
* @param string $text
* @param ?PageReference $page
* @param ParserOptions $options
* @param int|null $revid
* @param PPFrame|false $frame
* @return mixed|string
* @since 1.8
*/
public function preprocess(
$text,
?PageReference $page,
ParserOptions $options,
$revid = null,
$frame = false
) {
$magicScopeVariable = $this->lock();
$this->startParse( $page, $options, self::OT_PREPROCESS, true );
if ( $revid !== null ) {
$this->mRevisionId = $revid;
}
$this->hookRunner->onParserBeforePreprocess( $this, $text, $this->mStripState );
$text = $this->replaceVariables( $text, $frame );
$text = $this->mStripState->unstripBoth( $text );
return $text;
}
/**
* Recursive parser entry point that can be called from an extension tag
* hook.
*
* @param string $text Text to be expanded
* @param PPFrame|false $frame The frame to use for expanding any template variables
* @return string
* @since 1.19
*/
public function recursivePreprocess( $text, $frame = false ) {
$text = $this->replaceVariables( $text, $frame );
$text = $this->mStripState->unstripBoth( $text );
return $text;
}
/**
* Process the wikitext for the "?preload=" feature. (T7210)
*
* "<noinclude>", "<includeonly>" etc. are parsed as for template
* transclusion, comments, templates, arguments, tags hooks and parser
* functions are untouched.
*
* @param string $text
* @param PageReference $page
* @param ParserOptions $options
* @param array $params
* @return string
* @since 1.17
*/
public function getPreloadText( $text, PageReference $page, ParserOptions $options, $params = [] ) {
$msg = new RawMessage( $text );
$text = $msg->params( $params )->plain();
# Parser (re)initialisation
$magicScopeVariable = $this->lock();
$this->startParse( $page, $options, self::OT_PLAIN, true );
$flags = PPFrame::NO_ARGS | PPFrame::NO_TEMPLATES;
$dom = $this->preprocessToDom( $text, Preprocessor::DOM_FOR_INCLUSION );
$text = $this->getPreprocessor()->newFrame()->expand( $dom, $flags );
$text = $this->mStripState->unstripBoth( $text );
return $text;
}
/**
* Set the current user.
* Should only be used when doing pre-save transform.
*
* @param UserIdentity|null $user user identity or null (to reset)
* @since 1.17
*/
public function setUser( ?UserIdentity $user ) {
$this->mUser = $user;
}
/**
* Set the context title
*
* @deprecated since 1.37, use setPage() instead.
* @param Title|null $t
* @since 1.12
*/
public function setTitle( ?Title $t = null ) {
$this->setPage( $t );
}
/**
* @since 1.6
* @deprecated since 1.37, use getPage instead.
* @return Title
*/
public function getTitle(): Title {
return $this->mTitle;
}
/**
* Set the page used as context for parsing, e.g. when resolving relative subpage links.
*
* @since 1.37
* @param ?PageReference $t
*/
public function setPage( ?PageReference $t = null ) {
if ( !$t ) {
$t = Title::makeTitle( NS_SPECIAL, 'Badtitle/Parser' );
} else {
// For now (early 1.37 alpha), always convert to Title, so we don't have to do it over
// and over again in other methods. Eventually, we will no longer need to have a Title
// instance internally.
$t = Title::newFromPageReference( $t );
}
if ( $t->hasFragment() ) {
# Strip the fragment to avoid various odd effects
$this->mTitle = $t->createFragmentTarget( '' );
} else {
$this->mTitle = $t;
}
}
/**
* Returns the page used as context for parsing, e.g. when resolving relative subpage links.
* @since 1.37
* @return ?PageReference Null if no page is set (deprecated since 1.34)
*/
public function getPage(): ?PageReference {
if ( $this->mTitle->isSpecial( 'Badtitle' ) ) {
[ , $subPage ] = $this->specialPageFactory->resolveAlias( $this->mTitle->getDBkey() );
if ( $subPage === 'Missing' ) {
wfDeprecated( __METHOD__ . ' without a Title set', '1.34' );
return null;
}
}
return $this->mTitle;
}
/**
* Accessor for the output type.
* @return int One of the Parser::OT_... constants
* @since 1.35
*/
public function getOutputType(): int {
return $this->mOutputType;
}
/**
* Mutator for the output type.
* @param int $ot One of the Parser::OT_… constants
* @since 1.8
*/
public function setOutputType( $ot ): void {
$this->mOutputType = $ot;
# Shortcut alias
$this->ot = [
'html' => $ot == self::OT_HTML,
'wiki' => $ot == self::OT_WIKI,
'pre' => $ot == self::OT_PREPROCESS,
'plain' => $ot == self::OT_PLAIN,
];
}
/**
* Accessor/mutator for the output type
*
* @param int|null $x New value or null to just get the current one
* @return int
* @deprecated since 1.35, use getOutputType()/setOutputType()
*/
public function OutputType( $x = null ) {
wfDeprecated( __METHOD__, '1.35' );
return wfSetVar( $this->mOutputType, $x );
}
/**
* @return ParserOutput
* @since 1.14
*/
public function getOutput() {
// @phan-suppress-next-line PhanRedundantCondition False positive, see https://github.com/phan/phan/issues/4720
if ( !isset( $this->mOutput ) ) {
wfDeprecated( __METHOD__ . ' before initialization', '1.42' );
// @phan-suppress-next-line PhanTypeMismatchReturnProbablyReal We don’t want to tell anyone we’re doing this
return null;
}
return $this->mOutput;
}
/**
* @return ParserOptions|null
* @since 1.6
*/
public function getOptions() {
return $this->mOptions;
}
/**
* Mutator for the ParserOptions object
* @param ParserOptions $options The new parser options
* @since 1.35
*/
public function setOptions( ParserOptions $options ): void {
$this->mOptions = $options;
}
/**
* Accessor/mutator for the ParserOptions object
*
* @param ParserOptions|null $x New value or null to just get the current one
* @return ParserOptions Current ParserOptions object
* @deprecated since 1.35, use getOptions() / setOptions()
*/
public function Options( $x = null ) {
wfDeprecated( __METHOD__, '1.35' );
return wfSetVar( $this->mOptions, $x );
}
/**
* @return int
* @since 1.14
*/
public function nextLinkID() {
return $this->mLinkID++;
}
/**
* @param int $id
* @since 1.8
*/
public function setLinkID( $id ) {
$this->mLinkID = $id;
}
/**
* Get a language object for use in parser functions such as {{FORMATNUM:}}
* @return Language
* @since 1.7
* @deprecated since 1.40; use ::getTargetLanguage() instead.
*/
public function getFunctionLang() {
wfDeprecated( __METHOD__, '1.40' );
return $this->getTargetLanguage();
}
/**
* Get the target language for the content being parsed. This is usually the
* language that the content is in.
*
* @since 1.19
*
* @return Language
*/
public function getTargetLanguage() {
$target = $this->mOptions->getTargetLanguage();
if ( $target !== null ) {
return $target;
} elseif ( $this->mOptions->getInterfaceMessage() ) {
return $this->mOptions->getUserLangObj();
}
return $this->getTitle()->getPageLanguage();
}
/**
* Get a user either from the user set on Parser if it's set,
* or from the ParserOptions object otherwise.
*
* @since 1.36
* @return UserIdentity
*/
public function getUserIdentity(): UserIdentity {
return $this->mUser ?? $this->getOptions()->getUserIdentity();
}
/**
* Get a preprocessor object
*
* @return Preprocessor
* @since 1.12.0
*/
public function getPreprocessor() {
return $this->mPreprocessor;
}
/**
* Get a LinkRenderer instance to make links with
*
* @since 1.28
* @return LinkRenderer
*/
public function getLinkRenderer() {
// XXX We make the LinkRenderer with current options and then cache it forever
if ( !$this->mLinkRenderer ) {
$this->mLinkRenderer = $this->linkRendererFactory->create();
}
return $this->mLinkRenderer;
}
/**
* Get the MagicWordFactory that this Parser is using
*
* @since 1.32
* @return MagicWordFactory
*/
public function getMagicWordFactory() {
return $this->magicWordFactory;
}
/**
* Get the content language that this Parser is using
*
* @since 1.32
* @return Language
*/
public function getContentLanguage() {
return $this->contLang;
}
/**
* Get the BadFileLookup instance that this Parser is using
*
* @since 1.35
* @return BadFileLookup
*/
public function getBadFileLookup() {
return $this->badFileLookup;
}
/**
* Replaces all occurrences of HTML-style comments and the given tags
* in the text with a random marker and returns the next text. The output
* parameter $matches will be an associative array filled with data in
* the form:
*
* @code
* 'UNIQ-xxxxx' => [
* 'element',
* 'tag content',
* [ 'param' => 'x' ],
* '<element param="x">tag content</element>' ]
* @endcode
*
* @param string[] $elements List of element names. Comments are always extracted.
* @param string $text Source text string.
* @param array[] &$matches Out parameter, Array: extracted tags
* @return string Stripped text
*/
public static function extractTagsAndParams( array $elements, $text, &$matches ) {
static $n = 1;
$stripped = '';
$matches = [];
$taglist = implode( '|', $elements );
$start = "/<($taglist)(\\s+[^>]*?|\\s*?)(\/?>)|<(!--)/i";
while ( $text != '' ) {
$p = preg_split( $start, $text, 2, PREG_SPLIT_DELIM_CAPTURE );
$stripped .= $p[0];
if ( count( $p ) < 5 ) {
break;
}
if ( count( $p ) > 5 ) {
# comment
$element = $p[4];
$attributes = '';
$close = '';
$inside = $p[5];
} else {
# tag
[ , $element, $attributes, $close, $inside ] = $p;
}
$marker = self::MARKER_PREFIX . "-$element-" . sprintf( '%08X', $n++ ) . self::MARKER_SUFFIX;
$stripped .= $marker;
if ( $close === '/>' ) {
# Empty element tag, <tag />
$content = null;
$text = $inside;
$tail = null;
} else {
if ( $element === '!--' ) {
$end = '/(-->)/';
} else {
$end = "/(<\\/$element\\s*>)/i";
}
$q = preg_split( $end, $inside, 2, PREG_SPLIT_DELIM_CAPTURE );
$content = $q[0];
if ( count( $q ) < 3 ) {
# No end tag -- let it run out to the end of the text.
$tail = '';
$text = '';
} else {
[ , $tail, $text ] = $q;
}
}
$matches[$marker] = [ $element,
$content,
Sanitizer::decodeTagAttributes( $attributes ),
"<$element$attributes$close$content$tail" ];
}
return $stripped;
}
/**
* Get a list of strippable XML-like elements
*
* @return array
*/
public function getStripList() {
return $this->mStripList;
}
/**
* @return StripState
* @since 1.34
*/
public function getStripState() {
return $this->mStripState;
}
/**
* Add an item to the strip state
* Returns the unique tag which must be inserted into the stripped text
* The tag will be replaced with the original text in unstrip()
*
* @param string $text
*
* @return string
*/
public function insertStripItem( $text ) {
$marker = self::MARKER_PREFIX . "-item-{$this->mMarkerIndex}-" . self::MARKER_SUFFIX;
$this->mMarkerIndex++;
$this->mStripState->addGeneral( $marker, $text );
return $marker;
}
/**
* Parse the wiki syntax used to render tables.
*
* @param string $text
* @return string
*/
private function handleTables( $text ) {
$lines = StringUtils::explode( "\n", $text );
$out = '';
$td_history = []; # Is currently a td tag open?
$last_tag_history = []; # Save history of last lag activated (td, th or caption)
$tr_history = []; # Is currently a tr tag open?
$tr_attributes = []; # history of tr attributes
$has_opened_tr = []; # Did this table open a <tr> element?
$indent_level = 0; # indent level of the table
foreach ( $lines as $outLine ) {
$line = trim( $outLine );
if ( $line === '' ) { # empty line, go to next line
$out .= $outLine . "\n";
continue;
}
$first_character = $line[0];
$first_two = substr( $line, 0, 2 );
$matches = [];
if ( preg_match( '/^(:*)\s*\{\|(.*)$/', $line, $matches ) ) {
# First check if we are starting a new table
$indent_level = strlen( $matches[1] );
$attributes = $this->mStripState->unstripBoth( $matches[2] );
$attributes = Sanitizer::fixTagAttributes( $attributes, 'table' );
$outLine = str_repeat( '<dl><dd>', $indent_level ) . "<table{$attributes}>";
$td_history[] = false;
$last_tag_history[] = '';
$tr_history[] = false;
$tr_attributes[] = '';
$has_opened_tr[] = false;
} elseif ( count( $td_history ) == 0 ) {
# Don't do any of the following
$out .= $outLine . "\n";
continue;
} elseif ( $first_two === '|}' ) {
# We are ending a table
$line = '</table>' . substr( $line, 2 );
$last_tag = array_pop( $last_tag_history );
if ( !array_pop( $has_opened_tr ) ) {
$line = "<tr><td></td></tr>{$line}";
}
if ( array_pop( $tr_history ) ) {
$line = "</tr>{$line}";
}
if ( array_pop( $td_history ) ) {
$line = "</{$last_tag}>{$line}";
}
array_pop( $tr_attributes );
if ( $indent_level > 0 ) {
$outLine = rtrim( $line ) . str_repeat( '</dd></dl>', $indent_level );
} else {
$outLine = $line;
}
} elseif ( $first_two === '|-' ) {
# Now we have a table row
$line = preg_replace( '#^\|-+#', '', $line );
# Whats after the tag is now only attributes
$attributes = $this->mStripState->unstripBoth( $line );
$attributes = Sanitizer::fixTagAttributes( $attributes, 'tr' );
array_pop( $tr_attributes );
$tr_attributes[] = $attributes;
$line = '';
$last_tag = array_pop( $last_tag_history );
array_pop( $has_opened_tr );
$has_opened_tr[] = true;
if ( array_pop( $tr_history ) ) {
$line = '</tr>';
}
if ( array_pop( $td_history ) ) {
$line = "</{$last_tag}>{$line}";
}
$outLine = $line;
$tr_history[] = false;
$td_history[] = false;
$last_tag_history[] = '';
} elseif ( $first_character === '|'
|| $first_character === '!'
|| $first_two === '|+'
) {
# This might be cell elements, td, th or captions
if ( $first_two === '|+' ) {
$first_character = '+';
$line = substr( $line, 2 );
} else {
$line = substr( $line, 1 );
}
// Implies both are valid for table headings.
if ( $first_character === '!' ) {
$line = StringUtils::replaceMarkup( '!!', '||', $line );
}
# Split up multiple cells on the same line.
# FIXME : This can result in improper nesting of tags processed
# by earlier parser steps.
$cells = explode( '||', $line );
$outLine = '';
# Loop through each table cell
foreach ( $cells as $cell ) {
$previous = '';
if ( $first_character !== '+' ) {
$tr_after = array_pop( $tr_attributes );
if ( !array_pop( $tr_history ) ) {
$previous = "<tr{$tr_after}>\n";
}
$tr_history[] = true;
$tr_attributes[] = '';
array_pop( $has_opened_tr );
$has_opened_tr[] = true;
}
$last_tag = array_pop( $last_tag_history );
if ( array_pop( $td_history ) ) {
$previous = "</{$last_tag}>\n{$previous}";
}
if ( $first_character === '|' ) {
$last_tag = 'td';
} elseif ( $first_character === '!' ) {
$last_tag = 'th';
} elseif ( $first_character === '+' ) {
$last_tag = 'caption';
} else {
$last_tag = '';
}
$last_tag_history[] = $last_tag;
# A cell could contain both parameters and data
$cell_data = explode( '|', $cell, 2 );
# T2553: Note that a '|' inside an invalid link should not
# be mistaken as delimiting cell parameters
# Bug T153140: Neither should language converter markup.
if ( preg_match( '/\[\[|-\{/', $cell_data[0] ) === 1 ) {
$cell = "{$previous}<{$last_tag}>" . trim( $cell );
} elseif ( count( $cell_data ) == 1 ) {
// Whitespace in cells is trimmed
$cell = "{$previous}<{$last_tag}>" . trim( $cell_data[0] );
} else {
$attributes = $this->mStripState->unstripBoth( $cell_data[0] );
$attributes = Sanitizer::fixTagAttributes( $attributes, $last_tag );
// Whitespace in cells is trimmed
$cell = "{$previous}<{$last_tag}{$attributes}>" . trim( $cell_data[1] );
}
$outLine .= $cell;
$td_history[] = true;
}
}
$out .= $outLine . "\n";
}
# Closing open td, tr && table
while ( count( $td_history ) > 0 ) {
if ( array_pop( $td_history ) ) {
$out .= "</td>\n";
}
if ( array_pop( $tr_history ) ) {
$out .= "</tr>\n";
}
if ( !array_pop( $has_opened_tr ) ) {
$out .= "<tr><td></td></tr>\n";
}
$out .= "</table>\n";
}
# Remove trailing line-ending (b/c)
if ( substr( $out, -1 ) === "\n" ) {
$out = substr( $out, 0, -1 );
}
# special case: don't return empty table
if ( $out === "<table>\n<tr><td></td></tr>\n</table>" ) {
$out = '';
}
return $out;
}
/**
* Helper function for parse() that transforms wiki markup into half-parsed
* HTML. Only called for $mOutputType == self::OT_HTML.
*
* @internal
*
* @param string $text The text to parse
* @param-taint $text escapes_html
* @param bool $isMain Whether this is being called from the main parse() function
* @param PPFrame|false $frame A pre-processor frame
*
* @return string
*/
public function internalParse( $text, $isMain = true, $frame = false ) {
$origText = $text;
# Hook to suspend the parser in this state
if ( !$this->hookRunner->onParserBeforeInternalParse( $this, $text, $this->mStripState ) ) {
return $text;
}
# if $frame is provided, then use $frame for replacing any variables
if ( $frame ) {
# use frame depth to infer how include/noinclude tags should be handled
# depth=0 means this is the top-level document; otherwise it's an included document
if ( !$frame->depth ) {
$flag = 0;
} else {
$flag = Preprocessor::DOM_FOR_INCLUSION;
}
$dom = $this->preprocessToDom( $text, $flag );
$text = $frame->expand( $dom );
} else {
# if $frame is not provided, then use old-style replaceVariables
$text = $this->replaceVariables( $text );
}
$text = Sanitizer::internalRemoveHtmlTags(
$text,
// Callback from the Sanitizer for expanding items found in
// HTML attribute values, so they can be safely tested and escaped.
function ( &$text, $frame = false ) {
$text = $this->replaceVariables( $text, $frame );
$text = $this->mStripState->unstripBoth( $text );
},
false,
[],
[]
);
$this->hookRunner->onInternalParseBeforeLinks( $this, $text, $this->mStripState );
# Tables need to come after variable replacement for things to work
# properly; putting them before other transformations should keep
# exciting things like link expansions from showing up in surprising
# places.
$text = $this->handleTables( $text );
$text = preg_replace( '/(^|\n)-----*/', '\\1<hr />', $text );
$text = $this->handleDoubleUnderscore( $text );
$text = $this->handleHeadings( $text );
$text = $this->handleInternalLinks( $text );
$text = $this->handleAllQuotes( $text );
$text = $this->handleExternalLinks( $text );
# handleInternalLinks may sometimes leave behind
# absolute URLs, which have to be masked to hide them from handleExternalLinks
$text = str_replace( self::MARKER_PREFIX . 'NOPARSE', '', $text );
$text = $this->handleMagicLinks( $text );
$text = $this->finalizeHeadings( $text, $origText, $isMain );
return $text;
}
/**
* Shorthand for getting a Language Converter for Target language
*
* @since public since 1.38
* @return ILanguageConverter
*/
public function getTargetLanguageConverter(): ILanguageConverter {
return $this->languageConverterFactory->getLanguageConverter(
$this->getTargetLanguage()
);
}
/**
* Shorthand for getting a Language Converter for Content language
*
* @return ILanguageConverter
*/
private function getContentLanguageConverter(): ILanguageConverter {
return $this->languageConverterFactory->getLanguageConverter(
$this->getContentLanguage()
);
}
/**
* Get a HookContainer capable of returning metadata about hooks or running
* extension hooks.
*
* @since 1.35
* @return HookContainer
*/
protected function getHookContainer() {
return $this->hookContainer;
}
/**
* Get a HookRunner for calling core hooks
*
* @internal This is for use by core only. Hook interfaces may be removed
* without notice.
* @since 1.35
* @return HookRunner
*/
protected function getHookRunner() {
return $this->hookRunner;
}
/**
* Helper function for parse() that transforms half-parsed HTML into fully
* parsed HTML.
*
* @param string $text
* @param bool $isMain
* @param bool $linestart
* @return string
*/
private function internalParseHalfParsed( $text, $isMain = true, $linestart = true ) {
$text = $this->mStripState->unstripGeneral( $text );
$text = BlockLevelPass::doBlockLevels( $text, $linestart );
$this->replaceLinkHoldersPrivate( $text );
/**
* The input doesn't get language converted if
* a) It's disabled
* b) Content isn't converted
* c) It's a conversion table
* d) it is an interface message (which is in the user language)
*/
$converter = null;
if ( !( $this->mOptions->getDisableContentConversion()
|| isset( $this->mDoubleUnderscores['nocontentconvert'] )
|| $this->mOptions->getInterfaceMessage() )
) {
# The position of the convert() call should not be changed. it
# assumes that the links are all replaced and the only thing left
# is the <nowiki> mark.
$converter = $this->getTargetLanguageConverter();
$text = $converter->convert( $text );
// TOC will be converted below.
}
// Convert the TOC. This is done *after* the main text
// so that all the editor-defined conversion rules (by convention
// defined at the start of the article) are applied to the TOC
self::localizeTOC(
$this->mOutput->getTOCData(),
$this->getTargetLanguage(),
$converter // null if conversion is to be suppressed.
);
if ( $converter ) {
$this->mOutput->setLanguage( new Bcp47CodeValue(
LanguageCode::bcp47( $converter->getPreferredVariant() )
) );
} else {
$this->mOutput->setLanguage( $this->getTargetLanguage() );
}
$text = $this->mStripState->unstripNoWiki( $text );
$text = $this->mStripState->unstripGeneral( $text );
$text = $this->tidy->tidy( $text, [ Sanitizer::class, 'armorFrenchSpaces' ] );
if ( $isMain ) {
$this->hookRunner->onParserAfterTidy( $this, $text );
}
return $text;
}
/**
* Replace special strings like "ISBN xxx" and "RFC xxx" with
* magic external links.
*
* DML
*
* @param string $text
*
* @return string
*/
private function handleMagicLinks( $text ) {
$prots = $this->urlUtils->validAbsoluteProtocols();
$urlChar = self::EXT_LINK_URL_CLASS;
$addr = self::EXT_LINK_ADDR;
$space = self::SPACE_NOT_NL; # non-newline space
$spdash = "(?:-|$space)"; # a dash or a non-newline space
$spaces = "$space++"; # possessive match of 1 or more spaces
$text = preg_replace_callback(
'!(?: # Start cases
(<a[ \t\r\n>].*?</a>) | # m[1]: Skip link text
(<.*?>) | # m[2]: Skip stuff inside HTML elements' . "
(\b # m[3]: Free external links
(?i:$prots)
($addr$urlChar*) # m[4]: Post-protocol path
) |
\b(?:RFC|PMID) $spaces # m[5]: RFC or PMID, capture number
([0-9]+)\b |
\bISBN $spaces ( # m[6]: ISBN, capture number
(?: 97[89] $spdash? )? # optional 13-digit ISBN prefix
(?: [0-9] $spdash? ){9} # 9 digits with opt. delimiters
[0-9Xx] # check digit
)\b
)!xu",
[ $this, 'magicLinkCallback' ],
$text
);
return $text;
}
/**
* @param array $m
* @return string HTML
*/
private function magicLinkCallback( array $m ) {
if ( isset( $m[1] ) && $m[1] !== '' ) {
# Skip anchor
return $m[0];
} elseif ( isset( $m[2] ) && $m[2] !== '' ) {
# Skip HTML element
return $m[0];
} elseif ( isset( $m[3] ) && $m[3] !== '' ) {
# Free external link
return $this->makeFreeExternalLink( $m[0], strlen( $m[4] ) );
} elseif ( isset( $m[5] ) && $m[5] !== '' ) {
# RFC or PMID
if ( substr( $m[0], 0, 3 ) === 'RFC' ) {
if ( !$this->mOptions->getMagicRFCLinks() ) {
return $m[0];
}
$keyword = 'RFC';
$urlmsg = 'rfcurl';
$cssClass = 'mw-magiclink-rfc';
$trackingCat = 'magiclink-tracking-rfc';
$id = $m[5];
} elseif ( substr( $m[0], 0, 4 ) === 'PMID' ) {
if ( !$this->mOptions->getMagicPMIDLinks() ) {
return $m[0];
}
$keyword = 'PMID';
$urlmsg = 'pubmedurl';
$cssClass = 'mw-magiclink-pmid';
$trackingCat = 'magiclink-tracking-pmid';
$id = $m[5];
} else {
// Should never happen
throw new UnexpectedValueException( __METHOD__ . ': unrecognised match type "' .
substr( $m[0], 0, 20 ) . '"' );
}
$url = wfMessage( $urlmsg, $id )->inContentLanguage()->text();
$this->addTrackingCategory( $trackingCat );
return $this->getLinkRenderer()->makeExternalLink(
$url,
"{$keyword} {$id}",
$this->getTitle(),
$cssClass,
[]
);
} elseif ( isset( $m[6] ) && $m[6] !== ''
&& $this->mOptions->getMagicISBNLinks()
) {
# ISBN
$isbn = $m[6];
$space = self::SPACE_NOT_NL; # non-newline space
$isbn = preg_replace( "/$space/", ' ', $isbn );
$num = strtr( $isbn, [
'-' => '',
' ' => '',
'x' => 'X',
] );
$this->addTrackingCategory( 'magiclink-tracking-isbn' );
return $this->getLinkRenderer()->makeKnownLink(
SpecialPage::getTitleFor( 'Booksources', $num ),
"ISBN $isbn",
[
'class' => 'internal mw-magiclink-isbn',
'title' => false // suppress title attribute
]
);
} else {
return $m[0];
}
}
/**
* Make a free external link, given a user-supplied URL
*
* @param string $url
* @param int $numPostProto
* The number of characters after the protocol.
* @return string HTML
* @internal
*/
private function makeFreeExternalLink( $url, $numPostProto ) {
$trail = '';
# The characters '<' and '>' (which were escaped by
# internalRemoveHtmlTags()) should not be included in
# URLs, per RFC 2396.
# Make terminate a URL as well (bug T84937)
$m2 = [];
if ( preg_match(
'/&(lt|gt|nbsp|#x0*(3[CcEe]|[Aa]0)|#0*(60|62|160));/',
$url,
$m2,
PREG_OFFSET_CAPTURE
) ) {
$trail = substr( $url, $m2[0][1] ) . $trail;
$url = substr( $url, 0, $m2[0][1] );
}
# Move trailing punctuation to $trail
$sep = ',;\.:!?';
# If there is no left bracket, then consider right brackets fair game too
if ( strpos( $url, '(' ) === false ) {
$sep .= ')';
}
$urlRev = strrev( $url );
$numSepChars = strspn( $urlRev, $sep );
# Don't break a trailing HTML entity by moving the ; into $trail
# This is in hot code, so use substr_compare to avoid having to
# create a new string object for the comparison
if ( $numSepChars && substr_compare( $url, ";", -$numSepChars, 1 ) === 0 ) {
# more optimization: instead of running preg_match with a $
# anchor, which can be slow, do the match on the reversed
# string starting at the desired offset.
# un-reversed regexp is: /&([a-z]+|#x[\da-f]+|#\d+)$/i
if ( preg_match( '/\G([a-z]+|[\da-f]+x#|\d+#)&/i', $urlRev, $m2, 0, $numSepChars ) ) {
$numSepChars--;
}
}
if ( $numSepChars ) {
$trail = substr( $url, -$numSepChars ) . $trail;
$url = substr( $url, 0, -$numSepChars );
}
# Verify that we still have a real URL after trail removal, and
# not just lone protocol
if ( strlen( $trail ) >= $numPostProto ) {
return $url . $trail;
}
$url = Sanitizer::cleanUrl( $url );
# Is this an external image?
$text = $this->maybeMakeExternalImage( $url );
if ( $text === false ) {
# Not an image, make a link
$text = $this->getLinkRenderer()->makeExternalLink(
$url,
$this->getTargetLanguageConverter()->markNoConversion( $url ),
$this->getTitle(),
'free',
$this->getExternalLinkAttribs( $url )
);
# Register it in the output object...
$this->mOutput->addExternalLink( $url );
}
return $text . $trail;
}
/**
* Parse headers and return html
*
* @param string $text
* @return string
*/
private function handleHeadings( $text ) {
for ( $i = 6; $i >= 1; --$i ) {
$h = str_repeat( '=', $i );
// Trim non-newline whitespace from headings
// Using \s* will break for: "==\n===\n" and parse as <h2>=</h2>
$text = preg_replace( "/^(?:$h)[ \\t]*(.+?)[ \\t]*(?:$h)\\s*$/m", "<h$i>\\1</h$i>", $text );
}
return $text;
}
/**
* Replace single quotes with HTML markup
*
* @param string $text
*
* @return string The altered text
*/
private function handleAllQuotes( $text ) {
$outtext = '';
$lines = StringUtils::explode( "\n", $text );
foreach ( $lines as $line ) {
$outtext .= $this->doQuotes( $line ) . "\n";
}
$outtext = substr( $outtext, 0, -1 );
return $outtext;
}
/**
* Helper function for handleAllQuotes()
*
* @param string $text
*
* @return string
* @internal
*/
public function doQuotes( $text ) {
$arr = preg_split( "/(''+)/", $text, -1, PREG_SPLIT_DELIM_CAPTURE );
$countarr = count( $arr );
if ( $countarr == 1 ) {
return $text;
}
// First, do some preliminary work. This may shift some apostrophes from
// being mark-up to being text. It also counts the number of occurrences
// of bold and italics mark-ups.
$numbold = 0;
$numitalics = 0;
for ( $i = 1; $i < $countarr; $i += 2 ) {
$thislen = strlen( $arr[$i] );
// If there are ever four apostrophes, assume the first is supposed to
// be text, and the remaining three constitute mark-up for bold text.
// (T15227: ''''foo'''' turns into ' ''' foo ' ''')
if ( $thislen == 4 ) {
$arr[$i - 1] .= "'";
$arr[$i] = "'''";
$thislen = 3;
} elseif ( $thislen > 5 ) {
// If there are more than 5 apostrophes in a row, assume they're all
// text except for the last 5.
// (T15227: ''''''foo'''''' turns into ' ''''' foo ' ''''')
$arr[$i - 1] .= str_repeat( "'", $thislen - 5 );
$arr[$i] = "'''''";
$thislen = 5;
}
// Count the number of occurrences of bold and italics mark-ups.
if ( $thislen == 2 ) {
$numitalics++;
} elseif ( $thislen == 3 ) {
$numbold++;
} elseif ( $thislen == 5 ) {
$numitalics++;
$numbold++;
}
}
// If there is an odd number of both bold and italics, it is likely
// that one of the bold ones was meant to be an apostrophe followed
// by italics. Which one we cannot know for certain, but it is more
// likely to be one that has a single-letter word before it.
if ( ( $numbold % 2 == 1 ) && ( $numitalics % 2 == 1 ) ) {
$firstsingleletterword = -1;
$firstmultiletterword = -1;
$firstspace = -1;
for ( $i = 1; $i < $countarr; $i += 2 ) {
if ( strlen( $arr[$i] ) == 3 ) {
$x1 = substr( $arr[$i - 1], -1 );
$x2 = substr( $arr[$i - 1], -2, 1 );
if ( $x1 === ' ' ) {
if ( $firstspace == -1 ) {
$firstspace = $i;
}
} elseif ( $x2 === ' ' ) {
$firstsingleletterword = $i;
// if $firstsingleletterword is set, we don't
// look at the other options, so we can bail early.
break;
} elseif ( $firstmultiletterword == -1 ) {
$firstmultiletterword = $i;
}
}
}
// If there is a single-letter word, use it!
if ( $firstsingleletterword > -1 ) {
$arr[$firstsingleletterword] = "''";
$arr[$firstsingleletterword - 1] .= "'";
} elseif ( $firstmultiletterword > -1 ) {
// If not, but there's a multi-letter word, use that one.
$arr[$firstmultiletterword] = "''";
$arr[$firstmultiletterword - 1] .= "'";
} elseif ( $firstspace > -1 ) {
// ... otherwise use the first one that has neither.
// (notice that it is possible for all three to be -1 if, for example,
// there is only one pentuple-apostrophe in the line)
$arr[$firstspace] = "''";
$arr[$firstspace - 1] .= "'";
}
}
// Now let's actually convert our apostrophic mush to HTML!
$output = '';
$buffer = '';
$state = '';
$i = 0;
foreach ( $arr as $r ) {
if ( ( $i % 2 ) == 0 ) {
if ( $state === 'both' ) {
$buffer .= $r;
} else {
$output .= $r;
}
} else {
$thislen = strlen( $r );
if ( $thislen == 2 ) {
// two quotes - open or close italics
if ( $state === 'i' ) {
$output .= '</i>';
$state = '';
} elseif ( $state === 'bi' ) {
$output .= '</i>';
$state = 'b';
} elseif ( $state === 'ib' ) {
$output .= '</b></i><b>';
$state = 'b';
} elseif ( $state === 'both' ) {
$output .= '<b><i>' . $buffer . '</i>';
$state = 'b';
} else { // $state can be 'b' or ''
$output .= '<i>';
$state .= 'i';
}
} elseif ( $thislen == 3 ) {
// three quotes - open or close bold
if ( $state === 'b' ) {
$output .= '</b>';
$state = '';
} elseif ( $state === 'bi' ) {
$output .= '</i></b><i>';
$state = 'i';
} elseif ( $state === 'ib' ) {
$output .= '</b>';
$state = 'i';
} elseif ( $state === 'both' ) {
$output .= '<i><b>' . $buffer . '</b>';
$state = 'i';
} else { // $state can be 'i' or ''
$output .= '<b>';
$state .= 'b';
}
} elseif ( $thislen == 5 ) {
// five quotes - open or close both separately
if ( $state === 'b' ) {
$output .= '</b><i>';
$state = 'i';
} elseif ( $state === 'i' ) {
$output .= '</i><b>';
$state = 'b';
} elseif ( $state === 'bi' ) {
$output .= '</i></b>';
$state = '';
} elseif ( $state === 'ib' ) {
$output .= '</b></i>';
$state = '';
} elseif ( $state === 'both' ) {
$output .= '<i><b>' . $buffer . '</b></i>';
$state = '';
} else { // ($state == '')
$buffer = '';
$state = 'both';
}
}
}
$i++;
}
// Now close all remaining tags. Notice that the order is important.
if ( $state === 'b' || $state === 'ib' ) {
$output .= '</b>';
}
if ( $state === 'i' || $state === 'bi' || $state === 'ib' ) {
$output .= '</i>';
}
if ( $state === 'bi' ) {
$output .= '</b>';
}
// There might be lonely ''''', so make sure we have a buffer
if ( $state === 'both' && $buffer ) {
$output .= '<b><i>' . $buffer . '</i></b>';
}
return $output;
}
/**
* Replace external links (REL)
*
* Note: this is all very hackish and the order of execution matters a lot.
* Make sure to run tests/parser/parserTests.php if you change this code.
*
* @param string $text
* @return string
*/
private function handleExternalLinks( $text ) {
$bits = preg_split( $this->mExtLinkBracketedRegex, $text, -1, PREG_SPLIT_DELIM_CAPTURE );
// @phan-suppress-next-line PhanTypeComparisonFromArray See phan issue #3161
if ( $bits === false ) {
throw new RuntimeException( "PCRE failure" );
}
$s = array_shift( $bits );
$i = 0;
while ( $i < count( $bits ) ) {
$url = $bits[$i++];
$i++; // protocol
$text = $bits[$i++];
$trail = $bits[$i++];
# The characters '<' and '>' (which were escaped by
# internalRemoveHtmlTags()) should not be included in
# URLs, per RFC 2396.
$m2 = [];
if ( preg_match( '/&(lt|gt);/', $url, $m2, PREG_OFFSET_CAPTURE ) ) {
$text = substr( $url, $m2[0][1] ) . ' ' . $text;
$url = substr( $url, 0, $m2[0][1] );
}
# If the link text is an image URL, replace it with an <img> tag
# This happened by accident in the original parser, but some people used it extensively
$img = $this->maybeMakeExternalImage( $text );
if ( $img !== false ) {
$text = $img;
}
$dtrail = '';
# Set linktype for CSS
$linktype = 'text';
# No link text, e.g. [http://domain.tld/some.link]
if ( $text == '' ) {
# Autonumber
$langObj = $this->getTargetLanguage();
$text = '[' . $langObj->formatNum( ++$this->mAutonumber ) . ']';
$linktype = 'autonumber';
} else {
# Have link text, e.g. [http://domain.tld/some.link text]s
# Check for trail
[ $dtrail, $trail ] = Linker::splitTrail( $trail );
}
// Excluding protocol-relative URLs may avoid many false positives.
if ( preg_match( '/^(?:' . $this->urlUtils->validAbsoluteProtocols() . ')/', $text ) ) {
$text = $this->getTargetLanguageConverter()->markNoConversion( $text );
}
$url = Sanitizer::cleanUrl( $url );
# Use the encoded URL
# This means that users can paste URLs directly into the text
# Funny characters like ö aren't valid in URLs anyway
# This was changed in August 2004
$s .= $this->getLinkRenderer()->makeExternalLink(
$url,
// @phan-suppress-next-line SecurityCheck-XSS
new HtmlArmor( $text ),
$this->getTitle(),
$linktype,
$this->getExternalLinkAttribs( $url )
) . $dtrail . $trail;
# Register link in the output object.
$this->mOutput->addExternalLink( $url );
}
// @phan-suppress-next-line PhanTypeMismatchReturnNullable False positive from array_shift
return $s;
}
/**
* Get the rel attribute for a particular external link.
*
* @since 1.21
* @internal
* @param string|false $url Optional URL, to extract the domain from for rel =>
* nofollow if appropriate
* @param LinkTarget|null $title Optional LinkTarget, for wgNoFollowNsExceptions lookups
* @return string|null Rel attribute for $url
*/
public static function getExternalLinkRel( $url = false, ?LinkTarget $title = null ) {
$mainConfig = MediaWikiServices::getInstance()->getMainConfig();
$noFollowLinks = $mainConfig->get( MainConfigNames::NoFollowLinks );
$noFollowNsExceptions = $mainConfig->get( MainConfigNames::NoFollowNsExceptions );
$noFollowDomainExceptions = $mainConfig->get( MainConfigNames::NoFollowDomainExceptions );
$ns = $title ? $title->getNamespace() : false;
if (
$noFollowLinks && !in_array( $ns, $noFollowNsExceptions )
&& !wfGetUrlUtils()->matchesDomainList( (string)$url, $noFollowDomainExceptions )
) {
return 'nofollow';
}
return null;
}
/**
* Get an associative array of additional HTML attributes appropriate for a
* particular external link. This currently may include rel => nofollow
* (depending on configuration, namespace, and the URL's domain) and/or a
* target attribute (depending on configuration).
*
* @internal
* @param string $url URL to extract the domain from for rel =>
* nofollow if appropriate
* @return array Associative array of HTML attributes
*/
public function getExternalLinkAttribs( $url ) {
$attribs = [];
$rel = self::getExternalLinkRel( $url, $this->getTitle() ) ?? '';
$target = $this->mOptions->getExternalLinkTarget();
if ( $target ) {
$attribs['target'] = $target;
if ( !in_array( $target, [ '_self', '_parent', '_top' ] ) ) {
// T133507. New windows can navigate parent cross-origin.
// Including noreferrer due to lacking browser
// support of noopener. Eventually noreferrer should be removed.
if ( $rel !== '' ) {
$rel .= ' ';
}
$rel .= 'noreferrer noopener';
}
}
if ( $rel !== '' ) {
$attribs['rel'] = $rel;
}
return $attribs;
}
/**
* Replace unusual escape codes in a URL with their equivalent characters
*
* This generally follows the syntax defined in RFC 3986, with special
* consideration for HTTP query strings.
*
* @internal
* @param string $url
* @return string
*/
public static function normalizeLinkUrl( $url ) {
# Test for RFC 3986 IPv6 syntax
$scheme = '[a-z][a-z0-9+.-]*:';
$userinfo = '(?:[a-z0-9\-._~!$&\'()*+,;=:]|%[0-9a-f]{2})*';
$ipv6Host = '\\[((?:[0-9a-f:]|%3[0-A]|%[46][1-6])+)\\]';
if ( preg_match( "<^(?:{$scheme})?//(?:{$userinfo}@)?{$ipv6Host}(?:[:/?#].*|)$>i", $url, $m ) &&
IPUtils::isValid( rawurldecode( $m[1] ) )
) {
$isIPv6 = rawurldecode( $m[1] );
} else {
$isIPv6 = false;
}
# Make sure unsafe characters are encoded
$url = preg_replace_callback(
'/[\x00-\x20"<>\[\\\\\]^`{|}\x7F-\xFF]+/',
static fn ( $m ) => rawurlencode( $m[0] ),
$url
);
$ret = '';
$end = strlen( $url );
# Fragment part - 'fragment'
$start = strpos( $url, '#' );
if ( $start !== false && $start < $end ) {
$ret = self::normalizeUrlComponent(
substr( $url, $start, $end - $start ), '"#%<>[\]^`{|}' ) . $ret;
$end = $start;
}
# Query part - 'query' minus &=+;
$start = strpos( $url, '?' );
if ( $start !== false && $start < $end ) {
$ret = self::normalizeUrlComponent(
substr( $url, $start, $end - $start ), '"#%<>[\]^`{|}&=+;' ) . $ret;
$end = $start;
}
# Path part - 'pchar', remove dot segments
# (find first '/' after the optional '//' after the scheme)
$start = strpos( $url, '//' );
$start = strpos( $url, '/', $start === false ? 0 : $start + 2 );
if ( $start !== false && $start < $end ) {
$ret = UrlUtils::removeDotSegments( self::normalizeUrlComponent(
substr( $url, $start, $end - $start ), '"#%<>[\]^`{|}/?' ) ) . $ret;
$end = $start;
}
# Scheme and host part - 'pchar'
# (we assume no userinfo or encoded colons in the host)
$ret = self::normalizeUrlComponent(
substr( $url, 0, $end ), '"#%<>[\]^`{|}/?' ) . $ret;
# Fix IPv6 syntax
if ( $isIPv6 !== false ) {
$ipv6Host = "%5B({$isIPv6})%5D";
$ret = preg_replace(
"<^((?:{$scheme})?//(?:{$userinfo}@)?){$ipv6Host}(?=[:/?#]|$)>i",
"$1[$2]",
$ret
);
}
return $ret;
}
private static function normalizeUrlComponent( $component, $unsafe ) {
$callback = static function ( $matches ) use ( $unsafe ) {
$char = urldecode( $matches[0] );
$ord = ord( $char );
if ( $ord > 32 && $ord < 127 && strpos( $unsafe, $char ) === false ) {
# Unescape it
return $char;
} else {
# Leave it escaped, but use uppercase for a-f
return strtoupper( $matches[0] );
}
};
return preg_replace_callback( '/%[0-9A-Fa-f]{2}/', $callback, $component );
}
/**
* make an image if it's allowed, either through the global
* option, through the exception, or through the on-wiki whitelist
*
* @param string $url
*
* @return string
*/
private function maybeMakeExternalImage( $url ) {
$imagesfrom = $this->mOptions->getAllowExternalImagesFrom();
$imagesexception = (bool)$imagesfrom;
$text = false;
# $imagesfrom could be either a single string or an array of strings, parse out the latter
if ( $imagesexception && is_array( $imagesfrom ) ) {
$imagematch = false;
foreach ( $imagesfrom as $match ) {
if ( strpos( $url, $match ) === 0 ) {
$imagematch = true;
break;
}
}
} elseif ( $imagesexception ) {
$imagematch = ( strpos( $url, $imagesfrom ) === 0 );
} else {
$imagematch = false;
}
if ( $this->mOptions->getAllowExternalImages()
|| ( $imagesexception && $imagematch )
) {
if ( preg_match( self::EXT_IMAGE_REGEX, $url ) ) {
# Image found
$text = Linker::makeExternalImage( $url );
}
}
if ( !$text && $this->mOptions->getEnableImageWhitelist()
&& preg_match( self::EXT_IMAGE_REGEX, $url )
) {
$whitelist = explode(
"\n",
wfMessage( 'external_image_whitelist' )->inContentLanguage()->text()
);
foreach ( $whitelist as $entry ) {
# Sanitize the regex fragment, make it case-insensitive, ignore blank entries/comments
if ( strpos( $entry, '#' ) === 0 || $entry === '' ) {
continue;
}
// @phan-suppress-next-line SecurityCheck-ReDoS preg_quote is not wanted here
if ( preg_match( '/' . str_replace( '/', '\\/', $entry ) . '/i', $url ) ) {
# Image matches a whitelist entry
$text = Linker::makeExternalImage( $url );
break;
}
}
}
return $text;
}
/**
* Process [[ ]] wikilinks
*
* @param string $text
*
* @return string Processed text
*/
private function handleInternalLinks( $text ) {
$this->mLinkHolders->merge( $this->handleInternalLinks2( $text ) );
return $text;
}
/**
* Process [[ ]] wikilinks (RIL)
* @param string &$s
* @return LinkHolderArray
*/
private function handleInternalLinks2( &$s ) {
static $tc = false, $e1, $e1_img;
# the % is needed to support urlencoded titles as well
if ( !$tc ) {
$tc = Title::legalChars() . '#%';
# Match a link having the form [[namespace:link|alternate]]trail
$e1 = "/^([{$tc}]+)(?:\\|(.+?))?]](.*)\$/sD";
# Match cases where there is no "]]", which might still be images
$e1_img = "/^([{$tc}]+)\\|(.*)\$/sD";
}
$holders = new LinkHolderArray(
$this,
$this->getContentLanguageConverter(),
$this->getHookContainer() );
# split the entire text string on occurrences of [[
$a = StringUtils::explode( '[[', ' ' . $s );
# get the first element (all text up to first [[), and remove the space we added
$s = $a->current();
$a->next();
$line = $a->current(); # Workaround for broken ArrayIterator::next() that returns "void"
$s = substr( $s, 1 );
$nottalk = !$this->getTitle()->isTalkPage();
$useLinkPrefixExtension = $this->getTargetLanguage()->linkPrefixExtension();
$e2 = null;
if ( $useLinkPrefixExtension ) {
# Match the end of a line for a word that's not followed by whitespace,
# e.g. in the case of 'The Arab al[[Razi]]', 'al' will be matched
$charset = $this->contLang->linkPrefixCharset();
$e2 = "/^((?>.*[^$charset]|))(.+)$/sDu";
$m = [];
if ( preg_match( $e2, $s, $m ) ) {
$first_prefix = $m[2];
} else {
$first_prefix = false;
}
$prefix = false;
} else {
$first_prefix = false;
$prefix = '';
}
# Some namespaces don't allow subpages
$useSubpages = $this->nsInfo->hasSubpages(
$this->getTitle()->getNamespace()
);
# Loop for each link
for ( ; $line !== false && $line !== null; $a->next(), $line = $a->current() ) {
# Check for excessive memory usage
if ( $holders->isBig() ) {
# Too big
# Do the existence check, replace the link holders and clear the array
$holders->replace( $s );
$holders->clear();
}
if ( $useLinkPrefixExtension ) {
// @phan-suppress-next-line PhanTypeMismatchArgumentNullableInternal $e2 is set under this condition
if ( preg_match( $e2, $s, $m ) ) {
[ , $s, $prefix ] = $m;
} else {
$prefix = '';
}
# first link
if ( $first_prefix ) {
$prefix = $first_prefix;
$first_prefix = false;
}
}
$might_be_img = false;
if ( preg_match( $e1, $line, $m ) ) { # page with normal text or alt
$text = $m[2];
# If we get a ] at the beginning of $m[3] that means we have a link that's something like:
# [[Image:Foo.jpg|[http://example.com desc]]] <- having three ] in a row fucks up,
# the real problem is with the $e1 regex
# See T1500.
# Still some problems for cases where the ] is meant to be outside punctuation,
# and no image is in sight. See T4095.
if ( $text !== ''
&& substr( $m[3], 0, 1 ) === ']'
&& strpos( $text, '[' ) !== false
) {
$text .= ']'; # so that handleExternalLinks($text) works later
$m[3] = substr( $m[3], 1 );
}
# fix up urlencoded title texts
if ( strpos( $m[1], '%' ) !== false ) {
# Should anchors '#' also be rejected?
$m[1] = str_replace( [ '<', '>' ], [ '<', '>' ], rawurldecode( $m[1] ) );
}
$trail = $m[3];
} elseif ( preg_match( $e1_img, $line, $m ) ) {
# Invalid, but might be an image with a link in its caption
$might_be_img = true;
$text = $m[2];
if ( strpos( $m[1], '%' ) !== false ) {
$m[1] = str_replace( [ '<', '>' ], [ '<', '>' ], rawurldecode( $m[1] ) );
}
$trail = "";
} else { # Invalid form; output directly
$s .= $prefix . '[[' . $line;
continue;
}
// @phan-suppress-next-line PhanTypePossiblyInvalidDimOffset preg_match success when reached here
$origLink = ltrim( $m[1], ' ' );
# Don't allow internal links to pages containing
# PROTO: where PROTO is a valid URL protocol; these
# should be external links.
if ( preg_match( '/^(?i:' . $this->urlUtils->validProtocols() . ')/', $origLink ) ) {
$s .= $prefix . '[[' . $line;
continue;
}
# Make subpage if necessary
if ( $useSubpages ) {
$link = Linker::normalizeSubpageLink(
$this->getTitle(), $origLink, $text
);
} else {
$link = $origLink;
}
// \x7f isn't a default legal title char, so most likely strip
// markers will force us into the "invalid form" path above. But,
// just in case, let's assert that xmlish tags aren't valid in
// the title position.
$unstrip = $this->mStripState->killMarkers( $link );
$noMarkers = ( $unstrip === $link );
$nt = $noMarkers ? Title::newFromText( $link ) : null;
if ( $nt === null ) {
$s .= $prefix . '[[' . $line;
continue;
}
$ns = $nt->getNamespace();
$iw = $nt->getInterwiki();
$noforce = ( substr( $origLink, 0, 1 ) !== ':' );
if ( $might_be_img ) { # if this is actually an invalid link
if ( $ns === NS_FILE && $noforce ) { # but might be an image
$found = false;
while ( true ) {
# look at the next 'line' to see if we can close it there
$a->next();
$next_line = $a->current();
if ( $next_line === false || $next_line === null ) {
break;
}
$m = explode( ']]', $next_line, 3 );
if ( count( $m ) == 3 ) {
# the first ]] closes the inner link, the second the image
$found = true;
$text .= "[[{$m[0]}]]{$m[1]}";
$trail = $m[2];
break;
} elseif ( count( $m ) == 2 ) {
# if there's exactly one ]] that's fine, we'll keep looking
$text .= "[[{$m[0]}]]{$m[1]}";
} else {
# if $next_line is invalid too, we need look no further
$text .= '[[' . $next_line;
break;
}
}
if ( !$found ) {
# we couldn't find the end of this imageLink, so output it raw
# but don't ignore what might be perfectly normal links in the text we've examined
$holders->merge( $this->handleInternalLinks2( $text ) );
$s .= "{$prefix}[[$link|$text";
# note: no $trail, because without an end, there *is* no trail
continue;
}
} else { # it's not an image, so output it raw
$s .= "{$prefix}[[$link|$text";
# note: no $trail, because without an end, there *is* no trail
continue;
}
}
$wasblank = ( $text == '' );
if ( $wasblank ) {
$text = $link;
if ( !$noforce ) {
# Strip off leading ':'
$text = substr( $text, 1 );
}
} else {
# T6598 madness. Handle the quotes only if they come from the alternate part
# [[Lista d''e paise d''o munno]] -> <a href="...">Lista d''e paise d''o munno</a>
# [[Criticism of Harry Potter|Criticism of ''Harry Potter'']]
# -> <a href="Criticism of Harry Potter">Criticism of <i>Harry Potter</i></a>
$text = $this->doQuotes( $text );
}
# Link not escaped by : , create the various objects
if ( $noforce && !$nt->wasLocalInterwiki() ) {
# Interwikis
if (
$iw && $this->mOptions->getInterwikiMagic() && $nottalk && (
$this->languageNameUtils->getLanguageName(
$iw,
LanguageNameUtils::AUTONYMS,
LanguageNameUtils::DEFINED
)
|| in_array( $iw, $this->svcOptions->get( MainConfigNames::ExtraInterlanguageLinkPrefixes ) )
)
) {
# T26502: duplicates are resolved in ParserOutput
$this->mOutput->addLanguageLink( $nt );
/**
* Strip the whitespace interlanguage links produce, see
* T10897, T175416, and T359886.
*/
$s = preg_replace( '/\n\s*$/', '', $s . $prefix ) . $trail;
continue;
}
if ( $ns === NS_FILE ) {
if ( $wasblank ) {
# if no parameters were passed, $text
# becomes something like "File:Foo.png",
# which we don't want to pass on to the
# image generator
$text = '';
} else {
# recursively parse links inside the image caption
# actually, this will parse them in any other parameters, too,
# but it might be hard to fix that, and it doesn't matter ATM
$text = $this->handleExternalLinks( $text );
$holders->merge( $this->handleInternalLinks2( $text ) );
}
# cloak any absolute URLs inside the image markup, so handleExternalLinks() won't touch them
$s .= $prefix . $this->armorLinks(
$this->makeImage( $nt, $text, $holders ) ) . $trail;
continue;
} elseif ( $ns === NS_CATEGORY ) {
# Strip newlines from the left hand context of Category
# links.
# See T2087, T87753, T174639, T359886
$s = preg_replace( '/\n\s*$/', '', $s . $prefix ) . $trail;
$sortkey = ''; // filled in by CategoryLinksTable
if ( !$wasblank ) {
$sortkey = $text;
}
$this->mOutput->addCategory( $nt, $sortkey );
continue;
}
}
# Self-link checking. For some languages, variants of the title are checked in
# LinkHolderArray::doVariants() to allow batching the existence checks necessary
# for linking to a different variant.
if ( $ns !== NS_SPECIAL && $nt->equals( $this->getTitle() ) ) {
$s .= $prefix . Linker::makeSelfLinkObj( $nt, $text, '', $trail, '',
Sanitizer::escapeIdForLink( $nt->getFragment() ) );
continue;
}
# NS_MEDIA is a pseudo-namespace for linking directly to a file
# @todo FIXME: Should do batch file existence checks, see comment below
if ( $ns === NS_MEDIA ) {
# Give extensions a chance to select the file revision for us
$options = [];
$descQuery = false;
$this->hookRunner->onBeforeParserFetchFileAndTitle(
// @phan-suppress-next-line PhanTypeMismatchArgument Type mismatch on pass-by-ref args
$this, $nt, $options, $descQuery
);
# Fetch and register the file (file title may be different via hooks)
[ $file, $nt ] = $this->fetchFileAndTitle( $nt, $options );
# Cloak with NOPARSE to avoid replacement in handleExternalLinks
$s .= $prefix . $this->armorLinks(
Linker::makeMediaLinkFile( $nt, $file, $text ) ) . $trail;
continue;
}
# Some titles, such as valid special pages or files in foreign repos, should
# be shown as bluelinks even though they're not included in the page table
# @todo FIXME: isAlwaysKnown() can be expensive for file links; we should really do
# batch file existence checks for NS_FILE and NS_MEDIA
if ( $iw == '' && $nt->isAlwaysKnown() ) {
$this->mOutput->addLink( $nt );
$s .= $this->makeKnownLinkHolder( $nt, $text, $trail, $prefix );
} else {
# Links will be added to the output link list after checking
$s .= $holders->makeHolder( $nt, $text, $trail, $prefix );
}
}
return $holders;
}
/**
* Render a forced-blue link inline; protect against double expansion of
* URLs if we're in a mode that prepends full URL prefixes to internal links.
* Since this little disaster has to split off the trail text to avoid
* breaking URLs in the following text without breaking trails on the
* wiki links, it's been made into a horrible function.
*
* @param LinkTarget $nt
* @param string $text
* @param string $trail
* @param string $prefix
* @return string HTML-wikitext mix oh yuck
*/
private function makeKnownLinkHolder( LinkTarget $nt, $text = '', $trail = '', $prefix = '' ) {
[ $inside, $trail ] = Linker::splitTrail( $trail );
if ( $text == '' ) {
$text = htmlspecialchars( $this->titleFormatter->getPrefixedText( $nt ) );
}
$link = $this->getLinkRenderer()->makeKnownLink(
$nt, new HtmlArmor( "$prefix$text$inside" )
);
return $this->armorLinks( $link ) . $trail;
}
/**
* Insert a NOPARSE hacky thing into any inline links in a chunk that's
* going to go through further parsing steps before inline URL expansion.
*
* Not needed quite as much as it used to be since free links are a bit
* more sensible these days. But bracketed links are still an issue.
*
* @param string $text More-or-less HTML
* @return string Less-or-more HTML with NOPARSE bits
*/
private function armorLinks( $text ) {
return preg_replace( '/\b((?i)' . $this->urlUtils->validProtocols() . ')/',
self::MARKER_PREFIX . "NOPARSE$1", $text );
}
/**
* Make lists from lines starting with ':', '*', '#', etc. (DBL)
*
* @param string $text
* @param bool $linestart Whether or not this is at the start of a line.
* @internal
* @return string The lists rendered as HTML
* @deprecated since 1.35, will not be supported in future parsers
*/
public function doBlockLevels( $text, $linestart ) {
wfDeprecated( __METHOD__, '1.35' );
return BlockLevelPass::doBlockLevels( $text, $linestart );
}
/**
* Return value of a magic variable (like PAGENAME)
*
* @param string $index Magic variable identifier as mapped in MagicWordFactory::$mVariableIDs
* @param PPFrame|false $frame
*
* @return string
*/
private function expandMagicVariable( $index, $frame = false ) {
/**
* Some of these require message or data lookups and can be
* expensive to check many times.
*/
if ( isset( $this->mVarCache[$index] ) ) {
return $this->mVarCache[$index];
}
$ts = new MWTimestamp( $this->mOptions->getTimestamp() /* TS_MW */ );
if ( $this->hookContainer->isRegistered( 'ParserGetVariableValueTs' ) ) {
$s = $ts->getTimestamp( TS_UNIX );
$this->hookRunner->onParserGetVariableValueTs( $this, $s );
$ts = new MWTimestamp( $s );
}
$value = CoreMagicVariables::expand(
$this, $index, $ts, $this->svcOptions, $this->logger
);
if ( $value === null ) {
// Not a defined core magic word
// Don't give this hook unrestricted access to mVarCache
$fakeCache = [];
$this->hookRunner->onParserGetVariableValueSwitch(
// @phan-suppress-next-line PhanTypeMismatchArgument $value is passed as null but returned as string
$this, $fakeCache, $index, $value, $frame
);
// Cache the value returned by the hook by falling through here.
// Assert the the hook returned a non-null value for this MV
'@phan-var string $value';
}
$this->mVarCache[$index] = $value;
return $value;
}
/**
* Initialize the magic variables (like CURRENTMONTHNAME) and
* substitution modifiers.
*/
private function initializeVariables() {
$variableIDs = $this->magicWordFactory->getVariableIDs();
$this->mVariables = $this->magicWordFactory->newArray( $variableIDs );
$this->mSubstWords = $this->magicWordFactory->getSubstArray();
}
/**
* Get the document object model for the given wikitext
*
* @see Preprocessor::preprocessToObj()
*
* The generated DOM tree must depend only on the input text and the flags.
* The DOM tree must be the same in OT_HTML and OT_WIKI mode, to avoid a
* regression of T6899.
*
* Any flag added to the $flags parameter here, or any other parameter liable to cause a
* change in the DOM tree for a given text, must be passed through the section identifier
* in the section edit link and thus back to extractSections().
*
* @param string $text Wikitext
* @param int $flags Bit field of Preprocessor::DOM_* constants
* @return PPNode
* @since 1.23 method is public
*/
public function preprocessToDom( $text, $flags = 0 ) {
return $this->getPreprocessor()->preprocessToObj( $text, $flags );
}
/**
* Replace magic variables, templates, and template arguments
* with the appropriate text. Templates are substituted recursively,
* taking care to avoid infinite loops.
*
* Note that the substitution depends on value of $mOutputType:
* self::OT_WIKI: only {{subst:}} templates
* self::OT_PREPROCESS: templates but not extension tags
* self::OT_HTML: all templates and extension tags
*
* @param string $text The text to transform
* @param false|PPFrame|array $frame Object describing the arguments passed to the
* template. Arguments may also be provided as an associative array, as
* was the usual case before MW1.12. Providing arguments this way may be
* useful for extensions wishing to perform variable replacement
* explicitly.
* @param bool $argsOnly Only do argument (triple-brace) expansion, not
* double-brace expansion.
* @return string
* @since 1.24 method is public
*/
public function replaceVariables( $text, $frame = false, $argsOnly = false ) {
# Is there any text? Also, Prevent too big inclusions!
$textSize = strlen( $text );
if ( $textSize < 1 || $textSize > $this->mOptions->getMaxIncludeSize() ) {
return $text;
}
if ( $frame === false ) {
$frame = $this->getPreprocessor()->newFrame();
} elseif ( !( $frame instanceof PPFrame ) ) {
wfDeprecated(
__METHOD__ . " called using plain parameters instead of " .
"a PPFrame instance. Creating custom frame.",
'1.43'
);
$frame = $this->getPreprocessor()->newCustomFrame( $frame );
}
$dom = $this->preprocessToDom( $text );
$flags = $argsOnly ? PPFrame::NO_TEMPLATES : 0;
$text = $frame->expand( $dom, $flags );
return $text;
}
/**
* Warn the user when a parser limitation is reached
* Will warn at most once the user per limitation type
*
* The results are shown during preview and run through the Parser (See EditPage.php)
*
* @param string $limitationType Should be one of:
* 'expensive-parserfunction' (corresponding messages:
* 'expensive-parserfunction-warning',
* 'expensive-parserfunction-category')
* 'post-expand-template-argument' (corresponding messages:
* 'post-expand-template-argument-warning',
* 'post-expand-template-argument-category')
* 'post-expand-template-inclusion' (corresponding messages:
* 'post-expand-template-inclusion-warning',
* 'post-expand-template-inclusion-category')
* 'node-count-exceeded' (corresponding messages:
* 'node-count-exceeded-warning',
* 'node-count-exceeded-category')
* 'expansion-depth-exceeded' (corresponding messages:
* 'expansion-depth-exceeded-warning',
* 'expansion-depth-exceeded-category')
* @param string|int|null $current Current value
* @param string|int|null $max Maximum allowed, when an explicit limit has been
* exceeded, provide the values (optional)
* @internal
*/
public function limitationWarn( $limitationType, $current = '', $max = '' ) {
# does no harm if $current and $max are present but are unnecessary for the message
# Not doing ->inLanguage( $this->mOptions->getUserLangObj() ), since this is shown
# only during preview, and that would split the parser cache unnecessarily.
$this->mOutput->addWarningMsg(
"$limitationType-warning",
Message::numParam( $current ),
Message::numParam( $max )
);
$this->addTrackingCategory( "$limitationType-category" );
}
/**
* Return the text of a template, after recursively
* replacing any variables or templates within the template.
*
* @param array $piece The parts of the template
* $piece['title']: the title, i.e. the part before the |
* $piece['parts']: the parameter array
* $piece['lineStart']: whether the brace was at the start of a line
* @param PPFrame $frame The current frame, contains template arguments
* @throws Exception
* @return string|array The text of the template
* @internal
*/
public function braceSubstitution( array $piece, PPFrame $frame ) {
// Flags
// $text has been filled
$found = false;
$text = '';
// wiki markup in $text should be escaped
$nowiki = false;
// $text is HTML, armour it against wikitext transformation
$isHTML = false;
// Force interwiki transclusion to be done in raw mode not rendered
$forceRawInterwiki = false;
// $text is a DOM node needing expansion in a child frame
$isChildObj = false;
// $text is a DOM node needing expansion in the current frame
$isLocalObj = false;
# Title object, where $text came from
$title = false;
# $part1 is the bit before the first |, and must contain only title characters.
# Various prefixes will be stripped from it later.
$titleWithSpaces = $frame->expand( $piece['title'] );
$part1 = trim( $titleWithSpaces );
$titleText = false;
# Original title text preserved for various purposes
$originalTitle = $part1;
# $args is a list of argument nodes, starting from index 0, not including $part1
$args = $piece['parts'];
$profileSection = null; // profile templates
$sawDeprecatedTemplateEquals = false; // T91154
# SUBST
// @phan-suppress-next-line PhanImpossibleCondition
if ( !$found ) {
$substMatch = $this->mSubstWords->matchStartAndRemove( $part1 );
$part1 = trim( $part1 );
# Possibilities for substMatch: "subst", "safesubst" or FALSE
# Decide whether to expand template or keep wikitext as-is.
if ( $this->ot['wiki'] ) {
if ( $substMatch === false ) {
$literal = true; # literal when in PST with no prefix
} else {
$literal = false; # expand when in PST with subst: or safesubst:
}
} else {
if ( $substMatch == 'subst' ) {
$literal = true; # literal when not in PST with plain subst:
} else {
$literal = false; # expand when not in PST with safesubst: or no prefix
}
}
if ( $literal ) {
$text = $frame->virtualBracketedImplode( '{{', '|', '}}', $titleWithSpaces, $args );
$isLocalObj = true;
$found = true;
}
}
# Variables
if ( !$found && $args->getLength() == 0 ) {
$id = $this->mVariables->matchStartToEnd( $part1 );
if ( $id !== false ) {
if ( strpos( $part1, ':' ) !== false ) {
wfDeprecatedMsg(
'Registering a magic variable with a name including a colon',
'1.39', false, false
);
}
$text = $this->expandMagicVariable( $id, $frame );
$found = true;
}
}
# MSG, MSGNW and RAW
if ( !$found ) {
# Check for MSGNW:
$mwMsgnw = $this->magicWordFactory->get( 'msgnw' );
if ( $mwMsgnw->matchStartAndRemove( $part1 ) ) {
$nowiki = true;
} else {
# Remove obsolete MSG:
$mwMsg = $this->magicWordFactory->get( 'msg' );
$mwMsg->matchStartAndRemove( $part1 );
}
# Check for RAW:
$mwRaw = $this->magicWordFactory->get( 'raw' );
if ( $mwRaw->matchStartAndRemove( $part1 ) ) {
$forceRawInterwiki = true;
}
}
# Parser functions
if ( !$found ) {
$colonPos = strpos( $part1, ':' );
if ( $colonPos !== false ) {
$func = substr( $part1, 0, $colonPos );
$funcArgs = [ trim( substr( $part1, $colonPos + 1 ) ) ];
$argsLength = $args->getLength();
for ( $i = 0; $i < $argsLength; $i++ ) {
$funcArgs[] = $args->item( $i );
}
$result = $this->callParserFunction( $frame, $func, $funcArgs );
// Extract any forwarded flags
if ( isset( $result['title'] ) ) {
$title = $result['title'];
}
if ( isset( $result['found'] ) ) {
$found = $result['found'];
}
if ( array_key_exists( 'text', $result ) ) {
// a string or null
$text = $result['text'];
}
if ( isset( $result['nowiki'] ) ) {
$nowiki = $result['nowiki'];
}
if ( isset( $result['isHTML'] ) ) {
$isHTML = $result['isHTML'];
}
if ( isset( $result['forceRawInterwiki'] ) ) {
$forceRawInterwiki = $result['forceRawInterwiki'];
}
if ( isset( $result['isChildObj'] ) ) {
$isChildObj = $result['isChildObj'];
}
if ( isset( $result['isLocalObj'] ) ) {
$isLocalObj = $result['isLocalObj'];
}
}
}
# Finish mangling title and then check for loops.
# Set $title to a Title object and $titleText to the PDBK
if ( !$found ) {
$ns = NS_TEMPLATE;
# Split the title into page and subpage
$subpage = '';
$relative = Linker::normalizeSubpageLink(
$this->getTitle(), $part1, $subpage
);
if ( $part1 !== $relative ) {
$part1 = $relative;
$ns = $this->getTitle()->getNamespace();
}
$title = Title::newFromText( $part1, $ns );
if ( $title ) {
$titleText = $title->getPrefixedText();
# Check for language variants if the template is not found
if ( $this->getTargetLanguageConverter()->hasVariants() && $title->getArticleID() == 0 ) {
$this->getTargetLanguageConverter()->findVariantLink( $part1, $title, true );
}
# Do recursion depth check
$limit = $this->mOptions->getMaxTemplateDepth();
if ( $frame->depth >= $limit ) {
$found = true;
$text = '<span class="error">'
. wfMessage( 'parser-template-recursion-depth-warning' )
->numParams( $limit )->inContentLanguage()->text()
. '</span>';
}
}
}
# Load from database
if ( !$found && $title ) {
$profileSection = $this->mProfiler->scopedProfileIn( $title->getPrefixedDBkey() );
if ( !$title->isExternal() ) {
if ( $title->isSpecialPage()
&& $this->mOptions->getAllowSpecialInclusion()
&& $this->ot['html']
) {
$specialPage = $this->specialPageFactory->getPage( $title->getDBkey() );
// Pass the template arguments as URL parameters.
// "uselang" will have no effect since the Language object
// is forced to the one defined in ParserOptions.
$pageArgs = [];
$argsLength = $args->getLength();
for ( $i = 0; $i < $argsLength; $i++ ) {
$bits = $args->item( $i )->splitArg();
if ( strval( $bits['index'] ) === '' ) {
$name = trim( $frame->expand( $bits['name'], PPFrame::STRIP_COMMENTS ) );
$value = trim( $frame->expand( $bits['value'] ) );
$pageArgs[$name] = $value;
}
}
// Create a new context to execute the special page, that is expensive
if ( $this->incrementExpensiveFunctionCount() ) {
$context = new RequestContext;
$context->setTitle( $title );
$context->setRequest( new FauxRequest( $pageArgs ) );
if ( $specialPage && $specialPage->maxIncludeCacheTime() === 0 ) {
$context->setUser( $this->userFactory->newFromUserIdentity( $this->getUserIdentity() ) );
} else {
// If this page is cached, then we better not be per user.
$context->setUser( User::newFromName( '127.0.0.1', false ) );
}
$context->setLanguage( $this->mOptions->getUserLangObj() );
$ret = $this->specialPageFactory->capturePath( $title, $context, $this->getLinkRenderer() );
if ( $ret ) {
$text = $context->getOutput()->getHTML();
$this->mOutput->addOutputPageMetadata( $context->getOutput() );
$found = true;
$isHTML = true;
if ( $specialPage && $specialPage->maxIncludeCacheTime() !== false ) {
$this->mOutput->updateRuntimeAdaptiveExpiry(
$specialPage->maxIncludeCacheTime()
);
}
}
}
} elseif ( $this->nsInfo->isNonincludable( $title->getNamespace() ) ) {
$found = false; # access denied
$this->logger->debug(
__METHOD__ .
": template inclusion denied for " . $title->getPrefixedDBkey()
);
} else {
[ $text, $title ] = $this->getTemplateDom( $title );
if ( $text !== false ) {
$found = true;
$isChildObj = true;
if (
$title->getNamespace() === NS_TEMPLATE &&
$title->getDBkey() === '=' &&
$originalTitle === '='
) {
// Note that we won't get here if `=` is evaluated
// (in the future) as a parser function, nor if
// the Template namespace is given explicitly,
// ie `{{Template:=}}`. Only `{{=}}` triggers.
$sawDeprecatedTemplateEquals = true; // T91154
}
}
}
# If the title is valid but undisplayable, make a link to it
if ( !$found && ( $this->ot['html'] || $this->ot['pre'] ) ) {
$text = "[[:$titleText]]";
$found = true;
}
} elseif ( $title->isTrans() ) {
# Interwiki transclusion
if ( $this->ot['html'] && !$forceRawInterwiki ) {
$text = $this->interwikiTransclude( $title, 'render' );
$isHTML = true;
} else {
$text = $this->interwikiTransclude( $title, 'raw' );
# Preprocess it like a template
$text = $this->preprocessToDom( $text, Preprocessor::DOM_FOR_INCLUSION );
$isChildObj = true;
}
$found = true;
}
# Do infinite loop check
# This has to be done after redirect resolution to avoid infinite loops via redirects
if ( !$frame->loopCheck( $title ) ) {
$found = true;
$text = '<span class="error">'
. wfMessage( 'parser-template-loop-warning', $titleText )->inContentLanguage()->text()
. '</span>';
$this->addTrackingCategory( 'template-loop-category' );
$this->mOutput->addWarningMsg(
'template-loop-warning',
Message::plaintextParam( $titleText )
);
$this->logger->debug( __METHOD__ . ": template loop broken at '$titleText'" );
}
}
# If we haven't found text to substitute by now, we're done
# Recover the source wikitext and return it
if ( !$found ) {
$text = $frame->virtualBracketedImplode( '{{', '|', '}}', $titleWithSpaces, $args );
if ( $profileSection ) {
$this->mProfiler->scopedProfileOut( $profileSection );
}
return [ 'object' => $text ];
}
# Expand DOM-style return values in a child frame
if ( $isChildObj ) {
# Clean up argument array
$newFrame = $frame->newChild( $args, $title );
if ( $nowiki ) {
$text = $newFrame->expand( $text, PPFrame::RECOVER_ORIG );
} elseif ( $titleText !== false && $newFrame->isEmpty() ) {
# Expansion is eligible for the empty-frame cache
$text = $newFrame->cachedExpand( $titleText, $text );
} else {
# Uncached expansion
$text = $newFrame->expand( $text );
}
}
if ( $isLocalObj && $nowiki ) {
$text = $frame->expand( $text, PPFrame::RECOVER_ORIG );
$isLocalObj = false;
}
if ( $profileSection ) {
$this->mProfiler->scopedProfileOut( $profileSection );
}
if (
$sawDeprecatedTemplateEquals &&
$this->mStripState->unstripBoth( $text ) !== '='
) {
// T91154: {{=}} is deprecated when it doesn't expand to `=`;
// use {{Template:=}} if you must.
$this->addTrackingCategory( 'template-equals-category' );
$this->mOutput->addWarningMsg( 'template-equals-warning' );
}
# Replace raw HTML by a placeholder
if ( $isHTML ) {
// @phan-suppress-next-line SecurityCheck-XSS
$text = $this->insertStripItem( $text );
} elseif ( $nowiki && ( $this->ot['html'] || $this->ot['pre'] ) ) {
# Escape nowiki-style return values
// @phan-suppress-next-line SecurityCheck-DoubleEscaped
$text = wfEscapeWikiText( $text );
} elseif ( is_string( $text )
&& !$piece['lineStart']
&& preg_match( '/^(?:{\\||:|;|#|\*)/', $text )
) {
# T2529: if the template begins with a table or block-level
# element, it should be treated as beginning a new line.
# This behavior is somewhat controversial.
$text = "\n" . $text;
}
if ( is_string( $text ) && !$this->incrementIncludeSize( 'post-expand', strlen( $text ) ) ) {
# Error, oversize inclusion
if ( $titleText !== false ) {
# Make a working, properly escaped link if possible (T25588)
$text = "[[:$titleText]]";
} else {
# This will probably not be a working link, but at least it may
# provide some hint of where the problem is
$originalTitle = preg_replace( '/^:/', '', $originalTitle );
$text = "[[:$originalTitle]]";
}
$text .= $this->insertStripItem( '<!-- WARNING: template omitted, '
. 'post-expand include size too large -->' );
$this->limitationWarn( 'post-expand-template-inclusion' );
}
if ( $isLocalObj ) {
$ret = [ 'object' => $text ];
} else {
$ret = [ 'text' => $text ];
}
return $ret;
}
/**
* Call a parser function and return an array with text and flags.
*
* The returned array will always contain a boolean 'found', indicating
* whether the parser function was found or not. It may also contain the
* following:
* text: string|object, resulting wikitext or PP DOM object
* isHTML: bool, $text is HTML, armour it against wikitext transformation
* isChildObj: bool, $text is a DOM node needing expansion in a child frame
* isLocalObj: bool, $text is a DOM node needing expansion in the current frame
* nowiki: bool, wiki markup in $text should be escaped
*
* @since 1.21
* @param PPFrame $frame The current frame, contains template arguments
* @param string $function Function name
* @param array $args Arguments to the function
* @return array
*/
public function callParserFunction( PPFrame $frame, $function, array $args = [] ) {
# Case sensitive functions
if ( isset( $this->mFunctionSynonyms[1][$function] ) ) {
$function = $this->mFunctionSynonyms[1][$function];
} else {
# Case insensitive functions
$function = $this->contLang->lc( $function );
if ( isset( $this->mFunctionSynonyms[0][$function] ) ) {
$function = $this->mFunctionSynonyms[0][$function];
} else {
return [ 'found' => false ];
}
}
[ $callback, $flags ] = $this->mFunctionHooks[$function];
$allArgs = [ $this ];
if ( $flags & self::SFH_OBJECT_ARGS ) {
# Convert arguments to PPNodes and collect for appending to $allArgs
$funcArgs = [];
foreach ( $args as $k => $v ) {
if ( $v instanceof PPNode || $k === 0 ) {
$funcArgs[] = $v;
} else {
$funcArgs[] = $this->mPreprocessor->newPartNodeArray( [ $k => $v ] )->item( 0 );
}
}
# Add a frame parameter, and pass the arguments as an array
$allArgs[] = $frame;
$allArgs[] = $funcArgs;
} else {
# Convert arguments to plain text and append to $allArgs
foreach ( $args as $k => $v ) {
if ( $v instanceof PPNode ) {
$allArgs[] = trim( $frame->expand( $v ) );
} elseif ( is_int( $k ) && $k >= 0 ) {
$allArgs[] = trim( $v );
} else {
$allArgs[] = trim( "$k=$v" );
}
}
}
$result = $callback( ...$allArgs );
# The interface for function hooks allows them to return a wikitext
# string or an array containing the string and any flags. This mungs
# things around to match what this method should return.
if ( !is_array( $result ) ) {
$result = [
'found' => true,
'text' => $result,
];
} else {
if ( isset( $result[0] ) && !isset( $result['text'] ) ) {
$result['text'] = $result[0];
}
unset( $result[0] );
$result += [
'found' => true,
];
}
$noparse = true;
$preprocessFlags = 0;
if ( isset( $result['noparse'] ) ) {
$noparse = $result['noparse'];
}
if ( isset( $result['preprocessFlags'] ) ) {
$preprocessFlags = $result['preprocessFlags'];
}
if ( !$noparse ) {
$result['text'] = $this->preprocessToDom( $result['text'], $preprocessFlags );
$result['isChildObj'] = true;
}
return $result;
}
/**
* Get the semi-parsed DOM representation of a template with a given title,
* and its redirect destination title. Cached.
*
* @param LinkTarget $title
*
* @return array
* @since 1.12
*/
public function getTemplateDom( LinkTarget $title ) {
$cacheTitle = $title;
$titleKey = CacheKeyHelper::getKeyForPage( $title );
if ( isset( $this->mTplRedirCache[$titleKey] ) ) {
[ $ns, $dbk ] = $this->mTplRedirCache[$titleKey];
$title = Title::makeTitle( $ns, $dbk );
$titleKey = CacheKeyHelper::getKeyForPage( $title );
}
if ( isset( $this->mTplDomCache[$titleKey] ) ) {
return [ $this->mTplDomCache[$titleKey], $title ];
}
# Cache miss, go to the database
[ $text, $title ] = $this->fetchTemplateAndTitle( $title );
if ( $text === false ) {
$this->mTplDomCache[$titleKey] = false;
return [ false, $title ];
}
$dom = $this->preprocessToDom( $text, Preprocessor::DOM_FOR_INCLUSION );
$this->mTplDomCache[$titleKey] = $dom;
if ( !$title->isSamePageAs( $cacheTitle ) ) {
$this->mTplRedirCache[ CacheKeyHelper::getKeyForPage( $cacheTitle ) ] =
[ $title->getNamespace(), $title->getDBkey() ];
}
return [ $dom, $title ];
}
/**
* Fetch the current revision of a given title as a RevisionRecord.
* Note that the revision (and even the title) may not exist in the database,
* so everything contributing to the output of the parser should use this method
* where possible, rather than getting the revisions themselves. This
* method also caches its results, so using it benefits performance.
*
* This can return null if the callback returns false
*
* @since 1.35
* @param LinkTarget $link
* @return RevisionRecord|null
*/
public function fetchCurrentRevisionRecordOfTitle( LinkTarget $link ) {
$cacheKey = CacheKeyHelper::getKeyForPage( $link );
if ( !$this->currentRevisionCache ) {
$this->currentRevisionCache = new MapCacheLRU( 100 );
}
if ( !$this->currentRevisionCache->has( $cacheKey ) ) {
$title = Title::newFromLinkTarget( $link ); // hook signature compat
$revisionRecord =
// Defaults to Parser::statelessFetchRevisionRecord()
call_user_func(
$this->mOptions->getCurrentRevisionRecordCallback(),
$title,
$this
);
if ( $revisionRecord === false ) {
// Parser::statelessFetchRevisionRecord() can return false;
// normalize it to null.
$revisionRecord = null;
}
$this->currentRevisionCache->set( $cacheKey, $revisionRecord );
}
return $this->currentRevisionCache->get( $cacheKey );
}
/**
* @param LinkTarget $link
* @return bool
* @since 1.34
* @internal
*/
public function isCurrentRevisionOfTitleCached( LinkTarget $link ) {
$key = CacheKeyHelper::getKeyForPage( $link );
return (
$this->currentRevisionCache &&
$this->currentRevisionCache->has( $key )
);
}
/**
* Wrapper around RevisionLookup::getKnownCurrentRevision
*
* @since 1.34
* @param LinkTarget $link
* @param Parser|null $parser
* @return RevisionRecord|false False if missing
*/
public static function statelessFetchRevisionRecord( LinkTarget $link, $parser = null ) {
if ( $link instanceof PageIdentity ) {
// probably a Title, just use it.
$page = $link;
} else {
// XXX: use RevisionStore::getPageForLink()!
// ...but get the info for the current revision at the same time?
// Should RevisionStore::getKnownCurrentRevision accept a LinkTarget?
$page = Title::newFromLinkTarget( $link );
}
$revRecord = MediaWikiServices::getInstance()
->getRevisionLookup()
->getKnownCurrentRevision( $page );
return $revRecord;
}
/**
* Fetch the unparsed text of a template and register a reference to it.
* @param LinkTarget $link
* @return array ( string or false, Title )
* @since 1.11
*/
public function fetchTemplateAndTitle( LinkTarget $link ) {
// Use Title for compatibility with callbacks and return type
$title = Title::newFromLinkTarget( $link );
// Defaults to Parser::statelessFetchTemplate()
$templateCb = $this->mOptions->getTemplateCallback();
$stuff = $templateCb( $title, $this );
$revRecord = $stuff['revision-record'] ?? null;
$text = $stuff['text'];
if ( is_string( $stuff['text'] ) ) {
// We use U+007F DELETE to distinguish strip markers from regular text
$text = strtr( $text, "\x7f", "?" );
}
$finalTitle = $stuff['finalTitle'] ?? $title;
foreach ( ( $stuff['deps'] ?? [] ) as $dep ) {
$this->mOutput->addTemplate( $dep['title'], $dep['page_id'], $dep['rev_id'] );
if ( $dep['title']->equals( $this->getTitle() ) && $revRecord instanceof RevisionRecord ) {
// Self-transclusion; final result may change based on the new page version
try {
$sha1 = $revRecord->getSha1();
} catch ( RevisionAccessException $e ) {
$sha1 = null;
}
$this->setOutputFlag( ParserOutputFlags::VARY_REVISION_SHA1, 'Self transclusion' );
$this->getOutput()->setRevisionUsedSha1Base36( $sha1 );
}
}
return [ $text, $finalTitle ];
}
/**
* Static function to get a template
* Can be overridden via ParserOptions::setTemplateCallback().
*
* @param LinkTarget $page
* @param Parser|false $parser
*
* @return array
* @since 1.12
*/
public static function statelessFetchTemplate( $page, $parser = false ) {
$title = Title::castFromLinkTarget( $page ); // for compatibility with return type
$text = $skip = false;
$finalTitle = $title;
$deps = [];
$revRecord = null;
$contextTitle = $parser ? $parser->getTitle() : null;
# Loop to fetch the article, with up to 2 redirects
# Note that $title (including redirect targets) could be
# external; we do allow hooks a chance to redirect the
# external title to a local one (which might be useful), but
# are careful not to add external titles to the dependency
# list. (T362221)
$services = MediaWikiServices::getInstance();
$revLookup = $services->getRevisionLookup();
$hookRunner = new HookRunner( $services->getHookContainer() );
for ( $i = 0; $i < 3 && is_object( $title ); $i++ ) {
# Give extensions a chance to select the revision instead
$revRecord = null; # Assume no hook
$origTitle = $title;
$titleChanged = false;
$hookRunner->onBeforeParserFetchTemplateRevisionRecord(
# The $title is a not a PageIdentity, as it may
# contain fragments or even represent an attempt to transclude
# a broken or otherwise-missing Title, which the hook may
# fix up. Similarly, the $contextTitle may represent a special
# page or other page which "exists" as a parsing context but
# is not in the DB.
$contextTitle, $title,
$skip, $revRecord
);
if ( $skip ) {
$text = false;
if ( !$title->isExternal() ) {
$deps[] = [
'title' => $title,
'page_id' => $title->getArticleID(),
'rev_id' => null
];
}
break;
}
# Get the revision
if ( !$revRecord ) {
if ( $parser ) {
$revRecord = $parser->fetchCurrentRevisionRecordOfTitle( $title );
} else {
$revRecord = $revLookup->getRevisionByTitle( $title );
}
}
if ( $revRecord ) {
# Update title, as $revRecord may have been changed by hook
$title = Title::newFromLinkTarget(
$revRecord->getPageAsLinkTarget()
);
// Assuming title is not external if we've got a $revRecord
$deps[] = [
'title' => $title,
'page_id' => $revRecord->getPageId(),
'rev_id' => $revRecord->getId(),
];
} elseif ( !$title->isExternal() ) {
$deps[] = [
'title' => $title,
'page_id' => $title->getArticleID(),
'rev_id' => null,
];
}
if ( !$title->equals( $origTitle ) ) {
# If we fetched a rev from a different title, register
# the original title too...
if ( !$origTitle->isExternal() ) {
$deps[] = [
'title' => $origTitle,
'page_id' => $origTitle->getArticleID(),
'rev_id' => null,
];
}
$titleChanged = true;
}
# If there is no current revision, there is no page
if ( $revRecord === null || $revRecord->getId() === null ) {
$linkCache = $services->getLinkCache();
$linkCache->addBadLinkObj( $title );
}
if ( $revRecord ) {
if ( $titleChanged && !$revRecord->hasSlot( SlotRecord::MAIN ) ) {
// We've added this (missing) title to the dependencies;
// give the hook another chance to redirect it to an
// actual page.
$text = false;
$finalTitle = $title;
continue;
}
if ( $revRecord->hasSlot( SlotRecord::MAIN ) ) { // T276476
$content = $revRecord->getContent( SlotRecord::MAIN );
$text = $content ? $content->getWikitextForTransclusion() : null;
} else {
$text = false;
}
if ( $text === false || $text === null ) {
$text = false;
break;
}
} elseif ( $title->getNamespace() === NS_MEDIAWIKI ) {
$message = wfMessage( $services->getContentLanguage()->
lcfirst( $title->getText() ) )->inContentLanguage();
if ( !$message->exists() ) {
$text = false;
break;
}
$text = $message->plain();
break;
} else {
break;
}
// @phan-suppress-next-line PhanPossiblyUndeclaredVariable Only reached when content is set
if ( !$content ) {
break;
}
# Redirect?
$finalTitle = $title;
$title = $content->getRedirectTarget();
}
$retValues = [
// previously, when this also returned a Revision object, we set
// 'revision-record' to false instead of null if it was unavailable,
// so that callers to use isset and then rely on the revision-record
// key instead of the revision key, even if there was no corresponding
// object - we continue to set to false here for backwards compatability
'revision-record' => $revRecord ?: false,
'text' => $text,
'finalTitle' => $finalTitle,
'deps' => $deps
];
return $retValues;
}
/**
* Fetch a file and its title and register a reference to it.
* If 'broken' is a key in $options then the file will appear as a broken thumbnail.
* @param LinkTarget $link
* @param array $options Array of options to RepoGroup::findFile
* @return array ( File or false, Title of file )
* @since 1.18
*/
public function fetchFileAndTitle( LinkTarget $link, array $options = [] ) {
$file = $this->fetchFileNoRegister( $link, $options );
$time = $file ? $file->getTimestamp() : false;
$sha1 = $file ? $file->getSha1() : false;
# Register the file as a dependency...
$this->mOutput->addImage( $link, $time, $sha1 );
if ( $file && !$link->isSameLinkAs( $file->getTitle() ) ) {
# Update fetched file title after resolving redirects, etc.
$link = $file->getTitle();
$this->mOutput->addImage( $link, $time, $sha1 );
}
$title = Title::newFromLinkTarget( $link ); // for return type compat
return [ $file, $title ];
}
/**
* Helper function for fetchFileAndTitle.
*
* Also useful if you need to fetch a file but not use it yet,
* for example to get the file's handler.
*
* @param LinkTarget $link
* @param array $options Array of options to RepoGroup::findFile
* @return File|false
*/
protected function fetchFileNoRegister( LinkTarget $link, array $options = [] ) {
if ( isset( $options['broken'] ) ) {
$file = false; // broken thumbnail forced by hook
} else {
$repoGroup = MediaWikiServices::getInstance()->getRepoGroup();
if ( isset( $options['sha1'] ) ) { // get by (sha1,timestamp)
$file = $repoGroup->findFileFromKey( $options['sha1'], $options );
} else { // get by (name,timestamp)
$file = $repoGroup->findFile( $link, $options );
}
}
return $file;
}
/**
* Transclude an interwiki link.
*
* @param LinkTarget $link
* @param string $action Usually one of (raw, render)
*
* @return string
* @internal
*/
public function interwikiTransclude( LinkTarget $link, $action ) {
if ( !$this->svcOptions->get( MainConfigNames::EnableScaryTranscluding ) ) {
return wfMessage( 'scarytranscludedisabled' )->inContentLanguage()->text();
}
// TODO: extract relevant functionality from Title
$title = Title::newFromLinkTarget( $link );
$url = $title->getFullURL( [ 'action' => $action ] );
if ( strlen( $url ) > 1024 ) {
return wfMessage( 'scarytranscludetoolong' )->inContentLanguage()->text();
}
$wikiId = $title->getTransWikiID(); // remote wiki ID or false
$fname = __METHOD__;
$cache = $this->wanCache;
$data = $cache->getWithSetCallback(
$cache->makeGlobalKey(
'interwiki-transclude',
( $wikiId !== false ) ? $wikiId : 'external',
sha1( $url )
),
$this->svcOptions->get( MainConfigNames::TranscludeCacheExpiry ),
function ( $oldValue, &$ttl ) use ( $url, $fname, $cache ) {
$req = $this->httpRequestFactory->create( $url, [], $fname );
$status = $req->execute(); // Status object
if ( !$status->isOK() ) {
$ttl = $cache::TTL_UNCACHEABLE;
} elseif ( $req->getResponseHeader( 'X-Database-Lagged' ) !== null ) {
$ttl = min( $cache::TTL_LAGGED, $ttl );
}
return [
'text' => $status->isOK() ? $req->getContent() : null,
'code' => $req->getStatus()
];
},
[
'checkKeys' => ( $wikiId !== false )
? [ $cache->makeGlobalKey( 'interwiki-page', $wikiId, $title->getDBkey() ) ]
: [],
'pcGroup' => 'interwiki-transclude:5',
'pcTTL' => $cache::TTL_PROC_LONG
]
);
if ( is_string( $data['text'] ) ) {
$text = $data['text'];
} elseif ( $data['code'] != 200 ) {
// Though we failed to fetch the content, this status is useless.
$text = wfMessage( 'scarytranscludefailed-httpstatus' )
->params( $url, $data['code'] )->inContentLanguage()->text();
} else {
$text = wfMessage( 'scarytranscludefailed', $url )->inContentLanguage()->text();
}
return $text;
}
/**
* Triple brace replacement -- used for template arguments
*
* @param array $piece
* @param PPFrame $frame
*
* @return array
* @internal
*/
public function argSubstitution( array $piece, PPFrame $frame ) {
$error = false;
$parts = $piece['parts'];
$nameWithSpaces = $frame->expand( $piece['title'] );
$argName = trim( $nameWithSpaces );
$object = false;
$text = $frame->getArgument( $argName );
if ( $text === false && $parts->getLength() > 0
&& ( $this->ot['html']
|| $this->ot['pre']
|| ( $this->ot['wiki'] && $frame->isTemplate() )
)
) {
# No match in frame, use the supplied default
$object = $parts->item( 0 )->getChildren();
}
if ( !$this->incrementIncludeSize( 'arg', strlen( $text ) ) ) {
$error = '<!-- WARNING: argument omitted, expansion size too large -->';
$this->limitationWarn( 'post-expand-template-argument' );
}
if ( $text === false && $object === false ) {
# No match anywhere
$object = $frame->virtualBracketedImplode( '{{{', '|', '}}}', $nameWithSpaces, $parts );
}
if ( $error !== false ) {
$text .= $error;
}
if ( $object !== false ) {
$ret = [ 'object' => $object ];
} else {
$ret = [ 'text' => $text ];
}
return $ret;
}
/**
* @param string $lowerTagName
* @return bool
*/
public function tagNeedsNowikiStrippedInTagPF( string $lowerTagName ): bool {
$parsoidSiteConfig = MediaWikiServices::getInstance()->getParsoidSiteConfig();
return $parsoidSiteConfig->tagNeedsNowikiStrippedInTagPF( $lowerTagName );
}
/**
* Return the text to be used for a given extension tag.
* This is the ghost of strip().
*
* @param array $params Associative array of parameters:
* name PPNode for the tag name
* attr PPNode for unparsed text where tag attributes are thought to be
* attributes Optional associative array of parsed attributes
* inner Contents of extension element
* noClose Original text did not have a close tag
* @param PPFrame $frame
* @param bool $processNowiki Process nowiki tags by running the nowiki tag handler
* Normally, nowikis are only processed for the HTML output type. With this
* arg set to true, they are processed (and converted to a nowiki strip marker)
* for all output types.
* @return string
* @internal
* @since 1.12
*/
public function extensionSubstitution( array $params, PPFrame $frame, bool $processNowiki = false ) {
static $errorStr = '<span class="error">';
$name = $frame->expand( $params['name'] );
if ( str_starts_with( $name, $errorStr ) ) {
// Probably expansion depth or node count exceeded. Just punt the
// error up.
return $name;
}
// Parse attributes from XML-like wikitext syntax
$attrText = !isset( $params['attr'] ) ? '' : $frame->expand( $params['attr'] );
if ( str_starts_with( $attrText, $errorStr ) ) {
// See above
return $attrText;
}
// We can't safely check if the expansion for $content resulted in an
// error, because the content could happen to be the error string
// (T149622).
$content = !isset( $params['inner'] ) ? null : $frame->expand( $params['inner'] );
$marker = self::MARKER_PREFIX . "-$name-"
. sprintf( '%08X', $this->mMarkerIndex++ ) . self::MARKER_SUFFIX;
$normalizedName = strtolower( $name );
$isNowiki = $normalizedName === 'nowiki';
$markerType = $isNowiki ? 'nowiki' : 'general';
if ( $this->ot['html'] || ( $processNowiki && $isNowiki ) ) {
$attributes = Sanitizer::decodeTagAttributes( $attrText );
// Merge in attributes passed via {{#tag:}} parser function
if ( isset( $params['attributes'] ) ) {
$attributes += $params['attributes'];
}
if ( isset( $this->mTagHooks[$normalizedName] ) ) {
// Note that $content may be null here, for example if the
// tag is self-closed.
$output = call_user_func_array( $this->mTagHooks[$normalizedName],
[ $content, $attributes, $this, $frame ] );
} else {
$output = '<span class="error">Invalid tag extension name: ' .
htmlspecialchars( $normalizedName ) . '</span>';
}
if ( is_array( $output ) ) {
// Extract flags
$flags = $output;
$output = $flags[0];
if ( isset( $flags['markerType'] ) ) {
$markerType = $flags['markerType'];
}
}
} else {
// We're substituting a {{subst:#tag:}} parser function.
// Convert the attributes it passed into the XML-like string.
if ( isset( $params['attributes'] ) ) {
foreach ( $params['attributes'] as $attrName => $attrValue ) {
$attrText .= ' ' . htmlspecialchars( $attrName ) . '="' .
htmlspecialchars( $this->getStripState()->unstripBoth( $attrValue ), ENT_COMPAT ) . '"';
}
}
if ( $content === null ) {
$output = "<$name$attrText/>";
} else {
$close = $params['close'] === null ? '' : $frame->expand( $params['close'] );
if ( str_starts_with( $close, $errorStr ) ) {
// See above
return $close;
}
$output = "<$name$attrText>$content$close";
}
}
if ( $markerType === 'none' ) {
return $output;
} elseif ( $markerType === 'nowiki' ) {
$this->mStripState->addNoWiki( $marker, $output );
} elseif ( $markerType === 'general' ) {
$this->mStripState->addGeneral( $marker, $output );
} else {
throw new UnexpectedValueException( __METHOD__ . ': invalid marker type' );
}
return $marker;
}
/**
* Increment an include size counter
*
* @param string $type The type of expansion
* @param int $size The size of the text
* @return bool False if this inclusion would take it over the maximum, true otherwise
*/
private function incrementIncludeSize( $type, $size ) {
if ( $this->mIncludeSizes[$type] + $size > $this->mOptions->getMaxIncludeSize() ) {
return false;
} else {
$this->mIncludeSizes[$type] += $size;
return true;
}
}
/**
* @return bool False if the limit has been exceeded
* @since 1.13
*/
public function incrementExpensiveFunctionCount() {
$this->mExpensiveFunctionCount++;
return $this->mExpensiveFunctionCount <= $this->mOptions->getExpensiveParserFunctionLimit();
}
/**
* Strip double-underscore items like __NOGALLERY__ and __NOTOC__
* Fills $this->mDoubleUnderscores, returns the modified text
*
* @param string $text
* @return string
*/
private function handleDoubleUnderscore( $text ) {
# The position of __TOC__ needs to be recorded
$mw = $this->magicWordFactory->get( 'toc' );
if ( $mw->match( $text ) ) {
$this->mShowToc = true;
$this->mForceTocPosition = true;
# Set a placeholder. At the end we'll fill it in with the TOC.
$text = $mw->replace( self::TOC_PLACEHOLDER, $text, 1 );
# Only keep the first one.
$text = $mw->replace( '', $text );
# For consistency with all other double-underscores
# (see below)
$this->mOutput->setUnsortedPageProperty( 'toc' );
}
# Now match and remove the rest of them
$mwa = $this->magicWordFactory->getDoubleUnderscoreArray();
$this->mDoubleUnderscores = $mwa->matchAndRemove( $text );
if ( isset( $this->mDoubleUnderscores['nogallery'] ) ) {
$this->mOutput->setNoGallery( true );
}
if ( isset( $this->mDoubleUnderscores['notoc'] ) && !$this->mForceTocPosition ) {
$this->mShowToc = false;
}
if ( isset( $this->mDoubleUnderscores['hiddencat'] )
&& $this->getTitle()->getNamespace() === NS_CATEGORY
) {
$this->addTrackingCategory( 'hidden-category-category' );
}
# (T10068) Allow control over whether robots index a page.
# __INDEX__ always overrides __NOINDEX__, see T16899
if ( isset( $this->mDoubleUnderscores['noindex'] ) && $this->getTitle()->canUseNoindex() ) {
$this->mOutput->setIndexPolicy( 'noindex' );
$this->addTrackingCategory( 'noindex-category' );
}
if ( isset( $this->mDoubleUnderscores['index'] ) && $this->getTitle()->canUseNoindex() ) {
$this->mOutput->setIndexPolicy( 'index' );
$this->addTrackingCategory( 'index-category' );
}
# Cache all double underscores in the database
foreach ( $this->mDoubleUnderscores as $key => $val ) {
$this->mOutput->setUnsortedPageProperty( $key );
}
return $text;
}
/**
* @see TrackingCategories::addTrackingCategory()
* @param string $msg Message key
* @return bool Whether the addition was successful
* @since 1.19 method is public
*/
public function addTrackingCategory( $msg ) {
return $this->trackingCategories->addTrackingCategory(
$this->mOutput, $msg, $this->getPage()
);
}
/**
* Helper function to correctly set the target language and title of
* a message based on the parser context. Most uses of system messages
* inside extensions or parser functions should use this method (instead
* of directly using `wfMessage`) to ensure that the cache is not
* polluted.
*
* @param string $msg The localization message key
* @param mixed ...$args Optional arguments for the message
* @return Message
* @since 1.40
* @see https://phabricator.wikimedia.org/T202481
*/
public function msg( string $msg, ...$args ): Message {
return wfMessage( $msg, ...$args )
->inLanguage( $this->getTargetLanguage() )
->page( $this->getPage() );
}
private function cleanUpTocLine( Node $container ) {
'@phan-var Element|DocumentFragment $container'; // @var Element|DocumentFragment $container
# Strip out HTML
# Allowed tags are:
# * <sup> and <sub> (T10393)
# * <i> (T28375)
# * <b> (r105284)
# * <bdi> (T74884)
# * <span dir="rtl"> and <span dir="ltr"> (T37167)
# * <s> and <strike> (T35715)
# * <q> (T251672)
# We strip any parameter from accepted tags, except dir="rtl|ltr" from <span>,
# to allow setting directionality in toc items.
$allowedTags = [ 'span', 'sup', 'sub', 'bdi', 'i', 'b', 's', 'strike', 'q' ];
$node = $container->firstChild;
while ( $node !== null ) {
$next = $node->nextSibling;
if ( $node instanceof Element ) {
$nodeName = DOMCompat::nodeName( $node );
if ( in_array( $nodeName, [ 'style', 'script' ], true ) ) {
# Remove any <style> or <script> tags (T198618)
DOMCompat::remove( $node );
} elseif ( in_array( $nodeName, $allowedTags, true ) ) {
// Keep tag, remove attributes
$removeAttrs = [];
foreach ( $node->attributes as $attr ) {
if (
$nodeName === 'span' && $attr->name === 'dir'
&& ( $attr->value === 'rtl' || $attr->value === 'ltr' )
) {
// Keep <span dir="rtl"> and <span dir="ltr">
continue;
}
$removeAttrs[] = $attr;
}
foreach ( $removeAttrs as $attr ) {
$node->removeAttributeNode( $attr );
}
$this->cleanUpTocLine( $node );
# Strip '<span></span>', which is the result from the above if
# <span id="foo"></span> is used to produce an additional anchor
# for a section.
if ( $nodeName === 'span' && !$node->hasChildNodes() ) {
DOMCompat::remove( $node );
}
} else {
// Strip tag
$next = $node->firstChild;
// phpcs:ignore Generic.CodeAnalysis.AssignmentInCondition.FoundInWhileCondition
while ( $childNode = $node->firstChild ) {
$node->parentNode->insertBefore( $childNode, $node );
}
DOMCompat::remove( $node );
}
} elseif ( $node instanceof Comment ) {
// Extensions may add comments to headings;
// these shouldn't appear in the ToC either.
DOMCompat::remove( $node );
}
$node = $next;
}
}
/**
* This function accomplishes several tasks:
* 1) Auto-number headings if that option is enabled
* 2) Add an [edit] link to sections for users who have enabled the option and can edit the page
* 3) Add a Table of contents on the top for users who have enabled the option
* 4) Auto-anchor headings
*
* It loops through all headlines, collects the necessary data, then splits up the
* string and re-inserts the newly formatted headlines.
*
* @param string $text
* @param string $origText Original, untouched wikitext
* @param bool $isMain
* @return string
*/
private function finalizeHeadings( $text, $origText, $isMain = true ) {
# Inhibit editsection links if requested in the page
if ( isset( $this->mDoubleUnderscores['noeditsection'] ) ) {
$maybeShowEditLink = false;
} else {
$maybeShowEditLink = true; /* Actual presence will depend on post-cache transforms */
}
# Get all headlines for numbering them and adding funky stuff like [edit]
# links - this is for later, but we need the number of headlines right now
# NOTE: white space in headings have been trimmed in handleHeadings. They shouldn't
# be trimmed here since whitespace in HTML headings is significant.
$matches = [];
$numMatches = preg_match_all(
'/<H(?P<level>[1-6])(?P<attrib>.*?>)(?P<header>[\s\S]*?)<\/H[1-6] *>/i',
$text,
$matches
);
# if there are fewer than 4 headlines in the article, do not show TOC
# unless it's been explicitly enabled.
$enoughToc = $this->mShowToc &&
( ( $numMatches >= 4 ) || $this->mForceTocPosition );
# Allow user to stipulate that a page should have a "new section"
# link added via __NEWSECTIONLINK__
if ( isset( $this->mDoubleUnderscores['newsectionlink'] ) ) {
$this->mOutput->setNewSection( true );
}
# Allow user to remove the "new section"
# link via __NONEWSECTIONLINK__
if ( isset( $this->mDoubleUnderscores['nonewsectionlink'] ) ) {
$this->mOutput->setHideNewSection( true );
}
# if the string __FORCETOC__ (not case-sensitive) occurs in the HTML,
# override above conditions and always show TOC above first header
if ( isset( $this->mDoubleUnderscores['forcetoc'] ) ) {
$this->mShowToc = true;
$enoughToc = true;
}
# headline counter
$headlineCount = 0;
$haveTocEntries = false;
# Ugh .. the TOC should have neat indentation levels which can be
# passed to the skin functions. These are determined here
$full = '';
$head = [];
$level = 0;
$tocData = new TOCData();
$markerRegex = self::MARKER_PREFIX . "-h-(\d+)-" . self::MARKER_SUFFIX;
$baseTitleText = $this->getTitle()->getPrefixedDBkey();
$oldType = $this->mOutputType;
$this->setOutputType( self::OT_WIKI );
$frame = $this->getPreprocessor()->newFrame();
$root = $this->preprocessToDom( $origText );
$node = $root->getFirstChild();
$cpOffset = 0;
$refers = [];
$headlines = $numMatches !== false ? $matches[3] : [];
$maxTocLevel = $this->svcOptions->get( MainConfigNames::MaxTocLevel );
$domDocument = DOMUtils::parseHTML( '' );
foreach ( $headlines as $headline ) {
$isTemplate = false;
$titleText = false;
$sectionIndex = false;
$markerMatches = [];
if ( preg_match( "/^$markerRegex/", $headline, $markerMatches ) ) {
$serial = (int)$markerMatches[1];
[ $titleText, $sectionIndex ] = $this->mHeadings[$serial];
$isTemplate = ( $titleText != $baseTitleText );
$headline = preg_replace( "/^$markerRegex\\s*/", "", $headline );
}
$sectionMetadata = SectionMetadata::fromLegacy( [
"fromtitle" => $titleText ?: null,
"index" => $sectionIndex === false
? '' : ( ( $isTemplate ? 'T-' : '' ) . $sectionIndex )
] );
$tocData->addSection( $sectionMetadata );
$oldLevel = $level;
$level = (int)$matches[1][$headlineCount];
$tocData->processHeading( $oldLevel, $level, $sectionMetadata );
if ( $tocData->getCurrentTOCLevel() < $maxTocLevel ) {
$haveTocEntries = true;
}
# The safe header is a version of the header text safe to use for links
# Remove link placeholders by the link text.
# <!--LINK number-->
# turns into
# link text with suffix
# Do this before unstrip since link text can contain strip markers
$safeHeadline = $this->replaceLinkHoldersText( $headline );
# Avoid insertion of weird stuff like <math> by expanding the relevant sections
$safeHeadline = $this->mStripState->unstripBoth( $safeHeadline );
// Run Tidy to convert wikitext entities to HTML entities (T355386),
// conveniently also giving us a way to handle French spaces (T324763)
$safeHeadline = $this->tidy->tidy( $safeHeadline, [ Sanitizer::class, 'armorFrenchSpaces' ] );
// Parse the heading contents as HTML. This makes it easier to strip out some HTML tags,
// and ensures that we generate balanced HTML at the end (T218330).
$headlineDom = DOMUtils::parseHTMLToFragment( $domDocument, $safeHeadline );
$this->cleanUpTocLine( $headlineDom );
// Serialize back to HTML
$tocline = trim( DOMUtils::getFragmentInnerHTML( $headlineDom ) );
# For the anchor, strip out HTML-y stuff period
$safeHeadline = trim( $headlineDom->textContent );
# Save headline for section edit hint before it's normalized for the link
$headlineHint = htmlspecialchars( $safeHeadline );
$safeHeadline = Sanitizer::normalizeSectionNameWhitespace( $safeHeadline );
$safeHeadline = self::normalizeSectionName( $safeHeadline );
$fallbackHeadline = Sanitizer::escapeIdForAttribute( $safeHeadline, Sanitizer::ID_FALLBACK );
$linkAnchor = Sanitizer::escapeIdForLink( $safeHeadline );
$safeHeadline = Sanitizer::escapeIdForAttribute( $safeHeadline, Sanitizer::ID_PRIMARY );
if ( $fallbackHeadline === $safeHeadline ) {
# No reason to have both (in fact, we can't)
$fallbackHeadline = false;
}
# HTML IDs must be case-insensitively unique for IE compatibility (T12721).
$arrayKey = strtolower( $safeHeadline );
if ( $fallbackHeadline === false ) {
$fallbackArrayKey = false;
} else {
$fallbackArrayKey = strtolower( $fallbackHeadline );
}
# Create the anchor for linking from the TOC to the section
$anchor = $safeHeadline;
$fallbackAnchor = $fallbackHeadline;
if ( isset( $refers[$arrayKey] ) ) {
for ( $i = 2; isset( $refers["{$arrayKey}_$i"] ); ++$i );
$anchor .= "_$i";
$linkAnchor .= "_$i";
$refers["{$arrayKey}_$i"] = true;
} else {
$refers[$arrayKey] = true;
}
if ( $fallbackHeadline !== false && isset( $refers[$fallbackArrayKey] ) ) {
for ( $i = 2; isset( $refers["{$fallbackArrayKey}_$i"] ); ++$i );
$fallbackAnchor .= "_$i";
$refers["{$fallbackArrayKey}_$i"] = true;
} else {
$refers[$fallbackArrayKey] = true;
}
# Add the section to the section tree
# Find the DOM node for this header
$noOffset = ( $isTemplate || $sectionIndex === false );
while ( $node && !$noOffset ) {
if ( $node->getName() === 'h' ) {
$bits = $node->splitHeading();
if ( $bits['i'] == $sectionIndex ) {
break;
}
}
$cpOffset += mb_strlen(
$this->mStripState->unstripBoth(
$frame->expand( $node, PPFrame::RECOVER_ORIG )
)
);
$node = $node->getNextSibling();
}
$sectionMetadata->line = $tocline;
$sectionMetadata->codepointOffset = ( $noOffset ? null : $cpOffset );
$sectionMetadata->anchor = $anchor;
$sectionMetadata->linkAnchor = $linkAnchor;
if ( $maybeShowEditLink && $sectionIndex !== false ) {
// Output edit section links as markers with styles that can be customized by skins
if ( $isTemplate ) {
# Put a T flag in the section identifier, to indicate to extractSections()
# that sections inside <includeonly> should be counted.
$editsectionPage = $titleText;
$editsectionSection = "T-$sectionIndex";
} else {
$editsectionPage = $this->getTitle()->getPrefixedText();
$editsectionSection = $sectionIndex;
}
// Construct a pseudo-HTML tag as a placeholder for the section edit link. It is replaced in
// MediaWiki\OutputTransform\Stages\HandleSectionLinks with the real link.
//
// Any HTML markup in the input has already been escaped,
// so we don't have to worry about a user trying to input one of these markers directly.
//
// We put the page and section in attributes to stop the language converter from
// converting them, but put the headline hint in tag content
// because it is supposed to be able to convert that.
$editlink = '<mw:editsection page="' . htmlspecialchars( $editsectionPage, ENT_COMPAT );
$editlink .= '" section="' . htmlspecialchars( $editsectionSection, ENT_COMPAT ) . '"';
$editlink .= '>' . $headlineHint . '</mw:editsection>';
} else {
$editlink = '';
}
// Reconstruct the original <h#> tag with added attributes. It is replaced in
// MediaWiki\OutputTransform\Stages\HandleSectionLinks to add anchors and stuff.
//
// data-mw-... attributes are forbidden in Sanitizer::isReservedDataAttribute(),
// so we don't have to worry about a user trying to input one of these markers directly.
//
// We put the anchors in attributes to stop the language converter from converting them.
$head[$headlineCount] = "<h$level" . Html::expandAttributes( [
'data-mw-anchor' => $anchor,
'data-mw-fallback-anchor' => $fallbackAnchor,
] ) . $matches['attrib'][$headlineCount] . $headline . $editlink . "</h$level>";
$headlineCount++;
}
$this->setOutputType( $oldType );
# Never ever show TOC if no headers (or suppressed)
$suppressToc = $this->mOptions->getSuppressTOC();
if ( !$haveTocEntries ) {
$enoughToc = false;
}
$addTOCPlaceholder = false;
if ( $isMain && !$suppressToc ) {
// We generally output the section information via the API
// even if there isn't "enough" of a ToC to merit showing
// it -- but the "suppress TOC" parser option is set when
// any sections that might be found aren't "really there"
// (ie, JavaScript content that might have spurious === or
// <h2>: T307691) so we will *not* set section information
// in that case.
$this->mOutput->setTOCData( $tocData );
// T294950: Record a suggestion that the TOC should be shown.
// Skins are free to ignore this suggestion and implement their
// own criteria for showing/suppressing TOC (T318186).
if ( $enoughToc ) {
$this->mOutput->setOutputFlag( ParserOutputFlags::SHOW_TOC );
if ( !$this->mForceTocPosition ) {
$addTOCPlaceholder = true;
}
}
// If __NOTOC__ is used on the page (and not overridden by
// __TOC__ or __FORCETOC__) set the NO_TOC flag to tell
// the skin that although the section information is
// valid, it should perhaps not be presented as a Table Of
// Contents.
if ( !$this->mShowToc ) {
$this->mOutput->setOutputFlag( ParserOutputFlags::NO_TOC );
}
}
# split up and insert constructed headlines
$blocks = preg_split( '/<h[1-6]\b[^>]*>.*?<\/h[1-6]>/is', $text );
$i = 0;
// build an array of document sections
$sections = [];
foreach ( $blocks as $block ) {
// $head is zero-based, sections aren't.
if ( empty( $head[$i - 1] ) ) {
$sections[$i] = $block;
} else {
$sections[$i] = $head[$i - 1] . $block;
}
$i++;
}
if ( $addTOCPlaceholder ) {
// append the TOC at the beginning
// Top anchor now in skin
// @phan-suppress-next-line PhanTypePossiblyInvalidDimOffset At least one element when enoughToc is true
$sections[0] .= self::TOC_PLACEHOLDER . "\n";
}
$full .= implode( '', $sections );
return $full;
}
/**
* Localize the TOC into the given target language; this includes
* invoking the language converter on the headings.
* @param ?TOCData $tocData The Table of Contents
* @param Language $lang The target language
* @param ?ILanguageConverter $converter The target language converter, or
* null if language conversion is to be suppressed.
* @internal
*/
private static function localizeTOC(
?TOCData $tocData, Language $lang, ?ILanguageConverter $converter
) {
if ( $tocData === null ) {
return; // Nothing to do
}
foreach ( $tocData->getSections() as $s ) {
// Localize heading
if ( $converter ) {
// T331316: don't use 'convert' or 'convertTo' as these reset
// the language converter state.
$s->line = $converter->convertTo(
$s->line, $converter->getPreferredVariant(), false
);
}
// Localize numbering
$dot = '.';
$pieces = explode( $dot, $s->number );
$numbering = '';
foreach ( $pieces as $i => $p ) {
if ( $i > 0 ) {
$numbering .= $dot;
}
$numbering .= $lang->formatNum( $p );
}
$s->number = $numbering;
}
}
/**
* Transform wiki markup when saving a page by doing "\r\n" -> "\n"
* conversion, substituting signatures, {{subst:}} templates, etc.
*
* @param string $text The text to transform
* @param PageReference $page the current article
* @param UserIdentity $user the current user
* @param ParserOptions $options Parsing options
* @param bool $clearState Whether to clear the parser state first
* @return string The altered wiki markup
* @since 1.3
*/
public function preSaveTransform(
$text,
PageReference $page,
UserIdentity $user,
ParserOptions $options,
$clearState = true
) {
if ( $clearState ) {
$magicScopeVariable = $this->lock();
}
$this->startParse( $page, $options, self::OT_WIKI, $clearState );
$this->setUser( $user );
// Strip U+0000 NULL (T159174)
$text = str_replace( "\000", '', $text );
// We still normalize line endings (including trimming trailing whitespace) for
// backwards-compatibility with other code that just calls PST, but this should already
// be handled in TextContent subclasses
$text = TextContent::normalizeLineEndings( $text );
if ( $options->getPreSaveTransform() ) {
$text = $this->pstPass2( $text, $user );
}
$text = $this->mStripState->unstripBoth( $text );
// Trim trailing whitespace again, because the previous steps can introduce it.
$text = rtrim( $text );
$this->hookRunner->onParserPreSaveTransformComplete( $this, $text );
$this->setUser( null ); # Reset
return $text;
}
/**
* Pre-save transform helper function
*
* @param string $text
* @param UserIdentity $user
*
* @return string
*/
private function pstPass2( $text, UserIdentity $user ) {
# Note: This is the timestamp saved as hardcoded wikitext to the database, we use
# $this->contLang here in order to give everyone the same signature and use the default one
# rather than the one selected in each user's preferences. (see also T14815)
$ts = $this->mOptions->getTimestamp();
$timestamp = MWTimestamp::getLocalInstance( $ts );
$ts = $timestamp->format( 'YmdHis' );
$tzMsg = $timestamp->getTimezoneMessage()->inContentLanguage()->text();
$d = $this->contLang->timeanddate( $ts, false, false ) . " ($tzMsg)";
# Variable replacement
# Because mOutputType is OT_WIKI, this will only process {{subst:xxx}} type tags
$text = $this->replaceVariables( $text );
# This works almost by chance, as the replaceVariables are done before the getUserSig(),
# which may corrupt this parser instance via its wfMessage()->text() call-
# Signatures
if ( strpos( $text, '~~~' ) !== false ) {
$sigText = $this->getUserSig( $user );
$text = strtr( $text, [
'~~~~~' => $d,
'~~~~' => "$sigText $d",
'~~~' => $sigText
] );
# The main two signature forms used above are time-sensitive
$this->setOutputFlag( ParserOutputFlags::USER_SIGNATURE, 'User signature detected' );
}
# Context links ("pipe tricks"): [[|name]] and [[name (context)|]]
$tc = '[' . Title::legalChars() . ']';
$nc = '[ _0-9A-Za-z\x80-\xff-]'; # Namespaces can use non-ascii!
// [[ns:page (context)|]]
$p1 = "/\[\[(:?$nc+:|:|)($tc+?)( ?\\($tc+\\))\\|]]/";
// [[ns:page(context)|]] (double-width brackets, added in r40257)
$p4 = "/\[\[(:?$nc+:|:|)($tc+?)( ?($tc+))\\|]]/";
// [[ns:page (context), context|]] (using single, double-width or Arabic comma)
$p3 = "/\[\[(:?$nc+:|:|)($tc+?)( ?\\($tc+\\)|)((?:, |,|، )$tc+|)\\|]]/";
// [[|page]] (reverse pipe trick: add context from page title)
$p2 = "/\[\[\\|($tc+)]]/";
# try $p1 first, to turn "[[A, B (C)|]]" into "[[A, B (C)|A, B]]"
$text = preg_replace( $p1, '[[\\1\\2\\3|\\2]]', $text );
$text = preg_replace( $p4, '[[\\1\\2\\3|\\2]]', $text );
$text = preg_replace( $p3, '[[\\1\\2\\3\\4|\\2]]', $text );
$t = $this->getTitle()->getText();
$m = [];
if ( preg_match( "/^($nc+:|)$tc+?( \\($tc+\\))$/", $t, $m ) ) {
$text = preg_replace( $p2, "[[$m[1]\\1$m[2]|\\1]]", $text );
} elseif ( preg_match( "/^($nc+:|)$tc+?(, $tc+|)$/", $t, $m ) && "$m[1]$m[2]" != '' ) {
$text = preg_replace( $p2, "[[$m[1]\\1$m[2]|\\1]]", $text );
} else {
# if there's no context, don't bother duplicating the title
$text = preg_replace( $p2, '[[\\1]]', $text );
}
return $text;
}
/**
* Fetch the user's signature text, if any, and normalize to
* validated, ready-to-insert wikitext.
* If you have pre-fetched the nickname or the fancySig option, you can
* specify them here to save a database query.
* Do not reuse this parser instance after calling getUserSig(),
* as it may have changed.
*
* @param UserIdentity $user
* @param string|false $nickname Nickname to use or false to use user's default nickname
* @param bool|null $fancySig whether the nicknname is the complete signature
* or null to use default value
* @return string
* @since 1.6
*/
public function getUserSig( UserIdentity $user, $nickname = false, $fancySig = null ) {
$username = $user->getName();
# If not given, retrieve from the user object.
if ( $nickname === false ) {
$nickname = $this->userOptionsLookup->getOption( $user, 'nickname' );
}
$fancySig ??= $this->userOptionsLookup->getBoolOption( $user, 'fancysig' );
if ( $nickname === null || $nickname === '' ) {
// Empty value results in the default signature (even when fancysig is enabled)
$nickname = $username;
} elseif ( mb_strlen( $nickname ) > $this->svcOptions->get( MainConfigNames::MaxSigChars ) ) {
$nickname = $username;
$this->logger->debug( __METHOD__ . ": $username has overlong signature." );
} elseif ( $fancySig !== false ) {
# Sig. might contain markup; validate this
$isValid = $this->validateSig( $nickname ) !== false;
# New validator
$sigValidation = $this->svcOptions->get( MainConfigNames::SignatureValidation );
if ( $isValid && $sigValidation === 'disallow' ) {
$parserOpts = new ParserOptions(
$this->mOptions->getUserIdentity(),
$this->contLang
);
$validator = $this->signatureValidatorFactory
->newSignatureValidator( $user, null, $parserOpts );
$isValid = !$validator->validateSignature( $nickname );
}
if ( $isValid ) {
# Validated; clean up (if needed) and return it
return $this->cleanSig( $nickname, true );
} else {
# Failed to validate; fall back to the default
$nickname = $username;
$this->logger->debug( __METHOD__ . ": $username has invalid signature." );
}
}
# Make sure nickname doesnt get a sig in a sig
$nickname = self::cleanSigInSig( $nickname );
# If we're still here, make it a link to the user page
$userText = wfEscapeWikiText( $username );
$nickText = wfEscapeWikiText( $nickname );
if ( $this->userNameUtils->isTemp( $username ) ) {
$msgName = 'signature-temp';
} elseif ( $user->isRegistered() ) {
$msgName = 'signature';
} else {
$msgName = 'signature-anon';
}
return wfMessage( $msgName, $userText, $nickText )->inContentLanguage()
->page( $this->getPage() )->text();
}
/**
* Check that the user's signature contains no bad XML
*
* @param string $text
* @return string|false An expanded string, or false if invalid.
* @since 1.6
*/
public function validateSig( $text ) {
return Xml::isWellFormedXmlFragment( $text ) ? $text : false;
}
/**
* Clean up signature text
*
* 1) Strip 3, 4 or 5 tildes out of signatures @see cleanSigInSig
* 2) Substitute all transclusions
*
* @param string $text
* @param bool $parsing Whether we're cleaning (preferences save) or parsing
* @return string Signature text
* @since 1.6
*/
public function cleanSig( $text, $parsing = false ) {
if ( !$parsing ) {
$magicScopeVariable = $this->lock();
$this->startParse(
$this->mTitle,
ParserOptions::newFromUser( RequestContext::getMain()->getUser() ),
self::OT_PREPROCESS,
true
);
}
# Option to disable this feature
if ( !$this->mOptions->getCleanSignatures() ) {
return $text;
}
# @todo FIXME: Regex doesn't respect extension tags or nowiki
# => Move this logic to braceSubstitution()
$substWord = $this->magicWordFactory->get( 'subst' );
$substRegex = '/\{\{(?!(?:' . $substWord->getBaseRegex() . '))/x' . $substWord->getRegexCase();
$substText = '{{' . $substWord->getSynonym( 0 );
$text = preg_replace( $substRegex, $substText, $text );
$text = self::cleanSigInSig( $text );
$dom = $this->preprocessToDom( $text );
$frame = $this->getPreprocessor()->newFrame();
$text = $frame->expand( $dom );
if ( !$parsing ) {
$text = $this->mStripState->unstripBoth( $text );
}
return $text;
}
/**
* Strip 3, 4 or 5 tildes out of signatures.
*
* @param string $text
* @return string Signature text with /~{3,5}/ removed
* @since 1.7
*/
public static function cleanSigInSig( $text ) {
$text = preg_replace( '/~{3,5}/', '', $text );
return $text;
}
/**
* Replace table of contents marker in parsed HTML.
*
* Used to remove or replace the marker. This method should be
* used instead of direct access to Parser::TOC_PLACEHOLDER, since
* in the future the placeholder might have additional attributes
* attached which should be ignored when the replacement is made.
*
* @since 1.38
* @stable
*
* @param string $text Parsed HTML
* @param string $toc HTML table of contents string, or else an empty
* string to remove the marker.
* @return string Result HTML
*/
public static function replaceTableOfContentsMarker( $text, $toc ) {
$replaced = false;
// remove the additional metas. while not strictly necessary, this also ensures idempotence if we run
// the pass more than once on a given content and TOC markers are not inserted by $toc. At the same time,
// if $toc inserts TOC markers (which, as of 2024-05, it shouldn't be able to), these are preserved by the
// fact that we run a single pass with a callback (rather than doing a first replacement with the $toc and
// a replacement of leftover markers as a second pass).
$callback = static function ( array $matches ) use( &$replaced, $toc ): string {
if ( !$replaced ) {
$replaced = true;
return $toc;
}
return '';
};
return preg_replace_callback( self::TOC_PLACEHOLDER_REGEX, $callback, $text );
}
/**
* Set up some variables which are usually set up in parse()
* so that an external function can call some class members with confidence
*
* @param ?PageReference $page
* @param ParserOptions $options
* @param int $outputType One of the Parser::OT_… constants
* @param bool $clearState
* @param int|null $revId
* @since 1.3
*/
public function startExternalParse( ?PageReference $page, ParserOptions $options,
$outputType, $clearState = true, $revId = null
) {
$this->startParse( $page, $options, $outputType, $clearState );
if ( $revId !== null ) {
$this->mRevisionId = $revId;
}
}
/**
* @param ?PageReference $page
* @param ParserOptions $options
* @param int $outputType
* @param bool $clearState
*/
private function startParse( ?PageReference $page, ParserOptions $options,
$outputType, $clearState = true
) {
$this->setPage( $page );
$this->mOptions = $options;
$this->setOutputType( $outputType );
if ( $clearState ) {
$this->clearState();
}
}
/**
* Wrapper for preprocess()
*
* @param string $text The text to preprocess
* @param ParserOptions $options
* @param ?PageReference $page The context page
* @return string
* @since 1.3
*/
public function transformMsg( $text, ParserOptions $options, ?PageReference $page = null ) {
static $executing = false;
# Guard against infinite recursion
if ( $executing ) {
return $text;
}
$executing = true;
$text = $this->preprocess( $text, $page ?? $this->mTitle, $options );
$executing = false;
return $text;
}
/**
* Create an HTML-style tag, e.g. "<yourtag>special text</yourtag>"
* The callback should have the following form:
* function myParserHook( $text, array $params, Parser $parser, PPFrame $frame ) { ... }
*
* Transform and return $text. Use $parser for any required context, e.g. use
* $parser->getTitle() and $parser->getOptions() not $wgTitle or $wgOut->mParserOptions
*
* Hooks may return extended information by returning an array, of which the
* first numbered element (index 0) must be the return string. The following other
* keys are used:
* - 'markerType': used by some core tag hooks to override which strip
* array their results are placed in, 'general' or 'nowiki'.
*
* @param string $tag The tag to use, e.g. 'hook' for "<hook>"
* @param callable $callback The callback to use for the tag
* @return callable|null The old value of the mTagHooks array associated with the hook
* @since 1.3
*/
public function setHook( $tag, callable $callback ) {
$tag = strtolower( $tag );
if ( preg_match( '/[<>\r\n]/', $tag, $m ) ) {
throw new InvalidArgumentException( "Invalid character {$m[0]} in setHook('$tag', ...) call" );
}
$oldVal = $this->mTagHooks[$tag] ?? null;
$this->mTagHooks[$tag] = $callback;
if ( !in_array( $tag, $this->mStripList ) ) {
$this->mStripList[] = $tag;
}
return $oldVal;
}
/**
* Remove all tag hooks
* @since 1.12
*/
public function clearTagHooks() {
$this->mTagHooks = [];
$this->mStripList = [];
}
/**
* Create a function, e.g. {{sum:1|2|3}}
* The callback function should have the form:
* function myParserFunction( &$parser, $arg1, $arg2, $arg3 ) { ... }
*
* Or with Parser::SFH_OBJECT_ARGS:
* function myParserFunction( $parser, $frame, $args ) { ... }
*
* The callback may either return the text result of the function, or an array with the text
* in element 0, and a number of flags in the other elements. The names of the flags are
* specified in the keys. Valid flags are:
* found The text returned is valid, stop processing the template. This
* is on by default.
* nowiki Wiki markup in the return value should be escaped
* isHTML The returned text is HTML, armour it against wikitext transformation
*
* @param string $id The magic word ID
* @param callable $callback The callback function (and object) to use
* @param int $flags A combination of the following flags:
* Parser::SFH_NO_HASH No leading hash, i.e. {{plural:...}} instead of {{#if:...}}
*
* Parser::SFH_OBJECT_ARGS Pass the template arguments as PPNode objects instead of text.
* This allows for conditional expansion of the parse tree, allowing you to eliminate dead
* branches and thus speed up parsing. It is also possible to analyse the parse tree of
* the arguments, and to control the way they are expanded.
*
* The $frame parameter is a PPFrame. This can be used to produce expanded text from the
* arguments, for instance:
* $text = isset( $args[0] ) ? $frame->expand( $args[0] ) : '';
*
* For technical reasons, $args[0] is pre-expanded and will be a string. This may change in
* future versions. Please call $frame->expand() on it anyway so that your code keeps
* working if/when this is changed.
*
* If you want whitespace to be trimmed from $args, you need to do it yourself, post-
* expansion.
*
* Please read the documentation in includes/parser/Preprocessor.php for more information
* about the methods available in PPFrame and PPNode.
*
* @return string|callable|null The old callback function for this name, if any
* @since 1.6
*/
public function setFunctionHook( $id, callable $callback, $flags = 0 ) {
$oldVal = $this->mFunctionHooks[$id][0] ?? null;
$this->mFunctionHooks[$id] = [ $callback, $flags ];
# Add to function cache
$mw = $this->magicWordFactory->get( $id );
$synonyms = $mw->getSynonyms();
$sensitive = intval( $mw->isCaseSensitive() );
foreach ( $synonyms as $syn ) {
# Case
if ( !$sensitive ) {
$syn = $this->contLang->lc( $syn );
}
# Add leading hash
if ( !( $flags & self::SFH_NO_HASH ) ) {
$syn = '#' . $syn;
}
# Remove trailing colon
if ( substr( $syn, -1, 1 ) === ':' ) {
$syn = substr( $syn, 0, -1 );
}
$this->mFunctionSynonyms[$sensitive][$syn] = $id;
}
return $oldVal;
}
/**
* Get all registered function hook identifiers
*
* @return array
* @since 1.8
*/
public function getFunctionHooks() {
return array_keys( $this->mFunctionHooks );
}
/**
* Replace "<!--LINK-->" link placeholders with actual links, in the buffer
* Placeholders created in Linker::link()
*
* @param string &$text
* @deprecated since 1.34; should not be used outside parser class.
*/
public function replaceLinkHolders( &$text ) {
$this->replaceLinkHoldersPrivate( $text );
}
/**
* Replace "<!--LINK-->" link placeholders with actual links, in the buffer
* Placeholders created in Linker::link()
*
* @param string &$text
*/
private function replaceLinkHoldersPrivate( &$text ) {
$this->mLinkHolders->replace( $text );
}
/**
* Replace "<!--LINK-->" link placeholders with plain text of links
* (not HTML-formatted).
*
* @param string $text
* @return string
*/
private function replaceLinkHoldersText( $text ) {
return $this->mLinkHolders->replaceText( $text );
}
/**
* Renders an image gallery from a text with one line per image.
* text labels may be given by using |-style alternative text. E.g.
* Image:one.jpg|The number "1"
* Image:tree.jpg|A tree
* given as text will return the HTML of a gallery with two images,
* labeled 'The number "1"' and
* 'A tree'.
*
* @param string $text
* @param array $params
* @return string HTML
* @internal
*/
public function renderImageGallery( $text, array $params ) {
$mode = false;
if ( isset( $params['mode'] ) ) {
$mode = $params['mode'];
}
try {
$ig = ImageGalleryBase::factory( $mode );
} catch ( ImageGalleryClassNotFoundException $e ) {
// If invalid type set, fallback to default.
$ig = ImageGalleryBase::factory( false );
}
$ig->setContextTitle( $this->getTitle() );
$ig->setShowBytes( false );
$ig->setShowDimensions( false );
$ig->setShowFilename( false );
$ig->setParser( $this );
$ig->setHideBadImages();
$ig->setAttributes( Sanitizer::validateTagAttributes( $params, 'ul' ) );
if ( isset( $params['showfilename'] ) ) {
$ig->setShowFilename( true );
} else {
$ig->setShowFilename( false );
}
if ( isset( $params['caption'] ) ) {
// NOTE: We aren't passing a frame here or below. Frame info
// is currently opaque to Parsoid, which acts on OT_PREPROCESS.
// See T107332#4030581
$caption = $this->recursiveTagParse( $params['caption'] );
$ig->setCaptionHtml( $caption );
}
if ( isset( $params['perrow'] ) ) {
$ig->setPerRow( $params['perrow'] );
}
if ( isset( $params['widths'] ) ) {
$ig->setWidths( $params['widths'] );
}
if ( isset( $params['heights'] ) ) {
$ig->setHeights( $params['heights'] );
}
$ig->setAdditionalOptions( $params );
$enableLegacyMediaDOM = $this->svcOptions->get( MainConfigNames::ParserEnableLegacyMediaDOM );
$lines = StringUtils::explode( "\n", $text );
foreach ( $lines as $line ) {
# match lines like these:
# Image:someimage.jpg|This is some image
$matches = [];
preg_match( "/^([^|]+)(\\|(.*))?$/", $line, $matches );
# Skip empty lines
if ( count( $matches ) == 0 ) {
continue;
}
if ( strpos( $matches[0], '%' ) !== false ) {
$matches[1] = rawurldecode( $matches[1] );
}
$title = Title::newFromText( $matches[1], NS_FILE );
if ( $title === null ) {
# Bogus title. Ignore these so we don't bomb out later.
continue;
}
# We need to get what handler the file uses, to figure out parameters.
# Note, a hook can override the file name, and chose an entirely different
# file (which potentially could be of a different type and have different handler).
$options = [];
$descQuery = false;
$this->hookRunner->onBeforeParserFetchFileAndTitle(
// @phan-suppress-next-line PhanTypeMismatchArgument Type mismatch on pass-by-ref args
$this, $title, $options, $descQuery
);
# Don't register it now, as TraditionalImageGallery does that later.
$file = $this->fetchFileNoRegister( $title, $options );
$handler = $file ? $file->getHandler() : false;
$paramMap = [
'img_alt' => 'gallery-internal-alt',
'img_link' => 'gallery-internal-link',
];
if ( $handler ) {
$paramMap += $handler->getParamMap();
// We don't want people to specify per-image widths.
// Additionally the width parameter would need special casing anyhow.
unset( $paramMap['img_width'] );
}
$mwArray = $this->magicWordFactory->newArray( array_keys( $paramMap ) );
$label = '';
$alt = null;
$handlerOptions = [];
$imageOptions = [];
$hasAlt = false;
if ( isset( $matches[3] ) ) {
// look for an |alt= definition while trying not to break existing
// captions with multiple pipes (|) in it, until a more sensible grammar
// is defined for images in galleries
// FIXME: Doing recursiveTagParse at this stage is a bit odd,
// and different from makeImage.
$matches[3] = $this->recursiveTagParse( $matches[3] );
// Protect LanguageConverter markup
$parameterMatches = StringUtils::delimiterExplode(
'-{', '}-',
'|',
$matches[3],
true /* nested */
);
foreach ( $parameterMatches as $parameterMatch ) {
[ $magicName, $match ] = $mwArray->matchVariableStartToEnd( trim( $parameterMatch ) );
if ( !$magicName ) {
// Last pipe wins.
$label = $parameterMatch;
continue;
}
$paramName = $paramMap[$magicName];
switch ( $paramName ) {
case 'gallery-internal-alt':
$hasAlt = true;
$alt = $this->stripAltText( $match, false );
break;
case 'gallery-internal-link':
$linkValue = $this->stripAltText( $match, false );
if ( preg_match( '/^-{R\|(.*)}-$/', $linkValue ) ) {
// Result of LanguageConverter::markNoConversion
// invoked on an external link.
$linkValue = substr( $linkValue, 4, -2 );
}
[ $type, $target ] = $this->parseLinkParameter( $linkValue );
if ( $type ) {
if ( $type === 'no-link' ) {
$target = true;
}
$imageOptions[$type] = $target;
}
break;
default:
// Must be a handler specific parameter.
if ( $handler->validateParam( $paramName, $match ) ) {
$handlerOptions[$paramName] = $match;
} else {
// Guess not, consider it as caption.
$this->logger->debug(
"$parameterMatch failed parameter validation" );
$label = $parameterMatch;
}
}
}
}
// Match makeImage when !$hasVisibleCaption
if ( !$hasAlt ) {
if ( $label !== '' ) {
$alt = $this->stripAltText( $label, false );
} else {
if ( $enableLegacyMediaDOM ) {
$alt = $title->getText();
}
}
}
$imageOptions['title'] = $this->stripAltText( $label, false );
// Match makeImage which sets this unconditionally
$handlerOptions['targetlang'] = $this->getTargetLanguage()->getCode();
$ig->add(
$title, $label, $alt, '', $handlerOptions,
ImageGalleryBase::LOADING_DEFAULT, $imageOptions
);
}
$html = $ig->toHTML();
$this->hookRunner->onAfterParserFetchFileAndTitle( $this, $ig, $html );
return $html;
}
/**
* @param MediaHandler|false $handler
* @return array
*/
private function getImageParams( $handler ) {
if ( $handler ) {
$handlerClass = get_class( $handler );
} else {
$handlerClass = '';
}
if ( !isset( $this->mImageParams[$handlerClass] ) ) {
# Initialise static lists
static $internalParamNames = [
'horizAlign' => [ 'left', 'right', 'center', 'none' ],
'vertAlign' => [ 'baseline', 'sub', 'super', 'top', 'text-top', 'middle',
'bottom', 'text-bottom' ],
'frame' => [ 'thumbnail', 'framed', 'frameless', 'border',
// These parameters take arguments, so to ensure literals
// have precedence, keep them listed last (T372935):
'manualthumb', 'upright', 'link', 'alt', 'class' ],
];
static $internalParamMap;
if ( !$internalParamMap ) {
$internalParamMap = [];
foreach ( $internalParamNames as $type => $names ) {
foreach ( $names as $name ) {
// For grep: img_left, img_right, img_center, img_none,
// img_baseline, img_sub, img_super, img_top, img_text_top, img_middle,
// img_bottom, img_text_bottom,
// img_thumbnail, img_manualthumb, img_framed, img_frameless, img_upright,
// img_border, img_link, img_alt, img_class
$magicName = str_replace( '-', '_', "img_$name" );
$internalParamMap[$magicName] = [ $type, $name ];
}
}
}
# Add handler params
# Since img_width is one of these, it is important it is listed
# *after* the literal parameter names above (T372935).
$paramMap = $internalParamMap;
if ( $handler ) {
$handlerParamMap = $handler->getParamMap();
foreach ( $handlerParamMap as $magic => $paramName ) {
$paramMap[$magic] = [ 'handler', $paramName ];
}
} else {
// Parse the size for non-existent files. See T273013
$paramMap[ 'img_width' ] = [ 'handler', 'width' ];
}
$this->mImageParams[$handlerClass] = $paramMap;
$this->mImageParamsMagicArray[$handlerClass] =
$this->magicWordFactory->newArray( array_keys( $paramMap ) );
}
return [ $this->mImageParams[$handlerClass], $this->mImageParamsMagicArray[$handlerClass] ];
}
/**
* Parse image options text and use it to make an image
*
* @param LinkTarget $link
* @param string $options
* @param LinkHolderArray|false $holders
* @return string HTML
* @since 1.5
*/
public function makeImage( LinkTarget $link, $options, $holders = false ) {
# Check if the options text is of the form "options|alt text"
# Options are:
# * thumbnail make a thumbnail with enlarge-icon and caption, alignment depends on lang
# * left no resizing, just left align. label is used for alt= only
# * right same, but right aligned
# * none same, but not aligned
# * ___px scale to ___ pixels width, no aligning. e.g. use in taxobox
# * center center the image
# * framed Keep original image size, no magnify-button.
# * frameless like 'thumb' but without a frame. Keeps user preferences for width
# * upright reduce width for upright images, rounded to full __0 px
# * border draw a 1px border around the image
# * alt Text for HTML alt attribute (defaults to empty)
# * class Set a class for img node
# * link Set the target of the image link. Can be external, interwiki, or local
# vertical-align values (no % or length right now):
# * baseline
# * sub
# * super
# * top
# * text-top
# * middle
# * bottom
# * text-bottom
# Protect LanguageConverter markup when splitting into parts
$parts = StringUtils::delimiterExplode(
'-{', '}-', '|', $options, true /* allow nesting */
);
# Give extensions a chance to select the file revision for us
$options = [];
$descQuery = false;
$title = Title::castFromLinkTarget( $link ); // hook signature compat
$this->hookRunner->onBeforeParserFetchFileAndTitle(
// @phan-suppress-next-line PhanTypeMismatchArgument Type mismatch on pass-by-ref args
$this, $title, $options, $descQuery
);
# Fetch and register the file (file title may be different via hooks)
[ $file, $link ] = $this->fetchFileAndTitle( $link, $options );
# Get parameter map
$handler = $file ? $file->getHandler() : false;
[ $paramMap, $mwArray ] = $this->getImageParams( $handler );
if ( !$file ) {
$this->addTrackingCategory( 'broken-file-category' );
}
# Process the input parameters
$caption = '';
$params = [ 'frame' => [], 'handler' => [],
'horizAlign' => [], 'vertAlign' => [] ];
$seenformat = false;
foreach ( $parts as $part ) {
[ $magicName, $value ] = $mwArray->matchVariableStartToEnd( trim( $part ) );
$validated = false;
if ( isset( $paramMap[$magicName] ) ) {
[ $type, $paramName ] = $paramMap[$magicName];
# Special case; width and height come in one variable together
if ( $type === 'handler' && $paramName === 'width' ) {
// The 'px' suffix has already been localized by img_width
$parsedWidthParam = $this->parseWidthParam( $value, true, true );
// Parsoid applies data-(width|height) attributes to broken
// media spans, for client use. See T273013
$validateFunc = static function ( $name, $value ) use ( $handler ) {
return $handler
? $handler->validateParam( $name, $value )
: $value > 0;
};
if ( isset( $parsedWidthParam['width'] ) ) {
$width = $parsedWidthParam['width'];
if ( $validateFunc( 'width', $width ) ) {
$params[$type]['width'] = $width;
$validated = true;
}
}
if ( isset( $parsedWidthParam['height'] ) ) {
$height = $parsedWidthParam['height'];
if ( $validateFunc( 'height', $height ) ) {
$params[$type]['height'] = $height;
$validated = true;
}
}
# else no validation -- T15436
} else {
if ( $type === 'handler' ) {
# Validate handler parameter
$validated = $handler->validateParam( $paramName, $value );
} else {
# Validate internal parameters
switch ( $paramName ) {
case 'alt':
case 'class':
$validated = true;
$value = $this->stripAltText( $value, $holders );
break;
case 'link':
[ $paramName, $value ] =
$this->parseLinkParameter(
$this->stripAltText( $value, $holders )
);
if ( $paramName ) {
$validated = true;
if ( $paramName === 'no-link' ) {
$value = true;
}
}
break;
case 'manualthumb':
# @todo FIXME: Possibly check validity here for
# manualthumb? downstream behavior seems odd with
# missing manual thumbs.
$value = $this->stripAltText( $value, $holders );
// fall through
case 'frameless':
case 'framed':
case 'thumbnail':
// use first appearing option, discard others.
$validated = !$seenformat;
$seenformat = true;
break;
default:
# Most other things appear to be empty or numeric...
$validated = ( $value === false || is_numeric( trim( $value ) ) );
}
}
if ( $validated ) {
$params[$type][$paramName] = $value;
}
}
}
if ( !$validated ) {
$caption = $part;
}
}
# Process alignment parameters
if ( $params['horizAlign'] !== [] ) {
$params['frame']['align'] = array_key_first( $params['horizAlign'] );
}
if ( $params['vertAlign'] !== [] ) {
$params['frame']['valign'] = array_key_first( $params['vertAlign'] );
}
$params['frame']['caption'] = $caption;
$enableLegacyMediaDOM = $this->svcOptions->get( MainConfigNames::ParserEnableLegacyMediaDOM );
# Will the image be presented in a frame, with the caption below?
// @phan-suppress-next-line PhanImpossibleCondition
$hasVisibleCaption = isset( $params['frame']['framed'] )
// @phan-suppress-next-line PhanImpossibleCondition
|| isset( $params['frame']['thumbnail'] )
// @phan-suppress-next-line PhanImpossibleCondition
|| isset( $params['frame']['manualthumb'] );
# In the old days, [[Image:Foo|text...]] would set alt text. Later it
# came to also set the caption, ordinary text after the image -- which
# makes no sense, because that just repeats the text multiple times in
# screen readers. It *also* came to set the title attribute.
# Now that we have an alt attribute, we should not set the alt text to
# equal the caption: that's worse than useless, it just repeats the
# text. This is the framed/thumbnail case. If there's no caption, we
# use the unnamed parameter for alt text as well, just for the time be-
# ing, if the unnamed param is set and the alt param is not.
# For the future, we need to figure out if we want to tweak this more,
# e.g., introducing a title= parameter for the title; ignoring the un-
# named parameter entirely for images without a caption; adding an ex-
# plicit caption= parameter and preserving the old magic unnamed para-
# meter for BC; ...
if ( $hasVisibleCaption ) {
if (
// @phan-suppress-next-line PhanImpossibleCondition
$caption === '' && !isset( $params['frame']['alt'] ) &&
$enableLegacyMediaDOM
) {
# No caption or alt text, add the filename as the alt text so
# that screen readers at least get some description of the image
$params['frame']['alt'] = $link->getText();
}
# Do not set $params['frame']['title'] because tooltips are unnecessary
# for framed images, the caption is visible
} else {
// @phan-suppress-next-line PhanImpossibleCondition
if ( !isset( $params['frame']['alt'] ) ) {
# No alt text, use the "caption" for the alt text
if ( $caption !== '' ) {
$params['frame']['alt'] = $this->stripAltText( $caption, $holders );
} elseif ( $enableLegacyMediaDOM ) {
# No caption, fall back to using the filename for the
# alt text
$params['frame']['alt'] = $link->getText();
}
}
# Use the "caption" for the tooltip text
$params['frame']['title'] = $this->stripAltText( $caption, $holders );
}
$params['handler']['targetlang'] = $this->getTargetLanguage()->getCode();
// hook signature compat again, $link may have changed
$title = Title::castFromLinkTarget( $link );
$this->hookRunner->onParserMakeImageParams( $title, $file, $params, $this );
# Linker does the rest
$time = $options['time'] ?? false;
// @phan-suppress-next-line PhanTypePossiblyInvalidDimOffset
$ret = Linker::makeImageLink( $this, $link, $file, $params['frame'], $params['handler'],
$time, $descQuery, $this->mOptions->getThumbSize() );
# Give the handler a chance to modify the parser object
if ( $handler ) {
$handler->parserTransformHook( $this, $file );
}
if ( $file ) {
$this->modifyImageHtml( $file, $params, $ret );
}
return $ret;
}
/**
* Parse the value of 'link' parameter in image syntax (`[[File:Foo.jpg|link=<value>]]`).
*
* Adds an entry to appropriate link tables.
*
* @since 1.32
* @param string $value
* @return array of `[ type, target ]`, where:
* - `type` is one of:
* - `null`: Given value is not a valid link target, use default
* - `'no-link'`: Given value is empty, do not generate a link
* - `'link-url'`: Given value is a valid external link
* - `'link-title'`: Given value is a valid internal link
* - `target` is:
* - When `type` is `null` or `'no-link'`: `false`
* - When `type` is `'link-url'`: URL string corresponding to given value
* - When `type` is `'link-title'`: Title object corresponding to given value
*/
private function parseLinkParameter( $value ) {
$chars = self::EXT_LINK_URL_CLASS;
$addr = self::EXT_LINK_ADDR;
$prots = $this->urlUtils->validProtocols();
$type = null;
$target = false;
if ( $value === '' ) {
$type = 'no-link';
} elseif ( preg_match( "/^((?i)$prots)/", $value ) ) {
if ( preg_match( "/^((?i)$prots)$addr$chars*$/u", $value ) ) {
$this->mOutput->addExternalLink( $value );
$type = 'link-url';
$target = $value;
}
} else {
// Percent-decode link arguments for consistency with wikilink
// handling (T216003#7836261).
//
// There's slight concern here though. The |link= option supports
// two formats, link=Test%22test vs link=[[Test%22test]], both of
// which are about to be decoded.
//
// In the former case, the decoding here is straightforward and
// desirable.
//
// In the latter case, there's a potential for double decoding,
// because the wikilink syntax has a higher precedence and has
// already been parsed as a link before we get here. $value
// has had stripAltText() called on it, which in turn calls
// replaceLinkHoldersText() on the link. So, the text we're
// getting at this point has already been percent decoded.
//
// The problematic case is if %25 is in the title, since that
// decodes to %, which could combine with trailing characters.
// However, % is not a valid link title character, so it would
// not parse as a link and the string we received here would
// still contain the encoded %25.
//
// Hence, double decoded is not an issue. See the test,
// "Should not double decode the link option"
if ( strpos( $value, '%' ) !== false ) {
$value = rawurldecode( $value );
}
$linkTitle = Title::newFromText( $value );
if ( $linkTitle ) {
$this->mOutput->addLink( $linkTitle );
$type = 'link-title';
$target = $linkTitle;
}
}
return [ $type, $target ];
}
/**
* Give hooks a chance to modify image thumbnail HTML
*
* @param File $file
* @param array $params
* @param string &$html
*/
public function modifyImageHtml( File $file, array $params, string &$html ) {
$this->hookRunner->onParserModifyImageHTML( $this, $file, $params, $html );
}
/**
* @param string $caption
* @param LinkHolderArray|false $holders
* @return string
*/
private function stripAltText( $caption, $holders ) {
# Strip bad stuff out of the title (tooltip). We can't just use
# replaceLinkHoldersText() here, because if this function is called
# from handleInternalLinks2(), mLinkHolders won't be up-to-date.
if ( $holders ) {
$tooltip = $holders->replaceText( $caption );
} else {
$tooltip = $this->replaceLinkHoldersText( $caption );
}
# make sure there are no placeholders in thumbnail attributes
# that are later expanded to html- so expand them now and
# remove the tags
$tooltip = $this->mStripState->unstripBoth( $tooltip );
# Compatibility hack! In HTML certain entity references not terminated
# by a semicolon are decoded (but not if we're in an attribute; that's
# how link URLs get away without properly escaping & in queries).
# But wikitext has always required semicolon-termination of entities,
# so encode & where needed to avoid decode of semicolon-less entities.
# See T209236 and
# https://www.w3.org/TR/html5/syntax.html#named-character-references
# T210437 discusses moving this workaround to Sanitizer::stripAllTags.
$tooltip = preg_replace( "/
& # 1. entity prefix
(?= # 2. followed by:
(?: # a. one of the legacy semicolon-less named entities
A(?:Elig|MP|acute|circ|grave|ring|tilde|uml)|
C(?:OPY|cedil)|E(?:TH|acute|circ|grave|uml)|
GT|I(?:acute|circ|grave|uml)|LT|Ntilde|
O(?:acute|circ|grave|slash|tilde|uml)|QUOT|REG|THORN|
U(?:acute|circ|grave|uml)|Yacute|
a(?:acute|c(?:irc|ute)|elig|grave|mp|ring|tilde|uml)|brvbar|
c(?:cedil|edil|urren)|cent(?!erdot;)|copy(?!sr;)|deg|
divide(?!ontimes;)|e(?:acute|circ|grave|th|uml)|
frac(?:1(?:2|4)|34)|
gt(?!c(?:c|ir)|dot|lPar|quest|r(?:a(?:pprox|rr)|dot|eq(?:less|qless)|less|sim);)|
i(?:acute|circ|excl|grave|quest|uml)|laquo|
lt(?!c(?:c|ir)|dot|hree|imes|larr|quest|r(?:Par|i(?:e|f|));)|
m(?:acr|i(?:cro|ddot))|n(?:bsp|tilde)|
not(?!in(?:E|dot|v(?:a|b|c)|)|ni(?:v(?:a|b|c)|);)|
o(?:acute|circ|grave|rd(?:f|m)|slash|tilde|uml)|
p(?:lusmn|ound)|para(?!llel;)|quot|r(?:aquo|eg)|
s(?:ect|hy|up(?:1|2|3)|zlig)|thorn|times(?!b(?:ar|)|d;)|
u(?:acute|circ|grave|ml|uml)|y(?:acute|en|uml)
)
(?:[^;]|$)) # b. and not followed by a semicolon
# S = study, for efficiency
/Sx", '&', $tooltip );
$tooltip = Sanitizer::stripAllTags( $tooltip );
return $tooltip;
}
/**
* Callback from the Sanitizer for expanding items found in HTML attribute
* values, so they can be safely tested and escaped.
*
* @param string &$text
* @param PPFrame|false $frame
* @return string
* @deprecated since 1.35, internal callback should not have been public
*/
public function attributeStripCallback( &$text, $frame = false ) {
wfDeprecated( __METHOD__, '1.35' );
$text = $this->replaceVariables( $text, $frame );
$text = $this->mStripState->unstripBoth( $text );
return $text;
}
/**
* Accessor
*
* @return array
* @since 1.6
*/
public function getTags(): array {
return array_keys( $this->mTagHooks );
}
/**
* @since 1.32
* @return array{0:array<string,string>,1:array<string,string>}
*/
public function getFunctionSynonyms() {
return $this->mFunctionSynonyms;
}
/**
* @since 1.32
* @return string
*/
public function getUrlProtocols() {
return $this->urlUtils->validProtocols();
}
/**
* Break wikitext input into sections, and either pull or replace
* some particular section's text.
*
* External callers should use the getSection and replaceSection methods.
*
* @param string $text Page wikitext
* @param string|int $sectionId A section identifier string of the form:
* "<flag1> - <flag2> - ... - <section number>"
*
* Currently the only recognised flag is "T", which means the target section number
* was derived during a template inclusion parse, in other words this is a template
* section edit link. If no flags are given, it was an ordinary section edit link.
* This flag is required to avoid a section numbering mismatch when a section is
* enclosed by "<includeonly>" (T8563).
*
* The section number 0 pulls the text before the first heading; other numbers will
* pull the given section along with its lower-level subsections. If the section is
* not found, $mode=get will return $newtext, and $mode=replace will return $text.
*
* Section 0 is always considered to exist, even if it only contains the empty
* string. If $text is the empty string and section 0 is replaced, $newText is
* returned.
*
* @param string $mode One of "get" or "replace"
* @param string|false $newText Replacement text for section data.
* @param PageReference|null $page
* @return string For "get", the extracted section text.
* for "replace", the whole page with the section replaced.
*/
private function extractSections( $text, $sectionId, $mode, $newText, ?PageReference $page = null ) {
$magicScopeVariable = $this->lock();
$this->startParse(
$page,
ParserOptions::newFromUser( RequestContext::getMain()->getUser() ),
self::OT_PLAIN,
true
);
$outText = '';
$frame = $this->getPreprocessor()->newFrame();
# Process section extraction flags
$flags = 0;
$sectionParts = explode( '-', $sectionId );
// The section ID may either be a magic string such as 'new' (which should be treated as 0),
// or a numbered section ID in the format of "T-<section index>".
// Explicitly coerce the section index into a number accordingly. (T323373)
$sectionIndex = (int)array_pop( $sectionParts );
foreach ( $sectionParts as $part ) {
if ( $part === 'T' ) {
$flags |= Preprocessor::DOM_FOR_INCLUSION;
}
}
# Check for empty input
if ( strval( $text ) === '' ) {
# Only sections 0 and T-0 exist in an empty document
if ( $sectionIndex === 0 ) {
if ( $mode === 'get' ) {
return '';
}
return $newText;
} else {
if ( $mode === 'get' ) {
return $newText;
}
return $text;
}
}
# Preprocess the text
$root = $this->preprocessToDom( $text, $flags );
# <h> nodes indicate section breaks
# They can only occur at the top level, so we can find them by iterating the root's children
$node = $root->getFirstChild();
# Find the target section
if ( $sectionIndex === 0 ) {
# Section zero doesn't nest, level=big
$targetLevel = 1000;
} else {
while ( $node ) {
if ( $node->getName() === 'h' ) {
$bits = $node->splitHeading();
if ( $bits['i'] == $sectionIndex ) {
$targetLevel = $bits['level'];
break;
}
}
if ( $mode === 'replace' ) {
$outText .= $frame->expand( $node, PPFrame::RECOVER_ORIG );
}
$node = $node->getNextSibling();
}
}
if ( !$node ) {
# Not found
if ( $mode === 'get' ) {
return $newText;
} else {
return $text;
}
}
# Find the end of the section, including nested sections
do {
if ( $node->getName() === 'h' ) {
$bits = $node->splitHeading();
$curLevel = $bits['level'];
// @phan-suppress-next-line PhanPossiblyUndeclaredVariable False positive
if ( $bits['i'] != $sectionIndex && $curLevel <= $targetLevel ) {
break;
}
}
if ( $mode === 'get' ) {
$outText .= $frame->expand( $node, PPFrame::RECOVER_ORIG );
}
$node = $node->getNextSibling();
} while ( $node );
# Write out the remainder (in replace mode only)
if ( $mode === 'replace' ) {
# Output the replacement text
# Add two newlines on -- trailing whitespace in $newText is conventionally
# stripped by the editor, so we need both newlines to restore the paragraph gap
# Only add trailing whitespace if there is newText
if ( $newText != "" ) {
$outText .= $newText . "\n\n";
}
while ( $node ) {
$outText .= $frame->expand( $node, PPFrame::RECOVER_ORIG );
$node = $node->getNextSibling();
}
}
# Re-insert stripped tags
$outText = rtrim( $this->mStripState->unstripBoth( $outText ) );
return $outText;
}
/**
* This function returns the text of a section, specified by a number ($section).
* A section is text under a heading like == Heading == or \<h1\>Heading\</h1\>, or
* the first section before any such heading (section 0).
*
* If a section contains subsections, these are also returned.
*
* @param string $text Text to look in
* @param string|int $sectionId Section identifier as a number or string
* (e.g. 0, 1 or 'T-1').
* @param string|false $defaultText Default to return if section is not found
*
* @return string Text of the requested section
* @since 1.7
*/
public function getSection( $text, $sectionId, $defaultText = '' ) {
return $this->extractSections( $text, $sectionId, 'get', $defaultText );
}
/**
* This function returns $oldtext after the content of the section
* specified by $section has been replaced with $text. If the target
* section does not exist, $oldtext is returned unchanged.
*
* @param string $oldText Former text of the article
* @param string|int $sectionId Section identifier as a number or string
* (e.g. 0, 1 or 'T-1').
* @param string|false $newText Replacing text
*
* @return string Modified text
* @since 1.7
*/
public function replaceSection( $oldText, $sectionId, $newText ) {
return $this->extractSections( $oldText, $sectionId, 'replace', $newText );
}
/**
* Get an array of preprocessor section information.
*
* Preprocessor sections are those identified by wikitext-style syntax, not
* HTML-style syntax. Templates are not expanded, so these sections do not
* include sections created by templates or parser functions. This is the
* same definition of a section as used by section editing, but not the
* same as TOC generation.
*
* These sections are typically smaller than those acted on by getSection() and
* replaceSection() since they are not nested. Section nesting could be
* reconstructed from the heading levels.
*
* The return value is an array of associative array info structures. Each
* associative array contains the following keys, describing a section:
*
* - index: An integer identifying the section.
* - level: The heading level, e.g. 1 for <h1>. For the section before the
* the first heading, this will be 0.
* - offset: The byte offset within the wikitext at which the section starts
* - heading: The wikitext for the header which introduces the section,
* including equals signs. For the section before the first heading, this
* will be an empty string.
* - text: The complete text of the section.
*
* @param string $text
* @return array[]
* @internal
*/
public function getFlatSectionInfo( $text ) {
$magicScopeVariable = $this->lock();
$this->startParse(
null,
ParserOptions::newFromUser( RequestContext::getMain()->getUser() ),
self::OT_PLAIN,
true
);
$frame = $this->getPreprocessor()->newFrame();
$root = $this->preprocessToDom( $text, 0 );
$node = $root->getFirstChild();
$offset = 0;
$currentSection = [
'index' => 0,
'level' => 0,
'offset' => 0,
'heading' => '',
'text' => ''
];
$sections = [];
while ( $node ) {
$nodeText = $frame->expand( $node, PPFrame::RECOVER_ORIG );
if ( $node->getName() === 'h' ) {
$bits = $node->splitHeading();
$sections[] = $currentSection;
$currentSection = [
'index' => $bits['i'],
'level' => $bits['level'],
'offset' => $offset,
'heading' => $nodeText,
'text' => $nodeText
];
} else {
$currentSection['text'] .= $nodeText;
}
$offset += strlen( $nodeText );
$node = $node->getNextSibling();
}
$sections[] = $currentSection;
return $sections;
}
/**
* Get the ID of the revision we are parsing
*
* The return value will be either:
* - a) Positive, indicating a specific revision ID (current or old)
* - b) Zero, meaning the revision ID is specified by getCurrentRevisionRecordCallback()
* - c) Null, meaning the parse is for preview mode and there is no revision
*
* @return int|null
* @since 1.13
*/
public function getRevisionId() {
return $this->mRevisionId;
}
/**
* Get the revision record object for $this->mRevisionId
*
* @return RevisionRecord|null Either a RevisionRecord object or null
* @since 1.35
*/
public function getRevisionRecordObject() {
if ( $this->mRevisionRecordObject ) {
return $this->mRevisionRecordObject;
}
// NOTE: try to get the RevisionRecord object even if mRevisionId is null.
// This is useful when parsing a revision that has not yet been saved.
// However, if we get back a saved revision even though we are in
// preview mode, we'll have to ignore it, see below.
// NOTE: This callback may be used to inject an OLD revision that was
// already loaded, so "current" is a bit of a misnomer. We can't just
// skip it if mRevisionId is set.
$rev = call_user_func(
$this->mOptions->getCurrentRevisionRecordCallback(),
$this->getTitle(),
$this
);
if ( !$rev ) {
// The revision record callback returns `false` (not null) to
// indicate that the revision is missing. (See for example
// Parser::statelessFetchRevisionRecord(), the default callback.)
// This API expects `null` instead. (T251952)
return null;
}
if ( $this->mRevisionId === null && $rev->getId() ) {
// We are in preview mode (mRevisionId is null), and the current revision callback
// returned an existing revision. Ignore it and return null, it's probably the page's
// current revision, which is not what we want here. Note that we do want to call the
// callback to allow the unsaved revision to be injected here, e.g. for
// self-transclusion previews.
return null;
}
// If the parse is for a new revision, then the callback should have
// already been set to force the object and should match mRevisionId.
// If not, try to fetch by mRevisionId instead.
if ( $this->mRevisionId && $rev->getId() != $this->mRevisionId ) {
$rev = MediaWikiServices::getInstance()
->getRevisionLookup()
->getRevisionById( $this->mRevisionId );
}
$this->mRevisionRecordObject = $rev;
return $this->mRevisionRecordObject;
}
/**
* Get the timestamp associated with the current revision, adjusted for
* the default server-local timestamp
* @return string TS_MW timestamp
* @since 1.9
*/
public function getRevisionTimestamp() {
if ( $this->mRevisionTimestamp !== null ) {
return $this->mRevisionTimestamp;
}
# Use specified revision timestamp, falling back to the current timestamp
$revObject = $this->getRevisionRecordObject();
$timestamp = $revObject && $revObject->getTimestamp()
? $revObject->getTimestamp()
: $this->mOptions->getTimestamp();
$this->mOutput->setRevisionTimestampUsed( $timestamp ); // unadjusted time zone
# The cryptic '' timezone parameter tells to use the site-default
# timezone offset instead of the user settings.
# Since this value will be saved into the parser cache, served
# to other users, and potentially even used inside links and such,
# it needs to be consistent for all visitors.
$this->mRevisionTimestamp = $this->contLang->userAdjust( $timestamp, '' );
return $this->mRevisionTimestamp;
}
/**
* Get the name of the user that edited the last revision
*
* @return string|null User name
* @since 1.15
*/
public function getRevisionUser(): ?string {
if ( $this->mRevisionUser === null ) {
$revObject = $this->getRevisionRecordObject();
# if this template is subst: the revision id will be blank,
# so just use the current user's name
if ( $revObject && $revObject->getUser() ) {
$this->mRevisionUser = $revObject->getUser()->getName();
} elseif ( $this->ot['wiki'] || $this->mOptions->getIsPreview() ) {
$this->mRevisionUser = $this->getUserIdentity()->getName();
} else {
# Note that we fall through here with
# $this->mRevisionUser still null
}
}
return $this->mRevisionUser;
}
/**
* Get the size of the revision
*
* @return int|null Revision size
* @since 1.22
*/
public function getRevisionSize() {
if ( $this->mRevisionSize === null ) {
$revObject = $this->getRevisionRecordObject();
# if this variable is subst: the revision id will be blank,
# so just use the parser input size, because the own substitution
# will change the size.
if ( $revObject ) {
$this->mRevisionSize = $revObject->getSize();
} else {
$this->mRevisionSize = $this->mInputSize;
}
}
return $this->mRevisionSize;
}
/**
* Accessor for the 'defaultsort' page property.
* Will use the empty string if none is set.
*
* This value is treated as a prefix, so the
* empty string is equivalent to sorting by
* page name.
*
* @return string
* @since 1.9
* @deprecated since 1.38, use
* $parser->getOutput()->getPageProperty('defaultsort') ?? ''
*/
public function getDefaultSort() {
wfDeprecated( __METHOD__, '1.38' );
return $this->mOutput->getPageProperty( 'defaultsort' ) ?? '';
}
private static function getSectionNameFromStrippedText( $text ) {
$text = Sanitizer::normalizeSectionNameWhitespace( $text );
$text = Sanitizer::decodeCharReferences( $text );
$text = self::normalizeSectionName( $text );
return $text;
}
private static function makeAnchor( $sectionName ) {
return '#' . Sanitizer::escapeIdForLink( $sectionName );
}
private function makeLegacyAnchor( $sectionName ) {
$fragmentMode = $this->svcOptions->get( MainConfigNames::FragmentMode );
if ( isset( $fragmentMode[1] ) && $fragmentMode[1] === 'legacy' ) {
// ForAttribute() and ForLink() are the same for legacy encoding
$id = Sanitizer::escapeIdForAttribute( $sectionName, Sanitizer::ID_FALLBACK );
} else {
$id = Sanitizer::escapeIdForLink( $sectionName );
}
return "#$id";
}
/**
* Try to guess the section anchor name based on a wikitext fragment
* presumably extracted from a heading, for example "Header" from
* "== Header ==".
*
* @param string $text
* @return string Anchor (starting with '#')
* @since 1.12
*/
public function guessSectionNameFromWikiText( $text ) {
# Strip out wikitext links(they break the anchor)
$text = $this->stripSectionName( $text );
$sectionName = self::getSectionNameFromStrippedText( $text );
return self::makeAnchor( $sectionName );
}
/**
* Same as guessSectionNameFromWikiText(), but produces legacy anchors
* instead, if possible. For use in redirects, since various versions
* of Microsoft browsers interpret Location: headers as something other
* than UTF-8, resulting in breakage.
*
* @param string $text The section name
* @return string Anchor (starting with '#')
* @since 1.17
*/
public function guessLegacySectionNameFromWikiText( $text ) {
# Strip out wikitext links(they break the anchor)
$text = $this->stripSectionName( $text );
$sectionName = self::getSectionNameFromStrippedText( $text );
return $this->makeLegacyAnchor( $sectionName );
}
/**
* Like guessSectionNameFromWikiText(), but takes already-stripped text as input.
* @param string $text Section name (plain text)
* @return string Anchor (starting with '#')
* @since 1.31
*/
public static function guessSectionNameFromStrippedText( $text ) {
$sectionName = self::getSectionNameFromStrippedText( $text );
return self::makeAnchor( $sectionName );
}
/**
* Apply the same normalization as code making links to this section would
*
* @param string $text
* @return string
*/
private static function normalizeSectionName( $text ) {
# T90902: ensure the same normalization is applied for IDs as to links
/** @var MediaWikiTitleCodec $titleParser */
$titleParser = MediaWikiServices::getInstance()->getTitleParser();
'@phan-var MediaWikiTitleCodec $titleParser';
try {
$parts = $titleParser->splitTitleString( "#$text" );
} catch ( MalformedTitleException $ex ) {
return $text;
}
return $parts['fragment'];
}
/**
* Strips a text string of wikitext for use in a section anchor
*
* Accepts a text string and then removes all wikitext from the
* string and leaves only the resultant text (i.e. the result of
* [[User:WikiSysop|Sysop]] would be "Sysop" and the result of
* [[User:WikiSysop]] would be "User:WikiSysop") - this is intended
* to create valid section anchors by mimicking the output of the
* parser when headings are parsed.
*
* @param string $text Text string to be stripped of wikitext
* for use in a Section anchor
* @return string Filtered text string
* @since 1.12
*/
public function stripSectionName( $text ) {
# Strip internal link markup
$text = preg_replace( '/\[\[:?([^[|]+)\|([^[]+)\]\]/', '$2', $text );
$text = preg_replace( '/\[\[:?([^[]+)\|?\]\]/', '$1', $text );
# Strip external link markup
# @todo FIXME: Not tolerant to blank link text
# I.E. [https://www.mediawiki.org] will render as [1] or something depending
# on how many empty links there are on the page - need to figure that out.
$text = preg_replace(
'/\[(?i:' . $this->urlUtils->validProtocols() . ')([^ ]+?) ([^[]+)\]/', '$2', $text );
# Parse wikitext quotes (italics & bold)
$text = $this->doQuotes( $text );
# Strip HTML tags
$text = StringUtils::delimiterReplace( '<', '>', '', $text );
return $text;
}
/**
* Call a callback function on all regions of the given text that are not
* inside strip markers, and replace those regions with the return value
* of the callback. For example, with input:
*
* aaa<MARKER>bbb
*
* This will call the callback function twice, with 'aaa' and 'bbb'. Those
* two strings will be replaced with the value returned by the callback in
* each case.
*
* @param string $s
* @param callable $callback
*
* @return string
* @internal
* @since 1.12
*/
public function markerSkipCallback( $s, callable $callback ) {
$i = 0;
$out = '';
while ( $i < strlen( $s ) ) {
$markerStart = strpos( $s, self::MARKER_PREFIX, $i );
if ( $markerStart === false ) {
$out .= call_user_func( $callback, substr( $s, $i ) );
break;
} else {
$out .= call_user_func( $callback, substr( $s, $i, $markerStart - $i ) );
$markerEnd = strpos( $s, self::MARKER_SUFFIX, $markerStart );
if ( $markerEnd === false ) {
$out .= substr( $s, $markerStart );
break;
} else {
$markerEnd += strlen( self::MARKER_SUFFIX );
$out .= substr( $s, $markerStart, $markerEnd - $markerStart );
$i = $markerEnd;
}
}
}
return $out;
}
/**
* Remove any strip markers found in the given text.
*
* @param string $text
* @return string
* @since 1.19
*/
public function killMarkers( $text ) {
return $this->mStripState->killMarkers( $text );
}
/**
* Parsed a width param of imagelink like 300px or 200x300px
*
* @param string $value
* @param bool $parseHeight
* @param bool $localized Defaults to false; set to true if the $value
* has already been matched against `img_width` to localize the `px`
* suffix.
*
* @return array
* @since 1.20
* @internal
*/
public function parseWidthParam( $value, $parseHeight = true, bool $localized = false ) {
$parsedWidthParam = [];
if ( $value === '' ) {
return $parsedWidthParam;
}
$m = [];
if ( !$localized ) {
// Strip a localized 'px' suffix (T374311)
$mwArray = $this->magicWordFactory->newArray( [ 'img_width' ] );
[ $magicWord, $newValue ] = $mwArray->matchVariableStartToEnd( $value );
$value = $magicWord ? $newValue : $value;
}
# (T15500) In both cases (width/height and width only),
# permit trailing "px" for backward compatibility.
if ( $parseHeight && preg_match( '/^([0-9]*)x([0-9]*)\s*(px)?\s*$/', $value, $m ) ) {
$width = intval( $m[1] );
$height = intval( $m[2] );
$parsedWidthParam['width'] = $width;
$parsedWidthParam['height'] = $height;
if ( $m[3] ?? false ) {
$this->addTrackingCategory( 'double-px-category' );
}
} elseif ( preg_match( '/^([0-9]*)\s*(px)?\s*$/', $value, $m ) ) {
$width = intval( $m[1] );
$parsedWidthParam['width'] = $width;
if ( $m[2] ?? false ) {
$this->addTrackingCategory( 'double-px-category' );
}
}
return $parsedWidthParam;
}
/**
* Lock the current instance of the parser.
*
* This is meant to stop someone from calling the parser
* recursively and messing up all the strip state.
*
* @return ScopedCallback The lock will be released once the return value goes out of scope.
*/
protected function lock() {
if ( $this->mInParse ) {
throw new LogicException( "Parser state cleared while parsing. "
. "Did you call Parser::parse recursively? Lock is held by: " . $this->mInParse );
}
// Save the backtrace when locking, so that if some code tries locking again,
// we can print the lock owner's backtrace for easier debugging
$e = new RuntimeException;
$this->mInParse = $e->getTraceAsString();
$recursiveCheck = new ScopedCallback( function () {
$this->mInParse = false;
} );
return $recursiveCheck;
}
/**
* Will entry points such as parse() throw an exception due to the parser
* already being active?
*
* @since 1.39
* @return bool
*/
public function isLocked() {
return (bool)$this->mInParse;
}
/**
* Strip outer <p></p> tag from the HTML source of a single paragraph.
*
* Returns original HTML if the <p/> tag has any attributes, if there's no wrapping <p/> tag,
* or if there is more than one <p/> tag in the input HTML.
*
* @param string $html
* @return string
* @since 1.24
*/
public static function stripOuterParagraph( $html ) {
$m = [];
if ( preg_match( '/^<p>(.*)\n?<\/p>\n?$/sU', $html, $m ) && strpos( $m[1], '</p>' ) === false ) {
$html = $m[1];
}
return $html;
}
/**
* Add HTML tags marking the parts of a page title, to be displayed in the first heading of the page.
*
* @internal
* @since 1.39
* @param string|HtmlArmor $nsText
* @param string|HtmlArmor $nsSeparator
* @param string|HtmlArmor $mainText
* @return string HTML
*/
public static function formatPageTitle( $nsText, $nsSeparator, $mainText ): string {
$html = '';
if ( $nsText !== '' ) {
$html .= '<span class="mw-page-title-namespace">' . HtmlArmor::getHtml( $nsText ) . '</span>';
$html .= '<span class="mw-page-title-separator">' . HtmlArmor::getHtml( $nsSeparator ) . '</span>';
}
$html .= '<span class="mw-page-title-main">' . HtmlArmor::getHtml( $mainText ) . '</span>';
return $html;
}
/**
* Strip everything but the <body> from the provided string
* @param string $text
* @return string
* @unstable
*/
public static function extractBody( string $text ): string {
$text = preg_replace( '!^.*?<body[^>]*>!s', '', $text, 1 );
$text = preg_replace( '!</body>\s*</html>\s*$!', '', $text, 1 );
return $text;
}
/**
* Set's up the PHP implementation of OOUI for use in this request
* and instructs OutputPage to enable OOUI for itself.
*
* @since 1.26
* @deprecated since 1.35, use $parser->getOutput()->setEnableOOUI() instead.
*/
public function enableOOUI() {
wfDeprecated( __METHOD__, '1.35' );
OutputPage::setupOOUI();
$this->mOutput->setEnableOOUI( true );
}
/**
* Sets the flag on the parser output but also does some debug logging.
* Note that there is a copy of this method in CoreMagicVariables as well.
* @param string $flag
* @param string $reason
*/
private function setOutputFlag( string $flag, string $reason ): void {
$this->mOutput->setOutputFlag( $flag );
$name = $this->getTitle()->getPrefixedText();
$this->logger->debug( __METHOD__ . ": set $flag flag on '$name'; $reason" );
}
}
/** @deprecated class alias since 1.42 */
class_alias( Parser::class, 'Parser' );
|