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

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

3,570 lines 118.7 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, 'promote_protected_owner_on_connect' ) );
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	* Re-point the connection owner at the protected owner when they connect.
1465	*
1466	* Local only: it promotes an owner WordPress.com has already confirmed, and never establishes.
1467	* The binding is resolved rather than read because the token written moments earlier
1468	* invalidated any stored one.
1469	*
1470	* @internal Hooked on `jetpack_user_authorized`.
1471	* @since 9.5.0
1472	*/
1473	public function promote_protected_owner_on_connect() {
1474	$anchor = Protected_Owner::get_locked();
1475
1476	if ( ! $anchor ) {
1477	return;
1478	}
1479
1480	$user_id = get_current_user_id();
1481
1482	if ( ! $user_id ) {
1483	return;
1484	}
1485
1486	// `jetpack_connect_user` drops to `read` once an owner exists, so any user can authorize.
1487	if ( ! user_can( $user_id, ( new Roles() )->translate_role_to_cap( 'administrator' ) ) ) {
1488	return;
1489	}
1490
1491	if ( $this->resolve_wpcom_user_id( $user_id ) !== (int) $anchor['wpcom_user_id'] ) {
1492	return;
1493	}
1494
1495	// The cached local ID moves with the owner even when the master slot already agrees.
1496	Protected_Owner::repoint( $user_id );
1497
1498	if ( (int) \Jetpack_Options::get_option( 'master_user' ) !== $user_id ) {
1499	\Jetpack_Options::update_option( 'master_user', $user_id );
1500	}
1501	}
1502
1503	/**
1504	* Record a user as the protected owner and promote them to connection owner.
1505	*
1506	* Gated on `jetpack_connect` rather than on a role: a host can narrow that capability and
1507	* multisite does. It is false while the package is unconfigured, so a caller that has not
1508	* registered the connection's capabilities is refused rather than trusted.
1509	*
1510	* @since 9.3.0
1511	*
1512	* @param int $user_id The local user to anchor.
1513	* @param string $confirmed_by How the confirmation was obtained, e.g. `popup` or `recovery`.
1514	* @return true\|WP_Error True on success, WP_Error otherwise.
1515	*/
1516	public function set_protected_owner( $user_id, $confirmed_by ) {
1517	// Authorization precedes validation, so an unauthorized caller cannot use the argument
1518	// errors below to learn which users are administrators or hold a token.
1519	if ( ! current_user_can( 'jetpack_connect' ) ) {
1520	return new WP_Error(
1521	'protected_owner_forbidden',
1522	__( 'You do not have permission to manage the protected owner.', 'jetpack-connection' ),
1523	array( 'status' => 403 )
1524	);
1525	}
1526
1527	$user_id = absint( $user_id );
1528	$roles = new Roles();
1529
1530	if ( ! sanitize_key( $confirmed_by ) ) {
1531	return new WP_Error(
1532	'protected_owner_missing_provenance',
1533	__( 'Recording a protected owner requires naming how it was confirmed.', 'jetpack-connection' ),
1534	array( 'status' => 400 )
1535	);
1536	}
1537
1538	if ( ! user_can( $user_id, $roles->translate_role_to_cap( 'administrator' ) ) ) {
1539	return new WP_Error(
1540	'protected_owner_not_admin',
1541	__( 'The protected owner must be an administrator.', 'jetpack-connection' ),
1542	array( 'status' => 400 )
1543	);
1544	}
1545
1546	// Fail closed: this is false for a user with no token and for one WordPress.com cannot
1547	// confirm, and an unverified identity must never be written down and locked.
1548	$owner_data = $this->get_connected_user_data( $user_id );
1549
1550	if ( empty( $owner_data['ID'] ) ) {
1551	return new WP_Error(
1552	'protected_owner_not_verified',
1553	__( 'Could not confirm the protected owner with WordPress.com.', 'jetpack-connection' ),
1554	array( 'status' => 400 )
1555	);
1556	}
1557
1558	// Store the binding the anchor will be compared against, so the gate reads local state from
1559	// here on. Routed through the deduping writer, which clears the ID off any previous holder.
1560	Utils::set_wpcom_user_id( $user_id, (int) $owner_data['ID'] );
1561
1562	if ( ! Protected_Owner::set( (int) $owner_data['ID'], $user_id, $confirmed_by ) ) {
1563	return new WP_Error(
1564	'protected_owner_not_stored',
1565	__( 'Could not store the protected owner.', 'jetpack-connection' ),
1566	array( 'status' => 500 )
1567	);
1568	}
1569
1570	// Written directly rather than through update_connection_owner(): that round-trips to
1571	// WordPress.com first, and its ownership-change guard will refuse the anchor just set here.
1572	\Jetpack_Options::update_option( 'master_user', $user_id );
1573
1574	return true;
1575	}
1576
1577	/**
1578	* Drop the protected owner anchor, unlocking ownership.
1579	*
1580	* Gated on `jetpack_connect` like establishing one, releasing a lock being the more
1581	* consequential half. The `@internal` tag is documentation; the capability is enforcement.
1582	*
1583	* @internal Recovery and support flows only. Consumers must not call this.
1584	* @since 9.3.0
1585	*
1586	* @return true\|WP_Error True once no anchor is set, WP_Error otherwise.
1587	*/
1588	public function clear_protected_owner() {
1589	if ( ! current_user_can( 'jetpack_connect' ) ) {
1590	return new WP_Error(
1591	'protected_owner_forbidden',
1592	__( 'You do not have permission to manage the protected owner.', 'jetpack-connection' ),
1593	array( 'status' => 403 )
1594	);
1595	}
1596
1597	Protected_Owner::clear();
1598
1599	// Asked of the outcome rather than of `delete_option()`, which also reports false for an
1600	// anchor that was already absent — the state the caller asked for.
1601	if ( Protected_Owner::get() ) {
1602	return new WP_Error(
1603	'protected_owner_not_cleared',
1604	__( 'Could not clear the protected owner.', 'jetpack-connection' ),
1605	array( 'status' => 500 )
1606	);
1607	}
1608
1609	return true;
1610	}
1611
1612	/**
1613	* Connects the user with a specified ID to a WordPress.com user using the
1614	* remote login flow.
1615	*
1616	* @access public
1617	*
1618	* @param int\|null $user_id (optional) the user identifier, defaults to current user.
1619	* @param string\|null $redirect_url the URL to redirect the user to for processing, defaults to
1620	* admin_url().
1621	* @return WP_Error only in case of a failed user lookup.
1622	*/
1623	public function connect_user( $user_id = null, $redirect_url = null ) {
1624	$user = null;
1625	if ( null === $user_id ) {
1626	$user = wp_get_current_user();
1627	} else {
1628	$user = get_user_by( 'ID', $user_id );
1629	}
1630
1631	if ( empty( $user ) ) {
1632	return new \WP_Error( 'user_not_found', 'Attempting to connect a non-existent user.' );
1633	}
1634
1635	if ( null === $redirect_url ) {
1636	$redirect_url = admin_url();
1637	}
1638
1639	// Using wp_redirect intentionally because we're redirecting outside.
1640	wp_redirect( $this->get_authorization_url( $user, $redirect_url ) ); // phpcs:ignore WordPress.Security.SafeRedirect
1641	exit( 0 );
1642	}
1643
1644	/**
1645	* Force user disconnect.
1646	*
1647	* @param int $user_id Local (external) user ID.
1648	* @param bool $disconnect_all_users Whether to disconnect all users before disconnecting the primary user.
1649	*
1650	* @return bool
1651	*/
1652	public function disconnect_user_force( $user_id, $disconnect_all_users = false ) {
1653	if ( ! (int) $user_id ) {
1654	// Missing user ID.
1655	return false;
1656	}
1657	// If we are disconnecting the primary user we may need to disconnect all other users first
1658	if ( $user_id === $this->get_connection_owner_id() && $disconnect_all_users && ! $this->disconnect_all_users_except_primary() ) {
1659	return false;
1660	}
1661
1662	return $this->disconnect_user( $user_id, true, true );
1663	}
1664
1665	/**
1666	* Disconnects all users except the primary user.
1667	*
1668	* @return bool
1669	*/
1670	public function disconnect_all_users_except_primary() {
1671
1672	$all_connected_users = $this->get_connected_users();
1673
1674	foreach ( $all_connected_users as $user ) {
1675	// Skip the primary.
1676	if ( $user->ID === $this->get_connection_owner_id() ) {
1677	continue;
1678	}
1679	$disconnected = $this->disconnect_user( $user->ID, false, true );
1680	// If we fail to disconnect any user, we should not proceed with disconnecting the primary user.
1681	if ( ! $disconnected ) {
1682	return false;
1683	}
1684	}
1685
1686	return true;
1687	}
1688
1689	/**
1690	* Unlinks the current user from the linked WordPress.com user.
1691	*
1692	* @access public
1693	* @static
1694	*
1695	* @todo Refactor to properly load the XMLRPC client independently.
1696	*
1697	* @param int\|null $user_id the user identifier.
1698	* @param bool $can_overwrite_primary_user Allow for the primary user to be disconnected.
1699	* @param bool $force_disconnect_locally Disconnect user locally even if we were unable to disconnect them from WP.com.
1700	* @return bool Whether the disconnection of the user was successful.
1701	*/
1702	public function disconnect_user( $user_id = null, $can_overwrite_primary_user = false, $force_disconnect_locally = false ) {
1703	$user_id = empty( $user_id ) ? get_current_user_id() : (int) $user_id;
1704	$is_primary_user = Jetpack_Options::get_option( 'master_user' ) === $user_id;
1705
1706	if ( $is_primary_user && ! $can_overwrite_primary_user ) {
1707	return false;
1708	}
1709
1710	if ( in_array( $user_id, self::$disconnected_users, true ) ) {
1711	// The user is already disconnected.
1712	return false;
1713	}
1714
1715	// Attempt to disconnect the user from WordPress.com.
1716	$is_disconnected_from_wpcom = $this->unlink_user_from_wpcom( $user_id );
1717
1718	$is_disconnected_locally = false;
1719	if ( $is_disconnected_from_wpcom \|\| $force_disconnect_locally ) {
1720	// Get the WordPress.com email before disconnecting the user
1721	$wpcom_user_data = $this->get_connected_user_data( $user_id );
1722	$wpcom_email = $wpcom_user_data['email'] ?? null;
1723
1724	// Disconnect the user locally.
1725	$is_disconnected_locally = $this->get_tokens()->disconnect_user( $user_id );
1726
1727	if ( $is_disconnected_locally ) {
1728	// Delete cached connected user data.
1729	$transient_key = "jetpack_connected_user_data_$user_id";
1730	delete_transient( $transient_key );
1731
1732	// Clean up account mismatch transients for this user
1733	if ( $wpcom_email ) {
1734	$user_account_status = new User_Account_Status();
1735	$user_account_status->clean_account_mismatch_transients( $wpcom_email );
1736	}
1737
1738	/**
1739	* Fires after the current user has been unlinked from WordPress.com.
1740	*
1741	* @since 1.7.0
1742	* @since-jetpack 4.1.0
1743	*
1744	* @param int $user_id The current user's ID.
1745	*/
1746	do_action( 'jetpack_unlinked_user', $user_id );
1747
1748	if ( $is_primary_user ) {
1749	Jetpack_Options::delete_option( 'master_user' );
1750
1751	// Clear the memoized connection owner ID since it changed
1752	self::$connection_owner_id = null;
1753	}
1754	}
1755	}
1756
1757	self::$disconnected_users[] = $user_id;
1758
1759	return $is_disconnected_from_wpcom && $is_disconnected_locally;
1760	}
1761
1762	/**
1763	* Request to wpcom for a user to be unlinked from their WordPress.com account
1764	*
1765	* @param int $user_id The user identifier.
1766	*
1767	* @return bool Whether the disconnection of the user was successful.
1768	*/
1769	public function unlink_user_from_wpcom( $user_id ) {
1770	// Attempt to disconnect the user from WordPress.com.
1771	$xml = new Jetpack_IXR_Client();
1772
1773	$xml->query( 'jetpack.unlink_user', $user_id );
1774	if ( $xml->isError() ) {
1775	return false;
1776	}
1777
1778	return (bool) $xml->getResponse();
1779	}
1780
1781	/**
1782	* Update the connection owner.
1783	*
1784	* @since 1.29.0
1785	* @since 9.3.0 Refused while ownership is locked.
1786	*
1787	* @param int $new_owner_id The ID of the user to become the connection owner.
1788	*
1789	* @return true\|WP_Error True if owner successfully changed, WP_Error otherwise.
1790	*/
1791	public function update_connection_owner( $new_owner_id ) {
1792	// Answered before the arguments are validated: no candidate is valid while ownership is
1793	// locked, and an argument error would suggest a retry that cannot work.
1794	if ( ! $this->is_ownership_transferable() ) {
1795	return new WP_Error(
1796	'ownership_locked',
1797	__( 'The connection owner is locked on this site.', 'jetpack-connection' ),
1798	array( 'status' => 403 )
1799	);
1800	}
1801
1802	$roles = new Roles();
1803	if ( ! user_can( $new_owner_id, $roles->translate_role_to_cap( 'administrator' ) ) ) {
1804	return new WP_Error(
1805	'new_owner_not_admin',
1806	__( 'New owner is not admin', 'jetpack-connection' ),
1807	array( 'status' => 400 )
1808	);
1809	}
1810
1811	$old_owner_id = $this->get_connection_owner_id();
1812
1813	if ( $old_owner_id === $new_owner_id ) {
1814	return new WP_Error(
1815	'new_owner_is_existing_owner',
1816	__( 'New owner is same as existing owner', 'jetpack-connection' ),
1817	array( 'status' => 400 )
1818	);
1819	}
1820
1821	if ( ! $this->is_user_connected( $new_owner_id ) ) {
1822	return new WP_Error(
1823	'new_owner_not_connected',
1824	__( 'New owner is not connected', 'jetpack-connection' ),
1825	array( 'status' => 400 )
1826	);
1827	}
1828
1829	// Notify WPCOM about the connection owner change.
1830	$owner_updated_wpcom = $this->update_connection_owner_wpcom( $new_owner_id );
1831
1832	if ( $owner_updated_wpcom ) {
1833	// Update the connection owner in Jetpack only if they were successfully updated on WPCOM.
1834	// This will ensure consistency with WPCOM.
1835	\Jetpack_Options::update_option( 'master_user', $new_owner_id );
1836
1837	// Clear the memoized connection owner ID since it changed
1838	self::$connection_owner_id = null;
1839
1840	// Track it.
1841	( new Tracking() )->record_user_event( 'set_connection_owner_success' );
1842
1843	return true;
1844	}
1845	return new WP_Error(
1846	'error_setting_new_owner',
1847	__( 'Could not confirm new owner.', 'jetpack-connection' ),
1848	array( 'status' => 500 )
1849	);
1850	}
1851
1852	/**
1853	* Request to WPCOM to update the connection owner.
1854	*
1855	* @since 1.29.0
1856	*
1857	* @param int $new_owner_id The ID of the user to become the connection owner.
1858	*
1859	* @return bool Whether the ownership transfer was successful.
1860	*/
1861	public function update_connection_owner_wpcom( $new_owner_id ) {
1862	// Notify WPCOM about the connection owner change.
1863	$xml = new Jetpack_IXR_Client(
1864	array(
1865	'user_id' => get_current_user_id(),
1866	)
1867	);
1868	$xml->query(
1869	'jetpack.switchBlogOwner',
1870	array(
1871	'new_blog_owner' => $new_owner_id,
1872	)
1873	);
1874	if ( $xml->isError() ) {
1875	return false;
1876	}
1877
1878	return (bool) $xml->getResponse();
1879	}
1880
1881	/**
1882	* Returns the requested Jetpack API URL.
1883	*
1884	* @param string $relative_url the relative API path.
1885	* @return string API URL.
1886	*/
1887	public function api_url( $relative_url ) {
1888	$api_base = Constants::get_constant( 'JETPACK__API_BASE' );
1889	$api_version = '/' . Constants::get_constant( 'JETPACK__API_VERSION' ) . '/';
1890
1891	/**
1892	* Filters the API URL that Jetpack uses for server communication.
1893	*
1894	* @since 1.7.0
1895	* @since-jetpack 8.0.0
1896	*
1897	* @param string $url the generated URL.
1898	* @param string $relative_url the relative URL that was passed as an argument.
1899	* @param string $api_base the API base string that is being used.
1900	* @param string $api_version the API version string that is being used.
1901	*/
1902	return apply_filters(
1903	'jetpack_api_url',
1904	rtrim( $api_base . $relative_url, '/\\' ) . $api_version,
1905	$relative_url,
1906	$api_base,
1907	$api_version
1908	);
1909	}
1910
1911	/**
1912	* Returns the Jetpack XMLRPC WordPress.com API endpoint URL.
1913	*
1914	* @return string XMLRPC API URL.
1915	*/
1916	public function xmlrpc_api_url() {
1917	$base = preg_replace(
1918	'#(https?://[^?/]+)(/?.*)?$#',
1919	'\\1',
1920	Constants::get_constant( 'JETPACK__API_BASE' )
1921	);
1922	return untrailingslashit( $base ) . '/xmlrpc.php';
1923	}
1924
1925	/**
1926	* Attempts Jetpack registration which sets up the site for connection. Should
1927	* remain public because the call to action comes from the current site, not from
1928	* WordPress.com.
1929	*
1930	* @param string $api_endpoint (optional) an API endpoint to use, defaults to 'register'.
1931	* @return true\|WP_Error The error object.
1932	*/
1933	public function register( $api_endpoint = 'register' ) {
1934	// Clean-up leftover tokens just in-case.
1935	// This fixes an edge case that was preventing users to register when the blog token was missing but
1936	// there were still leftover user tokens present.
1937	$this->delete_all_connection_tokens( true );
1938
1939	add_action( 'pre_update_jetpack_option_register', array( '\\Jetpack_Options', 'delete_option' ) );
1940	$secrets = ( new Secrets() )->generate( 'register', get_current_user_id(), 600 );
1941
1942	if ( false === $secrets ) {
1943	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' ) );
1944	}
1945
1946	if (
1947	empty( $secrets['secret_1'] ) \|\|
1948	empty( $secrets['secret_2'] ) \|\|
1949	empty( $secrets['exp'] )
1950	) {
1951	return new \WP_Error( 'missing_secrets' );
1952	}
1953
1954	// Better to try (and fail) to set a higher timeout than this system
1955	// supports than to have register fail for more users than it should.
1956	$timeout = $this->set_min_time_limit( 60 ) / 2;
1957
1958	$gmt_offset = get_option( 'gmt_offset' );
1959	if ( ! $gmt_offset ) {
1960	$gmt_offset = 0;
1961	}
1962
1963	$stats_options = get_option( 'stats_options' );
1964	$stats_id = $stats_options['blog_id'] ?? null;
1965
1966	/* This action is documented in src/class-package-version-tracker.php */
1967	$package_versions = apply_filters( 'jetpack_package_versions', array() );
1968
1969	$active_plugins_using_connection = Plugin_Storage::get_all();
1970
1971	/**
1972	* Filters the request body for additional property addition.
1973	*
1974	* @since 1.7.0
1975	* @since-jetpack 7.7.0
1976	*
1977	* @param array $post_data request data.
1978	* @param Array $token_data token data.
1979	*/
1980	$body = apply_filters(
1981	'jetpack_register_request_body',
1982	array_merge(
1983	array(
1984	'siteurl' => Urls::site_url(),
1985	'home' => Urls::home_url(),
1986	'gmt_offset' => $gmt_offset,
1987	'timezone_string' => (string) get_option( 'timezone_string' ),
1988	'site_name' => (string) get_option( 'blogname' ),
1989	'secret_1' => $secrets['secret_1'],
1990	'secret_2' => $secrets['secret_2'],
1991	'site_lang' => get_locale(),
1992	'timeout' => $timeout,
1993	'stats_id' => $stats_id,
1994	'state' => get_current_user_id(),
1995	'site_created' => $this->get_assumed_site_creation_date(),
1996	'jetpack_version' => Constants::get_constant( 'JETPACK__VERSION' ),
1997	'ABSPATH' => Constants::get_constant( 'ABSPATH' ),
1998	'current_user_email' => wp_get_current_user()->user_email,
1999	'connect_plugin' => $this->get_plugin() ? $this->get_plugin()->get_slug() : null,
2000	'package_versions' => $package_versions,
2001	'active_connected_plugins' => $active_plugins_using_connection,
2002	),
2003	self::$extra_register_params
2004	)
2005	);
2006
2007	$args = array(
2008	'method' => 'POST',
2009	'body' => $body,
2010	'headers' => array(
2011	'Accept' => 'application/json',
2012	),
2013	'timeout' => $timeout,
2014	);
2015
2016	$args['body'] = static::apply_activation_source_to_args( $args['body'] );
2017
2018	// TODO: fix URLs for bad hosts.
2019	$response = Client::_wp_remote_request(
2020	$this->api_url( $api_endpoint ),
2021	$args,
2022	true
2023	);
2024
2025	// Make sure the response is valid and does not contain any Jetpack errors.
2026	$registration_details = $this->validate_remote_register_response( $response );
2027
2028	if ( is_wp_error( $registration_details ) ) {
2029	return $registration_details;
2030	} elseif ( ! $registration_details ) {
2031	return new \WP_Error(
2032	'unknown_error',
2033	'Unknown error registering your Jetpack site.',
2034	wp_remote_retrieve_response_code( $response )
2035	);
2036	}
2037
2038	if ( empty( $registration_details->jetpack_secret ) \|\| ! is_string( $registration_details->jetpack_secret ) ) {
2039	return new \WP_Error(
2040	'jetpack_secret',
2041	'Unable to validate registration of your Jetpack site.',
2042	wp_remote_retrieve_response_code( $response )
2043	);
2044	}
2045
2046	if ( isset( $registration_details->jetpack_public ) ) {
2047	$jetpack_public = (int) $registration_details->jetpack_public;
2048	} else {
2049	$jetpack_public = false;
2050	}
2051
2052	Jetpack_Options::update_options(
2053	array(
2054	'id' => (int) $registration_details->jetpack_id,
2055	'public' => $jetpack_public,
2056	)
2057	);
2058
2059	update_option( Package_Version_Tracker::PACKAGE_VERSION_OPTION, $package_versions );
2060
2061	$this->get_tokens()->update_blog_token( (string) $registration_details->jetpack_secret );
2062
2063	if ( ! Jetpack_Options::get_option( 'id' ) \|\| ! $this->get_tokens()->get_access_token() ) {
2064	return new WP_Error(
2065	'connection_data_save_failed',
2066	'Failed to save connection data in the database'
2067	);
2068	}
2069
2070	$alternate_authorization_url = $registration_details->alternate_authorization_url ?? '';
2071
2072	add_filter(
2073	'jetpack_register_site_rest_response',
2074	function ( $response ) use ( $alternate_authorization_url ) {
2075	$response['alternateAuthorizeUrl'] = $alternate_authorization_url;
2076	return $response;
2077	}
2078	);
2079
2080	/**
2081	* Fires when a site is registered on WordPress.com.
2082	*
2083	* @since 1.7.0
2084	* @since-jetpack 3.7.0
2085	*
2086	* @param int $json->jetpack_id Jetpack Blog ID.
2087	* @param string $json->jetpack_secret Jetpack Blog Token.
2088	* @param int\|bool $jetpack_public Is the site public.
2089	*/
2090	do_action(
2091	'jetpack_site_registered',
2092	$registration_details->jetpack_id,
2093	$registration_details->jetpack_secret,
2094	$jetpack_public
2095	);
2096
2097	if ( isset( $registration_details->token ) ) {
2098	/**
2099	* Fires when a user token is sent along with the registration data.
2100	*
2101	* @since 1.7.0
2102	* @since-jetpack 7.6.0
2103	*
2104	* @param object $token the administrator token for the newly registered site.
2105	*/
2106	do_action( 'jetpack_site_registered_user_token', $registration_details->token );
2107	}
2108
2109	return true;
2110	}
2111
2112	/**
2113	* Attempts Jetpack registration.
2114	*
2115	* @param bool $tos_agree Whether the user agreed to TOS.
2116	*
2117	* @return bool\|WP_Error
2118	*/
2119	public function try_registration( $tos_agree = true ) {
2120	if ( $tos_agree ) {
2121	$terms_of_service = new Terms_Of_Service();
2122	$terms_of_service->agree();
2123	}
2124
2125	/**
2126	* Action fired when the user attempts the registration.
2127	*
2128	* @since 1.26.0
2129	*/
2130	$pre_register = apply_filters( 'jetpack_pre_register', null );
2131
2132	if ( is_wp_error( $pre_register ) ) {
2133	return $pre_register;
2134	}
2135
2136	$tracking_data = array();
2137
2138	if ( null !== $this->get_plugin() ) {
2139	$tracking_data['plugin_slug'] = $this->get_plugin()->get_slug();
2140	}
2141
2142	$tracking = new Tracking();
2143	$tracking->record_user_event( 'jpc_register_begin', $tracking_data );
2144
2145	add_filter( 'jetpack_register_request_body', array( Utils::class, 'filter_register_request_body' ) );
2146
2147	$result = $this->register();
2148
2149	remove_filter( 'jetpack_register_request_body', array( Utils::class, 'filter_register_request_body' ) );
2150
2151	// If there was an error with registration and the site was not registered, record this so we can show a message.
2152	if ( ! $result \|\| is_wp_error( $result ) ) {
2153	return $result;
2154	}
2155
2156	return true;
2157	}
2158
2159	/**
2160	* Adds a parameter to the register request body
2161	*
2162	* @since 1.26.0
2163	*
2164	* @param string $name The name of the parameter to be added.
2165	* @param string $value The value of the parameter to be added.
2166	*
2167	* @throws \InvalidArgumentException If supplied arguments are not strings.
2168	* @return void
2169	*/
2170	public function add_register_request_param( $name, $value ) {
2171	if ( ! is_string( $name ) \|\| ! is_string( $value ) ) {
2172	throw new \InvalidArgumentException( 'name and value must be strings' );
2173	}
2174	self::$extra_register_params[ $name ] = $value;
2175	}
2176
2177	/**
2178	* Takes the response from the Jetpack register new site endpoint and
2179	* verifies it worked properly.
2180	*
2181	* @since 1.7.0
2182	* @since-jetpack 2.6.0
2183	*
2184	* @param mixed $response the response object, or the error object.
2185	* @return string\|WP_Error A JSON object on success or WP_Error on failures
2186	**/
2187	protected function validate_remote_register_response( $response ) {
2188	if ( is_wp_error( $response ) ) {
2189	return new \WP_Error(
2190	'register_http_request_failed',
2191	$response->get_error_message()
2192	);
2193	}
2194
2195	$code = wp_remote_retrieve_response_code( $response );
2196	$entity = wp_remote_retrieve_body( $response );
2197
2198	if ( $entity ) {
2199	$registration_response = json_decode( $entity );
2200	} else {
2201	$registration_response = false;
2202	}
2203
2204	$code_type = (int) ( $code / 100 );
2205	if ( 5 === $code_type ) {
2206	return new \WP_Error( 'wpcom_5??', $code );
2207	} elseif ( 408 === $code ) {
2208	return new \WP_Error( 'wpcom_408', $code );
2209	} elseif ( ! empty( $registration_response->error ) ) {
2210	if (
2211	'xml_rpc-32700' === $registration_response->error
2212	&& ! function_exists( 'xml_parser_create' )
2213	) {
2214	$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' );
2215	} else {
2216	$error_description = isset( $registration_response->error_description )
2217	? (string) $registration_response->error_description
2218	: '';
2219	}
2220
2221	return new \WP_Error(
2222	(string) $registration_response->error,
2223	$error_description,
2224	$code
2225	);
2226	} elseif ( 200 !== $code ) {
2227	return new \WP_Error( 'wpcom_bad_response', $code );
2228	}
2229
2230	// Jetpack ID error block.
2231	if ( empty( $registration_response->jetpack_id ) ) {
2232	return new \WP_Error(
2233	'jetpack_id',
2234	/* translators: %s is an error message string */
2235	sprintf( __( 'Error Details: Jetpack ID is empty. Do not publicly post this error message! %s', 'jetpack-connection' ), $entity ),
2236	$entity
2237	);
2238	} elseif ( ! is_scalar( $registration_response->jetpack_id ) ) {
2239	return new \WP_Error(
2240	'jetpack_id',
2241	/* translators: %s is an error message string */
2242	sprintf( __( 'Error Details: Jetpack ID is not a scalar. Do not publicly post this error message! %s', 'jetpack-connection' ), $entity ),
2243	$entity
2244	);
2245	} elseif ( preg_match( '/[^0-9]/', $registration_response->jetpack_id ) ) {
2246	return new \WP_Error(
2247	'jetpack_id',
2248	/* translators: %s is an error message string */
2249	sprintf( __( 'Error Details: Jetpack ID begins with a numeral. Do not publicly post this error message! %s', 'jetpack-connection' ), $entity ),
2250	$entity
2251	);
2252	}
2253
2254	return $registration_response;
2255	}
2256
2257	/**
2258	* Adds a used nonce to a list of known nonces.
2259	*
2260	* @param int $timestamp the current request timestamp.
2261	* @param string $nonce the nonce value.
2262	* @return bool whether the nonce is unique or not.
2263	*
2264	* @deprecated since 1.24.0
2265	* @see Nonce_Handler::add()
2266	*/
2267	public function add_nonce( $timestamp, $nonce ) {
2268	_deprecated_function( __METHOD__, '1.24.0', 'Automattic\\Jetpack\\Connection\\Nonce_Handler::add' );
2269	return ( new Nonce_Handler() )->add( $timestamp, $nonce );
2270	}
2271
2272	/**
2273	* Cleans nonces that were saved when calling ::add_nonce.
2274	*
2275	* @todo Properly prepare the query before executing it.
2276	*
2277	* @param bool $all whether to clean even non-expired nonces.
2278	*
2279	* @deprecated since 1.24.0
2280	* @see Nonce_Handler::clean_all()
2281	*/
2282	public function clean_nonces( $all = false ) {
2283	_deprecated_function( __METHOD__, '1.24.0', 'Automattic\\Jetpack\\Connection\\Nonce_Handler::clean_all' );
2284	( new Nonce_Handler() )->clean_all( $all ? PHP_INT_MAX : ( time() - Nonce_Handler::LIFETIME ) );
2285	}
2286
2287	/**
2288	* Sets the Connection custom capabilities.
2289	*
2290	* @param string[] $caps Array of the user's capabilities.
2291	* @param string $cap Capability name.
2292	* @param int $user_id The user ID.
2293	* @param array $args Adds the context to the cap. Typically the object ID.
2294	*/
2295	public function jetpack_connection_custom_caps( $caps, $cap, $user_id, $args ) { // phpcs:ignore VariableAnalysis.CodeAnalysis.VariableAnalysis.UnusedVariable
2296	switch ( $cap ) {
2297	case 'jetpack_connect':
2298	case 'jetpack_reconnect':
2299	$is_offline_mode = ( new Status() )->is_offline_mode();
2300	if ( $is_offline_mode ) {
2301	$caps = array( 'do_not_allow' );
2302	break;
2303	}
2304	// Pass through. If it's not offline mode, these should match disconnect.
2305	// Let users disconnect if it's offline mode, just in case things glitch.
2306	case 'jetpack_disconnect':
2307	/**
2308	* Filters the jetpack_disconnect capability.
2309	*
2310	* @since 1.14.2
2311	*
2312	* @param array An array containing the capability name.
2313	*/
2314	$caps = apply_filters( 'jetpack_disconnect_cap', array( 'manage_options' ) );
2315	break;
2316	case 'jetpack_connect_user':
2317	$is_offline_mode = ( new Status() )->is_offline_mode();
2318	if ( $is_offline_mode ) {
2319	$caps = array( 'do_not_allow' );
2320	break;
2321	}
2322	// With site connections in mind, non-admin users can connect their account only if a connection owner exists.
2323	$caps = $this->has_connected_owner() ? array( 'read' ) : array( 'manage_options' );
2324	break;
2325	case 'jetpack_unlink_user':
2326	$is_offline_mode = ( new Status() )->is_offline_mode();
2327	if ( $is_offline_mode ) {
2328	$caps = array( 'do_not_allow' );
2329	break;
2330	}
2331
2332	// Non-admins can always disconnect
2333	$caps = array( 'read' );
2334	break;
2335	}
2336	return $caps;
2337	}
2338
2339	/**
2340	* Builds the timeout limit for queries talking with the wpcom servers.
2341	*
2342	* Based on local php max_execution_time in php.ini
2343	*
2344	* @since 1.7.0
2345	* @since-jetpack 5.4.0
2346	* @return int
2347	**/
2348	public function get_max_execution_time() {
2349	$timeout = (int) ini_get( 'max_execution_time' );
2350
2351	// Ensure exec time set in php.ini.
2352	if ( ! $timeout ) {
2353	$timeout = 30;
2354	}
2355	return $timeout;
2356	}
2357
2358	/**
2359	* Sets a minimum request timeout, and returns the current timeout
2360	*
2361	* @since 1.7.0
2362	* @since-jetpack 5.4.0
2363	* @param int $min_timeout the minimum timeout value.
2364	**/
2365	public function set_min_time_limit( $min_timeout ) {
2366	$timeout = $this->get_max_execution_time();
2367	if ( $timeout < $min_timeout ) {
2368	$timeout = $min_timeout;
2369	set_time_limit( $timeout );
2370	}
2371	return $timeout;
2372	}
2373
2374	/**
2375	* Get our assumed site creation date.
2376	* Calculated based on the earlier date of either:
2377	* - Earliest admin user registration date.
2378	* - Earliest date of post of any post type.
2379	*
2380	* @since 1.7.0
2381	* @since-jetpack 7.2.0
2382	*
2383	* @return string Assumed site creation date and time.
2384	*/
2385	public function get_assumed_site_creation_date() {
2386	$cached_date = get_transient( 'jetpack_assumed_site_creation_date' );
2387	if ( ! empty( $cached_date ) ) {
2388	return $cached_date;
2389	}
2390
2391	/**
2392	* We don't use the 'ID' field, but need it to overcome a WP caching bug: https://core.trac.wordpress.org/ticket/62003
2393	*
2394	* @todo Remote the 'ID' field from users fetching when the issue is fixed and Jetpack-supported WP versions move beyond it.
2395	*/
2396	$earliest_registered_users = get_users(
2397	array(
2398	'role' => 'administrator',
2399	'orderby' => 'user_registered',
2400	'order' => 'ASC',
2401	'fields' => array( 'ID', 'user_registered' ),
2402	'number' => 1,
2403	)
2404	);
2405	$earliest_registration_date = $earliest_registered_users[0]->user_registered;
2406
2407	$earliest_posts = get_posts(
2408	array(
2409	'posts_per_page' => 1,
2410	'post_type' => 'any',
2411	'post_status' => 'any',
2412	'orderby' => 'date',
2413	'order' => 'ASC',
2414	)
2415	);
2416
2417	// If there are no posts at all, we'll count only on user registration date.
2418	if ( $earliest_posts ) {
2419	$earliest_post_date = $earliest_posts[0]->post_date;
2420	} else {
2421	$earliest_post_date = PHP_INT_MAX;
2422	}
2423
2424	$assumed_date = min( $earliest_registration_date, $earliest_post_date );
2425	set_transient( 'jetpack_assumed_site_creation_date', $assumed_date );
2426
2427	return $assumed_date;
2428	}
2429
2430	/**
2431	* Adds the activation source string as a parameter to passed arguments.
2432	*
2433	* @todo Refactor to use rawurlencode() instead of urlencode().
2434	*
2435	* @param array $args arguments that need to have the source added.
2436	* @return array $amended arguments.
2437	*/
2438	public static function apply_activation_source_to_args( $args ) {
2439	$activation_source = get_option( 'jetpack_activation_source' );
2440
2441	if ( ! empty( $activation_source[0] ) ) {
2442	// phpcs:ignore WordPress.PHP.DiscouragedPHPFunctions.urlencode_urlencode
2443	$args['_as'] = urlencode( $activation_source[0] );
2444	}
2445
2446	if ( ! empty( $activation_source[1] ) ) {
2447	// phpcs:ignore WordPress.PHP.DiscouragedPHPFunctions.urlencode_urlencode
2448	$args['_ak'] = urlencode( $activation_source[1] );
2449	}
2450
2451	return $args;
2452	}
2453
2454	/**
2455	* Generates two secret tokens and the end of life timestamp for them.
2456	*
2457	* @param string $action The action name.
2458	* @param int\|bool $user_id The user identifier.
2459	* @param int $exp Expiration time in seconds.
2460	*/
2461	public function generate_secrets( $action, $user_id = false, $exp = 600 ) {
2462	return ( new Secrets() )->generate( $action, $user_id, $exp );
2463	}
2464
2465	/**
2466	* Returns two secret tokens and the end of life timestamp for them.
2467	*
2468	* @deprecated 1.24.0 Use Automattic\Jetpack\Connection\Secrets->get() instead.
2469	*
2470	* @param string $action The action name.
2471	* @param int $user_id The user identifier.
2472	* @return string\|array an array of secrets or an error string.
2473	*/
2474	public function get_secrets( $action, $user_id ) {
2475	_deprecated_function( __METHOD__, '1.24.0', 'Automattic\\Jetpack\\Connection\\Secrets->get' );
2476	return ( new Secrets() )->get( $action, $user_id );
2477	}
2478
2479	/**
2480	* Deletes secret tokens in case they, for example, have expired.
2481	*
2482	* @deprecated 1.24.0 Use Automattic\Jetpack\Connection\Secrets->delete() instead.
2483	*
2484	* @param string $action The action name.
2485	* @param int $user_id The user identifier.
2486	*/
2487	public function delete_secrets( $action, $user_id ) {
2488	_deprecated_function( __METHOD__, '1.24.0', 'Automattic\\Jetpack\\Connection\\Secrets->delete' );
2489	( new Secrets() )->delete( $action, $user_id );
2490	}
2491
2492	/**
2493	* Deletes all connection tokens and transients from the local Jetpack site.
2494	* If the plugin object has been provided in the constructor, the function first checks
2495	* whether it's the only active connection.
2496	* If there are any other connections, the function will do nothing and return `false`
2497	* (unless `$ignore_connected_plugins` is set to `true`).
2498	*
2499	* @param bool $ignore_connected_plugins Delete the tokens even if there are other connected plugins.
2500	*
2501	* @return bool True if disconnected successfully, false otherwise.
2502	*/
2503	public function delete_all_connection_tokens( $ignore_connected_plugins = false ) {
2504	// refuse to delete if we're not the last Jetpack plugin installed.
2505	if ( ! $ignore_connected_plugins && null !== $this->plugin && ! $this->plugin->is_only() ) {
2506	return false;
2507	}
2508
2509	/**
2510	* Fires upon the disconnect attempt.
2511	* Return `false` to prevent the disconnect.
2512	*
2513	* @since 1.14.2
2514	*/
2515	if ( ! apply_filters( 'jetpack_connection_delete_all_tokens', true ) ) {
2516	return false;
2517	}
2518
2519	// The protected owner anchor is a local cache of a record WordPress.com owns. Dropping it
2520	// here keeps a disconnected site from carrying a lock that names a user who no longer holds
2521	// a token; the anchor is re-established from WordPress.com when the owner reconnects.
2522	\Jetpack_Options::delete_option(
2523	array(
2524	'master_user',
2525	'protected_owner',
2526	'time_diff',
2527	'fallback_no_verify_ssl_certs',
2528	)
2529	);
2530
2531	// Clear the memoized connection owner ID since it changed
2532	self::$connection_owner_id = null;
2533
2534	( new Secrets() )->delete_all();
2535	$this->get_tokens()->delete_all();
2536
2537	// Delete cached connected user data.
2538	$transient_key = 'jetpack_connected_user_data_' . get_current_user_id();
2539	delete_transient( $transient_key );
2540
2541	// Delete the cached site record, which a later connection must not serve.
2542	self::delete_cached_site_data();
2543
2544	// Delete all XML-RPC errors.
2545	Error_Handler::get_instance()->delete_all_errors();
2546
2547	return true;
2548	}
2549
2550	/**
2551	* Tells WordPress.com to disconnect the site and clear all tokens from cached site.
2552	* If the plugin object has been provided in the constructor, the function first check
2553	* whether it's the only active connection.
2554	* If there are any other connections, the function will do nothing and return `false`
2555	* (unless `$ignore_connected_plugins` is set to `true`).
2556	*
2557	* @param bool $ignore_connected_plugins Delete the tokens even if there are other connected plugins.
2558	*
2559	* @return bool True if disconnected successfully, false otherwise.
2560	*/
2561	public function disconnect_site_wpcom( $ignore_connected_plugins = false ) {
2562	if ( ! $ignore_connected_plugins && null !== $this->plugin && ! $this->plugin->is_only() ) {
2563	return false;
2564	}
2565
2566	if ( ( new Status() )->is_offline_mode() && ! apply_filters( 'jetpack_connection_disconnect_site_wpcom_offline_mode', false ) ) {
2567	// Prevent potential disconnect of the live site by removing WPCOM tokens.
2568	return false;
2569	}
2570
2571	/**
2572	* Fires upon the disconnect attempt.
2573	* Return `false` to prevent the disconnect.
2574	*
2575	* @since 1.14.2
2576	*/
2577	if ( ! apply_filters( 'jetpack_connection_disconnect_site_wpcom', true, $this ) ) {
2578	return false;
2579	}
2580
2581	$xml = new Jetpack_IXR_Client();
2582	$xml->query( 'jetpack.deregister', get_current_user_id() );
2583
2584	return true;
2585	}
2586
2587	/**
2588	* Disconnect the plugin and remove the tokens.
2589	* This function will automatically perform "soft" or "hard" disconnect depending on whether other plugins are using the connection.
2590	* This is a proxy method to simplify the Connection package API.
2591	*
2592	* @see Manager::disconnect_site()
2593	*
2594	* @param boolean $disconnect_wpcom Should disconnect_site_wpcom be called.
2595	* @param bool $ignore_connected_plugins Delete the tokens even if there are other connected plugins.
2596	* @return bool
2597	*/
2598	public function remove_connection( $disconnect_wpcom = true, $ignore_connected_plugins = false ) {
2599
2600	$this->disconnect_site( $disconnect_wpcom, $ignore_connected_plugins );
2601
2602	return true;
2603	}
2604
2605	/**
2606	* Completely clearing up the connection, and initiating reconnect.
2607	*
2608	* @return true\|WP_Error True if reconnected successfully, a `WP_Error` object otherwise.
2609	*/
2610	public function reconnect() {
2611	( new Tracking() )->record_user_event( 'restore_connection_reconnect' );
2612
2613	$this->disconnect_site_wpcom( true );
2614
2615	return $this->register();
2616	}
2617
2618	/**
2619	* Validate the tokens, and refresh the invalid ones.
2620	*
2621	* @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.
2622	*/
2623	public function restore() {
2624	// If this is a site connection we need to trigger a full reconnection as our only secure means of
2625	// communication with WPCOM, aka the blog token, is compromised.
2626	if ( $this->is_site_connection() ) {
2627	return $this->reconnect();
2628	}
2629
2630	$validate_tokens_response = $this->get_tokens()->validate();
2631
2632	// If token validation failed, trigger a full reconnection.
2633	if ( is_array( $validate_tokens_response ) &&
2634	isset( $validate_tokens_response['blog_token']['is_healthy'] ) &&
2635	isset( $validate_tokens_response['user_token']['is_healthy'] ) ) {
2636	$blog_token_healthy = $validate_tokens_response['blog_token']['is_healthy'];
2637	$user_token_healthy = $validate_tokens_response['user_token']['is_healthy'];
2638	} else {
2639	$blog_token_healthy = false;
2640	$user_token_healthy = false;
2641	}
2642
2643	// Tokens are both valid, or both invalid. We can't fix the problem we don't see, so the full reconnection is needed.
2644	if ( $blog_token_healthy === $user_token_healthy ) {
2645	$result = $this->reconnect();
2646	return ( true === $result ) ? 'authorize' : $result;
2647	}
2648
2649	if ( ! $blog_token_healthy ) {
2650	return $this->refresh_blog_token();
2651	}
2652
2653	if ( ! $user_token_healthy ) {
2654	return ( true === $this->refresh_user_token() ) ? 'authorize' : false;
2655	}
2656
2657	return false;
2658	}
2659
2660	/**
2661	* Responds to a WordPress.com call to register the current site.
2662	* Should be changed to protected.
2663	*
2664	* @param array $registration_data Array of [ secret_1, user_id ].
2665	*/
2666	public function handle_registration( array $registration_data ) {
2667	list( $registration_secret_1, $registration_user_id ) = $registration_data;
2668	if ( empty( $registration_user_id ) ) {
2669	return new \WP_Error( 'registration_state_invalid', __( 'Invalid Registration State', 'jetpack-connection' ), 400 );
2670	}
2671
2672	return ( new Secrets() )->verify( 'register', $registration_secret_1, (int) $registration_user_id );
2673	}
2674
2675	/**
2676	* Perform the API request to validate the blog and user tokens.
2677	*
2678	* @deprecated 1.24.0 Use Automattic\Jetpack\Connection\Tokens->validate_tokens() instead.
2679	*
2680	* @param int\|null $user_id ID of the user we need to validate token for. Current user's ID by default.
2681	*
2682	* @return array\|false\|WP_Error The API response: `array( 'blog_token_is_healthy' => true\|false, 'user_token_is_healthy' => true\|false )`.
2683	*/
2684	public function validate_tokens( $user_id = null ) {
2685	_deprecated_function( __METHOD__, '1.24.0', 'Automattic\\Jetpack\\Connection\\Tokens->validate' );
2686	return $this->get_tokens()->validate( $user_id );
2687	}
2688
2689	/**
2690	* Verify a Previously Generated Secret.
2691	*
2692	* @deprecated 1.24.0 Use Automattic\Jetpack\Connection\Secrets->verify() instead.
2693	*
2694	* @param string $action The type of secret to verify.
2695	* @param string $secret_1 The secret string to compare to what is stored.
2696	* @param int $user_id The user ID of the owner of the secret.
2697	* @return \WP_Error\|string WP_Error on failure, secret_2 on success.
2698	*/
2699	public function verify_secrets( $action, $secret_1, $user_id ) {
2700	_deprecated_function( __METHOD__, '1.24.0', 'Automattic\\Jetpack\\Connection\\Secrets->verify' );
2701	return ( new Secrets() )->verify( $action, $secret_1, $user_id );
2702	}
2703
2704	/**
2705	* Responds to a WordPress.com call to authorize the current user.
2706	* Should be changed to protected.
2707	*/
2708	public function handle_authorization() {
2709	}
2710
2711	/**
2712	* Obtains the auth token.
2713	*
2714	* @param array $data The request data.
2715	* @return object\|\WP_Error Returns the auth token on success.
2716	* Returns a \WP_Error on failure.
2717	*/
2718	public function get_token( $data ) {
2719	return $this->get_tokens()->get( $data, $this->api_url( 'token' ) );
2720	}
2721
2722	/**
2723	* Builds a URL to the Jetpack connection auth page.
2724	*
2725	* @since 2.7.6 Added optional $from and $raw parameters.
2726	*
2727	* @param WP_User\|null $user (optional) defaults to the current logged in user.
2728	* @param string\|null $redirect (optional) a redirect URL to use instead of the default.
2729	* @param bool\|string $from If not false, adds 'from=$from' param to the connect URL.
2730	* @param bool $raw If true, URL will not be escaped.
2731	*
2732	* @return string Connect URL.
2733	*/
2734	public function get_authorization_url( $user = null, $redirect = null, $from = false, $raw = false ) {
2735	if ( empty( $user ) ) {
2736	$user = wp_get_current_user();
2737	}
2738
2739	$roles = new Roles();
2740	$role = $roles->translate_user_to_role( $user );
2741	$signed_role = $this->get_tokens()->sign_role( $role );
2742
2743	/**
2744	* Filter the URL of the first time the user gets redirected back to your site for connection
2745	* data processing.
2746	*
2747	* @since 1.7.0
2748	* @since-jetpack 8.0.0
2749	*
2750	* @param string $redirect_url Defaults to the site admin URL.
2751	*/
2752	$processing_url = apply_filters( 'jetpack_connect_processing_url', admin_url( 'admin.php' ) );
2753
2754	/**
2755	* Filter the URL to redirect the user back to when the authorization process
2756	* is complete.
2757	*
2758	* @since 1.7.0
2759	* @since-jetpack 8.0.0
2760	*
2761	* @param string $redirect_url Defaults to the site URL.
2762	*/
2763	$redirect = apply_filters( 'jetpack_connect_redirect_url', $redirect );
2764
2765	$secrets = ( new Secrets() )->generate( 'authorize', $user->ID, 2 * HOUR_IN_SECONDS );
2766
2767	/**
2768	* Filter the type of authorization.
2769	* 'calypso' completes authorization on wordpress.com/jetpack/connect
2770	* while 'jetpack' ( or any other value ) completes the authorization at jetpack.wordpress.com.
2771	*
2772	* @since 1.7.0
2773	* @since-jetpack 4.3.3
2774	*
2775	* @param string $auth_type Defaults to 'calypso', can also be 'jetpack'.
2776	*/
2777	$auth_type = apply_filters( 'jetpack_auth_type', 'calypso' );
2778
2779	$body_args = array(
2780	'response_type' => 'code',
2781	'client_id' => \Jetpack_Options::get_option( 'id' ),
2782	'redirect_uri' => add_query_arg(
2783	array(
2784	'handler' => 'jetpack-connection-webhooks',
2785	'action' => 'authorize',
2786	'_wpnonce' => wp_create_nonce( "jetpack-authorize_{$role}_{$redirect}" ),
2787	'redirect' => $redirect ? rawurlencode( $redirect ) : false,
2788	),
2789	esc_url( $processing_url )
2790	),
2791	'state' => $user->ID,
2792	'scope' => $signed_role,
2793	'user_email' => $user->user_email,
2794	'user_login' => $user->user_login,
2795	'is_active' => $this->has_connected_owner(), // TODO Deprecate this.
2796	'jp_version' => (string) Constants::get_constant( 'JETPACK__VERSION' ),
2797	'auth_type' => $auth_type,
2798	'secret' => $secrets['secret_1'],
2799	'blogname' => get_option( 'blogname' ),
2800	'site_url' => Urls::site_url(),
2801	'home_url' => Urls::home_url(),
2802	'site_icon' => get_site_icon_url(),
2803	'site_lang' => get_locale(),
2804	'site_created' => $this->get_assumed_site_creation_date(),
2805	'allow_site_connection' => ! $this->has_connected_owner(),
2806	'calypso_env' => ( new Host() )->get_calypso_env(),
2807	'source' => ( new Host() )->get_source_query(),
2808	);
2809
2810	// Include the slugs of every plugin currently using the Jetpack connection so wpcom
2811	// knows which integrations the site is authorizing on behalf of. `Plugin_Storage::get_all()`
2812	// returns a `WP_Error` when called before `plugins_loaded`; in that case we silently skip.
2813	$active_plugins = Plugin_Storage::get_all();
2814	if ( is_array( $active_plugins ) && ! empty( $active_plugins ) ) {
2815	$body_args['plugins'] = implode( ',', array_keys( $active_plugins ) );
2816	}
2817
2818	// Signal to Calypso that the site already has a connection owner so the
2819	// authorize page can show secondary-connection content where appropriate.
2820	if ( $this->has_connected_owner() ) {
2821	$body_args['has_connected_owner'] = true;
2822	}
2823
2824	/**
2825	* Filters the user connection request data for additional property addition.
2826	*
2827	* @since 1.7.0
2828	* @since-jetpack 8.0.0
2829	*
2830	* @param array $request_data request data.
2831	*/
2832	$body = apply_filters( 'jetpack_connect_request_body', $body_args );
2833
2834	$body = static::apply_activation_source_to_args( urlencode_deep( $body ) );
2835
2836	$api_url = $this->api_url( 'authorize' );
2837
2838	$url = add_query_arg( $body, $api_url );
2839
2840	if ( is_network_admin() ) {
2841	$url = add_query_arg( 'is_multisite', network_admin_url( 'admin.php?page=jetpack-settings' ), $url );
2842	}
2843
2844	if ( $from ) {
2845	$url = add_query_arg( 'from', $from, $url );
2846	}
2847
2848	if ( $raw ) {
2849	$url = esc_url_raw( $url );
2850	}
2851
2852	/**
2853	* Filter the URL used when connecting a user to a WordPress.com account.
2854	*
2855	* @since 2.0.0
2856	* @since 2.7.6 Added $raw parameter.
2857	*
2858	* @param string $url Connection URL.
2859	* @param bool $raw If true, URL will not be escaped.
2860	*/
2861	return apply_filters( 'jetpack_build_authorize_url', $url, $raw );
2862	}
2863
2864	/**
2865	* Authorizes the user by obtaining and storing the user token.
2866	*
2867	* @param array $data The request data.
2868	* @return string\|\WP_Error Returns a string on success.
2869	* Returns a \WP_Error on failure.
2870	*/
2871	public function authorize( $data = array() ) {
2872	/**
2873	* Action fired when user authorization starts.
2874	*
2875	* @since 1.7.0
2876	* @since-jetpack 8.0.0
2877	*/
2878	do_action( 'jetpack_authorize_starting' );
2879
2880	$roles = new Roles();
2881	$role = $roles->translate_current_user_to_role();
2882
2883	if ( ! $role ) {
2884	return new \WP_Error( 'no_role', 'Invalid request.', 400 );
2885	}
2886
2887	$cap = $roles->translate_role_to_cap( $role );
2888	if ( ! $cap ) {
2889	return new \WP_Error( 'no_cap', 'Invalid request.', 400 );
2890	}
2891
2892	if ( ! empty( $data['error'] ) ) {
2893	return new \WP_Error( $data['error'], 'Error included in the request.', 400 );
2894	}
2895
2896	if ( ! isset( $data['state'] ) ) {
2897	return new \WP_Error( 'no_state', 'Request must include state.', 400 );
2898	}
2899
2900	if ( ! ctype_digit( $data['state'] ) ) {
2901	return new \WP_Error( $data['error'], 'State must be an integer.', 400 );
2902	}
2903
2904	$current_user_id = get_current_user_id();
2905	if ( $current_user_id !== (int) $data['state'] ) {
2906	return new \WP_Error( 'wrong_state', 'State does not match current user.', 400 );
2907	}
2908
2909	if ( empty( $data['code'] ) ) {
2910	return new \WP_Error( 'no_code', 'Request must include an authorization code.', 400 );
2911	}
2912
2913	$token = $this->get_tokens()->get( $data, $this->api_url( 'token' ) );
2914
2915	if ( is_wp_error( $token ) ) {
2916	$code = $token->get_error_code();
2917	if ( empty( $code ) ) {
2918	$code = 'invalid_token';
2919	}
2920	return new \WP_Error( $code, $token->get_error_message(), 400 );
2921	}
2922
2923	if ( ! $token ) {
2924	return new \WP_Error( 'no_token', 'Error generating token.', 400 );
2925	}
2926
2927	$is_connection_owner = ! $this->has_connected_owner();
2928
2929	$this->get_tokens()->update_user_token( $current_user_id, sprintf( '%s.%d', $token, $current_user_id ), $is_connection_owner );
2930
2931	// Delete cached connected user data, so a cached failure from the
2932	// previous (broken) token doesn't linger after reconnecting.
2933	delete_transient( "jetpack_connected_user_data_$current_user_id" );
2934
2935	/**
2936	* Fires after user has successfully received an auth token.
2937	*
2938	* @since 1.7.0
2939	* @since-jetpack 3.9.0
2940	*/
2941	do_action( 'jetpack_user_authorized' );
2942
2943	if ( ! $is_connection_owner ) {
2944	/**
2945	* Action fired when a secondary user has been authorized.
2946	*
2947	* @since 1.7.0
2948	* @since-jetpack 8.0.0
2949	*/
2950	do_action( 'jetpack_authorize_ending_linked' );
2951	return 'linked';
2952	}
2953
2954	/**
2955	* Action fired when the master user has been authorized.
2956	*
2957	* @since 1.7.0
2958	* @since-jetpack 8.0.0
2959	*
2960	* @param array $data The request data.
2961	*/
2962	do_action( 'jetpack_authorize_ending_authorized', $data );
2963
2964	\Jetpack_Options::delete_raw_option( 'jetpack_last_connect_url_check' );
2965
2966	( new Nonce_Handler() )->reschedule();
2967
2968	return 'authorized';
2969	}
2970
2971	/**
2972	* Disconnects from the Jetpack servers.
2973	* Forgets all connection details and tells the Jetpack servers to do the same.
2974	*
2975	* @param boolean $disconnect_wpcom Should disconnect_site_wpcom be called.
2976	* @param bool $ignore_connected_plugins Delete the tokens even if there are other connected plugins.
2977	*/
2978	public function disconnect_site( $disconnect_wpcom = true, $ignore_connected_plugins = true ) {
2979	if ( ! $ignore_connected_plugins && null !== $this->plugin && ! $this->plugin->is_only() ) {
2980	return false;
2981	}
2982
2983	wp_clear_scheduled_hook( 'jetpack_clean_nonces' );
2984
2985	( new Nonce_Handler() )->clean_all();
2986
2987	Heartbeat::init()->deactivate();
2988
2989	/**
2990	* Fires before a site is disconnected.
2991	*
2992	* @since 1.36.3
2993	*/
2994	do_action( 'jetpack_site_before_disconnected' );
2995
2996	// If the site is in an IDC because sync is not allowed,
2997	// let's make sure to not disconnect the production site.
2998	if ( $disconnect_wpcom ) {
2999	$tracking = new Tracking();
3000	$tracking->record_user_event( 'disconnect_site', array() );
3001
3002	$this->disconnect_site_wpcom( $ignore_connected_plugins );
3003	}
3004
3005	$this->delete_all_connection_tokens( $ignore_connected_plugins );
3006
3007	// Remove tracked package versions, since they depend on the Jetpack Connection.
3008	delete_option( Package_Version_Tracker::PACKAGE_VERSION_OPTION );
3009
3010	$jetpack_unique_connection = \Jetpack_Options::get_option( 'unique_connection' );
3011	if ( $jetpack_unique_connection ) {
3012	// Check then record unique disconnection if site has never been disconnected previously.
3013	if ( - 1 === $jetpack_unique_connection['disconnected'] ) {
3014	$jetpack_unique_connection['disconnected'] = 1;
3015	} else {
3016	if ( 0 === $jetpack_unique_connection['disconnected'] ) {
3017	$a8c_mc_stats_instance = new A8c_Mc_Stats();
3018	$a8c_mc_stats_instance->add( 'connections', 'unique-disconnect' );
3019	$a8c_mc_stats_instance->do_server_side_stats();
3020	}
3021	// increment number of times disconnected.
3022	$jetpack_unique_connection['disconnected'] += 1;
3023	}
3024
3025	\Jetpack_Options::update_option( 'unique_connection', $jetpack_unique_connection );
3026	}
3027
3028	/**
3029	* Fires when a site is disconnected.
3030	*
3031	* @since 1.30.1
3032	*/
3033	do_action( 'jetpack_site_disconnected' );
3034	}
3035
3036	/**
3037	* The Base64 Encoding of the SHA1 Hash of the Input.
3038	*
3039	* @param string $text The string to hash.
3040	* @return string
3041	*/
3042	public function sha1_base64( $text ) {
3043	return base64_encode( sha1( $text, true ) ); // phpcs:ignore WordPress.PHP.DiscouragedPHPFunctions.obfuscation_base64_encode
3044	}
3045
3046	/**
3047	* This function mirrors Jetpack_Data::is_usable_domain() in the WPCOM codebase.
3048	*
3049	* @param string $domain The domain to check.
3050	*
3051	* @return bool\|WP_Error
3052	*/
3053	public function is_usable_domain( $domain ) {
3054
3055	// If it's empty, just fail out.
3056	if ( ! $domain ) {
3057	return new \WP_Error(
3058	'fail_domain_empty',
3059	/* translators: %1$s is a domain name. */
3060	sprintf( __( 'Domain `%1$s` just failed is_usable_domain check as it is empty.', 'jetpack-connection' ), $domain )
3061	);
3062	}
3063
3064	/**
3065	* Skips the usuable domain check when connecting a site.
3066	*
3067	* Allows site administrators with domains that fail gethostname-based checks to pass the request to WP.com
3068	*
3069	* @since 1.7.0
3070	* @since-jetpack 4.1.0
3071	*
3072	* @param bool If the check should be skipped. Default false.
3073	*/
3074	if ( apply_filters( 'jetpack_skip_usuable_domain_check', false ) ) {
3075	return true;
3076	}
3077
3078	// None of the explicit localhosts.
3079	$forbidden_domains = array(
3080	'wordpress.com',
3081	'localhost',
3082	'localhost.localdomain',
3083	'local.wordpress.test', // VVV pattern.
3084	'local.wordpress-trunk.test', // VVV pattern.
3085	'src.wordpress-develop.test', // VVV pattern.
3086	'build.wordpress-develop.test', // VVV pattern.
3087	);
3088	if ( in_array( $domain, $forbidden_domains, true ) ) {
3089	return new \WP_Error(
3090	'fail_domain_forbidden',
3091	sprintf(
3092	/* translators: %1$s is a domain name. */
3093	__(
3094	'Domain `%1$s` just failed is_usable_domain check as it is in the forbidden array.',
3095	'jetpack-connection'
3096	),
3097	$domain
3098	)
3099	);
3100	}
3101
3102	// No .test or .local domains.
3103	if ( preg_match( '#\.(test\|local)$#i', $domain ) ) {
3104	return new \WP_Error(
3105	'fail_domain_tld',
3106	sprintf(
3107	/* translators: %1$s is a domain name. */
3108	__(
3109	'Domain `%1$s` just failed is_usable_domain check as it uses an invalid top level domain.',
3110	'jetpack-connection'
3111	),
3112	$domain
3113	)
3114	);
3115	}
3116
3117	// No WPCOM subdomains.
3118	if ( preg_match( '#\.WordPress\.com$#i', $domain ) ) {
3119	return new \WP_Error(
3120	'fail_subdomain_wpcom',
3121	sprintf(
3122	/* translators: %1$s is a domain name. */
3123	__(
3124	'Domain `%1$s` just failed is_usable_domain check as it is a subdomain of WordPress.com.',
3125	'jetpack-connection'
3126	),
3127	$domain
3128	)
3129	);
3130	}
3131
3132	// If PHP was compiled without support for the Filter module (very edge case).
3133	if ( ! function_exists( 'filter_var' ) ) {
3134	// Just pass back true for now, and let wpcom sort it out.
3135	return true;
3136	}
3137
3138	$domain = preg_replace( '#^https?://#', '', untrailingslashit( $domain ) );
3139
3140	if ( filter_var( $domain, FILTER_VALIDATE_IP )
3141	&& ! \Automattic\Jetpack\IP\Utils::ip_is_public( $domain )
3142	) {
3143	return new \WP_Error(
3144	'fail_ip_forbidden',
3145	sprintf(
3146	/* translators: %1$s is a domain name. */
3147	__(
3148	'IP address `%1$s` just failed is_usable_domain check as it is not a public IP address.',
3149	'jetpack-connection'
3150	),
3151	$domain
3152	)
3153	);
3154	}
3155
3156	return true;
3157	}
3158
3159	/**
3160	* Gets the requested token.
3161	*
3162	* @deprecated 1.24.0 Use Automattic\Jetpack\Connection\Tokens->get_access_token() instead.
3163	*
3164	* @param int\|false $user_id false: Return the Blog Token. int: Return that user's User Token.
3165	* @param string\|false $token_key If provided, check that the token matches the provided input.
3166	* @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.
3167	*
3168	* @return object\|false
3169	*
3170	* @see $this->get_tokens()->get_access_token()
3171	*/
3172	public function get_access_token( $user_id = false, $token_key = false, $suppress_errors = true ) {
3173	_deprecated_function( __METHOD__, '1.24.0', 'Automattic\\Jetpack\\Connection\\Tokens->get_access_token' );
3174	return $this->get_tokens()->get_access_token( $user_id, $token_key, $suppress_errors );
3175	}
3176
3177	/**
3178	* In some setups, $HTTP_RAW_POST_DATA can be emptied during some IXR_Server paths
3179	* since it is passed by reference to various methods.
3180	* Capture it here so we can verify the signature later.
3181	*
3182	* @param array $methods an array of available XMLRPC methods.
3183	* @return array the same array, since this method doesn't add or remove anything.
3184	*/
3185	public function xmlrpc_methods( $methods ) {
3186	$this->raw_post_data = $GLOBALS['HTTP_RAW_POST_DATA'] ?? null;
3187	return $methods;
3188	}
3189
3190	/**
3191	* Resets the raw post data parameter for testing purposes.
3192	*/
3193	public function reset_raw_post_data() {
3194	$this->raw_post_data = null;
3195	}
3196
3197	/**
3198	* Registering an additional method.
3199	*
3200	* @param array $methods an array of available XMLRPC methods.
3201	* @return array the amended array in case the method is added.
3202	*/
3203	public function public_xmlrpc_methods( $methods ) {
3204	if ( array_key_exists( 'wp.getOptions', $methods ) ) {
3205	$methods['wp.getOptions'] = array( $this, 'jetpack_get_options' );
3206	}
3207	return $methods;
3208	}
3209
3210	/**
3211	* Handles a getOptions XMLRPC method call.
3212	*
3213	* @param array $args method call arguments.
3214	* @return array\|IXR_Error An amended XMLRPC server options array.
3215	*/
3216	public function jetpack_get_options( $args ) {
3217	global $wp_xmlrpc_server;
3218
3219	$wp_xmlrpc_server->escape( $args );
3220
3221	$username = $args[1];
3222	$password = $args[2];
3223
3224	$user = $wp_xmlrpc_server->login( $username, $password );
3225	if ( ! $user ) {
3226	return $wp_xmlrpc_server->error;
3227	}
3228
3229	$options = array();
3230	$user_data = $this->get_connected_user_data();
3231	if ( is_array( $user_data ) ) {
3232	$options['jetpack_user_id'] = array(
3233	'desc' => __( 'The WP.com user ID of the connected user', 'jetpack-connection' ),
3234	'readonly' => true,
3235	'value' => $user_data['ID'],
3236	);
3237	$options['jetpack_user_login'] = array(
3238	'desc' => __( 'The WP.com username of the connected user', 'jetpack-connection' ),
3239	'readonly' => true,
3240	'value' => $user_data['login'],
3241	);
3242	$options['jetpack_user_email'] = array(
3243	'desc' => __( 'The WP.com user email of the connected user', 'jetpack-connection' ),
3244	'readonly' => true,
3245	'value' => $user_data['email'],
3246	);
3247	$options['jetpack_user_site_count'] = array(
3248	'desc' => __( 'The number of sites of the connected WP.com user', 'jetpack-connection' ),
3249	'readonly' => true,
3250	'value' => $user_data['site_count'],
3251	);
3252	}
3253	$wp_xmlrpc_server->blog_options = array_merge( $wp_xmlrpc_server->blog_options, $options );
3254	$args = stripslashes_deep( $args );
3255	return $wp_xmlrpc_server->wp_getOptions( $args );
3256	}
3257
3258	/**
3259	* Adds Jetpack-specific options to the output of the XMLRPC options method.
3260	*
3261	* @param array $options standard Core options.
3262	* @return array amended options.
3263	*/
3264	public function xmlrpc_options( $options ) {
3265	$jetpack_client_id = false;
3266	if ( $this->is_connected() ) {
3267	$jetpack_client_id = \Jetpack_Options::get_option( 'id' );
3268	}
3269	$options['jetpack_version'] = array(
3270	'desc' => __( 'Jetpack Plugin Version', 'jetpack-connection' ),
3271	'readonly' => true,
3272	'value' => Constants::get_constant( 'JETPACK__VERSION' ),
3273	);
3274
3275	$options['jetpack_client_id'] = array(
3276	'desc' => __( 'The Client ID/WP.com Blog ID of this site', 'jetpack-connection' ),
3277	'readonly' => true,
3278	'value' => $jetpack_client_id,
3279	);
3280	return $options;
3281	}
3282
3283	/**
3284	* Resets the saved authentication state in between testing requests.
3285	*/
3286	public function reset_saved_auth_state() {
3287	$this->xmlrpc_verification = null;
3288	}
3289
3290	/**
3291	* Sign a user role with the master access token.
3292	* If not specified, will default to the current user.
3293	*
3294	* @access public
3295	*
3296	* @param string $role User role.
3297	* @param int $user_id ID of the user.
3298	* @return string Signed user role.
3299	*/
3300	public function sign_role( $role, $user_id = null ) {
3301	return $this->get_tokens()->sign_role( $role, $user_id );
3302	}
3303
3304	/**
3305	* Set the plugin instance.
3306	*
3307	* @param Plugin $plugin_instance The plugin instance.
3308	*
3309	* @return $this
3310	*/
3311	public function set_plugin_instance( Plugin $plugin_instance ) {
3312	$this->plugin = $plugin_instance;
3313
3314	return $this;
3315	}
3316
3317	/**
3318	* Retrieve the plugin management object.
3319	*
3320	* @return Plugin\|null
3321	*/
3322	public function get_plugin() {
3323	return $this->plugin;
3324	}
3325
3326	/**
3327	* Get all connected plugins information, excluding those disconnected by user.
3328	* WARNING: the method cannot be called until Plugin_Storage::configure is called, which happens on plugins_loaded
3329	* Even if you don't use Jetpack Config, it may be introduced later by other plugins,
3330	* so please make sure not to run the method too early in the code.
3331	*
3332	* @return array\|WP_Error
3333	*/
3334	public function get_connected_plugins() {
3335	$maybe_plugins = Plugin_Storage::get_all();
3336
3337	if ( $maybe_plugins instanceof WP_Error ) {
3338	return $maybe_plugins;
3339	}
3340
3341	return $maybe_plugins;
3342	}
3343
3344	/**
3345	* Force plugin disconnect. After its called, the plugin will not be allowed to use the connection.
3346	* Note: this method does not remove any access tokens.
3347	*
3348	* @deprecated since 1.39.0
3349	* @return bool
3350	*/
3351	public function disable_plugin() {
3352	return null;
3353	}
3354
3355	/**
3356	* Force plugin reconnect after user-initiated disconnect.
3357	* After its called, the plugin will be allowed to use the connection again.
3358	* Note: this method does not initialize access tokens.
3359	*
3360	* @deprecated since 1.39.0.
3361	* @return bool
3362	*/
3363	public function enable_plugin() {
3364	return null;
3365	}
3366
3367	/**
3368	* Whether the plugin is allowed to use the connection, or it's been disconnected by user.
3369	* If no plugin slug was passed into the constructor, always returns true.
3370	*
3371	* @deprecated 1.42.0 This method no longer has a purpose after the removal of the soft disconnect feature.
3372	*
3373	* @return bool
3374	*/
3375	public function is_plugin_enabled() {
3376	return true;
3377	}
3378
3379	/**
3380	* Perform the API request to refresh the blog token.
3381	* Note that we are making this request on behalf of the Jetpack master user,
3382	* given they were (most probably) the ones that registered the site at the first place.
3383	*
3384	* @return WP_Error\|bool The result of updating the blog_token option.
3385	*/
3386	public function refresh_blog_token() {
3387	( new Tracking() )->record_user_event( 'restore_connection_refresh_blog_token' );
3388
3389	$blog_id = \Jetpack_Options::get_option( 'id' );
3390	if ( ! $blog_id ) {
3391	return new WP_Error( 'site_not_registered', 'Site not registered.' );
3392	}
3393
3394	$url = sprintf(
3395	'%s/%s/v%s/%s',
3396	Constants::get_constant( 'JETPACK__WPCOM_JSON_API_BASE' ),
3397	'wpcom',
3398	'2',
3399	'sites/' . $blog_id . '/jetpack-refresh-blog-token'
3400	);
3401	$method = 'POST';
3402	$user_id = get_current_user_id();
3403
3404	$response = Client::remote_request( compact( 'url', 'method', 'user_id' ) );
3405
3406	if ( is_wp_error( $response ) ) {
3407	return new WP_Error( 'refresh_blog_token_http_request_failed', $response->get_error_message() );
3408	}
3409
3410	$code = wp_remote_retrieve_response_code( $response );
3411	$entity = wp_remote_retrieve_body( $response );
3412
3413	if ( $entity ) {
3414	$json = json_decode( $entity );
3415	} else {
3416	$json = false;
3417	}
3418
3419	if ( 200 !== $code ) {
3420	if ( empty( $json->code ) ) {
3421	return new WP_Error( 'unknown', '', $code );
3422	}
3423
3424	/* translators: Error description string. */
3425	$error_description = isset( $json->message ) ? sprintf( __( 'Error Details: %s', 'jetpack-connection' ), (string) $json->message ) : '';
3426
3427	return new WP_Error( (string) $json->code, $error_description, $code );
3428	}
3429
3430	if ( empty( $json->jetpack_secret ) \|\| ! is_scalar( $json->jetpack_secret ) ) {
3431	return new WP_Error( 'jetpack_secret', '', $code );
3432	}
3433
3434	Error_Handler::get_instance()->delete_all_errors();
3435
3436	return $this->get_tokens()->update_blog_token( (string) $json->jetpack_secret );
3437	}
3438
3439	/**
3440	* Disconnect the user from WP.com, and initiate the reconnect process.
3441	*
3442	* @return bool
3443	*/
3444	public function refresh_user_token() {
3445	( new Tracking() )->record_user_event( 'restore_connection_refresh_user_token' );
3446	$this->disconnect_user( null, true, true );
3447	return true;
3448	}
3449
3450	/**
3451	* Fetches a signed token.
3452	*
3453	* @deprecated 1.24.0 Use Automattic\Jetpack\Connection\Tokens->get_signed_token() instead.
3454	*
3455	* @param object $token the token.
3456	* @return WP_Error\|string a signed token
3457	*/
3458	public function get_signed_token( $token ) {
3459	_deprecated_function( __METHOD__, '1.24.0', 'Automattic\\Jetpack\\Connection\\Tokens->get_signed_token' );
3460	return $this->get_tokens()->get_signed_token( $token );
3461	}
3462
3463	/**
3464	* If the site-level connection is active, add the list of plugins using connection to the heartbeat (except Jetpack itself)
3465	*
3466	* @since 6.11.0 Add the list of Jetpack package versions to the heartbeat.
3467	* @since 8.7.4 Add the missing connection owner and XML-RPC error stats to the heartbeat.
3468	* @since 8.7.9 Add the site environment stats (WordPress/PHP versions, etc.) to the heartbeat.
3469	*
3470	* @param array $stats The Heartbeat stats array.
3471	* @return array $stats
3472	*/
3473	public function add_stats_to_heartbeat( $stats ) {
3474
3475	if ( ! $this->is_connected() ) {
3476	return $stats;
3477	}
3478
3479	$active_plugins_using_connection = Plugin_Storage::get_all();
3480	foreach ( array_keys( $active_plugins_using_connection ) as $plugin_slug ) {
3481	if ( 'jetpack' !== $plugin_slug ) {
3482	$stats_group = isset( $active_plugins_using_connection['jetpack'] ) ? 'combined-connection' : 'standalone-connection';
3483	$stats[ $stats_group ][] = $plugin_slug;
3484	}
3485	}
3486
3487	$stats['jetpack_package_versions'] = apply_filters( 'jetpack_package_versions', array() );
3488
3489	$stats['identitycrisis'] = Identity_Crisis::check_identity_crisis() ? 'yes' : 'no';
3490
3491	// Missing the connection owner?
3492	$stats['missing-owner'] = $this->is_missing_connection_owner();
3493
3494	$xmlrpc_errors = \Jetpack_Options::get_option( 'xmlrpc_errors', array() );
3495	if ( $xmlrpc_errors ) {
3496	$stats['xmlrpc-errors'] = implode( ',', array_keys( $xmlrpc_errors ) );
3497	\Jetpack_Options::delete_option( 'xmlrpc_errors' );
3498	}
3499
3500	// Site environment stats (WordPress/PHP versions, site configuration, etc.).
3501	$stats = array_merge( $stats, Heartbeat::get_environment_stats() );
3502
3503	return $stats;
3504	}
3505
3506	/**
3507	* Records a failed XML-RPC signature verification so it can be reported in the heartbeat.
3508	*
3509	* We don't want to expose a detailed error message about why a request failed
3510	* signature verification, as doing so could leak information. Instead, we track
3511	* that the error occurred via a Jetpack option and send that data back in the
3512	* heartbeat. All this does is record the error code, but it's enough to find trends.
3513	*
3514	* @since 8.7.4
3515	*
3516	* @param \WP_Error $xmlrpc_error The error produced during signature validation.
3517	* @return void
3518	*/
3519	public function track_xmlrpc_error( $xmlrpc_error ) {
3520	$code = is_wp_error( $xmlrpc_error )
3521	? $xmlrpc_error->get_error_code()
3522	: 'should-not-happen';
3523
3524	$xmlrpc_errors = \Jetpack_Options::get_option( 'xmlrpc_errors', array() );
3525	if ( isset( $xmlrpc_errors[ $code ] ) && $xmlrpc_errors[ $code ] ) {
3526	// No need to update the option if we already have this code stored.
3527	return;
3528	}
3529	$xmlrpc_errors[ $code ] = true;
3530
3531	\Jetpack_Options::update_option( 'xmlrpc_errors', $xmlrpc_errors, false );
3532	}
3533
3534	/**
3535	* Get the WPCOM or self-hosted site ID.
3536	*
3537	* @param bool $quiet Return null instead of an error.
3538	*
3539	* @return int\|WP_Error\|null
3540	*/
3541	public static function get_site_id( $quiet = false ) {
3542	$is_wpcom = ( defined( 'IS_WPCOM' ) && IS_WPCOM );
3543	$site_id = $is_wpcom ? get_current_blog_id() : \Jetpack_Options::get_option( 'id' );
3544	if ( ! $site_id ) {
3545	return $quiet
3546	? null
3547	: new \WP_Error(
3548	'unavailable_site_id',
3549	__( 'Sorry, something is wrong with your Jetpack connection.', 'jetpack-connection' ),
3550	403
3551	);
3552	}
3553	return (int) $site_id;
3554	}
3555
3556	/**
3557	* Check if Jetpack is ready for uninstall cleanup.
3558	*
3559	* @param string $current_plugin_slug The current plugin's slug.
3560	*
3561	* @return bool
3562	*/
3563	public static function is_ready_for_cleanup( $current_plugin_slug ) {
3564	$active_plugins = get_option( Plugin_Storage::ACTIVE_PLUGINS_OPTION_NAME );
3565
3566	return empty( $active_plugins ) \|\| ! is_array( $active_plugins )
3567	\|\| ( count( $active_plugins ) === 1 && array_key_exists( $current_plugin_slug, $active_plugins ) );
3568	}
3569	}
3570