Jetpack_XMLRPC_Methods::json_api() - Code Metrics - Inspection of "moves json_api xmlrpc method to plugin" - Automattic/jetpack - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — update/connection-package-xmlr... ( 259e19...19458c )

unknown

created 2021-03-01 22:42 UTC

Jetpack_XMLRPC_Methods::json_api() F

↳ Parent: Jetpack_XMLRPC_Methods

Complexity

Conditions	17
Paths	292

Size

Total Lines

102

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	17
nc	292
nop	1
dl	0
loc	102
rs	2.5865
c	0
b	0
f	0

How to fix Long Method Complexity

<?php
/**
 * Jetpack XMLRPC Methods.
 *
 * Registers the Jetpack specific XMLRPC methods
 *
 * @package jetpack
 */

use Automattic\Jetpack\Connection\Manager as Connection_Manager;
use Automattic\Jetpack\Connection\Tokens;

/**
 * XMLRPC Methods registration and callbacks
 */
class Jetpack_XMLRPC_Methods {

	/**
	 * Initialize the main hooks.
	 */
	public static function init() {
		add_filter( 'jetpack_xmlrpc_unauthenticated_methods', array( __CLASS__, 'xmlrpc_methods' ) );
		add_filter( 'jetpack_xmlrpc_test_connection_response', array( __CLASS__, 'test_connection' ) );
	}

	/**
	 * Adds Jetpack specific methods to the methods added by the Connection package.
	 *
	 * @param array $methods Methods added by the Connection package.
	 */
	public function xmlrpc_methods( $methods ) {

		$methods['jetpack.featuresAvailable'] = array( __CLASS__, 'features_available' );
		$methods['jetpack.featuresEnabled']   = array( __CLASS__, 'features_enabled' );
		$methods['jetpack.disconnectBlog']    = array( __CLASS__, 'disconnect_blog' );
		$methods['jetpack.jsonAPI']           = array( __CLASS__, 'json_api' );

		return $methods;
	}

	/**
	 * Returns what features are available. Uses the slug of the module files.
	 *
	 * @return array
	 */
	public static function features_available() {
		$raw_modules = Jetpack::get_available_modules();
		$modules     = array();
		foreach ( $raw_modules as $module ) {
			$modules[] = Jetpack::get_module_slug( $module );
		}

		return $modules;
	}

	/**
	 * Returns what features are enabled. Uses the slug of the modules files.
	 *
	 * @return array
	 */
	public static function features_enabled() {
		$raw_modules = Jetpack::get_active_modules();
		$modules     = array();
		foreach ( $raw_modules as $module ) {
			$modules[] = Jetpack::get_module_slug( $module );
		}

		return $modules;
	}

	/**
	 * Filters the result of test_connection XMLRPC method
	 *
	 * @return string The current Jetpack version number
	 */
	public function test_connection() {
		return JETPACK__VERSION;
	}

	/**
	 * Disconnect this blog from the connected wordpress.com account
	 *
	 * @return boolean
	 */
	public function disconnect_blog() {

		/**
		 * Fired when we want to log an event to the Jetpack event log.
		 *
		 * @since 7.7.0
		 *
		 * @param string $code Unique name for the event.
		 * @param string $data Optional data about the event.
		 */
		do_action( 'jetpack_event_log', 'disconnect' );
		Jetpack::disconnect();

		return true;
	}

	/**
	 * Serve a JSON API request.
	 *
	 * @param array $args request arguments.
	 */
	public function json_api( $args = array() ) {
		$json_api_args        = $args[0];
		$verify_api_user_args = $args[1];

		$method       = (string) $json_api_args[0];
		$url          = (string) $json_api_args[1];
		$post_body    = is_null( $json_api_args[2] ) ? null : (string) $json_api_args[2];
		$user_details = (array) $json_api_args[4];
		$locale       = (string) $json_api_args[5];

		if ( ! $verify_api_user_args ) {
			$user_id = 0;
		} elseif ( 'internal' === $verify_api_user_args[0] ) {
			$user_id = (int) $verify_api_user_args[1];
			if ( $user_id ) {
				$user = get_user_by( 'id', $user_id );
				if ( ! $user || is_wp_error( $user ) ) {
					return false;
				}
			}
		} else {
			$user_id = call_user_func( array( new Jetpack_XMLRPC_Server(), 'test_api_user_code' ), $verify_api_user_args );
			if ( ! $user_id ) {
				return false;
			}
		}

		/* phpcs:ignore
		 debugging
		error_log( "-- begin json api via jetpack debugging -- " );
		error_log( "METHOD: $method" );
		error_log( "URL: $url" );
		error_log( "POST BODY: $post_body" );
		error_log( "VERIFY_ARGS: " . print_r( $verify_api_user_args, 1 ) );
		error_log( "VERIFIED USER_ID: " . (int) $user_id );
		error_log( "-- end json api via jetpack debugging -- " );
		*/

		if ( 'en' !== $locale ) {
			// .org mo files are named slightly different from .com, and all we have is this the locale -- try to guess them.
			$new_locale = $locale;
			if ( strpos( $locale, '-' ) !== false ) {
				$locale_pieces = explode( '-', $locale );
				$new_locale    = $locale_pieces[0];
				$new_locale   .= ( ! empty( $locale_pieces[1] ) ) ? '_' . strtoupper( $locale_pieces[1] ) : '';
			} else {
				// .com might pass 'fr' because thats what our language files are named as, where core seems
				// to do fr_FR - so try that if we don't think we can load the file.
				if ( ! file_exists( WP_LANG_DIR . '/' . $locale . '.mo' ) ) {
					$new_locale = $locale . '_' . strtoupper( $locale );
				}
			}

			if ( file_exists( WP_LANG_DIR . '/' . $new_locale . '.mo' ) ) {
				unload_textdomain( 'default' );
				load_textdomain( 'default', WP_LANG_DIR . '/' . $new_locale . '.mo' );
			}
		}

		$old_user = wp_get_current_user();
		wp_set_current_user( $user_id );

		if ( $user_id ) {
			$token_key = false;
		} else {
			$verified  = ( new Connection_Manager() )->verify_xml_rpc_signature();
			$token_key = $verified['token_key'];
		}

		$token = ( new Tokens() )->get_access_token( $user_id, $token_key );
		if ( ! $token || is_wp_error( $token ) ) {
			return false;
		}

		define( 'REST_API_REQUEST', true );
		define( 'WPCOM_JSON_API__BASE', 'public-api.wordpress.com/rest/v1' );

		// needed?
		require_once ABSPATH . 'wp-admin/includes/admin.php';

		require_once JETPACK__PLUGIN_DIR . 'class.json-api.php';
		$api                        = WPCOM_JSON_API::init( $method, $url, $post_body );
		$api->token_details['user'] = $user_details;
		require_once JETPACK__PLUGIN_DIR . 'class.json-api-endpoints.php';

		$display_errors = ini_set( 'display_errors', 0 ); // phpcs:ignore WordPress.PHP.IniSet
		ob_start();
		$api->serve( false );
		$output = ob_get_clean();
		ini_set( 'display_errors', $display_errors ); // phpcs:ignore WordPress.PHP.IniSet

		$nonce = wp_generate_password( 10, false );
		$hmac  = hash_hmac( 'md5', $nonce . $output, $token->secret );

		wp_set_current_user( isset( $old_user->ID ) ? $old_user->ID : 0 );

		return array(
			(string) $output,
			(string) $nonce,
			(string) $hmac,
		);
	}
}


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		}
25
26		/**
27		* Adds Jetpack specific methods to the methods added by the Connection package.
28		*
29		* @param array $methods Methods added by the Connection package.
30		*/
31		public function xmlrpc_methods( $methods ) {
32
33		$methods['jetpack.featuresAvailable'] = array( __CLASS__, 'features_available' );
34		$methods['jetpack.featuresEnabled'] = array( __CLASS__, 'features_enabled' );
35		$methods['jetpack.disconnectBlog'] = array( __CLASS__, 'disconnect_blog' );
36		$methods['jetpack.jsonAPI'] = array( __CLASS__, 'json_api' );
37
38		return $methods;
39		}
40
41		/**
42		* Returns what features are available. Uses the slug of the module files.
43		*
44		* @return array
45		*/
46	View Code Duplication	public static function features_available() {
47		$raw_modules = Jetpack::get_available_modules();
48		$modules = array();
49		foreach ( $raw_modules as $module ) {
50		$modules[] = Jetpack::get_module_slug( $module );
51		}
52
53		return $modules;
54		}
55
56		/**
57		* Returns what features are enabled. Uses the slug of the modules files.
58		*
59		* @return array
60		*/
61	View Code Duplication	public static function features_enabled() {
62		$raw_modules = Jetpack::get_active_modules();
63		$modules = array();
64		foreach ( $raw_modules as $module ) {
65		$modules[] = Jetpack::get_module_slug( $module );
66		}
67
68		return $modules;
69		}
70
71		/**
72		* Filters the result of test_connection XMLRPC method
73		*
74		* @return string The current Jetpack version number
75		*/
76		public function test_connection() {
77		return JETPACK__VERSION;
78		}
79
80		/**
81		* Disconnect this blog from the connected wordpress.com account
82		*
83		* @return boolean
84		*/
85		public function disconnect_blog() {
86
87		/**
88		* Fired when we want to log an event to the Jetpack event log.
89		*
90		* @since 7.7.0
91		*
92		* @param string $code Unique name for the event.
93		* @param string $data Optional data about the event.
94		*/
95		do_action( 'jetpack_event_log', 'disconnect' );
96		Jetpack::disconnect();
97
98		return true;
99		}
100
101		/**
102		* Serve a JSON API request.
103		*
104		* @param array $args request arguments.
105		*/
106		public function json_api( $args = array() ) {
107		$json_api_args = $args[0];
108		$verify_api_user_args = $args[1];
109
110		$method = (string) $json_api_args[0];
111		$url = (string) $json_api_args[1];
112		$post_body = is_null( $json_api_args[2] ) ? null : (string) $json_api_args[2];
113		$user_details = (array) $json_api_args[4];
114		$locale = (string) $json_api_args[5];
115
116		if ( ! $verify_api_user_args ) {
117		$user_id = 0;
118		} elseif ( 'internal' === $verify_api_user_args[0] ) {
119		$user_id = (int) $verify_api_user_args[1];
120		if ( $user_id ) {
121		$user = get_user_by( 'id', $user_id );
122		if ( ! $user \|\| is_wp_error( $user ) ) {
123		return false;
124		}
125		}
126		} else {
127		$user_id = call_user_func( array( new Jetpack_XMLRPC_Server(), 'test_api_user_code' ), $verify_api_user_args );
128		if ( ! $user_id ) {
129		return false;
130		}
131		}
132
133		/* phpcs:ignore
134		debugging
135		error_log( "-- begin json api via jetpack debugging -- " );
136		error_log( "METHOD: $method" );
137		error_log( "URL: $url" );
138		error_log( "POST BODY: $post_body" );
139		error_log( "VERIFY_ARGS: " . print_r( $verify_api_user_args, 1 ) );
140		error_log( "VERIFIED USER_ID: " . (int) $user_id );
141		error_log( "-- end json api via jetpack debugging -- " );
142		*/
143
144		if ( 'en' !== $locale ) {
145		// .org mo files are named slightly different from .com, and all we have is this the locale -- try to guess them.
146		$new_locale = $locale;
147		if ( strpos( $locale, '-' ) !== false ) {
148		$locale_pieces = explode( '-', $locale );
149		$new_locale = $locale_pieces[0];
150		$new_locale .= ( ! empty( $locale_pieces[1] ) ) ? '_' . strtoupper( $locale_pieces[1] ) : '';
151		} else {
152		// .com might pass 'fr' because thats what our language files are named as, where core seems
153		// to do fr_FR - so try that if we don't think we can load the file.
154		if ( ! file_exists( WP_LANG_DIR . '/' . $locale . '.mo' ) ) {
155		$new_locale = $locale . '_' . strtoupper( $locale );
156		}
157		}
158
159		if ( file_exists( WP_LANG_DIR . '/' . $new_locale . '.mo' ) ) {
160		unload_textdomain( 'default' );
161		load_textdomain( 'default', WP_LANG_DIR . '/' . $new_locale . '.mo' );
162		}
163		}
164
165		$old_user = wp_get_current_user();
166		wp_set_current_user( $user_id );
167
168		if ( $user_id ) {
169		$token_key = false;
170		} else {
171		$verified = ( new Connection_Manager() )->verify_xml_rpc_signature();
172		$token_key = $verified['token_key'];
173		}
174
175		$token = ( new Tokens() )->get_access_token( $user_id, $token_key );
176		if ( ! $token \|\| is_wp_error( $token ) ) {
177		return false;
178		}
179
180		define( 'REST_API_REQUEST', true );
181		define( 'WPCOM_JSON_API__BASE', 'public-api.wordpress.com/rest/v1' );
182
183		// needed?
184		require_once ABSPATH . 'wp-admin/includes/admin.php';
185
186		require_once JETPACK__PLUGIN_DIR . 'class.json-api.php';
187		$api = WPCOM_JSON_API::init( $method, $url, $post_body );
188		$api->token_details['user'] = $user_details;
189		require_once JETPACK__PLUGIN_DIR . 'class.json-api-endpoints.php';
190
191		$display_errors = ini_set( 'display_errors', 0 ); // phpcs:ignore WordPress.PHP.IniSet
192		ob_start();
193		$api->serve( false );
194		$output = ob_get_clean();
195		ini_set( 'display_errors', $display_errors ); // phpcs:ignore WordPress.PHP.IniSet
196
197		$nonce = wp_generate_password( 10, false );
198		$hmac = hash_hmac( 'md5', $nonce . $output, $token->secret );
199
200		wp_set_current_user( isset( $old_user->ID ) ? $old_user->ID : 0 );
201
202		return array(
203		(string) $output,
204		(string) $nonce,
205		(string) $hmac,
206		);
207		}
208		}
209

Automattic / jetpack

Push — update/connection-package-xmlr... ( 259e19...19458c )

Jetpack_XMLRPC_Methods::json_api() F

Complexity

Size

Duplication

Importance

How to fix Long Method Complexity

Long Method

Duplication Side-by-Side

Filter issues like