PluginProbe
Jetpack – WP Security, Backup, Speed, & Growth / 16.3-a.7
Jetpack – WP Security, Backup, Speed, & Growth v16.3-a.7
16.3-a.5 16.3-a.7 16.3-a.3 16.3-a.1 16.2 16.2-beta 12.0.3 12.1.3 12.2.3 12.3.2 12.4.2 12.5.2 12.6.4 12.7.3 12.8.3 12.9.5 13.0.2 13.1.5 13.2.4 13.3.3 13.4.5 13.5.2 13.6.2 13.7.2 13.8.3 All 506 releases
← All changes | class.jetpack-cli.php +161 -119 12.3.2 → 16.3-a.7 View file →
@@ -9,8 +9,10 @@
9 9 use Automattic\Jetpack\Connection\Manager as Connection_Manager;
10 10 use Automattic\Jetpack\Connection\Tokens;
11 11 use Automattic\Jetpack\Identity_Crisis;
12 12 use Automattic\Jetpack\IP\Utils as IP_Utils;
13 +use Automattic\Jetpack\Publicize\Connections;
14 +use Automattic\Jetpack\Publicize\Publicize;
13 15 use Automattic\Jetpack\Status;
14 16 use Automattic\Jetpack\Sync\Actions;
15 17 use Automattic\Jetpack\Sync\Listener;
16 18 use Automattic\Jetpack\Sync\Modules;
@@ -84,9 +86,9 @@
84 86 }
85 87
86 88 $master_user_email = Jetpack::get_master_user_email();
87 89
88 - $cxntests = new Jetpack_Cxn_Tests();
90 + $cxntests = new Automattic\Jetpack\Connection\Connection_Health_Tests();
89 91
90 92 if ( $cxntests->pass() ) {
91 93 $cxntests->output_results_for_cli();
92 94
@@ -229,9 +231,9 @@
229 231 WP_CLI::success( __( 'The site is not currently connected, so nothing to do!', 'jetpack' ) );
230 232 return;
231 233 }
232 234
233 - $action = isset( $args[0] ) ? $args[0] : 'prompt';
235 + $action = $args[0] ?? 'prompt';
234 236 if ( ! in_array( $action, array( 'blog', 'user', 'prompt' ), true ) ) {
235 237 /* translators: %s is a command like "prompt" */
236 238 WP_CLI::error( sprintf( __( '%s is not a valid command.', 'jetpack' ), $action ) );
237 239 }
@@ -323,9 +325,9 @@
323 325 * @param array $args Positional args.
324 326 * @param array $assoc_args Named args.
325 327 */
326 328 public function reset( $args, $assoc_args ) {
327 - $action = isset( $args[0] ) ? $args[0] : 'prompt';
329 + $action = $args[0] ?? 'prompt';
328 330 if ( ! in_array( $action, array( 'options', 'modules', 'sync-checksum' ), true ) ) {
329 331 /* translators: %s is a command like "prompt" */
330 332 WP_CLI::error( sprintf( __( '%s is not a valid command.', 'jetpack' ), $action ) );
331 333 }
@@ -544,9 +546,9 @@
544 546 * @param array $assoc_args Named args.
545 547 */
546 548 public function module( $args, $assoc_args ) {
547 549 $module_slug = null;
548 - $action = isset( $args[0] ) ? $args[0] : 'list';
550 + $action = $args[0] ?? 'list';
549 551
550 552 if ( isset( $args[1] ) ) {
551 553 $module_slug = $args[1];
552 554 if ( 'all' !== $module_slug && ! Jetpack::is_module( $module_slug ) ) {
@@ -589,8 +591,12 @@
589 591 case 'activate':
590 592 $module = Jetpack::get_module( $module_slug );
591 593 Jetpack::log( 'activate', $module_slug );
592 594 if ( Jetpack::activate_module( $module_slug, false, false ) ) {
595 + if ( ! Jetpack::is_module_active( $module_slug ) ) {
596 + /* translators: %s is the name of a Jetpack module */
597 + WP_CLI::error( sprintf( __( '%s is disabled by your host or site administrator, so it stays off.', 'jetpack' ), $module['name'] ) );
598 + }
593 599 /* translators: %s is the name of a Jetpack module */
594 600 WP_CLI::success( sprintf( __( '%s has been activated.', 'jetpack' ), $module['name'] ) );
595 601 } else {
596 602 /* translators: %s is the name of a Jetpack module */
@@ -605,8 +611,12 @@
605 611 case 'deactivate':
606 612 $module = Jetpack::get_module( $module_slug );
607 613 Jetpack::log( 'deactivate', $module_slug );
608 614 Jetpack::deactivate_module( $module_slug );
615 + if ( Jetpack::is_module_active( $module_slug ) ) {
616 + /* translators: %s is the name of a Jetpack module */
617 + WP_CLI::error( sprintf( __( '%s is enabled by your host or site administrator, so it stays on.', 'jetpack' ), $module['name'] ) );
618 + }
609 619 /* translators: %s is the name of a Jetpack module */
610 620 WP_CLI::success( sprintf( __( '%s has been deactivated.', 'jetpack' ), $module['name'] ) );
611 621 break;
612 622 case 'deactivate_all':
@@ -637,9 +647,9 @@
637 647 *
638 648 * @param array $args Positional args.
639 649 */
640 650 public function protect( $args ) {
641 - $action = isset( $args[0] ) ? $args[0] : 'prompt';
651 + $action = $args[0] ?? 'prompt';
642 652 if ( ! in_array( $action, array( 'whitelist', 'allow' ), true ) ) { // Still allow "whitelist" for legacy support.
643 653 /* translators: %s is a command like "prompt" */
644 654 WP_CLI::error( sprintf( __( '%s is not a valid command.', 'jetpack' ), $action ) );
645 655 }
@@ -766,9 +776,9 @@
766 776 *
767 777 * @param array $args Positional args.
768 778 */
769 779 public function options( $args ) {
770 - $action = isset( $args[0] ) ? $args[0] : 'list';
780 + $action = $args[0] ?? 'list';
771 781 $safe_to_modify = Jetpack_Options::get_options_for_reset();
772 782
773 783 // Is the option flagged as unsafe?
774 784 $flagged = ! in_array( $args[1], $safe_to_modify, true );
@@ -892,9 +902,9 @@
892 902 * @param array $assoc_args Named args.
893 903 */
894 904 public function sync( $args, $assoc_args ) {
895 905
896 - $action = isset( $args[0] ) ? $args[0] : 'status';
906 + $action = $args[0] ?? 'status';
897 907
898 908 switch ( $action ) {
899 909 case 'status':
900 910 $status = Actions::get_sync_status();
@@ -901,9 +911,9 @@
901 911 $collection = array();
902 912 foreach ( $status as $key => $item ) {
903 913 $collection[] = array(
904 914 'option' => $key,
905 - 'value' => is_scalar( $item ) ? $item : wp_json_encode( $item ),
915 + 'value' => is_scalar( $item ) ? $item : wp_json_encode( $item, JSON_UNESCAPED_SLASHES ),
906 916 );
907 917 }
908 918 WP_CLI::log( __( 'Sync Status:', 'jetpack' ) );
909 919 WP_CLI\Utils\format_items( 'table', $collection, array( 'option', 'value' ) );
@@ -913,9 +923,9 @@
913 923 $settings = array();
914 924 foreach ( Settings::get_settings() as $setting => $item ) {
915 925 $settings[] = array(
916 926 'setting' => $setting,
917 - 'value' => is_scalar( $item ) ? $item : wp_json_encode( $item ),
927 + 'value' => is_scalar( $item ) ? $item : wp_json_encode( $item, JSON_UNESCAPED_SLASHES ),
918 928 );
919 929 }
920 930 WP_CLI\Utils\format_items( 'table', $settings, array( 'setting', 'value' ) );
921 931 break;
@@ -983,10 +993,10 @@
983 993 if ( $status->is_offline_mode() ) {
984 994 WP_CLI::error( __( 'Jetpack sync is not currently allowed for this site. The site is in offline mode.', 'jetpack' ) );
985 995 return;
986 996 }
987 - if ( $status->is_staging_site() ) {
988 - WP_CLI::error( __( 'Jetpack sync is not currently allowed for this site. The site is in staging mode.', 'jetpack' ) );
997 + if ( $status->in_safe_mode() ) {
998 + WP_CLI::error( __( 'Jetpack sync is not currently allowed for this site. The site is in safe mode.', 'jetpack' ) );
989 999 return;
990 1000 }
991 1001 }
992 1002 // Get the original settings so that we can restore them later.
@@ -1033,11 +1043,11 @@
1033 1043 $modules = null;
1034 1044 }
1035 1045
1036 1046 // Kick off a full sync.
1037 - if ( Actions::do_full_sync( $modules ) ) {
1047 + if ( Actions::do_full_sync( $modules, 'jetpack_cli' ) ) {
1038 1048 if ( $modules ) {
1039 - /* translators: %s is a comma separated list of Jetpack modules */
1049 + /* translators: %s is a comma-separated list of Jetpack modules */
1040 1050 WP_CLI::log( sprintf( __( 'Initialized a new full sync with modules: %s', 'jetpack' ), implode( ', ', array_keys( $modules ) ) ) );
1041 1051 } else {
1042 1052 WP_CLI::log( __( 'Initialized a new full sync', 'jetpack' ) );
1043 1053 }
@@ -1046,9 +1056,9 @@
1046 1056 // Reset sync settings to original.
1047 1057 Settings::update_settings( $original_settings );
1048 1058
1049 1059 if ( $modules ) {
1050 - /* translators: %s is a comma separated list of Jetpack modules */
1060 + /* translators: %s is a comma-separated list of Jetpack modules */
1051 1061 WP_CLI::error( sprintf( __( 'Could not start a new full sync with modules: %s', 'jetpack' ), implode( ', ', $modules ) ) );
1052 1062 } else {
1053 1063 WP_CLI::error( __( 'Could not start a new full sync', 'jetpack' ) );
1054 1064 }
@@ -1071,9 +1081,9 @@
1071 1081 WP_CLI::log( __( 'Sent more data to WordPress.com', 'jetpack' ) );
1072 1082 }
1073 1083
1074 1084 // Immediate Full Sync does not wait for WP.com to process data so we need to enforce a wait.
1075 - if ( false !== strpos( get_class( Modules::get_module( 'full-sync' ) ), 'Full_Sync_Immediately' ) ) {
1085 + if ( Modules::get_module( 'full-sync' ) instanceof \Automattic\Jetpack\Sync\Modules\Full_Sync_Immediately ) {
1076 1086 sleep( 15 );
1077 1087 }
1078 1088 }
1079 1089 ++$i;
@@ -1106,10 +1116,10 @@
1106 1116 if ( ! Actions::sync_allowed() ) {
1107 1117 WP_CLI::error( __( 'Jetpack sync is not currently allowed for this site.', 'jetpack' ) );
1108 1118 }
1109 1119
1110 - $queue_name = isset( $args[0] ) ? $args[0] : 'sync';
1111 - $action = isset( $args[1] ) ? $args[1] : 'peek';
1120 + $queue_name = $args[0] ?? 'sync';
1121 + $action = $args[1] ?? 'peek';
1112 1122
1113 1123 // We map the queue name that way we can support more friendly queue names in the commands, but still use
1114 1124 // the queue name that the code expects.
1115 1125 $allowed_queues = array(
@@ -1116,9 +1126,9 @@
1116 1126 'incremental' => 'sync',
1117 1127 'full' => 'full_sync',
1118 1128 );
1119 1129 $queue_name_map = $allowed_queues;
1120 - $mapped_queue_name = isset( $queue_name_map[ $queue_name ] ) ? $queue_name_map[ $queue_name ] : $queue_name;
1130 + $mapped_queue_name = $queue_name_map[ $queue_name ] ?? $queue_name;
1121 1131
1122 1132 switch ( $action ) {
1123 1133 case 'peek':
1124 1134 $queue = new Queue( $mapped_queue_name );
@@ -1131,9 +1141,9 @@
1131 1141 $collection = array();
1132 1142 foreach ( $items as $item ) {
1133 1143 $collection[] = array(
1134 1144 'action' => $item[0],
1135 - 'args' => wp_json_encode( $item[1] ),
1145 + 'args' => wp_json_encode( $item[1], JSON_UNESCAPED_SLASHES ),
1136 1146 'current_user_id' => $item[2],
1137 1147 'microtime' => $item[3],
1138 1148 'importing' => (string) $item[4],
1139 1149 );
@@ -1189,9 +1199,9 @@
1189 1199 if ( Identity_Crisis::validate_sync_error_idc_option() ) {
1190 1200 $this->partner_provision_error(
1191 1201 new WP_Error(
1192 1202 'site_in_safe_mode',
1193 - esc_html__( 'Can not cancel a plan while in safe mode. See: https://jetpack.com/support/safe-mode/', 'jetpack' )
1203 + esc_html__( 'Cannot cancel a plan while in safe mode. See: https://jetpack.com/support/safe-mode/', 'jetpack' )
1194 1204 )
1195 1205 );
1196 1206 }
1197 1207
@@ -1215,12 +1225,11 @@
1215 1225 if ( ! empty( $named_args ) && ! empty( $named_args['partner_tracking_id'] ) ) {
1216 1226 $url = esc_url_raw( add_query_arg( 'partner_tracking_id', $named_args['partner_tracking_id'], $url ) );
1217 1227 }
1218 1228
1229 + // @phan-suppress-next-line PhanAccessMethodInternal -- Phan is correct, but the usage is intentional.
1219 1230 $result = Client::_wp_remote_request( $url, $request );
1220 1231
1221 - Jetpack_Options::delete_option( 'onboarding' );
1222 -
1223 1232 if ( is_wp_error( $result ) ) {
1224 1233 $this->partner_provision_error( $result );
1225 1234 }
1226 1235
@@ -1241,10 +1250,8 @@
1241 1250 * [--wpcom_user_id=<user_id>]
1242 1251 * : WordPress.com ID of user to connect as (must be whitelisted against partner key)
1243 1252 * [--wpcom_user_email=<wpcom_user_email>]
1244 1253 * : Override the email we send to WordPress.com for registration
1245 - * [--onboarding=<onboarding>]
1246 - * : Guide the user through an onboarding wizard
1247 1254 * [--force_register=<register>]
1248 1255 * : Whether to force a site to register
1249 1256 * [--force_connect=<force_connect>]
1250 1257 * : Force JPS to not reuse existing credentials
@@ -1259,9 +1266,9 @@
1259 1266 *
1260 1267 * $ wp jetpack partner_provision '{ some: "json" }' premium 1
1261 1268 * { success: true }
1262 1269 *
1263 - * @synopsis <token_json> [--wpcom_user_id=<user_id>] [--plan=<plan_name>] [--onboarding=<onboarding>] [--force_register=<register>] [--force_connect=<force_connect>] [--home_url=<home_url>] [--site_url=<site_url>] [--wpcom_user_email=<wpcom_user_email>] [--partner_tracking_id=<partner_tracking_id>]
1270 + * @synopsis <token_json> [--wpcom_user_id=<user_id>] [--plan=<plan_name>] [--force_register=<register>] [--force_connect=<force_connect>] [--home_url=<home_url>] [--site_url=<site_url>] [--wpcom_user_email=<wpcom_user_email>] [--partner_tracking_id=<partner_tracking_id>]
1264 1271 *
1265 1272 * @param array $args Positional args.
1266 1273 * @param array $named_args Named args.
1267 1274 */
@@ -1274,11 +1281,9 @@
1274 1281 $this->partner_provision_error( new WP_Error( 'missing_access_token', sprintf( __( 'Invalid token JSON: %s', 'jetpack' ), $token_json ) ) );
1275 1282 }
1276 1283
1277 1284 if ( isset( $token->error ) ) {
1278 - $message = isset( $token->message )
1279 - ? $token->message
1280 - : '';
1285 + $message = $token->message ?? '';
1281 1286 $this->partner_provision_error( new WP_Error( $token->error, $message ) );
1282 1287 }
1283 1288
1284 1289 if ( ! isset( $token->access_token ) ) {
@@ -1295,15 +1300,16 @@
1295 1300 array(
1296 1301 'success' => false,
1297 1302 'error_code' => $body_json->get_error_code(),
1298 1303 'error_message' => $body_json->get_error_message(),
1299 - )
1304 + ),
1305 + JSON_UNESCAPED_SLASHES
1300 1306 )
1301 1307 );
1302 1308 exit( 1 );
1303 1309 }
1304 1310
1305 - WP_CLI::log( wp_json_encode( $body_json ) );
1311 + WP_CLI::log( wp_json_encode( $body_json, JSON_UNESCAPED_SLASHES ) );
1306 1312 }
1307 1313
1308 1314 /**
1309 1315 * Manages your Jetpack sitemap
@@ -1311,23 +1317,23 @@
1311 1317 * ## OPTIONS
1312 1318 *
1313 1319 * rebuild : Rebuild all sitemaps
1314 1320 * --purge : if set, will remove all existing sitemap data before rebuilding
1321 + * --monitor : if set, will output elapsed time, peak memory usage, CPU time (user/system), and average CPU utilization
1322 + * --suspend-cache-addition : if set, will suspend cache additions during sitemap generation
1315 1323 *
1316 1324 * ## EXAMPLES
1317 1325 *
1318 1326 * wp jetpack sitemap rebuild
1327 + * wp jetpack sitemap rebuild --monitor
1319 1328 *
1320 1329 * @subcommand sitemap
1321 - * @synopsis <rebuild> [--purge]
1330 + * @synopsis <rebuild> [--purge] [--monitor] [--suspend-cache-addition]
1322 1331 *
1323 1332 * @param array $args Positional args.
1324 1333 * @param array $assoc_args Named args.
1325 1334 */
1326 1335 public function sitemap( $args, $assoc_args ) {
1327 - if ( ! Jetpack::is_connection_ready() ) {
1328 - WP_CLI::error( __( 'Jetpack is not currently connected to WordPress.com', 'jetpack' ) );
1329 - }
1330 1336 if ( ! Jetpack::is_module_active( 'sitemaps' ) ) {
1331 1337 WP_CLI::error( __( 'Jetpack Sitemaps module is not currently active. Activate it first if you want to work with sitemaps.', 'jetpack' ) );
1332 1338 }
1333 1339 if ( ! class_exists( 'Jetpack_Sitemap_Builder' ) ) {
@@ -1333,15 +1339,65 @@
1333 1339 if ( ! class_exists( 'Jetpack_Sitemap_Builder' ) ) {
1334 1340 WP_CLI::error( __( 'Jetpack Sitemaps module is active, but unavailable. This can happen if your site is set to discourage search engine indexing. Please enable search engine indexing to allow sitemap generation.', 'jetpack' ) );
1335 1341 }
1336 1342
1343 + if ( isset( $assoc_args['suspend-cache-addition'] ) && $assoc_args['suspend-cache-addition'] ) {
1344 + add_filter( 'jetpack_sitemap_suspend_cache_addition', '__return_true' );
1345 + WP_CLI::success( 'Suspending cache addition.' );
1346 + }
1347 +
1348 + $monitor = isset( $assoc_args['monitor'] ) && $assoc_args['monitor'];
1349 +
1350 + if ( $monitor ) {
1351 + $start_time = microtime( true );
1352 + $rusage_start = function_exists( 'getrusage' ) ? getrusage() : null;
1353 + }
1354 +
1337 1355 if ( isset( $assoc_args['purge'] ) && $assoc_args['purge'] ) {
1338 1356 $librarian = new Jetpack_Sitemap_Librarian();
1339 1357 $librarian->delete_all_stored_sitemap_data();
1358 +
1359 + // Clear sitemap-related transients
1360 + delete_transient( 'jetpack_news_sitemap_xml' );
1361 + delete_transient( 'jetpack-sitemap-state-lock' );
1362 + WP_CLI::success( __( 'Purged all sitemap data and cleared sitemap transients.', 'jetpack' ) );
1340 1363 }
1341 1364
1342 1365 $sitemap_builder = new Jetpack_Sitemap_Builder();
1343 1366 $sitemap_builder->update_sitemap();
1367 +
1368 + WP_CLI::success( __( 'Sitemap rebuilt successfully.', 'jetpack' ) );
1369 +
1370 + if ( $monitor && isset( $start_time ) ) {
1371 + $end_time = microtime( true );
1372 + $peak_memory = memory_get_peak_usage();
1373 + $elapsed_time = $end_time - $start_time;
1374 + $rusage_end = function_exists( 'getrusage' ) ? getrusage() : null;
1375 +
1376 + WP_CLI::log( '----------------------------------' );
1377 + WP_CLI::log( __( 'Performance Metrics:', 'jetpack' ) );
1378 + /* translators: %s is a float representing seconds */
1379 + WP_CLI::log( sprintf( __( 'Elapsed Time: %.4f seconds', 'jetpack' ), $elapsed_time ) );
1380 + /* translators: %s is a human-readable memory size (e.g., 128MB) */
1381 + WP_CLI::log( sprintf( __( 'Peak Memory Usage: %s', 'jetpack' ), size_format( $peak_memory ) ) );
1382 +
1383 + if ( ! empty( $rusage_start ) && ! empty( $rusage_end ) ) {
1384 + $user_cpu_time = ( $rusage_end['ru_utime.tv_sec'] * 1e6 + $rusage_end['ru_utime.tv_usec'] ) - ( $rusage_start['ru_utime.tv_sec'] * 1e6 + $rusage_start['ru_utime.tv_usec'] );
1385 + $system_cpu_time = ( $rusage_end['ru_stime.tv_sec'] * 1e6 + $rusage_end['ru_stime.tv_usec'] ) - ( $rusage_start['ru_stime.tv_sec'] * 1e6 + $rusage_start['ru_stime.tv_usec'] );
1386 +
1387 + /* translators: %d is an integer representing microseconds */
1388 + WP_CLI::log( sprintf( __( 'CPU time (user): %d microseconds', 'jetpack' ), $user_cpu_time ) );
1389 + /* translators: %d is an integer representing microseconds */
1390 + WP_CLI::log( sprintf( __( 'CPU time (system): %d microseconds', 'jetpack' ), $system_cpu_time ) );
1391 +
1392 + // Average CPU utilization over the elapsed wall time.
1393 + $total_cpu_sec = ( $user_cpu_time + $system_cpu_time ) / 1e6;
1394 + $avg_cpu_pct = $elapsed_time > 0 ? ( $total_cpu_sec / $elapsed_time ) * 100 : 0.0;
1395 + /* translators: %s is a percentage like 83.4 */
1396 + WP_CLI::log( sprintf( __( 'Average CPU Utilization: %.1f%%', 'jetpack' ), $avg_cpu_pct ) );
1397 + }
1398 + WP_CLI::log( '----------------------------------' );
1399 + }
1344 1400 }
1345 1401
1346 1402 /**
1347 1403 * Allows authorizing a user via the command line and will activate
@@ -1368,9 +1424,9 @@
1368 1424 $current_user_id = get_current_user_id();
1369 1425
1370 1426 ( new Tokens() )->update_user_token( $current_user_id, sprintf( '%s.%d', $named_args['token'], $current_user_id ), $is_connection_owner );
1371 1427
1372 - WP_CLI::log( wp_json_encode( $named_args ) );
1428 + WP_CLI::log( wp_json_encode( $named_args, JSON_UNESCAPED_SLASHES ) );
1373 1429
1374 1430 if ( $is_connection_owner ) {
1375 1431 /**
1376 1432 * Auto-enable SSO module for new Jetpack Start connections
@@ -1444,9 +1500,9 @@
1444 1500 $decoded_body = ! empty( $named_args['body'] )
1445 1501 ? json_decode( $named_args['body'], true )
1446 1502 : false;
1447 1503
1448 - $resource_url = ( false === strpos( $named_args['resource'], '%d' ) )
1504 + $resource_url = ( ! str_contains( $named_args['resource'], '%d' ) )
1449 1505 ? $named_args['resource']
1450 1506 : sprintf( $named_args['resource'], Jetpack_Options::get_option( 'id' ) );
1451 1507
1452 1508 $response = Client::wpcom_json_api_request_as_blog(
@@ -1483,9 +1539,9 @@
1483 1539 $output = wp_remote_retrieve_body( $response );
1484 1540 if ( isset( $named_args['pretty'] ) ) {
1485 1541 $decoded_output = json_decode( $output );
1486 1542 if ( $decoded_output ) {
1487 - $output = wp_json_encode( $decoded_output, JSON_PRETTY_PRINT );
1543 + $output = wp_json_encode( $decoded_output, JSON_UNESCAPED_SLASHES | JSON_PRETTY_PRINT );
1488 1544 }
1489 1545 }
1490 1546
1491 1547 if ( isset( $named_args['strip-success'] ) ) {
@@ -1571,9 +1627,9 @@
1571 1627 array(
1572 1628 'resource' => '/activity-log/%d/update-credentials',
1573 1629 'method' => 'POST',
1574 1630 'api_version' => '1.1',
1575 - 'body' => wp_json_encode( $values ),
1631 + 'body' => wp_json_encode( $values, JSON_UNESCAPED_SLASHES ),
1576 1632 'timeout' => 30,
1577 1633 ),
1578 1634 $named_args
1579 1635 );
@@ -1670,8 +1726,11 @@
1670 1726 *
1671 1727 * [<identifier>]
1672 1728 * : The connection ID or service to perform an action on.
1673 1729 *
1730 + * [--ignore-cache]
1731 + * : Whether to ignore connections cache.
1732 + *
1674 1733 * [--format=<format>]
1675 1734 * : Allows overriding the output of the command when listing connections.
1676 1735 * ---
1677 1736 * default: table
@@ -1688,8 +1747,11 @@
1688 1747 *
1689 1748 * # List all publicize connections.
1690 1749 * $ wp jetpack publicize list
1691 1750 *
1751 + * # List all publicize connections, ignoring the cache.
1752 + * $ wp jetpack publicize list --ignore-cache
1753 + *
1692 1754 * # List publicize connections for a given service.
1693 1755 * $ wp jetpack publicize list linkedin
1694 1756 *
1695 1757 * # List all publicize connections for a given user.
@@ -1724,11 +1786,10 @@
1724 1786
1725 1787 if ( ( new Status() )->is_offline_mode() ) {
1726 1788 if (
1727 1789 ! defined( 'JETPACK_DEV_DEBUG' ) &&
1728 - ! has_filter( 'jetpack_development_mode' ) &&
1729 1790 ! has_filter( 'jetpack_offline_mode' ) &&
1730 - false === strpos( site_url(), '.' )
1791 + ! str_contains( site_url(), '.' )
1731 1792 ) {
1732 1793 WP_CLI::error( __( "Jetpack is current in offline mode because the site url does not contain a '.', which often occurs when dynamically setting the WP_SITEURL constant. While in offline mode, the Jetpack Social module will not load.", 'jetpack' ) );
1733 1794 }
1734 1795
@@ -1734,9 +1795,9 @@
1734 1795
1735 1796 WP_CLI::error( __( 'Jetpack is currently in offline mode, so the Jetpack Social module will not load.', 'jetpack' ) );
1736 1797 }
1737 1798
1738 - if ( ! class_exists( 'Publicize' ) ) {
1799 + if ( ! class_exists( Publicize::class ) ) {
1739 1800 WP_CLI::error( __( 'The Jetpack Social module is not loaded.', 'jetpack' ) );
1740 1801 }
1741 1802
1742 1803 $action = $args[0];
@@ -1746,30 +1807,23 @@
1746 1807 $id_is_service = in_array( $identifier, $services, true );
1747 1808
1748 1809 switch ( $action ) {
1749 1810 case 'list':
1750 - $connections_to_return = array();
1751 -
1811 + $_args = array(
1812 + 'ignore_cache' => $named_args['ignore-cache'] ?? false,
1813 + );
1752 1814 // For the CLI command, let's return all connections when a user isn't specified. This
1753 1815 // differs from the logic in the Publicize class.
1754 - $option_connections = is_user_logged_in()
1755 - ? (array) $publicize->get_all_connections_for_user()
1756 - : (array) $publicize->get_all_connections();
1816 + $connections_to_return = is_user_logged_in()
1817 + ? Connections::get_all_for_user( $_args )
1818 + : Connections::get_all( $_args );
1757 1819
1758 - foreach ( $option_connections as $service_name => $connections ) {
1759 - foreach ( (array) $connections as $id => $connection ) {
1760 - $connection['id'] = $id;
1761 - $connection['service'] = $service_name;
1762 - $connections_to_return[] = $connection;
1763 - }
1764 - }
1765 -
1766 1820 if ( $id_is_service && ! empty( $identifier ) && ! empty( $connections_to_return ) ) {
1767 1821 $temp_connections = $connections_to_return;
1768 1822 $connections_to_return = array();
1769 1823
1770 1824 foreach ( $temp_connections as $connection ) {
1771 - if ( $identifier === $connection['service'] ) {
1825 + if ( $identifier === $connection['service_name'] ) {
1772 1826 $connections_to_return[] = $connection;
1773 1827 }
1774 1828 }
1775 1829 }
@@ -1774,27 +1828,22 @@
1774 1828 }
1775 1829 }
1776 1830
1777 1831 if ( $identifier && ! $id_is_service && ! empty( $connections_to_return ) ) {
1778 - $connections_to_return = wp_list_filter( $connections_to_return, array( 'id' => $identifier ) );
1832 + $connections_to_return = wp_list_filter( $connections_to_return, array( 'connection_id' => $identifier ) );
1779 1833 }
1780 1834
1781 1835 $expected_keys = array(
1782 - 'id',
1783 - 'service',
1784 - 'user_id',
1785 - 'provider',
1786 - 'issued',
1787 - 'expires',
1836 + 'connection_id',
1837 + 'service_name',
1838 + 'display_name',
1788 1839 'external_id',
1789 - 'external_name',
1790 - 'external_display',
1791 - 'type',
1792 - 'connection_data',
1840 + 'wpcom_user_id',
1841 + 'shared',
1793 1842 );
1794 1843
1795 1844 // Somehow, a test site ended up in a state where $connections_to_return looked like:
1796 - // array( array( array( 'id' => 0, 'service' => 0 ) ) ) // phpcs:ignore Squiz.PHP.CommentedOutCode.Found
1845 + // array( array( array( 'id' => 0, 'service' => 0 ) ) )
1797 1846 // This caused the CLI command to error when running WP_CLI\Utils\format_items() below. So
1798 1847 // to minimize future issues, this nested loop will remove any connections that don't contain
1799 1848 // any keys that we expect.
1800 1849 foreach ( (array) $connections_to_return as $connection_key => $connection ) {
@@ -1828,23 +1877,15 @@
1828 1877 }
1829 1878
1830 1879 jetpack_cli_are_you_sure();
1831 1880
1832 - $connections = array();
1833 1881 $service = $identifier;
1882 + $connections = is_user_logged_in()
1883 + ? Connections::get_all_for_user()
1884 + : Connections::get_all();
1834 1885
1835 - $option_connections = is_user_logged_in()
1836 - ? (array) $publicize->get_all_connections_for_user()
1837 - : (array) $publicize->get_all_connections();
1838 -
1839 - if ( 'all' === $service ) {
1840 - foreach ( (array) $option_connections as $service_name => $service_connections ) {
1841 - foreach ( $service_connections as $id => $connection ) {
1842 - $connections[ $id ] = $connection;
1843 - }
1844 - }
1845 - } elseif ( ! empty( $option_connections[ $service ] ) ) {
1846 - $connections = $option_connections[ $service ];
1886 + if ( 'all' !== $service ) {
1887 + $connections = wp_list_filter( $connections, array( 'service_name' => $service ) );
1847 1888 }
1848 1889
1849 1890 if ( ! empty( $connections ) ) {
1850 1891 $count = is_countable( $connections ) ? count( $connections ) : 0;
@@ -1853,9 +1894,10 @@
1853 1894 sprintf( __( 'Disconnecting all connections to %s.', 'jetpack' ), $service ),
1854 1895 $count
1855 1896 );
1856 1897
1857 - foreach ( $connections as $id => $connection ) {
1898 + foreach ( $connections as $connection ) {
1899 + $id = $connection['connection_id'];
1858 1900 if ( false === $publicize->disconnect( false, $id ) ) {
1859 1901 WP_CLI::error(
1860 1902 sprintf(
1861 1903 /* translators: %1$d is a numeric ID and %2$s is a lowercase string for a social network. */
@@ -1864,11 +1906,13 @@
1864 1906 )
1865 1907 );
1866 1908 }
1867 1909
1910 + // @phan-suppress-next-line PhanUndeclaredClassMethod - Class is missing from php-stubs/wp-cli-stubs 🤷
1868 1911 $progress->tick();
1869 1912 }
1870 1913
1914 + // @phan-suppress-next-line PhanUndeclaredClassMethod - Class is missing from php-stubs/wp-cli-stubs 🤷
1871 1915 $progress->finish();
1872 1916
1873 1917 if ( 'all' === $service ) {
1874 1918 WP_CLI::success( __( 'All Jetpack Social connections were successfully disconnected.', 'jetpack' ) );
@@ -1873,9 +1917,9 @@
1873 1917 if ( 'all' === $service ) {
1874 1918 WP_CLI::success( __( 'All Jetpack Social connections were successfully disconnected.', 'jetpack' ) );
1875 1919 } else {
1876 1920 /* translators: %s is a lowercase string for a social network. */
1877 - WP_CLI::success( __( 'All Jetpack Social connections to %s were successfully disconnected.', 'jetpack' ), $service );
1921 + WP_CLI::success( sprintf( __( 'All Jetpack Social connections to %s were successfully disconnected.', 'jetpack' ), $service ) );
1878 1922 }
1879 1923 }
1880 1924 } elseif ( false !== $publicize->disconnect( false, $identifier ) ) {
1881 1925 /* translators: %d is a numeric ID. Example: 1234. */
@@ -1901,8 +1945,9 @@
1901 1945 /**
1902 1946 * Log and exit on a partner provision error.
1903 1947 *
1904 1948 * @param WP_Error $error Error.
1949 + * @return never
1905 1950 */
1906 1951 private function partner_provision_error( $error ) {
1907 1952 WP_CLI::log(
1908 1953 wp_json_encode(
@@ -1909,9 +1954,10 @@
1909 1954 array(
1910 1955 'success' => false,
1911 1956 'error_code' => $error->get_error_code(),
1912 1957 'error_message' => $error->get_error_message(),
1913 - )
1958 + ),
1959 + JSON_UNESCAPED_SLASHES
1914 1960 )
1915 1961 );
1916 1962 exit( 1 );
1917 1963 }
@@ -1964,19 +2010,19 @@
1964 2010 * @param array $args Positional parameters. Only one is used, that corresponds to the block title.
1965 2011 * @param array $assoc_args Associative parameters defined in the scaffold() method.
1966 2012 */
1967 2013 public function block( $args, $assoc_args ) {
1968 - if ( isset( $args[1] ) ) {
1969 - $title = ucwords( $args[1] );
1970 - } else {
2014 + if ( ! isset( $args[1] ) ) {
1971 2015 WP_CLI::error( esc_html__( 'The title parameter is required.', 'jetpack' ) . ' 👻' );
1972 2016 exit( 1 );
1973 2017 }
1974 2018
1975 - $slug = isset( $assoc_args['slug'] )
1976 - ? $assoc_args['slug']
1977 - : sanitize_title( $title );
2019 + $title = ucwords( $args[1] );
1978 2020
2021 + $slug = $assoc_args['slug'] ?? sanitize_title( $title );
2022 +
2023 + $next_version = "\x24\x24next-version$$"; // Escapes to hide the string from tools/replace-next-version-tag.sh
2024 +
1979 2025 $variation_options = array( 'production', 'experimental', 'beta' );
1980 2026 $variation = ( isset( $assoc_args['variation'] ) && in_array( $assoc_args['variation'], $variation_options, true ) )
1981 2027 ? $assoc_args['variation']
1982 2028 : 'beta';
@@ -2003,42 +2049,40 @@
2003 2049 }
2004 2050
2005 2051 $wp_filesystem->mkdir( $path );
2006 2052
2007 - $has_keywords = isset( $assoc_args['keywords'] );
2053 + $keywords = isset( $assoc_args['keywords'] )
2054 + ? array_map(
2055 + function ( $keyword ) {
2056 + return trim( $keyword );
2057 + },
2058 + array_slice( explode( ',', $assoc_args['keywords'] ), 0, 3 )
2059 + )
2060 + : array();
2008 2061
2009 2062 $files = array(
2010 - "$path/$slug.php" => self::render_block_file(
2063 + "$path/block.json" => self::render_block_file(
2064 + 'block-block-json',
2065 + array(
2066 + 'slug' => $slug,
2067 + 'title' => wp_json_encode( $title, JSON_UNESCAPED_SLASHES | JSON_UNESCAPED_UNICODE ),
2068 + 'description' => isset( $assoc_args['description'] )
2069 + ? wp_json_encode( $assoc_args['description'], JSON_UNESCAPED_SLASHES | JSON_UNESCAPED_UNICODE )
2070 + : wp_json_encode( $title, JSON_UNESCAPED_SLASHES | JSON_UNESCAPED_UNICODE ),
2071 + 'nextVersion' => $next_version,
2072 + 'keywords' => wp_json_encode( $keywords, JSON_UNESCAPED_SLASHES | JSON_UNESCAPED_UNICODE ),
2073 + )
2074 + ),
2075 + "$path/$slug.php" => self::render_block_file(
2011 2076 'block-register-php',
2012 2077 array(
2013 - 'slug' => $slug,
2078 + 'nextVersion' => $next_version,
2014 2079 'title' => $title,
2015 - 'underscoredSlug' => str_replace( '-', '_', $slug ),
2016 2080 'underscoredTitle' => str_replace( ' ', '_', $title ),
2017 2081 )
2018 2082 ),
2019 - "$path/index.js" => self::render_block_file(
2020 - 'block-index-js',
2021 - array(
2022 - 'slug' => $slug,
2023 - 'title' => $title,
2024 - 'description' => isset( $assoc_args['description'] )
2025 - ? $assoc_args['description']
2026 - : $title,
2027 - 'keywords' => $has_keywords
2028 - ? array_map(
2029 - function ( $keyword ) {
2030 - // Construction necessary for Mustache lists.
2031 - return array( 'keyword' => trim( $keyword ) );
2032 - },
2033 - explode( ',', $assoc_args['keywords'], 3 )
2034 - )
2035 - : '',
2036 - 'hasKeywords' => $has_keywords,
2037 - )
2038 - ),
2039 - "$path/editor.js" => self::render_block_file( 'block-editor-js' ),
2040 - "$path/editor.scss" => self::render_block_file(
2083 + "$path/editor.js" => self::render_block_file( 'block-editor-js' ),
2084 + "$path/editor.scss" => self::render_block_file(
2041 2085 'block-editor-scss',
2042 2086 array(
2043 2087 'slug' => $slug,
2044 2088 'title' => $title,
@@ -2043,9 +2087,9 @@
2043 2087 'slug' => $slug,
2044 2088 'title' => $title,
2045 2089 )
2046 2090 ),
2047 - "$path/edit.js" => self::render_block_file(
2091 + "$path/edit.js" => self::render_block_file(
2048 2092 'block-edit-js',
2049 2093 array(
2050 2094 'title' => $title,
2051 2095 'className' => str_replace( ' ', '', ucwords( str_replace( '-', ' ', $slug ) ) ),
@@ -2050,10 +2094,8 @@
2050 2094 'title' => $title,
2051 2095 'className' => str_replace( ' ', '', ucwords( str_replace( '-', ' ', $slug ) ) ),
2052 2096 )
2053 2097 ),
2054 - "$path/icon.js" => self::render_block_file( 'block-icon-js' ),
2055 - "$path/attributes.js" => self::render_block_file( 'block-attributes-js' ),
2056 2098 );
2057 2099
2058 2100 $files_written = array();
2059 2101
@@ -2079,9 +2121,9 @@
2079 2121 $new_block_list = json_decode( $block_list );
2080 2122 $new_block_list->{ $variation }[] = $slug;
2081 2123
2082 2124 // Format the JSON to match our coding standards.
2083 - $new_block_list_formatted = wp_json_encode( $new_block_list, JSON_PRETTY_PRINT ) . "\n";
2125 + $new_block_list_formatted = wp_json_encode( $new_block_list, JSON_UNESCAPED_SLASHES | JSON_PRETTY_PRINT ) . "\n";
2084 2126 $new_block_list_formatted = preg_replace_callback(
2085 2127 // Find all occurrences of multiples of 4 spaces a the start of the line.
2086 2128 '/^((?: )+)/m',
2087 2129 function ( $matches ) {