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
|
<?php
/**
* Register WP REST API endpoints for Jetpack.
*
* @author Automattic
*/
/**
* Disable direct access.
*/
if ( ! defined( 'ABSPATH' ) ) {
exit;
}
// Load WP_Error for error messages.
require_once ABSPATH . '/wp-includes/class-wp-error.php';
// Register endpoints when WP REST API is initialized.
add_action( 'rest_api_init', array( 'Jetpack_Core_Json_Api_Endpoints', 'register_endpoints' ) );
/**
* Class Jetpack_Core_Json_Api_Endpoints
*
* @since 4.3.0
*/
class Jetpack_Core_Json_Api_Endpoints {
/**
* @var string Generic error message when user is not allowed to perform an action.
*/
public static $user_permissions_error_msg;
/**
* @var array Roles that can access Stats once they're granted access.
*/
public static $stats_roles;
/**
* Declare the Jetpack REST API endpoints.
*
* @since 4.3.0
*/
public static function register_endpoints() {
// Load API endpoint base classes
require_once JETPACK__PLUGIN_DIR . '_inc/lib/core-api/class.jetpack-core-api-xmlrpc-consumer-endpoint.php';
// Load API endpoints
require_once JETPACK__PLUGIN_DIR . '_inc/lib/core-api/class.jetpack-core-api-module-endpoints.php';
require_once JETPACK__PLUGIN_DIR . '_inc/lib/core-api/class.jetpack-core-api-site-endpoints.php';
require_once JETPACK__PLUGIN_DIR . '_inc/lib/core-api/class.jetpack-core-api-widgets-endpoints.php';
self::$user_permissions_error_msg = esc_html__(
'You do not have the correct user permissions to perform this action.
Please contact your site admin if you think this is a mistake.',
'jetpack'
);
self::$stats_roles = array( 'administrator', 'editor', 'author', 'contributor', 'subscriber' );
Jetpack::load_xml_rpc_client();
$ixr_client = new Jetpack_IXR_Client( array( 'user_id' => get_current_user_id() ) );
$core_api_endpoint = new Jetpack_Core_API_Data( $ixr_client );
$module_list_endpoint = new Jetpack_Core_API_Module_List_Endpoint();
$module_data_endpoint = new Jetpack_Core_API_Module_Data_Endpoint();
$module_toggle_endpoint = new Jetpack_Core_API_Module_Toggle_Endpoint( new Jetpack_IXR_Client() );
$site_endpoint = new Jetpack_Core_API_Site_Endpoint();
$widget_endpoint = new Jetpack_Core_API_Widget_Endpoint();
register_rest_route( 'jetpack/v4', 'plans', array(
'methods' => WP_REST_Server::READABLE,
'callback' => __CLASS__ . '::get_plans',
'permission_callback' => __CLASS__ . '::connect_url_permission_callback',
) );
register_rest_route( 'jetpack/v4', '/jitm', array(
'methods' => WP_REST_Server::READABLE,
'callback' => __CLASS__ . '::get_jitm_message',
) );
register_rest_route( 'jetpack/v4', '/jitm', array(
'methods' => WP_REST_Server::CREATABLE,
'callback' => __CLASS__ . '::delete_jitm_message'
) );
// Register a site
register_rest_route( 'jetpack/v4', '/verify_registration', array(
'methods' => WP_REST_Server::EDITABLE,
'callback' => __CLASS__ . '::verify_registration',
) );
// Authorize a remote user
register_rest_route( 'jetpack/v4', '/remote_authorize', array(
'methods' => WP_REST_Server::EDITABLE,
'callback' => __CLASS__ . '::remote_authorize',
) );
// Get current connection status of Jetpack
register_rest_route( 'jetpack/v4', '/connection', array(
'methods' => WP_REST_Server::READABLE,
'callback' => __CLASS__ . '::jetpack_connection_status',
) );
register_rest_route( 'jetpack/v4', '/rewind', array(
'methods' => WP_REST_Server::READABLE,
'callback' => __CLASS__ . '::get_rewind_data',
'permission_callback' => __CLASS__ . '::view_admin_page_permission_check',
) );
// Fetches a fresh connect URL
register_rest_route( 'jetpack/v4', '/connection/url', array(
'methods' => WP_REST_Server::READABLE,
'callback' => __CLASS__ . '::build_connect_url',
'permission_callback' => __CLASS__ . '::connect_url_permission_callback',
) );
// Get current user connection data
register_rest_route( 'jetpack/v4', '/connection/data', array(
'methods' => WP_REST_Server::READABLE,
'callback' => __CLASS__ . '::get_user_connection_data',
'permission_callback' => __CLASS__ . '::get_user_connection_data_permission_callback',
) );
// Set the connection owner
register_rest_route( 'jetpack/v4', '/connection/owner', array(
'methods' => WP_REST_Server::EDITABLE,
'callback' => __CLASS__ . '::set_connection_owner',
'permission_callback' => __CLASS__ . '::set_connection_owner_permission_callback',
) );
// Current user: get or set tracking settings.
register_rest_route( 'jetpack/v4', '/tracking/settings', array(
array(
'methods' => WP_REST_Server::READABLE,
'callback' => __CLASS__ . '::get_user_tracking_settings',
'permission_callback' => __CLASS__ . '::view_admin_page_permission_check',
),
array(
'methods' => WP_REST_Server::EDITABLE,
'callback' => __CLASS__ . '::update_user_tracking_settings',
'permission_callback' => __CLASS__ . '::view_admin_page_permission_check',
'args' => array(
'tracks_opt_out' => array( 'type' => 'boolean' ),
),
),
) );
// Disconnect site from WordPress.com servers
register_rest_route( 'jetpack/v4', '/connection', array(
'methods' => WP_REST_Server::EDITABLE,
'callback' => __CLASS__ . '::disconnect_site',
'permission_callback' => __CLASS__ . '::disconnect_site_permission_callback',
) );
// Disconnect/unlink user from WordPress.com servers
register_rest_route( 'jetpack/v4', '/connection/user', array(
'methods' => WP_REST_Server::EDITABLE,
'callback' => __CLASS__ . '::unlink_user',
'permission_callback' => __CLASS__ . '::unlink_user_permission_callback',
) );
// Get current site data
register_rest_route( 'jetpack/v4', '/site', array(
'methods' => WP_REST_Server::READABLE,
'callback' => __CLASS__ . '::get_site_data',
'permission_callback' => __CLASS__ . '::view_admin_page_permission_check',
) );
// Get current site data
register_rest_route( 'jetpack/v4', '/site/features', array(
'methods' => WP_REST_Server::READABLE,
'callback' => array( $site_endpoint, 'get_features' ),
'permission_callback' => array( $site_endpoint , 'can_request' ),
) );
// Confirm that a site in identity crisis should be in staging mode
register_rest_route( 'jetpack/v4', '/identity-crisis/confirm-safe-mode', array(
'methods' => WP_REST_Server::EDITABLE,
'callback' => __CLASS__ . '::confirm_safe_mode',
'permission_callback' => __CLASS__ . '::identity_crisis_mitigation_permission_check',
) );
// IDC resolve: create an entirely new shadow site for this URL.
register_rest_route( 'jetpack/v4', '/identity-crisis/start-fresh', array(
'methods' => WP_REST_Server::EDITABLE,
'callback' => __CLASS__ . '::start_fresh_connection',
'permission_callback' => __CLASS__ . '::identity_crisis_mitigation_permission_check',
) );
// Handles the request to migrate stats and subscribers during an identity crisis.
register_rest_route( 'jetpack/v4', 'identity-crisis/migrate', array(
'methods' => WP_REST_Server::EDITABLE,
'callback' => __CLASS__ . '::migrate_stats_and_subscribers',
'permissison_callback' => __CLASS__ . '::identity_crisis_mitigation_permission_check',
) );
// Return all modules
register_rest_route( 'jetpack/v4', '/module/all', array(
'methods' => WP_REST_Server::READABLE,
'callback' => array( $module_list_endpoint, 'process' ),
'permission_callback' => array( $module_list_endpoint, 'can_request' ),
) );
// Activate many modules
register_rest_route( 'jetpack/v4', '/module/all/active', array(
'methods' => WP_REST_Server::EDITABLE,
'callback' => array( $module_list_endpoint, 'process' ),
'permission_callback' => array( $module_list_endpoint, 'can_request' ),
'args' => array(
'modules' => array(
'default' => '',
'type' => 'array',
'items' => array(
'type' => 'string',
),
'required' => true,
'validate_callback' => __CLASS__ . '::validate_module_list',
),
'active' => array(
'default' => true,
'type' => 'boolean',
'required' => false,
'validate_callback' => __CLASS__ . '::validate_boolean',
),
)
) );
// Return a single module and update it when needed
register_rest_route( 'jetpack/v4', '/module/(?P<slug>[a-z\-]+)', array(
'methods' => WP_REST_Server::READABLE,
'callback' => array( $core_api_endpoint, 'process' ),
'permission_callback' => array( $core_api_endpoint, 'can_request' ),
) );
// Activate and deactivate a module
register_rest_route( 'jetpack/v4', '/module/(?P<slug>[a-z\-]+)/active', array(
'methods' => WP_REST_Server::EDITABLE,
'callback' => array( $module_toggle_endpoint, 'process' ),
'permission_callback' => array( $module_toggle_endpoint, 'can_request' ),
'args' => array(
'active' => array(
'default' => true,
'type' => 'boolean',
'required' => true,
'validate_callback' => __CLASS__ . '::validate_boolean',
),
)
) );
// Update a module
register_rest_route( 'jetpack/v4', '/module/(?P<slug>[a-z\-]+)', array(
'methods' => WP_REST_Server::EDITABLE,
'callback' => array( $core_api_endpoint, 'process' ),
'permission_callback' => array( $core_api_endpoint, 'can_request' ),
'args' => self::get_updateable_parameters( 'any' )
) );
// Get data for a specific module, i.e. Protect block count, WPCOM stats,
// Akismet spam count, etc.
register_rest_route( 'jetpack/v4', '/module/(?P<slug>[a-z\-]+)/data', array(
'methods' => WP_REST_Server::READABLE,
'callback' => array( $module_data_endpoint, 'process' ),
'permission_callback' => array( $module_data_endpoint, 'can_request' ),
'args' => array(
'range' => array(
'default' => 'day',
'type' => 'string',
'required' => false,
'validate_callback' => __CLASS__ . '::validate_string',
),
)
) );
// Check if the API key for a specific service is valid or not
register_rest_route( 'jetpack/v4', '/module/(?P<service>[a-z\-]+)/key/check', array(
'methods' => WP_REST_Server::READABLE,
'callback' => array( $module_data_endpoint, 'key_check' ),
'permission_callback' => __CLASS__ . '::update_settings_permission_check',
'sanitize_callback' => 'sanitize_text_field',
) );
register_rest_route( 'jetpack/v4', '/module/(?P<service>[a-z\-]+)/key/check', array(
'methods' => WP_REST_Server::EDITABLE,
'callback' => array( $module_data_endpoint, 'key_check' ),
'permission_callback' => __CLASS__ . '::update_settings_permission_check',
'sanitize_callback' => 'sanitize_text_field',
'args' => array(
'api_key' => array(
'default' => '',
'type' => 'string',
'validate_callback' => __CLASS__ . '::validate_alphanum',
),
)
) );
// Update any Jetpack module option or setting
register_rest_route( 'jetpack/v4', '/settings', array(
'methods' => WP_REST_Server::EDITABLE,
'callback' => array( $core_api_endpoint, 'process' ),
'permission_callback' => array( $core_api_endpoint, 'can_request' ),
'args' => self::get_updateable_parameters( 'any' )
) );
// Update a module
register_rest_route( 'jetpack/v4', '/settings/(?P<slug>[a-z\-]+)', array(
'methods' => WP_REST_Server::EDITABLE,
'callback' => array( $core_api_endpoint, 'process' ),
'permission_callback' => array( $core_api_endpoint, 'can_request' ),
'args' => self::get_updateable_parameters()
) );
// Return all module settings
register_rest_route( 'jetpack/v4', '/settings/', array(
'methods' => WP_REST_Server::READABLE,
'callback' => array( $core_api_endpoint, 'process' ),
'permission_callback' => array( $core_api_endpoint, 'can_request' ),
) );
// Reset all Jetpack options
register_rest_route( 'jetpack/v4', '/options/(?P<options>[a-z\-]+)', array(
'methods' => WP_REST_Server::EDITABLE,
'callback' => __CLASS__ . '::reset_jetpack_options',
'permission_callback' => __CLASS__ . '::manage_modules_permission_check',
) );
// Return current Jumpstart status
register_rest_route( 'jetpack/v4', '/jumpstart', array(
'methods' => WP_REST_Server::READABLE,
'callback' => __CLASS__ . '::jumpstart_status',
'permission_callback' => __CLASS__ . '::update_settings_permission_check',
) );
// Update Jumpstart
register_rest_route( 'jetpack/v4', '/jumpstart', array(
'methods' => WP_REST_Server::EDITABLE,
'callback' => __CLASS__ . '::jumpstart_toggle',
'permission_callback' => __CLASS__ . '::manage_modules_permission_check',
'args' => array(
'active' => array(
'required' => true,
'validate_callback' => __CLASS__ . '::validate_boolean',
),
),
) );
// Updates: get number of plugin updates available
register_rest_route( 'jetpack/v4', '/updates/plugins', array(
'methods' => WP_REST_Server::READABLE,
'callback' => __CLASS__ . '::get_plugin_update_count',
'permission_callback' => __CLASS__ . '::view_admin_page_permission_check',
) );
// Dismiss Jetpack Notices
register_rest_route( 'jetpack/v4', '/notice/(?P<notice>[a-z\-_]+)', array(
'methods' => WP_REST_Server::EDITABLE,
'callback' => __CLASS__ . '::dismiss_notice',
'permission_callback' => __CLASS__ . '::view_admin_page_permission_check',
) );
// Plugins: get list of all plugins.
register_rest_route( 'jetpack/v4', '/plugins', array(
'methods' => WP_REST_Server::READABLE,
'callback' => __CLASS__ . '::get_plugins',
'permission_callback' => __CLASS__ . '::activate_plugins_permission_check',
) );
// Plugins: check if the plugin is active.
register_rest_route( 'jetpack/v4', '/plugin/(?P<plugin>[a-z\/\.\-_]+)', array(
'methods' => WP_REST_Server::READABLE,
'callback' => __CLASS__ . '::get_plugin',
'permission_callback' => __CLASS__ . '::activate_plugins_permission_check',
) );
// Widgets: get information about a widget that supports it.
register_rest_route( 'jetpack/v4', '/widgets/(?P<id>[0-9a-z\-_]+)', array(
'methods' => WP_REST_Server::READABLE,
'callback' => array( $widget_endpoint, 'process' ),
'permission_callback' => array( $widget_endpoint, 'can_request' ),
) );
}
public static function get_plans( $request ) {
$request = Jetpack_Client::wpcom_json_api_request_as_user(
'/plans?_locale=' . get_user_locale(),
'2',
array(
'method' => 'GET',
'headers' => array(
'X-Forwarded-For' => Jetpack::current_user_ip( true ),
),
)
);
$body = wp_remote_retrieve_body( $request );
if ( 200 === wp_remote_retrieve_response_code( $request ) ) {
$data = $body;
} else {
// something went wrong so we'll just return the response without caching
return $body;
}
return $data;
}
/**
* Asks for a jitm, unless they've been disabled, in which case it returns an empty array
*
* @param $request WP_REST_Request
*
* @return array An array of jitms
*/
public static function get_jitm_message( $request ) {
require_once( JETPACK__PLUGIN_DIR . 'class.jetpack-jitm.php' );
$jitm = Jetpack_JITM::init();
if ( ! $jitm ) {
return array();
}
return $jitm->get_messages( $request['message_path'], urldecode_deep( $request['query'] ) );
}
/**
* Dismisses a jitm
* @param $request WP_REST_Request The request
*
* @return bool Always True
*/
public static function delete_jitm_message( $request ) {
require_once( JETPACK__PLUGIN_DIR . 'class.jetpack-jitm.php' );
$jitm = Jetpack_JITM::init();
if ( ! $jitm ) {
return true;
}
return $jitm->dismiss( $request['id'], $request['feature_class'] );
}
/**
* Handles verification that a site is registered
*
* @since 5.4.0
*
* @param WP_REST_Request $request The request sent to the WP REST API.
*
* @return array|wp-error
*/
public static function verify_registration( $request ) {
require_once JETPACK__PLUGIN_DIR . 'class.jetpack-xmlrpc-server.php';
$xmlrpc_server = new Jetpack_XMLRPC_Server();
$result = $xmlrpc_server->verify_registration( array( $request['secret_1'], $request['state'] ) );
if ( is_a( $result, 'IXR_Error' ) ) {
$result = new WP_Error( $result->code, $result->message );
}
return $result;
}
/**
* Handles verification that a site is registered
*
* @since 5.4.0
*
* @param WP_REST_Request $request The request sent to the WP REST API.
*
* @return array|wp-error
*/
public static function remote_authorize( $request ) {
require_once JETPACK__PLUGIN_DIR . 'class.jetpack-xmlrpc-server.php';
$xmlrpc_server = new Jetpack_XMLRPC_Server();
$result = $xmlrpc_server->remote_authorize( $request );
if ( is_a( $result, 'IXR_Error' ) ) {
$result = new WP_Error( $result->code, $result->message );
}
return $result;
}
/**
* Handles dismissing of Jetpack Notices
*
* @since 4.3.0
*
* @param WP_REST_Request $request The request sent to the WP REST API.
*
* @return array|wp-error
*/
public static function dismiss_notice( $request ) {
$notice = $request['notice'];
if ( ! isset( $request['dismissed'] ) || $request['dismissed'] !== true ) {
return new WP_Error( 'invalid_param', esc_html__( 'Invalid parameter "dismissed".', 'jetpack' ), array( 'status' => 404 ) );
}
if ( isset( $notice ) && ! empty( $notice ) ) {
switch( $notice ) {
case 'feedback_dash_request':
case 'welcome':
$notices = get_option( 'jetpack_dismissed_notices', array() );
$notices[ $notice ] = true;
update_option( 'jetpack_dismissed_notices', $notices );
return rest_ensure_response( get_option( 'jetpack_dismissed_notices', array() ) );
default:
return new WP_Error( 'invalid_param', esc_html__( 'Invalid parameter "notice".', 'jetpack' ), array( 'status' => 404 ) );
}
}
return new WP_Error( 'required_param', esc_html__( 'Missing parameter "notice".', 'jetpack' ), array( 'status' => 404 ) );
}
/**
* Verify that the user can disconnect the site.
*
* @since 4.3.0
*
* @return bool|WP_Error True if user is able to disconnect the site.
*/
public static function disconnect_site_permission_callback() {
if ( current_user_can( 'jetpack_disconnect' ) ) {
return true;
}
return new WP_Error( 'invalid_user_permission_jetpack_disconnect', self::$user_permissions_error_msg, array( 'status' => self::rest_authorization_required_code() ) );
}
/**
* Verify that the user can get a connect/link URL
*
* @since 4.3.0
*
* @return bool|WP_Error True if user is able to disconnect the site.
*/
public static function connect_url_permission_callback() {
if ( current_user_can( 'jetpack_connect_user' ) ) {
return true;
}
return new WP_Error( 'invalid_user_permission_jetpack_disconnect', self::$user_permissions_error_msg, array( 'status' => self::rest_authorization_required_code() ) );
}
/**
* Verify that a user can get the data about the current user.
* Only those who can connect.
*
* @since 4.3.0
*
* @uses Jetpack::is_user_connected();
*
* @return bool|WP_Error True if user is able to unlink.
*/
public static function get_user_connection_data_permission_callback() {
if ( current_user_can( 'jetpack_connect_user' ) ) {
return true;
}
return new WP_Error( 'invalid_user_permission_user_connection_data', self::$user_permissions_error_msg, array( 'status' => self::rest_authorization_required_code() ) );
}
/**
* Check that user has permission to change the master user.
*
* @since 6.2.0
*
* @return bool|WP_Error True if user is able to change master user.
*/
public static function set_connection_owner_permission_callback() {
if ( get_current_user_id() === Jetpack_Options::get_option( 'master_user' ) ) {
return true;
}
return new WP_Error( 'invalid_user_permission_set_connection_owner', self::$user_permissions_error_msg, array( 'status' => self::rest_authorization_required_code() ) );
}
/**
* Verify that a user can use the /connection/user endpoint. Has to be a registered user and be currently linked.
*
* @since 4.3.0
*
* @uses Jetpack::is_user_connected();
*
* @return bool|WP_Error True if user is able to unlink.
*/
public static function unlink_user_permission_callback() {
if ( current_user_can( 'jetpack_connect_user' ) && Jetpack::is_user_connected( get_current_user_id() ) ) {
return true;
}
return new WP_Error( 'invalid_user_permission_unlink_user', self::$user_permissions_error_msg, array( 'status' => self::rest_authorization_required_code() ) );
}
/**
* Verify that user can manage Jetpack modules.
*
* @since 4.3.0
*
* @return bool Whether user has the capability 'jetpack_manage_modules'.
*/
public static function manage_modules_permission_check() {
if ( current_user_can( 'jetpack_manage_modules' ) ) {
return true;
}
return new WP_Error( 'invalid_user_permission_manage_modules', self::$user_permissions_error_msg, array( 'status' => self::rest_authorization_required_code() ) );
}
/**
* Verify that user can update Jetpack modules.
*
* @since 4.3.0
*
* @return bool Whether user has the capability 'jetpack_configure_modules'.
*/
public static function configure_modules_permission_check() {
if ( current_user_can( 'jetpack_configure_modules' ) ) {
return true;
}
return new WP_Error( 'invalid_user_permission_configure_modules', self::$user_permissions_error_msg, array( 'status' => self::rest_authorization_required_code() ) );
}
/**
* Verify that user can view Jetpack admin page.
*
* @since 4.3.0
*
* @return bool Whether user has the capability 'jetpack_admin_page'.
*/
public static function view_admin_page_permission_check() {
if ( current_user_can( 'jetpack_admin_page' ) ) {
return true;
}
return new WP_Error( 'invalid_user_permission_view_admin', self::$user_permissions_error_msg, array( 'status' => self::rest_authorization_required_code() ) );
}
/**
* Verify that user can mitigate an identity crisis.
*
* @since 4.4.0
*
* @return bool Whether user has capability 'jetpack_disconnect'.
*/
public static function identity_crisis_mitigation_permission_check() {
if ( current_user_can( 'jetpack_disconnect' ) ) {
return true;
}
return new WP_Error( 'invalid_user_permission_identity_crisis', self::$user_permissions_error_msg, array( 'status' => self::rest_authorization_required_code() ) );
}
/**
* Verify that user can update Jetpack general settings.
*
* @since 4.3.0
*
* @return bool Whether user has the capability 'update_settings_permission_check'.
*/
public static function update_settings_permission_check() {
if ( current_user_can( 'jetpack_configure_modules' ) ) {
return true;
}
return new WP_Error( 'invalid_user_permission_manage_settings', self::$user_permissions_error_msg, array( 'status' => self::rest_authorization_required_code() ) );
}
/**
* Verify that user can view Jetpack admin page and can activate plugins.
*
* @since 4.3.0
*
* @return bool Whether user has the capability 'jetpack_admin_page' and 'activate_plugins'.
*/
public static function activate_plugins_permission_check() {
if ( current_user_can( 'jetpack_admin_page' ) && current_user_can( 'activate_plugins' ) ) {
return true;
}
return new WP_Error( 'invalid_user_permission_activate_plugins', self::$user_permissions_error_msg, array( 'status' => self::rest_authorization_required_code() ) );
}
/**
* Contextual HTTP error code for authorization failure.
*
* Taken from rest_authorization_required_code() in WP-API plugin until is added to core.
* @see https://github.com/WP-API/WP-API/commit/7ba0ae6fe4f605d5ffe4ee85b1cd5f9fb46900a6
*
* @since 4.3.0
*
* @return int
*/
public static function rest_authorization_required_code() {
return is_user_logged_in() ? 403 : 401;
}
/**
* Get connection status for this Jetpack site.
*
* @since 4.3.0
*
* @return bool True if site is connected
*/
public static function jetpack_connection_status() {
return rest_ensure_response( array(
'isActive' => Jetpack::is_active(),
'isStaging' => Jetpack::is_staging_site(),
'devMode' => array(
'isActive' => Jetpack::is_development_mode(),
'constant' => defined( 'JETPACK_DEV_DEBUG' ) && JETPACK_DEV_DEBUG,
'url' => site_url() && false === strpos( site_url(), '.' ),
'filter' => apply_filters( 'jetpack_development_mode', false ),
),
)
);
}
public static function rewind_data() {
$site_id = Jetpack_Options::get_option( 'id' );
if ( ! $site_id ) {
return new WP_Error( 'site_id_missing' );
}
$response = Jetpack_Client::wpcom_json_api_request_as_blog( sprintf( '/sites/%d/rewind', $site_id ) .'?force=wpcom', '2', array(), null, 'wpcom' );
if ( 200 !== wp_remote_retrieve_response_code( $response ) ) {
return new WP_Error( 'rewind_data_fetch_failed' );
}
$body = wp_remote_retrieve_body( $response );
return json_decode( $body );
}
/**
* Get rewind data
*
* @since 5.7.0
*
* @return array Array of rewind properties.
*/
public static function get_rewind_data() {
$rewind_data = self::rewind_data();
if ( ! is_wp_error( $rewind_data ) ) {
return rest_ensure_response( array(
'code' => 'success',
'message' => esc_html__( 'Rewind data correctly received.', 'jetpack' ),
'data' => wp_json_encode( $rewind_data ),
)
);
}
if ( $rewind_data->get_error_code() === 'rewind_data_fetch_failed' ) {
return new WP_Error( 'rewind_data_fetch_failed', esc_html__( 'Failed fetching rewind data. Try again later.', 'jetpack' ), array( 'status' => 400 ) );
}
if ( $rewind_data->get_error_code() === 'site_id_missing' ) {
return new WP_Error( 'site_id_missing', esc_html__( 'The ID of this site does not exist.', 'jetpack' ), array( 'status' => 404 ) );
}
return new WP_Error(
'error_get_rewind_data',
esc_html__( 'Could not retrieve Rewind data.', 'jetpack' ),
array( 'status' => 500 )
);
}
/**
* Disconnects Jetpack from the WordPress.com Servers
*
* @uses Jetpack::disconnect();
* @since 4.3.0
*
* @param WP_REST_Request $request The request sent to the WP REST API.
*
* @return bool|WP_Error True if Jetpack successfully disconnected.
*/
public static function disconnect_site( $request ) {
if ( ! isset( $request['isActive'] ) || $request['isActive'] !== false ) {
return new WP_Error( 'invalid_param', esc_html__( 'Invalid Parameter', 'jetpack' ), array( 'status' => 404 ) );
}
if ( Jetpack::is_active() ) {
Jetpack::disconnect();
return rest_ensure_response( array( 'code' => 'success' ) );
}
return new WP_Error( 'disconnect_failed', esc_html__( 'Was not able to disconnect the site. Please try again.', 'jetpack' ), array( 'status' => 400 ) );
}
/**
* Gets a new connect raw URL with fresh nonce.
*
* @uses Jetpack::disconnect();
* @since 4.3.0
*
* @param WP_REST_Request $request The request sent to the WP REST API.
*
* @return string|WP_Error A raw URL if the connection URL could be built; error message otherwise.
*/
public static function build_connect_url() {
$url = Jetpack::init()->build_connect_url( true, false, false );
if ( $url ) {
return rest_ensure_response( $url );
}
return new WP_Error( 'build_connect_url_failed', esc_html__( 'Unable to build the connect URL. Please reload the page and try again.', 'jetpack' ), array( 'status' => 400 ) );
}
/**
* Get miscellaneous user data related to the connection. Similar data available in old "My Jetpack".
* Information about the master/primary user.
* Information about the current user.
*
* @since 4.3.0
*
* @param WP_REST_Request $request The request sent to the WP REST API.
*
* @return object
*/
public static function get_user_connection_data() {
require_once( JETPACK__PLUGIN_DIR . '_inc/lib/admin-pages/class.jetpack-react-page.php' );
$response = array(
// 'othersLinked' => Jetpack::get_other_linked_admins(),
'currentUser' => jetpack_current_user_data(),
);
return rest_ensure_response( $response );
}
/**
* Change the master user.
*
* @since 6.2.0
*
* @param WP_REST_Request $request The request sent to the WP REST API.
*
* @return bool|WP_Error True if owner successfully changed.
*/
public static function set_connection_owner( $request ) {
if ( ! isset( $request['owner'] ) ) {
return new WP_Error(
'invalid_param',
esc_html__( 'Invalid Parameter', 'jetpack' ),
array( 'status' => 400 )
);
}
$new_owner_id = $request['owner'];
if ( ! user_can( $new_owner_id, 'administrator' ) ) {
return new WP_Error(
'new_owner_not_admin',
esc_html__( 'New owner is not admin', 'jetpack' ),
array( 'status' => 400 )
);
}
if ( $new_owner_id === get_current_user_id() ) {
return new WP_Error(
'new_owner_is_current_user',
esc_html__( 'New owner is same as current user', 'jetpack' ),
array( 'status' => 400 )
);
}
if ( ! Jetpack::is_user_connected( $new_owner_id ) ) {
return new WP_Error(
'new_owner_not_connected',
esc_html__( 'New owner is not connected', 'jetpack' ),
array( 'status' => 400 )
);
}
$updated = Jetpack_Options::update_option( 'master_user', $new_owner_id );
if ( $updated ) {
return rest_ensure_response(
array(
'code' => 'success'
)
);
}
return new WP_Error(
'error_setting_new_owner',
esc_html__( 'Could not confirm new owner.', 'jetpack' ),
array( 'status' => 500 )
);
}
/**
* Unlinks current user from the WordPress.com Servers.
*
* @since 4.3.0
* @uses Jetpack::unlink_user
*
* @param WP_REST_Request $request The request sent to the WP REST API.
*
* @return bool|WP_Error True if user successfully unlinked.
*/
public static function unlink_user( $request ) {
if ( ! isset( $request['linked'] ) || $request['linked'] !== false ) {
return new WP_Error( 'invalid_param', esc_html__( 'Invalid Parameter', 'jetpack' ), array( 'status' => 404 ) );
}
if ( Jetpack::unlink_user() ) {
return rest_ensure_response(
array(
'code' => 'success'
)
);
}
return new WP_Error( 'unlink_user_failed', esc_html__( 'Was not able to unlink the user. Please try again.', 'jetpack' ), array( 'status' => 400 ) );
}
/**
* Gets current user's tracking settings.
*
* @since 6.0.0
*
* @param WP_REST_Request $request The request sent to the WP REST API.
*
* @return WP_REST_Response|WP_Error Response, else error.
*/
public static function get_user_tracking_settings( $request ) {
if ( ! Jetpack::is_user_connected() ) {
$response = array(
'tracks_opt_out' => true, // Default to opt-out if not connected to wp.com.
);
} else {
$response = Jetpack_Client::wpcom_json_api_request_as_user(
'/jetpack-user-tracking',
'v2',
array(
'method' => 'GET',
'headers' => array(
'X-Forwarded-For' => Jetpack::current_user_ip( true ),
),
)
);
if ( ! is_wp_error( $response ) ) {
$response = json_decode( wp_remote_retrieve_body( $response ), true );
}
}
return rest_ensure_response( $response );
}
/**
* Updates current user's tracking settings.
*
* @since 6.0.0
*
* @param WP_REST_Request $request The request sent to the WP REST API.
*
* @return WP_REST_Response|WP_Error Response, else error.
*/
public static function update_user_tracking_settings( $request ) {
if ( ! Jetpack::is_user_connected() ) {
$response = array(
'tracks_opt_out' => true, // Default to opt-out if not connected to wp.com.
);
} else {
$response = Jetpack_Client::wpcom_json_api_request_as_user(
'/jetpack-user-tracking',
'v2',
array(
'method' => 'PUT',
'headers' => array(
'Content-Type' => 'application/json',
'X-Forwarded-For' => Jetpack::current_user_ip( true ),
),
),
wp_json_encode( $request->get_params() )
);
if ( ! is_wp_error( $response ) ) {
$response = json_decode( wp_remote_retrieve_body( $response ), true );
}
}
return rest_ensure_response( $response );
}
/**
* Fetch site data from .com including the site's current plan.
*
* @since 5.5.0
*
* @return array Array of site properties.
*/
public static function site_data() {
$site_id = Jetpack_Options::get_option( 'id' );
if ( ! $site_id ) {
new WP_Error( 'site_id_missing' );
}
$response = Jetpack_Client::wpcom_json_api_request_as_blog( sprintf( '/sites/%d', $site_id ) .'?force=wpcom', '1.1' );
if ( 200 !== wp_remote_retrieve_response_code( $response ) ) {
return new WP_Error( 'site_data_fetch_failed' );
}
// Save plan details in the database for future use without API calls
$results = json_decode( $response['body'], true );
if ( is_array( $results ) && isset( $results['plan'] ) ) {
// Set flag for newly purchased plan
$current_plan = Jetpack::get_active_plan();
if ( $current_plan['product_slug'] !== $results['plan']['product_slug'] && 'jetpack_free' !== $results['plan']['product_slug'] ) {
update_option( 'show_welcome_for_new_plan', true ) ;
}
update_option( 'jetpack_active_plan', $results['plan'] );
}
$body = wp_remote_retrieve_body( $response );
return json_decode( $body );
}
/**
* Get site data, including for example, the site's current plan.
*
* @since 4.3.0
*
* @return array Array of site properties.
*/
public static function get_site_data() {
$site_data = self::site_data();
if ( ! is_wp_error( $site_data ) ) {
return rest_ensure_response( array(
'code' => 'success',
'message' => esc_html__( 'Site data correctly received.', 'jetpack' ),
'data' => json_encode( $site_data ),
)
);
}
if ( $site_data->get_error_code() === 'site_data_fetch_failed' ) {
return new WP_Error( 'site_data_fetch_failed', esc_html__( 'Failed fetching site data. Try again later.', 'jetpack' ), array( 'status' => 400 ) );
}
if ( $site_data->get_error_code() === 'site_id_missing' ) {
return new WP_Error( 'site_id_missing', esc_html__( 'The ID of this site does not exist.', 'jetpack' ), array( 'status' => 404 ) );
}
}
/**
* Handles identity crisis mitigation, confirming safe mode for this site.
*
* @since 4.4.0
*
* @return bool | WP_Error True if option is properly set.
*/
public static function confirm_safe_mode() {
$updated = Jetpack_Options::update_option( 'safe_mode_confirmed', true );
if ( $updated ) {
return rest_ensure_response(
array(
'code' => 'success'
)
);
}
return new WP_Error(
'error_setting_jetpack_safe_mode',
esc_html__( 'Could not confirm safe mode.', 'jetpack' ),
array( 'status' => 500 )
);
}
/**
* Handles identity crisis mitigation, migrating stats and subscribers from old url to this, new url.
*
* @since 4.4.0
*
* @return bool | WP_Error True if option is properly set.
*/
public static function migrate_stats_and_subscribers() {
if ( Jetpack_Options::get_option( 'sync_error_idc' ) && ! Jetpack_Options::delete_option( 'sync_error_idc' ) ) {
return new WP_Error(
'error_deleting_sync_error_idc',
esc_html__( 'Could not delete sync error option.', 'jetpack' ),
array( 'status' => 500 )
);
}
if ( Jetpack_Options::get_option( 'migrate_for_idc' ) || Jetpack_Options::update_option( 'migrate_for_idc', true ) ) {
return rest_ensure_response(
array(
'code' => 'success'
)
);
}
return new WP_Error(
'error_setting_jetpack_migrate',
esc_html__( 'Could not confirm migration.', 'jetpack' ),
array( 'status' => 500 )
);
}
/**
* This IDC resolution will disconnect the site and re-connect to a completely new
* and separate shadow site than the original.
*
* It will first will disconnect the site without phoning home as to not disturb the production site.
* It then builds a fresh connection URL and sends it back along with the response.
*
* @since 4.4.0
* @return bool|WP_Error
*/
public static function start_fresh_connection() {
// First clear the options / disconnect.
Jetpack::disconnect();
return self::build_connect_url();
}
/**
* Reset Jetpack options
*
* @since 4.3.0
*
* @param WP_REST_Request $request {
* Array of parameters received by request.
*
* @type string $options Available options to reset are options|modules
* }
*
* @return bool|WP_Error True if options were reset. Otherwise, a WP_Error instance with the corresponding error.
*/
public static function reset_jetpack_options( $request ) {
if ( ! isset( $request['reset'] ) || $request['reset'] !== true ) {
return new WP_Error( 'invalid_param', esc_html__( 'Invalid Parameter', 'jetpack' ), array( 'status' => 404 ) );
}
if ( isset( $request['options'] ) ) {
$data = $request['options'];
switch( $data ) {
case ( 'options' ) :
$options_to_reset = Jetpack::get_jetpack_options_for_reset();
// Reset the Jetpack options
foreach ( $options_to_reset['jp_options'] as $option_to_reset ) {
Jetpack_Options::delete_option( $option_to_reset );
}
foreach ( $options_to_reset['wp_options'] as $option_to_reset ) {
delete_option( $option_to_reset );
}
// Reset to default modules
$default_modules = Jetpack::get_default_modules();
Jetpack::update_active_modules( $default_modules );
// Jumpstart option is special
Jetpack_Options::update_option( 'jumpstart', 'new_connection' );
return rest_ensure_response( array(
'code' => 'success',
'message' => esc_html__( 'Jetpack options reset.', 'jetpack' ),
) );
break;
case 'modules':
$default_modules = Jetpack::get_default_modules();
Jetpack::update_active_modules( $default_modules );
return rest_ensure_response( array(
'code' => 'success',
'message' => esc_html__( 'Modules reset to default.', 'jetpack' ),
) );
break;
default:
return new WP_Error( 'invalid_param', esc_html__( 'Invalid Parameter', 'jetpack' ), array( 'status' => 404 ) );
}
}
return new WP_Error( 'required_param', esc_html__( 'Missing parameter "type".', 'jetpack' ), array( 'status' => 404 ) );
}
/**
* Retrieves the current status of Jumpstart.
*
* @since 4.5.0
*
* @return bool
*/
public static function jumpstart_status() {
return array(
'status' => Jetpack_Options::get_option( 'jumpstart' )
);
}
/**
* Toggles activation or deactivation of the JumpStart
*
* @since 4.3.0
*
* @param WP_REST_Request $request The request sent to the WP REST API.
*
* @return bool|WP_Error True if toggling Jumpstart succeeded. Otherwise, a WP_Error instance with the corresponding error.
*/
public static function jumpstart_toggle( $request ) {
if ( $request[ 'active' ] ) {
return self::jumpstart_activate( $request );
} else {
return self::jumpstart_deactivate( $request );
}
}
/**
* Activates a series of valid Jetpack modules and initializes some options.
*
* @since 4.3.0
*
* @param WP_REST_Request $request The request sent to the WP REST API.
*
* @return bool|WP_Error True if Jumpstart succeeded. Otherwise, a WP_Error instance with the corresponding error.
*/
public static function jumpstart_activate( $request ) {
$modules = Jetpack::get_available_modules();
$activate_modules = array();
foreach ( $modules as $module ) {
$module_info = Jetpack::get_module( $module );
if ( isset( $module_info['feature'] ) && is_array( $module_info['feature'] ) && in_array( 'Jumpstart', $module_info['feature'] ) ) {
$activate_modules[] = $module;
}
}
// Collect success/error messages like modules that are properly activated.
$result = array(
'activated_modules' => array(),
'failed_modules' => array(),
);
// Update the jumpstart option
if ( 'new_connection' === Jetpack_Options::get_option( 'jumpstart' ) ) {
$result['jumpstart_activated'] = Jetpack_Options::update_option( 'jumpstart', 'jumpstart_activated' );
}
// Check for possible conflicting plugins
$module_slugs_filtered = Jetpack::init()->filter_default_modules( $activate_modules );
foreach ( $module_slugs_filtered as $module_slug ) {
Jetpack::log( 'activate', $module_slug );
if ( Jetpack::activate_module( $module_slug, false, false ) ) {
$result['activated_modules'][] = $module_slug;
} else {
$result['failed_modules'][] = $module_slug;
}
}
// Set the default sharing buttons and set to display on posts if none have been set.
$sharing_services = get_option( 'sharing-services' );
$sharing_options = get_option( 'sharing-options' );
if ( empty( $sharing_services['visible'] ) ) {
// Default buttons to set
$visible = array(
'twitter',
'facebook',
'google-plus-1',
);
$hidden = array();
// Set some sharing settings
if ( class_exists( 'Sharing_Service' ) ) {
$sharing = new Sharing_Service();
$sharing_options['global'] = array(
'button_style' => 'icon',
'sharing_label' => $sharing->default_sharing_label,
'open_links' => 'same',
'show' => array( 'post' ),
'custom' => isset( $sharing_options['global']['custom'] ) ? $sharing_options['global']['custom'] : array()
);
$result['sharing_options'] = update_option( 'sharing-options', $sharing_options );
$result['sharing_services'] = update_option( 'sharing-services', array( 'visible' => $visible, 'hidden' => $hidden ) );
}
}
// If all Jumpstart modules were activated
if ( empty( $result['failed_modules'] ) ) {
return rest_ensure_response( array(
'code' => 'success',
'message' => esc_html__( 'Jumpstart done.', 'jetpack' ),
'data' => $result,
) );
}
return new WP_Error( 'jumpstart_failed', esc_html( sprintf( _n( 'Jumpstart failed activating this module: %s.', 'Jumpstart failed activating these modules: %s.', count( $result['failed_modules'] ), 'jetpack' ), join( ', ', $result['failed_modules'] ) ) ), array( 'status' => 400 ) );
}
/**
* Dismisses Jumpstart so user is not prompted to go through it again.
*
* @since 4.3.0
*
* @param WP_REST_Request $request The request sent to the WP REST API.
*
* @return bool|WP_Error True if Jumpstart was disabled or was nothing to dismiss. Otherwise, a WP_Error instance with a message.
*/
public static function jumpstart_deactivate( $request ) {
// If dismissed, flag the jumpstart option as such.
if ( 'new_connection' === Jetpack_Options::get_option( 'jumpstart' ) ) {
if ( Jetpack_Options::update_option( 'jumpstart', 'jumpstart_dismissed' ) ) {
return rest_ensure_response( array(
'code' => 'success',
'message' => esc_html__( 'Jumpstart dismissed.', 'jetpack' ),
) );
} else {
return new WP_Error( 'jumpstart_failed_dismiss', esc_html__( 'Jumpstart could not be dismissed.', 'jetpack' ), array( 'status' => 400 ) );
}
}
// If this was not a new connection and there was nothing to dismiss, don't fail.
return rest_ensure_response( array(
'code' => 'success',
'message' => esc_html__( 'Nothing to dismiss. This was not a new connection.', 'jetpack' ),
) );
}
/**
* Get the query parameters to update module options or general settings.
*
* @since 4.3.0
* @since 4.4.0 Accepts a $selector parameter.
*
* @param string $selector Selects a set of options to update, Can be empty, a module slug or 'any'.
*
* @return array
*/
public static function get_updateable_parameters( $selector = '' ) {
$parameters = array(
'context' => array(
'default' => 'edit',
),
);
return array_merge( $parameters, self::get_updateable_data_list( $selector ) );
}
/**
* Returns a list of module options or general settings that can be updated.
*
* @since 4.3.0
* @since 4.4.0 Accepts 'any' as a parameter which will make it return the entire list.
*
* @param string|array $selector Module slug, 'any', or an array of parameters.
* If empty, it's assumed we're updating a module and we'll try to get its slug.
* If 'any' the full list is returned.
* If it's an array of parameters, includes the elements by matching keys.
*
* @return array
*/
public static function get_updateable_data_list( $selector = '' ) {
$options = array(
// Carousel
'carousel_background_color' => array(
'description' => esc_html__( 'Color scheme.', 'jetpack' ),
'type' => 'string',
'default' => 'black',
'enum' => array(
'black',
'white',
),
'enum_labels' => array(
'black' => esc_html__( 'Black', 'jetpack' ),
'white' => esc_html__( 'White', 'jetpack' ),
),
'validate_callback' => __CLASS__ . '::validate_list_item',
'jp_group' => 'carousel',
),
'carousel_display_exif' => array(
'description' => wp_kses( sprintf( __( 'Show photo metadata (<a href="http://en.wikipedia.org/wiki/Exchangeable_image_file_format" target="_blank">Exif</a>) in carousel, when available.', 'jetpack' ) ), array( 'a' => array( 'href' => true, 'target' => true ) ) ),
'type' => 'boolean',
'default' => 0,
'validate_callback' => __CLASS__ . '::validate_boolean',
'jp_group' => 'carousel',
),
// Comments
'highlander_comment_form_prompt' => array(
'description' => esc_html__( 'Greeting Text', 'jetpack' ),
'type' => 'string',
'default' => esc_html__( 'Leave a Reply', 'jetpack' ),
'sanitize_callback' => 'sanitize_text_field',
'jp_group' => 'comments',
),
'jetpack_comment_form_color_scheme' => array(
'description' => esc_html__( "Color scheme", 'jetpack' ),
'type' => 'string',
'default' => 'light',
'enum' => array(
'light',
'dark',
'transparent',
),
'enum_labels' => array(
'light' => esc_html__( 'Light', 'jetpack' ),
'dark' => esc_html__( 'Dark', 'jetpack' ),
'transparent' => esc_html__( 'Transparent', 'jetpack' ),
),
'validate_callback' => __CLASS__ . '::validate_list_item',
'jp_group' => 'comments',
),
// Custom Content Types
'jetpack_portfolio' => array(
'description' => esc_html__( 'Enable or disable Jetpack portfolio post type.', 'jetpack' ),
'type' => 'boolean',
'default' => 0,
'validate_callback' => __CLASS__ . '::validate_boolean',
'jp_group' => 'custom-content-types',
),
'jetpack_portfolio_posts_per_page' => array(
'description' => esc_html__( 'Number of entries to show at most in Portfolio pages.', 'jetpack' ),
'type' => 'integer',
'default' => 10,
'validate_callback' => __CLASS__ . '::validate_posint',
'jp_group' => 'custom-content-types',
),
'jetpack_testimonial' => array(
'description' => esc_html__( 'Enable or disable Jetpack testimonial post type.', 'jetpack' ),
'type' => 'boolean',
'default' => 0,
'validate_callback' => __CLASS__ . '::validate_boolean',
'jp_group' => 'custom-content-types',
),
'jetpack_testimonial_posts_per_page' => array(
'description' => esc_html__( 'Number of entries to show at most in Testimonial pages.', 'jetpack' ),
'type' => 'integer',
'default' => 10,
'validate_callback' => __CLASS__ . '::validate_posint',
'jp_group' => 'custom-content-types',
),
// Galleries
'tiled_galleries' => array(
'description' => esc_html__( 'Display all your gallery pictures in a cool mosaic.', 'jetpack' ),
'type' => 'boolean',
'default' => 0,
'validate_callback' => __CLASS__ . '::validate_boolean',
'jp_group' => 'tiled-gallery',
),
'gravatar_disable_hovercards' => array(
'description' => esc_html__( "View people's profiles when you mouse over their Gravatars", 'jetpack' ),
'type' => 'string',
'default' => 'enabled',
// Not visible. This is used as the checkbox value.
'enum' => array(
'enabled',
'disabled',
),
'enum_labels' => array(
'enabled' => esc_html__( 'Enabled', 'jetpack' ),
'disabled' => esc_html__( 'Disabled', 'jetpack' ),
),
'validate_callback' => __CLASS__ . '::validate_list_item',
'jp_group' => 'gravatar-hovercards',
),
// Infinite Scroll
'infinite_scroll' => array(
'description' => esc_html__( 'To infinity and beyond', 'jetpack' ),
'type' => 'boolean',
'default' => 1,
'validate_callback' => __CLASS__ . '::validate_boolean',
'jp_group' => 'infinite-scroll',
),
'infinite_scroll_google_analytics' => array(
'description' => esc_html__( 'Use Google Analytics with Infinite Scroll', 'jetpack' ),
'type' => 'boolean',
'default' => 0,
'validate_callback' => __CLASS__ . '::validate_boolean',
'jp_group' => 'infinite-scroll',
),
// Likes
'wpl_default' => array(
'description' => esc_html__( 'WordPress.com Likes are', 'jetpack' ),
'type' => 'string',
'default' => 'on',
'enum' => array(
'on',
'off',
),
'enum_labels' => array(
'on' => esc_html__( 'On for all posts', 'jetpack' ),
'off' => esc_html__( 'Turned on per post', 'jetpack' ),
),
'validate_callback' => __CLASS__ . '::validate_list_item',
'jp_group' => 'likes',
),
'social_notifications_like' => array(
'description' => esc_html__( 'Send email notification when someone likes a post', 'jetpack' ),
'type' => 'boolean',
'default' => 1,
'validate_callback' => __CLASS__ . '::validate_boolean',
'jp_group' => 'likes',
),
// Markdown
'wpcom_publish_comments_with_markdown' => array(
'description' => esc_html__( 'Use Markdown for comments.', 'jetpack' ),
'type' => 'boolean',
'default' => 0,
'validate_callback' => __CLASS__ . '::validate_boolean',
'jp_group' => 'markdown',
),
'wpcom_publish_posts_with_markdown' => array(
'description' => esc_html__( 'Use Markdown for posts.', 'jetpack' ),
'type' => 'boolean',
'default' => 0,
'validate_callback' => __CLASS__ . '::validate_boolean',
'jp_group' => 'markdown',
),
// Mobile Theme
'wp_mobile_excerpt' => array(
'description' => esc_html__( 'Excerpts', 'jetpack' ),
'type' => 'boolean',
'default' => 0,
'validate_callback' => __CLASS__ . '::validate_boolean',
'jp_group' => 'minileven',
),
'wp_mobile_featured_images' => array(
'description' => esc_html__( 'Featured Images', 'jetpack' ),
'type' => 'boolean',
'default' => 0,
'validate_callback' => __CLASS__ . '::validate_boolean',
'jp_group' => 'minileven',
),
'wp_mobile_app_promos' => array(
'description' => esc_html__( 'Show a promo for the WordPress mobile apps in the footer of the mobile theme.', 'jetpack' ),
'type' => 'boolean',
'default' => 0,
'validate_callback' => __CLASS__ . '::validate_boolean',
'jp_group' => 'minileven',
),
// Monitor
'monitor_receive_notifications' => array(
'description' => esc_html__( 'Receive Monitor Email Notifications.', 'jetpack' ),
'type' => 'boolean',
'default' => 0,
'validate_callback' => __CLASS__ . '::validate_boolean',
'jp_group' => 'monitor',
),
// Post by Email
'post_by_email_address' => array(
'description' => esc_html__( 'Email Address', 'jetpack' ),
'type' => 'string',
'default' => 'noop',
'enum' => array(
'noop',
'create',
'regenerate',
'delete',
),
'enum_labels' => array(
'noop' => '',
'create' => esc_html__( 'Create Post by Email address', 'jetpack' ),
'regenerate' => esc_html__( 'Regenerate Post by Email address', 'jetpack' ),
'delete' => esc_html__( 'Delete Post by Email address', 'jetpack' ),
),
'validate_callback' => __CLASS__ . '::validate_list_item',
'jp_group' => 'post-by-email',
),
// Protect
'jetpack_protect_key' => array(
'description' => esc_html__( 'Protect API key', 'jetpack' ),
'type' => 'string',
'default' => '',
'validate_callback' => __CLASS__ . '::validate_alphanum',
'jp_group' => 'protect',
),
'jetpack_protect_global_whitelist' => array(
'description' => esc_html__( 'Protect global whitelist', 'jetpack' ),
'type' => 'string',
'default' => '',
'validate_callback' => __CLASS__ . '::validate_string',
'sanitize_callback' => 'esc_textarea',
'jp_group' => 'protect',
),
// Sharing
'sharing_services' => array(
'description' => esc_html__( 'Enabled Services and those hidden behind a button', 'jetpack' ),
'type' => 'object',
'default' => array(
'visible' => array( 'twitter', 'facebook', 'google-plus-1' ),
'hidden' => array(),
),
'validate_callback' => __CLASS__ . '::validate_services',
'jp_group' => 'sharedaddy',
),
'button_style' => array(
'description' => esc_html__( 'Button Style', 'jetpack' ),
'type' => 'string',
'default' => 'icon',
'enum' => array(
'icon-text',
'icon',
'text',
'official',
),
'enum_labels' => array(
'icon-text' => esc_html__( 'Icon + text', 'jetpack' ),
'icon' => esc_html__( 'Icon only', 'jetpack' ),
'text' => esc_html__( 'Text only', 'jetpack' ),
'official' => esc_html__( 'Official buttons', 'jetpack' ),
),
'validate_callback' => __CLASS__ . '::validate_list_item',
'jp_group' => 'sharedaddy',
),
'sharing_label' => array(
'description' => esc_html__( 'Sharing Label', 'jetpack' ),
'type' => 'string',
'default' => '',
'validate_callback' => __CLASS__ . '::validate_string',
'sanitize_callback' => 'esc_html',
'jp_group' => 'sharedaddy',
),
'show' => array(
'description' => esc_html__( 'Views where buttons are shown', 'jetpack' ),
'type' => 'array',
'items' => array(
'type' => 'string'
),
'default' => array( 'post' ),
'validate_callback' => __CLASS__ . '::validate_sharing_show',
'jp_group' => 'sharedaddy',
),
'jetpack-twitter-cards-site-tag' => array(
'description' => esc_html__( "The Twitter username of the owner of this site's domain.", 'jetpack' ),
'type' => 'string',
'default' => '',
'validate_callback' => __CLASS__ . '::validate_twitter_username',
'sanitize_callback' => 'esc_html',
'jp_group' => 'sharedaddy',
),
'sharedaddy_disable_resources' => array(
'description' => esc_html__( 'Disable CSS and JS', 'jetpack' ),
'type' => 'boolean',
'default' => 0,
'validate_callback' => __CLASS__ . '::validate_boolean',
'jp_group' => 'sharedaddy',
),
'custom' => array(
'description' => esc_html__( 'Custom sharing services added by user.', 'jetpack' ),
'type' => 'object',
'default' => array(
'sharing_name' => '',
'sharing_url' => '',
'sharing_icon' => '',
),
'validate_callback' => __CLASS__ . '::validate_custom_service',
'jp_group' => 'sharedaddy',
),
// Not an option, but an action that can be perfomed on the list of custom services passing the service ID.
'sharing_delete_service' => array(
'description' => esc_html__( 'Delete custom sharing service.', 'jetpack' ),
'type' => 'string',
'default' => '',
'validate_callback' => __CLASS__ . '::validate_custom_service_id',
'jp_group' => 'sharedaddy',
),
// SSO
'jetpack_sso_require_two_step' => array(
'description' => esc_html__( 'Require Two-Step Authentication', 'jetpack' ),
'type' => 'boolean',
'default' => 0,
'validate_callback' => __CLASS__ . '::validate_boolean',
'jp_group' => 'sso',
),
'jetpack_sso_match_by_email' => array(
'description' => esc_html__( 'Match by Email', 'jetpack' ),
'type' => 'boolean',
'default' => 0,
'validate_callback' => __CLASS__ . '::validate_boolean',
'jp_group' => 'sso',
),
// Subscriptions
'stb_enabled' => array(
'description' => esc_html__( "Show a <em>'follow blog'</em> option in the comment form", 'jetpack' ),
'type' => 'boolean',
'default' => 1,
'validate_callback' => __CLASS__ . '::validate_boolean',
'jp_group' => 'subscriptions',
),
'stc_enabled' => array(
'description' => esc_html__( "Show a <em>'follow comments'</em> option in the comment form", 'jetpack' ),
'type' => 'boolean',
'default' => 1,
'validate_callback' => __CLASS__ . '::validate_boolean',
'jp_group' => 'subscriptions',
),
// Related Posts
'show_headline' => array(
'description' => esc_html__( 'Show a "Related" header to more clearly separate the related section from posts', 'jetpack' ),
'type' => 'boolean',
'default' => 1,
'validate_callback' => __CLASS__ . '::validate_boolean',
'jp_group' => 'related-posts',
),
'show_thumbnails' => array(
'description' => esc_html__( 'Show a thumbnail image where available', 'jetpack' ),
'type' => 'boolean',
'default' => 0,
'validate_callback' => __CLASS__ . '::validate_boolean',
'jp_group' => 'related-posts',
),
// Spelling and Grammar - After the Deadline
'onpublish' => array(
'description' => esc_html__( 'Proofread when a post or page is first published.', 'jetpack' ),
'type' => 'boolean',
'default' => 0,
'validate_callback' => __CLASS__ . '::validate_boolean',
'jp_group' => 'after-the-deadline',
),
'onupdate' => array(
'description' => esc_html__( 'Proofread when a post or page is updated.', 'jetpack' ),
'type' => 'boolean',
'default' => 0,
'validate_callback' => __CLASS__ . '::validate_boolean',
'jp_group' => 'after-the-deadline',
),
'Bias Language' => array(
'description' => esc_html__( 'Bias Language', 'jetpack' ),
'type' => 'boolean',
'default' => 0,
'validate_callback' => __CLASS__ . '::validate_boolean',
'jp_group' => 'after-the-deadline',
),
'Cliches' => array(
'description' => esc_html__( 'Clichés', 'jetpack' ),
'type' => 'boolean',
'default' => 0,
'validate_callback' => __CLASS__ . '::validate_boolean',
'jp_group' => 'after-the-deadline',
),
'Complex Expression' => array(
'description' => esc_html__( 'Complex Phrases', 'jetpack' ),
'type' => 'boolean',
'default' => 0,
'validate_callback' => __CLASS__ . '::validate_boolean',
'jp_group' => 'after-the-deadline',
),
'Diacritical Marks' => array(
'description' => esc_html__( 'Diacritical Marks', 'jetpack' ),
'type' => 'boolean',
'default' => 0,
'validate_callback' => __CLASS__ . '::validate_boolean',
'jp_group' => 'after-the-deadline',
),
'Double Negative' => array(
'description' => esc_html__( 'Double Negatives', 'jetpack' ),
'type' => 'boolean',
'default' => 0,
'validate_callback' => __CLASS__ . '::validate_boolean',
'jp_group' => 'after-the-deadline',
),
'Hidden Verbs' => array(
'description' => esc_html__( 'Hidden Verbs', 'jetpack' ),
'type' => 'boolean',
'default' => 0,
'validate_callback' => __CLASS__ . '::validate_boolean',
'jp_group' => 'after-the-deadline',
),
'Jargon Language' => array(
'description' => esc_html__( 'Jargon', 'jetpack' ),
'type' => 'boolean',
'default' => 0,
'validate_callback' => __CLASS__ . '::validate_boolean',
'jp_group' => 'after-the-deadline',
),
'Passive voice' => array(
'description' => esc_html__( 'Passive Voice', 'jetpack' ),
'type' => 'boolean',
'default' => 0,
'validate_callback' => __CLASS__ . '::validate_boolean',
'jp_group' => 'after-the-deadline',
),
'Phrases to Avoid' => array(
'description' => esc_html__( 'Phrases to Avoid', 'jetpack' ),
'type' => 'boolean',
'default' => 0,
'validate_callback' => __CLASS__ . '::validate_boolean',
'jp_group' => 'after-the-deadline',
),
'Redundant Expression' => array(
'description' => esc_html__( 'Redundant Phrases', 'jetpack' ),
'type' => 'boolean',
'default' => 0,
'validate_callback' => __CLASS__ . '::validate_boolean',
'jp_group' => 'after-the-deadline',
),
'guess_lang' => array(
'description' => esc_html__( 'Use automatically detected language to proofread posts and pages', 'jetpack' ),
'type' => 'boolean',
'default' => 0,
'validate_callback' => __CLASS__ . '::validate_boolean',
'jp_group' => 'after-the-deadline',
),
'ignored_phrases' => array(
'description' => esc_html__( 'Add Phrase to be ignored', 'jetpack' ),
'type' => 'string',
'default' => '',
'sanitize_callback' => 'esc_html',
'jp_group' => 'after-the-deadline',
),
'unignore_phrase' => array(
'description' => esc_html__( 'Remove Phrase from being ignored', 'jetpack' ),
'type' => 'string',
'default' => '',
'sanitize_callback' => 'esc_html',
'jp_group' => 'after-the-deadline',
),
// Verification Tools
'google' => array(
'description' => esc_html__( 'Google Search Console', 'jetpack' ),
'type' => 'string',
'default' => '',
'validate_callback' => __CLASS__ . '::validate_verification_service',
'jp_group' => 'verification-tools',
),
'bing' => array(
'description' => esc_html__( 'Bing Webmaster Center', 'jetpack' ),
'type' => 'string',
'default' => '',
'validate_callback' => __CLASS__ . '::validate_verification_service',
'jp_group' => 'verification-tools',
),
'pinterest' => array(
'description' => esc_html__( 'Pinterest Site Verification', 'jetpack' ),
'type' => 'string',
'default' => '',
'validate_callback' => __CLASS__ . '::validate_verification_service',
'jp_group' => 'verification-tools',
),
'yandex' => array(
'description' => esc_html__( 'Yandex Site Verification', 'jetpack' ),
'type' => 'string',
'default' => '',
'validate_callback' => __CLASS__ . '::validate_verification_service',
'jp_group' => 'verification-tools',
),
'enable_header_ad' => array(
'description' => esc_html__( 'Display an ad unit at the top of each page.', 'jetpack' ),
'type' => 'boolean',
'default' => 1,
'validate_callback' => __CLASS__ . '::validate_boolean',
'jp_group' => 'wordads',
),
'wordads_approved' => array(
'description' => esc_html__( 'Is site approved for WordAds?', 'jetpack' ),
'type' => 'boolean',
'default' => 0,
'validate_callback' => __CLASS__ . '::validate_boolean',
'jp_group' => 'wordads',
),
'wordads_second_belowpost' => array(
'description' => esc_html__( 'Display second ad below post?', 'jetpack' ),
'type' => 'boolean',
'default' => 1,
'validate_callback' => __CLASS__ . '::validate_boolean',
'jp_group' => 'wordads',
),
'wordads_display_front_page' => array(
'description' => esc_html__( 'Display ads on the front page?', 'jetpack' ),
'type' => 'boolean',
'default' => 1,
'validate_callback' => __CLASS__ . '::validate_boolean',
'jp_group' => 'wordads',
),
'wordads_display_post' => array(
'description' => esc_html__( 'Display ads on posts?', 'jetpack' ),
'type' => 'boolean',
'default' => 1,
'validate_callback' => __CLASS__ . '::validate_boolean',
'jp_group' => 'wordads',
),
'wordads_display_page' => array(
'description' => esc_html__( 'Display ads on pages?', 'jetpack' ),
'type' => 'boolean',
'default' => 1,
'validate_callback' => __CLASS__ . '::validate_boolean',
'jp_group' => 'wordads',
),
'wordads_display_archive' => array(
'description' => esc_html__( 'Display ads on archive pages?', 'jetpack' ),
'type' => 'boolean',
'default' => 1,
'validate_callback' => __CLASS__ . '::validate_boolean',
'jp_group' => 'wordads',
),
// Google Analytics
'google_analytics_tracking_id' => array(
'description' => esc_html__( 'Google Analytics', 'jetpack' ),
'type' => 'string',
'default' => '',
'validate_callback' => __CLASS__ . '::validate_alphanum',
'jp_group' => 'google-analytics',
),
// Stats
'admin_bar' => array(
'description' => esc_html__( 'Put a chart showing 48 hours of views in the admin bar.', 'jetpack' ),
'type' => 'boolean',
'default' => 1,
'validate_callback' => __CLASS__ . '::validate_boolean',
'jp_group' => 'stats',
),
'roles' => array(
'description' => esc_html__( 'Select the roles that will be able to view stats reports.', 'jetpack' ),
'type' => 'array',
'items' => array(
'type' => 'string'
),
'default' => array( 'administrator' ),
'validate_callback' => __CLASS__ . '::validate_stats_roles',
'sanitize_callback' => __CLASS__ . '::sanitize_stats_allowed_roles',
'jp_group' => 'stats',
),
'count_roles' => array(
'description' => esc_html__( 'Count the page views of registered users who are logged in.', 'jetpack' ),
'type' => 'array',
'items' => array(
'type' => 'string'
),
'default' => array( 'administrator' ),
'validate_callback' => __CLASS__ . '::validate_stats_roles',
'jp_group' => 'stats',
),
'blog_id' => array(
'description' => esc_html__( 'Blog ID.', 'jetpack' ),
'type' => 'boolean',
'default' => 0,
'validate_callback' => __CLASS__ . '::validate_boolean',
'jp_group' => 'stats',
),
'do_not_track' => array(
'description' => esc_html__( 'Do not track.', 'jetpack' ),
'type' => 'boolean',
'default' => 1,
'validate_callback' => __CLASS__ . '::validate_boolean',
'jp_group' => 'stats',
),
'hide_smile' => array(
'description' => esc_html__( 'Hide the stats smiley face image.', 'jetpack' ),
'type' => 'boolean',
'default' => 1,
'validate_callback' => __CLASS__ . '::validate_boolean',
'jp_group' => 'stats',
),
'version' => array(
'description' => esc_html__( 'Version.', 'jetpack' ),
'type' => 'integer',
'default' => 9,
'validate_callback' => __CLASS__ . '::validate_posint',
'jp_group' => 'stats',
),
// Akismet - Not a module, but a plugin. The options can be passed and handled differently.
'akismet_show_user_comments_approved' => array(
'description' => '',
'type' => 'boolean',
'default' => 0,
'validate_callback' => __CLASS__ . '::validate_boolean',
'jp_group' => 'settings',
),
'wordpress_api_key' => array(
'description' => '',
'type' => 'string',
'default' => '',
'validate_callback' => __CLASS__ . '::validate_alphanum',
'jp_group' => 'settings',
),
// Apps card on dashboard
'dismiss_dash_app_card' => array(
'description' => '',
'type' => 'boolean',
'default' => 0,
'validate_callback' => __CLASS__ . '::validate_boolean',
'jp_group' => 'settings',
),
// Empty stats card dismiss
'dismiss_empty_stats_card' => array(
'description' => '',
'type' => 'boolean',
'default' => 0,
'validate_callback' => __CLASS__ . '::validate_boolean',
'jp_group' => 'settings',
),
'lang_id' => array(
'description' => esc_html__( 'Primary language for the site.', 'jetpack' ),
'type' => 'string',
'default' => 'en_US',
'jp_group' => 'settings',
),
'onboarding' => array(
'description' => '',
'type' => 'object',
'default' => array(
'siteTitle' => '',
'siteDescription' => '',
'siteType' => 'personal',
'homepageFormat' => 'posts',
'addContactForm' => 0,
'businessAddress' => array(
'name' => '',
'street' => '',
'city' => '',
'state' => '',
'zip' => '',
),
'installWooCommerce' => false,
),
'validate_callback' => __CLASS__ . '::validate_onboarding',
'jp_group' => 'settings',
),
// Show welcome for newly purchased plan
'show_welcome_for_new_plan' => array(
'description' => '',
'type' => 'boolean',
'default' => 0,
'validate_callback' => __CLASS__ . '::validate_boolean',
'jp_group' => 'settings',
),
);
// Add modules to list so they can be toggled
$modules = Jetpack::get_available_modules();
if ( is_array( $modules ) && ! empty( $modules ) ) {
$module_args = array(
'description' => '',
'type' => 'boolean',
'default' => 0,
'validate_callback' => __CLASS__ . '::validate_boolean',
'jp_group' => 'modules',
);
foreach( $modules as $module ) {
$options[ $module ] = $module_args;
}
}
if ( is_array( $selector ) ) {
// Return only those options whose keys match $selector keys
return array_intersect_key( $options, $selector );
}
if ( 'any' === $selector ) {
// Toggle module or update any module option or any general setting
return $options;
}
// We're updating the options for a single module.
if ( empty( $selector ) ) {
$selector = self::get_module_requested();
}
$selected = array();
foreach ( $options as $option => $attributes ) {
// Not adding an isset( $attributes['jp_group'] ) because if it's not set, it must be fixed, otherwise options will fail.
if ( $selector === $attributes['jp_group'] ) {
$selected[ $option ] = $attributes;
}
}
return $selected;
}
/**
* Validates that the parameters are proper values that can be set during Jetpack onboarding.
*
* @since 5.4.0
*
* @param array $onboarding_data Values to check.
* @param WP_REST_Request $request The request sent to the WP REST API.
* @param string $param Name of the parameter passed to endpoint holding $value.
*
* @return bool|WP_Error
*/
public static function validate_onboarding( $onboarding_data, $request, $param ) {
if ( ! is_array( $onboarding_data ) ) {
return new WP_Error( 'invalid_param', esc_html__( 'Not valid onboarding data.', 'jetpack' ) );
}
foreach ( $onboarding_data as $value ) {
if ( is_string( $value ) ) {
$onboarding_choice = self::validate_string( $value, $request, $param );
} elseif ( is_array( $value ) ) {
$onboarding_choice = self::validate_onboarding( $value, $request, $param );
} else {
$onboarding_choice = self::validate_boolean( $value, $request, $param );
}
if ( is_wp_error( $onboarding_choice ) ) {
return $onboarding_choice;
}
}
return true;
}
/**
* Validates that the parameter is either a pure boolean or a numeric string that can be mapped to a boolean.
*
* @since 4.3.0
*
* @param string|bool $value Value to check.
* @param WP_REST_Request $request The request sent to the WP REST API.
* @param string $param Name of the parameter passed to endpoint holding $value.
*
* @return bool|WP_Error
*/
public static function validate_boolean( $value, $request, $param ) {
if ( ! is_bool( $value ) && ! ( ( ctype_digit( $value ) || is_numeric( $value ) ) && in_array( $value, array( 0, 1 ) ) ) ) {
return new WP_Error( 'invalid_param', sprintf( esc_html__( '%s must be true, false, 0 or 1.', 'jetpack' ), $param ) );
}
return true;
}
/**
* Validates that the parameter is a positive integer.
*
* @since 4.3.0
*
* @param int $value Value to check.
* @param WP_REST_Request $request The request sent to the WP REST API.
* @param string $param Name of the parameter passed to endpoint holding $value.
*
* @return bool|WP_Error
*/
public static function validate_posint( $value = 0, $request, $param ) {
if ( ! is_numeric( $value ) || $value <= 0 ) {
return new WP_Error( 'invalid_param', sprintf( esc_html__( '%s must be a positive integer.', 'jetpack' ), $param ) );
}
return true;
}
/**
* Validates that the parameter belongs to a list of admitted values.
*
* @since 4.3.0
*
* @param string $value Value to check.
* @param WP_REST_Request $request The request sent to the WP REST API.
* @param string $param Name of the parameter passed to endpoint holding $value.
*
* @return bool|WP_Error
*/
public static function validate_list_item( $value = '', $request, $param ) {
$attributes = $request->get_attributes();
if ( ! isset( $attributes['args'][ $param ] ) || ! is_array( $attributes['args'][ $param ] ) ) {
return new WP_Error( 'invalid_param', sprintf( esc_html__( '%s not recognized', 'jetpack' ), $param ) );
}
$args = $attributes['args'][ $param ];
if ( ! empty( $args['enum'] ) ) {
// If it's an associative array, use the keys to check that the value is among those admitted.
$enum = ( count( array_filter( array_keys( $args['enum'] ), 'is_string' ) ) > 0 ) ? array_keys( $args['enum'] ) : $args['enum'];
if ( ! in_array( $value, $enum ) ) {
return new WP_Error( 'invalid_param_value', sprintf(
/* Translators: first variable is the parameter passed to endpoint that holds the list item, the second is a list of admitted values. */
esc_html__( '%1$s must be one of %2$s', 'jetpack' ), $param, implode( ', ', $enum )
) );
}
}
return true;
}
/**
* Validates that the parameter belongs to a list of admitted values.
*
* @since 4.3.0
*
* @param string $value Value to check.
* @param WP_REST_Request $request The request sent to the WP REST API.
* @param string $param Name of the parameter passed to endpoint holding $value.
*
* @return bool|WP_Error
*/
public static function validate_module_list( $value = '', $request, $param ) {
if ( ! is_array( $value ) ) {
return new WP_Error( 'invalid_param_value', sprintf( esc_html__( '%s must be an array', 'jetpack' ), $param ) );
}
$modules = Jetpack::get_available_modules();
if ( count( array_intersect( $value, $modules ) ) != count( $value ) ) {
return new WP_Error( 'invalid_param_value', sprintf( esc_html__( '%s must be a list of valid modules', 'jetpack' ), $param ) );
}
return true;
}
/**
* Validates that the parameter is an alphanumeric or empty string (to be able to clear the field).
*
* @since 4.3.0
*
* @param string $value Value to check.
* @param WP_REST_Request $request The request sent to the WP REST API.
* @param string $param Name of the parameter passed to endpoint holding $value.
*
* @return bool|WP_Error
*/
public static function validate_alphanum( $value = '', $request, $param ) {
if ( ! empty( $value ) && ( ! is_string( $value ) || ! preg_match( '/^[a-z0-9]+$/i', $value ) ) ) {
return new WP_Error( 'invalid_param', sprintf( esc_html__( '%s must be an alphanumeric string.', 'jetpack' ), $param ) );
}
return true;
}
/**
* Validates that the parameter is a tag or id for a verification service, or an empty string (to be able to clear the field).
*
* @since 4.6.0
*
* @param string $value Value to check.
* @param WP_REST_Request $request
* @param string $param Name of the parameter passed to endpoint holding $value.
*
* @return bool|WP_Error
*/
public static function validate_verification_service( $value = '', $request, $param ) {
if ( ! empty( $value ) && ! ( is_string( $value ) && ( preg_match( '/^[a-z0-9_-]+$/i', $value ) || preg_match( '#^<meta name="([a-z0-9_\-.:]+)?" content="([a-z0-9_-]+)?" />$#i', $value ) ) ) ) {
return new WP_Error( 'invalid_param', sprintf( esc_html__( '%s must be an alphanumeric string or a verification tag.', 'jetpack' ), $param ) );
}
return true;
}
/**
* Validates that the parameter is among the roles allowed for Stats.
*
* @since 4.3.0
*
* @param string|bool $value Value to check.
* @param WP_REST_Request $request The request sent to the WP REST API.
* @param string $param Name of the parameter passed to endpoint holding $value.
*
* @return bool|WP_Error
*/
public static function validate_stats_roles( $value, $request, $param ) {
if ( ! empty( $value ) && ! array_intersect( self::$stats_roles, $value ) ) {
return new WP_Error( 'invalid_param', sprintf(
/* Translators: first variable is the name of a parameter passed to endpoint holding the role that will be checked, the second is a list of roles allowed to see stats. The parameter is checked against this list. */
esc_html__( '%1$s must be %2$s.', 'jetpack' ), $param, join( ', ', self::$stats_roles )
) );
}
return true;
}
/**
* Validates that the parameter is among the views where the Sharing can be displayed.
*
* @since 4.3.0
*
* @param string|bool $value Value to check.
* @param WP_REST_Request $request The request sent to the WP REST API.
* @param string $param Name of the parameter passed to endpoint holding $value.
*
* @return bool|WP_Error
*/
public static function validate_sharing_show( $value, $request, $param ) {
$views = array( 'index', 'post', 'page', 'attachment', 'jetpack-portfolio' );
if ( ! is_array( $value ) ) {
return new WP_Error( 'invalid_param', sprintf( esc_html__( '%s must be an array of post types.', 'jetpack' ), $param ) );
}
if ( ! array_intersect( $views, $value ) ) {
return new WP_Error( 'invalid_param', sprintf(
/* Translators: first variable is the name of a parameter passed to endpoint holding the post type where Sharing will be displayed, the second is a list of post types where Sharing can be displayed */
esc_html__( '%1$s must be %2$s.', 'jetpack' ), $param, join( ', ', $views )
) );
}
return true;
}
/**
* Validates that the parameter is among the views where the Sharing can be displayed.
*
* @since 4.3.0
*
* @param string|bool $value {
* Value to check received by request.
*
* @type array $visible List of slug of services to share to that are displayed directly in the page.
* @type array $hidden List of slug of services to share to that are concealed in a folding menu.
* }
* @param WP_REST_Request $request The request sent to the WP REST API.
* @param string $param Name of the parameter passed to endpoint holding $value.
*
* @return bool|WP_Error
*/
public static function validate_services( $value, $request, $param ) {
if ( ! is_array( $value ) || ! isset( $value['visible'] ) || ! isset( $value['hidden'] ) ) {
return new WP_Error( 'invalid_param', sprintf( esc_html__( '%s must be an array with visible and hidden items.', 'jetpack' ), $param ) );
}
// Allow to clear everything.
if ( empty( $value['visible'] ) && empty( $value['hidden'] ) ) {
return true;
}
if ( ! class_exists( 'Sharing_Service' ) && ! include_once( JETPACK__PLUGIN_DIR . 'modules/sharedaddy/sharing-service.php' ) ) {
return new WP_Error( 'invalid_param', esc_html__( 'Failed loading required dependency Sharing_Service.', 'jetpack' ) );
}
$sharer = new Sharing_Service();
$services = array_keys( $sharer->get_all_services() );
if (
( ! empty( $value['visible'] ) && ! array_intersect( $value['visible'], $services ) )
||
( ! empty( $value['hidden'] ) && ! array_intersect( $value['hidden'], $services ) ) )
{
return new WP_Error( 'invalid_param', sprintf(
/* Translators: placeholder 1 is a parameter holding the services passed to endpoint, placeholder 2 is a list of all Jetpack Sharing services */
esc_html__( '%1$s visible and hidden items must be a list of %2$s.', 'jetpack' ), $param, join( ', ', $services )
) );
}
return true;
}
/**
* Validates that the parameter has enough information to build a custom sharing button.
*
* @since 4.3.0
*
* @param string|bool $value Value to check.
* @param WP_REST_Request $request The request sent to the WP REST API.
* @param string $param Name of the parameter passed to endpoint holding $value.
*
* @return bool|WP_Error
*/
public static function validate_custom_service( $value, $request, $param ) {
if ( ! is_array( $value ) || ! isset( $value['sharing_name'] ) || ! isset( $value['sharing_url'] ) || ! isset( $value['sharing_icon'] ) ) {
return new WP_Error( 'invalid_param', sprintf( esc_html__( '%s must be an array with sharing name, url and icon.', 'jetpack' ), $param ) );
}
// Allow to clear everything.
if ( empty( $value['sharing_name'] ) && empty( $value['sharing_url'] ) && empty( $value['sharing_icon'] ) ) {
return true;
}
if ( ! class_exists( 'Sharing_Service' ) && ! include_once( JETPACK__PLUGIN_DIR . 'modules/sharedaddy/sharing-service.php' ) ) {
return new WP_Error( 'invalid_param', esc_html__( 'Failed loading required dependency Sharing_Service.', 'jetpack' ) );
}
if ( ( ! empty( $value['sharing_name'] ) && ! is_string( $value['sharing_name'] ) )
|| ( ! empty( $value['sharing_url'] ) && ! is_string( $value['sharing_url'] ) )
|| ( ! empty( $value['sharing_icon'] ) && ! is_string( $value['sharing_icon'] ) ) ) {
return new WP_Error( 'invalid_param', sprintf( esc_html__( '%s needs sharing name, url and icon.', 'jetpack' ), $param ) );
}
return true;
}
/**
* Validates that the parameter is a custom sharing service ID like 'custom-1461976264'.
*
* @since 4.3.0
*
* @param string $value Value to check.
* @param WP_REST_Request $request The request sent to the WP REST API.
* @param string $param Name of the parameter passed to endpoint holding $value.
*
* @return bool|WP_Error
*/
public static function validate_custom_service_id( $value = '', $request, $param ) {
if ( ! empty( $value ) && ( ! is_string( $value ) || ! preg_match( '/custom\-[0-1]+/i', $value ) ) ) {
return new WP_Error( 'invalid_param', sprintf( esc_html__( "%s must be a string prefixed with 'custom-' and followed by a numeric ID.", 'jetpack' ), $param ) );
}
if ( ! class_exists( 'Sharing_Service' ) && ! include_once( JETPACK__PLUGIN_DIR . 'modules/sharedaddy/sharing-service.php' ) ) {
return new WP_Error( 'invalid_param', esc_html__( 'Failed loading required dependency Sharing_Service.', 'jetpack' ) );
}
$sharer = new Sharing_Service();
$services = array_keys( $sharer->get_all_services() );
if ( ! empty( $value ) && ! in_array( $value, $services ) ) {
return new WP_Error( 'invalid_param', sprintf( esc_html__( '%s is not a registered custom sharing service.', 'jetpack' ), $param ) );
}
return true;
}
/**
* Validates that the parameter is a Twitter username or empty string (to be able to clear the field).
*
* @since 4.3.0
*
* @param string $value Value to check.
* @param WP_REST_Request $request
* @param string $param Name of the parameter passed to endpoint holding $value.
*
* @return bool|WP_Error
*/
public static function validate_twitter_username( $value = '', $request, $param ) {
if ( ! empty( $value ) && ( ! is_string( $value ) || ! preg_match( '/^@?\w{1,15}$/i', $value ) ) ) {
return new WP_Error( 'invalid_param', sprintf( esc_html__( '%s must be a Twitter username.', 'jetpack' ), $param ) );
}
return true;
}
/**
* Validates that the parameter is a string.
*
* @since 4.3.0
*
* @param string $value Value to check.
* @param WP_REST_Request $request The request sent to the WP REST API.
* @param string $param Name of the parameter passed to endpoint holding $value.
*
* @return bool|WP_Error
*/
public static function validate_string( $value = '', $request, $param ) {
if ( ! is_string( $value ) ) {
return new WP_Error( 'invalid_param', sprintf( esc_html__( '%s must be a string.', 'jetpack' ), $param ) );
}
return true;
}
/**
* If for some reason the roles allowed to see Stats are empty (for example, user tampering with checkboxes),
* return an array with only 'administrator' as the allowed role and save it for 'roles' option.
*
* @since 4.3.0
*
* @param string|bool $value Value to check.
*
* @return bool|array
*/
public static function sanitize_stats_allowed_roles( $value ) {
if ( empty( $value ) ) {
return array( 'administrator' );
}
return $value;
}
/**
* Get the currently accessed route and return the module slug in it.
*
* @since 4.3.0
*
* @param string $route Regular expression for the endpoint with the module slug to return.
*
* @return array|string
*/
public static function get_module_requested( $route = '/module/(?P<slug>[a-z\-]+)' ) {
if ( empty( $GLOBALS['wp']->query_vars['rest_route'] ) ) {
return '';
}
preg_match( "#$route#", $GLOBALS['wp']->query_vars['rest_route'], $module );
if ( empty( $module['slug'] ) ) {
return '';
}
return $module['slug'];
}
/**
* Adds extra information for modules.
*
* @since 4.3.0
*
* @param string|array $modules Can be a single module or a list of modules.
* @param null|string $slug Slug of the module in the first parameter.
*
* @return array|string
*/
public static function prepare_modules_for_response( $modules = '', $slug = null ) {
global $wp_rewrite;
/** This filter is documented in modules/sitemaps/sitemaps.php */
$location = apply_filters( 'jetpack_sitemap_location', '' );
if ( $wp_rewrite->using_index_permalinks() ) {
$sitemap_url = home_url( '/index.php' . $location . '/sitemap.xml' );
$news_sitemap_url = home_url( '/index.php' . $location . '/news-sitemap.xml' );
} else if ( $wp_rewrite->using_permalinks() ) {
$sitemap_url = home_url( $location . '/sitemap.xml' );
$news_sitemap_url = home_url( $location . '/news-sitemap.xml' );
} else {
$sitemap_url = home_url( $location . '/?jetpack-sitemap=sitemap.xml' );
$news_sitemap_url = home_url( $location . '/?jetpack-sitemap=news-sitemap.xml' );
}
if ( is_null( $slug ) && isset( $modules['sitemaps'] ) ) {
// Is a list of modules
$modules['sitemaps']['extra']['sitemap_url'] = $sitemap_url;
$modules['sitemaps']['extra']['news_sitemap_url'] = $news_sitemap_url;
} elseif ( 'sitemaps' == $slug ) {
// It's a single module
$modules['extra']['sitemap_url'] = $sitemap_url;
$modules['extra']['news_sitemap_url'] = $news_sitemap_url;
}
return $modules;
}
/**
* Remove 'validate_callback' item from options available for module.
* Fetch current option value and add to array of module options.
* Prepare values of module options that need special handling, like those saved in wpcom.
*
* @since 4.3.0
*
* @param string $module Module slug.
* @return array
*/
public static function prepare_options_for_response( $module = '' ) {
$options = self::get_updateable_data_list( $module );
if ( ! is_array( $options ) || empty( $options ) ) {
return $options;
}
// Some modules need special treatment.
switch ( $module ) {
case 'monitor':
// Status of user notifications
$options['monitor_receive_notifications']['current_value'] = self::cast_value( self::get_remote_value( 'monitor', 'monitor_receive_notifications' ), $options['monitor_receive_notifications'] );
break;
case 'post-by-email':
// Email address
$options['post_by_email_address']['current_value'] = self::cast_value( self::get_remote_value( 'post-by-email', 'post_by_email_address' ), $options['post_by_email_address'] );
break;
case 'protect':
// Protect
$options['jetpack_protect_key']['current_value'] = get_site_option( 'jetpack_protect_key', false );
if ( ! function_exists( 'jetpack_protect_format_whitelist' ) ) {
include_once( JETPACK__PLUGIN_DIR . 'modules/protect/shared-functions.php' );
}
$options['jetpack_protect_global_whitelist']['current_value'] = jetpack_protect_format_whitelist();
break;
case 'related-posts':
// It's local, but it must be broken apart since it's saved as an array.
$options = self::split_options( $options, Jetpack_Options::get_option( 'relatedposts' ) );
break;
case 'verification-tools':
// It's local, but it must be broken apart since it's saved as an array.
$options = self::split_options( $options, get_option( 'verification_services_codes' ) );
break;
case 'google-analytics':
$wga = get_option( 'jetpack_wga' );
$code = '';
if ( is_array( $wga ) && array_key_exists( 'code', $wga ) ) {
$code = $wga[ 'code' ];
}
$options[ 'google_analytics_tracking_id' ][ 'current_value' ] = $code;
break;
case 'sharedaddy':
// It's local, but it must be broken apart since it's saved as an array.
if ( ! class_exists( 'Sharing_Service' ) && ! include_once( JETPACK__PLUGIN_DIR . 'modules/sharedaddy/sharing-service.php' ) ) {
break;
}
$sharer = new Sharing_Service();
$options = self::split_options( $options, $sharer->get_global_options() );
$options['sharing_services']['current_value'] = $sharer->get_blog_services();
$other_sharedaddy_options = array( 'jetpack-twitter-cards-site-tag', 'sharedaddy_disable_resources', 'sharing_delete_service' );
foreach ( $other_sharedaddy_options as $key ) {
$default_value = isset( $options[ $key ]['default'] ) ? $options[ $key ]['default'] : '';
$current_value = get_option( $key, $default_value );
$options[ $key ]['current_value'] = self::cast_value( $current_value, $options[ $key ] );
}
break;
case 'after-the-deadline':
if ( ! function_exists( 'AtD_get_options' ) ) {
include_once( JETPACK__PLUGIN_DIR . 'modules/after-the-deadline.php' );
}
$atd_options = array_merge( AtD_get_options( get_current_user_id(), 'AtD_options' ), AtD_get_options( get_current_user_id(), 'AtD_check_when' ) );
unset( $atd_options['name'] );
foreach ( $atd_options as $key => $value ) {
$options[ $key ]['current_value'] = self::cast_value( $value, $options[ $key ] );
}
$atd_options = AtD_get_options( get_current_user_id(), 'AtD_guess_lang' );
$options['guess_lang']['current_value'] = self::cast_value( isset( $atd_options['true'] ), $options[ 'guess_lang' ] );
$options['ignored_phrases']['current_value'] = AtD_get_setting( get_current_user_id(), 'AtD_ignored_phrases' );
unset( $options['unignore_phrase'] );
break;
case 'stats':
// It's local, but it must be broken apart since it's saved as an array.
if ( ! function_exists( 'stats_get_options' ) ) {
include_once( JETPACK__PLUGIN_DIR . 'modules/stats.php' );
}
$options = self::split_options( $options, stats_get_options() );
break;
default:
// These option are just stored as plain WordPress options.
foreach ( $options as $key => $value ) {
$default_value = isset( $options[ $key ]['default'] ) ? $options[ $key ]['default'] : '';
$current_value = get_option( $key, $default_value );
$options[ $key ]['current_value'] = self::cast_value( $current_value, $options[ $key ] );
}
}
// At this point some options have current_value not set because they're options
// that only get written on update, so we set current_value to the default one.
foreach ( $options as $key => $value ) {
// We don't need validate_callback in the response
if ( isset( $options[ $key ]['validate_callback'] ) ) {
unset( $options[ $key ]['validate_callback'] );
}
$default_value = isset( $options[ $key ]['default'] ) ? $options[ $key ]['default'] : '';
if ( ! array_key_exists( 'current_value', $options[ $key ] ) ) {
$options[ $key ]['current_value'] = self::cast_value( $default_value, $options[ $key ] );
}
}
return $options;
}
/**
* Splits module options saved as arrays like relatedposts or verification_services_codes into separate options to be returned in the response.
*
* @since 4.3.0
*
* @param array $separate_options Array of options admitted by the module.
* @param array $grouped_options Option saved as array to be splitted.
* @param string $prefix Optional prefix for the separate option keys.
*
* @return array
*/
public static function split_options( $separate_options, $grouped_options, $prefix = '' ) {
if ( is_array( $grouped_options ) ) {
foreach ( $grouped_options as $key => $value ) {
$option_key = $prefix . $key;
if ( isset( $separate_options[ $option_key ] ) ) {
$separate_options[ $option_key ]['current_value'] = self::cast_value( $grouped_options[ $key ], $separate_options[ $option_key ] );
}
}
}
return $separate_options;
}
/**
* Perform a casting to the value specified in the option definition.
*
* @since 4.3.0
*
* @param mixed $value Value to cast to the proper type.
* @param array $definition Type to cast the value to.
*
* @return bool|float|int|string
*/
public static function cast_value( $value, $definition ) {
if ( $value === 'NULL' ) {
return null;
}
if ( isset( $definition['type'] ) ) {
switch ( $definition['type'] ) {
case 'boolean':
if ( 'true' === $value ) {
return true;
} elseif ( 'false' === $value ) {
return false;
}
return (bool) $value;
break;
case 'integer':
return (int) $value;
break;
case 'float':
return (float) $value;
break;
case 'string':
return (string) $value;
break;
}
}
return $value;
}
/**
* Get a value not saved locally.
*
* @since 4.3.0
*
* @param string $module Module slug.
* @param string $option Option name.
*
* @return bool Whether user is receiving notifications or not.
*/
public static function get_remote_value( $module, $option ) {
if ( in_array( $module, array( 'post-by-email' ), true ) ) {
$option .= get_current_user_id();
}
// If option doesn't exist, 'does_not_exist' will be returned.
$value = get_option( $option, 'does_not_exist' );
// If option exists, just return it.
if ( 'does_not_exist' !== $value ) {
return $value;
}
// Only check a remote option if Jetpack is connected.
if ( ! Jetpack::is_active() ) {
return false;
}
// Do what is necessary for each module.
switch ( $module ) {
case 'monitor':
// Load the class to use the method. If class can't be found, do nothing.
if ( ! class_exists( 'Jetpack_Monitor' ) && ! include_once( Jetpack::get_module_path( $module ) ) ) {
return false;
}
$value = Jetpack_Monitor::user_receives_notifications( false );
break;
case 'post-by-email':
// Load the class to use the method. If class can't be found, do nothing.
if ( ! class_exists( 'Jetpack_Post_By_Email' ) && ! include_once( Jetpack::get_module_path( $module ) ) ) {
return false;
}
$post_by_email = new Jetpack_Post_By_Email();
$value = $post_by_email->get_post_by_email_address();
if ( $value === null ) {
$value = 'NULL'; // sentinel value so it actually gets set
}
break;
}
// Normalize value to boolean.
if ( is_wp_error( $value ) || is_null( $value ) ) {
$value = false;
}
// Save option to use it next time.
update_option( $option, $value );
return $value;
}
/**
* Get number of plugin updates available.
*
* @since 4.3.0
*
* @return mixed|WP_Error Number of plugin updates available. Otherwise, a WP_Error instance with the corresponding error.
*/
public static function get_plugin_update_count() {
$updates = wp_get_update_data();
if ( isset( $updates['counts'] ) && isset( $updates['counts']['plugins'] ) ) {
$count = $updates['counts']['plugins'];
if ( 0 == $count ) {
$response = array(
'code' => 'success',
'message' => esc_html__( 'All plugins are up-to-date. Keep up the good work!', 'jetpack' ),
'count' => 0,
);
} else {
$response = array(
'code' => 'updates-available',
'message' => esc_html( sprintf( _n( '%s plugin need updating.', '%s plugins need updating.', $count, 'jetpack' ), $count ) ),
'count' => $count,
);
}
return rest_ensure_response( $response );
}
return new WP_Error( 'not_found', esc_html__( 'Could not check updates for plugins on this site.', 'jetpack' ), array( 'status' => 404 ) );
}
/**
* Returns a list of all plugins in the site.
*
* @since 4.2.0
* @uses get_plugins()
*
* @return array
*/
private static function core_get_plugins() {
if ( ! function_exists( 'get_plugins' ) ) {
require_once ABSPATH . 'wp-admin/includes/plugin.php';
}
/** This filter is documented in wp-admin/includes/class-wp-plugins-list-table.php */
$plugins = apply_filters( 'all_plugins', get_plugins() );
if ( is_array( $plugins ) && ! empty( $plugins ) ) {
foreach ( $plugins as $plugin_slug => $plugin_data ) {
$plugins[ $plugin_slug ]['active'] = self::core_is_plugin_active( $plugin_slug );
}
return $plugins;
}
return array();
}
/**
* Checks if the queried plugin is active.
*
* @since 4.2.0
* @uses is_plugin_active()
*
* @return bool
*/
private static function core_is_plugin_active( $plugin ) {
if ( ! function_exists( 'is_plugin_active' ) ) {
require_once ABSPATH . 'wp-admin/includes/plugin.php';
}
return is_plugin_active( $plugin );
}
/**
* Get plugins data in site.
*
* @since 4.2.0
*
* @return WP_REST_Response|WP_Error List of plugins in the site. Otherwise, a WP_Error instance with the corresponding error.
*/
public static function get_plugins() {
$plugins = self::core_get_plugins();
if ( ! empty( $plugins ) ) {
return rest_ensure_response( $plugins );
}
return new WP_Error( 'not_found', esc_html__( 'Unable to list plugins.', 'jetpack' ), array( 'status' => 404 ) );
}
/**
* Get data about the queried plugin. Currently it only returns whether the plugin is active or not.
*
* @since 4.2.0
*
* @param WP_REST_Request $request {
* Array of parameters received by request.
*
* @type string $slug Plugin slug with the syntax 'plugin-directory/plugin-main-file.php'.
* }
*
* @return bool|WP_Error True if module was activated. Otherwise, a WP_Error instance with the corresponding error.
*/
public static function get_plugin( $request ) {
$plugins = self::core_get_plugins();
if ( empty( $plugins ) ) {
return new WP_Error( 'no_plugins_found', esc_html__( 'This site has no plugins.', 'jetpack' ), array( 'status' => 404 ) );
}
$plugin = stripslashes( $request['plugin'] );
if ( ! in_array( $plugin, array_keys( $plugins ) ) ) {
return new WP_Error( 'plugin_not_found', esc_html( sprintf( __( 'Plugin %s is not installed.', 'jetpack' ), $plugin ) ), array( 'status' => 404 ) );
}
$plugin_data = $plugins[ $plugin ];
$plugin_data['active'] = self::core_is_plugin_active( $plugin );
return rest_ensure_response( array(
'code' => 'success',
'message' => esc_html__( 'Plugin found.', 'jetpack' ),
'data' => $plugin_data
) );
}
} // class end
|