1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
1679
1680
1681
1682
1683
1684
1685
1686
1687
1688
1689
1690
1691
1692
1693
1694
1695
1696
1697
1698
1699
1700
1701
1702
1703
1704
1705
1706
1707
1708
1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
1723
1724
1725
1726
1727
1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
1740
1741
1742
1743
1744
1745
1746
1747
1748
1749
1750
1751
1752
1753
1754
1755
1756
1757
1758
1759
1760
1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
1775
1776
1777
1778
1779
1780
1781
1782
1783
1784
1785
1786
1787
1788
1789
1790
1791
1792
1793
1794
1795
1796
1797
1798
1799
1800
1801
1802
1803
1804
1805
1806
1807
1808
1809
1810
1811
1812
1813
1814
1815
1816
1817
1818
1819
1820
1821
1822
1823
1824
1825
1826
1827
1828
1829
1830
1831
1832
1833
1834
1835
1836
1837
1838
1839
1840
1841
1842
1843
1844
1845
1846
1847
1848
1849
1850
1851
1852
1853
1854
1855
1856
1857
1858
1859
1860
1861
1862
1863
1864
1865
1866
1867
1868
1869
1870
1871
1872
1873
1874
1875
1876
1877
1878
1879
1880
1881
1882
1883
1884
1885
1886
1887
1888
1889
1890
1891
1892
1893
1894
1895
1896
1897
1898
1899
1900
1901
1902
1903
1904
1905
1906
1907
1908
1909
1910
1911
1912
1913
1914
1915
1916
1917
1918
1919
1920
1921
1922
1923
1924
1925
1926
1927
1928
1929
1930
1931
1932
1933
1934
1935
1936
1937
1938
1939
1940
1941
1942
1943
1944
1945
1946
1947
1948
1949
1950
1951
1952
1953
1954
1955
1956
1957
1958
1959
1960
1961
1962
1963
1964
1965
1966
1967
1968
1969
1970
1971
1972
1973
1974
1975
1976
1977
1978
1979
1980
1981
1982
1983
1984
1985
1986
1987
1988
1989
1990
1991
1992
1993
1994
1995
1996
1997
1998
1999
2000
2001
2002
2003
2004
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
2025
2026
2027
2028
2029
2030
2031
2032
2033
2034
2035
2036
2037
2038
2039
2040
2041
2042
2043
2044
2045
2046
2047
2048
2049
2050
2051
2052
2053
2054
2055
2056
2057
2058
2059
2060
2061
2062
2063
2064
2065
2066
2067
2068
2069
2070
2071
2072
2073
2074
2075
2076
2077
2078
2079
2080
2081
2082
2083
2084
2085
2086
2087
2088
2089
2090
2091
2092
2093
2094
2095
2096
2097
2098
2099
2100
2101
2102
2103
2104
2105
2106
2107
2108
2109
2110
2111
2112
2113
2114
2115
2116
2117
2118
2119
2120
2121
2122
2123
2124
2125
2126
2127
2128
2129
2130
2131
2132
2133
2134
2135
2136
2137
2138
2139
2140
2141
2142
2143
2144
2145
2146
2147
2148
2149
2150
2151
2152
2153
2154
2155
2156
2157
2158
2159
2160
2161
2162
2163
2164
2165
2166
2167
2168
2169
2170
2171
2172
2173
2174
2175
2176
2177
2178
2179
2180
2181
2182
2183
2184
2185
2186
2187
2188
2189
2190
2191
2192
2193
2194
2195
2196
2197
2198
2199
2200
2201
2202
2203
2204
2205
2206
2207
2208
2209
2210
2211
2212
2213
2214
2215
2216
2217
2218
2219
2220
2221
2222
2223
2224
2225
2226
2227
2228
2229
2230
2231
2232
2233
2234
2235
2236
2237
2238
2239
2240
2241
2242
2243
2244
2245
2246
2247
2248
2249
2250
2251
2252
2253
2254
2255
2256
2257
2258
2259
2260
2261
2262
2263
2264
2265
2266
2267
2268
2269
2270
2271
2272
2273
2274
2275
2276
2277
2278
2279
2280
2281
2282
2283
2284
2285
2286
2287
2288
2289
2290
2291
2292
2293
2294
2295
2296
2297
2298
2299
2300
2301
2302
2303
2304
2305
2306
2307
2308
2309
2310
2311
2312
2313
2314
2315
2316
2317
2318
2319
2320
2321
2322
2323
2324
2325
2326
2327
2328
2329
2330
2331
2332
2333
2334
2335
2336
2337
2338
2339
2340
2341
2342
2343
2344
2345
2346
2347
2348
2349
2350
2351
2352
2353
2354
2355
2356
2357
2358
2359
2360
2361
2362
2363
2364
2365
2366
2367
2368
2369
2370
2371
2372
2373
2374
2375
2376
2377
2378
2379
2380
2381
2382
2383
2384
2385
2386
2387
2388
2389
2390
2391
2392
2393
2394
2395
2396
2397
2398
2399
2400
2401
2402
2403
2404
2405
2406
2407
2408
2409
2410
2411
2412
2413
2414
2415
2416
2417
2418
2419
2420
2421
2422
2423
2424
2425
2426
2427
2428
2429
2430
2431
2432
2433
2434
2435
2436
2437
2438
2439
2440
2441
2442
2443
2444
2445
2446
2447
2448
2449
2450
2451
2452
2453
2454
2455
2456
2457
2458
2459
2460
2461
2462
2463
2464
2465
2466
2467
2468
2469
2470
2471
2472
2473
2474
2475
2476
2477
2478
2479
2480
2481
2482
2483
2484
2485
2486
2487
2488
2489
2490
2491
2492
2493
2494
2495
2496
2497
2498
2499
2500
2501
2502
2503
2504
2505
2506
2507
2508
2509
2510
2511
2512
2513
2514
2515
2516
2517
2518
2519
2520
2521
2522
2523
2524
2525
2526
2527
2528
2529
2530
2531
2532
2533
2534
2535
2536
2537
2538
2539
2540
2541
2542
2543
2544
2545
2546
2547
2548
2549
2550
2551
2552
2553
2554
2555
2556
2557
2558
2559
2560
2561
2562
2563
2564
2565
2566
2567
2568
2569
2570
2571
2572
2573
2574
2575
2576
2577
2578
2579
2580
2581
2582
2583
2584
2585
2586
2587
2588
2589
2590
2591
2592
2593
2594
2595
2596
2597
2598
2599
2600
2601
2602
2603
2604
2605
2606
2607
2608
2609
2610
2611
2612
2613
2614
2615
2616
2617
2618
2619
2620
2621
2622
2623
2624
2625
2626
2627
2628
2629
2630
2631
2632
2633
2634
2635
2636
2637
2638
2639
2640
2641
2642
2643
2644
2645
2646
2647
2648
2649
2650
2651
2652
2653
2654
2655
2656
2657
2658
2659
2660
2661
2662
2663
2664
2665
2666
2667
2668
2669
2670
2671
2672
2673
2674
2675
2676
2677
2678
2679
2680
2681
2682
2683
2684
2685
2686
2687
2688
2689
2690
2691
2692
2693
2694
2695
2696
2697
2698
2699
2700
2701
2702
2703
2704
2705
2706
2707
2708
2709
2710
2711
2712
2713
2714
2715
2716
2717
2718
2719
2720
2721
2722
2723
2724
2725
2726
2727
2728
2729
2730
2731
2732
2733
2734
2735
2736
2737
2738
2739
2740
2741
2742
2743
2744
2745
2746
2747
2748
2749
2750
2751
2752
2753
2754
2755
2756
2757
2758
2759
2760
2761
2762
2763
2764
2765
2766
2767
2768
2769
2770
2771
2772
2773
2774
2775
2776
2777
2778
2779
2780
2781
2782
2783
2784
2785
2786
2787
2788
2789
2790
2791
2792
2793
2794
2795
2796
2797
2798
2799
2800
2801
2802
2803
2804
2805
2806
2807
2808
2809
2810
2811
2812
2813
2814
2815
2816
2817
2818
2819
2820
2821
2822
2823
2824
2825
2826
2827
2828
2829
2830
2831
2832
2833
2834
2835
2836
2837
2838
2839
2840
2841
2842
2843
2844
2845
2846
2847
2848
2849
2850
2851
2852
2853
2854
2855
2856
2857
2858
2859
2860
2861
2862
2863
2864
2865
2866
2867
2868
2869
2870
2871
2872
2873
2874
2875
2876
2877
2878
2879
2880
2881
2882
2883
2884
2885
2886
2887
2888
2889
2890
2891
2892
2893
2894
2895
2896
2897
2898
2899
2900
2901
2902
2903
2904
2905
2906
2907
2908
2909
2910
2911
2912
2913
2914
2915
2916
2917
2918
2919
2920
2921
2922
2923
2924
2925
2926
2927
2928
2929
2930
2931
2932
2933
2934
2935
2936
2937
2938
2939
2940
2941
2942
2943
2944
2945
2946
2947
2948
2949
2950
2951
2952
2953
2954
2955
2956
2957
2958
2959
2960
2961
2962
2963
2964
2965
2966
2967
2968
2969
2970
2971
2972
2973
2974
2975
2976
2977
2978
2979
2980
2981
2982
2983
2984
2985
2986
2987
2988
2989
2990
2991
2992
2993
2994
2995
2996
2997
2998
2999
3000
3001
3002
3003
3004
3005
3006
3007
3008
3009
3010
3011
3012
3013
3014
3015
3016
3017
3018
3019
3020
3021
3022
3023
3024
3025
3026
3027
3028
3029
3030
3031
3032
3033
3034
3035
3036
3037
3038
3039
3040
3041
3042
3043
3044
3045
3046
3047
3048
3049
3050
3051
3052
3053
3054
3055
3056
3057
3058
3059
3060
3061
3062
3063
3064
3065
3066
3067
3068
3069
3070
3071
3072
3073
3074
3075
3076
3077
3078
3079
3080
3081
3082
3083
3084
3085
3086
3087
3088
3089
3090
3091
3092
3093
3094
3095
3096
3097
3098
3099
3100
3101
3102
3103
3104
3105
3106
3107
3108
3109
3110
3111
3112
3113
3114
3115
3116
3117
3118
3119
3120
3121
3122
3123
3124
3125
3126
3127
3128
3129
3130
3131
3132
3133
3134
3135
3136
3137
3138
3139
3140
3141
3142
3143
3144
3145
3146
3147
3148
3149
3150
3151
3152
3153
3154
3155
3156
3157
3158
3159
3160
3161
3162
3163
3164
3165
3166
3167
3168
3169
3170
3171
3172
3173
3174
3175
3176
3177
3178
3179
3180
3181
3182
3183
3184
3185
3186
3187
3188
3189
3190
3191
3192
3193
3194
3195
3196
3197
3198
3199
3200
3201
3202
3203
3204
3205
3206
3207
3208
3209
3210
3211
3212
3213
3214
3215
3216
3217
3218
3219
3220
3221
3222
3223
3224
3225
3226
3227
3228
3229
3230
3231
3232
3233
3234
3235
3236
3237
3238
3239
3240
3241
3242
3243
3244
3245
3246
3247
3248
3249
3250
3251
3252
3253
3254
3255
3256
3257
3258
3259
3260
3261
3262
3263
3264
3265
3266
3267
3268
3269
3270
3271
3272
3273
3274
3275
3276
3277
3278
3279
3280
3281
3282
3283
3284
3285
3286
3287
3288
3289
3290
3291
3292
3293
3294
3295
3296
3297
3298
3299
3300
3301
3302
3303
3304
3305
3306
3307
3308
3309
3310
3311
3312
3313
3314
3315
3316
3317
3318
3319
3320
3321
3322
3323
3324
3325
3326
3327
3328
3329
3330
3331
3332
3333
3334
3335
3336
3337
3338
3339
3340
3341
3342
3343
3344
3345
3346
3347
3348
3349
3350
3351
3352
3353
3354
3355
3356
3357
3358
3359
3360
3361
3362
3363
3364
3365
3366
3367
3368
3369
3370
3371
3372
3373
3374
3375
3376
3377
3378
3379
3380
3381
3382
3383
3384
3385
3386
3387
3388
3389
3390
3391
3392
3393
3394
3395
3396
3397
3398
3399
3400
3401
3402
3403
3404
3405
3406
3407
3408
3409
3410
3411
3412
3413
3414
3415
3416
3417
3418
3419
3420
3421
3422
3423
3424
3425
3426
3427
3428
3429
3430
3431
3432
3433
3434
3435
3436
3437
3438
3439
3440
3441
3442
3443
3444
3445
3446
3447
3448
3449
3450
3451
3452
3453
3454
3455
3456
3457
3458
3459
3460
3461
3462
3463
3464
3465
3466
3467
3468
3469
3470
3471
3472
3473
3474
3475
3476
3477
3478
3479
3480
3481
3482
3483
3484
3485
3486
3487
3488
3489
3490
3491
3492
3493
3494
3495
3496
3497
3498
3499
3500
3501
3502
3503
3504
3505
3506
3507
3508
3509
3510
3511
3512
3513
3514
3515
3516
3517
3518
3519
3520
3521
3522
3523
3524
3525
3526
3527
3528
3529
3530
3531
3532
3533
3534
3535
3536
3537
3538
3539
3540
3541
3542
3543
3544
3545
3546
3547
3548
3549
3550
3551
3552
3553
3554
3555
3556
3557
3558
3559
3560
3561
3562
3563
3564
3565
3566
3567
3568
3569
3570
3571
3572
3573
3574
3575
3576
3577
3578
3579
3580
3581
3582
3583
3584
3585
3586
3587
3588
3589
3590
3591
3592
3593
3594
3595
3596
3597
3598
3599
3600
3601
3602
3603
3604
3605
3606
3607
3608
3609
3610
3611
3612
3613
3614
3615
3616
3617
3618
3619
3620
3621
3622
3623
3624
3625
3626
3627
3628
3629
3630
3631
3632
3633
3634
3635
3636
3637
3638
3639
3640
3641
3642
3643
3644
3645
3646
3647
3648
3649
3650
3651
3652
3653
3654
3655
3656
3657
3658
3659
3660
3661
3662
3663
3664
3665
3666
3667
3668
3669
3670
3671
3672
3673
3674
3675
3676
3677
3678
3679
3680
3681
3682
3683
3684
3685
3686
3687
3688
3689
3690
3691
3692
3693
3694
3695
3696
3697
3698
3699
3700
3701
3702
3703
3704
3705
3706
3707
3708
3709
3710
3711
3712
3713
3714
3715
3716
3717
3718
3719
3720
3721
3722
3723
3724
3725
3726
3727
3728
3729
3730
3731
3732
3733
3734
3735
3736
3737
3738
3739
3740
3741
3742
3743
3744
3745
3746
3747
3748
3749
3750
3751
3752
3753
3754
3755
3756
3757
3758
3759
3760
3761
3762
3763
3764
3765
3766
3767
3768
3769
3770
3771
3772
3773
3774
3775
3776
3777
3778
3779
3780
3781
3782
3783
3784
3785
3786
3787
3788
3789
3790
3791
3792
3793
3794
3795
3796
3797
3798
3799
3800
3801
3802
3803
3804
3805
3806
3807
3808
3809
3810
3811
3812
3813
3814
3815
3816
3817
3818
|
<?php
/**
* Base representation for a MediaWiki page.
*
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation; either version 2 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License along
* with this program; if not, write to the Free Software Foundation, Inc.,
* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
* http://www.gnu.org/copyleft/gpl.html
*
* @file
*/
use MediaWiki\Config\ServiceOptions;
use MediaWiki\Content\ContentHandlerFactory;
use MediaWiki\Content\IContentHandlerFactory;
use MediaWiki\DAO\WikiAwareEntityTrait;
use MediaWiki\Edit\PreparedEdit;
use MediaWiki\HookContainer\ProtectedHookAccessorTrait;
use MediaWiki\Logger\LoggerFactory;
use MediaWiki\MediaWikiServices;
use MediaWiki\Page\ExistingPageRecord;
use MediaWiki\Page\PageIdentity;
use MediaWiki\Page\PageRecord;
use MediaWiki\Page\PageReference;
use MediaWiki\Page\PageStoreRecord;
use MediaWiki\Page\ParserOutputAccess;
use MediaWiki\Permissions\Authority;
use MediaWiki\Revision\RevisionRecord;
use MediaWiki\Revision\RevisionStore;
use MediaWiki\Revision\SlotRecord;
use MediaWiki\Revision\SlotRoleRegistry;
use MediaWiki\Storage\DerivedPageDataUpdater;
use MediaWiki\Storage\EditResult;
use MediaWiki\Storage\EditResultCache;
use MediaWiki\Storage\PageUpdater;
use MediaWiki\Storage\RevisionSlotsUpdate;
use MediaWiki\User\UserIdentity;
use Wikimedia\Assert\Assert;
use Wikimedia\Assert\PreconditionException;
use Wikimedia\IPUtils;
use Wikimedia\NonSerializable\NonSerializableTrait;
use Wikimedia\Rdbms\FakeResultWrapper;
use Wikimedia\Rdbms\IDatabase;
use Wikimedia\Rdbms\LoadBalancer;
/**
* Class representing a MediaWiki article and history.
*
* Some fields are public only for backwards-compatibility. Use accessors.
* In the past, this class was part of Article.php and everything was public.
*/
class WikiPage implements Page, IDBAccessObject, PageRecord {
use NonSerializableTrait;
use ProtectedHookAccessorTrait;
use WikiAwareEntityTrait;
// Constants for $mDataLoadedFrom and related
/**
* @var Title
* @todo make protected
* @note for access by subclasses only
*/
public $mTitle = null;
/**
* @var bool
* @todo make protected
* @note for access by subclasses only
*/
public $mDataLoaded = false;
/**
* A cache of the page_is_redirect field, loaded with page data
* @var bool
*/
private $mPageIsRedirectField = false;
/**
* Boolean if the redirect status is definitively known.
* If this is true, getRedirectTarget() must return non-null.
*
* @var bool|null
*/
private $mHasRedirectTarget = null;
/**
* The cache of the redirect target
*
* @var Title
*/
protected $mRedirectTarget = null;
/**
* @var bool
*/
private $mIsNew = false;
/**
* @var bool
*/
private $mIsRedirect = false;
/**
* @var int|false False means "not loaded"
* @todo make protected
* @note for access by subclasses only
*/
public $mLatest = false;
/**
* @var PreparedEdit|false Map of cache fields (text, parser output, ect) for a proposed/new edit
* @todo make protected
* @note for access by subclasses only
*/
public $mPreparedEdit = false;
/**
* @var int
*/
protected $mId = null;
/**
* @var int One of the READ_* constants
*/
protected $mDataLoadedFrom = self::READ_NONE;
/**
* @var RevisionRecord
*/
private $mLastRevision = null;
/**
* @var string Timestamp of the current revision or empty string if not loaded
*/
protected $mTimestamp = '';
/**
* @var string
*/
protected $mTouched = '19700101000000';
/**
* @var string|null
*/
protected $mLanguage = null;
/**
* @var string
*/
protected $mLinksUpdated = '19700101000000';
/**
* @var DerivedPageDataUpdater|null
*/
private $derivedDataUpdater = null;
/**
* @param PageIdentity $pageIdentity
*/
public function __construct( PageIdentity $pageIdentity ) {
$pageIdentity->assertWiki( PageIdentity::LOCAL );
// TODO: remove the need for casting to Title.
$title = Title::castFromPageIdentity( $pageIdentity );
if ( !$title->canExist() ) {
// TODO: In order to allow WikiPage to implement ProperPageIdentity,
// throw here to prevent construction of a WikiPage that doesn't
// represent a proper page.
wfDeprecatedMsg(
"WikiPage constructed on a Title that cannot exist as a page: $title",
'1.36'
);
}
$this->mTitle = $title;
}
/**
* Makes sure that the mTitle object is cloned
* to the newly cloned WikiPage.
*/
public function __clone() {
$this->mTitle = clone $this->mTitle;
}
/**
* Create a WikiPage object of the appropriate class for the given PageIdentity.
* The PageIdentity must represent a proper page that can exist on the wiki,
* that is, not a special page or media link or section link or interwiki link.
*
* @param PageIdentity $pageIdentity
*
* @throws MWException
* @return WikiPage|WikiCategoryPage|WikiFilePage
* @deprecated since 1.36, use WikiPageFactory::newFromTitle instead
*/
public static function factory( PageIdentity $pageIdentity ) {
return MediaWikiServices::getInstance()->getWikiPageFactory()->newFromTitle( $pageIdentity );
}
/**
* Constructor from a page id
*
* @param int $id Article ID to load
* @param string|int $from One of the following values:
* - "fromdb" or WikiPage::READ_NORMAL to select from a replica DB
* - "fromdbmaster" or WikiPage::READ_LATEST to select from the master database
*
* @return WikiPage|null
* @deprecated since 1.36, use WikiPageFactory::newFromID instead
*/
public static function newFromID( $id, $from = 'fromdb' ) {
return MediaWikiServices::getInstance()->getWikiPageFactory()->newFromID( $id, $from );
}
/**
* Constructor from a database row
*
* @since 1.20
* @param stdClass $row Database row containing at least fields returned by getQueryInfo().
* @param string|int $from Source of $data:
* - "fromdb" or WikiPage::READ_NORMAL: from a replica DB
* - "fromdbmaster" or WikiPage::READ_LATEST: from the master DB
* - "forupdate" or WikiPage::READ_LOCKING: from the master DB using SELECT FOR UPDATE
* @return WikiPage
* @deprecated since 1.36, use WikiPageFactory::newFromRow instead
*/
public static function newFromRow( $row, $from = 'fromdb' ) {
return MediaWikiServices::getInstance()->getWikiPageFactory()->newFromRow( $row, $from );
}
/**
* Convert 'fromdb', 'fromdbmaster' and 'forupdate' to READ_* constants.
*
* @param stdClass|string|int $type
* @return mixed
*/
public static function convertSelectType( $type ) {
switch ( $type ) {
case 'fromdb':
return self::READ_NORMAL;
case 'fromdbmaster':
return self::READ_LATEST;
case 'forupdate':
return self::READ_LOCKING;
default:
// It may already be an integer or whatever else
return $type;
}
}
/**
* @return RevisionStore
*/
private function getRevisionStore() {
return MediaWikiServices::getInstance()->getRevisionStore();
}
/**
* @return SlotRoleRegistry
*/
private function getSlotRoleRegistry() {
return MediaWikiServices::getInstance()->getSlotRoleRegistry();
}
/**
* @return ContentHandlerFactory
*/
private function getContentHandlerFactory(): IContentHandlerFactory {
return MediaWikiServices::getInstance()->getContentHandlerFactory();
}
/**
* @return LoadBalancer
*/
private function getDBLoadBalancer() {
return MediaWikiServices::getInstance()->getDBLoadBalancer();
}
/**
* @todo Move this UI stuff somewhere else
*
* @see ContentHandler::getActionOverrides
* @return array
*/
public function getActionOverrides() {
return $this->getContentHandler()->getActionOverrides();
}
/**
* Returns the ContentHandler instance to be used to deal with the content of this WikiPage.
*
* Shorthand for ContentHandler::getForModelID( $this->getContentModel() );
*
* @return ContentHandler
*
* @since 1.21
*/
public function getContentHandler() {
return $this->getContentHandlerFactory()
->getContentHandler( $this->getContentModel() );
}
/**
* Get the title object of the article
* @return Title Title object of this page
*/
public function getTitle() {
return $this->mTitle;
}
/**
* Clear the object
* @return void
*/
public function clear() {
$this->mDataLoaded = false;
$this->mDataLoadedFrom = self::READ_NONE;
$this->clearCacheFields();
}
/**
* Clear the object cache fields
* @return void
*/
protected function clearCacheFields() {
$this->mId = null;
$this->mRedirectTarget = null; // Title object if set
$this->mHasRedirectTarget = null;
$this->mPageIsRedirectField = false;
$this->mLastRevision = null; // Latest revision
$this->mTouched = '19700101000000';
$this->mLanguage = null;
$this->mLinksUpdated = '19700101000000';
$this->mTimestamp = '';
$this->mIsNew = false;
$this->mIsRedirect = false;
$this->mLatest = false;
// T59026: do not clear $this->derivedDataUpdater since getDerivedDataUpdater() already
// checks the requested rev ID and content against the cached one. For most
// content types, the output should not change during the lifetime of this cache.
// Clearing it can cause extra parses on edit for no reason.
}
/**
* Clear the mPreparedEdit cache field, as may be needed by mutable content types
* @return void
* @since 1.23
*/
public function clearPreparedEdit() {
$this->mPreparedEdit = false;
}
/**
* Return the tables, fields, and join conditions to be selected to create
* a new page object.
* @since 1.31
* @return array With three keys:
* - tables: (string[]) to include in the `$table` to `IDatabase->select()`
* - fields: (string[]) to include in the `$vars` to `IDatabase->select()`
* - joins: (array) to include in the `$join_conds` to `IDatabase->select()`
*/
public static function getQueryInfo() {
global $wgPageLanguageUseDB;
$ret = [
'tables' => [ 'page' ],
'fields' => [
'page_id',
'page_namespace',
'page_title',
'page_restrictions',
'page_is_redirect',
'page_is_new',
'page_random',
'page_touched',
'page_links_updated',
'page_latest',
'page_len',
'page_content_model',
],
'joins' => [],
];
if ( $wgPageLanguageUseDB ) {
$ret['fields'][] = 'page_lang';
}
return $ret;
}
/**
* Fetch a page record with the given conditions
* @param IDatabase $dbr
* @param array $conditions
* @param array $options
* @return stdClass|false Database result resource, or false on failure
*/
protected function pageData( $dbr, $conditions, $options = [] ) {
$pageQuery = self::getQueryInfo();
$this->getHookRunner()->onArticlePageDataBefore(
$this, $pageQuery['fields'], $pageQuery['tables'], $pageQuery['joins'] );
$row = $dbr->selectRow(
$pageQuery['tables'],
$pageQuery['fields'],
$conditions,
__METHOD__,
$options,
$pageQuery['joins']
);
$this->getHookRunner()->onArticlePageDataAfter( $this, $row );
return $row;
}
/**
* Fetch a page record matching the Title object's namespace and title
* using a sanitized title string
*
* @param IDatabase $dbr
* @param Title $title
* @param array $options
* @return stdClass|false Database result resource, or false on failure
*/
public function pageDataFromTitle( $dbr, $title, $options = [] ) {
if ( !$title->canExist() ) {
return false;
}
return $this->pageData( $dbr, [
'page_namespace' => $title->getNamespace(),
'page_title' => $title->getDBkey() ], $options );
}
/**
* Fetch a page record matching the requested ID
*
* @param IDatabase $dbr
* @param int $id
* @param array $options
* @return stdClass|false Database result resource, or false on failure
*/
public function pageDataFromId( $dbr, $id, $options = [] ) {
return $this->pageData( $dbr, [ 'page_id' => $id ], $options );
}
/**
* Load the object from a given source by title
*
* @param stdClass|string|int $from One of the following:
* - A DB query result object.
* - "fromdb" or WikiPage::READ_NORMAL to get from a replica DB.
* - "fromdbmaster" or WikiPage::READ_LATEST to get from the master DB.
* - "forupdate" or WikiPage::READ_LOCKING to get from the master DB
* using SELECT FOR UPDATE.
*
* @return void
*/
public function loadPageData( $from = 'fromdb' ) {
if ( !$this->mTitle->canExist() ) {
// NOTE: If and when WikiPage implements PageIdentity but not yet ProperPageIdentity,
// throw here to prevent usage of a WikiPage that doesn't
// represent a proper page.
// NOTE: The constructor will already have triggered a warning, but seeing how
// bad instances of WikiPage are used will be helpful.
wfDeprecatedMsg(
"Accessing WikiPage that cannot exist as a page: {$this->mTitle}. ",
'1.36'
);
}
$from = self::convertSelectType( $from );
if ( is_int( $from ) && $from <= $this->mDataLoadedFrom ) {
// We already have the data from the correct location, no need to load it twice.
return;
}
if ( is_int( $from ) ) {
list( $index, $opts ) = DBAccessObjectUtils::getDBOptions( $from );
$loadBalancer = $this->getDBLoadBalancer();
$db = $loadBalancer->getConnection( $index );
$data = $this->pageDataFromTitle( $db, $this->mTitle, $opts );
if ( !$data
&& $index == DB_REPLICA
&& $loadBalancer->getServerCount() > 1
&& $loadBalancer->hasOrMadeRecentMasterChanges()
) {
$from = self::READ_LATEST;
list( $index, $opts ) = DBAccessObjectUtils::getDBOptions( $from );
$db = $loadBalancer->getConnection( $index );
$data = $this->pageDataFromTitle( $db, $this->mTitle, $opts );
}
} else {
// No idea from where the caller got this data, assume replica DB.
$data = $from;
$from = self::READ_NORMAL;
}
$this->loadFromRow( $data, $from );
}
/**
* Checks whether the page data was loaded using the given database access mode (or better).
*
* @since 1.32
*
* @param string|int $from One of the following:
* - "fromdb" or WikiPage::READ_NORMAL to get from a replica DB.
* - "fromdbmaster" or WikiPage::READ_LATEST to get from the master DB.
* - "forupdate" or WikiPage::READ_LOCKING to get from the master DB
* using SELECT FOR UPDATE.
*
* @return bool
*/
public function wasLoadedFrom( $from ) {
$from = self::convertSelectType( $from );
if ( !is_int( $from ) ) {
// No idea from where the caller got this data, assume replica DB.
$from = self::READ_NORMAL;
}
if ( $from <= $this->mDataLoadedFrom ) {
return true;
}
return false;
}
/**
* Load the object from a database row
*
* @since 1.20
* @param stdClass|bool $data DB row containing fields returned by getQueryInfo() or false
* @param string|int $from One of the following:
* - "fromdb" or WikiPage::READ_NORMAL if the data comes from a replica DB
* - "fromdbmaster" or WikiPage::READ_LATEST if the data comes from the master DB
* - "forupdate" or WikiPage::READ_LOCKING if the data comes from
* the master DB using SELECT FOR UPDATE
*/
public function loadFromRow( $data, $from ) {
$lc = MediaWikiServices::getInstance()->getLinkCache();
$lc->clearLink( $this->mTitle );
if ( $data ) {
$lc->addGoodLinkObjFromRow( $this->mTitle, $data );
$this->mTitle->loadFromRow( $data );
// Old-fashioned restrictions
$this->mTitle->loadRestrictions( $data->page_restrictions );
$this->mId = intval( $data->page_id );
$this->mTouched = MWTimestamp::convert( TS_MW, $data->page_touched );
$this->mLanguage = $data->page_lang ?? null;
$this->mLinksUpdated = $data->page_links_updated === null
? null
: MWTimestamp::convert( TS_MW, $data->page_links_updated );
$this->mPageIsRedirectField = (bool)$data->page_is_redirect;
$this->mIsNew = intval( $data->page_is_new ?? 0 );
$this->mIsRedirect = intval( $data->page_is_redirect ?? 0 );
$this->mLatest = intval( $data->page_latest );
// T39225: $latest may no longer match the cached latest RevisionRecord object.
// Double-check the ID of any cached latest RevisionRecord object for consistency.
if ( $this->mLastRevision && $this->mLastRevision->getId() != $this->mLatest ) {
$this->mLastRevision = null;
$this->mTimestamp = '';
}
} else {
$lc->addBadLinkObj( $this->mTitle );
$this->mTitle->loadFromRow( false );
$this->clearCacheFields();
$this->mId = 0;
}
$this->mDataLoaded = true;
$this->mDataLoadedFrom = self::convertSelectType( $from );
}
/**
* Code that requires this WikiPage to be a "proper page" in the sense
* defined by PageIdentity should call this method.
*
* @note In the future, this method should become redundant, as the
* constructor should not allow a WikiPage to be constructed for as title
* that does not represent a proper page. For the time being, we allow
* such instances for backwards compatibility.
*
* @throws PreconditionException
*/
private function assertProperPage() {
Assert::precondition(
$this->mTitle->canExist(),
'This WikiPage instance does not represent a proper page!'
);
}
/**
* @param string|false $wikiId
*
* @return int Page ID
*/
public function getId( $wikiId = self::LOCAL ): int {
$this->assertWiki( $wikiId );
$this->assertProperPage();
if ( !$this->mDataLoaded ) {
$this->loadPageData();
}
return $this->mId;
}
/**
* @return bool Whether or not the page exists in the database
*/
public function exists(): bool {
if ( !$this->mDataLoaded ) {
$this->loadPageData();
}
return $this->mId > 0;
}
/**
* Check if this page is something we're going to be showing
* some sort of sensible content for. If we return false, page
* views (plain action=view) will return an HTTP 404 response,
* so spiders and robots can know they're following a bad link.
*
* @return bool
*/
public function hasViewableContent() {
return $this->mTitle->isKnown();
}
/**
* Is the page a redirect, according to secondary tracking tables?
* If this is true, getRedirectTarget() will return a Title.
*
* @return bool
*/
public function isRedirect() {
if ( !$this->mDataLoaded ) {
$this->loadPageData();
}
return (bool)$this->mIsRedirect;
}
/**
* Get the value of the page_is_redirect field in the DB. This is probably
* not what you want. Use WikiPage::isRedirect() to test if the page is a
* redirect. Use Title::isRedirect() for a fast check for the purposes of
* linking to a page.
*
* @since 1.36
* @return bool
*/
public function getPageIsRedirectField() {
if ( !$this->mDataLoaded ) {
$this->loadPageData();
}
return $this->mPageIsRedirectField;
}
/**
* Tests if the page is new (only has one revision).
* May produce false negatives for some old pages.
*
* @since 1.36
*
* @return bool
*/
public function isNew() {
if ( !$this->mDataLoaded ) {
$this->loadPageData();
}
return (bool)$this->mIsNew;
}
/**
* Returns the page's content model id (see the CONTENT_MODEL_XXX constants).
*
* Will use the revisions actual content model if the page exists,
* and the page's default if the page doesn't exist yet.
*
* @return string
*
* @since 1.21
*/
public function getContentModel() {
if ( $this->exists() ) {
$cache = MediaWikiServices::getInstance()->getMainWANObjectCache();
return $cache->getWithSetCallback(
$cache->makeKey( 'page-content-model', $this->getLatest() ),
$cache::TTL_MONTH,
function () {
$rev = $this->getRevisionRecord();
if ( $rev ) {
// Look at the revision's actual content model
$slot = $rev->getSlot(
SlotRecord::MAIN,
RevisionRecord::RAW
);
return $slot->getModel();
} else {
LoggerFactory::getInstance( 'wikipage' )->warning(
'Page exists but has no (visible) revisions!',
[
'page-title' => $this->mTitle->getPrefixedDBkey(),
'page-id' => $this->getId(),
]
);
return $this->mTitle->getContentModel();
}
},
[ 'pcTTL' => $cache::TTL_PROC_LONG ]
);
}
// use the default model for this page
return $this->mTitle->getContentModel();
}
/**
* Loads page_touched and returns a value indicating if it should be used
* @return bool True if this page exists and is not a redirect
*/
public function checkTouched() {
return ( $this->exists() && !$this->isRedirect() );
}
/**
* Get the page_touched field
* @return string Containing GMT timestamp
*/
public function getTouched() {
if ( !$this->mDataLoaded ) {
$this->loadPageData();
}
return $this->mTouched;
}
/**
* @return ?string language code for the page
*/
public function getLanguage() {
if ( !$this->mDataLoaded ) {
$this->loadLastEdit();
}
return $this->mLanguage;
}
/**
* Get the page_links_updated field
* @return string|null Containing GMT timestamp
*/
public function getLinksTimestamp() {
if ( !$this->mDataLoaded ) {
$this->loadPageData();
}
return $this->mLinksUpdated;
}
/**
* Get the page_latest field
* @param bool $wikiId
* @return int The rev_id of current revision
*/
public function getLatest( $wikiId = self::LOCAL ) {
$this->assertWiki( $wikiId );
if ( !$this->mDataLoaded ) {
$this->loadPageData();
}
return (int)$this->mLatest;
}
/**
* Loads everything except the text
* This isn't necessary for all uses, so it's only done if needed.
*/
protected function loadLastEdit() {
if ( $this->mLastRevision !== null ) {
return; // already loaded
}
if ( !$this->mTitle->canExist() ) {
// NOTE: If and when WikiPage implements PageIdentity but not yet ProperPageIdentity,
// throw here to prevent usage of a WikiPage that doesn't
// represent a proper page.
// NOTE: The constructor will already have triggered a warning, but seeing how
// bad instances of WikiPage are used will be helpful.
wfDeprecatedMsg(
"Accessing WikiPage that cannot exist as a page: {$this->mTitle}. ",
'1.36'
);
}
$latest = $this->getLatest();
if ( !$latest ) {
return; // page doesn't exist or is missing page_latest info
}
if ( $this->mDataLoadedFrom == self::READ_LOCKING ) {
// T39225: if session S1 loads the page row FOR UPDATE, the result always
// includes the latest changes committed. This is true even within REPEATABLE-READ
// transactions, where S1 normally only sees changes committed before the first S1
// SELECT. Thus we need S1 to also gets the revision row FOR UPDATE; otherwise, it
// may not find it since a page row UPDATE and revision row INSERT by S2 may have
// happened after the first S1 SELECT.
// https://dev.mysql.com/doc/refman/5.7/en/set-transaction.html#isolevel_repeatable-read
$revision = $this->getRevisionStore()
->getRevisionByPageId( $this->getId(), $latest, RevisionStore::READ_LOCKING );
} elseif ( $this->mDataLoadedFrom == self::READ_LATEST ) {
// Bug T93976: if page_latest was loaded from the master, fetch the
// revision from there as well, as it may not exist yet on a replica DB.
// Also, this keeps the queries in the same REPEATABLE-READ snapshot.
$revision = $this->getRevisionStore()
->getRevisionByPageId( $this->getId(), $latest, RevisionStore::READ_LATEST );
} else {
$revision = $this->getRevisionStore()->getKnownCurrentRevision( $this->getTitle(), $latest );
}
if ( $revision ) { // sanity
$this->setLastEdit( $revision );
}
}
/**
* Set the latest revision
* @param RevisionRecord $revRecord
*/
private function setLastEdit( RevisionRecord $revRecord ) {
$this->mLastRevision = $revRecord;
$this->mLatest = $revRecord->getId();
$this->mTimestamp = $revRecord->getTimestamp();
$this->mTouched = max( $this->mTouched, $revRecord->getTimestamp() );
}
/**
* Get the latest revision
* @since 1.32
* @return RevisionRecord|null
*/
public function getRevisionRecord() {
$this->loadLastEdit();
if ( $this->mLastRevision ) {
return $this->mLastRevision;
}
return null;
}
/**
* Get the content of the current revision. No side-effects...
*
* @param int $audience One of:
* RevisionRecord::FOR_PUBLIC to be displayed to all users
* RevisionRecord::FOR_THIS_USER to be displayed to the given user
* RevisionRecord::RAW get the text regardless of permissions
* @param Authority|null $performer object to check for, only if FOR_THIS_USER is passed
* to the $audience parameter
* @return Content|null The content of the current revision
*
* @since 1.21
*/
public function getContent( $audience = RevisionRecord::FOR_PUBLIC, Authority $performer = null ) {
$this->loadLastEdit();
if ( $this->mLastRevision ) {
return $this->mLastRevision->getContent( SlotRecord::MAIN, $audience, $performer );
}
return null;
}
/**
* @return string MW timestamp of last article revision
*/
public function getTimestamp() {
// Check if the field has been filled by WikiPage::setTimestamp()
if ( !$this->mTimestamp ) {
$this->loadLastEdit();
}
return MWTimestamp::convert( TS_MW, $this->mTimestamp );
}
/**
* Set the page timestamp (use only to avoid DB queries)
* @param string $ts MW timestamp of last article revision
* @return void
*/
public function setTimestamp( $ts ) {
$this->mTimestamp = MWTimestamp::convert( TS_MW, $ts );
}
/**
* @param int $audience One of:
* RevisionRecord::FOR_PUBLIC to be displayed to all users
* RevisionRecord::FOR_THIS_USER to be displayed to the given user
* RevisionRecord::RAW get the text regardless of permissions
* @param Authority|null $performer object to check for, only if FOR_THIS_USER is passed
* to the $audience parameter (since 1.36, if using FOR_THIS_USER and not specifying
* a user no fallback is provided and the RevisionRecord method will throw an error)
* @return int User ID for the user that made the last article revision
*/
public function getUser( $audience = RevisionRecord::FOR_PUBLIC, Authority $performer = null ) {
$this->loadLastEdit();
if ( $this->mLastRevision ) {
$revUser = $this->mLastRevision->getUser( $audience, $performer );
return $revUser ? $revUser->getId() : 0;
} else {
return -1;
}
}
/**
* Get the User object of the user who created the page
* @param int $audience One of:
* RevisionRecord::FOR_PUBLIC to be displayed to all users
* RevisionRecord::FOR_THIS_USER to be displayed to the given user
* RevisionRecord::RAW get the text regardless of permissions
* @param Authority|null $performer object to check for, only if FOR_THIS_USER is passed
* to the $audience parameter (since 1.36, if using FOR_THIS_USER and not specifying
* a user no fallback is provided and the RevisionRecord method will throw an error)
* @return UserIdentity|null
*/
public function getCreator( $audience = RevisionRecord::FOR_PUBLIC, Authority $performer = null ) {
$revRecord = $this->getRevisionStore()->getFirstRevision( $this->getTitle() );
if ( $revRecord ) {
return $revRecord->getUser( $audience, $performer );
} else {
return null;
}
}
/**
* @param int $audience One of:
* RevisionRecord::FOR_PUBLIC to be displayed to all users
* RevisionRecord::FOR_THIS_USER to be displayed to the given user
* RevisionRecord::RAW get the text regardless of permissions
* @param Authority|null $performer object to check for, only if FOR_THIS_USER is passed
* to the $audience parameter (since 1.36, if using FOR_THIS_USER and not specifying
* a user no fallback is provided and the RevisionRecord method will throw an error)
* @return string Username of the user that made the last article revision
*/
public function getUserText( $audience = RevisionRecord::FOR_PUBLIC, Authority $performer = null ) {
$this->loadLastEdit();
if ( $this->mLastRevision ) {
$revUser = $this->mLastRevision->getUser( $audience, $performer );
return $revUser ? $revUser->getName() : '';
} else {
return '';
}
}
/**
* @param int $audience One of:
* RevisionRecord::FOR_PUBLIC to be displayed to all users
* RevisionRecord::FOR_THIS_USER to be displayed to the given user
* RevisionRecord::RAW get the text regardless of permissions
* @param Authority|null $performer object to check for, only if FOR_THIS_USER is passed
* to the $audience parameter (since 1.36, if using FOR_THIS_USER and not specifying
* a user no fallback is provided and the RevisionRecord method will throw an error)
* @return string|null Comment stored for the last article revision, or null if the specified
* audience does not have access to the comment.
*/
public function getComment( $audience = RevisionRecord::FOR_PUBLIC, Authority $performer = null ) {
$this->loadLastEdit();
if ( $this->mLastRevision ) {
$revComment = $this->mLastRevision->getComment( $audience, $performer );
return $revComment ? $revComment->text : '';
} else {
return '';
}
}
/**
* Returns true if last revision was marked as "minor edit"
*
* @return bool Minor edit indicator for the last article revision.
*/
public function getMinorEdit() {
$this->loadLastEdit();
if ( $this->mLastRevision ) {
return $this->mLastRevision->isMinor();
} else {
return false;
}
}
/**
* Determine whether a page would be suitable for being counted as an
* article in the site_stats table based on the title & its content
*
* @param PreparedEdit|bool $editInfo (false): object returned by prepareTextForEdit(),
* if false, the current database state will be used
* @return bool
*/
public function isCountable( $editInfo = false ) {
global $wgArticleCountMethod;
// NOTE: Keep in sync with DerivedPageDataUpdater::isCountable.
if ( !$this->mTitle->isContentPage() ) {
return false;
}
if ( $editInfo ) {
// NOTE: only the main slot can make a page a redirect
$content = $editInfo->pstContent;
} else {
$content = $this->getContent();
}
if ( !$content || $content->isRedirect() ) {
return false;
}
$hasLinks = null;
if ( $wgArticleCountMethod === 'link' ) {
// nasty special case to avoid re-parsing to detect links
if ( $editInfo ) {
// ParserOutput::getLinks() is a 2D array of page links, so
// to be really correct we would need to recurse in the array
// but the main array should only have items in it if there are
// links.
$hasLinks = (bool)count( $editInfo->output->getLinks() );
} else {
// NOTE: keep in sync with RevisionRenderer::getLinkCount
// NOTE: keep in sync with DerivedPageDataUpdater::isCountable
$hasLinks = (bool)wfGetDB( DB_REPLICA )->selectField( 'pagelinks', '1',
[ 'pl_from' => $this->getId() ], __METHOD__ );
}
}
// TODO: MCR: determine $hasLinks for each slot, and use that info
// with that slot's Content's isCountable method. That requires per-
// slot ParserOutput in the ParserCache, or per-slot info in the
// pagelinks table.
return $content->isCountable( $hasLinks );
}
/**
* If this page is a redirect, get its target
*
* The target will be fetched from the redirect table if possible.
* If this page doesn't have an entry there, call insertRedirect()
*
* @return Title|null Title object, or null if this page is not a redirect
*/
public function getRedirectTarget() {
if ( $this->mRedirectTarget !== null ) {
return $this->mRedirectTarget;
}
if ( $this->mHasRedirectTarget === false || !$this->getPageIsRedirectField() ) {
return null;
}
// Query the redirect table
$dbr = wfGetDB( DB_REPLICA );
$row = $dbr->selectRow( 'redirect',
[ 'rd_namespace', 'rd_title', 'rd_fragment', 'rd_interwiki' ],
[ 'rd_from' => $this->getId() ],
__METHOD__
);
// rd_fragment and rd_interwiki were added later, populate them if empty
if ( $row && $row->rd_fragment !== null && $row->rd_interwiki !== null ) {
// (T203942) We can't redirect to Media namespace because it's virtual.
// We don't want to modify Title objects farther down the
// line. So, let's fix this here by changing to File namespace.
if ( $row->rd_namespace == NS_MEDIA ) {
$namespace = NS_FILE;
} else {
$namespace = $row->rd_namespace;
}
// T261347: be defensive when fetching data from the redirect table.
// Use Title::makeTitleSafe(), and if that returns null, ignore the
// row. In an ideal world, the DB would be cleaned up after a
// namespace change, but nobody could be bothered to do that.
$this->mRedirectTarget = Title::makeTitleSafe(
$namespace, $row->rd_title,
$row->rd_fragment, $row->rd_interwiki
);
$this->mHasRedirectTarget = $this->mRedirectTarget !== null;
return $this->mRedirectTarget;
}
// This page doesn't have an entry in the redirect table
$this->mRedirectTarget = $this->insertRedirect();
$this->mHasRedirectTarget = $this->mRedirectTarget !== null;
return $this->mRedirectTarget;
}
/**
* Insert an entry for this page into the redirect table if the content is a redirect
*
* The database update will be deferred via DeferredUpdates
*
* Don't call this function directly unless you know what you're doing.
* @return Title|null Title object or null if not a redirect
*/
public function insertRedirect() {
$content = $this->getContent();
$retval = $content ? $content->getUltimateRedirectTarget() : null;
if ( !$retval ) {
return null;
}
// Update the DB post-send if the page has not cached since now
$latest = $this->getLatest();
DeferredUpdates::addCallableUpdate(
function () use ( $retval, $latest ) {
$this->insertRedirectEntry( $retval, $latest );
},
DeferredUpdates::POSTSEND,
wfGetDB( DB_PRIMARY )
);
return $retval;
}
/**
* Insert or update the redirect table entry for this page to indicate it redirects to $rt
* @param Title $rt Redirect target
* @param int|null $oldLatest Prior page_latest for check and set
* @return bool Success
*/
public function insertRedirectEntry( Title $rt, $oldLatest = null ) {
if ( !$rt->isValidRedirectTarget() ) {
// Don't put a bad redirect into the database (T278367)
return false;
}
$dbw = wfGetDB( DB_PRIMARY );
$dbw->startAtomic( __METHOD__ );
if ( !$oldLatest || $oldLatest == $this->lockAndGetLatest() ) {
$contLang = MediaWikiServices::getInstance()->getContentLanguage();
$truncatedFragment = $contLang->truncateForDatabase( $rt->getFragment(), 255 );
$dbw->upsert(
'redirect',
[
'rd_from' => $this->getId(),
'rd_namespace' => $rt->getNamespace(),
'rd_title' => $rt->getDBkey(),
'rd_fragment' => $truncatedFragment,
'rd_interwiki' => $rt->getInterwiki(),
],
'rd_from',
[
'rd_namespace' => $rt->getNamespace(),
'rd_title' => $rt->getDBkey(),
'rd_fragment' => $truncatedFragment,
'rd_interwiki' => $rt->getInterwiki(),
],
__METHOD__
);
$success = true;
} else {
$success = false;
}
$dbw->endAtomic( __METHOD__ );
return $success;
}
/**
* Get the Title object or URL this page redirects to
*
* @return bool|Title|string False, Title of in-wiki target, or string with URL
*/
public function followRedirect() {
return $this->getRedirectURL( $this->getRedirectTarget() );
}
/**
* Get the Title object or URL to use for a redirect. We use Title
* objects for same-wiki, non-special redirects and URLs for everything
* else.
* @param Title $rt Redirect target
* @return bool|Title|string False, Title object of local target, or string with URL
*/
public function getRedirectURL( $rt ) {
if ( !$rt ) {
return false;
}
if ( $rt->isExternal() ) {
if ( $rt->isLocal() ) {
// Offsite wikis need an HTTP redirect.
// This can be hard to reverse and may produce loops,
// so they may be disabled in the site configuration.
$source = $this->mTitle->getFullURL( 'redirect=no' );
return $rt->getFullURL( [ 'rdfrom' => $source ] );
} else {
// External pages without "local" bit set are not valid
// redirect targets
return false;
}
}
if ( $rt->isSpecialPage() ) {
// Gotta handle redirects to special pages differently:
// Fill the HTTP response "Location" header and ignore the rest of the page we're on.
// Some pages are not valid targets.
if ( $rt->isValidRedirectTarget() ) {
return $rt->getFullURL();
} else {
return false;
}
} elseif ( !$rt->isValidRedirectTarget() ) {
// We somehow got a bad redirect target into the database (T278367)
return false;
}
return $rt;
}
/**
* Get a list of users who have edited this article, not including the user who made
* the most recent revision, which you can get from $article->getUser() if you want it
* @return UserArrayFromResult
*/
public function getContributors() {
// @todo: This is expensive; cache this info somewhere.
$dbr = wfGetDB( DB_REPLICA );
$actorMigration = ActorMigration::newMigration();
$actorQuery = $actorMigration->getJoin( 'rev_user' );
$tables = array_merge( [ 'revision' ], $actorQuery['tables'], [ 'user' ] );
$revactor_actor = $actorQuery['fields']['rev_actor'];
$fields = [
'user_id' => $actorQuery['fields']['rev_user'],
'user_name' => $actorQuery['fields']['rev_user_text'],
'actor_id' => "MIN($revactor_actor)",
'user_real_name' => 'MIN(user_real_name)',
'timestamp' => 'MAX(rev_timestamp)',
];
$conds = [ 'rev_page' => $this->getId() ];
// The user who made the top revision gets credited as "this page was last edited by
// John, based on contributions by Tom, Dick and Harry", so don't include them twice.
$user = $this->getUser()
? User::newFromId( $this->getUser() )
: User::newFromName( $this->getUserText(), false );
$conds[] = 'NOT(' . $actorMigration->getWhere( $dbr, 'rev_user', $user )['conds'] . ')';
// Username hidden?
$conds[] = "{$dbr->bitAnd( 'rev_deleted', RevisionRecord::DELETED_USER )} = 0";
$jconds = [
'user' => [ 'LEFT JOIN', $actorQuery['fields']['rev_user'] . ' = user_id' ],
] + $actorQuery['joins'];
$options = [
'GROUP BY' => [ $fields['user_id'], $fields['user_name'] ],
'ORDER BY' => 'timestamp DESC',
];
$res = $dbr->select( $tables, $fields, $conds, __METHOD__, $options, $jconds );
return new UserArrayFromResult( $res );
}
/**
* Should the parser cache be used?
*
* @param ParserOptions $parserOptions ParserOptions to check
* @param int $oldId
* @return bool
*/
public function shouldCheckParserCache( ParserOptions $parserOptions, $oldId ) {
// NOTE: Keep in sync with ParserOutputAccess::shouldUseCache().
// TODO: Once ParserOutputAccess is stable, deprecated this method.
return $this->exists()
&& ( $oldId === null || $oldId === 0 || $oldId === $this->getLatest() )
&& $this->getContentHandler()->isParserCacheSupported();
}
/**
* Get a ParserOutput for the given ParserOptions and revision ID.
*
* The parser cache will be used if possible. Cache misses that result
* in parser runs are debounced with PoolCounter.
*
* XXX merge this with updateParserCache()?
*
* @since 1.19
* @param ParserOptions $parserOptions ParserOptions to use for the parse operation
* @param null|int $oldid Revision ID to get the text from, passing null or 0 will
* get the current revision (default value)
* @param bool $noCache Do not read from or write to caches.
* @return bool|ParserOutput ParserOutput or false if the revision was not found or is not public
*/
public function getParserOutput(
ParserOptions $parserOptions, $oldid = null, $noCache = false
) {
if ( $oldid ) {
$revision = $this->getRevisionStore()->getRevisionByTitle( $this->getTitle(), $oldid );
if ( !$revision ) {
return false;
}
} else {
$revision = $this->getRevisionRecord();
}
$options = $noCache ? ParserOutputAccess::OPT_NO_CACHE : 0;
$status = MediaWikiServices::getInstance()->getParserOutputAccess()->getParserOutput(
$this, $parserOptions, $revision, $options
);
return $status->isOK() ? $status->getValue() : false; // convert null to false
}
/**
* Do standard deferred updates after page view (existing or missing page)
* @param Authority $performer The viewing user
* @param int $oldid Revision id being viewed; if not given or 0, latest revision is assumed
*/
public function doViewUpdates( Authority $performer, $oldid = 0 ) {
if ( wfReadOnly() ) {
return;
}
// Update newtalk / watchlist notification status;
// Avoid outage if the master is not reachable by using a deferred updated
DeferredUpdates::addCallableUpdate(
function () use ( $performer, $oldid ) {
$legacyUser = MediaWikiServices::getInstance()
->getUserFactory()
->newFromAuthority( $performer );
$this->getHookRunner()->onPageViewUpdates( $this, $legacyUser );
MediaWikiServices::getInstance()
->getWatchlistManager()
->clearTitleUserNotifications( $performer, $this, $oldid );
},
DeferredUpdates::PRESEND
);
}
/**
* Perform the actions of a page purging
* @return bool
* @note In 1.28 (and only 1.28), this took a $flags parameter that
* controlled how much purging was done.
*/
public function doPurge() {
if ( !$this->getHookRunner()->onArticlePurge( $this ) ) {
return false;
}
$this->mTitle->invalidateCache();
// Clear file cache and send purge after above page_touched update was committed
$hcu = MediaWikiServices::getInstance()->getHtmlCacheUpdater();
$hcu->purgeTitleUrls( $this->mTitle, $hcu::PURGE_PRESEND );
if ( $this->mTitle->getNamespace() === NS_MEDIAWIKI ) {
MediaWikiServices::getInstance()->getMessageCache()
->updateMessageOverride( $this->mTitle, $this->getContent() );
}
return true;
}
/**
* Insert a new empty page record for this article.
* This *must* be followed up by creating a revision
* and running $this->updateRevisionOn( ... );
* or else the record will be left in a funky state.
* Best if all done inside a transaction.
*
* @todo Factor out into a PageStore service, to be used by PageUpdater.
*
* @param IDatabase $dbw
* @param int|null $pageId Custom page ID that will be used for the insert statement
*
* @return bool|int The newly created page_id key; false if the row was not
* inserted, e.g. because the title already existed or because the specified
* page ID is already in use.
*/
public function insertOn( $dbw, $pageId = null ) {
$this->assertProperPage();
$pageIdForInsert = $pageId ? [ 'page_id' => $pageId ] : [];
$dbw->insert(
'page',
[
'page_namespace' => $this->mTitle->getNamespace(),
'page_title' => $this->mTitle->getDBkey(),
'page_restrictions' => '',
'page_is_redirect' => 0, // Will set this shortly...
'page_is_new' => 1,
'page_random' => wfRandom(),
'page_touched' => $dbw->timestamp(),
'page_latest' => 0, // Fill this in shortly...
'page_len' => 0, // Fill this in shortly...
] + $pageIdForInsert,
__METHOD__,
[ 'IGNORE' ]
);
if ( $dbw->affectedRows() > 0 ) {
$newid = $pageId ? (int)$pageId : $dbw->insertId();
$this->mId = $newid;
$this->mTitle->resetArticleID( $newid );
return $newid;
} else {
return false; // nothing changed
}
}
/**
* Update the page record to point to a newly saved revision.
*
* @todo Factor out into a PageStore service, or move into PageUpdater.
*
* @param IDatabase $dbw
* @param RevisionRecord $revision For ID number, and text used to set
* length and redirect status fields.
* @param int|null $lastRevision If given, will not overwrite the page field
* when different from the currently set value.
* Giving 0 indicates the new page flag should be set on.
* @param bool|null $lastRevIsRedirect If given, will optimize adding and
* removing rows in redirect table.
* @return bool Success; false if the page row was missing or page_latest changed
*/
public function updateRevisionOn(
$dbw,
RevisionRecord $revision,
$lastRevision = null,
$lastRevIsRedirect = null
) {
// TODO: move into PageUpdater or PageStore
// NOTE: when doing that, make sure cached fields get reset in doEditContent,
// and in the compat stub!
// Assertion to try to catch T92046
if ( (int)$revision->getId() === 0 ) {
throw new InvalidArgumentException(
__METHOD__ . ': revision has ID ' . var_export( $revision->getId(), 1 )
);
}
$content = $revision->getContent( SlotRecord::MAIN );
$len = $content ? $content->getSize() : 0;
$rt = $content ? $content->getUltimateRedirectTarget() : null;
$isNew = ( $lastRevision === 0 ) ? 1 : 0;
$isRedirect = $rt !== null ? 1 : 0;
$conditions = [ 'page_id' => $this->getId() ];
if ( $lastRevision !== null ) {
// An extra check against threads stepping on each other
$conditions['page_latest'] = $lastRevision;
}
$revId = $revision->getId();
Assert::parameter( $revId > 0, '$revision->getId()', 'must be > 0' );
$model = $revision->getSlot( SlotRecord::MAIN, RevisionRecord::RAW )->getModel();
$row = [ /* SET */
'page_latest' => $revId,
'page_touched' => $dbw->timestamp( $revision->getTimestamp() ),
'page_is_new' => $isNew,
'page_is_redirect' => $isRedirect,
'page_len' => $len,
'page_content_model' => $model,
];
$dbw->update( 'page',
$row,
$conditions,
__METHOD__ );
$result = $dbw->affectedRows() > 0;
if ( $result ) {
$this->mTitle->loadFromRow( (object)$row );
$this->updateRedirectOn( $dbw, $rt, $lastRevIsRedirect );
$this->setLastEdit( $revision );
$this->mRedirectTarget = null;
$this->mHasRedirectTarget = null;
$this->mPageIsRedirectField = (bool)$rt;
$this->mIsNew = (bool)$isNew;
$this->mIsRedirect = (bool)$isRedirect;
// Update the LinkCache.
$linkCache = MediaWikiServices::getInstance()->getLinkCache();
$linkCache->addGoodLinkObj(
$this->getId(),
$this->mTitle,
$len,
$this->mPageIsRedirectField,
$this->mLatest,
$model
);
}
return $result;
}
/**
* Add row to the redirect table if this is a redirect, remove otherwise.
*
* @param IDatabase $dbw
* @param Title|null $redirectTitle Title object pointing to the redirect target,
* or NULL if this is not a redirect
* @param null|bool $lastRevIsRedirect If given, will optimize adding and
* removing rows in redirect table.
* @return bool True on success, false on failure
* @internal
*/
public function updateRedirectOn( $dbw, $redirectTitle, $lastRevIsRedirect = null ) {
// Always update redirects (target link might have changed)
// Update/Insert if we don't know if the last revision was a redirect or not
// Delete if changing from redirect to non-redirect
$isRedirect = $redirectTitle !== null;
if ( !$isRedirect && $lastRevIsRedirect === false ) {
return true;
}
if ( $isRedirect ) {
$success = $this->insertRedirectEntry( $redirectTitle );
} else {
// This is not a redirect, remove row from redirect table
$where = [ 'rd_from' => $this->getId() ];
$dbw->delete( 'redirect', $where, __METHOD__ );
$success = true;
}
if ( $this->getTitle()->getNamespace() === NS_FILE ) {
MediaWikiServices::getInstance()->getRepoGroup()->getLocalRepo()
->invalidateImageRedirect( $this->getTitle() );
}
return $success;
}
/**
* Helper method for checking whether two revisions have differences that go
* beyond the main slot.
*
* MCR migration note: this method should go away!
*
* @deprecated Use only as a stop-gap before refactoring to support MCR.
*
* @param RevisionRecord $a
* @param RevisionRecord $b
* @return bool
*/
public static function hasDifferencesOutsideMainSlot( RevisionRecord $a, RevisionRecord $b ) {
$aSlots = $a->getSlots();
$bSlots = $b->getSlots();
$changedRoles = $aSlots->getRolesWithDifferentContent( $bSlots );
return ( $changedRoles !== [ SlotRecord::MAIN ] && $changedRoles !== [] );
}
/**
* Returns true if this page's content model supports sections.
*
* @return bool
*
* @todo The skin should check this and not offer section functionality if
* sections are not supported.
* @todo The EditPage should check this and not offer section functionality
* if sections are not supported.
*/
public function supportsSections() {
return $this->getContentHandler()->supportsSections();
}
/**
* @param string|int|null|bool $sectionId Section identifier as a number or string
* (e.g. 0, 1 or 'T-1'), null/false or an empty string for the whole page
* or 'new' for a new section.
* @param Content $sectionContent New content of the section.
* @param string $sectionTitle New section's subject, only if $section is "new".
* @param string $edittime Revision timestamp or null to use the current revision.
*
* @throws MWException
* @return Content|null New complete article content, or null if error.
*
* @since 1.21
* @deprecated since 1.24, use replaceSectionAtRev instead
*/
public function replaceSectionContent(
$sectionId, Content $sectionContent, $sectionTitle = '', $edittime = null
) {
$baseRevId = null;
if ( $edittime && $sectionId !== 'new' ) {
$lb = $this->getDBLoadBalancer();
$rev = $this->getRevisionStore()->getRevisionByTimestamp( $this->mTitle, $edittime );
// Try the primary database if this thread may have just added it.
// The logic to fallback to the primary database if the replica is missing
// the revision could be generalized into RevisionStore, but we don't want
// to encourage loading of revisions by timestamp.
if ( !$rev
&& $lb->getServerCount() > 1
&& $lb->hasOrMadeRecentMasterChanges()
) {
$rev = $this->getRevisionStore()->getRevisionByTimestamp(
$this->mTitle, $edittime, RevisionStore::READ_LATEST );
}
if ( $rev ) {
$baseRevId = $rev->getId();
}
}
return $this->replaceSectionAtRev( $sectionId, $sectionContent, $sectionTitle, $baseRevId );
}
/**
* @param string|int|null|bool $sectionId Section identifier as a number or string
* (e.g. 0, 1 or 'T-1'), null/false or an empty string for the whole page
* or 'new' for a new section.
* @param Content $sectionContent New content of the section.
* @param string $sectionTitle New section's subject, only if $section is "new".
* @param int|null $baseRevId
*
* @throws MWException
* @return Content|null New complete article content, or null if error.
*
* @since 1.24
*/
public function replaceSectionAtRev( $sectionId, Content $sectionContent,
$sectionTitle = '', $baseRevId = null
) {
if ( strval( $sectionId ) === '' ) {
// Whole-page edit; let the whole text through
$newContent = $sectionContent;
} else {
if ( !$this->supportsSections() ) {
throw new MWException( "sections not supported for content model " .
$this->getContentHandler()->getModelID() );
}
// T32711: always use current version when adding a new section
if ( $baseRevId === null || $sectionId === 'new' ) {
$oldContent = $this->getContent();
} else {
$revRecord = $this->getRevisionStore()->getRevisionById( $baseRevId );
if ( !$revRecord ) {
wfDebug( __METHOD__ . " asked for bogus section (page: " .
$this->getId() . "; section: $sectionId)" );
return null;
}
$oldContent = $revRecord->getContent( SlotRecord::MAIN );
}
if ( !$oldContent ) {
wfDebug( __METHOD__ . ": no page text" );
return null;
}
$newContent = $oldContent->replaceSection( $sectionId, $sectionContent, $sectionTitle );
}
return $newContent;
}
/**
* Check flags and add EDIT_NEW or EDIT_UPDATE to them as needed.
*
* @deprecated since 1.32, use exists() instead, or simply omit the EDIT_UPDATE
* and EDIT_NEW flags. To protect against race conditions, use PageUpdater::grabParentRevision.
*
* @param int $flags
* @return int Updated $flags
*/
public function checkFlags( $flags ) {
if ( !( $flags & EDIT_NEW ) && !( $flags & EDIT_UPDATE ) ) {
if ( $this->exists() ) {
$flags |= EDIT_UPDATE;
} else {
$flags |= EDIT_NEW;
}
}
return $flags;
}
/**
* @return DerivedPageDataUpdater
*/
private function newDerivedDataUpdater() {
global $wgRCWatchCategoryMembership, $wgArticleCountMethod;
$services = MediaWikiServices::getInstance();
$editResultCache = new EditResultCache(
$services->getMainObjectStash(),
$services->getDBLoadBalancer(),
new ServiceOptions(
EditResultCache::CONSTRUCTOR_OPTIONS,
$services->getMainConfig()
)
);
$derivedDataUpdater = new DerivedPageDataUpdater(
$this, // NOTE: eventually, PageUpdater should not know about WikiPage
$this->getRevisionStore(),
$services->getRevisionRenderer(),
$this->getSlotRoleRegistry(),
$services->getParserCache(),
JobQueueGroup::singleton(),
$services->getMessageCache(),
$services->getContentLanguage(),
$services->getDBLoadBalancerFactory(),
$this->getContentHandlerFactory(),
$this->getHookContainer(),
$editResultCache,
$services->getUserNameUtils()
);
$derivedDataUpdater->setLogger( LoggerFactory::getInstance( 'SaveParse' ) );
$derivedDataUpdater->setRcWatchCategoryMembership( $wgRCWatchCategoryMembership );
$derivedDataUpdater->setArticleCountMethod( $wgArticleCountMethod );
return $derivedDataUpdater;
}
/**
* Returns a DerivedPageDataUpdater for use with the given target revision or new content.
* This method attempts to re-use the same DerivedPageDataUpdater instance for subsequent calls.
* The parameters passed to this method are used to ensure that the DerivedPageDataUpdater
* returned matches that caller's expectations, allowing an existing instance to be re-used
* if the given parameters match that instance's internal state according to
* DerivedPageDataUpdater::isReusableFor(), and creating a new instance of the parameters do not
* match the existign one.
*
* If neither $forRevision nor $forUpdate is given, a new DerivedPageDataUpdater is always
* created, replacing any DerivedPageDataUpdater currently cached.
*
* MCR migration note: this replaces WikiPage::prepareContentForEdit.
*
* @since 1.32
*
* @param UserIdentity|null $forUser The user that will be used for, or was used for, PST.
* @param RevisionRecord|null $forRevision The revision created by the edit for which
* to perform updates, if the edit was already saved.
* @param RevisionSlotsUpdate|null $forUpdate The new content to be saved by the edit (pre PST),
* if the edit was not yet saved.
* @param bool $forEdit Only re-use if the cached DerivedPageDataUpdater has the current
* revision as the edit's parent revision. This ensures that the same
* DerivedPageDataUpdater cannot be re-used for two consecutive edits.
*
* @return DerivedPageDataUpdater
*/
private function getDerivedDataUpdater(
UserIdentity $forUser = null,
RevisionRecord $forRevision = null,
RevisionSlotsUpdate $forUpdate = null,
$forEdit = false
) {
if ( !$forRevision && !$forUpdate ) {
// NOTE: can't re-use an existing derivedDataUpdater if we don't know what the caller is
// going to use it with.
$this->derivedDataUpdater = null;
}
if ( $this->derivedDataUpdater && !$this->derivedDataUpdater->isContentPrepared() ) {
// NOTE: can't re-use an existing derivedDataUpdater if other code that has a reference
// to it did not yet initialize it, because we don't know what data it will be
// initialized with.
$this->derivedDataUpdater = null;
}
// XXX: It would be nice to have an LRU cache instead of trying to re-use a single instance.
// However, there is no good way to construct a cache key. We'd need to check against all
// cached instances.
if ( $this->derivedDataUpdater
&& !$this->derivedDataUpdater->isReusableFor(
$forUser,
$forRevision,
$forUpdate,
$forEdit ? $this->getLatest() : null
)
) {
$this->derivedDataUpdater = null;
}
if ( !$this->derivedDataUpdater ) {
$this->derivedDataUpdater = $this->newDerivedDataUpdater();
}
return $this->derivedDataUpdater;
}
/**
* Returns a PageUpdater for creating new revisions on this page (or creating the page).
*
* The PageUpdater can also be used to detect the need for edit conflict resolution,
* and to protected such conflict resolution from concurrent edits using a check-and-set
* mechanism.
*
* @since 1.32
*
* @param Authority $performer
* @param RevisionSlotsUpdate|null $forUpdate If given, allows any cached ParserOutput
* that may already have been returned via getDerivedDataUpdater to be re-used.
*
* @return PageUpdater
*/
public function newPageUpdater( Authority $performer, RevisionSlotsUpdate $forUpdate = null ) {
$this->assertProperPage();
$mwServices = MediaWikiServices::getInstance();
$config = $mwServices->getMainConfig();
$pageUpdater = new PageUpdater(
$performer,
$this, // NOTE: eventually, PageUpdater should not know about WikiPage
$this->getDerivedDataUpdater( $performer->getUser(), null, $forUpdate, true ),
$this->getDBLoadBalancer(),
$this->getRevisionStore(),
$this->getSlotRoleRegistry(),
$this->getContentHandlerFactory(),
$this->getHookContainer(),
$mwServices->getUserEditTracker(),
$mwServices->getUserGroupManager(),
new ServiceOptions(
PageUpdater::CONSTRUCTOR_OPTIONS,
$config
),
ChangeTags::getSoftwareTags()
);
$pageUpdater->setUsePageCreationLog( $config->get( 'PageCreationLog' ) );
$pageUpdater->setAjaxEditStash( $config->get( 'AjaxEditStash' ) );
$pageUpdater->setUseAutomaticEditSummaries(
$config->get( 'UseAutomaticEditSummaries' )
);
return $pageUpdater;
}
/**
* Change an existing article or create a new article. Updates RC and all necessary caches,
* optionally via the deferred update array.
*
* @deprecated since 1.32, use PageUpdater::saveRevision instead. Note that the new method
* expects callers to take care of checking EDIT_MINOR against the minoredit right, and to
* apply the autopatrol right as appropriate.
* @note since 1.36 ::doUserEditContent is available as an interim replacement
*
* @param Content $content New content
* @param string|CommentStoreComment $summary Edit summary
* @param int $flags Bitfield:
* EDIT_NEW
* Article is known or assumed to be non-existent, create a new one
* EDIT_UPDATE
* Article is known or assumed to be pre-existing, update it
* EDIT_MINOR
* Mark this edit minor, if the user is allowed to do so
* EDIT_SUPPRESS_RC
* Do not log the change in recentchanges
* EDIT_FORCE_BOT
* Mark the edit a "bot" edit regardless of user rights
* EDIT_AUTOSUMMARY
* Fill in blank summaries with generated text where possible
* EDIT_INTERNAL
* Signal that the page retrieve/save cycle happened entirely in this request.
*
* If neither EDIT_NEW nor EDIT_UPDATE is specified, the status of the
* article will be detected. If EDIT_UPDATE is specified and the article
* doesn't exist, the function will return an edit-gone-missing error. If
* EDIT_NEW is specified and the article does exist, an edit-already-exists
* error will be returned. These two conditions are also possible with
* auto-detection due to MediaWiki's performance-optimised locking strategy.
*
* @param bool|int $originalRevId: The ID of an original revision that the edit
* restores or repeats. This is used with reverts and with dummy "null" revisions
* which are created to record things like page moves. The new revision does not
* have to have the exact same content as the given original revision, an additional
* check is made to determine whether these edits really match. In case they don't,
* $originalRevId is set to false by this method.
* @param Authority|null $performer The user doing the edit
* @param string|null $serialFormat IGNORED.
* @param array|null $tags Change tags to apply to this edit
* Callers are responsible for permission checks
* (with ChangeTags::canAddTagsAccompanyingChange)
* @param int $undidRevId Id of the last revision that was undone or 0
*
* @throws MWException
* @return Status Possible errors:
* edit-hook-aborted: The ArticleSave hook aborted the edit but didn't
* set the fatal flag of $status.
* edit-gone-missing: In update mode, but the article didn't exist.
* edit-conflict: In update mode, the article changed unexpectedly.
* edit-no-change: Warning that the text was the same as before.
* edit-already-exists: In creation mode, but the article already exists.
*
* Extensions may define additional errors.
*
* $return->value will contain an associative array with members as follows:
* new: Boolean indicating if the function attempted to create a new article.
* revision-record: The RevisionRecord object for the inserted revision, or null.
*
* @since 1.21
* @throws MWException
*/
public function doEditContent(
Content $content, $summary, $flags = 0, $originalRevId = false,
Authority $performer = null, $serialFormat = null, $tags = [], $undidRevId = 0
) {
global $wgUser;
if ( !$performer ) {
$performer = $wgUser;
}
return $this->doUserEditContent(
$content, $performer, $summary, $flags, $originalRevId, $tags, $undidRevId
);
}
/**
* Change an existing article or create a new article. Updates RC and all necessary caches,
* optionally via the deferred update array.
*
* @deprecated since 1.36, use PageUpdater::saveRevision instead. Note that the new method
* expects callers to take care of checking EDIT_MINOR against the minoredit right, and to
* apply the autopatrol right as appropriate.
*
* @param Content $content New content
* @param Authority $performer doing the edit
* @param string|CommentStoreComment $summary Edit summary
* @param int $flags Bitfield:
* EDIT_NEW
* Article is known or assumed to be non-existent, create a new one
* EDIT_UPDATE
* Article is known or assumed to be pre-existing, update it
* EDIT_MINOR
* Mark this edit minor, if the user is allowed to do so
* EDIT_SUPPRESS_RC
* Do not log the change in recentchanges
* EDIT_FORCE_BOT
* Mark the edit a "bot" edit regardless of user rights
* EDIT_AUTOSUMMARY
* Fill in blank summaries with generated text where possible
* EDIT_INTERNAL
* Signal that the page retrieve/save cycle happened entirely in this request.
*
* If neither EDIT_NEW nor EDIT_UPDATE is specified, the status of the
* article will be detected. If EDIT_UPDATE is specified and the article
* doesn't exist, the function will return an edit-gone-missing error. If
* EDIT_NEW is specified and the article does exist, an edit-already-exists
* error will be returned. These two conditions are also possible with
* auto-detection due to MediaWiki's performance-optimised locking strategy.
*
* @param bool|int $originalRevId: The ID of an original revision that the edit
* restores or repeats. The new revision is expected to have the exact same content as
* the given original revision. This is used with rollbacks and with dummy "null" revisions
* which are created to record things like page moves.
* @param array|null $tags Change tags to apply to this edit
* Callers are responsible for permission checks
* (with ChangeTags::canAddTagsAccompanyingChange)
* @param int $undidRevId Id of revision that was undone or 0
*
* @throws MWException
* @return Status Possible errors:
* edit-hook-aborted: The ArticleSave hook aborted the edit but didn't
* set the fatal flag of $status.
* edit-gone-missing: In update mode, but the article didn't exist.
* edit-conflict: In update mode, the article changed unexpectedly.
* edit-no-change: Warning that the text was the same as before.
* edit-already-exists: In creation mode, but the article already exists.
*
* Extensions may define additional errors.
*
* $return->value will contain an associative array with members as follows:
* new: Boolean indicating if the function attempted to create a new article.
* revision-record: The revision record object for the inserted revision, or null.
*
* @since 1.36
*/
public function doUserEditContent(
Content $content,
Authority $performer,
$summary,
$flags = 0,
$originalRevId = false,
$tags = [],
$undidRevId = 0
) {
global $wgUseNPPatrol, $wgUseRCPatrol;
if ( !( $summary instanceof CommentStoreComment ) ) {
$summary = CommentStoreComment::newUnsavedComment( trim( $summary ) );
}
// TODO: this check is here for backwards-compatibility with 1.31 behavior.
// Checking the minoredit right should be done in the same place the 'bot' right is
// checked for the EDIT_FORCE_BOT flag, which is currently in EditPage::attemptSave.
if ( ( $flags & EDIT_MINOR ) && !$performer->isAllowed( 'minoredit' ) ) {
$flags &= ~EDIT_MINOR;
}
$slotsUpdate = new RevisionSlotsUpdate();
$slotsUpdate->modifyContent( SlotRecord::MAIN, $content );
// NOTE: while doUserEditContent() executes, callbacks to getDerivedDataUpdater and
// prepareContentForEdit will generally use the DerivedPageDataUpdater that is also
// used by this PageUpdater. However, there is no guarantee for this.
$updater = $this->newPageUpdater( $performer, $slotsUpdate );
$updater->setContent( SlotRecord::MAIN, $content );
$revisionStore = $this->getRevisionStore();
$originalRevision = $originalRevId ? $revisionStore->getRevisionById( $originalRevId ) : null;
if ( $originalRevision && $undidRevId !== 0 ) {
// Mark it as a revert if it's an undo
$oldestRevertedRev = $revisionStore->getNextRevision( $originalRevision );
if ( $oldestRevertedRev ) {
$updater->markAsRevert(
EditResult::REVERT_UNDO,
$oldestRevertedRev->getId(),
$undidRevId
);
} else {
// We can't find the oldest reverted revision for some reason
$updater->markAsRevert( EditResult::REVERT_UNDO, $undidRevId );
}
} elseif ( $undidRevId !== 0 ) {
// It's an undo, but the original revision is not specified, fall back to just
// marking it as an undo with one revision undone.
$updater->markAsRevert( EditResult::REVERT_UNDO, $undidRevId );
// Try finding the original revision ID by assuming it's the one before the edit
// that is being undone. If the bet fails, $originalRevision is ignored anyway, so
// no damage is done.
$undidRevision = $revisionStore->getRevisionById( $undidRevId );
if ( $undidRevision ) {
$originalRevision = $revisionStore->getPreviousRevision( $undidRevision );
}
}
// Make sure original revision's content is the same as the new content and save the
// original revision ID.
if ( $originalRevision &&
$originalRevision->getContent( SlotRecord::MAIN )->equals( $content )
) {
$updater->setOriginalRevisionId( $originalRevision->getId() );
}
$needsPatrol = $wgUseRCPatrol || ( $wgUseNPPatrol && !$this->exists() );
// TODO: this logic should not be in the storage layer, it's here for compatibility
// with 1.31 behavior. Applying the 'autopatrol' right should be done in the same
// place the 'bot' right is handled, which is currently in EditPage::attemptSave.
if ( $needsPatrol && $performer->authorizeWrite( 'autopatrol', $this->getTitle() ) ) {
$updater->setRcPatrolStatus( RecentChange::PRC_AUTOPATROLLED );
}
$updater->addTags( $tags );
$revRec = $updater->saveRevision(
$summary,
$flags
);
// $revRec will be null if the edit failed, or if no new revision was created because
// the content did not change.
if ( $revRec ) {
// update cached fields
// TODO: this is currently redundant to what is done in updateRevisionOn.
// But updateRevisionOn() should move into PageStore, and then this will be needed.
$this->setLastEdit( $revRec );
}
return $updater->getStatus();
}
/**
* Get parser options suitable for rendering the primary article wikitext
*
* @see ParserOptions::newCanonical
*
* @param IContextSource|UserIdentity|string $context One of the following:
* - IContextSource: Use the User and the Language of the provided
* context
* - UserIdentity: Use the provided UserIdentity object and $wgLang
* for the language, so use an IContextSource object if possible.
* - 'canonical': Canonical options (anonymous user with default
* preferences and content language).
* @return ParserOptions
*/
public function makeParserOptions( $context ) {
$options = ParserOptions::newCanonical( $context );
if ( $this->getTitle()->isConversionTable() ) {
// @todo ConversionTable should become a separate content model, so
// we don't need special cases like this one.
$options->disableContentConversion();
}
return $options;
}
/**
* Prepare content which is about to be saved.
*
* Prior to 1.30, this returned a stdClass.
*
* @deprecated since 1.32, use getDerivedDataUpdater instead.
* @note Calling without a UserIdentity is separately deprecated since 1.37
*
* @param Content $content
* @param RevisionRecord|null $revision
* Used with vary-revision or vary-revision-id.
* @param UserIdentity|null $user
* @param string|null $serialFormat IGNORED
* @param bool $useCache Check shared prepared edit cache
*
* @return PreparedEdit
*
* @since 1.21
*/
public function prepareContentForEdit(
Content $content,
RevisionRecord $revision = null,
UserIdentity $user = null,
$serialFormat = null,
$useCache = true
) {
if ( !$user ) {
wfDeprecated( __METHOD__ . ' without a UserIdentity', '1.37' );
global $wgUser;
$user = $wgUser;
}
$slots = RevisionSlotsUpdate::newFromContent( [ SlotRecord::MAIN => $content ] );
$updater = $this->getDerivedDataUpdater( $user, $revision, $slots );
if ( !$updater->isUpdatePrepared() ) {
$updater->prepareContent( $user, $slots, $useCache );
if ( $revision ) {
$updater->prepareUpdate(
$revision,
[
'causeAction' => 'prepare-edit',
'causeAgent' => $user->getName(),
]
);
}
}
return $updater->getPreparedEdit();
}
/**
* Do standard deferred updates after page edit.
* Update links tables, site stats, search index and message cache.
* Purges pages that include this page if the text was changed here.
* Every 100th edit, prune the recent changes table.
*
* @deprecated since 1.32 (soft), use DerivedPageDataUpdater::doUpdates instead.
*
* @param RevisionRecord $revisionRecord (Switched from the old Revision class to
* RevisionRecord since 1.35)
* @param UserIdentity $user User object that did the revision
* @param array $options Array of options, following indexes are used:
* - changed: bool, whether the revision changed the content (default true)
* - created: bool, whether the revision created the page (default false)
* - moved: bool, whether the page was moved (default false)
* - restored: bool, whether the page was undeleted (default false)
* - oldrevision: RevisionRecord object for the pre-update revision (default null)
* - oldcountable: bool, null, or string 'no-change' (default null):
* - bool: whether the page was counted as an article before that
* revision, only used in changed is true and created is false
* - null: if created is false, don't update the article count; if created
* is true, do update the article count
* - 'no-change': don't update the article count, ever
* - causeAction: an arbitrary string identifying the reason for the update.
* See DataUpdate::getCauseAction(). (default 'edit-page')
* - causeAgent: name of the user who caused the update. See DataUpdate::getCauseAgent().
* (string, defaults to the passed user)
*/
public function doEditUpdates(
RevisionRecord $revisionRecord,
UserIdentity $user,
array $options = []
) {
$options += [
'causeAction' => 'edit-page',
'causeAgent' => $user->getName(),
];
$updater = $this->getDerivedDataUpdater( $user, $revisionRecord );
$updater->prepareUpdate( $revisionRecord, $options );
$updater->doUpdates();
}
/**
* Update the parser cache.
*
* @note This is a temporary workaround until there is a proper data updater class.
* It will become deprecated soon.
*
* @param array $options
* - causeAction: an arbitrary string identifying the reason for the update.
* See DataUpdate::getCauseAction(). (default 'edit-page')
* - causeAgent: name of the user who caused the update (string, defaults to the
* user who created the revision)
* @since 1.32
*/
public function updateParserCache( array $options = [] ) {
$revision = $this->getRevisionRecord();
if ( !$revision || !$revision->getId() ) {
LoggerFactory::getInstance( 'wikipage' )->info(
__METHOD__ . 'called with ' . ( $revision ? 'unsaved' : 'no' ) . ' revision'
);
return;
}
$userIdentity = $revision->getUser( RevisionRecord::RAW );
$updater = $this->getDerivedDataUpdater( $userIdentity, $revision );
$updater->prepareUpdate( $revision, $options );
$updater->doParserCacheUpdate();
}
/**
* Do secondary data updates (such as updating link tables).
* Secondary data updates are only a small part of the updates needed after saving
* a new revision; normally PageUpdater::doUpdates should be used instead (which includes
* secondary data updates). This method is provided for partial purges.
*
* @note This is a temporary workaround until there is a proper data updater class.
* It will become deprecated soon.
*
* @param array $options
* - recursive (bool, default true): whether to do a recursive update (update pages that
* depend on this page, e.g. transclude it). This will set the $recursive parameter of
* Content::getSecondaryDataUpdates. Typically this should be true unless the update
* was something that did not really change the page, such as a null edit.
* - triggeringUser: The user triggering the update (UserIdentity, defaults to the
* user who created the revision)
* - causeAction: an arbitrary string identifying the reason for the update.
* See DataUpdate::getCauseAction(). (default 'unknown')
* - causeAgent: name of the user who caused the update (string, default 'unknown')
* - defer: one of the DeferredUpdates constants, or false to run immediately (default: false).
* Note that even when this is set to false, some updates might still get deferred (as
* some update might directly add child updates to DeferredUpdates).
* - known-revision-output: a combined canonical ParserOutput for the revision, perhaps
* from some cache. The caller is responsible for ensuring that the ParserOutput indeed
* matched the $rev and $options. This mechanism is intended as a temporary stop-gap,
* for the time until caches have been changed to store RenderedRevision states instead
* of ParserOutput objects. (default: null) (since 1.33)
* @since 1.32
*/
public function doSecondaryDataUpdates( array $options = [] ) {
$options['recursive'] = $options['recursive'] ?? true;
$revision = $this->getRevisionRecord();
if ( !$revision || !$revision->getId() ) {
LoggerFactory::getInstance( 'wikipage' )->info(
__METHOD__ . 'called with ' . ( $revision ? 'unsaved' : 'no' ) . ' revision'
);
return;
}
$userIdentity = $revision->getUser( RevisionRecord::RAW );
$updater = $this->getDerivedDataUpdater( $userIdentity, $revision );
$updater->prepareUpdate( $revision, $options );
$updater->doSecondaryDataUpdates( $options );
}
/**
* Update the article's restriction field, and leave a log entry.
* This works for protection both existing and non-existing pages.
*
* @param array $limit Set of restriction keys
* @param array $expiry Per restriction type expiration
* @param int &$cascade Set to false if cascading protection isn't allowed.
* @param string $reason
* @param UserIdentity $user The user updating the restrictions
* @param string|string[]|null $tags Change tags to add to the pages and protection log entries
* ($user should be able to add the specified tags before this is called)
* @return Status Status object; if action is taken, $status->value is the log_id of the
* protection log entry.
*/
public function doUpdateRestrictions( array $limit, array $expiry,
&$cascade, $reason, UserIdentity $user, $tags = null
) {
global $wgCascadingRestrictionLevels;
$this->assertProperPage();
if ( wfReadOnly() ) {
return Status::newFatal( wfMessage( 'readonlytext', wfReadOnlyReason() ) );
}
$this->loadPageData( 'fromdbmaster' );
$this->mTitle->loadRestrictions( null, Title::READ_LATEST );
$restrictionTypes = $this->mTitle->getRestrictionTypes();
$id = $this->getId();
if ( !$cascade ) {
$cascade = false;
}
// Take this opportunity to purge out expired restrictions
Title::purgeExpiredRestrictions();
// @todo: Same limitations as described in ProtectionForm.php (line 37);
// we expect a single selection, but the schema allows otherwise.
$isProtected = false;
$protect = false;
$changed = false;
$dbw = wfGetDB( DB_PRIMARY );
foreach ( $restrictionTypes as $action ) {
if ( !isset( $expiry[$action] ) || $expiry[$action] === $dbw->getInfinity() ) {
$expiry[$action] = 'infinity';
}
if ( !isset( $limit[$action] ) ) {
$limit[$action] = '';
} elseif ( $limit[$action] != '' ) {
$protect = true;
}
// Get current restrictions on $action
$current = implode( '', $this->mTitle->getRestrictions( $action ) );
if ( $current != '' ) {
$isProtected = true;
}
if ( $limit[$action] != $current ) {
$changed = true;
} elseif ( $limit[$action] != '' ) {
// Only check expiry change if the action is actually being
// protected, since expiry does nothing on an not-protected
// action.
if ( $this->mTitle->getRestrictionExpiry( $action ) != $expiry[$action] ) {
$changed = true;
}
}
}
if ( !$changed && $protect && $this->mTitle->areRestrictionsCascading() != $cascade ) {
$changed = true;
}
// If nothing has changed, do nothing
if ( !$changed ) {
return Status::newGood();
}
if ( !$protect ) { // No protection at all means unprotection
$revCommentMsg = 'unprotectedarticle-comment';
$logAction = 'unprotect';
} elseif ( $isProtected ) {
$revCommentMsg = 'modifiedarticleprotection-comment';
$logAction = 'modify';
} else {
$revCommentMsg = 'protectedarticle-comment';
$logAction = 'protect';
}
$logRelationsValues = [];
$logRelationsField = null;
$logParamsDetails = [];
// Null revision (used for change tag insertion)
$nullRevisionRecord = null;
if ( $id ) { // Protection of existing page
$legacyUser = MediaWikiServices::getInstance()->getUserFactory()->newFromUserIdentity( $user );
if ( !$this->getHookRunner()->onArticleProtect( $this, $legacyUser, $limit, $reason ) ) {
return Status::newGood();
}
// Only certain restrictions can cascade...
$editrestriction = isset( $limit['edit'] )
? [ $limit['edit'] ]
: $this->mTitle->getRestrictions( 'edit' );
foreach ( array_keys( $editrestriction, 'sysop' ) as $key ) {
$editrestriction[$key] = 'editprotected'; // backwards compatibility
}
foreach ( array_keys( $editrestriction, 'autoconfirmed' ) as $key ) {
$editrestriction[$key] = 'editsemiprotected'; // backwards compatibility
}
$cascadingRestrictionLevels = $wgCascadingRestrictionLevels;
foreach ( array_keys( $cascadingRestrictionLevels, 'sysop' ) as $key ) {
$cascadingRestrictionLevels[$key] = 'editprotected'; // backwards compatibility
}
foreach ( array_keys( $cascadingRestrictionLevels, 'autoconfirmed' ) as $key ) {
$cascadingRestrictionLevels[$key] = 'editsemiprotected'; // backwards compatibility
}
// The schema allows multiple restrictions
if ( !array_intersect( $editrestriction, $cascadingRestrictionLevels ) ) {
$cascade = false;
}
// insert null revision to identify the page protection change as edit summary
$latest = $this->getLatest();
$nullRevisionRecord = $this->insertNullProtectionRevision(
$revCommentMsg,
$limit,
$expiry,
$cascade,
$reason,
$user
);
if ( $nullRevisionRecord === null ) {
return Status::newFatal( 'no-null-revision', $this->mTitle->getPrefixedText() );
}
$logRelationsField = 'pr_id';
// T214035: Avoid deadlock on MySQL.
// Do a DELETE by primary key (pr_id) for any existing protection rows.
// On MySQL and derivatives, unconditionally deleting by page ID (pr_page) would.
// place a gap lock if there are no matching rows. This can deadlock when another
// thread modifies protection settings for page IDs in the same gap.
$existingProtectionIds = $dbw->selectFieldValues(
'page_restrictions',
'pr_id',
[
'pr_page' => $id,
'pr_type' => array_map( 'strval', array_keys( $limit ) )
],
__METHOD__
);
if ( $existingProtectionIds ) {
$dbw->delete(
'page_restrictions',
[ 'pr_id' => $existingProtectionIds ],
__METHOD__
);
}
// Update restrictions table
foreach ( $limit as $action => $restrictions ) {
if ( $restrictions != '' ) {
$cascadeValue = ( $cascade && $action == 'edit' ) ? 1 : 0;
$dbw->insert(
'page_restrictions',
[
'pr_page' => $id,
'pr_type' => $action,
'pr_level' => $restrictions,
'pr_cascade' => $cascadeValue,
'pr_expiry' => $dbw->encodeExpiry( $expiry[$action] )
],
__METHOD__
);
$logRelationsValues[] = $dbw->insertId();
$logParamsDetails[] = [
'type' => $action,
'level' => $restrictions,
'expiry' => $expiry[$action],
'cascade' => (bool)$cascadeValue,
];
}
}
// Clear out legacy restriction fields
$dbw->update(
'page',
[ 'page_restrictions' => '' ],
[ 'page_id' => $id ],
__METHOD__
);
$this->getHookRunner()->onRevisionFromEditComplete(
$this, $nullRevisionRecord, $latest, $user, $tags );
$this->getHookRunner()->onArticleProtectComplete( $this, $legacyUser, $limit, $reason );
} else { // Protection of non-existing page (also known as "title protection")
// Cascade protection is meaningless in this case
$cascade = false;
if ( $limit['create'] != '' ) {
$commentFields = CommentStore::getStore()->insert( $dbw, 'pt_reason', $reason );
$dbw->replace( 'protected_titles',
[ [ 'pt_namespace', 'pt_title' ] ],
[
'pt_namespace' => $this->mTitle->getNamespace(),
'pt_title' => $this->mTitle->getDBkey(),
'pt_create_perm' => $limit['create'],
'pt_timestamp' => $dbw->timestamp(),
'pt_expiry' => $dbw->encodeExpiry( $expiry['create'] ),
'pt_user' => $user->getId(),
] + $commentFields, __METHOD__
);
$logParamsDetails[] = [
'type' => 'create',
'level' => $limit['create'],
'expiry' => $expiry['create'],
];
} else {
$dbw->delete( 'protected_titles',
[
'pt_namespace' => $this->mTitle->getNamespace(),
'pt_title' => $this->mTitle->getDBkey()
], __METHOD__
);
}
}
$this->mTitle->flushRestrictions();
InfoAction::invalidateCache( $this->mTitle );
if ( $logAction == 'unprotect' ) {
$params = [];
} else {
$protectDescriptionLog = $this->protectDescriptionLog( $limit, $expiry );
$params = [
'4::description' => $protectDescriptionLog, // parameter for IRC
'5:bool:cascade' => $cascade,
'details' => $logParamsDetails, // parameter for localize and api
];
}
// Update the protection log
$logEntry = new ManualLogEntry( 'protect', $logAction );
$logEntry->setTarget( $this->mTitle );
$logEntry->setComment( $reason );
$logEntry->setPerformer( $user );
$logEntry->setParameters( $params );
if ( $nullRevisionRecord !== null ) {
$logEntry->setAssociatedRevId( $nullRevisionRecord->getId() );
}
$logEntry->addTags( $tags );
if ( $logRelationsField !== null && count( $logRelationsValues ) ) {
$logEntry->setRelations( [ $logRelationsField => $logRelationsValues ] );
}
$logId = $logEntry->insert();
$logEntry->publish( $logId );
return Status::newGood( $logId );
}
/**
* Insert a new null revision for this page.
*
* @since 1.35
*
* @param string $revCommentMsg Comment message key for the revision
* @param array $limit Set of restriction keys
* @param array $expiry Per restriction type expiration
* @param bool $cascade Set to false if cascading protection isn't allowed.
* @param string $reason
* @param UserIdentity $user User to attribute to
* @return RevisionRecord|null Null on error
*/
public function insertNullProtectionRevision(
string $revCommentMsg,
array $limit,
array $expiry,
bool $cascade,
string $reason,
UserIdentity $user
) : ?RevisionRecord {
$dbw = wfGetDB( DB_PRIMARY );
// Prepare a null revision to be added to the history
$editComment = wfMessage(
$revCommentMsg,
$this->mTitle->getPrefixedText(),
$user->getName()
)->inContentLanguage()->text();
if ( $reason ) {
$editComment .= wfMessage( 'colon-separator' )->inContentLanguage()->text() . $reason;
}
$protectDescription = $this->protectDescription( $limit, $expiry );
if ( $protectDescription ) {
$editComment .= wfMessage( 'word-separator' )->inContentLanguage()->text();
$editComment .= wfMessage( 'parentheses' )->params( $protectDescription )
->inContentLanguage()->text();
}
if ( $cascade ) {
$editComment .= wfMessage( 'word-separator' )->inContentLanguage()->text();
$editComment .= wfMessage( 'brackets' )->params(
wfMessage( 'protect-summary-cascade' )->inContentLanguage()->text()
)->inContentLanguage()->text();
}
$revStore = $this->getRevisionStore();
$comment = CommentStoreComment::newUnsavedComment( $editComment );
$nullRevRecord = $revStore->newNullRevision(
$dbw,
$this->getTitle(),
$comment,
true,
$user
);
if ( $nullRevRecord ) {
$inserted = $revStore->insertRevisionOn( $nullRevRecord, $dbw );
// Update page record and touch page
$oldLatest = $inserted->getParentId();
$this->updateRevisionOn( $dbw, $inserted, $oldLatest );
return $inserted;
} else {
return null;
}
}
/**
* @param string $expiry 14-char timestamp or "infinity", or false if the input was invalid
* @return string
*/
protected function formatExpiry( $expiry ) {
if ( $expiry != 'infinity' ) {
$contLang = MediaWikiServices::getInstance()->getContentLanguage();
return wfMessage(
'protect-expiring',
$contLang->timeanddate( $expiry, false, false ),
$contLang->date( $expiry, false, false ),
$contLang->time( $expiry, false, false )
)->inContentLanguage()->text();
} else {
return wfMessage( 'protect-expiry-indefinite' )
->inContentLanguage()->text();
}
}
/**
* Builds the description to serve as comment for the edit.
*
* @param array $limit Set of restriction keys
* @param array $expiry Per restriction type expiration
* @return string
*/
public function protectDescription( array $limit, array $expiry ) {
$protectDescription = '';
foreach ( array_filter( $limit ) as $action => $restrictions ) {
# $action is one of $wgRestrictionTypes = [ 'create', 'edit', 'move', 'upload' ].
# All possible message keys are listed here for easier grepping:
# * restriction-create
# * restriction-edit
# * restriction-move
# * restriction-upload
$actionText = wfMessage( 'restriction-' . $action )->inContentLanguage()->text();
# $restrictions is one of $wgRestrictionLevels = [ '', 'autoconfirmed', 'sysop' ],
# with '' filtered out. All possible message keys are listed below:
# * protect-level-autoconfirmed
# * protect-level-sysop
$restrictionsText = wfMessage( 'protect-level-' . $restrictions )
->inContentLanguage()->text();
$expiryText = $this->formatExpiry( $expiry[$action] );
if ( $protectDescription !== '' ) {
$protectDescription .= wfMessage( 'word-separator' )->inContentLanguage()->text();
}
$protectDescription .= wfMessage( 'protect-summary-desc' )
->params( $actionText, $restrictionsText, $expiryText )
->inContentLanguage()->text();
}
return $protectDescription;
}
/**
* Builds the description to serve as comment for the log entry.
*
* Some bots may parse IRC lines, which are generated from log entries which contain plain
* protect description text. Keep them in old format to avoid breaking compatibility.
* TODO: Fix protection log to store structured description and format it on-the-fly.
*
* @param array $limit Set of restriction keys
* @param array $expiry Per restriction type expiration
* @return string
*/
public function protectDescriptionLog( array $limit, array $expiry ) {
$protectDescriptionLog = '';
$dirMark = MediaWikiServices::getInstance()->getContentLanguage()->getDirMark();
foreach ( array_filter( $limit ) as $action => $restrictions ) {
$expiryText = $this->formatExpiry( $expiry[$action] );
$protectDescriptionLog .=
$dirMark .
"[$action=$restrictions] ($expiryText)";
}
return trim( $protectDescriptionLog );
}
/**
* Determines if deletion of this page would be batched (executed over time by the job queue)
* or not (completed in the same request as the delete call).
*
* It is unlikely but possible that an edit from another request could push the page over the
* batching threshold after this function is called, but before the caller acts upon the
* return value. Callers must decide for themselves how to deal with this. $safetyMargin
* is provided as an unreliable but situationally useful help for some common cases.
*
* @param int $safetyMargin Added to the revision count when checking for batching
* @return bool True if deletion would be batched, false otherwise
*/
public function isBatchedDelete( $safetyMargin = 0 ) {
global $wgDeleteRevisionsBatchSize;
$dbr = wfGetDB( DB_REPLICA );
$revCount = $this->getRevisionStore()->countRevisionsByPageId( $dbr, $this->getId() );
$revCount += $safetyMargin;
return $revCount >= $wgDeleteRevisionsBatchSize;
}
/**
* Back-end article deletion
* Deletes the article with database consistency, writes logs, purges caches
*
* @since 1.19
* @since 1.35 Signature changed, user moved to second parameter to prepare for requiring
* a user to be passed
* @since 1.36 User second parameter is required
*
* @param string $reason Delete reason for deletion log
* @param UserIdentity $deleter The deleting user
* @param bool $suppress Suppress all revisions and log the deletion in
* the suppression log instead of the deletion log
* @param bool|null $u1 Unused
* @param array|string &$error Array of errors to append to
* @param mixed $u2 Unused
* @param string[] $tags Tags to apply to the deletion action
* @param string $logsubtype
* @param bool $immediate false allows deleting over time via the job queue
* @return Status Status object; if successful, $status->value is the log_id of the
* deletion log entry. If the page couldn't be deleted because it wasn't
* found, $status is a non-fatal 'cannotdelete' error
* @throws FatalError
* @throws MWException
*/
public function doDeleteArticleReal(
$reason, UserIdentity $deleter, $suppress = false, $u1 = null, &$error = '', $u2 = null,
$tags = [], $logsubtype = 'delete', $immediate = false
) {
wfDebug( __METHOD__ );
$this->assertProperPage();
$status = Status::newGood();
$legacyDeleter = MediaWikiServices::getInstance()
->getUserFactory()
->newFromUserIdentity( $deleter );
if ( !$this->getHookRunner()->onArticleDelete(
$this, $legacyDeleter, $reason, $error, $status, $suppress )
) {
if ( $status->isOK() ) {
// Hook aborted but didn't set a fatal status
$status->fatal( 'delete-hook-aborted' );
}
return $status;
}
return $this->doDeleteArticleBatched( $reason, $suppress, $deleter, $tags,
$logsubtype, $immediate );
}
/**
* Back-end article deletion
*
* Only invokes batching via the job queue if necessary per $wgDeleteRevisionsBatchSize.
* Deletions can often be completed inline without involving the job queue.
*
* Potentially called many times per deletion operation for pages with many revisions.
* @param string $reason
* @param bool $suppress
* @param UserIdentity $deleter
* @param string[] $tags
* @param string $logsubtype
* @param bool $immediate
* @param string|null $webRequestId
* @return Status
*/
public function doDeleteArticleBatched(
$reason, $suppress, UserIdentity $deleter, $tags,
$logsubtype, $immediate = false, $webRequestId = null
) {
wfDebug( __METHOD__ );
$status = Status::newGood();
$dbw = wfGetDB( DB_PRIMARY );
$dbw->startAtomic( __METHOD__ );
$this->loadPageData( self::READ_LATEST );
$id = $this->getId();
// T98706: lock the page from various other updates but avoid using
// WikiPage::READ_LOCKING as that will carry over the FOR UPDATE to
// the revisions queries (which also JOIN on user). Only lock the page
// row and CAS check on page_latest to see if the trx snapshot matches.
$lockedLatest = $this->lockAndGetLatest();
if ( $id == 0 || $this->getLatest() != $lockedLatest ) {
$dbw->endAtomic( __METHOD__ );
// Page not there or trx snapshot is stale
$status->error( 'cannotdelete',
wfEscapeWikiText( $this->getTitle()->getPrefixedText() ) );
return $status;
}
// At this point we are now committed to returning an OK
// status unless some DB query error or other exception comes up.
// This way callers don't have to call rollback() if $status is bad
// unless they actually try to catch exceptions (which is rare).
// we need to remember the old content so we can use it to generate all deletion updates.
$revisionRecord = $this->getRevisionRecord();
try {
$content = $this->getContent( RevisionRecord::RAW );
} catch ( Exception $ex ) {
wfLogWarning( __METHOD__ . ': failed to load content during deletion! '
. $ex->getMessage() );
$content = null;
}
// Archive revisions. In immediate mode, archive all revisions. Otherwise, archive
// one batch of revisions and defer archival of any others to the job queue.
$explictTrxLogged = false;
while ( true ) {
$done = $this->archiveRevisions( $dbw, $id, $suppress );
if ( $done || !$immediate ) {
break;
}
$dbw->endAtomic( __METHOD__ );
if ( $dbw->explicitTrxActive() ) {
// Explict transactions may never happen here in practice. Log to be sure.
if ( !$explictTrxLogged ) {
$explictTrxLogged = true;
LoggerFactory::getInstance( 'wfDebug' )->debug(
'explicit transaction active in ' . __METHOD__ . ' while deleting {title}', [
'title' => $this->getTitle()->getText(),
] );
}
continue;
}
if ( $dbw->trxLevel() ) {
$dbw->commit( __METHOD__ );
}
$lbFactory = MediaWikiServices::getInstance()->getDBLoadBalancerFactory();
$lbFactory->waitForReplication();
$dbw->startAtomic( __METHOD__ );
}
// If done archiving, also delete the article.
if ( !$done ) {
$dbw->endAtomic( __METHOD__ );
$jobParams = [
'namespace' => $this->getTitle()->getNamespace(),
'title' => $this->getTitle()->getDBkey(),
'wikiPageId' => $id,
'requestId' => $webRequestId ?? WebRequest::getRequestId(),
'reason' => $reason,
'suppress' => $suppress,
'userId' => $deleter->getId(),
'tags' => json_encode( $tags ),
'logsubtype' => $logsubtype,
];
$job = new DeletePageJob( $jobParams );
JobQueueGroup::singleton()->push( $job );
$status->warning( 'delete-scheduled',
wfEscapeWikiText( $this->getTitle()->getPrefixedText() ) );
} else {
// Get archivedRevisionCount by db query, because there's no better alternative.
// Jobs cannot pass a count of archived revisions to the next job, because additional
// deletion operations can be started while the first is running. Jobs from each
// gracefully interleave, but would not know about each other's count. Deduplication
// in the job queue to avoid simultaneous deletion operations would add overhead.
// Number of archived revisions cannot be known beforehand, because edits can be made
// while deletion operations are being processed, changing the number of archivals.
$archivedRevisionCount = (int)$dbw->selectField(
'archive', 'COUNT(*)',
[
'ar_namespace' => $this->getTitle()->getNamespace(),
'ar_title' => $this->getTitle()->getDBkey(),
'ar_page_id' => $id
], __METHOD__
);
// Clone the title and wikiPage, so we have the information we need when
// we log and run the ArticleDeleteComplete hook.
$logTitle = clone $this->mTitle;
$wikiPageBeforeDelete = clone $this;
// Now that it's safely backed up, delete it
$dbw->delete( 'page', [ 'page_id' => $id ], __METHOD__ );
// Log the deletion, if the page was suppressed, put it in the suppression log instead
$logtype = $suppress ? 'suppress' : 'delete';
$logEntry = new ManualLogEntry( $logtype, $logsubtype );
$logEntry->setPerformer( $deleter );
$logEntry->setTarget( $logTitle );
$logEntry->setComment( $reason );
$logEntry->addTags( $tags );
$logid = $logEntry->insert();
$dbw->onTransactionPreCommitOrIdle(
static function () use ( $logEntry, $logid ) {
// T58776: avoid deadlocks (especially from FileDeleteForm)
$logEntry->publish( $logid );
},
__METHOD__
);
$dbw->endAtomic( __METHOD__ );
$this->doDeleteUpdates(
$id,
$content,
$revisionRecord,
$deleter
);
$legacyDeleter = MediaWikiServices::getInstance()
->getUserFactory()
->newFromUserIdentity( $deleter );
$this->getHookRunner()->onArticleDeleteComplete(
$wikiPageBeforeDelete,
$legacyDeleter,
$reason,
$id,
$content,
$logEntry,
$archivedRevisionCount
);
$status->value = $logid;
// Show log excerpt on 404 pages rather than just a link
$dbCache = ObjectCache::getInstance( 'db-replicated' );
$key = $dbCache->makeKey( 'page-recent-delete', md5( $logTitle->getPrefixedText() ) );
$dbCache->set( $key, 1, $dbCache::TTL_DAY );
}
return $status;
}
/**
* Archives revisions as part of page deletion.
*
* @param IDatabase $dbw
* @param int $id
* @param bool $suppress Suppress all revisions and log the deletion in
* the suppression log instead of the deletion log
* @return bool
*/
protected function archiveRevisions( $dbw, $id, $suppress ) {
global $wgDeleteRevisionsBatchSize;
// Given the lock above, we can be confident in the title and page ID values
$namespace = $this->getTitle()->getNamespace();
$dbKey = $this->getTitle()->getDBkey();
$commentStore = CommentStore::getStore();
$revQuery = $this->getRevisionStore()->getQueryInfo();
$bitfield = false;
// Bitfields to further suppress the content
if ( $suppress ) {
$bitfield = RevisionRecord::SUPPRESSED_ALL;
$revQuery['fields'] = array_diff( $revQuery['fields'], [ 'rev_deleted' ] );
}
// For now, shunt the revision data into the archive table.
// Text is *not* removed from the text table; bulk storage
// is left intact to avoid breaking block-compression or
// immutable storage schemes.
// In the future, we may keep revisions and mark them with
// the rev_deleted field, which is reserved for this purpose.
// Lock rows in `revision` and its temp tables, but not any others.
// Note array_intersect() preserves keys from the first arg, and we're
// assuming $revQuery has `revision` primary and isn't using subtables
// for anything we care about.
$dbw->lockForUpdate(
array_intersect(
$revQuery['tables'],
[ 'revision', 'revision_comment_temp', 'revision_actor_temp' ]
),
[ 'rev_page' => $id ],
__METHOD__,
[],
$revQuery['joins']
);
// Get as many of the page revisions as we are allowed to. The +1 lets us recognize the
// unusual case where there were exactly $wgDeleteRevisionBatchSize revisions remaining.
$res = $dbw->select(
$revQuery['tables'],
$revQuery['fields'],
[ 'rev_page' => $id ],
__METHOD__,
[ 'ORDER BY' => 'rev_timestamp ASC, rev_id ASC', 'LIMIT' => $wgDeleteRevisionsBatchSize + 1 ],
$revQuery['joins']
);
// Build their equivalent archive rows
$rowsInsert = [];
$revids = [];
/** @var int[] Revision IDs of edits that were made by IPs */
$ipRevIds = [];
$done = true;
foreach ( $res as $row ) {
if ( count( $revids ) >= $wgDeleteRevisionsBatchSize ) {
$done = false;
break;
}
$comment = $commentStore->getComment( 'rev_comment', $row );
$rowInsert = [
'ar_namespace' => $namespace,
'ar_title' => $dbKey,
'ar_actor' => $row->rev_actor,
'ar_timestamp' => $row->rev_timestamp,
'ar_minor_edit' => $row->rev_minor_edit,
'ar_rev_id' => $row->rev_id,
'ar_parent_id' => $row->rev_parent_id,
'ar_len' => $row->rev_len,
'ar_page_id' => $id,
'ar_deleted' => $suppress ? $bitfield : $row->rev_deleted,
'ar_sha1' => $row->rev_sha1,
] + $commentStore->insert( $dbw, 'ar_comment', $comment );
$rowsInsert[] = $rowInsert;
$revids[] = $row->rev_id;
// Keep track of IP edits, so that the corresponding rows can
// be deleted in the ip_changes table.
if ( (int)$row->rev_user === 0 && IPUtils::isValid( $row->rev_user_text ) ) {
$ipRevIds[] = $row->rev_id;
}
}
// This conditional is just a sanity check
if ( count( $revids ) > 0 ) {
// Copy them into the archive table
$dbw->insert( 'archive', $rowsInsert, __METHOD__ );
$dbw->delete( 'revision', [ 'rev_id' => $revids ], __METHOD__ );
$dbw->delete( 'revision_comment_temp', [ 'revcomment_rev' => $revids ], __METHOD__ );
$dbw->delete( 'revision_actor_temp', [ 'revactor_rev' => $revids ], __METHOD__ );
// Also delete records from ip_changes as applicable.
if ( count( $ipRevIds ) > 0 ) {
$dbw->delete( 'ip_changes', [ 'ipc_rev_id' => $ipRevIds ], __METHOD__ );
}
}
return $done;
}
/**
* Lock the page row for this title+id and return page_latest (or 0)
*
* @return int Returns 0 if no row was found with this title+id
* @since 1.27
*/
public function lockAndGetLatest() {
return (int)wfGetDB( DB_PRIMARY )->selectField(
'page',
'page_latest',
[
'page_id' => $this->getId(),
// Typically page_id is enough, but some code might try to do
// updates assuming the title is the same, so verify that
'page_namespace' => $this->getTitle()->getNamespace(),
'page_title' => $this->getTitle()->getDBkey()
],
__METHOD__,
[ 'FOR UPDATE' ]
);
}
/**
* Do some database updates after deletion
*
* @param int $id The page_id value of the page being deleted
* @param Content|null $content Page content to be used when determining
* the required updates. This may be needed because $this->getContent()
* may already return null when the page proper was deleted.
* @param RevisionRecord|null $revRecord The current page revision at the time of
* deletion, used when determining the required updates. This may be needed because
* $this->getRevisionRecord() may already return null when the page proper was deleted.
* @param UserIdentity|null $user The user that caused the deletion
*/
public function doDeleteUpdates(
$id,
Content $content = null,
RevisionRecord $revRecord = null,
UserIdentity $user = null
) {
if ( $id !== $this->getId() ) {
throw new InvalidArgumentException( 'Mismatching page ID' );
}
try {
$countable = $this->isCountable();
} catch ( Exception $ex ) {
// fallback for deleting broken pages for which we cannot load the content for
// some reason. Note that doDeleteArticleReal() already logged this problem.
$countable = false;
}
// Update site status
DeferredUpdates::addUpdate( SiteStatsUpdate::factory(
[ 'edits' => 1, 'articles' => -$countable, 'pages' => -1 ]
) );
// Delete pagelinks, update secondary indexes, etc
$updates = $this->getDeletionUpdates( $revRecord ?: $content );
foreach ( $updates as $update ) {
DeferredUpdates::addUpdate( $update );
}
$causeAgent = $user ? $user->getName() : 'unknown';
// Reparse any pages transcluding this page
LinksUpdate::queueRecursiveJobsForTable(
$this->mTitle, 'templatelinks', 'delete-page', $causeAgent );
// Reparse any pages including this image
if ( $this->mTitle->getNamespace() === NS_FILE ) {
LinksUpdate::queueRecursiveJobsForTable(
$this->mTitle, 'imagelinks', 'delete-page', $causeAgent );
}
// Clear caches
self::onArticleDelete( $this->mTitle );
ResourceLoaderWikiModule::invalidateModuleCache(
$this->mTitle,
$revRecord,
null,
WikiMap::getCurrentWikiDbDomain()->getId()
);
// Reset this object and the Title object
$this->loadFromRow( false, self::READ_LATEST );
// Search engine
DeferredUpdates::addUpdate( new SearchUpdate( $id, $this->mTitle ) );
}
/**
* The onArticle*() functions are supposed to be a kind of hooks
* which should be called whenever any of the specified actions
* are done.
*
* This is a good place to put code to clear caches, for instance.
*
* This is called on page move and undelete, as well as edit
*
* @param Title $title
*/
public static function onArticleCreate( Title $title ) {
// TODO: move this into a PageEventEmitter service
// Update existence markers on article/talk tabs...
$other = $title->getOtherPage();
$hcu = MediaWikiServices::getInstance()->getHtmlCacheUpdater();
$hcu->purgeTitleUrls( [ $title, $other ], $hcu::PURGE_INTENT_TXROUND_REFLECTED );
$title->touchLinks();
$title->deleteTitleProtection();
MediaWikiServices::getInstance()->getLinkCache()->invalidateTitle( $title );
// Invalidate caches of articles which include this page
$job = HTMLCacheUpdateJob::newForBacklinks(
$title,
'templatelinks',
[ 'causeAction' => 'page-create' ]
);
JobQueueGroup::singleton()->lazyPush( $job );
if ( $title->getNamespace() === NS_CATEGORY ) {
// Load the Category object, which will schedule a job to create
// the category table row if necessary. Checking a replica DB is ok
// here, in the worst case it'll run an unnecessary recount job on
// a category that probably doesn't have many members.
Category::newFromTitle( $title )->getID();
}
}
/**
* Clears caches when article is deleted
*
* @param Title $title
*/
public static function onArticleDelete( Title $title ) {
// TODO: move this into a PageEventEmitter service
// Update existence markers on article/talk tabs...
$other = $title->getOtherPage();
$hcu = MediaWikiServices::getInstance()->getHtmlCacheUpdater();
$hcu->purgeTitleUrls( [ $title, $other ], $hcu::PURGE_INTENT_TXROUND_REFLECTED );
$title->touchLinks();
$services = MediaWikiServices::getInstance();
$services->getLinkCache()->invalidateTitle( $title );
InfoAction::invalidateCache( $title );
// Messages
if ( $title->getNamespace() === NS_MEDIAWIKI ) {
$services->getMessageCache()->updateMessageOverride( $title, null );
}
// Images
if ( $title->getNamespace() === NS_FILE ) {
$job = HTMLCacheUpdateJob::newForBacklinks(
$title,
'imagelinks',
[ 'causeAction' => 'page-delete' ]
);
JobQueueGroup::singleton()->lazyPush( $job );
}
// User talk pages
if ( $title->getNamespace() === NS_USER_TALK ) {
$user = User::newFromName( $title->getText(), false );
if ( $user ) {
MediaWikiServices::getInstance()
->getTalkPageNotificationManager()
->removeUserHasNewMessages( $user );
}
}
// Image redirects
$services->getRepoGroup()->getLocalRepo()->invalidateImageRedirect( $title );
// Purge cross-wiki cache entities referencing this page
self::purgeInterwikiCheckKey( $title );
}
/**
* Purge caches on page update etc
*
* @param Title $title
* @param RevisionRecord|null $revRecord revision that was just saved, may be null
* @param string[]|null $slotsChanged The role names of the slots that were changed.
* If not given, all slots are assumed to have changed.
*/
public static function onArticleEdit(
Title $title,
RevisionRecord $revRecord = null,
$slotsChanged = null
) {
// TODO: move this into a PageEventEmitter service
$jobs = [];
if ( $slotsChanged === null || in_array( SlotRecord::MAIN, $slotsChanged ) ) {
// Invalidate caches of articles which include this page.
// Only for the main slot, because only the main slot is transcluded.
// TODO: MCR: not true for TemplateStyles! [SlotHandler]
$jobs[] = HTMLCacheUpdateJob::newForBacklinks(
$title,
'templatelinks',
[ 'causeAction' => 'page-edit' ]
);
}
// Invalidate the caches of all pages which redirect here
$jobs[] = HTMLCacheUpdateJob::newForBacklinks(
$title,
'redirect',
[ 'causeAction' => 'page-edit' ]
);
JobQueueGroup::singleton()->lazyPush( $jobs );
MediaWikiServices::getInstance()->getLinkCache()->invalidateTitle( $title );
$hcu = MediaWikiServices::getInstance()->getHtmlCacheUpdater();
$hcu->purgeTitleUrls( $title, $hcu::PURGE_INTENT_TXROUND_REFLECTED );
// Purge ?action=info cache
$revid = $revRecord ? $revRecord->getId() : null;
DeferredUpdates::addCallableUpdate( static function () use ( $title, $revid ) {
InfoAction::invalidateCache( $title, $revid );
} );
// Purge cross-wiki cache entities referencing this page
self::purgeInterwikiCheckKey( $title );
}
/** #@- */
/**
* Purge the check key for cross-wiki cache entries referencing this page
*
* @param Title $title
*/
private static function purgeInterwikiCheckKey( Title $title ) {
global $wgEnableScaryTranscluding;
if ( !$wgEnableScaryTranscluding ) {
return; // @todo: perhaps this wiki is only used as a *source* for content?
}
DeferredUpdates::addCallableUpdate( static function () use ( $title ) {
$cache = MediaWikiServices::getInstance()->getMainWANObjectCache();
$cache->resetCheckKey(
// Do not include the namespace since there can be multiple aliases to it
// due to different namespace text definitions on different wikis. This only
// means that some cache invalidations happen that are not strictly needed.
$cache->makeGlobalKey(
'interwiki-page',
WikiMap::getCurrentWikiDbDomain()->getId(),
$title->getDBkey()
)
);
} );
}
/**
* Returns a list of categories this page is a member of.
* Results will include hidden categories
*
* @return TitleArray
*/
public function getCategories() {
$id = $this->getId();
if ( $id == 0 ) {
return TitleArray::newFromResult( new FakeResultWrapper( [] ) );
}
$dbr = wfGetDB( DB_REPLICA );
$res = $dbr->select( 'categorylinks',
[ 'page_title' => 'cl_to', 'page_namespace' => NS_CATEGORY ],
[ 'cl_from' => $id ],
__METHOD__
);
return TitleArray::newFromResult( $res );
}
/**
* Returns a list of hidden categories this page is a member of.
* Uses the page_props and categorylinks tables.
*
* @return Title[]
*/
public function getHiddenCategories() {
$result = [];
$id = $this->getId();
if ( $id == 0 ) {
return [];
}
$dbr = wfGetDB( DB_REPLICA );
$res = $dbr->select( [ 'categorylinks', 'page_props', 'page' ],
[ 'cl_to' ],
[ 'cl_from' => $id, 'pp_page=page_id', 'pp_propname' => 'hiddencat',
'page_namespace' => NS_CATEGORY, 'page_title=cl_to' ],
__METHOD__ );
if ( $res !== false ) {
foreach ( $res as $row ) {
$result[] = Title::makeTitle( NS_CATEGORY, $row->cl_to );
}
}
return $result;
}
/**
* Auto-generates a deletion reason
*
* @param bool &$hasHistory Whether the page has a history
* @return string|bool String containing deletion reason or empty string, or boolean false
* if no revision occurred
*/
public function getAutoDeleteReason( &$hasHistory ) {
return $this->getContentHandler()->getAutoDeleteReason( $this->getTitle(), $hasHistory );
}
/**
* Update all the appropriate counts in the category table, given that
* we've added the categories $added and deleted the categories $deleted.
*
* This should only be called from deferred updates or jobs to avoid contention.
*
* @param string[] $added The names of categories that were added
* @param string[] $deleted The names of categories that were deleted
* @param int $id Page ID (this should be the original deleted page ID)
*/
public function updateCategoryCounts( array $added, array $deleted, $id = 0 ) {
$id = $id ?: $this->getId();
$type = MediaWikiServices::getInstance()->getNamespaceInfo()->
getCategoryLinkType( $this->getTitle()->getNamespace() );
$addFields = [ 'cat_pages = cat_pages + 1' ];
$removeFields = [ 'cat_pages = cat_pages - 1' ];
if ( $type !== 'page' ) {
$addFields[] = "cat_{$type}s = cat_{$type}s + 1";
$removeFields[] = "cat_{$type}s = cat_{$type}s - 1";
}
$dbw = wfGetDB( DB_PRIMARY );
if ( count( $added ) ) {
$existingAdded = $dbw->selectFieldValues(
'category',
'cat_title',
[ 'cat_title' => $added ],
__METHOD__
);
// For category rows that already exist, do a plain
// UPDATE instead of INSERT...ON DUPLICATE KEY UPDATE
// to avoid creating gaps in the cat_id sequence.
if ( count( $existingAdded ) ) {
$dbw->update(
'category',
$addFields,
[ 'cat_title' => $existingAdded ],
__METHOD__
);
}
$missingAdded = array_diff( $added, $existingAdded );
if ( count( $missingAdded ) ) {
$insertRows = [];
foreach ( $missingAdded as $cat ) {
$insertRows[] = [
'cat_title' => $cat,
'cat_pages' => 1,
'cat_subcats' => ( $type === 'subcat' ) ? 1 : 0,
'cat_files' => ( $type === 'file' ) ? 1 : 0,
];
}
$dbw->upsert(
'category',
$insertRows,
'cat_title',
$addFields,
__METHOD__
);
}
}
if ( count( $deleted ) ) {
$dbw->update(
'category',
$removeFields,
[ 'cat_title' => $deleted ],
__METHOD__
);
}
foreach ( $added as $catName ) {
$cat = Category::newFromName( $catName );
$this->getHookRunner()->onCategoryAfterPageAdded( $cat, $this );
}
foreach ( $deleted as $catName ) {
$cat = Category::newFromName( $catName );
$this->getHookRunner()->onCategoryAfterPageRemoved( $cat, $this, $id );
// Refresh counts on categories that should be empty now (after commit, T166757)
DeferredUpdates::addCallableUpdate( static function () use ( $cat ) {
$cat->refreshCountsIfEmpty();
} );
}
}
/**
* Opportunistically enqueue link update jobs after a fresh parser output was generated.
*
* This method should only be called by PoolWorkArticleViewCurrent, after a page view
* experienced a miss from the ParserCache, and a new ParserOutput was generated.
* Specifically, for load reasons, this method must not get called during page views that
* use a cached ParserOutput.
*
* @since 1.25
* @internal For use by PoolWorkArticleViewCurrent
* @param ParserOutput $parserOutput Current version page output
*/
public function triggerOpportunisticLinksUpdate( ParserOutput $parserOutput ) {
if ( wfReadOnly() ) {
return;
}
if ( !$this->getHookRunner()->onOpportunisticLinksUpdate( $this,
$this->mTitle, $parserOutput )
) {
return;
}
$config = RequestContext::getMain()->getConfig();
$params = [
'isOpportunistic' => true,
'rootJobTimestamp' => $parserOutput->getCacheTime()
];
if ( $this->mTitle->areRestrictionsCascading() ) {
// In general, MediaWiki does not re-run LinkUpdate (e.g. for search index, category
// listings, and backlinks for Whatlinkshere), unless either the page was directly
// edited, or was re-generate following a template edit propagating to an affected
// page. As such, during page views when there is no valid ParserCache entry,
// we re-parse and save, but leave indexes as-is.
//
// We make an exception for pages that have cascading protection (perhaps for a wiki's
// "Main Page"). When such page is re-parsed on-demand after a parser cache miss, we
// queue a high-priority LinksUpdate job, to ensure that we really protect all
// content that is currently transcluded onto the page. This is important, because
// wikitext supports conditional statements based on the current time, which enables
// transcluding of a different sub page based on which day it is, and then show that
// information on the Main Page, without the Main Page itself being edited.
JobQueueGroup::singleton()->lazyPush(
RefreshLinksJob::newPrioritized( $this->mTitle, $params )
);
} elseif ( !$config->get( 'MiserMode' ) && $parserOutput->hasReducedExpiry() ) {
// Assume the output contains "dynamic" time/random based magic words.
// Only update pages that expired due to dynamic content and NOT due to edits
// to referenced templates/files. When the cache expires due to dynamic content,
// page_touched is unchanged. We want to avoid triggering redundant jobs due to
// views of pages that were just purged via HTMLCacheUpdateJob. In that case, the
// template/file edit already triggered recursive RefreshLinksJob jobs.
if ( $this->getLinksTimestamp() > $this->getTouched() ) {
// If a page is uncacheable, do not keep spamming a job for it.
// Although it would be de-duplicated, it would still waste I/O.
$cache = ObjectCache::getLocalClusterInstance();
$key = $cache->makeKey( 'dynamic-linksupdate', 'last', $this->getId() );
$ttl = max( $parserOutput->getCacheExpiry(), 3600 );
if ( $cache->add( $key, time(), $ttl ) ) {
JobQueueGroup::singleton()->lazyPush(
RefreshLinksJob::newDynamic( $this->mTitle, $params )
);
}
}
}
}
/**
* Returns a list of updates to be performed when this page is deleted. The
* updates should remove any information about this page from secondary data
* stores such as links tables.
*
* @param RevisionRecord|Content|null $rev The revision being deleted. Also accepts a Content
* object for backwards compatibility.
* @return DeferrableUpdate[]
*/
public function getDeletionUpdates( $rev = null ) {
if ( !$rev ) {
wfDeprecated( __METHOD__ . ' without a RevisionRecord', '1.32' );
try {
$rev = $this->getRevisionRecord();
} catch ( Exception $ex ) {
// If we can't load the content, something is wrong. Perhaps that's why
// the user is trying to delete the page, so let's not fail in that case.
// Note that doDeleteArticleReal() will already have logged an issue with
// loading the content.
wfDebug( __METHOD__ . ' failed to load current revision of page ' . $this->getId() );
}
}
if ( !$rev ) {
$slotContent = [];
} elseif ( $rev instanceof Content ) {
wfDeprecated( __METHOD__ . ' with a Content object instead of a RevisionRecord', '1.32' );
$slotContent = [ SlotRecord::MAIN => $rev ];
} else {
$slotContent = array_map( static function ( SlotRecord $slot ) {
return $slot->getContent();
}, $rev->getSlots()->getSlots() );
}
$allUpdates = [ new LinksDeletionUpdate( $this ) ];
// NOTE: once Content::getDeletionUpdates() is removed, we only need to content
// model here, not the content object!
// TODO: consolidate with similar logic in DerivedPageDataUpdater::getSecondaryDataUpdates()
/** @var ?Content $content */
$content = null; // in case $slotContent is zero-length
foreach ( $slotContent as $role => $content ) {
$handler = $content->getContentHandler();
$updates = $handler->getDeletionUpdates(
$this->getTitle(),
$role
);
$allUpdates = array_merge( $allUpdates, $updates );
// TODO: remove B/C hack in 1.32!
$legacyUpdates = $content->getDeletionUpdates( $this );
// HACK: filter out redundant and incomplete LinksDeletionUpdate
$legacyUpdates = array_filter( $legacyUpdates, static function ( $update ) {
return !( $update instanceof LinksDeletionUpdate );
} );
$allUpdates = array_merge( $allUpdates, $legacyUpdates );
}
$this->getHookRunner()->onPageDeletionDataUpdates(
$this->getTitle(), $rev, $allUpdates );
// TODO: hard deprecate old hook in 1.33
$this->getHookRunner()->onWikiPageDeletionUpdates( $this, $content, $allUpdates );
return $allUpdates;
}
/**
* Whether this content displayed on this page
* comes from the local database
*
* @since 1.28
* @return bool
*/
public function isLocal() {
return true;
}
/**
* The display name for the site this content
* come from. If a subclass overrides isLocal(),
* this could return something other than the
* current site name
*
* @since 1.28
* @return string
*/
public function getWikiDisplayName() {
global $wgSitename;
return $wgSitename;
}
/**
* Get the source URL for the content on this page,
* typically the canonical URL, but may be a remote
* link if the content comes from another site
*
* @since 1.28
* @return string
*/
public function getSourceURL() {
return $this->getTitle()->getCanonicalURL();
}
/**
* @param WANObjectCache $cache
* @return string[]
* @since 1.28
*/
public function getMutableCacheKeys( WANObjectCache $cache ) {
$linkCache = MediaWikiServices::getInstance()->getLinkCache();
return $linkCache->getMutableCacheKeys( $cache, $this->getTitle() );
}
/**
* Ensure consistency when unserializing.
* @note WikiPage objects should never be serialized in the first place.
* But some extensions like AbuseFilter did (see T213006),
* and we need to be able to read old data (see T187153).
*/
public function __wakeup() {
// Make sure we re-fetch the latest state from the database.
// In particular, the latest revision may have changed.
// As a side-effect, this makes sure mLastRevision doesn't
// end up being an instance of the old Revision class (see T259181),
// especially since that class was removed entirely in 1.37.
$this->clear();
}
/**
* @inheritDoc
* @since 1.36
*/
public function getNamespace(): int {
return $this->getTitle()->getNamespace();
}
/**
* @inheritDoc
* @since 1.36
*/
public function getDBkey(): string {
return $this->getTitle()->getDBkey();
}
/**
* @return false self::LOCAL
* @since 1.36
*/
public function getWikiId() {
return $this->getTitle()->getWikiId();
}
/**
* @return true
* @since 1.36
*/
public function canExist(): bool {
// NOTE: once WikiPage becomes a ProperPageIdentity, this should always return true
return $this->mTitle->canExist();
}
/**
* @inheritDoc
* @since 1.36
*/
public function __toString(): string {
return $this->mTitle->__toString();
}
/**
* @inheritDoc
* @since 1.36
*
* @param PageReference $other
* @return bool
*/
public function isSamePageAs( PageReference $other ): bool {
// NOTE: keep in sync with PageIdentityValue::isSamePageAs()!
if ( $other->getWikiId() !== $this->getWikiId() ) {
return false;
}
if ( $other->getNamespace() !== $this->getNamespace()
|| $other->getDBkey() !== $this->getDBkey() ) {
return false;
}
return true;
}
/**
* Returns the page represented by this WikiPage as a PageStoreRecord.
* The PageRecord returned by this method is guaranteed to be immutable.
*
* It is preferred to use this method rather than using the WikiPage as a PageIdentity directly.
* @since 1.36
*
* @throws PreconditionException if the page does not exist.
*
* @return ExistingPageRecord
*/
public function toPageRecord(): ExistingPageRecord {
// TODO: replace individual member fields with a PageRecord instance that is always present
if ( !$this->mDataLoaded ) {
$this->loadPageData();
}
Assert::precondition(
$this->exists(),
'This WikiPage instance does not represent an existing page: ' . $this->mTitle
);
return new PageStoreRecord(
(object)[
'page_id' => $this->getId(),
'page_namespace' => $this->mTitle->getNamespace(),
'page_title' => $this->mTitle->getDBkey(),
'page_latest' => $this->mLatest,
'page_is_new' => $this->mIsNew,
'page_is_redirect' => $this->mIsRedirect,
'page_touched' => $this->getTouched(),
'page_lang' => $this->getLanguage()
],
PageIdentity::LOCAL
);
}
}
|