Completed
Push — fix/4.4.1-typos ( 3db521 )
by
unknown
25s
created

Jetpack_Client   B

Complexity

Total Complexity 51

Size/Duplication

Total Lines 333
Duplicated Lines 0 %

Coupling/Cohesion

Components 1
Dependencies 5

Importance

Changes 0
Metric Value
dl 0
loc 333
rs 8.3206
c 0
b 0
f 0
wmc 51
lcom 1
cbo 5

5 Methods

Rating   Name   Duplication   Size   Complexity  
C _wp_remote_request() 0 73 14
D set_time_diff() 0 27 10
B wpcom_json_api_request_as_blog() 0 34 4
F remote_request() 0 130 17
B _stringify_data() 0 23 6

How to fix   Complexity   

Complex Class

Complex classes like Jetpack_Client often do a lot of different things. To break such a class down, we need to identify a cohesive component within that class. A common approach to find such a component is to look for fields/methods that share the same prefixes, or suffixes. You can also have a look at the cohesion graph to spot any un-connected, or weakly-connected components.

Once you have determined the fields that belong together, you can apply the Extract Class refactoring. If the component makes sense as a sub-class, Extract Subclass is also a candidate, and is often faster.

While breaking up the class, it is a good idea to analyze how other classes use Jetpack_Client, and based on these observations, apply Extract Interface, too.

1
<?php
2
3
class Jetpack_Client {
4
	const WPCOM_JSON_API_VERSION = '1.1';
5
6
	/**
7
	 * Makes an authorized remote request using Jetpack_Signature
8
	 *
9
	 * @return array|WP_Error WP HTTP response on success
10
	 */
11
	public static function remote_request( $args, $body = null ) {
12
		$defaults = array(
13
			'url' => '',
14
			'user_id' => 0,
15
			'blog_id' => 0,
16
			'auth_location' => JETPACK_CLIENT__AUTH_LOCATION,
17
			'method' => 'POST',
18
			'timeout' => 10,
19
			'redirection' => 0,
20
			'headers' => array(),
21
		);
22
23
		$args = wp_parse_args( $args, $defaults );
24
25
		$args['blog_id'] = (int) $args['blog_id'];
26
27
		if ( 'header' != $args['auth_location'] ) {
28
			$args['auth_location'] = 'query_string';
29
		}
30
31
		$token = Jetpack_Data::get_access_token( $args['user_id'] );
0 ignored issues
show
Documentation introduced by
$args['user_id'] is of type integer|string, 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...
32
		if ( !$token ) {
33
			return new Jetpack_Error( 'missing_token' );
34
		}
35
36
		$method = strtoupper( $args['method'] );
37
38
		$timeout = intval( $args['timeout'] );
39
40
		$redirection = $args['redirection'];
41
42
		$request = compact( 'method', 'body', 'timeout', 'redirection' );
43
44
		@list( $token_key, $secret ) = explode( '.', $token->secret );
0 ignored issues
show
Security Best Practice introduced by
It seems like you do not handle an error condition here. This can introduce security issues, and is generally not recommended.

If you suppress an error, we recommend checking for the error condition explicitly:

// For example instead of
@mkdir($dir);

// Better use
if (@mkdir($dir) === false) {
    throw new \RuntimeException('The directory '.$dir.' could not be created.');
}
Loading history...
45
		if ( empty( $token ) || empty( $secret ) ) {
46
			return new Jetpack_Error( 'malformed_token' );
47
		}
48
49
		$token_key = sprintf( '%s:%d:%d', $token_key, JETPACK__API_VERSION, $token->external_user_id );
50
51
		require_once JETPACK__PLUGIN_DIR . 'class.jetpack-signature.php';
52
53
		$time_diff = (int) Jetpack_Options::get_option( 'time_diff' );
54
		$jetpack_signature = new Jetpack_Signature( $token->secret, $time_diff );
55
56
		$timestamp = time() + $time_diff;
57
58
		if( function_exists( 'wp_generate_password' ) ) {
59
			$nonce = wp_generate_password( 10, false );
60
		} else {
61
			$nonce = substr( sha1( rand( 0, 1000000 ) ), 0, 10);
62
		}
63
64
		// Kind of annoying.  Maybe refactor Jetpack_Signature to handle body-hashing
65
		if ( is_null( $body ) ) {
66
			$body_hash = '';
67
68
		} else {
69
			// Allow arrays to be used in passing data.
70
			$body_to_hash = $body;
71
72
			if ( is_array( $body ) ) {
73
				// We cast this to a new variable, because the array form of $body needs to be
74
				// maintained so it can be passed into the request later on in the code.
75
				if ( count( $body ) > 0 ) {
76
					$body_to_hash = json_encode( self::_stringify_data( $body ) );
77
				} else {
78
					$body_to_hash = '';
79
				}
80
			}
81
82
			if ( ! is_string( $body_to_hash ) ) {
83
				return new Jetpack_Error( 'invalid_body', 'Body is malformed.' );
84
			}
85
86
			$body_hash = jetpack_sha1_base64( $body_to_hash );
87
		}
88
89
		$auth = array(
90
			'token' => $token_key,
91
			'timestamp' => $timestamp,
92
			'nonce' => $nonce,
93
			'body-hash' => $body_hash,
94
		);
95
96
		if ( false !== strpos( $args['url'], 'xmlrpc.php' ) ) {
97
			$url_args = array(
98
				'for'           => 'jetpack',
99
				'wpcom_blog_id' => Jetpack_Options::get_option( 'id' ),
100
			);
101
		} else {
102
			$url_args = array();
103
		}
104
105
		if ( 'header' != $args['auth_location'] ) {
106
			$url_args += $auth;
107
		}
108
109
		$url = add_query_arg( urlencode_deep( $url_args ), $args['url'] );
110
		$url = Jetpack::fix_url_for_bad_hosts( $url );
111
112
		$signature = $jetpack_signature->sign_request( $token_key, $timestamp, $nonce, $body_hash, $method, $url, $body, false );
113
114
		if ( !$signature || is_wp_error( $signature ) ) {
115
			return $signature;
116
		}
117
118
		// Send an Authorization header so various caches/proxies do the right thing
119
		$auth['signature'] = $signature;
120
		$auth['version'] = JETPACK__VERSION;
121
		$header_pieces = array();
122
		foreach ( $auth as $key => $value ) {
123
			$header_pieces[] = sprintf( '%s="%s"', $key, $value );
124
		}
125
		$request['headers'] = array_merge( $args['headers'], array(
126
			'Authorization' => "X_JETPACK " . join( ' ', $header_pieces ),
127
		) );
128
129
		// Make sure we keep the host when we do JETPACK__WPCOM_JSON_API_HOST requests.
130
		$host = parse_url( $url, PHP_URL_HOST );
131
		if ( $host === JETPACK__WPCOM_JSON_API_HOST ) {
132
			$request['headers']['Host'] = 'public-api.wordpress.com';
133
		}
134
135
		if ( 'header' != $args['auth_location'] ) {
136
			$url = add_query_arg( 'signature', urlencode( $signature ), $url );
137
		}
138
139
		return Jetpack_Client::_wp_remote_request( $url, $request );
140
	}
141
142
	/**
143
	 * Wrapper for wp_remote_request().  Turns off SSL verification for certain SSL errors.
144
	 * This is lame, but many, many, many hosts have misconfigured SSL.
145
	 *
146
	 * When Jetpack is registered, the jetpack_fallback_no_verify_ssl_certs option is set to the current time if:
147
	 * 1. a certificate error is found AND
148
	 * 2. not verifying the certificate works around the problem.
149
	 *
150
	 * The option is checked on each request.
151
	 *
152
	 * @internal
153
	 * @see Jetpack::fix_url_for_bad_hosts()
154
	 *
155
	 * @return array|WP_Error WP HTTP response on success
156
	 */
157
	public static function _wp_remote_request( $url, $args, $set_fallback = false ) {
158
		/**
159
		 * SSL verification (`sslverify`) for the JetpackClient remote request
160
		 * defaults to off, use this filter to force it on.
161
		 *
162
		 * Return `true` to ENABLE SSL verification, return `false`
163
		 * to DISABLE SSL verification.
164
		 *
165
		 * @since 3.6.0
166
		 *
167
		 * @param bool Whether to force `sslverify` or not.
168
		 */
169
		if ( apply_filters( 'jetpack_client_verify_ssl_certs', false ) ) {
170
			return wp_remote_request( $url, $args );
171
		}
172
173
		$fallback = Jetpack_Options::get_option( 'fallback_no_verify_ssl_certs' );
174
		if ( false === $fallback ) {
175
			Jetpack_Options::update_option( 'fallback_no_verify_ssl_certs', 0 );
176
		}
177
178
		if ( (int) $fallback ) {
179
			// We're flagged to fallback
180
			$args['sslverify'] = false;
181
		}
182
183
		$response = wp_remote_request( $url, $args );
184
185
		if (
186
			!$set_fallback                                     // We're not allowed to set the flag on this request, so whatever happens happens
187
		||
188
			isset( $args['sslverify'] ) && !$args['sslverify'] // No verification - no point in doing it again
189
		||
190
			!is_wp_error( $response )                          // Let it ride
191
		) {
192
			Jetpack_Client::set_time_diff( $response, $set_fallback );
193
			return $response;
194
		}
195
196
		// At this point, we're not flagged to fallback and we are allowed to set the flag on this request.
197
198
		$message = $response->get_error_message();
199
200
		// Is it an SSL Certificate verification error?
201
		if (
202
			false === strpos( $message, '14090086' ) // OpenSSL SSL3 certificate error
203
		&&
204
			false === strpos( $message, '1407E086' ) // OpenSSL SSL2 certificate error
205
		&&
206
			false === strpos( $message, 'error setting certificate verify locations' ) // cURL CA bundle not found
207
		&&
208
			false === strpos( $message, 'Peer certificate cannot be authenticated with' ) // cURL CURLE_SSL_CACERT: CA bundle found, but not helpful
209
			                                                                              // different versions of curl have different error messages
210
			                                                                              // this string should catch them all
211
		&&
212
			false === strpos( $message, 'Problem with the SSL CA cert' ) // cURL CURLE_SSL_CACERT_BADFILE: probably access rights
213
		) {
214
			// No, it is not.
215
			return $response;
216
		}
217
218
		// Redo the request without SSL certificate verification.
219
		$args['sslverify'] = false;
220
		$response = wp_remote_request( $url, $args );
221
222
		if ( !is_wp_error( $response ) ) {
223
			// The request went through this time, flag for future fallbacks
224
			Jetpack_Options::update_option( 'fallback_no_verify_ssl_certs', time() );
225
			Jetpack_Client::set_time_diff( $response, $set_fallback );
226
		}
227
228
		return $response;
229
	}
230
231
	public static function set_time_diff( &$response, $force_set = false ) {
232
		$code = wp_remote_retrieve_response_code( $response );
233
234
		// Only trust the Date header on some responses
235
		if ( 200 != $code && 304 != $code && 400 != $code && 401 != $code ) {
236
			return;
237
		}
238
239
		if ( !$date = wp_remote_retrieve_header( $response, 'date' ) ) {
240
			return;
241
		}
242
243
		if ( 0 >= $time = (int) strtotime( $date ) ) {
244
			return;
245
		}
246
247
		$time_diff = $time - time();
248
249
		if ( $force_set ) { // during register
250
			Jetpack_Options::update_option( 'time_diff', $time_diff );
251
		} else { // otherwise
252
			$old_diff = Jetpack_Options::get_option( 'time_diff' );
253
			if ( false === $old_diff || abs( $time_diff - (int) $old_diff ) > 10 ) {
254
				Jetpack_Options::update_option( 'time_diff', $time_diff );
255
			}
256
		}
257
	}
258
259
	/**
260
	 * Query the WordPress.com REST API using the blog token
261
	 *
262
	 * @param string  $path
263
	 * @param string  $version
264
	 * @param array   $args
265
	 * @param string  $body
0 ignored issues
show
Documentation introduced by
Should the type for parameter $body not be string|null?

This check looks for @param annotations where the type inferred by our type inference engine differs from the declared type.

It makes a suggestion as to what type it considers more descriptive.

Most often this is a case of a parameter that can be null in addition to its declared types.

Loading history...
266
	 * @return array|WP_Error $response Data.
267
	 */
268
	static function wpcom_json_api_request_as_blog( $path, $version = self::WPCOM_JSON_API_VERSION, $args = array(), $body = null ) {
269
		$filtered_args = array_intersect_key( $args, array(
270
			'method'      => 'string',
271
			'timeout'     => 'int',
272
			'redirection' => 'int',
273
		) );
274
275
		/**
276
		 * Determines whether Jetpack can send outbound https requests to the WPCOM api.
277
		 *
278
		 * @since 3.6.0
279
		 *
280
		 * @param bool $proto Defaults to true.
281
		 */
282
		$proto = apply_filters( 'jetpack_can_make_outbound_https', true ) ? 'https' : 'http';
283
284
		// unprecedingslashit
285
		$_path = preg_replace( '/^\//', '', $path );
286
287
		// Use GET by default whereas `remote_request` uses POST
288
		if ( isset( $filtered_args['method'] ) && strtoupper( $filtered_args['method'] === 'POST' ) ) {
289
			$request_method = 'POST';
290
		} else {
291
			$request_method = 'GET';
292
		}
293
294
		$validated_args = array_merge( $filtered_args, array(
295
			'url'     => sprintf( '%s://%s/rest/v%s/%s', $proto, JETPACK__WPCOM_JSON_API_HOST, $version, $_path ),
296
			'blog_id' => (int) Jetpack_Options::get_option( 'id' ),
297
			'method'  => $request_method,
298
		) );
299
300
		return Jetpack_Client::remote_request( $validated_args, $body );
301
	}
302
303
	/**
304
	 * Takes an array or similar structure and recursively turns all values into strings. This is used to
305
	 * make sure that body hashes are made ith the string version, which is what will be seen after a
306
	 * server pulls up the data in the $_POST array.
307
	 *
308
	 * @param array|mixed $data
309
	 *
310
	 * @return array|string
311
	 */
312
	public static function _stringify_data( $data ) {
313
314
		// Booleans are special, lets just makes them and explicit 1/0 instead of the 0 being an empty string.
315
		if ( is_bool( $data ) ) {
316
			return $data ? "1" : "0";
317
		}
318
319
		// Cast objects into arrays.
320
		if ( is_object( $data ) ) {
321
			$data = (array) $data;
322
		}
323
324
		// Non arrays at this point should be just converted to strings.
325
		if ( ! is_array( $data ) ) {
326
			return (string)$data;
327
		}
328
329
		foreach ( $data as $key => &$value ) {
330
			$value = self::_stringify_data( $value );
331
		}
332
333
		return $data;
334
	}
335
}
336