jetpack / jetpack_vendor / automattic / jetpack-connection / src / class-manager.php

class-manager.php in Jetpack – WP Security, Backup, Speed, & Growth 16.3-a.5, at jetpack_vendor/automattic/jetpack-connection/src/class-manager.php

3,772 lines 127.3 KB

Raw Download Zip

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\A8c_Mc_Stats;
11	use Automattic\Jetpack\Constants;
12	use Automattic\Jetpack\Heartbeat;
13	use Automattic\Jetpack\Identity_Crisis;
14	use Automattic\Jetpack\Partner;
15	use Automattic\Jetpack\Roles;
16	use Automattic\Jetpack\Status;
17	use Automattic\Jetpack\Status\Host;
18	use Automattic\Jetpack\Terms_Of_Service;
19	use Automattic\Jetpack\Tracking;
20	use IXR_Error;
21	use Jetpack_IXR_Client;
22	use Jetpack_Options;
23	use Jetpack_XMLRPC_Server;
24	use WP_Error;
25	use WP_User;
26
27	/**
28	* The Jetpack Connection Manager class that is used as a single gateway between WordPress.com
29	* and Jetpack.
30	*/
31	class Manager {
32	/**
33	* Prefix of the transient holding the cached WordPress.com site record. The blog ID is
34	* appended so a reconnect to a different site cannot read the previous site's record.
35	*
36	* @since 9.0.0
37	*
38	* @var string
39	*/
40	const SITE_DATA_TRANSIENT_PREFIX = 'jetpack_site_data_';
41
42	/**
43	* Why `has_protected_owner()` answered false, and what would change it.
44	*
45	* `RE_EVALUATE` is the race: the gate said false, and by the time the state was classified the
46	* owner matched after all. It is not a problem to report, it is an instruction to ask again.
47	*
48	* @since 9.4.0
49	*/
50	const PO_STATE_NOT_ELIGIBLE = 'NOT_ELIGIBLE';
51	const PO_STATE_NEEDS_CONNECT_TO_ESTABLISH = 'NEEDS_CONNECT_TO_ESTABLISH';
52	const PO_STATE_CAN_ESTABLISH = 'CAN_ESTABLISH';
53	const PO_STATE_NEEDS_OWNER_RECONNECT = 'NEEDS_OWNER_RECONNECT';
54	const PO_STATE_NEEDS_DIFFERENT_OWNER = 'NEEDS_DIFFERENT_OWNER';
55	const PO_STATE_RE_EVALUATE = 'RE_EVALUATE';
56
57	/**
58	* A copy of the raw POST data for signature verification purposes.
59	*
60	* @var string
61	*/
62	protected $raw_post_data;
63
64	/**
65	* Verification data needs to be stored to properly verify everything.
66	*
67	* @var Object
68	*/
69	private $xmlrpc_verification = null;
70
71	/**
72	* Plugin management object.
73	*
74	* @var Plugin
75	*/
76	private $plugin = null;
77
78	/**
79	* Error handler object.
80	*
81	* @var Error_Handler
82	*/
83	public $error_handler = null;
84
85	/**
86	* Jetpack_XMLRPC_Server object
87	*
88	* @var Jetpack_XMLRPC_Server
89	*/
90	public $xmlrpc_server = null;
91
92	/**
93	* Holds extra parameters that will be sent along in the register request body.
94	*
95	* Use Manager::add_register_request_param to add values to this array.
96	*
97	* @since 1.26.0
98	* @var array
99	*/
100	private static $extra_register_params = array();
101
102	/**
103	* We store ID's of users already disconnected to prevent multiple disconnect requests.
104	*
105	* @var array
106	*/
107	private static $disconnected_users = array();
108
109	/**
110	* Cached connection status.
111	*
112	* @var bool\|null True if the site is connected, false if not, null if not determined yet.
113	*/
114	private static $is_connected = null;
115
116	/**
117	* Memoized user ID of the connection owner.
118	* If undefined or invalid, set to 0.
119	*
120	* @var null\|int
121	*/
122	private static $connection_owner_id = null;
123
124	/**
125	* Tracks whether connection status invalidation hooks have been added.
126	*
127	* @var bool
128	*/
129	private static $connection_invalidators_added = false;
130
131	/**
132	* Initialize the object.
133	* Make sure to call the "Configure" first.
134	*
135	* @param string $plugin_slug Slug of the plugin using the connection (optional, but encouraged).
136	*
137	* @see \Automattic\Jetpack\Config
138	*/
139	public function __construct( $plugin_slug = null ) {
140	if ( $plugin_slug && is_string( $plugin_slug ) ) {
141	$this->set_plugin_instance( new Plugin( $plugin_slug ) );
142	}
143	}
144
145	/**
146	* Initializes required listeners. This is done separately from the constructors
147	* because some objects sometimes need to instantiate separate objects of this class.
148	*
149	* @todo Implement a proper nonce verification.
150	*/
151	public static function configure() {
152	$manager = new self();
153
154	add_filter(
155	'jetpack_constant_default_value',
156	__NAMESPACE__ . '\Utils::jetpack_api_constant_filter',
157	10,
158	2
159	);
160
161	$manager->setup_xmlrpc_handlers(
162	null,
163	$manager->has_connected_owner(),
164	$manager->verify_xml_rpc_signature()
165	);
166
167	$manager->error_handler = Error_Handler::get_instance();
168
169	if ( $manager->is_connected() ) {
170	add_filter( 'xmlrpc_methods', array( $manager, 'public_xmlrpc_methods' ) );
171	add_filter( 'shutdown', array( Package_Version_Tracker::class, 'update_on_shutdown' ) );
172	}
173
174	// This runs on priority 11 - at least one api method in the connection package is set to override a previously
175	// existing method from the Jetpack plugin. Running later than Jetpack's api init ensures the override is successful.
176	add_action( 'rest_api_init', array( $manager, 'initialize_rest_api_registration_connector' ), 11 );
177
178	( new Nonce_Handler() )->init_schedule();
179
180	add_action( 'plugins_loaded', __NAMESPACE__ . '\Plugin_Storage::configure', 100 );
181
182	add_filter( 'map_meta_cap', array( $manager, 'jetpack_connection_custom_caps' ), 1, 4 );
183
184	Heartbeat::init();
185	add_filter( 'jetpack_heartbeat_stats_array', array( $manager, 'add_stats_to_heartbeat' ) );
186	add_action( 'jetpack_verify_signature_error', array( $manager, 'track_xmlrpc_error' ) );
187
188	Webhooks::init( $manager );
189
190	add_action( 'pre_update_jetpack_option_user_tokens', array( $manager, 'unbind_wpcom_user_ids_for_new_tokens' ), 10, 2 );
191	add_action( 'jetpack_user_authorized', array( $manager, 'reconcile_protected_owner' ) );
192
193	// Unlink user before deleting the user from WP.com.
194	add_action( 'deleted_user', array( $manager, 'disconnect_user_force' ), 9, 1 );
195	add_action( 'remove_user_from_blog', array( $manager, 'disconnect_user_force' ), 9, 1 );
196
197	// Add hooks for cleaning up account mismatch transients
198	$user_account_status = new User_Account_Status();
199	add_action( 'delete_user', array( $user_account_status, 'clean_account_mismatch_transients' ), 9, 1 );
200	add_action( 'remove_user_from_blog', array( $user_account_status, 'clean_account_mismatch_transients' ), 9, 1 );
201	add_action( 'user_register', array( $user_account_status, 'clean_account_mismatch_transients' ), 9, 1 );
202	add_action( 'profile_update', array( $user_account_status, 'clean_account_mismatch_transients' ), 9, 1 );
203
204	$manager->add_connection_status_invalidation_hooks();
205
206	// Set up package version hook.
207	add_filter( 'jetpack_package_versions', __NAMESPACE__ . '\Package_Version::send_package_version_to_tracker' );
208
209	if ( defined( 'JETPACK__SANDBOX_DOMAIN' ) && JETPACK__SANDBOX_DOMAIN ) {
210	( new Server_Sandbox() )->init();
211	}
212
213	// Initialize connection notices.
214	new Connection_Notice();
215
216	// Initialize token locks.
217	new Tokens_Locks();
218
219	// Initial Partner management.
220	Partner::init();
221
222	// WP 7.0+ Connectors screen card.
223	Jetpack_Connector::init();
224
225	// Site Health integration.
226	Site_Health::init();
227	}
228
229	/**
230	* Adds hooks to invalidate the memoized connection status.
231	*/
232	private function add_connection_status_invalidation_hooks() {
233	if ( self::$connection_invalidators_added ) {
234	return;
235	}
236
237	// Force is_connected() to recompute after important actions.
238	add_action( 'jetpack_site_registered', array( $this, 'reset_connection_status' ) );
239	add_action( 'jetpack_site_disconnected', array( $this, 'reset_connection_status' ) );
240	// Deletion doesn't fire `pre_update_jetpack_option_*`; see the action's docblock in `Tokens::delete_all()`.
241	add_action( 'jetpack_connection_tokens_deleted', array( $this, 'reset_connection_status' ) );
242	add_action( 'jetpack_sync_register_user', array( $this, 'reset_connection_status' ) );
243	add_action( 'pre_update_jetpack_option_id', array( $this, 'reset_connection_status' ) );
244	add_action( 'pre_update_jetpack_option_blog_token', array( $this, 'reset_connection_status' ) );
245	add_action( 'pre_update_jetpack_option_user_token', array( $this, 'reset_connection_status' ) );
246	add_action( 'pre_update_jetpack_option_user_tokens', array( $this, 'reset_connection_status' ) );
247	add_action( 'pre_update_jetpack_option_master_user', array( $this, 'reset_connection_status' ) );
248	// phpcs:ignore WPCUT.SwitchBlog.SwitchBlog -- wpcom flags every use of switch_blog, apparently expecting valid instances to ignore or suppress the sniff.
249	add_action( 'switch_blog', array( $this, 'reset_connection_status' ) );
250	add_action( 'jetpack_external_storage_provider_registered', array( $this, 'reset_connection_status' ), 10, 0 );
251
252	self::$connection_invalidators_added = true;
253	}
254
255	/**
256	* Sets up the XMLRPC request handlers.
257	*
258	* @since 1.25.0 Deprecate $is_active param.
259	* @since 2.8.4 Deprecate $request_params param.
260	*
261	* @param array\|null $deprecated Deprecated. Not used.
262	* @param bool $has_connected_owner Whether the site has a connected owner.
263	* @param bool $is_signed whether the signature check has been successful.
264	* @param Jetpack_XMLRPC_Server $xmlrpc_server (optional) an instance of the server to use instead of instantiating a new one.
265	*/
266	public function setup_xmlrpc_handlers(
267	$deprecated,
268	$has_connected_owner,
269	$is_signed,
270	?Jetpack_XMLRPC_Server $xmlrpc_server = null
271	) {
272	add_filter( 'xmlrpc_blog_options', array( $this, 'xmlrpc_options' ), 1000, 2 );
273	if ( $deprecated !== null ) {
274	_deprecated_argument( __METHOD__, '2.8.4' );
275	}
276	// phpcs:ignore WordPress.Security.NonceVerification.Recommended -- We are using the 'for' request param to early return unless it's 'jetpack'.
277	if ( ! isset( $_GET['for'] ) \|\| 'jetpack' !== $_GET['for'] ) {
278	return false;
279	}
280
281	// Alternate XML-RPC, via ?for=jetpack&jetpack=comms.
282	// phpcs:ignore WordPress.Security.NonceVerification.Recommended -- This just determines whether to handle the request as an XML-RPC request. The actual XML-RPC endpoints do the appropriate nonce checking where applicable. Plus we make sure to clear all cookies via require_jetpack_authentication called later in method.
283	if ( isset( $_GET['jetpack'] ) && 'comms' === $_GET['jetpack'] ) {
284	if ( ! Constants::is_defined( 'XMLRPC_REQUEST' ) ) {
285	// Use the real constant here for WordPress' sake.
286	define( 'XMLRPC_REQUEST', true );
287	}
288
289	add_action( 'template_redirect', array( $this, 'alternate_xmlrpc' ) );
290
291	add_filter( 'xmlrpc_methods', array( $this, 'remove_non_jetpack_xmlrpc_methods' ), 1000 );
292	}
293
294	if ( ! Constants::get_constant( 'XMLRPC_REQUEST' ) ) {
295	return false;
296	}
297
298	// Display errors can cause the XML to be not well formed.
299	// This only affects Jetpack XML-RPC endpoints received from WordPress.com servers.
300	// All other XML-RPC requests are unaffected.
301	@ini_set( 'display_errors', false ); // phpcs:ignore
302
303	if ( $xmlrpc_server ) {
304	$this->xmlrpc_server = $xmlrpc_server;
305	} else {
306	$this->xmlrpc_server = new Jetpack_XMLRPC_Server();
307	}
308
309	$this->require_jetpack_authentication();
310
311	if ( $is_signed ) {
312	// If the site is connected either at a site or user level and the request is signed, expose the methods.
313	// The callback is responsible to determine whether the request is signed with blog or user token and act accordingly.
314	// The actual API methods.
315	$callback = array( $this->xmlrpc_server, 'xmlrpc_methods' );
316
317	// Hack to preserve $HTTP_RAW_POST_DATA.
318	add_filter( 'xmlrpc_methods', array( $this, 'xmlrpc_methods' ) );
319
320	} elseif ( $has_connected_owner ) {
321	// The jetpack.authorize method should be available for unauthenticated users on a site with an
322	// active Jetpack connection, so that additional users can link their account.
323	$callback = array( $this->xmlrpc_server, 'authorize_xmlrpc_methods' );
324	} else {
325	// Any other unsigned request should expose the bootstrap methods.
326	$callback = array( $this->xmlrpc_server, 'bootstrap_xmlrpc_methods' );
327	new XMLRPC_Connector( $this );
328	}
329
330	add_filter( 'xmlrpc_methods', $callback );
331
332	// Now that no one can authenticate, and we're whitelisting all XML-RPC methods, force enable_xmlrpc on.
333	add_filter( 'pre_option_enable_xmlrpc', '__return_true' );
334	return true;
335	}
336
337	/**
338	* Initializes the REST API connector on the init hook.
339	*/
340	public function initialize_rest_api_registration_connector() {
341	new REST_Connector( $this );
342	}
343
344	/**
345	* Since a lot of hosts use a hammer approach to "protecting" WordPress sites,
346	* and just blanket block all requests to /xmlrpc.php, or apply other overly-sensitive
347	* security/firewall policies, we provide our own alternate XML RPC API endpoint
348	* which is accessible via a different URI. Most of the below is copied directly
349	* from /xmlrpc.php so that we're replicating it as closely as possible.
350	*
351	* @todo Tighten $wp_xmlrpc_server_class a bit to make sure it doesn't do bad things.
352	*
353	* @return never
354	*/
355	public function alternate_xmlrpc() {
356	// Some browser-embedded clients send cookies. We don't want them.
357	$_COOKIE = array();
358
359	include_once ABSPATH . 'wp-admin/includes/admin.php';
360	include_once ABSPATH . WPINC . '/class-IXR.php';
361	include_once ABSPATH . WPINC . '/class-wp-xmlrpc-server.php';
362
363	/**
364	* Filters the class used for handling XML-RPC requests.
365	*
366	* @since 1.7.0
367	* @since-jetpack 3.1.0
368	*
369	* @param string $class The name of the XML-RPC server class.
370	*/
371	$wp_xmlrpc_server_class = apply_filters( 'wp_xmlrpc_server_class', 'wp_xmlrpc_server' );
372	$wp_xmlrpc_server = new $wp_xmlrpc_server_class();
373
374	// Fire off the request.
375	nocache_headers();
376	$wp_xmlrpc_server->serve_request();
377
378	exit( 0 );
379	}
380
381	/**
382	* Removes all XML-RPC methods that are not `jetpack.*`.
383	* Only used in our alternate XML-RPC endpoint, where we want to
384	* ensure that Core and other plugins' methods are not exposed.
385	*
386	* @param array $methods a list of registered WordPress XMLRPC methods.
387	* @return array filtered $methods
388	*/
389	public function remove_non_jetpack_xmlrpc_methods( $methods ) {
390	$jetpack_methods = array();
391
392	foreach ( $methods as $method => $callback ) {
393	if ( str_starts_with( $method, 'jetpack.' ) ) {
394	$jetpack_methods[ $method ] = $callback;
395	}
396	}
397
398	return $jetpack_methods;
399	}
400
401	/**
402	* Removes all other authentication methods not to allow other
403	* methods to validate unauthenticated requests.
404	*/
405	public function require_jetpack_authentication() {
406	// Don't let anyone authenticate.
407	$_COOKIE = array();
408	remove_all_filters( 'authenticate' );
409	remove_all_actions( 'wp_login_failed' );
410
411	if ( $this->is_connected() ) {
412	// Allow Jetpack authentication.
413	add_filter( 'authenticate', array( $this, 'authenticate_jetpack' ), 10, 3 );
414	}
415	}
416
417	/**
418	* Authenticates XML-RPC and other requests from the Jetpack Server
419	*
420	* @param WP_User\|mixed $user user object if authenticated.
421	* @param string $username username.
422	* @param string $password password string.
423	* @return WP_User\|mixed authenticated user or error.
424	*/
425	public function authenticate_jetpack( $user, $username, $password ) { // phpcs:ignore VariableAnalysis.CodeAnalysis.VariableAnalysis.UnusedVariable
426	if ( is_a( $user, '\\WP_User' ) ) {
427	return $user;
428	}
429
430	$token_details = $this->verify_xml_rpc_signature();
431
432	if ( ! $token_details ) {
433	return $user;
434	}
435
436	if ( 'user' !== $token_details['type'] ) {
437	return $user;
438	}
439
440	if ( ! $token_details['user_id'] ) {
441	return $user;
442	}
443
444	nocache_headers();
445
446	return new \WP_User( $token_details['user_id'] );
447	}
448
449	/**
450	* Verifies the signature of the current request.
451	*
452	* @return false\|array
453	*/
454	public function verify_xml_rpc_signature() {
455	if ( $this->xmlrpc_verification === null ) {
456	$this->xmlrpc_verification = $this->internal_verify_xml_rpc_signature();
457
458	if ( is_wp_error( $this->xmlrpc_verification ) ) {
459	/**
460	* Action for logging XMLRPC signature verification errors. This data is sensitive.
461	*
462	* @since 1.7.0
463	* @since-jetpack 7.5.0
464	*
465	* @param WP_Error $signature_verification_error The verification error
466	*/
467	do_action( 'jetpack_verify_signature_error', $this->xmlrpc_verification );
468
469	Error_Handler::get_instance()->report_error( $this->xmlrpc_verification );
470
471	}
472	}
473
474	return is_wp_error( $this->xmlrpc_verification ) ? false : $this->xmlrpc_verification;
475	}
476
477	/**
478	* Verifies the signature of the current request.
479	*
480	* This function has side effects and should not be used. Instead,
481	* use the memoized version `->verify_xml_rpc_signature()`.
482	*
483	* @internal
484	* @todo Refactor to use proper nonce verification.
485	*/
486	private function internal_verify_xml_rpc_signature() {
487	// phpcs:disable WordPress.Security.NonceVerification.Recommended, WordPress.Security.ValidatedSanitizedInput.InputNotSanitized
488	// It's not for us.
489	if ( ! isset( $_GET['token'] ) \|\| empty( $_GET['signature'] ) ) {
490	return false;
491	}
492
493	// Skip XML-RPC signature verification for OAuth authorization flow.
494	// OAuth uses GET requests without body-hash and has its own
495	// signature verification in Authorize_Json_Api class.
496	if ( isset( $_GET['action'] ) && $_GET['action'] === 'jetpack_json_api_authorization' ) {
497	return false;
498	}
499
500	$signature_details = array(
501	'token' => isset( $_GET['token'] ) ? wp_unslash( $_GET['token'] ) : '',
502	'timestamp' => isset( $_GET['timestamp'] ) ? wp_unslash( $_GET['timestamp'] ) : '',
503	'nonce' => isset( $_GET['nonce'] ) ? wp_unslash( $_GET['nonce'] ) : '',
504	'body_hash' => isset( $_GET['body-hash'] ) ? wp_unslash( $_GET['body-hash'] ) : '',
505	'method' => isset( $_SERVER['REQUEST_METHOD'] ) ? wp_unslash( $_SERVER['REQUEST_METHOD'] ) : null,
506	'url' => wp_unslash( ( $_SERVER['HTTP_HOST'] ?? null ) . ( $_SERVER['REQUEST_URI'] ?? null ) ), // Temp - will get real signature URL later.
507	'signature' => isset( $_GET['signature'] ) ? wp_unslash( $_GET['signature'] ) : '',
508	);
509
510	// Transport of the incoming request being verified. This signature-verification path
511	// serves both XML-RPC requests and signed REST requests (REST_Authentication funnels
512	// REST authentication into verify_xml_rpc_signature()), so the stored error type is
513	// derived from the actual request context rather than hardcoded.
514	$error_type = $this->get_current_request_transport();
515	$error_direction = 'incoming'; // Matches Error_Handler::DIRECTION_INCOMING — see build_connection_error_data() for why the constant is not referenced.
516
517	// phpcs:ignore WordPress.PHP.NoSilencedErrors.Discouraged
518	@list( $token_key, $version, $user_id ) = explode( ':', wp_unslash( $_GET['token'] ) );
519	// phpcs:enable WordPress.Security.NonceVerification.Recommended, WordPress.Security.ValidatedSanitizedInput.InputNotSanitized
520
521	$jetpack_api_version = Constants::get_constant( 'JETPACK__API_VERSION' );
522
523	if (
524	empty( $token_key )
525	\|\| empty( $version )
526	\|\| (string) $jetpack_api_version !== $version
527	) {
528	return new \WP_Error( 'malformed_token', 'Malformed token in request', $this->build_connection_error_data( $signature_details, $error_type, $error_direction ) );
529	}
530
531	if ( '0' === $user_id ) {
532	$token_type = 'blog';
533	$user_id = 0;
534	} else {
535	$token_type = 'user';
536	if ( empty( $user_id ) \|\| ! ctype_digit( $user_id ) ) {
537	return new \WP_Error(
538	'malformed_user_id',
539	'Malformed user_id in request',
540	$this->build_connection_error_data( $signature_details, $error_type, $error_direction )
541	);
542	}
543	$user_id = (int) $user_id;
544
545	$user = new \WP_User( $user_id );
546	if ( ! $user->exists() ) {
547	return new \WP_Error(
548	'unknown_user',
549	sprintf( 'User %d does not exist', $user_id ),
550	$this->build_connection_error_data( $signature_details, $error_type, $error_direction )
551	);
552	}
553	}
554
555	$token = $this->get_tokens()->get_access_token( $user_id, $token_key, false );
556	if ( is_wp_error( $token ) ) {
557	$token->add_data( $this->build_connection_error_data( $signature_details, $error_type, $error_direction ) );
558	return $token;
559	} elseif ( ! $token ) {
560	// `get_access_token()` explains itself for every case but one: it returns a bare
561	// `false` when the tokens are locked (Tokens::is_locked()). The lock is
562	// one-shot and self-healing.
563	return new \WP_Error(
564	'tokens_locked',
565	sprintf( 'Tokens are locked; %s:%s:%d could not be verified', $token_key, $version, $user_id ),
566	$this->build_connection_error_data( $signature_details, $error_type, $error_direction )
567	);
568	}
569
570	$jetpack_signature = new \Jetpack_Signature( $token->secret, (int) \Jetpack_Options::get_option( 'time_diff' ) );
571	// phpcs:disable WordPress.Security.NonceVerification.Missing -- Used to verify a cryptographic signature of the post data. Also a nonce is verified later in the function.
572	if ( isset( $_POST['_jetpack_is_multipart'] ) ) {
573	$post_data = $_POST; // We need all of $_POST in order to verify a cryptographic signature of the post data.
574	$file_hashes = array();
575	foreach ( $post_data as $post_data_key => $post_data_value ) {
576	if ( ! str_starts_with( $post_data_key, '_jetpack_file_hmac_' ) ) {
577	continue;
578	}
579	$post_data_key = substr( $post_data_key, strlen( '_jetpack_file_hmac_' ) );
580	$file_hashes[ $post_data_key ] = $post_data_value;
581	}
582
583	foreach ( $file_hashes as $post_data_key => $post_data_value ) {
584	unset( $post_data[ "_jetpack_file_hmac_{$post_data_key}" ] );
585	$post_data[ $post_data_key ] = $post_data_value;
586	}
587
588	ksort( $post_data );
589
590	$body = http_build_query( stripslashes_deep( $post_data ) );
591	} elseif ( $this->raw_post_data === null ) {
592	$body = file_get_contents( 'php://input' );
593	} else {
594	$body = null;
595	}
596	// phpcs:enable
597
598	$signature = $jetpack_signature->sign_current_request(
599	array( 'body' => $body === null ? $this->raw_post_data : $body )
600	);
601
602	$signature_details['url'] = $jetpack_signature->current_request_url;
603
604	// This path currently can't ever be true, unless a new path is added resulting
605	// in $signature 'false', null or an empty string. Leaving for additional security.
606	if ( ! $signature ) {
607	return new \WP_Error(
608	'could_not_sign',
609	'Unknown signature error',
610	$this->build_connection_error_data( $signature_details, $error_type, $error_direction )
611	);
612	} elseif ( is_wp_error( $signature ) ) {
613	// Jetpack_Signature errors carry their own signature_details (or, for some codes,
614	// no data at all) but never a type or direction; normalize them into the standard
615	// error data shape so Error_Handler can attribute and store them.
616	$signature_error_data = $signature->get_error_data();
617	if ( isset( $signature_error_data['signature_details'] ) && is_array( $signature_error_data['signature_details'] ) ) {
618	$signature_details = array_merge( $signature_details, $signature_error_data['signature_details'] );
619	}
620	$signature->add_data( $this->build_connection_error_data( $signature_details, $error_type, $error_direction ) );
621	return $signature;
622	}
623
624	// phpcs:disable WordPress.Security.NonceVerification.Recommended
625	$timestamp = (int) $_GET['timestamp'];
626	$nonce = wp_unslash( (string) $_GET['nonce'] ); // phpcs:ignore WordPress.Security.ValidatedSanitizedInput.InputNotSanitized -- WP Core doesn't sanitize nonces either.
627	// phpcs:enable WordPress.Security.NonceVerification.Recommended
628
629	// Use up the nonce regardless of whether the signature matches.
630	if ( ! ( new Nonce_Handler() )->add( $timestamp, $nonce ) ) {
631	return new \WP_Error(
632	'invalid_nonce',
633	'Could not add nonce',
634	$this->build_connection_error_data( $signature_details, $error_type, $error_direction )
635	);
636	}
637
638	// Be careful about what you do with this debugging data.
639	// If a malicious requester has access to the expected signature,
640	// bad things might be possible.
641	$signature_details['expected'] = $signature;
642
643	// phpcs:ignore WordPress.Security.NonceVerification.Recommended
644	if ( ! hash_equals( $signature, wp_unslash( $_GET['signature'] ) ) ) {
645	return new \WP_Error(
646	'signature_mismatch',
647	'Signature mismatch',
648	$this->build_connection_error_data( $signature_details, $error_type, $error_direction )
649	);
650	}
651
652	/**
653	* Action for additional token checking.
654	*
655	* @since 1.7.0
656	* @since-jetpack 7.7.0
657	*
658	* @param array $post_data request data.
659	* @param array $token_data token data.
660	*/
661	return apply_filters(
662	'jetpack_signature_check_token',
663	array(
664	'type' => $token_type,
665	'token_key' => $token_key,
666	'user_id' => $token->external_user_id,
667	),
668	$token,
669	$this->raw_post_data
670	);
671	}
672
673	/**
674	* Determines the transport of the incoming request currently being verified.
675	*
676	* @since 8.9.0
677	*
678	* @return string Error_Handler::ERROR_TYPE_XMLRPC or Error_Handler::ERROR_TYPE_REST.
679	*/
680	private function get_current_request_transport() {
681	$is_xmlrpc = defined( 'XMLRPC_REQUEST' ) && XMLRPC_REQUEST;
682
683	// XMLRPC_REQUEST covers both /xmlrpc.php and the alternate XML-RPC endpoint, which
684	// defines the constant itself (see setup_xmlrpc_handlers). Outside those, signed REST
685	// requests are detected via the REST dispatch state. Anything else (e.g. signed
686	// requests verified on the 'authenticate' filter for regular URLs) keeps the historic
687	// XML-RPC label rather than guessing at a transport.
688	$is_rest = ! $is_xmlrpc && ( function_exists( 'wp_is_rest_endpoint' ) ? wp_is_rest_endpoint() : ( defined( 'REST_REQUEST' ) && REST_REQUEST ) );
689
690	// Signature verification can run before REST dispatch is set up: REST_Authentication
691	// hooks `determine_current_user`, which any plugin can trigger early (e.g. by calling
692	// wp_get_current_user() on plugins_loaded), before the REST_REQUEST constant exists.
693	// In that window, recognize REST requests by their URL: the REST prefix in the path,
694	// or the rest_route query argument used by sites without pretty permalinks.
695	if ( ! $is_xmlrpc && ! $is_rest ) {
696	// phpcs:ignore WordPress.Security.NonceVerification.Recommended -- Only used to classify the request transport.
697	$has_rest_route_arg = isset( $_GET['rest_route'] );
698	$request_path = (string) wp_parse_url( isset( $_SERVER['REQUEST_URI'] ) ? wp_unslash( $_SERVER['REQUEST_URI'] ) : '', PHP_URL_PATH ); // phpcs:ignore WordPress.Security.ValidatedSanitizedInput.InputNotSanitized -- Parsed for path comparison only.
699	$is_rest = $has_rest_route_arg \|\| false !== strpos( $request_path, '/' . rest_get_url_prefix() . '/' );
700	}
701
702	// The literals match Error_Handler::ERROR_TYPE_REST / ERROR_TYPE_XMLRPC — see
703	// build_connection_error_data() for why the constants are not referenced.
704	return $is_rest ? 'rest' : 'xmlrpc';
705	}
706
707	/**
708	* Builds the standardized connection error data attached to signature-verification errors.
709	*
710	* Wraps `Error_Handler::build_connection_error_data()`, falling back to the legacy
711	* error-data shape when the loaded Error_Handler predates that method: during a plugin
712	* update, an older version of the class can already be in memory while this file is the
713	* new one, and a mid-update request must never fatal. For the same reason, code in this
714	* class must not reference Error_Handler constants introduced along with that method
715	* ('xmlrpc', 'rest', 'local_state', 'incoming', 'outgoing') — use the literal values.
716	*
717	* @since 8.10.0
718	*
719	* @param array $signature_details Details of the request signature being verified.
720	* @param string $error_type The transport of the request: 'xmlrpc' or 'rest'.
721	* @param string $error_direction The direction of the request: 'incoming' or 'outgoing'.
722	* @return array Error data for `WP_Error`.
723	*/
724	private function build_connection_error_data( $signature_details, $error_type, $error_direction ) {
725	if ( ! method_exists( Error_Handler::class, 'build_connection_error_data' ) ) {
726	return compact( 'signature_details', 'error_type' );
727	}
728	return Error_Handler::build_connection_error_data( $signature_details, $error_type, $error_direction );
729	}
730
731	/**
732	* Returns true if the current site is connected to WordPress.com and has the minimum requirements to enable Jetpack UI.
733	*
734	* This method is deprecated since version 1.25.0 of this package. Please use has_connected_owner instead.
735	*
736	* Since this method has a wide spread use, we decided not to throw any deprecation warnings for now.
737	*
738	* @deprecated 1.25.0
739	* @see Manager::has_connected_owner
740	* @return bool is the site connected?
741	*/
742	public function is_active() {
743	return (bool) $this->get_tokens()->get_access_token( true );
744	}
745
746	/**
747	* Obtains an instance of the Tokens class.
748	*
749	* @return Tokens the Tokens object
750	*/
751	public function get_tokens() {
752	return new Tokens();
753	}
754
755	/**
756	* Returns true if the site has both a token and a blog id, which indicates a site has been registered.
757	*
758	* @access public
759	* @deprecated 1.12.1 Use is_connected instead
760	* @see Manager::is_connected
761	*
762	* @return bool
763	*/
764	public function is_registered() {
765	_deprecated_function( __METHOD__, '1.12.1' );
766	return $this->is_connected();
767	}
768
769	/**
770	* Returns true if the site has both a token and a blog id, which indicates a site has been connected.
771	*
772	* @access public
773	* @since 1.21.1
774	*
775	* @return bool
776	*/
777	public function is_connected() {
778	if ( self::$is_connected === null ) {
779	if ( ! self::$connection_invalidators_added ) {
780	$this->add_connection_status_invalidation_hooks();
781	}
782
783	$has_blog_id = (bool) \Jetpack_Options::get_option( 'id' );
784	if ( $has_blog_id ) {
785	self::$is_connected = (bool) $this->get_tokens()->get_access_token();
786	} else {
787	// Short-circuit, no need to check for tokens if there's no blog ID.
788	self::$is_connected = false;
789	}
790	}
791	return self::$is_connected;
792	}
793
794	/**
795	* Resets the memoized connection status.
796	* This will force the connection status to be recomputed on the next check.
797	*
798	* @since 5.0.0
799	*/
800	public function reset_connection_status() {
801	self::$is_connected = null;
802	self::$connection_owner_id = null;
803	}
804
805	/**
806	* Returns true if the site has at least one connected administrator.
807	*
808	* @access public
809	* @since 1.21.1
810	*
811	* @return bool
812	*/
813	public function has_connected_admin() {
814	return (bool) count( $this->get_connected_users( 'manage_options' ) );
815	}
816
817	/**
818	* Returns true if the site has any connected user.
819	*
820	* @access public
821	* @since 1.21.1
822	*
823	* @return bool
824	*/
825	public function has_connected_user() {
826	return (bool) count( $this->get_connected_users( 'any', 1 ) );
827	}
828
829	/**
830	* Returns an array of users that have user tokens for communicating with wpcom.
831	* Able to select by specific capability.
832	*
833	* @since 9.9.1 Added $limit parameter.
834	*
835	* @param string $capability The capability of the user.
836	* @param int\|null $limit How many connected users to get before returning.
837	* @return WP_User[] Array of WP_User objects if found.
838	*/
839	public function get_connected_users( $capability = 'any', $limit = null ) {
840	$connected_users = array();
841	$user_tokens = $this->get_tokens()->get_user_tokens();
842
843	if ( ! is_array( $user_tokens ) \|\| empty( $user_tokens ) ) {
844	return $connected_users;
845	}
846	$connected_user_ids = array_keys( $user_tokens );
847
848	if ( ! empty( $connected_user_ids ) ) {
849	foreach ( $connected_user_ids as $id ) {
850	// Check for capability.
851	if ( 'any' !== $capability && ! user_can( $id, $capability ) ) {
852	continue;
853	}
854
855	$user_data = get_userdata( $id );
856	if ( $user_data instanceof \WP_User ) {
857	$connected_users[] = $user_data;
858	if ( $limit && count( $connected_users ) >= $limit ) {
859	return $connected_users;
860	}
861	}
862	}
863	}
864
865	return $connected_users;
866	}
867
868	/**
869	* Returns true if the site has a connected Blog owner (master_user).
870	*
871	* @access public
872	* @since 1.21.1
873	*
874	* @return bool
875	*/
876	public function has_connected_owner() {
877	return (bool) $this->get_connection_owner_id();
878	}
879
880	/**
881	* Returns true if the site is connected only at a site level.
882	*
883	* Note that we are explicitly checking for the existence of the master_user option in order to account for cases where we don't have any user tokens (user-level connection) but the master_user option is set, which could be the result of a problematic user connection.
884	*
885	* @access public
886	* @since 1.25.0
887	* @deprecated 1.27.0
888	*
889	* @return bool
890	*/
891	public function is_userless() {
892	_deprecated_function( __METHOD__, '1.27.0', 'Automattic\\Jetpack\\Connection\\Manager::is_site_connection' );
893	return $this->is_site_connection();
894	}
895
896	/**
897	* Returns true if the site is connected only at a site level.
898	*
899	* Note that we are explicitly checking for the existence of the master_user option in order to account for cases where we don't have any user tokens (user-level connection) but the master_user option is set, which could be the result of a problematic user connection.
900	*
901	* @access public
902	* @since 1.27.0
903	*
904	* @return bool
905	*/
906	public function is_site_connection() {
907	return $this->is_connected() && ! $this->has_connected_user() && ! \Jetpack_Options::get_option( 'master_user' );
908	}
909
910	/**
911	* Checks to see if the connection owner of the site is missing.
912	*
913	* @return bool
914	*/
915	public function is_missing_connection_owner() {
916	$connection_owner = $this->get_connection_owner_id();
917	if ( ! get_user_by( 'id', $connection_owner ) ) {
918	return true;
919	}
920
921	return false;
922	}
923
924	/**
925	* Returns true if the user with the specified identifier is connected to
926	* WordPress.com.
927	*
928	* @param int $user_id the user identifier. Default is the current user.
929	* @return bool Boolean is the user connected?
930	*/
931	public function is_user_connected( $user_id = false ) {
932	$user_id = false === $user_id ? get_current_user_id() : absint( $user_id );
933	if ( ! $user_id ) {
934	return false;
935	}
936
937	return (bool) $this->get_tokens()->get_access_token( $user_id );
938	}
939
940	/**
941	* Returns the local user ID of the connection owner.
942	*
943	* @return bool\|int Returns the ID of the connection owner or False if no connection owner found.
944	*/
945	public function get_connection_owner_id() {
946	// Check if the memoized value is available.
947	if ( null === self::$connection_owner_id ) {
948	$owner = $this->get_connection_owner();
949	self::$connection_owner_id = $owner instanceof \WP_User ? $owner->ID : 0;
950	}
951
952	// If the ID is set to 0, there's no valid connection owner.
953	return self::$connection_owner_id > 0 ? self::$connection_owner_id : false;
954	}
955
956	/**
957	* Get the wpcom user data of the current\|specified connected user.
958	*
959	* Fetches the data from the WordPress.com `jetpack-wpcom-user-data` REST endpoint
960	* with a signed request as the connected user. Routing this through
961	* Client::remote_request() (rather than the legacy `wpcom.getUser` XML-RPC method)
962	* ensures any connection errors are captured by the Error_Handler.
963	*
964	* @since 8.8.1 Fetch the data over REST instead of the `wpcom.getUser` XML-RPC method.
965	*
966	* @param int\|null $user_id the user identifier.
967	* @return bool\|array An array with the WPCOM user data on success, false otherwise.
968	*/
969	public function get_connected_user_data( $user_id = null ) {
970	if ( ! $user_id ) {
971	$user_id = get_current_user_id();
972	}
973
974	// Check if the user is connected and return false otherwise.
975	if ( ! $this->is_user_connected( $user_id ) ) {
976	return false;
977	}
978
979	$transient_key = "jetpack_connected_user_data_$user_id";
980	$cached_user_data = get_transient( $transient_key );
981
982	if ( 'error' === $cached_user_data ) {
983	return false;
984	}
985
986	if ( $cached_user_data ) {
987	return $cached_user_data;
988	}
989
990	$blog_id = (int) \Jetpack_Options::get_option( 'id' );
991
992	// Build a signed request as the connected user. We can't use
993	// Client::wpcom_json_api_request_as_user() because it always signs as the
994	// current user, whereas this method may be called for an arbitrary $user_id.
995	$args = Client::validate_args_for_wpcom_json_api_request(
996	"/sites/{$blog_id}/jetpack-wpcom-user-data",
997	'2',
998	array( 'method' => 'GET' )
999	);
1000	$args['user_id'] = $user_id;
1001
1002	$response = Client::remote_request( $args );
1003
1004	if ( is_wp_error( $response ) \|\| 200 !== wp_remote_retrieve_response_code( $response ) ) {
1005	// Cache errors briefly so a failing remote request doesn't result in
1006	// a blocking request on every call, e.g. on each admin page
1007	// load via Initial_State::set_connection_script_data().
1008	set_transient( $transient_key, 'error', 5 * MINUTE_IN_SECONDS );
1009
1010	return false;
1011	}
1012
1013	$user_data = json_decode( wp_remote_retrieve_body( $response ), true );
1014
1015	if ( ! is_array( $user_data ) \|\| empty( $user_data ) ) {
1016	set_transient( $transient_key, 'error', 5 * MINUTE_IN_SECONDS );
1017
1018	return false;
1019	}
1020
1021	set_transient( $transient_key, $user_data, DAY_IN_SECONDS );
1022
1023	return $user_data;
1024	}
1025
1026	/**
1027	* Returns the WordPress.com user ID of a connected user.
1028	*
1029	* Answers only for a user who currently holds a token: the binding outlives any one token, so
1030	* connectedness is checked here rather than inferred from a row existing. Resolving an unbound
1031	* user costs a blocking request to WordPress.com, so this is not safe to call per row.
1032	*
1033	* @since 9.2.0
1034	*
1035	* @param int\|false $user_id The local user identifier. Default is the current user.
1036	* @return int The WordPress.com user ID, or 0 if it could not be determined.
1037	*/
1038	public function resolve_wpcom_user_id( $user_id = false ) {
1039	$user_id = $user_id ? absint( $user_id ) : get_current_user_id();
1040
1041	// The binding outlives the token, unlike the transient behind `get_connected_user_data()`,
1042	// so connectedness is checked here rather than left to the lookup below.
1043	if ( ! $user_id \|\| ! $this->is_user_connected( $user_id ) ) {
1044	return 0;
1045	}
1046
1047	$bound = Utils::get_wpcom_user_id( $user_id );
1048
1049	if ( $bound ) {
1050	return $bound;
1051	}
1052
1053	$user_data = $this->get_connected_user_data( $user_id );
1054
1055	// Callers must read 0 as "unknown", never as "no match": a failed lookup lands here too.
1056	if ( empty( $user_data['ID'] ) ) {
1057	return 0;
1058	}
1059
1060	Utils::set_wpcom_user_id( $user_id, (int) $user_data['ID'] );
1061
1062	return (int) $user_data['ID'];
1063	}
1064
1065	/**
1066	* Unbind the WordPress.com user ID of any user whose token is new.
1067	*
1068	* Every path that changes a user's token writes the `user_tokens` option, so this covers
1069	* authorize, remote connect and the REST endpoint alike. A token that is added or replaced can
1070	* name a different WordPress.com account, so any binding it would answer with is unverified. A
1071	* token merely removed leaves the binding correct, and other subsystems store their own meaning
1072	* in the same meta, so removals are left alone.
1073	*
1074	* @internal Hooked on `pre_update_jetpack_option_user_tokens`, which fires before the write.
1075	* @since 9.2.0
1076	*
1077	* @param string $name The option name.
1078	* @param mixed $value The tokens about to be written.
1079	*/
1080	public function unbind_wpcom_user_ids_for_new_tokens( $name, $value ) {
1081	if ( ! is_array( $value ) ) {
1082	return;
1083	}
1084
1085	// A site disconnect deletes the option outright, so the first write back has nothing to
1086	// diff against — treat that as every token being new rather than skipping the check.
1087	$previous = \Jetpack_Options::get_option( 'user_tokens' );
1088	$previous = is_array( $previous ) ? $previous : array();
1089
1090	// Iterating the incoming tokens covers a token being added as well as replaced, and skips
1091	// removal for free: a user absent from the new set is never visited.
1092	foreach ( $value as $user_id => $token ) {
1093	if ( ( $previous[ $user_id ] ?? null ) !== $token ) {
1094	Utils::delete_wpcom_user_id( $user_id );
1095	}
1096	}
1097	}
1098
1099	/**
1100	* Drop the cached WordPress.com site record.
1101	*
1102	* A caller that fetched the record by another route holds something newer than the cache can,
1103	* and `jetpack_site_data_fetched` fires on a cached read too. The cached copy has to go, or it
1104	* keeps announcing the older record and undoes what that caller stored.
1105	*
1106	* @since 9.0.0
1107	*
1108	* @return void
1109	*/
1110	public static function delete_cached_site_data() {
1111	$site_id = \Jetpack_Options::get_option( 'id' );
1112
1113	if ( $site_id ) {
1114	delete_transient( self::SITE_DATA_TRANSIENT_PREFIX . $site_id );
1115	}
1116	}
1117
1118	/**
1119	* Fetch the site's own record from the WordPress.com `/sites/%d` endpoint.
1120	*
1121	* The result is cached briefly. Every plugin that bundles this package serves this route, and
1122	* the Jetpack dashboard requests it on mount, so an uncached read means a blocking round trip
1123	* per render.
1124	*
1125	* @since 8.10.0
1126	*
1127	* @return object\|WP_Error The decoded site record, or an error describing the failure.
1128	*/
1129	public function get_connected_site_data() {
1130	$site_id = \Jetpack_Options::get_option( 'id' );
1131
1132	if ( ! $site_id ) {
1133	return new WP_Error( 'site_id_missing', '', array( 'api_error_code' => 'site_id_missing' ) );
1134	}
1135
1136	$sandbox_secret = null;
1137
1138	// An array cookie (`store_sandbox[]=`) carries no secret to send, and `filter_var()` turns
1139	// it into `false`.
1140	if ( isset( $_COOKIE['store_sandbox'] ) && is_string( $_COOKIE['store_sandbox'] ) ) {
1141	// Keep only RFC 6265 cookie-octets so the value cannot break out of the Cookie header.
1142	$sandbox_secret = preg_replace( '/[^\x21-\x7E]\|[";,\\\\]/', '', filter_var( wp_unslash( $_COOKIE['store_sandbox'] ) ) );
1143
1144	// An empty cookie, or one the sanitizer strips to nothing, is not a sandbox secret.
1145	// Counting it as one opts the request out of the cache with no sandbox to reach.
1146	if ( '' === $sandbox_secret ) {
1147	$sandbox_secret = null;
1148	}
1149	}
1150
1151	// A sandboxed request must neither read the shared cache nor seed it with sandbox data.
1152	$sandboxed = null !== $sandbox_secret;
1153	$transient_key = self::SITE_DATA_TRANSIENT_PREFIX . $site_id;
1154
1155	// WordPress.com itself requests this route right after a purchase, for the side effect of
1156	// the `jetpack_site_data_fetched` consumers storing the new plan. Those requests arrive
1157	// signed with a connection token, which no browser request carries. A cached read would
1158	// hand that refresh the pre-purchase record and turn it into a no-op, so a signed request
1159	// always reads from WordPress.com and replaces the cache with the record it fetched.
1160	$signed = Rest_Authentication::is_signed_with_blog_token() \|\| Rest_Authentication::is_signed_with_user_token();
1161
1162	$result = ( $sandboxed \|\| $signed ) ? false : get_transient( $transient_key );
1163
1164	// Only the array shape stored below can be served. A `pre_transient_*` filter or a damaged
1165	// object cache entry can hand back anything, and a non-array would throw on
1166	// `$result['body']` for every request until the entry expired, so it reads as a miss.
1167	if ( ! is_array( $result ) ) {
1168	$result = $this->fetch_connected_site_data( $site_id, $sandbox_secret );
1169
1170	// A signed read that failed must not replace a still-usable cached record with the failure.
1171	if ( ! $sandboxed && ! ( $signed && isset( $result['error'] ) ) ) {
1172	// Failures expire sooner so an outage recovers without waiting out a full success window.
1173	set_transient(
1174	$transient_key,
1175	$result,
1176	isset( $result['error'] ) ? 2 * MINUTE_IN_SECONDS : 5 * MINUTE_IN_SECONDS
1177	);
1178	}
1179	}
1180
1181	if ( isset( $result['error'] ) ) {
1182	return new WP_Error( 'site_data_fetch_failed', '', $result['error'] );
1183	}
1184
1185	/**
1186	* Fires after the site record was served, whether it was fetched or read from the cache.
1187	*
1188	* Consumers that cache anything derived from the record, such as the current plan,
1189	* can refresh it here.
1190	*
1191	* This fires on a cached read too, so a consumer stays in step with every request that
1192	* serves the record rather than only the ones that reached WordPress.com.
1193	*
1194	* The record is passed as an array rather than the object this method returns, so that a
1195	* listener cannot mutate the instance that becomes the REST response.
1196	*
1197	* @since 9.0.0
1198	*
1199	* @param array $record The decoded site record from the WordPress.com `/sites/%d` endpoint.
1200	*/
1201	do_action( 'jetpack_site_data_fetched', json_decode( $result['body'], true ) );
1202
1203	return json_decode( $result['body'] );
1204	}
1205
1206	/**
1207	* Request the site record from WordPress.com.
1208	*
1209	* Returns a cacheable array rather than the decoded record so that both outcomes survive a
1210	* round trip through a transient.
1211	*
1212	* @since 9.0.0
1213	*
1214	* @param int $site_id The WordPress.com blog ID.
1215	* @param string\|null $sandbox_secret Sanitized store sandbox cookie value, or null when not sandboxed.
1216	* @return array Either `array( 'body' => string )` or `array( 'error' => array )`.
1217	*/
1218	private function fetch_connected_site_data( $site_id, $sandbox_secret ) {
1219	$args = array( 'headers' => array() );
1220
1221	// Allow use a store sandbox. Internal ref: PCYsg-IA-p2.
1222	if ( null !== $sandbox_secret ) {
1223	$args['headers']['Cookie'] = "store_sandbox=$sandbox_secret;";
1224	}
1225
1226	$response = Client::wpcom_json_api_request_as_blog( sprintf( '/sites/%d', $site_id ) . '?force=wpcom', '1.1', $args );
1227	$body = wp_remote_retrieve_body( $response );
1228	$data = $body ? json_decode( $body ) : null;
1229
1230	if ( 200 !== wp_remote_retrieve_response_code( $response ) ) {
1231	$error_info = array(
1232	'api_error_code' => null,
1233	'api_http_code' => wp_remote_retrieve_response_code( $response ),
1234	);
1235
1236	if ( is_wp_error( $response ) ) {
1237	$error_info['api_error_code'] = $response->get_error_code() ? wp_strip_all_tags( $response->get_error_code() ) : null;
1238	} elseif ( $data && ! empty( $data->error ) ) {
1239	$error_info['api_error_code'] = is_string( $data->error ) ? wp_strip_all_tags( $data->error ) : null;
1240	}
1241
1242	return array( 'error' => $error_info );
1243	}
1244
1245	if ( ! is_object( $data ) ) {
1246	return array(
1247	'error' => array(
1248	'api_error_code' => 'invalid_body',
1249	'api_http_code' => 200,
1250	),
1251	);
1252	}
1253
1254	return array( 'body' => $body );
1255	}
1256
1257	/**
1258	* Returns a user object of the connection owner.
1259	*
1260	* @return WP_User\|false False if no connection owner found.
1261	*/
1262	public function get_connection_owner() {
1263	$user_id = \Jetpack_Options::get_option( 'master_user' );
1264	if ( ! $user_id ) {
1265	return false;
1266	}
1267
1268	// Make sure user is connected.
1269	$user_token = $this->get_tokens()->get_access_token( $user_id );
1270
1271	$connection_owner = false;
1272
1273	if ( $user_token && is_object( $user_token ) && isset( $user_token->external_user_id ) ) {
1274	$connection_owner = get_userdata( $user_token->external_user_id );
1275	}
1276
1277	// Reporting is best-effort and must never fatal a request running mid-plugin-update:
1278	// skip it when the already-loaded Error_Handler is a stale version predating the factory.
1279	if ( $connection_owner === false && method_exists( Error_Handler::class, 'build_connection_wp_error' ) ) {
1280	Error_Handler::get_instance()->report_error(
1281	Error_Handler::build_connection_wp_error(
1282	'invalid_connection_owner',
1283	'Invalid connection owner',
1284	array( 'token' => '' ),
1285	'local_state', // Error_Handler::ERROR_TYPE_LOCAL_STATE.
1286	'', // Local-state errors describe the site's database, not a request, so they have no direction.
1287	array(
1288	'user_id' => $user_id,
1289	'has_user_token' => (bool) $user_token,
1290	)
1291	),
1292	false,
1293	true
1294	);
1295	}
1296
1297	return $connection_owner;
1298	}
1299
1300	/**
1301	* Returns true if the provided user is the Jetpack connection owner.
1302	* If user ID is not specified, the current user will be used.
1303	*
1304	* @param int\|bool $user_id the user identifier. False for current user.
1305	* @return bool True the user the connection owner, false otherwise.
1306	*/
1307	public function is_connection_owner( $user_id = false ) {
1308	if ( ! $user_id ) {
1309	$user_id = get_current_user_id();
1310	}
1311
1312	return ( (int) $user_id ) === $this->get_connection_owner_id();
1313	}
1314
1315	/**
1316	* Determines whether the connection ownership can be transferred to another user.
1317	*
1318	* The default Jetpack connection uses a transferable ownership model. A set protected owner
1319	* anchor locks it outright; otherwise a consumer can declare ownership locked by returning
1320	* `false` from the `jetpack_connection_ownership_transferable` filter. This is the single
1321	* chokepoint used both when deciding which connection-error CTA to surface and (eventually)
1322	* when performing an ownership change.
1323	*
1324	* @since 8.8.0
1325	* @since 9.3.0 A locked protected owner anchor makes ownership non-transferable.
1326	*
1327	* @return bool True if ownership can be transferred, false if it is locked.
1328	*/
1329	public function is_ownership_transferable() {
1330	// Keyed on the anchor, never on has_protected_owner(): an owner who does not match the
1331	// anchor is exactly when ownership must stay locked.
1332	if ( Protected_Owner::is_locked() ) {
1333	return false;
1334	}
1335
1336	/**
1337	* Filters whether the Jetpack connection ownership can be transferred.
1338	*
1339	* Return `false` to lock ownership so it can never be taken over.
1340	*
1341	* @since 8.8.0
1342	*
1343	* @param bool $transferable Whether ownership can be transferred. Default true.
1344	*/
1345	return (bool) apply_filters( 'jetpack_connection_ownership_transferable', true );
1346	}
1347
1348	/**
1349	* Whether a protected owner is required right now.
1350	*
1351	* Evaluated at the moment of the request, not as a standing declaration: a consumer may
1352	* legitimately answer false while it is installed and active — running in test mode, say —
1353	* and true only at the lifecycle moment that binds something to the owner's identity.
1354	*
1355	* @since 9.3.0
1356	*
1357	* @return bool True if a protected owner is required at this moment. Default false.
1358	*/
1359	public function requires_protected_owner() {
1360	/**
1361	* Filters whether a protected owner is required at this moment.
1362	*
1363	* Return `true` at the point a feature is about to bind to the connection owner's
1364	* identity. Answering false at other times is expected and supported.
1365	*
1366	* @since 9.3.0
1367	*
1368	* @param bool $required Whether a protected owner is required. Default false.
1369	*/
1370	return (bool) apply_filters( 'jetpack_connection_requires_protected_owner', false );
1371	}
1372
1373	/**
1374	* Whether the connection owner is the protected owner the anchor names.
1375	*
1376	* This is the question consumers gate on before binding anything to the owner's identity.
1377	*
1378	* Reads the binding of the current owner rather than searching for whoever holds the anchored
1379	* ID, so a row on any other user cannot affect the answer. Requiring the owner to hold a live
1380	* token on top of that is what keeps a row written by another subsystem from ever satisfying
1381	* this: both halves are load-bearing, and there are tests for each.
1382	*
1383	* @since 9.3.0
1384	*
1385	* @return bool
1386	*/
1387	public function has_protected_owner() {
1388	$anchor = Protected_Owner::get_locked();
1389
1390	if ( ! $anchor ) {
1391	return false;
1392	}
1393
1394	$owner_id = $this->get_connection_owner_id();
1395
1396	if ( ! $owner_id ) {
1397	return false;
1398	}
1399
1400	return $this->resolve_wpcom_user_id( $owner_id ) === (int) $anchor['wpcom_user_id'];
1401	}
1402
1403	/**
1404	* Classify why `has_protected_owner()` answered false, and what would change it.
1405	*
1406	* Deliberately inspects only what the gate inspects — the anchor and the current connection
1407	* owner — so the two can never disagree about the same site. Anything needing a user search or
1408	* a reachability probe is a different question and is not answered here.
1409	*
1410	* `is_current_user_the_po` reads the current user's own stored binding, never a search for
1411	* whoever holds the anchored ID, so it cannot be confused by a second user carrying the same
1412	* meta, and never costs a network call. It is a hint for copy, not a gate.
1413	*
1414	* @since 9.4.0
1415	*
1416	* @return array{status: string, is_current_user_the_po: bool}
1417	*/
1418	public function resolve_protected_owner_state() {
1419	$anchor = Protected_Owner::get_locked();
1420	$current_id = get_current_user_id();
1421
1422	// Only meaningful against an anchor: with none, there is nothing for the user to be.
1423	// Reads the stored binding rather than resolving it, so classifying a state never costs a
1424	// WordPress.com round trip. An unbound user reads as false and gets the generic copy.
1425	$is_current_user_the_po = $anchor
1426	&& Utils::get_wpcom_user_id( $current_id ) === (int) $anchor['wpcom_user_id'];
1427
1428	if ( ! $anchor ) {
1429	$roles = new Roles();
1430
1431	if ( ! current_user_can( 'jetpack_connect' ) \|\| ! current_user_can( $roles->translate_role_to_cap( 'administrator' ) ) ) {
1432	// Eligibility is being an admin, not holding the master slot.
1433	$status = self::PO_STATE_NOT_ELIGIBLE;
1434	} elseif ( ! $this->is_user_connected( $current_id ) ) {
1435	// A WordPress.com identity has to exist before it can be confirmed and locked.
1436	$status = self::PO_STATE_NEEDS_CONNECT_TO_ESTABLISH;
1437	} else {
1438	$status = self::PO_STATE_CAN_ESTABLISH;
1439	}
1440	} else {
1441	$owner_id = $this->get_connection_owner_id();
1442	$owner_wpcom_id = $owner_id ? $this->resolve_wpcom_user_id( $owner_id ) : 0;
1443
1444	if ( ! $owner_wpcom_id ) {
1445	// A zero is "could not determine", never "does not match", so an owner whose
1446	// identity cannot be confirmed is reported as needing to reconnect, not replaced.
1447	$status = self::PO_STATE_NEEDS_OWNER_RECONNECT;
1448	} elseif ( $owner_wpcom_id !== (int) $anchor['wpcom_user_id'] ) {
1449	// Legitimate, not broken: the first admin to connect takes a vacant master slot,
1450	// so an agency can hold it while the protected owner is away.
1451	$status = self::PO_STATE_NEEDS_DIFFERENT_OWNER;
1452	} else {
1453	$status = self::PO_STATE_RE_EVALUATE;
1454	}
1455	}
1456
1457	return array(
1458	'status' => $status,
1459	'is_current_user_the_po' => $is_current_user_the_po,
1460	);
1461	}
1462
1463	/**
1464	* Reconcile this site's protected owner against WordPress.com, which is the owner of record.
1465	*
1466	* Runs at connect, when the site has a fresh user token and an answer is cheap, and only once
1467	* something is anchored: a site with no protected owner asks nothing and behaves as it did
1468	* before this existed. One answer settles the rest — whether an owner still exists, whether
1469	* the anchor names them, and whether the user connecting is them — so the anchor, the binding
1470	* and the master slot are decided together rather than from two calls that could disagree.
1471	*
1472	* Only an answer moves anything. Unreachable, refused, unimplemented and malformed leave the
1473	* anchor exactly as it was: it was confirmed once, and a request that never arrived is no
1474	* evidence against it.
1475	*
1476	* @internal Hooked on `jetpack_user_authorized`.
1477	* @since 9.8.0
1478	*
1479	* @return bool Whether WordPress.com confirmed the anchored identity.
1480	*/
1481	public function reconcile_protected_owner() {
1482	$user_id = get_current_user_id();
1483
1484	if ( ! $user_id ) {
1485	return false;
1486	}
1487
1488	$anchor = Protected_Owner::get();
1489
1490	// Nothing anchored is nothing to reconcile, and a site with no protected owner must behave
1491	// exactly as it did before this existed — including making no request. Such a site reaches
1492	// an owner through the claim instead, which is where confirming belongs.
1493	if ( ! $anchor ) {
1494	return false;
1495	}
1496
1497	$record = $this->query_protected_owner_record( (int) $anchor['wpcom_user_id'] );
1498
1499	// Silence is not an answer. Unreachable, refused and unimplemented leave the anchor exactly
1500	// as it was: it was confirmed once, and a request that never arrived is no evidence against
1501	// it. Dropping a good lock because WordPress.com had a bad minute costs a merchant their
1502	// payouts until the owner happens to connect again.
1503	if ( ! is_array( $record ) \|\| ! isset( $record['has_owner'] ) ) {
1504	return false;
1505	}
1506
1507	// WordPress.com no longer has an owner of record, so neither does this site. Support
1508	// clearing it at that end is how a wrongly anchored site recovers.
1509	if ( ! $record['has_owner'] ) {
1510	Protected_Owner::clear();
1511
1512	return false;
1513	}
1514
1515	$caller_wpcom_user_id = (int) ( $record['caller_wpcom_user_id'] ?? 0 );
1516
1517	// The identity is disclosed only to the owner it names, so this is the one branch that can
1518	// learn it — and what it settles is which account the anchor should name, since
1519	// WordPress.com may have moved the owner since this site last asked.
1520	if ( ! empty( $record['is_caller'] ) ) {
1521	return $this->adopt_protected_owner( $user_id, $caller_wpcom_user_id, $anchor );
1522	}
1523
1524	// Connecting cleared this, and it is the caller's own identity rather than the owner's, so
1525	// it is written whoever they are. Nothing is anchored on this path, so an early write
1526	// cannot strand a half-finished lock.
1527	if ( $caller_wpcom_user_id ) {
1528	Utils::set_wpcom_user_id( $user_id, $caller_wpcom_user_id );
1529	}
1530
1531	// Somebody else is connecting. WordPress.com confirms the anchored identity rather than
1532	// naming the owner, so the answer is the same whoever asks.
1533	if ( empty( $record['matches'] ) ) {
1534	Protected_Owner::clear();
1535
1536	return false;
1537	}
1538
1539	return true;
1540	}
1541
1542	/**
1543	* Take WordPress.com's word that the connecting user owns this site.
1544	*
1545	* @since 9.8.0
1546	*
1547	* @param int $user_id The connecting local user.
1548	* @param int $wpcom_user_id The connecting user's WordPress.com identity, which this
1549	* branch has just been told is the owner of record.
1550	* @param array\|null $anchor What this site has anchored, if anything.
1551	* @return bool Whether the anchor now names that identity.
1552	*/
1553	private function adopt_protected_owner( $user_id, $wpcom_user_id, $anchor ) {
1554	// An owner without an identity is a malformed answer, and trusting it would lock the site
1555	// to nobody.
1556	if ( ! $wpcom_user_id ) {
1557	return false;
1558	}
1559
1560	// Anchored before the binding, so a failed write leaves nothing behind for a later
1561	// connection to build on. Re-pointing only moves the cached local ID, so it is right only
1562	// while the anchored identity is the one WordPress.com just confirmed.
1563	if ( $anchor && (int) $anchor['wpcom_user_id'] === $wpcom_user_id ) {
1564	Protected_Owner::repoint( $user_id );
1565	} elseif ( ! Protected_Owner::set( $wpcom_user_id, $user_id ) ) {
1566	return false;
1567	}
1568
1569	// Connecting clears the binding, so this writes back the one the answer just confirmed.
1570	Utils::set_wpcom_user_id( $user_id, $wpcom_user_id );
1571
1572	// Eligibility for the master slot is being an administrator here, which the owner of record
1573	// need not be.
1574	if ( user_can( $user_id, ( new Roles() )->translate_role_to_cap( 'administrator' ) )
1575	&& (int) \Jetpack_Options::get_option( 'master_user' ) !== $user_id ) {
1576	\Jetpack_Options::update_option( 'master_user', $user_id );
1577	}
1578
1579	return true;
1580	}
1581
1582	/**
1583	* Ask WordPress.com whether it still holds the anchored identity as this site's owner.
1584	*
1585	* Split from `reconcile_protected_owner()` so the decision it drives can be exercised without a
1586	* network, which is the half worth testing: every branch of it changes whether a site gates a
1587	* live feature. The anchored ID is sent so the answer confirms rather than discloses.
1588	*
1589	* @since 9.8.0
1590	*
1591	* @param int $anchored_wpcom_user_id The WordPress.com identity this site has anchored.
1592	* @return array\|null The record, or null when WordPress.com could not answer.
1593	*/
1594	protected function query_protected_owner_record( $anchored_wpcom_user_id ) {
1595	$xml = new Jetpack_IXR_Client( array( 'user_id' => get_current_user_id() ) );
1596	$xml->query( 'jetpack.reconcileProtectedOwner', array( 'anchored_wpcom_user_id' => $anchored_wpcom_user_id ) );
1597
1598	if ( $xml->isError() ) {
1599	return null;
1600	}
1601
1602	$response = $xml->getResponse();
1603
1604	return is_array( $response ) ? $response : null;
1605	}
1606
1607	/**
1608	* Claim this site's protected ownership for the current user with WordPress.com.
1609	*
1610	* Split from `set_protected_owner()` so the decision it drives can be exercised without a
1611	* network. The identity travels in the signature rather than the payload, so nothing is sent.
1612	*
1613	* @since 9.8.0
1614	*
1615	* @return array\|null The record, or null when WordPress.com could not answer.
1616	*/
1617	protected function assert_protected_owner_record() {
1618	$xml = new Jetpack_IXR_Client( array( 'user_id' => get_current_user_id() ) );
1619	$xml->query( 'jetpack.assertProtectedOwner' );
1620
1621	if ( $xml->isError() ) {
1622	return null;
1623	}
1624
1625	$response = $xml->getResponse();
1626
1627	return is_array( $response ) ? $response : null;
1628	}
1629
1630	/**
1631	* Record a user as the protected owner and promote them to connection owner.
1632	*
1633	* Gated on `jetpack_connect` rather than on a role: a host can narrow that capability and
1634	* multisite does. It is false while the package is unconfigured, so a caller that has not
1635	* registered the connection's capabilities is refused rather than trusted.
1636	*
1637	* @since 9.3.0
1638	* @since 9.6.0 No longer takes how the owner was confirmed.
1639	* @since 9.8.0 WordPress.com records the owner before anything is anchored here.
1640	*
1641	* @param int $user_id The local user to anchor.
1642	* @return true\|WP_Error True on success, WP_Error otherwise.
1643	*/
1644	public function set_protected_owner( $user_id ) {
1645	// Authorization precedes validation, so an unauthorized caller cannot use the argument
1646	// errors below to learn which users are administrators or hold a token.
1647	if ( ! current_user_can( 'jetpack_connect' ) ) {
1648	return new WP_Error(
1649	'protected_owner_forbidden',
1650	__( 'You do not have permission to manage the protected owner.', 'jetpack-connection' ),
1651	array( 'status' => 403 )
1652	);
1653	}
1654
1655	$user_id = absint( $user_id );
1656	$roles = new Roles();
1657
1658	if ( ! user_can( $user_id, $roles->translate_role_to_cap( 'administrator' ) ) ) {
1659	return new WP_Error(
1660	'protected_owner_not_admin',
1661	__( 'The protected owner must be an administrator.', 'jetpack-connection' ),
1662	array( 'status' => 400 )
1663	);
1664	}
1665
1666	// The claim is signed as the current user, so it can only ever anchor the current user.
1667	// Anchoring somebody else would be an owner assignment they never agreed to.
1668	if ( $user_id !== get_current_user_id() ) {
1669	return new WP_Error(
1670	'protected_owner_not_self',
1671	__( 'A protected owner can only be recorded by the user confirming it.', 'jetpack-connection' ),
1672	array( 'status' => 400 )
1673	);
1674	}
1675
1676	// WordPress.com is asked before anything is written here. It owns the record, so a claim it
1677	// has not accepted must not leave a locked anchor behind on this site.
1678	$record = $this->assert_protected_owner_record();
1679
1680	// Fail closed: unreachable, refused, or a WordPress.com that does not implement the call.
1681	// A site that cannot get an answer must not end up protecting anybody on its own say-so.
1682	if ( ! is_array( $record ) \|\| empty( $record['status'] ) ) {
1683	return new WP_Error(
1684	'protected_owner_unconfirmed',
1685	__( 'Could not reach WordPress.com to confirm the protected owner.', 'jetpack-connection' ),
1686	array( 'status' => 503 )
1687	);
1688	}
1689
1690	// Somebody else already holds this site. Beyond support there is no way past this, which is
1691	// the point: an owner that could be overwritten by the next claimant protects nobody.
1692	if ( 'locked_to_other' === $record['status'] ) {
1693	return new WP_Error(
1694	'protected_owner_claimed_by_other',
1695	__( 'This site is already protected by a different WordPress.com account. Contact support.', 'jetpack-connection' ),
1696	array( 'status' => 409 )
1697	);
1698	}
1699
1700	// Only an accepted claim is anchored: any other verdict is refused, even one carrying an ID.
1701	if ( ! in_array( $record['status'], array( 'recorded', 'already_yours' ), true ) \|\| empty( $record['wpcom_user_id'] ) ) {
1702	return new WP_Error(
1703	'protected_owner_not_verified',
1704	__( 'Could not confirm the protected owner with WordPress.com.', 'jetpack-connection' ),
1705	array( 'status' => 400 )
1706	);
1707	}
1708
1709	// Store the binding the anchor will be compared against, so the gate reads local state from
1710	// here on. Routed through the deduping writer, which clears the ID off any previous holder.
1711	Utils::set_wpcom_user_id( $user_id, (int) $record['wpcom_user_id'] );
1712
1713	if ( ! Protected_Owner::set( (int) $record['wpcom_user_id'], $user_id ) ) {
1714	return new WP_Error(
1715	'protected_owner_not_stored',
1716	__( 'Could not store the protected owner.', 'jetpack-connection' ),
1717	array( 'status' => 500 )
1718	);
1719	}
1720
1721	// Written directly rather than through update_connection_owner(): that round-trips to
1722	// WordPress.com first, and its ownership-change guard will refuse the anchor just set here.
1723	\Jetpack_Options::update_option( 'master_user', $user_id );
1724
1725	return true;
1726	}
1727
1728	/**
1729	* Drop the protected owner anchor, unlocking ownership.
1730	*
1731	* Gated on `jetpack_connect` like establishing one, releasing a lock being the more
1732	* consequential half. The `@internal` tag is documentation; the capability is enforcement.
1733	*
1734	* @internal Recovery and support flows only. Consumers must not call this.
1735	* @since 9.3.0
1736	*
1737	* @return true\|WP_Error True once no anchor is set, WP_Error otherwise.
1738	*/
1739	public function clear_protected_owner() {
1740	if ( ! current_user_can( 'jetpack_connect' ) ) {
1741	return new WP_Error(
1742	'protected_owner_forbidden',
1743	__( 'You do not have permission to manage the protected owner.', 'jetpack-connection' ),
1744	array( 'status' => 403 )
1745	);
1746	}
1747
1748	Protected_Owner::clear();
1749
1750	// Asked of the outcome rather than of `delete_option()`, which also reports false for an
1751	// anchor that was already absent — the state the caller asked for.
1752	if ( Protected_Owner::get() ) {
1753	return new WP_Error(
1754	'protected_owner_not_cleared',
1755	__( 'Could not clear the protected owner.', 'jetpack-connection' ),
1756	array( 'status' => 500 )
1757	);
1758	}
1759
1760	return true;
1761	}
1762
1763	/**
1764	* Connects the user with a specified ID to a WordPress.com user using the
1765	* remote login flow.
1766	*
1767	* @access public
1768	*
1769	* @param int\|null $user_id (optional) the user identifier, defaults to current user.
1770	* @param string\|null $redirect_url the URL to redirect the user to for processing, defaults to
1771	* admin_url().
1772	* @return WP_Error only in case of a failed user lookup.
1773	*/
1774	public function connect_user( $user_id = null, $redirect_url = null ) {
1775	$user = null;
1776	if ( null === $user_id ) {
1777	$user = wp_get_current_user();
1778	} else {
1779	$user = get_user_by( 'ID', $user_id );
1780	}
1781
1782	if ( empty( $user ) ) {
1783	return new \WP_Error( 'user_not_found', 'Attempting to connect a non-existent user.' );
1784	}
1785
1786	if ( null === $redirect_url ) {
1787	$redirect_url = admin_url();
1788	}
1789
1790	// Using wp_redirect intentionally because we're redirecting outside.
1791	wp_redirect( $this->get_authorization_url( $user, $redirect_url ) ); // phpcs:ignore WordPress.Security.SafeRedirect
1792	exit( 0 );
1793	}
1794
1795	/**
1796	* Force user disconnect.
1797	*
1798	* @param int $user_id Local (external) user ID.
1799	* @param bool $disconnect_all_users Whether to disconnect all users before disconnecting the primary user.
1800	*
1801	* @return bool
1802	*/
1803	public function disconnect_user_force( $user_id, $disconnect_all_users = false ) {
1804	if ( ! (int) $user_id ) {
1805	// Missing user ID.
1806	return false;
1807	}
1808	// If we are disconnecting the primary user we may need to disconnect all other users first
1809	if ( $user_id === $this->get_connection_owner_id() && $disconnect_all_users && ! $this->disconnect_all_users_except_primary() ) {
1810	return false;
1811	}
1812
1813	return $this->disconnect_user( $user_id, true, true );
1814	}
1815
1816	/**
1817	* Disconnects all users except the primary user.
1818	*
1819	* @return bool
1820	*/
1821	public function disconnect_all_users_except_primary() {
1822
1823	$all_connected_users = $this->get_connected_users();
1824
1825	foreach ( $all_connected_users as $user ) {
1826	// Skip the primary.
1827	if ( $user->ID === $this->get_connection_owner_id() ) {
1828	continue;
1829	}
1830	$disconnected = $this->disconnect_user( $user->ID, false, true );
1831	// If we fail to disconnect any user, we should not proceed with disconnecting the primary user.
1832	if ( ! $disconnected ) {
1833	return false;
1834	}
1835	}
1836
1837	return true;
1838	}
1839
1840	/**
1841	* Unlinks the current user from the linked WordPress.com user.
1842	*
1843	* @access public
1844	* @static
1845	*
1846	* @todo Refactor to properly load the XMLRPC client independently.
1847	*
1848	* @param int\|null $user_id the user identifier.
1849	* @param bool $can_overwrite_primary_user Allow for the primary user to be disconnected.
1850	* @param bool $force_disconnect_locally Disconnect user locally even if we were unable to disconnect them from WP.com.
1851	* @return bool Whether the disconnection of the user was successful.
1852	*/
1853	public function disconnect_user( $user_id = null, $can_overwrite_primary_user = false, $force_disconnect_locally = false ) {
1854	$user_id = empty( $user_id ) ? get_current_user_id() : (int) $user_id;
1855	$is_primary_user = Jetpack_Options::get_option( 'master_user' ) === $user_id;
1856
1857	if ( $is_primary_user && ! $can_overwrite_primary_user ) {
1858	return false;
1859	}
1860
1861	if ( in_array( $user_id, self::$disconnected_users, true ) ) {
1862	// The user is already disconnected.
1863	return false;
1864	}
1865
1866	// Attempt to disconnect the user from WordPress.com.
1867	$is_disconnected_from_wpcom = $this->unlink_user_from_wpcom( $user_id );
1868
1869	$is_disconnected_locally = false;
1870	if ( $is_disconnected_from_wpcom \|\| $force_disconnect_locally ) {
1871	// Get the WordPress.com email before disconnecting the user
1872	$wpcom_user_data = $this->get_connected_user_data( $user_id );
1873	$wpcom_email = $wpcom_user_data['email'] ?? null;
1874
1875	// Disconnect the user locally.
1876	$is_disconnected_locally = $this->get_tokens()->disconnect_user( $user_id );
1877
1878	if ( $is_disconnected_locally ) {
1879	// Delete cached connected user data.
1880	$transient_key = "jetpack_connected_user_data_$user_id";
1881	delete_transient( $transient_key );
1882
1883	// Clean up account mismatch transients for this user
1884	if ( $wpcom_email ) {
1885	$user_account_status = new User_Account_Status();
1886	$user_account_status->clean_account_mismatch_transients( $wpcom_email );
1887	}
1888
1889	/**
1890	* Fires after the current user has been unlinked from WordPress.com.
1891	*
1892	* @since 1.7.0
1893	* @since-jetpack 4.1.0
1894	*
1895	* @param int $user_id The current user's ID.
1896	*/
1897	do_action( 'jetpack_unlinked_user', $user_id );
1898
1899	if ( $is_primary_user ) {
1900	Jetpack_Options::delete_option( 'master_user' );
1901
1902	// Clear the memoized connection owner ID since it changed
1903	self::$connection_owner_id = null;
1904	}
1905	}
1906	}
1907
1908	self::$disconnected_users[] = $user_id;
1909
1910	return $is_disconnected_from_wpcom && $is_disconnected_locally;
1911	}
1912
1913	/**
1914	* Request to wpcom for a user to be unlinked from their WordPress.com account
1915	*
1916	* @param int $user_id The user identifier.
1917	*
1918	* @return bool Whether the disconnection of the user was successful.
1919	*/
1920	public function unlink_user_from_wpcom( $user_id ) {
1921	// Attempt to disconnect the user from WordPress.com.
1922	$xml = new Jetpack_IXR_Client();
1923
1924	$xml->query( 'jetpack.unlink_user', $user_id );
1925	if ( $xml->isError() ) {
1926	return false;
1927	}
1928
1929	return (bool) $xml->getResponse();
1930	}
1931
1932	/**
1933	* Update the connection owner.
1934	*
1935	* @since 1.29.0
1936	* @since 9.3.0 Refused while ownership is locked.
1937	*
1938	* @param int $new_owner_id The ID of the user to become the connection owner.
1939	*
1940	* @return true\|WP_Error True if owner successfully changed, WP_Error otherwise.
1941	*/
1942	public function update_connection_owner( $new_owner_id ) {
1943	// Answered before the arguments are validated: no candidate is valid while ownership is
1944	// locked, and an argument error would suggest a retry that cannot work.
1945	if ( ! $this->is_ownership_transferable() ) {
1946	return new WP_Error(
1947	'ownership_locked',
1948	__( 'The connection owner is locked on this site.', 'jetpack-connection' ),
1949	array( 'status' => 403 )
1950	);
1951	}
1952
1953	$roles = new Roles();
1954	if ( ! user_can( $new_owner_id, $roles->translate_role_to_cap( 'administrator' ) ) ) {
1955	return new WP_Error(
1956	'new_owner_not_admin',
1957	__( 'New owner is not admin', 'jetpack-connection' ),
1958	array( 'status' => 400 )
1959	);
1960	}
1961
1962	$old_owner_id = $this->get_connection_owner_id();
1963
1964	if ( $old_owner_id === $new_owner_id ) {
1965	return new WP_Error(
1966	'new_owner_is_existing_owner',
1967	__( 'New owner is same as existing owner', 'jetpack-connection' ),
1968	array( 'status' => 400 )
1969	);
1970	}
1971
1972	if ( ! $this->is_user_connected( $new_owner_id ) ) {
1973	return new WP_Error(
1974	'new_owner_not_connected',
1975	__( 'New owner is not connected', 'jetpack-connection' ),
1976	array( 'status' => 400 )
1977	);
1978	}
1979
1980	// Notify WPCOM about the connection owner change.
1981	$owner_updated_wpcom = $this->update_connection_owner_wpcom( $new_owner_id );
1982
1983	if ( $owner_updated_wpcom ) {
1984	// Update the connection owner in Jetpack only if they were successfully updated on WPCOM.
1985	// This will ensure consistency with WPCOM.
1986	\Jetpack_Options::update_option( 'master_user', $new_owner_id );
1987
1988	// Clear the memoized connection owner ID since it changed
1989	self::$connection_owner_id = null;
1990
1991	// Track it.
1992	( new Tracking() )->record_user_event( 'set_connection_owner_success' );
1993
1994	return true;
1995	}
1996	return new WP_Error(
1997	'error_setting_new_owner',
1998	__( 'Could not confirm new owner.', 'jetpack-connection' ),
1999	array( 'status' => 500 )
2000	);
2001	}
2002
2003	/**
2004	* Request to WPCOM to update the connection owner.
2005	*
2006	* @since 1.29.0
2007	*
2008	* @param int $new_owner_id The ID of the user to become the connection owner.
2009	*
2010	* @return bool Whether the ownership transfer was successful.
2011	*/
2012	public function update_connection_owner_wpcom( $new_owner_id ) {
2013	// Notify WPCOM about the connection owner change.
2014	$xml = new Jetpack_IXR_Client(
2015	array(
2016	'user_id' => get_current_user_id(),
2017	)
2018	);
2019	$xml->query(
2020	'jetpack.switchBlogOwner',
2021	array(
2022	'new_blog_owner' => $new_owner_id,
2023	)
2024	);
2025	if ( $xml->isError() ) {
2026	return false;
2027	}
2028
2029	return (bool) $xml->getResponse();
2030	}
2031
2032	/**
2033	* Returns the requested Jetpack API URL.
2034	*
2035	* @param string $relative_url the relative API path.
2036	* @return string API URL.
2037	*/
2038	public function api_url( $relative_url ) {
2039	$api_base = Constants::get_constant( 'JETPACK__API_BASE' );
2040	$api_version = '/' . Constants::get_constant( 'JETPACK__API_VERSION' ) . '/';
2041
2042	/**
2043	* Filters the API URL that Jetpack uses for server communication.
2044	*
2045	* @since 1.7.0
2046	* @since-jetpack 8.0.0
2047	*
2048	* @param string $url the generated URL.
2049	* @param string $relative_url the relative URL that was passed as an argument.
2050	* @param string $api_base the API base string that is being used.
2051	* @param string $api_version the API version string that is being used.
2052	*/
2053	return apply_filters(
2054	'jetpack_api_url',
2055	rtrim( $api_base . $relative_url, '/\\' ) . $api_version,
2056	$relative_url,
2057	$api_base,
2058	$api_version
2059	);
2060	}
2061
2062	/**
2063	* Returns the Jetpack XMLRPC WordPress.com API endpoint URL.
2064	*
2065	* @return string XMLRPC API URL.
2066	*/
2067	public function xmlrpc_api_url() {
2068	$base = preg_replace(
2069	'#(https?://[^?/]+)(/?.*)?$#',
2070	'\\1',
2071	Constants::get_constant( 'JETPACK__API_BASE' )
2072	);
2073	return untrailingslashit( $base ) . '/xmlrpc.php';
2074	}
2075
2076	/**
2077	* Attempts Jetpack registration which sets up the site for connection. Should
2078	* remain public because the call to action comes from the current site, not from
2079	* WordPress.com.
2080	*
2081	* @param string $api_endpoint (optional) an API endpoint to use, defaults to 'register'.
2082	* @return true\|WP_Error The error object.
2083	*/
2084	public function register( $api_endpoint = 'register' ) {
2085	// Clean-up leftover tokens just in-case.
2086	// This fixes an edge case that was preventing users to register when the blog token was missing but
2087	// there were still leftover user tokens present.
2088	$this->delete_all_connection_tokens( true );
2089
2090	add_action( 'pre_update_jetpack_option_register', array( '\\Jetpack_Options', 'delete_option' ) );
2091	$secrets = ( new Secrets() )->generate( 'register', get_current_user_id(), 600 );
2092
2093	if ( false === $secrets ) {
2094	return new WP_Error( 'cannot_save_secrets', __( 'Jetpack experienced an issue trying to save options (cannot_save_secrets). We suggest that you contact your hosting provider, and ask them for help checking that the options table is writable on your site.', 'jetpack-connection' ) );
2095	}
2096
2097	if (
2098	empty( $secrets['secret_1'] ) \|\|
2099	empty( $secrets['secret_2'] ) \|\|
2100	empty( $secrets['exp'] )
2101	) {
2102	return new \WP_Error( 'missing_secrets' );
2103	}
2104
2105	// Better to try (and fail) to set a higher timeout than this system
2106	// supports than to have register fail for more users than it should.
2107	$timeout = $this->set_min_time_limit( 60 ) / 2;
2108
2109	$gmt_offset = get_option( 'gmt_offset' );
2110	if ( ! $gmt_offset ) {
2111	$gmt_offset = 0;
2112	}
2113
2114	$stats_options = get_option( 'stats_options' );
2115	$stats_id = $stats_options['blog_id'] ?? null;
2116
2117	/* This action is documented in src/class-package-version-tracker.php */
2118	$package_versions = apply_filters( 'jetpack_package_versions', array() );
2119
2120	$active_plugins_using_connection = Plugin_Storage::get_all();
2121
2122	/**
2123	* Filters the request body for additional property addition.
2124	*
2125	* @since 1.7.0
2126	* @since-jetpack 7.7.0
2127	*
2128	* @param array $post_data request data.
2129	* @param Array $token_data token data.
2130	*/
2131	$body = apply_filters(
2132	'jetpack_register_request_body',
2133	array_merge(
2134	array(
2135	'siteurl' => Urls::site_url(),
2136	'home' => Urls::home_url(),
2137	'gmt_offset' => $gmt_offset,
2138	'timezone_string' => (string) get_option( 'timezone_string' ),
2139	'site_name' => (string) get_option( 'blogname' ),
2140	'secret_1' => $secrets['secret_1'],
2141	'secret_2' => $secrets['secret_2'],
2142	'site_lang' => get_locale(),
2143	'timeout' => $timeout,
2144	'stats_id' => $stats_id,
2145	'state' => get_current_user_id(),
2146	'site_created' => $this->get_assumed_site_creation_date(),
2147	'jetpack_version' => Constants::get_constant( 'JETPACK__VERSION' ),
2148	'ABSPATH' => Constants::get_constant( 'ABSPATH' ),
2149	'current_user_email' => wp_get_current_user()->user_email,
2150	'connect_plugin' => $this->get_plugin() ? $this->get_plugin()->get_slug() : null,
2151	'package_versions' => $package_versions,
2152	'active_connected_plugins' => $active_plugins_using_connection,
2153	),
2154	self::$extra_register_params
2155	)
2156	);
2157
2158	$args = array(
2159	'method' => 'POST',
2160	'body' => $body,
2161	'headers' => array(
2162	'Accept' => 'application/json',
2163	),
2164	'timeout' => $timeout,
2165	);
2166
2167	$args['body'] = static::apply_activation_source_to_args( $args['body'] );
2168
2169	// TODO: fix URLs for bad hosts.
2170	$response = Client::_wp_remote_request(
2171	$this->api_url( $api_endpoint ),
2172	$args,
2173	true
2174	);
2175
2176	// Make sure the response is valid and does not contain any Jetpack errors.
2177	$registration_details = $this->validate_remote_register_response( $response );
2178
2179	if ( is_wp_error( $registration_details ) ) {
2180	return $registration_details;
2181	} elseif ( ! $registration_details ) {
2182	return new \WP_Error(
2183	'unknown_error',
2184	'Unknown error registering your Jetpack site.',
2185	wp_remote_retrieve_response_code( $response )
2186	);
2187	}
2188
2189	if ( empty( $registration_details->jetpack_secret ) \|\| ! is_string( $registration_details->jetpack_secret ) ) {
2190	return new \WP_Error(
2191	'jetpack_secret',
2192	'Unable to validate registration of your Jetpack site.',
2193	wp_remote_retrieve_response_code( $response )
2194	);
2195	}
2196
2197	if ( isset( $registration_details->jetpack_public ) ) {
2198	$jetpack_public = (int) $registration_details->jetpack_public;
2199	} else {
2200	$jetpack_public = false;
2201	}
2202
2203	Jetpack_Options::update_options(
2204	array(
2205	'id' => (int) $registration_details->jetpack_id,
2206	'public' => $jetpack_public,
2207	)
2208	);
2209
2210	update_option( Package_Version_Tracker::PACKAGE_VERSION_OPTION, $package_versions );
2211
2212	$this->get_tokens()->update_blog_token( (string) $registration_details->jetpack_secret );
2213
2214	if ( ! Jetpack_Options::get_option( 'id' ) \|\| ! $this->get_tokens()->get_access_token() ) {
2215	return new WP_Error(
2216	'connection_data_save_failed',
2217	'Failed to save connection data in the database'
2218	);
2219	}
2220
2221	$alternate_authorization_url = $registration_details->alternate_authorization_url ?? '';
2222
2223	add_filter(
2224	'jetpack_register_site_rest_response',
2225	function ( $response ) use ( $alternate_authorization_url ) {
2226	$response['alternateAuthorizeUrl'] = $alternate_authorization_url;
2227	return $response;
2228	}
2229	);
2230
2231	/**
2232	* Fires when a site is registered on WordPress.com.
2233	*
2234	* @since 1.7.0
2235	* @since-jetpack 3.7.0
2236	*
2237	* @param int $json->jetpack_id Jetpack Blog ID.
2238	* @param string $json->jetpack_secret Jetpack Blog Token.
2239	* @param int\|bool $jetpack_public Is the site public.
2240	*/
2241	do_action(
2242	'jetpack_site_registered',
2243	$registration_details->jetpack_id,
2244	$registration_details->jetpack_secret,
2245	$jetpack_public
2246	);
2247
2248	if ( isset( $registration_details->token ) ) {
2249	/**
2250	* Fires when a user token is sent along with the registration data.
2251	*
2252	* @since 1.7.0
2253	* @since-jetpack 7.6.0
2254	*
2255	* @param object $token the administrator token for the newly registered site.
2256	*/
2257	do_action( 'jetpack_site_registered_user_token', $registration_details->token );
2258	}
2259
2260	return true;
2261	}
2262
2263	/**
2264	* Attempts Jetpack registration.
2265	*
2266	* @param bool $tos_agree Whether the user agreed to TOS.
2267	*
2268	* @return bool\|WP_Error
2269	*/
2270	public function try_registration( $tos_agree = true ) {
2271	if ( $tos_agree ) {
2272	$terms_of_service = new Terms_Of_Service();
2273	$terms_of_service->agree();
2274	}
2275
2276	/**
2277	* Action fired when the user attempts the registration.
2278	*
2279	* @since 1.26.0
2280	*/
2281	$pre_register = apply_filters( 'jetpack_pre_register', null );
2282
2283	if ( is_wp_error( $pre_register ) ) {
2284	return $pre_register;
2285	}
2286
2287	$tracking_data = array();
2288
2289	if ( null !== $this->get_plugin() ) {
2290	$tracking_data['plugin_slug'] = $this->get_plugin()->get_slug();
2291	}
2292
2293	$tracking = new Tracking();
2294	$tracking->record_user_event( 'jpc_register_begin', $tracking_data );
2295
2296	add_filter( 'jetpack_register_request_body', array( Utils::class, 'filter_register_request_body' ) );
2297
2298	$result = $this->register();
2299
2300	remove_filter( 'jetpack_register_request_body', array( Utils::class, 'filter_register_request_body' ) );
2301
2302	// If there was an error with registration and the site was not registered, record this so we can show a message.
2303	if ( ! $result \|\| is_wp_error( $result ) ) {
2304	return $result;
2305	}
2306
2307	return true;
2308	}
2309
2310	/**
2311	* Adds a parameter to the register request body
2312	*
2313	* @since 1.26.0
2314	*
2315	* @param string $name The name of the parameter to be added.
2316	* @param string $value The value of the parameter to be added.
2317	*
2318	* @throws \InvalidArgumentException If supplied arguments are not strings.
2319	* @return void
2320	*/
2321	public function add_register_request_param( $name, $value ) {
2322	if ( ! is_string( $name ) \|\| ! is_string( $value ) ) {
2323	throw new \InvalidArgumentException( 'name and value must be strings' );
2324	}
2325	self::$extra_register_params[ $name ] = $value;
2326	}
2327
2328	/**
2329	* Takes the response from the Jetpack register new site endpoint and
2330	* verifies it worked properly.
2331	*
2332	* @since 1.7.0
2333	* @since-jetpack 2.6.0
2334	*
2335	* @param mixed $response the response object, or the error object.
2336	* @return string\|WP_Error A JSON object on success or WP_Error on failures
2337	**/
2338	protected function validate_remote_register_response( $response ) {
2339	if ( is_wp_error( $response ) ) {
2340	return new \WP_Error(
2341	'register_http_request_failed',
2342	$response->get_error_message()
2343	);
2344	}
2345
2346	$code = wp_remote_retrieve_response_code( $response );
2347	$entity = wp_remote_retrieve_body( $response );
2348
2349	if ( $entity ) {
2350	$registration_response = json_decode( $entity );
2351	} else {
2352	$registration_response = false;
2353	}
2354
2355	$code_type = (int) ( $code / 100 );
2356	if ( 5 === $code_type ) {
2357	return new \WP_Error( 'wpcom_5??', $code );
2358	} elseif ( 408 === $code ) {
2359	return new \WP_Error( 'wpcom_408', $code );
2360	} elseif ( ! empty( $registration_response->error ) ) {
2361	if (
2362	'xml_rpc-32700' === $registration_response->error
2363	&& ! function_exists( 'xml_parser_create' )
2364	) {
2365	$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-connection' );
2366	} else {
2367	$error_description = isset( $registration_response->error_description )
2368	? (string) $registration_response->error_description
2369	: '';
2370	}
2371
2372	return new \WP_Error(
2373	(string) $registration_response->error,
2374	$error_description,
2375	$code
2376	);
2377	} elseif ( 200 !== $code ) {
2378	return new \WP_Error( 'wpcom_bad_response', $code );
2379	}
2380
2381	// Jetpack ID error block.
2382	if ( empty( $registration_response->jetpack_id ) ) {
2383	return new \WP_Error(
2384	'jetpack_id',
2385	/* translators: %s is an error message string */
2386	sprintf( __( 'Error Details: Jetpack ID is empty. Do not publicly post this error message! %s', 'jetpack-connection' ), $entity ),
2387	$entity
2388	);
2389	} elseif ( ! is_scalar( $registration_response->jetpack_id ) ) {
2390	return new \WP_Error(
2391	'jetpack_id',
2392	/* translators: %s is an error message string */
2393	sprintf( __( 'Error Details: Jetpack ID is not a scalar. Do not publicly post this error message! %s', 'jetpack-connection' ), $entity ),
2394	$entity
2395	);
2396	} elseif ( preg_match( '/[^0-9]/', $registration_response->jetpack_id ) ) {
2397	return new \WP_Error(
2398	'jetpack_id',
2399	/* translators: %s is an error message string */
2400	sprintf( __( 'Error Details: Jetpack ID begins with a numeral. Do not publicly post this error message! %s', 'jetpack-connection' ), $entity ),
2401	$entity
2402	);
2403	}
2404
2405	return $registration_response;
2406	}
2407
2408	/**
2409	* Adds a used nonce to a list of known nonces.
2410	*
2411	* @param int $timestamp the current request timestamp.
2412	* @param string $nonce the nonce value.
2413	* @return bool whether the nonce is unique or not.
2414	*
2415	* @deprecated since 1.24.0
2416	* @see Nonce_Handler::add()
2417	*/
2418	public function add_nonce( $timestamp, $nonce ) {
2419	_deprecated_function( __METHOD__, '1.24.0', 'Automattic\\Jetpack\\Connection\\Nonce_Handler::add' );
2420	return ( new Nonce_Handler() )->add( $timestamp, $nonce );
2421	}
2422
2423	/**
2424	* Cleans nonces that were saved when calling ::add_nonce.
2425	*
2426	* @todo Properly prepare the query before executing it.
2427	*
2428	* @param bool $all whether to clean even non-expired nonces.
2429	*
2430	* @deprecated since 1.24.0
2431	* @see Nonce_Handler::clean_all()
2432	*/
2433	public function clean_nonces( $all = false ) {
2434	_deprecated_function( __METHOD__, '1.24.0', 'Automattic\\Jetpack\\Connection\\Nonce_Handler::clean_all' );
2435	( new Nonce_Handler() )->clean_all( $all ? PHP_INT_MAX : ( time() - Nonce_Handler::LIFETIME ) );
2436	}
2437
2438	/**
2439	* Sets the Connection custom capabilities.
2440	*
2441	* @param string[] $caps Array of the user's capabilities.
2442	* @param string $cap Capability name.
2443	* @param int $user_id The user ID.
2444	* @param array $args Adds the context to the cap. Typically the object ID.
2445	*/
2446	public function jetpack_connection_custom_caps( $caps, $cap, $user_id, $args ) { // phpcs:ignore VariableAnalysis.CodeAnalysis.VariableAnalysis.UnusedVariable
2447	switch ( $cap ) {
2448	case 'jetpack_connect':
2449	case 'jetpack_reconnect':
2450	$is_offline_mode = ( new Status() )->is_offline_mode();
2451	if ( $is_offline_mode ) {
2452	$caps = array( 'do_not_allow' );
2453	break;
2454	}
2455	// Pass through. If it's not offline mode, these should match disconnect.
2456	// Let users disconnect if it's offline mode, just in case things glitch.
2457	case 'jetpack_disconnect':
2458	/**
2459	* Filters the jetpack_disconnect capability.
2460	*
2461	* @since 1.14.2
2462	*
2463	* @param array An array containing the capability name.
2464	*/
2465	$caps = apply_filters( 'jetpack_disconnect_cap', array( 'manage_options' ) );
2466	break;
2467	case 'jetpack_connect_user':
2468	$is_offline_mode = ( new Status() )->is_offline_mode();
2469	if ( $is_offline_mode ) {
2470	$caps = array( 'do_not_allow' );
2471	break;
2472	}
2473	// With site connections in mind, non-admin users can connect their account only if a connection owner exists.
2474	$caps = $this->has_connected_owner() ? array( 'read' ) : array( 'manage_options' );
2475	break;
2476	case 'jetpack_unlink_user':
2477	$is_offline_mode = ( new Status() )->is_offline_mode();
2478	if ( $is_offline_mode ) {
2479	$caps = array( 'do_not_allow' );
2480	break;
2481	}
2482
2483	// Non-admins can always disconnect
2484	$caps = array( 'read' );
2485	break;
2486	}
2487	return $caps;
2488	}
2489
2490	/**
2491	* Builds the timeout limit for queries talking with the wpcom servers.
2492	*
2493	* Based on local php max_execution_time in php.ini
2494	*
2495	* @since 1.7.0
2496	* @since-jetpack 5.4.0
2497	* @return int
2498	**/
2499	public function get_max_execution_time() {
2500	$timeout = (int) ini_get( 'max_execution_time' );
2501
2502	// Ensure exec time set in php.ini.
2503	if ( ! $timeout ) {
2504	$timeout = 30;
2505	}
2506	return $timeout;
2507	}
2508
2509	/**
2510	* Sets a minimum request timeout, and returns the current timeout
2511	*
2512	* @since 1.7.0
2513	* @since-jetpack 5.4.0
2514	* @param int $min_timeout the minimum timeout value.
2515	**/
2516	public function set_min_time_limit( $min_timeout ) {
2517	$timeout = $this->get_max_execution_time();
2518	if ( $timeout < $min_timeout ) {
2519	$timeout = $min_timeout;
2520	set_time_limit( $timeout );
2521	}
2522	return $timeout;
2523	}
2524
2525	/**
2526	* Get our assumed site creation date.
2527	* Calculated based on the earlier date of either:
2528	* - Earliest admin user registration date.
2529	* - Earliest date of post of any post type.
2530	*
2531	* @since 1.7.0
2532	* @since-jetpack 7.2.0
2533	*
2534	* @return string Assumed site creation date and time.
2535	*/
2536	public function get_assumed_site_creation_date() {
2537	$cached_date = get_transient( 'jetpack_assumed_site_creation_date' );
2538	if ( ! empty( $cached_date ) ) {
2539	return $cached_date;
2540	}
2541
2542	/**
2543	* We don't use the 'ID' field, but need it to overcome a WP caching bug: https://core.trac.wordpress.org/ticket/62003
2544	*
2545	* @todo Remote the 'ID' field from users fetching when the issue is fixed and Jetpack-supported WP versions move beyond it.
2546	*/
2547	$earliest_registered_users = get_users(
2548	array(
2549	'role' => 'administrator',
2550	'orderby' => 'user_registered',
2551	'order' => 'ASC',
2552	'fields' => array( 'ID', 'user_registered' ),
2553	'number' => 1,
2554	)
2555	);
2556	$earliest_registration_date = $earliest_registered_users[0]->user_registered;
2557
2558	$earliest_posts = get_posts(
2559	array(
2560	'posts_per_page' => 1,
2561	'post_type' => 'any',
2562	'post_status' => 'any',
2563	'orderby' => 'date',
2564	'order' => 'ASC',
2565	)
2566	);
2567
2568	// If there are no posts at all, we'll count only on user registration date.
2569	if ( $earliest_posts ) {
2570	$earliest_post_date = $earliest_posts[0]->post_date;
2571	} else {
2572	$earliest_post_date = PHP_INT_MAX;
2573	}
2574
2575	$assumed_date = min( $earliest_registration_date, $earliest_post_date );
2576	set_transient( 'jetpack_assumed_site_creation_date', $assumed_date );
2577
2578	return $assumed_date;
2579	}
2580
2581	/**
2582	* Adds the activation source string as a parameter to passed arguments.
2583	*
2584	* @todo Refactor to use rawurlencode() instead of urlencode().
2585	*
2586	* @param array $args arguments that need to have the source added.
2587	* @return array $amended arguments.
2588	*/
2589	public static function apply_activation_source_to_args( $args ) {
2590	$activation_source = get_option( 'jetpack_activation_source' );
2591
2592	if ( ! empty( $activation_source[0] ) ) {
2593	// phpcs:ignore WordPress.PHP.DiscouragedPHPFunctions.urlencode_urlencode
2594	$args['_as'] = urlencode( $activation_source[0] );
2595	}
2596
2597	if ( ! empty( $activation_source[1] ) ) {
2598	// phpcs:ignore WordPress.PHP.DiscouragedPHPFunctions.urlencode_urlencode
2599	$args['_ak'] = urlencode( $activation_source[1] );
2600	}
2601
2602	return $args;
2603	}
2604
2605	/**
2606	* Generates two secret tokens and the end of life timestamp for them.
2607	*
2608	* @param string $action The action name.
2609	* @param int\|bool $user_id The user identifier.
2610	* @param int $exp Expiration time in seconds.
2611	*/
2612	public function generate_secrets( $action, $user_id = false, $exp = 600 ) {
2613	return ( new Secrets() )->generate( $action, $user_id, $exp );
2614	}
2615
2616	/**
2617	* Returns two secret tokens and the end of life timestamp for them.
2618	*
2619	* @deprecated 1.24.0 Use Automattic\Jetpack\Connection\Secrets->get() instead.
2620	*
2621	* @param string $action The action name.
2622	* @param int $user_id The user identifier.
2623	* @return string\|array an array of secrets or an error string.
2624	*/
2625	public function get_secrets( $action, $user_id ) {
2626	_deprecated_function( __METHOD__, '1.24.0', 'Automattic\\Jetpack\\Connection\\Secrets->get' );
2627	return ( new Secrets() )->get( $action, $user_id );
2628	}
2629
2630	/**
2631	* Deletes secret tokens in case they, for example, have expired.
2632	*
2633	* @deprecated 1.24.0 Use Automattic\Jetpack\Connection\Secrets->delete() instead.
2634	*
2635	* @param string $action The action name.
2636	* @param int $user_id The user identifier.
2637	*/
2638	public function delete_secrets( $action, $user_id ) {
2639	_deprecated_function( __METHOD__, '1.24.0', 'Automattic\\Jetpack\\Connection\\Secrets->delete' );
2640	( new Secrets() )->delete( $action, $user_id );
2641	}
2642
2643	/**
2644	* Deletes all connection tokens and transients from the local Jetpack site.
2645	* If the plugin object has been provided in the constructor, the function first checks
2646	* whether it's the only active connection.
2647	* If there are any other connections, the function will do nothing and return `false`
2648	* (unless `$ignore_connected_plugins` is set to `true`).
2649	*
2650	* @param bool $ignore_connected_plugins Delete the tokens even if there are other connected plugins.
2651	*
2652	* @return bool True if disconnected successfully, false otherwise.
2653	*/
2654	public function delete_all_connection_tokens( $ignore_connected_plugins = false ) {
2655	// refuse to delete if we're not the last Jetpack plugin installed.
2656	if ( ! $ignore_connected_plugins && null !== $this->plugin && ! $this->plugin->is_only() ) {
2657	return false;
2658	}
2659
2660	/**
2661	* Fires upon the disconnect attempt.
2662	* Return `false` to prevent the disconnect.
2663	*
2664	* @since 1.14.2
2665	*/
2666	if ( ! apply_filters( 'jetpack_connection_delete_all_tokens', true ) ) {
2667	return false;
2668	}
2669
2670	// The protected owner anchor is a local cache of a record WordPress.com owns. Dropping it
2671	// here keeps a disconnected site from carrying a lock that names a user who no longer holds
2672	// a token; the anchor is re-established from WordPress.com when the owner reconnects.
2673	\Jetpack_Options::delete_option(
2674	array(
2675	'master_user',
2676	'protected_owner',
2677	'time_diff',
2678	'fallback_no_verify_ssl_certs',
2679	)
2680	);
2681
2682	// Clear the memoized connection owner ID since it changed
2683	self::$connection_owner_id = null;
2684
2685	( new Secrets() )->delete_all();
2686	$this->get_tokens()->delete_all();
2687
2688	// Delete cached connected user data.
2689	$transient_key = 'jetpack_connected_user_data_' . get_current_user_id();
2690	delete_transient( $transient_key );
2691
2692	// Delete the cached site record, which a later connection must not serve.
2693	self::delete_cached_site_data();
2694
2695	// Delete all XML-RPC errors.
2696	Error_Handler::get_instance()->delete_all_errors();
2697
2698	return true;
2699	}
2700
2701	/**
2702	* Tells WordPress.com to disconnect the site and clear all tokens from cached site.
2703	* If the plugin object has been provided in the constructor, the function first check
2704	* whether it's the only active connection.
2705	* If there are any other connections, the function will do nothing and return `false`
2706	* (unless `$ignore_connected_plugins` is set to `true`).
2707	*
2708	* @param bool $ignore_connected_plugins Delete the tokens even if there are other connected plugins.
2709	*
2710	* @return bool True if disconnected successfully, false otherwise.
2711	*/
2712	public function disconnect_site_wpcom( $ignore_connected_plugins = false ) {
2713	if ( ! $ignore_connected_plugins && null !== $this->plugin && ! $this->plugin->is_only() ) {
2714	return false;
2715	}
2716
2717	if ( ( new Status() )->is_offline_mode() && ! apply_filters( 'jetpack_connection_disconnect_site_wpcom_offline_mode', false ) ) {
2718	// Prevent potential disconnect of the live site by removing WPCOM tokens.
2719	return false;
2720	}
2721
2722	/**
2723	* Fires upon the disconnect attempt.
2724	* Return `false` to prevent the disconnect.
2725	*
2726	* @since 1.14.2
2727	*/
2728	if ( ! apply_filters( 'jetpack_connection_disconnect_site_wpcom', true, $this ) ) {
2729	return false;
2730	}
2731
2732	$xml = new Jetpack_IXR_Client();
2733	$xml->query( 'jetpack.deregister', get_current_user_id() );
2734
2735	return true;
2736	}
2737
2738	/**
2739	* Disconnect the plugin and remove the tokens.
2740	* This function will automatically perform "soft" or "hard" disconnect depending on whether other plugins are using the connection.
2741	* This is a proxy method to simplify the Connection package API.
2742	*
2743	* @see Manager::disconnect_site()
2744	*
2745	* @param boolean $disconnect_wpcom Should disconnect_site_wpcom be called.
2746	* @param bool $ignore_connected_plugins Delete the tokens even if there are other connected plugins.
2747	* @return bool
2748	*/
2749	public function remove_connection( $disconnect_wpcom = true, $ignore_connected_plugins = false ) {
2750
2751	$this->disconnect_site( $disconnect_wpcom, $ignore_connected_plugins );
2752
2753	return true;
2754	}
2755
2756	/**
2757	* Completely clearing up the connection, and initiating reconnect.
2758	*
2759	* @return true\|WP_Error True if reconnected successfully, a `WP_Error` object otherwise.
2760	*/
2761	public function reconnect() {
2762	( new Tracking() )->record_user_event( 'restore_connection_reconnect' );
2763
2764	$this->disconnect_site_wpcom( true );
2765
2766	return $this->register();
2767	}
2768
2769	/**
2770	* Validate the tokens, and refresh the invalid ones.
2771	*
2772	* @return string\|bool\|WP_Error True if connection restored or string indicating what's to be done next. A `WP_Error` object or false otherwise.
2773	*/
2774	public function restore() {
2775	// If this is a site connection we need to trigger a full reconnection as our only secure means of
2776	// communication with WPCOM, aka the blog token, is compromised.
2777	if ( $this->is_site_connection() ) {
2778	return $this->reconnect();
2779	}
2780
2781	$validate_tokens_response = $this->get_tokens()->validate();
2782
2783	// If token validation failed, trigger a full reconnection.
2784	if ( is_array( $validate_tokens_response ) &&
2785	isset( $validate_tokens_response['blog_token']['is_healthy'] ) &&
2786	isset( $validate_tokens_response['user_token']['is_healthy'] ) ) {
2787	$blog_token_healthy = $validate_tokens_response['blog_token']['is_healthy'];
2788	$user_token_healthy = $validate_tokens_response['user_token']['is_healthy'];
2789	} else {
2790	$blog_token_healthy = false;
2791	$user_token_healthy = false;
2792	}
2793
2794	// Tokens are both valid, or both invalid. We can't fix the problem we don't see, so the full reconnection is needed.
2795	if ( $blog_token_healthy === $user_token_healthy ) {
2796	$result = $this->reconnect();
2797	return ( true === $result ) ? 'authorize' : $result;
2798	}
2799
2800	if ( ! $blog_token_healthy ) {
2801	return $this->refresh_blog_token();
2802	}
2803
2804	if ( ! $user_token_healthy ) {
2805	return ( true === $this->refresh_user_token() ) ? 'authorize' : false;
2806	}
2807
2808	return false;
2809	}
2810
2811	/**
2812	* Responds to a WordPress.com call to register the current site.
2813	* Should be changed to protected.
2814	*
2815	* @param array $registration_data Array of [ secret_1, user_id ].
2816	*/
2817	public function handle_registration( array $registration_data ) {
2818	list( $registration_secret_1, $registration_user_id ) = $registration_data;
2819	if ( empty( $registration_user_id ) ) {
2820	return new \WP_Error( 'registration_state_invalid', __( 'Invalid Registration State', 'jetpack-connection' ), 400 );
2821	}
2822
2823	return ( new Secrets() )->verify( 'register', $registration_secret_1, (int) $registration_user_id );
2824	}
2825
2826	/**
2827	* Perform the API request to validate the blog and user tokens.
2828	*
2829	* @deprecated 1.24.0 Use Automattic\Jetpack\Connection\Tokens->validate_tokens() instead.
2830	*
2831	* @param int\|null $user_id ID of the user we need to validate token for. Current user's ID by default.
2832	*
2833	* @return array\|false\|WP_Error The API response: `array( 'blog_token_is_healthy' => true\|false, 'user_token_is_healthy' => true\|false )`.
2834	*/
2835	public function validate_tokens( $user_id = null ) {
2836	_deprecated_function( __METHOD__, '1.24.0', 'Automattic\\Jetpack\\Connection\\Tokens->validate' );
2837	return $this->get_tokens()->validate( $user_id );
2838	}
2839
2840	/**
2841	* Verify a Previously Generated Secret.
2842	*
2843	* @deprecated 1.24.0 Use Automattic\Jetpack\Connection\Secrets->verify() instead.
2844	*
2845	* @param string $action The type of secret to verify.
2846	* @param string $secret_1 The secret string to compare to what is stored.
2847	* @param int $user_id The user ID of the owner of the secret.
2848	* @return \WP_Error\|string WP_Error on failure, secret_2 on success.
2849	*/
2850	public function verify_secrets( $action, $secret_1, $user_id ) {
2851	_deprecated_function( __METHOD__, '1.24.0', 'Automattic\\Jetpack\\Connection\\Secrets->verify' );
2852	return ( new Secrets() )->verify( $action, $secret_1, $user_id );
2853	}
2854
2855	/**
2856	* Responds to a WordPress.com call to authorize the current user.
2857	* Should be changed to protected.
2858	*/
2859	public function handle_authorization() {
2860	}
2861
2862	/**
2863	* Obtains the auth token.
2864	*
2865	* @param array $data The request data.
2866	* @return object\|\WP_Error Returns the auth token on success.
2867	* Returns a \WP_Error on failure.
2868	*/
2869	public function get_token( $data ) {
2870	return $this->get_tokens()->get( $data, $this->api_url( 'token' ) );
2871	}
2872
2873	/**
2874	* Builds a URL to the Jetpack connection auth page.
2875	*
2876	* @since 2.7.6 Added optional $from and $raw parameters.
2877	*
2878	* @param WP_User\|null $user (optional) defaults to the current logged in user.
2879	* @param string\|null $redirect (optional) a redirect URL to use instead of the default.
2880	* @param bool\|string $from If not false, adds 'from=$from' param to the connect URL.
2881	* @param bool $raw If true, URL will not be escaped.
2882	*
2883	* @return string Connect URL.
2884	*/
2885	public function get_authorization_url( $user = null, $redirect = null, $from = false, $raw = false ) {
2886	if ( empty( $user ) ) {
2887	$user = wp_get_current_user();
2888	}
2889
2890	$roles = new Roles();
2891	$role = $roles->translate_user_to_role( $user );
2892	$signed_role = $this->get_tokens()->sign_role( $role );
2893
2894	/**
2895	* Filter the URL of the first time the user gets redirected back to your site for connection
2896	* data processing.
2897	*
2898	* @since 1.7.0
2899	* @since-jetpack 8.0.0
2900	*
2901	* @param string $redirect_url Defaults to the site admin URL.
2902	*/
2903	$processing_url = apply_filters( 'jetpack_connect_processing_url', admin_url( 'admin.php' ) );
2904
2905	/**
2906	* Filter the URL to redirect the user back to when the authorization process
2907	* is complete.
2908	*
2909	* @since 1.7.0
2910	* @since-jetpack 8.0.0
2911	*
2912	* @param string $redirect_url Defaults to the site URL.
2913	*/
2914	$redirect = apply_filters( 'jetpack_connect_redirect_url', $redirect );
2915
2916	$secrets = ( new Secrets() )->generate( 'authorize', $user->ID, 2 * HOUR_IN_SECONDS );
2917
2918	/**
2919	* Filter the type of authorization.
2920	* 'calypso' completes authorization on wordpress.com/jetpack/connect
2921	* while 'jetpack' ( or any other value ) completes the authorization at jetpack.wordpress.com.
2922	*
2923	* @since 1.7.0
2924	* @since-jetpack 4.3.3
2925	*
2926	* @param string $auth_type Defaults to 'calypso', can also be 'jetpack'.
2927	*/
2928	$auth_type = apply_filters( 'jetpack_auth_type', 'calypso' );
2929
2930	$body_args = array(
2931	'response_type' => 'code',
2932	'client_id' => \Jetpack_Options::get_option( 'id' ),
2933	'redirect_uri' => add_query_arg(
2934	array(
2935	'handler' => 'jetpack-connection-webhooks',
2936	'action' => 'authorize',
2937	'_wpnonce' => wp_create_nonce( "jetpack-authorize_{$role}_{$redirect}" ),
2938	'redirect' => $redirect ? rawurlencode( $redirect ) : false,
2939	),
2940	esc_url( $processing_url )
2941	),
2942	'state' => $user->ID,
2943	'scope' => $signed_role,
2944	'user_email' => $user->user_email,
2945	'user_login' => $user->user_login,
2946	'is_active' => $this->has_connected_owner(), // TODO Deprecate this.
2947	'jp_version' => (string) Constants::get_constant( 'JETPACK__VERSION' ),
2948	'auth_type' => $auth_type,
2949	'secret' => $secrets['secret_1'],
2950	'blogname' => get_option( 'blogname' ),
2951	'site_url' => Urls::site_url(),
2952	'home_url' => Urls::home_url(),
2953	'site_icon' => get_site_icon_url(),
2954	'site_lang' => get_locale(),
2955	'site_created' => $this->get_assumed_site_creation_date(),
2956	'allow_site_connection' => ! $this->has_connected_owner(),
2957	'calypso_env' => ( new Host() )->get_calypso_env(),
2958	'source' => ( new Host() )->get_source_query(),
2959	);
2960
2961	// Include the slugs of every plugin currently using the Jetpack connection so wpcom
2962	// knows which integrations the site is authorizing on behalf of. `Plugin_Storage::get_all()`
2963	// returns a `WP_Error` when called before `plugins_loaded`; in that case we silently skip.
2964	$active_plugins = Plugin_Storage::get_all();
2965	if ( is_array( $active_plugins ) && ! empty( $active_plugins ) ) {
2966	$body_args['plugins'] = implode( ',', array_keys( $active_plugins ) );
2967	}
2968
2969	// Signal to Calypso that the site already has a connection owner so the
2970	// authorize page can show secondary-connection content where appropriate.
2971	if ( $this->has_connected_owner() ) {
2972	$body_args['has_connected_owner'] = true;
2973	}
2974
2975	/**
2976	* Filters the user connection request data for additional property addition.
2977	*
2978	* @since 1.7.0
2979	* @since-jetpack 8.0.0
2980	*
2981	* @param array $request_data request data.
2982	*/
2983	$body = apply_filters( 'jetpack_connect_request_body', $body_args );
2984
2985	$body = static::apply_activation_source_to_args( urlencode_deep( $body ) );
2986
2987	$api_url = $this->api_url( 'authorize' );
2988
2989	$url = add_query_arg( $body, $api_url );
2990
2991	if ( is_network_admin() ) {
2992	$url = add_query_arg( 'is_multisite', network_admin_url( 'admin.php?page=jetpack-settings' ), $url );
2993	}
2994
2995	if ( $from ) {
2996	$url = add_query_arg( 'from', $from, $url );
2997	}
2998
2999	if ( $raw ) {
3000	$url = esc_url_raw( $url );
3001	}
3002
3003	/**
3004	* Filter the URL used when connecting a user to a WordPress.com account.
3005	*
3006	* @since 2.0.0
3007	* @since 2.7.6 Added $raw parameter.
3008	*
3009	* @param string $url Connection URL.
3010	* @param bool $raw If true, URL will not be escaped.
3011	*/
3012	return apply_filters( 'jetpack_build_authorize_url', $url, $raw );
3013	}
3014
3015	/**
3016	* Authorizes the user by obtaining and storing the user token.
3017	*
3018	* @param array $data The request data.
3019	* @return string\|\WP_Error Returns a string on success.
3020	* Returns a \WP_Error on failure.
3021	*/
3022	public function authorize( $data = array() ) {
3023	/**
3024	* Action fired when user authorization starts.
3025	*
3026	* @since 1.7.0
3027	* @since-jetpack 8.0.0
3028	*/
3029	do_action( 'jetpack_authorize_starting' );
3030
3031	$roles = new Roles();
3032	$role = $roles->translate_current_user_to_role();
3033
3034	if ( ! $role ) {
3035	return new \WP_Error( 'no_role', 'Invalid request.', 400 );
3036	}
3037
3038	$cap = $roles->translate_role_to_cap( $role );
3039	if ( ! $cap ) {
3040	return new \WP_Error( 'no_cap', 'Invalid request.', 400 );
3041	}
3042
3043	if ( ! empty( $data['error'] ) ) {
3044	return new \WP_Error( $data['error'], 'Error included in the request.', 400 );
3045	}
3046
3047	if ( ! isset( $data['state'] ) ) {
3048	return new \WP_Error( 'no_state', 'Request must include state.', 400 );
3049	}
3050
3051	if ( ! ctype_digit( $data['state'] ) ) {
3052	return new \WP_Error( $data['error'], 'State must be an integer.', 400 );
3053	}
3054
3055	$current_user_id = get_current_user_id();
3056	if ( $current_user_id !== (int) $data['state'] ) {
3057	return new \WP_Error( 'wrong_state', 'State does not match current user.', 400 );
3058	}
3059
3060	if ( empty( $data['code'] ) ) {
3061	return new \WP_Error( 'no_code', 'Request must include an authorization code.', 400 );
3062	}
3063
3064	$token = $this->get_tokens()->get( $data, $this->api_url( 'token' ) );
3065
3066	if ( is_wp_error( $token ) ) {
3067	$code = $token->get_error_code();
3068	if ( empty( $code ) ) {
3069	$code = 'invalid_token';
3070	}
3071	return new \WP_Error( $code, $token->get_error_message(), 400 );
3072	}
3073
3074	if ( ! $token ) {
3075	return new \WP_Error( 'no_token', 'Error generating token.', 400 );
3076	}
3077
3078	$is_connection_owner = ! $this->has_connected_owner();
3079
3080	$this->get_tokens()->update_user_token( $current_user_id, sprintf( '%s.%d', $token, $current_user_id ), $is_connection_owner );
3081
3082	// Delete cached connected user data, so a cached failure from the
3083	// previous (broken) token doesn't linger after reconnecting.
3084	delete_transient( "jetpack_connected_user_data_$current_user_id" );
3085
3086	/**
3087	* Fires after user has successfully received an auth token.
3088	*
3089	* @since 1.7.0
3090	* @since-jetpack 3.9.0
3091	*/
3092	do_action( 'jetpack_user_authorized' );
3093
3094	if ( ! $is_connection_owner ) {
3095	/**
3096	* Action fired when a secondary user has been authorized.
3097	*
3098	* @since 1.7.0
3099	* @since-jetpack 8.0.0
3100	*/
3101	do_action( 'jetpack_authorize_ending_linked' );
3102	return 'linked';
3103	}
3104
3105	/**
3106	* Action fired when the master user has been authorized.
3107	*
3108	* @since 1.7.0
3109	* @since-jetpack 8.0.0
3110	*
3111	* @param array $data The request data.
3112	*/
3113	do_action( 'jetpack_authorize_ending_authorized', $data );
3114
3115	\Jetpack_Options::delete_raw_option( 'jetpack_last_connect_url_check' );
3116
3117	( new Nonce_Handler() )->reschedule();
3118
3119	return 'authorized';
3120	}
3121
3122	/**
3123	* Disconnects from the Jetpack servers.
3124	* Forgets all connection details and tells the Jetpack servers to do the same.
3125	*
3126	* @param boolean $disconnect_wpcom Should disconnect_site_wpcom be called.
3127	* @param bool $ignore_connected_plugins Delete the tokens even if there are other connected plugins.
3128	*/
3129	public function disconnect_site( $disconnect_wpcom = true, $ignore_connected_plugins = true ) {
3130	if ( ! $ignore_connected_plugins && null !== $this->plugin && ! $this->plugin->is_only() ) {
3131	return false;
3132	}
3133
3134	wp_clear_scheduled_hook( 'jetpack_clean_nonces' );
3135
3136	( new Nonce_Handler() )->clean_all();
3137
3138	Heartbeat::init()->deactivate();
3139
3140	/**
3141	* Fires before a site is disconnected.
3142	*
3143	* @since 1.36.3
3144	*/
3145	do_action( 'jetpack_site_before_disconnected' );
3146
3147	// If the site is in an IDC because sync is not allowed,
3148	// let's make sure to not disconnect the production site.
3149	if ( $disconnect_wpcom ) {
3150	$tracking = new Tracking();
3151	$tracking->record_user_event( 'disconnect_site', array() );
3152
3153	$this->disconnect_site_wpcom( $ignore_connected_plugins );
3154	}
3155
3156	$this->delete_all_connection_tokens( $ignore_connected_plugins );
3157
3158	// Remove tracked package versions, since they depend on the Jetpack Connection.
3159	delete_option( Package_Version_Tracker::PACKAGE_VERSION_OPTION );
3160
3161	$jetpack_unique_connection = \Jetpack_Options::get_option( 'unique_connection' );
3162	if ( $jetpack_unique_connection ) {
3163	// Check then record unique disconnection if site has never been disconnected previously.
3164	if ( - 1 === $jetpack_unique_connection['disconnected'] ) {
3165	$jetpack_unique_connection['disconnected'] = 1;
3166	} else {
3167	if ( 0 === $jetpack_unique_connection['disconnected'] ) {
3168	$a8c_mc_stats_instance = new A8c_Mc_Stats();
3169	$a8c_mc_stats_instance->add( 'connections', 'unique-disconnect' );
3170	$a8c_mc_stats_instance->do_server_side_stats();
3171	}
3172	// increment number of times disconnected.
3173	$jetpack_unique_connection['disconnected'] += 1;
3174	}
3175
3176	\Jetpack_Options::update_option( 'unique_connection', $jetpack_unique_connection );
3177	}
3178
3179	/**
3180	* Fires when a site is disconnected.
3181	*
3182	* @since 1.30.1
3183	*/
3184	do_action( 'jetpack_site_disconnected' );
3185	}
3186
3187	/**
3188	* The Base64 Encoding of the SHA1 Hash of the Input.
3189	*
3190	* @param string $text The string to hash.
3191	* @return string
3192	*/
3193	public function sha1_base64( $text ) {
3194	return base64_encode( sha1( $text, true ) ); // phpcs:ignore WordPress.PHP.DiscouragedPHPFunctions.obfuscation_base64_encode
3195	}
3196
3197	/**
3198	* This function mirrors Jetpack_Data::is_usable_domain() in the WPCOM codebase.
3199	*
3200	* @param string $domain The domain to check.
3201	*
3202	* @return bool\|WP_Error
3203	*/
3204	public function is_usable_domain( $domain ) {
3205
3206	// If it's empty, just fail out.
3207	if ( ! $domain ) {
3208	return new \WP_Error(
3209	'fail_domain_empty',
3210	/* translators: %1$s is a domain name. */
3211	sprintf( __( 'Domain `%1$s` just failed is_usable_domain check as it is empty.', 'jetpack-connection' ), $domain )
3212	);
3213	}
3214
3215	/**
3216	* Skips the usuable domain check when connecting a site.
3217	*
3218	* Allows site administrators with domains that fail gethostname-based checks to pass the request to WP.com
3219	*
3220	* @since 1.7.0
3221	* @since-jetpack 4.1.0
3222	*
3223	* @param bool If the check should be skipped. Default false.
3224	*/
3225	if ( apply_filters( 'jetpack_skip_usuable_domain_check', false ) ) {
3226	return true;
3227	}
3228
3229	// None of the explicit localhosts.
3230	$forbidden_domains = array(
3231	'wordpress.com',
3232	'localhost',
3233	'localhost.localdomain',
3234	'local.wordpress.test', // VVV pattern.
3235	'local.wordpress-trunk.test', // VVV pattern.
3236	'src.wordpress-develop.test', // VVV pattern.
3237	'build.wordpress-develop.test', // VVV pattern.
3238	);
3239	if ( in_array( $domain, $forbidden_domains, true ) ) {
3240	return new \WP_Error(
3241	'fail_domain_forbidden',
3242	sprintf(
3243	/* translators: %1$s is a domain name. */
3244	__(
3245	'Domain `%1$s` just failed is_usable_domain check as it is in the forbidden array.',
3246	'jetpack-connection'
3247	),
3248	$domain
3249	)
3250	);
3251	}
3252
3253	// No .test or .local domains.
3254	if ( preg_match( '#\.(test\|local)$#i', $domain ) ) {
3255	return new \WP_Error(
3256	'fail_domain_tld',
3257	sprintf(
3258	/* translators: %1$s is a domain name. */
3259	__(
3260	'Domain `%1$s` just failed is_usable_domain check as it uses an invalid top level domain.',
3261	'jetpack-connection'
3262	),
3263	$domain
3264	)
3265	);
3266	}
3267
3268	// No WPCOM subdomains.
3269	if ( preg_match( '#\.WordPress\.com$#i', $domain ) ) {
3270	return new \WP_Error(
3271	'fail_subdomain_wpcom',
3272	sprintf(
3273	/* translators: %1$s is a domain name. */
3274	__(
3275	'Domain `%1$s` just failed is_usable_domain check as it is a subdomain of WordPress.com.',
3276	'jetpack-connection'
3277	),
3278	$domain
3279	)
3280	);
3281	}
3282
3283	// If PHP was compiled without support for the Filter module (very edge case).
3284	if ( ! function_exists( 'filter_var' ) ) {
3285	// Just pass back true for now, and let wpcom sort it out.
3286	return true;
3287	}
3288
3289	$domain = preg_replace( '#^https?://#', '', untrailingslashit( $domain ) );
3290
3291	if ( filter_var( $domain, FILTER_VALIDATE_IP )
3292	&& ! \Automattic\Jetpack\IP\Utils::ip_is_public( $domain )
3293	) {
3294	return new \WP_Error(
3295	'fail_ip_forbidden',
3296	sprintf(
3297	/* translators: %1$s is a domain name. */
3298	__(
3299	'IP address `%1$s` just failed is_usable_domain check as it is not a public IP address.',
3300	'jetpack-connection'
3301	),
3302	$domain
3303	)
3304	);
3305	}
3306
3307	return true;
3308	}
3309
3310	/**
3311	* Gets the requested token.
3312	*
3313	* @deprecated 1.24.0 Use Automattic\Jetpack\Connection\Tokens->get_access_token() instead.
3314	*
3315	* @param int\|false $user_id false: Return the Blog Token. int: Return that user's User Token.
3316	* @param string\|false $token_key If provided, check that the token matches the provided input.
3317	* @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.
3318	*
3319	* @return object\|false
3320	*
3321	* @see $this->get_tokens()->get_access_token()
3322	*/
3323	public function get_access_token( $user_id = false, $token_key = false, $suppress_errors = true ) {
3324	_deprecated_function( __METHOD__, '1.24.0', 'Automattic\\Jetpack\\Connection\\Tokens->get_access_token' );
3325	return $this->get_tokens()->get_access_token( $user_id, $token_key, $suppress_errors );
3326	}
3327
3328	/**
3329	* In some setups, $HTTP_RAW_POST_DATA can be emptied during some IXR_Server paths
3330	* since it is passed by reference to various methods.
3331	* Capture it here so we can verify the signature later.
3332	*
3333	* @param array $methods an array of available XMLRPC methods.
3334	* @return array the same array, since this method doesn't add or remove anything.
3335	*/
3336	public function xmlrpc_methods( $methods ) {
3337	$this->raw_post_data = $GLOBALS['HTTP_RAW_POST_DATA'] ?? null;
3338	return $methods;
3339	}
3340
3341	/**
3342	* Resets the raw post data parameter for testing purposes.
3343	*/
3344	public function reset_raw_post_data() {
3345	$this->raw_post_data = null;
3346	}
3347
3348	/**
3349	* Registering an additional method.
3350	*
3351	* @param array $methods an array of available XMLRPC methods.
3352	* @return array the amended array in case the method is added.
3353	*/
3354	public function public_xmlrpc_methods( $methods ) {
3355	if ( array_key_exists( 'wp.getOptions', $methods ) ) {
3356	$methods['wp.getOptions'] = array( $this, 'jetpack_get_options' );
3357	}
3358	return $methods;
3359	}
3360
3361	/**
3362	* Handles a getOptions XMLRPC method call.
3363	*
3364	* @param array $args method call arguments.
3365	* @return array\|IXR_Error An amended XMLRPC server options array.
3366	*/
3367	public function jetpack_get_options( $args ) {
3368	global $wp_xmlrpc_server;
3369
3370	$wp_xmlrpc_server->escape( $args );
3371
3372	$username = $args[1];
3373	$password = $args[2];
3374
3375	$user = $wp_xmlrpc_server->login( $username, $password );
3376	if ( ! $user ) {
3377	return $wp_xmlrpc_server->error;
3378	}
3379
3380	$options = array();
3381	$user_data = $this->get_connected_user_data();
3382	if ( is_array( $user_data ) ) {
3383	$options['jetpack_user_id'] = array(
3384	'desc' => __( 'The WP.com user ID of the connected user', 'jetpack-connection' ),
3385	'readonly' => true,
3386	'value' => $user_data['ID'],
3387	);
3388	$options['jetpack_user_login'] = array(
3389	'desc' => __( 'The WP.com username of the connected user', 'jetpack-connection' ),
3390	'readonly' => true,
3391	'value' => $user_data['login'],
3392	);
3393	$options['jetpack_user_email'] = array(
3394	'desc' => __( 'The WP.com user email of the connected user', 'jetpack-connection' ),
3395	'readonly' => true,
3396	'value' => $user_data['email'],
3397	);
3398	$options['jetpack_user_site_count'] = array(
3399	'desc' => __( 'The number of sites of the connected WP.com user', 'jetpack-connection' ),
3400	'readonly' => true,
3401	'value' => $user_data['site_count'],
3402	);
3403	}
3404	$wp_xmlrpc_server->blog_options = array_merge( $wp_xmlrpc_server->blog_options, $options );
3405	$args = stripslashes_deep( $args );
3406	return $wp_xmlrpc_server->wp_getOptions( $args );
3407	}
3408
3409	/**
3410	* Adds Jetpack-specific options to the output of the XMLRPC options method.
3411	*
3412	* @param array $options standard Core options.
3413	* @return array amended options.
3414	*/
3415	public function xmlrpc_options( $options ) {
3416	$jetpack_client_id = false;
3417	if ( $this->is_connected() ) {
3418	$jetpack_client_id = \Jetpack_Options::get_option( 'id' );
3419	}
3420	$options['jetpack_version'] = array(
3421	'desc' => __( 'Jetpack Plugin Version', 'jetpack-connection' ),
3422	'readonly' => true,
3423	'value' => Constants::get_constant( 'JETPACK__VERSION' ),
3424	);
3425
3426	$options['jetpack_client_id'] = array(
3427	'desc' => __( 'The Client ID/WP.com Blog ID of this site', 'jetpack-connection' ),
3428	'readonly' => true,
3429	'value' => $jetpack_client_id,
3430	);
3431	return $options;
3432	}
3433
3434	/**
3435	* Resets the saved authentication state in between testing requests.
3436	*/
3437	public function reset_saved_auth_state() {
3438	$this->xmlrpc_verification = null;
3439	}
3440
3441	/**
3442	* Sign a user role with the master access token.
3443	* If not specified, will default to the current user.
3444	*
3445	* @access public
3446	*
3447	* @param string $role User role.
3448	* @param int $user_id ID of the user.
3449	* @return string Signed user role.
3450	*/
3451	public function sign_role( $role, $user_id = null ) {
3452	return $this->get_tokens()->sign_role( $role, $user_id );
3453	}
3454
3455	/**
3456	* Set the plugin instance.
3457	*
3458	* @param Plugin $plugin_instance The plugin instance.
3459	*
3460	* @return $this
3461	*/
3462	public function set_plugin_instance( Plugin $plugin_instance ) {
3463	$this->plugin = $plugin_instance;
3464
3465	return $this;
3466	}
3467
3468	/**
3469	* Retrieve the plugin management object.
3470	*
3471	* @return Plugin\|null
3472	*/
3473	public function get_plugin() {
3474	return $this->plugin;
3475	}
3476
3477	/**
3478	* Get all connected plugins information, excluding those disconnected by user.
3479	* WARNING: the method cannot be called until Plugin_Storage::configure is called, which happens on plugins_loaded
3480	* Even if you don't use Jetpack Config, it may be introduced later by other plugins,
3481	* so please make sure not to run the method too early in the code.
3482	*
3483	* @return array\|WP_Error
3484	*/
3485	public function get_connected_plugins() {
3486	$maybe_plugins = Plugin_Storage::get_all();
3487
3488	if ( $maybe_plugins instanceof WP_Error ) {
3489	return $maybe_plugins;
3490	}
3491
3492	return $maybe_plugins;
3493	}
3494
3495	/**
3496	* Force plugin disconnect. After its called, the plugin will not be allowed to use the connection.
3497	* Note: this method does not remove any access tokens.
3498	*
3499	* @deprecated since 1.39.0
3500	* @return bool
3501	*/
3502	public function disable_plugin() {
3503	return null;
3504	}
3505
3506	/**
3507	* Force plugin reconnect after user-initiated disconnect.
3508	* After its called, the plugin will be allowed to use the connection again.
3509	* Note: this method does not initialize access tokens.
3510	*
3511	* @deprecated since 1.39.0.
3512	* @return bool
3513	*/
3514	public function enable_plugin() {
3515	return null;
3516	}
3517
3518	/**
3519	* Whether the plugin is allowed to use the connection, or it's been disconnected by user.
3520	* If no plugin slug was passed into the constructor, always returns true.
3521	*
3522	* @deprecated 1.42.0 This method no longer has a purpose after the removal of the soft disconnect feature.
3523	*
3524	* @return bool
3525	*/
3526	public function is_plugin_enabled() {
3527	return true;
3528	}
3529
3530	/**
3531	* Perform the API request to refresh the blog token.
3532	* Note that we are making this request on behalf of the Jetpack master user,
3533	* given they were (most probably) the ones that registered the site at the first place.
3534	*
3535	* @return WP_Error\|bool The result of updating the blog_token option.
3536	*/
3537	public function refresh_blog_token() {
3538	( new Tracking() )->record_user_event( 'restore_connection_refresh_blog_token' );
3539
3540	$blog_id = \Jetpack_Options::get_option( 'id' );
3541	if ( ! $blog_id ) {
3542	return new WP_Error( 'site_not_registered', 'Site not registered.' );
3543	}
3544
3545	$url = sprintf(
3546	'%s/%s/v%s/%s',
3547	Constants::get_constant( 'JETPACK__WPCOM_JSON_API_BASE' ),
3548	'wpcom',
3549	'2',
3550	'sites/' . $blog_id . '/jetpack-refresh-blog-token'
3551	);
3552	$method = 'POST';
3553	$user_id = get_current_user_id();
3554
3555	$response = Client::remote_request( compact( 'url', 'method', 'user_id' ) );
3556
3557	if ( is_wp_error( $response ) ) {
3558	return new WP_Error( 'refresh_blog_token_http_request_failed', $response->get_error_message() );
3559	}
3560
3561	$code = wp_remote_retrieve_response_code( $response );
3562	$entity = wp_remote_retrieve_body( $response );
3563
3564	if ( $entity ) {
3565	$json = json_decode( $entity );
3566	} else {
3567	$json = false;
3568	}
3569
3570	if ( 200 !== $code ) {
3571	if ( empty( $json->code ) ) {
3572	return new WP_Error( 'unknown', '', $code );
3573	}
3574
3575	/* translators: Error description string. */
3576	$error_description = isset( $json->message ) ? sprintf( __( 'Error Details: %s', 'jetpack-connection' ), (string) $json->message ) : '';
3577
3578	return new WP_Error( (string) $json->code, $error_description, $code );
3579	}
3580
3581	if ( empty( $json->jetpack_secret ) \|\| ! is_scalar( $json->jetpack_secret ) ) {
3582	return new WP_Error( 'jetpack_secret', '', $code );
3583	}
3584
3585	Error_Handler::get_instance()->delete_all_errors();
3586
3587	return $this->get_tokens()->update_blog_token( (string) $json->jetpack_secret );
3588	}
3589
3590	/**
3591	* Disconnect the user from WP.com, and initiate the reconnect process.
3592	*
3593	* @since 9.8.0 Added the `$force` parameter.
3594	*
3595	* @param bool $force Whether to remove the local token even if WordPress.com does not confirm the unlink.
3596	* When false, only the current user's own token is refreshed, never the owner's,
3597	* and only over a healthy blog token.
3598	* @return true\|string\|WP_Error True when forced. Otherwise 'authorize' when the user should authorize again, a `WP_Error` object on failure.
3599	*/
3600	public function refresh_user_token( $force = true ) {
3601	$user_id = get_current_user_id();
3602
3603	if ( ! $force ) {
3604	// Unlinking the owner would leave the site without one.
3605	if ( ! $user_id \|\| $this->is_site_connection() \|\| $this->get_connection_owner_id() === $user_id ) {
3606	return new WP_Error(
3607	'restore_requires_administrator',
3608	__( 'An administrator needs to restore the Jetpack connection.', 'jetpack-connection' ),
3609	array( 'status' => 403 )
3610	);
3611	}
3612
3613	// Relinking goes over the blog token, so it must work before anything is unlinked.
3614	$blog_token_health = $this->get_tokens()->validate_blog_token();
3615
3616	if ( is_wp_error( $blog_token_health ) ) {
3617	return new WP_Error(
3618	'restore_check_failed',
3619	__( 'The site connection could not be checked. Please try again shortly.', 'jetpack-connection' ),
3620	array( 'status' => 503 )
3621	);
3622	}
3623
3624	if ( true !== $blog_token_health ) {
3625	return new WP_Error(
3626	'restore_requires_administrator',
3627	__( 'The site connection is broken. An administrator needs to restore it before you can reconnect your account.', 'jetpack-connection' ),
3628	array( 'status' => 409 )
3629	);
3630	}
3631	}
3632
3633	// A forced refresh unlinks even without a stored token, as it always has.
3634	if ( $force \|\| $this->is_user_connected( $user_id ) ) {
3635	( new Tracking() )->record_user_event( 'restore_connection_refresh_user_token' );
3636
3637	// Unforced, the local token only goes once WordPress.com has unlinked it.
3638	$unlinked = $this->disconnect_user( $force ? null : $user_id, $force, $force );
3639
3640	if ( ! $force && ! $unlinked ) {
3641	return new WP_Error(
3642	'restore_unlink_failed',
3643	__( 'Your account could not be disconnected from WordPress.com. Please try again.', 'jetpack-connection' ),
3644	array( 'status' => 502 )
3645	);
3646	}
3647	}
3648
3649	return $force ? true : 'authorize';
3650	}
3651
3652	/**
3653	* Fetches a signed token.
3654	*
3655	* @deprecated 1.24.0 Use Automattic\Jetpack\Connection\Tokens->get_signed_token() instead.
3656	*
3657	* @param object $token the token.
3658	* @return WP_Error\|string a signed token
3659	*/
3660	public function get_signed_token( $token ) {
3661	_deprecated_function( __METHOD__, '1.24.0', 'Automattic\\Jetpack\\Connection\\Tokens->get_signed_token' );
3662	return $this->get_tokens()->get_signed_token( $token );
3663	}
3664
3665	/**
3666	* If the site-level connection is active, add the list of plugins using connection to the heartbeat (except Jetpack itself)
3667	*
3668	* @since 6.11.0 Add the list of Jetpack package versions to the heartbeat.
3669	* @since 8.7.4 Add the missing connection owner and XML-RPC error stats to the heartbeat.
3670	* @since 8.7.9 Add the site environment stats (WordPress/PHP versions, etc.) to the heartbeat.
3671	*
3672	* @param array $stats The Heartbeat stats array.
3673	* @return array $stats
3674	*/
3675	public function add_stats_to_heartbeat( $stats ) {
3676
3677	if ( ! $this->is_connected() ) {
3678	return $stats;
3679	}
3680
3681	$active_plugins_using_connection = Plugin_Storage::get_all();
3682	foreach ( array_keys( $active_plugins_using_connection ) as $plugin_slug ) {
3683	if ( 'jetpack' !== $plugin_slug ) {
3684	$stats_group = isset( $active_plugins_using_connection['jetpack'] ) ? 'combined-connection' : 'standalone-connection';
3685	$stats[ $stats_group ][] = $plugin_slug;
3686	}
3687	}
3688
3689	$stats['jetpack_package_versions'] = apply_filters( 'jetpack_package_versions', array() );
3690
3691	$stats['identitycrisis'] = Identity_Crisis::check_identity_crisis() ? 'yes' : 'no';
3692
3693	// Missing the connection owner?
3694	$stats['missing-owner'] = $this->is_missing_connection_owner();
3695
3696	$xmlrpc_errors = \Jetpack_Options::get_option( 'xmlrpc_errors', array() );
3697	if ( $xmlrpc_errors ) {
3698	$stats['xmlrpc-errors'] = implode( ',', array_keys( $xmlrpc_errors ) );
3699	\Jetpack_Options::delete_option( 'xmlrpc_errors' );
3700	}
3701
3702	// Site environment stats (WordPress/PHP versions, site configuration, etc.).
3703	$stats = array_merge( $stats, Heartbeat::get_environment_stats() );
3704
3705	return $stats;
3706	}
3707
3708	/**
3709	* Records a failed XML-RPC signature verification so it can be reported in the heartbeat.
3710	*
3711	* We don't want to expose a detailed error message about why a request failed
3712	* signature verification, as doing so could leak information. Instead, we track
3713	* that the error occurred via a Jetpack option and send that data back in the
3714	* heartbeat. All this does is record the error code, but it's enough to find trends.
3715	*
3716	* @since 8.7.4
3717	*
3718	* @param \WP_Error $xmlrpc_error The error produced during signature validation.
3719	* @return void
3720	*/
3721	public function track_xmlrpc_error( $xmlrpc_error ) {
3722	$code = is_wp_error( $xmlrpc_error )
3723	? $xmlrpc_error->get_error_code()
3724	: 'should-not-happen';
3725
3726	$xmlrpc_errors = \Jetpack_Options::get_option( 'xmlrpc_errors', array() );
3727	if ( isset( $xmlrpc_errors[ $code ] ) && $xmlrpc_errors[ $code ] ) {
3728	// No need to update the option if we already have this code stored.
3729	return;
3730	}
3731	$xmlrpc_errors[ $code ] = true;
3732
3733	\Jetpack_Options::update_option( 'xmlrpc_errors', $xmlrpc_errors, false );
3734	}
3735
3736	/**
3737	* Get the WPCOM or self-hosted site ID.
3738	*
3739	* @param bool $quiet Return null instead of an error.
3740	*
3741	* @return int\|WP_Error\|null
3742	*/
3743	public static function get_site_id( $quiet = false ) {
3744	$is_wpcom = ( defined( 'IS_WPCOM' ) && IS_WPCOM );
3745	$site_id = $is_wpcom ? get_current_blog_id() : \Jetpack_Options::get_option( 'id' );
3746	if ( ! $site_id ) {
3747	return $quiet
3748	? null
3749	: new \WP_Error(
3750	'unavailable_site_id',
3751	__( 'Sorry, something is wrong with your Jetpack connection.', 'jetpack-connection' ),
3752	403
3753	);
3754	}
3755	return (int) $site_id;
3756	}
3757
3758	/**
3759	* Check if Jetpack is ready for uninstall cleanup.
3760	*
3761	* @param string $current_plugin_slug The current plugin's slug.
3762	*
3763	* @return bool
3764	*/
3765	public static function is_ready_for_cleanup( $current_plugin_slug ) {
3766	$active_plugins = get_option( Plugin_Storage::ACTIVE_PLUGINS_OPTION_NAME );
3767
3768	return empty( $active_plugins ) \|\| ! is_array( $active_plugins )
3769	\|\| ( count( $active_plugins ) === 1 && array_key_exists( $current_plugin_slug, $active_plugins ) );
3770	}
3771	}
3772