Completed
Push — update/calendly-front-end ( 8b5db8...cffa8a )
by
unknown
13:45 queued 06:35
created

Manager::get_assumed_site_creation_date()   A

Complexity

Conditions 3
Paths 3

Size

Total Lines 39

Duplication

Lines 0
Ratio 0 %

Importance

Changes 0
Metric Value
cc 3
nc 3
nop 0
dl 0
loc 39
rs 9.296
c 0
b 0
f 0
1
<?php
2
/**
3
 * The Jetpack Connection manager class file.
4
 *
5
 * @package automattic/jetpack-connection
6
 */
7
8
namespace Automattic\Jetpack\Connection;
9
10
use Automattic\Jetpack\Constants;
11
use Automattic\Jetpack\Roles;
12
use Automattic\Jetpack\Tracking;
13
14
/**
15
 * The Jetpack Connection Manager class that is used as a single gateway between WordPress.com
16
 * and Jetpack.
17
 */
18
class Manager {
19
20
	const SECRETS_MISSING        = 'secrets_missing';
21
	const SECRETS_EXPIRED        = 'secrets_expired';
22
	const SECRETS_OPTION_NAME    = 'jetpack_secrets';
23
	const MAGIC_NORMAL_TOKEN_KEY = ';normal;';
24
	const JETPACK_MASTER_USER    = true;
25
26
	/**
27
	 * The procedure that should be run to generate secrets.
28
	 *
29
	 * @var Callable
30
	 */
31
	protected $secret_callable;
32
33
	/**
34
	 * A copy of the raw POST data for signature verification purposes.
35
	 *
36
	 * @var String
37
	 */
38
	protected $raw_post_data;
39
40
	/**
41
	 * Verification data needs to be stored to properly verify everything.
42
	 *
43
	 * @var Object
44
	 */
45
	private $xmlrpc_verification = null;
46
47
	/**
48
	 * Initializes required listeners. This is done separately from the constructors
49
	 * because some objects sometimes need to instantiate separate objects of this class.
50
	 *
51
	 * @todo Implement a proper nonce verification.
52
	 */
53
	public static function configure() {
54
		$manager = new self();
55
56
		$manager->setup_xmlrpc_handlers(
57
			$_GET, // phpcs:ignore WordPress.Security.NonceVerification.Recommended
58
			$manager->is_active(),
59
			$manager->verify_xml_rpc_signature()
0 ignored issues
show
Bug introduced by
It seems like $manager->verify_xml_rpc_signature() targeting Automattic\Jetpack\Conne...ify_xml_rpc_signature() can also be of type array; however, Automattic\Jetpack\Conne...setup_xmlrpc_handlers() does only seem to accept boolean, maybe add an additional type check?

This check looks at variables that are passed out again to other methods.

If the outgoing method call has stricter type requirements than the method itself, an issue is raised.

An additional type check may prevent trouble.

Loading history...
60
		);
61
62
		if ( $manager->is_active() ) {
63
			add_filter( 'xmlrpc_methods', array( $manager, 'public_xmlrpc_methods' ) );
64
		} else {
65
			add_action( 'rest_api_init', array( $manager, 'initialize_rest_api_registration_connector' ) );
66
		}
67
68
		add_action( 'jetpack_clean_nonces', array( $manager, 'clean_nonces' ) );
69
		if ( ! wp_next_scheduled( 'jetpack_clean_nonces' ) ) {
70
			wp_schedule_event( time(), 'hourly', 'jetpack_clean_nonces' );
71
		}
72
	}
73
74
	/**
75
	 * Sets up the XMLRPC request handlers.
76
	 *
77
	 * @param Array                  $request_params incoming request parameters.
78
	 * @param Boolean                $is_active whether the connection is currently active.
79
	 * @param Boolean                $is_signed whether the signature check has been successful.
80
	 * @param \Jetpack_XMLRPC_Server $xmlrpc_server (optional) an instance of the server to use instead of instantiating a new one.
0 ignored issues
show
Documentation introduced by
Should the type for parameter $xmlrpc_server not be null|\Jetpack_XMLRPC_Server?

This check looks for @param annotations where the type inferred by our type inference engine differs from the declared type.

It makes a suggestion as to what type it considers more descriptive.

Most often this is a case of a parameter that can be null in addition to its declared types.

Loading history...
81
	 */
82
	public function setup_xmlrpc_handlers(
83
		$request_params,
84
		$is_active,
85
		$is_signed,
86
		\Jetpack_XMLRPC_Server $xmlrpc_server = null
87
	) {
88
		add_filter( 'xmlrpc_blog_options', array( $this, 'xmlrpc_options' ), 1000, 2 );
89
90
		if (
91
			! isset( $request_params['for'] )
92
			|| 'jetpack' !== $request_params['for']
93
		) {
94
			return false;
95
		}
96
97
		// Alternate XML-RPC, via ?for=jetpack&jetpack=comms.
98
		if (
99
			isset( $request_params['jetpack'] )
100
			&& 'comms' === $request_params['jetpack']
101
		) {
102
			if ( ! Constants::is_defined( 'XMLRPC_REQUEST' ) ) {
103
				// Use the real constant here for WordPress' sake.
104
				define( 'XMLRPC_REQUEST', true );
105
			}
106
107
			add_action( 'template_redirect', array( $this, 'alternate_xmlrpc' ) );
108
109
			add_filter( 'xmlrpc_methods', array( $this, 'remove_non_jetpack_xmlrpc_methods' ), 1000 );
110
		}
111
112
		if ( ! Constants::get_constant( 'XMLRPC_REQUEST' ) ) {
113
			return false;
114
		}
115
		// Display errors can cause the XML to be not well formed.
116
		@ini_set( 'display_errors', false ); // phpcs:ignore
0 ignored issues
show
Security Best Practice introduced by
It seems like you do not handle an error condition here. This can introduce security issues, and is generally not recommended.

If you suppress an error, we recommend checking for the error condition explicitly:

// For example instead of
@mkdir($dir);

// Better use
if (@mkdir($dir) === false) {
    throw new \RuntimeException('The directory '.$dir.' could not be created.');
}
Loading history...
117
118
		if ( $xmlrpc_server ) {
119
			$this->xmlrpc_server = $xmlrpc_server;
0 ignored issues
show
Bug introduced by
The property xmlrpc_server does not exist. Did you maybe forget to declare it?

In PHP it is possible to write to properties without declaring them. For example, the following is perfectly valid PHP code:

class MyClass { }

$x = new MyClass();
$x->foo = true;

Generally, it is a good practice to explictly declare properties to avoid accidental typos and provide IDE auto-completion:

class MyClass {
    public $foo;
}

$x = new MyClass();
$x->foo = true;
Loading history...
120
		} else {
121
			$this->xmlrpc_server = new \Jetpack_XMLRPC_Server();
122
		}
123
124
		$this->require_jetpack_authentication();
125
126
		if ( $is_active ) {
127
			// Hack to preserve $HTTP_RAW_POST_DATA.
128
			add_filter( 'xmlrpc_methods', array( $this, 'xmlrpc_methods' ) );
129
130
			if ( $is_signed ) {
131
				// The actual API methods.
132
				add_filter( 'xmlrpc_methods', array( $this->xmlrpc_server, 'xmlrpc_methods' ) );
133
			} else {
134
				// The jetpack.authorize method should be available for unauthenticated users on a site with an
135
				// active Jetpack connection, so that additional users can link their account.
136
				add_filter( 'xmlrpc_methods', array( $this->xmlrpc_server, 'authorize_xmlrpc_methods' ) );
137
			}
138
		} else {
139
			// The bootstrap API methods.
140
			add_filter( 'xmlrpc_methods', array( $this->xmlrpc_server, 'bootstrap_xmlrpc_methods' ) );
141
142
			if ( $is_signed ) {
143
				// The jetpack Provision method is available for blog-token-signed requests.
144
				add_filter( 'xmlrpc_methods', array( $this->xmlrpc_server, 'provision_xmlrpc_methods' ) );
145
			} else {
146
				new XMLRPC_Connector( $this );
147
			}
148
		}
149
150
		// Now that no one can authenticate, and we're whitelisting all XML-RPC methods, force enable_xmlrpc on.
151
		add_filter( 'pre_option_enable_xmlrpc', '__return_true' );
152
		return true;
153
	}
154
155
	/**
156
	 * Initializes the REST API connector on the init hook.
157
	 */
158
	public function initialize_rest_api_registration_connector() {
159
		new REST_Connector( $this );
160
	}
161
162
	/**
163
	 * Since a lot of hosts use a hammer approach to "protecting" WordPress sites,
164
	 * and just blanket block all requests to /xmlrpc.php, or apply other overly-sensitive
165
	 * security/firewall policies, we provide our own alternate XML RPC API endpoint
166
	 * which is accessible via a different URI. Most of the below is copied directly
167
	 * from /xmlrpc.php so that we're replicating it as closely as possible.
168
	 *
169
	 * @todo Tighten $wp_xmlrpc_server_class a bit to make sure it doesn't do bad things.
170
	 */
171
	public function alternate_xmlrpc() {
172
		// phpcs:disable PHPCompatibility.Variables.RemovedPredefinedGlobalVariables.http_raw_post_dataDeprecatedRemoved
173
		// phpcs:disable WordPress.WP.GlobalVariablesOverride.Prohibited
174
		global $HTTP_RAW_POST_DATA;
175
176
		// Some browser-embedded clients send cookies. We don't want them.
177
		$_COOKIE = array();
178
179
		// A fix for mozBlog and other cases where '<?xml' isn't on the very first line.
180
		if ( isset( $HTTP_RAW_POST_DATA ) ) {
181
			$HTTP_RAW_POST_DATA = trim( $HTTP_RAW_POST_DATA );
182
		}
183
184
		// phpcs:enable
185
186
		include_once ABSPATH . 'wp-admin/includes/admin.php';
187
		include_once ABSPATH . WPINC . '/class-IXR.php';
188
		include_once ABSPATH . WPINC . '/class-wp-xmlrpc-server.php';
189
190
		/**
191
		 * Filters the class used for handling XML-RPC requests.
192
		 *
193
		 * @since 3.1.0
194
		 *
195
		 * @param string $class The name of the XML-RPC server class.
196
		 */
197
		$wp_xmlrpc_server_class = apply_filters( 'wp_xmlrpc_server_class', 'wp_xmlrpc_server' );
198
		$wp_xmlrpc_server       = new $wp_xmlrpc_server_class();
199
200
		// Fire off the request.
201
		nocache_headers();
202
		$wp_xmlrpc_server->serve_request();
203
204
		exit;
205
	}
206
207
	/**
208
	 * Removes all XML-RPC methods that are not `jetpack.*`.
209
	 * Only used in our alternate XML-RPC endpoint, where we want to
210
	 * ensure that Core and other plugins' methods are not exposed.
211
	 *
212
	 * @param array $methods a list of registered WordPress XMLRPC methods.
213
	 * @return array filtered $methods
214
	 */
215
	public function remove_non_jetpack_xmlrpc_methods( $methods ) {
216
		$jetpack_methods = array();
217
218
		foreach ( $methods as $method => $callback ) {
219
			if ( 0 === strpos( $method, 'jetpack.' ) ) {
220
				$jetpack_methods[ $method ] = $callback;
221
			}
222
		}
223
224
		return $jetpack_methods;
225
	}
226
227
	/**
228
	 * Removes all other authentication methods not to allow other
229
	 * methods to validate unauthenticated requests.
230
	 */
231
	public function require_jetpack_authentication() {
232
		// Don't let anyone authenticate.
233
		$_COOKIE = array();
234
		remove_all_filters( 'authenticate' );
235
		remove_all_actions( 'wp_login_failed' );
236
237
		if ( $this->is_active() ) {
238
			// Allow Jetpack authentication.
239
			add_filter( 'authenticate', array( $this, 'authenticate_jetpack' ), 10, 3 );
240
		}
241
	}
242
243
	/**
244
	 * Authenticates XML-RPC and other requests from the Jetpack Server
245
	 *
246
	 * @param WP_User|Mixed $user user object if authenticated.
247
	 * @param String        $username username.
248
	 * @param String        $password password string.
249
	 * @return WP_User|Mixed authenticated user or error.
250
	 */
251
	public function authenticate_jetpack( $user, $username, $password ) {
252
		if ( is_a( $user, '\\WP_User' ) ) {
253
			return $user;
254
		}
255
256
		$token_details = $this->verify_xml_rpc_signature();
257
258
		if ( ! $token_details ) {
259
			return $user;
260
		}
261
262
		if ( 'user' !== $token_details['type'] ) {
263
			return $user;
264
		}
265
266
		if ( ! $token_details['user_id'] ) {
267
			return $user;
268
		}
269
270
		nocache_headers();
271
272
		return new \WP_User( $token_details['user_id'] );
273
	}
274
275
	/**
276
	 * Verifies the signature of the current request.
277
	 *
278
	 * @return false|array
279
	 */
280
	public function verify_xml_rpc_signature() {
281
		if ( is_null( $this->xmlrpc_verification ) ) {
282
			$this->xmlrpc_verification = $this->internal_verify_xml_rpc_signature();
283
284
			if ( is_wp_error( $this->xmlrpc_verification ) ) {
285
				/**
286
				 * Action for logging XMLRPC signature verification errors. This data is sensitive.
287
				 *
288
				 * Error codes:
289
				 * - malformed_token
290
				 * - malformed_user_id
291
				 * - unknown_token
292
				 * - could_not_sign
293
				 * - invalid_nonce
294
				 * - signature_mismatch
295
				 *
296
				 * @since 7.5.0
297
				 *
298
				 * @param WP_Error $signature_verification_error The verification error
299
				 */
300
				do_action( 'jetpack_verify_signature_error', $this->xmlrpc_verification );
301
			}
302
		}
303
304
		return is_wp_error( $this->xmlrpc_verification ) ? false : $this->xmlrpc_verification;
305
	}
306
307
	/**
308
	 * Verifies the signature of the current request.
309
	 *
310
	 * This function has side effects and should not be used. Instead,
311
	 * use the memoized version `->verify_xml_rpc_signature()`.
312
	 *
313
	 * @internal
314
	 * @todo Refactor to use proper nonce verification.
315
	 */
316
	private function internal_verify_xml_rpc_signature() {
317
		// phpcs:disable WordPress.Security.NonceVerification.Recommended
318
		// It's not for us.
319
		if ( ! isset( $_GET['token'] ) || empty( $_GET['signature'] ) ) {
320
			return false;
321
		}
322
323
		$signature_details = array(
324
			'token'     => isset( $_GET['token'] ) ? wp_unslash( $_GET['token'] ) : '',
325
			'timestamp' => isset( $_GET['timestamp'] ) ? wp_unslash( $_GET['timestamp'] ) : '',
326
			'nonce'     => isset( $_GET['nonce'] ) ? wp_unslash( $_GET['nonce'] ) : '',
327
			'body_hash' => isset( $_GET['body-hash'] ) ? wp_unslash( $_GET['body-hash'] ) : '',
328
			'method'    => wp_unslash( $_SERVER['REQUEST_METHOD'] ),
329
			'url'       => wp_unslash( $_SERVER['HTTP_HOST'] . $_SERVER['REQUEST_URI'] ), // Temp - will get real signature URL later.
330
			'signature' => isset( $_GET['signature'] ) ? wp_unslash( $_GET['signature'] ) : '',
331
		);
332
333
		// phpcs:ignore WordPress.PHP.NoSilencedErrors.Discouraged
334
		@list( $token_key, $version, $user_id ) = explode( ':', wp_unslash( $_GET['token'] ) );
0 ignored issues
show
Security Best Practice introduced by
It seems like you do not handle an error condition here. This can introduce security issues, and is generally not recommended.

If you suppress an error, we recommend checking for the error condition explicitly:

// For example instead of
@mkdir($dir);

// Better use
if (@mkdir($dir) === false) {
    throw new \RuntimeException('The directory '.$dir.' could not be created.');
}
Loading history...
335
		// phpcs:enable WordPress.Security.NonceVerification.Recommended
336
337
		if (
338
			empty( $token_key )
339
		||
340
			empty( $version ) || strval( JETPACK__API_VERSION ) !== $version
341
		) {
342
			return new \WP_Error( 'malformed_token', 'Malformed token in request', compact( 'signature_details' ) );
0 ignored issues
show
Unused Code introduced by
The call to WP_Error::__construct() has too many arguments starting with 'malformed_token'.

This check compares calls to functions or methods with their respective definitions. If the call has more arguments than are defined, it raises an issue.

If a function is defined several times with a different number of parameters, the check may pick up the wrong definition and report false positives. One codebase where this has been known to happen is Wordpress.

In this case you can add the @ignore PhpDoc annotation to the duplicate definition and it will be ignored.

Loading history...
343
		}
344
345
		if ( '0' === $user_id ) {
346
			$token_type = 'blog';
347
			$user_id    = 0;
348
		} else {
349
			$token_type = 'user';
350
			if ( empty( $user_id ) || ! ctype_digit( $user_id ) ) {
351
				return new \WP_Error(
352
					'malformed_user_id',
0 ignored issues
show
Unused Code introduced by
The call to WP_Error::__construct() has too many arguments starting with 'malformed_user_id'.

This check compares calls to functions or methods with their respective definitions. If the call has more arguments than are defined, it raises an issue.

If a function is defined several times with a different number of parameters, the check may pick up the wrong definition and report false positives. One codebase where this has been known to happen is Wordpress.

In this case you can add the @ignore PhpDoc annotation to the duplicate definition and it will be ignored.

Loading history...
353
					'Malformed user_id in request',
354
					compact( 'signature_details' )
355
				);
356
			}
357
			$user_id = (int) $user_id;
358
359
			$user = new \WP_User( $user_id );
360
			if ( ! $user || ! $user->exists() ) {
361
				return new \WP_Error(
362
					'unknown_user',
0 ignored issues
show
Unused Code introduced by
The call to WP_Error::__construct() has too many arguments starting with 'unknown_user'.

This check compares calls to functions or methods with their respective definitions. If the call has more arguments than are defined, it raises an issue.

If a function is defined several times with a different number of parameters, the check may pick up the wrong definition and report false positives. One codebase where this has been known to happen is Wordpress.

In this case you can add the @ignore PhpDoc annotation to the duplicate definition and it will be ignored.

Loading history...
363
					sprintf( 'User %d does not exist', $user_id ),
364
					compact( 'signature_details' )
365
				);
366
			}
367
		}
368
369
		$token = $this->get_access_token( $user_id, $token_key, false );
370
		if ( is_wp_error( $token ) ) {
371
			$token->add_data( compact( 'signature_details' ) );
372
			return $token;
373
		} elseif ( ! $token ) {
374
			return new \WP_Error(
375
				'unknown_token',
0 ignored issues
show
Unused Code introduced by
The call to WP_Error::__construct() has too many arguments starting with 'unknown_token'.

This check compares calls to functions or methods with their respective definitions. If the call has more arguments than are defined, it raises an issue.

If a function is defined several times with a different number of parameters, the check may pick up the wrong definition and report false positives. One codebase where this has been known to happen is Wordpress.

In this case you can add the @ignore PhpDoc annotation to the duplicate definition and it will be ignored.

Loading history...
376
				sprintf( 'Token %s:%s:%d does not exist', $token_key, $version, $user_id ),
377
				compact( 'signature_details' )
378
			);
379
		}
380
381
		$jetpack_signature = new \Jetpack_Signature( $token->secret, (int) \Jetpack_Options::get_option( 'time_diff' ) );
382
		// phpcs:disable WordPress.Security.NonceVerification.Missing
383
		if ( isset( $_POST['_jetpack_is_multipart'] ) ) {
384
			$post_data   = $_POST;
385
			$file_hashes = array();
386
			foreach ( $post_data as $post_data_key => $post_data_value ) {
387
				if ( 0 !== strpos( $post_data_key, '_jetpack_file_hmac_' ) ) {
388
					continue;
389
				}
390
				$post_data_key                 = substr( $post_data_key, strlen( '_jetpack_file_hmac_' ) );
391
				$file_hashes[ $post_data_key ] = $post_data_value;
392
			}
393
394
			foreach ( $file_hashes as $post_data_key => $post_data_value ) {
395
				unset( $post_data[ "_jetpack_file_hmac_{$post_data_key}" ] );
396
				$post_data[ $post_data_key ] = $post_data_value;
397
			}
398
399
			ksort( $post_data );
400
401
			$body = http_build_query( stripslashes_deep( $post_data ) );
402
		} elseif ( is_null( $this->raw_post_data ) ) {
403
			$body = file_get_contents( 'php://input' );
404
		} else {
405
			$body = null;
406
		}
407
		// phpcs:enable
408
409
		$signature = $jetpack_signature->sign_current_request(
410
			array( 'body' => is_null( $body ) ? $this->raw_post_data : $body )
411
		);
412
413
		$signature_details['url'] = $jetpack_signature->current_request_url;
414
415
		if ( ! $signature ) {
416
			return new \WP_Error(
417
				'could_not_sign',
0 ignored issues
show
Unused Code introduced by
The call to WP_Error::__construct() has too many arguments starting with 'could_not_sign'.

This check compares calls to functions or methods with their respective definitions. If the call has more arguments than are defined, it raises an issue.

If a function is defined several times with a different number of parameters, the check may pick up the wrong definition and report false positives. One codebase where this has been known to happen is Wordpress.

In this case you can add the @ignore PhpDoc annotation to the duplicate definition and it will be ignored.

Loading history...
418
				'Unknown signature error',
419
				compact( 'signature_details' )
420
			);
421
		} elseif ( is_wp_error( $signature ) ) {
422
			return $signature;
423
		}
424
425
		// phpcs:disable WordPress.Security.NonceVerification.Recommended
426
		$timestamp = (int) $_GET['timestamp'];
427
		$nonce     = stripslashes( (string) $_GET['nonce'] );
428
		// phpcs:enable WordPress.Security.NonceVerification.Recommended
429
430
		// Use up the nonce regardless of whether the signature matches.
431
		if ( ! $this->add_nonce( $timestamp, $nonce ) ) {
432
			return new \WP_Error(
433
				'invalid_nonce',
0 ignored issues
show
Unused Code introduced by
The call to WP_Error::__construct() has too many arguments starting with 'invalid_nonce'.

This check compares calls to functions or methods with their respective definitions. If the call has more arguments than are defined, it raises an issue.

If a function is defined several times with a different number of parameters, the check may pick up the wrong definition and report false positives. One codebase where this has been known to happen is Wordpress.

In this case you can add the @ignore PhpDoc annotation to the duplicate definition and it will be ignored.

Loading history...
434
				'Could not add nonce',
435
				compact( 'signature_details' )
436
			);
437
		}
438
439
		// Be careful about what you do with this debugging data.
440
		// If a malicious requester has access to the expected signature,
441
		// bad things might be possible.
442
		$signature_details['expected'] = $signature;
443
444
		// phpcs:ignore WordPress.Security.NonceVerification.Recommended
445
		if ( ! hash_equals( $signature, $_GET['signature'] ) ) {
446
			return new \WP_Error(
447
				'signature_mismatch',
0 ignored issues
show
Unused Code introduced by
The call to WP_Error::__construct() has too many arguments starting with 'signature_mismatch'.

This check compares calls to functions or methods with their respective definitions. If the call has more arguments than are defined, it raises an issue.

If a function is defined several times with a different number of parameters, the check may pick up the wrong definition and report false positives. One codebase where this has been known to happen is Wordpress.

In this case you can add the @ignore PhpDoc annotation to the duplicate definition and it will be ignored.

Loading history...
448
				'Signature mismatch',
449
				compact( 'signature_details' )
450
			);
451
		}
452
453
		/**
454
		 * Action for additional token checking.
455
		 *
456
		 * @since 7.7.0
457
		 *
458
		 * @param Array $post_data request data.
459
		 * @param Array $token_data token data.
460
		 */
461
		return apply_filters(
462
			'jetpack_signature_check_token',
463
			array(
464
				'type'      => $token_type,
465
				'token_key' => $token_key,
466
				'user_id'   => $token->external_user_id,
467
			),
468
			$token,
469
			$this->raw_post_data
470
		);
471
	}
472
473
	/**
474
	 * Returns true if the current site is connected to WordPress.com.
475
	 *
476
	 * @return Boolean is the site connected?
477
	 */
478
	public function is_active() {
479
		return (bool) $this->get_access_token( self::JETPACK_MASTER_USER );
0 ignored issues
show
Documentation introduced by
self::JETPACK_MASTER_USER is of type boolean, but the function expects a false|integer.

It seems like the type of the argument is not accepted by the function/method which you are calling.

In some cases, in particular if PHP’s automatic type-juggling kicks in this might be fine. In other cases, however this might be a bug.

We suggest to add an explicit type cast like in the following example:

function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
Loading history...
480
	}
481
482
	/**
483
	 * Returns true if the site has both a token and a blog id, which indicates a site has been registered.
484
	 *
485
	 * @access public
486
	 *
487
	 * @return bool
488
	 */
489
	public function is_registered() {
490
		$blog_id   = \Jetpack_Options::get_option( 'id' );
491
		$has_token = $this->is_active();
492
		return $blog_id && $has_token;
493
	}
494
495
	/**
496
	 * Checks to see if the connection owner of the site is missing.
497
	 *
498
	 * @return bool
499
	 */
500
	public function is_missing_connection_owner() {
501
		$connection_owner = $this->get_connection_owner_id();
502
		if ( ! get_user_by( 'id', $connection_owner ) ) {
503
			return true;
504
		}
505
506
		return false;
507
	}
508
509
	/**
510
	 * Returns true if the user with the specified identifier is connected to
511
	 * WordPress.com.
512
	 *
513
	 * @param Integer|Boolean $user_id the user identifier.
514
	 * @return Boolean is the user connected?
515
	 */
516
	public function is_user_connected( $user_id = false ) {
517
		$user_id = false === $user_id ? get_current_user_id() : absint( $user_id );
518
		if ( ! $user_id ) {
519
			return false;
520
		}
521
522
		return (bool) $this->get_access_token( $user_id );
523
	}
524
525
	/**
526
	 * Returns the local user ID of the connection owner.
527
	 *
528
	 * @return string|int Returns the ID of the connection owner or False if no connection owner found.
529
	 */
530 View Code Duplication
	public function get_connection_owner_id() {
531
		$user_token       = $this->get_access_token( JETPACK_MASTER_USER );
0 ignored issues
show
Documentation introduced by
JETPACK_MASTER_USER is of type boolean, but the function expects a false|integer.

It seems like the type of the argument is not accepted by the function/method which you are calling.

In some cases, in particular if PHP’s automatic type-juggling kicks in this might be fine. In other cases, however this might be a bug.

We suggest to add an explicit type cast like in the following example:

function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
Loading history...
532
		$connection_owner = false;
533
		if ( $user_token && is_object( $user_token ) && isset( $user_token->external_user_id ) ) {
534
			$connection_owner = $user_token->external_user_id;
535
		}
536
537
		return $connection_owner;
538
	}
539
540
	/**
541
	 * Returns an array of user_id's that have user tokens for communicating with wpcom.
542
	 * Able to select by specific capability.
543
	 *
544
	 * @param string $capability The capability of the user.
545
	 * @return array Array of WP_User objects if found.
546
	 */
547
	public function get_connected_users( $capability = 'any' ) {
548
		$connected_users    = array();
549
		$connected_user_ids = array_keys( \Jetpack_Options::get_option( 'user_tokens' ) );
550
551
		if ( ! empty( $connected_user_ids ) ) {
552
			foreach ( $connected_user_ids as $id ) {
553
				// Check for capability.
554
				if ( 'any' !== $capability && ! user_can( $id, $capability ) ) {
555
					continue;
556
				}
557
558
				$connected_users[] = get_userdata( $id );
559
			}
560
		}
561
562
		return $connected_users;
563
	}
564
565
	/**
566
	 * Get the wpcom user data of the current|specified connected user.
567
	 *
568
	 * @todo Refactor to properly load the XMLRPC client independently.
569
	 *
570
	 * @param Integer $user_id the user identifier.
0 ignored issues
show
Documentation introduced by
Should the type for parameter $user_id not be integer|null?

This check looks for @param annotations where the type inferred by our type inference engine differs from the declared type.

It makes a suggestion as to what type it considers more descriptive.

Most often this is a case of a parameter that can be null in addition to its declared types.

Loading history...
571
	 * @return Object the user object.
572
	 */
573 View Code Duplication
	public function get_connected_user_data( $user_id = null ) {
574
		if ( ! $user_id ) {
0 ignored issues
show
Bug Best Practice introduced by
The expression $user_id of type integer|null is loosely compared to false; this is ambiguous if the integer can be zero. You might want to explicitly use === null instead.

In PHP, under loose comparison (like ==, or !=, or switch conditions), values of different types might be equal.

For integer values, zero is a special case, in particular the following results might be unexpected:

0   == false // true
0   == null  // true
123 == false // false
123 == null  // false

// It is often better to use strict comparison
0 === false // false
0 === null  // false
Loading history...
575
			$user_id = get_current_user_id();
576
		}
577
578
		$transient_key    = "jetpack_connected_user_data_$user_id";
579
		$cached_user_data = get_transient( $transient_key );
580
581
		if ( $cached_user_data ) {
582
			return $cached_user_data;
583
		}
584
585
		$xml = new \Jetpack_IXR_Client(
586
			array(
587
				'user_id' => $user_id,
588
			)
589
		);
590
		$xml->query( 'wpcom.getUser' );
591
		if ( ! $xml->isError() ) {
592
			$user_data = $xml->getResponse();
593
			set_transient( $transient_key, $xml->getResponse(), DAY_IN_SECONDS );
594
			return $user_data;
595
		}
596
597
		return false;
598
	}
599
600
	/**
601
	 * Returns a user object of the connection owner.
602
	 *
603
	 * @return object|false False if no connection owner found.
604
	 */
605 View Code Duplication
	public function get_connection_owner() {
606
		$user_token = $this->get_access_token( JETPACK_MASTER_USER );
0 ignored issues
show
Documentation introduced by
JETPACK_MASTER_USER is of type boolean, but the function expects a false|integer.

It seems like the type of the argument is not accepted by the function/method which you are calling.

In some cases, in particular if PHP’s automatic type-juggling kicks in this might be fine. In other cases, however this might be a bug.

We suggest to add an explicit type cast like in the following example:

function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
Loading history...
607
608
		$connection_owner = false;
609
		if ( $user_token && is_object( $user_token ) && isset( $user_token->external_user_id ) ) {
610
			$connection_owner = get_userdata( $user_token->external_user_id );
611
		}
612
613
		return $connection_owner;
614
	}
615
616
	/**
617
	 * Returns true if the provided user is the Jetpack connection owner.
618
	 * If user ID is not specified, the current user will be used.
619
	 *
620
	 * @param Integer|Boolean $user_id the user identifier. False for current user.
621
	 * @return Boolean True the user the connection owner, false otherwise.
622
	 */
623 View Code Duplication
	public function is_connection_owner( $user_id = false ) {
624
		if ( ! $user_id ) {
625
			$user_id = get_current_user_id();
626
		}
627
628
		$user_token = $this->get_access_token( JETPACK_MASTER_USER );
0 ignored issues
show
Documentation introduced by
JETPACK_MASTER_USER is of type boolean, but the function expects a false|integer.

It seems like the type of the argument is not accepted by the function/method which you are calling.

In some cases, in particular if PHP’s automatic type-juggling kicks in this might be fine. In other cases, however this might be a bug.

We suggest to add an explicit type cast like in the following example:

function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
Loading history...
629
630
		return $user_token && is_object( $user_token ) && isset( $user_token->external_user_id ) && $user_id === $user_token->external_user_id;
631
	}
632
633
	/**
634
	 * Connects the user with a specified ID to a WordPress.com user using the
635
	 * remote login flow.
636
	 *
637
	 * @access public
638
	 *
639
	 * @param Integer $user_id (optional) the user identifier, defaults to current user.
0 ignored issues
show
Documentation introduced by
Should the type for parameter $user_id not be integer|null?

This check looks for @param annotations where the type inferred by our type inference engine differs from the declared type.

It makes a suggestion as to what type it considers more descriptive.

Most often this is a case of a parameter that can be null in addition to its declared types.

Loading history...
640
	 * @param String  $redirect_url the URL to redirect the user to for processing, defaults to
0 ignored issues
show
Documentation introduced by
Should the type for parameter $redirect_url not be string|null?

This check looks for @param annotations where the type inferred by our type inference engine differs from the declared type.

It makes a suggestion as to what type it considers more descriptive.

Most often this is a case of a parameter that can be null in addition to its declared types.

Loading history...
641
	 *                              admin_url().
642
	 * @return WP_Error only in case of a failed user lookup.
643
	 */
644
	public function connect_user( $user_id = null, $redirect_url = null ) {
645
		$user = null;
0 ignored issues
show
Unused Code introduced by
$user is not used, you could remove the assignment.

This check looks for variable assignements that are either overwritten by other assignments or where the variable is not used subsequently.

$myVar = 'Value';
$higher = false;

if (rand(1, 6) > 3) {
    $higher = true;
} else {
    $higher = false;
}

Both the $myVar assignment in line 1 and the $higher assignment in line 2 are dead. The first because $myVar is never used and the second because $higher is always overwritten for every possible time line.

Loading history...
646
		if ( null === $user_id ) {
647
			$user = wp_get_current_user();
648
		} else {
649
			$user = get_user_by( 'ID', $user_id );
650
		}
651
652
		if ( empty( $user ) ) {
653
			return new \WP_Error( 'user_not_found', 'Attempting to connect a non-existent user.' );
0 ignored issues
show
Unused Code introduced by
The call to WP_Error::__construct() has too many arguments starting with 'user_not_found'.

This check compares calls to functions or methods with their respective definitions. If the call has more arguments than are defined, it raises an issue.

If a function is defined several times with a different number of parameters, the check may pick up the wrong definition and report false positives. One codebase where this has been known to happen is Wordpress.

In this case you can add the @ignore PhpDoc annotation to the duplicate definition and it will be ignored.

Loading history...
654
		}
655
656
		if ( null === $redirect_url ) {
657
			$redirect_url = admin_url();
0 ignored issues
show
Unused Code introduced by
$redirect_url is not used, you could remove the assignment.

This check looks for variable assignements that are either overwritten by other assignments or where the variable is not used subsequently.

$myVar = 'Value';
$higher = false;

if (rand(1, 6) > 3) {
    $higher = true;
} else {
    $higher = false;
}

Both the $myVar assignment in line 1 and the $higher assignment in line 2 are dead. The first because $myVar is never used and the second because $higher is always overwritten for every possible time line.

Loading history...
658
		}
659
660
		// Using wp_redirect intentionally because we're redirecting outside.
661
		wp_redirect( $this->get_authorization_url( $user ) ); // phpcs:ignore WordPress.Security.SafeRedirect
662
		exit();
663
	}
664
665
	/**
666
	 * Unlinks the current user from the linked WordPress.com user.
667
	 *
668
	 * @access public
669
	 * @static
670
	 *
671
	 * @todo Refactor to properly load the XMLRPC client independently.
672
	 *
673
	 * @param Integer $user_id the user identifier.
0 ignored issues
show
Documentation introduced by
Should the type for parameter $user_id not be integer|null?

This check looks for @param annotations where the type inferred by our type inference engine differs from the declared type.

It makes a suggestion as to what type it considers more descriptive.

Most often this is a case of a parameter that can be null in addition to its declared types.

Loading history...
674
	 * @return Boolean Whether the disconnection of the user was successful.
675
	 */
676
	public static function disconnect_user( $user_id = null ) {
677
		$tokens = \Jetpack_Options::get_option( 'user_tokens' );
678
		if ( ! $tokens ) {
679
			return false;
680
		}
681
682
		$user_id = empty( $user_id ) ? get_current_user_id() : intval( $user_id );
683
684
		if ( \Jetpack_Options::get_option( 'master_user' ) === $user_id ) {
685
			return false;
686
		}
687
688
		if ( ! isset( $tokens[ $user_id ] ) ) {
689
			return false;
690
		}
691
692
		$xml = new \Jetpack_IXR_Client( compact( 'user_id' ) );
693
		$xml->query( 'jetpack.unlink_user', $user_id );
694
695
		unset( $tokens[ $user_id ] );
696
697
		\Jetpack_Options::update_option( 'user_tokens', $tokens );
698
699
		/**
700
		 * Fires after the current user has been unlinked from WordPress.com.
701
		 *
702
		 * @since 4.1.0
703
		 *
704
		 * @param int $user_id The current user's ID.
705
		 */
706
		do_action( 'jetpack_unlinked_user', $user_id );
707
708
		return true;
709
	}
710
711
	/**
712
	 * Returns the requested Jetpack API URL.
713
	 *
714
	 * @param String $relative_url the relative API path.
715
	 * @return String API URL.
716
	 */
717
	public function api_url( $relative_url ) {
718
		$api_base = Constants::get_constant( 'JETPACK__API_BASE' );
719
		$version  = Constants::get_constant( 'JETPACK__API_VERSION' );
720
721
		$api_base = $api_base ? $api_base : 'https://jetpack.wordpress.com/jetpack.';
722
		$version  = $version ? '/' . $version . '/' : '/1/';
723
724
		/**
725
		 * Filters the API URL that Jetpack uses for server communication.
726
		 *
727
		 * @since 8.0.0
728
		 *
729
		 * @param String $url the generated URL.
730
		 * @param String $relative_url the relative URL that was passed as an argument.
731
		 * @param String $api_base the API base string that is being used.
732
		 * @param String $version the version string that is being used.
733
		 */
734
		return apply_filters(
735
			'jetpack_api_url',
736
			rtrim( $api_base . $relative_url, '/\\' ) . $version,
737
			$relative_url,
738
			$api_base,
739
			$version
740
		);
741
	}
742
743
	/**
744
	 * Returns the Jetpack XMLRPC WordPress.com API endpoint URL.
745
	 *
746
	 * @return String XMLRPC API URL.
747
	 */
748
	public function xmlrpc_api_url() {
749
		$base = preg_replace(
750
			'#(https?://[^?/]+)(/?.*)?$#',
751
			'\\1',
752
			Constants::get_constant( 'JETPACK__API_BASE' )
753
		);
754
		return untrailingslashit( $base ) . '/xmlrpc.php';
755
	}
756
757
	/**
758
	 * Attempts Jetpack registration which sets up the site for connection. Should
759
	 * remain public because the call to action comes from the current site, not from
760
	 * WordPress.com.
761
	 *
762
	 * @param String $api_endpoint (optional) an API endpoint to use, defaults to 'register'.
763
	 * @return Integer zero on success, or a bitmask on failure.
764
	 */
765
	public function register( $api_endpoint = 'register' ) {
766
		add_action( 'pre_update_jetpack_option_register', array( '\\Jetpack_Options', 'delete_option' ) );
767
		$secrets = $this->generate_secrets( 'register', get_current_user_id(), 600 );
768
769
		if (
770
			empty( $secrets['secret_1'] ) ||
771
			empty( $secrets['secret_2'] ) ||
772
			empty( $secrets['exp'] )
773
		) {
774
			return new \WP_Error( 'missing_secrets' );
0 ignored issues
show
Unused Code introduced by
The call to WP_Error::__construct() has too many arguments starting with 'missing_secrets'.

This check compares calls to functions or methods with their respective definitions. If the call has more arguments than are defined, it raises an issue.

If a function is defined several times with a different number of parameters, the check may pick up the wrong definition and report false positives. One codebase where this has been known to happen is Wordpress.

In this case you can add the @ignore PhpDoc annotation to the duplicate definition and it will be ignored.

Loading history...
775
		}
776
777
		// Better to try (and fail) to set a higher timeout than this system
778
		// supports than to have register fail for more users than it should.
779
		$timeout = $this->set_min_time_limit( 60 ) / 2;
780
781
		$gmt_offset = get_option( 'gmt_offset' );
782
		if ( ! $gmt_offset ) {
783
			$gmt_offset = 0;
784
		}
785
786
		$stats_options = get_option( 'stats_options' );
787
		$stats_id      = isset( $stats_options['blog_id'] )
788
			? $stats_options['blog_id']
789
			: null;
790
791
		/**
792
		 * Filters the request body for additional property addition.
793
		 *
794
		 * @since 7.7.0
795
		 *
796
		 * @param Array $post_data request data.
797
		 * @param Array $token_data token data.
798
		 */
799
		$body = apply_filters(
800
			'jetpack_register_request_body',
801
			array(
802
				'siteurl'         => site_url(),
803
				'home'            => home_url(),
804
				'gmt_offset'      => $gmt_offset,
805
				'timezone_string' => (string) get_option( 'timezone_string' ),
806
				'site_name'       => (string) get_option( 'blogname' ),
807
				'secret_1'        => $secrets['secret_1'],
808
				'secret_2'        => $secrets['secret_2'],
809
				'site_lang'       => get_locale(),
810
				'timeout'         => $timeout,
811
				'stats_id'        => $stats_id,
812
				'state'           => get_current_user_id(),
813
				'site_created'    => $this->get_assumed_site_creation_date(),
814
				'jetpack_version' => Constants::get_constant( 'JETPACK__VERSION' ),
815
			)
816
		);
817
818
		$args = array(
819
			'method'  => 'POST',
820
			'body'    => $body,
821
			'headers' => array(
822
				'Accept' => 'application/json',
823
			),
824
			'timeout' => $timeout,
825
		);
826
827
		$args['body'] = $this->apply_activation_source_to_args( $args['body'] );
828
829
		// TODO: fix URLs for bad hosts.
830
		$response = Client::_wp_remote_request(
831
			$this->api_url( $api_endpoint ),
832
			$args,
833
			true
834
		);
835
836
		// Make sure the response is valid and does not contain any Jetpack errors.
837
		$registration_details = $this->validate_remote_register_response( $response );
838
839
		if ( is_wp_error( $registration_details ) ) {
840
			return $registration_details;
841
		} elseif ( ! $registration_details ) {
842
			return new \WP_Error(
843
				'unknown_error',
0 ignored issues
show
Unused Code introduced by
The call to WP_Error::__construct() has too many arguments starting with 'unknown_error'.

This check compares calls to functions or methods with their respective definitions. If the call has more arguments than are defined, it raises an issue.

If a function is defined several times with a different number of parameters, the check may pick up the wrong definition and report false positives. One codebase where this has been known to happen is Wordpress.

In this case you can add the @ignore PhpDoc annotation to the duplicate definition and it will be ignored.

Loading history...
844
				'Unknown error registering your Jetpack site.',
845
				wp_remote_retrieve_response_code( $response )
846
			);
847
		}
848
849
		if ( empty( $registration_details->jetpack_secret ) || ! is_string( $registration_details->jetpack_secret ) ) {
850
			return new \WP_Error(
851
				'jetpack_secret',
0 ignored issues
show
Unused Code introduced by
The call to WP_Error::__construct() has too many arguments starting with 'jetpack_secret'.

This check compares calls to functions or methods with their respective definitions. If the call has more arguments than are defined, it raises an issue.

If a function is defined several times with a different number of parameters, the check may pick up the wrong definition and report false positives. One codebase where this has been known to happen is Wordpress.

In this case you can add the @ignore PhpDoc annotation to the duplicate definition and it will be ignored.

Loading history...
852
				'Unable to validate registration of your Jetpack site.',
853
				wp_remote_retrieve_response_code( $response )
854
			);
855
		}
856
857
		if ( isset( $registration_details->jetpack_public ) ) {
858
			$jetpack_public = (int) $registration_details->jetpack_public;
859
		} else {
860
			$jetpack_public = false;
861
		}
862
863
		\Jetpack_Options::update_options(
864
			array(
865
				'id'         => (int) $registration_details->jetpack_id,
866
				'blog_token' => (string) $registration_details->jetpack_secret,
867
				'public'     => $jetpack_public,
868
			)
869
		);
870
871
		/**
872
		 * Fires when a site is registered on WordPress.com.
873
		 *
874
		 * @since 3.7.0
875
		 *
876
		 * @param int $json->jetpack_id Jetpack Blog ID.
877
		 * @param string $json->jetpack_secret Jetpack Blog Token.
878
		 * @param int|bool $jetpack_public Is the site public.
879
		 */
880
		do_action(
881
			'jetpack_site_registered',
882
			$registration_details->jetpack_id,
883
			$registration_details->jetpack_secret,
884
			$jetpack_public
885
		);
886
887
		if ( isset( $registration_details->token ) ) {
888
			/**
889
			 * Fires when a user token is sent along with the registration data.
890
			 *
891
			 * @since 7.6.0
892
			 *
893
			 * @param object $token the administrator token for the newly registered site.
894
			 */
895
			do_action( 'jetpack_site_registered_user_token', $registration_details->token );
896
		}
897
898
		return true;
899
	}
900
901
	/**
902
	 * Takes the response from the Jetpack register new site endpoint and
903
	 * verifies it worked properly.
904
	 *
905
	 * @since 2.6
906
	 *
907
	 * @param Mixed $response the response object, or the error object.
908
	 * @return string|WP_Error A JSON object on success or Jetpack_Error on failures
909
	 **/
910
	protected function validate_remote_register_response( $response ) {
911
		if ( is_wp_error( $response ) ) {
912
			return new \WP_Error(
913
				'register_http_request_failed',
0 ignored issues
show
Unused Code introduced by
The call to WP_Error::__construct() has too many arguments starting with 'register_http_request_failed'.

This check compares calls to functions or methods with their respective definitions. If the call has more arguments than are defined, it raises an issue.

If a function is defined several times with a different number of parameters, the check may pick up the wrong definition and report false positives. One codebase where this has been known to happen is Wordpress.

In this case you can add the @ignore PhpDoc annotation to the duplicate definition and it will be ignored.

Loading history...
914
				$response->get_error_message()
915
			);
916
		}
917
918
		$code   = wp_remote_retrieve_response_code( $response );
919
		$entity = wp_remote_retrieve_body( $response );
920
921
		if ( $entity ) {
922
			$registration_response = json_decode( $entity );
923
		} else {
924
			$registration_response = false;
925
		}
926
927
		$code_type = intval( $code / 100 );
928
		if ( 5 === $code_type ) {
929
			return new \WP_Error( 'wpcom_5??', $code );
0 ignored issues
show
Unused Code introduced by
The call to WP_Error::__construct() has too many arguments starting with 'wpcom_5??'.

This check compares calls to functions or methods with their respective definitions. If the call has more arguments than are defined, it raises an issue.

If a function is defined several times with a different number of parameters, the check may pick up the wrong definition and report false positives. One codebase where this has been known to happen is Wordpress.

In this case you can add the @ignore PhpDoc annotation to the duplicate definition and it will be ignored.

Loading history...
930
		} elseif ( 408 === $code ) {
931
			return new \WP_Error( 'wpcom_408', $code );
0 ignored issues
show
Unused Code introduced by
The call to WP_Error::__construct() has too many arguments starting with 'wpcom_408'.

This check compares calls to functions or methods with their respective definitions. If the call has more arguments than are defined, it raises an issue.

If a function is defined several times with a different number of parameters, the check may pick up the wrong definition and report false positives. One codebase where this has been known to happen is Wordpress.

In this case you can add the @ignore PhpDoc annotation to the duplicate definition and it will be ignored.

Loading history...
932
		} elseif ( ! empty( $registration_response->error ) ) {
933
			if (
934
				'xml_rpc-32700' === $registration_response->error
935
				&& ! function_exists( 'xml_parser_create' )
936
			) {
937
				$error_description = __( "PHP's XML extension is not available. Jetpack requires the XML extension to communicate with WordPress.com. Please contact your hosting provider to enable PHP's XML extension.", 'jetpack' );
938
			} else {
939
				$error_description = isset( $registration_response->error_description )
940
					? (string) $registration_response->error_description
941
					: '';
942
			}
943
944
			return new \WP_Error(
945
				(string) $registration_response->error,
0 ignored issues
show
Unused Code introduced by
The call to WP_Error::__construct() has too many arguments starting with (string) $registration_response->error.

This check compares calls to functions or methods with their respective definitions. If the call has more arguments than are defined, it raises an issue.

If a function is defined several times with a different number of parameters, the check may pick up the wrong definition and report false positives. One codebase where this has been known to happen is Wordpress.

In this case you can add the @ignore PhpDoc annotation to the duplicate definition and it will be ignored.

Loading history...
946
				$error_description,
947
				$code
948
			);
949
		} elseif ( 200 !== $code ) {
950
			return new \WP_Error( 'wpcom_bad_response', $code );
0 ignored issues
show
Unused Code introduced by
The call to WP_Error::__construct() has too many arguments starting with 'wpcom_bad_response'.

This check compares calls to functions or methods with their respective definitions. If the call has more arguments than are defined, it raises an issue.

If a function is defined several times with a different number of parameters, the check may pick up the wrong definition and report false positives. One codebase where this has been known to happen is Wordpress.

In this case you can add the @ignore PhpDoc annotation to the duplicate definition and it will be ignored.

Loading history...
951
		}
952
953
		// Jetpack ID error block.
954
		if ( empty( $registration_response->jetpack_id ) ) {
955
			return new \WP_Error(
956
				'jetpack_id',
0 ignored issues
show
Unused Code introduced by
The call to WP_Error::__construct() has too many arguments starting with 'jetpack_id'.

This check compares calls to functions or methods with their respective definitions. If the call has more arguments than are defined, it raises an issue.

If a function is defined several times with a different number of parameters, the check may pick up the wrong definition and report false positives. One codebase where this has been known to happen is Wordpress.

In this case you can add the @ignore PhpDoc annotation to the duplicate definition and it will be ignored.

Loading history...
957
				/* translators: %s is an error message string */
958
				sprintf( __( 'Error Details: Jetpack ID is empty. Do not publicly post this error message! %s', 'jetpack' ), $entity ),
959
				$entity
960
			);
961
		} elseif ( ! is_scalar( $registration_response->jetpack_id ) ) {
962
			return new \WP_Error(
963
				'jetpack_id',
0 ignored issues
show
Unused Code introduced by
The call to WP_Error::__construct() has too many arguments starting with 'jetpack_id'.

This check compares calls to functions or methods with their respective definitions. If the call has more arguments than are defined, it raises an issue.

If a function is defined several times with a different number of parameters, the check may pick up the wrong definition and report false positives. One codebase where this has been known to happen is Wordpress.

In this case you can add the @ignore PhpDoc annotation to the duplicate definition and it will be ignored.

Loading history...
964
				/* translators: %s is an error message string */
965
				sprintf( __( 'Error Details: Jetpack ID is not a scalar. Do not publicly post this error message! %s', 'jetpack' ), $entity ),
966
				$entity
967
			);
968 View Code Duplication
		} elseif ( preg_match( '/[^0-9]/', $registration_response->jetpack_id ) ) {
969
			return new \WP_Error(
970
				'jetpack_id',
0 ignored issues
show
Unused Code introduced by
The call to WP_Error::__construct() has too many arguments starting with 'jetpack_id'.

This check compares calls to functions or methods with their respective definitions. If the call has more arguments than are defined, it raises an issue.

If a function is defined several times with a different number of parameters, the check may pick up the wrong definition and report false positives. One codebase where this has been known to happen is Wordpress.

In this case you can add the @ignore PhpDoc annotation to the duplicate definition and it will be ignored.

Loading history...
971
				/* translators: %s is an error message string */
972
				sprintf( __( 'Error Details: Jetpack ID begins with a numeral. Do not publicly post this error message! %s', 'jetpack' ), $entity ),
973
				$entity
974
			);
975
		}
976
977
		return $registration_response;
978
	}
979
980
	/**
981
	 * Adds a used nonce to a list of known nonces.
982
	 *
983
	 * @param int    $timestamp the current request timestamp.
984
	 * @param string $nonce the nonce value.
985
	 * @return bool whether the nonce is unique or not.
986
	 */
987
	public function add_nonce( $timestamp, $nonce ) {
988
		global $wpdb;
989
		static $nonces_used_this_request = array();
990
991
		if ( isset( $nonces_used_this_request[ "$timestamp:$nonce" ] ) ) {
992
			return $nonces_used_this_request[ "$timestamp:$nonce" ];
993
		}
994
995
		// This should always have gone through Jetpack_Signature::sign_request() first to check $timestamp an $nonce.
996
		$timestamp = (int) $timestamp;
997
		$nonce     = esc_sql( $nonce );
998
999
		// Raw query so we can avoid races: add_option will also update.
1000
		$show_errors = $wpdb->show_errors( false );
1001
1002
		$old_nonce = $wpdb->get_row(
1003
			$wpdb->prepare( "SELECT * FROM `$wpdb->options` WHERE option_name = %s", "jetpack_nonce_{$timestamp}_{$nonce}" )
1004
		);
1005
1006
		if ( is_null( $old_nonce ) ) {
1007
			$return = $wpdb->query(
1008
				$wpdb->prepare(
1009
					"INSERT INTO `$wpdb->options` (`option_name`, `option_value`, `autoload`) VALUES (%s, %s, %s)",
1010
					"jetpack_nonce_{$timestamp}_{$nonce}",
1011
					time(),
1012
					'no'
1013
				)
1014
			);
1015
		} else {
1016
			$return = false;
1017
		}
1018
1019
		$wpdb->show_errors( $show_errors );
1020
1021
		$nonces_used_this_request[ "$timestamp:$nonce" ] = $return;
1022
1023
		return $return;
1024
	}
1025
1026
	/**
1027
	 * Cleans nonces that were saved when calling ::add_nonce.
1028
	 *
1029
	 * @todo Properly prepare the query before executing it.
1030
	 *
1031
	 * @param bool $all whether to clean even non-expired nonces.
1032
	 */
1033
	public function clean_nonces( $all = false ) {
1034
		global $wpdb;
1035
1036
		$sql      = "DELETE FROM `$wpdb->options` WHERE `option_name` LIKE %s";
1037
		$sql_args = array( $wpdb->esc_like( 'jetpack_nonce_' ) . '%' );
1038
1039
		if ( true !== $all ) {
1040
			$sql       .= ' AND CAST( `option_value` AS UNSIGNED ) < %d';
1041
			$sql_args[] = time() - 3600;
1042
		}
1043
1044
		$sql .= ' ORDER BY `option_id` LIMIT 100';
1045
1046
		$sql = $wpdb->prepare( $sql, $sql_args ); // phpcs:ignore WordPress.DB.PreparedSQL.NotPrepared
1047
1048
		for ( $i = 0; $i < 1000; $i++ ) {
1049
			if ( ! $wpdb->query( $sql ) ) { // phpcs:ignore WordPress.DB.PreparedSQL.NotPrepared
1050
				break;
1051
			}
1052
		}
1053
	}
1054
1055
	/**
1056
	 * Builds the timeout limit for queries talking with the wpcom servers.
1057
	 *
1058
	 * Based on local php max_execution_time in php.ini
1059
	 *
1060
	 * @since 5.4
1061
	 * @return int
1062
	 **/
1063
	public function get_max_execution_time() {
1064
		$timeout = (int) ini_get( 'max_execution_time' );
1065
1066
		// Ensure exec time set in php.ini.
1067
		if ( ! $timeout ) {
1068
			$timeout = 30;
1069
		}
1070
		return $timeout;
1071
	}
1072
1073
	/**
1074
	 * Sets a minimum request timeout, and returns the current timeout
1075
	 *
1076
	 * @since 5.4
1077
	 * @param Integer $min_timeout the minimum timeout value.
1078
	 **/
1079 View Code Duplication
	public function set_min_time_limit( $min_timeout ) {
1080
		$timeout = $this->get_max_execution_time();
1081
		if ( $timeout < $min_timeout ) {
1082
			$timeout = $min_timeout;
1083
			set_time_limit( $timeout );
1084
		}
1085
		return $timeout;
1086
	}
1087
1088
	/**
1089
	 * Get our assumed site creation date.
1090
	 * Calculated based on the earlier date of either:
1091
	 * - Earliest admin user registration date.
1092
	 * - Earliest date of post of any post type.
1093
	 *
1094
	 * @since 7.2.0
1095
	 *
1096
	 * @return string Assumed site creation date and time.
1097
	 */
1098
	public function get_assumed_site_creation_date() {
1099
		$cached_date = get_transient( 'jetpack_assumed_site_creation_date' );
1100
		if ( ! empty( $cached_date ) ) {
1101
			return $cached_date;
1102
		}
1103
1104
		$earliest_registered_users  = get_users(
1105
			array(
1106
				'role'    => 'administrator',
1107
				'orderby' => 'user_registered',
1108
				'order'   => 'ASC',
1109
				'fields'  => array( 'user_registered' ),
1110
				'number'  => 1,
1111
			)
1112
		);
1113
		$earliest_registration_date = $earliest_registered_users[0]->user_registered;
1114
1115
		$earliest_posts = get_posts(
1116
			array(
1117
				'posts_per_page' => 1,
1118
				'post_type'      => 'any',
1119
				'post_status'    => 'any',
1120
				'orderby'        => 'date',
1121
				'order'          => 'ASC',
1122
			)
1123
		);
1124
1125
		// If there are no posts at all, we'll count only on user registration date.
1126
		if ( $earliest_posts ) {
1127
			$earliest_post_date = $earliest_posts[0]->post_date;
1128
		} else {
1129
			$earliest_post_date = PHP_INT_MAX;
1130
		}
1131
1132
		$assumed_date = min( $earliest_registration_date, $earliest_post_date );
1133
		set_transient( 'jetpack_assumed_site_creation_date', $assumed_date );
1134
1135
		return $assumed_date;
1136
	}
1137
1138
	/**
1139
	 * Adds the activation source string as a parameter to passed arguments.
1140
	 *
1141
	 * @todo Refactor to use rawurlencode() instead of urlencode().
1142
	 *
1143
	 * @param Array $args arguments that need to have the source added.
1144
	 * @return Array $amended arguments.
1145
	 */
1146 View Code Duplication
	public static function apply_activation_source_to_args( $args ) {
1147
		list( $activation_source_name, $activation_source_keyword ) = get_option( 'jetpack_activation_source' );
1148
1149
		if ( $activation_source_name ) {
1150
			// phpcs:ignore WordPress.PHP.DiscouragedPHPFunctions.urlencode_urlencode
1151
			$args['_as'] = urlencode( $activation_source_name );
1152
		}
1153
1154
		if ( $activation_source_keyword ) {
1155
			// phpcs:ignore WordPress.PHP.DiscouragedPHPFunctions.urlencode_urlencode
1156
			$args['_ak'] = urlencode( $activation_source_keyword );
1157
		}
1158
1159
		return $args;
1160
	}
1161
1162
	/**
1163
	 * Returns the callable that would be used to generate secrets.
1164
	 *
1165
	 * @return Callable a function that returns a secure string to be used as a secret.
1166
	 */
1167
	protected function get_secret_callable() {
1168
		if ( ! isset( $this->secret_callable ) ) {
1169
			/**
1170
			 * Allows modification of the callable that is used to generate connection secrets.
1171
			 *
1172
			 * @param Callable a function or method that returns a secret string.
1173
			 */
1174
			$this->secret_callable = apply_filters( 'jetpack_connection_secret_generator', 'wp_generate_password' );
1175
		}
1176
1177
		return $this->secret_callable;
1178
	}
1179
1180
	/**
1181
	 * Generates two secret tokens and the end of life timestamp for them.
1182
	 *
1183
	 * @param String  $action  The action name.
1184
	 * @param Integer $user_id The user identifier.
0 ignored issues
show
Documentation introduced by
Should the type for parameter $user_id not be false|integer?

This check looks for @param annotations where the type inferred by our type inference engine differs from the declared type.

It makes a suggestion as to what type it considers more descriptive.

Most often this is a case of a parameter that can be null in addition to its declared types.

Loading history...
1185
	 * @param Integer $exp     Expiration time in seconds.
1186
	 */
1187
	public function generate_secrets( $action, $user_id = false, $exp = 600 ) {
1188
		if ( false === $user_id ) {
1189
			$user_id = get_current_user_id();
1190
		}
1191
1192
		$callable = $this->get_secret_callable();
1193
1194
		$secrets = \Jetpack_Options::get_raw_option(
1195
			self::SECRETS_OPTION_NAME,
1196
			array()
1197
		);
1198
1199
		$secret_name = 'jetpack_' . $action . '_' . $user_id;
1200
1201
		if (
1202
			isset( $secrets[ $secret_name ] ) &&
1203
			$secrets[ $secret_name ]['exp'] > time()
1204
		) {
1205
			return $secrets[ $secret_name ];
1206
		}
1207
1208
		$secret_value = array(
1209
			'secret_1' => call_user_func( $callable ),
1210
			'secret_2' => call_user_func( $callable ),
1211
			'exp'      => time() + $exp,
1212
		);
1213
1214
		$secrets[ $secret_name ] = $secret_value;
1215
1216
		\Jetpack_Options::update_raw_option( self::SECRETS_OPTION_NAME, $secrets );
1217
		return $secrets[ $secret_name ];
1218
	}
1219
1220
	/**
1221
	 * Returns two secret tokens and the end of life timestamp for them.
1222
	 *
1223
	 * @param String  $action  The action name.
1224
	 * @param Integer $user_id The user identifier.
1225
	 * @return string|array an array of secrets or an error string.
1226
	 */
1227
	public function get_secrets( $action, $user_id ) {
1228
		$secret_name = 'jetpack_' . $action . '_' . $user_id;
1229
		$secrets     = \Jetpack_Options::get_raw_option(
1230
			self::SECRETS_OPTION_NAME,
1231
			array()
1232
		);
1233
1234
		if ( ! isset( $secrets[ $secret_name ] ) ) {
1235
			return self::SECRETS_MISSING;
1236
		}
1237
1238
		if ( $secrets[ $secret_name ]['exp'] < time() ) {
1239
			$this->delete_secrets( $action, $user_id );
1240
			return self::SECRETS_EXPIRED;
1241
		}
1242
1243
		return $secrets[ $secret_name ];
1244
	}
1245
1246
	/**
1247
	 * Deletes secret tokens in case they, for example, have expired.
1248
	 *
1249
	 * @param String  $action  The action name.
1250
	 * @param Integer $user_id The user identifier.
1251
	 */
1252
	public function delete_secrets( $action, $user_id ) {
1253
		$secret_name = 'jetpack_' . $action . '_' . $user_id;
1254
		$secrets     = \Jetpack_Options::get_raw_option(
1255
			self::SECRETS_OPTION_NAME,
1256
			array()
1257
		);
1258
		if ( isset( $secrets[ $secret_name ] ) ) {
1259
			unset( $secrets[ $secret_name ] );
1260
			\Jetpack_Options::update_raw_option( self::SECRETS_OPTION_NAME, $secrets );
1261
		}
1262
	}
1263
1264
	/**
1265
	 * Deletes all connection tokens and transients from the local Jetpack site.
1266
	 */
1267
	public function delete_all_connection_tokens() {
1268
		\Jetpack_Options::delete_option(
1269
			array(
1270
				'blog_token',
1271
				'user_token',
1272
				'user_tokens',
1273
				'master_user',
1274
				'time_diff',
1275
				'fallback_no_verify_ssl_certs',
1276
			)
1277
		);
1278
1279
		\Jetpack_Options::delete_raw_option( 'jetpack_secrets' );
1280
1281
		// Delete cached connected user data.
1282
		$transient_key = 'jetpack_connected_user_data_' . get_current_user_id();
1283
		delete_transient( $transient_key );
1284
	}
1285
1286
	/**
1287
	 * Tells WordPress.com to disconnect the site and clear all tokens from cached site.
1288
	 */
1289
	public function disconnect_site_wpcom() {
1290
		$xml = new \Jetpack_IXR_Client();
1291
		$xml->query( 'jetpack.deregister', get_current_user_id() );
1292
	}
1293
1294
	/**
1295
	 * Responds to a WordPress.com call to register the current site.
1296
	 * Should be changed to protected.
1297
	 *
1298
	 * @param array $registration_data Array of [ secret_1, user_id ].
1299
	 */
1300
	public function handle_registration( array $registration_data ) {
1301
		list( $registration_secret_1, $registration_user_id ) = $registration_data;
1302
		if ( empty( $registration_user_id ) ) {
1303
			return new \WP_Error( 'registration_state_invalid', __( 'Invalid Registration State', 'jetpack' ), 400 );
0 ignored issues
show
Unused Code introduced by
The call to WP_Error::__construct() has too many arguments starting with 'registration_state_invalid'.

This check compares calls to functions or methods with their respective definitions. If the call has more arguments than are defined, it raises an issue.

If a function is defined several times with a different number of parameters, the check may pick up the wrong definition and report false positives. One codebase where this has been known to happen is Wordpress.

In this case you can add the @ignore PhpDoc annotation to the duplicate definition and it will be ignored.

Loading history...
1304
		}
1305
1306
		return $this->verify_secrets( 'register', $registration_secret_1, (int) $registration_user_id );
1307
	}
1308
1309
	/**
1310
	 * Verify a Previously Generated Secret.
1311
	 *
1312
	 * @param string $action   The type of secret to verify.
1313
	 * @param string $secret_1 The secret string to compare to what is stored.
1314
	 * @param int    $user_id  The user ID of the owner of the secret.
1315
	 * @return \WP_Error|string WP_Error on failure, secret_2 on success.
1316
	 */
1317
	public function verify_secrets( $action, $secret_1, $user_id ) {
1318
		$allowed_actions = array( 'register', 'authorize', 'publicize' );
1319
		if ( ! in_array( $action, $allowed_actions, true ) ) {
1320
			return new \WP_Error( 'unknown_verification_action', 'Unknown Verification Action', 400 );
0 ignored issues
show
Unused Code introduced by
The call to WP_Error::__construct() has too many arguments starting with 'unknown_verification_action'.

This check compares calls to functions or methods with their respective definitions. If the call has more arguments than are defined, it raises an issue.

If a function is defined several times with a different number of parameters, the check may pick up the wrong definition and report false positives. One codebase where this has been known to happen is Wordpress.

In this case you can add the @ignore PhpDoc annotation to the duplicate definition and it will be ignored.

Loading history...
1321
		}
1322
1323
		$user = get_user_by( 'id', $user_id );
1324
1325
		/**
1326
		 * We've begun verifying the previously generated secret.
1327
		 *
1328
		 * @since 7.5.0
1329
		 *
1330
		 * @param string   $action The type of secret to verify.
1331
		 * @param \WP_User $user The user object.
1332
		 */
1333
		do_action( 'jetpack_verify_secrets_begin', $action, $user );
1334
1335
		$return_error = function( \WP_Error $error ) use ( $action, $user ) {
1336
			/**
1337
			 * Verifying of the previously generated secret has failed.
1338
			 *
1339
			 * @since 7.5.0
1340
			 *
1341
			 * @param string    $action  The type of secret to verify.
1342
			 * @param \WP_User  $user The user object.
1343
			 * @param \WP_Error $error The error object.
1344
			 */
1345
			do_action( 'jetpack_verify_secrets_fail', $action, $user, $error );
1346
1347
			return $error;
1348
		};
1349
1350
		$stored_secrets = $this->get_secrets( $action, $user_id );
1351
		$this->delete_secrets( $action, $user_id );
1352
1353
		$error = null;
1354
		if ( empty( $secret_1 ) ) {
1355
			$error = $return_error(
1356
				new \WP_Error(
1357
					'verify_secret_1_missing',
0 ignored issues
show
Unused Code introduced by
The call to WP_Error::__construct() has too many arguments starting with 'verify_secret_1_missing'.

This check compares calls to functions or methods with their respective definitions. If the call has more arguments than are defined, it raises an issue.

If a function is defined several times with a different number of parameters, the check may pick up the wrong definition and report false positives. One codebase where this has been known to happen is Wordpress.

In this case you can add the @ignore PhpDoc annotation to the duplicate definition and it will be ignored.

Loading history...
1358
					/* translators: "%s" is the name of a paramter. It can be either "secret_1" or "state". */
1359
					sprintf( __( 'The required "%s" parameter is missing.', 'jetpack' ), 'secret_1' ),
1360
					400
1361
				)
1362
			);
1363
		} elseif ( ! is_string( $secret_1 ) ) {
1364
			$error = $return_error(
1365
				new \WP_Error(
1366
					'verify_secret_1_malformed',
0 ignored issues
show
Unused Code introduced by
The call to WP_Error::__construct() has too many arguments starting with 'verify_secret_1_malformed'.

This check compares calls to functions or methods with their respective definitions. If the call has more arguments than are defined, it raises an issue.

If a function is defined several times with a different number of parameters, the check may pick up the wrong definition and report false positives. One codebase where this has been known to happen is Wordpress.

In this case you can add the @ignore PhpDoc annotation to the duplicate definition and it will be ignored.

Loading history...
1367
					/* translators: "%s" is the name of a paramter. It can be either "secret_1" or "state". */
1368
					sprintf( __( 'The required "%s" parameter is malformed.', 'jetpack' ), 'secret_1' ),
1369
					400
1370
				)
1371
			);
1372
		} elseif ( empty( $user_id ) ) {
1373
			// $user_id is passed around during registration as "state".
1374
			$error = $return_error(
1375
				new \WP_Error(
1376
					'state_missing',
0 ignored issues
show
Unused Code introduced by
The call to WP_Error::__construct() has too many arguments starting with 'state_missing'.

This check compares calls to functions or methods with their respective definitions. If the call has more arguments than are defined, it raises an issue.

If a function is defined several times with a different number of parameters, the check may pick up the wrong definition and report false positives. One codebase where this has been known to happen is Wordpress.

In this case you can add the @ignore PhpDoc annotation to the duplicate definition and it will be ignored.

Loading history...
1377
					/* translators: "%s" is the name of a paramter. It can be either "secret_1" or "state". */
1378
					sprintf( __( 'The required "%s" parameter is missing.', 'jetpack' ), 'state' ),
1379
					400
1380
				)
1381
			);
1382
		} elseif ( ! ctype_digit( (string) $user_id ) ) {
1383
			$error = $return_error(
1384
				new \WP_Error(
1385
					'state_malformed',
0 ignored issues
show
Unused Code introduced by
The call to WP_Error::__construct() has too many arguments starting with 'state_malformed'.

This check compares calls to functions or methods with their respective definitions. If the call has more arguments than are defined, it raises an issue.

If a function is defined several times with a different number of parameters, the check may pick up the wrong definition and report false positives. One codebase where this has been known to happen is Wordpress.

In this case you can add the @ignore PhpDoc annotation to the duplicate definition and it will be ignored.

Loading history...
1386
					/* translators: "%s" is the name of a paramter. It can be either "secret_1" or "state". */
1387
					sprintf( __( 'The required "%s" parameter is malformed.', 'jetpack' ), 'state' ),
1388
					400
1389
				)
1390
			);
1391
		} elseif ( self::SECRETS_MISSING === $stored_secrets ) {
1392
			$error = $return_error(
1393
				new \WP_Error(
1394
					'verify_secrets_missing',
0 ignored issues
show
Unused Code introduced by
The call to WP_Error::__construct() has too many arguments starting with 'verify_secrets_missing'.

This check compares calls to functions or methods with their respective definitions. If the call has more arguments than are defined, it raises an issue.

If a function is defined several times with a different number of parameters, the check may pick up the wrong definition and report false positives. One codebase where this has been known to happen is Wordpress.

In this case you can add the @ignore PhpDoc annotation to the duplicate definition and it will be ignored.

Loading history...
1395
					__( 'Verification secrets not found', 'jetpack' ),
1396
					400
1397
				)
1398
			);
1399
		} elseif ( self::SECRETS_EXPIRED === $stored_secrets ) {
1400
			$error = $return_error(
1401
				new \WP_Error(
1402
					'verify_secrets_expired',
0 ignored issues
show
Unused Code introduced by
The call to WP_Error::__construct() has too many arguments starting with 'verify_secrets_expired'.

This check compares calls to functions or methods with their respective definitions. If the call has more arguments than are defined, it raises an issue.

If a function is defined several times with a different number of parameters, the check may pick up the wrong definition and report false positives. One codebase where this has been known to happen is Wordpress.

In this case you can add the @ignore PhpDoc annotation to the duplicate definition and it will be ignored.

Loading history...
1403
					__( 'Verification took too long', 'jetpack' ),
1404
					400
1405
				)
1406
			);
1407
		} elseif ( ! $stored_secrets ) {
1408
			$error = $return_error(
1409
				new \WP_Error(
1410
					'verify_secrets_empty',
0 ignored issues
show
Unused Code introduced by
The call to WP_Error::__construct() has too many arguments starting with 'verify_secrets_empty'.

This check compares calls to functions or methods with their respective definitions. If the call has more arguments than are defined, it raises an issue.

If a function is defined several times with a different number of parameters, the check may pick up the wrong definition and report false positives. One codebase where this has been known to happen is Wordpress.

In this case you can add the @ignore PhpDoc annotation to the duplicate definition and it will be ignored.

Loading history...
1411
					__( 'Verification secrets are empty', 'jetpack' ),
1412
					400
1413
				)
1414
			);
1415
		} elseif ( is_wp_error( $stored_secrets ) ) {
1416
			$stored_secrets->add_data( 400 );
0 ignored issues
show
Bug introduced by
The method add_data cannot be called on $stored_secrets (of type string|array).

Methods can only be called on objects. This check looks for methods being called on variables that have been inferred to never be objects.

Loading history...
1417
			$error = $return_error( $stored_secrets );
1418
		} elseif ( empty( $stored_secrets['secret_1'] ) || empty( $stored_secrets['secret_2'] ) || empty( $stored_secrets['exp'] ) ) {
1419
			$error = $return_error(
1420
				new \WP_Error(
1421
					'verify_secrets_incomplete',
0 ignored issues
show
Unused Code introduced by
The call to WP_Error::__construct() has too many arguments starting with 'verify_secrets_incomplete'.

This check compares calls to functions or methods with their respective definitions. If the call has more arguments than are defined, it raises an issue.

If a function is defined several times with a different number of parameters, the check may pick up the wrong definition and report false positives. One codebase where this has been known to happen is Wordpress.

In this case you can add the @ignore PhpDoc annotation to the duplicate definition and it will be ignored.

Loading history...
1422
					__( 'Verification secrets are incomplete', 'jetpack' ),
1423
					400
1424
				)
1425
			);
1426
		} elseif ( ! hash_equals( $secret_1, $stored_secrets['secret_1'] ) ) {
1427
			$error = $return_error(
1428
				new \WP_Error(
1429
					'verify_secrets_mismatch',
0 ignored issues
show
Unused Code introduced by
The call to WP_Error::__construct() has too many arguments starting with 'verify_secrets_mismatch'.

This check compares calls to functions or methods with their respective definitions. If the call has more arguments than are defined, it raises an issue.

If a function is defined several times with a different number of parameters, the check may pick up the wrong definition and report false positives. One codebase where this has been known to happen is Wordpress.

In this case you can add the @ignore PhpDoc annotation to the duplicate definition and it will be ignored.

Loading history...
1430
					__( 'Secret mismatch', 'jetpack' ),
1431
					400
1432
				)
1433
			);
1434
		}
1435
1436
		// Something went wrong during the checks, returning the error.
1437
		if ( ! empty( $error ) ) {
1438
			return $error;
1439
		}
1440
1441
		/**
1442
		 * We've succeeded at verifying the previously generated secret.
1443
		 *
1444
		 * @since 7.5.0
1445
		 *
1446
		 * @param string   $action The type of secret to verify.
1447
		 * @param \WP_User $user The user object.
1448
		 */
1449
		do_action( 'jetpack_verify_secrets_success', $action, $user );
1450
1451
		return $stored_secrets['secret_2'];
1452
	}
1453
1454
	/**
1455
	 * Responds to a WordPress.com call to authorize the current user.
1456
	 * Should be changed to protected.
1457
	 */
1458
	public function handle_authorization() {
1459
1460
	}
1461
1462
	/**
1463
	 * Obtains the auth token.
1464
	 *
1465
	 * @param array $data The request data.
1466
	 * @return object|\WP_Error Returns the auth token on success.
1467
	 *                          Returns a \WP_Error on failure.
1468
	 */
1469
	public function get_token( $data ) {
1470
		$roles = new Roles();
1471
		$role  = $roles->translate_current_user_to_role();
1472
1473
		if ( ! $role ) {
1474
			return new \WP_Error( 'role', __( 'An administrator for this blog must set up the Jetpack connection.', 'jetpack' ) );
0 ignored issues
show
Unused Code introduced by
The call to WP_Error::__construct() has too many arguments starting with 'role'.

This check compares calls to functions or methods with their respective definitions. If the call has more arguments than are defined, it raises an issue.

If a function is defined several times with a different number of parameters, the check may pick up the wrong definition and report false positives. One codebase where this has been known to happen is Wordpress.

In this case you can add the @ignore PhpDoc annotation to the duplicate definition and it will be ignored.

Loading history...
1475
		}
1476
1477
		$client_secret = $this->get_access_token();
1478
		if ( ! $client_secret ) {
1479
			return new \WP_Error( 'client_secret', __( 'You need to register your Jetpack before connecting it.', 'jetpack' ) );
0 ignored issues
show
Unused Code introduced by
The call to WP_Error::__construct() has too many arguments starting with 'client_secret'.

This check compares calls to functions or methods with their respective definitions. If the call has more arguments than are defined, it raises an issue.

If a function is defined several times with a different number of parameters, the check may pick up the wrong definition and report false positives. One codebase where this has been known to happen is Wordpress.

In this case you can add the @ignore PhpDoc annotation to the duplicate definition and it will be ignored.

Loading history...
1480
		}
1481
1482
		/**
1483
		 * Filter the URL of the first time the user gets redirected back to your site for connection
1484
		 * data processing.
1485
		 *
1486
		 * @since 8.0.0
1487
		 *
1488
		 * @param string $redirect_url Defaults to the site admin URL.
1489
		 */
1490
		$processing_url = apply_filters( 'jetpack_token_processing_url', admin_url( 'admin.php' ) );
1491
1492
		$redirect = isset( $data['redirect'] ) ? esc_url_raw( (string) $data['redirect'] ) : '';
1493
1494
		/**
1495
		* Filter the URL to redirect the user back to when the authentication process
1496
		* is complete.
1497
		*
1498
		* @since 8.0.0
1499
		*
1500
		* @param string $redirect_url Defaults to the site URL.
1501
		*/
1502
		$redirect = apply_filters( 'jetpack_token_redirect_url', $redirect );
1503
1504
		$redirect_uri = ( 'calypso' === $data['auth_type'] )
1505
			? $data['redirect_uri']
1506
			: add_query_arg(
1507
				array(
1508
					'action'   => 'authorize',
1509
					'_wpnonce' => wp_create_nonce( "jetpack-authorize_{$role}_{$redirect}" ),
1510
					'redirect' => $redirect ? rawurlencode( $redirect ) : false,
1511
				),
1512
				esc_url( $processing_url )
1513
			);
1514
1515
		/**
1516
		 * Filters the token request data.
1517
		 *
1518
		 * @since 8.0.0
1519
		 *
1520
		 * @param Array $request_data request data.
1521
		 */
1522
		$body = apply_filters(
1523
			'jetpack_token_request_body',
1524
			array(
1525
				'client_id'     => \Jetpack_Options::get_option( 'id' ),
1526
				'client_secret' => $client_secret->secret,
1527
				'grant_type'    => 'authorization_code',
1528
				'code'          => $data['code'],
1529
				'redirect_uri'  => $redirect_uri,
1530
			)
1531
		);
1532
1533
		$args = array(
1534
			'method'  => 'POST',
1535
			'body'    => $body,
1536
			'headers' => array(
1537
				'Accept' => 'application/json',
1538
			),
1539
		);
1540
1541
		$response = Client::_wp_remote_request( Utils::fix_url_for_bad_hosts( $this->api_url( 'token' ) ), $args );
1542
1543
		if ( is_wp_error( $response ) ) {
1544
			return new \WP_Error( 'token_http_request_failed', $response->get_error_message() );
0 ignored issues
show
Unused Code introduced by
The call to WP_Error::__construct() has too many arguments starting with 'token_http_request_failed'.

This check compares calls to functions or methods with their respective definitions. If the call has more arguments than are defined, it raises an issue.

If a function is defined several times with a different number of parameters, the check may pick up the wrong definition and report false positives. One codebase where this has been known to happen is Wordpress.

In this case you can add the @ignore PhpDoc annotation to the duplicate definition and it will be ignored.

Loading history...
1545
		}
1546
1547
		$code   = wp_remote_retrieve_response_code( $response );
1548
		$entity = wp_remote_retrieve_body( $response );
1549
1550
		if ( $entity ) {
1551
			$json = json_decode( $entity );
1552
		} else {
1553
			$json = false;
1554
		}
1555
1556
		if ( 200 !== $code || ! empty( $json->error ) ) {
1557
			if ( empty( $json->error ) ) {
1558
				return new \WP_Error( 'unknown', '', $code );
0 ignored issues
show
Unused Code introduced by
The call to WP_Error::__construct() has too many arguments starting with 'unknown'.

This check compares calls to functions or methods with their respective definitions. If the call has more arguments than are defined, it raises an issue.

If a function is defined several times with a different number of parameters, the check may pick up the wrong definition and report false positives. One codebase where this has been known to happen is Wordpress.

In this case you can add the @ignore PhpDoc annotation to the duplicate definition and it will be ignored.

Loading history...
1559
			}
1560
1561
			/* translators: Error description string. */
1562
			$error_description = isset( $json->error_description ) ? sprintf( __( 'Error Details: %s', 'jetpack' ), (string) $json->error_description ) : '';
1563
1564
			return new \WP_Error( (string) $json->error, $error_description, $code );
0 ignored issues
show
Unused Code introduced by
The call to WP_Error::__construct() has too many arguments starting with (string) $json->error.

This check compares calls to functions or methods with their respective definitions. If the call has more arguments than are defined, it raises an issue.

If a function is defined several times with a different number of parameters, the check may pick up the wrong definition and report false positives. One codebase where this has been known to happen is Wordpress.

In this case you can add the @ignore PhpDoc annotation to the duplicate definition and it will be ignored.

Loading history...
1565
		}
1566
1567
		if ( empty( $json->access_token ) || ! is_scalar( $json->access_token ) ) {
1568
			return new \WP_Error( 'access_token', '', $code );
0 ignored issues
show
Unused Code introduced by
The call to WP_Error::__construct() has too many arguments starting with 'access_token'.

This check compares calls to functions or methods with their respective definitions. If the call has more arguments than are defined, it raises an issue.

If a function is defined several times with a different number of parameters, the check may pick up the wrong definition and report false positives. One codebase where this has been known to happen is Wordpress.

In this case you can add the @ignore PhpDoc annotation to the duplicate definition and it will be ignored.

Loading history...
1569
		}
1570
1571
		if ( empty( $json->token_type ) || 'X_JETPACK' !== strtoupper( $json->token_type ) ) {
1572
			return new \WP_Error( 'token_type', '', $code );
0 ignored issues
show
Unused Code introduced by
The call to WP_Error::__construct() has too many arguments starting with 'token_type'.

This check compares calls to functions or methods with their respective definitions. If the call has more arguments than are defined, it raises an issue.

If a function is defined several times with a different number of parameters, the check may pick up the wrong definition and report false positives. One codebase where this has been known to happen is Wordpress.

In this case you can add the @ignore PhpDoc annotation to the duplicate definition and it will be ignored.

Loading history...
1573
		}
1574
1575
		if ( empty( $json->scope ) ) {
1576
			return new \WP_Error( 'scope', 'No Scope', $code );
0 ignored issues
show
Unused Code introduced by
The call to WP_Error::__construct() has too many arguments starting with 'scope'.

This check compares calls to functions or methods with their respective definitions. If the call has more arguments than are defined, it raises an issue.

If a function is defined several times with a different number of parameters, the check may pick up the wrong definition and report false positives. One codebase where this has been known to happen is Wordpress.

In this case you can add the @ignore PhpDoc annotation to the duplicate definition and it will be ignored.

Loading history...
1577
		}
1578
1579
		@list( $role, $hmac ) = explode( ':', $json->scope );
0 ignored issues
show
Security Best Practice introduced by
It seems like you do not handle an error condition here. This can introduce security issues, and is generally not recommended.

If you suppress an error, we recommend checking for the error condition explicitly:

// For example instead of
@mkdir($dir);

// Better use
if (@mkdir($dir) === false) {
    throw new \RuntimeException('The directory '.$dir.' could not be created.');
}
Loading history...
1580
		if ( empty( $role ) || empty( $hmac ) ) {
1581
			return new \WP_Error( 'scope', 'Malformed Scope', $code );
0 ignored issues
show
Unused Code introduced by
The call to WP_Error::__construct() has too many arguments starting with 'scope'.

This check compares calls to functions or methods with their respective definitions. If the call has more arguments than are defined, it raises an issue.

If a function is defined several times with a different number of parameters, the check may pick up the wrong definition and report false positives. One codebase where this has been known to happen is Wordpress.

In this case you can add the @ignore PhpDoc annotation to the duplicate definition and it will be ignored.

Loading history...
1582
		}
1583
1584
		if ( $this->sign_role( $role ) !== $json->scope ) {
1585
			return new \WP_Error( 'scope', 'Invalid Scope', $code );
0 ignored issues
show
Unused Code introduced by
The call to WP_Error::__construct() has too many arguments starting with 'scope'.

This check compares calls to functions or methods with their respective definitions. If the call has more arguments than are defined, it raises an issue.

If a function is defined several times with a different number of parameters, the check may pick up the wrong definition and report false positives. One codebase where this has been known to happen is Wordpress.

In this case you can add the @ignore PhpDoc annotation to the duplicate definition and it will be ignored.

Loading history...
1586
		}
1587
1588
		$cap = $roles->translate_role_to_cap( $role );
1589
		if ( ! $cap ) {
1590
			return new \WP_Error( 'scope', 'No Cap', $code );
0 ignored issues
show
Unused Code introduced by
The call to WP_Error::__construct() has too many arguments starting with 'scope'.

This check compares calls to functions or methods with their respective definitions. If the call has more arguments than are defined, it raises an issue.

If a function is defined several times with a different number of parameters, the check may pick up the wrong definition and report false positives. One codebase where this has been known to happen is Wordpress.

In this case you can add the @ignore PhpDoc annotation to the duplicate definition and it will be ignored.

Loading history...
1591
		}
1592
1593
		if ( ! current_user_can( $cap ) ) {
1594
			return new \WP_Error( 'scope', 'current_user_cannot', $code );
0 ignored issues
show
Unused Code introduced by
The call to WP_Error::__construct() has too many arguments starting with 'scope'.

This check compares calls to functions or methods with their respective definitions. If the call has more arguments than are defined, it raises an issue.

If a function is defined several times with a different number of parameters, the check may pick up the wrong definition and report false positives. One codebase where this has been known to happen is Wordpress.

In this case you can add the @ignore PhpDoc annotation to the duplicate definition and it will be ignored.

Loading history...
1595
		}
1596
1597
		/**
1598
		 * Fires after user has successfully received an auth token.
1599
		 *
1600
		 * @since 3.9.0
1601
		 */
1602
		do_action( 'jetpack_user_authorized' );
1603
1604
		return (string) $json->access_token;
1605
	}
1606
1607
	/**
1608
	 * Builds a URL to the Jetpack connection auth page.
1609
	 *
1610
	 * @param WP_User $user (optional) defaults to the current logged in user.
0 ignored issues
show
Documentation introduced by
Should the type for parameter $user not be WP_User|null?

This check looks for @param annotations where the type inferred by our type inference engine differs from the declared type.

It makes a suggestion as to what type it considers more descriptive.

Most often this is a case of a parameter that can be null in addition to its declared types.

Loading history...
1611
	 * @param String  $redirect (optional) a redirect URL to use instead of the default.
0 ignored issues
show
Documentation introduced by
Should the type for parameter $redirect not be string|null?

This check looks for @param annotations where the type inferred by our type inference engine differs from the declared type.

It makes a suggestion as to what type it considers more descriptive.

Most often this is a case of a parameter that can be null in addition to its declared types.

Loading history...
1612
	 * @return string Connect URL.
1613
	 */
1614
	public function get_authorization_url( $user = null, $redirect = null ) {
1615
1616
		if ( empty( $user ) ) {
1617
			$user = wp_get_current_user();
1618
		}
1619
1620
		$roles       = new Roles();
1621
		$role        = $roles->translate_user_to_role( $user );
1622
		$signed_role = $this->sign_role( $role );
1623
1624
		/**
1625
		 * Filter the URL of the first time the user gets redirected back to your site for connection
1626
		 * data processing.
1627
		 *
1628
		 * @since 8.0.0
1629
		 *
1630
		 * @param string $redirect_url Defaults to the site admin URL.
1631
		 */
1632
		$processing_url = apply_filters( 'jetpack_connect_processing_url', admin_url( 'admin.php' ) );
1633
1634
		/**
1635
		 * Filter the URL to redirect the user back to when the authorization process
1636
		 * is complete.
1637
		 *
1638
		 * @since 8.0.0
1639
		 *
1640
		 * @param string $redirect_url Defaults to the site URL.
1641
		 */
1642
		$redirect = apply_filters( 'jetpack_connect_redirect_url', $redirect );
1643
1644
		$secrets = $this->generate_secrets( 'authorize', $user->ID, 2 * HOUR_IN_SECONDS );
1645
1646
		/**
1647
		 * Filter the type of authorization.
1648
		 * 'calypso' completes authorization on wordpress.com/jetpack/connect
1649
		 * while 'jetpack' ( or any other value ) completes the authorization at jetpack.wordpress.com.
1650
		 *
1651
		 * @since 4.3.3
1652
		 *
1653
		 * @param string $auth_type Defaults to 'calypso', can also be 'jetpack'.
1654
		 */
1655
		$auth_type = apply_filters( 'jetpack_auth_type', 'calypso' );
1656
1657
		/**
1658
		 * Filters the user connection request data for additional property addition.
1659
		 *
1660
		 * @since 8.0.0
1661
		 *
1662
		 * @param Array $request_data request data.
1663
		 */
1664
		$body = apply_filters(
1665
			'jetpack_connect_request_body',
1666
			array(
1667
				'response_type' => 'code',
1668
				'client_id'     => \Jetpack_Options::get_option( 'id' ),
1669
				'redirect_uri'  => add_query_arg(
1670
					array(
1671
						'action'   => 'authorize',
1672
						'_wpnonce' => wp_create_nonce( "jetpack-authorize_{$role}_{$redirect}" ),
1673
						'redirect' => rawurlencode( $redirect ),
1674
					),
1675
					esc_url( $processing_url )
1676
				),
1677
				'state'         => $user->ID,
1678
				'scope'         => $signed_role,
1679
				'user_email'    => $user->user_email,
1680
				'user_login'    => $user->user_login,
1681
				'is_active'     => $this->is_active(),
1682
				'jp_version'    => Constants::get_constant( 'JETPACK__VERSION' ),
1683
				'auth_type'     => $auth_type,
1684
				'secret'        => $secrets['secret_1'],
1685
				'blogname'      => get_option( 'blogname' ),
1686
				'site_url'      => site_url(),
1687
				'home_url'      => home_url(),
1688
				'site_icon'     => get_site_icon_url(),
1689
				'site_lang'     => get_locale(),
1690
				'site_created'  => $this->get_assumed_site_creation_date(),
1691
			)
1692
		);
1693
1694
		$body = $this->apply_activation_source_to_args( urlencode_deep( $body ) );
1695
1696
		$api_url = $this->api_url( 'authorize' );
1697
1698
		return add_query_arg( $body, $api_url );
1699
	}
1700
1701
	/**
1702
	 * Authorizes the user by obtaining and storing the user token.
1703
	 *
1704
	 * @param array $data The request data.
1705
	 * @return string|\WP_Error Returns a string on success.
1706
	 *                          Returns a \WP_Error on failure.
1707
	 */
1708
	public function authorize( $data = array() ) {
1709
		/**
1710
		 * Action fired when user authorization starts.
1711
		 *
1712
		 * @since 8.0.0
1713
		 */
1714
		do_action( 'jetpack_authorize_starting' );
1715
1716
		$roles = new Roles();
1717
		$role  = $roles->translate_current_user_to_role();
1718
1719
		if ( ! $role ) {
1720
			return new \WP_Error( 'no_role', 'Invalid request.', 400 );
0 ignored issues
show
Unused Code introduced by
The call to WP_Error::__construct() has too many arguments starting with 'no_role'.

This check compares calls to functions or methods with their respective definitions. If the call has more arguments than are defined, it raises an issue.

If a function is defined several times with a different number of parameters, the check may pick up the wrong definition and report false positives. One codebase where this has been known to happen is Wordpress.

In this case you can add the @ignore PhpDoc annotation to the duplicate definition and it will be ignored.

Loading history...
1721
		}
1722
1723
		$cap = $roles->translate_role_to_cap( $role );
1724
		if ( ! $cap ) {
1725
			return new \WP_Error( 'no_cap', 'Invalid request.', 400 );
0 ignored issues
show
Unused Code introduced by
The call to WP_Error::__construct() has too many arguments starting with 'no_cap'.

This check compares calls to functions or methods with their respective definitions. If the call has more arguments than are defined, it raises an issue.

If a function is defined several times with a different number of parameters, the check may pick up the wrong definition and report false positives. One codebase where this has been known to happen is Wordpress.

In this case you can add the @ignore PhpDoc annotation to the duplicate definition and it will be ignored.

Loading history...
1726
		}
1727
1728
		if ( ! empty( $data['error'] ) ) {
1729
			return new \WP_Error( $data['error'], 'Error included in the request.', 400 );
0 ignored issues
show
Unused Code introduced by
The call to WP_Error::__construct() has too many arguments starting with $data['error'].

This check compares calls to functions or methods with their respective definitions. If the call has more arguments than are defined, it raises an issue.

If a function is defined several times with a different number of parameters, the check may pick up the wrong definition and report false positives. One codebase where this has been known to happen is Wordpress.

In this case you can add the @ignore PhpDoc annotation to the duplicate definition and it will be ignored.

Loading history...
1730
		}
1731
1732
		if ( ! isset( $data['state'] ) ) {
1733
			return new \WP_Error( 'no_state', 'Request must include state.', 400 );
0 ignored issues
show
Unused Code introduced by
The call to WP_Error::__construct() has too many arguments starting with 'no_state'.

This check compares calls to functions or methods with their respective definitions. If the call has more arguments than are defined, it raises an issue.

If a function is defined several times with a different number of parameters, the check may pick up the wrong definition and report false positives. One codebase where this has been known to happen is Wordpress.

In this case you can add the @ignore PhpDoc annotation to the duplicate definition and it will be ignored.

Loading history...
1734
		}
1735
1736
		if ( ! ctype_digit( $data['state'] ) ) {
1737
			return new \WP_Error( $data['error'], 'State must be an integer.', 400 );
0 ignored issues
show
Unused Code introduced by
The call to WP_Error::__construct() has too many arguments starting with $data['error'].

This check compares calls to functions or methods with their respective definitions. If the call has more arguments than are defined, it raises an issue.

If a function is defined several times with a different number of parameters, the check may pick up the wrong definition and report false positives. One codebase where this has been known to happen is Wordpress.

In this case you can add the @ignore PhpDoc annotation to the duplicate definition and it will be ignored.

Loading history...
1738
		}
1739
1740
		$current_user_id = get_current_user_id();
1741
		if ( $current_user_id !== (int) $data['state'] ) {
1742
			return new \WP_Error( 'wrong_state', 'State does not match current user.', 400 );
0 ignored issues
show
Unused Code introduced by
The call to WP_Error::__construct() has too many arguments starting with 'wrong_state'.

This check compares calls to functions or methods with their respective definitions. If the call has more arguments than are defined, it raises an issue.

If a function is defined several times with a different number of parameters, the check may pick up the wrong definition and report false positives. One codebase where this has been known to happen is Wordpress.

In this case you can add the @ignore PhpDoc annotation to the duplicate definition and it will be ignored.

Loading history...
1743
		}
1744
1745
		if ( empty( $data['code'] ) ) {
1746
			return new \WP_Error( 'no_code', 'Request must include an authorization code.', 400 );
0 ignored issues
show
Unused Code introduced by
The call to WP_Error::__construct() has too many arguments starting with 'no_code'.

This check compares calls to functions or methods with their respective definitions. If the call has more arguments than are defined, it raises an issue.

If a function is defined several times with a different number of parameters, the check may pick up the wrong definition and report false positives. One codebase where this has been known to happen is Wordpress.

In this case you can add the @ignore PhpDoc annotation to the duplicate definition and it will be ignored.

Loading history...
1747
		}
1748
1749
		$token = $this->get_token( $data );
1750
1751 View Code Duplication
		if ( is_wp_error( $token ) ) {
1752
			$code = $token->get_error_code();
0 ignored issues
show
Bug introduced by
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...
1753
			if ( empty( $code ) ) {
1754
				$code = 'invalid_token';
1755
			}
1756
			return new \WP_Error( $code, $token->get_error_message(), 400 );
0 ignored issues
show
Bug introduced by
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...
Unused Code introduced by
The call to WP_Error::__construct() has too many arguments starting with $code.

This check compares calls to functions or methods with their respective definitions. If the call has more arguments than are defined, it raises an issue.

If a function is defined several times with a different number of parameters, the check may pick up the wrong definition and report false positives. One codebase where this has been known to happen is Wordpress.

In this case you can add the @ignore PhpDoc annotation to the duplicate definition and it will be ignored.

Loading history...
1757
		}
1758
1759
		if ( ! $token ) {
1760
			return new \WP_Error( 'no_token', 'Error generating token.', 400 );
0 ignored issues
show
Unused Code introduced by
The call to WP_Error::__construct() has too many arguments starting with 'no_token'.

This check compares calls to functions or methods with their respective definitions. If the call has more arguments than are defined, it raises an issue.

If a function is defined several times with a different number of parameters, the check may pick up the wrong definition and report false positives. One codebase where this has been known to happen is Wordpress.

In this case you can add the @ignore PhpDoc annotation to the duplicate definition and it will be ignored.

Loading history...
1761
		}
1762
1763
		$is_master_user = ! $this->is_active();
1764
1765
		Utils::update_user_token( $current_user_id, sprintf( '%s.%d', $token, $current_user_id ), $is_master_user );
1766
1767
		if ( ! $is_master_user ) {
1768
			/**
1769
			 * Action fired when a secondary user has been authorized.
1770
			 *
1771
			 * @since 8.0.0
1772
			 */
1773
			do_action( 'jetpack_authorize_ending_linked' );
1774
			return 'linked';
1775
		}
1776
1777
		/**
1778
		 * Action fired when the master user has been authorized.
1779
		 *
1780
		 * @since 8.0.0
1781
		 *
1782
		 * @param array $data The request data.
1783
		 */
1784
		do_action( 'jetpack_authorize_ending_authorized', $data );
1785
1786
		return 'authorized';
1787
	}
1788
1789
	/**
1790
	 * Disconnects from the Jetpack servers.
1791
	 * Forgets all connection details and tells the Jetpack servers to do the same.
1792
	 */
1793
	public function disconnect_site() {
1794
1795
	}
1796
1797
	/**
1798
	 * The Base64 Encoding of the SHA1 Hash of the Input.
1799
	 *
1800
	 * @param string $text The string to hash.
1801
	 * @return string
1802
	 */
1803
	public function sha1_base64( $text ) {
1804
		return base64_encode( sha1( $text, true ) ); // phpcs:ignore WordPress.PHP.DiscouragedPHPFunctions.obfuscation_base64_encode
1805
	}
1806
1807
	/**
1808
	 * This function mirrors Jetpack_Data::is_usable_domain() in the WPCOM codebase.
1809
	 *
1810
	 * @param string $domain The domain to check.
1811
	 *
1812
	 * @return bool|WP_Error
1813
	 */
1814
	public function is_usable_domain( $domain ) {
1815
1816
		// If it's empty, just fail out.
1817
		if ( ! $domain ) {
1818
			return new \WP_Error(
1819
				'fail_domain_empty',
0 ignored issues
show
Unused Code introduced by
The call to WP_Error::__construct() has too many arguments starting with 'fail_domain_empty'.

This check compares calls to functions or methods with their respective definitions. If the call has more arguments than are defined, it raises an issue.

If a function is defined several times with a different number of parameters, the check may pick up the wrong definition and report false positives. One codebase where this has been known to happen is Wordpress.

In this case you can add the @ignore PhpDoc annotation to the duplicate definition and it will be ignored.

Loading history...
1820
				/* translators: %1$s is a domain name. */
1821
				sprintf( __( 'Domain `%1$s` just failed is_usable_domain check as it is empty.', 'jetpack' ), $domain )
1822
			);
1823
		}
1824
1825
		/**
1826
		 * Skips the usuable domain check when connecting a site.
1827
		 *
1828
		 * Allows site administrators with domains that fail gethostname-based checks to pass the request to WP.com
1829
		 *
1830
		 * @since 4.1.0
1831
		 *
1832
		 * @param bool If the check should be skipped. Default false.
1833
		 */
1834
		if ( apply_filters( 'jetpack_skip_usuable_domain_check', false ) ) {
1835
			return true;
1836
		}
1837
1838
		// None of the explicit localhosts.
1839
		$forbidden_domains = array(
1840
			'wordpress.com',
1841
			'localhost',
1842
			'localhost.localdomain',
1843
			'127.0.0.1',
1844
			'local.wordpress.test',         // VVV pattern.
1845
			'local.wordpress-trunk.test',   // VVV pattern.
1846
			'src.wordpress-develop.test',   // VVV pattern.
1847
			'build.wordpress-develop.test', // VVV pattern.
1848
		);
1849 View Code Duplication
		if ( in_array( $domain, $forbidden_domains, true ) ) {
1850
			return new \WP_Error(
1851
				'fail_domain_forbidden',
0 ignored issues
show
Unused Code introduced by
The call to WP_Error::__construct() has too many arguments starting with 'fail_domain_forbidden'.

This check compares calls to functions or methods with their respective definitions. If the call has more arguments than are defined, it raises an issue.

If a function is defined several times with a different number of parameters, the check may pick up the wrong definition and report false positives. One codebase where this has been known to happen is Wordpress.

In this case you can add the @ignore PhpDoc annotation to the duplicate definition and it will be ignored.

Loading history...
1852
				sprintf(
1853
					/* translators: %1$s is a domain name. */
1854
					__(
1855
						'Domain `%1$s` just failed is_usable_domain check as it is in the forbidden array.',
1856
						'jetpack'
1857
					),
1858
					$domain
1859
				)
1860
			);
1861
		}
1862
1863
		// No .test or .local domains.
1864 View Code Duplication
		if ( preg_match( '#\.(test|local)$#i', $domain ) ) {
1865
			return new \WP_Error(
1866
				'fail_domain_tld',
0 ignored issues
show
Unused Code introduced by
The call to WP_Error::__construct() has too many arguments starting with 'fail_domain_tld'.

This check compares calls to functions or methods with their respective definitions. If the call has more arguments than are defined, it raises an issue.

If a function is defined several times with a different number of parameters, the check may pick up the wrong definition and report false positives. One codebase where this has been known to happen is Wordpress.

In this case you can add the @ignore PhpDoc annotation to the duplicate definition and it will be ignored.

Loading history...
1867
				sprintf(
1868
					/* translators: %1$s is a domain name. */
1869
					__(
1870
						'Domain `%1$s` just failed is_usable_domain check as it uses an invalid top level domain.',
1871
						'jetpack'
1872
					),
1873
					$domain
1874
				)
1875
			);
1876
		}
1877
1878
		// No WPCOM subdomains.
1879 View Code Duplication
		if ( preg_match( '#\.WordPress\.com$#i', $domain ) ) {
1880
			return new \WP_Error(
1881
				'fail_subdomain_wpcom',
0 ignored issues
show
Unused Code introduced by
The call to WP_Error::__construct() has too many arguments starting with 'fail_subdomain_wpcom'.

This check compares calls to functions or methods with their respective definitions. If the call has more arguments than are defined, it raises an issue.

If a function is defined several times with a different number of parameters, the check may pick up the wrong definition and report false positives. One codebase where this has been known to happen is Wordpress.

In this case you can add the @ignore PhpDoc annotation to the duplicate definition and it will be ignored.

Loading history...
1882
				sprintf(
1883
					/* translators: %1$s is a domain name. */
1884
					__(
1885
						'Domain `%1$s` just failed is_usable_domain check as it is a subdomain of WordPress.com.',
1886
						'jetpack'
1887
					),
1888
					$domain
1889
				)
1890
			);
1891
		}
1892
1893
		// If PHP was compiled without support for the Filter module (very edge case).
1894
		if ( ! function_exists( 'filter_var' ) ) {
1895
			// Just pass back true for now, and let wpcom sort it out.
1896
			return true;
1897
		}
1898
1899
		return true;
1900
	}
1901
1902
	/**
1903
	 * Gets the requested token.
1904
	 *
1905
	 * Tokens are one of two types:
1906
	 * 1. Blog Tokens: These are the "main" tokens. Each site typically has one Blog Token,
1907
	 *    though some sites can have multiple "Special" Blog Tokens (see below). These tokens
1908
	 *    are not associated with a user account. They represent the site's connection with
1909
	 *    the Jetpack servers.
1910
	 * 2. User Tokens: These are "sub-"tokens. Each connected user account has one User Token.
1911
	 *
1912
	 * All tokens look like "{$token_key}.{$private}". $token_key is a public ID for the
1913
	 * token, and $private is a secret that should never be displayed anywhere or sent
1914
	 * over the network; it's used only for signing things.
1915
	 *
1916
	 * Blog Tokens can be "Normal" or "Special".
1917
	 * * Normal: The result of a normal connection flow. They look like
1918
	 *   "{$random_string_1}.{$random_string_2}"
1919
	 *   That is, $token_key and $private are both random strings.
1920
	 *   Sites only have one Normal Blog Token. Normal Tokens are found in either
1921
	 *   Jetpack_Options::get_option( 'blog_token' ) (usual) or the JETPACK_BLOG_TOKEN
1922
	 *   constant (rare).
1923
	 * * Special: A connection token for sites that have gone through an alternative
1924
	 *   connection flow. They look like:
1925
	 *   ";{$special_id}{$special_version};{$wpcom_blog_id};.{$random_string}"
1926
	 *   That is, $private is a random string and $token_key has a special structure with
1927
	 *   lots of semicolons.
1928
	 *   Most sites have zero Special Blog Tokens. Special tokens are only found in the
1929
	 *   JETPACK_BLOG_TOKEN constant.
1930
	 *
1931
	 * In particular, note that Normal Blog Tokens never start with ";" and that
1932
	 * Special Blog Tokens always do.
1933
	 *
1934
	 * When searching for a matching Blog Tokens, Blog Tokens are examined in the following
1935
	 * order:
1936
	 * 1. Defined Special Blog Tokens (via the JETPACK_BLOG_TOKEN constant)
1937
	 * 2. Stored Normal Tokens (via Jetpack_Options::get_option( 'blog_token' ))
1938
	 * 3. Defined Normal Tokens (via the JETPACK_BLOG_TOKEN constant)
1939
	 *
1940
	 * @param int|false    $user_id   false: Return the Blog Token. int: Return that user's User Token.
1941
	 * @param string|false $token_key If provided, check that the token matches the provided input.
1942
	 * @param bool|true    $suppress_errors If true, return a falsy value when the token isn't found; When false, return a descriptive WP_Error when the token isn't found.
1943
	 *
1944
	 * @return object|false
1945
	 */
1946
	public function get_access_token( $user_id = false, $token_key = false, $suppress_errors = true ) {
1947
		$possible_special_tokens = array();
1948
		$possible_normal_tokens  = array();
1949
		$user_tokens             = \Jetpack_Options::get_option( 'user_tokens' );
1950
1951
		if ( $user_id ) {
0 ignored issues
show
Bug Best Practice introduced by
The expression $user_id of type false|integer is loosely compared to true; this is ambiguous if the integer can be zero. You might want to explicitly use !== null instead.

In PHP, under loose comparison (like ==, or !=, or switch conditions), values of different types might be equal.

For integer values, zero is a special case, in particular the following results might be unexpected:

0   == false // true
0   == null  // true
123 == false // false
123 == null  // false

// It is often better to use strict comparison
0 === false // false
0 === null  // false
Loading history...
1952
			if ( ! $user_tokens ) {
1953
				return $suppress_errors ? false : new \WP_Error( 'no_user_tokens' );
0 ignored issues
show
Unused Code introduced by
The call to WP_Error::__construct() has too many arguments starting with 'no_user_tokens'.

This check compares calls to functions or methods with their respective definitions. If the call has more arguments than are defined, it raises an issue.

If a function is defined several times with a different number of parameters, the check may pick up the wrong definition and report false positives. One codebase where this has been known to happen is Wordpress.

In this case you can add the @ignore PhpDoc annotation to the duplicate definition and it will be ignored.

Loading history...
1954
			}
1955
			if ( self::JETPACK_MASTER_USER === $user_id ) {
1956
				$user_id = \Jetpack_Options::get_option( 'master_user' );
1957
				if ( ! $user_id ) {
1958
					return $suppress_errors ? false : new \WP_Error( 'empty_master_user_option' );
0 ignored issues
show
Unused Code introduced by
The call to WP_Error::__construct() has too many arguments starting with 'empty_master_user_option'.

This check compares calls to functions or methods with their respective definitions. If the call has more arguments than are defined, it raises an issue.

If a function is defined several times with a different number of parameters, the check may pick up the wrong definition and report false positives. One codebase where this has been known to happen is Wordpress.

In this case you can add the @ignore PhpDoc annotation to the duplicate definition and it will be ignored.

Loading history...
1959
				}
1960
			}
1961
			if ( ! isset( $user_tokens[ $user_id ] ) || ! $user_tokens[ $user_id ] ) {
1962
				return $suppress_errors ? false : new \WP_Error( 'no_token_for_user', sprintf( 'No token for user %d', $user_id ) );
0 ignored issues
show
Unused Code introduced by
The call to WP_Error::__construct() has too many arguments starting with 'no_token_for_user'.

This check compares calls to functions or methods with their respective definitions. If the call has more arguments than are defined, it raises an issue.

If a function is defined several times with a different number of parameters, the check may pick up the wrong definition and report false positives. One codebase where this has been known to happen is Wordpress.

In this case you can add the @ignore PhpDoc annotation to the duplicate definition and it will be ignored.

Loading history...
1963
			}
1964
			$user_token_chunks = explode( '.', $user_tokens[ $user_id ] );
1965 View Code Duplication
			if ( empty( $user_token_chunks[1] ) || empty( $user_token_chunks[2] ) ) {
1966
				return $suppress_errors ? false : new \WP_Error( 'token_malformed', sprintf( 'Token for user %d is malformed', $user_id ) );
0 ignored issues
show
Unused Code introduced by
The call to WP_Error::__construct() has too many arguments starting with 'token_malformed'.

This check compares calls to functions or methods with their respective definitions. If the call has more arguments than are defined, it raises an issue.

If a function is defined several times with a different number of parameters, the check may pick up the wrong definition and report false positives. One codebase where this has been known to happen is Wordpress.

In this case you can add the @ignore PhpDoc annotation to the duplicate definition and it will be ignored.

Loading history...
1967
			}
1968 View Code Duplication
			if ( $user_token_chunks[2] !== (string) $user_id ) {
1969
				return $suppress_errors ? false : new \WP_Error( 'user_id_mismatch', sprintf( 'Requesting user_id %d does not match token user_id %d', $user_id, $user_token_chunks[2] ) );
0 ignored issues
show
Unused Code introduced by
The call to WP_Error::__construct() has too many arguments starting with 'user_id_mismatch'.

This check compares calls to functions or methods with their respective definitions. If the call has more arguments than are defined, it raises an issue.

If a function is defined several times with a different number of parameters, the check may pick up the wrong definition and report false positives. One codebase where this has been known to happen is Wordpress.

In this case you can add the @ignore PhpDoc annotation to the duplicate definition and it will be ignored.

Loading history...
1970
			}
1971
			$possible_normal_tokens[] = "{$user_token_chunks[0]}.{$user_token_chunks[1]}";
1972
		} else {
1973
			$stored_blog_token = \Jetpack_Options::get_option( 'blog_token' );
1974
			if ( $stored_blog_token ) {
1975
				$possible_normal_tokens[] = $stored_blog_token;
1976
			}
1977
1978
			$defined_tokens_string = Constants::get_constant( 'JETPACK_BLOG_TOKEN' );
1979
1980
			if ( $defined_tokens_string ) {
1981
				$defined_tokens = explode( ',', $defined_tokens_string );
1982
				foreach ( $defined_tokens as $defined_token ) {
1983
					if ( ';' === $defined_token[0] ) {
1984
						$possible_special_tokens[] = $defined_token;
1985
					} else {
1986
						$possible_normal_tokens[] = $defined_token;
1987
					}
1988
				}
1989
			}
1990
		}
1991
1992
		if ( self::MAGIC_NORMAL_TOKEN_KEY === $token_key ) {
1993
			$possible_tokens = $possible_normal_tokens;
1994
		} else {
1995
			$possible_tokens = array_merge( $possible_special_tokens, $possible_normal_tokens );
1996
		}
1997
1998
		if ( ! $possible_tokens ) {
0 ignored issues
show
Bug Best Practice introduced by
The expression $possible_tokens of type array is implicitly converted to a boolean; are you sure this is intended? If so, consider using empty($expr) instead to make it clear that you intend to check for an array without elements.

This check marks implicit conversions of arrays to boolean values in a comparison. While in PHP an empty array is considered to be equal (but not identical) to false, this is not always apparent.

Consider making the comparison explicit by using empty(..) or ! empty(...) instead.

Loading history...
1999
			return $suppress_errors ? false : new \WP_Error( 'no_possible_tokens' );
0 ignored issues
show
Unused Code introduced by
The call to WP_Error::__construct() has too many arguments starting with 'no_possible_tokens'.

This check compares calls to functions or methods with their respective definitions. If the call has more arguments than are defined, it raises an issue.

If a function is defined several times with a different number of parameters, the check may pick up the wrong definition and report false positives. One codebase where this has been known to happen is Wordpress.

In this case you can add the @ignore PhpDoc annotation to the duplicate definition and it will be ignored.

Loading history...
2000
		}
2001
2002
		$valid_token = false;
2003
2004
		if ( false === $token_key ) {
2005
			// Use first token.
2006
			$valid_token = $possible_tokens[0];
2007
		} elseif ( self::MAGIC_NORMAL_TOKEN_KEY === $token_key ) {
2008
			// Use first normal token.
2009
			$valid_token = $possible_tokens[0]; // $possible_tokens only contains normal tokens because of earlier check.
2010
		} else {
2011
			// Use the token matching $token_key or false if none.
2012
			// Ensure we check the full key.
2013
			$token_check = rtrim( $token_key, '.' ) . '.';
2014
2015
			foreach ( $possible_tokens as $possible_token ) {
2016
				if ( hash_equals( substr( $possible_token, 0, strlen( $token_check ) ), $token_check ) ) {
2017
					$valid_token = $possible_token;
2018
					break;
2019
				}
2020
			}
2021
		}
2022
2023
		if ( ! $valid_token ) {
2024
			return $suppress_errors ? false : new \WP_Error( 'no_valid_token' );
0 ignored issues
show
Unused Code introduced by
The call to WP_Error::__construct() has too many arguments starting with 'no_valid_token'.

This check compares calls to functions or methods with their respective definitions. If the call has more arguments than are defined, it raises an issue.

If a function is defined several times with a different number of parameters, the check may pick up the wrong definition and report false positives. One codebase where this has been known to happen is Wordpress.

In this case you can add the @ignore PhpDoc annotation to the duplicate definition and it will be ignored.

Loading history...
2025
		}
2026
2027
		return (object) array(
2028
			'secret'           => $valid_token,
2029
			'external_user_id' => (int) $user_id,
2030
		);
2031
	}
2032
2033
	/**
2034
	 * In some setups, $HTTP_RAW_POST_DATA can be emptied during some IXR_Server paths
2035
	 * since it is passed by reference to various methods.
2036
	 * Capture it here so we can verify the signature later.
2037
	 *
2038
	 * @param Array $methods an array of available XMLRPC methods.
2039
	 * @return Array the same array, since this method doesn't add or remove anything.
2040
	 */
2041
	public function xmlrpc_methods( $methods ) {
2042
		$this->raw_post_data = $GLOBALS['HTTP_RAW_POST_DATA'];
2043
		return $methods;
2044
	}
2045
2046
	/**
2047
	 * Resets the raw post data parameter for testing purposes.
2048
	 */
2049
	public function reset_raw_post_data() {
2050
		$this->raw_post_data = null;
2051
	}
2052
2053
	/**
2054
	 * Registering an additional method.
2055
	 *
2056
	 * @param Array $methods an array of available XMLRPC methods.
2057
	 * @return Array the amended array in case the method is added.
2058
	 */
2059
	public function public_xmlrpc_methods( $methods ) {
2060
		if ( array_key_exists( 'wp.getOptions', $methods ) ) {
2061
			$methods['wp.getOptions'] = array( $this, 'jetpack_get_options' );
2062
		}
2063
		return $methods;
2064
	}
2065
2066
	/**
2067
	 * Handles a getOptions XMLRPC method call.
2068
	 *
2069
	 * @param Array $args method call arguments.
2070
	 * @return an amended XMLRPC server options array.
2071
	 */
2072
	public function jetpack_get_options( $args ) {
2073
		global $wp_xmlrpc_server;
2074
2075
		$wp_xmlrpc_server->escape( $args );
2076
2077
		$username = $args[1];
2078
		$password = $args[2];
2079
2080
		$user = $wp_xmlrpc_server->login( $username, $password );
2081
		if ( ! $user ) {
2082
			return $wp_xmlrpc_server->error;
2083
		}
2084
2085
		$options   = array();
2086
		$user_data = $this->get_connected_user_data();
2087
		if ( is_array( $user_data ) ) {
2088
			$options['jetpack_user_id']         = array(
2089
				'desc'     => __( 'The WP.com user ID of the connected user', 'jetpack' ),
2090
				'readonly' => true,
2091
				'value'    => $user_data['ID'],
2092
			);
2093
			$options['jetpack_user_login']      = array(
2094
				'desc'     => __( 'The WP.com username of the connected user', 'jetpack' ),
2095
				'readonly' => true,
2096
				'value'    => $user_data['login'],
2097
			);
2098
			$options['jetpack_user_email']      = array(
2099
				'desc'     => __( 'The WP.com user email of the connected user', 'jetpack' ),
2100
				'readonly' => true,
2101
				'value'    => $user_data['email'],
2102
			);
2103
			$options['jetpack_user_site_count'] = array(
2104
				'desc'     => __( 'The number of sites of the connected WP.com user', 'jetpack' ),
2105
				'readonly' => true,
2106
				'value'    => $user_data['site_count'],
2107
			);
2108
		}
2109
		$wp_xmlrpc_server->blog_options = array_merge( $wp_xmlrpc_server->blog_options, $options );
2110
		$args                           = stripslashes_deep( $args );
2111
		return $wp_xmlrpc_server->wp_getOptions( $args );
2112
	}
2113
2114
	/**
2115
	 * Adds Jetpack-specific options to the output of the XMLRPC options method.
2116
	 *
2117
	 * @param Array $options standard Core options.
2118
	 * @return Array amended options.
2119
	 */
2120
	public function xmlrpc_options( $options ) {
2121
		$jetpack_client_id = false;
2122
		if ( $this->is_active() ) {
2123
			$jetpack_client_id = \Jetpack_Options::get_option( 'id' );
2124
		}
2125
		$options['jetpack_version'] = array(
2126
			'desc'     => __( 'Jetpack Plugin Version', 'jetpack' ),
2127
			'readonly' => true,
2128
			'value'    => Constants::get_constant( 'JETPACK__VERSION' ),
2129
		);
2130
2131
		$options['jetpack_client_id'] = array(
2132
			'desc'     => __( 'The Client ID/WP.com Blog ID of this site', 'jetpack' ),
2133
			'readonly' => true,
2134
			'value'    => $jetpack_client_id,
2135
		);
2136
		return $options;
2137
	}
2138
2139
	/**
2140
	 * Resets the saved authentication state in between testing requests.
2141
	 */
2142
	public function reset_saved_auth_state() {
2143
		$this->xmlrpc_verification = null;
2144
	}
2145
2146
	/**
2147
	 * Sign a user role with the master access token.
2148
	 * If not specified, will default to the current user.
2149
	 *
2150
	 * @access public
2151
	 *
2152
	 * @param string $role    User role.
2153
	 * @param int    $user_id ID of the user.
0 ignored issues
show
Documentation introduced by
Should the type for parameter $user_id not be integer|null?

This check looks for @param annotations where the type inferred by our type inference engine differs from the declared type.

It makes a suggestion as to what type it considers more descriptive.

Most often this is a case of a parameter that can be null in addition to its declared types.

Loading history...
2154
	 * @return string Signed user role.
2155
	 */
2156
	public function sign_role( $role, $user_id = null ) {
2157
		if ( empty( $user_id ) ) {
2158
			$user_id = (int) get_current_user_id();
2159
		}
2160
2161
		if ( ! $user_id ) {
2162
			return false;
2163
		}
2164
2165
		$token = $this->get_access_token();
2166
		if ( ! $token || is_wp_error( $token ) ) {
2167
			return false;
2168
		}
2169
2170
		return $role . ':' . hash_hmac( 'md5', "{$role}|{$user_id}", $token->secret );
2171
	}
2172
}
2173