Automattic /
jetpack
These results are based on our legacy PHP analysis, consider migrating to our new PHP analysis engine instead. Learn more
| 1 | <?php |
||
| 2 | /** |
||
| 3 | * Collection of tests to run on the Jetpack connection locally. |
||
| 4 | * |
||
| 5 | * @package Jetpack |
||
| 6 | */ |
||
| 7 | |||
| 8 | use Automattic\Jetpack\Connection\Client; |
||
| 9 | use Automattic\Jetpack\Connection\Manager as Connection_Manager; |
||
| 10 | use Automattic\Jetpack\Status; |
||
| 11 | use Automattic\Jetpack\Connection\Utils as Connection_Utils; |
||
| 12 | use Automattic\Jetpack\Sync\Modules; |
||
| 13 | use Automattic\Jetpack\Sync\Settings as Sync_Settings; |
||
| 14 | use Automattic\Jetpack\Sync\Health as Sync_Health; |
||
| 15 | use Automattic\Jetpack\Sync\Sender as Sync_Sender; |
||
| 16 | use Automattic\Jetpack\Redirect; |
||
| 17 | |||
| 18 | /** |
||
| 19 | * Class Jetpack_Cxn_Tests contains all of the actual tests. |
||
| 20 | */ |
||
| 21 | class Jetpack_Cxn_Tests extends Jetpack_Cxn_Test_Base { |
||
| 22 | |||
| 23 | /** |
||
| 24 | * Jetpack_Cxn_Tests constructor. |
||
| 25 | */ |
||
| 26 | public function __construct() { |
||
| 27 | parent::__construct(); |
||
| 28 | |||
| 29 | $methods = get_class_methods( 'Jetpack_Cxn_Tests' ); |
||
| 30 | |||
| 31 | foreach ( $methods as $method ) { |
||
| 32 | if ( false === strpos( $method, 'test__' ) ) { |
||
| 33 | continue; |
||
| 34 | } |
||
| 35 | $this->add_test( array( $this, $method ), $method, 'direct' ); |
||
| 36 | } |
||
| 37 | |||
| 38 | /** |
||
| 39 | * Fires after loading default Jetpack Connection tests. |
||
| 40 | * |
||
| 41 | * @since 7.1.0 |
||
| 42 | * @since 8.3.0 Passes the Jetpack_Cxn_Tests instance. |
||
| 43 | */ |
||
| 44 | do_action( 'jetpack_connection_tests_loaded', $this ); |
||
| 45 | |||
| 46 | /** |
||
| 47 | * Determines if the WP.com testing suite should be included. |
||
| 48 | * |
||
| 49 | * @since 7.1.0 |
||
| 50 | * @since 8.1.0 Default false. |
||
| 51 | * |
||
| 52 | * @param bool $run_test To run the WP.com testing suite. Default false. |
||
| 53 | */ |
||
| 54 | if ( apply_filters( 'jetpack_debugger_run_self_test', false ) ) { |
||
| 55 | /** |
||
| 56 | * Intentionally added last as it checks for an existing failure state before attempting. |
||
| 57 | * Generally, any failed location condition would result in the WP.com check to fail too, so |
||
| 58 | * we will skip it to avoid confusing error messages. |
||
| 59 | * |
||
| 60 | * Note: This really should be an 'async' test. |
||
| 61 | */ |
||
| 62 | $this->add_test( array( $this, 'last__wpcom_self_test' ), 'test__wpcom_self_test', 'direct' ); |
||
| 63 | } |
||
| 64 | } |
||
| 65 | |||
| 66 | /** |
||
| 67 | * Helper function to look up the expected master user and return the local WP_User. |
||
| 68 | * |
||
| 69 | * @return WP_User Jetpack's expected master user. |
||
| 70 | */ |
||
| 71 | protected function helper_retrieve_local_master_user() { |
||
| 72 | $master_user = Jetpack_Options::get_option( 'master_user' ); |
||
| 73 | return new WP_User( $master_user ); |
||
| 74 | } |
||
| 75 | |||
| 76 | /** |
||
| 77 | * Is Jetpack even connected and supposed to be talking to WP.com? |
||
| 78 | */ |
||
| 79 | protected function helper_is_jetpack_connected() { |
||
| 80 | return Jetpack::is_active() && ! ( new Status() )->is_offline_mode(); |
||
| 81 | } |
||
| 82 | |||
| 83 | /** |
||
| 84 | * Retrieve the `blog_token` if it exists. |
||
| 85 | * |
||
| 86 | * @return object|false |
||
| 87 | */ |
||
| 88 | protected function helper_get_blog_token() { |
||
| 89 | return Jetpack::connection()->get_access_token(); |
||
| 90 | } |
||
| 91 | |||
| 92 | /** |
||
| 93 | * Returns a support url based on using a development version. |
||
| 94 | */ |
||
| 95 | protected function helper_get_support_url() { |
||
| 96 | return Jetpack::is_development_version() |
||
| 97 | ? Redirect::get_url( 'jetpack-contact-support-beta-group' ) |
||
| 98 | : Redirect::get_url( 'jetpack-contact-support' ); |
||
| 99 | } |
||
| 100 | |||
| 101 | /** |
||
| 102 | * Returns the url to reconnect Jetpack. |
||
| 103 | * |
||
| 104 | * @return string The reconnect url. |
||
| 105 | */ |
||
| 106 | protected static function helper_get_reconnect_url() { |
||
| 107 | return admin_url( 'admin.php?page=jetpack#/reconnect' ); |
||
| 108 | } |
||
| 109 | |||
| 110 | /** |
||
| 111 | * Gets translated support text. |
||
| 112 | */ |
||
| 113 | protected function helper_get_support_text() { |
||
| 114 | return __( 'Please contact Jetpack support.', 'jetpack' ); |
||
| 115 | } |
||
| 116 | |||
| 117 | /** |
||
| 118 | * Returns the translated text to reconnect Jetpack. |
||
| 119 | * |
||
| 120 | * @return string The translated reconnect text. |
||
| 121 | */ |
||
| 122 | protected static function helper_get_reconnect_text() { |
||
| 123 | return __( 'Reconnect Jetpack now', 'jetpack' ); |
||
| 124 | } |
||
| 125 | |||
| 126 | /** |
||
| 127 | * Returns the translated text for failing tests due to timeouts. |
||
| 128 | * |
||
| 129 | * @return string The translated timeout text. |
||
| 130 | */ |
||
| 131 | protected static function helper_get_timeout_text() { |
||
| 132 | return __( 'The test timed out which may sometimes indicate a failure or may be a false failure. Please relaunch tests.', 'jetpack' ); |
||
| 133 | } |
||
| 134 | |||
| 135 | /** |
||
| 136 | * Gets translated reconnect long description. |
||
| 137 | * |
||
| 138 | * @param string $connection_error The connection specific error. |
||
| 139 | * @param string $recommendation The recommendation for resolving the connection error. |
||
| 140 | * |
||
| 141 | * @return string The translated long description for reconnection recommendations. |
||
| 142 | */ |
||
| 143 | protected static function helper_get_reconnect_long_description( $connection_error, $recommendation ) { |
||
| 144 | |||
| 145 | return sprintf( |
||
| 146 | '<p>%1$s</p>' . |
||
| 147 | '<p><span class="dashicons fail"><span class="screen-reader-text">%2$s</span></span> %3$s</p><p><strong>%4$s</strong></p>', |
||
| 148 | __( 'A healthy connection ensures Jetpack essential services are provided to your WordPress site, such as Stats and Site Security.', 'jetpack' ), |
||
| 149 | /* translators: screen reader text indicating a test failed */ |
||
| 150 | __( 'Error', 'jetpack' ), |
||
| 151 | $connection_error, |
||
| 152 | $recommendation |
||
| 153 | ); |
||
| 154 | } |
||
| 155 | |||
| 156 | /** |
||
| 157 | * Helper function to return consistent responses for a connection failing test. |
||
| 158 | * |
||
| 159 | * @param string $name The raw method name that runs the test. Default unnamed_test. |
||
| 160 | * @param string $connection_error The connection specific error. Default 'Your site is not connected to Jetpack.'. |
||
| 161 | * @param string $recommendation The recommendation for resolving the connection error. Default 'We recommend reconnecting Jetpack.'. |
||
| 162 | * |
||
| 163 | * @return array Test results. |
||
| 164 | */ |
||
| 165 | public static function connection_failing_test( $name, $connection_error = '', $recommendation = '' ) { |
||
| 166 | $connection_error = empty( $connection_error ) ? __( 'Your site is not connected to Jetpack.', 'jetpack' ) : $connection_error; |
||
| 167 | $recommendation = empty( $recommendation ) ? __( 'We recommend reconnecting Jetpack.', 'jetpack' ) : $recommendation; |
||
| 168 | |||
| 169 | $args = array( |
||
| 170 | 'name' => $name, |
||
| 171 | 'short_description' => $connection_error, |
||
| 172 | 'action' => self::helper_get_reconnect_url(), |
||
| 173 | 'action_label' => self::helper_get_reconnect_text(), |
||
| 174 | 'long_description' => self::helper_get_reconnect_long_description( $connection_error, $recommendation ), |
||
| 175 | ); |
||
| 176 | |||
| 177 | return self::failing_test( $args ); |
||
| 178 | } |
||
| 179 | |||
| 180 | /** |
||
| 181 | * Gets translated text to enable outbound requests. |
||
| 182 | * |
||
| 183 | * @param string $protocol Either 'HTTP' or 'HTTPS'. |
||
| 184 | * |
||
| 185 | * @return string The translated text. |
||
| 186 | */ |
||
| 187 | protected function helper_enable_outbound_requests( $protocol ) { |
||
| 188 | return sprintf( |
||
| 189 | /* translators: %1$s - request protocol, either http or https */ |
||
| 190 | __( |
||
| 191 | 'Your server did not successfully connect to the Jetpack server using %1$s |
||
| 192 | Please ask your hosting provider to confirm your server can make outbound requests to jetpack.com.', |
||
| 193 | 'jetpack' |
||
| 194 | ), |
||
| 195 | $protocol |
||
| 196 | ); |
||
| 197 | } |
||
| 198 | |||
| 199 | /** |
||
| 200 | * Returns 30 for use with a filter. |
||
| 201 | * |
||
| 202 | * To allow time for WP.com to run upstream testing, this function exists to increase the http_request_timeout value |
||
| 203 | * to 30. |
||
| 204 | * |
||
| 205 | * @return int 30 |
||
| 206 | */ |
||
| 207 | public static function increase_timeout() { |
||
| 208 | return 30; // seconds. |
||
| 209 | } |
||
| 210 | |||
| 211 | /** |
||
| 212 | * The test verifies the blog token exists. |
||
| 213 | * |
||
| 214 | * @return array |
||
| 215 | */ |
||
| 216 | View Code Duplication | protected function test__blog_token_if_exists() { |
|
| 217 | $name = __FUNCTION__; |
||
| 218 | |||
| 219 | if ( ! $this->helper_is_jetpack_connected() ) { |
||
| 220 | return self::skipped_test( |
||
| 221 | array( |
||
| 222 | 'name' => $name, |
||
| 223 | 'short_description' => __( 'Jetpack is not connected. No blog token to check.', 'jetpack' ), |
||
| 224 | ) |
||
| 225 | ); |
||
| 226 | } |
||
| 227 | $blog_token = $this->helper_get_blog_token(); |
||
| 228 | |||
| 229 | if ( $blog_token ) { |
||
| 230 | $result = self::passing_test( array( 'name' => $name ) ); |
||
| 231 | } else { |
||
| 232 | $connection_error = __( 'Blog token is missing.', 'jetpack' ); |
||
| 233 | |||
| 234 | $result = self::connection_failing_test( $name, $connection_error ); |
||
| 235 | } |
||
| 236 | |||
| 237 | return $result; |
||
| 238 | } |
||
| 239 | |||
| 240 | /** |
||
| 241 | * Test if Jetpack is connected. |
||
| 242 | */ |
||
| 243 | protected function test__check_if_connected() { |
||
| 244 | $name = __FUNCTION__; |
||
| 245 | |||
| 246 | if ( ! $this->helper_get_blog_token() ) { |
||
| 247 | return self::skipped_test( |
||
| 248 | array( |
||
| 249 | 'name' => $name, |
||
| 250 | 'short_description' => __( 'Blog token is missing.', 'jetpack' ), |
||
| 251 | ) |
||
| 252 | ); |
||
| 253 | } |
||
| 254 | |||
| 255 | if ( $this->helper_is_jetpack_connected() ) { |
||
| 256 | $result = self::passing_test( |
||
| 257 | array( |
||
| 258 | 'name' => $name, |
||
| 259 | 'label' => __( 'Your site is connected to Jetpack', 'jetpack' ), |
||
| 260 | 'long_description' => sprintf( |
||
| 261 | '<p>%1$s</p>' . |
||
| 262 | '<p><span class="dashicons pass"><span class="screen-reader-text">%2$s</span></span> %3$s</p>', |
||
| 263 | __( 'A healthy connection ensures Jetpack essential services are provided to your WordPress site, such as Stats and Site Security.', 'jetpack' ), |
||
| 264 | /* translators: Screen reader text indicating a test has passed */ |
||
| 265 | __( 'Passed', 'jetpack' ), |
||
| 266 | __( 'Your site is connected to Jetpack.', 'jetpack' ) |
||
| 267 | ), |
||
| 268 | ) |
||
| 269 | ); |
||
| 270 | } elseif ( ( new Status() )->is_offline_mode() ) { |
||
| 271 | $result = self::skipped_test( |
||
| 272 | array( |
||
| 273 | 'name' => $name, |
||
| 274 | 'short_description' => __( 'Jetpack is in Offline Mode:', 'jetpack' ) . ' ' . Jetpack::development_mode_trigger_text(), |
||
| 275 | ) |
||
| 276 | ); |
||
| 277 | } else { |
||
| 278 | $connection_error = __( 'Your site is not connected to Jetpack', 'jetpack' ); |
||
| 279 | |||
| 280 | $result = self::connection_failing_test( $name, $connection_error ); |
||
| 281 | } |
||
| 282 | |||
| 283 | return $result; |
||
| 284 | } |
||
| 285 | |||
| 286 | /** |
||
| 287 | * Test that the master user still exists on this site. |
||
| 288 | * |
||
| 289 | * @return array Test results. |
||
| 290 | */ |
||
| 291 | View Code Duplication | protected function test__master_user_exists_on_site() { |
|
| 292 | $name = __FUNCTION__; |
||
| 293 | if ( ! $this->helper_is_jetpack_connected() ) { |
||
| 294 | return self::skipped_test( |
||
| 295 | array( |
||
| 296 | 'name' => $name, |
||
| 297 | 'short_description' => __( 'Jetpack is not connected. No master user to check.', 'jetpack' ), |
||
| 298 | ) |
||
| 299 | ); |
||
| 300 | } |
||
| 301 | $local_user = $this->helper_retrieve_local_master_user(); |
||
| 302 | |||
| 303 | if ( $local_user->exists() ) { |
||
| 304 | $result = self::passing_test( array( 'name' => $name ) ); |
||
| 305 | } else { |
||
| 306 | $connection_error = __( 'The user who setup the Jetpack connection no longer exists on this site.', 'jetpack' ); |
||
| 307 | |||
| 308 | $result = self::connection_failing_test( $name, $connection_error ); |
||
| 309 | } |
||
| 310 | |||
| 311 | return $result; |
||
| 312 | } |
||
| 313 | |||
| 314 | /** |
||
| 315 | * Test that the master user has the manage options capability (e.g. is an admin). |
||
| 316 | * |
||
| 317 | * Generic calls from WP.com execute on Jetpack as the master user. If it isn't an admin, random things will fail. |
||
| 318 | * |
||
| 319 | * @return array Test results. |
||
| 320 | */ |
||
| 321 | protected function test__master_user_can_manage_options() { |
||
| 322 | $name = __FUNCTION__; |
||
| 323 | if ( ! $this->helper_is_jetpack_connected() ) { |
||
| 324 | return self::skipped_test( |
||
| 325 | array( |
||
| 326 | 'name' => $name, |
||
| 327 | 'short_description' => __( 'Jetpack is not connected.', 'jetpack' ), |
||
| 328 | ) |
||
| 329 | ); |
||
| 330 | } |
||
| 331 | $master_user = $this->helper_retrieve_local_master_user(); |
||
| 332 | |||
| 333 | if ( user_can( $master_user, 'manage_options' ) ) { |
||
| 334 | $result = self::passing_test( array( 'name' => $name ) ); |
||
| 335 | } else { |
||
| 336 | /* translators: a WordPress username */ |
||
| 337 | $connection_error = sprintf( __( 'The user (%s) who setup the Jetpack connection is not an administrator.', 'jetpack' ), $master_user->user_login ); |
||
| 338 | /* translators: a WordPress username */ |
||
| 339 | $recommendation = sprintf( __( 'We recommend either upgrading the user (%s) or reconnecting Jetpack.', 'jetpack' ), $master_user->user_login ); |
||
| 340 | |||
| 341 | $result = self::connection_failing_test( $name, $connection_error, $recommendation ); |
||
| 342 | } |
||
| 343 | |||
| 344 | return $result; |
||
| 345 | } |
||
| 346 | |||
| 347 | /** |
||
| 348 | * Test that the PHP's XML library is installed. |
||
| 349 | * |
||
| 350 | * While it should be installed by default, increasingly in PHP 7, some OSes require an additional php-xml package. |
||
| 351 | * |
||
| 352 | * @return array Test results. |
||
| 353 | */ |
||
| 354 | protected function test__xml_parser_available() { |
||
| 355 | $name = __FUNCTION__; |
||
| 356 | if ( function_exists( 'xml_parser_create' ) ) { |
||
| 357 | $result = self::passing_test( array( 'name' => $name ) ); |
||
| 358 | } else { |
||
| 359 | $result = self::failing_test( |
||
| 360 | array( |
||
| 361 | 'name' => $name, |
||
| 362 | 'label' => __( 'PHP XML manipulation libraries are not available.', 'jetpack' ), |
||
| 363 | 'short_description' => __( 'Please ask your hosting provider to refer to our server requirements and enable PHP\'s XML module.', 'jetpack' ), |
||
| 364 | 'action_label' => __( 'View our server requirements', 'jetpack' ), |
||
| 365 | 'action' => Redirect::get_url( 'jetpack-support-server-requirements' ), |
||
| 366 | ) |
||
| 367 | ); |
||
| 368 | } |
||
| 369 | return $result; |
||
| 370 | } |
||
| 371 | |||
| 372 | /** |
||
| 373 | * Test that the server is able to send an outbound http communication. |
||
| 374 | * |
||
| 375 | * @return array Test results. |
||
| 376 | */ |
||
| 377 | View Code Duplication | protected function test__outbound_http() { |
|
| 378 | $name = __FUNCTION__; |
||
| 379 | $request = wp_remote_get( preg_replace( '/^https:/', 'http:', JETPACK__API_BASE ) . 'test/1/' ); |
||
| 380 | $code = wp_remote_retrieve_response_code( $request ); |
||
| 381 | |||
| 382 | if ( 200 === intval( $code ) ) { |
||
| 383 | $result = self::passing_test( array( 'name' => $name ) ); |
||
| 384 | } else { |
||
| 385 | $result = self::failing_test( |
||
| 386 | array( |
||
| 387 | 'name' => $name, |
||
| 388 | 'short_description' => $this->helper_enable_outbound_requests( 'HTTP' ), |
||
| 389 | ) |
||
| 390 | ); |
||
| 391 | } |
||
| 392 | |||
| 393 | return $result; |
||
| 394 | } |
||
| 395 | |||
| 396 | /** |
||
| 397 | * Test that the server is able to send an outbound https communication. |
||
| 398 | * |
||
| 399 | * @return array Test results. |
||
| 400 | */ |
||
| 401 | View Code Duplication | protected function test__outbound_https() { |
|
| 402 | $name = __FUNCTION__; |
||
| 403 | $request = wp_remote_get( preg_replace( '/^http:/', 'https:', JETPACK__API_BASE ) . 'test/1/' ); |
||
| 404 | $code = wp_remote_retrieve_response_code( $request ); |
||
| 405 | |||
| 406 | if ( 200 === intval( $code ) ) { |
||
| 407 | $result = self::passing_test( array( 'name' => $name ) ); |
||
| 408 | } else { |
||
| 409 | $result = self::failing_test( |
||
| 410 | array( |
||
| 411 | 'name' => $name, |
||
| 412 | 'short_description' => $this->helper_enable_outbound_requests( 'HTTPS' ), |
||
| 413 | ) |
||
| 414 | ); |
||
| 415 | } |
||
| 416 | |||
| 417 | return $result; |
||
| 418 | } |
||
| 419 | |||
| 420 | /** |
||
| 421 | * Check for an IDC. |
||
| 422 | * |
||
| 423 | * @return array Test results. |
||
| 424 | */ |
||
| 425 | protected function test__identity_crisis() { |
||
| 426 | $name = __FUNCTION__; |
||
| 427 | if ( ! $this->helper_is_jetpack_connected() ) { |
||
| 428 | return self::skipped_test( |
||
| 429 | array( |
||
| 430 | 'name' => $name, |
||
| 431 | 'short_description' => __( 'Jetpack is not connected.', 'jetpack' ), |
||
| 432 | ) |
||
| 433 | ); |
||
| 434 | } |
||
| 435 | $identity_crisis = Jetpack::check_identity_crisis(); |
||
| 436 | |||
| 437 | if ( ! $identity_crisis ) { |
||
| 438 | $result = self::passing_test( array( 'name' => $name ) ); |
||
| 439 | } else { |
||
| 440 | $result = self::failing_test( |
||
| 441 | array( |
||
| 442 | 'name' => $name, |
||
| 443 | 'short_description' => sprintf( |
||
| 444 | /* translators: Two URLs. The first is the locally-recorded value, the second is the value as recorded on WP.com. */ |
||
| 445 | __( 'Your url is set as `%1$s`, but your WordPress.com connection lists it as `%2$s`!', 'jetpack' ), |
||
| 446 | $identity_crisis['home'], |
||
| 447 | $identity_crisis['wpcom_home'] |
||
| 448 | ), |
||
| 449 | 'action_label' => $this->helper_get_support_text(), |
||
| 450 | 'action' => $this->helper_get_support_url(), |
||
| 451 | ) |
||
| 452 | ); |
||
| 453 | } |
||
| 454 | return $result; |
||
| 455 | } |
||
| 456 | |||
| 457 | /** |
||
| 458 | * Tests blog and current user's token against wp.com's check-token-health endpoint. |
||
| 459 | * |
||
| 460 | * @since 9.0.0 |
||
| 461 | * |
||
| 462 | * @return array Test results. |
||
| 463 | */ |
||
| 464 | protected function test__connection_token_health() { |
||
| 465 | $name = __FUNCTION__; |
||
| 466 | |||
| 467 | $m = new Connection_Manager(); |
||
| 468 | $user_id = get_current_user_id() ? get_current_user_id() : $m->get_connection_owner_id(); |
||
| 469 | $validated_tokens = $m->validate_tokens( $user_id ); |
||
| 470 | |||
| 471 | if ( ! is_array( $validated_tokens ) || count( array_diff_key( array_flip( array( 'blog_token', 'user_token' ) ), $validated_tokens ) ) ) { |
||
| 472 | return self::skipped_test( |
||
| 473 | array( |
||
| 474 | 'name' => $name, |
||
| 475 | 'short_description' => __( 'Token health check failed to validate tokens.', 'jetpack' ), |
||
| 476 | ) |
||
| 477 | ); |
||
| 478 | } |
||
| 479 | |||
| 480 | $invalid_tokens_exist = false; |
||
| 481 | foreach ( $validated_tokens as $validated_token ) { |
||
| 482 | if ( ! $validated_token['is_healthy'] ) { |
||
| 483 | $invalid_tokens_exist = true; |
||
| 484 | break; |
||
| 485 | } |
||
| 486 | } |
||
| 487 | |||
| 488 | if ( false === $invalid_tokens_exist ) { |
||
| 489 | return self::passing_test( array( 'name' => $name ) ); |
||
| 490 | } |
||
| 491 | |||
| 492 | $connection_error = __( 'Invalid Jetpack connection tokens.', 'jetpack' ); |
||
| 493 | |||
| 494 | return self::connection_failing_test( $name, $connection_error ); |
||
| 495 | } |
||
| 496 | |||
| 497 | /** |
||
| 498 | * Tests connection status against wp.com's test-connection endpoint. |
||
| 499 | * |
||
| 500 | * @todo: Compare with the wpcom_self_test. We only need one of these. |
||
| 501 | * |
||
| 502 | * @return array Test results. |
||
| 503 | */ |
||
| 504 | protected function test__wpcom_connection_test() { |
||
| 505 | $name = __FUNCTION__; |
||
| 506 | |||
| 507 | $status = new Status(); |
||
| 508 | View Code Duplication | if ( ! Jetpack::is_active() || $status->is_offline_mode() || $status->is_staging_site() || ! $this->pass ) { |
|
| 509 | return self::skipped_test( array( 'name' => $name ) ); |
||
| 510 | } |
||
| 511 | |||
| 512 | add_filter( 'http_request_timeout', array( 'Jetpack_Cxn_Tests', 'increase_timeout' ) ); |
||
| 513 | $response = Client::wpcom_json_api_request_as_blog( |
||
| 514 | sprintf( '/jetpack-blogs/%d/test-connection', Jetpack_Options::get_option( 'id' ) ), |
||
| 515 | Client::WPCOM_JSON_API_VERSION |
||
| 516 | ); |
||
| 517 | remove_filter( 'http_request_timeout', array( 'Jetpack_Cxn_Tests', 'increase_timeout' ) ); |
||
| 518 | |||
| 519 | if ( is_wp_error( $response ) ) { |
||
| 520 | if ( false !== strpos( $response->get_error_message(), 'cURL error 28' ) ) { // Timeout. |
||
|
0 ignored issues
–
show
|
|||
| 521 | $result = self::skipped_test( |
||
| 522 | array( |
||
| 523 | 'name' => $name, |
||
| 524 | 'short_description' => self::helper_get_timeout_text(), |
||
| 525 | ) |
||
| 526 | ); |
||
| 527 | } else { |
||
| 528 | /* translators: %1$s is the error code, %2$s is the error message */ |
||
| 529 | $message = sprintf( __( 'Connection test failed (#%1$s: %2$s)', 'jetpack' ), $response->get_error_code(), $response->get_error_message() ); |
||
|
0 ignored issues
–
show
The method
get_error_code() does not seem to exist on object<WP_Error>.
This check looks for calls to methods that do not seem to exist on a given type. It looks for the method on the type itself as well as in inherited classes or implemented interfaces. This is most likely a typographical error or the method has been renamed. Loading history...
The method
get_error_message() does not seem to exist on object<WP_Error>.
This check looks for calls to methods that do not seem to exist on a given type. It looks for the method on the type itself as well as in inherited classes or implemented interfaces. This is most likely a typographical error or the method has been renamed. Loading history...
|
|||
| 530 | |||
| 531 | $result = self::connection_failing_test( $name, $message ); |
||
| 532 | } |
||
| 533 | |||
| 534 | return $result; |
||
| 535 | } |
||
| 536 | |||
| 537 | $body = wp_remote_retrieve_body( $response ); |
||
| 538 | if ( ! $body ) { |
||
| 539 | return self::failing_test( |
||
| 540 | array( |
||
| 541 | 'name' => $name, |
||
| 542 | 'short_description' => __( 'Connection test failed (empty response body)', 'jetpack' ) . wp_remote_retrieve_response_code( $response ), |
||
| 543 | 'action_label' => $this->helper_get_support_text(), |
||
| 544 | 'action' => $this->helper_get_support_url(), |
||
| 545 | ) |
||
| 546 | ); |
||
| 547 | } |
||
| 548 | |||
| 549 | if ( 404 === wp_remote_retrieve_response_code( $response ) ) { |
||
| 550 | return self::skipped_test( |
||
| 551 | array( |
||
| 552 | 'name' => $name, |
||
| 553 | 'short_description' => __( 'The WordPress.com API returned a 404 error.', 'jetpack' ), |
||
| 554 | ) |
||
| 555 | ); |
||
| 556 | } |
||
| 557 | |||
| 558 | $result = json_decode( $body ); |
||
| 559 | $is_connected = ! empty( $result->connected ); |
||
| 560 | $message = $result->message . ': ' . wp_remote_retrieve_response_code( $response ); |
||
| 561 | |||
| 562 | if ( $is_connected ) { |
||
| 563 | $res = self::passing_test( array( 'name' => $name ) ); |
||
| 564 | } else { |
||
| 565 | $res = self::connection_failing_test( $name, $message ); |
||
| 566 | } |
||
| 567 | |||
| 568 | return $res; |
||
| 569 | } |
||
| 570 | |||
| 571 | /** |
||
| 572 | * Tests the port number to ensure it is an expected value. |
||
| 573 | * |
||
| 574 | * We expect that sites on be on one of: |
||
| 575 | * port 80, |
||
| 576 | * port 443 (https sites only), |
||
| 577 | * the value of JETPACK_SIGNATURE__HTTP_PORT, |
||
| 578 | * unless the site is intentionally on a different port (e.g. example.com:8080 is the site's URL). |
||
| 579 | * |
||
| 580 | * If the value isn't one of those and the site's URL doesn't include a port, then the signature verification will fail. |
||
| 581 | * |
||
| 582 | * This happens most commonly on sites with reverse proxies, so the edge (e.g. Varnish) is running on 80/443, but nginx |
||
| 583 | * or Apache is responding internally on a different port (e.g. 81). |
||
| 584 | * |
||
| 585 | * @return array Test results |
||
| 586 | */ |
||
| 587 | protected function test__server_port_value() { |
||
| 588 | $name = __FUNCTION__; |
||
| 589 | if ( ! isset( $_SERVER['HTTP_X_FORWARDED_PORT'] ) && ! isset( $_SERVER['SERVER_PORT'] ) ) { |
||
| 590 | return self::skipped_test( |
||
| 591 | array( |
||
| 592 | 'name' => $name, |
||
| 593 | 'short_description' => __( 'The server port values are not defined. This is most common when running PHP via a CLI.', 'jetpack' ), |
||
| 594 | ) |
||
| 595 | ); |
||
| 596 | } |
||
| 597 | $site_port = wp_parse_url( home_url(), PHP_URL_PORT ); |
||
| 598 | $server_port = isset( $_SERVER['HTTP_X_FORWARDED_PORT'] ) ? (int) $_SERVER['HTTP_X_FORWARDED_PORT'] : (int) $_SERVER['SERVER_PORT']; |
||
| 599 | $http_ports = array( 80 ); |
||
| 600 | $https_ports = array( 80, 443 ); |
||
| 601 | |||
| 602 | if ( defined( 'JETPACK_SIGNATURE__HTTP_PORT' ) ) { |
||
| 603 | $http_ports[] = JETPACK_SIGNATURE__HTTP_PORT; |
||
| 604 | } |
||
| 605 | |||
| 606 | if ( defined( 'JETPACK_SIGNATURE__HTTPS_PORT' ) ) { |
||
| 607 | $https_ports[] = JETPACK_SIGNATURE__HTTPS_PORT; |
||
| 608 | } |
||
| 609 | |||
| 610 | if ( $site_port ) { |
||
| 611 | return self::skipped_test( array( 'name' => $name ) ); // Not currently testing for this situation. |
||
| 612 | } |
||
| 613 | |||
| 614 | if ( is_ssl() && in_array( $server_port, $https_ports, true ) ) { |
||
| 615 | return self::passing_test( array( 'name' => $name ) ); |
||
| 616 | } elseif ( in_array( $server_port, $http_ports, true ) ) { |
||
| 617 | return self::passing_test( array( 'name' => $name ) ); |
||
| 618 | } else { |
||
| 619 | if ( is_ssl() ) { |
||
| 620 | $needed_constant = 'JETPACK_SIGNATURE__HTTPS_PORT'; |
||
| 621 | } else { |
||
| 622 | $needed_constant = 'JETPACK_SIGNATURE__HTTP_PORT'; |
||
| 623 | } |
||
| 624 | return self::failing_test( |
||
| 625 | array( |
||
| 626 | 'name' => $name, |
||
| 627 | 'short_description' => sprintf( |
||
| 628 | /* translators: %1$s - a PHP code snippet */ |
||
| 629 | __( |
||
| 630 | 'The server port value is unexpected. |
||
| 631 | Try adding the following to your wp-config.php file: %1$s', |
||
| 632 | 'jetpack' |
||
| 633 | ), |
||
| 634 | "define( '$needed_constant', $server_port )" |
||
| 635 | ), |
||
| 636 | ) |
||
| 637 | ); |
||
| 638 | } |
||
| 639 | } |
||
| 640 | |||
| 641 | /** |
||
| 642 | * Full Sync Health Test. |
||
| 643 | * |
||
| 644 | * Sync Disabled: Results in a skipped test |
||
| 645 | * Not In Progress : Results in a skipped test |
||
| 646 | * In Progress: Results in skipped test w/ status in CLI |
||
| 647 | */ |
||
| 648 | protected function test__full_sync_health() { |
||
| 649 | |||
| 650 | $name = __FUNCTION__; |
||
| 651 | |||
| 652 | if ( ! $this->helper_is_jetpack_connected() ) { |
||
| 653 | // If the site is not connected, there is no point in testing Sync health. |
||
| 654 | return self::skipped_test( |
||
| 655 | array( |
||
| 656 | 'name' => $name, |
||
| 657 | 'show_in_site_health' => false, |
||
| 658 | ) |
||
| 659 | ); |
||
| 660 | } |
||
| 661 | |||
| 662 | // Sync is enabled. |
||
| 663 | if ( Sync_Settings::is_sync_enabled() ) { |
||
| 664 | |||
| 665 | // Get Full Sync Progress. |
||
| 666 | $full_sync_module = Modules::get_module( 'full-sync' ); |
||
| 667 | $progress_percent = $full_sync_module ? $full_sync_module->get_sync_progress_percentage() : null; |
||
| 668 | |||
| 669 | // Full Sync in Progress. |
||
| 670 | if ( $progress_percent ) { |
||
| 671 | |||
| 672 | return self::informational_test( |
||
| 673 | array( |
||
| 674 | 'name' => $name, |
||
| 675 | 'label' => __( 'Jetpack is performing a full sync of your site', 'jetpack' ), |
||
| 676 | 'severity' => 'recommended', |
||
| 677 | /* translators: placeholder is a percentage number. */ |
||
| 678 | 'short_description' => sprintf( __( 'Jetpack is performing a full sync of your site. Current Progress: %1$d %%', 'jetpack' ), $progress_percent ), |
||
| 679 | 'long_description' => sprintf( |
||
| 680 | '<p>%1$s</p><p><span class="dashicons dashicons-update"><span class="screen-reader-text">%2$s</span></span> %3$s</p><div class="jetpack-sync-progress-ui"><div class="jetpack-sync-progress-label"></div><div class="jetpack-sync-progress-bar"></div></div>', |
||
| 681 | __( 'The information synced by Jetpack ensures that Jetpack Search, Related Posts and other features are aligned with your site’s current content.', 'jetpack' ), /* translators: screen reader text indicating data is updating. */ |
||
| 682 | __( 'Updating', 'jetpack' ), |
||
| 683 | __( 'Jetpack is currently performing a full sync of your site data.', 'jetpack' ) |
||
| 684 | ), |
||
| 685 | ) |
||
| 686 | ); |
||
| 687 | |||
| 688 | } else { |
||
| 689 | |||
| 690 | // no Full Sync in Progress. |
||
| 691 | return self::skipped_test( |
||
| 692 | array( |
||
| 693 | 'name' => $name, |
||
| 694 | 'show_in_site_health' => false, |
||
| 695 | ) |
||
| 696 | ); |
||
| 697 | |||
| 698 | } |
||
| 699 | } else { |
||
| 700 | |||
| 701 | // If sync is not enabled no Full Sync can occur. |
||
| 702 | return self::skipped_test( |
||
| 703 | array( |
||
| 704 | 'name' => $name, |
||
| 705 | 'show_in_site_health' => false, |
||
| 706 | ) |
||
| 707 | ); |
||
| 708 | |||
| 709 | } |
||
| 710 | |||
| 711 | } |
||
| 712 | |||
| 713 | /** |
||
| 714 | * Sync Health Tests. |
||
| 715 | * |
||
| 716 | * Disabled: Results in a failing test (recommended) |
||
| 717 | * Delayed: Results in failing test (recommended) |
||
| 718 | * Error: Results in failing test (critical) |
||
| 719 | */ |
||
| 720 | protected function test__sync_health() { |
||
| 721 | |||
| 722 | $name = __FUNCTION__; |
||
| 723 | |||
| 724 | if ( ! $this->helper_is_jetpack_connected() ) { |
||
| 725 | // If the site is not connected, there is no point in testing Sync health. |
||
| 726 | return self::skipped_test( |
||
| 727 | array( |
||
| 728 | 'name' => $name, |
||
| 729 | 'show_in_site_health' => false, |
||
| 730 | ) |
||
| 731 | ); |
||
| 732 | } |
||
| 733 | |||
| 734 | // Sync is enabled. |
||
| 735 | if ( Sync_Settings::is_sync_enabled() ) { |
||
| 736 | |||
| 737 | if ( Sync_Health::get_status() === Sync_Health::STATUS_OUT_OF_SYNC ) { |
||
| 738 | /* |
||
| 739 | * Sync has experienced Data Loss. |
||
| 740 | */ |
||
| 741 | $description = '<p>'; |
||
| 742 | $description .= esc_html__( 'The information synced by Jetpack ensures that Jetpack Search, Related Posts and other features are aligned with your site’s current content.', 'jetpack' ); |
||
| 743 | $description .= '</p>'; |
||
| 744 | $description .= '<p>'; |
||
| 745 | $description .= sprintf( |
||
| 746 | '<span class="dashicons fail"><span class="screen-reader-text">%1$s</span></span> ', |
||
| 747 | esc_html__( 'Error', 'jetpack' ) |
||
| 748 | ); |
||
| 749 | $description .= wp_kses( |
||
| 750 | __( 'Jetpack has detected an error while syncing your site. <strong>We recommend <a id="full_sync_request_link" href="#">a full sync</a> to align Jetpack with your site data.</strong>', 'jetpack' ), |
||
| 751 | array( |
||
| 752 | 'a' => array( |
||
| 753 | 'id' => array(), |
||
| 754 | 'href' => array(), |
||
| 755 | ), |
||
| 756 | 'strong' => array(), |
||
| 757 | ) |
||
| 758 | ); |
||
| 759 | $description .= '</p>'; |
||
| 760 | |||
| 761 | return self::failing_test( |
||
| 762 | array( |
||
| 763 | 'name' => $name, |
||
| 764 | 'label' => __( 'Jetpack has detected an error syncing your site.', 'jetpack' ), |
||
| 765 | 'severity' => 'critical', |
||
| 766 | 'action' => Redirect::get_url( 'jetpack-contact-support' ), |
||
| 767 | 'action_label' => __( 'Contact Jetpack Support', 'jetpack' ), |
||
| 768 | 'short_description' => __( 'Jetpack has detected an error while syncing your site. We recommend a full sync to align Jetpack with your site data.', 'jetpack' ), |
||
| 769 | 'long_description' => $description, |
||
| 770 | ) |
||
| 771 | ); |
||
| 772 | |||
| 773 | } else { |
||
| 774 | // Get the Sync Queue. |
||
| 775 | $sender = Sync_Sender::get_instance(); |
||
| 776 | $sync_queue = $sender->get_sync_queue(); |
||
| 777 | |||
| 778 | // lag exceeds 5 minutes. |
||
| 779 | if ( $sync_queue->lag() > 5 * MINUTE_IN_SECONDS ) { |
||
| 780 | |||
| 781 | $description = '<p>'; |
||
| 782 | $description .= esc_html__( 'The information synced by Jetpack ensures that Jetpack Search, Related Posts and other features are aligned with your site’s current content.', 'jetpack' ); |
||
| 783 | $description .= '</p>'; |
||
| 784 | $description .= '<p>'; |
||
| 785 | $description .= sprintf( |
||
| 786 | '<span class="dashicons dashicons-clock" style="color: orange;"><span class="screen-reader-text">%1$s</span></span> ', |
||
| 787 | /* translators: name, used to describe a clock icon. */ |
||
| 788 | esc_html__( 'Clock', 'jetpack' ) |
||
| 789 | ); |
||
| 790 | $description .= wp_kses( |
||
| 791 | sprintf( |
||
| 792 | /* translators: placeholder is a number of minutes. */ |
||
| 793 | _n( |
||
| 794 | 'Jetpack has identified a delay while syncing individual content updates. Certain features might be slower than usual, but this is only temporary while sync catches up with recent changes to your site. <strong>We’re seeing a current delay of %1$d minute.</strong>', |
||
| 795 | 'Jetpack has identified a delay while syncing individual content updates. Certain features might be slower than usual, but this is only temporary while sync catches up with recent changes to your site. <strong>We’re seeing a current delay of %1$d minutes.</strong>', |
||
| 796 | intval( $sync_queue->lag() / MINUTE_IN_SECONDS ), |
||
| 797 | 'jetpack' |
||
| 798 | ), |
||
| 799 | number_format_i18n( $sync_queue->lag() / MINUTE_IN_SECONDS ) |
||
| 800 | ), |
||
| 801 | array( 'strong' => array() ) |
||
| 802 | ); |
||
| 803 | $description .= '</p>'; |
||
| 804 | |||
| 805 | return self::informational_test( |
||
| 806 | array( |
||
| 807 | 'name' => $name, |
||
| 808 | 'label' => __( 'Jetpack is experiencing a delay syncing your site.', 'jetpack' ), |
||
| 809 | 'severity' => 'recommended', |
||
| 810 | 'action' => null, |
||
| 811 | 'action_label' => null, |
||
| 812 | 'short_description' => __( 'Jetpack is experiencing a delay syncing your site.', 'jetpack' ), |
||
| 813 | 'long_description' => $description, |
||
| 814 | ) |
||
| 815 | ); |
||
| 816 | |||
| 817 | } else { |
||
| 818 | |||
| 819 | // Sync is Healthy. |
||
| 820 | return self::passing_test( array( 'name' => $name ) ); |
||
| 821 | |||
| 822 | } |
||
| 823 | } |
||
| 824 | } else { |
||
| 825 | /* |
||
| 826 | * Sync is disabled. |
||
| 827 | */ |
||
| 828 | |||
| 829 | $description = '<p>'; |
||
| 830 | $description .= esc_html__( 'The information synced by Jetpack ensures that Jetpack Search, Related Posts and other features are aligned with your site’s current content.', 'jetpack' ); |
||
| 831 | $description .= '</p>'; |
||
| 832 | $description .= '<p>'; |
||
| 833 | $description .= __( 'Developers may enable / disable syncing using the Sync Settings API.', 'jetpack' ); |
||
| 834 | $description .= '</p>'; |
||
| 835 | $description .= '<p>'; |
||
| 836 | $description .= sprintf( |
||
| 837 | '<span class="dashicons fail"><span class="screen-reader-text">%1$s</span></span> ', |
||
| 838 | esc_html__( 'Error', 'jetpack' ) |
||
| 839 | ); |
||
| 840 | $description .= wp_kses( |
||
| 841 | __( 'Jetpack Sync has been disabled on your site. Without it, certain Jetpack features will not work. <strong>We recommend enabling Sync.</strong>', 'jetpack' ), |
||
| 842 | array( 'strong' => array() ) |
||
| 843 | ); |
||
| 844 | $description .= '</p>'; |
||
| 845 | |||
| 846 | return self::failing_test( |
||
| 847 | array( |
||
| 848 | 'name' => $name, |
||
| 849 | 'label' => __( 'Jetpack Sync has been disabled on your site.', 'jetpack' ), |
||
| 850 | 'severity' => 'recommended', |
||
| 851 | 'action' => 'https://github.com/Automattic/jetpack/blob/master/packages/sync/src/class-settings.php', |
||
| 852 | 'action_label' => __( 'See Github for more on Sync Settings', 'jetpack' ), |
||
| 853 | 'short_description' => __( 'Jetpack Sync has been disabled on your site.', 'jetpack' ), |
||
| 854 | 'long_description' => $description, |
||
| 855 | ) |
||
| 856 | ); |
||
| 857 | |||
| 858 | } |
||
| 859 | |||
| 860 | } |
||
| 861 | |||
| 862 | /** |
||
| 863 | * Calls to WP.com to run the connection diagnostic testing suite. |
||
| 864 | * |
||
| 865 | * Intentionally added last as it will be skipped if any local failed conditions exist. |
||
| 866 | * |
||
| 867 | * @since 7.1.0 |
||
| 868 | * @since 7.9.0 Timeout waiting for a WP.com response no longer fails the test. Test is marked skipped instead. |
||
| 869 | * |
||
| 870 | * @return array Test results. |
||
| 871 | */ |
||
| 872 | protected function last__wpcom_self_test() { |
||
| 873 | $name = 'test__wpcom_self_test'; |
||
| 874 | |||
| 875 | $status = new Status(); |
||
| 876 | View Code Duplication | if ( ! Jetpack::is_active() || $status->is_offline_mode() || $status->is_staging_site() || ! $this->pass ) { |
|
| 877 | return self::skipped_test( array( 'name' => $name ) ); |
||
| 878 | } |
||
| 879 | |||
| 880 | $self_xml_rpc_url = site_url( 'xmlrpc.php' ); |
||
| 881 | |||
| 882 | $testsite_url = JETPACK__API_BASE . 'testsite/1/?url='; |
||
| 883 | |||
| 884 | // Using PHP_INT_MAX - 1 so that there is still a way to override this if needed and since it only impacts this one call. |
||
| 885 | add_filter( 'http_request_timeout', array( 'Jetpack_Cxn_Tests', 'increase_timeout' ), PHP_INT_MAX - 1 ); |
||
| 886 | |||
| 887 | $response = wp_remote_get( $testsite_url . $self_xml_rpc_url ); |
||
| 888 | |||
| 889 | remove_filter( 'http_request_timeout', array( 'Jetpack_Cxn_Tests', 'increase_timeout' ), PHP_INT_MAX - 1 ); |
||
| 890 | |||
| 891 | if ( 200 === wp_remote_retrieve_response_code( $response ) ) { |
||
| 892 | $result = self::passing_test( array( 'name' => $name ) ); |
||
| 893 | } elseif ( is_wp_error( $response ) && false !== strpos( $response->get_error_message(), 'cURL error 28' ) ) { // Timeout. |
||
| 894 | $result = self::skipped_test( |
||
| 895 | array( |
||
| 896 | 'name' => $name, |
||
| 897 | 'short_description' => self::helper_get_timeout_text(), |
||
| 898 | ) |
||
| 899 | ); |
||
| 900 | } else { |
||
| 901 | $result = self::failing_test( |
||
| 902 | array( |
||
| 903 | 'name' => $name, |
||
| 904 | 'short_description' => sprintf( |
||
| 905 | /* translators: %1$s - A debugging url */ |
||
| 906 | __( 'Jetpack.com detected an error on the WP.com Self Test. Visit the Jetpack Debug page for more info: %1$s, or contact support.', 'jetpack' ), |
||
| 907 | Redirect::get_url( 'jetpack-support-debug', array( 'query' => 'url=' . rawurlencode( site_url() ) ) ) |
||
| 908 | ), |
||
| 909 | 'action_label' => $this->helper_get_support_text(), |
||
| 910 | 'action' => $this->helper_get_support_url(), |
||
| 911 | ) |
||
| 912 | ); |
||
| 913 | } |
||
| 914 | |||
| 915 | return $result; |
||
| 916 | } |
||
| 917 | } |
||
| 918 |
This check looks for calls to methods that do not seem to exist on a given type. It looks for the method on the type itself as well as in inherited classes or implemented interfaces.
This is most likely a typographical error or the method has been renamed.