pass() ) { $cxntests->output_results_for_cli(); WP_CLI::success( __( 'Jetpack is currently connected to WordPress.com', 'jetpack' ) ); } else { $error = array(); foreach ( $cxntests->list_fails() as $fail ) { $error[] = $fail['name'] . ': ' . $fail['message']; } WP_CLI::error_multi_line( $error ); $cxntests->output_results_for_cli(); WP_CLI::error( __( 'One or more tests did not pass. Please investigate!', 'jetpack' ) ); // Exit CLI. } /* translators: %s is current version of Jetpack, for example 7.3 */ WP_CLI::line( sprintf( __( 'The Jetpack Version is %s', 'jetpack' ), JETPACK__VERSION ) ); /* translators: %d is WP.com ID of this blog */ WP_CLI::line( sprintf( __( 'The WordPress.com blog_id is %d', 'jetpack' ), Jetpack_Options::get_option( 'id' ) ) ); /* translators: %s is the email address of the connection owner */ WP_CLI::line( sprintf( __( 'The WordPress.com account for the primary connection is %s', 'jetpack' ), $master_user_email ) ); /* * Are they asking for all data? * * Loop through heartbeat data and organize by priority. */ $all_data = ( isset( $args[0] ) && 'full' === $args[0] ) ? 'full' : false; if ( $all_data ) { // Heartbeat data. WP_CLI::line( "\n" . __( 'Additional data: ', 'jetpack' ) ); // Get the filtered heartbeat data. // Filtered so we can color/list by severity. $stats = Jetpack::jetpack_check_heartbeat_data(); // Display red flags first. foreach ( $stats['bad'] as $stat => $value ) { WP_CLI::line( sprintf( "$this->red_open%-'.16s %s $this->color_close", $stat, $value ) ); } // Display caution warnings next. foreach ( $stats['caution'] as $stat => $value ) { WP_CLI::line( sprintf( "$this->yellow_open%-'.16s %s $this->color_close", $stat, $value ) ); } // The rest of the results are good! foreach ( $stats['good'] as $stat => $value ) { // Modules should get special spacing for aestetics. if ( strpos( $stat, 'odule-' ) ) { WP_CLI::line( sprintf( "%-'.30s %s", $stat, $value ) ); usleep( 4000 ); // For dramatic effect lolz. continue; } WP_CLI::line( sprintf( "%-'.16s %s", $stat, $value ) ); usleep( 4000 ); // For dramatic effect lolz. } } else { // Just the basics. WP_CLI::line( "\n" . _x( "View full status with 'wp jetpack status full'", '"wp jetpack status full" is a command - do not translate', 'jetpack' ) ); } } /** * Tests the active connection * * Does a two-way test to verify that the local site can communicate with remote Jetpack/WP.com servers and that Jetpack/WP.com servers can talk to the local site. * * ## EXAMPLES * * wp jetpack test-connection * * @subcommand test-connection */ public function test_connection() { /* translators: %s is the site URL */ WP_CLI::line( sprintf( __( 'Testing connection for %s', 'jetpack' ), esc_url( get_site_url() ) ) ); if ( ! Jetpack::is_connection_ready() ) { WP_CLI::error( __( 'Jetpack is not currently connected to WordPress.com', 'jetpack' ) ); } $response = Client::wpcom_json_api_request_as_blog( sprintf( '/jetpack-blogs/%d/test-connection', Jetpack_Options::get_option( 'id' ) ), Client::WPCOM_JSON_API_VERSION ); if ( is_wp_error( $response ) ) { /* translators: %1$s is the error code, %2$s is the error message */ WP_CLI::error( sprintf( __( 'Failed to test connection (#%1$s: %2$s)', 'jetpack' ), $response->get_error_code(), $response->get_error_message() ) ); } $body = wp_remote_retrieve_body( $response ); if ( ! $body ) { WP_CLI::error( __( 'Failed to test connection (empty response body)', 'jetpack' ) ); } $result = json_decode( $body ); $is_connected = (bool) $result->connected; $message = $result->message; if ( $is_connected ) { WP_CLI::success( $message ); } else { WP_CLI::error( $message ); } } /** * Disconnect Jetpack Blogs or Users * * ## OPTIONS * * blog: Disconnect the entire blog. * * user : Disconnect a specific user from WordPress.com. * * [--force] * If the user ID provided is the connection owner, it will only be disconnected if --force is passed * * ## EXAMPLES * * wp jetpack disconnect blog * wp jetpack disconnect user 13 * wp jetpack disconnect user 1 --force * wp jetpack disconnect user username * wp jetpack disconnect user email@domain.com * * @synopsis [] [--force] * * @param array $args Positional args. * @param array $assoc_args Named args. */ public function disconnect( $args, $assoc_args ) { if ( ! Jetpack::is_connection_ready() ) { WP_CLI::success( __( 'The site is not currently connected, so nothing to do!', 'jetpack' ) ); return; } $action = isset( $args[0] ) ? $args[0] : 'prompt'; if ( ! in_array( $action, array( 'blog', 'user', 'prompt' ), true ) ) { /* translators: %s is a command like "prompt" */ WP_CLI::error( sprintf( __( '%s is not a valid command.', 'jetpack' ), $action ) ); } if ( in_array( $action, array( 'user' ), true ) ) { if ( isset( $args[1] ) ) { $user_id = $args[1]; if ( ctype_digit( $user_id ) ) { $field = 'id'; $user_id = (int) $user_id; } elseif ( is_email( $user_id ) ) { $field = 'email'; $user_id = sanitize_user( $user_id, true ); } else { $field = 'login'; $user_id = sanitize_user( $user_id, true ); } $user = get_user_by( $field, $user_id ); if ( ! $user ) { WP_CLI::error( __( 'Please specify a valid user.', 'jetpack' ) ); } } else { WP_CLI::error( __( 'Please specify a user by either ID, username, or email.', 'jetpack' ) ); } } $force_user_disconnect = ! empty( $assoc_args['force'] ); switch ( $action ) { case 'blog': Jetpack::log( 'disconnect' ); ( new Connection_Manager( 'jetpack' ) )->disconnect_site(); WP_CLI::success( sprintf( /* translators: %s is the site URL */ __( 'Jetpack has been successfully disconnected for %s.', 'jetpack' ), esc_url( get_site_url() ) ) ); break; case 'user': $connection_manager = new Connection_Manager( 'jetpack' ); $disconnected = $connection_manager->disconnect_user( $user->ID, $force_user_disconnect ); if ( $disconnected ) { Jetpack::log( 'unlink', $user->ID ); WP_CLI::success( __( 'User has been successfully disconnected.', 'jetpack' ) ); } else { if ( ! $connection_manager->is_user_connected( $user->ID ) ) { /* translators: %s is a username */ $error_message = sprintf( __( 'User %s could not be disconnected because it is not connected!', 'jetpack' ), "{$user->data->user_login} <{$user->data->user_email}>" ); } elseif ( ! $force_user_disconnect && $connection_manager->is_connection_owner( $user->ID ) ) { /* translators: %s is a username */ $error_message = sprintf( __( 'User %s could not be disconnected because it is the connection owner! If you want to disconnect in anyway, use the --force parameter.', 'jetpack' ), "{$user->data->user_login} <{$user->data->user_email}>" ); } else { /* translators: %s is a username */ $error_message = sprintf( __( 'User %s could not be disconnected.', 'jetpack' ), "{$user->data->user_login} <{$user->data->user_email}>" ); } WP_CLI::error( $error_message ); } break; case 'prompt': WP_CLI::error( __( 'Please specify if you would like to disconnect a blog or user.', 'jetpack' ) ); break; } } /** * Reset Jetpack options and settings to default * * ## OPTIONS * * modules: Resets modules to default state ( get_default_modules() ) * * options: Resets all Jetpack options except: * - All private options (Blog token, user token, etc...) * - id (The Client ID/WP.com Blog ID of this site) * - master_user * - version * - activated * * ## EXAMPLES * * wp jetpack reset options * wp jetpack reset modules * wp jetpack reset sync-checksum --dry-run --offset=0 * * @synopsis [--dry-run] [--offset=] * * @param array $args Positional args. * @param array $assoc_args Named args. */ public function reset( $args, $assoc_args ) { $action = isset( $args[0] ) ? $args[0] : 'prompt'; if ( ! in_array( $action, array( 'options', 'modules', 'sync-checksum' ), true ) ) { /* translators: %s is a command like "prompt" */ WP_CLI::error( sprintf( __( '%s is not a valid command.', 'jetpack' ), $action ) ); } $is_dry_run = ! empty( $assoc_args['dry-run'] ); if ( $is_dry_run ) { WP_CLI::warning( __( "\nThis is a dry run.\n", 'jetpack' ) . __( "No actions will be taken.\n", 'jetpack' ) . __( "The following messages will give you preview of what will happen when you run this command.\n\n", 'jetpack' ) ); } else { // We only need to confirm "Are you sure?" when we are not doing a dry run. jetpack_cli_are_you_sure(); } switch ( $action ) { case 'options': $options_to_reset = Jetpack_Options::get_options_for_reset(); // Reset the Jetpack options. WP_CLI::line( sprintf( /* translators: %s is the site URL */ __( "Resetting Jetpack Options for %s...\n", 'jetpack' ), esc_url( get_site_url() ) ) ); sleep( 1 ); // Take a breath. foreach ( $options_to_reset['jp_options'] as $option_to_reset ) { if ( ! $is_dry_run ) { Jetpack_Options::delete_option( $option_to_reset ); usleep( 100000 ); } /* translators: This is the result of an action. The option named %s was reset */ WP_CLI::success( sprintf( __( '%s option reset', 'jetpack' ), $option_to_reset ) ); } // Reset the WP options. WP_CLI::line( __( "Resetting the jetpack options stored in wp_options...\n", 'jetpack' ) ); usleep( 500000 ); // Take a breath. foreach ( $options_to_reset['wp_options'] as $option_to_reset ) { if ( ! $is_dry_run ) { delete_option( $option_to_reset ); usleep( 100000 ); } /* translators: This is the result of an action. The option named %s was reset */ WP_CLI::success( sprintf( __( '%s option reset', 'jetpack' ), $option_to_reset ) ); } // Reset to default modules. WP_CLI::line( __( "Resetting default modules...\n", 'jetpack' ) ); usleep( 500000 ); // Take a breath. $default_modules = Jetpack::get_default_modules(); if ( ! $is_dry_run ) { Jetpack::update_active_modules( $default_modules ); } WP_CLI::success( __( 'Modules reset to default.', 'jetpack' ) ); break; case 'modules': if ( ! $is_dry_run ) { $default_modules = Jetpack::get_default_modules(); Jetpack::update_active_modules( $default_modules ); } WP_CLI::success( __( 'Modules reset to default.', 'jetpack' ) ); break; case 'prompt': WP_CLI::error( __( 'Please specify if you would like to reset your options, modules or sync-checksum', 'jetpack' ) ); break; case 'sync-checksum': $option = 'jetpack_callables_sync_checksum'; if ( is_multisite() ) { $offset = isset( $assoc_args['offset'] ) ? (int) $assoc_args['offset'] : 0; /* * 1000 is a good limit since we don't expect the number of sites to be more than 1000 * Offset can be used to paginate and try to clean up more sites. */ $sites = get_sites( array( 'number' => 1000, 'offset' => $offset, ) ); $count_fixes = 0; foreach ( $sites as $site ) { switch_to_blog( $site->blog_id ); $count = self::count_option( $option ); if ( $count > 1 ) { if ( ! $is_dry_run ) { delete_option( $option ); } WP_CLI::line( sprintf( /* translators: %1$d is a number, %2$s is the name of an option, %2$s is the site URL. */ __( 'Deleted %1$d %2$s options from %3$s', 'jetpack' ), $count, $option, "{$site->domain}{$site->path}" ) ); $count_fixes++; if ( ! $is_dry_run ) { /* * We could be deleting a lot of options rows at the same time. * Allow some time for replication to catch up. */ sleep( 3 ); } } restore_current_blog(); } if ( $count_fixes ) { WP_CLI::success( sprintf( /* translators: %1$s is the name of an option, %2$d is a number of sites. */ __( 'Successfully reset %1$s on %2$d sites.', 'jetpack' ), $option, $count_fixes ) ); } else { WP_CLI::success( __( 'No options were deleted.', 'jetpack' ) ); } return; } $count = self::count_option( $option ); if ( $count > 1 ) { if ( ! $is_dry_run ) { delete_option( $option ); } WP_CLI::success( sprintf( /* translators: %1$d is a number, %2$s is the name of an option. */ __( 'Deleted %1$d %2$s options', 'jetpack' ), $count, $option ) ); return; } WP_CLI::success( __( 'No options were deleted.', 'jetpack' ) ); break; } } /** * Return the number of times an option appears * Normally an option would only appear 1 since the option key is supposed to be unique * but if a site hasn't updated the DB schema then that would not be the case. * * @param string $option Option name. * * @return int */ private static function count_option( $option ) { global $wpdb; return (int) $wpdb->get_var( $wpdb->prepare( "SELECT COUNT(*) FROM $wpdb->options WHERE option_name = %s", $option ) ); } /** * Manage Jetpack Modules * * ## OPTIONS * * * : The action to take. * --- * default: list * options: * - list * - activate * - deactivate * - toggle * --- * * [] * : The slug of the module to perform an action on. * * [--format=] * : Allows overriding the output of the command when listing modules. * --- * default: table * options: * - table * - json * - csv * - yaml * - ids * - count * --- * * ## EXAMPLES * * wp jetpack module list * wp jetpack module list --format=json * wp jetpack module activate stats * wp jetpack module deactivate stats * wp jetpack module toggle stats * wp jetpack module activate all * wp jetpack module deactivate all * * @param array $args Positional args. * @param array $assoc_args Named args. */ public function module( $args, $assoc_args ) { $action = isset( $args[0] ) ? $args[0] : 'list'; if ( isset( $args[1] ) ) { $module_slug = $args[1]; if ( 'all' !== $module_slug && ! Jetpack::is_module( $module_slug ) ) { /* translators: %s is a module slug like "stats" */ WP_CLI::error( sprintf( __( '%s is not a valid module.', 'jetpack' ), $module_slug ) ); } if ( 'toggle' === $action ) { $action = Jetpack::is_module_active( $module_slug ) ? 'deactivate' : 'activate'; } if ( 'all' === $args[1] ) { $action = ( 'deactivate' === $action ) ? 'deactivate_all' : 'activate_all'; } } elseif ( 'list' !== $action ) { WP_CLI::line( __( 'Please specify a valid module.', 'jetpack' ) ); $action = 'list'; } switch ( $action ) { case 'list': $modules_list = array(); $modules = Jetpack::get_available_modules(); sort( $modules ); foreach ( (array) $modules as $module_slug ) { if ( 'vaultpress' === $module_slug ) { continue; } $modules_list[] = array( 'slug' => $module_slug, 'status' => Jetpack::is_module_active( $module_slug ) ? __( 'Active', 'jetpack' ) : __( 'Inactive', 'jetpack' ), ); } WP_CLI\Utils\format_items( $assoc_args['format'], $modules_list, array( 'slug', 'status' ) ); break; case 'activate': $module = Jetpack::get_module( $module_slug ); Jetpack::log( 'activate', $module_slug ); if ( Jetpack::activate_module( $module_slug, false, false ) ) { /* translators: %s is the name of a Jetpack module */ WP_CLI::success( sprintf( __( '%s has been activated.', 'jetpack' ), $module['name'] ) ); } else { /* translators: %s is the name of a Jetpack module */ WP_CLI::error( sprintf( __( '%s could not be activated.', 'jetpack' ), $module['name'] ) ); } break; case 'activate_all': $modules = Jetpack::get_available_modules(); Jetpack::update_active_modules( $modules ); WP_CLI::success( __( 'All modules activated!', 'jetpack' ) ); break; case 'deactivate': $module = Jetpack::get_module( $module_slug ); Jetpack::log( 'deactivate', $module_slug ); Jetpack::deactivate_module( $module_slug ); /* translators: %s is the name of a Jetpack module */ WP_CLI::success( sprintf( __( '%s has been deactivated.', 'jetpack' ), $module['name'] ) ); break; case 'deactivate_all': Jetpack::delete_active_modules(); WP_CLI::success( __( 'All modules deactivated!', 'jetpack' ) ); break; case 'toggle': // Will never happen, should have been handled above and changed to activate or deactivate. break; } } /** * Manage Protect Settings * * ## OPTIONS * * allow: Add an IP address to an always allow list. You can also read or clear the allow list. * * * ## EXAMPLES * * wp jetpack protect allow * wp jetpack protect allow list * wp jetpack protect allow clear * * @synopsis [] * * @param array $args Positional args. */ public function protect( $args ) { $action = isset( $args[0] ) ? $args[0] : 'prompt'; if ( ! in_array( $action, array( 'whitelist', 'allow' ), true ) ) { // Still allow "whitelist" for legacy support. /* translators: %s is a command like "prompt" */ WP_CLI::error( sprintf( __( '%s is not a valid command.', 'jetpack' ), $action ) ); } // Check if module is active. if ( ! Jetpack::is_module_active( __FUNCTION__ ) ) { /* translators: %s is a module name */ WP_CLI::error( sprintf( _x( '%1$s is not active. You can activate it with "wp jetpack module activate %2$s"', '"wp jetpack module activate" is a command - do not translate', 'jetpack' ), __FUNCTION__, __FUNCTION__ ) ); } if ( in_array( $action, array( 'allow', 'whitelist' ), true ) ) { if ( isset( $args[1] ) ) { $action = 'allow'; } else { $action = 'prompt'; } } switch ( $action ) { case 'allow': $allow = array(); $new_ip = $args[1]; $current_allow = get_site_option( 'jetpack_protect_whitelist', array() ); // @todo Update the option name. // Build array of IPs that are already on the allowed list. // Re-build manually instead of using jetpack_protect_format_whitelist() so we can easily get // low & high range params for jetpack_protect_ip_address_is_in_range(). foreach ( $current_allow as $allowed ) { // IP ranges. if ( $allowed->range ) { // Is it already on the allowed list? if ( jetpack_protect_ip_address_is_in_range( $new_ip, $allowed->range_low, $allowed->range_high ) ) { /* translators: %s is an IP address */ WP_CLI::error( sprintf( __( '%s is already on the always allow list.', 'jetpack' ), $new_ip ) ); break; } $allow[] = $allowed->range_low . ' - ' . $allowed->range_high; } else { // Individual IPs. // Check if the IP is already on the allow list (single IP only). if ( $new_ip === $allowed->ip_address ) { /* translators: %s is an IP address */ WP_CLI::error( sprintf( __( '%s is already on the always allow list.', 'jetpack' ), $new_ip ) ); break; } $allow[] = $allowed->ip_address; } } /* * List the allowed IPs. * Done here because it's easier to read the $allow array after it's been rebuilt. */ if ( isset( $args[1] ) && 'list' === $args[1] ) { if ( ! empty( $allow ) ) { WP_CLI::success( __( 'Here are your always allowed IPs:', 'jetpack' ) ); foreach ( $allow as $ip ) { WP_CLI::line( "\t" . str_pad( $ip, 24 ) ); } } else { WP_CLI::line( __( 'Always allow list is empty.', 'jetpack' ) ); } break; } /* * Clear the always allow list. */ if ( isset( $args[1] ) && 'clear' === $args[1] ) { if ( ! empty( $allow ) ) { $allow = array(); jetpack_protect_save_whitelist( $allow ); // @todo Need to update function name in the Protect module. WP_CLI::success( __( 'Cleared all IPs from the always allow list.', 'jetpack' ) ); } else { WP_CLI::line( __( 'Always allow list is empty.', 'jetpack' ) ); } break; } // Append new IP to allow array. array_push( $allow, $new_ip ); // Save allow list if there are no errors. $result = jetpack_protect_save_whitelist( $allow ); // @todo Need to update function name in the Protect module. if ( is_wp_error( $result ) ) { WP_CLI::error( $result ); } /* translators: %s is an IP address */ WP_CLI::success( sprintf( __( '%s has been added to the always allowed list.', 'jetpack' ), $new_ip ) ); break; case 'prompt': WP_CLI::error( __( 'No command found.', 'jetpack' ) . "\n" . __( 'Please enter the IP address you want to always allow.', 'jetpack' ) . "\n" . _x( 'You can save a range of IPs {low_range}-{high_range}. No spaces allowed. (example: 1.1.1.1-2.2.2.2)', 'Instructions on how to add IP ranges - low_range/high_range should be translated.', 'jetpack' ) . "\n" . _x( "You can also 'list' or 'clear' the always allowed list.", "'list' and 'clear' are commands and should not be translated", 'jetpack' ) . "\n" ); break; } } /** * Manage Jetpack Options * * ## OPTIONS * * list : List all jetpack options and their values * delete : Delete an option * - can only delete options that are white listed. * update : update an option * - can only update option strings * get : get the value of an option * * ## EXAMPLES * * wp jetpack options list * wp jetpack options get * wp jetpack options delete * wp jetpack options update [] * * @synopsis [] [] * * @param array $args Positional args. */ public function options( $args ) { $action = isset( $args[0] ) ? $args[0] : 'list'; $safe_to_modify = Jetpack_Options::get_options_for_reset(); // Is the option flagged as unsafe? $flagged = ! in_array( $args[1], $safe_to_modify, true ); if ( ! in_array( $action, array( 'list', 'get', 'delete', 'update' ), true ) ) { /* translators: %s is a command like "prompt" */ WP_CLI::error( sprintf( __( '%s is not a valid command.', 'jetpack' ), $action ) ); } if ( isset( $args[0] ) ) { if ( 'get' === $args[0] && isset( $args[1] ) ) { $action = 'get'; } elseif ( 'delete' === $args[0] && isset( $args[1] ) ) { $action = 'delete'; } elseif ( 'update' === $args[0] && isset( $args[1] ) ) { $action = 'update'; } else { $action = 'list'; } } // Bail if the option isn't found. $option = isset( $args[1] ) ? Jetpack_Options::get_option( $args[1] ) : false; if ( isset( $args[1] ) && ! $option && 'update' !== $args[0] ) { WP_CLI::error( __( 'Option not found or is empty. Use "list" to list option names', 'jetpack' ) ); } // Let's print_r the option if it's an array. // Used in the 'get' and 'list' actions. // phpcs:ignore WordPress.PHP.DevelopmentFunctions.error_log_print_r $option = is_array( $option ) ? print_r( $option, true ) : $option; switch ( $action ) { case 'get': WP_CLI::success( "\t" . $option ); break; case 'delete': jetpack_cli_are_you_sure( $flagged ); Jetpack_Options::delete_option( $args[1] ); /* translators: %s is the option name */ WP_CLI::success( sprintf( __( 'Deleted option: %s', 'jetpack' ), $args[1] ) ); break; case 'update': jetpack_cli_are_you_sure( $flagged ); // Updating arrays would get pretty tricky... $value = Jetpack_Options::get_option( $args[1] ); if ( $value && is_array( $value ) ) { WP_CLI::error( __( 'Sorry, no updating arrays at this time', 'jetpack' ) ); } Jetpack_Options::update_option( $args[1], $args[2] ); /* translators: %1$s is the previous value, %2$s is the new value */ WP_CLI::success( sprintf( _x( 'Updated option: %1$s to "%2$s"', 'Updating an option from "this" to "that".', 'jetpack' ), $args[1], $args[2] ) ); break; case 'list': $options_compact = Jetpack_Options::get_option_names(); $options_non_compact = Jetpack_Options::get_option_names( 'non_compact' ); $options_private = Jetpack_Options::get_option_names( 'private' ); $options = array_merge( $options_compact, $options_non_compact, $options_private ); // Table headers. WP_CLI::line( "\t" . str_pad( __( 'Option', 'jetpack' ), 30 ) . __( 'Value', 'jetpack' ) ); // List out the options and their values. // Tell them if the value is empty or not. // Tell them if it's an array. foreach ( $options as $option ) { $value = Jetpack_Options::get_option( $option ); if ( ! $value ) { WP_CLI::line( "\t" . str_pad( $option, 30 ) . 'Empty' ); continue; } if ( ! is_array( $value ) ) { WP_CLI::line( "\t" . str_pad( $option, 30 ) . $value ); } elseif ( is_array( $value ) ) { WP_CLI::line( "\t" . str_pad( $option, 30 ) . 'Array - Use "get