Jetpack_Provision::get_api_host() - Code Metrics - Inspection of "PHPCS fixes for changed function" - Automattic/jetpack - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — kraftbj-patch-1 ( 599bd6...9b0476 )

unknown

created 2019-03-20 16:42 UTC

Jetpack_Provision::get_api_host() A

↳ Parent: Jetpack_Provision

Complexity

Conditions	2
Paths	2

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	2
nc	2
nop	0
dl	0
loc	4
rs	10
c	0
b	0
f	0

<?php //phpcs:ignore

class Jetpack_Provision { //phpcs:ignore

	/**
	 * Responsible for checking pre-conditions, registering site, and returning an array of details
	 * that can be used to provision a plan for the site.
	 *
	 * @param array $named_args The array of arguments.
	 *
	 * @return WP_Error|array
	 */
	public static function register_and_build_request_body( $named_args ) {
		$url_args = array(
			'home_url' => 'WP_HOME',
			'site_url' => 'WP_SITEURL',
		);

		foreach ( $url_args as $url_arg => $constant_name ) {
			// Anonymous functions were introduced in 5.3.0. So, if we're running on
			// >= 5.3.0, use an anonymous function to set the home/siteurl value%s.
			//
			// Otherwise, fallback to setting the home/siteurl value via the WP_HOME and
			// WP_SITEURL constants if the constant hasn't already been defined.
			if ( isset( $named_args[ $url_arg ] ) ) {
				if ( version_compare( phpversion(), '5.3.0', '>=' ) ) {
					add_filter( $url_arg, function() use ( $url_arg, $named_args ) { // phpcs:ignore PHPCompatibility.PHP.NewClosure.Found
						return $named_args[ $url_arg ];
					}, 11 );
				} elseif ( ! defined( $constant_name ) ) {
					define( $constant_name, $named_args[ $url_arg ] );
				}
			}
		}

		// If Jetpack is currently connected, and is not in Safe Mode already, kick off a sync of the current
		// functions/callables so that we can test if this site is in IDC.
		if ( Jetpack::is_active() && ! Jetpack::validate_sync_error_idc_option() && Jetpack_Sync_Actions::sync_allowed() ) {
			Jetpack_Sync_Actions::do_full_sync( array( 'functions' => true ) );
			Jetpack_Sync_Actions::$sender->do_full_sync();

		}

		if ( Jetpack::validate_sync_error_idc_option() ) {
			return new WP_Error(
				'site_in_safe_mode',
				__( 'Can not provision a plan while in safe mode. See: https://jetpack.com/support/safe-mode/', 'jetpack' )
			);
		}

		$blog_id    = Jetpack_Options::get_option( 'id' );
		$blog_token = Jetpack_Options::get_option( 'blog_token' );

		if ( ! $blog_id || ! $blog_token || ( isset( $named_args['force_register'] ) && intval( $named_args['force_register'] ) ) ) {
			// This code mostly copied from Jetpack::admin_page_load.
			Jetpack::maybe_set_version_option();
			$registered = Jetpack::try_registration();
			if ( is_wp_error( $registered ) ) {
				return $registered;
			} elseif ( ! $registered ) {
				return new WP_Error( 'registration_error', __( 'There was an unspecified error registering the site', 'jetpack' ) );
			}

			$blog_id    = Jetpack_Options::get_option( 'id' );
$myVar = 'Value';
$higher = false;

if (rand(1, 6) > 3) {
    $higher = true;
} else {
    $higher = false;
}
			$blog_token = Jetpack_Options::get_option( 'blog_token' );
$myVar = 'Value';
$higher = false;

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

		// If the user isn't specified, but we have a current master user, then set that to current user.
		$master_user_id = Jetpack_Options::get_option( 'master_user' );
		if ( ! get_current_user_id() && $master_user_id ) {
			wp_set_current_user( $master_user_id );
		}

		$site_icon = get_site_icon_url();

		$auto_enable_sso = ( ! Jetpack::is_active() || Jetpack::is_module_active( 'sso' ) );

		/** This filter is documented in class.jetpack-cli.php */
		if ( apply_filters( 'jetpack_start_enable_sso', $auto_enable_sso ) ) {
			$redirect_uri = add_query_arg(
				array(
					'action'      => 'jetpack-sso',
					'redirect_to' => rawurlencode( admin_url() ),
				),
				wp_login_url() // TODO: come back to Jetpack dashboard?
			);
		} else {
			$redirect_uri = admin_url();
		}

		$request_body = array(
			'jp_version'   => JETPACK__VERSION,
			'redirect_uri' => $redirect_uri,
		);

		if ( $site_icon ) {
			$request_body['site_icon'] = $site_icon;
		}

		if ( get_current_user_id() ) {
			$user = wp_get_current_user();

			// Role.
			$role        = Jetpack::translate_current_user_to_role();
			$signed_role = Jetpack::sign_role( $role );

			$secrets = Jetpack::init()->generate_secrets( 'authorize' );

			// Jetpack auth stuff.
			$request_body['scope']  = $signed_role;
			$request_body['secret'] = $secrets['secret_1'];

			// User stuff.
			$request_body['user_id']    = $user->ID;
			$request_body['user_email'] = $user->user_email;
			$request_body['user_login'] = $user->user_login;
		}

		// Optional additional params.
		if ( isset( $named_args['wpcom_user_id'] ) && ! empty( $named_args['wpcom_user_id'] ) ) {
			$request_body['wpcom_user_id'] = $named_args['wpcom_user_id'];
		}

		// Override email of selected user.
		if ( isset( $named_args['wpcom_user_email'] ) && ! empty( $named_args['wpcom_user_email'] ) ) {
			$request_body['user_email'] = $named_args['wpcom_user_email'];
		}

		if ( isset( $named_args['plan'] ) && ! empty( $named_args['plan'] ) ) {
			$request_body['plan'] = $named_args['plan'];
		}

		if ( isset( $named_args['onboarding'] ) && ! empty( $named_args['onboarding'] ) ) {
			$request_body['onboarding'] = intval( $named_args['onboarding'] );
		}

		if ( isset( $named_args['force_connect'] ) && ! empty( $named_args['force_connect'] ) ) {
			$request_body['force_connect'] = intval( $named_args['force_connect'] );
		}

		if ( isset( $request_body['onboarding'] ) && (bool) $request_body['onboarding'] ) {
			Jetpack::create_onboarding_token();
		}

		return $request_body;
	}

	/**
	 * Given an access token and an array of arguments, will provision a plan for this site.
	 *
	 * @param string $access_token The access token from the partner.
	 * @param array  $named_args   The arguments used for registering the site and then provisioning a plan.
	 *
	 * @return WP_Error|array
	 */
	public static function partner_provision( $access_token, $named_args ) {
		// First, verify the token.
		$verify_response = self::verify_token( $access_token );

		if ( is_wp_error( $verify_response ) ) {
			return $verify_response;
		}

		$request_body = self::register_and_build_request_body( $named_args );
		if ( is_wp_error( $request_body ) ) {
			return $request_body;
		}

		$request = array(
			'headers' => array(
				'Authorization' => "Bearer $access_token",
				'Host'          => 'public-api.wordpress.com',
			),
			'timeout' => 60,
			'method'  => 'POST',
			'body'    => wp_json_encode( $request_body ),
		);

		$blog_id = Jetpack_Options::get_option( 'id' );
		$url     = esc_url_raw( sprintf(
			'https://%s/rest/v1.3/jpphp/%d/partner-provision',
			self::get_api_host(),
			$blog_id
		) );
		if ( ! empty( $named_args['partner_tracking_id'] ) ) {
			$url = esc_url_raw( add_query_arg( 'partner_tracking_id', $named_args['partner_tracking_id'], $url ) );
		}

		// Add calypso env if set.
		if ( getenv( 'CALYPSO_ENV' ) ) {
			$url = add_query_arg( array( 'calypso_env' => getenv( 'CALYPSO_ENV' ) ), $url );
		}

		$result = Jetpack_Client::_wp_remote_request( $url, $request );

		if ( is_wp_error( $result ) ) {
			return $result;
		}

		$response_code = wp_remote_retrieve_response_code( $result );
		$body_json     = json_decode( wp_remote_retrieve_body( $result ) );

		if ( 200 !== $response_code ) {
			if ( isset( $body_json->error ) ) {
				return new WP_Error( $body_json->error, $body_json->message );
			} else {
				return new WP_Error(
					'server_error',
					/* translators: %s is an HTTP status code retured from an API request. Ex. – 400 */
					sprintf( __( 'Request failed with code %s', 'jetpack' ), $response_code )
				);
			}
		}

		if ( isset( $body_json->access_token ) && is_user_logged_in() ) {
			// Check if this matches the existing token before replacing.
			$existing_token = Jetpack_Data::get_access_token( get_current_user_id() );
			if ( empty( $existing_token ) || $existing_token->secret !== $body_json->access_token ) {
				self::authorize_user( get_current_user_id(), $body_json->access_token );
			}
		}

		return $body_json;
	}

	private static function authorize_user( $user_id, $access_token ) {
		// authorize user and enable SSO
		Jetpack::update_user_token( $user_id, sprintf( '%s.%d', $access_token, $user_id ), true );

		/**
		 * Auto-enable SSO module for new Jetpack Start connections
		 *
		 * @since 5.0.0
		 *
		 * @param bool $enable_sso Whether to enable the SSO module. Default to true.
		 */
		$other_modules = apply_filters( 'jetpack_start_enable_sso', true )
			? array( 'sso' )
			: array();

		if ( $active_modules = Jetpack_Options::get_option( 'active_modules' ) ) {
			Jetpack::delete_active_modules();
			Jetpack::activate_default_modules( 999, 1, array_merge( $active_modules, $other_modules ), false );
function acceptsInteger($int) { }

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

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
		} else {
			Jetpack::activate_default_modules( false, false, $other_modules, false );
		}
	}

	private static function verify_token( $access_token ) {
		$request = array(
			'headers' => array(
				'Authorization' => "Bearer " . $access_token,
				'Host'          => 'public-api.wordpress.com',
			),
			'timeout' => 10,
			'method'  => 'POST',
			'body'    => ''
		);

		$url = sprintf( 'https://%s/rest/v1.3/jpphp/partner-keys/verify', self::get_api_host() );
		$result = Jetpack_Client::_wp_remote_request( $url, $request );

		if ( is_wp_error( $result ) ) {
			return $result;
		}

		$response_code = wp_remote_retrieve_response_code( $result );
		$body_json     = json_decode( wp_remote_retrieve_body( $result ) );

		if( 200 !== $response_code ) {
			if ( isset( $body_json->error ) ) {
				return new WP_Error( $body_json->error, $body_json->message );
			} else {
				return new WP_Error( 'server_error', sprintf( __( 'Request failed with code %s', 'jetpack' ), $response_code ) );
			}
		}

		return true;
	}

	private static function get_api_host() {
		$env_api_host = getenv( 'JETPACK_START_API_HOST', true );
		return $env_api_host ? $env_api_host : JETPACK__WPCOM_JSON_API_HOST;
	}
}


1		<?php //phpcs:ignore
2
3		class Jetpack_Provision { //phpcs:ignore
4
5		/**
6		* Responsible for checking pre-conditions, registering site, and returning an array of details
7		* that can be used to provision a plan for the site.
8		*
9		* @param array $named_args The array of arguments.
10		*
11		* @return WP_Error\|array
12		*/
13		public static function register_and_build_request_body( $named_args ) {
14		$url_args = array(
15		'home_url' => 'WP_HOME',
16		'site_url' => 'WP_SITEURL',
17		);
18
19		foreach ( $url_args as $url_arg => $constant_name ) {
20		// Anonymous functions were introduced in 5.3.0. So, if we're running on
21		// >= 5.3.0, use an anonymous function to set the home/siteurl value%s.
22		//
23		// Otherwise, fallback to setting the home/siteurl value via the WP_HOME and
24		// WP_SITEURL constants if the constant hasn't already been defined.
25		if ( isset( $named_args[ $url_arg ] ) ) {
26		if ( version_compare( phpversion(), '5.3.0', '>=' ) ) {
27		add_filter( $url_arg, function() use ( $url_arg, $named_args ) { // phpcs:ignore PHPCompatibility.PHP.NewClosure.Found
28		return $named_args[ $url_arg ];
29		}, 11 );
30		} elseif ( ! defined( $constant_name ) ) {
31		define( $constant_name, $named_args[ $url_arg ] );
32		}
33		}
34		}
35
36		// If Jetpack is currently connected, and is not in Safe Mode already, kick off a sync of the current
37		// functions/callables so that we can test if this site is in IDC.
38		if ( Jetpack::is_active() && ! Jetpack::validate_sync_error_idc_option() && Jetpack_Sync_Actions::sync_allowed() ) {
39		Jetpack_Sync_Actions::do_full_sync( array( 'functions' => true ) );
40		Jetpack_Sync_Actions::$sender->do_full_sync();
		0 ignored issues – show Bug introduced 2018-02-28 16:29 UTC by Report Bug Copy Issue Report The property `sender` cannot be accessed from this context as it is declared `private` in class `Jetpack_Sync_Actions`. This check looks for access to properties that are not accessible from the current context. If you need to make a property accessible to another context you can either raise its visibility level or provide an accessible getter in the defining class. Loading history...
41		}
42
43		if ( Jetpack::validate_sync_error_idc_option() ) {
44		return new WP_Error(
45		'site_in_safe_mode',
46		__( 'Can not provision a plan while in safe mode. See: https://jetpack.com/support/safe-mode/', 'jetpack' )
47		);
48		}
49
50		$blog_id = Jetpack_Options::get_option( 'id' );
51		$blog_token = Jetpack_Options::get_option( 'blog_token' );
52
53		if ( ! $blog_id \|\| ! $blog_token \|\| ( isset( $named_args['force_register'] ) && intval( $named_args['force_register'] ) ) ) {
54		// This code mostly copied from Jetpack::admin_page_load.
55		Jetpack::maybe_set_version_option();
56		$registered = Jetpack::try_registration();
57		if ( is_wp_error( $registered ) ) {
58		return $registered;
59		} elseif ( ! $registered ) {
60		return new WP_Error( 'registration_error', __( 'There was an unspecified error registering the site', 'jetpack' ) );
61		}
62
63		$blog_id = Jetpack_Options::get_option( 'id' );
		0 ignored issues – show Unused Code introduced 2018-03-28 21:35 UTC by Report Bug Copy Issue Report `$blog_id` is not used, you could remove the assignment. This check looks for variable assignements that are either overwritten by other assignments or where the variable is not used subsequently. $myVar = 'Value'; $higher = false; if (rand(1, 6) > 3) { $higher = true; } else { $higher = false; } Both the `$myVar` assignment in line 1 and the `$higher` assignment in line 2 are dead. The first because `$myVar` is never used and the second because `$higher` is always overwritten for every possible time line. Loading history...
64		$blog_token = Jetpack_Options::get_option( 'blog_token' );
		0 ignored issues – show Unused Code introduced 2017-05-07 05:28 UTC by Report Bug Copy Issue Report `$blog_token` is not used, you could remove the assignment. This check looks for variable assignements that are either overwritten by other assignments or where the variable is not used subsequently. $myVar = 'Value'; $higher = false; if (rand(1, 6) > 3) { $higher = true; } else { $higher = false; } Both the `$myVar` assignment in line 1 and the `$higher` assignment in line 2 are dead. The first because `$myVar` is never used and the second because `$higher` is always overwritten for every possible time line. Loading history...
65		}
66
67		// If the user isn't specified, but we have a current master user, then set that to current user.
68		$master_user_id = Jetpack_Options::get_option( 'master_user' );
69		if ( ! get_current_user_id() && $master_user_id ) {
70		wp_set_current_user( $master_user_id );
71		}
72
73		$site_icon = get_site_icon_url();
74
75		$auto_enable_sso = ( ! Jetpack::is_active() \|\| Jetpack::is_module_active( 'sso' ) );
76
77		/** This filter is documented in class.jetpack-cli.php */
78	View Code Duplication	if ( apply_filters( 'jetpack_start_enable_sso', $auto_enable_sso ) ) {
79		$redirect_uri = add_query_arg(
80		array(
81		'action' => 'jetpack-sso',
82		'redirect_to' => rawurlencode( admin_url() ),
83		),
84		wp_login_url() // TODO: come back to Jetpack dashboard?
85		);
86		} else {
87		$redirect_uri = admin_url();
88		}
89
90		$request_body = array(
91		'jp_version' => JETPACK__VERSION,
92		'redirect_uri' => $redirect_uri,
93		);
94
95		if ( $site_icon ) {
96		$request_body['site_icon'] = $site_icon;
97		}
98
99		if ( get_current_user_id() ) {
100		$user = wp_get_current_user();
101
102		// Role.
103		$role = Jetpack::translate_current_user_to_role();
104		$signed_role = Jetpack::sign_role( $role );
105
106		$secrets = Jetpack::init()->generate_secrets( 'authorize' );
107
108		// Jetpack auth stuff.
109		$request_body['scope'] = $signed_role;
110		$request_body['secret'] = $secrets['secret_1'];
111
112		// User stuff.
113		$request_body['user_id'] = $user->ID;
114		$request_body['user_email'] = $user->user_email;
115		$request_body['user_login'] = $user->user_login;
116		}
117
118		// Optional additional params.
119	View Code Duplication	if ( isset( $named_args['wpcom_user_id'] ) && ! empty( $named_args['wpcom_user_id'] ) ) {
120		$request_body['wpcom_user_id'] = $named_args['wpcom_user_id'];
121		}
122
123		// Override email of selected user.
124	View Code Duplication	if ( isset( $named_args['wpcom_user_email'] ) && ! empty( $named_args['wpcom_user_email'] ) ) {
125		$request_body['user_email'] = $named_args['wpcom_user_email'];
126		}
127
128	View Code Duplication	if ( isset( $named_args['plan'] ) && ! empty( $named_args['plan'] ) ) {
129		$request_body['plan'] = $named_args['plan'];
130		}
131
132	View Code Duplication	if ( isset( $named_args['onboarding'] ) && ! empty( $named_args['onboarding'] ) ) {
133		$request_body['onboarding'] = intval( $named_args['onboarding'] );
134		}
135
136	View Code Duplication	if ( isset( $named_args['force_connect'] ) && ! empty( $named_args['force_connect'] ) ) {
137		$request_body['force_connect'] = intval( $named_args['force_connect'] );
138		}
139
140		if ( isset( $request_body['onboarding'] ) && (bool) $request_body['onboarding'] ) {
141		Jetpack::create_onboarding_token();
142		}
143
144		return $request_body;
145		}
146
147		/**
148		* Given an access token and an array of arguments, will provision a plan for this site.
149		*
150		* @param string $access_token The access token from the partner.
151		* @param array $named_args The arguments used for registering the site and then provisioning a plan.
152		*
153		* @return WP_Error\|array
154		*/
155		public static function partner_provision( $access_token, $named_args ) {
156		// First, verify the token.
157		$verify_response = self::verify_token( $access_token );
158
159		if ( is_wp_error( $verify_response ) ) {
160		return $verify_response;
161		}
162
163		$request_body = self::register_and_build_request_body( $named_args );
164		if ( is_wp_error( $request_body ) ) {
165		return $request_body;
166		}
167
168		$request = array(
169		'headers' => array(
170		'Authorization' => "Bearer $access_token",
171		'Host' => 'public-api.wordpress.com',
172		),
173		'timeout' => 60,
174		'method' => 'POST',
175		'body' => wp_json_encode( $request_body ),
176		);
177
178		$blog_id = Jetpack_Options::get_option( 'id' );
179		$url = esc_url_raw( sprintf(
180		'https://%s/rest/v1.3/jpphp/%d/partner-provision',
181		self::get_api_host(),
182		$blog_id
183		) );
184	View Code Duplication	if ( ! empty( $named_args['partner_tracking_id'] ) ) {
185		$url = esc_url_raw( add_query_arg( 'partner_tracking_id', $named_args['partner_tracking_id'], $url ) );
186		}
187
188		// Add calypso env if set.
189		if ( getenv( 'CALYPSO_ENV' ) ) {
190		$url = add_query_arg( array( 'calypso_env' => getenv( 'CALYPSO_ENV' ) ), $url );
191		}
192
193		$result = Jetpack_Client::_wp_remote_request( $url, $request );
194
195		if ( is_wp_error( $result ) ) {
196		return $result;
197		}
198
199		$response_code = wp_remote_retrieve_response_code( $result );
200		$body_json = json_decode( wp_remote_retrieve_body( $result ) );
201
202	View Code Duplication	if ( 200 !== $response_code ) {
203		if ( isset( $body_json->error ) ) {
204		return new WP_Error( $body_json->error, $body_json->message );
205		} else {
206		return new WP_Error(
207		'server_error',
208		/* translators: %s is an HTTP status code retured from an API request. Ex. – 400 */
209		sprintf( __( 'Request failed with code %s', 'jetpack' ), $response_code )
210		);
211		}
212		}
213
214		if ( isset( $body_json->access_token ) && is_user_logged_in() ) {
215		// Check if this matches the existing token before replacing.
216		$existing_token = Jetpack_Data::get_access_token( get_current_user_id() );
217		if ( empty( $existing_token ) \|\| $existing_token->secret !== $body_json->access_token ) {
218		self::authorize_user( get_current_user_id(), $body_json->access_token );
219		}
220		}
221
222		return $body_json;
223		}
224
225		private static function authorize_user( $user_id, $access_token ) {
226		// authorize user and enable SSO
227		Jetpack::update_user_token( $user_id, sprintf( '%s.%d', $access_token, $user_id ), true );
228
229		/**
230		* Auto-enable SSO module for new Jetpack Start connections
231		*
232		* @since 5.0.0
233		*
234		* @param bool $enable_sso Whether to enable the SSO module. Default to true.
235		*/
236		$other_modules = apply_filters( 'jetpack_start_enable_sso', true )
237		? array( 'sso' )
238		: array();
239
240		if ( $active_modules = Jetpack_Options::get_option( 'active_modules' ) ) {
241		Jetpack::delete_active_modules();
242		Jetpack::activate_default_modules( 999, 1, array_merge( $active_modules, $other_modules ), false );
		0 ignored issues – show Documentation introduced 2017-10-19 23:58 UTC by Report Bug Copy Issue Report `999` is of type `integer`, but the function expects a `boolean`. It seems like the type of the argument is not accepted by the function/method which you are calling. In some cases, in particular if PHP’s automatic type-juggling kicks in this might be fine. In other cases, however this might be a bug. We suggest to add an explicit type cast like in the following example: function acceptsInteger($int) { } $x = '123'; // string "123" // Instead of acceptsInteger($x); // we recommend to use acceptsInteger((integer) $x); Loading history...
243		} else {
244		Jetpack::activate_default_modules( false, false, $other_modules, false );
245		}
246		}
247
248		private static function verify_token( $access_token ) {
249		$request = array(
250		'headers' => array(
251		'Authorization' => "Bearer " . $access_token,
252		'Host' => 'public-api.wordpress.com',
253		),
254		'timeout' => 10,
255		'method' => 'POST',
256		'body' => ''
257		);
258
259		$url = sprintf( 'https://%s/rest/v1.3/jpphp/partner-keys/verify', self::get_api_host() );
260		$result = Jetpack_Client::_wp_remote_request( $url, $request );
261
262		if ( is_wp_error( $result ) ) {
263		return $result;
264		}
265
266		$response_code = wp_remote_retrieve_response_code( $result );
267		$body_json = json_decode( wp_remote_retrieve_body( $result ) );
268
269	View Code Duplication	if( 200 !== $response_code ) {
270		if ( isset( $body_json->error ) ) {
271		return new WP_Error( $body_json->error, $body_json->message );
272		} else {
273		return new WP_Error( 'server_error', sprintf( __( 'Request failed with code %s', 'jetpack' ), $response_code ) );
274		}
275		}
276
277		return true;
278		}
279
280		private static function get_api_host() {
281		$env_api_host = getenv( 'JETPACK_START_API_HOST', true );
282		return $env_api_host ? $env_api_host : JETPACK__WPCOM_JSON_API_HOST;
283		}
284		}
285

Automattic / jetpack

Push — kraftbj-patch-1 ( 599bd6...9b0476 )

Jetpack_Provision::get_api_host() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like