class-jetpack-xmlrpc-methods.php — Jetpack – WP Security, Backup, Speed, & Growth 14.0.1

jetpack / class-jetpack-xmlrpc-methods.php

jetpack Last commit date

class-jetpack-xmlrpc-methods.php

273 lines

1	<?php
2	/**
3	* Jetpack XMLRPC Methods.
4	*
5	* Registers the Jetpack specific XMLRPC methods
6	*
7	* @package jetpack
8	*/
9
10	use Automattic\Jetpack\Connection\Manager as Connection_Manager;
11	use Automattic\Jetpack\Connection\Tokens;
12
13	/**
14	* XMLRPC Methods registration and callbacks
15	*/
16	class Jetpack_XMLRPC_Methods {
17
18	/**
19	* Initialize the main hooks.
20	*/
21	public static function init() {
22	add_filter( 'jetpack_xmlrpc_unauthenticated_methods', array( __CLASS__, 'xmlrpc_methods' ) );
23	add_filter( 'jetpack_xmlrpc_test_connection_response', array( __CLASS__, 'test_connection' ) );
24	add_action( 'jetpack_xmlrpc_server_event', array( __CLASS__, 'jetpack_xmlrpc_server_event' ), 10, 4 );
25	add_action( 'jetpack_remote_connect_end', array( __CLASS__, 'remote_connect_end' ) );
26	add_filter( 'jetpack_xmlrpc_remote_register_redirect_uri', array( __CLASS__, 'remote_register_redirect_uri' ) );
27	}
28
29	/**
30	* Adds Jetpack specific methods to the methods added by the Connection package.
31	*
32	* @param array $methods Methods added by the Connection package.
33	*/
34	public static function xmlrpc_methods( $methods ) {
35
36	$methods['jetpack.featuresAvailable'] = array( __CLASS__, 'features_available' );
37	$methods['jetpack.featuresEnabled'] = array( __CLASS__, 'features_enabled' );
38	$methods['jetpack.disconnectBlog'] = array( __CLASS__, 'disconnect_blog' );
39	$methods['jetpack.jsonAPI'] = array( __CLASS__, 'json_api' );
40
41	return $methods;
42	}
43
44	/**
45	* Returns what features are available. Uses the slug of the module files.
46	*
47	* @deprecated 13.9
48	* @see Jetpack_Core_Json_Api_Endpoints::get_features_available()
49	* @return array
50	*/
51	public static function features_available() {
52	$raw_modules = Jetpack::get_available_modules();
53	$modules = array();
54	foreach ( $raw_modules as $module ) {
55	$modules[] = Jetpack::get_module_slug( $module );
56	}
57
58	return $modules;
59	}
60
61	/**
62	* Returns what features are enabled. Uses the slug of the modules files.
63	*
64	* @deprecated 13.9
65	* @see Jetpack_Core_Json_Api_Endpoints::get_features_enabled()
66	* @return array
67	*/
68	public static function features_enabled() {
69	$raw_modules = Jetpack::get_active_modules();
70	$modules = array();
71	foreach ( $raw_modules as $module ) {
72	$modules[] = Jetpack::get_module_slug( $module );
73	}
74
75	return $modules;
76	}
77
78	/**
79	* Filters the result of test_connection XMLRPC method
80	*
81	* @return string The current Jetpack version number
82	*/
83	public static function test_connection() {
84	return JETPACK__VERSION;
85	}
86
87	/**
88	* Disconnect this blog from the connected wordpress.com account
89	*
90	* @return boolean
91	*/
92	public static function disconnect_blog() {
93
94	/**
95	* Fired when we want to log an event to the Jetpack event log.
96	*
97	* @since 7.7.0
98	*
99	* @param string $code Unique name for the event.
100	* @param string $data Optional data about the event.
101	*/
102	do_action( 'jetpack_event_log', 'disconnect' );
103	( new Connection_Manager( 'jetpack' ) )->disconnect_site();
104
105	return true;
106	}
107
108	/**
109	* Serve a JSON API request.
110	*
111	* @param array $args request arguments.
112	*/
113	public static function json_api( $args = array() ) {
114	$json_api_args = $args[0];
115	$verify_api_user_args = $args[1];
116
117	$method = (string) $json_api_args[0];
118	$url = (string) $json_api_args[1];
119	$post_body = $json_api_args[2] === null ? null : (string) $json_api_args[2];
120	$user_details = (array) $json_api_args[4];
121	$locale = (string) $json_api_args[5];
122
123	if ( ! $verify_api_user_args ) {
124	$user_id = 0;
125	} elseif ( 'internal' === $verify_api_user_args[0] ) {
126	$user_id = (int) $verify_api_user_args[1];
127	if ( $user_id ) {
128	$user = get_user_by( 'id', $user_id );
129	if ( ! $user \|\| is_wp_error( $user ) ) {
130	return false;
131	}
132	}
133	} else {
134	$user_id = call_user_func( array( new Jetpack_XMLRPC_Server(), 'test_api_user_code' ), $verify_api_user_args );
135	if ( ! $user_id ) {
136	return false;
137	}
138	}
139
140	if ( 'en' !== $locale ) {
141	// .org mo files are named slightly different from .com, and all we have is this the locale -- try to guess them.
142	$new_locale = $locale;
143	if ( str_contains( $locale, '-' ) ) {
144	$locale_pieces = explode( '-', $locale );
145	$new_locale = $locale_pieces[0];
146	$new_locale .= ( ! empty( $locale_pieces[1] ) ) ? '_' . strtoupper( $locale_pieces[1] ) : '';
147	} else { // phpcs:ignore Universal.ControlStructures.DisallowLonelyIf.Found
148	// .com might pass 'fr' because thats what our language files are named as, where core seems
149	// to do fr_FR - so try that if we don't think we can load the file.
150	if ( ! file_exists( WP_LANG_DIR . '/' . $locale . '.mo' ) ) {
151	$new_locale = $locale . '_' . strtoupper( $locale );
152	}
153	}
154
155	if ( file_exists( WP_LANG_DIR . '/' . $new_locale . '.mo' ) ) {
156	unload_textdomain( 'default' );
157	load_textdomain( 'default', WP_LANG_DIR . '/' . $new_locale . '.mo' );
158	}
159	}
160
161	$old_user = wp_get_current_user();
162	wp_set_current_user( $user_id );
163
164	if ( $user_id ) {
165	$token_key = false;
166	} else {
167	$verified = ( new Connection_Manager() )->verify_xml_rpc_signature();
168	$token_key = $verified['token_key'];
169	}
170
171	$token = ( new Tokens() )->get_access_token( $user_id, $token_key );
172	if ( ! $token \|\| is_wp_error( $token ) ) {
173	return false;
174	}
175
176	define( 'REST_API_REQUEST', true );
177	define( 'WPCOM_JSON_API__BASE', 'public-api.wordpress.com/rest/v1' );
178
179	// needed?
180	require_once ABSPATH . 'wp-admin/includes/admin.php';
181
182	require_once JETPACK__PLUGIN_DIR . 'class.json-api.php';
183	$api = WPCOM_JSON_API::init( $method, $url, $post_body );
184	$api->token_details['user'] = $user_details;
185	require_once JETPACK__PLUGIN_DIR . 'class.json-api-endpoints.php';
186
187	$display_errors = ini_set( 'display_errors', 0 ); // phpcs:ignore WordPress.PHP.IniSet
188	ob_start();
189	$api->serve( false );
190	$output = ob_get_clean();
191	ini_set( 'display_errors', $display_errors ); // phpcs:ignore WordPress.PHP.IniSet
192
193	$nonce = wp_generate_password( 10, false );
194	$hmac = hash_hmac( 'md5', $nonce . $output, $token->secret );
195
196	wp_set_current_user( isset( $old_user->ID ) ? $old_user->ID : 0 );
197
198	return array(
199	(string) $output,
200	(string) $nonce,
201	(string) $hmac,
202	);
203	}
204
205	/**
206	* Filters the response of the remote_provision XMLRPC method
207	*
208	* @param array $response The response.
209	* @param array $request An array containing at minimum a nonce key and a local_username key.
210	*
211	* @since 9.8.0
212	* @deprecated since 13.9
213	*
214	* @return array
215	*/
216	public static function remote_provision_response( $response, $request ) { // phpcs:ignore VariableAnalysis.CodeAnalysis.VariableAnalysis.UnusedVariable
217	_deprecated_function( __METHOD__, '13.9' );
218	return $response;
219	}
220
221	/**
222	* Runs Jetpack specific action in xmlrpc server events
223	*
224	* @param String $action the action name, i.e., 'remote_authorize'.
225	* @param String $stage the execution stage, can be 'begin', 'success', 'error', etc.
226	* @param array $parameters extra parameters from the event.
227	* @param WP_User $user the acting user.
228	* @return void
229	*/
230	public static function jetpack_xmlrpc_server_event( $action, $stage, $parameters = array(), $user = null ) { //phpcs:ignore VariableAnalysis.CodeAnalysis.VariableAnalysis.UnusedVariable
231	if ( 'remote_register' === $action && 'begin' === $stage ) {
232	Jetpack::maybe_set_version_option();
233	}
234	}
235
236	/**
237	* Hooks into the remote_connect XMLRPC endpoint and triggers Jetpack::handle_post_authorization_actions
238	*
239	* @since 9.8.0
240	* @return void
241	*/
242	public static function remote_connect_end() {
243	/** This filter is documented in class.jetpack-cli.php */
244	$enable_sso = apply_filters( 'jetpack_start_enable_sso', true );
245	Jetpack::handle_post_authorization_actions( $enable_sso, false, false );
246	}
247
248	/**
249	* Filters the Redirect URI returned by the remote_register XMLRPC method
250	*
251	* @since 9.8.0
252	*
253	* @param string $redirect_uri The Redirect URI.
254	* @return string
255	*/
256	public static function remote_register_redirect_uri( $redirect_uri ) {
257	$auto_enable_sso = ( ! ( new Connection_Manager() )->has_connected_owner() \|\| Jetpack::is_module_active( 'sso' ) );
258
259	/** This filter is documented in class.jetpack-cli.php */
260	if ( apply_filters( 'jetpack_start_enable_sso', $auto_enable_sso ) ) {
261	$redirect_uri = add_query_arg(
262	array(
263	'action' => 'jetpack-sso',
264	'redirect_to' => rawurlencode( admin_url() ),
265	),
266	wp_login_url() // TODO: come back to Jetpack dashboard?
267	);
268	}
269
270	return $redirect_uri;
271	}
272	}
273