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
|
<?php
/**
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation; either version 2 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License along
* with this program; if not, write to the Free Software Foundation, Inc.,
* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
* http://www.gnu.org/copyleft/gpl.html
*
* @file
*/
namespace MediaWiki\Parser;
use InvalidArgumentException;
use LogicException;
use MediaWiki\Edit\ParsoidRenderID;
use MediaWiki\Json\JsonDeserializable;
use MediaWiki\Json\JsonDeserializableTrait;
use MediaWiki\Json\JsonDeserializer;
use MediaWiki\MainConfigNames;
use MediaWiki\MediaWikiServices;
use MediaWiki\Message\Converter;
use MediaWiki\Output\OutputPage;
use MediaWiki\Parser\Parsoid\PageBundleParserOutputConverter;
use MediaWiki\Title\TitleValue;
use UnexpectedValueException;
use Wikimedia\Bcp47Code\Bcp47Code;
use Wikimedia\Bcp47Code\Bcp47CodeValue;
use Wikimedia\Message\MessageValue;
use Wikimedia\Parsoid\Core\ContentMetadataCollector;
use Wikimedia\Parsoid\Core\ContentMetadataCollectorCompat;
use Wikimedia\Parsoid\Core\LinkTarget as ParsoidLinkTarget;
use Wikimedia\Parsoid\Core\TOCData;
use Wikimedia\Reflection\GhostFieldAccessTrait;
/**
* ParserOutput is a rendering of a Content object or a message.
* Content objects and messages often contain wikitext, but not always.
*
* `ParserOutput` object combine the HTML rendering of Content objects
* or messages, available via `::getRawText()`, with various bits of
* metadata generated during rendering, which may include categories,
* links, page properties, and extension data, among others.
*
* `ParserOutput` objects corresponding to the content of page revisions
* are created by the `ParserOutputAccess` service, which
* automatically caches them via `ParserCache` where appropriate and
* produces new output via `ContentHandler` as needed.
*
* In addition, wikitext from system messages as well as odd bits of
* wikitext rendered to create special pages and other UX elements are
* rendered to `ParserOutput` objects. In these cases the metadata
* from the `ParserOutput` is generally discarded and the
* `ParserOutput` is not cached. These bits of wikitext are generally
* rendered with `ParserOptions::setInterfaceMessage(true)` when
* content is intended to be in the user interface language, but
* sometimes rendered to the content language and displayed in the
* content area instead.
*
* A `ParserOutput` object corresponding to a given revision may be a
* combination of the renderings of multiple "slots":
* the Multi-Content Revisions (MCR) work allows articles to be
* composed from multiple `Content` objects. Each `Content` renders
* to a `ParserOutput`, and those `ParserOutput`s are merged by
* `RevisionRenderer::combineSlotOutput()` to create the final article
* output.
*
* Similarly, `OutputPage` maintains metadata overlapping
* with the metadata kept by `ParserOutput` (T301020) and may merge
* several `ParserOutput`s using `OutputPage::addParserOutput()` to
* create the final output page. Parsoid parses certain transclusions
* in independent top-level contexts using
* `Parser::parseExtensionTagAsTopLevelDoc()` and these also result in
* `ParserOutput`s which are merged via
* `ParserOutput::collectMetadata()`.
*
* Future plans for incremental parsing and asynchronous rendering may
* result in several of these component `ParserOutput` objects being
* cached independently and then recombined asynchronously, so
* operations on `ParserOutput` objects should be compatible with that
* model (T300979).
*
* @ingroup Parser
*/
class ParserOutput extends CacheTime implements ContentMetadataCollector {
use GhostFieldAccessTrait;
use JsonDeserializableTrait;
// This is used to break cyclic dependencies and allow a measure
// of compatibility when new methods are added to ContentMetadataCollector
// by Parsoid.
use ContentMetadataCollectorCompat;
/**
* Feature flags to indicate to extensions that MediaWiki core supports and
* uses getText() stateless transforms.
*
* @since 1.31
*/
public const SUPPORTS_STATELESS_TRANSFORMS = 1;
/**
* @since 1.31
*/
public const SUPPORTS_UNWRAP_TRANSFORM = 1;
/**
* @internal
* @since 1.38
*/
public const MW_MERGE_STRATEGY_KEY = '_mw-strategy';
/**
* Merge strategy to use for ParserOutput accumulators: "union"
* means that values are strings, stored as a set, and exposed as
* a PHP associative array mapping from values to `true`.
*
* This constant should be treated as @internal until we expose
* alternative merge strategies for external use.
* @internal
* @since 1.38
*/
public const MW_MERGE_STRATEGY_UNION = 'union';
/**
* @var string|null The output text
*/
private $mRawText = null;
/**
* @var array<string,string> Array mapping interwiki prefix to (non DB key) Titles (e.g. 'fr' => 'Test page')
*/
private $mLanguageLinkMap = [];
/**
* @var array<string,string> Map of category names to sort keys
*/
private $mCategories;
/**
* @var array<string,string> Page status indicators, usually displayed in top-right corner.
*/
private $mIndicators = [];
/**
* @var string Title text of the chosen language variant, as HTML.
*/
private $mTitleText;
/**
* @var array<int,array<string,int>> 2-D map of NS/DBK to ID for the links in the document.
* ID=zero for broken.
*/
private $mLinks = [];
/**
* @var array<string,int> Keys are DBKs for the links to special pages in the document.
* @since 1.35
*/
private $mLinksSpecial = [];
/**
* @var array<int,array<string,int>> 2-D map of NS/DBK to ID for the template references.
* ID=zero for broken.
*/
private $mTemplates = [];
/**
* @var array<int,array<string,int>> 2-D map of NS/DBK to rev ID for the template references.
* ID=zero for broken.
*/
private $mTemplateIds = [];
/**
* @var array<string,int> DB keys of the images used, in the array key only
*/
private $mImages = [];
/**
* @var array<string,array<string,string>> DB keys of the images used mapped to sha1 and MW timestamp.
*/
private $mFileSearchOptions = [];
/**
* @var array<string,int> External link URLs, in the key only.
*/
private array $mExternalLinks = [];
/**
* @var array<string,array<string,int>> 2-D map of prefix/DBK (in keys only)
* for the inline interwiki links in the document.
*/
private $mInterwikiLinks = [];
/**
* @var bool Show a new section link?
*/
private $mNewSection = false;
/**
* @var bool Hide the new section link?
*/
private $mHideNewSection = false;
/**
* @var bool No gallery on category page? (__NOGALLERY__).
*/
private $mNoGallery = false;
/**
* @var string[] Items to put in the <head> section
*/
private $mHeadItems = [];
/**
* @var array<string,true> Modules to be loaded by ResourceLoader
*/
private $mModuleSet = [];
/**
* @var array<string,true> Modules of which only the CSS will be loaded by ResourceLoader.
*/
private $mModuleStyleSet = [];
/**
* @var array JavaScript config variable for mw.config combined with this page.
*/
private $mJsConfigVars = [];
/**
* @var array<string,int> Warning text to be returned to the user.
* Wikitext formatted, in the key only.
*/
private $mWarnings = [];
/**
* @var array<string,array> *Unformatted* warning messages and
* arguments to be returned to the user. This is for internal use
* when merging ParserOutputs and are not serialized/deserialized.
*/
private $mWarningMsgs = [];
/**
* @var ?TOCData Table of contents data, or null if it hasn't been set.
*/
private $mTOCData;
/**
* @var array Name/value pairs to be cached in the DB.
*/
private $mProperties = [];
/**
* @var ?string Timestamp of the revision.
*/
private $mTimestamp;
/**
* @var bool Whether OOUI should be enabled.
*/
private $mEnableOOUI = false;
/**
* @var bool Whether the index policy has been set to 'index'.
*/
private $mIndexSet = false;
/**
* @var bool Whether the index policy has been set to 'noindex'.
*/
private $mNoIndexSet = false;
/**
* @var array extra data used by extensions.
*/
private $mExtensionData = [];
/**
* @var array Parser limit report data.
*/
private $mLimitReportData = [];
/** @var array Parser limit report data for JSON */
private $mLimitReportJSData = [];
/** @var string Debug message added by ParserCache */
private $mCacheMessage = '';
/**
* @var array Timestamps for getTimeSinceStart().
*/
private $mParseStartTime = [];
/**
* @var array Durations for getTimeProfile().
*/
private $mTimeProfile = [];
/**
* @var bool Whether to emit X-Frame-Options: DENY.
* This controls if anti-clickjacking / frame-breaking headers will
* be sent. This should be done for pages where edit actions are possible.
*/
private $mPreventClickjacking = false;
/**
* @var string[] Extra script-src for CSP
*/
private $mExtraScriptSrcs = [];
/**
* @var string[] Extra default-src for CSP [Everything but script and style]
*/
private $mExtraDefaultSrcs = [];
/**
* @var string[] Extra style-src for CSP
*/
private $mExtraStyleSrcs = [];
/**
* @var array<string,true> Generic flags.
*/
private $mFlags = [];
private const SPECULATIVE_FIELDS = [
'speculativePageIdUsed',
'mSpeculativeRevId',
'revisionTimestampUsed',
];
/** @var int|null Assumed rev ID for {{REVISIONID}} if no revision is set */
private $mSpeculativeRevId;
/** @var int|null Assumed page ID for {{PAGEID}} if no revision is set */
private $speculativePageIdUsed;
/** @var string|null Assumed rev timestamp for {{REVISIONTIMESTAMP}} if no revision is set */
private $revisionTimestampUsed;
/** @var string|null SHA-1 base 36 hash of any self-transclusion */
private $revisionUsedSha1Base36;
/** string CSS classes to use for the wrapping div, stored in the array keys.
* If no class is given, no wrapper is added.
* @var array<string,true>
*/
private $mWrapperDivClasses = [];
/** @var int Upper bound of expiry based on parse duration */
private $mMaxAdaptiveExpiry = INF;
// finalizeAdaptiveCacheExpiry() uses TTL = MAX( m * PARSE_TIME + b, MIN_AR_TTL)
// Current values imply that m=3933.333333 and b=-333.333333
// See https://www.nngroup.com/articles/website-response-times/
private const PARSE_FAST_SEC = 0.100; // perceived "fast" page parse
private const PARSE_SLOW_SEC = 1.0; // perceived "slow" page parse
private const FAST_AR_TTL = 60; // adaptive TTL for "fast" pages
private const SLOW_AR_TTL = 3600; // adaptive TTL for "slow" pages
private const MIN_AR_TTL = 15; // min adaptive TTL (for pool counter, and edit stashing)
/**
* @param string|null $text HTML. Use null to indicate that this ParserOutput contains only
* meta-data, and the HTML output is undetermined, as opposed to empty. Passing null
* here causes hasText() to return false. In 1.39 the default value changed from ''
* to null.
* @param array $languageLinks
* @param array $categoryLinks
* @param bool $unused
* @param string $titletext
*/
public function __construct( $text = null, $languageLinks = [], $categoryLinks = [],
$unused = false, $titletext = ''
) {
$this->mRawText = $text;
$this->mCategories = $categoryLinks;
$this->mTitleText = $titletext;
if ( $languageLinks === null ) { // T376323
wfDeprecated( __METHOD__ . ' with null $languageLinks', '1.43' );
}
foreach ( ( $languageLinks ?? [] ) as $ll ) {
$this->addLanguageLink( $ll );
}
// If the content handler does not specify an alternative (by
// calling ::resetParseStartTime() at a later point) then use
// the creation of the ParserOutput as the "start of parse" time.
$this->resetParseStartTime();
}
/**
* Returns true if text was passed to the constructor, or set using setText(). Returns false
* if null was passed to the $text parameter of the constructor to indicate that this
* ParserOutput only contains meta-data, and the HTML output is undetermined.
*
* @since 1.32
*
* @return bool Whether this ParserOutput contains rendered text. If this returns false, the
* ParserOutput contains meta-data only.
*/
public function hasText(): bool {
return ( $this->mRawText !== null );
}
/**
* Get the cacheable text with <mw:editsection> markers still in it. The
* return value is suitable for writing back via setText() but is not valid
* for display to the user.
*
* @return string
* @since 1.27
*/
public function getRawText() {
if ( $this->mRawText === null ) {
throw new LogicException( 'This ParserOutput contains no text!' );
}
return $this->mRawText;
}
/**
* Get the output HTML
*
* T293512: in the future, ParserOutput::getText() will be deprecated in favor of invoking
* the OutputTransformPipeline directly on a ParserOutput.
* @param array $options (since 1.31) Transformations to apply to the HTML
* - allowClone: (bool) Whether to clone the ParserOutput before
* applying transformations. Default is false.
* - allowTOC: (bool) Show the TOC, assuming there were enough headings
* to generate one and `__NOTOC__` wasn't used. Default is true,
* but might be statefully overridden.
* - injectTOC: (bool) Replace the TOC_PLACEHOLDER with TOC contents;
* otherwise the marker will be left in the article (and the skin
* will be responsible for replacing or removing it). Default is
* true.
* - enableSectionEditLinks: (bool) Include section edit links, assuming
* section edit link tokens are present in the HTML. Default is true,
* but might be statefully overridden.
* - userLang: (Language) Language object used for localizing UX messages,
* for example the heading of the table of contents. If omitted, will
* use the language of the main request context.
* - skin: (Skin) Skin object used for transforming section edit links.
* - unwrap: (bool) Return text without a wrapper div. Default is false,
* meaning a wrapper div will be added if getWrapperDivClass() returns
* a non-empty string.
* - wrapperDivClass: (string) Wrap the output in a div and apply the given
* CSS class to that div. This overrides the output of getWrapperDivClass().
* Setting this to an empty string has the same effect as 'unwrap' => true.
* - deduplicateStyles: (bool) When true, which is the default, `<style>`
* tags with the `data-mw-deduplicate` attribute set are deduplicated by
* value of the attribute: all but the first will be replaced by `<link
* rel="mw-deduplicated-inline-style" href="mw-data:..."/>` tags, where
* the scheme-specific-part of the href is the (percent-encoded) value
* of the `data-mw-deduplicate` attribute.
* - absoluteURLs: (bool) use absolute URLs in all links. Default: false
* - includeDebugInfo: (bool) render PP limit report in HTML. Default: false
* @return string HTML
* @return-taint escaped
* @deprecated since 1.42, this method has side-effects on the ParserOutput
* (see T353257) and so should be avoided in favor of directly invoking
* the default output pipeline on a ParserOutput; for now, use of
* ::runOutputPipeline() is preferred to ensure that ParserOptions are
* available.
*/
public function getText( $options = [] ) {
$oldText = $this->mRawText; // T353257
$options += [ 'allowClone' => false ];
$po = $this->runPipelineInternal( null, $options );
$newText = $po->getContentHolderText();
// T353257: for back-compat only mutations to metadata performed by
// the pipeline should be preserved; mutations to $mText should be
// discarded.
$this->setRawText( $oldText );
return $newText;
}
/**
* @unstable This method is transitional and will be replaced by a method
* in another class, maybe ContentRenderer. It allows us to break our
* porting work into two steps; in the first we bring ParserOptions to
* to each ::getText() callsite to ensure it is made available to the
* postprocessing pipeline. In the second we move this functionality
* into the Content hierarchy and out of ParserOutput, which should become
* a pure value object.
*
* @param ParserOptions $popts
* @param array $options (since 1.31) Transformations to apply to the HTML
* - allowClone: (bool) Whether to clone the ParserOutput before
* applying transformations. Default is true.
* - allowTOC: (bool) Show the TOC, assuming there were enough headings
* to generate one and `__NOTOC__` wasn't used. Default is true,
* but might be statefully overridden.
* - injectTOC: (bool) Replace the TOC_PLACEHOLDER with TOC contents;
* otherwise the marker will be left in the article (and the skin
* will be responsible for replacing or removing it). Default is
* true.
* - enableSectionEditLinks: (bool) Include section edit links, assuming
* section edit link tokens are present in the HTML. Default is true,
* but might be statefully overridden.
* - userLang: (Language) Language object used for localizing UX messages,
* for example the heading of the table of contents. If omitted, will
* use the language of the main request context.
* - skin: (Skin) Skin object used for transforming section edit links.
* - unwrap: (bool) Return text without a wrapper div. Default is false,
* meaning a wrapper div will be added if getWrapperDivClass() returns
* a non-empty string.
* - wrapperDivClass: (string) Wrap the output in a div and apply the given
* CSS class to that div. This overrides the output of getWrapperDivClass().
* Setting this to an empty string has the same effect as 'unwrap' => true.
* - deduplicateStyles: (bool) When true, which is the default, `<style>`
* tags with the `data-mw-deduplicate` attribute set are deduplicated by
* value of the attribute: all but the first will be replaced by `<link
* rel="mw-deduplicated-inline-style" href="mw-data:..."/>` tags, where
* the scheme-specific-part of the href is the (percent-encoded) value
* of the `data-mw-deduplicate` attribute.
* - absoluteURLs: (bool) use absolute URLs in all links. Default: false
* - includeDebugInfo: (bool) render PP limit report in HTML. Default: false
* It is planned to eventually deprecate this $options array and to be able to
* pass its content in the $popts ParserOptions.
* @return ParserOutput
*/
public function runOutputPipeline( ParserOptions $popts, array $options = [] ): ParserOutput {
return $this->runPipelineInternal( $popts, $options );
}
/**
* Temporary helper method to allow running the pipeline with null $popts for now, although
* passing a null ParserOptions is a temporary backward-compatibility hack and will be deprecated.
*/
private function runPipelineInternal( ?ParserOptions $popts, array $options = [] ): ParserOutput {
$pipeline = MediaWikiServices::getInstance()->getDefaultOutputPipeline();
$options += [
'allowClone' => true,
'allowTOC' => true,
'injectTOC' => true,
'enableSectionEditLinks' => !$this->getOutputFlag( ParserOutputFlags::NO_SECTION_EDIT_LINKS ),
'userLang' => null,
'skin' => null,
'unwrap' => false,
'wrapperDivClass' => $this->getWrapperDivClass(),
'deduplicateStyles' => true,
'absoluteURLs' => false,
'includeDebugInfo' => false,
'isParsoidContent' => PageBundleParserOutputConverter::hasPageBundle( $this ),
];
return $pipeline->run( $this, $popts, $options );
}
/**
* Adds a comment notice about cache state to the text of the page
* @param string $msg
* @internal used by ParserCache
*/
public function addCacheMessage( string $msg ): void {
$this->mCacheMessage .= $msg;
}
/**
* Add a CSS class to use for the wrapping div. If no class is given, no wrapper is added.
*
* @param string $class
*/
public function addWrapperDivClass( $class ): void {
$this->mWrapperDivClasses[$class] = true;
}
/**
* Clears the CSS class to use for the wrapping div, effectively disabling the wrapper div
* until addWrapperDivClass() is called.
*/
public function clearWrapperDivClass(): void {
$this->mWrapperDivClasses = [];
}
/**
* Returns the class (or classes) to be used with the wrapper div for this output.
* If there is no wrapper class given, no wrapper div should be added.
* The wrapper div is added automatically by getText().
*
* @return string
*/
public function getWrapperDivClass(): string {
return implode( ' ', array_keys( $this->mWrapperDivClasses ) );
}
/**
* @param int $id
* @since 1.28
*/
public function setSpeculativeRevIdUsed( $id ): void {
$this->mSpeculativeRevId = $id;
}
/**
* @return int|null
* @since 1.28
*/
public function getSpeculativeRevIdUsed(): ?int {
return $this->mSpeculativeRevId;
}
/**
* @param int $id
* @since 1.34
*/
public function setSpeculativePageIdUsed( $id ): void {
$this->speculativePageIdUsed = $id;
}
/**
* @return int|null
* @since 1.34
*/
public function getSpeculativePageIdUsed() {
return $this->speculativePageIdUsed;
}
/**
* @param string $timestamp TS_MW timestamp
* @since 1.34
*/
public function setRevisionTimestampUsed( $timestamp ): void {
$this->revisionTimestampUsed = $timestamp;
}
/**
* @return string|null TS_MW timestamp or null if not used
* @since 1.34
*/
public function getRevisionTimestampUsed() {
return $this->revisionTimestampUsed;
}
/**
* @param string $hash Lowercase SHA-1 base 36 hash
* @since 1.34
*/
public function setRevisionUsedSha1Base36( $hash ): void {
if ( $hash === null ) {
return; // e.g. RevisionRecord::getSha1() returned null
}
if (
$this->revisionUsedSha1Base36 !== null &&
$this->revisionUsedSha1Base36 !== $hash
) {
$this->revisionUsedSha1Base36 = ''; // mismatched
} else {
$this->revisionUsedSha1Base36 = $hash;
}
}
/**
* @return string|null Lowercase SHA-1 base 36 hash, null if unused, or "" on inconsistency
* @since 1.34
*/
public function getRevisionUsedSha1Base36() {
return $this->revisionUsedSha1Base36;
}
/**
* @return string[]
* @note Before 1.43, this function returned an array reference.
* @deprecated since 1.43, use ::getLinkList(ParserOutputLinkTypes::LANGUAGE)
*/
public function getLanguageLinks() {
$result = [];
foreach ( $this->mLanguageLinkMap as $lang => $title ) {
// T374736: Back-compat with empty prefix; see ::addLanguageLink()
$result[] = $title === '|' ? "$lang" : "$lang:$title";
}
return $result;
}
/** @deprecated since 1.43, use ::getLinkList(ParserOutputLinkTypes::INTERWIKI) */
public function getInterwikiLinks() {
return $this->mInterwikiLinks;
}
/**
* Return the names of the categories on this page.
* Unlike ::getCategories(), sort keys are *not* included in the
* return value.
* @return array<string> The names of the categories
* @since 1.38
*/
public function getCategoryNames(): array {
# Note that numeric category names get converted to 'int' when
# stored as array keys; stringify the keys to ensure they
# return to original string form so as not to confuse callers.
return array_map( 'strval', array_keys( $this->mCategories ) );
}
/**
* Return category names and sort keys as a map.
*
* BEWARE that numeric category names get converted to 'int' when stored
* as array keys. Because of this, use of this method is not recommended
* in new code; using ::getCategoryNames() and ::getCategorySortKey() will
* be less error-prone.
*
* @return array<string|int,string>
* @internal
*/
public function getCategoryMap(): array {
return $this->mCategories;
}
/**
* Return the sort key for a given category name, or `null` if the
* category is not present in this ParserOutput. Returns the
* empty string if the category is to use the default sort key.
*
* @note The effective sort key in the database may vary from what
* is returned here; see note in ParserOutput::addCategory().
*
* @param string $name The category name
* @return ?string The sort key for the category, or `null` if the
* category is not present in this ParserOutput
* @since 1.40
*/
public function getCategorySortKey( string $name ): ?string {
// This API avoids exposing the fact that numeric string category
// names are going to be converted to 'int' when used as array
// keys for the `mCategories` field.
return $this->mCategories[$name] ?? null;
}
/**
* @return string[]
* @since 1.25
*/
public function getIndicators(): array {
return $this->mIndicators;
}
public function getTitleText() {
return $this->mTitleText;
}
/**
* @return ?TOCData the table of contents data, or null if it hasn't been
* set.
*/
public function getTOCData(): ?TOCData {
return $this->mTOCData;
}
/**
* @internal
* @return string
*/
public function getCacheMessage(): string {
return $this->mCacheMessage;
}
/**
* @internal
* @return array
*/
public function getSections(): array {
if ( $this->mTOCData !== null ) {
return $this->mTOCData->toLegacy();
}
// For compatibility
return [];
}
/**
* Get a list of links of the given type.
*
* Provides a uniform interface to various lists of links stored in
* the metadata.
*
* Each element of the returned array has a LinkTarget as the 'link'
* property. Local and template links also have 'pageid' set.
* Template links have 'revid' set. Category links have 'sort' set.
* Media links optionally have 'time' and 'sha1' set.
*
* @param string $linkType A link type, which should be a constant from
* ParserOutputLinkTypes.
* @return list<array{link:ParsoidLinkTarget,pageid?:int,revid?:int,sort?:string,time?:string|false,sha1?:string|false}>
*/
public function getLinkList( string $linkType ): array {
# Note that fragments are dropped for everything except language links
$result = [];
switch ( $linkType ) {
case ParserOutputLinkTypes::CATEGORY:
foreach ( $this->mCategories as $dbkey => $sort ) {
$result[] = [
'link' => new TitleValue( NS_CATEGORY, (string)$dbkey ),
'sort' => $sort,
];
}
break;
case ParserOutputLinkTypes::INTERWIKI:
foreach ( $this->mInterwikiLinks as $prefix => $arr ) {
foreach ( $arr as $dbkey => $ignore ) {
$result[] = [
'link' => new TitleValue( NS_MAIN, (string)$dbkey, '', (string)$prefix ),
];
}
}
break;
case ParserOutputLinkTypes::LANGUAGE:
foreach ( $this->mLanguageLinkMap as $lang => $title ) {
if ( $title === '|' ) {
continue; // T374736
}
# language links can have fragments!
[ $title, $frag ] = array_pad( explode( '#', $title, 2 ), 2, '' );
$result[] = [
'link' => new TitleValue( NS_MAIN, $title, $frag, (string)$lang ),
];
}
break;
case ParserOutputLinkTypes::LOCAL:
foreach ( $this->mLinks as $ns => $arr ) {
foreach ( $arr as $dbkey => $id ) {
$result[] = [
'link' => new TitleValue( $ns, (string)$dbkey ),
'pageid' => $id,
];
}
}
break;
case ParserOutputLinkTypes::MEDIA:
foreach ( $this->mImages as $dbkey => $ignore ) {
$extra = $this->mFileSearchOptions[$dbkey] ?? [];
$extra['link'] = new TitleValue( NS_FILE, (string)$dbkey );
$result[] = $extra;
}
break;
case ParserOutputLinkTypes::SPECIAL:
foreach ( $this->mLinksSpecial as $dbkey => $ignore ) {
$result[] = [
'link' => new TitleValue( NS_SPECIAL, (string)$dbkey ),
];
}
break;
case ParserOutputLinkTypes::TEMPLATE:
foreach ( $this->mTemplates as $ns => $arr ) {
foreach ( $arr as $dbkey => $pageid ) {
$result[] = [
'link' => new TitleValue( $ns, (string)$dbkey ),
'pageid' => $pageid,
'revid' => $this->mTemplateIds[$ns][$dbkey],
];
}
}
break;
default:
throw new UnexpectedValueException( "Unknown link type $linkType" );
}
return $result;
}
/** @deprecated since 1.43, use ::getLinkList(ParserOutputLinkTypes::LOCAL) */
public function &getLinks() {
return $this->mLinks;
}
/**
* @return array Keys are DBKs for the links to special pages in the document
* @since 1.35
* @deprecated since 1.43, use ::getLinkList(ParserOutputLinkTypes::SPECIAL)
*/
public function &getLinksSpecial() {
return $this->mLinksSpecial;
}
/** @deprecated since 1.43, use ::getLinkList(ParserOutputLinkTypes::TEMPLATE) */
public function &getTemplates() {
return $this->mTemplates;
}
/** @deprecated since 1.43, use ::getLinkList(ParserOutputLinkTypes::TEMPLATE) */
public function &getTemplateIds() {
return $this->mTemplateIds;
}
/** @deprecated since 1.43, use ::getLinkList(ParserOutputLinkTypes::MEDIA) */
public function &getImages() {
return $this->mImages;
}
/** @deprecated since 1.43, use ::getLinkList(ParserOutputLinkTypes::MEDIA) */
public function &getFileSearchOptions() {
return $this->mFileSearchOptions;
}
/**
* @note Use of the reference returned by this method has been
* deprecated since 1.43. In a future release this will return a
* normal array. Use ::addExternalLink() to modify the set of
* external links stored in this ParserOutput.
*/
public function &getExternalLinks(): array {
return $this->mExternalLinks;
}
public function setNoGallery( $value ): void {
$this->mNoGallery = (bool)$value;
}
public function getNoGallery() {
return $this->mNoGallery;
}
public function getHeadItems() {
return $this->mHeadItems;
}
public function getModules() {
return array_keys( $this->mModuleSet );
}
public function getModuleStyles() {
return array_keys( $this->mModuleStyleSet );
}
/**
* @param bool $showStrategyKeys Defaults to false; if set to true will
* expose the internal `MW_MERGE_STRATEGY_KEY` in the result. This
* should only be used internally to allow safe merge of config vars.
* @return array
* @since 1.23
*/
public function getJsConfigVars( bool $showStrategyKeys = false ) {
$result = $this->mJsConfigVars;
// Don't expose the internal strategy key
foreach ( $result as &$value ) {
if ( is_array( $value ) && !$showStrategyKeys ) {
unset( $value[self::MW_MERGE_STRATEGY_KEY] );
}
}
return $result;
}
public function getWarnings(): array {
return array_keys( $this->mWarnings );
}
public function getIndexPolicy(): string {
// 'noindex' wins if both are set. (T16899)
if ( $this->mNoIndexSet ) {
return 'noindex';
} elseif ( $this->mIndexSet ) {
return 'index';
}
return '';
}
/**
* @return string|null TS_MW timestamp of the revision content
*/
public function getRevisionTimestamp(): ?string {
return $this->mTimestamp;
}
/**
* @return string|null TS_MW timestamp of the revision content
* @deprecated since 1.42; use ::getRevisionTimestamp() instead
*/
public function getTimestamp() {
return $this->getRevisionTimestamp();
}
public function getLimitReportData() {
return $this->mLimitReportData;
}
public function getLimitReportJSData() {
return $this->mLimitReportJSData;
}
public function getEnableOOUI() {
return $this->mEnableOOUI;
}
/**
* Get extra Content-Security-Policy 'default-src' directives
* @since 1.35
* @return string[]
*/
public function getExtraCSPDefaultSrcs() {
return $this->mExtraDefaultSrcs;
}
/**
* Get extra Content-Security-Policy 'script-src' directives
* @since 1.35
* @return string[]
*/
public function getExtraCSPScriptSrcs() {
return $this->mExtraScriptSrcs;
}
/**
* Get extra Content-Security-Policy 'style-src' directives
* @since 1.35
* @return string[]
*/
public function getExtraCSPStyleSrcs() {
return $this->mExtraStyleSrcs;
}
/**
* Set the raw text of the ParserOutput.
*
* If you did not generate html, pass null to mark it as such.
*
* @since 1.42
* @param string|null $text HTML content of ParserOutput or null if not generated
* @param-taint $text exec_html
*/
public function setRawText( ?string $text ): void {
$this->mRawText = $text;
}
/**
* Set the raw text of the ParserOutput.
*
* If you did not generate html, pass null to mark it as such.
*
* @since 1.39 You can now pass null to this function
* @param string|null $text HTML content of ParserOutput or null if not generated
* @param-taint $text exec_html
* @return string|null Previous value of ParserOutput's raw text
* @deprecated since 1.42; use ::setRawText() which matches the getter ::getRawText()
*/
public function setText( $text ) {
return wfSetVar( $this->mRawText, $text, true );
}
/**
* @deprecated since 1.42, use ::addLanguageLink() instead.
*/
public function setLanguageLinks( $ll ) {
$old = $this->getLanguageLinks();
$this->mLanguageLinkMap = [];
if ( $ll === null ) { // T376323
wfDeprecated( __METHOD__ . ' with null argument', '1.43' );
}
foreach ( ( $ll ?? [] ) as $l ) {
$this->addLanguageLink( $l );
}
return $old;
}
public function setTitleText( $t ) {
return wfSetVar( $this->mTitleText, $t );
}
/**
* @param TOCData $tocData Table of contents data for the page
*/
public function setTOCData( TOCData $tocData ): void {
$this->mTOCData = $tocData;
}
/**
* @param array $sectionArray
* @return array Previous value of ::getSections()
*/
public function setSections( array $sectionArray ) {
$oldValue = $this->getSections();
$this->setTOCData( TOCData::fromLegacy( $sectionArray ) );
return $oldValue;
}
/**
* Update the index policy of the robots meta tag.
*
* Note that calling this method does not guarantee
* that {@link self::getIndexPolicy()} will return the given policy –
* if different calls set the index policy to 'index' and 'noindex',
* then 'noindex' always wins (T16899), even if the 'index' call happened later.
* If this is not what you want,
* you can reset {@link ParserOutputFlags::NO_INDEX_POLICY} with {@link self::setOutputFlag()}.
*
* @param string $policy 'index' or 'noindex'.
* @return string The previous policy.
*/
public function setIndexPolicy( $policy ): string {
$old = $this->getIndexPolicy();
if ( $policy === 'noindex' ) {
$this->mNoIndexSet = true;
} elseif ( $policy === 'index' ) {
$this->mIndexSet = true;
}
return $old;
}
/**
* @param ?string $timestamp TS_MW timestamp of the revision content
*/
public function setRevisionTimestamp( ?string $timestamp ): void {
$this->mTimestamp = $timestamp;
}
/**
* @param ?string $timestamp TS_MW timestamp of the revision content
*
* @return ?string The previous value of the timestamp
* @deprecated since 1.42; use ::setRevisionTimestamp() instead
*/
public function setTimestamp( $timestamp ) {
return wfSetVar( $this->mTimestamp, $timestamp );
}
/**
* Add a category.
*
* Although ParserOutput::getCategorySortKey() will return exactly
* the sort key you specify here, before storing in the database
* all sort keys will be language converted, HTML entities will be
* decoded, newlines stripped, and then they will be truncated to
* 255 bytes. Thus the "effective" sort key in the DB may be different
* from what is passed to `$sort` here and returned by
* ::getCategorySortKey().
*
* @param string|ParsoidLinkTarget $c The category name
* @param string $sort The sort key; an empty string indicates
* that the default sort key for the page should be used.
*/
public function addCategory( $c, $sort = '' ): void {
if ( $c instanceof ParsoidLinkTarget ) {
$c = $c->getDBkey();
}
$this->mCategories[$c] = $sort;
}
/**
* Overwrite the category map.
* @param array<string,string> $c Map of category names to sort keys
* @since 1.38
*/
public function setCategories( array $c ): void {
$this->mCategories = $c;
}
/**
* @param string $id
* @param string $content
* @param-taint $content exec_html
* @since 1.25
*/
public function setIndicator( $id, $content ): void {
$this->mIndicators[$id] = $content;
}
/**
* Enables OOUI, if true, in any OutputPage instance this ParserOutput
* object is added to.
*
* @since 1.26
* @param bool $enable If OOUI should be enabled or not
*/
public function setEnableOOUI( bool $enable = false ): void {
$this->mEnableOOUI = $enable;
}
/**
* Add a language link.
* @param ParsoidLinkTarget|string $t
*/
public function addLanguageLink( $t ): void {
# Note that fragments are preserved
if ( $t instanceof ParsoidLinkTarget ) {
// Language links are unusual in using 'text' rather than 'db key'
// Note that fragments are preserved.
$lang = $t->getInterwiki();
$title = $t->getText();
if ( $t->hasFragment() ) {
$title .= '#' . $t->getFragment();
}
} else {
[ $lang, $title ] = array_pad( explode( ':', $t, 2 ), -2, '' );
}
if ( $lang === '' ) {
// T374736: For backward compatibility with test cases only!
wfDeprecated( __METHOD__ . ' without prefix', '1.43' );
[ $lang, $title ] = [ $title, '|' ]; // | can not occur in valid title
}
$this->mLanguageLinkMap[$lang] ??= $title;
}
/**
* Add a warning to the output for this page.
* @param MessageValue $mv Note that the parameters must be serializable/deserializable
* with JsonCodec; see the @note on ParserOutput::setExtensionData(). MessageValue guarantees
* that unless the deprecated ParamType::OBJECT or the ->objectParams() method is used.
* @since 1.43
*/
public function addWarningMsgVal( MessageValue $mv ) {
$m = ( new Converter() )->convertMessageValue( $mv );
// These can eventually be stored as MessageValue instead of converting to Message.
$this->addWarningMsg( $m->getKey(), ...$m->getParams() );
}
/**
* Add a warning to the output for this page.
* @param string $msg The localization message key for the warning
* @param mixed|JsonDeserializable ...$args Optional arguments for the
* message. These arguments must be serializable/deserializable with
* JsonCodec; see the @note on ParserOutput::setExtensionData()
* @since 1.38
*/
public function addWarningMsg( string $msg, ...$args ): void {
// MessageValue objects are defined in core and thus not visible
// to Parsoid or to its ContentMetadataCollector interface.
// Eventually this method (defined in ContentMetadataCollector) should
// call ::addWarningMsgVal() instead of the other way around.
// preserve original arguments in $mWarningMsgs to allow merge
// @todo: these aren't serialized/deserialized yet -- before we
// turn on serialization of $this->mWarningMsgs we need to ensure
// callers aren't passing nonserializable arguments: T343048.
$jsonCodec = MediaWikiServices::getInstance()->getJsonCodec();
$path = $jsonCodec->detectNonSerializableData( $args, true );
if ( $path !== null ) {
wfDeprecatedMsg(
"ParserOutput::addWarningMsg() called with nonserializable arguments: $path",
'1.41'
);
}
$this->mWarningMsgs[$msg] = $args;
$s = wfMessage( $msg, ...$args )
// some callers set the title here?
->inContentLanguage() // because this ends up in cache
->text();
$this->mWarnings[$s] = 1;
}
public function setNewSection( $value ): void {
$this->mNewSection = (bool)$value;
}
/**
* @param bool $value Hide the new section link?
*/
public function setHideNewSection( bool $value ): void {
$this->mHideNewSection = $value;
}
public function getHideNewSection(): bool {
return (bool)$this->mHideNewSection;
}
public function getNewSection(): bool {
return (bool)$this->mNewSection;
}
/**
* Checks, if a url is pointing to the own server
*
* @param string $internal The server to check against
* @param string $url The url to check
* @return bool
* @internal
*/
public static function isLinkInternal( $internal, $url ): bool {
return (bool)preg_match( '/^' .
# If server is proto relative, check also for http/https links
( substr( $internal, 0, 2 ) === '//' ? '(?:https?:)?' : '' ) .
preg_quote( $internal, '/' ) .
# check for query/path/anchor or end of link in each case
'(?:[\?\/\#]|$)/i',
$url
);
}
public function addExternalLink( $url ): void {
# We don't register links pointing to our own server, unless... :-)
$config = MediaWikiServices::getInstance()->getMainConfig();
$server = $config->get( MainConfigNames::Server );
$registerInternalExternals = $config->get( MainConfigNames::RegisterInternalExternals );
# Replace unnecessary URL escape codes with the referenced character
# This prevents spammers from hiding links from the filters
$url = Parser::normalizeLinkUrl( $url );
$registerExternalLink = true;
if ( !$registerInternalExternals ) {
$registerExternalLink = !self::isLinkInternal( $server, $url );
}
if ( $registerExternalLink ) {
$this->mExternalLinks[$url] = 1;
}
}
/**
* Record a local or interwiki inline link for saving in future link tables.
*
* @param ParsoidLinkTarget $link (used to require Title until 1.38)
* @param int|null $id Optional known page_id so we can skip the lookup
*/
public function addLink( ParsoidLinkTarget $link, $id = null ): void {
if ( $link->isExternal() ) {
// Don't record interwikis in pagelinks
$this->addInterwikiLink( $link );
return;
}
$ns = $link->getNamespace();
$dbk = $link->getDBkey();
if ( $ns === NS_MEDIA ) {
// Normalize this pseudo-alias if it makes it down here...
$ns = NS_FILE;
} elseif ( $ns === NS_SPECIAL ) {
// We don't want to record Special: links in the database, so put them in a separate place.
// It might actually be wise to, but we'd need to do some normalization.
$this->mLinksSpecial[$dbk] = 1;
return;
} elseif ( $dbk === '' ) {
// Don't record self links - [[#Foo]]
return;
}
if ( $id === null ) {
// T357048: This actually kills performance; we should batch these.
$page = MediaWikiServices::getInstance()->getPageStore()->getPageForLink( $link );
$id = $page->getId();
}
$this->mLinks[$ns][$dbk] = $id;
}
/**
* Register a file dependency for this output
* @param string|ParsoidLinkTarget $name Title dbKey
* @param string|false|null $timestamp MW timestamp of file creation (or false if non-existing)
* @param string|false|null $sha1 Base 36 SHA-1 of file (or false if non-existing)
*/
public function addImage( $name, $timestamp = null, $sha1 = null ): void {
if ( $name instanceof ParsoidLinkTarget ) {
$name = $name->getDBkey();
}
$this->mImages[$name] = 1;
if ( $timestamp !== null && $sha1 !== null ) {
$this->mFileSearchOptions[$name] = [ 'time' => $timestamp, 'sha1' => $sha1 ];
}
}
/**
* Register a template dependency for this output
*
* @param ParsoidLinkTarget $link (used to require Title until 1.38)
* @param int $page_id
* @param int $rev_id
*/
public function addTemplate( $link, $page_id, $rev_id ): void {
if ( $link->isExternal() ) {
// Will throw an InvalidArgumentException in a future release.
wfDeprecated( __METHOD__ . " with interwiki link", '1.42' );
return;
}
$ns = $link->getNamespace();
$dbk = $link->getDBkey();
// T357048: Parsoid doesn't have page_id
$this->mTemplates[$ns][$dbk] = $page_id;
$this->mTemplateIds[$ns][$dbk] = $rev_id; // For versioning
}
/**
* @param ParsoidLinkTarget $link must be an interwiki link
* (used to require Title until 1.38).
*/
public function addInterwikiLink( $link ): void {
if ( !$link->isExternal() ) {
throw new InvalidArgumentException( 'Non-interwiki link passed, internal parser error.' );
}
$prefix = $link->getInterwiki();
$this->mInterwikiLinks[$prefix][$link->getDBkey()] = 1;
}
/**
* Add some text to the "<head>".
* If $tag is set, the section with that tag will only be included once
* in a given page.
* @param string $section
* @param string|false $tag
*/
public function addHeadItem( $section, $tag = false ): void {
if ( $tag !== false ) {
$this->mHeadItems[$tag] = $section;
} else {
$this->mHeadItems[] = $section;
}
}
/**
* @see OutputPage::addModules
* @param string[] $modules
*/
public function addModules( array $modules ): void {
$modules = array_fill_keys( $modules, true );
$this->mModuleSet = array_merge( $this->mModuleSet, $modules );
}
/**
* @see OutputPage::addModuleStyles
* @param string[] $modules
*/
public function addModuleStyles( array $modules ): void {
$modules = array_fill_keys( $modules, true );
$this->mModuleStyleSet = array_merge( $this->mModuleStyleSet, $modules );
}
/**
* Add one or more variables to be set in mw.config in JavaScript.
*
* @param string|array $keys Key or array of key/value pairs.
* @param mixed|null $value [optional] Value of the configuration variable.
* @since 1.23
* @deprecated since 1.38, use ::setJsConfigVar() or ::appendJsConfigVar()
* which ensures compatibility with asynchronous parsing; emitting warnings
* since 1.43.
*/
public function addJsConfigVars( $keys, $value = null ): void {
wfDeprecated( __METHOD__, '1.38' );
if ( is_array( $keys ) ) {
foreach ( $keys as $key => $value ) {
$this->mJsConfigVars[$key] = $value;
}
return;
}
$this->mJsConfigVars[$keys] = $value;
}
/**
* Add a variable to be set in mw.config in JavaScript.
*
* In order to ensure the result is independent of the parse order, the values
* set here must be unique -- that is, you can pass the same $key
* multiple times but ONLY if the $value is identical each time.
* If you want to collect multiple pieces of data under a single key,
* use ::appendJsConfigVar().
*
* @param string $key Key to use under mw.config
* @param mixed|null $value Value of the configuration variable.
* @since 1.38
*/
public function setJsConfigVar( string $key, $value ): void {
if (
array_key_exists( $key, $this->mJsConfigVars ) &&
$this->mJsConfigVars[$key] !== $value
) {
// Ensure that a key is mapped to only a single value in order
// to prevent the resulting array from varying if content
// is parsed in a different order.
throw new InvalidArgumentException( "Multiple conflicting values given for $key" );
}
$this->mJsConfigVars[$key] = $value;
}
/**
* Append a value to a variable to be set in mw.config in JavaScript.
*
* In order to ensure the result is independent of the parse order,
* the value of this key will be an associative array, mapping all of
* the values set under that key to true. (The array is implicitly
* ordered in PHP, but you should treat it as unordered.)
* If you want a non-array type for the key, and can ensure that only
* a single value will be set, you should use ::setJsConfigVar() instead.
*
* @param string $key Key to use under mw.config
* @param string $value Value to append to the configuration variable.
* @param string $strategy Merge strategy:
* only MW_MERGE_STRATEGY_UNION is currently supported and external callers
* should treat this parameter as @internal at this time and omit it.
* @since 1.38
*/
public function appendJsConfigVar(
string $key,
string $value,
string $strategy = self::MW_MERGE_STRATEGY_UNION
): void {
if ( $strategy !== self::MW_MERGE_STRATEGY_UNION ) {
throw new InvalidArgumentException( "Unknown merge strategy $strategy." );
}
if ( !array_key_exists( $key, $this->mJsConfigVars ) ) {
$this->mJsConfigVars[$key] = [
// Indicate how these values are to be merged.
self::MW_MERGE_STRATEGY_KEY => $strategy,
];
} elseif ( !is_array( $this->mJsConfigVars[$key] ) ) {
throw new InvalidArgumentException( "Mixing set and append for $key" );
} elseif ( ( $this->mJsConfigVars[$key][self::MW_MERGE_STRATEGY_KEY] ?? null ) !== $strategy ) {
throw new InvalidArgumentException( "Conflicting merge strategies for $key" );
}
$this->mJsConfigVars[$key][$value] = true;
}
/**
* Accommodate very basic transcluding of a temporary OutputPage object into parser output.
*
* This is a fragile method that cannot be relied upon in any meaningful way.
* It exists solely to support the wikitext feature of transcluding a SpecialPage, and
* only has to work for that use case to ensure relevant styles are loaded, and that
* essential config vars needed between SpecialPage and a JS feature are added.
*
* This relies on there being no overlap between modules or config vars added by
* the SpecialPage and those added by parser extensions. If there is overlap,
* then arise and break one or both sides. This is expected and unsupported.
*
* @internal For use by Parser for basic special page transclusion
* @param OutputPage $out
*/
public function addOutputPageMetadata( OutputPage $out ): void {
// This should eventually use the same merge mechanism used
// internally to merge ParserOutputs together.
// (ie: $this->mergeHtmlMetaDataFrom( $out->getMetadata() )
// once preventClickjacking, moduleStyles, modules, jsconfigvars,
// and head items are moved to OutputPage::$metadata)
// Take the strictest click-jacking policy. This is to ensure any one-click features
// such as patrol or rollback on the transcluded special page will result in the wiki page
// disallowing embedding in cross-origin iframes. Articles are generally allowed to be
// embedded. Pages that transclude special pages are expected to be user pages or
// other non-content pages that content re-users won't discover or care about.
$this->mPreventClickjacking = $this->mPreventClickjacking || $out->getPreventClickjacking();
$this->addModuleStyles( $out->getModuleStyles() );
// TODO: Figure out if style modules suffice, or whether the below is needed as well.
// Are there special pages that permit transcluding/including and also have JS modules
// that should be activate on the host page?
$this->addModules( $out->getModules() );
$this->mJsConfigVars = self::mergeMapStrategy(
$this->mJsConfigVars, $out->getJsConfigVars()
);
$this->mHeadItems = array_merge( $this->mHeadItems, $out->getHeadItemsArray() );
}
/**
* Override the title to be used for display
*
* @note this is assumed to have been validated
* (check equal normalisation, etc.)
*
* @note this is expected to be safe HTML,
* ready to be served to the client.
*
* @param string $text Desired title text
*/
public function setDisplayTitle( $text ): void {
$this->setTitleText( $text );
$this->setPageProperty( 'displaytitle', $text );
}
/**
* Get the title to be used for display.
*
* As per the contract of setDisplayTitle(), this is safe HTML,
* ready to be served to the client.
*
* @return string|false HTML
*/
public function getDisplayTitle() {
$t = $this->getTitleText();
if ( $t === '' ) {
return false;
}
return $t;
}
/**
* Get the primary language code of the output.
*
* This returns the primary language of the output, including
* any LanguageConverter variant applied.
*
* NOTE: This may differ from the wiki's default content language
* ($wgLanguageCode, MediaWikiServices::getContentLanguage), because
* each page may have its own "page language" set (PageStoreRecord,
* Title::getDbPageLanguageCode, ContentHandler::getPageLanguage).
*
* NOTE: This may differ from the "page language" when parsing
* user interface messages, in which case this reflects the user
* language (including any variant preference).
*
* NOTE: This may differ from the Parser's "target language" that was
* set while the Parser was parsing the page, because the final output
* is converted to the current user's preferred LanguageConverter variant
* (assuming this is a variant of the target language).
* See Parser::getTargetLanguageConverter()->getPreferredVariant(); use
* LanguageFactory::getParentLanguage() on the language code to obtain
* the base language code. LanguageConverter::getPreferredVariant()
* depends on the global RequestContext for the URL and the User
* language preference.
*
* Finally, note that a single ParserOutput object may contain
* HTML content in multiple different languages and directions
* (T114640). Authors of wikitext and of parser extensions are
* expected to mark such subtrees with a `lang` attribute (set to
* a BCP-47 value, see Language::toBcp47Code()) and a corresponding
* `dir` attribute (see Language::getDir()). This method returns
* the language code for wrapper of the HTML content.
*
* @see Parser::internalParseHalfParsed
* @since 1.40
* @return ?Bcp47Code The primary language for this output,
* or `null` if a language was not set.
*/
public function getLanguage(): ?Bcp47Code {
// This information is temporarily stored in extension data (T303329)
$code = $this->getExtensionData( 'core:target-lang-variant' );
// This is null if the ParserOutput was cached by MW 1.40 or earlier,
// or not constructed by Parser/ParserCache.
return $code === null ? null : new Bcp47CodeValue( $code );
}
/**
* Set the primary language of the output.
*
* See the discussion and caveats in ::getLanguage().
*
* @param Bcp47Code $lang The primary language for this output, including
* any variant specification.
* @since 1.40
*/
public function setLanguage( Bcp47Code $lang ): void {
$this->setExtensionData( 'core:target-lang-variant', $lang->toBcp47Code() );
}
/**
* Return an HTML prefix to be applied on redirect pages, or null
* if this is not a redirect.
* @return ?string HTML to prepend to redirect pages, or null
* @internal
*/
public function getRedirectHeader(): ?string {
return $this->getExtensionData( 'core:redirect-header' );
}
/**
* Set an HTML prefix to be applied on redirect pages.
* @param string $html HTML to prepend to redirect pages
*/
public function setRedirectHeader( string $html ): void {
$this->setExtensionData( 'core:redirect-header', $html );
}
/**
* Store a unique rendering id for this ParserOutput. This is used
* whenever a client needs to record a dependency on a specific parse.
* It is typically set only when a parser output is cached.
*
* @param string $renderId a UUID identifying a specific parse
* @internal
*/
public function setRenderId( string $renderId ): void {
$this->setExtensionData( 'core:render-id', $renderId );
}
/**
* Return the unique rendering id for this ParserOutput. This is used
* whenever a client needs to record a dependency on a specific parse.
*
* @return string|null
* @internal
*/
public function getRenderId(): ?string {
// Backward-compatibility with old cache contents
// Can be removed after parser cache contents have expired
$old = $this->getExtensionData( 'parsoid-render-id' );
if ( $old !== null ) {
return ParsoidRenderId::newFromKey( $old )->getUniqueID();
}
return $this->getExtensionData( 'core:render-id' );
}
/**
* @return string[] List of flags signifying special cases
* @internal
*/
public function getAllFlags(): array {
return array_keys( $this->mFlags );
}
/**
* Set a page property to be stored in the page_props database table.
*
* page_props is a key-value store indexed by the page ID. This allows
* the parser to set a property on a page which can then be quickly
* retrieved given the page ID or via a DB join when given the page
* title.
*
* Since 1.23, page_props are also indexed by numeric value, to allow
* for efficient "top k" queries of pages wrt a given property.
* This only works if the value is passed as a int, float, or
* bool. Since 1.42 you should use ::setNumericPageProperty()
* if you want your page property value to be indexed, which will ensure
* that the value is of the proper type.
*
* setPageProperty() is thus used to propagate properties from the parsed
* page to request contexts other than a page view of the currently parsed
* article.
*
* Some applications examples:
*
* * To implement hidden categories, hiding pages from category listings
* by storing a page property.
*
* * Overriding the displayed article title (ParserOutput::setDisplayTitle()).
*
* * To implement image tagging, for example displaying an icon on an
* image thumbnail to indicate that it is listed for deletion on
* Wikimedia Commons.
* This is not actually implemented, yet but would be pretty cool.
*
* @note Use of non-scalar values (anything other than
* `string|int|float|bool`) has been deprecated in 1.42.
* Although any JSON-serializable value can be stored/fetched in
* ParserOutput, when the values are stored to the database
* (in `deferred/LinksUpdate/PagePropsTable.php`) they will be
* converted: booleans will be converted to '0' and '1', null
* will become '', and everything else will be cast to string
* (not JSON-serialized). Page properties obtained from the
* PageProps service will thus always be strings.
*
* @note The sort key stored in the database *will be NULL* unless
* the value passed here is an `int|float|bool`. If you *do not*
* want your property *value* indexed and sorted (for example, the
* value is a title string which can be numeric but only
* incidentally, like when it gets retrieved from an array key)
* be sure to cast to string or use
* `::setUnsortedPageProperty()`. If you *do* want your property
* *value* indexed and sorted, you should use
* `::setNumericPageProperty()` instead as this will ensure the
* value type is correct. Note that either way it is possible to
* efficiently look up all the pages with a certain property; we
* are only talking about sorting the *values* assigned to the
* property, for example for a "top N values of the property"
* query.
*
* @note Note that `::getPageProperty()`/`::setPageProperty()` do
* not do any conversions themselves; you should therefore be
* careful to distinguish values returned from the PageProp
* service (always strings) from values retrieved from a
* ParserOutput.
*
* @note Do not use setPageProperty() to set a property which is only used
* in a context where the ParserOutput object itself is already available,
* for example a normal page view. There is no need to save such a property
* in the database since the text is already parsed; use
* ::setExtensionData() instead.
*
* @par Example:
* @code
* $parser->getOutput()->setExtensionData( 'my_ext_foo', '...' );
* @endcode
*
* And then later, in OutputPageParserOutput or similar:
*
* @par Example:
* @code
* $output->getExtensionData( 'my_ext_foo' );
* @endcode
*
* @note The use of `null` as a value is deprecated since 1.42; use
* the empty string instead if you need a placeholder value, or
* ::unsetPageProperty() if you mean to remove a page property.
*
* @note The use of non-string values is deprecated since 1.42; if you
* need an page property value with a sort index
* use ::setNumericPageProperty().
*
* @param string $name
* @param ?scalar $value
* @since 1.38
*/
public function setPageProperty( string $name, $value ): void {
if ( $value === null ) {
// Use an empty string instead.
wfDeprecated( __METHOD__ . " with null value for $name", '1.42' );
} elseif ( !is_scalar( $value ) ) {
// Use ::setExtensionData() instead.
wfDeprecated( __METHOD__ . " with non-scalar value for $name", '1.42' );
} elseif ( !is_string( $value ) ) {
// Use ::setNumericPageProperty() instead.
wfDeprecated( __METHOD__ . " with non-string value for $name", '1.42' );
}
$this->mProperties[$name] = $value;
}
/**
* Set a numeric page property whose *value* is intended to be sorted
* and indexed. The sort key used for the property will be the value,
* coerced to a number.
*
* See `::setPageProperty()` for details.
*
* In the future, we may allow the value to be specified independent
* of sort key (T357783).
*
* @param string $propName The name of the page property
* @param int|float|string $numericValue the numeric value
* @since 1.42
*/
public function setNumericPageProperty( string $propName, $numericValue ): void {
if ( !is_numeric( $numericValue ) ) {
throw new \TypeError( __METHOD__ . " with non-numeric value" );
}
// Coerce numeric sort key to a number.
$this->mProperties[$propName] = 0 + $numericValue;
}
/**
* Set a page property whose *value* is not intended to be sorted and
* indexed.
*
* See `::setPageProperty()` for details. It is recommended to
* use the empty string if you need a placeholder value (ie, if
* it is the *presence* of the property which is important, not
* the *value* the property is set to).
*
* It is still possible to efficiently look up all the pages with
* a certain property (the "presence" of it *is* indexed; see
* Special:PagesWithProp, list=pageswithprop).
*
* @param string $propName The name of the page property
* @param string $value Optional value; defaults to the empty string.
* @since 1.42
*/
public function setUnsortedPageProperty( string $propName, string $value = '' ): void {
$this->mProperties[$propName] = $value;
}
/**
* Look up a page property.
* @param string $name The page property name to look up.
* @return ?scalar The value previously set using
* ::setPageProperty(), ::setUnsortedPageProperty(), or
* ::setNumericPageProperty().
* Returns null if no value was set for the given property name.
*
* @note You would need to use ::getPageProperties() to test for an
* explicitly-set null value; but see the note in ::setPageProperty()
* deprecating the use of null values.
* @since 1.38
*/
public function getPageProperty( string $name ) {
return $this->mProperties[$name] ?? null;
}
/**
* Remove a page property.
* @param string $name The page property name.
* @since 1.38
*/
public function unsetPageProperty( string $name ): void {
unset( $this->mProperties[$name] );
}
/**
* Return all the page properties set on this ParserOutput.
* @return array<string,?scalar>
* @since 1.38
*/
public function getPageProperties(): array {
if ( !isset( $this->mProperties ) ) {
$this->mProperties = [];
}
return $this->mProperties;
}
/**
* Provides a uniform interface to various boolean flags stored
* in the ParserOutput. Flags internal to MediaWiki core should
* have names which are constants in ParserOutputFlags. Extensions
* should use ::setExtensionData() rather than creating new flags
* with ::setOutputFlag() in order to prevent namespace conflicts.
*
* Flags are always combined with OR. That is, the flag is set in
* the resulting ParserOutput if the flag is set in *any* of the
* fragments composing the ParserOutput.
*
* @note The combination policy means that a ParserOutput may end
* up with both INDEX_POLICY and NO_INDEX_POLICY set. It is
* expected that NO_INDEX_POLICY "wins" in that case. (T16899)
* (This resolution is implemented in ::getIndexPolicy().)
*
* @param string $name A flag name
* @param bool $val
* @since 1.38
*/
public function setOutputFlag( string $name, bool $val = true ): void {
switch ( $name ) {
case ParserOutputFlags::NO_GALLERY:
$this->setNoGallery( $val );
break;
case ParserOutputFlags::ENABLE_OOUI:
$this->setEnableOOUI( $val );
break;
case ParserOutputFlags::NO_INDEX_POLICY:
$this->mNoIndexSet = $val;
break;
case ParserOutputFlags::INDEX_POLICY:
$this->mIndexSet = $val;
break;
case ParserOutputFlags::NEW_SECTION:
$this->setNewSection( $val );
break;
case ParserOutputFlags::HIDE_NEW_SECTION:
$this->setHideNewSection( $val );
break;
case ParserOutputFlags::PREVENT_CLICKJACKING:
$this->setPreventClickjacking( $val );
break;
default:
if ( $val ) {
$this->mFlags[$name] = true;
} else {
unset( $this->mFlags[$name] );
}
break;
}
}
/**
* Provides a uniform interface to various boolean flags stored
* in the ParserOutput. Flags internal to MediaWiki core should
* have names which are constants in ParserOutputFlags. Extensions
* should only use ::getOutputFlag() to query flags defined in
* ParserOutputFlags in core; they should use ::getExtensionData()
* to define their own flags.
*
* @param string $name A flag name
* @return bool The flag value
* @since 1.38
*/
public function getOutputFlag( string $name ): bool {
switch ( $name ) {
case ParserOutputFlags::NO_GALLERY:
return $this->getNoGallery();
case ParserOutputFlags::ENABLE_OOUI:
return $this->getEnableOOUI();
case ParserOutputFlags::INDEX_POLICY:
return $this->mIndexSet;
case ParserOutputFlags::NO_INDEX_POLICY:
return $this->mNoIndexSet;
case ParserOutputFlags::NEW_SECTION:
return $this->getNewSection();
case ParserOutputFlags::HIDE_NEW_SECTION:
return $this->getHideNewSection();
case ParserOutputFlags::PREVENT_CLICKJACKING:
return $this->getPreventClickjacking();
default:
return isset( $this->mFlags[$name] );
}
}
/**
* Provides a uniform interface to various string sets stored
* in the ParserOutput. String sets internal to MediaWiki core should
* have names which are constants in ParserOutputStringSets. Extensions
* should use ::appendExtensionData() rather than creating new string sets
* with ::appendOutputStrings() in order to prevent namespace conflicts.
*
* @param string $name A string set name
* @param string[] $value
* @since 1.41
*/
public function appendOutputStrings( string $name, array $value ): void {
switch ( $name ) {
case ParserOutputStringSets::MODULE:
$this->addModules( $value );
break;
case ParserOutputStringSets::MODULE_STYLE:
$this->addModuleStyles( $value );
break;
case ParserOutputStringSets::EXTRA_CSP_DEFAULT_SRC:
foreach ( $value as $v ) {
$this->addExtraCSPDefaultSrc( $v );
}
break;
case ParserOutputStringSets::EXTRA_CSP_SCRIPT_SRC:
foreach ( $value as $v ) {
$this->addExtraCSPScriptSrc( $v );
}
break;
case ParserOutputStringSets::EXTRA_CSP_STYLE_SRC:
foreach ( $value as $v ) {
$this->addExtraCSPStyleSrc( $v );
}
break;
default:
throw new UnexpectedValueException( "Unknown output string set name $name" );
}
}
/**
* Provides a uniform interface to various boolean string sets stored
* in the ParserOutput. String sets internal to MediaWiki core should
* have names which are constants in ParserOutputStringSets. Extensions
* should only use ::getOutputStrings() to query string sets defined in
* ParserOutputStringSets in core; they should use ::appendExtensionData()
* to define their own string sets.
*
* @param string $name A string set name
* @return string[] The string set value
* @since 1.41
*/
public function getOutputStrings( string $name ): array {
switch ( $name ) {
case ParserOutputStringSets::MODULE:
return $this->getModules();
case ParserOutputStringSets::MODULE_STYLE:
return $this->getModuleStyles();
case ParserOutputStringSets::EXTRA_CSP_DEFAULT_SRC:
return $this->getExtraCSPDefaultSrcs();
case ParserOutputStringSets::EXTRA_CSP_SCRIPT_SRC:
return $this->getExtraCSPScriptSrcs();
case ParserOutputStringSets::EXTRA_CSP_STYLE_SRC:
return $this->getExtraCSPStyleSrcs();
default:
throw new UnexpectedValueException( "Unknown output string set name $name" );
}
}
/**
* Attaches arbitrary data to this ParserObject. This can be used to store some information in
* the ParserOutput object for later use during page output. The data will be cached along with
* the ParserOutput object, but unlike data set using setPageProperty(), it is not recorded in the
* database.
*
* This method is provided to overcome the unsafe practice of attaching extra information to a
* ParserObject by directly assigning member variables.
*
* To use setExtensionData() to pass extension information from a hook inside the parser to a
* hook in the page output, use this in the parser hook:
*
* @par Example:
* @code
* $parser->getOutput()->setExtensionData( 'my_ext_foo', '...' );
* @endcode
*
* And then later, in OutputPageParserOutput or similar:
*
* @par Example:
* @code
* $output->getExtensionData( 'my_ext_foo' );
* @endcode
*
* In MediaWiki 1.20 and older, you have to use a custom member variable
* within the ParserOutput object:
*
* @par Example:
* @code
* $parser->getOutput()->my_ext_foo = '...';
* @endcode
*
* @note Only scalar values, e.g. numbers, strings, arrays or MediaWiki\Json\JsonDeserializable
* instances are supported as a value. Attempt to set other class instance as extension data
* will break ParserCache for the page.
*
* @note Since MW 1.38 the practice of setting conflicting values for
* the same key has been deprecated. As with ::setJsConfigVar(), if
* you set the same key multiple times on a ParserOutput, it is expected
* that the value will be identical each time. If you want to collect
* multiple pieces of data under a single key, use ::appendExtensionData().
*
* @param string $key The key for accessing the data. Extensions should take care to avoid
* conflicts in naming keys. It is suggested to use the extension's name as a prefix.
*
* @param mixed|JsonDeserializable $value The value to set.
* Setting a value to null is equivalent to removing the value.
* @since 1.21
*/
public function setExtensionData( $key, $value ): void {
if (
array_key_exists( $key, $this->mExtensionData ) &&
$this->mExtensionData[$key] !== $value
) {
// This behavior was deprecated in 1.38. We will eventually
// emit a warning here, then throw an exception.
}
if ( $value === null ) {
unset( $this->mExtensionData[$key] );
} else {
$this->mExtensionData[$key] = $value;
}
}
/**
* Appends arbitrary data to this ParserObject. This can be used
* to store some information in the ParserOutput object for later
* use during page output. The data will be cached along with the
* ParserOutput object, but unlike data set using
* setPageProperty(), it is not recorded in the database.
*
* See ::setExtensionData() for more details on rationale and use.
*
* In order to provide for out-of-order/asynchronous/incremental
* parsing, this method appends values to a set. See
* ::setExtensionData() for the flag-like version of this method.
*
* @note Only values which can be array keys are currently supported
* as values.
*
* @param string $key The key for accessing the data. Extensions should take care to avoid
* conflicts in naming keys. It is suggested to use the extension's name as a prefix.
*
* @param int|string $value The value to append to the list.
* @param string $strategy Merge strategy:
* only MW_MERGE_STRATEGY_UNION is currently supported and external callers
* should treat this parameter as @internal at this time and omit it.
* @since 1.38
*/
public function appendExtensionData(
string $key,
$value,
string $strategy = self::MW_MERGE_STRATEGY_UNION
): void {
if ( $strategy !== self::MW_MERGE_STRATEGY_UNION ) {
throw new InvalidArgumentException( "Unknown merge strategy $strategy." );
}
if ( !array_key_exists( $key, $this->mExtensionData ) ) {
$this->mExtensionData[$key] = [
// Indicate how these values are to be merged.
self::MW_MERGE_STRATEGY_KEY => $strategy,
];
} elseif ( !is_array( $this->mExtensionData[$key] ) ) {
throw new InvalidArgumentException( "Mixing set and append for $key" );
} elseif ( ( $this->mExtensionData[$key][self::MW_MERGE_STRATEGY_KEY] ?? null ) !== $strategy ) {
throw new InvalidArgumentException( "Conflicting merge strategies for $key" );
}
$this->mExtensionData[$key][$value] = true;
}
/**
* Gets extensions data previously attached to this ParserOutput using setExtensionData().
* Typically, such data would be set while parsing the page, e.g. by a parser function.
*
* @since 1.21
*
* @param string $key The key to look up.
*
* @return mixed|null The value previously set for the given key using setExtensionData()
* or null if no value was set for this key.
*/
public function getExtensionData( $key ) {
$value = $this->mExtensionData[$key] ?? null;
if ( is_array( $value ) ) {
// Don't expose our internal merge strategy key.
unset( $value[self::MW_MERGE_STRATEGY_KEY] );
}
return $value;
}
private static function getTimes( $clock = null ): array {
$ret = [];
if ( !$clock || $clock === 'wall' ) {
$ret['wall'] = microtime( true );
}
if ( !$clock || $clock === 'cpu' ) {
$ru = getrusage( 0 /* RUSAGE_SELF */ );
$ret['cpu'] = $ru['ru_utime.tv_sec'] + $ru['ru_utime.tv_usec'] / 1e6;
$ret['cpu'] += $ru['ru_stime.tv_sec'] + $ru['ru_stime.tv_usec'] / 1e6;
}
return $ret;
}
/**
* Resets the parse start timestamps for future calls to getTimeSinceStart()
* and recordTimeProfile().
*
* @since 1.22
*/
public function resetParseStartTime(): void {
$this->mParseStartTime = self::getTimes();
$this->mTimeProfile = [];
}
/**
* Unset the parse start time.
*
* This is intended for testing purposes only, in order to avoid
* spurious differences between testing outputs created at different
* times.
*
* @since 1.43
*/
public function clearParseStartTime(): void {
$this->mParseStartTime = [];
}
/**
* Record the time since resetParseStartTime() was last called.
* The recorded time can be accessed using getTimeProfile().
*
* After resetParseStartTime() was called, the first call to recordTimeProfile()
* will record the time profile. Subsequent calls to recordTimeProfile() will have
* no effect until resetParseStartTime() is called again.
*
* @since 1.42
*/
public function recordTimeProfile() {
if ( !$this->mParseStartTime ) {
// If resetParseStartTime was never called, there is nothing to record
return;
}
if ( $this->mTimeProfile !== [] ) {
// Don't override the times recorded by the previous call to recordTimeProfile().
return;
}
$now = self::getTimes();
$this->mTimeProfile = [
'wall' => $now['wall'] - $this->mParseStartTime['wall'],
'cpu' => $now['cpu'] - $this->mParseStartTime['cpu'],
];
}
/**
* Returns the time that elapsed between the most recent call to resetParseStartTime()
* and the first call to recordTimeProfile() after that.
*
* Clocks available are:
* - wall: Wall clock time
* - cpu: CPU time (requires getrusage)
*
* If recordTimeProfile() has noit been called since the most recent call to
* resetParseStartTime(), or if resetParseStartTime() was never called, then
* this method will return null.
*
* @param string $clock
*
* @since 1.42
* @return float|null
*/
public function getTimeProfile( string $clock ) {
return $this->mTimeProfile[ $clock ] ?? null;
}
/**
* Returns the time since resetParseStartTime() was last called
*
* Clocks available are:
* - wall: Wall clock time
* - cpu: CPU time (requires getrusage)
*
* @since 1.22
* @deprecated since 1.42, use getTimeProfile() instead.
* @param string $clock
* @return float|null
*/
public function getTimeSinceStart( $clock ) {
wfDeprecated( __METHOD__, '1.42' );
if ( !isset( $this->mParseStartTime[$clock] ) ) {
return null;
}
$end = self::getTimes( $clock );
return $end[$clock] - $this->mParseStartTime[$clock];
}
/**
* Sets parser limit report data for a key
*
* The key is used as the prefix for various messages used for formatting:
* - $key: The label for the field in the limit report
* - $key-value-text: Message used to format the value in the "NewPP limit
* report" HTML comment. If missing, uses $key-format.
* - $key-value-html: Message used to format the value in the preview
* limit report table. If missing, uses $key-format.
* - $key-value: Message used to format the value. If missing, uses "$1".
*
* Note that all values are interpreted as wikitext, and so should be
* encoded with htmlspecialchars() as necessary, but should avoid complex
* HTML for display in the "NewPP limit report" comment.
*
* @since 1.22
* @param string $key Message key
* @param mixed $value Appropriate for Message::params()
*/
public function setLimitReportData( $key, $value ): void {
$this->mLimitReportData[$key] = $value;
if ( is_array( $value ) ) {
if ( array_keys( $value ) === [ 0, 1 ]
&& is_numeric( $value[0] )
&& is_numeric( $value[1] )
) {
$data = [ 'value' => $value[0], 'limit' => $value[1] ];
} else {
$data = $value;
}
} else {
$data = $value;
}
if ( strpos( $key, '-' ) ) {
[ $ns, $name ] = explode( '-', $key, 2 );
$this->mLimitReportJSData[$ns][$name] = $data;
} else {
$this->mLimitReportJSData[$key] = $data;
}
}
/**
* Check whether the cache TTL was lowered from the site default.
*
* When content is determined by more than hard state (e.g. page edits),
* such as template/file transclusions based on the current timestamp or
* extension tags that generate lists based on queries, this return true.
*
* This method mainly exists to facilitate the logic in
* WikiPage::triggerOpportunisticLinksUpdate. As such, beware that reducing the TTL for
* reasons that do not relate to "dynamic content", may have the side-effect of incurring
* more RefreshLinksJob executions.
*
* @internal For use by Parser and WikiPage
* @since 1.37
* @return bool
*/
public function hasReducedExpiry(): bool {
$parserCacheExpireTime = MediaWikiServices::getInstance()->getMainConfig()->get(
MainConfigNames::ParserCacheExpireTime );
return $this->getCacheExpiry() < $parserCacheExpireTime;
}
/**
* Set the prevent-clickjacking flag. If set this will cause an
* `X-Frame-Options` header appropriate for edit pages to be sent.
* The header value is controlled by `$wgEditPageFrameOptions`.
*
* This is the default for special pages. If you display a CSRF-protected
* form on an ordinary view page, then you need to call this function
* with `$flag = true`.
*
* @param bool $flag New flag value
* @since 1.38
*/
public function setPreventClickjacking( bool $flag ): void {
$this->mPreventClickjacking = $flag;
}
/**
* Get the prevent-clickjacking flag.
*
* @return bool Flag value
* @since 1.38
* @see ::setPreventClickjacking
*/
public function getPreventClickjacking(): bool {
return $this->mPreventClickjacking;
}
/**
* Lower the runtime adaptive TTL to at most this value
*
* @param int $ttl
* @since 1.28
*/
public function updateRuntimeAdaptiveExpiry( $ttl ): void {
$this->mMaxAdaptiveExpiry = min( $ttl, $this->mMaxAdaptiveExpiry );
$this->updateCacheExpiry( $ttl );
}
/**
* Add an extra value to Content-Security-Policy default-src directive
*
* Call this if you are including a resource (e.g. image) from a third party domain.
* This is used for all source types except style and script.
*
* @since 1.35
* @param string $src CSP source e.g. example.com
*/
public function addExtraCSPDefaultSrc( $src ): void {
$this->mExtraDefaultSrcs[] = $src;
}
/**
* Add an extra value to Content-Security-Policy style-src directive
*
* @since 1.35
* @param string $src CSP source e.g. example.com
*/
public function addExtraCSPStyleSrc( $src ): void {
$this->mExtraStyleSrcs[] = $src;
}
/**
* Add an extra value to Content-Security-Policy script-src directive
*
* Call this if you are loading third-party Javascript
*
* @since 1.35
* @param string $src CSP source e.g. example.com
*/
public function addExtraCSPScriptSrc( $src ): void {
$this->mExtraScriptSrcs[] = $src;
}
/**
* Call this when parsing is done to lower the TTL based on low parse times
*
* @since 1.28
*/
public function finalizeAdaptiveCacheExpiry(): void {
if ( is_infinite( $this->mMaxAdaptiveExpiry ) ) {
return; // not set
}
$runtime = $this->getTimeProfile( 'wall' );
if ( is_float( $runtime ) ) {
$slope = ( self::SLOW_AR_TTL - self::FAST_AR_TTL )
/ ( self::PARSE_SLOW_SEC - self::PARSE_FAST_SEC );
// SLOW_AR_TTL = PARSE_SLOW_SEC * $slope + $point
$point = self::SLOW_AR_TTL - self::PARSE_SLOW_SEC * $slope;
$adaptiveTTL = min(
max( $slope * $runtime + $point, self::MIN_AR_TTL ),
$this->mMaxAdaptiveExpiry
);
$this->updateCacheExpiry( $adaptiveTTL );
}
}
/**
* Transfer parser options which affect post-processing from ParserOptions
* to this ParserOutput.
* @param ParserOptions $parserOptions
*/
public function setFromParserOptions( ParserOptions $parserOptions ) {
// Copied from Parser.php::parse and should probably be abstracted
// into the parent base class (probably as part of T236809)
// Wrap non-interface parser output in a <div> so it can be targeted
// with CSS (T37247)
$class = $parserOptions->getWrapOutputClass();
if ( $class !== false && !$parserOptions->getInterfaceMessage() ) {
$this->addWrapperDivClass( $class );
}
// Record whether we should suppress section edit links
if ( $parserOptions->getSuppressSectionEditLinks() ) {
$this->setOutputFlag( ParserOutputFlags::NO_SECTION_EDIT_LINKS );
}
// Record whether we should wrap sections for collapsing them
if ( $parserOptions->getCollapsibleSections() ) {
$this->setOutputFlag( ParserOutputFlags::COLLAPSIBLE_SECTIONS );
}
// Record whether this is a preview parse in the output (T341010)
if ( $parserOptions->getIsPreview() ) {
$this->setOutputFlag( ParserOutputFlags::IS_PREVIEW, true );
// Ensure that previews aren't cacheable, just to be safe.
$this->updateCacheExpiry( 0 );
}
}
public function __sleep() {
return array_filter( array_keys( get_object_vars( $this ) ),
static function ( $field ) {
if ( $field === 'mParseStartTime' || $field === 'mWarningMsgs' ) {
return false;
}
// Unserializing unknown private fields in HHVM causes
// member variables with nulls in their names (T229366)
return strpos( $field, "\0" ) === false;
}
);
}
/**
* Merges internal metadata such as flags, accessed options, and profiling info
* from $source into this ParserOutput. This should be used whenever the state of $source
* has any impact on the state of this ParserOutput.
*
* @param ParserOutput $source
*/
public function mergeInternalMetaDataFrom( ParserOutput $source ): void {
$this->mWarnings = self::mergeMap( $this->mWarnings, $source->mWarnings ); // don't use getter
$this->mTimestamp = $this->useMaxValue( $this->mTimestamp, $source->getRevisionTimestamp() );
if ( $source->hasCacheTime() ) {
$sourceCacheTime = $source->getCacheTime();
if (
!$this->hasCacheTime() ||
// "undocumented use of -1 to mean not cacheable"
// deprecated, but still supported by ::setCacheTime()
strval( $sourceCacheTime ) === '-1' ||
(
strval( $this->getCacheTime() ) !== '-1' &&
// use newer of the two times
$this->getCacheTime() < $sourceCacheTime
)
) {
$this->setCacheTime( $sourceCacheTime );
}
}
if ( $source->getRenderId() !== null ) {
// Final render ID should be a function of all component POs
$rid = ( $this->getRenderId() ?? '' ) . $source->getRenderId();
$this->setRenderId( $rid );
}
if ( $source->getCacheRevisionId() !== null ) {
$sourceCacheRevisionId = $source->getCacheRevisionId();
$thisCacheRevisionId = $this->getCacheRevisionId();
if ( $thisCacheRevisionId === null ) {
$this->setCacheRevisionId( $sourceCacheRevisionId );
} elseif ( $sourceCacheRevisionId !== $thisCacheRevisionId ) {
// May throw an exception here in the future
wfDeprecated(
__METHOD__ . ": conflicting revision IDs " .
"$thisCacheRevisionId and $sourceCacheRevisionId"
);
}
}
foreach ( self::SPECULATIVE_FIELDS as $field ) {
if ( $this->$field && $source->$field && $this->$field !== $source->$field ) {
wfLogWarning( __METHOD__ . ": inconsistent '$field' properties!" );
}
$this->$field = $this->useMaxValue( $this->$field, $source->$field );
}
$this->mParseStartTime = $this->useEachMinValue(
$this->mParseStartTime,
$source->mParseStartTime
);
$this->mTimeProfile = $this->useEachTotalValue(
$this->mTimeProfile,
$source->mTimeProfile
);
$this->mFlags = self::mergeMap( $this->mFlags, $source->mFlags );
$this->mParseUsedOptions = self::mergeMap( $this->mParseUsedOptions, $source->mParseUsedOptions );
// TODO: maintain per-slot limit reports!
if ( !$this->mLimitReportData ) {
$this->mLimitReportData = $source->mLimitReportData;
}
if ( !$this->mLimitReportJSData ) {
$this->mLimitReportJSData = $source->mLimitReportJSData;
}
}
/**
* Merges HTML metadata such as head items, JS config vars, and HTTP cache control info
* from $source into this ParserOutput. This should be used whenever the HTML in $source
* has been somehow merged into the HTML of this ParserOutput.
*
* @param ParserOutput $source
*/
public function mergeHtmlMetaDataFrom( ParserOutput $source ): void {
// HTML and HTTP
$this->mHeadItems = self::mergeMixedList( $this->mHeadItems, $source->getHeadItems() );
$this->addModules( $source->getModules() );
$this->addModuleStyles( $source->getModuleStyles() );
$this->mJsConfigVars = self::mergeMapStrategy( $this->mJsConfigVars, $source->mJsConfigVars );
$this->mMaxAdaptiveExpiry = min( $this->mMaxAdaptiveExpiry, $source->mMaxAdaptiveExpiry );
$this->mExtraStyleSrcs = self::mergeList(
$this->mExtraStyleSrcs,
$source->getExtraCSPStyleSrcs()
);
$this->mExtraScriptSrcs = self::mergeList(
$this->mExtraScriptSrcs,
$source->getExtraCSPScriptSrcs()
);
$this->mExtraDefaultSrcs = self::mergeList(
$this->mExtraDefaultSrcs,
$source->getExtraCSPDefaultSrcs()
);
// "noindex" always wins!
$this->mIndexSet = $this->mIndexSet || $source->mIndexSet;
$this->mNoIndexSet = $this->mNoIndexSet || $source->mNoIndexSet;
// Skin control
$this->mNewSection = $this->mNewSection || $source->getNewSection();
$this->mHideNewSection = $this->mHideNewSection || $source->getHideNewSection();
$this->mNoGallery = $this->mNoGallery || $source->getNoGallery();
$this->mEnableOOUI = $this->mEnableOOUI || $source->getEnableOOUI();
$this->mPreventClickjacking = $this->mPreventClickjacking || $source->getPreventClickjacking();
$tocData = $this->getTOCData();
$sourceTocData = $source->getTOCData();
if ( $tocData !== null ) {
if ( $sourceTocData !== null ) {
// T327429: Section merging is broken, since it doesn't respect
// global numbering, but there are tests which expect section
// metadata to be concatenated.
// There should eventually be a deprecation warning here.
foreach ( $sourceTocData->getSections() as $s ) {
$tocData->addSection( $s );
}
}
} elseif ( $sourceTocData !== null ) {
$this->setTOCData( $sourceTocData );
}
// XXX: we don't want to concatenate title text, so first write wins.
// We should use the first *modified* title text, but we don't have the original to check.
if ( $this->mTitleText === null || $this->mTitleText === '' ) {
$this->mTitleText = $source->mTitleText;
}
// class names are stored in array keys
$this->mWrapperDivClasses = self::mergeMap(
$this->mWrapperDivClasses,
$source->mWrapperDivClasses
);
// NOTE: last write wins, same as within one ParserOutput
$this->mIndicators = self::mergeMap( $this->mIndicators, $source->getIndicators() );
// NOTE: include extension data in "tracking meta data" as well as "html meta data"!
// TODO: add a $mergeStrategy parameter to setExtensionData to allow different
// kinds of extension data to be merged in different ways.
$this->mExtensionData = self::mergeMapStrategy(
$this->mExtensionData,
$source->mExtensionData
);
}
/**
* Merges dependency tracking metadata such as backlinks, images used, and extension data
* from $source into this ParserOutput. This allows dependency tracking to be done for the
* combined output of multiple content slots.
*
* @param ParserOutput $source
*/
public function mergeTrackingMetaDataFrom( ParserOutput $source ): void {
foreach ( $source->getLanguageLinks() as $ll ) {
$this->addLanguageLink( $ll );
}
$this->mCategories = self::mergeMap( $this->mCategories, $source->getCategoryMap() );
$this->mLinks = self::merge2D( $this->mLinks, $source->getLinks() );
$this->mTemplates = self::merge2D( $this->mTemplates, $source->getTemplates() );
$this->mTemplateIds = self::merge2D( $this->mTemplateIds, $source->getTemplateIds() );
$this->mImages = self::mergeMap( $this->mImages, $source->getImages() );
$this->mFileSearchOptions = self::mergeMap(
$this->mFileSearchOptions,
$source->getFileSearchOptions()
);
$this->mExternalLinks = self::mergeMap( $this->mExternalLinks, $source->getExternalLinks() );
$this->mInterwikiLinks = self::merge2D(
$this->mInterwikiLinks,
$source->getInterwikiLinks()
);
// TODO: add a $mergeStrategy parameter to setPageProperty to allow different
// kinds of properties to be merged in different ways.
// (Model this after ::appendJsConfigVar(); use ::mergeMapStrategy here)
$this->mProperties = self::mergeMap( $this->mProperties, $source->getPageProperties() );
// NOTE: include extension data in "tracking meta data" as well as "html meta data"!
$this->mExtensionData = self::mergeMapStrategy(
$this->mExtensionData,
$source->mExtensionData
);
}
/**
* Adds the metadata collected in this ParserOutput to the supplied
* ContentMetadataCollector. This is similar to ::mergeHtmlMetaDataFrom()
* but in the opposite direction, since ParserOutput is read/write while
* ContentMetadataCollector is write-only.
*
* @param ContentMetadataCollector $metadata
* @since 1.38
*/
public function collectMetadata( ContentMetadataCollector $metadata ): void {
// Uniform handling of all boolean flags: they are OR'ed together.
$flags = array_keys(
$this->mFlags + array_flip( ParserOutputFlags::cases() )
);
foreach ( $flags as $name ) {
if ( $this->getOutputFlag( $name ) ) {
$metadata->setOutputFlag( $name );
}
}
// Uniform handling of string sets: they are unioned.
// (This includes modules, style modes, and CSP src.)
foreach ( ParserOutputStringSets::cases() as $name ) {
$metadata->appendOutputStrings(
$name, $this->getOutputStrings( $name )
);
}
foreach ( $this->mCategories as $cat => $key ) {
// Numeric category strings are going to come out of the
// `mCategories` array as ints; cast back to string.
// Also convert back to a LinkTarget!
$lt = TitleValue::tryNew( NS_CATEGORY, (string)$cat );
$metadata->addCategory( $lt, $key );
}
foreach ( $this->mLinks as $ns => $arr ) {
foreach ( $arr as $dbk => $id ) {
// Numeric titles are going to come out of the
// `mLinks` array as ints; cast back to string.
$lt = TitleValue::tryNew( $ns, (string)$dbk );
$metadata->addLink( $lt, $id );
}
}
foreach ( $this->mInterwikiLinks as $prefix => $arr ) {
foreach ( $arr as $dbk => $ignore ) {
$lt = TitleValue::tryNew( NS_MAIN, (string)$dbk, '', $prefix );
$metadata->addLink( $lt );
}
}
foreach ( $this->mLinksSpecial as $dbk => $ignore ) {
// Numeric titles are going to come out of the
// `mLinks` array as ints; cast back to string.
$lt = TitleValue::tryNew( NS_SPECIAL, (string)$dbk );
$metadata->addLink( $lt );
}
foreach ( $this->mImages as $name => $ignore ) {
// Numeric titles come out of mImages as ints.
$lt = TitleValue::tryNew( NS_FILE, (string)$name );
$props = $this->mFileSearchOptions[$name] ?? [];
$metadata->addImage( $lt, $props['time'] ?? null, $props['sha1'] ?? null );
}
foreach ( $this->mLanguageLinkMap as $lang => $title ) {
if ( $title === '|' ) {
continue; // T374736: not a valid language link
}
# language links can have fragments!
[ $title, $frag ] = array_pad( explode( '#', $title, 2 ), 2, '' );
$lt = TitleValue::tryNew( NS_MAIN, $title, $frag, (string)$lang );
$metadata->addLanguageLink( $lt );
}
foreach ( $this->mJsConfigVars as $key => $value ) {
if ( is_array( $value ) && isset( $value[self::MW_MERGE_STRATEGY_KEY] ) ) {
$strategy = $value[self::MW_MERGE_STRATEGY_KEY];
foreach ( $value as $item => $ignore ) {
if ( $item !== self::MW_MERGE_STRATEGY_KEY ) {
$metadata->appendJsConfigVar( $key, $item, $strategy );
}
}
} elseif ( $metadata instanceof ParserOutput &&
array_key_exists( $key, $metadata->mJsConfigVars )
) {
// This behavior is deprecated, will likely result in
// incorrect output, and we'll eventually emit a
// warning here---but at the moment this is usually
// caused by limitations in Parsoid and/or use of
// the ParserAfterParse hook: T303015#7770480
$metadata->mJsConfigVars[$key] = $value;
} else {
$metadata->setJsConfigVar( $key, $value );
}
}
foreach ( $this->mExtensionData as $key => $value ) {
if ( is_array( $value ) && isset( $value[self::MW_MERGE_STRATEGY_KEY] ) ) {
$strategy = $value[self::MW_MERGE_STRATEGY_KEY];
foreach ( $value as $item => $ignore ) {
if ( $item !== self::MW_MERGE_STRATEGY_KEY ) {
$metadata->appendExtensionData( $key, $item, $strategy );
}
}
} elseif ( $metadata instanceof ParserOutput &&
array_key_exists( $key, $metadata->mExtensionData )
) {
// This behavior is deprecated, will likely result in
// incorrect output, and we'll eventually emit a
// warning here---but at the moment this is usually
// caused by limitations in Parsoid and/or use of
// the ParserAfterParse hook: T303015#7770480
$metadata->mExtensionData[$key] = $value;
} else {
$metadata->setExtensionData( $key, $value );
}
}
foreach ( $this->mExternalLinks as $url => $ignore ) {
$metadata->addExternalLink( $url );
}
foreach ( $this->mProperties as $prop => $value ) {
if ( is_numeric( $value ) ) {
$metadata->setNumericPageProperty( $prop, $value );
} elseif ( is_string( $value ) ) {
$metadata->setUnsortedPageProperty( $prop, $value );
} else {
// Deprecated, but there are still sites which call
// ::setPageProperty() with "unusual" values (T374046)
$metadata->setPageProperty( $prop, $value );
}
}
foreach ( $this->mWarningMsgs as $msg => $args ) {
$metadata->addWarningMsg( $msg, ...$args );
}
foreach ( $this->mLimitReportData as $key => $value ) {
$metadata->setLimitReportData( $key, $value );
}
foreach ( $this->mIndicators as $id => $content ) {
$metadata->setIndicator( $id, $content );
}
// ParserOutput-only fields; maintained "behind the curtain"
// since Parsoid doesn't have to know about them.
//
// In production use, the $metadata supplied to this method
// will almost always be an instance of ParserOutput, passed to
// Parsoid by core when parsing begins and returned to core by
// Parsoid as a ContentMetadataCollector (Parsoid's name for
// ParserOutput) when DataAccess::parseWikitext() is called.
//
// We may use still Parsoid's StubMetadataCollector for testing or
// when running Parsoid in standalone mode, so forcing a downcast
// here would lose some flexibility.
if ( $metadata instanceof ParserOutput ) {
foreach ( $this->getUsedOptions() as $opt ) {
$metadata->recordOption( $opt );
}
if ( $this->mCacheExpiry !== null ) {
$metadata->updateCacheExpiry( $this->mCacheExpiry );
}
if ( $this->mCacheTime !== '' ) {
$metadata->setCacheTime( $this->mCacheTime );
}
if ( $this->mCacheRevisionId !== null ) {
$metadata->setCacheRevisionId( $this->mCacheRevisionId );
}
// T293514: We should use the first *modified* title text, but
// we don't have the original to check.
$otherTitle = $metadata->getTitleText();
if ( $otherTitle === null || $otherTitle === '' ) {
$metadata->setTitleText( $this->getTitleText() );
}
foreach ( $this->mTemplates as $ns => $arr ) {
foreach ( $arr as $dbk => $page_id ) {
$rev_id = $this->mTemplateIds[$ns][$dbk];
$metadata->addTemplate( TitleValue::tryNew( $ns, (string)$dbk ), $page_id, $rev_id );
}
}
}
}
private static function mergeMixedList( array $a, array $b ): array {
return array_unique( array_merge( $a, $b ), SORT_REGULAR );
}
private static function mergeList( array $a, array $b ): array {
return array_values( array_unique( array_merge( $a, $b ), SORT_REGULAR ) );
}
private static function mergeMap( array $a, array $b ): array {
return array_replace( $a, $b );
}
private static function mergeMapStrategy( array $a, array $b ): array {
foreach ( $b as $key => $bValue ) {
if ( !array_key_exists( $key, $a ) ) {
$a[$key] = $bValue;
} elseif (
is_array( $a[$key] ) &&
isset( $a[$key][self::MW_MERGE_STRATEGY_KEY] ) &&
isset( $bValue[self::MW_MERGE_STRATEGY_KEY] )
) {
$strategy = $bValue[self::MW_MERGE_STRATEGY_KEY];
if ( $strategy !== $a[$key][self::MW_MERGE_STRATEGY_KEY] ) {
throw new InvalidArgumentException( "Conflicting merge strategy for $key" );
}
if ( $strategy === self::MW_MERGE_STRATEGY_UNION ) {
// Note the array_merge is *not* safe to use here, because
// the $bValue is expected to be a map from items to `true`.
// If the item is a numeric string like '1' then array_merge
// will convert it to an integer and renumber the array!
$a[$key] = array_replace( $a[$key], $bValue );
} else {
throw new InvalidArgumentException( "Unknown merge strategy $strategy" );
}
} else {
$valuesSame = ( $a[$key] === $bValue );
if ( ( !$valuesSame ) &&
is_object( $a[$key] ) &&
is_object( $bValue )
) {
$jsonCodec = MediaWikiServices::getInstance()->getJsonCodec();
$valuesSame = ( $jsonCodec->serialize( $a[$key] ) === $jsonCodec->serialize( $bValue ) );
}
if ( !$valuesSame ) {
// Silently replace for now; in the future will first emit
// a deprecation warning, and then (later) throw.
$a[$key] = $bValue;
}
}
}
return $a;
}
private static function merge2D( array $a, array $b ): array {
$values = [];
$keys = array_merge( array_keys( $a ), array_keys( $b ) );
foreach ( $keys as $k ) {
if ( empty( $a[$k] ) ) {
$values[$k] = $b[$k];
} elseif ( empty( $b[$k] ) ) {
$values[$k] = $a[$k];
} elseif ( is_array( $a[$k] ) && is_array( $b[$k] ) ) {
$values[$k] = array_replace( $a[$k], $b[$k] );
} else {
$values[$k] = $b[$k];
}
}
return $values;
}
private static function useEachMinValue( array $a, array $b ): array {
$values = [];
$keys = array_merge( array_keys( $a ), array_keys( $b ) );
foreach ( $keys as $k ) {
$values[$k] = min( $a[$k] ?? INF, $b[$k] ?? INF );
}
return $values;
}
private static function useEachTotalValue( array $a, array $b ): array {
$values = [];
$keys = array_merge( array_keys( $a ), array_keys( $b ) );
foreach ( $keys as $k ) {
$values[$k] = ( $a[$k] ?? 0 ) + ( $b[$k] ?? 0 );
}
return $values;
}
private static function useMaxValue( $a, $b ) {
if ( $a === null ) {
return $b;
}
if ( $b === null ) {
return $a;
}
return max( $a, $b );
}
/**
* Returns a JSON serializable structure representing this ParserOutput instance.
* @see newFromJson()
*
* @return array
*/
protected function toJsonArray(): array {
// WARNING: When changing how this class is serialized, follow the instructions
// at <https://www.mediawiki.org/wiki/Manual:Parser_cache/Serialization_compatibility>!
$data = [
'Text' => $this->mRawText,
'LanguageLinks' => $this->getLanguageLinks(),
'Categories' => $this->mCategories,
'Indicators' => $this->mIndicators,
'TitleText' => $this->mTitleText,
'Links' => $this->mLinks,
'LinksSpecial' => $this->mLinksSpecial,
'Templates' => $this->mTemplates,
'TemplateIds' => $this->mTemplateIds,
'Images' => $this->mImages,
'FileSearchOptions' => $this->mFileSearchOptions,
'ExternalLinks' => $this->mExternalLinks,
'InterwikiLinks' => $this->mInterwikiLinks,
'NewSection' => $this->mNewSection,
'HideNewSection' => $this->mHideNewSection,
'NoGallery' => $this->mNoGallery,
'HeadItems' => $this->mHeadItems,
'Modules' => array_keys( $this->mModuleSet ),
'ModuleStyles' => array_keys( $this->mModuleStyleSet ),
'JsConfigVars' => $this->mJsConfigVars,
'Warnings' => $this->mWarnings,
'Sections' => $this->getSections(),
'Properties' => self::detectAndEncodeBinary( $this->mProperties ),
'Timestamp' => $this->mTimestamp,
'EnableOOUI' => $this->mEnableOOUI,
'IndexPolicy' => $this->getIndexPolicy(),
// may contain arbitrary structures!
'ExtensionData' => $this->mExtensionData,
'LimitReportData' => $this->mLimitReportData,
'LimitReportJSData' => $this->mLimitReportJSData,
'CacheMessage' => $this->mCacheMessage,
'TimeProfile' => $this->mTimeProfile,
'ParseStartTime' => [], // don't serialize this
'PreventClickjacking' => $this->mPreventClickjacking,
'ExtraScriptSrcs' => $this->mExtraScriptSrcs,
'ExtraDefaultSrcs' => $this->mExtraDefaultSrcs,
'ExtraStyleSrcs' => $this->mExtraStyleSrcs,
'Flags' => $this->mFlags + (
// backward-compatibility: distinguish "no sections" from
// "sections not set" (Will be unnecessary after T327439.)
$this->mTOCData === null ? [] : [ 'mw:toc-set' => true ]
),
'SpeculativeRevId' => $this->mSpeculativeRevId,
'SpeculativePageIdUsed' => $this->speculativePageIdUsed,
'RevisionTimestampUsed' => $this->revisionTimestampUsed,
'RevisionUsedSha1Base36' => $this->revisionUsedSha1Base36,
'WrapperDivClasses' => $this->mWrapperDivClasses,
];
// Fill in missing fields from parents. Array addition does not override existing fields.
$data += parent::toJsonArray();
// TODO: make more fields optional!
if ( $this->mMaxAdaptiveExpiry !== INF ) {
// NOTE: JSON can't encode infinity!
$data['MaxAdaptiveExpiry'] = $this->mMaxAdaptiveExpiry;
}
if ( $this->mTOCData ) {
// Temporarily add information from TOCData extension data
// T327439: We should eventually make the entire mTOCData
// serializable
$toc = $this->mTOCData->jsonSerialize();
if ( isset( $toc['extensionData'] ) ) {
$data['TOCExtensionData'] = $toc['extensionData'];
}
}
return $data;
}
public static function newFromJsonArray( JsonDeserializer $deserializer, array $json ): ParserOutput {
$parserOutput = new ParserOutput();
$parserOutput->initFromJson( $deserializer, $json );
return $parserOutput;
}
/**
* Initialize member fields from an array returned by jsonSerialize().
* @param JsonDeserializer $deserializer
* @param array $jsonData
*/
protected function initFromJson( JsonDeserializer $deserializer, array $jsonData ): void {
parent::initFromJson( $deserializer, $jsonData );
// WARNING: When changing how this class is serialized, follow the instructions
// at <https://www.mediawiki.org/wiki/Manual:Parser_cache/Serialization_compatibility>!
$this->mRawText = $jsonData['Text'];
$this->mLanguageLinkMap = [];
foreach ( ( $jsonData['LanguageLinks'] ?? [] ) as $l ) {
$this->addLanguageLink( $l );
}
$this->mCategories = $jsonData['Categories'];
$this->mIndicators = $jsonData['Indicators'];
$this->mTitleText = $jsonData['TitleText'];
$this->mLinks = $jsonData['Links'];
$this->mLinksSpecial = $jsonData['LinksSpecial'];
$this->mTemplates = $jsonData['Templates'];
$this->mTemplateIds = $jsonData['TemplateIds'];
$this->mImages = $jsonData['Images'];
$this->mFileSearchOptions = $jsonData['FileSearchOptions'];
$this->mExternalLinks = $jsonData['ExternalLinks'];
$this->mInterwikiLinks = $jsonData['InterwikiLinks'];
$this->mNewSection = $jsonData['NewSection'];
$this->mHideNewSection = $jsonData['HideNewSection'];
$this->mNoGallery = $jsonData['NoGallery'];
$this->mHeadItems = $jsonData['HeadItems'];
$this->mModuleSet = array_fill_keys( $jsonData['Modules'], true );
$this->mModuleStyleSet = array_fill_keys( $jsonData['ModuleStyles'], true );
$this->mJsConfigVars = $jsonData['JsConfigVars'];
$this->mWarnings = $jsonData['Warnings'];
$this->mFlags = $jsonData['Flags'];
if (
$jsonData['Sections'] !== [] ||
// backward-compatibility: distinguish "no sections" from
// "sections not set" (Will be unnecessary after T327439.)
$this->getOutputFlag( 'mw:toc-set' )
) {
$this->setSections( $jsonData['Sections'] );
unset( $this->mFlags['mw:toc-set'] );
if ( isset( $jsonData['TOCExtensionData'] ) ) {
$tocData = $this->getTOCData(); // created by setSections() above
foreach ( $jsonData['TOCExtensionData'] as $key => $value ) {
$tocData->setExtensionData( $key, $value );
}
}
}
$this->mProperties = self::detectAndDecodeBinary( $jsonData['Properties'] );
$this->mTimestamp = $jsonData['Timestamp'];
$this->mEnableOOUI = $jsonData['EnableOOUI'];
$this->setIndexPolicy( $jsonData['IndexPolicy'] );
$this->mExtensionData = $jsonData['ExtensionData'] ?? [];
$this->mLimitReportData = $jsonData['LimitReportData'];
$this->mLimitReportJSData = $jsonData['LimitReportJSData'];
$this->mCacheMessage = $jsonData['CacheMessage'] ?? '';
$this->mParseStartTime = []; // invalid after reloading
$this->mTimeProfile = $jsonData['TimeProfile'] ?? [];
$this->mPreventClickjacking = $jsonData['PreventClickjacking'];
$this->mExtraScriptSrcs = $jsonData['ExtraScriptSrcs'];
$this->mExtraDefaultSrcs = $jsonData['ExtraDefaultSrcs'];
$this->mExtraStyleSrcs = $jsonData['ExtraStyleSrcs'];
$this->mSpeculativeRevId = $jsonData['SpeculativeRevId'];
$this->speculativePageIdUsed = $jsonData['SpeculativePageIdUsed'];
$this->revisionTimestampUsed = $jsonData['RevisionTimestampUsed'];
$this->revisionUsedSha1Base36 = $jsonData['RevisionUsedSha1Base36'];
$this->mWrapperDivClasses = $jsonData['WrapperDivClasses'];
$this->mMaxAdaptiveExpiry = $jsonData['MaxAdaptiveExpiry'] ?? INF;
}
/**
* Finds any non-utf8 strings in the given array and replaces them with
* an associative array that wraps a base64 encoded version of the data.
* Inverse of detectAndDecodeBinary().
*
* @param array $properties
*
* @return array
*/
private static function detectAndEncodeBinary( array $properties ) {
foreach ( $properties as $key => $value ) {
if ( is_string( $value ) ) {
if ( !mb_detect_encoding( $value, 'UTF-8', true ) ) {
$properties[$key] = [
// T313818: This key name conflicts with JsonCodec
'_type_' => 'string',
'_encoding_' => 'base64',
'_data_' => base64_encode( $value ),
];
}
}
}
return $properties;
}
/**
* Finds any associative arrays that represent encoded binary strings, and
* replaces them with the decoded binary data.
*
* @param array $properties
*
* @return array
*/
private static function detectAndDecodeBinary( array $properties ) {
foreach ( $properties as $key => $value ) {
if ( is_array( $value ) && isset( $value['_encoding_'] ) ) {
if ( $value['_encoding_'] === 'base64' ) {
$properties[$key] = base64_decode( $value['_data_'] );
}
}
}
return $properties;
}
public function __wakeup() {
$oldAliases = [
// This was the pre-namespace name of the class, which is still
// used in pre-1.42 serialized objects.
'ParserOutput',
];
// Backwards compatibility, pre 1.36
$priorAccessedOptions = $this->getGhostFieldValue( 'mAccessedOptions', ...$oldAliases );
if ( $priorAccessedOptions ) {
$this->mParseUsedOptions = $priorAccessedOptions;
}
// Backwards compatibility, pre 1.39
$priorIndexPolicy = $this->getGhostFieldValue( 'mIndexPolicy', ...$oldAliases );
if ( $priorIndexPolicy ) {
$this->setIndexPolicy( $priorIndexPolicy );
}
// Backwards compatibility, pre 1.40
$mSections = $this->getGhostFieldValue( 'mSections', ...$oldAliases );
if ( $mSections !== null && $mSections !== [] ) {
$this->setSections( $mSections );
}
// Backwards compatibility, pre 1.42
$mModules = $this->getGhostFieldValue( 'mModules', ...$oldAliases );
if ( $mModules !== null && $mModules !== [] ) {
$this->addModules( $mModules );
}
// Backwards compatibility, pre 1.42
$mModuleStyles = $this->getGhostFieldValue( 'mModuleStyles', ...$oldAliases );
if ( $mModuleStyles !== null && $mModuleStyles !== [] ) {
$this->addModuleStyles( $mModuleStyles );
}
// Backwards compatibility, pre 1.42
$mText = $this->getGhostFieldValue( 'mText', ...$oldAliases );
if ( $mText !== null ) {
$this->setRawText( $mText );
}
// Backwards compatibility, pre 1.42
$ll = $this->getGhostFieldValue( 'mLanguageLinks', ...$oldAliases );
if ( $ll !== null && $ll !== [] ) {
foreach ( $ll as $l ) {
$this->addLanguageLink( $l );
}
}
// Backward compatibility with private fields, pre 1.42
$oldPrivateFields = [
'mRawText',
'mCategories',
'mIndicators',
'mTitleText',
'mLinks',
'mLinksSpecial',
'mTemplates',
'mTemplateIds',
'mImages',
'mFileSearchOptions',
'mExternalLinks',
'mInterwikiLinks',
'mNewSection',
'mHideNewSection',
'mNoGallery',
'mHeadItems',
'mModuleSet',
'mModuleStyleSet',
'mJsConfigVars',
'mWarnings',
'mWarningMsgs',
'mTOCData',
'mProperties',
'mTimestamp',
'mEnableOOUI',
'mIndexSet',
'mNoIndexSet',
'mExtensionData',
'mLimitReportData',
'mLimitReportJSData',
'mCacheMessage',
'mParseStartTime',
'mTimeProfile',
'mPreventClickjacking',
'mExtraScriptSrcs',
'mExtraDefaultSrcs',
'mExtraStyleSrcs',
'mFlags',
'mSpeculativeRevId',
'speculativePageIdUsed',
'revisionTimestampUsed',
'revisionUsedSha1Base36',
'mWrapperDivClasses',
'mMaxAdaptiveExpiry',
];
foreach ( $oldPrivateFields as $f ) {
$this->restoreAliasedGhostField( $f, ...$oldAliases );
}
$this->clearParseStartTime();
}
public function __clone() {
// It seems that very little of this object needs to be explicitly deep-cloned
// while keeping copies reasonably separated.
// Most of the non-scalar properties of this object are either
// - (potentially multi-nested) arrays of scalars (which get deep-cloned), or
// - arrays that may contain arbitrary elements (which don't necessarily get
// deep-cloned), but for which no particular care elsewhere is given to
// copying their references around (e.g. mJsConfigVars).
// Hence, we are not going out of our way to ensure that the references to innermost
// objects that may appear in a ParserOutput are unique. If that becomes the
// expectation at any point, this method will require updating as well.
// The exception is TOCData (which is an object), which we clone explicitly.
if ( $this->mTOCData ) {
$this->mTOCData = clone $this->mTOCData;
}
}
/**
* Returns the content holder text of the ParserOutput.
* This will eventually be replaced by something like getContentHolder()->getText() when we have a
* ContentHolder/HtmlHolder class.
* @internal
* @unstable
* @return string
*/
public function getContentHolderText(): string {
return $this->getRawText();
}
/**
* Sets the content holder text of the ParserOutput.
* This will eventually be replaced by something like getContentHolder()->setText() when we have a
* ContentHolder/HtmlHolder class.
* @internal
* @unstable
*/
public function setContentHolderText( string $s ): void {
$this->setRawText( $s );
}
public function __get( $name ) {
if ( property_exists( get_called_class(), $name ) ) {
// Direct access to a public property, deprecated.
wfDeprecatedMsg( "ParserOutput::{$name} public read access deprecated", '1.38' );
return $this->$name;
} elseif ( property_exists( $this, $name ) ) {
// Dynamic property access, deprecated.
wfDeprecatedMsg( "ParserOutput::{$name} dynamic property read access deprecated", '1.38' );
return $this->$name;
} else {
trigger_error( "Inaccessible property via __get(): $name" );
return null;
}
}
public function __set( $name, $value ) {
if ( property_exists( get_called_class(), $name ) ) {
// Direct access to a public property, deprecated.
wfDeprecatedMsg( "ParserOutput::$name public write access deprecated", '1.38' );
$this->$name = $value;
} else {
// Dynamic property access, deprecated.
wfDeprecatedMsg( "ParserOutput::$name dynamic property write access deprecated", '1.38' );
$this->$name = $value;
}
}
}
/** @deprecated class alias since 1.42 */
class_alias( ParserOutput::class, 'ParserOutput' );
|