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
|
<?php
/**
* This is the base class for every Core API endpoint Jetpack uses.
*
*/
class Jetpack_Core_API_Module_Toggle_Endpoint
extends Jetpack_Core_API_XMLRPC_Consumer_Endpoint {
/**
* Check if the module requires the site to be publicly accessible from WPCOM.
* If the site meets this requirement, the module is activated. Otherwise an error is returned.
*
* @since 4.3.0
*
* @param WP_REST_Request $request {
* Array of parameters received by request.
*
* @type string $slug Module slug.
* @type bool $active should module be activated.
* }
*
* @return WP_REST_Response|WP_Error A REST response if the request was served successfully, otherwise an error.
*/
public function process( $request ) {
if ( $request['active'] ) {
return $this->activate_module( $request );
} else {
return $this->deactivate_module( $request );
}
}
/**
* If it's a valid Jetpack module, activate it.
*
* @since 4.3.0
*
* @param string|WP_REST_Request $request It's a WP_REST_Request when called from endpoint /module/<slug>/*
* and a string when called from Jetpack_Core_API_Data->update_data.
* {
* Array of parameters received by request.
*
* @type string $slug Module slug.
* }
*
* @return bool|WP_Error True if module was activated. Otherwise, a WP_Error instance with the corresponding error.
*/
public function activate_module( $request ) {
$module_slug = '';
if (
(
is_array( $request )
|| is_object( $request )
)
&& isset( $request['slug'] )
) {
$module_slug = $request['slug'];
} else {
$module_slug = $request;
}
if ( ! Jetpack::is_module( $module_slug ) ) {
return new WP_Error(
'not_found',
esc_html__( 'The requested Jetpack module was not found.', 'jetpack' ),
array( 'status' => 404 )
);
}
if ( ! Jetpack::active_plan_supports( $module_slug ) ) {
return new WP_Error(
'not_supported',
esc_html__( 'The requested Jetpack module is not supported by your plan.', 'jetpack' ),
array( 'status' => 424 )
);
}
if ( Jetpack::activate_module( $module_slug, false, false ) ) {
return rest_ensure_response( array(
'code' => 'success',
'message' => esc_html__( 'The requested Jetpack module was activated.', 'jetpack' ),
) );
}
return new WP_Error(
'activation_failed',
esc_html__( 'The requested Jetpack module could not be activated.', 'jetpack' ),
array( 'status' => 424 )
);
}
/**
* If it's a valid Jetpack module, deactivate it.
*
* @since 4.3.0
*
* @param string|WP_REST_Request $request It's a WP_REST_Request when called from endpoint /module/<slug>/*
* and a string when called from Jetpack_Core_API_Data->update_data.
* {
* Array of parameters received by request.
*
* @type string $slug Module slug.
* }
*
* @return bool|WP_Error True if module was activated. Otherwise, a WP_Error instance with the corresponding error.
*/
public function deactivate_module( $request ) {
$module_slug = '';
if (
(
is_array( $request )
|| is_object( $request )
)
&& isset( $request['slug'] )
) {
$module_slug = $request['slug'];
} else {
$module_slug = $request;
}
if ( ! Jetpack::is_module( $module_slug ) ) {
return new WP_Error(
'not_found',
esc_html__( 'The requested Jetpack module was not found.', 'jetpack' ),
array( 'status' => 404 )
);
}
if ( ! Jetpack::is_module_active( $module_slug ) ) {
return new WP_Error(
'already_inactive',
esc_html__( 'The requested Jetpack module was already inactive.', 'jetpack' ),
array( 'status' => 409 )
);
}
if ( Jetpack::deactivate_module( $module_slug ) ) {
return rest_ensure_response( array(
'code' => 'success',
'message' => esc_html__( 'The requested Jetpack module was deactivated.', 'jetpack' ),
) );
}
return new WP_Error(
'deactivation_failed',
esc_html__( 'The requested Jetpack module could not be deactivated.', 'jetpack' ),
array( 'status' => 400 )
);
}
/**
* Check that the current user has permissions to manage Jetpack modules.
*
* @since 4.3.0
*
* @return bool
*/
public function can_request() {
return current_user_can( 'jetpack_manage_modules' );
}
}
class Jetpack_Core_API_Module_List_Endpoint {
/**
* A WordPress REST API callback method that accepts a request object and decides what to do with it.
*
* @param WP_REST_Request $request The request sent to the WP REST API.
*
* @since 4.3.0
*
* @return bool|Array|WP_Error a resulting value or object, or an error.
*/
public function process( $request ) {
if ( 'GET' === $request->get_method() ) {
return $this->get_modules( $request );
} else {
return $this->activate_modules( $request );
}
}
/**
* Get a list of all Jetpack modules and their information.
*
* @since 4.3.0
*
* @return array Array of Jetpack modules.
*/
public function get_modules() {
require_once( JETPACK__PLUGIN_DIR . 'class.jetpack-admin.php' );
$modules = Jetpack_Admin::init()->get_modules();
foreach ( $modules as $slug => $properties ) {
$modules[ $slug ]['options'] =
Jetpack_Core_Json_Api_Endpoints::prepare_options_for_response( $slug );
if (
isset( $modules[ $slug ]['requires_connection'] )
&& $modules[ $slug ]['requires_connection']
&& Jetpack::is_development_mode()
) {
$modules[ $slug ]['activated'] = false;
}
}
$modules = Jetpack::get_translated_modules( $modules );
return Jetpack_Core_Json_Api_Endpoints::prepare_modules_for_response( $modules );
}
/**
* Activate a list of valid Jetpack modules.
*
* @since 4.3.0
*
* @param WP_REST_Request $request {
* Array of parameters received by request.
*
* @type string $slug Module slug.
* }
*
* @return bool|WP_Error True if modules were activated. Otherwise, a WP_Error instance with the corresponding error.
*/
public static function activate_modules( $request ) {
if (
! isset( $request['modules'] )
|| ! is_array( $request['modules'] )
) {
return new WP_Error(
'not_found',
esc_html__( 'The requested Jetpack module was not found.', 'jetpack' ),
array( 'status' => 404 )
);
}
$activated = array();
$failed = array();
foreach ( $request['modules'] as $module ) {
if ( Jetpack::activate_module( $module, false, false ) ) {
$activated[] = $module;
} else {
$failed[] = $module;
}
}
if ( empty( $failed ) ) {
return rest_ensure_response( array(
'code' => 'success',
'message' => esc_html__( 'All modules activated.', 'jetpack' ),
) );
}
$error = '';
$activated_count = count( $activated );
if ( $activated_count > 0 ) {
$activated_last = array_pop( $activated );
$activated_text = $activated_count > 1 ? sprintf(
/* Translators: first variable is a list followed by the last item, which is the second variable. Example: dog, cat and bird. */
__( '%1$s and %2$s', 'jetpack' ),
join( ', ', $activated ), $activated_last ) : $activated_last;
$error = sprintf(
/* Translators: the variable is a module name. */
_n( 'The module %s was activated.', 'The modules %s were activated.', $activated_count, 'jetpack' ),
$activated_text ) . ' ';
}
$failed_count = count( $failed );
if ( count( $failed ) > 0 ) {
$failed_last = array_pop( $failed );
$failed_text = $failed_count > 1 ? sprintf(
/* Translators: first variable is a list followed by the last item, which is the second variable. Example: dog, cat and bird. */
__( '%1$s and %2$s', 'jetpack' ),
join( ', ', $failed ), $failed_last ) : $failed_last;
$error = sprintf(
/* Translators: the variable is a module name. */
_n( 'The module %s failed to be activated.', 'The modules %s failed to be activated.', $failed_count, 'jetpack' ),
$failed_text ) . ' ';
}
return new WP_Error(
'activation_failed',
esc_html( $error ),
array( 'status' => 424 )
);
}
/**
* A WordPress REST API permission callback method that accepts a request object and decides
* if the current user has enough privileges to act.
*
* @since 4.3.0
*
* @param WP_REST_Request $request The request sent to the WP REST API.
*
* @return bool does the current user have enough privilege.
*/
public function can_request( $request ) {
if ( 'GET' === $request->get_method() ) {
return current_user_can( 'jetpack_admin_page' );
} else {
return current_user_can( 'jetpack_manage_modules' );
}
}
}
/**
* Class that manages updating of Jetpack module options and general Jetpack settings or retrieving module data.
* If no module is specified, all module settings are retrieved/updated.
*
* @since 4.3.0
* @since 4.4.0 Renamed Jetpack_Core_API_Module_Endpoint from to Jetpack_Core_API_Data.
*
* @author Automattic
*/
class Jetpack_Core_API_Data extends Jetpack_Core_API_XMLRPC_Consumer_Endpoint {
/**
* Process request by returning the module or updating it.
* If no module is specified, settings for all modules are assumed.
*
* @since 4.3.0
*
* @param WP_REST_Request $request
*
* @return bool|mixed|void|WP_Error
*/
public function process( $request ) {
if ( 'GET' === $request->get_method() ) {
if ( isset( $request['slug'] ) ) {
return $this->get_module( $request );
}
return $this->get_all_options();
} else {
return $this->update_data( $request );
}
}
/**
* Get information about a specific and valid Jetpack module.
*
* @since 4.3.0
*
* @param WP_REST_Request $request {
* Array of parameters received by request.
*
* @type string $slug Module slug.
* }
*
* @return mixed|void|WP_Error
*/
public function get_module( $request ) {
if ( Jetpack::is_module( $request['slug'] ) ) {
$module = Jetpack::get_module( $request['slug'] );
$module['options'] = Jetpack_Core_Json_Api_Endpoints::prepare_options_for_response( $request['slug'] );
if (
isset( $module['requires_connection'] )
&& $module['requires_connection']
&& Jetpack::is_development_mode()
) {
$module['activated'] = false;
}
$i18n = jetpack_get_module_i18n( $request['slug'] );
if ( isset( $module['name'] ) ) {
$module['name'] = $i18n['name'];
}
if ( isset( $module['description'] ) ) {
$module['description'] = $i18n['description'];
$module['short_description'] = $i18n['description'];
}
return Jetpack_Core_Json_Api_Endpoints::prepare_modules_for_response( $module );
}
return new WP_Error(
'not_found',
esc_html__( 'The requested Jetpack module was not found.', 'jetpack' ),
array( 'status' => 404 )
);
}
/**
* Get information about all Jetpack module options and settings.
*
* @since 4.6.0
*
* @return WP_REST_Response $response
*/
public function get_all_options() {
$response = array();
$modules = Jetpack::get_available_modules();
if ( is_array( $modules ) && ! empty( $modules ) ) {
foreach ( $modules as $module ) {
// Add all module options
$options = Jetpack_Core_Json_Api_Endpoints::prepare_options_for_response( $module );
foreach ( $options as $option_name => $option ) {
$response[ $option_name ] = $option['current_value'];
}
// Add the module activation state
$response[ $module ] = Jetpack::is_module_active( $module );
}
}
$settings = Jetpack_Core_Json_Api_Endpoints::get_updateable_data_list( 'settings' );
if ( ! function_exists( 'is_plugin_active' ) ) {
require_once ABSPATH . 'wp-admin/includes/plugin.php';
}
foreach ( $settings as $setting => $properties ) {
switch ( $setting ) {
case 'lang_id':
if ( defined( 'WPLANG' ) ) {
// We can't affect this setting, so warn the client
$response[ $setting ] = 'error_const';
break;
}
if ( ! current_user_can( 'install_languages' ) ) {
// The user doesn't have caps to install language packs, so warn the client
$response[ $setting ] = 'error_cap';
break;
}
$value = get_option( 'WPLANG' );
$response[ $setting ] = empty( $value ) ? 'en_US' : $value;
break;
case 'wordpress_api_key':
// When field is clear, return empty. Otherwise it would return "false".
if ( '' === get_option( 'wordpress_api_key', '' ) ) {
$response[ $setting ] = '';
} else {
if ( ! class_exists( 'Akismet' ) ) {
if ( is_readable( WP_PLUGIN_DIR . '/akismet/class.akismet.php' ) ) {
require_once WP_PLUGIN_DIR . '/akismet/class.akismet.php';
}
}
$response[ $setting ] = class_exists( 'Akismet' ) ? Akismet::get_api_key() : '';
}
break;
case 'onboarding':
$business_address = get_option( 'jpo_business_address' );
$business_address = is_array( $business_address ) ? array_map( array( $this, 'decode_special_characters' ), $business_address ) : $business_address;
$response[ $setting ] = array(
'siteTitle' => $this->decode_special_characters( get_option( 'blogname' ) ),
'siteDescription' => $this->decode_special_characters( get_option( 'blogdescription' ) ),
'siteType' => get_option( 'jpo_site_type' ),
'homepageFormat' => get_option( 'jpo_homepage_format' ),
'addContactForm' => intval( get_option( 'jpo_contact_page' ) ),
'businessAddress' => $business_address,
'installWooCommerce' => is_plugin_active( 'woocommerce/woocommerce.php' ),
'stats' => Jetpack::is_active() && Jetpack::is_module_active( 'stats' ),
);
break;
default:
$response[ $setting ] = Jetpack_Core_Json_Api_Endpoints::cast_value( get_option( $setting ), $settings[ $setting ] );
break;
}
}
$response['akismet'] = is_plugin_active( 'akismet/akismet.php' );
return rest_ensure_response( $response );
}
/**
* Decode the special HTML characters in a certain value.
*
* @since 5.8
*
* @param string $value Value to decode.
*
* @return string Value with decoded HTML characters.
*/
private function decode_special_characters( $value ) {
return (string) htmlspecialchars_decode( $value, ENT_QUOTES );
}
/**
* If it's a valid Jetpack module and configuration parameters have been sent, update it.
*
* @since 4.3.0
*
* @param WP_REST_Request $request {
* Array of parameters received by request.
*
* @type string $slug Module slug.
* }
*
* @return bool|WP_Error True if module was updated. Otherwise, a WP_Error instance with the corresponding error.
*/
public function update_data( $request ) {
// If it's null, we're trying to update many module options from different modules.
if ( is_null( $request['slug'] ) ) {
// Value admitted by Jetpack_Core_Json_Api_Endpoints::get_updateable_data_list that will make it return all module options.
// It will not be passed. It's just checked in this method to pass that method a string or array.
$request['slug'] = 'any';
} else {
if ( ! Jetpack::is_module( $request['slug'] ) ) {
return new WP_Error( 'not_found', esc_html__( 'The requested Jetpack module was not found.', 'jetpack' ), array( 'status' => 404 ) );
}
if ( ! Jetpack::is_module_active( $request['slug'] ) ) {
return new WP_Error( 'inactive', esc_html__( 'The requested Jetpack module is inactive.', 'jetpack' ), array( 'status' => 409 ) );
}
}
// Get parameters to update the module. We can not simply use $request->get_params() because when we registered
// this route, we are adding the entire output of Jetpack_Core_Json_Api_Endpoints::get_updateable_data_list() to
// the current request object's params. We are interested in body of the actual request.
// This may be JSON:
$params = $request->get_json_params();
if ( ! is_array( $params ) ) {
// Or it may be standard POST key-value pairs:
$params = $request->get_body_params();
}
// Exit if no parameters were passed.
if ( ! is_array( $params ) ) {
return new WP_Error( 'missing_options', esc_html__( 'Missing options.', 'jetpack' ), array( 'status' => 404 ) );
}
// If $params was set via `get_body_params()` there may be some additional variables in the request that can
// cause validation to fail. This method verifies that each param was in fact updated and will throw a `some_updated`
// error if unused variables are included in the request.
foreach ( array_keys( $params ) as $key ) {
if ( is_int( $key ) || 'slug' === $key || 'context' === $key ) {
unset( $params[ $key ] );
}
}
// Get available module options.
$options = Jetpack_Core_Json_Api_Endpoints::get_updateable_data_list( 'any' === $request['slug']
? $params
: $request['slug']
);
// Prepare to toggle module if needed
$toggle_module = new Jetpack_Core_API_Module_Toggle_Endpoint( new Jetpack_IXR_Client() );
// Options that are invalid or failed to update.
$invalid = array_keys( array_diff_key( $params, $options ) );
$not_updated = array();
// Remove invalid options
$params = array_intersect_key( $params, $options );
// Used if response is successful. The message can be overwritten and additional data can be added here.
$response = array(
'code' => 'success',
'message' => esc_html__( 'The requested Jetpack data updates were successful.', 'jetpack' ),
);
// If there are modules to activate, activate them first so they're ready when their options are set.
foreach ( $params as $option => $value ) {
if ( 'modules' === $options[ $option ]['jp_group'] ) {
// Used if there was an error. Can be overwritten with specific error messages.
$error = '';
// Set to true if the module toggling was successful.
$updated = false;
// Check if user can toggle the module.
if ( $toggle_module->can_request() ) {
// Activate or deactivate the module according to the value passed.
$toggle_result = $value
? $toggle_module->activate_module( $option )
: $toggle_module->deactivate_module( $option );
if (
is_wp_error( $toggle_result )
&& 'already_inactive' === $toggle_result->get_error_code()
) {
// If the module is already inactive, we don't fail
$updated = true;
} elseif ( is_wp_error( $toggle_result ) ) {
$error = $toggle_result->get_error_message();
} else {
$updated = true;
}
} else {
$error = Jetpack_Core_Json_Api_Endpoints::$user_permissions_error_msg;
}
// The module was not toggled.
if ( ! $updated ) {
$not_updated[ $option ] = $error;
}
// Remove module from list so we don't go through it again.
unset( $params[ $option ] );
}
}
foreach ( $params as $option => $value ) {
// Used if there was an error. Can be overwritten with specific error messages.
$error = '';
// Set to true if the option update was successful.
$updated = false;
// Get option attributes, including the group it belongs to.
$option_attrs = $options[ $option ];
// If this is a module option and the related module isn't active for any reason, continue with the next one.
if ( 'settings' !== $option_attrs['jp_group'] ) {
if ( ! Jetpack::is_module( $option_attrs['jp_group'] ) ) {
$not_updated[ $option ] = esc_html__( 'The requested Jetpack module was not found.', 'jetpack' );
continue;
}
if (
'any' !== $request['slug']
&& ! Jetpack::is_module_active( $option_attrs['jp_group'] )
) {
// We only take note of skipped options when updating one module
$not_updated[ $option ] = esc_html__( 'The requested Jetpack module is inactive.', 'jetpack' );
continue;
}
}
// Properly cast value based on its type defined in endpoint accepted args.
$value = Jetpack_Core_Json_Api_Endpoints::cast_value( $value, $option_attrs );
switch ( $option ) {
case 'lang_id':
if ( defined( 'WPLANG' ) || ! current_user_can( 'install_languages' ) ) {
// We can't affect this setting
$updated = false;
break;
}
if ( $value === 'en_US' || empty( $value ) ) {
return delete_option( 'WPLANG' );
}
if ( ! function_exists( 'request_filesystem_credentials' ) ) {
require_once( ABSPATH . 'wp-admin/includes/file.php' );
}
if ( ! function_exists( 'wp_download_language_pack' ) ) {
require_once ABSPATH . 'wp-admin/includes/translation-install.php';
}
// `wp_download_language_pack` only tries to download packs if they're not already available
$language = wp_download_language_pack( $value );
if ( $language === false ) {
// The language pack download failed.
$updated = false;
break;
}
$updated = get_option( 'WPLANG' ) === $language ? true : update_option( 'WPLANG', $language );
break;
case 'monitor_receive_notifications':
$monitor = new Jetpack_Monitor();
// If we got true as response, consider it done.
$updated = true === $monitor->update_option_receive_jetpack_monitor_notification( $value );
break;
case 'post_by_email_address':
if ( 'create' == $value ) {
$result = $this->_process_post_by_email(
'jetpack.createPostByEmailAddress',
esc_html__( 'Unable to create the Post by Email address. Please try again later.', 'jetpack' )
);
} elseif ( 'regenerate' == $value ) {
$result = $this->_process_post_by_email(
'jetpack.regeneratePostByEmailAddress',
esc_html__( 'Unable to regenerate the Post by Email address. Please try again later.', 'jetpack' )
);
} elseif ( 'delete' == $value ) {
$result = $this->_process_post_by_email(
'jetpack.deletePostByEmailAddress',
esc_html__( 'Unable to delete the Post by Email address. Please try again later.', 'jetpack' )
);
} else {
$result = false;
}
// If we got an email address (create or regenerate) or 1 (delete), consider it done.
if ( is_string( $result ) && preg_match( '/[a-z0-9]+@post.wordpress.com/', $result ) ) {
$response[$option] = $result;
$updated = true;
} elseif ( 1 == $result ) {
$updated = true;
} elseif ( is_array( $result ) && isset( $result['message'] ) ) {
$error = $result['message'];
}
break;
case 'jetpack_protect_key':
$protect = Jetpack_Protect_Module::instance();
if ( 'create' == $value ) {
$result = $protect->get_protect_key();
} else {
$result = false;
}
// If we got one of Protect keys, consider it done.
if ( preg_match( '/[a-z0-9]{40,}/i', $result ) ) {
$response[$option] = $result;
$updated = true;
}
break;
case 'jetpack_protect_global_whitelist':
$updated = jetpack_protect_save_whitelist( explode( PHP_EOL, str_replace( array( ' ', ',' ), array( '', "\n" ), $value ) ) );
if ( is_wp_error( $updated ) ) {
$error = $updated->get_error_message();
}
break;
case 'show_headline':
case 'show_thumbnails':
$grouped_options = $grouped_options_current = (array) Jetpack_Options::get_option( 'relatedposts' );
$grouped_options[$option] = $value;
// If option value was the same, consider it done.
$updated = $grouped_options_current != $grouped_options ? Jetpack_Options::update_option( 'relatedposts', $grouped_options ) : true;
break;
case 'google':
case 'bing':
case 'pinterest':
case 'yandex':
$grouped_options = $grouped_options_current = (array) get_option( 'verification_services_codes' );
// Extracts the content attribute from the HTML meta tag if needed
if ( preg_match( '#.*<meta name="(?:[^"]+)" content="([^"]+)" />.*#i', $value, $matches ) ) {
$grouped_options[ $option ] = $matches[1];
} else {
$grouped_options[ $option ] = $value;
}
// If option value was the same, consider it done.
$updated = $grouped_options_current != $grouped_options ? update_option( 'verification_services_codes', $grouped_options ) : true;
break;
case 'sharing_services':
if ( ! class_exists( 'Sharing_Service' ) && ! include_once( JETPACK__PLUGIN_DIR . 'modules/sharedaddy/sharing-service.php' ) ) {
break;
}
$sharer = new Sharing_Service();
// If option value was the same, consider it done.
$updated = $value != $sharer->get_blog_services() ? $sharer->set_blog_services( $value['visible'], $value['hidden'] ) : true;
break;
case 'button_style':
case 'sharing_label':
case 'show':
if ( ! class_exists( 'Sharing_Service' ) && ! include_once( JETPACK__PLUGIN_DIR . 'modules/sharedaddy/sharing-service.php' ) ) {
break;
}
$sharer = new Sharing_Service();
$grouped_options = $sharer->get_global_options();
$grouped_options[ $option ] = $value;
$updated = $sharer->set_global_options( $grouped_options );
break;
case 'custom':
if ( ! class_exists( 'Sharing_Service' ) && ! include_once( JETPACK__PLUGIN_DIR . 'modules/sharedaddy/sharing-service.php' ) ) {
break;
}
$sharer = new Sharing_Service();
$updated = $sharer->new_service( stripslashes( $value['sharing_name'] ), stripslashes( $value['sharing_url'] ), stripslashes( $value['sharing_icon'] ) );
// Return new custom service
$response[$option] = $updated;
break;
case 'sharing_delete_service':
if ( ! class_exists( 'Sharing_Service' ) && ! include_once( JETPACK__PLUGIN_DIR . 'modules/sharedaddy/sharing-service.php' ) ) {
break;
}
$sharer = new Sharing_Service();
$updated = $sharer->delete_service( $value );
break;
case 'jetpack-twitter-cards-site-tag':
$value = trim( ltrim( strip_tags( $value ), '@' ) );
$updated = get_option( $option ) !== $value ? update_option( $option, $value ) : true;
break;
case 'onpublish':
case 'onupdate':
case 'Bias Language':
case 'Cliches':
case 'Complex Expression':
case 'Diacritical Marks':
case 'Double Negative':
case 'Hidden Verbs':
case 'Jargon Language':
case 'Passive voice':
case 'Phrases to Avoid':
case 'Redundant Expression':
case 'guess_lang':
if ( in_array( $option, array( 'onpublish', 'onupdate' ) ) ) {
$atd_option = 'AtD_check_when';
} elseif ( 'guess_lang' == $option ) {
$atd_option = 'AtD_guess_lang';
$option = 'true';
} else {
$atd_option = 'AtD_options';
}
$user_id = get_current_user_id();
if ( ! function_exists( 'AtD_get_options' ) ) {
include_once( JETPACK__PLUGIN_DIR . 'modules/after-the-deadline.php' );
}
$grouped_options_current = AtD_get_options( $user_id, $atd_option );
unset( $grouped_options_current['name'] );
$grouped_options = $grouped_options_current;
if ( $value && ! isset( $grouped_options [$option] ) ) {
$grouped_options [$option] = $value;
} elseif ( ! $value && isset( $grouped_options [$option] ) ) {
unset( $grouped_options [$option] );
}
// If option value was the same, consider it done, otherwise try to update it.
$options_to_save = implode( ',', array_keys( $grouped_options ) );
$updated = $grouped_options != $grouped_options_current ? AtD_update_setting( $user_id, $atd_option, $options_to_save ) : true;
break;
case 'ignored_phrases':
case 'unignore_phrase':
$user_id = get_current_user_id();
$atd_option = 'AtD_ignored_phrases';
$grouped_options = $grouped_options_current = explode( ',', AtD_get_setting( $user_id, $atd_option ) );
if ( 'ignored_phrases' == $option ) {
$grouped_options = explode( ',', $value );
} else {
$index = array_search( $value, $grouped_options );
if ( false !== $index ) {
unset( $grouped_options[$index] );
$grouped_options = array_values( $grouped_options );
}
}
$ignored_phrases = implode( ',', array_filter( array_map( 'strip_tags', $grouped_options ) ) );
$updated = $grouped_options != $grouped_options_current ? AtD_update_setting( $user_id, $atd_option, $ignored_phrases ) : true;
break;
case 'admin_bar':
case 'roles':
case 'count_roles':
case 'blog_id':
case 'do_not_track':
case 'hide_smile':
case 'version':
$grouped_options = $grouped_options_current = (array) get_option( 'stats_options' );
$grouped_options[$option] = $value;
// If option value was the same, consider it done.
$updated = $grouped_options_current != $grouped_options ? update_option( 'stats_options', $grouped_options ) : true;
break;
case 'akismet_show_user_comments_approved':
// Save Akismet option '1' or '0' like it's done in akismet/class.akismet-admin.php
$updated = get_option( $option ) != $value ? update_option( $option, (bool) $value ? '1' : '0' ) : true;
break;
case 'wordpress_api_key':
if ( ! file_exists( WP_PLUGIN_DIR . '/akismet/class.akismet.php' ) ) {
$error = esc_html__( 'Please install Akismet.', 'jetpack' );
$updated = false;
break;
}
if ( ! defined( 'AKISMET_VERSION' ) ) {
$error = esc_html__( 'Please activate Akismet.', 'jetpack' );
$updated = false;
break;
}
// Allow to clear the API key field
if ( '' === $value ) {
$updated = get_option( $option ) != $value ? update_option( $option, $value ) : true;
break;
}
require_once WP_PLUGIN_DIR . '/akismet/class.akismet.php';
require_once WP_PLUGIN_DIR . '/akismet/class.akismet-admin.php';
if ( class_exists( 'Akismet_Admin' ) && method_exists( 'Akismet_Admin', 'save_key' ) ) {
if ( Akismet::verify_key( $value ) === 'valid' ) {
$akismet_user = Akismet_Admin::get_akismet_user( $value );
if ( $akismet_user ) {
if ( in_array( $akismet_user->status, array( 'active', 'active-dunning', 'no-sub' ) ) ) {
$updated = get_option( $option ) != $value ? update_option( $option, $value ) : true;
break;
} else {
$error = esc_html__( "Akismet user status doesn't allow to update the key", 'jetpack' );
}
} else {
$error = esc_html__( 'Invalid Akismet user', 'jetpack' );
}
} else {
$error = esc_html__( 'Invalid Akismet key', 'jetpack' );
}
} else {
$error = esc_html__( 'Akismet is not installed or active', 'jetpack' );
}
$updated = false;
break;
case 'google_analytics_tracking_id':
$grouped_options = $grouped_options_current = (array) get_option( 'jetpack_wga' );
$grouped_options[ 'code' ] = $value;
// If option value was the same, consider it done.
$updated = $grouped_options_current != $grouped_options ? update_option( 'jetpack_wga', $grouped_options ) : true;
break;
case 'dismiss_dash_app_card':
case 'dismiss_empty_stats_card':
// If option value was the same, consider it done.
$updated = get_option( $option ) != $value ? update_option( $option, (bool) $value ) : true;
break;
case 'onboarding':
jetpack_require_lib( 'widgets' );
// Break apart and set Jetpack onboarding options.
$result = $this->_process_onboarding( (array) $value );
if ( empty( $result ) ) {
$updated = true;
} else {
$error = sprintf( esc_html__( 'Onboarding failed to process: %s', 'jetpack' ), $result );
$updated = false;
}
break;
case 'show_welcome_for_new_plan':
// If option value was the same, consider it done.
$updated = get_option( $option ) !== $value ? update_option( $option, (bool) $value ) : true;
break;
default:
// If option value was the same, consider it done.
$updated = get_option( $option ) != $value ? update_option( $option, $value ) : true;
break;
}
// The option was not updated.
if ( ! $updated ) {
$not_updated[ $option ] = $error;
}
}
if ( empty( $invalid ) && empty( $not_updated ) ) {
// The option was updated.
return rest_ensure_response( $response );
} else {
$invalid_count = count( $invalid );
$not_updated_count = count( $not_updated );
$error = '';
if ( $invalid_count > 0 ) {
$error = sprintf(
/* Translators: the plural variable is a comma-separated list. Example: dog, cat, bird. */
_n( 'Invalid option: %s.', 'Invalid options: %s.', $invalid_count, 'jetpack' ),
join( ', ', $invalid )
);
}
if ( $not_updated_count > 0 ) {
$not_updated_messages = array();
foreach ( $not_updated as $not_updated_option => $not_updated_message ) {
if ( ! empty( $not_updated_message ) ) {
$not_updated_messages[] = sprintf(
/* Translators: the first variable is a module option or slug, or setting. The second is the error message . */
__( '%1$s: %2$s', 'jetpack' ),
$not_updated_option, $not_updated_message );
}
}
if ( ! empty( $error ) ) {
$error .= ' ';
}
if ( ! empty( $not_updated_messages ) ) {
$error .= ' ' . join( '. ', $not_updated_messages );
}
}
// There was an error because some options were updated but others were invalid or failed to update.
return new WP_Error( 'some_updated', esc_html( $error ), array( 'status' => 400 ) );
}
}
/**
* Perform tasks in the site based on onboarding choices.
*
* @since 5.4.0
*
* @param array $data Onboarding choices made by user.
*
* @return string Result of onboarding processing and, if there is one, an error message.
*/
private function _process_onboarding( $data ) {
if ( isset( $data['end'] ) && $data['end'] ) {
return Jetpack::invalidate_onboarding_token()
? ''
: esc_html__( "The onboarding token couldn't be deleted.", 'jetpack' );
}
$error = array();
if ( ! empty( $data['siteTitle'] ) ) {
// If option value was the same, consider it done.
if ( ! ( update_option( 'blogname', $data['siteTitle'] ) || get_option( 'blogname' ) == $data['siteTitle'] ) ) {
$error[] = 'siteTitle';
}
}
if ( isset( $data['siteDescription'] ) ) {
// If option value was the same, consider it done.
if ( ! ( update_option( 'blogdescription', $data['siteDescription'] ) || get_option( 'blogdescription' ) == $data['siteDescription'] ) ) {
$error[] = 'siteDescription';
}
}
$site_title = get_option( 'blogname' );
$author = get_current_user_id() || 1;
if ( ! empty( $data['siteType'] ) ) {
if ( ! ( update_option( 'jpo_site_type', $data['siteType'] ) || get_option( 'jpo_site_type' ) == $data['siteType'] ) ) {
$error[] = 'siteType';
}
}
if ( isset( $data['homepageFormat'] ) ) {
// If $data['homepageFormat'] is 'posts', we have nothing to do since it's WordPress' default
// if it exists, just update
$homepage_format = get_option( 'jpo_homepage_format' );
if ( ! $homepage_format || $homepage_format !== $data['homepageFormat'] ) {
if ( 'page' === $data['homepageFormat'] ) {
if ( ! ( update_option( 'show_on_front', 'page' ) || get_option( 'show_on_front' ) == 'page' ) ) {
$error[] = 'homepageFormat';
}
$home = wp_insert_post( array(
'post_type' => 'page',
/* translators: this references the home page of a site, also called front page. */
'post_title' => esc_html_x( 'Home Page', 'The home page of a website.', 'jetpack' ),
'post_content' => sprintf( esc_html__( 'Welcome to %s.', 'jetpack' ), $site_title ),
'post_status' => 'publish',
'post_author' => $author,
) );
if ( 0 == $home ) {
$error[] = 'home insert: 0';
} elseif ( is_wp_error( $home ) ) {
$error[] = 'home creation: '. $home->get_error_message();
}
if ( ! ( update_option( 'page_on_front', $home ) || get_option( 'page_on_front' ) == $home ) ) {
$error[] = 'home set';
}
$blog = wp_insert_post( array(
'post_type' => 'page',
/* translators: this references the page where blog posts are listed. */
'post_title' => esc_html_x( 'Blog', 'The blog of a website.', 'jetpack' ),
'post_content' => sprintf( esc_html__( 'These are the latest posts in %s.', 'jetpack' ), $site_title ),
'post_status' => 'publish',
'post_author' => $author,
) );
if ( 0 == $blog ) {
$error[] = 'blog insert: 0';
} elseif ( is_wp_error( $blog ) ) {
$error[] = 'blog creation: '. $blog->get_error_message();
}
if ( ! ( update_option( 'page_for_posts', $blog ) || get_option( 'page_for_posts' ) == $blog ) ) {
$error[] = 'blog set';
}
} else {
$front_page = get_option( 'page_on_front' );
$posts_page = get_option( 'page_for_posts' );
if ( $posts_page && get_post( $posts_page ) ) {
wp_delete_post( $posts_page );
}
if ( $front_page && get_post( $front_page ) ) {
wp_delete_post( $front_page );
}
update_option( 'show_on_front', 'posts' );
}
}
update_option( 'jpo_homepage_format', $data['homepageFormat'] );
}
// Setup contact page and add a form and/or business info
$contact_page = '';
if ( ! empty( $data['addContactForm'] ) && ! get_option( 'jpo_contact_page' ) ) {
$contact_form_module_active = Jetpack::is_module_active( 'contact-form' );
if ( ! $contact_form_module_active ) {
$contact_form_module_active = Jetpack::activate_module( 'contact-form', false, false );
}
if ( $contact_form_module_active ) {
$contact_page = '[contact-form][contact-field label="' . esc_html__( 'Name', 'jetpack' ) . '" type="name" required="true" /][contact-field label="' . esc_html__( 'Email', 'jetpack' ) . '" type="email" required="true" /][contact-field label="' . esc_html__( 'Website', 'jetpack' ) . '" type="url" /][contact-field label="' . esc_html__( 'Message', 'jetpack' ) . '" type="textarea" /][/contact-form]';
} else {
$error[] = 'contact-form activate';
}
}
if ( isset( $data['businessPersonal'] ) && 'business' === $data['businessPersonal'] ) {
$contact_page .= "\n" . join( "\n", $data['businessInfo'] );
}
if ( ! empty( $contact_page ) ) {
$form = wp_insert_post( array(
'post_type' => 'page',
/* translators: this references a page with contact details and possibly a form. */
'post_title' => esc_html_x( 'Contact us', 'Contact page for your website.', 'jetpack' ),
'post_content' => esc_html__( 'Send us a message!', 'jetpack' ) . "\n" . $contact_page,
'post_status' => 'publish',
'post_author' => $author,
) );
if ( 0 == $form ) {
$error[] = 'form insert: 0';
} elseif ( is_wp_error( $form ) ) {
$error[] = 'form creation: '. $form->get_error_message();
} else {
update_option( 'jpo_contact_page', $form );
}
}
if ( isset( $data['businessAddress'] ) ) {
$handled_business_address = self::handle_business_address( $data['businessAddress'] );
if ( is_wp_error( $handled_business_address ) ) {
$error[] = 'BusinessAddress';
}
}
if ( ! empty( $data['installWooCommerce'] ) ) {
jetpack_require_lib( 'plugins' );
$wc_install_result = Jetpack_Plugins::install_and_activate_plugin( 'woocommerce' );
delete_transient( '_wc_activation_redirect' ); // Redirecting to WC setup would kill our users' flow
if ( is_wp_error( $wc_install_result ) ) {
$error[] = 'woocommerce installation';
}
}
if ( ! empty( $data['stats'] ) ) {
if ( Jetpack::is_active() ) {
$stats_module_active = Jetpack::is_module_active( 'stats' );
if ( ! $stats_module_active ) {
$stats_module_active = Jetpack::activate_module( 'stats', false, false );
}
if ( ! $stats_module_active ) {
$error[] = 'stats activate';
}
} else {
$error[] = 'stats not connected';
}
}
return empty( $error )
? ''
: join( ', ', $error );
}
/**
* Add or update Business Address widget.
*
* @param array $address Array of business address fields.
*
* @return WP_Error|true True if the data was saved correctly.
*/
static function handle_business_address( $address ) {
$first_sidebar = Jetpack_Widgets::get_first_sidebar();
$widgets_module_active = Jetpack::is_module_active( 'widgets' );
if ( ! $widgets_module_active ) {
$widgets_module_active = Jetpack::activate_module( 'widgets', false, false );
}
if ( ! $widgets_module_active ) {
return new WP_Error( 'module_activation_failed', 'Failed to activate the widgets module.', 400 );
}
if ( $first_sidebar ) {
$title = isset( $address['name'] ) ? sanitize_text_field( $address['name'] ) : '';
$street = isset( $address['street'] ) ? sanitize_text_field( $address['street'] ) : '';
$city = isset( $address['city'] ) ? sanitize_text_field( $address['city'] ) : '';
$state = isset( $address['state'] ) ? sanitize_text_field( $address['state'] ) : '';
$zip = isset( $address['zip'] ) ? sanitize_text_field( $address['zip'] ) : '';
$country = isset( $address['country'] ) ? sanitize_text_field( $address['country'] ) : '';
$full_address = implode( ' ', array_filter( array( $street, $city, $state, $zip, $country ) ) );
$widget_options = array(
'title' => $title,
'address' => $full_address,
'phone' => '',
'hours' => '',
'showmap' => false,
'email' => ''
);
$widget_updated = '';
if ( ! self::has_business_address_widget( $first_sidebar ) ) {
$widget_updated = Jetpack_Widgets::insert_widget_in_sidebar( 'widget_contact_info', $widget_options, $first_sidebar );
} else {
$widget_updated = Jetpack_Widgets::update_widget_in_sidebar( 'widget_contact_info', $widget_options, $first_sidebar );
}
if ( is_wp_error( $widget_updated ) ) {
return new WP_Error( 'widget_update_failed', 'Widget could not be updated.', 400 );
}
$address_save = array(
'name' => $title,
'street' => $street,
'city' => $city,
'state' => $state,
'zip' => $zip,
'country' => $country
);
update_option( 'jpo_business_address', $address_save );
return true;
}
// No sidebar to place the widget
return new WP_Error( 'sidebar_not_found', 'No sidebar.', 400 );
}
/**
* Check whether "Contact Info & Map" widget is present in a given sidebar.
*
* @param string $sidebar ID of the sidebar to which the widget will be added.
*
* @return bool Whether the widget is present in a given sidebar.
*/
static function has_business_address_widget( $sidebar ) {
$sidebars_widgets = get_option( 'sidebars_widgets', array() );
if ( ! isset( $sidebars_widgets[ $sidebar ] ) ) {
return false;
}
foreach ( $sidebars_widgets[ $sidebar ] as $widget ) {
if ( strpos( $widget, 'widget_contact_info' ) !== false ) {
return true;
}
}
return false;
}
/**
* Calls WPCOM through authenticated request to create, regenerate or delete the Post by Email address.
* @todo: When all settings are updated to use endpoints, move this to the Post by Email module and replace __process_ajax_proxy_request.
*
* @since 4.3.0
*
* @param string $endpoint Process to call on WPCOM to create, regenerate or delete the Post by Email address.
* @param string $error Error message to return.
*
* @return array
*/
private function _process_post_by_email( $endpoint, $error ) {
if ( ! current_user_can( 'edit_posts' ) ) {
return array( 'message' => $error );
}
$this->xmlrpc->query( $endpoint );
if ( $this->xmlrpc->isError() ) {
return array( 'message' => $error );
}
$response = $this->xmlrpc->getResponse();
if ( empty( $response ) ) {
return array( 'message' => $error );
}
// Used only in Jetpack_Core_Json_Api_Endpoints::get_remote_value.
update_option( 'post_by_email_address' . get_current_user_id(), $response );
return $response;
}
/**
* Check if user is allowed to perform the update.
*
* @since 4.3.0
*
* @param WP_REST_Request $request The request sent to the WP REST API.
*
* @return bool
*/
public function can_request( $request ) {
$req_params = $request->get_params();
if ( ! empty( $req_params['onboarding']['token'] ) && isset( $req_params['rest_route'] ) ) {
return Jetpack::validate_onboarding_token_action( $req_params['onboarding']['token'], $req_params['rest_route'] );
}
if ( 'GET' === $request->get_method() ) {
return current_user_can( 'jetpack_admin_page' );
} else {
$module = Jetpack_Core_Json_Api_Endpoints::get_module_requested();
if ( empty( $module ) ) {
$params = $request->get_json_params();
if ( ! is_array( $params ) ) {
$params = $request->get_body_params();
}
$options = Jetpack_Core_Json_Api_Endpoints::get_updateable_data_list( $params );
foreach ( $options as $option => $definition ) {
if ( in_array( $options[ $option ]['jp_group'], array( 'after-the-deadline', 'post-by-email' ) ) ) {
$module = $options[ $option ]['jp_group'];
break;
}
}
}
// User is trying to create, regenerate or delete its PbE || ATD settings.
if ( 'post-by-email' === $module || 'after-the-deadline' === $module ) {
return current_user_can( 'edit_posts' ) && current_user_can( 'jetpack_admin_page' );
}
return current_user_can( 'jetpack_configure_modules' );
}
}
}
class Jetpack_Core_API_Module_Data_Endpoint {
public function process( $request ) {
switch( $request['slug'] ) {
case 'protect':
return $this->get_protect_data();
case 'stats':
return $this->get_stats_data( $request );
case 'akismet':
return $this->get_akismet_data();
case 'monitor':
return $this->get_monitor_data();
case 'verification-tools':
return $this->get_verification_tools_data();
case 'vaultpress':
return $this->get_vaultpress_data();
}
}
/**
* Decide against which service to check the key.
*
* @since 4.8.0
*
* @param WP_REST_Request $request
*
* @return bool
*/
public function key_check( $request ) {
switch( $request['service'] ) {
case 'akismet':
$params = $request->get_json_params();
if ( isset( $params['api_key'] ) && ! empty( $params['api_key'] ) ) {
return $this->check_akismet_key( $params['api_key'] );
}
return $this->check_akismet_key();
}
return false;
}
/**
* Get number of blocked intrusion attempts.
*
* @since 4.3.0
*
* @return mixed|WP_Error Number of blocked attempts if protection is enabled. Otherwise, a WP_Error instance with the corresponding error.
*/
public function get_protect_data() {
if ( Jetpack::is_module_active( 'protect' ) ) {
return get_site_option( 'jetpack_protect_blocked_attempts' );
}
return new WP_Error(
'not_active',
esc_html__( 'The requested Jetpack module is not active.', 'jetpack' ),
array( 'status' => 404 )
);
}
/**
* Get number of spam messages blocked by Akismet.
*
* @since 4.3.0
*
* @return int|string Number of spam blocked by Akismet. Otherwise, an error message.
*/
public function get_akismet_data() {
if ( ! is_wp_error( $status = $this->akismet_is_active_and_registered() ) ) {
return rest_ensure_response( Akismet_Admin::get_stats( Akismet::get_api_key() ) );
} else {
return $status->get_error_code();
}
}
/**
* Verify the Akismet API key.
*
* @since 4.8.0
*
* @param string $api_key Optional API key to check.
*
* @return array Information about the key. 'validKey' is true if key is valid, false otherwise.
*/
public function check_akismet_key( $api_key = '' ) {
$akismet_status = $this->akismet_class_exists();
if ( is_wp_error( $akismet_status ) ) {
return rest_ensure_response( array(
'validKey' => false,
'invalidKeyCode' => $akismet_status->get_error_code(),
'invalidKeyMessage' => $akismet_status->get_error_message(),
) );
}
$key_status = Akismet::check_key_status( empty( $api_key ) ? Akismet::get_api_key() : $api_key );
if ( ! $key_status || 'invalid' === $key_status || 'failed' === $key_status ) {
return rest_ensure_response( array(
'validKey' => false,
'invalidKeyCode' => 'invalid_key',
'invalidKeyMessage' => esc_html__( 'Invalid Akismet key. Please contact support.', 'jetpack' ),
) );
}
return rest_ensure_response( array(
'validKey' => isset( $key_status[1] ) && 'valid' === $key_status[1]
) );
}
/**
* Check if Akismet class file exists and if class is loaded.
*
* @since 4.8.0
*
* @return bool|WP_Error Returns true if class file exists and class is loaded, WP_Error otherwise.
*/
private function akismet_class_exists() {
if ( ! file_exists( WP_PLUGIN_DIR . '/akismet/class.akismet.php' ) ) {
return new WP_Error( 'not_installed', esc_html__( 'Please install Akismet.', 'jetpack' ), array( 'status' => 400 ) );
}
if ( ! class_exists( 'Akismet' ) ) {
return new WP_Error( 'not_active', esc_html__( 'Please activate Akismet.', 'jetpack' ), array( 'status' => 400 ) );
}
return true;
}
/**
* Is Akismet registered and active?
*
* @since 4.3.0
*
* @return bool|WP_Error True if Akismet is active and registered. Otherwise, a WP_Error instance with the corresponding error.
*/
private function akismet_is_active_and_registered() {
if ( is_wp_error( $akismet_exists = $this->akismet_class_exists() ) ) {
return $akismet_exists;
}
// What about if Akismet is put in a sub-directory or maybe in mu-plugins?
require_once WP_PLUGIN_DIR . '/akismet/class.akismet.php';
require_once WP_PLUGIN_DIR . '/akismet/class.akismet-admin.php';
$akismet_key = Akismet::verify_key( Akismet::get_api_key() );
if ( ! $akismet_key || 'invalid' === $akismet_key || 'failed' === $akismet_key ) {
return new WP_Error( 'invalid_key', esc_html__( 'Invalid Akismet key. Please contact support.', 'jetpack' ), array( 'status' => 400 ) );
}
return true;
}
/**
* Get stats data for this site
*
* @since 4.1.0
*
* @param WP_REST_Request $request {
* Array of parameters received by request.
*
* @type string $date Date range to restrict results to.
* }
*
* @return int|string Number of spam blocked by Akismet. Otherwise, an error message.
*/
public function get_stats_data( WP_REST_Request $request ) {
// Get parameters to fetch Stats data.
$range = $request->get_param( 'range' );
// If no parameters were passed.
if (
empty ( $range )
|| ! in_array( $range, array( 'day', 'week', 'month' ), true )
) {
$range = 'day';
}
if ( ! function_exists( 'stats_get_from_restapi' ) ) {
require_once( JETPACK__PLUGIN_DIR . 'modules/stats.php' );
}
switch ( $range ) {
// This is always called first on page load
case 'day':
$initial_stats = stats_get_from_restapi();
return rest_ensure_response( array(
'general' => $initial_stats,
// Build data for 'day' as if it was stats_get_from_restapi( array(), 'visits?unit=day&quantity=30' );
'day' => isset( $initial_stats->visits )
? $initial_stats->visits
: array(),
) );
case 'week':
return rest_ensure_response( array(
'week' => stats_get_from_restapi( array(), 'visits?unit=week&quantity=14' ),
) );
case 'month':
return rest_ensure_response( array(
'month' => stats_get_from_restapi( array(), 'visits?unit=month&quantity=12&' ),
) );
}
}
/**
* Get date of last downtime.
*
* @since 4.3.0
*
* @return mixed|WP_Error Number of days since last downtime. Otherwise, a WP_Error instance with the corresponding error.
*/
public function get_monitor_data() {
if ( ! Jetpack::is_module_active( 'monitor' ) ) {
return new WP_Error(
'not_active',
esc_html__( 'The requested Jetpack module is not active.', 'jetpack' ),
array( 'status' => 404 )
);
}
$monitor = new Jetpack_Monitor();
$last_downtime = $monitor->monitor_get_last_downtime();
if ( is_wp_error( $last_downtime ) ) {
return $last_downtime;
} else if ( false === strtotime( $last_downtime ) ) {
return rest_ensure_response( array(
'code' => 'success',
'date' => null,
) );
} else {
return rest_ensure_response( array(
'code' => 'success',
'date' => human_time_diff( strtotime( $last_downtime ), strtotime( 'now' ) ),
) );
}
}
/**
* Get services that this site is verified with.
*
* @since 4.3.0
*
* @return mixed|WP_Error List of services that verified this site. Otherwise, a WP_Error instance with the corresponding error.
*/
public function get_verification_tools_data() {
if ( ! Jetpack::is_module_active( 'verification-tools' ) ) {
return new WP_Error(
'not_active',
esc_html__( 'The requested Jetpack module is not active.', 'jetpack' ),
array( 'status' => 404 )
);
}
$verification_services_codes = get_option( 'verification_services_codes' );
if (
! is_array( $verification_services_codes )
|| empty( $verification_services_codes )
) {
return new WP_Error(
'empty',
esc_html__( 'Site not verified with any service.', 'jetpack' ),
array( 'status' => 404 )
);
}
$services = array();
foreach ( jetpack_verification_services() as $name => $service ) {
if ( is_array( $service ) && ! empty( $verification_services_codes[ $name ] ) ) {
switch ( $name ) {
case 'google':
$services[] = 'Google';
break;
case 'bing':
$services[] = 'Bing';
break;
case 'pinterest':
$services[] = 'Pinterest';
break;
case 'yandex':
$services[] = 'Yandex';
break;
}
}
}
if ( empty( $services ) ) {
return new WP_Error(
'empty',
esc_html__( 'Site not verified with any service.', 'jetpack' ),
array( 'status' => 404 )
);
}
if ( 2 > count( $services ) ) {
$message = esc_html(
sprintf(
/* translators: %s is a service name like Google, Bing, Pinterest, etc. */
__( 'Your site is verified with %s.', 'jetpack' ),
$services[0]
)
);
} else {
$copy_services = $services;
$last = count( $copy_services ) - 1;
$last_service = $copy_services[ $last ];
unset( $copy_services[ $last ] );
$message = esc_html(
sprintf(
/* translators: %1$s is a comma separated list of services, and %2$s is a single service name like Google, Bing, Pinterest, etc. */
__( 'Your site is verified with %1$s and %2$s.', 'jetpack' ),
join( ', ', $copy_services ),
$last_service
)
);
}
return rest_ensure_response( array(
'code' => 'success',
'message' => $message,
'services' => $services,
) );
}
/**
* Get VaultPress site data including, among other things, the date of the last backup if it was completed.
*
* @since 4.3.0
*
* @return mixed|WP_Error VaultPress site data. Otherwise, a WP_Error instance with the corresponding error.
*/
public function get_vaultpress_data() {
if ( ! class_exists( 'VaultPress' ) ) {
return new WP_Error(
'not_active',
esc_html__( 'The requested Jetpack module is not active.', 'jetpack' ),
array( 'status' => 404 )
);
}
$vaultpress = new VaultPress();
if ( ! $vaultpress->is_registered() ) {
return rest_ensure_response( array(
'code' => 'not_registered',
'message' => esc_html__( 'You need to register for VaultPress.', 'jetpack' )
) );
}
$data = json_decode( base64_decode( $vaultpress->contact_service( 'plugin_data' ) ) );
if ( false == $data ) {
return rest_ensure_response( array(
'code' => 'not_registered',
'message' => esc_html__( 'Could not connect to VaultPress.', 'jetpack' )
) );
} else if ( is_wp_error( $data ) || ! isset( $data->backups->last_backup ) ) {
return $data;
} else if ( empty( $data->backups->last_backup ) ) {
return rest_ensure_response( array(
'code' => 'success',
'message' => esc_html__( 'VaultPress is active and will back up your site soon.', 'jetpack' ),
'data' => $data,
) );
} else {
return rest_ensure_response( array(
'code' => 'success',
'message' => esc_html(
sprintf(
__( 'Your site was successfully backed-up %s ago.', 'jetpack' ),
human_time_diff(
$data->backups->last_backup,
current_time( 'timestamp' )
)
)
),
'data' => $data,
) );
}
}
/**
* A WordPress REST API permission callback method that accepts a request object and
* decides if the current user has enough privileges to act.
*
* @since 4.3.0
*
* @return bool does a current user have enough privileges.
*/
public function can_request() {
return current_user_can( 'jetpack_admin_page' );
}
}
/**
* Actions performed only when Gravatar Hovercards is activated through the endpoint call.
*
* @since 4.3.1
*/
function jetpack_do_after_gravatar_hovercards_activation() {
// When Gravatar Hovercards is activated, enable them automatically.
update_option( 'gravatar_disable_hovercards', 'enabled' );
}
add_action( 'jetpack_activate_module_gravatar-hovercards', 'jetpack_do_after_gravatar_hovercards_activation' );
/**
* Actions performed only when Gravatar Hovercards is activated through the endpoint call.
*
* @since 4.3.1
*/
function jetpack_do_after_gravatar_hovercards_deactivation() {
// When Gravatar Hovercards is deactivated, disable them automatically.
update_option( 'gravatar_disable_hovercards', 'disabled' );
}
add_action( 'jetpack_deactivate_module_gravatar-hovercards', 'jetpack_do_after_gravatar_hovercards_deactivation' );
/**
* Actions performed only when Markdown is activated through the endpoint call.
*
* @since 4.7.0
*/
function jetpack_do_after_markdown_activation() {
// When Markdown is activated, enable support for post editing automatically.
update_option( 'wpcom_publish_posts_with_markdown', true );
}
add_action( 'jetpack_activate_module_markdown', 'jetpack_do_after_markdown_activation' );
|